/vp_plugins/sptsd/cups/help-index.h

http://cupsfilter.googlecode.com/ · C Header · 75 lines · 35 code · 14 blank · 26 comment · 0 complexity · 6ff40a527456c68685ed96752a0c065c MD5 · raw file 

    

  1. /*
    2. 

  2.  * "$Id: help-index.h 7615 2008-05-25 07:17:07Z mike $"
    3. 

  3.  *
    4. 

  4.  *   Online help index definitions for the Common UNIX Printing System (CUPS).
    5. 

  5.  *
    6. 

  6.  *   Copyright 2007 by Apple Inc.
    7. 

  7.  *   Copyright 1997-2007 by Easy Software Products.
    8. 

  8.  *
    9. 

  9.  *   These coded instructions, statements, and computer programs are the
    10. 

  10.  *   property of Apple Inc. and are protected by Federal copyright
    11. 

  11.  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
    12. 

  12.  *   which should have been included with this file.  If this file is
    13. 

  13.  *   file is missing or damaged, see the license at "http://www.cups.org/".
    14. 

  14.  */
    15. 

  15. 

  16. #ifndef _CUPS_HELP_INDEX_H_
    17. 

  17. #  define _CUPS_HELP_INDEX_H_
    18. 

  18. 

  19. /*
    20. 

  20.  * Include necessary headers...
    21. 

  21.  */
    22. 

  22. 

  23. #  include <cups/array.h>
    24. 

  24. 

  25. 

  26. /*
    27. 

  27.  * Data structures...
    28. 

  28.  */
    29. 

  29. 

  30. typedef struct help_word_s		/**** Help word structure... ****/
    31. 

  31. {
    32. 

  32.   int		count;			/* Number of occurrences */
    33. 

  33.   char		*text;			/* Word text */
    34. 

  34. } help_word_t;
    35. 

  35. 

  36. typedef struct help_node_s		/**** Help node structure... ****/
    37. 

  37. {
    38. 

  38.   char		*filename;		/* Filename, relative to help dir */
    39. 

  39.   char		*section;		/* Section name (NULL if none) */
    40. 

  40.   char		*anchor;		/* Anchor name (NULL if none) */
    41. 

  41.   char		*text;			/* Text in anchor */
    42. 

  42.   cups_array_t	*words;			/* Words after this node */
    43. 

  43.   time_t	mtime;			/* Last modification time */
    44. 

  44.   off_t		offset;			/* Offset in file */
    45. 

  45.   size_t	length;			/* Length in bytes */
    46. 

  46.   int		score;			/* Search score */
    47. 

  47. } help_node_t;
    48. 

  48. 

  49. typedef struct help_index_s		/**** Help index structure ****/
    50. 

  50. {
    51. 

  51.   int		search;			/* 1 = search index, 0 = normal */
    52. 

  52.   cups_array_t	*nodes;			/* Nodes sorted by filename */
    53. 

  53.   cups_array_t	*sorted;		/* Nodes sorted by score + text */
    54. 

  54. } help_index_t;
    55. 

  55. 

  56. 

  57. /*
    58. 

  58.  * Functions...
    59. 

  59.  */
    60. 

  60. 

  61. extern void		helpDeleteIndex(help_index_t *hi);
    62. 

  62. extern help_node_t	*helpFindNode(help_index_t *hi, const char *filename,
    63. 

  63. 			              const char *anchor);
    64. 

  64. extern help_index_t	*helpLoadIndex(const char *hifile, const char *directory);
    65. 

  65. extern int		helpSaveIndex(help_index_t *hi, const char *hifile);
    66. 

  66. extern help_index_t	*helpSearchIndex(help_index_t *hi, const char *query,
    67. 

  67. 			                 const char *section,
    68. 

  68. 					 const char *filename);
    69. 

  69. 

  70. 

  71. #endif /* !_CUPS_HELP_INDEX_H_ */
    72. 

  72. 

  73. /*
    74. 

  74.  * End of "$Id: help-index.h 7615 2008-05-25 07:17:07Z mike $".
    75. 

  75.  */
    76.