[thirdparty/cups.git] / cgi-bin / help-index.h

/*
 * "$Id: help-index.h 6649 2007-07-11 21:46:42Z mike $"
 *
 *   On-line help index definitions for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 2007 by Apple Inc.
 *   Copyright 1997-2007 by Easy Software Products.
 *
 *   These coded instructions, statements, and computer programs are the
 *   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_
#  define _CUPS_HELP_INDEX_H_

/*
 * Include necessary headers...
 */

#  include <cups/array.h>


/*
 * Data structures...
 */

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_s		/**** Help index structure ****/
{
  int		search;			/* 1 = search index, 0 = normal */
  cups_array_t	*nodes;			/* Nodes sorted by filename */
  cups_array_t	*sorted;		/* Nodes sorted by score + text */
} help_index_t;


/*
 * Functions...
 */

extern void		helpDeleteIndex(help_index_t *hi);
extern help_node_t	*helpFindNode(help_index_t *hi, const char *filename,
			              const char *anchor);
extern help_index_t	*helpLoadIndex(const char *hifile, const char *directory);
extern int		helpSaveIndex(help_index_t *hi, const char *hifile);
extern help_index_t	*helpSearchIndex(help_index_t *hi, const char *query,
			                 const char *section,
					 const char *filename);


#endif /* !_CUPS_HELP_INDEX_H_ */

/*
 * End of "$Id: help-index.h 6649 2007-07-11 21:46:42Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
bc44d920	2	* "$Id: help-index.h 6649 2007-07-11 21:46:42Z mike $"
ef416fc2	3	*
	4	* On-line help index definitions for the Common UNIX Printing System (CUPS).
	5	*
bc44d920	6	* Copyright 2007 by Apple Inc.
f7deaa1a	7	* Copyright 1997-2007 by Easy Software Products.
ef416fc2	8	*
ef416fc2	9	* These coded instructions, statements, and computer programs are the
bc44d920	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/".
ef416fc2	14	*/
	15
	16	#ifndef _CUPS_HELP_INDEX_H_
	17	# define _CUPS_HELP_INDEX_H_
	18
ecdc0628	19	/*
	20	* Include necessary headers...
	21	*/
	22
	23	# include <cups/array.h>
	24
ef416fc2	25
	26	/*
	27	* Data structures...
	28	*/
	29
f7deaa1a	30	typedef struct help_word_s /** Help word structure... **/
	31	{
	32	int count; /* Number of occurrences */
	33	char text; / Word text */
	34	} help_word_t;
	35
	36	typedef struct help_node_s /** Help node structure... **/
ef416fc2	37	{
	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 */
f7deaa1a	42	cups_array_t words; / Words after this node */
ef416fc2	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 */
	47	} help_node_t;
	48
f7deaa1a	49	typedef struct help_index_s /** Help index structure **/
ef416fc2	50	{
ecdc0628	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 */
ef416fc2	54	} help_index_t;
	55
	56
	57	/*
	58	* Functions...
	59	*/
	60
	61	extern void helpDeleteIndex(help_index_t *hi);
ecdc0628	62	extern help_node_t helpFindNode(help_index_t hi, const char *filename,
ecdc0628	63	const char *anchor);
ef416fc2	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,
	67	const char *section,
	68	const char *filename);
	69
	70
	71	#endif /* !_CUPS_HELP_INDEX_H_ */
	72
	73	/*
bc44d920	74	* End of "$Id: help-index.h 6649 2007-07-11 21:46:42Z mike $".
ef416fc2	75	*/