Implemented sub-trees feature for schemas - including forward
[yaz-moved-to-github.git] / include / data1.h
index bd0747d..4178b55 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995, Index Data.
+ * Copyright (c) 1995-1997, Index Data.
  *
  * Permission to use, copy, modify, distribute, and sell this software and
  * its documentation, in whole or in part, for any purpose, is hereby granted,
  * OF THIS SOFTWARE.
  *
  * $Log: data1.h,v $
- * Revision 1.2  1995-11-01 13:54:35  quinn
+ * Revision 1.33  1997-12-18 10:51:30  adam
+ * Implemented sub-trees feature for schemas - including forward
+ * references.
+ *
+ * Revision 1.32  1997/12/09 16:18:16  adam
+ * Work on EXPLAIN schema. First implementation of sub-schema facility
+ * in the *.abs files.
+ *
+ * Revision 1.31  1997/11/18 09:51:08  adam
+ * Removed element num_children from data1_node. Minor changes in
+ * data1 to Explain.
+ *
+ * Revision 1.30  1997/10/31 12:20:07  adam
+ * Improved memory debugging for xmalloc/nmem.c. References to NMEM
+ * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
+ * Bug fix: missing fclose in data1_read_espec1.
+ *
+ * Revision 1.29  1997/10/27 13:54:18  adam
+ * Changed structure field in data1 node to be simple string which
+ * is "unknown" to the retrieval system itself.
+ *
+ * Revision 1.28  1997/10/06 09:37:53  adam
+ * Added prototype for data1_get_map_buf.
+ *
+ * Revision 1.27  1997/09/24 13:35:44  adam
+ * Added two members to data1_marctab to ease reading of weird MARC records.
+ *
+ * Revision 1.26  1997/09/17 12:10:32  adam
+ * YAZ version 1.4.
+ *
+ * Revision 1.25  1997/09/05 09:50:55  adam
+ * Removed global data1_tabpath - uses data1_get_tabpath() instead.
+ *
+ * Revision 1.24  1997/09/01 09:30:39  adam
+ * Added include of yaz-util.h.
+ *
+ * Revision 1.23  1997/09/01 08:58:04  adam
+ * Removed declaration of data1_matchstr since it's a macro.
+ *
+ * Revision 1.22  1997/09/01 08:49:48  adam
+ * New windows NT/95 port using MSV5.0. To export DLL functions the
+ * YAZ_EXPORT modifier was added. Defined in yconfig.h.
+ *
+ * Revision 1.21  1997/05/14 06:53:38  adam
+ * C++ support.
+ *
+ * Revision 1.20  1996/10/29 13:34:39  adam
+ * New functions to get/set data1_tabpath.
+ *
+ * Revision 1.19  1996/10/11 11:57:16  quinn
+ * Smallish
+ *
+ * Revision 1.18  1996/10/07  15:29:16  quinn
+ * Added SOIF support
+ *
+ * Revision 1.17  1996/07/06  19:58:32  quinn
+ * System headerfiles gathered in yconfig
+ *
+ * Revision 1.16  1996/06/10  08:55:34  quinn
+ * Added Summary. Unfinished work
+ *
+ * Revision 1.15  1996/06/03  09:46:03  quinn
+ * Added OID type.
+ *
+ * Revision 1.14  1996/05/09  07:27:11  quinn
+ * Multiple local values supported.
+ *
+ * Revision 1.13  1996/02/20  16:32:48  quinn
+ * Created util file.
+ *
+ * Revision 1.12  1996/01/18  09:46:34  adam
+ * Changed prototype for reader function parsed to data1_read_record.
+ *
+ * Revision 1.11  1995/12/15  16:19:45  quinn
+ * Added formatted_text.
+ *
+ * Revision 1.10  1995/12/14  11:09:43  quinn
+ * Work on Explain
+ *
+ * Revision 1.9  1995/12/13  15:32:47  quinn
+ * Added sgml-output.
+ *
+ * Revision 1.8  1995/12/13  13:44:23  quinn
+ * Modified Data1-system to use nmem
+ *
+ * Revision 1.7  1995/12/12  16:37:05  quinn
+ * Added destroy element to data1_node.
+ *
+ * Revision 1.6  1995/12/11  15:22:12  quinn
+ * Added last_child field to the node.
+ *
+ * Revision 1.5  1995/12/05  14:26:40  quinn
+ * Added global lbuf to data1_node.
+ *
+ * Revision 1.4  1995/11/13  09:27:29  quinn
+ * Fiddling with the variant stuff.
+ *
+ * Revision 1.3  1995/11/01  16:34:52  quinn
+ * Making data1 look for tables in data1_tabpath
+ *
+ * Revision 1.2  1995/11/01  13:54:35  quinn
  * Minor adjustments
  *
  * Revision 1.1  1995/11/01  13:07:18  quinn
 
 #include <stdio.h>
 
