| 1 | /* xml.h -- xml output declarations.
|
|---|
| 2 | $Id: xml.h,v 1.24 2004/11/26 00:48:35 karl Exp $
|
|---|
| 3 |
|
|---|
| 4 | Copyright (C) 2001, 2002, 2003, 2004 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 | Originally written by Philippe Martin <feloy@free.fr>. */
|
|---|
| 21 |
|
|---|
| 22 | #ifndef XML_H
|
|---|
| 23 | #define XML_H
|
|---|
| 24 |
|
|---|
| 25 | /* Options. */
|
|---|
| 26 |
|
|---|
| 27 | /* Separate index entries into divisions for each letters. */
|
|---|
| 28 | extern int xml_index_divisions;
|
|---|
| 29 | extern int xml_sort_index;
|
|---|
| 30 |
|
|---|
| 31 | extern int xml_no_indent;
|
|---|
| 32 |
|
|---|
| 33 | extern int xml_node_open;
|
|---|
| 34 | extern int xml_no_para;
|
|---|
| 35 | extern char *xml_node_id;
|
|---|
| 36 | extern int xml_last_section_output_position;
|
|---|
| 37 |
|
|---|
| 38 | extern int xml_in_xref_token;
|
|---|
| 39 | extern int xml_in_bookinfo;
|
|---|
| 40 | extern int xml_in_book_title;
|
|---|
| 41 | extern int xml_in_abstract;
|
|---|
| 42 |
|
|---|
| 43 | /* Non-zero if we are handling an element that can appear between
|
|---|
| 44 | @item and @itemx, @deffn and @deffnx. */
|
|---|
| 45 | extern int xml_dont_touch_items_defs;
|
|---|
| 46 |
|
|---|
| 47 | /* Non-zero if whitespace in the source document should be kept as-is. */
|
|---|
| 48 | extern int xml_keep_space;
|
|---|
| 49 |
|
|---|
| 50 | enum xml_element
|
|---|
| 51 | {
|
|---|
| 52 | TEXINFO=0, SETFILENAME, TITLEFONT, SETTITLE, DOCUMENTDESCRIPTION,
|
|---|
| 53 | /* Node */
|
|---|
| 54 | NODE, NODENEXT, NODEPREV, NODEUP,
|
|---|
| 55 | /* Structuring */
|
|---|
| 56 | CHAPTER, SECTION, SUBSECTION, SUBSUBSECTION,
|
|---|
| 57 | TOP, UNNUMBERED, UNNUMBEREDSEC, UNNUMBEREDSUBSEC,
|
|---|
| 58 | UNNUMBEREDSUBSUBSEC,
|
|---|
| 59 | APPENDIX, APPENDIXSEC, APPENDIXSUBSEC, APPENDIXSUBSUBSEC,
|
|---|
| 60 | MAJORHEADING, CHAPHEADING, HEADING, SUBHEADING, SUBSUBHEADING,
|
|---|
| 61 | /* Titlepage */
|
|---|
| 62 | TITLEPAGE, AUTHOR, BOOKTITLE, BOOKSUBTITLE,
|
|---|
| 63 | /* Menu */
|
|---|
| 64 | MENU, DETAILMENU, MENUENTRY, MENUTITLE, MENUCOMMENT, MENUNODE,
|
|---|
| 65 | NODENAME,
|
|---|
| 66 | /* -- */
|
|---|
| 67 | ACRONYM, ACRONYMWORD, ACRONYMDESC,
|
|---|
| 68 | ABBREV, ABBREVWORD, ABBREVDESC,
|
|---|
| 69 | TT, CODE, COMMAND_TAG, ENV, FILE_TAG, OPTION, SAMP, KBD, URL, KEY,
|
|---|
| 70 | VAR, SC, DFN, EMPH, STRONG, CITE, NOTFIXEDWIDTH, I, B, R, SLANTED, SANSSERIF,
|
|---|
| 71 | EXDENT,
|
|---|
| 72 | TITLE,
|
|---|
| 73 | IFINFO,
|
|---|
| 74 | SP, CENTER,
|
|---|
| 75 | DIRCATEGORY,
|
|---|
| 76 | QUOTATION, EXAMPLE, SMALLEXAMPLE, LISP, SMALLLISP, CARTOUCHE,
|
|---|
| 77 | COPYING, FORMAT, SMALLFORMAT, DISPLAY, SMALLDISPLAY, VERBATIM,
|
|---|
| 78 | FOOTNOTE, LINEANNOTATION,
|
|---|
| 79 | TIP, NOTE, IMPORTANT, WARNING, CAUTION,
|
|---|
| 80 | ITEMIZE, ITEMFUNCTION, ITEM, ENUMERATE, TABLE, TABLEITEM, TABLETERM,
|
|---|
| 81 | INDEXTERM,
|
|---|
| 82 | MATH, DIMENSION,
|
|---|
| 83 | XREF, XREFNODENAME, XREFINFONAME, XREFPRINTEDDESC, XREFINFOFILE,
|
|---|
| 84 | XREFPRINTEDNAME,
|
|---|
| 85 | INFOREF, INFOREFNODENAME, INFOREFREFNAME, INFOREFINFONAME,
|
|---|
| 86 | UREF, UREFURL, UREFDESC, UREFREPLACEMENT,
|
|---|
| 87 | EMAIL, EMAILADDRESS, EMAILNAME,
|
|---|
| 88 | GROUP, FLOAT, FLOATTYPE, FLOATPOS, CAPTION, SHORTCAPTION,
|
|---|
| 89 | FLOATTABLE, FLOATFIGURE, FLOATEXAMPLE, FLOATCARTOUCHE,
|
|---|
| 90 | PRINTINDEX, LISTOFFLOATS,
|
|---|
| 91 | ANCHOR,
|
|---|
| 92 | IMAGE, INLINEIMAGE, IMAGEALTTEXT,
|
|---|
| 93 | PRIMARY, SECONDARY, INFORMALFIGURE, MEDIAOBJECT, IMAGEOBJECT,
|
|---|
| 94 | IMAGEDATA, TEXTOBJECT,
|
|---|
| 95 | INDEXENTRY, PRIMARYIE, SECONDARYIE, INDEXDIV,
|
|---|
| 96 | MULTITABLE, TGROUP, COLSPEC, THEAD, TBODY, ENTRY, ROW,
|
|---|
| 97 | BOOKINFO, ABSTRACT, REPLACEABLE, ENVAR, COMMENT, FUNCTION, LEGALNOTICE,
|
|---|
| 98 | CONTENTS, SHORTCONTENTS, DOCUMENTLANGUAGE,
|
|---|
| 99 | SETVALUE, CLEARVALUE,
|
|---|
| 100 | DEFINITION, DEFINITIONTERM, DEFINITIONITEM,
|
|---|
| 101 | DEFCATEGORY, DEFFUNCTION, DEFVARIABLE, DEFPARAM, DEFDELIMITER, DEFTYPE,
|
|---|
| 102 | DEFPARAMTYPE, DEFDATATYPE, DEFCLASS, DEFCLASSVAR, DEFOPERATION,
|
|---|
| 103 | PARA
|
|---|
| 104 | };
|
|---|
| 105 |
|
|---|
| 106 | extern void xml_add_char (int character),
|
|---|
| 107 | xml_asterisk (void),
|
|---|
| 108 | xml_insert_element (int elt, int arg),
|
|---|
| 109 | xml_insert_entity (char *entity_name),
|
|---|
| 110 | xml_insert_footnote (char *note),
|
|---|
| 111 | xml_insert_quotation (char *type, int arg),
|
|---|
| 112 | xml_insert_indexentry (char *entry, char *node),
|
|---|
| 113 | xml_insert_indexterm (char *indexterm, char *index),
|
|---|
| 114 | xml_insert_docbook_image (char *name_arg),
|
|---|
| 115 | xml_synindex (char *from, char *to),
|
|---|
| 116 | xml_start_para (void),
|
|---|
| 117 | xml_end_para (void),
|
|---|
| 118 | xml_begin_document (char *output_filename),
|
|---|
| 119 | xml_end_document (void),
|
|---|
| 120 | xml_start_menu_entry (char *tem),
|
|---|
| 121 | xml_end_menu (void),
|
|---|
| 122 | xml_end_current_element (void),
|
|---|
| 123 | xml_open_section (int level, char *name),
|
|---|
| 124 | xml_close_sections (int level),
|
|---|
| 125 | xml_begin_node (void),
|
|---|
| 126 | xml_begin_index (void),
|
|---|
| 127 | xml_end_index (void),
|
|---|
| 128 | xml_begin_multitable (int ncolumns, int *column_widths),
|
|---|
| 129 | xml_end_multitable (void),
|
|---|
| 130 | xml_end_multitable_row (int first_row),
|
|---|
| 131 | xml_end_multitable_column (void),
|
|---|
| 132 | xml_begin_table (int type, char *item_function),
|
|---|
| 133 | xml_end_table (int type),
|
|---|
| 134 | xml_begin_item (void),
|
|---|
| 135 | xml_begin_table_item (void),
|
|---|
| 136 | xml_continue_table_item (void),
|
|---|
| 137 | xml_begin_enumerate (char *enum_arg),
|
|---|
| 138 | xml_end_enumerate (void),
|
|---|
| 139 | xml_begin_docbook_float (int elt);
|
|---|
| 140 |
|
|---|
| 141 | extern char *xml_id (char *id);
|
|---|
| 142 |
|
|---|
| 143 | extern void xml_begin_definition (void),
|
|---|
| 144 | xml_end_definition (void),
|
|---|
| 145 | xml_process_defun_args (char **defun_args, int auto_var_p),
|
|---|
| 146 | xml_begin_def_term (int base_type, const char *category,
|
|---|
| 147 | char *defined_name, char *type_name, char *type_name2),
|
|---|
| 148 | xml_end_def_term (void);
|
|---|
| 149 |
|
|---|
| 150 | extern int xml_current_stack_index (void),
|
|---|
| 151 | xml_element (char *name);
|
|---|
| 152 |
|
|---|
| 153 | #if defined (VA_FPRINTF) && __STDC__
|
|---|
| 154 | void xml_insert_element_with_attribute (int elt, int arg, char *format, ...);
|
|---|
| 155 | #else
|
|---|
| 156 | void xml_insert_element_with_attribute ();
|
|---|
| 157 | #endif
|
|---|
| 158 |
|
|---|
| 159 | #endif /* XML_H */
|
|---|