ModuleManager.h

Go to the documentation of this file.

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
  ModuleManager.h

  Qore Programming Language

  Copyright (C) 2003 - 2015 David Nichols

  Permission is hereby granted, free of charge, to any person obtaining a
  copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  DEALINGS IN THE SOFTWARE.

  Note that the Qore library is released under a choice of three open-source
  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
  information.
*/

#ifndef _QORE_MODULEMANAGER_H

#define _QORE_MODULEMANAGER_H

#include <qore/QoreThreadLock.h>
#include <qore/QoreString.h>

#include <vector>

// If changing the module API numbers, make sure to change the appropriate
// variables in CMakeLists.txt too.

#define QORE_MODULE_API_MAJOR 0  
#define QORE_MODULE_API_MINOR 19 

#define QORE_MODULE_COMPAT_API_MAJOR 0  
#define QORE_MODULE_COMPAT_API_MINOR 19 

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