File rtf.c

RCS Header: /home/amb/CVS/cxref/src/rtf.c,v 1.11 2004-06-26 18:50:36 amb Exp

C Cross Referencing & Documentation tool. Version 1.6.
Writes the RTF 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 rtf file.

#define RTF_FILE ".rtf"

#define RTF_FILE_BACKUP ".rtf~"

The name of the output rtf file that contains the appendix.

#define RTF_APDX ".apdx"

#define STYLE_NORM "\\s0\\f0\\fs24"

#define STYLE_H1 "\\s1\\f0\\fs40\\b\\sb400\\sa200\\keepn\\keep"

#define STYLE_H2 "\\s2\\f0\\fs32\\b\\sb200\\sa100\\keepn\\keep"

#define STYLE_H3 "\\s3\\f0\\fs28\\b\\sb100\\sa100\\keepn\\keep"

#define STYLE_H4 "\\s4\\f0\\fs24\\b\\sb100\\sa50\\keepn\\keep"

#define STYLE_TT "\\s5\\f1\\fs20\\ql\\sb50\\sa50"

#define STYLE_IND "\\s6\\f0\\fs24\\ql\\li720"

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

of

The output file for the RTF.

static FILE* of

filename

The name of the file.

static char* filename

Global Function WriteRTFAppendix()

Write out the appendix information.

void WriteRTFAppendix ( 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 WriteRTFFile()

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

void WriteRTFFile ( 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 WriteRTFFileDelete()

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

void WriteRTFFileDelete ( char* name )

char* name

The name of the file to delete.

Local Function WriteRTFDefine()

Write a Define structure out.

static void WriteRTFDefine ( Define def )

Define def

The Define structure to output.

Local Function WriteRTFFilePart()

Write a File structure out.

static void WriteRTFFilePart ( File file )

File file

The File to output.

Local Function WriteRTFFunction()

Write a Function structure out.

static void WriteRTFFunction ( Function func )

Function func

The Function structure to output.

Local Function WriteRTFInclude()

Write an Include structure out.

static void WriteRTFInclude ( Include inc )

Include inc

The Include structure to output.

Local Function WriteRTFPostamble()

Write out the tail of an RTF file.

static void WriteRTFPostamble ( FILE* f )

FILE* f

The file to write to.

Local Function WriteRTFPreamble()

Write out the head of an RTF file.

static void WriteRTFPreamble ( FILE* f )

FILE* f

The file to write to.

Local Function WriteRTFStructUnion()

Write a structure / union structure out.

static void WriteRTFStructUnion ( StructUnion su, int depth )

StructUnion su

The structure / union to write.

int depth

The current depth within the structure.

Local Function WriteRTFSubInclude()

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

static void WriteRTFSubInclude ( Include inc, int depth )

Include inc

The Include structure to output.

int depth

The depth of the include hierarchy.

Local Function WriteRTFTypedef()

Write a Typedef structure out.

static void WriteRTFTypedef ( Typedef type )

Typedef type

The Typedef structure to output.

Local Function WriteRTFVariable()

Write a Variable structure out.

static void WriteRTFVariable ( Variable var )

Variable var

The Variable structure to output.

Local Function rtf()

Make the input string safe to output as RTF ( not \, { or } ).

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

char* rtf

Returns a safe RTF string.

char* c

A non-safe RTF 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.