Added --with-yc option to configure. For the data1_node in data1.h:
[yaz-moved-to-github.git] / include / data1.h
index ef47cb8..dce4698 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-1997, Index Data.
+ * Copyright (c) 1995-1998, 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.28  1997-10-06 09:37:53  adam
+ * Revision 1.39  1998-10-28 15:10:06  adam
+ * Added --with-yc option to configure. For the data1_node in data1.h:
+ * decreased size of localdata and removed member "line" which wasn't useful.
+ *
+ * Revision 1.38  1998/10/15 08:29:15  adam
+ * Tag set type may be specified in reference to it using "tagset"
+ * directive in .abs-files and "include" directive in .tag-files.
+ *
+ * Revision 1.37  1998/10/13 16:09:46  adam
+ * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
+ * Added support for multiple attribute set references and tagset references
+ * from an abstract syntax file.
+ * Fixed many bad logs-calls in routines that read the various
+ * specifications regarding data1 (*.abs,*.att,...) and made the messages
+ * consistent whenever possible.
+ * Added extra 'lineno' argument to function readconf_line.
+ *
+ * Revision 1.36  1998/05/18 13:06:57  adam
+ * Changed the way attribute sets are handled by the retriaval module.
+ * Extended Explain conversion / schema.
+ * Modified server and client to work with ASN.1 compiled protocol handlers.
+ *
+ * Revision 1.35  1998/03/05 08:15:32  adam
+ * Implemented data1_add_insert_taggeddata utility which is more flexible
+ * than data1_insert_taggeddata.
+ *
+ * Revision 1.34  1998/02/27 14:08:04  adam
+ * Added const to some char pointer arguments.
+ * Reworked data1_read_node so that it doesn't create a tree with
+ * pointers to original "SGML"-buffer.
+ *
+ * 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
@@ -180,10 +232,12 @@ typedef struct data1_name
 } data1_name;
 
 typedef struct data1_absyn_cache_info *data1_absyn_cache;
+typedef struct data1_attset_cache_info *data1_attset_cache;
 
 typedef enum data1_datatype
 {
-    DATA1K_structured = 1,
+    DATA1K_unknown,
+    DATA1K_structured,
     DATA1K_string,
     DATA1K_numeric,
     DATA1K_bool,
@@ -195,12 +249,6 @@ typedef enum data1_datatype
     DATA1K_null
 } data1_datatype;
 
-typedef enum data1_structure
-{
-    DATA1S_word,
-    DATA1S_phrase
-} data1_structure;
-
 typedef struct data1_marctab
 {
     char *name;
@@ -281,20 +329,22 @@ typedef struct data1_tag
     struct data1_tag *next;
 } data1_tag;
 
-typedef struct data1_tagset
+typedef struct data1_tagset data1_tagset;
+
+struct data1_tagset
 {
+    int type;                        /* type of tagset in current context */
     char *name;                      /* symbolic name */
     oid_value reference;
-    int type;                        /* type of tagset in current context */
     data1_tag *tags;                 /* tags defined by this set */
-    struct data1_tagset *children;   /* included tagsets */
-    struct data1_tagset *next;       /* sibling */
-} data1_tagset;
+    data1_tagset *children;          /* children */
+    data1_tagset *next;              /* sibling */
+};
 
 typedef struct data1_termlist
 {
     data1_att *att;
-    data1_structure structure;
+    char *structure;
     struct data1_termlist *next;
 } data1_termlist;
 
@@ -307,11 +357,17 @@ typedef struct data1_element
     char *name;
     data1_tag *tag;
     data1_termlist *termlists;
-    struct data1_element *parent;
+    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;
@@ -322,7 +378,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;
 
 /*
@@ -331,13 +388,13 @@ typedef struct data1_absyn
 
 typedef struct data1_node
 {
-        /* the root of a record (containing global data) */
+    /* the root of a record (containing global data) */
 #define DATA1N_root 1 
-        /* a tag */
+    /* a tag */
 #define DATA1N_tag  2       
-        /* some data under a leaf tag or variant */
+    /* some data under a leaf tag or variant */
 #define DATA1N_data 3
-        /* variant specification (a triple, actually) */
+    /* variant specification (a triple, actually) */
 #define DATA1N_variant 4
     int which;
 
@@ -375,8 +432,6 @@ typedef struct data1_node
            int formatted_text;     /* newlines are significant */
            int len;
            char *data;      /* filename or data */
-#define DATA1_LOCALDATA 40
-           char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
        } data;
 
        struct
@@ -384,17 +439,11 @@ typedef struct data1_node
            data1_vartype *type;
            char *value;
        } variant;
-
-       struct
-       {
-           char *ind;
-       } indicator;
     } u;
 
     void (*destroy)(struct data1_node *n);
+#define DATA1_LOCALDATA 20
     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;
@@ -405,47 +454,55 @@ typedef struct data1_node
 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,
+YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const 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,
+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_tagset *data1_empty_tagset (data1_handle dh);
+YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, 
+                                          const char *file,
+                                          int type);
 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh, 
                                                    data1_absyn *abs,
                                                    data1_element *parent,
-                                                   char *tagname);
+                                                   const 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);
+                                        const 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);
+                                              const char *tagname, NMEM m);
+YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
+                                           data1_node *at,
+                                           const 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,
-                                      ODR o);
+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);
+                                              data1_absyn *a,
+                                              const char *name);
 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
                                                 data1_absyn *absyn,
-                                                char *name);
+                                                const 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_absyn *data1_get_absyn(data1_handle dh, const char *name);
+YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const 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);
@@ -470,8 +527,23 @@ 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 data1_attset_cache *data1_attset_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);
+YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
+                                     NMEM m, const char *str);
+YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
+                                       const char *buf);
+YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
+                                 void (*fh)(data1_handle dh,
+                                            void *h, data1_absyn *a));
+
+YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
+
+YAZ_EXPORT data1_node 
+*data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
+                             data1_node *at, const char *tagname, NMEM m,
+                             int first_flag, int local_allowed);
 #ifdef __cplusplus
 }
 #endif