034931605e71ca1e65f7ce5690fa9c6a6e9d8dae
[idzebra-moved-to-github.git] / include / idzebra / zebramap.h
1 /* $Id: zebramap.h,v 1.5 2006-03-28 12:39:07 adam Exp $
2    Copyright (C) 1995-2005
3    Index Data ApS
4
5 This file is part of the Zebra server.
6
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.
21 */
22
23 #ifndef ZEBRAMAP_H
24 #define ZEBRAMAP_H
25
26 #include <yaz/proto.h>
27 #include <idzebra/res.h>
28
29 YAZ_BEGIN_CDECL
30
31 typedef struct zebra_maps *ZebraMaps;
32
33 YAZ_EXPORT
34 ZebraMaps zebra_maps_open (Res res, const char *base_path,
35                            const char *profile_path);
36 YAZ_EXPORT
37 ZEBRA_RES zebra_maps_read_file(ZebraMaps zms, const char *fname);
38
39 YAZ_EXPORT
40 void zebra_maps_close (ZebraMaps zm);
41
42 YAZ_EXPORT
43 const char **zebra_maps_input (ZebraMaps zms, unsigned reg_id,
44                                const char **from, int len, int first);
45
46 YAZ_EXPORT
47 const char **zebra_maps_search (ZebraMaps zms, unsigned reg_id,
48                                 const char **from, int len, int *q_map_match);
49
50 YAZ_EXPORT
51 const char *zebra_maps_output(ZebraMaps, unsigned reg_id, const char **from);
52
53 YAZ_EXPORT
54 int zebra_maps_attr (ZebraMaps zms, Z_AttributesPlusTerm *zapt,
55                      unsigned *reg_id, char **search_type, char *rank_type,
56                      int *complete_flag, int *sort_flag);
57
58 YAZ_EXPORT
59 int zebra_maps_sort (ZebraMaps zms, Z_SortAttributes *sortAttributes,
60                      int *numerical);
61
62 YAZ_EXPORT
63 int zebra_maps_is_complete (ZebraMaps zms, unsigned reg_id);
64
65 YAZ_EXPORT
66 int zebra_maps_is_sort (ZebraMaps zms, unsigned reg_id);
67
68 YAZ_EXPORT
69 int zebra_maps_is_positioned (ZebraMaps zms, unsigned reg_id);
70
71 YAZ_EXPORT
72 WRBUF zebra_replace(ZebraMaps zms, unsigned reg_id, const char *ex_list,
73                     const char *input_str, int input_len);
74
75 YAZ_END_CDECL
76
77 #endif