perl/IDZebra.i

   1 %module "IDZebra"
   2 %include typemaps.i                       // Load the typemaps librayr
   3
   4 %{
   5 #include "zebraapi.h"
   6 #include "zebra_api_ext.h"
   7 #include "zebra_perl.h"
   8 #include "data1.h"
   9 #include "yaz/odr.h"
  10 #include "yaz/cql.h"
  11 %}
  12
  13 /* == Typemaps ============================================================= */
  14
  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(in) int * {
  18   int i;
  19   if (!SvIOK($input))
  20     croak("Argument $argnum is not an integer.");
  21   i = SvIV($input);
  22   $1 = &i;
  23 }
  24
  25 %typemap(out) int * {
  26   $result=newSViv($1)
  27   sv_2mortal($result);
  28   argvi++;
  29 }
  30
  31 %typemap(out) RetrievalRecordBuf * {
  32   if ($1->len) {
  33     $result = newSVpv($1->buf,$1->len);
  34   } else {
  35     $result = newSVpv("",0);
  36   }
  37   sv_2mortal($result);
  38   argvi++;
  39 }
  40
  41 /* All char ** values are mapped in-out to array of strings. */
  42 %typemap(in) char ** {
  43         AV *tempav;
  44         I32 len;
  45         int i;
  46         SV  **tv;
  47         STRLEN na;
  48         if (!SvROK($input))
  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);
  53         len = av_len(tempav);
  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);
  58         }
  59         $1[i] = NULL;
  60 };
  61
  62 /* This cleans up the char ** array after the function call */
  63 %typemap(freearg) char ** {
  64         free($1);
  65 }
  66
  67 /* Creates a new Perl array and places a NULL-terminated char ** into it */
  68 %typemap(out) char ** {
  69         AV *myav;
  70         SV **svs;
  71         int i = 0,len = 0;
  72         /* Figure out how many elements we have */
  73         while ($1[len])
  74            len++;
  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]);
  79         };
  80         myav =  av_make(len,svs);
  81         free(svs);
  82         $result = newRV((SV*)myav);
  83         sv_2mortal($result);
  84         argvi++;
  85 }
  86
  87 /* == Structures for shadow classes  ======================================= */
  88
  89 %include "zebra_perl.h"
  90
  91 typedef struct {
  92   int processed;
  93   int inserted;
  94   int updated;
  95   int deleted;
  96   long utime;
  97   long stime;
  98 } ZebraTransactionStatus;
  99
 100
 101 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
 102
 103 void init (void);
 104 void DESTROY (void);
 105
 106 /* == Logging facilities (yaz/log.h) ======================================= */
 107
 108 void logLevel (int level);
 109 void logFile (const char *fname);
 110 void logMsg  (int level, const char *message);
 111
 112 #define LOG_FATAL  0x0001
 113 #define LOG_DEBUG  0x0002
 114 #define LOG_WARN   0x0004
 115 #define LOG_LOG    0x0008
 116 #define LOG_ERRNO  0x0010     /* append strerror to message */
 117 #define LOG_FILE   0x0020
 118 #define LOG_APP    0x0040     /* For application level events */
 119 #define LOG_MALLOC 0x0080     /* debugging mallocs */
 120 #define LOG_ALL    0xff7f
 121 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
 122
 123 /* == ODR stuff (yaz/odr.h) ================================================ */
 124
 125 #define ODR_DECODE      0
 126 #define ODR_ENCODE      1
 127 #define ODR_PRINT       2
 128 ODR odr_createmem(int direction);
 129 void odr_reset(ODR o);
 130 void odr_destroy(ODR o);
 131 void *odr_malloc(ODR o, int size);
 132
 133
 134 /* == Zebra session and service (index/zebraapi.c) ========================= */
 135
 136 %name(start)
 137 ZebraService zebra_start (const char *configName);
 138
 139 %name(open)
 140 ZebraHandle zebra_open (ZebraService zs);
 141
 142 %name(close)
 143 void zebra_close (ZebraHandle zh);
 144
 145 %name(stop)
 146 void zebra_stop (ZebraService zs);
 147
 148
 149 /* == Error handling and reporting (index/zebraapi.c) ====================== */
 150
 151 /* last error code */
 152 %name(errCode)
 153 int zebra_errCode (ZebraHandle zh);
 154
 155 /* string representatio of above */
 156 %name(errString)
 157 const char * zebra_errString (ZebraHandle zh);
 158
 159 /* extra information associated with error */
 160 %name(errAdd)
 161 char *  zebra_errAdd (ZebraHandle zh);
 162
 163
 164 /* == Record groups and database selection ================================= */
 165
 166 /* initialize a recordGroup (zebra_api_ext.c); */
 167 void init_recordGroup (recordGroup *rg);
 168
 169 /* set up a recordGroup for a specific file extension from zebra.cfg
 170    (zebra_api_ext.c); */
 171 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg,
 172                           const char *ext);
 173 /* set current record group for update purposes (zebraapi.c) */
 174 %name(set_group)
 175 void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
 176
 177 /* select database for update purposes (zebraapi.c) */
 178 %name(select_database)
 179 int zebra_select_database (ZebraHandle zh, const char *basename);
 180
 181 /* select databases for record retrieval (zebraapi.c) */
 182 %name(select_databases)
 183 int zebra_select_databases (ZebraHandle zh, int num_bases,
 184                              const char **basenames);
 185
 186
 187 /* == Transactions, locking, shadow register =============================== */
 188
 189 /* begin transaction (add write lock) (zebraapi.c) */
 190 %name(begin_trans)
 191 void zebra_begin_trans (ZebraHandle zh);
 192
 193 /* end transaction (remove write lock) (zebraapi.c) */
 194 %name(end_trans)
 195 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
 196
 197 %name(trans_no)
 198 int zebra_trans_no (ZebraHandle zh);
 199
 200 %name(begin_read)
 201 int zebra_begin_read (ZebraHandle zh);
 202
 203 void zts_test (ZebraTransactionStatus *stat);
 204
 205 /* end retrieval (remove read lock) (zebraapi.c) */
 206 %name(end_read)
 207 void zebra_end_read (ZebraHandle zh);
 208
 209 /* commit changes from shadow (zebraapi.c) */
 210 %name(commit)
 211 int  zebra_commit (ZebraHandle zh);
 212
 213 /* get shadow status (zebra_api_ext.c) */
 214 %name(get_shadow_enable)
 215 int  zebra_get_shadow_enable (ZebraHandle zh);
 216
 217 /* set shadow status (zebra_api_ext.c) */
 218 %name(set_shadow_enable)
 219 void zebra_set_shadow_enable (ZebraHandle zh, int value);
 220
 221
 222 /* == Repository actions (zebraapi.c) ====================================== */
 223
 224 %name(init)
 225 int  zebra_init (ZebraHandle zh);
 226
 227 %name(compact)
 228 int  zebra_compact (ZebraHandle zh);
 229
 230 %name(repository_update)
 231 void zebra_repository_update (ZebraHandle zh);
 232
 233 %name(repository_delete)
 234 void zebra_repository_delete (ZebraHandle zh);
 235
 236 %name(repository_show)
 237 void zebra_repository_show (ZebraHandle zh);
 238
 239
 240 /* == Record update/delete (zebra_api_ext.c) =============================== */
 241
 242 /* If sysno is provided, then it's used to identify the reocord.
 243    If not, and match_criteria is provided, then sysno is guessed
 244    If not, and a record is provided, then sysno is got from there */
 245
 246 %name(update_record)
 247 int zebra_update_record (ZebraHandle zh,
 248                          recordGroup *rGroup,
 249                          const char *recordType,
 250                          int sysno,
 251                          const char *match,
 252                          const char *fname,
 253                          const char *buf,
 254                          int buf_size);
 255
 256 %name(delete_record)
 257 int zebra_delete_record (ZebraHandle zh,
 258                          recordGroup *rGroup,
 259                          const char *recordType,
 260                          int sysno,
 261                          const char *match,
 262                          const char *fname,
 263                          const char *buf,
 264                          int buf_size);
 265
 266 /* == Search (zebra_api_ext.c) ============================================= */
 267
 268 %name(search_PQF)
 269 int zebra_search_PQF (ZebraHandle zh,
 270                       ODR odr_input, ODR odr_output,
 271                       const char *pqf_query,
 272                       const char *setname);
 273
 274
 275 /* == YAZ - query tools ==================================================== */
 276
 277
 278 cql_transform_t cql_transform_open_fname(const char *fname);
 279 void cql_transform_close(cql_transform_t ct);
 280 int cql_transform_error(cql_transform_t ct, const char **addinfo);
 281
 282 %name(cql2pqf)
 283 int zebra_cql2pqf (cql_transform_t ct,
 284                    const char *query, char *res, int len);
 285
 286 /* == Retrieval (zebra_api_ext.c) ========================================== */
 287
 288 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
 289    used to get the individual records. Elementset, schema and format strings
 290    are threated the same way yaz-client does. */
 291 void records_retrieve(ZebraHandle zh,
 292                       ODR stream,
 293                       const char *setname,      // resultset name
 294                       const char *a_eset,       // optional elementset
 295                       const char *a_schema,     // optional schema
 296                       const char *a_format,     // optional record syntax
 297                       int from,                 // range, 1 based
 298                       int to,
 299                       RetrievalObj *res
 300                       );
 301
 302 /* fetch a record from the retrieval object. pos is 1 based */
 303 void record_retrieve(RetrievalObj *ro,
 304                      ODR stream,
 305                      RetrievalRecord *res,
 306                      int pos);
 307
 308 /* Delete Result Set(s) (zebraapi.c) */
 309 %name(deleteResultSet)
 310 int zebra_deleleResultSet(ZebraHandle zh, int function,
 311                           int num_setnames, char **setnames,
 312                           int *statuses);
 313
 314
 315 /* == Sort ================================================================= */
 316 int sort (ZebraHandle zh,
 317           ODR stream,
 318           const char *sort_spec,
 319           const char *output_setname,
 320           const char **input_setnames
 321           );
 322
 323 /* == Scan ================================================================= */
 324 %name(scan_PQF)
 325 void zebra_scan_PQF (ZebraHandle zh,
 326                      ScanObj *so,
 327                      ODR stream,
 328                      const char *pqf_query);
 329
 330 scanEntry *getScanEntry(ScanObj *so, int pos);
 331
 332 /* Admin functionality */
 333 /*
 334 %name(admin_start)         void zebra_admin_start (ZebraHandle zh);
 335 %name(admin_shutdown)      void zebra_admin_shutdown (ZebraHandle zh);
 336 */
 337
 338
 339
 340 /* do authentication */
 341 /*
 342 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
 343
 344 */
 345
 346
 347 /*
 348
 349 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
 350 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
 351                           int no, int *count,
 352                           int *type, char *out, size_t *len);
 353 */
 354
 355 /*
 356 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
 357
 358 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
 359
 360 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
 361                                             Z_Segment *segment);
 362
 363 void zebra_admin_shutdown (ZebraHandle zh);
 364 void zebra_admin_start (ZebraHandle zh);
 365 void zebra_admin_import_end (ZebraHandle zh);
 366
 367
 368 */
 369
 370
 371 /* =========================================================================
 372  * NMEM stuff
 373  * =========================================================================
 374 */
 375
 376 NMEM         nmem_create (void);
 377 void         nmem_destroy (NMEM handle);
 378
 379 /* =========================================================================
 380  * Data1 stuff
 381  * =========================================================================
 382 */
 383
 384 typedef enum data1_datatype
 385 {
 386     DATA1K_unknown,
 387     DATA1K_structured,
 388     DATA1K_string,
 389     DATA1K_numeric,
 390     DATA1K_bool,
 391     DATA1K_oid,
 392     DATA1K_generalizedtime,
 393     DATA1K_intunit,
 394     DATA1K_int,
 395     DATA1K_octetstring,
 396     DATA1K_null
 397 } data1_datatype;
 398
 399 #define DATA1T_numeric 1
 400 #define DATA1T_string 2
 401 #define DATA1N_root 1
 402 #define DATA1N_tag  2
 403 #define DATA1N_data 3
 404 #define DATA1N_variant 4
 405 #define DATA1N_comment 5
 406 #define DATA1N_preprocess 6
 407 #define DATA1I_inctxt 1
 408 #define DATA1I_incbin 2
 409 #define DATA1I_text 3
 410 #define DATA1I_num 4
 411 #define DATA1I_oid 5
 412 #define DATA1_LOCALDATA 12
 413 #define DATA1_FLAG_XML  1
 414
 415 data1_handle data1_create (void);
 416 data1_handle data1_createx (int flags);
 417 void data1_destroy(data1_handle dh);
 418
 419 /* Data1 node */
 420 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
 421 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
 422 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
 423 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
 424 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
 425 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
 426
 427 data1_tagset *data1_empty_tagset (data1_handle dh);
 428 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
 429 data1_element *data1_getelementbytagname(data1_handle dh,
 430                                          data1_absyn *abs,
 431                                          data1_element *parent,
 432                                          const char *tagname);
 433
 434 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 435                                 int select, ODR o,
 436                                 int *len);
 437
 438 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
 439                               const char *name);
 440
 441 void data1_free_tree(data1_handle dh, data1_node *t);
 442
 443 char *data1_nodetobuf(data1_handle dh, data1_node *n,
 444                       int select, int *len);
 445
 446 data1_node *data1_mk_tag_data_wd(data1_handle dh,
 447                                  data1_node *at,
 448                                  const char *tagname, NMEM m);
 449 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
 450                               const char *tagname, NMEM m);
 451 data1_datatype data1_maptype(data1_handle dh, char *t);
 452 data1_varset *data1_read_varset(data1_handle dh, const char *file);
 453 data1_vartype *data1_getvartypebyct(data1_handle dh,
 454                                     data1_varset *set,
 455                                     char *zclass, char *type);
 456 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
 457 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
 458
 459 data1_esetname *data1_getesetbyname(data1_handle dh,
 460                                     data1_absyn *a,
 461                                     const char *name);
 462 data1_element *data1_getelementbyname(data1_handle dh,
 463                                                  data1_absyn *absyn,
 464                                                  const char *name);
 465 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
 466                                       int type, data1_node *parent);
 467
 468 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
 469                                      const char *tag, const char **attr,
 470                                      data1_node *at);
 471 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
 472                                        const char *tag, size_t len,
 473                                        const char **attr,
 474                                        data1_node *at);
 475 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
 476                                     data1_node *res, const char **attr);
 477
 478 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
 479                                         const char *buf, size_t len,
 480                                         data1_node *parent);
 481 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
 482                                          const char *buf, size_t len,
 483                                          data1_node *parent);
 484 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
 485                                       const char *buf, data1_node *parent);
 486
 487 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
 488                                            const char *buf, size_t len,
 489                                            data1_node *parent);
 490
 491 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
 492                                          const char *buf, data1_node *parent);
 493
 494 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
 495                                             const char *target,
 496                                             const char **attr,
 497                                             data1_node *at);
 498
 499 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
 500                                       const char *name);
 501 void data1_set_root(data1_handle dh, data1_node *res,
 502                                NMEM nmem, const char *name);
 503
 504 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
 505                                               const char *tag, int num,
 506                                               NMEM nmem);
 507 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
 508                                               const char *tag, Odr_oid *oid,
 509                                               NMEM nmem);
 510 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
 511                                                const char *tag,
 512                                                const char *str,
 513                                                NMEM nmem);
 514 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
 515                                                    data1_node *at,
 516                                                    const char *tag,
 517                                                    const char *str,
 518                                                    NMEM nmem);
 519
 520 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
 521
 522 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
 523                                          const char *tag);
 524 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
 525                                          const char *tag, data1_node *at);
 526 data1_attset *data1_get_attset (data1_handle dh, const char *name);
 527 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
 528 data1_node *data1_map_record(data1_handle dh, data1_node *n,
 529                                         data1_maptab *map, NMEM m);
 530 data1_marctab *data1_read_marctab (data1_handle dh,
 531                                               const char *file);
 532 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
 533                                   data1_node *n, int selected, int *len);
 534 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
 535                                     int select, int *len);
 536 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
 537                                                 data1_node *n, int select,
 538                                                 ODR o);
 539 Z_BriefBib *data1_nodetosummary(data1_handle dh,
 540                                            data1_node *n, int select,
 541                                            ODR o);
 542 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
 543                                   int *len);
 544 WRBUF data1_get_wrbuf (data1_handle dp);
 545 char **data1_get_read_buf (data1_handle dp, int **lenp);
 546 char **data1_get_map_buf (data1_handle dp, int **lenp);
 547 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
 548 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
 549 NMEM data1_nmem_get (data1_handle dh);
 550
 551 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
 552 void data1_print_tree (data1_handle dh, data1_node *n);
 553
 554
 555 char *data1_insert_string (data1_handle dh, data1_node *res,
 556                                       NMEM m, const char *str);
 557 char *data1_insert_string_n (data1_handle dh, data1_node *res,
 558                                         NMEM m, const char *str, size_t len);
 559 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
 560                                         const char *buf);
 561 /*
 562 data1_node *data1_read_xml (data1_handle dh,
 563                                        int (*rf)(void *, char *, size_t),
 564                                        void *fh, NMEM m);
 565 */
 566 void data1_absyn_trav (data1_handle dh, void *handle,
 567                                   void (*fh)(data1_handle dh,
 568                                              void *h, data1_absyn *a));
 569
 570 data1_attset *data1_attset_search_id (data1_handle dh, int id);
 571
 572 char *data1_getNodeValue(data1_node* node, char* pTagPath);
 573 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
 574 int data1_CountOccurences(data1_node* node, char* pTagPath);
 575
 576
 577 FILE *data1_path_fopen (data1_handle dh, const char *file,
 578                                    const char *mode);
 579 void data1_set_tabpath(data1_handle dh, const char *path);
 580 void data1_set_tabroot (data1_handle dp, const char *p);
 581 const char *data1_get_tabpath(data1_handle dh);
 582 const char *data1_get_tabroot(data1_handle dh);
 583
 584
 585
 586 /* =========================================================================
 587  * Filter stuff
 588  * =========================================================================
 589  */
 590 int grs_perl_readf(struct perl_context *context, size_t len);
 591 int grs_perl_readline(struct perl_context *context);
 592 char grs_perl_getc(struct perl_context *context);
 593 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
 594 off_t grs_perl_tellf(struct perl_context *context);
 595 void grs_perl_endf(struct perl_context *context, off_t offset);
 596
 597 data1_handle *grs_perl_get_dh(struct perl_context *context);
 598 NMEM *grs_perl_get_mem(struct perl_context *context);
 599 void grs_perl_set_res(struct perl_context *context, data1_node *n);
 600