Qore Programming Language  0.8.8
 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/QoreObject.h>
51 #include <qore/QoreProgram.h>
52 #include <qore/ModuleManager.h>
53 #include <qore/QoreLib.h>
54 #include <qore/QoreStringNode.h>
55 #include <qore/DateTimeNode.h>
56 #include <qore/QoreBigIntNode.h>
57 #include <qore/QoreBoolNode.h>
58 #include <qore/QoreFloatNode.h>
59 #include <qore/QoreNumberNode.h>
60 #include <qore/QoreNothingNode.h>
61 #include <qore/QoreNullNode.h>
62 #include <qore/QoreNet.h>
63 #include <qore/QoreURL.h>
64 #include <qore/QoreFile.h>
65 #include <qore/QoreQueueHelper.h>
66 #include <qore/QoreRWLock.h>
67 #include <qore/QoreNamespace.h>
68 #include <qore/ExceptionSink.h>
69 #include <qore/BinaryNode.h>
70 #include <qore/QoreString.h>
71 #include <qore/DateTime.h>
72 #include <qore/QoreType.h>
74 #include <qore/qore_thread.h>
75 #include <qore/QoreThreadLock.h>
76 #include <qore/QoreThreadLocalStorage.h>
77 #include <qore/QoreCondition.h>
78 #include <qore/DBI.h>
79 #include <qore/Datasource.h>
80 #include <qore/SQLStatement.h>
81 #include <qore/QoreClass.h>
82 #include <qore/ScopeGuard.h>
83 #include <qore/SystemEnvironment.h>
84 #include <qore/AutoVLock.h>
85 #include <qore/CallReferenceNode.h>
86 #include <qore/ReferenceNode.h>
87 #include <qore/params.h>
88 #include <qore/QoreTypeSafeReferenceHelper.h>
89 #include <qore/QoreEvents.h>
90 #include <qore/qore-version.h>
91 
93 DLLEXPORT extern const char* qore_version_string;
94 
96 DLLEXPORT extern int qore_version_major;
97 
99 DLLEXPORT extern int qore_version_minor;
100 
102 DLLEXPORT extern int qore_version_sub;
103 
105 DLLEXPORT extern int qore_build_number;
106 
108 DLLEXPORT extern int qore_target_bits;
109 
111 DLLEXPORT extern const char* qore_target_os;
112 
114 DLLEXPORT extern const char* qore_target_arch;
115 
117 DLLEXPORT extern const char* qore_module_dir;
118 
120 DLLEXPORT extern const char* qore_cplusplus_compiler;
121 
123 DLLEXPORT extern const char* qore_cflags;
124 
126 DLLEXPORT extern const char* qore_ldflags;
127 
129 DLLEXPORT extern const char* qore_build_host;
130 
132 
134 DLLEXPORT extern const char* qore_mpfr_info;
135 
137 DLLEXPORT bool qore_has_debug();
138 
140 DLLEXPORT extern int qore_min_mod_api_major;
141 
143 DLLEXPORT extern int qore_min_mod_api_minor;
144 
146 DLLEXPORT extern const QoreStringMaker mpfrInfo;
147 
148 #define QLO_NONE 0
149 #define QLO_DISABLE_SIGNAL_HANDLING (1 << 0)
150 #define QLO_DISABLE_OPENSSL_INIT (1 << 1)
151 #define QLO_DISABLE_OPENSSL_CLEANUP (1 << 2)
152 
153 #define QLO_DISABLE_OPENSSL_INIT_CLEANUP (QLO_DISABLE_OPENSSL_INIT|QLO_DISABLE_OPENSSL_CLEANUP)
155 
157 #define QLO_CLEANUP_MASK (QLO_DISABLE_OPENSSL_CLEANUP)
158 
160 
169 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);
170 
172 
176 DLLEXPORT void qore_cleanup();
177 
179 
183 DLLEXPORT int qore_get_library_init_options();
184 
186 DLLEXPORT int qore_set_library_cleanup_options(int options);
187 
189 DLLEXPORT bool qore_check_option(int opt);
190 
191 #include <qore/support.h>
192 
193 // include private definitions if compiling the library
194 #ifdef _QORE_LIB_INTERN
195 #include <qore/intern/QoreLibIntern.h>
196 #endif
197 
198 #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&#39;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:73
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:74
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:148
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