include/prt-esp.h

   1 /*
   2  * Copyright (c) 1995, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The names of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  */
  27
  28 #ifndef PRT_ESP_H
  29 #define PRT_ESP_H
  30
  31 #include <yconfig.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 typedef struct Z_OccurValues
  38 {
  39     int *start;
  40     int *howMany;                     /* OPTIONAL */
  41 } Z_OccurValues;
  42
  43 typedef struct Z_Occurrences
  44 {
  45     int which;
  46 #define Z_Occurrences_all 0
  47 #define Z_Occurrences_last 1
  48 #define Z_Occurrences_values 2
  49     union
  50     {
  51         Odr_null *all;
  52         Odr_null *last;
  53         Z_OccurValues *values;
  54     } u;
  55 } Z_Occurrences;
  56
  57 typedef struct Z_SpecificTag
  58 {
  59     int *tagType;                           /* OPTIONAL */
  60     Z_StringOrNumeric *tagValue;
  61     Z_Occurrences *occurrences;             /* OPTIONAL */
  62 } Z_SpecificTag;
  63
  64 typedef struct Z_ETagUnit
  65 {
  66     int which;
  67 #define Z_ETagUnit_specificTag 0
  68 #define Z_ETagUnit_wildThing 1
  69 #define Z_ETagUnit_wildPath 2
  70     union
  71     {
  72         Z_SpecificTag *specificTag;
  73         Z_Occurrences *wildThing;
  74         Odr_null *wildPath;
  75     } u;
  76 } Z_ETagUnit;
  77
  78 typedef struct Z_ETagPath
  79 {
  80     int num_tags;
  81     Z_ETagUnit **tags;
  82 } Z_ETagPath;
  83
  84 typedef struct Z_SimpleElement
  85 {
  86     Z_ETagPath *path;
  87     Z_Variant *variantRequest;           /* OPTIONAL */
  88 } Z_SimpleElement;
  89
  90 typedef struct Z_CompoPrimitives
  91 {
  92     int num_primitives;
  93     char **primitives;
  94 } Z_CompoPrimitives;
  95
  96 typedef struct Z_CompoSpecs
  97 {
  98     int num_specs;
  99     Z_SimpleElement **specs;
 100 } Z_CompoSpecs;
 101
 102 typedef struct Z_CompositeElement
 103 {
 104     int which;
 105 #define Z_CompoElement_primitives 0
 106 #define Z_CompoElement_specs 1
 107     union
 108     {
 109         Z_CompoPrimitives *primitives;
 110         Z_CompoSpecs *specs;
 111     } elementList;
 112     Z_ETagPath *deliveryTag;
 113     Z_Variant *variantRequest;
 114 } Z_CompositeElement;
 115
 116 typedef struct Z_ElementRequest
 117 {
 118     int which;
 119 #define Z_ERequest_simpleElement 0
 120 #define Z_ERequest_compositeElement 1
 121     union
 122     {
 123         Z_SimpleElement *simpleElement;
 124         Z_CompositeElement *compositeElement;
 125     } u;
 126 } Z_ElementRequest;
 127
 128 typedef struct Z_Espec1
 129 {
 130     int num_elementSetNames;
 131     char **elementSetNames;               /* OPTIONAL */
 132     Odr_oid *defaultVariantSetId;         /* OPTIONAL */
 133     Z_Variant *defaultVariantRequest;     /* OPTIONAL */
 134     int *defaultTagType;                  /* OPTIONAL */
 135     int num_elements;
 136     Z_ElementRequest **elements;           /* OPTIONAL */
 137 } Z_Espec1;
 138
 139 YAZ_EXPORT int z_Espec1(ODR o, Z_Espec1 **p, int opt);
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif
 144
 145 #endif