QoreReflection.h

Go to the documentation of this file.

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    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.
*/

#ifndef _QORE_QOREREFLECTION_H

#define _QORE_QOREREFLECTION_H


class QoreExternalVariant {
public:
    DLLEXPORT const QoreClass* getClass() const;

    DLLEXPORT const char* getSignatureText() const;

    DLLEXPORT int64 getCodeFlags() const;

    DLLEXPORT bool isModulePublic() const;

    DLLEXPORT bool isSynchronized() const;

    DLLEXPORT bool isBuiltin() const;

    DLLEXPORT bool hasBody() const;

    DLLEXPORT int64 getDomain() const;

    DLLEXPORT unsigned numParams() const;

    DLLEXPORT const QoreTypeInfo* getReturnTypeInfo() const;

    DLLEXPORT const type_vec_t& getParamTypeList() const;

    DLLEXPORT const arg_vec_t& getDefaultArgList() const;

    DLLEXPORT const name_vec_t& getParamNames() const;

    DLLEXPORT const QoreExternalProgramLocation* getSourceLocation() const;

private:
    DLLLOCAL QoreExternalVariant();
};


class QoreExternalMethodVariant : public QoreExternalVariant {
public:
    DLLEXPORT const QoreMethod* getMethod() const;

    DLLEXPORT bool isAbstract() const;

    DLLEXPORT bool isFinal() const;

    DLLEXPORT bool isStatic() const;

    DLLEXPORT ClassAccess getAccess() const;

    DLLEXPORT const char* getAccessString() const;

private:
    DLLLOCAL QoreExternalMethodVariant();
};


class QoreExternalMemberBase {
public:
    DLLEXPORT const QoreTypeInfo* getTypeInfo() const;

    DLLEXPORT QoreValue getDefaultValue(ExceptionSink* xsink) const;

    DLLEXPORT const QoreExternalProgramLocation* getSourceLocation() const;

private:
    DLLLOCAL QoreExternalMemberBase();
};


class QoreExternalMemberVarBase : public QoreExternalMemberBase {
public:
    DLLEXPORT ClassAccess getAccess() const;

    DLLEXPORT const char* getAccessString() const;

private:
    DLLLOCAL QoreExternalMemberVarBase();
};


class QoreExternalStaticMember : public QoreExternalMemberVarBase {
public:
    DLLEXPORT QoreValue getValue() const;


    DLLEXPORT int setValue(const QoreValue val, ExceptionSink* xsink) const;

private:
    DLLLOCAL QoreExternalStaticMember();
};


class QoreExternalNormalMember : public QoreExternalMemberVarBase {
public:
    DLLEXPORT bool isTransient() const;

private:
    DLLLOCAL QoreExternalNormalMember();
};


class QoreExternalProgramLocation {
public:
    DLLEXPORT QoreHashNode* getHash() const;

private:
    DLLLOCAL QoreExternalProgramLocation();
};


class QoreExternalConstant {
public:
    DLLEXPORT const char* getName() const;


    DLLEXPORT const char* getModuleName() const;

    DLLEXPORT bool isModulePublic() const;

    DLLEXPORT bool isBuiltin() const;

    DLLEXPORT const QoreTypeInfo* getTypeInfo() const;

    DLLEXPORT QoreValue getReferencedValue() const;

    DLLEXPORT const QoreExternalProgramLocation* getSourceLocation() const;

    DLLEXPORT ClassAccess getAccess() const;

private:
    DLLLOCAL QoreExternalConstant();
};

class QoreExternalFunction {
public:
    DLLEXPORT const char* getName() const;


    DLLEXPORT const char* getModuleName() const;

    DLLEXPORT const QoreClass* getClass() const;

    DLLEXPORT const QoreExternalVariant* findVariant(const type_vec_t& type_vec, ExceptionSink* xsink) const;

    DLLEXPORT bool isBuiltin() const;

    DLLEXPORT bool isInjected() const;

    DLLEXPORT unsigned numVariants() const;

    DLLEXPORT QoreValue evalFunction(const QoreExternalVariant* variant, const QoreListNode* args, QoreProgram* pgm, ExceptionSink* xsink) const;

    DLLEXPORT const QoreExternalVariant* getFirstVariant() const;


    DLLEXPORT int64 getDomain() const;


    DLLEXPORT int64 getCodeFlags() const;

private:
    DLLLOCAL QoreExternalFunction();
};

class QoreExternalFunctionIterator {
public:
    DLLEXPORT QoreExternalFunctionIterator(const QoreExternalFunction& f);

    DLLEXPORT ~QoreExternalFunctionIterator();

    DLLEXPORT bool next();

    DLLEXPORT const QoreExternalVariant* getVariant();

private:
    class qore_external_function_iterator_private* priv;
};

class QoreExternalMethodFunction : public QoreExternalFunction {
public:
    DLLEXPORT const QoreMethod* getMethod() const;

    DLLEXPORT bool isStatic() const;

private:
    DLLLOCAL QoreExternalMethodFunction();
};

class QoreExternalGlobalVar {
public:
    DLLEXPORT const char* getName() const;

    DLLEXPORT bool isModulePublic() const;

    DLLEXPORT bool isBuiltin() const;

    DLLEXPORT const QoreTypeInfo* getTypeInfo() const;

    DLLEXPORT QoreValue getReferencedValue() const;

    DLLEXPORT const QoreExternalProgramLocation* getSourceLocation() const;


    DLLEXPORT int setValue(const QoreValue val, ExceptionSink* xsink) const;

private:
    DLLLOCAL QoreExternalGlobalVar();
};

DLLEXPORT const char* qore_type_get_name(const QoreTypeInfo* ti);

DLLEXPORT bool qore_type_equal(const QoreTypeInfo* ti1, const QoreTypeInfo* ti2);

DLLEXPORT bool qore_type_is_output_compatible(const QoreTypeInfo* ti1, const QoreTypeInfo* ti2);


DLLEXPORT bool qore_type_is_assignable_from(const QoreTypeInfo* ti1, const QoreTypeInfo* ti2);


DLLEXPORT bool qore_type_is_assignable_from(const QoreTypeInfo* ti1, const QoreTypeInfo* ti2, bool& may_not_match);


DLLEXPORT int qore_type_is_assignable_from(const QoreTypeInfo* t, QoreValue value);


DLLEXPORT QoreValue qore_type_assign_value(const QoreTypeInfo* t, const QoreValue value, ExceptionSink* xsink);


DLLEXPORT qore_type_t qore_type_get_base_type(const QoreTypeInfo* t);


DLLEXPORT QoreHashNode* qore_type_get_accept_types(const QoreTypeInfo* t);


DLLEXPORT QoreHashNode* qore_type_get_return_types(const QoreTypeInfo* t);

DLLEXPORT bool qore_type_can_convert_to_scalar(const QoreTypeInfo* ti);

DLLEXPORT bool qore_type_has_default_value(const QoreTypeInfo* ti);

DLLEXPORT QoreValue qore_type_get_default_value(const QoreTypeInfo* ti);

DLLEXPORT bool qore_type_is_input_output_compatible(const QoreTypeInfo* ti1, const QoreTypeInfo* ti2);

#endif