File sgml.c

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.

Included Files

• #include <stdlib.h>

• #include <stdio.h>

• #include <string.h>

• #include <sys/types.h>

• #include <sys/stat.h>

• #include <unistd.h>

• #include "version.h"

• #include "memory.h"

• #include "datatype.h"

• #include "cxref.h"
  • #include "datatype.h"

Preprocessor definitions

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"

External Variables

option_verbatim_comments

The comments are to be inserted verbatim.

extern int option_verbatim_comments

option_odir

The name of the directory for the output.

extern char* option_odir

option_name

The base name of the file for the output.

extern char* option_name

run_command

The information about the cxref run, the command line options.

extern char* run_command

run_cpp_command

The information about the cxref run, the cpp command and options.

extern char* run_cpp_command

Local Variables

goback

The directories to go back to get to the base output directory.

static char* goback

of

The output file for the SGML.

static FILE* of

filename

The name of the file.

static char* filename

Global Function WriteSGMLAppendix()

Write out the appendix information.

void WriteSGMLAppendix ( StringList files, StringList2 funcs, StringList2 vars, StringList2 types )

StringList files

The list of files to write.

StringList2 funcs

The list of functions to write.

StringList2 vars

The list of variables to write.

StringList2 types

The list of types to write.

Global Function WriteSGMLFile()

Write an sgml file for a complete File structure and all components.

void WriteSGMLFile ( File file )

File file

The File structure to output.

The file structure is broken into its components and they are each written out.

Global Function WriteSGMLFileDelete()

Delete the SGML file and main file reference that belong to the named file.

void WriteSGMLFileDelete ( char* name )

char* name

The name of the file to delete.

Local Function WriteSGMLDefine()

Write a Define structure out.

static void WriteSGMLDefine ( Define def )

Define def

The Define structure to output.

Local Function WriteSGMLFilePart()

Write a File structure out.

static void WriteSGMLFilePart ( File file )

File file

The File to output.

Local Function WriteSGMLFunction()

Write a Function structure out.

static void WriteSGMLFunction ( Function func )

Function func

The Function structure to output.

Local Function WriteSGMLInclude()

Write an Include structure out.

static void WriteSGMLInclude ( Include inc )

Include inc

The Include structure to output.

Local Function WriteSGMLPostamble()

Write out a standard post-amble. This includes the end of document marker.

static void WriteSGMLPostamble ( FILE* f )

FILE* f

The file to write the post amble to.

Local Function WriteSGMLPreamble()

Write out a standard pre-amble.

static void WriteSGMLPreamble ( FILE* f, char* title )

FILE* f

The file to write the pre amble to.

char* title

The title of the file.

Local Function WriteSGMLStructUnion()

Write a structure / union structure out.

static void WriteSGMLStructUnion ( StructUnion su, int depth )

StructUnion su

The structure / union to write.

int depth

The current depth within the structure.

Local Function WriteSGMLSubInclude()

Write an Sub Include structure out. (An include structure that is included from another file.)

static void WriteSGMLSubInclude ( Include inc, int depth )

Include inc

The Include structure to output.

int depth

The depth of the include hierarchy.

Local Function WriteSGMLTypedef()

Write a Typedef structure out.

static void WriteSGMLTypedef ( Typedef type )

Typedef type

The Typedef structure to output.

Local Function WriteSGMLVariable()

Write a Variable structure out.

static void WriteSGMLVariable ( Variable var )

Variable var

The Variable structure to output.

Local Function sgml()

Make the input string safe to output as SGML ( not <, >, &, ", $, #, % or ~ ).

static char* sgml ( char* c, int verbatim )

char* sgml

Returns a safe SGML string.

char* c

A non-safe SGML string.

int verbatim

Set to true inside a verbatim environment.

The function can only be called four times in each fprintf() since it returns one of only four static strings.