RCS Header: /home/amb/CVS/cxref/src/sgml.c,v 1.10 2004-06-26 18:50:36 amb Exp
C Cross Referencing & Documentation tool. Version 1.6.
Writes the SGML output.
The name of the output tex file that includes each of the others.
#define SGML_FILE ".sgml"
#define SGML_FILE_BACKUP ".sgml~"
The name of the output tex file that contains the appendix.
#define SGML_APDX ".apdx"
The comments are to be inserted verbatim.
extern int option_verbatim_comments
Defined in: | cxref.c |
The name of the directory for the output.
extern char* option_odir
Defined in: | cxref.c |
The base name of the file for the output.
extern char* option_name
Defined in: | cxref.c |
The information about the cxref run, the command line options.
extern char* run_command
Defined in: | cxref.c |
The information about the cxref run, the cpp command and options.
extern char* run_cpp_command
Defined in: | cxref.c |
The directories to go back to get to the base output directory.
Used in: | WriteSGMLFile() |
The output file for the SGML.
The name of the file.
Used in: | WriteSGMLAppendix() | |
WriteSGMLFile() | ||
WriteSGMLPreamble() |
Write out the appendix information.
void WriteSGMLAppendix ( StringList files, StringList2 funcs, StringList2 vars, StringList2 types )
Prototyped in: | cxref.h | |
Calls: | ConcatStrings() | memory.c |
WriteSGMLPostamble() | sgml.c | |
WriteSGMLPreamble() | sgml.c | |
sgml() | sgml.c | |
exit(), fclose(), fopen(), fprintf(), strncmp() | ||
Called by: | main() | cxref.c |
References Variables: | filename | sgml.c |
of | sgml.c | |
option_name | cxref.c | |
option_odir | cxref.c |
Write an sgml file for a complete File structure and all components.
void WriteSGMLFile ( File file )
The file structure is broken into its components and they are each written out.
Prototyped in: | cxref.h | |
Calls: | ConcatStrings() | memory.c |
WriteSGMLDefine() | sgml.c | |
WriteSGMLFilePart() | sgml.c | |
WriteSGMLFunction() | sgml.c | |
WriteSGMLInclude() | sgml.c | |
WriteSGMLPostamble() | sgml.c | |
WriteSGMLPreamble() | sgml.c | |
WriteSGMLTypedef() | sgml.c | |
WriteSGMLVariable() | sgml.c | |
sgml() | sgml.c | |
exit(), fclose(), fopen(), fprintf(), mkdir(), stat(), strlen() | ||
Called by: | main() | cxref.c |
References Variables: | filename | sgml.c |
goback | sgml.c | |
of | sgml.c | |
option_name | cxref.c | |
option_odir | cxref.c |
Delete the SGML file and main file reference that belong to the named file.
void WriteSGMLFileDelete ( char* name )
Prototyped in: | cxref.h | |
Calls: | ConcatStrings() | memory.c |
unlink() | ||
Called by: | main() | cxref.c |
References Variables: | option_odir | cxref.c |
Write a Define structure out.
static void WriteSGMLDefine ( Define def )
Prototyped in: | sgml.c | |
Calls: | sgml() | sgml.c |
fprintf() | ||
Called by: | WriteSGMLFile() | sgml.c |
References Variables: | of | sgml.c |
Write a File structure out.
static void WriteSGMLFilePart ( File file )
Prototyped in: | sgml.c | |
Calls: | sgml() | sgml.c |
fprintf(), strstr() | ||
Called by: | WriteSGMLFile() | sgml.c |
References Variables: | of | sgml.c |
option_verbatim_comments | cxref.c |
Write a Function structure out.
static void WriteSGMLFunction ( Function func )
Prototyped in: | sgml.c | |
Calls: | sgml() | sgml.c |
fprintf(), strcmp(), strncmp(), strstr() | ||
Called by: | WriteSGMLFile() | sgml.c |
References Variables: | of | sgml.c |
option_verbatim_comments | cxref.c |
Write an Include structure out.
static void WriteSGMLInclude ( Include inc )
Prototyped in: | sgml.c | |
Calls: | WriteSGMLSubInclude() | sgml.c |
sgml() | sgml.c | |
fprintf() | ||
Called by: | WriteSGMLFile() | sgml.c |
References Variables: | of | sgml.c |
Write out a standard post-amble. This includes the end of document marker.
static void WriteSGMLPostamble ( FILE* f )
Prototyped in: | sgml.c | |
Calls: | fputs() | |
Called by: | WriteSGMLAppendix() | sgml.c |
WriteSGMLFile() | sgml.c |
Write out a standard pre-amble.
static void WriteSGMLPreamble ( FILE* f, char* title )
Prototyped in: | sgml.c | |
Calls: | fprintf(), fputs() | |
Called by: | WriteSGMLAppendix() | sgml.c |
WriteSGMLFile() | sgml.c | |
References Variables: | filename | sgml.c |
run_command | cxref.c | |
run_cpp_command | cxref.c |
Write a structure / union structure out.
static void WriteSGMLStructUnion ( StructUnion su, int depth )
Prototyped in: | sgml.c | |
Calls: | WriteSGMLStructUnion() | sgml.c |
sgml() | sgml.c | |
fprintf(), strstr() | ||
Called by: | WriteSGMLStructUnion() | sgml.c |
WriteSGMLTypedef() | sgml.c | |
References Variables: | of | sgml.c |
Write an Sub Include structure out. (An include structure that is included from another file.)
static void WriteSGMLSubInclude ( Include inc, int depth )
Prototyped in: | sgml.c | |
Calls: | WriteSGMLSubInclude() | sgml.c |
sgml() | sgml.c | |
fprintf() | ||
Called by: | WriteSGMLInclude() | sgml.c |
WriteSGMLSubInclude() | sgml.c | |
References Variables: | of | sgml.c |
Write a Typedef structure out.
static void WriteSGMLTypedef ( Typedef type )
Prototyped in: | sgml.c | |
Calls: | WriteSGMLStructUnion() | sgml.c |
sgml() | sgml.c | |
fprintf(), strncmp() | ||
Called by: | WriteSGMLFile() | sgml.c |
References Variables: | of | sgml.c |
Write a Variable structure out.
static void WriteSGMLVariable ( Variable var )
Prototyped in: | sgml.c | |
Calls: | sgml() | sgml.c |
fprintf() | ||
Called by: | WriteSGMLFile() | sgml.c |
References Variables: | of | sgml.c |
Make the input string safe to output as SGML ( not <, >, &, ", $, #, % or ~ ).
static char* sgml ( char* c, int verbatim )
The function can only be called four times in each fprintf() since it returns one of only four static strings.