C Cross Referencing & Documentation tool. Version 1.6e.
Writes the HTML output.
The file extension to use for the output files.
#define HTML_FILE ".html"
#define HTML_FILE_BACKUP ".html~"
The file extension to use for the output source files.
#define HTML_SRC_FILE ".src.html"
The name of the output tex file that contains the appendix.
#define HTML_APDX ".apdx"
The comments are to be inserted verbatim.
extern int option_verbatim_comments
Defined in: | cxref.c |
The type of HTML output to produce.
extern int option_html
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 built-in style sheet.
extern char* html_cxref_style
Defined in: | html-style.c |
The directories to go back to get to the base output directory.
The output file for the HTML.
The name of the file.
Used in: | WriteHTMLAppendix() | |
WriteHTMLDefine() | ||
WriteHTMLFile() | ||
WriteHTMLFunction() | ||
WriteHTMLPreamble() | ||
WriteHTMLTypedef() | ||
WriteHTMLVariable() |
Write out the appendix information.
void WriteHTMLAppendix ( StringList files, StringList2 funcs, StringList2 vars, StringList2 types )
Prototyped in: | cxref.h | |
Calls: | ConcatStrings() | memory.c |
WriteHTMLDocument() | html.c | |
WriteHTMLPostamble() | html.c | |
WriteHTMLPreamble() | html.c | |
html() | html.c | |
exit(), fclose(), fopen(), fprintf(), strncmp() | ||
Called by: | main() | cxref.c |
References Variables: | filename | html.c |
goback | html.c | |
of | html.c | |
option_name | cxref.c | |
option_odir | cxref.c |
Write an html file for a complete File structure and all components.
void WriteHTMLFile ( File file )
The file structure is broken into its components and they are each written out.
Prototyped in: | cxref.h | |
Calls: | ConcatStrings() | memory.c |
WriteHTMLDefine() | html.c | |
WriteHTMLDocument() | html.c | |
WriteHTMLFilePart() | html.c | |
WriteHTMLFunction() | html.c | |
WriteHTMLInclude() | html.c | |
WriteHTMLPostamble() | html.c | |
WriteHTMLPreamble() | html.c | |
WriteHTMLSource() | html.c | |
WriteHTMLTypedef() | html.c | |
WriteHTMLVariable() | html.c | |
html() | html.c | |
exit(), fclose(), fopen(), fprintf(), mkdir(), stat(), strlen() | ||
Called by: | main() | cxref.c |
References Variables: | filename | html.c |
goback | html.c | |
of | html.c | |
option_html | cxref.c | |
option_name | cxref.c | |
option_odir | cxref.c |
Delete the HTML file and main file reference that belong to the named file.
void WriteHTMLFileDelete ( char* name )
Prototyped in: | cxref.h | |
Calls: | ConcatStrings() | memory.c |
fclose(), fgets(), fopen(), fprintf(), fputs(), rename(), strcmp(), strlen(), strncmp(), unlink() | ||
Called by: | main() | cxref.c |
References Variables: | option_name | cxref.c |
option_odir | cxref.c |
Write out the source file.
void WriteHTMLSource ( char* name )
Prototyped in: | html.c | |
Calls: | ConcatStrings() | memory.c |
WriteHTMLPostamble() | html.c | |
WriteHTMLPreamble() | html.c | |
html() | html.c | |
exit(), fclose(), fgets(), fopen(), fprintf(), fputs(), strcpy() | ||
Called by: | WriteHTMLFile() | html.c |
References Variables: | option_odir | cxref.c |
Write a Define structure out.
static void WriteHTMLDefine ( Define def )
Prototyped in: | html.c | |
Calls: | html() | html.c |
fprintf() | ||
Called by: | WriteHTMLFile() | html.c |
References Variables: | filename | html.c |
goback | html.c | |
of | html.c | |
option_html | cxref.c |
Write out a file that will include the current information.
static void WriteHTMLDocument ( char* name, int appendix )
Prototyped in: | html.c | |
Calls: | ConcatStrings() | memory.c |
WriteHTMLPostamble() | html.c | |
WriteHTMLPreamble() | html.c | |
exit(), fclose(), fgets(), fopen(), fprintf(), fputs(), rename(), stat(), strcmp(), strlen(), strncmp(), unlink() | ||
Called by: | WriteHTMLAppendix() | html.c |
WriteHTMLFile() | html.c | |
References Variables: | html_cxref_style | html-style.c |
option_name | cxref.c | |
option_odir | cxref.c |
Write a File structure out.
static void WriteHTMLFilePart ( File file )
Prototyped in: | html.c | |
Calls: | html() | html.c |
fprintf(), strstr() | ||
Called by: | WriteHTMLFile() | html.c |
References Variables: | goback | html.c |
of | html.c | |
option_html | cxref.c | |
option_verbatim_comments | cxref.c |
Write a Function structure out.
static void WriteHTMLFunction ( Function func )
Prototyped in: | html.c | |
Calls: | html() | html.c |
fprintf(), strcmp(), strncmp(), strstr() | ||
Called by: | WriteHTMLFile() | html.c |
References Variables: | filename | html.c |
goback | html.c | |
of | html.c | |
option_html | cxref.c | |
option_verbatim_comments | cxref.c |
Write an Include structure out.
static void WriteHTMLInclude ( Include inc )
Prototyped in: | html.c | |
Calls: | WriteHTMLSubInclude() | html.c |
html() | html.c | |
fprintf() | ||
Called by: | WriteHTMLFile() | html.c |
References Variables: | goback | html.c |
of | html.c |
Write out a standard post-amble. This includes the end of document marker.
static void WriteHTMLPostamble ( FILE* f, int sourcefile )
Prototyped in: | html.c | |
Calls: | fputs() | |
Called by: | WriteHTMLAppendix() | html.c |
WriteHTMLDocument() | html.c | |
WriteHTMLFile() | html.c | |
WriteHTMLSource() | html.c |
Write out a standard pre-amble.
static void WriteHTMLPreamble ( FILE* f, char* title, int sourcefile )
Prototyped in: | html.c | |
Calls: | fprintf(), fputs() | |
Called by: | WriteHTMLAppendix() | html.c |
WriteHTMLDocument() | html.c | |
WriteHTMLFile() | html.c | |
WriteHTMLSource() | html.c | |
References Variables: | filename | html.c |
goback | html.c | |
run_command | cxref.c | |
run_cpp_command | cxref.c |
Write a structure / union structure out.
static void WriteHTMLStructUnion ( StructUnion su, int depth )
Prototyped in: | html.c | |
Calls: | WriteHTMLStructUnion() | html.c |
html() | html.c | |
fprintf(), strstr() | ||
Called by: | WriteHTMLStructUnion() | html.c |
WriteHTMLTypedef() | html.c | |
References Variables: | of | html.c |
Write an Sub Include structure out. (An include structure that is included from another file.)
static void WriteHTMLSubInclude ( Include inc, int depth )
Prototyped in: | html.c | |
Calls: | WriteHTMLSubInclude() | html.c |
html() | html.c | |
fprintf() | ||
Called by: | WriteHTMLInclude() | html.c |
WriteHTMLSubInclude() | html.c | |
References Variables: | goback | html.c |
of | html.c |
Write a Typedef structure out.
static void WriteHTMLTypedef ( Typedef type )
Prototyped in: | html.c | |
Calls: | WriteHTMLStructUnion() | html.c |
html() | html.c | |
fprintf(), strncmp() | ||
Called by: | WriteHTMLFile() | html.c |
References Variables: | filename | html.c |
goback | html.c | |
of | html.c | |
option_html | cxref.c |
Write a Variable structure out.
static void WriteHTMLVariable ( Variable var )
Prototyped in: | html.c | |
Calls: | html() | html.c |
fprintf() | ||
Called by: | WriteHTMLFile() | html.c |
References Variables: | filename | html.c |
goback | html.c | |
of | html.c | |
option_html | cxref.c |
Make the input string safe to output as HTML ( not <, >, & or " ).
static char* html ( char* c, int verbatim )
The function can only be called four times in each fprintf() since it returns one of only four static strings.