2 %include typemaps.i // Load the typemaps librayr
6 #include "zebra_perl.h"
12 /* == Typemaps ============================================================= */
14 /* RetrievalRecordBuff is a special construct, to allow to map a char * buf
15 to non-null terminated perl string scalar value (SVpv). */
19 croak("Argument $argnum is not an integer.");
30 %typemap(out) RetrievalRecordBuf * {
32 $result = newSVpv($1->buf,$1->len);
34 $result = newSVpv("",0);
40 /* All char ** values are mapped in-out to array of strings. */
41 %typemap(in) char ** {
48 croak("Argument $argnum is not a reference.");
49 if (SvTYPE(SvRV($input)) != SVt_PVAV)
50 croak("Argument $argnum is not an array.");
51 tempav = (AV*)SvRV($input);
53 $1 = (char **) malloc((len+2)*sizeof(char *));
54 for (i = 0; i <= len; i++) {
55 tv = av_fetch(tempav, i, 0);
56 $1[i] = (char *) SvPV(*tv,na);
61 /* This cleans up the char ** array after the function call */
62 %typemap(freearg) char ** {
66 /* Creates a new Perl array and places a NULL-terminated char ** into it */
67 %typemap(out) char ** {
71 /* Figure out how many elements we have */
74 svs = (SV **) malloc(len*sizeof(SV *));
75 for (i = 0; i < len ; i++) {
76 svs[i] = sv_newmortal();
77 sv_setpv((SV*)svs[i],$1[i]);
79 myav = av_make(len,svs);
81 $result = newRV((SV*)myav);
86 /* == Structures for shadow classes ======================================= */
88 %include "zebra_perl.h"
97 } ZebraTransactionStatus;
100 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
105 /* == Logging facilities (yaz/log.h) ======================================= */
107 void logLevel (int level);
108 void logFile (const char *fname);
109 void logMsg (int level, const char *message);
111 #define LOG_FATAL 0x0001
112 #define LOG_DEBUG 0x0002
113 #define LOG_WARN 0x0004
114 #define LOG_LOG 0x0008
115 #define LOG_ERRNO 0x0010 /* append strerror to message */
116 #define LOG_FILE 0x0020
117 #define LOG_APP 0x0040 /* For application level events */
118 #define LOG_MALLOC 0x0080 /* debugging mallocs */
119 #define LOG_ALL 0xff7f
120 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
122 /* == ODR stuff (yaz/odr.h) ================================================ */
127 ODR odr_createmem(int direction);
128 void odr_reset(ODR o);
129 void odr_destroy(ODR o);
130 void *odr_malloc(ODR o, int size);
133 /* == Zebra session and service (index/zebraapi.c) ========================= */
136 ZebraService zebra_start (const char *configName);
139 ZebraHandle zebra_open (ZebraService zs);
142 void zebra_close (ZebraHandle zh);
145 void zebra_stop (ZebraService zs);
148 /* == Error handling and reporting (index/zebraapi.c) ====================== */
150 /* last error code */
152 int zebra_errCode (ZebraHandle zh);
154 /* string representatio of above */
156 const char * zebra_errString (ZebraHandle zh);
158 /* extra information associated with error */
160 char * zebra_errAdd (ZebraHandle zh);
163 /* == Record groups and database selection ================================= */
165 /* initialize a recordGroup (zebra_api_ext.c); */
166 void init_recordGroup (recordGroup *rg);
168 /* set up a recordGroup for a specific file extension from zebra.cfg
169 (zebra_api_ext.c); */
170 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg,
172 /* set current record group for update purposes (zebraapi.c) */
174 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
176 /* select database for update purposes (zebraapi.c) */
177 %name(select_database)
178 int zebra_select_database (ZebraHandle zh, const char *basename);
180 /* select databases for record retrieval (zebraapi.c) */
181 %name(select_databases)
182 int zebra_select_databases (ZebraHandle zh, int num_bases,
183 const char **basenames);
186 /* == Transactions, locking, shadow register =============================== */
188 /* begin transaction (add write lock) (zebraapi.c) */
190 void zebra_begin_trans (ZebraHandle zh);
192 /* end transaction (remove write lock) (zebraapi.c) */
194 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
197 int zebra_trans_no (ZebraHandle zh);
200 int zebra_begin_read (ZebraHandle zh);
202 /* end retrieval (remove read lock) (zebraapi.c) */
204 void zebra_end_read (ZebraHandle zh);
206 /* commit changes from shadow (zebraapi.c) */
208 int zebra_commit (ZebraHandle zh);
210 /* get shadow status (zebra_api_ext.c) */
211 %name(get_shadow_enable)
212 int zebra_get_shadow_enable (ZebraHandle zh);
214 /* set shadow status (zebra_api_ext.c) */
215 %name(set_shadow_enable)
216 void zebra_set_shadow_enable (ZebraHandle zh, int value);
219 /* == Repository actions (zebraapi.c) ====================================== */
222 int zebra_init (ZebraHandle zh);
225 int zebra_compact (ZebraHandle zh);
227 %name(repository_update)
228 void zebra_repository_update (ZebraHandle zh);
230 %name(repository_delete)
231 void zebra_repository_delete (ZebraHandle zh);
233 %name(repository_show)
234 void zebra_repository_show (ZebraHandle zh);
237 /* == Record update/delete (zebra_api_ext.c) =============================== */
239 /* If sysno is provided, then it's used to identify the reocord.
240 If not, and match_criteria is provided, then sysno is guessed
241 If not, and a record is provided, then sysno is got from there */
244 int zebra_update_record (ZebraHandle zh,
246 const char *recordType,
254 int zebra_delete_record (ZebraHandle zh,
256 const char *recordType,
263 /* == Search (zebra_api_ext.c) ============================================= */
266 int zebra_search_PQF (ZebraHandle zh,
267 ODR odr_input, ODR odr_output,
268 const char *pqf_query,
269 const char *setname);
272 /* == YAZ - query tools ==================================================== */
275 cql_transform_t cql_transform_open_fname(const char *fname);
276 void cql_transform_close(cql_transform_t ct);
277 int cql_transform_error(cql_transform_t ct, const char **addinfo);
280 int zebra_cql2pqf (cql_transform_t ct,
281 const char *query, char *res, int len);
283 /* == Retrieval (zebra_api_ext.c) ========================================== */
285 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
286 used to get the individual records. Elementset, schema and format strings
287 are threated the same way yaz-client does. */
288 void records_retrieve(ZebraHandle zh,
290 const char *setname, // resultset name
291 const char *a_eset, // optional elementset
292 const char *a_schema, // optional schema
293 const char *a_format, // optional record syntax
294 int from, // range, 1 based
299 /* fetch a record from the retrieval object. pos is 1 based */
300 void record_retrieve(RetrievalObj *ro,
302 RetrievalRecord *res,
305 /* Delete Result Set(s) (zebraapi.c) */
306 %name(deleteResultSet)
307 int zebra_deleleResultSet(ZebraHandle zh, int function,
308 int num_setnames, char **setnames,
312 /* == Sort ================================================================= */
313 int sort (ZebraHandle zh,
315 const char *sort_spec,
316 const char *output_setname,
317 const char **input_setnames
320 /* == Scan ================================================================= */
322 void zebra_scan_PQF (ZebraHandle zh,
325 const char *pqf_query);
327 scanEntry *getScanEntry(ScanObj *so, int pos);
329 /* Admin functionality */
331 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
332 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
337 /* do authentication */
339 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
346 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
347 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
349 int *type, char *out, size_t *len);
353 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
355 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
357 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
360 void zebra_admin_shutdown (ZebraHandle zh);
361 void zebra_admin_start (ZebraHandle zh);
362 void zebra_admin_import_end (ZebraHandle zh);
368 /* =========================================================================
370 * =========================================================================
373 NMEM nmem_create (void);
374 void nmem_destroy (NMEM handle);
376 /* =========================================================================
378 * =========================================================================
381 typedef enum data1_datatype
389 DATA1K_generalizedtime,
396 #define DATA1T_numeric 1
397 #define DATA1T_string 2
398 #define DATA1N_root 1
400 #define DATA1N_data 3
401 #define DATA1N_variant 4
402 #define DATA1N_comment 5
403 #define DATA1N_preprocess 6
404 #define DATA1I_inctxt 1
405 #define DATA1I_incbin 2
406 #define DATA1I_text 3
409 #define DATA1_LOCALDATA 12
410 #define DATA1_FLAG_XML 1
412 data1_handle data1_create (void);
413 data1_handle data1_createx (int flags);
414 void data1_destroy(data1_handle dh);
417 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
418 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
419 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
420 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
421 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
422 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
424 data1_tagset *data1_empty_tagset (data1_handle dh);
425 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
426 data1_element *data1_getelementbytagname(data1_handle dh,
428 data1_element *parent,
429 const char *tagname);
431 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
435 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
438 void data1_free_tree(data1_handle dh, data1_node *t);
440 char *data1_nodetobuf(data1_handle dh, data1_node *n,
441 int select, int *len);
443 data1_node *data1_mk_tag_data_wd(data1_handle dh,
445 const char *tagname, NMEM m);
446 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
447 const char *tagname, NMEM m);
448 data1_datatype data1_maptype(data1_handle dh, char *t);
449 data1_varset *data1_read_varset(data1_handle dh, const char *file);
450 data1_vartype *data1_getvartypebyct(data1_handle dh,
452 char *zclass, char *type);
453 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
454 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
456 data1_esetname *data1_getesetbyname(data1_handle dh,
459 data1_element *data1_getelementbyname(data1_handle dh,
462 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
463 int type, data1_node *parent);
465 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
466 const char *tag, const char **attr,
468 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
469 const char *tag, size_t len,
472 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
473 data1_node *res, const char **attr);
475 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
476 const char *buf, size_t len,
478 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
479 const char *buf, size_t len,
481 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
482 const char *buf, data1_node *parent);
484 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
485 const char *buf, size_t len,
488 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
489 const char *buf, data1_node *parent);
491 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
496 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
498 void data1_set_root(data1_handle dh, data1_node *res,
499 NMEM nmem, const char *name);
501 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
502 const char *tag, int num,
504 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
505 const char *tag, Odr_oid *oid,
507 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
511 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
517 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
519 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
521 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
522 const char *tag, data1_node *at);
523 data1_attset *data1_get_attset (data1_handle dh, const char *name);
524 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
525 data1_node *data1_map_record(data1_handle dh, data1_node *n,
526 data1_maptab *map, NMEM m);
527 data1_marctab *data1_read_marctab (data1_handle dh,
529 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
530 data1_node *n, int selected, int *len);
531 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
532 int select, int *len);
533 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
534 data1_node *n, int select,
536 Z_BriefBib *data1_nodetosummary(data1_handle dh,
537 data1_node *n, int select,
539 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
541 WRBUF data1_get_wrbuf (data1_handle dp);
542 char **data1_get_read_buf (data1_handle dp, int **lenp);
543 char **data1_get_map_buf (data1_handle dp, int **lenp);
544 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
545 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
546 NMEM data1_nmem_get (data1_handle dh);
548 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
549 void data1_print_tree (data1_handle dh, data1_node *n);
552 char *data1_insert_string (data1_handle dh, data1_node *res,
553 NMEM m, const char *str);
554 char *data1_insert_string_n (data1_handle dh, data1_node *res,
555 NMEM m, const char *str, size_t len);
556 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
559 data1_node *data1_read_xml (data1_handle dh,
560 int (*rf)(void *, char *, size_t),
563 void data1_absyn_trav (data1_handle dh, void *handle,
564 void (*fh)(data1_handle dh,
565 void *h, data1_absyn *a));
567 data1_attset *data1_attset_search_id (data1_handle dh, int id);
569 char *data1_getNodeValue(data1_node* node, char* pTagPath);
570 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
571 int data1_CountOccurences(data1_node* node, char* pTagPath);
574 FILE *data1_path_fopen (data1_handle dh, const char *file,
576 void data1_set_tabpath(data1_handle dh, const char *path);
577 void data1_set_tabroot (data1_handle dp, const char *p);
578 const char *data1_get_tabpath(data1_handle dh);
579 const char *data1_get_tabroot(data1_handle dh);
583 /* =========================================================================
585 * =========================================================================
587 int grs_perl_readf(struct perl_context *context, size_t len);
588 int grs_perl_readline(struct perl_context *context);
589 char grs_perl_getc(struct perl_context *context);
590 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
591 off_t grs_perl_tellf(struct perl_context *context);
592 void grs_perl_endf(struct perl_context *context, off_t offset);
594 data1_handle *grs_perl_get_dh(struct perl_context *context);
595 NMEM *grs_perl_get_mem(struct perl_context *context);
596 void grs_perl_set_res(struct perl_context *context, data1_node *n);