QoreNamespace.h

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

    Qore Programming Language

    Copyright (C) 2003 - 2020 Qore Technologies, s.r.o.

    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.
*/

/*
  namespaces are children of a program object.  there is a parse
  lock per program object to ensure that objects are added (or backed out)
  atomically per program object.  All the objects referenced here should
  be safe to read & copied at all times.  They will only be deleted when the
  program object is deleted (except the pending structures, which will be
  deleted any time there is a parse error, together with all other
  pending structures)
*/

#ifndef _QORE_QORENAMESPACE_H

#define _QORE_QORENAMESPACE_H

#include <cstdlib>
#include <cstring>
#include <string>

// forward declarations
class QoreExternalFunction;
class QoreExternalConstant;
class QoreExternalGlobalVar;
class QoreProgram;


typedef QoreClass* (*q_ns_class_handler_t)(QoreNamespace* ns, const char* cname);

class QoreNamespace {
    friend class QoreNamespaceList;
    friend class RootQoreNamespace;
    friend class qore_ns_private;
    friend class qore_root_ns_private;
    friend hashdecl NSOInfoBase;

public:

    DLLEXPORT QoreNamespace(const char* n);

    DLLEXPORT virtual ~QoreNamespace();


    DLLEXPORT void clear(ExceptionSink* xsink);


    DLLEXPORT void addConstant(const char* name, QoreValue value);


    DLLEXPORT void addConstant(const char* name, QoreValue value, const QoreTypeInfo* typeInfo);


    DLLEXPORT void addSystemClass(QoreClass* oc);


    DLLEXPORT void addSystemHashDecl(TypedHashDecl* hashdecl);


    DLLEXPORT QoreNamespace* copy(int po) const;


    DLLEXPORT QoreNamespace* copy(int64 po = PO_DEFAULT) const;


    DLLEXPORT QoreHashNode* getClassInfo() const;


    DLLEXPORT QoreHashNode* getConstantInfo() const;


    DLLEXPORT QoreHashNode* getInfo() const;


    DLLEXPORT const char* getName() const;


    DLLEXPORT void addNamespace(QoreNamespace* ns);


    DLLEXPORT void addInitialNamespace(QoreNamespace* ns);


    DLLEXPORT QoreNamespace* findCreateNamespacePath(const char* nspath);


    DLLEXPORT QoreNamespace* findCreateNamespacePathAll(const char* nspath);


    DLLEXPORT QoreClass* findLocalClass(const char* cname) const;


    DLLEXPORT QoreClass* findLoadLocalClass(const char* cname);


    DLLEXPORT QoreNamespace* findLocalNamespace(const char* nsname) const;


    DLLEXPORT void setClassHandler(q_ns_class_handler_t class_handler);


    DLLEXPORT const QoreNamespace* getParent() const;

    DLLEXPORT void deleteData(ExceptionSink* xsink);

    DLLEXPORT void addBuiltinVariant(const char* name, q_func_n_t f, int64 code_flags = QCF_NO_FLAGS, int64 functional_domain = QDOM_DEFAULT, const QoreTypeInfo* returnTypeInfo = 0, unsigned num_params = 0, ...);


    DLLEXPORT void addBuiltinVariant(void* ptr, const char* name, q_external_func_t f,
        int64 code_flags = QCF_NO_FLAGS, int64 functional_domain = QDOM_DEFAULT,
        const QoreTypeInfo* returnTypeInfo = nullptr, unsigned num_params = 0, ...);


    DLLEXPORT const QoreExternalFunction* findLocalFunction(const char* name) const;


    DLLEXPORT const QoreExternalConstant* findLocalConstant(const char* name) const;


    DLLEXPORT const QoreExternalGlobalVar* findLocalGlobalVar(const char* name) const;


    DLLEXPORT const TypedHashDecl* findLocalTypedHash(const char* name) const;


    DLLEXPORT std::string getPath(bool anchored = false) const;


    DLLEXPORT bool isModulePublic() const;


    DLLEXPORT bool isBuiltin() const;


    DLLEXPORT bool isImported() const;


    DLLEXPORT bool isRoot() const;


    DLLEXPORT QoreProgram* getProgram() const;


    DLLEXPORT const char* getModuleName() const;

private:
    QoreNamespace(const QoreNamespace&) = delete;

    QoreNamespace& operator=(const QoreNamespace&) = delete;

protected:
    class qore_ns_private* priv; // private implementation

    // protected, function not exported in the API
    DLLLOCAL QoreNamespace(qore_ns_private* p);
};


class RootQoreNamespace : public QoreNamespace {
    friend class qore_ns_private;
    friend class qore_root_ns_private;
    friend class StaticSystemNamespace;

public:

    DLLEXPORT QoreNamespace* rootGetQoreNamespace() const;

    DLLLOCAL virtual ~RootQoreNamespace();


    DLLEXPORT QoreProgram* getProgram() const;

protected:
    // private implementation
    class qore_root_ns_private* rpriv;

private:
    RootQoreNamespace(const RootQoreNamespace&) = delete;

    RootQoreNamespace& operator=(const RootQoreNamespace&) = delete;

    DLLLOCAL RootQoreNamespace(class qore_root_ns_private* p);
};

class QorePrivateNamespaceIterator;


class QoreNamespaceIterator {
public:
    DLLEXPORT QoreNamespaceIterator(QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceIterator();

    DLLEXPORT bool next();

    DLLEXPORT QoreNamespace* operator->();

    DLLEXPORT QoreNamespace* operator*();

    DLLEXPORT QoreNamespace& get();

    DLLEXPORT const QoreNamespace* operator->() const;
    DLLEXPORT const QoreNamespace* operator*() const;

    DLLEXPORT const QoreNamespace& get() const;

private:
    QoreNamespaceIterator(const QoreNamespaceIterator&) = delete;

    QoreNamespaceIterator& operator=(const QoreNamespaceIterator&) = delete;

    QorePrivateNamespaceIterator* priv;
};


class QoreNamespaceConstIterator {
public:
    DLLEXPORT QoreNamespaceConstIterator(const QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceConstIterator();

    DLLEXPORT bool next();

    DLLEXPORT const QoreNamespace* operator->() const;

    DLLEXPORT const QoreNamespace* operator*() const;

    DLLEXPORT const QoreNamespace& get() const;

private:
    QoreNamespaceConstIterator(const QoreNamespaceConstIterator&) = delete;

    QoreNamespaceConstIterator& operator=(const QoreNamespaceConstIterator&) = delete;

    QorePrivateNamespaceIterator* priv;
};


class QoreNamespaceNamespaceIterator {
public:
    DLLEXPORT QoreNamespaceNamespaceIterator(const QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceNamespaceIterator();

    DLLEXPORT bool next();

    DLLEXPORT const QoreNamespace& get() const;

private:
    QoreNamespaceNamespaceIterator(const QoreNamespaceNamespaceIterator&) = delete;

    QoreNamespaceNamespaceIterator& operator=(const QoreNamespaceNamespaceIterator&) = delete;

    class qore_namespace_namespace_iterator* priv;
};


class QoreNamespaceFunctionIterator {
public:
    DLLEXPORT QoreNamespaceFunctionIterator(const QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceFunctionIterator();

    DLLEXPORT bool next();

    DLLEXPORT const QoreExternalFunction& get() const;

private:
    QoreNamespaceFunctionIterator(const QoreNamespaceFunctionIterator&) = delete;

    QoreNamespaceFunctionIterator& operator=(const QoreNamespaceFunctionIterator&) = delete;

    class qore_namespace_function_iterator* priv;
};


class QoreNamespaceConstantIterator {
public:
    DLLEXPORT QoreNamespaceConstantIterator(const QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceConstantIterator();

    DLLEXPORT bool next();

    DLLEXPORT const QoreExternalConstant& get() const;

private:
    QoreNamespaceConstantIterator(const QoreNamespaceConstantIterator&) = delete;

    QoreNamespaceConstantIterator& operator=(const QoreNamespaceConstantIterator&) = delete;

    class qore_namespace_constant_iterator* priv;
};


class QoreNamespaceClassIterator {
public:
    DLLEXPORT QoreNamespaceClassIterator(const QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceClassIterator();

    DLLEXPORT bool next();

    DLLEXPORT const QoreClass& get() const;

private:
    QoreNamespaceClassIterator(const QoreNamespaceClassIterator&) = delete;

    QoreNamespaceClassIterator& operator=(const QoreNamespaceClassIterator&) = delete;

    class ConstClassListIterator* priv;
};


class QoreNamespaceGlobalVarIterator {
public:
    DLLEXPORT QoreNamespaceGlobalVarIterator(const QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceGlobalVarIterator();

    DLLEXPORT bool next();

    DLLEXPORT const QoreExternalGlobalVar& get() const;

private:
    QoreNamespaceGlobalVarIterator(const QoreNamespaceGlobalVarIterator&) = delete;

    QoreNamespaceGlobalVarIterator& operator=(const QoreNamespaceGlobalVarIterator&) = delete;

    class qore_namespace_globalvar_iterator* priv;
};


class QoreNamespaceTypedHashIterator {
public:
    DLLEXPORT QoreNamespaceTypedHashIterator(const QoreNamespace& ns);

    DLLEXPORT virtual ~QoreNamespaceTypedHashIterator();

    DLLEXPORT bool next();

    DLLEXPORT const TypedHashDecl& get() const;

private:
    QoreNamespaceTypedHashIterator(const QoreNamespaceTypedHashIterator&) = delete;

    QoreNamespaceTypedHashIterator& operator=(const QoreNamespaceTypedHashIterator&) = delete;

    class ConstHashDeclListIterator* priv;
};

#endif // QORE_NAMESPACE_H