xref: /openbsd-src/gnu/usr.bin/texinfo/makeinfo/toc.h (revision a1acfa9b69ad64eb720639240c8438f11107dc85)
11cc83814Sespie /* toc.h -- table of contents handling.
2*a1acfa9bSespie    $Id: toc.h,v 1.1.1.3 2006/07/17 16:03:48 espie Exp $
31cc83814Sespie 
41cc83814Sespie    Copyright (C) 1999 Free Software Foundation, Inc.
51cc83814Sespie 
61cc83814Sespie    This program is free software; you can redistribute it and/or modify
71cc83814Sespie    it under the terms of the GNU General Public License as published by
81cc83814Sespie    the Free Software Foundation; either version 2, or (at your option)
91cc83814Sespie    any later version.
101cc83814Sespie 
111cc83814Sespie    This program is distributed in the hope that it will be useful,
121cc83814Sespie    but WITHOUT ANY WARRANTY; without even the implied warranty of
131cc83814Sespie    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
141cc83814Sespie    GNU General Public License for more details.
151cc83814Sespie 
161cc83814Sespie    You should have received a copy of the GNU General Public License
171cc83814Sespie    along with this program; if not, write to the Free Software
181cc83814Sespie    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
191cc83814Sespie 
201cc83814Sespie    Written by Karl Heinz Marbaise <kama@hippo.fido.de>.  */
211cc83814Sespie 
221cc83814Sespie #ifndef TOC_H
231cc83814Sespie #define TOC_H
241cc83814Sespie 
251cc83814Sespie /* Structure to hold one entry for the toc. */
261cc83814Sespie typedef struct toc_entry_elt {
271cc83814Sespie   char *name;
281cc83814Sespie   char *containing_node; /* Name of node containing this section.  */
293fb98d4aSespie   char *html_file;       /* Name of HTML node-file in split-HTML mode */
301cc83814Sespie   int number;            /* counting number from 0...n independent from
311cc83814Sespie                             chapter/section can be used for anchors or
321cc83814Sespie                             references to it.  */
331cc83814Sespie   int level;             /* level: chapter, section, subsection... */
341cc83814Sespie } TOC_ENTRY_ELT;
351cc83814Sespie 
361cc83814Sespie /* all routines which have relationship with TOC should start with
371cc83814Sespie    toc_ (this is a kind of name-space) */
38*a1acfa9bSespie extern int toc_add_entry (char *tocname, int level,
39*a1acfa9bSespie     char *node_name, char *anchor); /* return the number for the toc-entry */
40*a1acfa9bSespie extern void toc_free (void);
41*a1acfa9bSespie extern char *toc_find_section_of_node (char *node);
421cc83814Sespie 
43*a1acfa9bSespie extern void cm_contents (int arg);
441cc83814Sespie 
451cc83814Sespie #endif /* not TOC_H */
46