2 %include typemaps.i // Load the typemaps librayr
6 #include <idzebra/api.h>
7 #include "zebra_perl.h"
13 /* == Typemaps ============================================================= */
18 croak("Argument $argnum is not an integer.");
29 /* * * * * * Fix for broken swig implementation */
30 %typemap(argout) long long *INOUT {
35 /* sprintf(temp,"%lld", $1); */
36 sprintf(temp,"%lld", *$1);
37 $result = sv_newmortal();
38 sv_setpv($result,temp);
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 * {
47 $result = newSVpv($1->buf,$1->len);
49 $result = newSVpv("",0);
55 /* All char ** values are mapped in-out to array of strings. */
56 %typemap(in) char ** {
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);
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);
76 /* This cleans up the char ** array after the function call */
77 %typemap(freearg) char ** {
81 /* Creates a new Perl array and places a NULL-terminated char ** into it */
82 %typemap(out) char ** {
86 /* Figure out how many elements we have */
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]);
94 myav = av_make(len,svs);
96 $result = newRV((SV*)myav);
101 /* == Structures for shadow classes ======================================= */
104 /*%include "zebra_perl.h" */
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) ======================================= */
153 void yaz_log_init_level (int level);
156 void yaz_log_init_file (const char *fname);
159 void logMsg (int level, const char *message);
162 void yaz_log_init_prefix (const char *prefix);
165 void yaz_log_init_prefix2 (const char *prefix);
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)
178 /* == ODR stuff (yaz/odr.h) ================================================ */
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);
189 /* == Zebra session and service (index/zebraapi.c) ========================= */
192 ZebraService zebra_start (const char *configName);
195 ZebraHandle zebra_open (ZebraService zs);
198 void zebra_close (ZebraHandle zh);
201 void zebra_stop (ZebraService zs);
204 /* == Error handling and reporting (index/zebraapi.c) ====================== */
206 /* last error code */
208 int zebra_errCode (ZebraHandle zh);
210 /* string representatio of above */
212 const char * zebra_errString (ZebraHandle zh);
214 /* extra information associated with error */
216 char * zebra_errAdd (ZebraHandle zh);
219 /* == Zebra resources and database selection =============================== */
223 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
227 const char *zebra_set_resource(ZebraHandle zh, const char *name,
228 const char *defaultvalue);
230 /* select database for update purposes (zebraapi.c) */
231 %name(select_database)
232 int zebra_select_database (ZebraHandle zh, const char *basename);
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);
240 /* == Transactions, locking, shadow register =============================== */
242 /* begin transaction (add write lock) (zebraapi.c) */
244 int zebra_begin_trans (ZebraHandle zh, int rw);
246 /* end transaction (remove write lock) (zebraapi.c) */
248 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
251 int zebra_trans_no (ZebraHandle zh);
253 /* commit changes from shadow (zebraapi.c) */
255 int zebra_commit (ZebraHandle zh);
257 /* get shadow status (zebra_api_ext.c) */
258 %name(get_shadow_enable)
259 int zebra_get_shadow_enable (ZebraHandle zh);
261 /* set shadow status (zebra_api_ext.c) */
262 %name(set_shadow_enable)
263 void zebra_set_shadow_enable (ZebraHandle zh, int value);
266 /* == Repository actions (zebraapi.c) ====================================== */
269 int zebra_init (ZebraHandle zh);
272 int zebra_compact (ZebraHandle zh);
274 %name(repository_update)
275 void zebra_repository_update (ZebraHandle zh, const char *path);
277 %name(repository_delete)
278 void zebra_repository_delete (ZebraHandle zh, const char *path);
280 %name(repository_show)
281 void zebra_repository_show (ZebraHandle zh, const char *path);
284 /* == Record update/delete (zebra_api_ext.c) =============================== */
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 */
290 %apply long long *INOUT { long long *sysno };
293 int zebra_insert_record (ZebraHandle zh,
294 const char *recordType,
303 int zebra_update_record (ZebraHandle zh,
304 const char *recordType,
313 int zebra_delete_record (ZebraHandle zh,
314 const char *recordType,
322 /* == Search (zebraapi.c) ================================================== */
323 %include "typemaps.i"
324 %apply int *REFERENCE { int *hits };
326 int zebra_search_PQF (ZebraHandle zh,
327 const char *pqf_query,
331 /* == YAZ - query tools ==================================================== */
334 cql_transform_t cql_transform_open_fname(const char *fname);
335 void cql_transform_close(cql_transform_t ct);
336 int cql_transform_error(cql_transform_t ct, const char **addinfo);
339 int zebra_cql2pqf (cql_transform_t ct,
340 const char *query, char *res, int len);
342 /* == Retrieval (zebra_api_ext.c) ========================================== */
344 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
345 used to get the individual records. Elementset, schema and format strings
346 are threated the same way yaz-client does. */
347 void records_retrieve(ZebraHandle zh,
349 const char *setname, // resultset name
350 const char *a_eset, // optional elementset
351 const char *a_schema, // optional schema
352 const char *a_format, // optional record syntax
353 int from, // range, 1 based
358 /* fetch a record from the retrieval object. pos is 1 based */
359 void record_retrieve(RetrievalObj *ro,
361 RetrievalRecord *res,
364 /* Delete Result Set(s) (zebraapi.c) */
365 %name(deleteResultSet)
366 int zebra_deleleResultSet(ZebraHandle zh, int function,
367 int num_setnames, char **setnames,
371 /* Resultset terms */
373 %name(resultSetTerms)
374 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
375 int no, int *REFERENCE,
376 int *REFERENCE, char *out, int *REFERENCE);
379 /* == Sort ================================================================= */
381 int zebra_sort_by_specstr (ZebraHandle zh,
383 const char *sort_spec,
384 const char *output_setname,
385 const char **input_setnames
388 /* == Scan ================================================================= */
390 void zebra_scan_PQF (ZebraHandle zh,
393 const char *pqf_query);
395 scanEntry *getScanEntry(ScanObj *so, int pos);
397 %typemap(in) int * (int dvalue);
398 %typemap(argout) int *;
401 /* Admin functionality */
403 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
404 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
409 /* do authentication */
411 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
418 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
419 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
421 int *type, char *out, size_t *len);
425 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
427 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
429 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
432 void zebra_admin_shutdown (ZebraHandle zh);
433 void zebra_admin_start (ZebraHandle zh);
434 void zebra_admin_import_end (ZebraHandle zh);
440 /* =========================================================================
442 * =========================================================================
445 NMEM nmem_create (void);
446 void nmem_destroy (NMEM handle);
448 /* =========================================================================
450 * =========================================================================
453 typedef enum data1_datatype
461 DATA1K_generalizedtime,
468 #define DATA1T_numeric 1
469 #define DATA1T_string 2
470 #define DATA1N_root 1
472 #define DATA1N_data 3
473 #define DATA1N_variant 4
474 #define DATA1N_comment 5
475 #define DATA1N_preprocess 6
476 #define DATA1I_inctxt 1
477 #define DATA1I_incbin 2
478 #define DATA1I_text 3
481 #define DATA1_LOCALDATA 12
482 #define DATA1_FLAG_XML 1
484 data1_handle data1_create (void);
485 data1_handle data1_createx (int flags);
486 void data1_destroy(data1_handle dh);
489 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
490 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
491 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
492 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
493 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
494 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
496 data1_tagset *data1_empty_tagset (data1_handle dh);
497 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
498 data1_element *data1_getelementbytagname(data1_handle dh,
500 data1_element *parent,
501 const char *tagname);
503 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
507 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
510 void data1_free_tree(data1_handle dh, data1_node *t);
512 char *data1_nodetobuf(data1_handle dh, data1_node *n,
513 int select, int *len);
515 data1_node *data1_mk_tag_data_wd(data1_handle dh,
517 const char *tagname, NMEM m);
518 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
519 const char *tagname, NMEM m);
520 data1_datatype data1_maptype(data1_handle dh, char *t);
521 data1_varset *data1_read_varset(data1_handle dh, const char *file);
522 data1_vartype *data1_getvartypebyct(data1_handle dh,
524 char *zclass, char *type);
525 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
526 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
528 data1_esetname *data1_getesetbyname(data1_handle dh,
531 data1_element *data1_getelementbyname(data1_handle dh,
534 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
535 int type, data1_node *parent);
537 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
538 const char *tag, const char **attr,
540 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
541 const char *tag, size_t len,
544 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
545 data1_node *res, const char **attr);
547 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
548 const char *buf, size_t len,
550 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
551 const char *buf, size_t len,
553 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
554 const char *buf, data1_node *parent);
556 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
557 const char *buf, size_t len,
560 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
561 const char *buf, data1_node *parent);
563 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
568 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
570 void data1_set_root(data1_handle dh, data1_node *res,
571 NMEM nmem, const char *name);
573 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
574 const char *tag, int num,
576 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
577 const char *tag, Odr_oid *oid,
579 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
583 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
589 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
591 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
593 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
594 const char *tag, data1_node *at);
595 data1_attset *data1_get_attset (data1_handle dh, const char *name);
596 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
597 data1_node *data1_map_record(data1_handle dh, data1_node *n,
598 data1_maptab *map, NMEM m);
599 data1_marctab *data1_read_marctab (data1_handle dh,
601 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
602 data1_node *n, int selected, int *len);
603 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
604 int select, int *len);
605 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
606 data1_node *n, int select,
608 Z_BriefBib *data1_nodetosummary(data1_handle dh,
609 data1_node *n, int select,
611 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
613 WRBUF data1_get_wrbuf (data1_handle dp);
614 char **data1_get_read_buf (data1_handle dp, int **lenp);
615 char **data1_get_map_buf (data1_handle dp, int **lenp);
616 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
617 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
618 NMEM data1_nmem_get (data1_handle dh);
620 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
621 void data1_print_tree (data1_handle dh, data1_node *n);
624 char *data1_insert_string (data1_handle dh, data1_node *res,
625 NMEM m, const char *str);
626 char *data1_insert_string_n (data1_handle dh, data1_node *res,
627 NMEM m, const char *str, size_t len);
628 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
631 data1_node *data1_read_xml (data1_handle dh,
632 int (*rf)(void *, char *, size_t),
635 void data1_absyn_trav (data1_handle dh, void *handle,
636 void (*fh)(data1_handle dh,
637 void *h, data1_absyn *a));
639 data1_attset *data1_attset_search_id (data1_handle dh, int id);
641 char *data1_getNodeValue(data1_node* node, char* pTagPath);
642 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
643 int data1_CountOccurences(data1_node* node, char* pTagPath);
646 FILE *data1_path_fopen (data1_handle dh, const char *file,
648 void data1_set_tabpath(data1_handle dh, const char *path);
649 void data1_set_tabroot (data1_handle dp, const char *p);
650 const char *data1_get_tabpath(data1_handle dh);
651 const char *data1_get_tabroot(data1_handle dh);
655 /* =========================================================================
657 * =========================================================================
659 int grs_perl_readf(struct perl_context *context, size_t len);
660 int grs_perl_readline(struct perl_context *context);
661 char grs_perl_getc(struct perl_context *context);
662 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
663 off_t grs_perl_tellf(struct perl_context *context);
664 void grs_perl_endf(struct perl_context *context, off_t offset);
666 data1_handle *grs_perl_get_dh(struct perl_context *context);
667 NMEM *grs_perl_get_mem(struct perl_context *context);
668 void grs_perl_set_res(struct perl_context *context, data1_node *n);