Beginnings of zebra_register_check

[idzebra-moved-to-github.git] / include / idzebra / api.h

diff --git a/include/idzebra/api.h b/include/idzebra/api.h
index 76690ae..82bf7ce 100644 (file)
--- a/include/idzebra/api.h
+++ b/include/idzebra/api.h
@@ -1,8 +1,5 @@
-/* $Id: api.h,v 1.48 2007-04-16 08:44:31 adam Exp $
-   Copyright (C) 1995-2007
-   Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+   Copyright (C) 1994-2010 Index Data
 
 Zebra is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -55,7 +52,7 @@ typedef struct {
     int position;        /* position of record in result set (1,2,..) */
     char *buf;           /* record buffer (void pointer really) */
     int len;             /* length */
-    const int *format;   /* record syntax */
+    const Odr_oid *format; /* record syntax */
     char *base; 
     zint sysno;
     int  score;
@@ -65,6 +62,7 @@ typedef struct {
 typedef struct {
     zint occurrences;    /* scan term occurrences */
     char *term;          /* scan term string */
+    char *display_term;  /* display scan term entry */
 } ZebraScanEntry;
 
 /** \var ZebraHandle
@@ -161,6 +159,14 @@ char *zebra_errAdd(ZebraHandle zh);
 YAZ_EXPORT
 void zebra_result(ZebraHandle zh, int *code, char **addinfo);
 
+
+/** \brief Returns character set encoding for session
+    \param zh zebra session handle.
+    \returns encoding name (e.g. "iso-8859-1")
+*/
+YAZ_EXPORT
+const char *zebra_get_encoding(ZebraHandle zh);
+
 /** \brief Set limit before Zebra does approx hit count
     \param zh session handle
     \param approx_limit the limit
@@ -220,7 +226,7 @@ YAZ_EXPORT
 ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
                                 const char *setname,
                                 Z_RecordComposition *comp,
-                                const int *input_format,
+                                const Odr_oid *input_format,
                                 int num_recs,
                                 ZebraRetrievalRecord *recs);
 /** \brief Deletes one or more resultsets 
@@ -287,7 +293,7 @@ ZEBRA_RES zebra_result_set_term_info(ZebraHandle zh, const char *setname,
 */
 YAZ_EXPORT ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream,
                                Z_AttributesPlusTerm *zapt,
-                               const int *attributeset,
+                               const Odr_oid *attributeset,
                                int *position, int *num_entries,
                                ZebraScanEntry **entries,
                                int *is_partial,
@@ -319,14 +325,15 @@ ZEBRA_RES zebra_auth(ZebraHandle zh, const char *user, const char *pass);
 
 /** \brief Normalize zebra term for register (subject to change!)
     \param zh session handle
-    \param reg_id register ID, 'w', 'p',..
+    \param index_type "w", "p",..
     \param input_str input string buffer
     \param input_len input string length
     \param output_str output string buffer
     \param output_len output string length
 */
 YAZ_EXPORT
-int zebra_string_norm(ZebraHandle zh, unsigned reg_id, const char *input_str, 
+int zebra_string_norm(ZebraHandle zh, const char *index_type,
+                      const char *input_str, 
                      int input_len, char *output_str, int output_len);
 
 /** \brief Creates a database
@@ -388,6 +395,10 @@ YAZ_EXPORT
 ZEBRA_RES zebra_compact(ZebraHandle zh);
 
 YAZ_EXPORT 
+ZEBRA_RES zebra_repository_index(ZebraHandle zh, const char *path,
+                                 enum zebra_recctrl_action_t action);
+
+YAZ_EXPORT 
 ZEBRA_RES zebra_repository_update(ZebraHandle zh, const char *path);
 
 YAZ_EXPORT 
@@ -404,7 +415,6 @@ ZEBRA_RES zebra_repository_show(ZebraHandle zh, const char *path);
     This function is a simple wrapper or zebra_update_record with
     action=action_update (insert or replace) .
 */
-YAZ_EXPORT
 YAZ_EXPORT 
 ZEBRA_RES zebra_add_record(ZebraHandle zh, const char *buf, int buf_size);
                               
@@ -500,6 +510,9 @@ ZEBRA_RES zebra_set_break_handler(ZebraHandle zh,
                                   int (*f)(void *client_data),
                                   void *client_data);
 
+YAZ_EXPORT
+ZEBRA_RES zebra_register_check(ZebraHandle zh);
+
 YAZ_END_CDECL                                
 
 /** \mainpage Zebra
@@ -587,6 +600,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab