4#include "../Foundation/Function.h"
5#include "../Foundation/Platform.h"
6#include "../Foundation/PrimitiveTypes.h"
7#include "../Foundation/StringPath.h"
8#include "Internal/DynamicLibrary.h"
12struct PluginDefinition;
16struct PluginDynamicLibrary;
18struct PluginCompilerEnvironment;
22using FixedString = detail::StringNativeFixed<N>;
23using PluginIdentifier = FixedString<64>;
24using PluginBuildOption = FixedString<32>;
26template <
typename T,
size_t N>
29 constexpr size_t size()
const {
return numValues; }
30 constexpr void clear() { numValues = 0; }
32 operator Span<const T>()
const {
return {values, numValues}; }
35 [[nodiscard]]
constexpr bool contains(
const U& value,
size_t* outIndex =
nullptr)
const
37 for (
size_t idx = 0; idx < numValues; ++idx)
39 if (values[idx] == value)
49 [[nodiscard]]
constexpr bool isEmpty()
const {
return numValues == 0; }
51 [[nodiscard]]
constexpr bool push_back(
const T& value)
55 values[numValues++] = value;
61 constexpr T* begin() {
return values; }
62 constexpr T* end() {
return values + numValues; }
63 constexpr T& operator[](
size_t idx) {
return values[idx]; }
64 constexpr const T* begin()
const {
return values; }
65 constexpr const T* end()
const {
return values + numValues; }
66 constexpr const T& operator[](
size_t idx)
const {
return values[idx]; }
146 size_t pluginFileIndex = 0;
159 template <
typename T>
163 return scanDirectory(directory, definitionsStorage, GrowableBuffer<T>{tempFileBuffer}, foundDefinitions);
221 struct CompilerFinder;
263 template <
typename T>
266 if (pluginQueryInterface and instance !=
nullptr)
268 return pluginQueryInterface(instance, T::InterfaceHash,
reinterpret_cast<void**
>(&outInterface));
276 void* instance =
nullptr;
277 bool (*pluginInit)(
void*& instance) =
nullptr;
278 bool (*pluginClose)(
void* instance) =
nullptr;
280 bool (*pluginQueryInterface)(
void* instance,
uint32_t hash,
void** instanceInterface) =
nullptr;
339 return libraries[index].definition.identity.identifier;
350 Function<
void(
const PluginIdentifier&)> onPlugin);
unsigned int uint32_t
Platform independent (4) bytes unsigned int.
Definition PrimitiveTypes.h:38
char native_char_t
The native char for the platform (wchar_t (4 bytes) on Windows, char (1 byte) everywhere else )
Definition PrimitiveTypes.h:34
Wraps function pointers, member functions and lambdas without ever allocating.
Definition Function.h:19
Reads and holds CFLAGS and LDFLAGS environment variables, mainly to pass down sysroot location.
Definition Plugin.h:241
Compiles a plugin to a dynamic library.
Definition Plugin.h:174
StringPath linkerPath
Path to the linker.
Definition Plugin.h:203
Result link(const PluginDefinition &definition, const PluginSysroot &sysroot, const PluginCompilerEnvironment &environment, StringView executablePath, Span< char > &linkerLog) const
Links a Definition into a dynamic library, with symbols from executablePath
FixedVector< StringPath, 8 > includePaths
Path to include directories used to compile plugin.
Definition Plugin.h:205
Type type
Compile Type.
Definition Plugin.h:201
FixedVector< StringPath, 8 > compilerLibraryPaths
Path to compiler library directories.
Definition Plugin.h:208
Type
Compiler type (clang/gcc/msvc)
Definition Plugin.h:196
static Result findBestCompiler(PluginCompiler &compiler)
Look for best compiler on current system.
FixedVector< StringPath, 8 > compilerIncludePaths
Path to compiler include directories.
Definition Plugin.h:207
Result compile(const PluginDefinition &definition, const PluginSysroot &sysroot, const PluginCompilerEnvironment &environment, Span< char > &compilerLog) const
Compiles a Definition to an object file.
StringPath compilerPath
Path to the compiler.
Definition Plugin.h:202
Plugin description, category, dependencies, files and directory location.
Definition Plugin.h:102
StringPath directory
Path to the directory holding the plugin.
Definition Plugin.h:107
FixedVector< PluginFile, 10 > files
Source files that compose this plugin.
Definition Plugin.h:111
PluginIdentity identity
Uniquely identifier a plugin.
Definition Plugin.h:103
static bool find(const StringView text, StringView &extracted)
Extracts the plugin definition (SC_BEGIN_PLUGIN / SC_END_PLUGIN) comment from a .cpp file.
FixedString< 256 > description
Long description of plugin.
Definition Plugin.h:105
const PluginFile & getMainPluginFile() const
Get main plugin file, holding plugin definition.
Definition Plugin.h:119
FixedVector< PluginIdentifier, 8 > dependencies
Dependencies necessary to load this plugin.
Definition Plugin.h:109
static bool parse(StringView text, PluginDefinition &pluginDefinition)
Parses an extracted plugin definition text.
Result getDynamicLibraryAbsolutePath(StringPath &fullDynamicPath) const
Gets absolute path of where compiled dynamic library will exist after plugin is compiled.
FixedString< 64 > category
Category where plugin belongs to.
Definition Plugin.h:106
Result getDynamicLibraryPDBAbsolutePath(StringPath &fullDynamicPath) const
Gets absolute path of where compiled Program Database File will exist after plugin is compiled.
PluginFile & getMainPluginFile()
Get main plugin file, holding plugin definition.
Definition Plugin.h:115
FixedVector< PluginBuildOption, 8 > build
Build options.
Definition Plugin.h:110
A plugin dynamic library loaded from a SC::PluginRegistry.
Definition Plugin.h:251
SystemDynamicLibrary dynamicLibrary
System handle of plugin's dynamic library.
Definition Plugin.h:253
TimeMs lastLoadTime
Last time when this plugin was last loaded.
Definition Plugin.h:254
PluginDefinition definition
Definition of the loaded plugin.
Definition Plugin.h:252
StringView lastErrorLog
Last error log of compiler / linker (if any)
Definition Plugin.h:258
uint32_t numReloads
Number of times that the plugin has been hot-reloaded.
Definition Plugin.h:255
bool queryInterface(T *&outInterface) const
Try to obtain a given interface as exported by a plugin through SC_PLUGIN_EXPORT_INTERFACES macro.
Definition Plugin.h:264
char errorStorage[1024 *8]
Storage for last error log (below)
Definition Plugin.h:257
Holds path to a given plugin source file.
Definition Plugin.h:83
StringPath absolutePath
Absolute path to a plugin source file.
Definition Plugin.h:84
Represents the unique signature / identity of a Plugin.
Definition Plugin.h:89
bool operator==(const PluginIdentity &other) const
Compares two plugins on Identity::identifier.
Definition Plugin.h:97
PluginIdentifier identifier
Unique string identifying the plugin.
Definition Plugin.h:90
FixedString< 64 > name
Plugin name.
Definition Plugin.h:91
FixedString< 16 > version
Plugin version (x.y.z)
Definition Plugin.h:92
Holds a registry of plugins, loading and compiling them on the fly.
Definition Plugin.h:289
void getPluginsToReloadBecauseOf(StringView relativePath, TimeMs tolerance, Function< void(const PluginIdentifier &)> onPlugin)
Enumerates all plugins that must be reloaded when relativePath is modified.
LoadMode
Instructs loadPlugin to Load or Reload the plugin.
Definition Plugin.h:303
void init(Span< PluginDynamicLibrary > librariesStorage)
Init a PluginRegistry with some given storage.
Result unloadPlugin(const StringView identifier)
Unloads an already loaded plugin by its identifier.
Result loadPlugin(const StringView identifier, const PluginCompiler &compiler, const PluginSysroot &sysroot, StringView executablePath, LoadMode loadMode=LoadMode::Load)
Loads a plugin with given identifier, compiling it with given PluginCompiler.
size_t getNumberOfEntries() const
Returns the total number of registry entries (counting both loaded and unloaded plugins)
Definition Plugin.h:334
Result removeAllBuildProducts(const StringView identifier)
Removes all temporary build products of the Plugin with given identifier.
const PluginDynamicLibrary & getPluginDynamicLibraryAt(size_t index)
Returns the PluginIdentifier corresponding to the index entry of the registry.
Definition Plugin.h:343
Result close()
Unregisters all plugins.
const PluginIdentifier & getIdentifierAt(size_t index) const
Returns the PluginIdentifier corresponding to the index entry of the registry.
Definition Plugin.h:337
Result replaceDefinitions(Span< PluginDefinition > &&definitions)
Appends the definitions to registry.
PluginDynamicLibrary * findPlugin(const StringView identifier)
Find a PluginDynamicLibrary in the registry with a given identifier.
Scans a directory for PluginDefinition.
Definition Plugin.h:152
static Result scanDirectory(const StringView directory, Span< PluginDefinition > definitionsStorage, T &tempFileBuffer, Span< PluginDefinition > &foundDefinitions)
Scans a directory for PluginDefinition.
Definition Plugin.h:160
Holds include and library paths for a system toolchain, used to let plugins link to libc and libc++.
Definition Plugin.h:226
FixedVector< StringPath, 8 > includePaths
Path to system include directories.
Definition Plugin.h:227
StringPath isysroot
Path to sysroot include (optional)
Definition Plugin.h:230
static Result findBestSysroot(PluginCompiler::Type compiler, PluginSysroot &sysroot)
Finds a reasonable sysroot for the given compiler.
FixedVector< StringPath, 8 > libraryPaths
Path to system library directories.
Definition Plugin.h:228
An ascii string used as boolean result. SC_TRY macro forwards errors to caller.
Definition Result.h:12
View over a contiguous sequence of items (pointer + size in elements).
Definition Span.h:29
A string iterator for ASCII strings.
Definition StringIterator.h:239
Pre-sized char array holding enough space to represent a file system path.
Definition StringPath.h:42
Non-owning view over a range of characters with UTF Encoding.
Definition StringView.h:46
A vocabulary type representing a time interval in milliseconds since epoch.
Definition PrimitiveTypes.h:63