contrib/texinfo/makeinfo/toc.h

   1 /* toc.h -- table of contents handling.
   2    $Id: toc.h,v 1.5 2002/02/09 00:54:51 karl Exp $
   3
   4    Copyright (C) 1999 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 2, or (at your option)
   9    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, write to the Free Software
  18    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20    Written by Karl Heinz Marbaise <kama@hippo.fido.de>.  */
  21
  22 #ifndef TOC_H
  23 #define TOC_H
  24
  25 /* the file where we found the @contents directive */
  26 extern char *contents_filename;
  27
  28 /* the file where we found the @shortcontents directive */
  29 extern char *shortcontents_filename;
  30
  31 /* Structure to hold one entry for the toc. */
  32 typedef struct toc_entry_elt {
  33   char *name;
  34   char *containing_node; /* Name of node containing this section.  */
  35   char *html_file;       /* Name of HTML node-file in split-HTML mode */
  36   int number;            /* counting number from 0...n independent from
  37                             chapter/section can be used for anchors or
  38                             references to it.  */
  39   int level;             /* level: chapter, section, subsection... */
  40 } TOC_ENTRY_ELT;
  41
  42 /* all routines which have relationship with TOC should start with
  43    toc_ (this is a kind of name-space) */
  44 extern int toc_add_entry (); /* return the number for the toc-entry */
  45 extern void toc_free ();
  46 extern char *toc_find_section_of_node ();
  47
  48 extern void cm_contents (), cm_shortcontents ();
  49
  50 #endif /* not TOC_H */