zorbac.h File Reference

#include <stdio.h>
#include <zorba/error.h>
#include <zorba/static_context_consts.h>
#include <zorba/options.h>

Go to the source code of this file.

Data Structures

struct  XQC_Collection_s
 A Collection is a sequence of Node Items. More...
struct  XQC_DataManager_s
 Using the XmlDataManager one can manage documents and collections. More...
struct  XQC_DynamicContext_s
 An object of the type XQC_DynamicContext contains the information that is available at the time the query is executed. More...
struct  XQC_ErrorHandler_s
 The XQC_ErrorHandler struct is designed to be populated by users for the purpose of collecting more detailed error messages from an XQC implementation. More...
struct  XQC_Implementation_s
 The XQC_Implementation struct provides factory functions for parsing queries. More...
struct  XQC_InputStream_s
 The XQC_InputStream struct is designed to be populated by users for the purpose of streaming data into an XQC implementation. More...
struct  XQC_Item_s
 This struct is Zorba's representation of an Item as defined in the XQuery 1.0 and XPath 2.0 Data Model (XDM); see http://www.w3.org/TR/xpath-datamodel/. More...
struct  XQC_ItemFactory_s
 An instance of this class can be obtained by calling item_factory function of an XQC_Implementation object. More...
struct  XQC_OutputStream_s
 The XQC_OutputStream struct is designed to be passed to an XQC implementation in order to return streaming data (i.e. More...
struct  XQC_Query_s
 The XQC_Expression struct represents a pre-parsed query, and allows the user to execute that query any number of times. More...
struct  XQC_Sequence_s
 This struct represents an instance of the XQuery 1.0 and XPath 2.0 Data Model (XDM). More...
struct  XQC_StaticContext_s
 The XQC_StaticContext struct provides a way to specify values for the static context of the query to be prepared. More...

Typedefs

typedef void(* external_function_init )(void **user_data, void *global_user_data)
typedef XQUERY_ERROR(* external_function_next )(XQC_Sequence args, int argc, XQC_Item_Ref result, void *user_data, void *global_user_data)
typedef void(* external_function_release )(void *user_data, void *global_user_data)
typedef struct XQC_Collection_sXQC_Collection
typedef XQC_CollectionXQC_Collection_Ref
typedef struct XQC_DataManager_sXQC_DataManager
typedef XQC_DataManagerXQC_DataManager_Ref
typedef struct
XQC_DynamicContext_s
XQC_DynamicContext
typedef XQC_DynamicContextXQC_DynamicContext_Ref
typedef struct XQC_ErrorHandler_sXQC_ErrorHandler
typedef struct
XQC_Implementation_s
XQC_Implementation
typedef XQC_ImplementationXQC_Implementation_Ref
typedef struct XQC_InputStream_sXQC_InputStream
typedef struct XQC_Item_sXQC_Item
typedef XQC_ItemXQC_Item_Ref
typedef struct XQC_ItemFactory_sXQC_ItemFactory
typedef XQC_ItemFactoryXQC_ItemFactory_Ref
typedef struct XQC_OutputStream_sXQC_OutputStream
typedef struct XQC_Query_sXQC_Query
typedef XQC_QueryXQC_Query_Ref
typedef struct XQC_Sequence_sXQC_Sequence
typedef XQC_SequenceXQC_Sequence_Ref
typedef struct
XQC_StaticContext_s
XQC_StaticContext
typedef XQC_StaticContextXQC_StaticContext_Ref

Functions

XQUERY_ERROR zorba_implementation (XQC_Implementation_Ref impl, void *store)
 The zorba_implementation function creates a new XQC_Implementation object.


Typedef Documentation

typedef void(* external_function_init)(void **user_data, void *global_user_data)

Definition at line 57 of file zorbac.h.

typedef XQUERY_ERROR(* external_function_next)(XQC_Sequence args, int argc, XQC_Item_Ref result, void *user_data, void *global_user_data)

Definition at line 59 of file zorbac.h.

typedef void(* external_function_release)(void *user_data, void *global_user_data)

Definition at line 65 of file zorbac.h.

typedef struct XQC_Collection_s* XQC_Collection

Definition at line 45 of file zorbac.h.

typedef XQC_Collection* XQC_Collection_Ref

Definition at line 46 of file zorbac.h.

typedef struct XQC_DataManager_s* XQC_DataManager

Definition at line 48 of file zorbac.h.

typedef XQC_DataManager* XQC_DataManager_Ref

Definition at line 49 of file zorbac.h.

typedef struct XQC_DynamicContext_s* XQC_DynamicContext

Definition at line 33 of file zorbac.h.

typedef XQC_DynamicContext* XQC_DynamicContext_Ref

Definition at line 34 of file zorbac.h.

typedef struct XQC_ErrorHandler_s* XQC_ErrorHandler

Definition at line 53 of file zorbac.h.

typedef struct XQC_Implementation_s* XQC_Implementation

Definition at line 24 of file zorbac.h.

typedef XQC_Implementation* XQC_Implementation_Ref

Definition at line 25 of file zorbac.h.

typedef struct XQC_InputStream_s* XQC_InputStream

Definition at line 52 of file zorbac.h.

typedef struct XQC_Item_s* XQC_Item

Definition at line 39 of file zorbac.h.

typedef XQC_Item* XQC_Item_Ref

Definition at line 40 of file zorbac.h.

typedef struct XQC_ItemFactory_s* XQC_ItemFactory

Definition at line 42 of file zorbac.h.

typedef XQC_ItemFactory* XQC_ItemFactory_Ref

Definition at line 43 of file zorbac.h.

typedef struct XQC_OutputStream_s* XQC_OutputStream

Definition at line 51 of file zorbac.h.

typedef struct XQC_Query_s* XQC_Query

Definition at line 27 of file zorbac.h.

typedef XQC_Query* XQC_Query_Ref

Definition at line 28 of file zorbac.h.

typedef struct XQC_Sequence_s* XQC_Sequence

Definition at line 36 of file zorbac.h.

typedef XQC_Sequence* XQC_Sequence_Ref

Definition at line 37 of file zorbac.h.

typedef struct XQC_StaticContext_s* XQC_StaticContext

Definition at line 30 of file zorbac.h.

typedef XQC_StaticContext* XQC_StaticContext_Ref

Definition at line 31 of file zorbac.h.


Function Documentation

XQUERY_ERROR zorba_implementation ( XQC_Implementation_Ref  impl,
void *  store 
)

The zorba_implementation function creates a new XQC_Implementation object.

Thereby, the Zorba processor is initialized. The user is responsible for freeing the object by calling the free() function of the XQC_Implementation struct.

Parameters:
store A pointer to the store that is being used by the Zorba instance that is created by this call.
[out] impl The newly created XQC_Implementation object.
Return values:
XQC_NO_ERROR 
XQP0019_INTERNAL_ERROR 
Examples:
ccontext.c, cdatamanager.c, cerror.c, cexternal_functions.c, cserialization.c, and csimple.c.