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;
148 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
153 /* == Logging facilities (yaz/log.h) ======================================= */
155 void logLevel (int level);
156 void logFile (const char *fname);
157 void logMsg (int level, const char *message);
159 #define LOG_FATAL 0x0001
160 #define LOG_DEBUG 0x0002
161 #define LOG_WARN 0x0004
162 #define LOG_LOG 0x0008
163 #define LOG_ERRNO 0x0010 /* append strerror to message */
164 #define LOG_FILE 0x0020
165 #define LOG_APP 0x0040 /* For application level events */
166 #define LOG_MALLOC 0x0080 /* debugging mallocs */
167 #define LOG_ALL 0xff7f
168 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
170 /* == ODR stuff (yaz/odr.h) ================================================ */
175 ODR odr_createmem(int direction);
176 void odr_reset(ODR o);
177 void odr_destroy(ODR o);
178 void *odr_malloc(ODR o, int size);
181 /* == Zebra session and service (index/zebraapi.c) ========================= */
184 ZebraService zebra_start (const char *configName);
187 ZebraHandle zebra_open (ZebraService zs);
190 void zebra_close (ZebraHandle zh);
193 void zebra_stop (ZebraService zs);
196 /* == Error handling and reporting (index/zebraapi.c) ====================== */
198 /* last error code */
200 int zebra_errCode (ZebraHandle zh);
202 /* string representatio of above */
204 const char * zebra_errString (ZebraHandle zh);
206 /* extra information associated with error */
208 char * zebra_errAdd (ZebraHandle zh);
211 /* == Record groups and database selection ================================= */
213 /* initialize a recordGroup (zebra_api_ext.c); */
214 void init_recordGroup (recordGroup *rg);
216 /* set up a recordGroup for a specific file extension from zebra.cfg
217 (zebra_api_ext.c); */
218 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg,
220 /* set current record group for update purposes (zebraapi.c) */
222 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
224 /* select database for update purposes (zebraapi.c) */
225 %name(select_database)
226 int zebra_select_database (ZebraHandle zh, const char *basename);
228 /* select databases for record retrieval (zebraapi.c) */
229 %name(select_databases)
230 int zebra_select_databases (ZebraHandle zh, int num_bases,
231 const char **basenames);
234 /* == Transactions, locking, shadow register =============================== */
236 /* begin transaction (add write lock) (zebraapi.c) */
238 int zebra_begin_trans (ZebraHandle zh, int rw);
240 /* end transaction (remove write lock) (zebraapi.c) */
242 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
245 int zebra_trans_no (ZebraHandle zh);
248 int zebra_begin_read (ZebraHandle zh);
250 /* end retrieval (remove read lock) (zebraapi.c) */
252 void zebra_end_read (ZebraHandle zh);
254 /* commit changes from shadow (zebraapi.c) */
256 int zebra_commit (ZebraHandle zh);
258 /* get shadow status (zebra_api_ext.c) */
259 %name(get_shadow_enable)
260 int zebra_get_shadow_enable (ZebraHandle zh);
262 /* set shadow status (zebra_api_ext.c) */
263 %name(set_shadow_enable)
264 void zebra_set_shadow_enable (ZebraHandle zh, int value);
267 /* == Repository actions (zebraapi.c) ====================================== */
270 int zebra_init (ZebraHandle zh);
273 int zebra_compact (ZebraHandle zh);
275 %name(repository_update)
276 void zebra_repository_update (ZebraHandle zh);
278 %name(repository_delete)
279 void zebra_repository_delete (ZebraHandle zh);
281 %name(repository_show)
282 void zebra_repository_show (ZebraHandle zh);
285 /* == Record update/delete (zebra_api_ext.c) =============================== */
287 /* If sysno is provided, then it's used to identify the reocord.
288 If not, and match_criteria is provided, then sysno is guessed
289 If not, and a record is provided, then sysno is got from there */
292 int zebra_update_record (ZebraHandle zh,
294 const char *recordType,
302 int zebra_delete_record (ZebraHandle zh,
304 const char *recordType,
311 /* == Search (zebra_api_ext.c) ============================================= */
314 int zebra_search_PQF (ZebraHandle zh,
315 ODR odr_input, ODR odr_output,
316 const char *pqf_query,
317 const char *setname);
320 /* == YAZ - query tools ==================================================== */
323 cql_transform_t cql_transform_open_fname(const char *fname);
324 void cql_transform_close(cql_transform_t ct);
325 int cql_transform_error(cql_transform_t ct, const char **addinfo);
328 int zebra_cql2pqf (cql_transform_t ct,
329 const char *query, char *res, int len);
331 /* == Retrieval (zebra_api_ext.c) ========================================== */
333 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
334 used to get the individual records. Elementset, schema and format strings
335 are threated the same way yaz-client does. */
336 void records_retrieve(ZebraHandle zh,
338 const char *setname, // resultset name
339 const char *a_eset, // optional elementset
340 const char *a_schema, // optional schema
341 const char *a_format, // optional record syntax
342 int from, // range, 1 based
347 /* fetch a record from the retrieval object. pos is 1 based */
348 void record_retrieve(RetrievalObj *ro,
350 RetrievalRecord *res,
353 /* Delete Result Set(s) (zebraapi.c) */
354 %name(deleteResultSet)
355 int zebra_deleleResultSet(ZebraHandle zh, int function,
356 int num_setnames, char **setnames,
360 /* == Sort ================================================================= */
361 int sort (ZebraHandle zh,
363 const char *sort_spec,
364 const char *output_setname,
365 const char **input_setnames
368 /* == Scan ================================================================= */
370 void zebra_scan_PQF (ZebraHandle zh,
373 const char *pqf_query);
375 scanEntry *getScanEntry(ScanObj *so, int pos);
377 /* Admin functionality */
379 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
380 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
385 /* do authentication */
387 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
394 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
395 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
397 int *type, char *out, size_t *len);
401 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
403 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
405 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
408 void zebra_admin_shutdown (ZebraHandle zh);
409 void zebra_admin_start (ZebraHandle zh);
410 void zebra_admin_import_end (ZebraHandle zh);
416 /* =========================================================================
418 * =========================================================================
421 NMEM nmem_create (void);
422 void nmem_destroy (NMEM handle);
424 /* =========================================================================
426 * =========================================================================
429 typedef enum data1_datatype
437 DATA1K_generalizedtime,
444 #define DATA1T_numeric 1
445 #define DATA1T_string 2
446 #define DATA1N_root 1
448 #define DATA1N_data 3
449 #define DATA1N_variant 4
450 #define DATA1N_comment 5
451 #define DATA1N_preprocess 6
452 #define DATA1I_inctxt 1
453 #define DATA1I_incbin 2
454 #define DATA1I_text 3
457 #define DATA1_LOCALDATA 12
458 #define DATA1_FLAG_XML 1
460 data1_handle data1_create (void);
461 data1_handle data1_createx (int flags);
462 void data1_destroy(data1_handle dh);
465 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
466 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
467 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
468 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
469 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
470 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
472 data1_tagset *data1_empty_tagset (data1_handle dh);
473 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
474 data1_element *data1_getelementbytagname(data1_handle dh,
476 data1_element *parent,
477 const char *tagname);
479 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
483 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
486 void data1_free_tree(data1_handle dh, data1_node *t);
488 char *data1_nodetobuf(data1_handle dh, data1_node *n,
489 int select, int *len);
491 data1_node *data1_mk_tag_data_wd(data1_handle dh,
493 const char *tagname, NMEM m);
494 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
495 const char *tagname, NMEM m);
496 data1_datatype data1_maptype(data1_handle dh, char *t);
497 data1_varset *data1_read_varset(data1_handle dh, const char *file);
498 data1_vartype *data1_getvartypebyct(data1_handle dh,
500 char *zclass, char *type);
501 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
502 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
504 data1_esetname *data1_getesetbyname(data1_handle dh,
507 data1_element *data1_getelementbyname(data1_handle dh,
510 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
511 int type, data1_node *parent);
513 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
514 const char *tag, const char **attr,
516 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
517 const char *tag, size_t len,
520 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
521 data1_node *res, const char **attr);
523 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
524 const char *buf, size_t len,
526 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
527 const char *buf, size_t len,
529 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
530 const char *buf, data1_node *parent);
532 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
533 const char *buf, size_t len,
536 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
537 const char *buf, data1_node *parent);
539 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
544 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
546 void data1_set_root(data1_handle dh, data1_node *res,
547 NMEM nmem, const char *name);
549 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
550 const char *tag, int num,
552 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
553 const char *tag, Odr_oid *oid,
555 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
559 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
565 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
567 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
569 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
570 const char *tag, data1_node *at);
571 data1_attset *data1_get_attset (data1_handle dh, const char *name);
572 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
573 data1_node *data1_map_record(data1_handle dh, data1_node *n,
574 data1_maptab *map, NMEM m);
575 data1_marctab *data1_read_marctab (data1_handle dh,
577 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
578 data1_node *n, int selected, int *len);
579 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
580 int select, int *len);
581 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
582 data1_node *n, int select,
584 Z_BriefBib *data1_nodetosummary(data1_handle dh,
585 data1_node *n, int select,
587 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
589 WRBUF data1_get_wrbuf (data1_handle dp);
590 char **data1_get_read_buf (data1_handle dp, int **lenp);
591 char **data1_get_map_buf (data1_handle dp, int **lenp);
592 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
593 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
594 NMEM data1_nmem_get (data1_handle dh);
596 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
597 void data1_print_tree (data1_handle dh, data1_node *n);
600 char *data1_insert_string (data1_handle dh, data1_node *res,
601 NMEM m, const char *str);
602 char *data1_insert_string_n (data1_handle dh, data1_node *res,
603 NMEM m, const char *str, size_t len);
604 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
607 data1_node *data1_read_xml (data1_handle dh,
608 int (*rf)(void *, char *, size_t),
611 void data1_absyn_trav (data1_handle dh, void *handle,
612 void (*fh)(data1_handle dh,
613 void *h, data1_absyn *a));
615 data1_attset *data1_attset_search_id (data1_handle dh, int id);
617 char *data1_getNodeValue(data1_node* node, char* pTagPath);
618 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
619 int data1_CountOccurences(data1_node* node, char* pTagPath);
622 FILE *data1_path_fopen (data1_handle dh, const char *file,
624 void data1_set_tabpath(data1_handle dh, const char *path);
625 void data1_set_tabroot (data1_handle dp, const char *p);
626 const char *data1_get_tabpath(data1_handle dh);
627 const char *data1_get_tabroot(data1_handle dh);
631 /* =========================================================================
633 * =========================================================================
635 int grs_perl_readf(struct perl_context *context, size_t len);
636 int grs_perl_readline(struct perl_context *context);
637 char grs_perl_getc(struct perl_context *context);
638 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
639 off_t grs_perl_tellf(struct perl_context *context);
640 void grs_perl_endf(struct perl_context *context, off_t offset);
642 data1_handle *grs_perl_get_dh(struct perl_context *context);
643 NMEM *grs_perl_get_mem(struct perl_context *context);
644 void grs_perl_set_res(struct perl_context *context, data1_node *n);