Plugin description, category, dependencies, files and directory location. More...
#include <Plugin.h>
Public Member Functions | |
PluginFile & | getMainPluginFile () |
Get main plugin file, holding plugin definition. More... | |
const PluginFile & | getMainPluginFile () const |
Get main plugin file, holding plugin definition. More... | |
Result | getDynamicLibraryAbsolutePath (String &fullDynamicPath) const |
Gets absolute path of where compiled dynamic library will exist after plugin is compiled. More... | |
Result | getDynamicLibraryPDBAbsolutePath (String &fullDynamicPath) const |
Gets absolute path of where compiled Program Database File will exist after plugin is compiled. More... | |
Static Public Member Functions | |
static bool | find (const StringView text, StringView &extracted) |
Extracts the plugin definition (SC_BEGIN_PLUGIN / SC_END_PLUGIN) comment from a .cpp file. More... | |
static bool | parse (StringView text, PluginDefinition &pluginDefinition) |
Parses an extracted plugin definition text. More... | |
Public Attributes | |
PluginIdentity | identity |
Uniquely identifier a plugin. More... | |
SmallString< 255 > | description |
Long description of plugin. More... | |
SmallString< 10 > | category |
Category where plugin belongs to. More... | |
SmallString< 255 > | directory |
Path to the directory holding the plugin. More... | |
SmallVector< PluginIdentifier, 8 > | dependencies |
Dependencies necessary to load this plugin. More... | |
SmallVector< SmallString< 10 >, 8 > | build |
Build options. More... | |
SmallVector< PluginFile, 10 > | files |
Source files that compose this plugin. More... | |
Friends | |
struct | PluginScanner |
Plugin description, category, dependencies, files and directory location.
|
static |
Extracts the plugin definition (SC_BEGIN_PLUGIN / SC_END_PLUGIN) comment from a .cpp file.
[in] | text | Content of .cpp file where to look for plugin definition |
[out] | extracted | Extracted comment block out of text |
true
if a comment block has been found successfully Gets absolute path of where compiled dynamic library will exist after plugin is compiled.
fullDynamicPath | absolute path of where compiled dynamic library from plugin |
Gets absolute path of where compiled Program Database File will exist after plugin is compiled.
fullDynamicPath | absolute path of where compiled Program Database File from plugin |
|
inline |
Get main plugin file, holding plugin definition.
|
inline |
Get main plugin file, holding plugin definition.
|
static |
Parses an extracted plugin definition text.
[in] | text | An extracted plugin definition text (extracted of PluginDefinition::find) |
[out] | pluginDefinition | A valid PluginDefinition parsed from the given text |
true
if the plugin definition can be parsed successfully SmallVector<SmallString<10>, 8> SC::PluginDefinition::build |
Build options.
SmallString<10> SC::PluginDefinition::category |
Category where plugin belongs to.
SmallVector<PluginIdentifier, 8> SC::PluginDefinition::dependencies |
Dependencies necessary to load this plugin.
SmallString<255> SC::PluginDefinition::description |
Long description of plugin.
SmallString<255> SC::PluginDefinition::directory |
Path to the directory holding the plugin.
SmallVector<PluginFile, 10> SC::PluginDefinition::files |
Source files that compose this plugin.
PluginIdentity SC::PluginDefinition::identity |
Uniquely identifier a plugin.