Classes | Typedefs | Enumerations | Functions
options.h File Reference
#include <zorba/config.h>
Include dependency graph for options.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  Zorba_CompilerHints
 Set of hints that can be passed to the query compiler. More...
 

Typedefs

typedef struct Zorba_CompilerHints Zorba_CompilerHints_t
 Set of hints that can be passed to the query compiler. More...
 
typedef struct
Zorba_SerializerOptions 
Zorba_SerializerOptions_t
 

Enumerations

enum  bool { false = 0, true = 1 }
 
enum  Zorba_binary_plan_format_t { ZORBA_USE_BINARY_ARCHIVE, ZORBA_USE_XML_ARCHIVE }
 
enum  Zorba_byte_order_mark_t { ZORBA_BYTE_ORDER_MARK_YES, ZORBA_BYTE_ORDER_MARK_NO }
 
enum  Zorba_encoding_t { ZORBA_ENCODING_UTF8, ZORBA_ENCODING_UTF16 }
 
enum  Zorba_escape_uri_attributes_t { ZORBA_ESCAPE_URI_ATTRIBUTES_YES, ZORBA_ESCAPE_URI_ATTRIBUTES_NO }
 
enum  Zorba_include_content_type_t { ZORBA_INCLUDE_CONTENT_TYPE_YES, ZORBA_INCLUDE_CONTENT_TYPE_NO }
 
enum  Zorba_indent_t { ZORBA_INDENT_YES, ZORBA_INDENT_NO }
 
enum  Zorba_jsoniq_extensions_t { JSONIQ_EXTENSIONS_YES, JSONIQ_EXTENSIONS_NO }
 
enum  Zorba_jsoniq_multiple_items_t { JSONIQ_MULTIPLE_ITEMS_NO, JSONIQ_MULTIPLE_ITEMS_YES }
 
enum  Zorba_normalization_form_t {
  ZORBA_NORMALIZATION_FORM_NFC, ZORBA_NORMALIZATION_FORM_NFD, ZORBA_NORMALIZATION_FORM_NFKC, ZORBA_NORMALIZATION_FORM_NFKD,
  ZORBA_NORMALIZATION_FORM_FULLY_normalized, ZORBA_NORMALIZATION_FORM_NONE
}
 
enum  Zorba_omit_xml_declaration_t { ZORBA_OMIT_XML_DECLARATION_YES, ZORBA_OMIT_XML_DECLARATION_NO }
 
enum  Zorba_opt_level_t { ZORBA_OPT_LEVEL_O0, ZORBA_OPT_LEVEL_O1, ZORBA_OPT_LEVEL_O2 }
 The optimization level used for optimizing the query. More...
 
enum  Zorba_save_plan_options_t { DONT_SAVE_UNUSED_FUNCTIONS = 0, SAVE_UNUSED_FUNCTIONS = 1 }
 
enum  Zorba_serialization_method_t {
  ZORBA_SERIALIZATION_METHOD_XML, ZORBA_SERIALIZATION_METHOD_HTML, ZORBA_SERIALIZATION_METHOD_XHTML, ZORBA_SERIALIZATION_METHOD_TEXT,
  ZORBA_SERIALIZATION_METHOD_BINARY
}
 
enum  Zorba_standalone_t { ZORBA_STANDALONE_YES, ZORBA_STANDALONE_NO, ZORBA_STANDALONE_OMIT }
 
enum  Zorba_undeclare_prefixes_t { ZORBA_UNDECLARE_PREFIXES_YES, ZORBA_UNDECLARE_PREFIXES_NO }
 

Functions

ZORBA_DLL_PUBLIC void Zorba_CompilerHints_default (Zorba_CompilerHints_t *)
 Helper function for C to set default values ComplilerHints struct. More...
 
ZORBA_DLL_PUBLIC
Zorba_SerializerOptions_t
Zorba_SerializerOptions_default ()
 Helper function to create a Zorba_SerializerOptions_t struct because of missing default constructor. More...
 
ZORBA_DLL_PUBLIC void Zorba_SerializerOptions_free (Zorba_SerializerOptions_t *serializerOptions)
 Helper function to delete a Zorba_SerializerOptions_t struct. More...
 
ZORBA_DLL_PUBLIC void Zorba_SerializerOptions_set (Zorba_SerializerOptions_t *serializerOptions, const char *parameter, const char *value)
 Helper function to set an option in a Zorba_SerializerOptions_t structure. More...
 

Typedef Documentation

Set of hints that can be passed to the query compiler.

An instance of this class can be passed to the compileQuery function of the Zorba class or the compile function of this class. The members of this class represent hints that are passed to the query compiler. For example, whether optimization of the query should be done (O1) or not (O0).

example_6 in file simple.cpp shows an example how CompilerHints can be used.

typedef struct Zorba_SerializerOptions Zorba_SerializerOptions_t

