2 %include typemaps.i // Load the typemaps librayr
6 #include "zebra_api_ext.h"
7 #include "zebra_perl.h"
13 /* == Typemaps ============================================================= */
15 /* RetrievalRecordBuff is a special construct, to allow to map a char * buf
16 to non-null terminated perl string scalar value (SVpv). */
17 %typemap(out) RetrievalRecordBuf * {
18 $result = newSVpv($1->buf,$1->len);
23 /* All char ** values are mapped in-out to array of strings. */
24 %typemap(in) char ** {
31 croak("Argument $argnum is not a reference.");
32 if (SvTYPE(SvRV($input)) != SVt_PVAV)
33 croak("Argument $argnum is not an array.");
34 tempav = (AV*)SvRV($input);
36 $1 = (char **) malloc((len+2)*sizeof(char *));
37 for (i = 0; i <= len; i++) {
38 tv = av_fetch(tempav, i, 0);
39 $1[i] = (char *) SvPV(*tv,na);
44 /* This cleans up the char ** array after the function call */
45 %typemap(freearg) char ** {
49 /* Creates a new Perl array and places a NULL-terminated char ** into it */
50 %typemap(out) char ** {
54 /* Figure out how many elements we have */
57 svs = (SV **) malloc(len*sizeof(SV *));
58 for (i = 0; i < len ; i++) {
59 svs[i] = sv_newmortal();
60 sv_setpv((SV*)svs[i],$1[i]);
62 myav = av_make(len,svs);
64 $result = newRV((SV*)myav);
69 /* == Structures for shadow classes ======================================= */
71 %include "zebra_perl.h"
80 } ZebraTransactionStatus;
83 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
88 /* == Logging facilities (yaz/log.h) ======================================= */
90 void logLevel (int level);
91 void logFile (const char *fname);
92 void logMsg (int level, const char *message);
94 #define LOG_FATAL 0x0001
95 #define LOG_DEBUG 0x0002
96 #define LOG_WARN 0x0004
97 #define LOG_LOG 0x0008
98 #define LOG_ERRNO 0x0010 /* append strerror to message */
99 #define LOG_FILE 0x0020
100 #define LOG_APP 0x0040 /* For application level events */
101 #define LOG_MALLOC 0x0080 /* debugging mallocs */
102 #define LOG_ALL 0xff7f
103 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
105 /* == ODR stuff (yaz/odr.h) ================================================ */
110 ODR odr_createmem(int direction);
111 void odr_reset(ODR o);
112 void odr_destroy(ODR o);
113 void *odr_malloc(ODR o, int size);
116 /* == Zebra session and service (index/zebraapi.c) ========================= */
119 ZebraService zebra_start (const char *configName);
122 ZebraHandle zebra_open (ZebraService zs);
125 void zebra_close (ZebraHandle zh);
128 void zebra_stop (ZebraService zs);
131 /* == Error handling and reporting (index/zebraapi.c) ====================== */
133 /* last error code */
135 int zebra_errCode (ZebraHandle zh);
137 /* string representatio of above */
139 const char * zebra_errString (ZebraHandle zh);
141 /* extra information associated with error */
143 char * zebra_errAdd (ZebraHandle zh);
146 /* == Record groups and database selection ================================= */
148 /* initialize a recordGroup (zebra_api_ext.c); */
149 void init_recordGroup (recordGroup *rg);
151 /* set up a recordGroup for a specific file extension from zebra.cfg
152 (zebra_api_ext.c); */
153 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg,
155 /* set current record group for update purposes (zebraapi.c) */
157 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
159 /* select database for update purposes (zebraapi.c) */
160 %name(select_database)
161 int zebra_select_database (ZebraHandle zh, const char *basename);
163 /* select databases for record retrieval (zebraapi.c) */
164 %name(select_databases)
165 int zebra_select_databases (ZebraHandle zh, int num_bases,
166 const char **basenames);
169 /* == Transactions, locking, shadow register =============================== */
171 /* begin transaction (add write lock) (zebraapi.c) */
173 void zebra_begin_trans (ZebraHandle zh);
175 /* end transaction (remove write lock) (zebraapi.c) */
177 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
180 int zebra_trans_no (ZebraHandle zh);
183 int zebra_begin_read (ZebraHandle zh);
185 void zts_test (ZebraTransactionStatus *stat);
187 /* end retrieval (remove read lock) (zebraapi.c) */
189 void zebra_end_read (ZebraHandle zh);
191 /* commit changes from shadow (zebraapi.c) */
193 int zebra_commit (ZebraHandle zh);
195 /* get shadow status (zebra_api_ext.c) */
196 %name(get_shadow_enable)
197 int zebra_get_shadow_enable (ZebraHandle zh);
199 /* set shadow status (zebra_api_ext.c) */
200 %name(set_shadow_enable)
201 void zebra_set_shadow_enable (ZebraHandle zh, int value);
204 /* == Repository actions (zebraapi.c) ====================================== */
207 int zebra_init (ZebraHandle zh);
210 int zebra_compact (ZebraHandle zh);
212 %name(repository_update)
213 void zebra_repository_update (ZebraHandle zh);
215 %name(repository_delete)
216 void zebra_repository_delete (ZebraHandle zh);
218 %name(repository_show)
219 void zebra_repository_show (ZebraHandle zh);
222 /* == Record update/delete (zebra_api_ext.c) =============================== */
224 /* If sysno is provided, then it's used to identify the reocord.
225 If not, and match_criteria is provided, then sysno is guessed
226 If not, and a record is provided, then sysno is got from there */
229 int zebra_update_record (ZebraHandle zh,
231 const char *recordType,
239 int zebra_delete_record (ZebraHandle zh,
241 const char *recordType,
248 /* == Search (zebra_api_ext.c) ============================================= */
251 int zebra_search_PQF (ZebraHandle zh,
252 ODR odr_input, ODR odr_output,
253 const char *pqf_query,
254 const char *setname);
257 /* == YAZ - query tools ==================================================== */
260 cql_transform_t cql_transform_open_fname(const char *fname);
261 void cql_transform_close(cql_transform_t ct);
262 int cql_transform_error(cql_transform_t ct, const char **addinfo);
265 int zebra_cql2pqf (cql_transform_t ct,
266 const char *query, char *res, int len);
268 /* == Retrieval (zebra_api_ext.c) ========================================== */
270 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
271 used to get the individual records. Elementset, schema and format strings
272 are threated the same way yaz-client does. */
273 void records_retrieve(ZebraHandle zh,
275 const char *setname, // resultset name
276 const char *a_eset, // optional elementset
277 const char *a_schema, // optional schema
278 const char *a_format, // optional record syntax
279 int from, // range, 1 based
284 /* fetch a record from the retrieval object. pos is 1 based */
285 void record_retrieve(RetrievalObj *ro,
287 RetrievalRecord *res,
290 /* == Sort ================================================================= */
291 int sort (ZebraHandle zh,
293 const char *sort_spec,
294 const char *output_setname,
295 const char **input_setnames
298 /* == Scan ================================================================= */
300 void zebra_scan_PQF (ZebraHandle zh,
303 const char *pqf_query);
305 ScanEntry *getScanEntry(ScanObj *so, int pos);
307 /* Admin functionality */
309 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
310 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
314 /* Delete Result Set(s) */
316 int zebra_deleleResultSet(ZebraHandle zh, int function,
317 int num_setnames, char **setnames,
321 /* do authentication */
323 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
330 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
331 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
333 int *type, char *out, size_t *len);
337 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
339 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
341 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
344 void zebra_admin_shutdown (ZebraHandle zh);
345 void zebra_admin_start (ZebraHandle zh);
346 void zebra_admin_import_end (ZebraHandle zh);
352 /* =========================================================================
354 * =========================================================================
357 NMEM nmem_create (void);
358 void nmem_destroy (NMEM handle);
360 /* =========================================================================
362 * =========================================================================
365 typedef enum data1_datatype
373 DATA1K_generalizedtime,
380 #define DATA1T_numeric 1
381 #define DATA1T_string 2
382 #define DATA1N_root 1
384 #define DATA1N_data 3
385 #define DATA1N_variant 4
386 #define DATA1N_comment 5
387 #define DATA1N_preprocess 6
388 #define DATA1I_inctxt 1
389 #define DATA1I_incbin 2
390 #define DATA1I_text 3
393 #define DATA1_LOCALDATA 12
394 #define DATA1_FLAG_XML 1
396 data1_handle data1_create (void);
397 data1_handle data1_createx (int flags);
398 void data1_destroy(data1_handle dh);
401 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
402 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
403 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
404 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
405 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
406 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
408 data1_tagset *data1_empty_tagset (data1_handle dh);
409 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
410 data1_element *data1_getelementbytagname(data1_handle dh,
412 data1_element *parent,
413 const char *tagname);
415 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
419 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
422 void data1_free_tree(data1_handle dh, data1_node *t);
424 char *data1_nodetobuf(data1_handle dh, data1_node *n,
425 int select, int *len);
427 data1_node *data1_mk_tag_data_wd(data1_handle dh,
429 const char *tagname, NMEM m);
430 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
431 const char *tagname, NMEM m);
432 data1_datatype data1_maptype(data1_handle dh, char *t);
433 data1_varset *data1_read_varset(data1_handle dh, const char *file);
434 data1_vartype *data1_getvartypebyct(data1_handle dh,
436 char *zclass, char *type);
437 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
438 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
440 data1_esetname *data1_getesetbyname(data1_handle dh,
443 data1_element *data1_getelementbyname(data1_handle dh,
446 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
447 int type, data1_node *parent);
449 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
450 const char *tag, const char **attr,
452 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
453 const char *tag, size_t len,
456 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
457 data1_node *res, const char **attr);
459 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
460 const char *buf, size_t len,
462 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
463 const char *buf, size_t len,
465 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
466 const char *buf, data1_node *parent);
468 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
469 const char *buf, size_t len,
472 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
473 const char *buf, data1_node *parent);
475 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
480 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
482 void data1_set_root(data1_handle dh, data1_node *res,
483 NMEM nmem, const char *name);
485 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
486 const char *tag, int num,
488 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
489 const char *tag, Odr_oid *oid,
491 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
495 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
501 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
503 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
505 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
506 const char *tag, data1_node *at);
507 data1_attset *data1_get_attset (data1_handle dh, const char *name);
508 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
509 data1_node *data1_map_record(data1_handle dh, data1_node *n,
510 data1_maptab *map, NMEM m);
511 data1_marctab *data1_read_marctab (data1_handle dh,
513 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
514 data1_node *n, int selected, int *len);
515 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
516 int select, int *len);
517 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
518 data1_node *n, int select,
520 Z_BriefBib *data1_nodetosummary(data1_handle dh,
521 data1_node *n, int select,
523 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
525 WRBUF data1_get_wrbuf (data1_handle dp);
526 char **data1_get_read_buf (data1_handle dp, int **lenp);
527 char **data1_get_map_buf (data1_handle dp, int **lenp);
528 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
529 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
530 NMEM data1_nmem_get (data1_handle dh);
532 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
533 void data1_print_tree (data1_handle dh, data1_node *n);
536 char *data1_insert_string (data1_handle dh, data1_node *res,
537 NMEM m, const char *str);
538 char *data1_insert_string_n (data1_handle dh, data1_node *res,
539 NMEM m, const char *str, size_t len);
540 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
543 data1_node *data1_read_xml (data1_handle dh,
544 int (*rf)(void *, char *, size_t),
547 void data1_absyn_trav (data1_handle dh, void *handle,
548 void (*fh)(data1_handle dh,
549 void *h, data1_absyn *a));
551 data1_attset *data1_attset_search_id (data1_handle dh, int id);
553 char *data1_getNodeValue(data1_node* node, char* pTagPath);
554 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
555 int data1_CountOccurences(data1_node* node, char* pTagPath);
558 FILE *data1_path_fopen (data1_handle dh, const char *file,
560 void data1_set_tabpath(data1_handle dh, const char *path);
561 void data1_set_tabroot (data1_handle dp, const char *p);
562 const char *data1_get_tabpath(data1_handle dh);
563 const char *data1_get_tabroot(data1_handle dh);
567 /* =========================================================================
569 * =========================================================================
571 int grs_perl_readf(struct perl_context *context, size_t len);
572 int grs_perl_readline(struct perl_context *context);
573 char grs_perl_getc(struct perl_context *context);
574 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
575 off_t grs_perl_tellf(struct perl_context *context);
576 void grs_perl_endf(struct perl_context *context, off_t offset);
578 data1_handle *grs_perl_get_dh(struct perl_context *context);
579 NMEM *grs_perl_get_mem(struct perl_context *context);
580 void grs_perl_set_res(struct perl_context *context, data1_node *n);