include/idzebra/snippet.h

   1 /* $Id: snippet.h,v 1.6 2006-08-14 10:40:14 adam Exp $
   2    Copyright (C) 1995-2006
   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 this program; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 */
  22
  23 #ifndef IDZEBRA_SNIPPET_H
  24 #define IDZEBRA_SNIPPET_H
  25
  26 #include <idzebra/util.h>
  27
  28 YAZ_BEGIN_CDECL
  29
  30 struct zebra_snippet_word {
  31     zint seqno;
  32     int ord;
  33     char *term;
  34     int match;
  35     struct zebra_snippet_word *next;
  36 };
  37
  38 typedef struct zebra_snippets zebra_snippets;
  39 typedef struct zebra_snippet_word zebra_snippet_word;
  40
  41 YAZ_EXPORT
  42 zebra_snippets *zebra_snippets_create();
  43
  44 YAZ_EXPORT
  45 void zebra_snippets_destroy(zebra_snippets *l);
  46
  47 YAZ_EXPORT
  48 void zebra_snippets_append(zebra_snippets *l,
  49                            zint seqno, int ord, const char *term);
  50
  51 YAZ_EXPORT
  52 void zebra_snippets_append_match(zebra_snippets *l,
  53                                  zint seqno, int ord, const char *term,
  54                                  int match);
  55
  56 YAZ_EXPORT
  57 zebra_snippet_word *zebra_snippets_list(zebra_snippets *l);
  58
  59 YAZ_EXPORT
  60 void zebra_snippets_log(zebra_snippets *l, int log_level);
  61
  62 YAZ_EXPORT
  63 zebra_snippets *zebra_snippets_window(zebra_snippets *doc, zebra_snippets *hit,
  64                                       int window_size);
  65
  66 YAZ_END_CDECL
  67
  68 #endif
  69 /*
  70  * Local variables:
  71  * c-basic-offset: 4
  72  * indent-tabs-mode: nil
  73  * End:
  74  * vim: shiftwidth=4 tabstop=8 expandtab
  75  */
  76