Updated footer comment

[idzebra-moved-to-github.git] / include / idzebra / recctrl.h

diff --git a/include/idzebra/recctrl.h b/include/idzebra/recctrl.h
index ac5f448..a7df4a7 100644 (file)
--- a/include/idzebra/recctrl.h
+++ b/include/idzebra/recctrl.h
@@ -1,8 +1,5 @@
-/* $Id: recctrl.h,v 1.32 2007-03-14 11:48:31 adam Exp $
-   Copyright (C) 1995-2007
-   Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+   Copyright (C) 1994-2009 Index Data
 
 Zebra is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -25,7 +22,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 #include <sys/types.h>
 #include <yaz/proto.h>
-#include <yaz/oid.h>
 #include <yaz/odr.h>
 #include <idzebra/res.h>
 #include <idzebra/data1.h>
@@ -50,8 +46,8 @@ YAZ_BEGIN_CDECL
 
 /** Indexing token */
 typedef struct {
-    /** index type ('w', 'p', .. */
-    unsigned index_type;
+    /** index type, e.g. "w", "p", .. */
+    const char *index_type;
     /** index name, e.g. "title" */
     const char *index_name;
     /** token char data */
@@ -85,11 +81,18 @@ struct ZebraRecStream {
     void      (*destroy)(struct ZebraRecStream *s);
 };
 
+/** record update action */
 enum zebra_recctrl_action_t {
+    /** insert record (fail if it exists already) */
     action_insert = 1,
+    /** replace record (fail it it does not exist) */
     action_replace,
+    /** delete record (fail if it does not exist) */
     action_delete,
-    action_update  /* insert or replace as needed */
+    /** insert or replace */
+    action_update,
+    /** delete record (ignore if it does not exist) */
+    action_a_delete
 };
 
 /** \brief record extract for indexing */
@@ -101,12 +104,12 @@ struct recExtractCtrl {
     void      (*setStoreData)(struct recExtractCtrl *p, void *buf, size_t size);
     int       first_record;
     int       flagShowRecords;
-    int       seqno[256];
     char      match_criteria[256];
     zint      staticrank;
     void      (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
     data1_handle dh;
     void      *handle;
+    enum zebra_recctrl_action_t action;
 };
 
 /* Retrieve record control */
@@ -115,7 +118,7 @@ struct recRetrieveCtrl {
     /* Input parameters ... */
     Res       res;                   /* Resource pool                     */
     ODR       odr;                    /* ODR used to create response       */
-    oid_value input_format;           /* Preferred record syntax           */
+    const Odr_oid * input_format;     /* Preferred record syntax OID       */
     Z_RecordComposition *comp;        /* formatting instructions           */
     char      *encoding;              /* preferred character encoding      */
     zint      localno;                /* local id of record                */
@@ -124,15 +127,20 @@ struct recRetrieveCtrl {
     int       recordSize;             /* size of record in bytes */
     char      *fname;                 /* name of file (or NULL if internal) */
     data1_handle dh;
-    zebra_snippets *hit_snippet;
-    zebra_snippets *doc_snippet;
     
     /* response */
-    oid_value  output_format;
-    void       *rec_buf;
+    const Odr_oid * output_format;    /* output format OID */
+    void *     rec_buf;
     int        rec_len;
     int        diagnostic;
-    char       *addinfo;
+    char *     addinfo;
+    
+    /* special fetch to be included in retrieved response (say snippets) */
+    void *handle;
+    int (*special_fetch)(void *handle, const char *esn,
+                         const Odr_oid *input_format,
+                         const Odr_oid **output_format,
+                         WRBUF result, WRBUF addinfo);
 };
 
 typedef struct recType *RecType;
@@ -196,6 +204,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab