2 %include typemaps.i // Load the typemaps librayr
6 #include "zebra_api_ext.h"
7 #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). */
16 %typemap(out) RetrievalRecordBuf * {
17 $result = newSVpv($1->buf,$1->len);
22 /* All char ** values are mapped in-out to array of strings. */
23 %typemap(in) char ** {
30 croak("Argument $argnum is not a reference.");
31 if (SvTYPE(SvRV($input)) != SVt_PVAV)
32 croak("Argument $argnum is not an array.");
33 tempav = (AV*)SvRV($input);
35 $1 = (char **) malloc((len+2)*sizeof(char *));
36 for (i = 0; i <= len; i++) {
37 tv = av_fetch(tempav, i, 0);
38 $1[i] = (char *) SvPV(*tv,na);
43 /* This cleans up the char ** array after the function call */
44 %typemap(freearg) char ** {
48 /* Creates a new Perl array and places a NULL-terminated char ** into it */
49 %typemap(out) char ** {
53 /* Figure out how many elements we have */
56 svs = (SV **) malloc(len*sizeof(SV *));
57 for (i = 0; i < len ; i++) {
58 svs[i] = sv_newmortal();
59 sv_setpv((SV*)svs[i],$1[i]);
61 myav = av_make(len,svs);
63 $result = newRV((SV*)myav);
68 /* == Structures for shadow classes ======================================= */
70 %include "zebra_perl.h"
72 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
78 /* == Logging facilities (yaz/log.h) ======================================= */
80 void logLevel (int level);
81 void logFile (const char *fname);
82 void logMsg (int level, const char *message);
84 #define LOG_FATAL 0x0001
85 #define LOG_DEBUG 0x0002
86 #define LOG_WARN 0x0004
87 #define LOG_LOG 0x0008
88 #define LOG_ERRNO 0x0010 /* append strerror to message */
89 #define LOG_FILE 0x0020
90 #define LOG_APP 0x0040 /* For application level events */
91 #define LOG_MALLOC 0x0080 /* debugging mallocs */
92 #define LOG_ALL 0xff7f
93 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
95 /* == ODR stuff (yaz/odr.h) ================================================ */
100 ODR odr_createmem(int direction);
101 void odr_reset(ODR o);
102 void odr_destroy(ODR o);
103 void *odr_malloc(ODR o, int size);
106 /* == Zebra session and service (index/zebraapi.c) ========================= */
109 ZebraService zebra_start (const char *configName);
112 ZebraHandle zebra_open (ZebraService zs);
115 void zebra_close (ZebraHandle zh);
118 void zebra_stop (ZebraService zs);
121 /* == Error handling and reporting (index/zebraapi.c) ====================== */
123 /* last error code */
125 int zebra_errCode (ZebraHandle zh);
127 /* string representatio of above */
129 const char * zebra_errString (ZebraHandle zh);
131 /* extra information associated with error */
133 char * zebra_errAdd (ZebraHandle zh);
136 /* == Record groups and database selection ================================= */
138 /* initialize a recordGroup (zebra_api_ext.c); */
139 void init_recordGroup (recordGroup *rg);
141 /* set up a recordGroup for a specific file extension from zebra.cfg
142 (zebra_api_ext.c); */
143 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg,
145 /* set current record group for update purposes (zebraapi.c) */
147 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
149 /* select database for update purposes (zebraapi.c) */
150 %name(select_database)
151 int zebra_select_database (ZebraHandle zh, const char *basename);
153 /* select databases for record retrieval (zebraapi.c) */
154 %name(select_databases)
155 int zebra_select_databases (ZebraHandle zh, int num_bases,
156 const char **basenames);
159 /* == Transactions, locking, shadow register =============================== */
161 /* begin transaction (add write lock) (zebraapi.c) */
163 void zebra_begin_trans (ZebraHandle zh);
165 /* end transaction (remove write lock) (zebraapi.c) */
167 void zebra_end_trans (ZebraHandle zh);
169 /* begin retrieval (add read lock) (zebraapi.c) */
171 int zebra_begin_read (ZebraHandle zh);
173 /* end retrieval (remove read lock) (zebraapi.c) */
175 void zebra_end_read (ZebraHandle zh);
177 /* commit changes from shadow (zebraapi.c) */
179 int zebra_commit (ZebraHandle zh);
181 /* get shadow status (zebra_api_ext.c) */
182 %name(get_shadow_enable)
183 int zebra_get_shadow_enable (ZebraHandle zh);
185 /* set shadow status (zebra_api_ext.c) */
186 %name(set_shadow_enable)
187 void zebra_set_shadow_enable (ZebraHandle zh, int value);
190 /* == Repository actions (zebraapi.c) ====================================== */
193 int zebra_init (ZebraHandle zh);
196 int zebra_compact (ZebraHandle zh);
198 %name(repository_update)
199 void zebra_repository_update (ZebraHandle zh);
201 %name(repository_delete)
202 void zebra_repository_delete (ZebraHandle zh);
204 %name(repository_show)
205 void zebra_repository_show (ZebraHandle zh);
208 /* == Record update/delete (zebra_api_ext.c) =============================== */
210 /* If sysno is provided, then it's used to identify the reocord.
211 If not, and match_criteria is provided, then sysno is guessed
212 If not, and a record is provided, then sysno is got from there */
215 int zebra_update_record (ZebraHandle zh,
224 int zebra_delete_record (ZebraHandle zh,
232 /* == Search (zebra_api_ext.c) ============================================= */
235 int zebra_search_PQF (ZebraHandle zh,
236 ODR odr_input, ODR odr_output,
237 const char *pqf_query,
238 const char *setname);
241 /* TODO: search_CCL */
244 /* == Retrieval (zebra_api_ext.c) ========================================== */
246 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
247 used to get the individual records. Elementset, schema and format strings
248 are threated the same way yaz-client does. */
249 void records_retrieve(ZebraHandle zh,
251 const char *setname, // resultset name
252 const char *a_eset, // optional elementset
253 const char *a_schema, // optional schema
254 const char *a_format, // optional record syntax
255 int from, // range, 1 based
260 /* fetch a record from the retrieval object. pos is 1 based */
261 void record_retrieve(RetrievalObj *ro,
263 RetrievalRecord *res,
266 /* == Sort ================================================================= */
267 int sort (ZebraHandle zh,
269 const char *sort_spec,
270 const char *output_setname,
271 const char **input_setnames
274 /* == Scan ================================================================= */
276 %apply int *INOUT {int *position};
277 %apply int *INOUT {int *num_entries};
278 %apply int *INOUT {int *is_partial};
281 void zebra_scan_PQF (ZebraHandle zh,
283 const char *pqf_query,
289 void zebra_scan_PQF (ZebraHandle zh,
292 const char *pqf_query);
294 ScanEntry *getScanEntry(ScanObj *so, int pos);
296 /* Admin functionality */
298 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
299 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
303 /* Delete Result Set(s) */
305 int zebra_deleleResultSet(ZebraHandle zh, int function,
306 int num_setnames, char **setnames,
310 /* do authentication */
312 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
319 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
320 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
322 int *type, char *out, size_t *len);
326 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
328 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
330 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
333 void zebra_admin_shutdown (ZebraHandle zh);
334 void zebra_admin_start (ZebraHandle zh);
335 void zebra_admin_import_end (ZebraHandle zh);
341 /* =========================================================================
343 * =========================================================================
346 NMEM nmem_create (void);
347 void nmem_destroy (NMEM handle);
349 /* =========================================================================
351 * =========================================================================
354 typedef enum data1_datatype
362 DATA1K_generalizedtime,
369 #define DATA1T_numeric 1
370 #define DATA1T_string 2
371 #define DATA1N_root 1
373 #define DATA1N_data 3
374 #define DATA1N_variant 4
375 #define DATA1N_comment 5
376 #define DATA1N_preprocess 6
377 #define DATA1I_inctxt 1
378 #define DATA1I_incbin 2
379 #define DATA1I_text 3
382 #define DATA1_LOCALDATA 12
383 #define DATA1_FLAG_XML 1
385 data1_handle data1_create (void);
386 data1_handle data1_createx (int flags);
387 void data1_destroy(data1_handle dh);
390 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
391 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
392 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
393 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
394 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
395 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
397 data1_tagset *data1_empty_tagset (data1_handle dh);
398 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
399 data1_element *data1_getelementbytagname(data1_handle dh,
401 data1_element *parent,
402 const char *tagname);
404 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
408 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
411 void data1_free_tree(data1_handle dh, data1_node *t);
413 char *data1_nodetobuf(data1_handle dh, data1_node *n,
414 int select, int *len);
416 data1_node *data1_mk_tag_data_wd(data1_handle dh,
418 const char *tagname, NMEM m);
419 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
420 const char *tagname, NMEM m);
421 data1_datatype data1_maptype(data1_handle dh, char *t);
422 data1_varset *data1_read_varset(data1_handle dh, const char *file);
423 data1_vartype *data1_getvartypebyct(data1_handle dh,
425 char *zclass, char *type);
426 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
427 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
429 data1_esetname *data1_getesetbyname(data1_handle dh,
432 data1_element *data1_getelementbyname(data1_handle dh,
435 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
436 int type, data1_node *parent);
438 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
439 const char *tag, const char **attr,
441 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
442 const char *tag, size_t len,
445 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
446 data1_node *res, const char **attr);
448 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
449 const char *buf, size_t len,
451 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
452 const char *buf, size_t len,
454 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
455 const char *buf, data1_node *parent);
457 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
458 const char *buf, size_t len,
461 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
462 const char *buf, data1_node *parent);
464 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
469 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
471 void data1_set_root(data1_handle dh, data1_node *res,
472 NMEM nmem, const char *name);
474 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
475 const char *tag, int num,
477 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
478 const char *tag, Odr_oid *oid,
480 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
484 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
490 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
492 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
494 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
495 const char *tag, data1_node *at);
496 data1_attset *data1_get_attset (data1_handle dh, const char *name);
497 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
498 data1_node *data1_map_record(data1_handle dh, data1_node *n,
499 data1_maptab *map, NMEM m);
500 data1_marctab *data1_read_marctab (data1_handle dh,
502 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
503 data1_node *n, int selected, int *len);
504 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
505 int select, int *len);
506 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
507 data1_node *n, int select,
509 Z_BriefBib *data1_nodetosummary(data1_handle dh,
510 data1_node *n, int select,
512 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
514 WRBUF data1_get_wrbuf (data1_handle dp);
515 char **data1_get_read_buf (data1_handle dp, int **lenp);
516 char **data1_get_map_buf (data1_handle dp, int **lenp);
517 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
518 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
519 NMEM data1_nmem_get (data1_handle dh);
521 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
522 void data1_print_tree (data1_handle dh, data1_node *n);
525 char *data1_insert_string (data1_handle dh, data1_node *res,
526 NMEM m, const char *str);
527 char *data1_insert_string_n (data1_handle dh, data1_node *res,
528 NMEM m, const char *str, size_t len);
529 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
532 data1_node *data1_read_xml (data1_handle dh,
533 int (*rf)(void *, char *, size_t),
536 void data1_absyn_trav (data1_handle dh, void *handle,
537 void (*fh)(data1_handle dh,
538 void *h, data1_absyn *a));
540 data1_attset *data1_attset_search_id (data1_handle dh, int id);
542 char *data1_getNodeValue(data1_node* node, char* pTagPath);
543 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
544 int data1_CountOccurences(data1_node* node, char* pTagPath);
547 FILE *data1_path_fopen (data1_handle dh, const char *file,
549 void data1_set_tabpath(data1_handle dh, const char *path);
550 void data1_set_tabroot (data1_handle dp, const char *p);
551 const char *data1_get_tabpath(data1_handle dh);
552 const char *data1_get_tabroot(data1_handle dh);
556 /* =========================================================================
558 * =========================================================================
560 int grs_perl_readf(struct perl_context *context, size_t len);
561 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
562 off_t grs_perl_tellf(struct perl_context *context);
563 void grs_perl_endf(struct perl_context *context, off_t offset);
565 data1_handle *grs_perl_get_dh(struct perl_context *context);
566 NMEM *grs_perl_get_mem(struct perl_context *context);
567 void grs_perl_set_res(struct perl_context *context, data1_node *n);