include/idzebra/snippet.h

   1 /* $Id: snippet.h,v 1.3 2005-08-18 19:20:37 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 SNIPPET_H
  24 #define SNIPPET_H
  25
  26 #include <idzebra/util.h>
  27
  28 YAZ_BEGIN_CDECL
  29
  30 struct zebra_snippet_word {
  31     zint seqno;
  32     int reg_type;
  33     int ord;
  34     char *term;
  35     int match;
  36     struct zebra_snippet_word *next;
  37 };
  38
  39 typedef struct zebra_snippets zebra_snippets;
  40 typedef struct zebra_snippet_word zebra_snippet_word;
  41
  42 YAZ_EXPORT
  43 zebra_snippets *zebra_snippets_create();
  44
  45 YAZ_EXPORT
  46 void zebra_snippets_destroy(zebra_snippets *l);
  47
  48 YAZ_EXPORT
  49 void zebra_snippets_append(zebra_snippets *l,
  50                            zint seqno, int reg_type,
  51                            int ord, const char *term);
  52
  53 YAZ_EXPORT
  54 void zebra_snippets_append_match(zebra_snippets *l,
  55                                  zint seqno, int reg_type,
  56                                  int ord, const char *term,
  57                                  int match);
  58
  59 YAZ_EXPORT
  60 zebra_snippet_word *zebra_snippets_list(zebra_snippets *l);
  61
  62 YAZ_EXPORT
  63 void zebra_snippets_log(zebra_snippets *l, int log_level);
  64
  65 YAZ_EXPORT
  66 zebra_snippets *zebra_snippets_window(zebra_snippets *doc, zebra_snippets *hit,
  67                                       int window_size);
  68
  69 YAZ_END_CDECL
  70
  71 #endif