Added the scope parameter to rsets, and using it in all forwards and reads
[idzebra-moved-to-github.git] / include / recctrl.h
1 /* $Id: recctrl.h,v 1.41 2004-08-06 12:28:22 adam Exp $
2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
3    Index Data Aps
4
5 This file is part of the Zebra server.
6
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.
21 */
22
23
24
25 #ifndef RECCTRL_H
26 #define RECCTRL_H
27
28 #include <yaz/proto.h>
29 #include <yaz/oid.h>
30 #include <yaz/odr.h>
31 #include <data1.h>
32 #include <zebramap.h>
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 /* single word entity */
39 typedef struct {
40     int  attrSet;
41     int  attrUse;
42     unsigned reg_type;
43     char *string;
44     int  length;
45     int  seqno;
46     ZebraMaps zebra_maps;
47     struct recExtractCtrl *extractCtrl;
48 } RecWord;
49
50 /* Extract record control */
51 struct recExtractCtrl {
52     void      *fh;                    /* File handle and read function     */
53     int       (*readf)(void *fh, char *buf, size_t count);
54     off_t     (*seekf)(void *fh, off_t offset);  /* seek function          */
55     off_t     (*tellf)(void *fh);                /* tell function          */
56     void      (*endf)(void *fh, off_t offset);   /* end of record position */
57     off_t     offset;                            /* start offset           */
58     char      *subType;
59     void      (*init)(struct recExtractCtrl *p, RecWord *w);
60     void      *clientData;
61     void      (*tokenAdd)(RecWord *w);
62     ZebraMaps zebra_maps;
63     int       flagShowRecords;
64     int       seqno[256];
65     void      (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
66     data1_handle dh;
67     void      *handle;
68 };
69
70 /* Retrieve record control */
71 struct recRetrieveCtrl {
72     /* Input parameters ... */
73     Res       res;                    /* Resource pool                     */
74     ODR       odr;                    /* ODR used to create response       */
75     void     *fh;                     /* File descriptor and read function */
76     int       (*readf)(void *fh, char *buf, size_t count);
77     off_t     (*seekf)(void *fh, off_t offset);
78     off_t     (*tellf)(void *fh);
79     oid_value input_format;           /* Preferred record syntax           */
80     Z_RecordComposition *comp;        /* formatting instructions           */
81     char      *encoding;              /* preferred character encoding      */
82     zint      localno;                /* local id of record                */
83     int       score;                  /* score 0-1000 or -1 if none        */
84     int       recordSize;             /* size of record in bytes */
85     char      *fname;                 /* name of file (or NULL if internal) */
86     char      *subType;
87     data1_handle dh;
88     
89     /* response */
90     oid_value  output_format;
91     void       *rec_buf;
92     int        rec_len;
93     int        diagnostic;
94     char *message;
95 };
96
97 typedef struct recType *RecType;
98
99 struct recType
100 {
101     char *name;                           /* Name of record type */
102     void *(*init)(RecType recType);       /* Init function - called once */
103     void (*destroy)(void *clientData);    /* Destroy function */
104     int  (*extract)(void *clientData,
105                     struct recExtractCtrl *ctrl);   /* Extract proc */
106     int  (*retrieve)(void *clientData,
107                      struct recRetrieveCtrl *ctrl); /* Retrieve proc */
108 };
109
110 #define RECCTRL_EXTRACT_OK    0
111 #define RECCTRL_EXTRACT_EOF   1
112 #define RECCTRL_EXTRACT_ERROR_GENERIC 2
113 #define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
114
115 typedef struct recTypes *RecTypes;
116
117 RecTypes recTypes_init (data1_handle dh);
118 void recTypes_destroy (RecTypes recTypes);
119 void recTypes_default_handlers (RecTypes recTypes);
120
121 RecType recType_byName (RecTypes rts, const char *name, char *subType,
122                         void **clientDataP);
123
124 int grs_extract_tree(struct recExtractCtrl *p, data1_node *n);
125
126 #ifdef __cplusplus
127 }
128 #endif
129
130 #endif