First parts of index_rules system (ICU support).

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

diff --git a/include/index_rules.h b/include/index_rules.h
new file mode 100644 (file)
index 0000000..5966842
--- /dev/null
+++ b/include/index_rules.h
@@ -0,0 +1,93 @@
+/* $Id: index_rules.h,v 1.1 2007-10-23 12:26:25 adam Exp $
+   Copyright (C) 1995-2007
+   Index Data ApS
+
+This file is part of the Zebra server.
+
+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
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+*/
+
+/** 
+    \brief Definitions for Zebra's index rules system
+*/
+
+#ifndef ZEBRA_INDEX_RULES_H
+#define ZEBRA_INDEX_RULES_H
+
+#include <yaz/yconfig.h>
+#include <yaz/xmltypes.h>
+
+YAZ_BEGIN_CDECL
+
+typedef struct zebra_index_rules_s *zebra_index_rules_t;
+
+/** \brief creates index rules handler/object from file
+    \param fname filename
+    \returns handle (NULL if unsuccessful)
+
+    Config file format:
+    \verbatim
+    <indexrules>
+      <indexrule id="*:w" position="1" alwaysmatches="1" firstinfield="1"
+        locale="en">
+        <!-- conversion rules for words -->
+      </indexrule>
+      <indexrule id="*:p" position="0" alwaysmatches="0" firstinfield="0"
+        locale="en">
+        <!-- conversion rules for phrase -->
+      </indexrule>
+      <indexrule id="*:s" sort="1" 
+        locale="en">
+        <!-- conversion rules for phrase -->
+      </indexrule>
+    </indexrules>
+   \endverbatim
+ */
+zebra_index_rules_t zebra_index_rules_create(const char *fname);
+
+/** \brief destroys index rules object
+    \param r handle
+ */
+void zebra_index_rules_destroy(zebra_index_rules_t r);
+
+
+/** \brief creates index rules handler/object from xml Doc
+    \param fname filename
+    \returns handle (NULL if unsuccessful)
+
+    Similar to zebra_index_rules_create
+*/
+zebra_index_rules_t zebra_index_rules_create_doc(xmlDocPtr doc);
+
+
+/** \brief lookup of indexrule
+    \param r rules
+    \param id id to search for
+    \returns pattern ID
+*/
+const char *zebra_index_rule_lookup_str(zebra_index_rules_t r, const char *id);
+
+YAZ_END_CDECL
+
+#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+