KiCad PCB EDA Suite
include/plugins/kicad_plugin.h File Reference

Go to the source code of this file.

Macros

#define KICAD_PLUGIN_EXPORT   extern "C" __attribute__((__visibility__("default")))
 

Functions

KICAD_PLUGIN_EXPORT char const * GetKicadPluginClass (void)
 Function GetKicadPluginClass returns the name of the implemented plugin class; for example 3DPLUGIN. More...
 
KICAD_PLUGIN_EXPORT void GetClassVersion (unsigned char *Major, unsigned char *Minor, unsigned char *Patch, unsigned char *Revision)
 Function GetClassVersion retrieves the version of the Plugin Class. More...
 
KICAD_PLUGIN_EXPORT bool CheckClassVersion (unsigned char Major, unsigned char Minor, unsigned char Patch, unsigned char Revision)
 Function CheckClassVersion returns true if the class version reported by the Plugin Loader is compatible with the specific implementation of a plugin. More...
 
KICAD_PLUGIN_EXPORT const char * GetKicadPluginName (void)
 Function GetKicadPluginName returns the name of the plugin instance; for example IDFv3. More...
 
KICAD_PLUGIN_EXPORT void GetPluginVersion (unsigned char *Major, unsigned char *Minor, unsigned char *Patch, unsigned char *Revision)
 Function GetPluginVersion retrieves the version of the instantiated plugin for informational purposes. More...
 

Macro Definition Documentation

#define KICAD_PLUGIN_EXPORT   extern "C" __attribute__((__visibility__("default")))

Definition at line 36 of file include/plugins/kicad_plugin.h.

Function Documentation

KICAD_PLUGIN_EXPORT bool CheckClassVersion ( unsigned char  Major,
unsigned char  Minor,
unsigned char  Patch,
unsigned char  Revision 
)

Function CheckClassVersion returns true if the class version reported by the Plugin Loader is compatible with the specific implementation of a plugin.

This function must be defined by each specific plugin and it is the plugin developer's responsibility to ensure that the Plugin is in fact compatible with the Plugin Loader. The Plugin Loader shall reject any Plugin with a different Major number regardless of the return value of this function.

Definition at line 73 of file 3d_plugin.h.

References MAJOR.

75 {
76  if( Major != MAJOR )
77  return false;
78 
79  // at the moment there are no incompatibility rules other than the Major Version check
80  return true;
81 }
#define MAJOR
Definition: 3d_plugin.h:41
KICAD_PLUGIN_EXPORT void GetClassVersion ( unsigned char *  Major,
unsigned char *  Minor,
unsigned char *  Patch,
unsigned char *  Revision 
)

Function GetClassVersion retrieves the version of the Plugin Class.

This value is used to ensure API compatibility of a plugin as per typical practice. This must be implemented in a source module which is compiled as part of every implementation of a specific plugin class

Parameters
Majorwill hold the Plugin Class Major version
Minorwill hold the Plugin Class Minor version
Revisionwill hold the Plugin Class Revision
Patchwill hold the Plugin Class Patch level

Definition at line 55 of file 3d_plugin.h.

References MAJOR, MINOR, PATCH, and REVISION.

57 {
58  if( Major )
59  *Major = MAJOR;
60 
61  if( Minor )
62  *Minor = MINOR;
63 
64  if( Patch )
65  *Patch = PATCH;
66 
67  if( Revision )
68  *Revision = REVISION;
69 
70  return;
71 }
#define MAJOR
Definition: 3d_plugin.h:41
#define MINOR
Definition: 3d_plugin.h:42
#define REVISION
Definition: 3d_plugin.h:43
#define PATCH
Definition: 3d_plugin.h:44
KICAD_PLUGIN_EXPORT char const* GetKicadPluginClass ( void  )

Function GetKicadPluginClass returns the name of the implemented plugin class; for example 3DPLUGIN.

This should be implemented in a source module which is compiled as part of every implementation of a specific plugin class.

Returns
is the NULL-terminated UTF-8 string representing the plugin class

Definition at line 49 of file 3d_plugin.h.

References KICAD_PLUGIN_CLASS.

50 {
51  return KICAD_PLUGIN_CLASS;
52 }
#define KICAD_PLUGIN_CLASS
Definition: 3d_plugin.h:40
KICAD_PLUGIN_EXPORT const char* GetKicadPluginName ( void  )

Function GetKicadPluginName returns the name of the plugin instance; for example IDFv3.

This string may be used to check for name conflicts or to display informational messages about loaded plugins. This method must be implemented in specific instantiations of a plugin class.

Returns
is the NULL-terminated UTF-8 string representing the plugin name
KICAD_PLUGIN_EXPORT void GetPluginVersion ( unsigned char *  Major,
unsigned char *  Minor,
unsigned char *  Patch,
unsigned char *  Revision 
)

Function GetPluginVersion retrieves the version of the instantiated plugin for informational purposes.

Do not confuse this with GetClassVersion which is used to determine API compatibility.

Parameters
Majorwill hold the Plugin Major version
Minorwill hold the Plugin Minor version
Patchwill hold the Plugin Patch level
Revisionwill hold the Plugin Revision