ICU term lists are handled for search.
[idzebra-moved-to-github.git] / include / zebramap.h
index e9894c3..db4343c 100644 (file)
-/*
- * Copyright (C) 1994-1998, Index Data I/S 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: zebramap.h,v $
- * Revision 1.5  1998-03-05 08:39:26  adam
- * Minor changes to zebramap data structures. Changed query
- * mapping rules.
- *
- * Revision 1.4  1998/02/10 12:03:05  adam
- * Implemented Sort.
- *
- * Revision 1.3  1997/11/18 10:05:08  adam
- * Changed character map facility so that admin can specify character
- * mapping files for each register type, w, p, etc.
- *
- * Revision 1.2  1997/10/29 12:02:47  adam
- * Added missing prototype.
- *
- * Revision 1.1  1997/10/27 14:33:04  adam
- * Moved towards generic character mapping depending on "structure"
- * field in abstract syntax file. Fixed a few memory leaks. Fixed
- * bug with negative integers when doing searches with relational
- * operators.
- *
- */
+/* $Id: zebramap.h,v 1.28 2007-12-07 14:09:09 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
+
+*/
 
 #ifndef ZEBRAMAP_H
 #define ZEBRAMAP_H
 
-#include <proto.h>
-#include <res.h>
+#include <yaz/proto.h>
+#include <idzebra/res.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+YAZ_BEGIN_CDECL
 
-typedef struct zebra_maps *ZebraMaps;
-ZebraMaps zebra_maps_open (Res res);
+typedef struct zebra_maps_s *zebra_maps_t;
+typedef struct zebra_map *zebra_map_t;
 
-void zebra_maps_close (ZebraMaps zm);
+YAZ_EXPORT
+zebra_maps_t zebra_maps_open(Res res, const char *base_path,
+                          const char *profile_path);
+YAZ_EXPORT
+ZEBRA_RES zebra_maps_read_file(zebra_maps_t zms, const char *fname);
 
-const char **zebra_maps_input (ZebraMaps zms, unsigned reg_id,
-                              const char **from, int len);
-const char *zebra_maps_output(ZebraMaps, unsigned reg_id, const char **from);
+YAZ_EXPORT
+void zebra_maps_close(zebra_maps_t zm);
 
-int zebra_maps_attr (ZebraMaps zms, Z_AttributesPlusTerm *zapt,
-                    unsigned *reg_id, char **search_type, char **rank_type,
-                    int *complete_flag);
+YAZ_EXPORT
+const char **zebra_maps_input(zebra_map_t zm,
+                              const char **from, int len, int first);
 
-int zebra_maps_sort (ZebraMaps zms, Z_SortAttributes *sortAttributes);
+YAZ_EXPORT
+const char **zebra_maps_search(zebra_map_t zm,
+                               const char **from, int len, int *q_map_match);
 
-int zebra_maps_is_complete (ZebraMaps zms, unsigned reg_id);
-int zebra_maps_is_sort (ZebraMaps zms, unsigned reg_id);
-#ifdef __cplusplus
-}
-#endif
+YAZ_EXPORT
+const char *zebra_maps_output(zebra_map_t zm, const char **from);
+
+YAZ_EXPORT
+int zebra_maps_attr(zebra_maps_t zms, Z_AttributesPlusTerm *zapt,
+                    const char **reg_id, char **search_type, char *rank_type,
+                    int *complete_flag, int *sort_flag);
+
+YAZ_EXPORT
+int zebra_maps_sort(zebra_maps_t zms, Z_SortAttributes *sortAttributes,
+                    int *numerical);
+
+YAZ_EXPORT
+int zebra_maps_is_complete(zebra_map_t zm);
+
+YAZ_EXPORT
+int zebra_maps_is_sort(zebra_map_t zm);
+
+YAZ_EXPORT
+int zebra_maps_is_index(zebra_map_t zm);
+
+YAZ_EXPORT
+int zebra_maps_is_staticrank(zebra_map_t zm);
+
+YAZ_EXPORT
+int zebra_maps_is_alwaysmatches(zebra_map_t zm);
+
+YAZ_EXPORT
+int zebra_maps_is_positioned(zebra_map_t zm);
+
+YAZ_EXPORT
+int zebra_maps_is_icu(zebra_map_t zm);
+
+YAZ_EXPORT
+int zebra_maps_is_first_in_field(zebra_map_t zm);
+
+YAZ_EXPORT
+WRBUF zebra_replace(zebra_map_t zm, const char *ex_list,
+                   const char *input_str, int input_len);
+
+YAZ_EXPORT
+zebra_map_t zebra_map_get(zebra_maps_t zms, const char *id);
+
+YAZ_EXPORT
+zebra_map_t zebra_map_get_or_add(zebra_maps_t zms, const char *id);
+
+YAZ_EXPORT
+int zebra_map_tokenize_start(zebra_map_t zm,
+                             const char *buf, size_t len);
+
+YAZ_EXPORT
+int zebra_map_tokenize_next(zebra_map_t zm,
+                            const char **result_buf, size_t *result_len);
+
+YAZ_END_CDECL
 
 #endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+