+#include <nmem.h>
 #include <oid.h>
 #include <proto.h>
 
 #include <d1_attset.h>
 #include <d1_map.h>
+#include <yaz-util.h>
+#include <wrbuf.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
 
 #define DATA1_MAX_SYMBOL 31
 
@@ -91,6 +200,8 @@ typedef struct data1_name
     struct data1_name *next;
 } data1_name;
 
+typedef struct data1_absyn_cache_info *data1_absyn_cache;
+
 typedef enum data1_datatype
 {
     DATA1K_structured = 1,
@@ -121,6 +232,8 @@ typedef struct data1_marctab
     int  length_implementation;
     char future_use[2];
 
+    int  force_indicator_length;
+    int  force_identifier_length;
     struct data1_marctab *next;
 } data1_marctab;
 
@@ -138,7 +251,7 @@ typedef struct data1_esetname
 typedef struct data1_vartype
 {
     char *name;
-    struct data1_varclass *class;
+    struct data1_varclass *zclass;
     int type;
     data1_datatype datatype;
     struct data1_vartype *next;
@@ -148,7 +261,7 @@ typedef struct data1_varclass
 {
     char *name;
     struct data1_varset *set;
-    int class;
+    int zclass;
     data1_vartype *types;
     struct data1_varclass *next;
 } data1_varclass;
@@ -169,11 +282,9 @@ struct data1_tagset;
 typedef struct data1_tag
 {
     data1_name *names;
-    enum
-    {
-       DATA1T_numeric,
-       DATA1T_string
-    } which;
+#define DATA1T_numeric 1
+#define DATA1T_string 2
+    int which;
     union
     {
        int numeric;
@@ -195,6 +306,13 @@ typedef struct data1_tagset
     struct data1_tagset *next;       /* sibling */
 } data1_tagset;
 
+typedef struct data1_termlist
+{
+    data1_att *att;
+    char *structure;
+    struct data1_termlist *next;
+} data1_termlist;
+
 /*
  * abstract syntax specification
  */
@@ -203,11 +321,18 @@ typedef struct data1_element
 {
     char *name;
     data1_tag *tag;
-    data1_att *att;
+    data1_termlist *termlists;
+    char *sub_name;
     struct data1_element *children;
     struct data1_element *next;
 } data1_element;
 
+typedef struct data1_sub_elements {
+    char *name;
+    struct data1_sub_elements *next;
+    data1_element *elements;
+} data1_sub_elements;
+
 typedef struct data1_absyn
 {
     char *name;
@@ -218,7 +343,8 @@ typedef struct data1_absyn
     data1_esetname *esetnames;
     data1_maptab *maptabs;
     data1_marctab *marc;
-    data1_element *elements;
+    data1_sub_elements *sub_elements;
+    data1_element *main_elements;
 } data1_absyn;
 
 /*
@@ -227,14 +353,15 @@ typedef struct data1_absyn
 
 typedef struct data1_node
 {
-    enum 
-    {
-       DATA1N_root,
-       DATA1N_tag,         /* a tag */
-       DATA1N_data,        /* */
-       DATA1N_variant,     /* variant specification */
-       DATA1N_indicator    /* ISO2709 indicator */
-    } which;
+    /* the root of a record (containing global data) */
+#define DATA1N_root 1 
+    /* a tag */
+#define DATA1N_tag  2       
+    /* some data under a leaf tag or variant */
+#define DATA1N_data 3
+    /* variant specification (a triple, actually) */
+#define DATA1N_variant 4
+    int which;
 
     union
     {
@@ -249,21 +376,27 @@ typedef struct data1_node
            char *tag;
            data1_element *element;
            int node_selected;
+           int make_variantlist;
+           int no_data_requested;
+           int get_bytes;
        } tag;
 
        struct
        {
-           enum
-           {
-               DATA1I_inctxt,      /* text inclusion */
-               DATA1I_incbin,      /* binary data inclusion */
-               DATA1I_text,        /* text data */
-               DATA1I_num          /* numerical data */
-           } what;
+        /* text inclusion */
+#define DATA1I_inctxt 1
+        /* binary data inclusion */
+#define DATA1I_incbin 2
+        /* text data */
+#define DATA1I_text 3 
+        /* numerical data */
+#define DATA1I_num 4
+        /* object identifier */
+#define DATA1I_oid 5         
+            int what;
+           int formatted_text;     /* newlines are significant */
            int len;
            char *data;      /* filename or data */
-#define DATA1_LOCALDATA 15
-           char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
        } data;
 
        struct
@@ -271,49 +404,91 @@ typedef struct data1_node
            data1_vartype *type;
            char *value;
        } variant;
