include/qore/Qore.h File Reference

(3401)

#include <qore/common.h>
#include <qore/QoreEncoding.h>
#include <qore/ReferenceHolder.h>
#include <qore/AbstractQoreNode.h>
#include <qore/QoreNodeEvalOptionalRefHolder.h>
#include <qore/QoreListNode.h>
#include <qore/QoreProgram.h>
#include <qore/ModuleManager.h>
#include <qore/QoreLib.h>
#include <qore/QoreStringNode.h>
#include <qore/DateTimeNode.h>
#include <qore/QoreHashNode.h>
#include <qore/QoreBigIntNode.h>
#include <qore/QoreBoolNode.h>
#include <qore/QoreFloatNode.h>
#include <qore/QoreNothingNode.h>
#include <qore/QoreNullNode.h>
#include <qore/QoreNet.h>
#include <qore/QoreURL.h>
#include <qore/QoreFile.h>
#include <qore/AbstractPrivateData.h>
#include <qore/QoreObject.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/BuiltinFunctionList.h>
#include <qore/qore_thread.h>
#include <qore/QoreThreadLock.h>
#include <qore/QoreThreadLocalStorage.h>
#include <qore/QoreCondition.h>
#include <qore/DBI.h>
#include <qore/Datasource.h>
#include <qore/QoreClass.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/ReferenceHelper.h>
#include <qore/QoreEvents.h>
#include <qore/qore-version.h>
#include <qore/support.h>

Go to the source code of this file.

Defines

#define QLO_NONE   0
 no options (default)
#define QLO_DISABLE_SIGNAL_HANDLING   1 << 0
 disable qore signal handling entirely

Functions

DLLEXPORT bool qore_has_debug ()
 if the qore library includes debugging or not
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
DLLEXPORT void qore_cleanup ()
 frees all memory allocated by the library

Variables

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
DLLEXPORT int qore_version_minor
 the minor version number of the qore library
DLLEXPORT int qore_version_sub
 the version number below the minor version number of the qore library
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 const char * qore_target_os
 the build target Operating System name
DLLEXPORT const char * qore_target_arch
 the build target machine architecture name
DLLEXPORT const char * qore_module_dir
 the qore module directory
DLLEXPORT const char * qore_cplusplus_compiler
 the c++ compiler used to build qore
DLLEXPORT const char * qore_cflags
 the compiler flags used to build qore
DLLEXPORT const char * qore_ldflags
 the linker flags used to link qore
DLLEXPORT const char * qore_build_host
 information about the build host


Detailed Description

the main header file for the Qore library. All code using any part of the Qore library's functionality should include this file

Function Documentation

DLLEXPORT void qore_cleanup (  ) 

frees all memory allocated by the library

Note:
The openssl and libxml2 libraries are cleaned up as well

This function can only be called once and should be called when a program using the Qore library terminates.

See also:
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

Parameters:
license the license that the library will be used under; note that if the license type is QL_LGPL, then modules tagged with QL_GPL cannot be loaded
default_encoding the default character encoding for the library, if 0 then the environment variables QORE_CHARSET and LANG will be processed, in that order, to determine the default character encoding. If no character encoding can be determined from either of these environment variables, UTF-8 will be used as the default.
show_module_errors if true then any errors loading qore modules will be output to stdout
init_options a binary "or" sum of the qore library options
Note:
The openssl and libxml2 libraries are also initialized in this function.

This function can only be called once and must be called before any other qore facilities are used.

The license value must be QL_LGPL unless the program using Qore is a GPL program, in which case QL_GPL may be used (the default)

See also:
qore_cleanup()


doxygen