Qore Programming Language  1.9.1
Qore.h
Go to the documentation of this file.
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  Qore.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2022 Qore Technologies, s.r.o.
8 
9  Permission is hereby granted, free of charge, to any person obtaining a
10  copy of this software and associated documentation files (the "Software"),
11  to deal in the Software without restriction, including without limitation
12  the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  and/or sell copies of the Software, and to permit persons to whom the
14  Software is furnished to do so, subject to the following conditions:
15 
16  The above copyright notice and this permission notice shall be included in
17  all copies or substantial portions of the Software.
18 
19  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25  DEALINGS IN THE SOFTWARE.
26 
27  Note that the Qore library is released under a choice of three open-source
28  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
29  information.
30 */
31 
32 #ifndef _QORE_QORE_H
33 
34 #define _QORE_QORE_H
35 
40 // include configuration first if compiling the library
41 #ifdef _QORE_LIB_INTERN
42 #include "qore/intern/config.h"
43 #endif
44 
45 #include <qore/common.h>
46 #include <qore/AbstractException.h>
49 #include <qore/QoreCounter.h>
50 
52 DLLEXPORT extern QoreCounter thread_counter;
53 
54 #include <qore/QoreEncoding.h>
55 #include <qore/ReferenceHolder.h>
56 #include <qore/QoreValue.h>
57 #include <qore/AbstractQoreNode.h>
58 #include <qore/QoreListNode.h>
59 #include <qore/TypedHashDecl.h>
60 #include <qore/QoreHashNode.h>
61 #include <qore/AbstractPrivateData.h>
62 #include <qore/QoreIteratorBase.h>
63 #include <qore/QoreObject.h>
64 #include <qore/QoreProgram.h>
65 #include <qore/QoreDebugProgram.h>
66 #include <qore/ModuleManager.h>
67 #include <qore/QoreLib.h>
68 #include <qore/QoreStringNode.h>
69 #include <qore/DateTimeNode.h>
70 #include <qore/QoreNumberNode.h>
71 #include <qore/QoreNothingNode.h>
72 #include <qore/QoreNullNode.h>
73 #include <qore/QoreNet.h>
74 #include <qore/QoreURL.h>
75 #include <qore/QoreFile.h>
76 #include <qore/QoreQueueHelper.h>
77 #include <qore/QoreRWLock.h>
78 #include <qore/QoreNamespace.h>
79 #include <qore/ExceptionSink.h>
80 #include <qore/BinaryNode.h>
81 #include <qore/QoreString.h>
82 #include <qore/DateTime.h>
83 #include <qore/QoreType.h>
84 #include <qore/qore_thread.h>
85 #include <qore/QoreThreadLock.h>
86 #include <qore/QoreThreadLocalStorage.h>
87 #include <qore/QoreCondition.h>
88 #include <qore/QoreQueue.h>
89 #include <qore/DBI.h>
90 #include <qore/Datasource.h>
91 #include <qore/SQLStatement.h>
92 #include <qore/QoreClass.h>
93 #include <qore/QoreReflection.h>
94 #include <qore/ScopeGuard.h>
95 #include <qore/SystemEnvironment.h>
96 #include <qore/AutoVLock.h>
97 #include <qore/CallReferenceNode.h>
98 #include <qore/ReferenceNode.h>
99 #include <qore/params.h>
100 #include <qore/QoreTypeSafeReferenceHelper.h>
101 #include <qore/QoreEvents.h>
102 #include <qore/UnicodeCharacterIterator.h>
103 #include <qore/qore-version.h>
104 
106 DLLEXPORT extern const char* qore_version_string;
107 
109 DLLEXPORT extern int qore_version_major;
110 
112 DLLEXPORT extern int qore_version_minor;
113 
115 DLLEXPORT extern int qore_version_sub;
116 
118 DLLEXPORT extern int qore_version_patch;
119 
121 
123 DLLEXPORT extern int qore_build_number;
124 
126 DLLEXPORT extern int qore_target_bits;
127 
129 DLLEXPORT extern const char* qore_git_hash;
130 
132 DLLEXPORT extern const char* qore_target_os;
133 
135 DLLEXPORT extern const char* qore_target_arch;
136 
138 DLLEXPORT extern const char* qore_module_dir;
139 
141 DLLEXPORT extern const char* qore_user_module_dir;
142 
144 DLLEXPORT extern const char* qore_module_ver_dir;
145 
147 DLLEXPORT extern const char* qore_user_module_ver_dir;
148 
150 DLLEXPORT extern const char* qore_cplusplus_compiler;
151 
153 DLLEXPORT extern const char* qore_cflags;
154 
156 DLLEXPORT extern const char* qore_ldflags;
157 
159 DLLEXPORT extern const char* qore_build_host;
160 
162 
164 DLLEXPORT extern const char* qore_mpfr_info;
165 
167 DLLEXPORT bool qore_has_debug();
168 
170 DLLEXPORT extern int qore_min_mod_api_major;
171 
173 DLLEXPORT extern int qore_min_mod_api_minor;
174 
176 DLLEXPORT extern const QoreStringMaker mpfrInfo;
177 
178 #define QLO_NONE 0
179 #define QLO_DISABLE_SIGNAL_HANDLING (1 << 0)
180 #define QLO_DISABLE_OPENSSL_INIT (1 << 1)
181 #define QLO_DISABLE_OPENSSL_CLEANUP (1 << 2)
182 #define QLO_DISABLE_GARBAGE_COLLECTION (1 << 3)
183 #define QLO_DO_NOT_SEED_RNG (1 << 4)
184 #define QLO_DISABLE_TLS_13 (1 << 5)
185 #define QLO_MINIMUM_TLS_13 (1 << 6)
186 
187 #define QLO_RUNTIME_OPTS (QLO_DISABLE_TLS_13)
188 
190 #define QLO_DISABLE_OPENSSL_INIT_CLEANUP (QLO_DISABLE_OPENSSL_INIT|QLO_DISABLE_OPENSSL_CLEANUP)
191 
193 #define QLO_CLEANUP_MASK (QLO_DISABLE_OPENSSL_CLEANUP)
194 
196 
205 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);
206 
208 
212 DLLEXPORT void qore_cleanup();
213 
215 
220 
222 DLLEXPORT int qore_set_library_cleanup_options(int options);
223 
225 DLLEXPORT bool qore_check_option(int opt);
226 
228 
232 DLLEXPORT int qore_set_library_options(int opts);
233 
235 
237 DLLEXPORT int qore_get_library_options();
238 
239 #include <qore/support.h>
240 
241 // include private definitions if compiling the library
242 #ifdef _QORE_LIB_INTERN
243 #include "qore/intern/QoreLibIntern.h"
244 #endif
245 
246 #endif // _QORE_QORE_H
describes Qore's DBI interface for writing database drivers
DLLEXPORT int qore_target_bits
the build target machine word size in bits (32 or 64 normally)
DLLEXPORT const char * qore_git_hash
the git hash of the sources
DLLEXPORT bool qore_has_debug()
if the qore library includes debugging or not
DLLEXPORT const char * qore_target_os
the build target Operating System name
DLLEXPORT const char * qore_module_ver_dir
the qore version-specific module directory
DLLEXPORT const char * qore_build_host
information about the build host
DLLEXPORT QoreCounter thread_counter
global background thread counter (for threads started explicitly by Qore)
DLLEXPORT const char * qore_user_module_dir
the qore user module directory
DLLEXPORT int qore_build_number
the build number of the qore library
DLLEXPORT const char * qore_ldflags
the linker flags used to link qore
DLLEXPORT int qore_get_library_init_options()
returns the current library options
DLLEXPORT int qore_version_major
the major version number of the qore library
DLLEXPORT const char * qore_target_arch
the build target machine architecture name
DLLEXPORT const char * qore_user_module_ver_dir
the qore version-specific user module directory
DLLEXPORT const QoreStringMaker mpfrInfo
a string giving information about the MPFR library used by the qore library
DLLEXPORT const char * qore_cflags
the compiler flags used to build qore
DLLEXPORT const char * qore_cplusplus_compiler
the c++ compiler used to build qore
DLLEXPORT int qore_min_mod_api_minor
the recommended minimum module api minor number to use
DLLEXPORT const char * qore_version_string
the complete version string of the qore library
DLLEXPORT int qore_get_library_options()
returns library options
#define QLO_NONE
no options (default)
Definition: Qore.h:178
DLLEXPORT void qore_cleanup()
frees all memory allocated by the library
DLLEXPORT int qore_min_mod_api_major
the recommended minimum module api major number to use
DLLEXPORT int qore_version_sub
the version number below the minor version number of the qore library
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...
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...
DLLEXPORT int qore_set_library_options(int opts)
set library options at runtime
DLLEXPORT const char * qore_module_dir
the qore module directory
DLLEXPORT const char * qore_mpfr_info
information about the MPFR library used by the qore library
DLLEXPORT int qore_version_patch
the version number below the sub version number of the qore library
DLLEXPORT int qore_version_minor
the minor version number of the qore library
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
a simple thread-safe counter object; objects can block on it until the counter reaches zero
Definition: QoreCounter.h:40
qore_license_t
qore library and module license type identifiers
Definition: common.h:85
@ QL_GPL
code to be used under the GPL license
Definition: common.h:86