Removed element num_children from data1_node. Minor changes in
[yaz-moved-to-github.git] / retrieval / d1_grs.c
1 /*
2  * Copyright (c) 1995-1997, Index Data.
3  * See the file LICENSE for details.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: d1_grs.c,v $
7  * Revision 1.11  1997-11-18 09:51:09  adam
8  * Removed element num_children from data1_node. Minor changes in
9  * data1 to Explain.
10  *
11  * Revision 1.10  1997/09/17 12:10:36  adam
12  * YAZ version 1.4.
13  *
14  * Revision 1.9  1997/05/14 06:54:03  adam
15  * C++ support.
16  *
17  * Revision 1.8  1996/12/05 13:17:49  quinn
18  * Fixed GRS-1 null-ref
19  *
20  * Revision 1.7  1996/10/11  11:57:23  quinn
21  * Smallish
22  *
23  * Revision 1.6  1996/07/06  19:58:34  quinn
24  * System headerfiles gathered in yconfig
25  *
26  * Revision 1.5  1996/06/03  09:46:42  quinn
27  * Added OID data type.
28  *
29  * Revision 1.4  1996/05/01  12:45:30  quinn
30  * Support use of local tag names in abs file.
31  *
32  * Revision 1.3  1995/11/13  09:27:35  quinn
33  * Fiddling with the variant stuff.
34  *
35  * Revision 1.2  1995/11/01  13:54:46  quinn
36  * Minor adjustments
37  *
38  * Revision 1.1  1995/11/01  11:56:07  quinn
39  * Added Retrieval (data management) functions en masse.
40  *
41  *
42  */
43
44 #include <assert.h>
45 #include <stdlib.h>
46
47 #include <proto.h>
48 #include <log.h>
49
50 #include <data1.h>
51
52 #define D1_VARIANTARRAY 20 /* fixed max length on sup'd variant-list. Lazy me */
53
54 static Z_ElementMetaData *get_ElementMetaData(ODR o)
55 {
56     Z_ElementMetaData *r = odr_malloc(o, sizeof(*r));
57
58     r->seriesOrder = 0;
59     r->usageRight = 0;
60     r->num_hits = 0;
61     r->hits = 0;
62     r->displayName = 0;
63     r->num_supportedVariants = 0;
64     r->supportedVariants = 0;
65     r->message = 0;
66     r->elementDescriptor = 0;
67     r->surrogateFor = 0;
68     r->surrogateElement = 0;
69     r->other = 0;
70
71     return r;
72 }
73
74 /*
75  * N should point to the *last* (leaf) triple in a sequence. Construct a variant
76  * from each of the triples beginning (ending) with 'n', up to the
77  * nearest parent tag. num should equal the number of triples in the
78  * sequence.
79  */
80 static Z_Variant *make_variant(data1_node *n, int num, ODR o)
81 {
82     Z_Variant *v = odr_malloc(o, sizeof(*v));
83     data1_node *p;
84
85     v->globalVariantSetId = 0;
86     v->num_triples = num;
87     v->triples = odr_malloc(o, sizeof(Z_Triple*) * num);
88
89     /*
90      * cycle back up through the tree of variants
91      * (traversing exactly 'level' variants).
92      */
93     for (p = n, num--; p && num >= 0; p = p->parent, num--)
94     {
95         Z_Triple *t;
96
97         assert(p->which == DATA1N_variant);
98         t = v->triples[num] = odr_malloc(o, sizeof(*t));
99         t->variantSetId = 0;
100         t->zclass = odr_malloc(o, sizeof(int));
101         *t->zclass = p->u.variant.type->zclass->zclass;
102         t->type = odr_malloc(o, sizeof(int));
103         *t->type = p->u.variant.type->type;
104
105         switch (p->u.variant.type->datatype)
106         {
107             case DATA1K_string:
108                 t->which = Z_Triple_internationalString;
109                 t->value.internationalString = odr_malloc(o,
110                     strlen(p->u.variant.value)+1);
111                 strcpy(t->value.internationalString, p->u.variant.value);
112                 break;
113             default:
114                 logf(LOG_WARN, "Unable to handle value for variant %s",
115                     p->u.variant.type->name);
116                 return 0;
117         }
118     }
119     return v;
120 }
121
122 /*
123  * Traverse the variant children of n, constructing a supportedVariant list.
124  */
125 static int traverse_triples(data1_node *n, int level, Z_ElementMetaData *m,
126     ODR o)
127 {
128     data1_node *c;
129     
130     for (c = n->child; c; c = c->next)
131         if (c->which == DATA1N_data && level)
132         {
133             if (!m->supportedVariants)
134                 m->supportedVariants = odr_malloc(o, sizeof(Z_Variant*) *
135                     D1_VARIANTARRAY);
136             else if (m->num_supportedVariants >= D1_VARIANTARRAY)
137             {
138                 logf(LOG_WARN, "Too many variants (D1_VARIANTARRAY==%d)",
139                     D1_VARIANTARRAY);
140                 return -1;
141             }
142
143             if (!(m->supportedVariants[m->num_supportedVariants++] =
144                 make_variant(n, level, o)))
145                 return -1;
146         }
147         else if (c->which == DATA1N_variant)
148             if (traverse_triples(c, level+1, m, o) < 0)
149                 return -1;
150     return 0;
151 }
152
153 static Z_ElementData *nodetoelementdata(data1_handle dh, data1_node *n,
154                                         int select, int leaf,
155                                         ODR o, int *len)
156 {
157     Z_ElementData *res = odr_malloc(o, sizeof(*res));
158
159     if (!n)
160     {
161         res->which = Z_ElementData_elementNotThere;
162         res->u.elementNotThere = ODR_NULLVAL;
163     }
164     else if (n->which == DATA1N_data && (leaf || n->next == NULL))
165     {
166         char str[512];
167         int toget;
168         data1_node *p;
169
170         for (p = n->parent; p && p->which != DATA1N_tag; p = p->parent)
171             ;
172
173         switch (n->u.data.what)
174         {
175             case DATA1I_num:
176                 res->which = Z_ElementData_numeric;
177                 res->u.numeric = odr_malloc(o, sizeof(int));
178                 *res->u.numeric = atoi(n->u.data.data);
179                 *len += 4;
180                 break;
181             case DATA1I_text:
182                 toget = n->u.data.len;
183                 if (p->u.tag.get_bytes > 0 && p->u.tag.get_bytes < toget)
184                     toget = p->u.tag.get_bytes;
185                 res->which = Z_ElementData_string;
186                 res->u.string = odr_malloc(o, toget+1);
187                 memcpy(res->u.string, n->u.data.data, toget);
188                 res->u.string[toget] = '\0';
189                 *len += toget;
190                 break;
191             case DATA1I_oid:
192                 res->which = Z_ElementData_oid;
193                 strncpy(str, n->u.data.data, n->u.data.len);
194                 str[n->u.data.len] = '\0';
195                 res->u.oid = odr_getoidbystr(o, str);
196                 *len += n->u.data.len;
197                 break;
198             default:
199                 logf(LOG_WARN, "Can't handle datatype.");
200                 return 0;
201         }
202     }
203     else
204     {
205         res->which = Z_ElementData_subtree;
206         if (!(res->u.subtree = data1_nodetogr (dh, n->parent, select, o, len)))
207             return 0;
208     }
209     return res;
210 }
211
212 static Z_TaggedElement *nodetotaggedelement(data1_handle dh, data1_node *n,
213                                             int select, ODR o,
214                                             int *len)
215 {
216     Z_TaggedElement *res = odr_malloc(o, sizeof(*res));
217     data1_tag *tag = 0;
218     data1_node *data;
219     int leaf;
220
221     if (n->which == DATA1N_tag)
222     {
223         if (n->u.tag.element)
224             tag = n->u.tag.element->tag;
225         data = n->child;
226         leaf = 0;
227     }
228     /*
229      * If we're a data element at this point, we need to insert a
230      * wellKnown tag to wrap us up.
231      */
232     else if (n->which == DATA1N_data || n->which == DATA1N_variant)
233     {
234         if (!(tag = data1_gettagbyname (dh, n->root->u.root.absyn->tagset,
235                                         "wellKnown")))
236         {
237             logf(LOG_WARN, "Unable to locate tag for 'wellKnown'");
238             return 0;
239         }
240         data = n;
241         leaf = 1;
242     }
243     else
244     {
245         logf(LOG_WARN, "Bad data.");
246         return 0;
247     }
248
249     res->tagType = odr_malloc(o, sizeof(int));
250     *res->tagType = (tag && tag->tagset) ? tag->tagset->type : 3;
251     res->tagValue = odr_malloc(o, sizeof(Z_StringOrNumeric));
252     if (tag && tag->which == DATA1T_numeric)
253     {
254         res->tagValue->which = Z_StringOrNumeric_numeric;
255         res->tagValue->u.numeric = odr_malloc(o, sizeof(int));
256         *res->tagValue->u.numeric = tag->value.numeric;
257     }
258     else
259     {
260         char *tagstr;
261
262         if (tag) /* well-known tag */
263             tagstr = tag->value.string;
264         else /* tag local to this file */
265             tagstr = n->u.tag.tag;
266
267         res->tagValue->which = Z_StringOrNumeric_string;
268         res->tagValue->u.string = odr_malloc(o, strlen(tagstr)+1);
269         strcpy(res->tagValue->u.string, tagstr);
270     }
271     res->tagOccurrence = 0;
272     res->appliedVariant = 0;
273     res->metaData = 0;
274     if (n->which == DATA1N_variant || (data && data->which ==
275         DATA1N_variant && data->next == NULL))
276     {
277         int nvars = 0;
278
279         res->metaData = get_ElementMetaData(o);
280         if (n->which == DATA1N_tag && n->u.tag.make_variantlist)
281             if (traverse_triples(data, 0, res->metaData, o) < 0)
282                 return 0;
283         while (data && data->which == DATA1N_variant)
284         {
285             nvars++;
286             data = data->child;
287         }
288         if (n->which != DATA1N_tag || !n->u.tag.no_data_requested)
289             res->appliedVariant = make_variant(data->parent, nvars-1, o);
290     }
291     if (n->which == DATA1N_tag && n->u.tag.no_data_requested)
292     {
293         res->content = odr_malloc(o, sizeof(*res->content));
294         res->content->which = Z_ElementData_noDataRequested;
295         res->content->u.noDataRequested = ODR_NULLVAL;
296     }
297     else if (!(res->content = nodetoelementdata (dh, data, select, leaf,
298                                                  o, len)))
299         return 0;
300     *len += 10;
301     return res;
302 }
303
304 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
305                                 int select, ODR o, int *len)
306 {
307     Z_GenericRecord *res = odr_malloc(o, sizeof(*res));
308     data1_node *c;
309     int num_children = 0;
310     
311     for (c = n->child; c; c = c->next)
312         num_children++;
313
314     res->elements = odr_malloc(o, sizeof(Z_TaggedElement *) * num_children);
315     res->num_elements = 0;
316     for (c = n->child; c; c = c->next)
317     {
318         if (c->which == DATA1N_tag && select && !c->u.tag.node_selected)
319             continue;
320         if (!(res->elements[res->num_elements++] =
321               nodetotaggedelement (dh, c, select, o, len)))
322             return 0;
323     }
324     return res;
325 }