2 * Copyright (c) 1995-1999, Index Data.
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.33 2000-11-29 14:22:47 adam
8 * Implemented XML/SGML attributes for data1 so that d1_read reads them
9 * and d1_write generates proper attributes for XML/SGML records. Added
10 * register locking for threaded version.
12 * Revision 1.32 2000/01/06 11:25:59 adam
13 * Added case to prevent warning.
15 * Revision 1.31 1999/12/21 14:16:20 ian
16 * Changed retrieval module to allow data1 trees with no associated absyn.
17 * Also added a simple interface for extracting values from data1 trees using
18 * a string based tagpath.
20 * Revision 1.30 1999/11/30 13:47:12 adam
21 * Improved installation. Moved header files to include/yaz.
23 * Revision 1.29 1999/10/21 12:06:29 adam
24 * Retrieval module no longer uses ctype.h - functions.
26 * Revision 1.28 1999/10/21 09:50:33 adam
27 * SGML reader uses own isspace - it doesn't do 8-bit on WIN32!
29 * Revision 1.27 1999/08/27 09:40:32 adam
30 * Renamed logf function to yaz_log. Removed VC++ project files.
32 * Revision 1.26 1999/07/13 13:23:48 adam
33 * Non-recursive version of data1_read_node. data1_read_nodex reads
34 * stream of bytes (instead of buffer in memory).
36 * Revision 1.25 1999/04/20 09:56:48 adam
37 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
38 * Modified all encoders/decoders to reflect this change.
40 * Revision 1.24 1998/10/28 15:10:09 adam
41 * Added --with-yc option to configure. For the data1_node in data1.h:
42 * decreased size of localdata and removed member "line" which wasn't useful.
44 * Revision 1.23 1998/03/12 11:28:45 adam
45 * Fix: didn't set root member of tagged node in function.
46 * data1_add_insert_taggeddata.
48 * Revision 1.22 1998/03/05 08:15:32 adam
49 * Implemented data1_add_insert_taggeddata utility which is more flexible
50 * than data1_insert_taggeddata.
52 * Revision 1.21 1998/02/27 14:08:05 adam
53 * Added const to some char pointer arguments.
54 * Reworked data1_read_node so that it doesn't create a tree with
55 * pointers to original "SGML"-buffer.
57 * Revision 1.20 1998/02/11 11:53:35 adam
58 * Changed code so that it compiles as C++.
60 * Revision 1.19 1997/12/09 16:17:09 adam
61 * Fix bug regarding variants. Tags with prefix "var" was incorrectly
62 * interpreted as "start of variants". Now, only "var" indicates such
64 * Cleaned up data1_read_node so tag names and variant names are
65 * copied and not pointed to by the generated data1 tree. Data nodes
66 * still point to old buffer.
68 * Revision 1.18 1997/11/18 09:51:09 adam
69 * Removed element num_children from data1_node. Minor changes in
72 * Revision 1.17 1997/11/05 09:20:51 adam
75 * Revision 1.16 1997/09/17 12:10:37 adam
78 * Revision 1.15 1997/09/05 09:50:57 adam
79 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
81 * Revision 1.14 1997/05/14 06:54:04 adam
84 * Revision 1.13 1996/10/29 13:35:38 adam
85 * Implemented data1_set_tabpath and data1_get_tabpath.
87 * Revision 1.12 1996/10/11 10:35:38 adam
88 * Fixed a bug that caused data1_read_node to core dump when no abstract
89 * syntax was defined in a "sgml"-record.
91 * Revision 1.11 1996/07/06 19:58:35 quinn
92 * System headerfiles gathered in yconfig
94 * Revision 1.10 1996/01/19 15:41:47 quinn
95 * Fixed uninitialized boolean.
97 * Revision 1.9 1996/01/17 14:52:47 adam
98 * Changed prototype for reader function parsed to data1_read_record.
100 * Revision 1.8 1995/12/15 16:20:41 quinn
101 * Added formatted text.
103 * Revision 1.7 1995/12/13 13:44:32 quinn
104 * Modified Data1-system to use nmem
106 * Revision 1.6 1995/12/12 16:37:08 quinn
107 * Added destroy element to data1_node.
109 * Revision 1.5 1995/12/11 15:22:37 quinn
110 * Added last_child field to the node.
111 * Rewrote schema-mapping.
113 * Revision 1.4 1995/11/13 09:27:36 quinn
114 * Fiddling with the variant stuff.
116 * Revision 1.3 1995/11/01 16:34:57 quinn
117 * Making data1 look for tables in data1_tabpath
119 * Revision 1.2 1995/11/01 13:54:48 quinn
122 * Revision 1.1 1995/11/01 11:56:09 quinn
123 * Added Retrieval (data management) functions en masse.
125 * Revision 1.14 1995/10/30 12:40:55 quinn
126 * Fixed a couple of bugs.
128 * Revision 1.13 1995/10/25 16:00:47 quinn
129 * USMARC support is now almost operational
131 * Revision 1.12 1995/10/16 14:02:55 quinn
132 * Changes to support element set names and espec1
134 * Revision 1.11 1995/10/13 16:05:08 quinn
135 * Adding Espec1-processing
137 * Revision 1.10 1995/10/11 14:53:44 quinn
140 * Revision 1.9 1995/10/06 16:56:50 quinn
141 * Fixed ranked result.
143 * Revision 1.8 1995/10/06 16:44:13 quinn
144 * Work on attribute set mapping, etc.
146 * Revision 1.7 1995/10/06 12:58:35 quinn
149 * Revision 1.6 1995/10/04 09:29:49 quinn
150 * Adjustments to support USGS test data
152 * Revision 1.5 1995/10/03 17:56:43 quinn
155 * Revision 1.4 1995/10/02 15:53:19 quinn
158 * Revision 1.3 1995/10/02 14:55:21 quinn
159 * *** empty log message ***
161 * Revision 1.2 1995/09/14 15:18:13 quinn
164 * Revision 1.1 1995/09/12 11:24:30 quinn
165 * Beginning to add code for structured records.
174 #include <yaz/xmalloc.h>
176 #include <yaz/data1.h>
179 * get the tag which is the immediate parent of this node (this may mean
180 * traversing intermediate things like variants and stuff.
182 data1_node *get_parent_tag (data1_handle dh, data1_node *n)
184 for (; n && n->which != DATA1N_root; n = n->parent)
185 if (n->which == DATA1N_tag)
190 data1_node *data1_mk_node (data1_handle dh, NMEM m)
194 r = (data1_node *)nmem_malloc(m, sizeof(*r));
195 r->next = r->child = r->last_child = r->parent = 0;
200 data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type)
204 r = data1_mk_node(dh, m);
210 r->u.tag.element = 0;
211 r->u.tag.no_data_requested = 0;
212 r->u.tag.node_selected = 0;
213 r->u.tag.make_variantlist = 0;
214 r->u.tag.get_bytes = -1;
215 #if DATA1_USING_XATTR
216 r->u.tag.attributes = 0;
227 r->u.data.formatted_text = 0;
230 logf (LOG_WARN, "data_mk_node_type. bad type = %d\n", type);
235 void data1_free_tree (data1_handle dh, data1_node *t)
237 data1_node *p = t->child, *pn;
242 data1_free_tree (dh, p);
249 char *data1_insert_string (data1_handle dh, data1_node *res,
250 NMEM m, const char *str)
252 int len = strlen(str);
254 if (len >= DATA1_LOCALDATA)
255 return nmem_strdup (m, str);
258 strcpy (res->lbuf, str);
263 data1_node *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
265 const char *tagname, NMEM m,
266 int first_flag, int local_allowed)
268 data1_node *partag = get_parent_tag (dh, at);
269 data1_node *tagn = data1_mk_node_type (dh, m, DATA1N_tag);
270 data1_element *e = NULL;
273 tagn->u.tag.tag = data1_insert_string (dh, tagn, m, tagname);
276 e = partag->u.tag.element;
277 tagn->u.tag.element =
278 data1_getelementbytagname (dh, root->u.root.absyn, e, tagname);
279 if (!local_allowed && !tagn->u.tag.element)
281 tagn->last_child = tagn->child = datn = data1_mk_node_type (dh, m, DATA1N_data);
285 datn->u.data.formatted_text = 0;
290 tagn->next = at->child;
292 at->last_child = tagn;
301 assert (at->last_child);
302 at->last_child->next = tagn;
304 at->last_child = tagn;
309 data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
311 const char *tagname, NMEM m)
313 return data1_add_insert_taggeddata (dh, root, at, tagname, m, 0, 1);
318 * Insert a tagged node into the record root as first child of the node at
319 * which should be root or tag itself). Returns pointer to the data node,
320 * which can then be modified.
322 data1_node *data1_insert_taggeddata(data1_handle dh, data1_node *root,
324 const char *tagname, NMEM m)
326 return data1_add_insert_taggeddata (dh, root, at, tagname, m, 1, 0);
329 #if DATA1_USING_XATTR
330 data1_xattr *data1_read_xattr (data1_handle dh, NMEM m,
331 int (*get_byte)(void *fh), void *fh,
332 WRBUF wrbuf, int *ch)
334 data1_xattr *p_first = 0;
335 data1_xattr **pp = &p_first;
341 while (c && d1_isspace(c))
343 if (!c || c == '>' || c == '/')
345 *pp = p = nmem_malloc (m, sizeof(*p));
351 while (c && c != '=' && c != '>' && c != '/' && !d1_isspace(c))
353 wrbuf_putc (wrbuf, c);
356 wrbuf_putc (wrbuf, '\0');
357 len = wrbuf_len(wrbuf);
358 p->name = nmem_malloc (m, len);
359 strcpy (p->name, wrbuf_buf(wrbuf));
366 while (c && c != '"' && c != '>' && c != '/')
368 wrbuf_putc (wrbuf, c);
371 wrbuf_putc (wrbuf, '\0');
372 len = wrbuf_len(wrbuf);
373 p->value = nmem_malloc (m, len);
374 strcpy (p->value, wrbuf_buf(wrbuf));
385 * Ugh. Sometimes functions just grow and grow on you. This one reads a
386 * 'node' and its children.
388 data1_node *data1_read_nodex (data1_handle dh, NMEM m,
389 int (*get_byte)(void *fh), void *fh, WRBUF wrbuf)
391 data1_absyn *absyn = 0;
392 data1_node *d1_stack[256];
402 data1_node *parent = level ? d1_stack[level-1] : 0;
403 while (c != '\0' && d1_isspace(c))
412 if (c == '<') /* beginning of tag */
414 #if DATA1_USING_XATTR
420 for (i = 0; (c=(*get_byte)(fh)) && c != '>' && !d1_isspace(c);)
421 if (i < (sizeof(tag)-1))
424 #if DATA1_USING_XATTR
425 xattr = data1_read_xattr (dh, m, get_byte, fh, wrbuf, &c);
428 while (d1_isspace(c))
430 for (i = 0; c && c != '>'; c = (*get_byte)(fh))
431 if (i < (sizeof(args)-1))
437 yaz_log(LOG_WARN, "d1: %d: Malformed tag", line);
453 parent = d1_stack[--i];
454 if ((parent->which == DATA1N_root &&
455 !strcmp(tag+1, parent->u.root.type)) ||
456 (parent->which == DATA1N_tag &&
457 !strcmp(tag+1, parent->u.tag.tag)))
465 yaz_log (LOG_WARN, "%d: no begin tag for %s",
474 if (level == 0) /* root ? */
476 if (!(absyn = data1_get_absyn (dh, tag)))
478 yaz_log(LOG_WARN, "Unable to acquire abstract syntax " "for '%s'", tag);
479 /* It's now OK for a record not to have an absyn */
481 res = data1_mk_node_type (dh, m, DATA1N_root);
482 res->u.root.type = data1_insert_string (dh, res, m, tag);
483 res->u.root.absyn = absyn;
486 else if (!strcmp(tag, "var"))
488 char tclass[DATA1_MAX_SYMBOL], type[DATA1_MAX_SYMBOL];
492 if (sscanf(args, "%s %s %n", tclass, type, &val_offset) != 2)
494 yaz_log(LOG_WARN, "Malformed variant triple at '%s'", tag);
498 data1_getvartypebyct(dh,
499 parent->root->u.root.absyn->varset,
503 * If we're the first variant in this group, create a parent
504 * variant, and insert it before the current variant.
506 if (parent->which != DATA1N_variant)
508 res = data1_mk_node (dh, m);
509 res->which = DATA1N_variant;
510 res->u.variant.type = 0;
511 res->u.variant.value = 0;
516 * now determine if one of our ancestor triples is of
517 * same type. If so, we break here.
520 for (i = level-1; d1_stack[i]->which==DATA1N_variant; --i)
521 if (d1_stack[i]->u.variant.type == tp)
526 res = data1_mk_node (dh, m);
527 res->which = DATA1N_variant;
528 res->u.variant.type = tp;
529 res->u.variant.value =
530 data1_insert_string (dh, res, m, args + val_offset);
533 else /* tag.. acquire our element in the abstract syntax */
535 data1_node *partag = get_parent_tag (dh, parent);
536 data1_element *elem, *e = 0;
539 if (parent->which == DATA1N_variant)
542 if (!(e = partag->u.tag.element))
543 localtag = 1; /* our parent is a local tag */
545 elem = data1_getelementbytagname(dh, absyn, e, tag);
546 res = data1_mk_node_type (dh, m, DATA1N_tag);
547 res->u.tag.tag = data1_insert_string (dh, res, m, tag);
548 res->u.tag.element = elem;
549 #if DATA1_USING_XATTR
550 res->u.tag.attributes = xattr;
555 parent->last_child = res;
556 res->root = parent->root;
558 res->parent = parent;
560 d1_stack[level]->next = res;
563 d1_stack[level] = res;
564 d1_stack[++level] = 0;
566 else /* != '<'... this is a body of text */
570 int len, prev_char = 0;
577 res = data1_mk_node_type (dh, m, DATA1N_data);
578 res->parent = parent;
579 res->u.data.what = DATA1I_text;
580 res->u.data.formatted_text = 0;
581 res->root = parent->root;
582 parent->last_child = res;
584 d1_stack[level]->next = res;
587 d1_stack[level] = res;
591 while (c && c != '<')
593 wrbuf_putc (wrbuf, c);
596 len = wrbuf_len(wrbuf);
598 /* use local buffer of nmem if too large */
599 if (len >= DATA1_LOCALDATA)
600 res->u.data.data = (char*) nmem_malloc (m, len);
602 res->u.data.data = res->lbuf;
604 /* read "data" and transfer while removing white space */
605 dst = res->u.data.data;
606 for (src = wrbuf_buf(wrbuf); --len >= 0; src++)
610 if (d1_isspace (*src))
622 res->u.data.len = dst - res->u.data.data;
628 int getc_mem (void *fh)
630 const char **p = (const char **) fh;
636 data1_node *data1_read_node (data1_handle dh, const char **buf, NMEM m)
638 WRBUF wrbuf = wrbuf_alloc();
641 node = data1_read_nodex(dh, m, getc_mem, (void *) (buf), wrbuf);
642 wrbuf_free (wrbuf, 1);
647 * Read a record in the native syntax.
649 data1_node *data1_read_record(data1_handle dh,
650 int (*rf)(void *, char *, size_t), void *fh,
654 char **buf = data1_get_read_buf (dh, &size);
659 *buf = (char *)xmalloc(*size = 4096);
663 if (rd + 2048 >= *size && !(*buf =(char *)xrealloc(*buf, *size *= 2)))
665 if ((res = (*rf)(fh, *buf + rd, 2048)) <= 0)
671 return data1_read_node(dh, &bp, m);
680 data1_node *data1_read_sgml (data1_handle dh, NMEM m, const char *buf)
682 const char *bp = buf;
683 return data1_read_node (dh, &bp, m);