contrib/texinfo/makeinfo/toc.h

   1 /* toc.h -- table of contents handling.
   2    $Id: toc.h,v 1.5 2007/07/01 21:20:33 karl Exp $
   3
   4    Copyright (C) 1999, 2007 Free Software Foundation, Inc.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19    Written by Karl Heinz Marbaise <kama@hippo.fido.de>.  */
  20
  21 #ifndef TOC_H
  22 #define TOC_H
  23
  24 /* Structure to hold one entry for the toc. */
  25 typedef struct toc_entry_elt {
  26   char *name;
  27   char *containing_node; /* Name of node containing this section.  */
  28   char *html_file;       /* Name of HTML node-file in split-HTML mode */
  29   int number;            /* counting number from 0...n independent from
  30                             chapter/section can be used for anchors or
  31                             references to it.  */
  32   int level;             /* level: chapter, section, subsection... */
  33 } TOC_ENTRY_ELT;
  34
  35 /* all routines which have relationship with TOC should start with
  36    toc_ (this is a kind of name-space) */
  37 extern int toc_add_entry (char *tocname, int level,
  38     char *node_name, char *anchor); /* return the number for the toc-entry */
  39 extern void toc_free (void);
  40 extern char *toc_find_section_of_node (char *node);
  41
  42 extern void cm_contents (int arg);
  43
  44 #endif /* not TOC_H */