-
-       struct
-       {
-           char *ind;
-       } indicator;
     } u;
 
+    void (*destroy)(struct data1_node *n);
+#define DATA1_LOCALDATA 40
+    char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
     int line;
-    int num_children;
     struct data1_node *next;
     struct data1_node *child;
+    struct data1_node *last_child;
     struct data1_node *parent;
     struct data1_node *root;
 } data1_node;
 
-data1_node *get_parent_tag(data1_node *n);
-data1_node *data1_read_node(char **buf, data1_node *parent, int *line,
-    data1_absyn *absyn);
-data1_node *data1_read_record(int (*rf)(int, char *, size_t), int fd);
-data1_absyn *data1_read_absyn(char *file);
-data1_tag *data1_gettagbynum(data1_tagset *s, int type, int value);
-data1_tagset *data1_read_tagset(char *file);
-data1_element *data1_getelementbytagname(data1_absyn *abs,
-    data1_element *parent, char *tagname);
-Z_GenericRecord *data1_nodetogr(data1_node *n, int select, ODR o);
-int data1_matchstr(char *s1, char *s2);
-data1_tag *data1_gettagbyname(data1_tagset *s, char *name);
-void data1_free_tree(data1_node *t);
-char *data1_nodetobuf(data1_node *n, int select, int *len);
-data1_node *data1_insert_taggeddata(data1_node *root, data1_node *at,
-    char *tagname);
-data1_datatype data1_maptype(char *t);
-data1_varset *data1_read_varset(char *file);
-data1_vartype *data1_getvartypebyct(data1_varset *set, char *class, char *type);
-Z_Espec1 *data1_read_espec1(char *file, ODR o);
-int data1_doespec1(data1_node *n, Z_Espec1 *e);
-data1_esetname *data1_getesetbyname(data1_absyn *a, char *name);
-data1_element *data1_getelementbyname(data1_absyn *absyn, char *name);
-data1_node *data1_mk_node(void);
-data1_absyn *data1_get_absyn(char *name);
-data1_maptab *data1_read_maptab(char *file);
-data1_node *data1_map_record(data1_node *n, data1_maptab *map);
-data1_marctab *data1_read_marctab(char *file);
-char *data1_nodetomarc(data1_marctab *p, data1_node *n, int selected, int *len);
+YAZ_EXPORT data1_handle data1_create (void);
+YAZ_EXPORT void data1_destroy(data1_handle dh);
+YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
+YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, char **buf,
+                                      data1_node *parent,
+                                      int *line, data1_absyn *absyn, NMEM m);
+YAZ_EXPORT data1_node *data1_read_record(data1_handle dh, 
+                                        int (*rf)(void *, char *, size_t),
+                                        void *fh, NMEM m);
+YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
+YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
+                                       int type, int value);
+YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
+YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh, 
+                                                   data1_absyn *abs,
+                                                   data1_element *parent,
+                                                   char *tagname);
+YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
+                                          int select, ODR o,
+                                          int *len);
+YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
+                                        char *name);
+YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
+YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
+                                int select, int *len);
+YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
+                                              data1_node *root,
+                                              data1_node *at,
+                                              char *tagname, NMEM m);
+YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
+YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
+YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
+                                              data1_varset *set,
+                                              char *zclass, char *type);
+YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
+YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
+YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh, 
+                                              data1_absyn *a, char *name);
+YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
+                                                data1_absyn *absyn,
+                                                char *name);
+YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
+YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, char *name);
+YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
+YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
+                                       data1_maptab *map, NMEM m);
+YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
+                                             const char *file);
+YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
+                                 data1_node *n, int selected, int *len);
+YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
+                                   int select, int *len);
+YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
+                                               data1_node *n, int select,
+                                               ODR o);
+YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh, 
+                                          data1_node *n, int select,
+                                          ODR o);
+YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
+                                 int *len);
+YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
+YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
+
+YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
+YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
+YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
+YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
+YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
+YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif