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" */
94 ZebraRetrievalRecord *records;
98 int errCode; /* non-zero if error when fetching this */
99 char *errString; /* error string */
100 int position; /* position of record in result set (1,2,..) */
104 char *format; /* record syntax */
105 RetrievalRecordBuf *buf;
108 /* Scan Term Descriptor */
110 int occurrences; /* scan term occurrences */
111 char *term; /* scan term string */
129 } ZebraTransactionStatus;
131 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
136 /* == Logging facilities (yaz/log.h) ======================================= */
139 void yaz_log_init_level (int level);
142 void yaz_log_init_file (const char *fname);
145 void logMsg (int level, const char *message);
148 void yaz_log_init_prefix (const char *prefix);
151 void yaz_log_init_prefix2 (const char *prefix);
153 #define LOG_FATAL 0x0001
154 #define LOG_DEBUG 0x0002
155 #define LOG_WARN 0x0004
156 #define LOG_LOG 0x0008
157 #define LOG_ERRNO 0x0010 /* append strerror to message */
158 #define LOG_FILE 0x0020
159 #define LOG_APP 0x0040 /* For application level events */
160 #define LOG_MALLOC 0x0080 /* debugging mallocs */
161 #define LOG_ALL 0xff7f
162 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
164 /* == ODR stuff (yaz/odr.h) ================================================ */
169 ODR odr_createmem(int direction);
170 void odr_reset(ODR o);
171 void odr_destroy(ODR o);
172 void *odr_malloc(ODR o, int size);
175 /* == Zebra session and service (index/zebraapi.c) ========================= */
178 ZebraService zebra_start (const char *configName);
181 ZebraHandle zebra_open (ZebraService zs);
184 void zebra_close (ZebraHandle zh);
187 void zebra_stop (ZebraService zs);
190 /* == Error handling and reporting (index/zebraapi.c) ====================== */
192 /* last error code */
194 int zebra_errCode (ZebraHandle zh);
196 /* string representatio of above */
198 const char * zebra_errString (ZebraHandle zh);
200 /* extra information associated with error */
202 char * zebra_errAdd (ZebraHandle zh);
205 /* == Zebra resources and database selection =============================== */
209 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
213 const char *zebra_set_resource(ZebraHandle zh, const char *name,
214 const char *defaultvalue);
216 /* select database for update purposes (zebraapi.c) */
217 %name(select_database)
218 int zebra_select_database (ZebraHandle zh, const char *basename);
220 /* select databases for record retrieval (zebraapi.c) */
221 %name(select_databases)
222 int zebra_select_databases (ZebraHandle zh, int num_bases,
223 const char **basenames);
226 /* == Transactions, locking, shadow register =============================== */
228 /* begin transaction (add write lock) (zebraapi.c) */
230 int zebra_begin_trans (ZebraHandle zh, int rw);
232 /* end transaction (remove write lock) (zebraapi.c) */
234 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
237 int zebra_trans_no (ZebraHandle zh);
239 /* commit changes from shadow (zebraapi.c) */
241 int zebra_commit (ZebraHandle zh);
243 /* get shadow status (zebra_api_ext.c) */
244 %name(get_shadow_enable)
245 int zebra_get_shadow_enable (ZebraHandle zh);
247 /* set shadow status (zebra_api_ext.c) */
248 %name(set_shadow_enable)
249 void zebra_set_shadow_enable (ZebraHandle zh, int value);
252 /* == Repository actions (zebraapi.c) ====================================== */
255 int zebra_init (ZebraHandle zh);
258 int zebra_compact (ZebraHandle zh);
260 %name(repository_update)
261 void zebra_repository_update (ZebraHandle zh, const char *path);
263 %name(repository_delete)
264 void zebra_repository_delete (ZebraHandle zh, const char *path);
266 %name(repository_show)
267 void zebra_repository_show (ZebraHandle zh, const char *path);
270 /* == Record update/delete (zebra_api_ext.c) =============================== */
272 /* If sysno is provided, then it's used to identify the reocord.
273 If not, and match_criteria is provided, then sysno is guessed
274 If not, and a record is provided, then sysno is got from there */
276 %apply int *REFERENCE { long long *sysno };
278 int zebra_insert_record (ZebraHandle zh,
279 const char *recordType,
288 int zebra_update_record (ZebraHandle zh,
289 const char *recordType,
298 int zebra_delete_record (ZebraHandle zh,
299 const char *recordType,
307 /* == Search (zebraapi.c) ================================================== */
308 %include "typemaps.i"
309 %apply int *REFERENCE { int *hits };
311 int zebra_search_PQF (ZebraHandle zh,
312 const char *pqf_query,
316 /* == YAZ - query tools ==================================================== */
319 cql_transform_t cql_transform_open_fname(const char *fname);
320 void cql_transform_close(cql_transform_t ct);
321 int cql_transform_error(cql_transform_t ct, const char **addinfo);
324 int zebra_cql2pqf (cql_transform_t ct,
325 const char *query, char *res, int len);
327 /* == Retrieval (zebra_api_ext.c) ========================================== */
329 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
330 used to get the individual records. Elementset, schema and format strings
331 are threated the same way yaz-client does. */
332 void records_retrieve(ZebraHandle zh,
334 const char *setname, // resultset name
335 const char *a_eset, // optional elementset
336 const char *a_schema, // optional schema
337 const char *a_format, // optional record syntax
338 int from, // range, 1 based
343 /* fetch a record from the retrieval object. pos is 1 based */
344 void record_retrieve(RetrievalObj *ro,
346 RetrievalRecord *res,
349 /* Delete Result Set(s) (zebraapi.c) */
350 %name(deleteResultSet)
351 int zebra_deleleResultSet(ZebraHandle zh, int function,
352 int num_setnames, char **setnames,
356 /* Resultset terms */
357 %name(resultSetTerms)
358 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
359 int no, int *REFERENCE,
360 int *REFERENCE, char *out, int *REFERENCE);
362 /* == Sort ================================================================= */
364 int zebra_sort_by_specstr (ZebraHandle zh,
366 const char *sort_spec,
367 const char *output_setname,
368 const char **input_setnames
371 /* == Scan ================================================================= */
373 void zebra_scan_PQF (ZebraHandle zh,
376 const char *pqf_query);
378 scanEntry *getScanEntry(ScanObj *so, int pos);
380 %typemap(in) int * (int dvalue);
381 %typemap(argout) int *;
384 /* Admin functionality */
386 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
387 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
392 /* do authentication */
394 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
401 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
402 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
404 int *type, char *out, size_t *len);
408 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
410 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
412 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
415 void zebra_admin_shutdown (ZebraHandle zh);
416 void zebra_admin_start (ZebraHandle zh);
417 void zebra_admin_import_end (ZebraHandle zh);
423 /* =========================================================================
425 * =========================================================================
428 NMEM nmem_create (void);
429 void nmem_destroy (NMEM handle);
431 /* =========================================================================
433 * =========================================================================
436 typedef enum data1_datatype
444 DATA1K_generalizedtime,
451 #define DATA1T_numeric 1
452 #define DATA1T_string 2
453 #define DATA1N_root 1
455 #define DATA1N_data 3
456 #define DATA1N_variant 4
457 #define DATA1N_comment 5
458 #define DATA1N_preprocess 6
459 #define DATA1I_inctxt 1
460 #define DATA1I_incbin 2
461 #define DATA1I_text 3
464 #define DATA1_LOCALDATA 12
465 #define DATA1_FLAG_XML 1
467 data1_handle data1_create (void);
468 data1_handle data1_createx (int flags);
469 void data1_destroy(data1_handle dh);
472 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
473 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
474 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
475 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
476 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
477 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
479 data1_tagset *data1_empty_tagset (data1_handle dh);
480 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
481 data1_element *data1_getelementbytagname(data1_handle dh,
483 data1_element *parent,
484 const char *tagname);
486 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
490 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
493 void data1_free_tree(data1_handle dh, data1_node *t);
495 char *data1_nodetobuf(data1_handle dh, data1_node *n,
496 int select, int *len);
498 data1_node *data1_mk_tag_data_wd(data1_handle dh,
500 const char *tagname, NMEM m);
501 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
502 const char *tagname, NMEM m);
503 data1_datatype data1_maptype(data1_handle dh, char *t);
504 data1_varset *data1_read_varset(data1_handle dh, const char *file);
505 data1_vartype *data1_getvartypebyct(data1_handle dh,
507 char *zclass, char *type);
508 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
509 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
511 data1_esetname *data1_getesetbyname(data1_handle dh,
514 data1_element *data1_getelementbyname(data1_handle dh,
517 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
518 int type, data1_node *parent);
520 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
521 const char *tag, const char **attr,
523 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
524 const char *tag, size_t len,
527 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
528 data1_node *res, const char **attr);
530 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
531 const char *buf, size_t len,
533 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
534 const char *buf, size_t len,
536 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
537 const char *buf, data1_node *parent);
539 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
540 const char *buf, size_t len,
543 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
544 const char *buf, data1_node *parent);
546 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
551 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
553 void data1_set_root(data1_handle dh, data1_node *res,
554 NMEM nmem, const char *name);
556 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
557 const char *tag, int num,
559 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
560 const char *tag, Odr_oid *oid,
562 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
566 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
572 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
574 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
576 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
577 const char *tag, data1_node *at);
578 data1_attset *data1_get_attset (data1_handle dh, const char *name);
579 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
580 data1_node *data1_map_record(data1_handle dh, data1_node *n,
581 data1_maptab *map, NMEM m);
582 data1_marctab *data1_read_marctab (data1_handle dh,
584 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
585 data1_node *n, int selected, int *len);
586 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
587 int select, int *len);
588 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
589 data1_node *n, int select,
591 Z_BriefBib *data1_nodetosummary(data1_handle dh,
592 data1_node *n, int select,
594 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
596 WRBUF data1_get_wrbuf (data1_handle dp);
597 char **data1_get_read_buf (data1_handle dp, int **lenp);
598 char **data1_get_map_buf (data1_handle dp, int **lenp);
599 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
600 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
601 NMEM data1_nmem_get (data1_handle dh);
603 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
604 void data1_print_tree (data1_handle dh, data1_node *n);
607 char *data1_insert_string (data1_handle dh, data1_node *res,
608 NMEM m, const char *str);
609 char *data1_insert_string_n (data1_handle dh, data1_node *res,
610 NMEM m, const char *str, size_t len);
611 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
614 data1_node *data1_read_xml (data1_handle dh,
615 int (*rf)(void *, char *, size_t),
618 void data1_absyn_trav (data1_handle dh, void *handle,
619 void (*fh)(data1_handle dh,
620 void *h, data1_absyn *a));
622 data1_attset *data1_attset_search_id (data1_handle dh, int id);
624 char *data1_getNodeValue(data1_node* node, char* pTagPath);
625 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
626 int data1_CountOccurences(data1_node* node, char* pTagPath);
629 FILE *data1_path_fopen (data1_handle dh, const char *file,
631 void data1_set_tabpath(data1_handle dh, const char *path);
632 void data1_set_tabroot (data1_handle dp, const char *p);
633 const char *data1_get_tabpath(data1_handle dh);
634 const char *data1_get_tabroot(data1_handle dh);
638 /* =========================================================================
640 * =========================================================================
642 int grs_perl_readf(struct perl_context *context, size_t len);
643 int grs_perl_readline(struct perl_context *context);
644 char grs_perl_getc(struct perl_context *context);
645 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
646 off_t grs_perl_tellf(struct perl_context *context);
647 void grs_perl_endf(struct perl_context *context, off_t offset);
649 data1_handle *grs_perl_get_dh(struct perl_context *context);
650 NMEM *grs_perl_get_mem(struct perl_context *context);
651 void grs_perl_set_res(struct perl_context *context, data1_node *n);