Fix for libidzebra-2.0-dev

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

diff --git a/include/sortidx.h b/include/sortidx.h
index cf3ae64..d660d19 100644 (file)
--- a/include/sortidx.h
+++ b/include/sortidx.h
@@ -1,8 +1,5 @@
-/* $Id: sortidx.h,v 1.12 2006-12-18 23:40:06 adam Exp $
-   Copyright (C) 1995-2006
-   Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+   Copyright (C) 1994-2011 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
@@ -26,23 +23,71 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/yconfig.h>
 #include <idzebra/version.h>
 #include <idzebra/bfile.h>
+#include <yaz/wrbuf.h>
 
 YAZ_BEGIN_CDECL
 
 #define SORT_IDX_ENTRYSIZE 64
 
+/** \var zebra_sort_index_t
+    \brief sort index handle
+*/
 typedef struct zebra_sort_index *zebra_sort_index_t;
 
 #define ZEBRA_SORT_TYPE_FLAT 1
 #define ZEBRA_SORT_TYPE_ISAMB 2
+#define ZEBRA_SORT_TYPE_MULTI 3
 
+/** \brief creates sort handle
+    \param bfs block files handle
+    \param write_flag (0=read-only, 1=write and read)
+    \param sort_type one of ZEBRA_SORT_TYPE_..
+    \return sort index handle
+*/
 zebra_sort_index_t zebra_sort_open(BFiles bfs, int write_flag, int sort_type);
+
+/** \brief frees sort handle
+*/
 void zebra_sort_close(zebra_sort_index_t si);
+
+/** \brief sets type for sort usage
+    \param si sort index handle
+    \param type opaque type .. A sort file for each type is created
+*/
 int zebra_sort_type(zebra_sort_index_t si, int type);
+
+/** \brief sets sort system number for read / add / delete
+    \param si sort index handle
+    \param sysno system number
+*/
 void zebra_sort_sysno(zebra_sort_index_t si, zint sysno);
-void zebra_sort_add(zebra_sort_index_t si, const char *buf, int len);
-void zebra_sort_delete(zebra_sort_index_t si);
-void zebra_sort_read(zebra_sort_index_t si, char *buf);
+
+/** \brief adds multi-map content to sort file
+    \param si sort index handle
+    \param section_id section of key
+    \param w one or more 0-terminted strings (thus an array)
+
+    zebra_sort_type and zebra_sort_sysno must be called prior to this
+*/
+void zebra_sort_add(zebra_sort_index_t si, zint section_id, WRBUF w);
+
+
+/** \brief delete sort entry
+    \param si sort index handle
+    \param section_id section of sort key to be deleted
+
+    zebra_sort_type and zebra_sort_sysno must be called prior to this
+*/
+void zebra_sort_delete(zebra_sort_index_t si, zint section_id);
+
+/** \brief reads sort entry
+    \param si sort index handle
+    \param section_id output section ID (may be NULL and it will not be set)
+    \param w resulting buffer
+    \retval 0 could not be read
+    \retval 1 could be read (found)
+*/
+int zebra_sort_read(zebra_sort_index_t si, zint *section_id, WRBUF w);
 
 YAZ_END_CDECL
 
@@ -50,6 +95,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