Move headers zebraapi.h->idzebra/api.h, zebraver.h->idzebra/version.h,
[idzebra-moved-to-github.git] / include / zebramap.h
1 /* $Id: zebramap.h,v 1.16 2004-08-25 09:23:36 adam Exp $
2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
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 ZebraMaps zebra_maps_open (Res res, const char *base);
33
34 void zebra_maps_close (ZebraMaps zm);
35
36 const char **zebra_maps_input (ZebraMaps zms, unsigned reg_id,
37                                const char **from, int len);
38 const char *zebra_maps_output(ZebraMaps, unsigned reg_id, const char **from);
39
40 int zebra_maps_attr (ZebraMaps zms, Z_AttributesPlusTerm *zapt,
41                      unsigned *reg_id, char **search_type, char *rank_type,
42                      int *complete_flag, int *sort_flag);
43
44 int zebra_maps_sort (ZebraMaps zms, Z_SortAttributes *sortAttributes,
45                      int *numerical);
46
47 int zebra_maps_is_complete (ZebraMaps zms, unsigned reg_id);
48 int zebra_maps_is_sort (ZebraMaps zms, unsigned reg_id);
49 int zebra_maps_is_positioned (ZebraMaps zms, unsigned reg_id);
50
51 WRBUF zebra_replace(ZebraMaps zms, unsigned reg_id, const char *ex_list,
52                     const char *input_str, int input_len);
53
54 YAZ_END_CDECL
55
56 #endif