2 %include typemaps.i // Load the typemaps librayr
7 #include "zebra_perl.h"
13 /* == Typemaps ============================================================= */
18 croak("Argument $argnum is not an integer.");
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 * {
33 $result = newSVpv($1->buf,$1->len);
35 $result = newSVpv("",0);
41 /* All char ** values are mapped in-out to array of strings. */
42 %typemap(in) char ** {
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);
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);
62 /* This cleans up the char ** array after the function call */
63 %typemap(freearg) char ** {
67 /* Creates a new Perl array and places a NULL-terminated char ** into it */
68 %typemap(out) char ** {
72 /* Figure out how many elements we have */
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]);
80 myav = av_make(len,svs);
82 $result = newRV((SV*)myav);
87 /* == Structures for shadow classes ======================================= */
90 /*%include "zebra_perl.h" */
100 int fileVerboseLimit;
101 int databaseNamePath;
108 ZebraRetrievalRecord *records;
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,..) */
118 char *format; /* record syntax */
119 RetrievalRecordBuf *buf;
122 /* Scan Term Descriptor */
124 int occurrences; /* scan term occurrences */
125 char *term; /* scan term string */
143 } ZebraTransactionStatus;
145 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
150 /* == Logging facilities (yaz/log.h) ======================================= */
152 void logLevel (int level);
153 void logFile (const char *fname);
154 void logMsg (int level, const char *message);
156 #define LOG_FATAL 0x0001
157 #define LOG_DEBUG 0x0002
158 #define LOG_WARN 0x0004
159 #define LOG_LOG 0x0008
160 #define LOG_ERRNO 0x0010 /* append strerror to message */
161 #define LOG_FILE 0x0020
162 #define LOG_APP 0x0040 /* For application level events */
163 #define LOG_MALLOC 0x0080 /* debugging mallocs */
164 #define LOG_ALL 0xff7f
165 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
167 /* == ODR stuff (yaz/odr.h) ================================================ */
172 ODR odr_createmem(int direction);
173 void odr_reset(ODR o);
174 void odr_destroy(ODR o);
175 void *odr_malloc(ODR o, int size);
178 /* == Zebra session and service (index/zebraapi.c) ========================= */
181 ZebraService zebra_start (const char *configName);
184 ZebraHandle zebra_open (ZebraService zs);
187 void zebra_close (ZebraHandle zh);
190 void zebra_stop (ZebraService zs);
193 /* == Error handling and reporting (index/zebraapi.c) ====================== */
195 /* last error code */
197 int zebra_errCode (ZebraHandle zh);
199 /* string representatio of above */
201 const char * zebra_errString (ZebraHandle zh);
203 /* extra information associated with error */
205 char * zebra_errAdd (ZebraHandle zh);
208 /* == Record groups and database selection ================================= */
210 /* initialize a recordGroup (zebra_api_ext.c); */
211 void init_recordGroup (recordGroup *rg);
213 /* set up a recordGroup for a specific file extension from zebra.cfg
214 (zebra_api_ext.c); */
215 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg,
217 /* set current record group for update purposes (zebraapi.c) */
219 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
221 /* select database for update purposes (zebraapi.c) */
222 %name(select_database)
223 int zebra_select_database (ZebraHandle zh, const char *basename);
225 /* select databases for record retrieval (zebraapi.c) */
226 %name(select_databases)
227 int zebra_select_databases (ZebraHandle zh, int num_bases,
228 const char **basenames);
231 /* == Transactions, locking, shadow register =============================== */
233 /* begin transaction (add write lock) (zebraapi.c) */
235 int zebra_begin_trans (ZebraHandle zh, int rw);
237 /* end transaction (remove write lock) (zebraapi.c) */
239 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
242 int zebra_trans_no (ZebraHandle zh);
244 /* commit changes from shadow (zebraapi.c) */
246 int zebra_commit (ZebraHandle zh);
248 /* get shadow status (zebra_api_ext.c) */
249 %name(get_shadow_enable)
250 int zebra_get_shadow_enable (ZebraHandle zh);
252 /* set shadow status (zebra_api_ext.c) */
253 %name(set_shadow_enable)
254 void zebra_set_shadow_enable (ZebraHandle zh, int value);
257 /* == Repository actions (zebraapi.c) ====================================== */
260 int zebra_init (ZebraHandle zh);
263 int zebra_compact (ZebraHandle zh);
265 %name(repository_update)
266 void zebra_repository_update (ZebraHandle zh);
268 %name(repository_delete)
269 void zebra_repository_delete (ZebraHandle zh);
271 %name(repository_show)
272 void zebra_repository_show (ZebraHandle zh);
275 /* == Record update/delete (zebra_api_ext.c) =============================== */
277 /* If sysno is provided, then it's used to identify the reocord.
278 If not, and match_criteria is provided, then sysno is guessed
279 If not, and a record is provided, then sysno is got from there */
282 int zebra_update_record (ZebraHandle zh,
284 const char *recordType,
292 int zebra_delete_record (ZebraHandle zh,
294 const char *recordType,
301 /* == Search (zebra_api_ext.c) ============================================= */
304 int zebra_search_PQF (ZebraHandle zh,
305 ODR odr_input, ODR odr_output,
306 const char *pqf_query,
307 const char *setname);
310 /* == YAZ - query tools ==================================================== */
313 cql_transform_t cql_transform_open_fname(const char *fname);
314 void cql_transform_close(cql_transform_t ct);
315 int cql_transform_error(cql_transform_t ct, const char **addinfo);
318 int zebra_cql2pqf (cql_transform_t ct,
319 const char *query, char *res, int len);
321 /* == Retrieval (zebra_api_ext.c) ========================================== */
323 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
324 used to get the individual records. Elementset, schema and format strings
325 are threated the same way yaz-client does. */
326 void records_retrieve(ZebraHandle zh,
328 const char *setname, // resultset name
329 const char *a_eset, // optional elementset
330 const char *a_schema, // optional schema
331 const char *a_format, // optional record syntax
332 int from, // range, 1 based
337 /* fetch a record from the retrieval object. pos is 1 based */
338 void record_retrieve(RetrievalObj *ro,
340 RetrievalRecord *res,
343 /* Delete Result Set(s) (zebraapi.c) */
344 %name(deleteResultSet)
345 int zebra_deleleResultSet(ZebraHandle zh, int function,
346 int num_setnames, char **setnames,
350 /* == Sort ================================================================= */
351 int sort (ZebraHandle zh,
353 const char *sort_spec,
354 const char *output_setname,
355 const char **input_setnames
358 /* == Scan ================================================================= */
360 void zebra_scan_PQF (ZebraHandle zh,
363 const char *pqf_query);
365 scanEntry *getScanEntry(ScanObj *so, int pos);
367 /* Admin functionality */
369 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
370 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
375 /* do authentication */
377 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
384 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
385 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
387 int *type, char *out, size_t *len);
391 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
393 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
395 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
398 void zebra_admin_shutdown (ZebraHandle zh);
399 void zebra_admin_start (ZebraHandle zh);
400 void zebra_admin_import_end (ZebraHandle zh);
406 /* =========================================================================
408 * =========================================================================
411 NMEM nmem_create (void);
412 void nmem_destroy (NMEM handle);
414 /* =========================================================================
416 * =========================================================================
419 typedef enum data1_datatype
427 DATA1K_generalizedtime,
434 #define DATA1T_numeric 1
435 #define DATA1T_string 2
436 #define DATA1N_root 1
438 #define DATA1N_data 3
439 #define DATA1N_variant 4
440 #define DATA1N_comment 5
441 #define DATA1N_preprocess 6
442 #define DATA1I_inctxt 1
443 #define DATA1I_incbin 2
444 #define DATA1I_text 3
447 #define DATA1_LOCALDATA 12
448 #define DATA1_FLAG_XML 1
450 data1_handle data1_create (void);
451 data1_handle data1_createx (int flags);
452 void data1_destroy(data1_handle dh);
455 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
456 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
457 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
458 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
459 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
460 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
462 data1_tagset *data1_empty_tagset (data1_handle dh);
463 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
464 data1_element *data1_getelementbytagname(data1_handle dh,
466 data1_element *parent,
467 const char *tagname);
469 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
473 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
476 void data1_free_tree(data1_handle dh, data1_node *t);
478 char *data1_nodetobuf(data1_handle dh, data1_node *n,
479 int select, int *len);
481 data1_node *data1_mk_tag_data_wd(data1_handle dh,
483 const char *tagname, NMEM m);
484 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
485 const char *tagname, NMEM m);
486 data1_datatype data1_maptype(data1_handle dh, char *t);
487 data1_varset *data1_read_varset(data1_handle dh, const char *file);
488 data1_vartype *data1_getvartypebyct(data1_handle dh,
490 char *zclass, char *type);
491 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
492 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
494 data1_esetname *data1_getesetbyname(data1_handle dh,
497 data1_element *data1_getelementbyname(data1_handle dh,
500 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
501 int type, data1_node *parent);
503 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
504 const char *tag, const char **attr,
506 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
507 const char *tag, size_t len,
510 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
511 data1_node *res, const char **attr);
513 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
514 const char *buf, size_t len,
516 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
517 const char *buf, size_t len,
519 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
520 const char *buf, data1_node *parent);
522 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
523 const char *buf, size_t len,
526 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
527 const char *buf, data1_node *parent);
529 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
534 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
536 void data1_set_root(data1_handle dh, data1_node *res,
537 NMEM nmem, const char *name);
539 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
540 const char *tag, int num,
542 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
543 const char *tag, Odr_oid *oid,
545 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
549 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
555 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
557 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
559 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
560 const char *tag, data1_node *at);
561 data1_attset *data1_get_attset (data1_handle dh, const char *name);
562 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
563 data1_node *data1_map_record(data1_handle dh, data1_node *n,
564 data1_maptab *map, NMEM m);
565 data1_marctab *data1_read_marctab (data1_handle dh,
567 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
568 data1_node *n, int selected, int *len);
569 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
570 int select, int *len);
571 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
572 data1_node *n, int select,
574 Z_BriefBib *data1_nodetosummary(data1_handle dh,
575 data1_node *n, int select,
577 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
579 WRBUF data1_get_wrbuf (data1_handle dp);
580 char **data1_get_read_buf (data1_handle dp, int **lenp);
581 char **data1_get_map_buf (data1_handle dp, int **lenp);
582 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
583 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
584 NMEM data1_nmem_get (data1_handle dh);
586 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
587 void data1_print_tree (data1_handle dh, data1_node *n);
590 char *data1_insert_string (data1_handle dh, data1_node *res,
591 NMEM m, const char *str);
592 char *data1_insert_string_n (data1_handle dh, data1_node *res,
593 NMEM m, const char *str, size_t len);
594 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
597 data1_node *data1_read_xml (data1_handle dh,
598 int (*rf)(void *, char *, size_t),
601 void data1_absyn_trav (data1_handle dh, void *handle,
602 void (*fh)(data1_handle dh,
603 void *h, data1_absyn *a));
605 data1_attset *data1_attset_search_id (data1_handle dh, int id);
607 char *data1_getNodeValue(data1_node* node, char* pTagPath);
608 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
609 int data1_CountOccurences(data1_node* node, char* pTagPath);
612 FILE *data1_path_fopen (data1_handle dh, const char *file,
614 void data1_set_tabpath(data1_handle dh, const char *path);
615 void data1_set_tabroot (data1_handle dp, const char *p);
616 const char *data1_get_tabpath(data1_handle dh);
617 const char *data1_get_tabroot(data1_handle dh);
621 /* =========================================================================
623 * =========================================================================
625 int grs_perl_readf(struct perl_context *context, size_t len);
626 int grs_perl_readline(struct perl_context *context);
627 char grs_perl_getc(struct perl_context *context);
628 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
629 off_t grs_perl_tellf(struct perl_context *context);
630 void grs_perl_endf(struct perl_context *context, off_t offset);
632 data1_handle *grs_perl_get_dh(struct perl_context *context);
633 NMEM *grs_perl_get_mem(struct perl_context *context);
634 void grs_perl_set_res(struct perl_context *context, data1_node *n);