f3e62766d95067d567388739ded5f03990b5027c
[idzebra-moved-to-github.git] / perl / IDZebra.i
1 %module "IDZebra"
2 %include typemaps.i                       // Load the typemaps librayr
3
4
5 %{
6 #include <idzebra/api.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 /* * * * * *  Fix for broken swig implementation */
30 %typemap(argout) long long *INOUT {
31     char temp[256];
32     if (argvi >= items) {
33         EXTEND(sp,1);
34     }
35  /* sprintf(temp,"%lld", $1); */
36     sprintf(temp,"%lld", *$1);
37     $result = sv_newmortal();
38     sv_setpv($result,temp);
39     argvi++;
40 }
41
42
43 /* RetrievalRecordBuff is a special construct, to allow to map a char * buf
44    to non-null terminated perl string scalar value (SVpv). */
45 %typemap(out) RetrievalRecordBuf * {
46   if ($1->len) {
47     $result = newSVpv($1->buf,$1->len);
48   } else {
49     $result = newSVpv("",0);
50   }
51   sv_2mortal($result);
52   argvi++;
53 }
54
55 /* All char ** values are mapped in-out to array of strings. */
56 %typemap(in) char ** {
57         AV *tempav;
58         I32 len;
59         int i;
60         SV  **tv;
61         STRLEN na;
62         if (!SvROK($input))
63             croak("Argument $argnum is not a reference.");
64         if (SvTYPE(SvRV($input)) != SVt_PVAV)
65             croak("Argument $argnum is not an array.");
66         tempav = (AV*)SvRV($input);
67         len = av_len(tempav);
68         $1 = (char **) malloc((len+2)*sizeof(char *));
69         for (i = 0; i <= len; i++) {
70             tv = av_fetch(tempav, i, 0);        
71             $1[i] = (char *) SvPV(*tv,na);
72         }
73         $1[i] = NULL;
74 };
75
76 /* This cleans up the char ** array after the function call */
77 %typemap(freearg) char ** {
78         free($1);
79 }
80
81 /* Creates a new Perl array and places a NULL-terminated char ** into it */
82 %typemap(out) char ** {
83         AV *myav;
84         SV **svs;
85         int i = 0,len = 0;
86         /* Figure out how many elements we have */
87         while ($1[len])
88            len++;
89         svs = (SV **) malloc(len*sizeof(SV *));
90         for (i = 0; i < len ; i++) {
91             svs[i] = sv_newmortal();
92             sv_setpv((SV*)svs[i],$1[i]);
93         };
94         myav =  av_make(len,svs);
95         free(svs);
96         $result = newRV((SV*)myav);
97         sv_2mortal($result);
98         argvi++;
99 }
100
101 /* == Structures for shadow classes  ======================================= */
102
103
104 /*%include "zebra_perl.h" */
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   long long 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 /* == Zebra resources and database selection =============================== */
220
221 /* set a resource */
222 %name(set_resource)     
223 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
224
225 /* get a resource */
226 %name(get_resource)     
227 const char *zebra_set_resource(ZebraHandle zh, const char *name,
228                                const char *defaultvalue);
229
230 /* select database for update purposes (zebraapi.c) */
231 %name(select_database)     
232 int zebra_select_database (ZebraHandle zh, const char *basename);
233
234 /* select databases for record retrieval (zebraapi.c) */
235 %name(select_databases)    
236 int zebra_select_databases (ZebraHandle zh, int num_bases, 
237                              const char **basenames);
238
239
240 /* == Transactions, locking, shadow register =============================== */
241
242 /* begin transaction (add write lock) (zebraapi.c) */
243 %name(begin_trans)         
244 int zebra_begin_trans (ZebraHandle zh, int rw);
245
246 /* end transaction (remove write lock) (zebraapi.c) */
247 %name(end_trans)           
248 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat); 
249
250 %name(trans_no)
251 int zebra_trans_no (ZebraHandle zh);
252
253 /* commit changes from shadow (zebraapi.c) */
254 %name(commit)              
255 int  zebra_commit (ZebraHandle zh);
256
257 /* get shadow status (zebra_api_ext.c) */
258 %name(get_shadow_enable)   
259 int  zebra_get_shadow_enable (ZebraHandle zh);
260
261 /* set shadow status (zebra_api_ext.c) */
262 %name(set_shadow_enable)   
263 void zebra_set_shadow_enable (ZebraHandle zh, int value);
264
265
266 /* == Repository actions (zebraapi.c) ====================================== */
267
268 %name(init)                
269 int  zebra_init (ZebraHandle zh);
270
271 %name(compact)             
272 int  zebra_compact (ZebraHandle zh);
273
274 %name(repository_update)   
275 void zebra_repository_update (ZebraHandle zh, const char *path);
276
277 %name(repository_delete)   
278 void zebra_repository_delete (ZebraHandle zh, const char *path);
279
280 %name(repository_show)     
281 void zebra_repository_show (ZebraHandle zh, const char *path); 
282
283
284 /* == Record update/delete (zebra_api_ext.c) =============================== */
285
286 /* If sysno is provided, then it's used to identify the reocord.
287    If not, and match_criteria is provided, then sysno is guessed
288    If not, and a record is provided, then sysno is got from there */
289
290 %apply long long *INOUT { long long *sysno };
291
292 %name(insert_record)       
293 int zebra_insert_record (ZebraHandle zh, 
294                          const char *recordType,
295                          long long *sysno, 
296                          const char *match, 
297                          const char *fname,
298                          const char *buf, 
299                          int buf_size,
300                          int force_update);
301 /* actually, susno is only output param in insert_record, but kept */
302 /* as inout for symmetry in the interface. The session class assures */
303 /* that nothing goes in... */
304
305
306 %name(update_record)       
307 int zebra_update_record (ZebraHandle zh, 
308                          const char *recordType,
309                          long long *sysno, 
310                          const char *match, 
311                          const char *fname,
312                          const char *buf, 
313                          int buf_size,
314                          int force_update);
315      
316 %name(delete_record)       
317 int zebra_delete_record (ZebraHandle zh, 
318                          const char *recordType,
319                          long long *sysno, 
320                          const char *match, 
321                          const char *fname,
322                          const char *buf, 
323                          int buf_size,
324                          int force_update);
325
326 /* == Search (zebraapi.c) ================================================== */
327 %include "typemaps.i"
328 %apply int *REFERENCE { int *hits };
329 %name(search_PQF) 
330 int zebra_search_PQF (ZebraHandle zh, 
331                       const char *pqf_query,
332                       const char *setname,
333                       int *hits);
334
335 /* == YAZ - query tools ==================================================== */
336
337
338 cql_transform_t cql_transform_open_fname(const char *fname);
339 void cql_transform_close(cql_transform_t ct);
340 int cql_transform_error(cql_transform_t ct, const char **addinfo);
341
342 %name(cql2pqf) 
343 int zebra_cql2pqf (cql_transform_t ct, 
344                    const char *query, char *res, int len);
345
346 /* == Retrieval (zebra_api_ext.c) ========================================== */
347
348 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be 
349    used to get the individual records. Elementset, schema and format strings
350    are threated the same way yaz-client does. */
351 void records_retrieve(ZebraHandle zh,
352                       ODR stream,
353                       const char *setname,      // resultset name
354                       const char *a_eset,       // optional elementset
355                       const char *a_schema,     // optional schema
356                       const char *a_format,     // optional record syntax
357                       int from,                 // range, 1 based
358                       int to,
359                       RetrievalObj *res
360                       );
361
362 /* fetch a record from the retrieval object. pos is 1 based */
363 void record_retrieve(RetrievalObj *ro,
364                      ODR stream,
365                      RetrievalRecord *res,
366                      int pos);
367
368 /* Delete Result Set(s) (zebraapi.c) */
369 %name(deleteResultSet)
370 int zebra_deleleResultSet(ZebraHandle zh, int function,
371                           int num_setnames, char **setnames,
372                           int *statuses);
373
374
375 /* Resultset terms */
376 /* disabled
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
383 /* == Sort ================================================================= */
384 %name(sort)
385 int zebra_sort_by_specstr (ZebraHandle zh, 
386           ODR stream,
387           const char *sort_spec,
388           const char *output_setname,
389           const char **input_setnames
390           ); 
391
392 /* == Scan ================================================================= */
393 %name(scan_PQF) 
394 void zebra_scan_PQF (ZebraHandle zh,
395                      ScanObj *so,
396                      ODR stream,
397                      const char *pqf_query);
398
399 scanEntry *getScanEntry(ScanObj *so, int pos);
400
401 %typemap(in) int * (int dvalue);
402 %typemap(argout) int *;
403
404
405 /* Admin functionality */
406 /*
407 %name(admin_start)         void zebra_admin_start (ZebraHandle zh);
408 %name(admin_shutdown)      void zebra_admin_shutdown (ZebraHandle zh);
409 */
410
411
412
413 /* do authentication */
414 /*
415 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
416
417 */
418
419
420 /*
421
422 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
423 int zebra_resultSetTerms (ZebraHandle zh, const char *setname, 
424                           int no, int *count, 
425                           int *type, char *out, size_t *len);
426 */
427
428 /*
429 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
430
431 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
432
433 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
434                                             Z_Segment *segment);
435
436 void zebra_admin_shutdown (ZebraHandle zh);
437 void zebra_admin_start (ZebraHandle zh);
438 void zebra_admin_import_end (ZebraHandle zh);
439
440
441 */
442
443
444 /* =========================================================================
445  * NMEM stuff
446  * ========================================================================= 
447 */
448
449 NMEM         nmem_create (void);
450 void         nmem_destroy (NMEM handle);
451
452 /* =========================================================================
453  * Data1 stuff
454  * ========================================================================= 
455 */
456
457 typedef enum data1_datatype
458 {
459     DATA1K_unknown,
460     DATA1K_structured,
461     DATA1K_string,
462     DATA1K_numeric,
463     DATA1K_bool,
464     DATA1K_oid,
465     DATA1K_generalizedtime,
466     DATA1K_intunit,
467     DATA1K_int,
468     DATA1K_octetstring,
469     DATA1K_null
470 } data1_datatype;
471
472 #define DATA1T_numeric 1
473 #define DATA1T_string 2
474 #define DATA1N_root 1 
475 #define DATA1N_tag  2       
476 #define DATA1N_data 3
477 #define DATA1N_variant 4
478 #define DATA1N_comment 5
479 #define DATA1N_preprocess 6
480 #define DATA1I_inctxt 1
481 #define DATA1I_incbin 2
482 #define DATA1I_text 3 
483 #define DATA1I_num 4
484 #define DATA1I_oid 5         
485 #define DATA1_LOCALDATA 12
486 #define DATA1_FLAG_XML  1
487
488 data1_handle data1_create (void);
489 data1_handle data1_createx (int flags);
490 void data1_destroy(data1_handle dh);
491
492 /* Data1 node */
493 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
494 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
495 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
496 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
497 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
498 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
499
500 data1_tagset *data1_empty_tagset (data1_handle dh);
501 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
502 data1_element *data1_getelementbytagname(data1_handle dh,
503                                          data1_absyn *abs,
504                                          data1_element *parent,
505                                          const char *tagname);
506
507 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
508                                 int select, ODR o,
509                                 int *len);
510
511 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
512                               const char *name);
513
514 void data1_free_tree(data1_handle dh, data1_node *t);
515
516 char *data1_nodetobuf(data1_handle dh, data1_node *n,
517                       int select, int *len);
518
519 data1_node *data1_mk_tag_data_wd(data1_handle dh,
520                                  data1_node *at,
521                                  const char *tagname, NMEM m);
522 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
523                               const char *tagname, NMEM m);
524 data1_datatype data1_maptype(data1_handle dh, char *t);
525 data1_varset *data1_read_varset(data1_handle dh, const char *file);
526 data1_vartype *data1_getvartypebyct(data1_handle dh,
527                                     data1_varset *set,
528                                     char *zclass, char *type);
529 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
530 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
531
532 data1_esetname *data1_getesetbyname(data1_handle dh, 
533                                     data1_absyn *a,
534                                     const char *name);
535 data1_element *data1_getelementbyname(data1_handle dh,
536                                                  data1_absyn *absyn,
537                                                  const char *name);
538 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
539                                       int type, data1_node *parent);
540
541 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem, 
542                                      const char *tag, const char **attr,
543                                      data1_node *at);
544 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
545                                        const char *tag, size_t len,
546                                        const char **attr,
547                                        data1_node *at);
548 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
549                                     data1_node *res, const char **attr);
550
551 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
552                                         const char *buf, size_t len,
553                                         data1_node *parent);
554 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
555                                          const char *buf, size_t len,
556                                          data1_node *parent);
557 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
558                                       const char *buf, data1_node *parent);
559
560 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
561                                            const char *buf, size_t len,
562                                            data1_node *parent);
563
564 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
565                                          const char *buf, data1_node *parent);
566
567 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
568                                             const char *target,
569                                             const char **attr,
570                                             data1_node *at);
571
572 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
573                                       const char *name);
574 void data1_set_root(data1_handle dh, data1_node *res,
575                                NMEM nmem, const char *name);
576
577 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
578                                               const char *tag, int num,
579                                               NMEM nmem);
580 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
581                                               const char *tag, Odr_oid *oid,
582                                               NMEM nmem);
583 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
584                                                const char *tag,
585                                                const char *str,
586                                                NMEM nmem);
587 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
588                                                    data1_node *at,
589                                                    const char *tag,
590                                                    const char *str,
591                                                    NMEM nmem);
592
593 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
594
595 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
596                                          const char *tag);
597 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem, 
598                                          const char *tag, data1_node *at);
599 data1_attset *data1_get_attset (data1_handle dh, const char *name);
600 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
601 data1_node *data1_map_record(data1_handle dh, data1_node *n,
602                                         data1_maptab *map, NMEM m);
603 data1_marctab *data1_read_marctab (data1_handle dh,
604                                               const char *file);
605 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
606                                   data1_node *n, int selected, int *len);
607 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
608                                     int select, int *len);
609 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
610                                                 data1_node *n, int select,
611                                                 ODR o);
612 Z_BriefBib *data1_nodetosummary(data1_handle dh, 
613                                            data1_node *n, int select,
614                                            ODR o);
615 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
616                                   int *len);
617 WRBUF data1_get_wrbuf (data1_handle dp);
618 char **data1_get_read_buf (data1_handle dp, int **lenp);
619 char **data1_get_map_buf (data1_handle dp, int **lenp);
620 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
621 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
622 NMEM data1_nmem_get (data1_handle dh);
623
624 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
625 void data1_print_tree (data1_handle dh, data1_node *n);
626
627
628 char *data1_insert_string (data1_handle dh, data1_node *res,
629                                       NMEM m, const char *str);
630 char *data1_insert_string_n (data1_handle dh, data1_node *res,
631                                         NMEM m, const char *str, size_t len);
632 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
633                                         const char *buf);
634 /*
635 data1_node *data1_read_xml (data1_handle dh,
636                                        int (*rf)(void *, char *, size_t),
637                                        void *fh, NMEM m);
638 */
639 void data1_absyn_trav (data1_handle dh, void *handle,
640                                   void (*fh)(data1_handle dh,
641                                              void *h, data1_absyn *a));
642
643 data1_attset *data1_attset_search_id (data1_handle dh, int id);
644
645 char *data1_getNodeValue(data1_node* node, char* pTagPath);
646 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
647 int data1_CountOccurences(data1_node* node, char* pTagPath);
648
649  
650 FILE *data1_path_fopen (data1_handle dh, const char *file,
651                                    const char *mode);
652 void data1_set_tabpath(data1_handle dh, const char *path);
653 void data1_set_tabroot (data1_handle dp, const char *p);
654 const char *data1_get_tabpath(data1_handle dh);
655 const char *data1_get_tabroot(data1_handle dh);
656
657
658
659 /* =========================================================================
660  * Filter stuff
661  * ========================================================================= 
662  */
663 int grs_perl_readf(struct perl_context *context, size_t len);
664 int grs_perl_readline(struct perl_context *context);
665 char grs_perl_getc(struct perl_context *context);
666 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
667 off_t grs_perl_tellf(struct perl_context *context);
668 void grs_perl_endf(struct perl_context *context, off_t offset);
669
670 data1_handle *grs_perl_get_dh(struct perl_context *context);
671 NMEM *grs_perl_get_mem(struct perl_context *context);
672 void grs_perl_set_res(struct perl_context *context, data1_node *n);
673