options.h

#include <zorba/config.h>

Type Definitions

struct Zorba_CompilerHints

Zorba_CompilerHints_t

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

struct Zorba_opaque_char_ptr

Zorba_opaque_char_ptr_t

Wraps a char* to make it a compile-time error to assign to the pointer directly.

char

Zorba_opt_bool_t

struct ZORBA_DLL_PUBLIC Zorba_SerializerOptions

Zorba_SerializerOptions_t

Options that configure the serialization process of a query result.

Functions

ZORBA_DLL_PUBLIC void

Zorba_CompilerHints_default(Zorba_CompilerHints_t *)

Helper function for C to set default values ComplilerHints struct.

ZORBA_DLL_PUBLIC void

Zorba_SerializerOptions_free(Zorba_SerializerOptions_t *opts)

Frees all internal data used by a Zorba_SerializerOptions.

ZORBA_DLL_PUBLIC void

Zorba_SerializerOptions_init(Zorba_SerializerOptions_t *opts)

Initializes a Zorba_SerializerOptions.

ZORBA_DLL_PUBLIC Zorba_opt_bool_t

Zorba_SerializerOptions_set(Zorba_SerializerOptions_t *opts, char const *option, char const *value)

Sets an option in a Zorba_SerializerOptions.

Enumerations

Zorba_byte_order_mark_t

 Zorba_byte_order_mark_t

Zorba_escape_uri_attributes_t

 Zorba_escape_uri_attributes_t

Zorba_include_content_type_t

 Zorba_include_content_type_t

Zorba_indent_t

 Zorba_indent_t

Zorba_jsoniq_extensions_t

 Zorba_jsoniq_extensions_t

Zorba_jsoniq_multiple_items_t

 Zorba_jsoniq_multiple_items_t

Zorba_normalization_form_t

 Zorba_normalization_form_t

Zorba_omit_xml_declaration_t

 Zorba_omit_xml_declaration_t

Zorba_opt_level_t

 Zorba_opt_level_t

The optimization level used for optimizing the query.

Zorba_save_plan_options_t

 Zorba_save_plan_options_t

Zorba_serialization_method_t

 Zorba_serialization_method_t

Zorba_standalone_t

 Zorba_standalone_t

Zorba_undeclare_prefixes_t

 Zorba_undeclare_prefixes_t

Type Definitions

Zorba_CompilerHints_t

struct Zorba_CompilerHints Zorba_CompilerHints_t

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.

Zorba_opaque_char_ptr_t

struct Zorba_opaque_char_ptr Zorba_opaque_char_ptr_t

Wraps a char* to make it a compile-time error to assign to the pointer directly.

Zorba_opt_bool_t

char Zorba_opt_bool_t

Zorba_SerializerOptions_t

struct ZORBA_DLL_PUBLIC Zorba_SerializerOptions Zorba_SerializerOptions_t

Options that configure the serialization process of a query result.

See http://www.w3.org/TR/2005/CR-xslt-xquery-serialization-20051103/.This struct defines options that can be passed to the serialization process of a query result. An instance of this class can be passed to the serialize function.File serialization.cpp contains examples that show how to use the SerializerOptions.

Functions

Zorba_CompilerHints_default

ZORBA_DLL_PUBLIC void Zorba_CompilerHints_default(Zorba_CompilerHints_t *)

Helper function for C to set default values ComplilerHints struct.

Parameters

Zorba_CompilerHints_t with default member values

Zorba_SerializerOptions_free

ZORBA_DLL_PUBLIC void Zorba_SerializerOptions_free(Zorba_SerializerOptions_t *opts)

Frees all internal data used by a Zorba_SerializerOptions.

This is needed only in C code; C++ code calls the destructor. Note that this does not free opts itself (which may be on the stack).

Parameters

opts The Zorba_SerializerOptions to be freed.

Zorba_SerializerOptions_init

ZORBA_DLL_PUBLIC void Zorba_SerializerOptions_init(Zorba_SerializerOptions_t *opts)

Initializes a Zorba_SerializerOptions.

This is needed only in C code; C++ code calls the default constructor.

Parameters

opts The Zorba_SerializerOptions to be initialized.

Zorba_SerializerOptions_set

ZORBA_DLL_PUBLIC Zorba_opt_bool_t Zorba_SerializerOptions_set(Zorba_SerializerOptions_t *opts, char const *option, char const *value)

Sets an option in a Zorba_SerializerOptions.

Parameters

opts The Zorba_SerializerOptions to affect.
option The name of the option to be set.
value The option's new value.

Returns

true only if all the arguments were valid; false otherwise.