Qore.h
Go to the documentation of this file.
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
Qore.h
Qore Programming Language
Copyright (C) 2003 - 2021 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_QORE_H
#define _QORE_QORE_H
// include configuration first if compiling the library
#ifdef _QORE_LIB_INTERN
#include "qore/intern/config.h"
#endif
#include <qore/common.h>
#include <qore/AbstractException.h>
#include <qore/QoreStandardException.h>
#include <qore/QoreXSinkException.h>
#include <qore/QoreCounter.h>
DLLEXPORT extern QoreCounter thread_counter;
#include <qore/QoreEncoding.h>
#include <qore/ReferenceHolder.h>
#include <qore/QoreValue.h>
#include <qore/AbstractQoreNode.h>
#include <qore/QoreListNode.h>
#include <qore/TypedHashDecl.h>
#include <qore/QoreHashNode.h>
#include <qore/AbstractPrivateData.h>
#include <qore/QoreIteratorBase.h>
#include <qore/QoreObject.h>
#include <qore/QoreProgram.h>
#include <qore/QoreDebugProgram.h>
#include <qore/ModuleManager.h>
#include <qore/QoreLib.h>
#include <qore/QoreStringNode.h>
#include <qore/DateTimeNode.h>
#include <qore/QoreNumberNode.h>
#include <qore/QoreNothingNode.h>
#include <qore/QoreNullNode.h>
#include <qore/QoreNet.h>
#include <qore/QoreURL.h>
#include <qore/QoreFile.h>
#include <qore/QoreQueueHelper.h>
#include <qore/QoreRWLock.h>
#include <qore/QoreNamespace.h>
#include <qore/ExceptionSink.h>
#include <qore/BinaryNode.h>
#include <qore/QoreString.h>
#include <qore/DateTime.h>
#include <qore/QoreType.h>
#include <qore/qore_thread.h>
#include <qore/QoreThreadLock.h>
#include <qore/QoreThreadLocalStorage.h>
#include <qore/QoreCondition.h>
#include <qore/QoreQueue.h>
#include <qore/DBI.h>
#include <qore/Datasource.h>
#include <qore/SQLStatement.h>
#include <qore/QoreClass.h>
#include <qore/QoreReflection.h>
#include <qore/ScopeGuard.h>
#include <qore/SystemEnvironment.h>
#include <qore/AutoVLock.h>
#include <qore/CallReferenceNode.h>
#include <qore/ReferenceNode.h>
#include <qore/params.h>
#include <qore/QoreTypeSafeReferenceHelper.h>
#include <qore/QoreEvents.h>
#include <qore/UnicodeCharacterIterator.h>
#include <qore/qore-version.h>
DLLEXPORT extern const char* qore_version_string;
DLLEXPORT extern int qore_version_major;
DLLEXPORT extern int qore_version_minor;
DLLEXPORT extern int qore_version_sub;
DLLEXPORT extern int qore_version_patch;
DLLEXPORT extern int qore_build_number;
DLLEXPORT extern int qore_target_bits;
DLLEXPORT extern const char* qore_git_hash;
DLLEXPORT extern const char* qore_target_os;
DLLEXPORT extern const char* qore_target_arch;
DLLEXPORT extern const char* qore_module_dir;
DLLEXPORT extern const char* qore_user_module_dir;
DLLEXPORT extern const char* qore_module_ver_dir;
DLLEXPORT extern const char* qore_user_module_ver_dir;
DLLEXPORT extern const char* qore_cplusplus_compiler;
DLLEXPORT extern const char* qore_cflags;
DLLEXPORT extern const char* qore_ldflags;
DLLEXPORT extern const char* qore_build_host;
DLLEXPORT extern const char* qore_mpfr_info;
DLLEXPORT bool qore_has_debug();
DLLEXPORT extern int qore_min_mod_api_major;
DLLEXPORT extern int qore_min_mod_api_minor;
DLLEXPORT extern const QoreStringMaker mpfrInfo;
#define QLO_NONE 0
#define QLO_DISABLE_SIGNAL_HANDLING (1 << 0)
#define QLO_DISABLE_OPENSSL_INIT (1 << 1)
#define QLO_DISABLE_OPENSSL_CLEANUP (1 << 2)
#define QLO_DISABLE_GARBAGE_COLLECTION (1 << 3)
#define QLO_DO_NOT_SEED_RNG (1 << 4)
#define QLO_DISABLE_TLS_13 (1 << 5)
#define QLO_RUNTIME_OPTS (QLO_DISABLE_TLS_13)
#define QLO_DISABLE_OPENSSL_INIT_CLEANUP (QLO_DISABLE_OPENSSL_INIT|QLO_DISABLE_OPENSSL_CLEANUP)
#define QLO_CLEANUP_MASK (QLO_DISABLE_OPENSSL_CLEANUP)
DLLEXPORT void qore_init(qore_license_t license = QL_GPL, const char* default_encoding = 0, bool show_module_errors = false, int init_options = QLO_NONE);
DLLEXPORT void qore_cleanup();
DLLEXPORT int qore_get_library_init_options();
DLLEXPORT int qore_set_library_cleanup_options(int options);
DLLEXPORT bool qore_check_option(int opt);
DLLEXPORT int qore_set_library_options(int opts);
DLLEXPORT int qore_get_library_options();
#include <qore/support.h>
// include private definitions if compiling the library
#ifdef _QORE_LIB_INTERN
#include "qore/intern/QoreLibIntern.h"
#endif
#endif // _QORE_QORE_H
qore_build_number
DLLEXPORT int qore_build_number
the build number of the qore library
qore_target_bits
DLLEXPORT int qore_target_bits
the build target machine word size in bits (32 or 64 normally)
qore_git_hash
DLLEXPORT const char * qore_git_hash
the git hash of the sources
qore_init
DLLEXPORT void qore_init(qore_license_t license=QL_GPL, const char *default_encoding=0, bool show_module_errors=false, int init_options=QLO_NONE)
initializes the Qore library
QoreCounter
a simple thread-safe counter object; objects can block on it until the counter reaches zero ...
Definition: QoreCounter.h:40
qore_set_library_cleanup_options
DLLEXPORT int qore_set_library_cleanup_options(int options)
the given options will be combined with binary or to the library init options; only options that affe...
thread_counter
DLLEXPORT QoreCounter thread_counter
global background thread counter (for threads started explicitly by Qore)
qore_check_option
DLLEXPORT bool qore_check_option(int opt)
returns true if all the bits set in the argument are also set in the qore library init option variabl...
qore_module_ver_dir
DLLEXPORT const char * qore_module_ver_dir
the qore version-specific module directory
qore_target_arch
DLLEXPORT const char * qore_target_arch
the build target machine architecture name
qore_set_library_options
DLLEXPORT int qore_set_library_options(int opts)
set library options at runtime
QoreReflection.h
ModuleManager.h
QoreNothingNode.h
qore_target_os
DLLEXPORT const char * qore_target_os
the build target Operating System name
QoreEncoding.h
params.h
QoreStandardException.h
qore_ldflags
DLLEXPORT const char * qore_ldflags
the linker flags used to link qore
qore_has_debug
DLLEXPORT bool qore_has_debug()
if the qore library includes debugging or not
qore_cplusplus_compiler
DLLEXPORT const char * qore_cplusplus_compiler
the c++ compiler used to build qore
qore_version_patch
DLLEXPORT int qore_version_patch
the version number below the sub version number of the qore library
DBI.h
describes Qore&#39;s DBI interface for writing database drivers
qore_version_string
DLLEXPORT const char * qore_version_string
the complete version string of the qore library
qore_version_major
DLLEXPORT int qore_version_major
the major version number of the qore library
qore_license_t
qore_license_t
qore library and module license type identifiers
Definition: common.h:85
qore_version_minor
DLLEXPORT int qore_version_minor
the minor version number of the qore library
QoreLib.h
mpfrInfo
DLLEXPORT const QoreStringMaker mpfrInfo
a string giving information about the MPFR library used by the qore library
qore_module_dir
DLLEXPORT const char * qore_module_dir
the qore module directory
QoreXSinkException.h
qore_mpfr_info
DLLEXPORT const char * qore_mpfr_info
information about the MPFR library used by the qore library
QoreNullNode.h
qore_user_module_dir
DLLEXPORT const char * qore_user_module_dir
the qore user module directory
QL_GPL
code to be used under the GPL license
Definition: common.h:86
qore_get_library_init_options
DLLEXPORT int qore_get_library_init_options()
returns the current library options
common.h
AbstractException.h
qore_min_mod_api_major
DLLEXPORT int qore_min_mod_api_major
the recommended minimum module api major number to use
qore_cleanup
DLLEXPORT void qore_cleanup()
frees all memory allocated by the library
qore_get_library_options
DLLEXPORT int qore_get_library_options()
returns library options
qore_min_mod_api_minor
DLLEXPORT int qore_min_mod_api_minor
the recommended minimum module api minor number to use
qore_user_module_ver_dir
DLLEXPORT const char * qore_user_module_ver_dir
the qore version-specific user module directory
qore_cflags
DLLEXPORT const char * qore_cflags
the compiler flags used to build qore
QLO_NONE
#define QLO_NONE
no options (default)
Definition: Qore.h:178
qore_version_sub
DLLEXPORT int qore_version_sub
the version number below the minor version number of the qore library
qore_build_host
DLLEXPORT const char * qore_build_host
information about the build host
qore_thread.h