Definition at line 239 of file options.h.

Enumeration Type Documentation

enum bool
Enumerator
false 
true 

Definition at line 40 of file options.h.

Enumerator
ZORBA_USE_BINARY_ARCHIVE 
ZORBA_USE_XML_ARCHIVE 

Definition at line 147 of file options.h.

Enumerator
ZORBA_BYTE_ORDER_MARK_YES 
ZORBA_BYTE_ORDER_MARK_NO 

Definition at line 94 of file options.h.

Enumerator
ZORBA_ENCODING_UTF8 
ZORBA_ENCODING_UTF16 

Definition at line 142 of file options.h.

Enumerator
ZORBA_ESCAPE_URI_ATTRIBUTES_YES 
ZORBA_ESCAPE_URI_ATTRIBUTES_NO 

Definition at line 101 of file options.h.

Enumerator
ZORBA_INCLUDE_CONTENT_TYPE_YES 
ZORBA_INCLUDE_CONTENT_TYPE_NO 

Definition at line 107 of file options.h.

Enumerator
ZORBA_INDENT_YES 
ZORBA_INDENT_NO 

Definition at line 112 of file options.h.

Enumerator
JSONIQ_EXTENSIONS_YES 
JSONIQ_EXTENSIONS_NO 

Definition at line 157 of file options.h.

Enumerator
JSONIQ_MULTIPLE_ITEMS_NO 
JSONIQ_MULTIPLE_ITEMS_YES 

Definition at line 162 of file options.h.

Enumerator
ZORBA_NORMALIZATION_FORM_NFC 
ZORBA_NORMALIZATION_FORM_NFD 
ZORBA_NORMALIZATION_FORM_NFKC 
ZORBA_NORMALIZATION_FORM_NFKD 
ZORBA_NORMALIZATION_FORM_FULLY_normalized 
ZORBA_NORMALIZATION_FORM_NONE 

Definition at line 117 of file options.h.

Enumerator
ZORBA_OMIT_XML_DECLARATION_YES 
ZORBA_OMIT_XML_DECLARATION_NO 

Definition at line 126 of file options.h.

The optimization level used for optimizing the query.

Enumerator
ZORBA_OPT_LEVEL_O0 

Don't use any optimization.

ZORBA_OPT_LEVEL_O1 

Use basic optimizations (e.g. removing sorting, removing duplicate elimination, or constant folding).

ZORBA_OPT_LEVEL_O2 

Use basic optimizations (like O1) and some more optimizations (like not to generate an iterator for inlined functions) - call stacks in case of an exception are not generated.

Definition at line 27 of file options.h.

Enumerator
DONT_SAVE_UNUSED_FUNCTIONS 
SAVE_UNUSED_FUNCTIONS 

Definition at line 152 of file options.h.

Enumerator
ZORBA_SERIALIZATION_METHOD_XML 
ZORBA_SERIALIZATION_METHOD_HTML 
ZORBA_SERIALIZATION_METHOD_XHTML 
ZORBA_SERIALIZATION_METHOD_TEXT 
ZORBA_SERIALIZATION_METHOD_BINARY 

Definition at line 80 of file options.h.

Enumerator
ZORBA_STANDALONE_YES 
ZORBA_STANDALONE_NO 
ZORBA_STANDALONE_OMIT 

Definition at line 131 of file options.h.

Enumerator
ZORBA_UNDECLARE_PREFIXES_YES 
ZORBA_UNDECLARE_PREFIXES_NO 

Definition at line 137 of file options.h.

Function Documentation

ZORBA_DLL_PUBLIC void Zorba_CompilerHints_default ( Zorba_CompilerHints_t )

Helper function for C to set default values ComplilerHints struct.

Return values
Zorba_CompilerHints_twith default member values
ZORBA_DLL_PUBLIC Zorba_SerializerOptions_t* Zorba_SerializerOptions_default ( )

Helper function to create a Zorba_SerializerOptions_t struct because of missing default constructor.

C++ code can delete the returned Zorba_SerializerOptions_t* struct, while C code must call Zorba_SerializerOptions_free().

Return values
Zorba_CompilerHints_twith default member values
ZORBA_DLL_PUBLIC void Zorba_SerializerOptions_free ( Zorba_SerializerOptions_t serializerOptions)

Helper function to delete a Zorba_SerializerOptions_t struct.

Return values
Zorba_CompilerHints_twith default member values
ZORBA_DLL_PUBLIC void Zorba_SerializerOptions_set ( Zorba_SerializerOptions_t serializerOptions,
const char *  parameter,
const char *  value 
)

Helper function to set an option in a Zorba_SerializerOptions_t structure.

Parameters
serializerOptionsserializer options
parameterthe serializer parameter to be configured
valuethe value to which the parameter should be set
Return values
Zorba_CompilerHints_twith default member values