common.h
Go to the documentation of this file.
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
common.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.
*/
#ifndef _QORE_COMMON_H
#define _QORE_COMMON_H
#include <algorithm>
#include <cinttypes>
#include <cstdarg>
#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <functional>
#include <list>
#include <set>
#include <set>
#include <string>
#include <strings.h>
#include <vector>
class QoreTypeInfo;
#define Q_AF_UNSPEC -1
#define Q_AF_INET -2
#define Q_AF_INET6 -3
#define Q_SOCK_STREAM -1
typedef int16_t qore_type_t;
typedef size_t qore_size_t;
typedef intptr_t qore_offset_t;
typedef unsigned qore_classid_t;
typedef std::set<int> int_set_t;
enum qore_license_t {
QL_GPL = 0,
QL_LGPL = 1,
QL_MIT = 2
};
// class access values
enum ClassAccess : unsigned char {
Public = 0, // publicly accessible
Private = 1, // accessible only in the class hierarchy (like c++'s 'protected')
Internal = 2, // accessible only in the class itself
Inaccessible = 3, // not accessible from the class
};
#if defined _MSC_VER || ((defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__)
#define _Q_WINDOWS 1
#ifdef _WIN64
#define _Q_WINDOWS64 1
#endif
#endif
#ifdef _Q_WINDOWS
#ifdef BUILDING_DLL
#define DLLEXPORT __declspec(dllexport)
#else
#define DLLEXPORT __declspec(dllimport)
#endif
#define DLLLOCAL
#define QLLD "%I64d"
#define QLLX "%I64x"
#define QLLDx(a) "%" #a "I64d"
#define QORE_DIR_SEP '\\'
#define QORE_DIR_SEP_STR "\\"
#define QORE_PATH_SEP ';'
#define QORE_PATH_SEP_STR ";"
#include <winsock2.h>
#else
#ifdef HAVE_GCC_VISIBILITY
#define DLLEXPORT __attribute__ ((visibility("default")))
#define DLLLOCAL __attribute__ ((visibility("hidden")))
#else
#define DLLEXPORT
#define DLLLOCAL
#endif
#define QLLD "%lld"
#define QLLX "%llx"
#define QLLDx(a) "%" #a "lld"
#define QORE_DIR_SEP '/'
#define QORE_DIR_SEP_STR "/"
#define QORE_PATH_SEP ':'
#define QORE_PATH_SEP_STR ":"
#endif
#define _Q_MAKE_STRING(x) #x
#define MAKE_STRING_FROM_SYMBOL(x) _Q_MAKE_STRING(x)
// forward references
class AbstractQoreNode;
class QoreListNode;
class ExceptionSink;
class QoreObject;
class AbstractPrivateData;
class QoreMethod;
class QoreBuiltinMethod;
class QoreClass;
class TypedHashDecl;
class QoreExternalFunction;
class QoreExternalGlobalVar;
class QoreExternalConstant;
class QoreNamespace;
class QoreHashNode;
struct QoreValue;
typedef std::vector<const QoreClass*> class_vec_t;
typedef std::vector<std::pair<const TypedHashDecl*, const QoreNamespace*>> hashdecl_vec_t;
typedef std::vector<const QoreExternalFunction*> func_vec_t;
typedef std::vector<const QoreNamespace*> ns_vec_t;
typedef std::vector<std::pair<const QoreExternalGlobalVar*, const QoreNamespace*>> gvar_vec_t;
typedef std::vector<std::pair<const QoreExternalConstant*, const QoreNamespace*>> const_vec_t;
template <typename T> struct free_ptr : std::unary_function <T*, void> {
DLLLOCAL void operator()(T* ptr) {
free(ptr);
}
};
template <typename T> struct simple_delete {
DLLLOCAL void operator()(T* ptr) {
delete ptr;
}
};
template <typename T> struct simple_deref {
DLLLOCAL void operator()(T* ptr) {
ptr->deref();
}
DLLLOCAL void operator()(T* ptr, ExceptionSink* xsink) {
ptr->deref(xsink);
}
};
class ltstr {
public:
DLLLOCAL bool operator()(const char* s1, const char* s2) const {
return strcmp(s1, s2) < 0;
}
};
class ltcstrcase {
public:
DLLLOCAL bool operator()(const char* s1, const char* s2) const {
return strcasecmp(s1, s2) < 0;
}
};
class ltstrcase {
public:
DLLLOCAL bool operator()(std::string s1, std::string s2) const {
return strcasecmp(s1.c_str(), s2.c_str()) < 0;
}
};
class eqstr {
public:
DLLLOCAL bool operator()(const char* s1, const char* s2) const {
return !strcmp(s1, s2);
}
};
class eqstrcase {
public:
DLLLOCAL bool operator()(const char* s1, const char* s2) const {
return !strcasecmp(s1, s2);
}
};
class ltchar {
public:
DLLLOCAL bool operator()(const char s1, const char s2) const {
return s1 < s2;
}
};
class cstr_vector_t : public std::vector<char*> {
public:
DLLLOCAL ~cstr_vector_t() {
clear();
}
DLLLOCAL void clear() {
std::for_each(begin(), end(), free_ptr<char>());
std::vector<char*>::clear();
}
};
typedef std::vector<const QoreTypeInfo*> type_vec_t;
typedef std::vector<QoreValue> arg_vec_t;
typedef std::vector<std::string> name_vec_t;
typedef long long int64;
typedef uint64_t q_rt_flags_t;
class QoreSerializationContext {
public:
DLLLOCAL int serializeObject(const QoreObject& obj, std::string& index, ExceptionSink* xsink);
DLLLOCAL QoreValue serializeValue(const QoreValue val, ExceptionSink* xsink);
DLLLOCAL void addModule(const char* module);
private:
DLLLOCAL QoreSerializationContext();
};
class QoreDeserializationContext {
public:
DLLLOCAL QoreObject* deserializeObject(const char* index, ExceptionSink* xsink);
DLLLOCAL QoreValue deserializeValue(const QoreValue val, ExceptionSink* xsink);
private:
DLLLOCAL QoreDeserializationContext();
};
typedef QoreValue (*q_func_n_t)(const QoreListNode* args, q_rt_flags_t flags, ExceptionSink* xsink);
typedef QoreValue (*q_external_func_t)(const void* ptr, const QoreListNode* args, q_rt_flags_t flags, ExceptionSink* xsink);
typedef QoreValue (*q_method_n_t)(QoreObject* self, AbstractPrivateData* private_data, const QoreListNode* args, q_rt_flags_t flags, ExceptionSink* xsink);
typedef QoreValue (*q_external_method_t)(const QoreMethod& method, const void* ptr, QoreObject* self, AbstractPrivateData* private_data, const QoreListNode* args, q_rt_flags_t flags, ExceptionSink* xsink);
typedef QoreValue (*q_external_static_method_t)(const QoreMethod& method, const void* ptr, const QoreListNode* args, q_rt_flags_t flags, ExceptionSink* xsink);
typedef void (*q_constructor_n_t)(QoreObject* self, const QoreListNode* args, q_rt_flags_t rtflags, ExceptionSink* xsink);
typedef void (*q_external_constructor_t)(const QoreMethod& method, const void* ptr, QoreObject* self, const QoreListNode* args, q_rt_flags_t rtflags, ExceptionSink* xsink);
typedef void (*q_system_constructor_t)(QoreObject* self, int code, va_list args);
typedef void (*q_destructor_t)(QoreObject* self, AbstractPrivateData* private_data, ExceptionSink* xsink);
typedef void (*q_external_destructor_t)(const QoreClass& thisclass, const void* ptr, QoreObject* self, AbstractPrivateData* private_data, ExceptionSink* xsink);
typedef void (*q_copy_t)(QoreObject* self, QoreObject* old, AbstractPrivateData* private_data, ExceptionSink* xsink);
typedef void (*q_external_copy_t)(const QoreClass& thisclass, const void* ptr, QoreObject* self, QoreObject* old, AbstractPrivateData* private_data, ExceptionSink* xsink);
typedef bool (*q_delete_blocker_t)(QoreObject* self, AbstractPrivateData* private_data);
typedef QoreHashNode* (*q_serializer_t)(const QoreObject& self, const AbstractPrivateData& data, QoreSerializationContext& context, ExceptionSink* xsink);
typedef void (*q_deserializer_t)(QoreObject& self, const QoreHashNode* sdata, QoreDeserializationContext& context, ExceptionSink* xsink);
typedef unsigned q_trid_t;
DLLEXPORT long long q_atoll(const char* str);
DLLEXPORT const char* type_get_name(const QoreTypeInfo* t);
#endif // _QORE_COMMON_H
q_external_func_t
QoreValue(* q_external_func_t)(const void *ptr, const QoreListNode *args, q_rt_flags_t flags, ExceptionSink *xsink)
the type used for builtin function signatures for external functions
Definition: common.h:319
q_rt_flags_t
uint64_t q_rt_flags_t
runtime code execution flags
Definition: common.h:263
ltstrcase
for std::string case-insensitive less-than comparisons
Definition: common.h:208
q_func_n_t
QoreValue(* q_func_n_t)(const QoreListNode *args, q_rt_flags_t flags, ExceptionSink *xsink)
the type used for builtin function signatures
Definition: common.h:307
int_set_t
std::set< int > int_set_t
set of integers
Definition: common.h:82
q_external_constructor_t
void(* q_external_constructor_t)(const QoreMethod &method, const void *ptr, QoreObject *self, const QoreListNode *args, q_rt_flags_t rtflags, ExceptionSink *xsink)
the type used for builtin QoreClass constructor method signatures
Definition: common.h:378
QoreDeserializationContext::deserializeObject
DLLLOCAL QoreObject * deserializeObject(const char *index, ExceptionSink *xsink)
returns the object corresponding to the given object serialization index, throws a Qore-language exce...
qore_offset_t
intptr_t qore_offset_t
used for offsets that could be negative
Definition: common.h:76
QoreValue
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:262
QoreSerializationContext::serializeObject
DLLLOCAL int serializeObject(const QoreObject &obj, std::string &index, ExceptionSink *xsink)
serializes the given object and return the serialization index, throws a Qore-language exception if t...
q_system_constructor_t
void(* q_system_constructor_t)(QoreObject *self, int code, va_list args)
the type used for builtin QoreClass system constructor method signatures
Definition: common.h:390
QoreHashNode
This is the hash or associative list container type in Qore, dynamically allocated only,...
Definition: QoreHashNode.h:50
QoreClass
defines a Qore-language class
Definition: QoreClass.h:239
qore_size_t
size_t qore_size_t
used for sizes (same range as a pointer)
Definition: common.h:73
cstr_vector_t
non-thread-safe vector for storing "char*" that you want to delete
Definition: common.h:238
q_deserializer_t
void(* q_deserializer_t)(QoreObject &self, const QoreHashNode *sdata, QoreDeserializationContext &context, ExceptionSink *xsink)
the type used for builtin QoreClass deserializer method signatures
Definition: common.h:458
QL_MIT
@ QL_MIT
code to be used under the MIT license
Definition: common.h:88
QoreListNode
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
QoreDeserializationContext::deserializeValue
DLLLOCAL QoreValue deserializeValue(const QoreValue val, ExceptionSink *xsink)
deserializes the given data value and returns the deserialized value, throws a Qore-language exceptio...
int64
long long int64
64bit integer type, cannot use int64_t here since it breaks the API on some 64-bit systems due to equ...
Definition: common.h:260
arg_vec_t
std::vector< QoreValue > arg_vec_t
vector of value information for default argument lists
Definition: common.h:254
QoreSerializationContext
serialization context object used in builtin serializer methods
Definition: common.h:268
q_external_copy_t
void(* q_external_copy_t)(const QoreClass &thisclass, const void *ptr, QoreObject *self, QoreObject *old, AbstractPrivateData *private_data, ExceptionSink *xsink)
the type used for builtin QoreClass copy signatures with the new generic calling convention
Definition: common.h:428
QoreNamespace
contains constants, classes, and subnamespaces in QoreProgram objects
Definition: QoreNamespace.h:65
ltstr
for simple c-string less-than comparisons
Definition: common.h:192
QoreExternalConstant
external wrapper class for constants
Definition: QoreReflection.h:200
ltcstrcase
for simple c-string case-insensitive less-than comparisons
Definition: common.h:200
q_method_n_t
QoreValue(* q_method_n_t)(QoreObject *self, AbstractPrivateData *private_data, const QoreListNode *args, q_rt_flags_t flags, ExceptionSink *xsink)
the type used for builtin QoreClass method signatures
Definition: common.h:330
qore_license_t
qore_license_t
qore library and module license type identifiers
Definition: common.h:85
q_external_static_method_t
QoreValue(* q_external_static_method_t)(const QoreMethod &method, const void *ptr, const QoreListNode *args, q_rt_flags_t flags, ExceptionSink *xsink)
the type used for external static methods
Definition: common.h:358
TypedHashDecl
typed hash declaration
Definition: TypedHashDecl.h:44
QL_LGPL
@ QL_LGPL
code to be used under the LGPL license
Definition: common.h:87
QoreDeserializationContext
deserialization context object used in builtin deserializer methods
Definition: common.h:287
QoreObject
the implementation of Qore's object data type, reference counted, dynamically-allocated only
Definition: QoreObject.h:61
ExceptionSink
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
q_external_method_t
QoreValue(* q_external_method_t)(const QoreMethod &method, const void *ptr, QoreObject *self, AbstractPrivateData *private_data, const QoreListNode *args, q_rt_flags_t flags, ExceptionSink *xsink)
the type used for builtin QoreClass method signatures
Definition: common.h:345
q_delete_blocker_t
bool(* q_delete_blocker_t)(QoreObject *self, AbstractPrivateData *private_data)
the typed used for QoreClass deleteBlocker signatures
Definition: common.h:436
QoreSerializationContext::addModule
DLLLOCAL void addModule(const char *module)
adds a module to be loaded when the data is deserialized
qore_classid_t
unsigned qore_classid_t
used for the unique class ID for QoreClass objects
Definition: common.h:79
ltchar
for char less-than comparisons
Definition: common.h:230
simple_delete
functor template for deleting elements
Definition: common.h:175
q_constructor_n_t
void(* q_constructor_n_t)(QoreObject *self, const QoreListNode *args, q_rt_flags_t rtflags, ExceptionSink *xsink)
the type used for builtin QoreClass constructor method signatures
Definition: common.h:366
QoreSerializationContext::serializeValue
DLLLOCAL QoreValue serializeValue(const QoreValue val, ExceptionSink *xsink)
serializes the given value and returns a serialized value representing the value to be serialized,...
free_ptr
functor template for calling free() on pointers
Definition: common.h:168
q_external_destructor_t
void(* q_external_destructor_t)(const QoreClass &thisclass, const void *ptr, QoreObject *self, AbstractPrivateData *private_data, ExceptionSink *xsink)
the type used for builtin QoreClass destructor signatures with the new generic calling convention and...
Definition: common.h:408
type_get_name
DLLEXPORT const char * type_get_name(const QoreTypeInfo *t)
returns the type name for an opaqua QoreTypeInfo ptr
type_vec_t
std::vector< const QoreTypeInfo * > type_vec_t
vector of type information for parameter lists
Definition: common.h:251
QoreMethod
a method in a QoreClass
Definition: QoreClass.h:125
q_destructor_t
void(* q_destructor_t)(QoreObject *self, AbstractPrivateData *private_data, ExceptionSink *xsink)
the type used for builtin QoreClass destructor signatures
Definition: common.h:398
AbstractPrivateData
the base class for all data to be used as private data of Qore objects
Definition: AbstractPrivateData.h:44
QL_GPL
@ QL_GPL
code to be used under the GPL license
Definition: common.h:86
name_vec_t
std::vector< std::string > name_vec_t
vector of parameter names for parameter lists
Definition: common.h:257
q_atoll
DLLEXPORT long long q_atoll(const char *str)
returns an integer value for a string
AbstractQoreNode
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:54
qore_type_t
int16_t qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode)
Definition: common.h:70
simple_deref
functor template for dereferencing elements
Definition: common.h:182
q_trid_t
unsigned q_trid_t
type for thread resource IDs (unique within a single running qore library process)
Definition: common.h:463
q_copy_t
void(* q_copy_t)(QoreObject *self, QoreObject *old, AbstractPrivateData *private_data, ExceptionSink *xsink)
the type used for builtin QoreClass copy signatures
Definition: common.h:417