SourceForge.net Logo
xqc.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008, Matthias Brantner, John Snelson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the developers nor the names of contributors may be
14  * used to endorse or promote products derived from this software without
15  * specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef _XQUERY_C_API_H
31 #define _XQUERY_C_API_H
32 
33 /* Include stdio for FILE */
34 #include <stdio.h>
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
41 #define XQC_VERSION_NUMBER 1
42 
50 
55 typedef enum {
62 
65 
70 
75 } XQC_Error;
76 
88  const char *encoding;
89 
93  void *user_data;
94 
108  unsigned int (*read)(XQC_InputStream *stream, void *buffer, unsigned int length);
109 
116  void (*free)(XQC_InputStream *stream);
117 };
118 
132 
136  void *user_data;
137 
156  void (*error)(XQC_ErrorHandler *handler, XQC_Error error, const char *error_uri,
157  const char *error_localname, const char *description, XQC_Sequence *error_object);
158 };
159 
160 typedef enum {
162 
170 
194 
195 } XQC_ItemType;
196 
208 
226 
244  XQC_Error (*prepare)(XQC_Implementation *implementation, const char *string,
245  const XQC_StaticContext *context, XQC_Expression **expression);
246 
266  XQC_Error (*prepare_file)(XQC_Implementation *implementation, FILE *file,
267  const XQC_StaticContext *context, XQC_Expression **expression);
268 
291  const XQC_StaticContext *context, XQC_Expression **expression);
292 
294 
300 
302  const char *string, XQC_Sequence **sequence);
305  FILE *file, XQC_Sequence **sequence);
308  XQC_InputStream *stream, XQC_Sequence **sequence);
309 
311 
318  XQC_Sequence **sequence);
320  XQC_ItemType type, const char *value,
321  XQC_Sequence **sequence);
323  const char *values[], unsigned int count,
324  XQC_Sequence **sequence);
326  int values[], unsigned int count,
327  XQC_Sequence **sequence);
329  double values[], unsigned int count,
330  XQC_Sequence **sequence);
331 
333 
343  void *(*get_interface)(const XQC_Implementation *implementation, const char *name);
344 
351  void (*free)(XQC_Implementation *implementation);
352 };
353 
360 
365 
371 
377 
383 
388 
393 
405 
420  XQC_Error
422 
434  XQC_Error
435  (*declare_ns)(XQC_StaticContext *context, const char *prefix, const char *uri);
436 
448  XQC_Error
449  (*get_ns_by_prefix)(XQC_StaticContext *context, const char *prefix, const char **result_ns);
450 
460  XQC_Error
461  (*set_default_element_and_type_ns)(XQC_StaticContext *context, const char *uri);
462 
471  XQC_Error
472  (*get_default_element_and_type_ns)(XQC_StaticContext *context, const char **uri);
473 
483  XQC_Error
484  (*set_default_function_ns)(XQC_StaticContext *context, const char *uri);
485 
495  XQC_Error
496  (*get_default_function_ns)(XQC_StaticContext *context, const char **uri);
497 
507  XQC_Error
509 
519  XQC_Error
521 
531  XQC_Error
533 
543  XQC_Error
545 
555  XQC_Error
557 
567  XQC_Error
569 
580  XQC_Error
582 
593  XQC_Error
595 
605  XQC_Error
607 
617  XQC_Error
619 
630  XQC_Error
632 
644  XQC_Error
646 
656  XQC_Error
657  (*set_base_uri)(XQC_StaticContext *context, const char *base_uri);
658 
668  XQC_Error
669  (*get_base_uri)(XQC_StaticContext *context, const char **base_uri);
670 
673 
683  void *(*get_interface)(const XQC_StaticContext *context, const char *name);
684 
691  void (*free)(XQC_StaticContext *context);
692 };
693 
708 
720  XQC_Error (*create_context)(const XQC_Expression *expression, XQC_DynamicContext **context);
721 
738  XQC_Error (*execute)(const XQC_Expression *expression, const XQC_DynamicContext *context, XQC_Sequence **sequence);
739 
749  void *(*get_interface)(const XQC_Expression *expression, const char *name);
750 
757  void (*free)(XQC_Expression *expression);
758 };
759 
779  XQC_Error (*set_variable)(XQC_DynamicContext *context, const char *uri, const char *name,
780  XQC_Sequence *value);
781 
782  XQC_Error (*get_variable)(const XQC_DynamicContext *context, const char *uri, const char *name,
783  XQC_Sequence **value);
784 
803 
805 
812  XQC_Error (*get_implicit_timezone)(const XQC_DynamicContext *context, int *timezone);
813 
816 
826  void *(*get_interface)(const XQC_DynamicContext *context, const char *name);
827 
834  void (*free)(XQC_DynamicContext *context);
835 };
836 
854  XQC_Error (*next)(XQC_Sequence *sequence);
855 
871  XQC_Error (*item_type)(const XQC_Sequence *sequence, XQC_ItemType *type);
872 
886  XQC_Error (*type_name)(const XQC_Sequence *sequence, const char **uri, const char **name);
887 
901  XQC_Error (*string_value)(const XQC_Sequence *sequence, const char **value);
902 
915  XQC_Error (*integer_value)(const XQC_Sequence *sequence, int *value);
916 
929  XQC_Error (*double_value)(const XQC_Sequence *sequence, double *value);
930 
945  XQC_Error (*node_name)(const XQC_Sequence *sequence, const char **uri, const char **name);
946 
958  void *(*get_interface)(const XQC_Sequence *sequence, const char *name);
959 
966  void (*free)(XQC_Sequence *sequence);
967 };
968 
969 #ifdef __cplusplus
970 }
971 #endif
972 
973 #endif