Qore Programming Language  0.8.11
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 2003 - 2013 David Nichols
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23 
24 #ifndef _QORE_QORE_H
25 
26 #define _QORE_QORE_H
27 
32 // include configuration first if compiling the library
33 #ifdef _QORE_LIB_INTERN
34 #include <qore/intern/config.h>
35 #endif
36 
37 #include <qore/common.h>
38 #include <qore/QoreCounter.h>
39 
41 DLLEXPORT extern QoreCounter thread_counter;
42 
43 #include <qore/QoreEncoding.h>
44 #include <qore/ReferenceHolder.h>
45 #include <qore/AbstractQoreNode.h>
46 #include <qore/QoreNodeEvalOptionalRefHolder.h>
47 #include <qore/QoreListNode.h>
48 #include <qore/QoreHashNode.h>
49 #include <qore/AbstractPrivateData.h>
50 #include <qore/QoreIteratorBase.h>
51 #include <qore/QoreObject.h>
52 #include <qore/QoreProgram.h>
53 #include <qore/ModuleManager.h>
54 #include <qore/QoreLib.h>
55 #include <qore/QoreStringNode.h>
56 #include <qore/DateTimeNode.h>
57 #include <qore/QoreBigIntNode.h>
58 #include <qore/QoreBoolNode.h>
59 #include <qore/QoreFloatNode.h>
60 #include <qore/QoreNumberNode.h>
61 #include <qore/QoreNothingNode.h>
62 #include <qore/QoreNullNode.h>
63 #include <qore/QoreNet.h>
64 #include <qore/QoreURL.h>
65 #include <qore/QoreFile.h>
66 #include <qore/QoreQueueHelper.h>
67 #include <qore/QoreRWLock.h>
68 #include <qore/QoreNamespace.h>
69 #include <qore/ExceptionSink.h>
70 #include <qore/BinaryNode.h>
71 #include <qore/QoreString.h>
72 #include <qore/DateTime.h>
73 #include <qore/QoreType.h>
75 #include <qore/qore_thread.h>
76 #include <qore/QoreThreadLock.h>
77 #include <qore/QoreThreadLocalStorage.h>
78 #include <qore/QoreCondition.h>
79 #include <qore/QoreQueue.h>
80 #include <qore/DBI.h>
81 #include <qore/Datasource.h>
82 #include <qore/SQLStatement.h>
83 #include <qore/QoreClass.h>
84 #include <qore/ScopeGuard.h>
85 #include <qore/SystemEnvironment.h>
86 #include <qore/AutoVLock.h>
87 #include <qore/CallReferenceNode.h>
88 #include <qore/ReferenceNode.h>
89 #include <qore/params.h>
90 #include <qore/QoreTypeSafeReferenceHelper.h>
91 #include <qore/QoreEvents.h>
92 #include <qore/qore-version.h>
93 
95 DLLEXPORT extern const char* qore_version_string;
96 
98 DLLEXPORT extern int qore_version_major;
99 
101 DLLEXPORT extern int qore_version_minor;
102 
104 DLLEXPORT extern int qore_version_sub;
105 
107 DLLEXPORT extern int qore_build_number;
108 
110 DLLEXPORT extern int qore_target_bits;
111 
113 DLLEXPORT extern const char* qore_target_os;
114 
116 DLLEXPORT extern const char* qore_target_arch;
117 
119 DLLEXPORT extern const char* qore_module_dir;
120 
122 DLLEXPORT extern const char* qore_cplusplus_compiler;
123 
125 DLLEXPORT extern const char* qore_cflags;
126 
128 DLLEXPORT extern const char* qore_ldflags;
129 
131 DLLEXPORT extern const char* qore_build_host;
132 
134 
136 DLLEXPORT extern const char* qore_mpfr_info;
137 
139 DLLEXPORT bool qore_has_debug();
140 
142 DLLEXPORT extern int qore_min_mod_api_major;
143 
145 DLLEXPORT extern int qore_min_mod_api_minor;
146 
148 DLLEXPORT extern const QoreStringMaker mpfrInfo;
149 
150 #define QLO_NONE 0
151 #define QLO_DISABLE_SIGNAL_HANDLING (1 << 0)
152 #define QLO_DISABLE_OPENSSL_INIT (1 << 1)
153 #define QLO_DISABLE_OPENSSL_CLEANUP (1 << 2)
154 
155 #define QLO_DISABLE_OPENSSL_INIT_CLEANUP (QLO_DISABLE_OPENSSL_INIT|QLO_DISABLE_OPENSSL_CLEANUP)
157 
159 #define QLO_CLEANUP_MASK (QLO_DISABLE_OPENSSL_CLEANUP)
160 
162 
171 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);
172 
174 
178 DLLEXPORT void qore_cleanup();
179 
181 
185 DLLEXPORT int qore_get_library_init_options();
186 
188 DLLEXPORT int qore_set_library_cleanup_options(int options);
189 
191 DLLEXPORT bool qore_check_option(int opt);
192 
193 #include <qore/support.h>
194 
195 // include private definitions if compiling the library
196 #ifdef _QORE_LIB_INTERN
197 #include <qore/intern/QoreLibIntern.h>
198 #endif
199 
200 #endif // _QORE_QORE_H
DLLEXPORT int qore_build_number
the build number of the qore library
DLLEXPORT int qore_target_bits
the build target machine word size in bits (32 or 64 normally)
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:32
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 QoreCounter thread_counter
global background thread counter (for threads started explicitly by Qore)
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 const char * qore_target_arch
the build target machine architecture name
DLLEXPORT const char * qore_target_os
the build target Operating System name
DLLEXPORT const char * qore_ldflags
the linker flags used to link qore
DLLEXPORT bool qore_has_debug()
if the qore library includes debugging or not
DLLEXPORT const char * qore_cplusplus_compiler
the c++ compiler used to build qore
describes Qore's DBI interface for writing database drivers
DLLEXPORT const char * qore_version_string
the complete version string of the qore library
DLLEXPORT int qore_version_major
the major version number of the qore library
qore_license_t
qore library and module license type identifiers
Definition: common.h:74
DLLEXPORT int qore_version_minor
the minor version number of the qore library
DLLEXPORT const QoreStringMaker mpfrInfo
a string giving information about the MPFR library used by the qore library
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
code to be used under the GPL license
Definition: common.h:75
DLLEXPORT int qore_get_library_init_options()
returns the current library options
DLLEXPORT int qore_min_mod_api_major
the recommended minimum module api major number to use
DLLEXPORT void qore_cleanup()
frees all memory allocated by the library
DLLEXPORT int qore_min_mod_api_minor
the recommended minimum module api minor number to use
DLLEXPORT const char * qore_cflags
the compiler flags used to build qore
#define QLO_NONE
no options (default)
Definition: Qore.h:150
DLLEXPORT int qore_version_sub
the version number below the minor version number of the qore library
DLLEXPORT const char * qore_build_host
information about the build host