2 Copyright (C) 1994-2007 Frans Slothouber, Jacco van Weert, Petteri Kettunen,
3 Bernd Koesling, Thomas Aglassinger, Anthon Pang, Stefan Kost, David Druffner,
4 Sasha Vasko, Kai Hofmann, Thierry Pierron, Friedrich Haase, and Gergely Budai.
6 This file is part of ROBODoc
8 ROBODoc is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 /****h* ROBODoc/Globals
26 * A number of global variables.
30 * $Id: globals.c,v 1.22 2007/07/10 19:13:51 gumpu Exp $
43 int number_of_warnings = 0;
45 /* Pointer to the name of the current file that is being analysed,
48 char *current_file = 0;
50 /****v* Globals/document_title
52 * document_title -- title for the documentation.
54 * Used as the title for master index files or for latex documentation.
58 char *document_title = NULL;
63 /****v* Globals/document_header
65 * document_header -- Header for the documentation.
67 * Used as the header of generated files
71 char *document_header = NULL;
76 /****v* Globals/document_footer
78 * document_footer -- Footer for the documentation.
80 * Used as the footer of generated files
84 char *document_footer = NULL;
89 /****v* Globals/output_mode [2.0]
91 * output_mode -- the mode of output
93 * Controls which type of output will be generated.
97 T_RB_DocType output_mode = ASCII;
102 /****v* Globals/course_of_action [2.0]
106 * Global Variable that defines the course of action.
110 actions_t course_of_action;
114 /****v* Globals/debugmode
118 * A bitfield determining the output levels
127 /****v* Globals/line_buffer [2.0]
129 * line_buffer -- global line buffer
131 * Temporary storage area for lines
132 * that are read from an input file.
136 char line_buffer[MAX_LINE_LEN];
140 /****v* Globals/myLine
142 * myLine -- dynamic buffer for current line
144 * Temporary storage area for lines
145 * that are read from an input file.
153 /****v* Globals/readChars
155 * readChars -- number of characters in the currently bufferd line
157 * Temporary storage area for lines
158 * that are read from an input file.
166 /****v* Globals/line_number [2.0]
168 * line_number -- global line counter
170 * Keeps track of the number of lines that are read from the source file.
183 /* TODO Document these. */
185 char *source_file; /* DCD */
186 char *whoami = NULL; /* me,myself&i */
187 int tab_stops[MAX_TABS]; /* Tab stop positions */
189 // Number of header item names before linebreak
190 int header_breaks = DEFAULT_HEADER_BREAKS;
193 // Path and filename to dot tool
194 char *dot_name = DEFAULT_DOT_NAME;
197 /****i* Globals/RB_Close_The_Shop [3.0b]
199 * RB_Close_The_Shop -- free resources.
201 * void RB_Close_The_Shop ()
203 * Frees all resources used by robodoc.
205 * RB_Free_Header(), RB_Free_Link()
209 void RB_Close_The_Shop(
212 /* TODO if (link_index) { free(link_index); } */