Towards 1.3.15
[idzebra-moved-to-github.git] / perl / IDZebra.i
1 %module "IDZebra"
2 %include typemaps.i                       // Load the typemaps librayr
3
4
5 %{
6 #include "zebraapi.h"
7 #include "zebra_perl.h"
8 #include "data1.h"
9 #include "yaz/odr.h"
10 #include "yaz/cql.h"
11 %}
12
13 /* == Typemaps ============================================================= */
14
15 %typemap(in) int * {
16   int i;
17   if (!SvIOK($input)) 
18     croak("Argument $argnum is not an integer.");
19   i = SvIV($input);
20   $1 = &i;
21 }
22
23 %typemap(out) int * {
24   $result=newSViv($1)  
25   sv_2mortal($result);
26   argvi++;
27 }
28
29 /* RetrievalRecordBuff is a special construct, to allow to map a char * buf
30    to non-null terminated perl string scalar value (SVpv). */
31 %typemap(out) RetrievalRecordBuf * {
32   if ($1->len) {
33     $result = newSVpv($1->buf,$1->len);
34   } else {
35     $result = newSVpv("",0);
36   }
37   sv_2mortal($result);
38   argvi++;
39 }
40
41 /* All char ** values are mapped in-out to array of strings. */
42 %typemap(in) char ** {
43         AV *tempav;
44         I32 len;
45         int i;
46         SV  **tv;
47         STRLEN na;
48         if (!SvROK($input))
49             croak("Argument $argnum is not a reference.");
50         if (SvTYPE(SvRV($input)) != SVt_PVAV)
51             croak("Argument $argnum is not an array.");
52         tempav = (AV*)SvRV($input);
53         len = av_len(tempav);
54         $1 = (char **) malloc((len+2)*sizeof(char *));
55         for (i = 0; i <= len; i++) {
56             tv = av_fetch(tempav, i, 0);        
57             $1[i] = (char *) SvPV(*tv,na);
58         }
59         $1[i] = NULL;
60 };
61
62 /* This cleans up the char ** array after the function call */
63 %typemap(freearg) char ** {
64         free($1);
65 }
66
67 /* Creates a new Perl array and places a NULL-terminated char ** into it */
68 %typemap(out) char ** {
69         AV *myav;
70         SV **svs;
71         int i = 0,len = 0;
72         /* Figure out how many elements we have */
73         while ($1[len])
74            len++;
75         svs = (SV **) malloc(len*sizeof(SV *));
76         for (i = 0; i < len ; i++) {
77             svs[i] = sv_newmortal();
78             sv_setpv((SV*)svs[i],$1[i]);
79         };
80         myav =  av_make(len,svs);
81         free(svs);
82         $result = newRV((SV*)myav);
83         sv_2mortal($result);
84         argvi++;
85 }
86
87 /* == Structures for shadow classes  ======================================= */
88
89
90 /*%include "zebra_perl.h" */
91 typedef struct {
92     char  *groupName;
93     char  *databaseName;
94     char  *path;
95     char  *recordId;
96     char  *recordType;
97     int   flagStoreData;
98     int   flagStoreKeys;
99     int   flagRw;
100     int   fileVerboseLimit;
101     int   databaseNamePath;
102     int   explainDatabase;
103     int   followLinks;
104 } recordGroup;
105
106 typedef struct {
107   int noOfRecords;
108   ZebraRetrievalRecord *records;
109 } RetrievalObj;
110
111 typedef struct {
112   int  errCode;        /* non-zero if error when fetching this */
113   char *errString;     /* error string */
114   int  position;       /* position of record in result set (1,2,..) */
115   char *base; 
116   int  sysno;
117   int  score;
118   char *format;    /* record syntax */
119   RetrievalRecordBuf *buf;
120 } RetrievalRecord;
121
122 /* Scan Term Descriptor */
123 typedef struct {
124     int occurrences;     /* scan term occurrences */
125     char *term;          /* scan term string */
126 } scanEntry;
127
128 typedef struct {
129   int num_entries;
130   int position;
131   int is_partial;
132   scanEntry *entries;
133 } ScanObj;
134
135
136 typedef struct {
137   int processed;
138   int inserted;
139   int updated;
140   int deleted;
141   long utime;
142   long stime;
143 } ZebraTransactionStatus;
144
145 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
146
147 void init (void);
148 void DESTROY (void);
149
150 /* == Logging facilities (yaz/log.h) ======================================= */
151
152 %name(logLevel) 
153 void yaz_log_init_level (int level);
154
155 %name(logFile)
156 void yaz_log_init_file (const char *fname);
157
158 %name(logMsg)
159 void logMsg  (int level, const char *message);
160
161 %name(logPrefix)   
162 void yaz_log_init_prefix (const char *prefix);
163
164 %name(logPrefix2)   
165 void yaz_log_init_prefix2 (const char *prefix);
166
167 #define LOG_FATAL  0x0001
168 #define LOG_DEBUG  0x0002
169 #define LOG_WARN   0x0004
170 #define LOG_LOG    0x0008
171 #define LOG_ERRNO  0x0010     /* append strerror to message */
172 #define LOG_FILE   0x0020
173 #define LOG_APP    0x0040     /* For application level events */
174 #define LOG_MALLOC 0x0080     /* debugging mallocs */
175 #define LOG_ALL    0xff7f
176 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
177
178 /* == ODR stuff (yaz/odr.h) ================================================ */
179
180 #define ODR_DECODE      0
181 #define ODR_ENCODE      1
182 #define ODR_PRINT       2
183 ODR odr_createmem(int direction);
184 void odr_reset(ODR o);
185 void odr_destroy(ODR o);
186 void *odr_malloc(ODR o, int size);
187
188
189 /* == Zebra session and service (index/zebraapi.c) ========================= */
190
191 %name(start)     
192 ZebraService zebra_start (const char *configName);
193
194 %name(open)      
195 ZebraHandle zebra_open (ZebraService zs);
196
197 %name(close)     
198 void zebra_close (ZebraHandle zh);
199
200 %name(stop)      
201 void zebra_stop (ZebraService zs);
202
203
204 /* == Error handling and reporting (index/zebraapi.c) ====================== */
205
206 /* last error code */
207 %name(errCode)   
208 int zebra_errCode (ZebraHandle zh); 
209
210 /* string representatio of above */
211 %name(errString) 
212 const char * zebra_errString (ZebraHandle zh); 
213
214 /* extra information associated with error */
215 %name(errAdd)    
216 char *  zebra_errAdd (ZebraHandle zh); 
217
218
219 /* == Record groups and database selection ================================= */
220
221 /* initialize a recordGroup (zebra_api_ext.c); */
222 void init_recordGroup (recordGroup *rg);
223
224 /* set up a recordGroup for a specific file extension from zebra.cfg 
225    (zebra_api_ext.c); */
226 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg, 
227                           const char *ext); 
228 /* set current record group for update purposes (zebraapi.c) */
229 %name(set_group)           
230 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
231
232 /* select database for update purposes (zebraapi.c) */
233 %name(select_database)     
234 int zebra_select_database (ZebraHandle zh, const char *basename);
235
236 /* select databases for record retrieval (zebraapi.c) */
237 %name(select_databases)    
238 int zebra_select_databases (ZebraHandle zh, int num_bases, 
239                              const char **basenames);
240
241
242 /* == Transactions, locking, shadow register =============================== */
243
244 /* begin transaction (add write lock) (zebraapi.c) */
245 %name(begin_trans)         
246 int zebra_begin_trans (ZebraHandle zh, int rw);
247
248 /* end transaction (remove write lock) (zebraapi.c) */
249 %name(end_trans)           
250 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat); 
251
252 %name(trans_no)
253 int zebra_trans_no (ZebraHandle zh);
254
255 /* commit changes from shadow (zebraapi.c) */
256 %name(commit)              
257 int  zebra_commit (ZebraHandle zh);
258
259 /* get shadow status (zebra_api_ext.c) */
260 %name(get_shadow_enable)   
261 int  zebra_get_shadow_enable (ZebraHandle zh);
262
263 /* set shadow status (zebra_api_ext.c) */
264 %name(set_shadow_enable)   
265 void zebra_set_shadow_enable (ZebraHandle zh, int value);
266
267
268 /* == Repository actions (zebraapi.c) ====================================== */
269
270 %name(init)                
271 int  zebra_init (ZebraHandle zh);
272
273 %name(compact)             
274 int  zebra_compact (ZebraHandle zh);
275
276 %name(repository_update)   
277 void zebra_repository_update (ZebraHandle zh);
278
279 %name(repository_delete)   
280 void zebra_repository_delete (ZebraHandle zh);
281
282 %name(repository_show)     
283 void zebra_repository_show (ZebraHandle zh); 
284
285
286 /* == Record update/delete (zebra_api_ext.c) =============================== */
287
288 /* If sysno is provided, then it's used to identify the reocord.
289    If not, and match_criteria is provided, then sysno is guessed
290    If not, and a record is provided, then sysno is got from there */
291
292 %apply int *REFERENCE { int *sysno };
293 %name(insert_record)       
294 int zebra_insert_record (ZebraHandle zh, 
295                          recordGroup *rGroup, 
296                          const char *recordType,
297                          int *sysno, 
298                          const char *match, 
299                          const char *fname,
300                          const char *buf, 
301                          int buf_size,
302                          int force_update);
303
304 %name(update_record)       
305 int zebra_update_record (ZebraHandle zh, 
306                          recordGroup *rGroup, 
307                          const char *recordType,
308                          int *sysno, 
309                          const char *match, 
310                          const char *fname,
311                          const char *buf, 
312                          int buf_size,
313                          int force_update);
314      
315 %name(delete_record)       
316 int zebra_delete_record (ZebraHandle zh, 
317                          recordGroup *rGroup, 
318                          const char *recordType,
319                          int *sysno, 
320                          const char *match, 
321                          const char *fname,
322                          const char *buf, 
323                          int buf_size,
324                          int force_update);
325
326
327 /* == Search (zebraapi.c) ================================================== */
328 %include "typemaps.i"
329 %apply int *REFERENCE { int *hits };
330 %name(search_PQF) 
331 int zebra_search_PQF (ZebraHandle zh, 
332                       const char *pqf_query,
333                       const char *setname,
334                       int *hits);
335
336 /* == YAZ - query tools ==================================================== */
337
338
339 cql_transform_t cql_transform_open_fname(const char *fname);
340 void cql_transform_close(cql_transform_t ct);
341 int cql_transform_error(cql_transform_t ct, const char **addinfo);
342
343 %name(cql2pqf) 
344 int zebra_cql2pqf (cql_transform_t ct, 
345                    const char *query, char *res, int len);
346
347 /* == Retrieval (zebra_api_ext.c) ========================================== */
348
349 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be 
350    used to get the individual records. Elementset, schema and format strings
351    are threated the same way yaz-client does. */
352 void records_retrieve(ZebraHandle zh,
353                       ODR stream,
354                       const char *setname,      // resultset name
355                       const char *a_eset,       // optional elementset
356                       const char *a_schema,     // optional schema
357                       const char *a_format,     // optional record syntax
358                       int from,                 // range, 1 based
359                       int to,
360                       RetrievalObj *res
361                       );
362
363 /* fetch a record from the retrieval object. pos is 1 based */
364 void record_retrieve(RetrievalObj *ro,
365                      ODR stream,
366                      RetrievalRecord *res,
367                      int pos);
368
369 /* Delete Result Set(s) (zebraapi.c) */
370 %name(deleteResultSet)
371 int zebra_deleleResultSet(ZebraHandle zh, int function,
372                           int num_setnames, char **setnames,
373                           int *statuses);
374
375
376 /* Resultset terms */
377 %name(resultSetTerms)
378 int zebra_resultSetTerms (ZebraHandle zh, const char *setname, 
379                           int no, int *REFERENCE, 
380                           int *REFERENCE, char *out, int *REFERENCE);
381
382 /* == Sort ================================================================= */
383 %name(sort)
384 int zebra_sort_by_specstr (ZebraHandle zh, 
385           ODR stream,
386           const char *sort_spec,
387           const char *output_setname,
388           const char **input_setnames
389           ); 
390
391 /* == Scan ================================================================= */
392 %name(scan_PQF) 
393 void zebra_scan_PQF (ZebraHandle zh,
394                      ScanObj *so,
395                      ODR stream,
396                      const char *pqf_query);
397
398 scanEntry *getScanEntry(ScanObj *so, int pos);
399
400 %typemap(in) int * (int dvalue);
401 %typemap(argout) int *;
402
403
404 /* Admin functionality */
405 /*
406 %name(admin_start)         void zebra_admin_start (ZebraHandle zh);
407 %name(admin_shutdown)      void zebra_admin_shutdown (ZebraHandle zh);
408 */
409
410
411
412 /* do authentication */
413 /*
414 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
415
416 */
417
418
419 /*
420
421 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
422 int zebra_resultSetTerms (ZebraHandle zh, const char *setname, 
423                           int no, int *count, 
424                           int *type, char *out, size_t *len);
425 */
426
427 /*
428 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
429
430 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
431
432 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
433                                             Z_Segment *segment);
434
435 void zebra_admin_shutdown (ZebraHandle zh);
436 void zebra_admin_start (ZebraHandle zh);
437 void zebra_admin_import_end (ZebraHandle zh);
438
439
440 */
441
442
443 /* =========================================================================
444  * NMEM stuff
445  * ========================================================================= 
446 */
447
448 NMEM         nmem_create (void);
449 void         nmem_destroy (NMEM handle);
450
451 /* =========================================================================
452  * Data1 stuff
453  * ========================================================================= 
454 */
455
456 typedef enum data1_datatype
457 {
458     DATA1K_unknown,
459     DATA1K_structured,
460     DATA1K_string,
461     DATA1K_numeric,
462     DATA1K_bool,
463     DATA1K_oid,
464     DATA1K_generalizedtime,
465     DATA1K_intunit,
466     DATA1K_int,
467     DATA1K_octetstring,
468     DATA1K_null
469 } data1_datatype;
470
471 #define DATA1T_numeric 1
472 #define DATA1T_string 2
473 #define DATA1N_root 1 
474 #define DATA1N_tag  2       
475 #define DATA1N_data 3
476 #define DATA1N_variant 4
477 #define DATA1N_comment 5
478 #define DATA1N_preprocess 6
479 #define DATA1I_inctxt 1
480 #define DATA1I_incbin 2
481 #define DATA1I_text 3 
482 #define DATA1I_num 4
483 #define DATA1I_oid 5         
484 #define DATA1_LOCALDATA 12
485 #define DATA1_FLAG_XML  1
486
487 data1_handle data1_create (void);
488 data1_handle data1_createx (int flags);
489 void data1_destroy(data1_handle dh);
490
491 /* Data1 node */
492 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
493 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
494 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
495 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
496 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
497 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
498
499 data1_tagset *data1_empty_tagset (data1_handle dh);
500 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
501 data1_element *data1_getelementbytagname(data1_handle dh,
502                                          data1_absyn *abs,
503                                          data1_element *parent,
504                                          const char *tagname);
505
506 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
507                                 int select, ODR o,
508                                 int *len);
509
510 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
511                               const char *name);
512
513 void data1_free_tree(data1_handle dh, data1_node *t);
514
515 char *data1_nodetobuf(data1_handle dh, data1_node *n,
516                       int select, int *len);
517
518 data1_node *data1_mk_tag_data_wd(data1_handle dh,
519                                  data1_node *at,
520                                  const char *tagname, NMEM m);
521 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
522                               const char *tagname, NMEM m);
523 data1_datatype data1_maptype(data1_handle dh, char *t);
524 data1_varset *data1_read_varset(data1_handle dh, const char *file);
525 data1_vartype *data1_getvartypebyct(data1_handle dh,
526                                     data1_varset *set,
527                                     char *zclass, char *type);
528 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
529 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
530
531 data1_esetname *data1_getesetbyname(data1_handle dh, 
532                                     data1_absyn *a,
533                                     const char *name);
534 data1_element *data1_getelementbyname(data1_handle dh,
535                                                  data1_absyn *absyn,
536                                                  const char *name);
537 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
538                                       int type, data1_node *parent);
539
540 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem, 
541                                      const char *tag, const char **attr,
542                                      data1_node *at);
543 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
544                                        const char *tag, size_t len,
545                                        const char **attr,
546                                        data1_node *at);
547 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
548                                     data1_node *res, const char **attr);
549
550 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
551                                         const char *buf, size_t len,
552                                         data1_node *parent);
553 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
554                                          const char *buf, size_t len,
555                                          data1_node *parent);
556 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
557                                       const char *buf, data1_node *parent);
558
559 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
560                                            const char *buf, size_t len,
561                                            data1_node *parent);
562
563 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
564                                          const char *buf, data1_node *parent);
565
566 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
567                                             const char *target,
568                                             const char **attr,
569                                             data1_node *at);
570
571 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
572                                       const char *name);
573 void data1_set_root(data1_handle dh, data1_node *res,
574                                NMEM nmem, const char *name);
575
576 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
577                                               const char *tag, int num,
578                                               NMEM nmem);
579 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
580                                               const char *tag, Odr_oid *oid,
581                                               NMEM nmem);
582 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
583                                                const char *tag,
584                                                const char *str,
585                                                NMEM nmem);
586 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
587                                                    data1_node *at,
588                                                    const char *tag,
589                                                    const char *str,
590                                                    NMEM nmem);
591
592 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
593
594 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
595                                          const char *tag);
596 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem, 
597                                          const char *tag, data1_node *at);
598 data1_attset *data1_get_attset (data1_handle dh, const char *name);
599 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
600 data1_node *data1_map_record(data1_handle dh, data1_node *n,
601                                         data1_maptab *map, NMEM m);
602 data1_marctab *data1_read_marctab (data1_handle dh,
603                                               const char *file);
604 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
605                                   data1_node *n, int selected, int *len);
606 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
607                                     int select, int *len);
608 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
609                                                 data1_node *n, int select,
610                                                 ODR o);
611 Z_BriefBib *data1_nodetosummary(data1_handle dh, 
612                                            data1_node *n, int select,
613                                            ODR o);
614 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
615                                   int *len);
616 WRBUF data1_get_wrbuf (data1_handle dp);
617 char **data1_get_read_buf (data1_handle dp, int **lenp);
618 char **data1_get_map_buf (data1_handle dp, int **lenp);
619 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
620 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
621 NMEM data1_nmem_get (data1_handle dh);
622
623 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
624 void data1_print_tree (data1_handle dh, data1_node *n);
625
626
627 char *data1_insert_string (data1_handle dh, data1_node *res,
628                                       NMEM m, const char *str);
629 char *data1_insert_string_n (data1_handle dh, data1_node *res,
630                                         NMEM m, const char *str, size_t len);
631 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
632                                         const char *buf);
633 /*
634 data1_node *data1_read_xml (data1_handle dh,
635                                        int (*rf)(void *, char *, size_t),
636                                        void *fh, NMEM m);
637 */
638 void data1_absyn_trav (data1_handle dh, void *handle,
639                                   void (*fh)(data1_handle dh,
640                                              void *h, data1_absyn *a));
641
642 data1_attset *data1_attset_search_id (data1_handle dh, int id);
643
644 char *data1_getNodeValue(data1_node* node, char* pTagPath);
645 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
646 int data1_CountOccurences(data1_node* node, char* pTagPath);
647
648  
649 FILE *data1_path_fopen (data1_handle dh, const char *file,
650                                    const char *mode);
651 void data1_set_tabpath(data1_handle dh, const char *path);
652 void data1_set_tabroot (data1_handle dp, const char *p);
653 const char *data1_get_tabpath(data1_handle dh);
654 const char *data1_get_tabroot(data1_handle dh);
655
656
657
658 /* =========================================================================
659  * Filter stuff
660  * ========================================================================= 
661  */
662 int grs_perl_readf(struct perl_context *context, size_t len);
663 int grs_perl_readline(struct perl_context *context);
664 char grs_perl_getc(struct perl_context *context);
665 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
666 off_t grs_perl_tellf(struct perl_context *context);
667 void grs_perl_endf(struct perl_context *context, off_t offset);
668
669 data1_handle *grs_perl_get_dh(struct perl_context *context);
670 NMEM *grs_perl_get_mem(struct perl_context *context);
671 void grs_perl_set_res(struct perl_context *context, data1_node *n);
672