All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ModuleManager.h
Go to the documentation of this file.
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
ModuleManager.h
Qore Programming Language
Copyright 2003 - 2014 David Nichols
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _QORE_MODULEMANAGER_H
#define _QORE_MODULEMANAGER_H
#include <qore/QoreThreadLock.h>
#include <qore/QoreString.h>
#include <vector>
#define QORE_MODULE_API_MAJOR 0
#define QORE_MODULE_API_MINOR 18
#define QORE_MODULE_COMPAT_API_MAJOR 0
#define QORE_MODULE_COMPAT_API_MINOR 18
struct qore_mod_api_compat_s {
unsigned char major;
unsigned char minor;
};
DLLEXPORT extern const qore_mod_api_compat_s *qore_mod_api_list;
DLLEXPORT extern const unsigned qore_mod_api_list_len;
class QoreNamespace;
class QoreStringNode;
class QoreListNode;
class ExceptionSink;
typedef QoreStringNode *(*qore_module_init_t)();
typedef void (*qore_module_ns_init_t)(QoreNamespace *root_ns, QoreNamespace *qore_ns);
typedef void (*qore_module_delete_t)();
typedef void (*qore_module_parse_cmd_t)(const QoreString &cmd, ExceptionSink *xsink);
enum mod_op_e { MOD_OP_NONE, MOD_OP_EQ, MOD_OP_GT,
MOD_OP_GE, MOD_OP_LT, MOD_OP_LE };
class ModuleManager {
private:
DLLLOCAL ModuleManager(const ModuleManager&);
DLLLOCAL ModuleManager& operator=(const ModuleManager&);
public:
DLLEXPORT static void addModuleDir(const char *dir);
DLLEXPORT static void addAutoModuleDir(const char *dir);
DLLEXPORT static void addModuleDirList(const char *strlist);
DLLEXPORT static void addAutoModuleDirList(const char *strlist);
DLLEXPORT static QoreListNode *getModuleList();
DLLEXPORT static QoreHashNode *getModuleHash();
DLLEXPORT static int runTimeLoadModule(const char *name, ExceptionSink *xsink);
DLLEXPORT static int runTimeLoadModule(const char *name, QoreProgram* pgm, ExceptionSink *xsink);
DLLEXPORT static QoreStringNode *parseLoadModule(const char *name, QoreProgram *pgm = 0);
DLLEXPORT void registerUserModuleFromSource(const char* name, const char* src, QoreProgram *pgm, ExceptionSink* xsink);
DLLEXPORT static void addStandardModulePaths();
// not exported in the public API
DLLLOCAL ModuleManager();
};
DLLEXPORT extern ModuleManager MM;
static inline bool is_module_api_supported(int major, int minor) {
for (unsigned i = 0; i < qore_mod_api_list_len; ++i)
if (qore_mod_api_list[i].major == major && qore_mod_api_list[i].minor == minor)
return true;
return false;
}
#endif // _QORE_MODULEMANAGER_H
ModuleManager::getModuleList
static DLLEXPORT QoreListNode * getModuleList()
retuns a list of module information hashes, caller owns the list reference returned ...
qore_mod_api_list
DLLEXPORT const qore_mod_api_compat_s * qore_mod_api_list
list of module APIs this library supports
ModuleManager::getModuleHash
static DLLEXPORT QoreHashNode * getModuleHash()
retuns a hash of module information hashes, caller owns the list reference returned ...
QoreHashNode
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:41
ModuleManager::runTimeLoadModule
static DLLEXPORT int runTimeLoadModule(const char *name, ExceptionSink *xsink)
loads the named module at run time, returns -1 if an exception was raised, 0 for OK ...
ModuleManager::addModuleDir
static DLLEXPORT void addModuleDir(const char *dir)
to add a single directory to the QORE_MODULE_DIR list, can only be called before the library initiali...
ModuleManager::registerUserModuleFromSource
DLLEXPORT void registerUserModuleFromSource(const char *name, const char *src, QoreProgram *pgm, ExceptionSink *xsink)
registers the given user module from the module source given as an argument
QoreNamespace
contains constants, classes, and subnamespaces in QoreProgram objects
Definition: QoreNamespace.h:50
qore_module_ns_init_t
void(* qore_module_ns_init_t)(QoreNamespace *root_ns, QoreNamespace *qore_ns)
signature of the module namespace change/delta function
Definition: ModuleManager.h:64
QoreString
Qore&#39;s string type supported by the QoreEncoding class.
Definition: QoreString.h:42
QoreStringNode
Qore&#39;s string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:40
ModuleManager::addModuleDirList
static DLLEXPORT void addModuleDirList(const char *strlist)
to add a list of directories separated by &#39;:&#39; characters to the QORE_MODULE_DIR list, can only be called before the library initialization function qore_init()
ModuleManager
manages the loading of Qore modules from feature or path names. Also manages adding module changes in...
Definition: ModuleManager.h:83
QoreListNode
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:44
ModuleManager::addAutoModuleDir
static DLLEXPORT void addAutoModuleDir(const char *dir)
no longer supported - removed for security reasons
ModuleManager::parseLoadModule
static DLLEXPORT QoreStringNode * parseLoadModule(const char *name, QoreProgram *pgm=0)
loads the named module at parse time (or before run time, even if parsing is not active), returns a non-0 QoreStringNode pointer if an error occured, caller owns the QoreStringNode pointer&#39;s reference count returned if non-0
QoreProgram
supports parsing and executing Qore-language code, reference counted, dynamically-allocated only ...
Definition: QoreProgram.h:95
ExceptionSink
container for holding Qore-language exception information and also for registering a &quot;thread_exit&quot; ca...
Definition: ExceptionSink.h:35
qore_mod_api_compat_s
element of qore_mod_api_list;
Definition: ModuleManager.h:44
MM
DLLEXPORT ModuleManager MM
the global ModuleManager object
ModuleManager::addStandardModulePaths
static DLLEXPORT void addStandardModulePaths()
adds the standard module directories to the module path (only necessary if the module paths are set u...
ModuleManager::addAutoModuleDirList
static DLLEXPORT void addAutoModuleDirList(const char *strlist)
no longer supported - removed for security reasons
qore_module_delete_t
void(* qore_module_delete_t)()
signature of the module destructor function
Definition: ModuleManager.h:67
qore_mod_api_list_len
DLLEXPORT const unsigned qore_mod_api_list_len
number of elements in qore_mod_api_list;
qore_module_parse_cmd_t
void(* qore_module_parse_cmd_t)(const QoreString &cmd, ExceptionSink *xsink)
signature of the module parse command function
Definition: ModuleManager.h:70