Happy new year.
[idzebra-moved-to-github.git] / include / idzebra / snippet.h
index 474b9a4..aeb95bd 100644 (file)
@@ -1,8 +1,5 @@
-/* $Id: snippet.h,v 1.9 2007-08-21 11:06:46 adam Exp $
-   Copyright (C) 1995-2007
-   Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+   Copyright (C) 1994-2011 Index Data
 
 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
@@ -28,12 +25,12 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 YAZ_BEGIN_CDECL
 
 struct zebra_snippet_word {
-    zint seqno;
-    int ord;
-    char *term;
-    int match;
-    int mark;
-    int ws;
+    zint seqno;  /**< sequence number */
+    int ord;     /**< ordinal, i.e. database,field,type */
+    char *term;  /**< term itself */
+    int match;   /**< both part and real match */
+    int mark;    /**< part of snippet */
+    int ws;      /**< white space flag (not indexed material) */
     struct zebra_snippet_word *next;
     struct zebra_snippet_word *prev;
 };
@@ -81,12 +78,17 @@ void zebra_snippets_ring(zebra_snippets *doc, const zebra_snippets *hit,
                          int before, int after);
 
 
+YAZ_EXPORT
+const struct zebra_snippet_word *zebra_snippets_lookup(
+    const zebra_snippets *doc, const zebra_snippets *hit);
+
 YAZ_END_CDECL
 
 #endif
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab