]>
git.ipfire.org Git - thirdparty/cups.git/blob - cgi-bin/help-index.h
2 * "$Id: help-index.h 7615 2008-05-25 07:17:07Z mike $"
4 * Online help index definitions for the Common UNIX Printing System (CUPS).
6 * Copyright 2007 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
16 #ifndef _CUPS_HELP_INDEX_H_
17 # define _CUPS_HELP_INDEX_H_
20 * Include necessary headers...
23 # include <cups/array.h>
30 typedef struct help_word_s
/**** Help word structure... ****/
32 int count
; /* Number of occurrences */
33 char *text
; /* Word text */
36 typedef struct help_node_s
/**** Help node structure... ****/
38 char *filename
; /* Filename, relative to help dir */
39 char *section
; /* Section name (NULL if none) */
40 char *anchor
; /* Anchor name (NULL if none) */
41 char *text
; /* Text in anchor */
42 cups_array_t
*words
; /* Words after this node */
43 time_t mtime
; /* Last modification time */
44 off_t offset
; /* Offset in file */
45 size_t length
; /* Length in bytes */
46 int score
; /* Search score */
49 typedef struct help_index_s
/**** Help index structure ****/
51 int search
; /* 1 = search index, 0 = normal */
52 cups_array_t
*nodes
; /* Nodes sorted by filename */
53 cups_array_t
*sorted
; /* Nodes sorted by score + text */
61 extern void helpDeleteIndex(help_index_t
*hi
);
62 extern help_node_t
*helpFindNode(help_index_t
*hi
, const char *filename
,
64 extern help_index_t
*helpLoadIndex(const char *hifile
, const char *directory
);
65 extern int helpSaveIndex(help_index_t
*hi
, const char *hifile
);
66 extern help_index_t
*helpSearchIndex(help_index_t
*hi
, const char *query
,
68 const char *filename
);
71 #endif /* !_CUPS_HELP_INDEX_H_ */
74 * End of "$Id: help-index.h 7615 2008-05-25 07:17:07Z mike $".