perl/IDZebra.i

   1 %module "IDZebra"
   2
   3 /* Module initialization and cleanup */
   4
   5 %{
   6 #include "zebraapi.h"
   7 #include "rg.h"
   8 #include "data1.h"
   9 #include "yaz/odr.h"
  10 %}
  11
  12 %include "rg.h"
  13
  14 /* ----------------------------------------------------------------------------------- */
  15 %typemap(in) char ** {
  16         AV *tempav;
  17         I32 len;
  18         int i;
  19         SV  **tv;
  20         STRLEN na;
  21         if (!SvROK($input))
  22             croak("Argument $argnum is not a reference.");
  23         if (SvTYPE(SvRV($input)) != SVt_PVAV)
  24             croak("Argument $argnum is not an array.");
  25         tempav = (AV*)SvRV($input);
  26         len = av_len(tempav);
  27         $1 = (char **) malloc((len+2)*sizeof(char *));
  28         for (i = 0; i <= len; i++) {
  29             tv = av_fetch(tempav, i, 0);
  30             $1[i] = (char *) SvPV(*tv,na);
  31         }
  32         $1[i] = NULL;
  33 };
  34
  35 // This cleans up the char ** array after the function call
  36 %typemap(freearg) char ** {
  37         free($1);
  38 }
  39
  40 // Creates a new Perl array and places a NULL-terminated char ** into it
  41 %typemap(out) char ** {
  42         AV *myav;
  43         SV **svs;
  44         int i = 0,len = 0;
  45         /* Figure out how many elements we have */
  46         while ($1[len])
  47            len++;
  48         svs = (SV **) malloc(len*sizeof(SV *));
  49         for (i = 0; i < len ; i++) {
  50             svs[i] = sv_newmortal();
  51             sv_setpv((SV*)svs[i],$1[i]);
  52         };
  53         myav =  av_make(len,svs);
  54         free(svs);
  55         $result = newRV((SV*)myav);
  56         sv_2mortal($result);
  57         argvi++;
  58 }
  59 /* ----------------------------------------------------------------------------------- */
  60
  61 void init (void);
  62 void DESTROY (void);
  63
  64 /* Logging facilities from yaz */
  65 void logLevel (int level);
  66 void logFile (const char *fname);
  67 void logMsg  (int level, const char *message);
  68
  69 #define LOG_FATAL  0x0001
  70 #define LOG_DEBUG  0x0002
  71 #define LOG_WARN   0x0004
  72 #define LOG_LOG    0x0008
  73 #define LOG_ERRNO  0x0010     /* append strerror to message */
  74 #define LOG_FILE   0x0020
  75 #define LOG_APP    0x0040     /* For application level events such as new-connection */
  76 #define LOG_MALLOC 0x0080     /* debugging mallocs */
  77 #define LOG_ALL   0xff7f
  78 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
  79
  80
  81 /* ODR stuff */
  82 #define ODR_DECODE      0
  83 #define ODR_ENCODE      1
  84 #define ODR_PRINT       2
  85 ODR odr_createmem(int direction);
  86 void odr_reset(ODR o);
  87 void odr_destroy(ODR o);
  88 void *odr_malloc(ODR o, int size);
  89
  90 /* Session and service */
  91 %name(start)     ZebraService zebra_start (const char *configName);
  92 %name(open)      ZebraHandle zebra_open (ZebraService zs);
  93 %name(close)     void zebra_close (ZebraHandle zh);
  94 %name(stop)      void zebra_stop (ZebraService zs);
  95
  96
  97 /* Error handling and reporting */
  98 %name(errCode)   int zebra_errCode (ZebraHandle zh); /* last error code */
  99 %name(errString) const char * zebra_errString (ZebraHandle zh); /* string representatio of above */
 100 %name(errAdd)    char *  zebra_errAdd (ZebraHandle zh); /* extra information associated with error */
 101
 102 /* Record groups */
 103 void describe_recordGroup (recordGroup *rg);
 104 void init_recordGroup (recordGroup *rg);
 105 void res_get_recordGroup (ZebraHandle zh, recordGroup *rg, const char *ext);
 106 %name(set_group)           void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
 107 %name(select_databases)    int  zebra_select_databases (ZebraHandle zh, int num_bases, const char **basenames);
 108 %name(select_database)     int  zebra_select_database (ZebraHandle zh, const char *basename);
 109
 110 /* Transaction, shadow register */
 111 %name(begin_trans)         void zebra_begin_trans (ZebraHandle zh);
 112 %name(end_trans)           void zebra_end_trans (ZebraHandle zh);
 113 %name(commit)              int  zebra_commit (ZebraHandle zh);
 114 %name(get_shadow_enable)   int  zebra_get_shadow_enable (ZebraHandle zh);
 115 %name(set_shadow_enable)   void zebra_set_shadow_enable (ZebraHandle zh, int value);
 116
 117 /* Repository actions */
 118 %name(init)                int  zebra_init (ZebraHandle zh);
 119 %name(compact)             int  zebra_compact (ZebraHandle zh);
 120 %name(repository_update)   void zebra_repository_update (ZebraHandle zh);
 121 %name(repository_delete)   void zebra_repository_delete (ZebraHandle zh);
 122 %name(repository_show)     void zebra_repository_show (ZebraHandle zh);
 123 %name(update_record)       int zebra_update_record (ZebraHandle zh,
 124                                                     recordGroup *rGroup,
 125                                                     int sysno, const char *match, const char *fname,
 126                                                     const char *buf, int buf_size);
 127 %name(delete_record)       int zebra_delete_record (ZebraHandle zh,
 128                                                     recordGroup *rGroup,
 129                                                     int sysno, const char *match, const char *fname,
 130                                                     const char *buf, int buf_size);
 131
 132 /* Search and retrieval */
 133 %name(begin_read)          int zebra_begin_read (ZebraHandle zh);
 134 %name(end_read)            void zebra_end_read (ZebraHandle zh);
 135 %name(search_PQF)          int zebra_search_PQF (ZebraHandle zh,
 136                                                  ODR odr_input, ODR odr_output,
 137                                                  const char *pqf_query,
 138                                                  const char *setname);
 139
 140 /* Admin functionality */
 141 %name(admin_start)         void zebra_admin_start (ZebraHandle zh);
 142 %name(admin_shutdown)      void zebra_admin_shutdown (ZebraHandle zh);
 143
 144
 145 /* Search using RPN-Query
 146 YAZ_EXPORT void zebra_search_rpn (ZebraHandle zh, ODR input, ODR output,
 147                                   Z_RPNQuery *query,
 148                                   const char *setname, int *hits);
 149 */
 150
 151 /* Retrieve record(s)
 152 void zebra_records_retrieve (ZebraHandle zh, ODR stream,
 153                        const char *setname, Z_RecordComposition *comp,
 154                        oid_value input_format,
 155                        int num_recs, ZebraRetrievalRecord *recs);
 156 */
 157
 158 /* Browse
 159 void zebra_scan (ZebraHandle zh, ODR stream,
 160                  Z_AttributesPlusTerm *zapt,
 161                  oid_value attributeset,
 162                  int *position, int *num_entries,
 163                  ZebraScanEntry **list,
 164                  int *is_partial);
 165 */
 166
 167 /* Delete Result Set(s) */
 168 /*
 169 int zebra_deleleResultSet(ZebraHandle zh, int function,
 170                           int num_setnames, char **setnames,
 171                           int *statuses);
 172 */
 173
 174 /* do authentication */
 175 /*
 176 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
 177
 178 */
 179
 180
 181 /*
 182
 183 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
 184 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
 185                           int no, int *count,
 186                           int *type, char *out, size_t *len);
 187 */
 188 /*
 189 void zebra_sort (ZebraHandle zh, ODR stream,
 190                  int num_input_setnames,
 191                  const char **input_setnames,
 192                  const char *output_setname,
 193                  Z_SortKeySpecList *sort_sequence,
 194                  int *sort_status);
 195 */
 196
 197 /*
 198 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
 199
 200 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
 201
 202 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
 203                                             Z_Segment *segment);
 204
 205 void zebra_admin_shutdown (ZebraHandle zh);
 206 void zebra_admin_start (ZebraHandle zh);
 207 void zebra_admin_import_end (ZebraHandle zh);
 208
 209
 210 */
 211
 212
 213 /* =========================================================================
 214  * NMEM stuff
 215  * =========================================================================
 216 */
 217
 218 NMEM         nmem_create (void);
 219 void         nmem_destroy (NMEM handle);
 220
 221 /* =========================================================================
 222  * Data1 stuff
 223  * =========================================================================
 224 */
 225
 226 typedef enum data1_datatype
 227 {
 228     DATA1K_unknown,
 229     DATA1K_structured,
 230     DATA1K_string,
 231     DATA1K_numeric,
 232     DATA1K_bool,
 233     DATA1K_oid,
 234     DATA1K_generalizedtime,
 235     DATA1K_intunit,
 236     DATA1K_int,
 237     DATA1K_octetstring,
 238     DATA1K_null
 239 } data1_datatype;
 240
 241 #define DATA1T_numeric 1
 242 #define DATA1T_string 2
 243 #define DATA1N_root 1
 244 #define DATA1N_tag  2
 245 #define DATA1N_data 3
 246 #define DATA1N_variant 4
 247 #define DATA1N_comment 5
 248 #define DATA1N_preprocess 6
 249 #define DATA1I_inctxt 1
 250 #define DATA1I_incbin 2
 251 #define DATA1I_text 3
 252 #define DATA1I_num 4
 253 #define DATA1I_oid 5
 254 #define DATA1_LOCALDATA 12
 255 #define DATA1_FLAG_XML  1
 256
 257 data1_handle data1_create (void);
 258 data1_handle data1_createx (int flags);
 259 void data1_destroy(data1_handle dh);
 260
 261 // Data1 node
 262 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
 263 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
 264 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
 265 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
 266 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
 267 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
 268
 269 data1_tagset *data1_empty_tagset (data1_handle dh);
 270 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
 271 data1_element *data1_getelementbytagname(data1_handle dh,
 272                                          data1_absyn *abs,
 273                                          data1_element *parent,
 274                                          const char *tagname);
 275
 276 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 277                                 int select, ODR o,
 278                                 int *len);
 279
 280 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
 281                               const char *name);
 282
 283 void data1_free_tree(data1_handle dh, data1_node *t);
 284
 285 char *data1_nodetobuf(data1_handle dh, data1_node *n,
 286                       int select, int *len);
 287
 288 data1_node *data1_mk_tag_data_wd(data1_handle dh,
 289                                  data1_node *at,
 290                                  const char *tagname, NMEM m);
 291 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
 292                               const char *tagname, NMEM m);
 293 data1_datatype data1_maptype(data1_handle dh, char *t);
 294 data1_varset *data1_read_varset(data1_handle dh, const char *file);
 295 data1_vartype *data1_getvartypebyct(data1_handle dh,
 296                                     data1_varset *set,
 297                                     char *zclass, char *type);
 298 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
 299 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
 300
 301 data1_esetname *data1_getesetbyname(data1_handle dh,
 302                                     data1_absyn *a,
 303                                     const char *name);
 304 data1_element *data1_getelementbyname(data1_handle dh,
 305                                                  data1_absyn *absyn,
 306                                                  const char *name);
 307 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
 308                                       int type, data1_node *parent);
 309
 310 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
 311                                      const char *tag, const char **attr,
 312                                      data1_node *at);
 313 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
 314                                        const char *tag, size_t len,
 315                                        const char **attr,
 316                                        data1_node *at);
 317 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
 318                                     data1_node *res, const char **attr);
 319
 320 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
 321                                         const char *buf, size_t len,
 322                                         data1_node *parent);
 323 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
 324                                          const char *buf, size_t len,
 325                                          data1_node *parent);
 326 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
 327                                       const char *buf, data1_node *parent);
 328
 329 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
 330                                            const char *buf, size_t len,
 331                                            data1_node *parent);
 332
 333 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
 334                                          const char *buf, data1_node *parent);
 335
 336 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
 337                                             const char *target,
 338                                             const char **attr,
 339                                             data1_node *at);
 340
 341 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
 342                                       const char *name);
 343 void data1_set_root(data1_handle dh, data1_node *res,
 344                                NMEM nmem, const char *name);
 345
 346 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
 347                                               const char *tag, int num,
 348                                               NMEM nmem);
 349 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
 350                                               const char *tag, Odr_oid *oid,
 351                                               NMEM nmem);
 352 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
 353                                                const char *tag,
 354                                                const char *str,
 355                                                NMEM nmem);
 356 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
 357                                                    data1_node *at,
 358                                                    const char *tag,
 359                                                    const char *str,
 360                                                    NMEM nmem);
 361
 362 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
 363
 364 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
 365                                          const char *tag);
 366 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
 367                                          const char *tag, data1_node *at);
 368 data1_attset *data1_get_attset (data1_handle dh, const char *name);
 369 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
 370 data1_node *data1_map_record(data1_handle dh, data1_node *n,
 371                                         data1_maptab *map, NMEM m);
 372 data1_marctab *data1_read_marctab (data1_handle dh,
 373                                               const char *file);
 374 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
 375                                   data1_node *n, int selected, int *len);
 376 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
 377                                     int select, int *len);
 378 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
 379                                                 data1_node *n, int select,
 380                                                 ODR o);
 381 Z_BriefBib *data1_nodetosummary(data1_handle dh,
 382                                            data1_node *n, int select,
 383                                            ODR o);
 384 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
 385                                   int *len);
 386 WRBUF data1_get_wrbuf (data1_handle dp);
 387 char **data1_get_read_buf (data1_handle dp, int **lenp);
 388 char **data1_get_map_buf (data1_handle dp, int **lenp);
 389 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
 390 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
 391 NMEM data1_nmem_get (data1_handle dh);
 392
 393 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
 394 void data1_print_tree (data1_handle dh, data1_node *n);
 395
 396
 397 char *data1_insert_string (data1_handle dh, data1_node *res,
 398                                       NMEM m, const char *str);
 399 char *data1_insert_string_n (data1_handle dh, data1_node *res,
 400                                         NMEM m, const char *str, size_t len);
 401 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
 402                                         const char *buf);
 403 /*
 404 data1_node *data1_read_xml (data1_handle dh,
 405                                        int (*rf)(void *, char *, size_t),
 406                                        void *fh, NMEM m);
 407 */
 408 void data1_absyn_trav (data1_handle dh, void *handle,
 409                                   void (*fh)(data1_handle dh,
 410                                              void *h, data1_absyn *a));
 411
 412 data1_attset *data1_attset_search_id (data1_handle dh, int id);
 413
 414 char *data1_getNodeValue(data1_node* node, char* pTagPath);
 415 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
 416 int data1_CountOccurences(data1_node* node, char* pTagPath);
 417
 418
 419 FILE *data1_path_fopen (data1_handle dh, const char *file,
 420                                    const char *mode);
 421 void data1_set_tabpath(data1_handle dh, const char *path);
 422 void data1_set_tabroot (data1_handle dp, const char *p);
 423 const char *data1_get_tabpath(data1_handle dh);
 424 const char *data1_get_tabroot(data1_handle dh);
 425
 426
 427
 428 /* =========================================================================
 429  * Filter stuff
 430  * =========================================================================
 431  */
 432 int grs_perl_readf(struct perl_context *context, size_t len);
 433 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
 434 off_t grs_perl_tellf(struct perl_context *context);
 435 void grs_perl_endf(struct perl_context *context, off_t offset);
 436
 437 data1_handle grs_perl_get_dh(struct perl_context *context);
 438 NMEM grs_perl_get_mem(struct perl_context *context);
 439 void grs_perl_set_res(struct perl_context *context, data1_node *n);
 440