5 #include "zebra_api_ext.h"
6 #include "zebra_perl.h"
11 /* == Typemaps ============================================================= */
13 /* RetrievalRecordBuff is a special construct, to allow to map a char * buf
14 to non-null terminated perl string scalar value (SVpv). */
15 %typemap(out) RetrievalRecordBuf * {
16 $result = newSVpv($1->buf,$1->len);
21 /* All char ** values are mapped in-out to array of strings. */
22 %typemap(in) char ** {
29 croak("Argument $argnum is not a reference.");
30 if (SvTYPE(SvRV($input)) != SVt_PVAV)
31 croak("Argument $argnum is not an array.");
32 tempav = (AV*)SvRV($input);
34 $1 = (char **) malloc((len+2)*sizeof(char *));
35 for (i = 0; i <= len; i++) {
36 tv = av_fetch(tempav, i, 0);
37 $1[i] = (char *) SvPV(*tv,na);
42 /* This cleans up the char ** array after the function call */
43 %typemap(freearg) char ** {
47 /* Creates a new Perl array and places a NULL-terminated char ** into it */
48 %typemap(out) char ** {
52 /* Figure out how many elements we have */
55 svs = (SV **) malloc(len*sizeof(SV *));
56 for (i = 0; i < len ; i++) {
57 svs[i] = sv_newmortal();
58 sv_setpv((SV*)svs[i],$1[i]);
60 myav = av_make(len,svs);
62 $result = newRV((SV*)myav);
68 /* == Structures for shadow classes ======================================= */
70 %include "zebra_perl.h"
73 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
79 /* == Logging facilities (yaz/log.h) ======================================= */
81 void logLevel (int level);
82 void logFile (const char *fname);
83 void logMsg (int level, const char *message);
85 #define LOG_FATAL 0x0001
86 #define LOG_DEBUG 0x0002
87 #define LOG_WARN 0x0004
88 #define LOG_LOG 0x0008
89 #define LOG_ERRNO 0x0010 /* append strerror to message */
90 #define LOG_FILE 0x0020
91 #define LOG_APP 0x0040 /* For application level events */
92 #define LOG_MALLOC 0x0080 /* debugging mallocs */
93 #define LOG_ALL 0xff7f
94 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
96 /* == ODR stuff (yaz/odr.h) ================================================ */
101 ODR odr_createmem(int direction);
102 void odr_reset(ODR o);
103 void odr_destroy(ODR o);
104 void *odr_malloc(ODR o, int size);
107 /* == Zebra session and service (index/zebraapi.c) ========================= */
110 ZebraService zebra_start (const char *configName);
113 ZebraHandle zebra_open (ZebraService zs);
116 void zebra_close (ZebraHandle zh);
119 void zebra_stop (ZebraService zs);
122 /* == Error handling and reporting (index/zebraapi.c) ====================== */
124 /* last error code */
126 int zebra_errCode (ZebraHandle zh);
128 /* string representatio of above */
130 const char * zebra_errString (ZebraHandle zh);
132 /* extra information associated with error */
134 char * zebra_errAdd (ZebraHandle zh);
137 /* == Record groups and database selection ================================= */
139 /* initialize a recordGroup (zebra_api_ext.c); */
140 void init_recordGroup (recordGroup *rg);
142 /* set up a recordGroup for a specific file extension from zebra.cfg
143 (zebra_api_ext.c); */
144 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg,
146 /* set current record group for update purposes (zebraapi.c) */
148 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
150 /* select database for update purposes (zebraapi.c) */
151 %name(select_database)
152 int zebra_select_database (ZebraHandle zh, const char *basename);
154 /* select databases for record retrieval (zebraapi.c) */
155 %name(select_databases)
156 int zebra_select_databases (ZebraHandle zh, int num_bases,
157 const char **basenames);
160 /* == Transactions, locking, shadow register =============================== */
162 /* begin transaction (add write lock) (zebraapi.c) */
164 void zebra_begin_trans (ZebraHandle zh);
166 /* end transaction (remove write lock) (zebraapi.c) */
168 void zebra_end_trans (ZebraHandle zh);
170 /* begin retrieval (add read lock) (zebraapi.c) */
172 int zebra_begin_read (ZebraHandle zh);
174 /* end retrieval (remove read lock) (zebraapi.c) */
176 void zebra_end_read (ZebraHandle zh);
178 /* commit changes from shadow (zebraapi.c) */
180 int zebra_commit (ZebraHandle zh);
182 /* get shadow status (zebra_api_ext.c) */
183 %name(get_shadow_enable)
184 int zebra_get_shadow_enable (ZebraHandle zh);
186 /* set shadow status (zebra_api_ext.c) */
187 %name(set_shadow_enable)
188 void zebra_set_shadow_enable (ZebraHandle zh, int value);
191 /* == Repository actions (zebraapi.c) ====================================== */
194 int zebra_init (ZebraHandle zh);
197 int zebra_compact (ZebraHandle zh);
199 %name(repository_update)
200 void zebra_repository_update (ZebraHandle zh);
202 %name(repository_delete)
203 void zebra_repository_delete (ZebraHandle zh);
205 %name(repository_show)
206 void zebra_repository_show (ZebraHandle zh);
209 /* == Record update/delete (zebra_api_ext.c) =============================== */
211 /* If sysno is provided, then it's used to identify the reocord.
212 If not, and match_criteria is provided, then sysno is guessed
213 If not, and a record is provided, then sysno is got from there */
216 int zebra_update_record (ZebraHandle zh,
225 int zebra_delete_record (ZebraHandle zh,
233 /* == Search (zebra_api_ext.c) ============================================= */
236 int zebra_search_PQF (ZebraHandle zh,
237 ODR odr_input, ODR odr_output,
238 const char *pqf_query,
239 const char *setname);
242 /* TODO: search_CCL */
245 /* == Retrieval (zebra_api_ext.c) ========================================== */
247 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
248 used to get the individual records. Elementset, schema and format strings
249 are threated the same way yaz-client does. */
250 void records_retrieve(ZebraHandle zh,
252 const char *setname, // resultset name
253 const char *a_eset, // optional elementset
254 const char *a_schema, // optional schema
255 const char *a_format, // optional record syntax
256 int from, // range, 1 based
261 /* fetch a record from the retrieval object. pos is 1 based */
262 void record_retrieve(RetrievalObj *ro,
264 RetrievalRecord *res,
267 /* == Sort ================================================================= */
268 int sort (ZebraHandle zh,
270 const char *sort_spec,
271 const char *output_setname,
272 const char **input_setnames
276 void zebra_sort (ZebraHandle zh, ODR stream,
277 int num_input_setnames,
278 const char **input_setnames,
279 const char *output_setname,
280 Z_SortKeySpecList *sort_sequence,
284 /* Admin functionality */
286 %name(admin_start) void zebra_admin_start (ZebraHandle zh);
287 %name(admin_shutdown) void zebra_admin_shutdown (ZebraHandle zh);
291 void zebra_scan (ZebraHandle zh, ODR stream,
292 Z_AttributesPlusTerm *zapt,
293 oid_value attributeset,
294 int *position, int *num_entries,
295 ZebraScanEntry **list,
299 /* Delete Result Set(s) */
301 int zebra_deleleResultSet(ZebraHandle zh, int function,
302 int num_setnames, char **setnames,
306 /* do authentication */
308 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
315 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
316 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
318 int *type, char *out, size_t *len);
322 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
324 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
326 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
329 void zebra_admin_shutdown (ZebraHandle zh);
330 void zebra_admin_start (ZebraHandle zh);
331 void zebra_admin_import_end (ZebraHandle zh);
337 /* =========================================================================
339 * =========================================================================
342 NMEM nmem_create (void);
343 void nmem_destroy (NMEM handle);
345 /* =========================================================================
347 * =========================================================================
350 typedef enum data1_datatype
358 DATA1K_generalizedtime,
365 #define DATA1T_numeric 1
366 #define DATA1T_string 2
367 #define DATA1N_root 1
369 #define DATA1N_data 3
370 #define DATA1N_variant 4
371 #define DATA1N_comment 5
372 #define DATA1N_preprocess 6
373 #define DATA1I_inctxt 1
374 #define DATA1I_incbin 2
375 #define DATA1I_text 3
378 #define DATA1_LOCALDATA 12
379 #define DATA1_FLAG_XML 1
381 data1_handle data1_create (void);
382 data1_handle data1_createx (int flags);
383 void data1_destroy(data1_handle dh);
386 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
387 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
388 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
389 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
390 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
391 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
393 data1_tagset *data1_empty_tagset (data1_handle dh);
394 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
395 data1_element *data1_getelementbytagname(data1_handle dh,
397 data1_element *parent,
398 const char *tagname);
400 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
404 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
407 void data1_free_tree(data1_handle dh, data1_node *t);
409 char *data1_nodetobuf(data1_handle dh, data1_node *n,
410 int select, int *len);
412 data1_node *data1_mk_tag_data_wd(data1_handle dh,
414 const char *tagname, NMEM m);
415 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
416 const char *tagname, NMEM m);
417 data1_datatype data1_maptype(data1_handle dh, char *t);
418 data1_varset *data1_read_varset(data1_handle dh, const char *file);
419 data1_vartype *data1_getvartypebyct(data1_handle dh,
421 char *zclass, char *type);
422 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
423 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
425 data1_esetname *data1_getesetbyname(data1_handle dh,
428 data1_element *data1_getelementbyname(data1_handle dh,
431 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
432 int type, data1_node *parent);
434 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
435 const char *tag, const char **attr,
437 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
438 const char *tag, size_t len,
441 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
442 data1_node *res, const char **attr);
444 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
445 const char *buf, size_t len,
447 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
448 const char *buf, size_t len,
450 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
451 const char *buf, data1_node *parent);
453 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
454 const char *buf, size_t len,
457 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
458 const char *buf, data1_node *parent);
460 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
465 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
467 void data1_set_root(data1_handle dh, data1_node *res,
468 NMEM nmem, const char *name);
470 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
471 const char *tag, int num,
473 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
474 const char *tag, Odr_oid *oid,
476 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
480 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
486 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
488 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
490 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
491 const char *tag, data1_node *at);
492 data1_attset *data1_get_attset (data1_handle dh, const char *name);
493 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
494 data1_node *data1_map_record(data1_handle dh, data1_node *n,
495 data1_maptab *map, NMEM m);
496 data1_marctab *data1_read_marctab (data1_handle dh,
498 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
499 data1_node *n, int selected, int *len);
500 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
501 int select, int *len);
502 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
503 data1_node *n, int select,
505 Z_BriefBib *data1_nodetosummary(data1_handle dh,
506 data1_node *n, int select,
508 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
510 WRBUF data1_get_wrbuf (data1_handle dp);
511 char **data1_get_read_buf (data1_handle dp, int **lenp);
512 char **data1_get_map_buf (data1_handle dp, int **lenp);
513 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
514 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
515 NMEM data1_nmem_get (data1_handle dh);
517 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
518 void data1_print_tree (data1_handle dh, data1_node *n);
521 char *data1_insert_string (data1_handle dh, data1_node *res,
522 NMEM m, const char *str);
523 char *data1_insert_string_n (data1_handle dh, data1_node *res,
524 NMEM m, const char *str, size_t len);
525 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
528 data1_node *data1_read_xml (data1_handle dh,
529 int (*rf)(void *, char *, size_t),
532 void data1_absyn_trav (data1_handle dh, void *handle,
533 void (*fh)(data1_handle dh,
534 void *h, data1_absyn *a));
536 data1_attset *data1_attset_search_id (data1_handle dh, int id);
538 char *data1_getNodeValue(data1_node* node, char* pTagPath);
539 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
540 int data1_CountOccurences(data1_node* node, char* pTagPath);
543 FILE *data1_path_fopen (data1_handle dh, const char *file,
545 void data1_set_tabpath(data1_handle dh, const char *path);
546 void data1_set_tabroot (data1_handle dp, const char *p);
547 const char *data1_get_tabpath(data1_handle dh);
548 const char *data1_get_tabroot(data1_handle dh);
552 /* =========================================================================
554 * =========================================================================
556 int grs_perl_readf(struct perl_context *context, size_t len);
557 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
558 off_t grs_perl_tellf(struct perl_context *context);
559 void grs_perl_endf(struct perl_context *context, off_t offset);
561 data1_handle *grs_perl_get_dh(struct perl_context *context);
562 NMEM *grs_perl_get_mem(struct perl_context *context);
563 void grs_perl_set_res(struct perl_context *context, data1_node *n);