csshlib.h File Reference
Crystal Space cross-platform shared library management. More...
#include "csextern.h"
#include "csutil/ref.h"
#include "csutil/stringarray.h"
#include "iutil/string.h"
Go to the source code of this file.
Low-level shared library support | |
typedef void * | csLibraryHandle |
void * | csGetLibrarySymbol (csLibraryHandle Handle, char const *iName) |
Return a pointer to a symbol within given shared library. | |
bool | csGetLoadLibraryVerbose () |
Query if failed dynamic library loads generate verbose messages. | |
csRef< iString > | csGetPluginMetadata (const char *fullPath, csRef< iDocument > &metadata) |
Retrive a plugin's metadata. | |
csLibraryHandle | csLoadLibrary (char const *iName) |
Load a shared library and return a library handle, which is used later to query and unload the library. | |
void | csPrintLibraryError (char const *iModule) |
Print out the latest dynamic loader error. | |
csRef< iStringArray > | csScanPluginDir (const char *dir, csRef< iStringArray > &plugins, bool recursive=true) |
Scan a given directory for plugins and return a list of the plugin native file names and their respective metadata. | |
csRef< iStringArray > | csScanPluginDirs (csPathsList *dirs, csRef< iStringArray > &plugins) |
Scan some given directories for plugins. | |
void | csSetLoadLibraryVerbose (bool) |
Control whether dynamic library loading messages are verbose or terse. | |
bool | csUnloadLibrary (csLibraryHandle Handle) |
Unload a shared library given its handle. |
Detailed Description
Crystal Space cross-platform shared library management.
Definition in file csshlib.h.
Function Documentation
|
Return a pointer to a symbol within given shared library. Note that generally Crystal Space needs just one exported symbol from every shared library; the symbol is called {library}_scfInitialize. If your OS is short on features, you may implement querying of just this symbol. |
|
Query if failed dynamic library loads generate verbose messages.
|
|
Retrive a plugin's metadata.
|
|
Load a shared library and return a library handle, which is used later to query and unload the library. iName is the FULL path to the library. |
|
Print out the latest dynamic loader error. This is not strictly required (and on some platforms its just a empty routine) but sometimes it helps to find problems. |
|
Scan a given directory for plugins and return a list of the plugin native file names and their respective metadata.
|
|
Scan some given directories for plugins.
Accepts the same parameters as csScanPluginDir(), with the exception of |
|
Control whether dynamic library loading messages are verbose or terse. When verbose, and a library fails to load, csPrintLibraryError() is invoked to emit detailed diagnostic information regarding the failure. If terse, then a simple message is emitted stating that the library failed to load and instructing the user to use the -verbose command-line option for more details. Verbose messages are enabled by default for debug builds; terse messages for optimized builds. |
|
Unload a shared library given its handle. The function returns false on error. |
Generated for Crystal Space by doxygen 1.4.4