]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cgi-bin/help-index.h
Update svn:keyword properties.
[thirdparty/cups.git] / cgi-bin / help-index.h
index fd587b0e4c0a1248972e14c1a180c274265f6b1b..41d8d93db515f2727f4e62535c7208f4b140bc4c 100644 (file)
@@ -1,25 +1,16 @@
 /*
  * "$Id$"
  *
- *   On-line help index definitions for the Common UNIX Printing System (CUPS).
+ *   Online help index definitions for CUPS.
  *
- *   Copyright 1997-2006 by Easy Software Products.
+ *   Copyright 2007-2011 by Apple Inc.
+ *   Copyright 1997-2007 by Easy Software Products.
  *
  *   These coded instructions, statements, and computer programs are the
- *   property of Easy Software Products and are protected by Federal
- *   copyright law.  Distribution and use rights are outlined in the file
- *   "LICENSE.txt" which should have been included with this file.  If this
- *   file is missing or damaged please contact Easy Software Products
- *   at:
- *
- *       Attn: CUPS Licensing Information
- *       Easy Software Products
- *       44141 Airport View Drive, Suite 204
- *       Hollywood, Maryland 20636 USA
- *
- *       Voice: (301) 373-9600
- *       EMail: cups-info@cups.org
- *         WWW: http://www.cups.org
+ *   property of Apple Inc. and are protected by Federal copyright
+ *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
+ *   which should have been included with this file.  If this file is
+ *   file is missing or damaged, see the license at "http://www.cups.org/".
  */
 
 #ifndef _CUPS_HELP_INDEX_H_
 #  include <cups/array.h>
 
 
+/*
+ * C++ magic...
+ */
+
+#  ifdef __cplusplus
+extern "C" {
+#  endif /* __cplusplus */
+
 /*
  * Data structures...
  */
 
-typedef struct                         /**** Help node structure... ****/
+typedef struct help_word_s             /**** Help word structure... ****/
+{
+  int          count;                  /* Number of occurrences */
+  char         *text;                  /* Word text */
+} help_word_t;
+
+typedef struct help_node_s             /**** Help node structure... ****/
 {
   char         *filename;              /* Filename, relative to help dir */
   char         *section;               /* Section name (NULL if none) */
   char         *anchor;                /* Anchor name (NULL if none) */
   char         *text;                  /* Text in anchor */
+  cups_array_t *words;                 /* Words after this node */
   time_t       mtime;                  /* Last modification time */
   off_t                offset;                 /* Offset in file */
   size_t       length;                 /* Length in bytes */
   int          score;                  /* Search score */
 } help_node_t;
 
-typedef struct                         /**** Help index structure ****/
+typedef struct help_index_s            /**** Help index structure ****/
 {
   int          search;                 /* 1 = search index, 0 = normal */
   cups_array_t *nodes;                 /* Nodes sorted by filename */
@@ -70,6 +76,10 @@ extern help_index_t  *helpSearchIndex(help_index_t *hi, const char *query,
                                         const char *filename);
 
 
+#  ifdef __cplusplus
+}
+#  endif /* __cplusplus */
+
 #endif /* !_CUPS_HELP_INDEX_H_ */
 
 /*