Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
Plugin.h
1// Copyright (c) Stefano Cristiano
2// SPDX-License-Identifier: MIT
3#pragma once
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"
9namespace SC
10{
11
12struct PluginDefinition;
13struct PluginScanner;
14struct PluginFile;
15struct PluginIdentity;
16struct PluginDynamicLibrary;
17struct PluginCompiler;
18struct PluginCompilerEnvironment;
19struct PluginSysroot;
20struct PluginRegistry;
21template <int N>
22using FixedString = detail::StringNativeFixed<N>;
23using PluginIdentifier = FixedString<64>;
24using PluginBuildOption = FixedString<32>;
25
26template <typename T, size_t N>
28{
29 constexpr size_t size() const { return numValues; }
30 constexpr void clear() { numValues = 0; }
31
32 operator Span<const T>() const { return {values, numValues}; }
33
34 template <typename U>
35 [[nodiscard]] constexpr bool contains(const U& value, size_t* outIndex = nullptr) const
36 {
37 for (size_t idx = 0; idx < numValues; ++idx)
38 {
39 if (values[idx] == value)
40 {
41 if (outIndex)
42 *outIndex = idx;
43 return true;
44 }
45 }
46 return false;
47 }
48
49 [[nodiscard]] constexpr bool isEmpty() const { return numValues == 0; }
50
51 [[nodiscard]] constexpr bool push_back(const T& value)
52 {
53 if (numValues < N)
54 {
55 values[numValues++] = value;
56 return true;
57 }
58 return false;
59 }
60
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]; }
67
68 private:
69 T values[N];
70 size_t numValues = 0;
71};
72
77
80
86
89{
90 PluginIdentifier identifier;
91 FixedString<64> name;
92 FixedString<16> version;
93
97 bool operator==(const PluginIdentity& other) const { return identifier.view() == other.identifier.view(); }
98};
99
102{
104
105 FixedString<256> description;
106 FixedString<64> category;
108
112
115 PluginFile& getMainPluginFile() { return files[pluginFileIndex]; }
116
119 const PluginFile& getMainPluginFile() const { return files[pluginFileIndex]; }
120
125 [[nodiscard]] static bool find(const StringView text, StringView& extracted);
126
131 [[nodiscard]] static bool parse(StringView text, PluginDefinition& pluginDefinition);
132
137
142
143 private:
144 [[nodiscard]] static bool parseLine(StringIteratorASCII& iterator, StringView& key, StringView& value);
145
146 size_t pluginFileIndex = 0;
147 friend struct PluginScanner;
148};
149
152{
159 template <typename T>
160 static Result scanDirectory(const StringView directory, Span<PluginDefinition> definitionsStorage,
161 T& tempFileBuffer, Span<PluginDefinition>& foundDefinitions)
162 {
163 return scanDirectory(directory, definitionsStorage, GrowableBuffer<T>{tempFileBuffer}, foundDefinitions);
164 }
165
166 private:
167 static Result scanDirectory(const StringView directory, Span<PluginDefinition> definitionsStorage,
168 IGrowableBuffer&& tempFileBuffer, Span<PluginDefinition>& foundDefinitions);
169 struct ScannerState;
170};
171
174{
181 Result compile(const PluginDefinition& definition, const PluginSysroot& sysroot,
182 const PluginCompilerEnvironment& environment, Span<char>& compilerLog) const;
183
191 Result link(const PluginDefinition& definition, const PluginSysroot& sysroot,
192 const PluginCompilerEnvironment& environment, StringView executablePath, Span<char>& linkerLog) const;
193
195 enum class Type
196 {
197 ClangCompiler,
198 GnuCompiler,
199 MicrosoftCompiler
200 };
201 Type type = Type::ClangCompiler;
204
206
209
213 [[nodiscard]] static Result findBestCompiler(PluginCompiler& compiler);
214
215 private:
216 mutable native_char_t buffer[4096];
217
218 Result compileFile(const PluginDefinition& definition, const PluginSysroot& sysroot,
219 const PluginCompilerEnvironment& compilerEnvironment, StringView sourceFile,
220 StringView objectFile, Span<char>& compilerLog) const;
221 struct CompilerFinder;
222};
223
238
241{
242 StringView cFlags;
243 StringView ldFlags;
244
245 private:
246 struct Internal;
247 friend struct PluginCompiler;
248};
251{
253 SystemDynamicLibrary dynamicLibrary;
256
257 char errorStorage[1024 * 8] = {};
259
263 template <typename T>
264 [[nodiscard]] bool queryInterface(T*& outInterface) const
265 {
266 if (pluginQueryInterface and instance != nullptr)
267 {
268 return pluginQueryInterface(instance, T::InterfaceHash, reinterpret_cast<void**>(&outInterface));
269 }
270 return false;
271 }
272
274
275 private:
276 void* instance = nullptr;
277 bool (*pluginInit)(void*& instance) = nullptr;
278 bool (*pluginClose)(void* instance) = nullptr;
279
280 bool (*pluginQueryInterface)(void* instance, uint32_t hash, void** instanceInterface) = nullptr;
281
282 friend struct PluginRegistry;
283 Result load(const PluginCompiler& compiler, const PluginSysroot& sysroot, StringView executablePath);
284 Result unload();
285};
286
289{
291 void init(Span<PluginDynamicLibrary> librariesStorage);
292
295
300
302 enum class LoadMode
303 {
304 Load = 0,
305 Reload = 1,
306 };
307
315 Result loadPlugin(const StringView identifier, const PluginCompiler& compiler, const PluginSysroot& sysroot,
316 StringView executablePath, LoadMode loadMode = LoadMode::Load);
317
321 Result unloadPlugin(const StringView identifier);
322
327
331 [[nodiscard]] PluginDynamicLibrary* findPlugin(const StringView identifier);
332
334 [[nodiscard]] size_t getNumberOfEntries() const { return libraries.sizeInElements(); }
335
337 [[nodiscard]] const PluginIdentifier& getIdentifierAt(size_t index) const
338 {
339 return libraries[index].definition.identity.identifier;
340 }
341
343 [[nodiscard]] const PluginDynamicLibrary& getPluginDynamicLibraryAt(size_t index) { return libraries[index]; }
344
349 void getPluginsToReloadBecauseOf(StringView relativePath, TimeMs tolerance,
350 Function<void(const PluginIdentifier&)> onPlugin);
351
352 private:
355};
356
358} // namespace SC
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
Definition Plugin.h:28
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