options.h File Reference

Go to the source code of this file.

Classes

struct  Zorba_CompilerHints
 Set of hints that can be passed to the query compiler. More...
struct  Zorba_SerializerOptions
 Options that configure the serialization process of a query result. More...

Typedefs

typedef struct Zorba_CompilerHints Zorba_CompilerHints_t
typedef struct
Zorba_SerializerOptions 
Zorba_SerializerOptions_t

Enumerations

enum  Zorba_byte_order_mark_t { ZORBA_BYTE_ORDER_MARK_YES, ZORBA_BYTE_ORDER_MARK_NO }
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_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 }
 The optimization level used for optimizing the query. More...
enum  Zorba_serialization_method_t { ZORBA_SERIALIZATION_METHOD_XML, ZORBA_SERIALIZATION_METHOD_HTML }
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_CompilerHints_t Zorba_CompilerHints_default ()
 Helper function for C to create a Zorba_CompilerHints_t struct because of missing default constructor.
Zorba_SerializerOptions_t Zorba_SerializerOptions_default ()
 Helper function for C to create a Zorba_SerializerOptions_t struct because of missing default constructor.


Typedef Documentation

typedef struct Zorba_CompilerHints Zorba_CompilerHints_t

typedef struct Zorba_SerializerOptions Zorba_SerializerOptions_t


Enumeration Type Documentation

enum Zorba_byte_order_mark_t

Enumerator:
ZORBA_BYTE_ORDER_MARK_YES 
ZORBA_BYTE_ORDER_MARK_NO 

Definition at line 56 of file options.h.

enum Zorba_escape_uri_attributes_t

Enumerator:
ZORBA_ESCAPE_URI_ATTRIBUTES_YES 
ZORBA_ESCAPE_URI_ATTRIBUTES_NO 

Definition at line 61 of file options.h.

enum Zorba_include_content_type_t

Enumerator:
ZORBA_INCLUDE_CONTENT_TYPE_YES 
ZORBA_INCLUDE_CONTENT_TYPE_NO 

Definition at line 66 of file options.h.

enum Zorba_indent_t

Enumerator:
ZORBA_INDENT_YES 
ZORBA_INDENT_NO 

Definition at line 71 of file options.h.

enum Zorba_normalization_form_t

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 76 of file options.h.

enum Zorba_omit_xml_declaration_t

Enumerator:
ZORBA_OMIT_XML_DECLARATION_YES 
ZORBA_OMIT_XML_DECLARATION_NO 

Definition at line 85 of file options.h.

enum Zorba_opt_level_t

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).

Definition at line 20 of file options.h.

enum Zorba_serialization_method_t

Enumerator:
ZORBA_SERIALIZATION_METHOD_XML 
ZORBA_SERIALIZATION_METHOD_HTML 

Definition at line 51 of file options.h.

enum Zorba_standalone_t

Enumerator:
ZORBA_STANDALONE_YES 
ZORBA_STANDALONE_NO 
ZORBA_STANDALONE_OMIT 

Definition at line 90 of file options.h.

enum Zorba_undeclare_prefixes_t

Enumerator:
ZORBA_UNDECLARE_PREFIXES_YES 
ZORBA_UNDECLARE_PREFIXES_NO 

Definition at line 96 of file options.h.


Function Documentation

Zorba_CompilerHints_t Zorba_CompilerHints_default (  ) 

Helper function for C to create a Zorba_CompilerHints_t struct because of missing default constructor.

Return values:
Zorba_CompilerHints_t with default member values

Zorba_SerializerOptions_t Zorba_SerializerOptions_default (  ) 

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

Return values:
Zorba_CompilerHints_t with default member values