fbdoc_options.bi File Reference

Header file for options. More...

#include "dir.bi"
#include "fbdoc_parser.bi"

Include dependency graph for fbdoc_options.bi:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Options
	Evaluate parameters from command line. More...

Macros
#define	ERROUT(_T_)   /* PRINT #OPT->Efnr, PROJ_NAME & ": " & _T_ */
	Emit an error message to STDERR More...
#define	MSG_LINE(_T_)   /* PRINT #OPT->Efnr, NL; SPC(38 - LEN(_T_)); _T_; " -->"; */
	Emit a message to STDERR More...
#define	MSG_CONT(_T_)   /* PRINT #OPT->Efnr, " " & _T_; */
	Emit a message to STDERR More...
#define	MSG_END(_T_)   /* PRINT #OPT->Efnr, _T_ */
	Emit a message to STDERR More...

Typedefs
typedef Options *	Options_PTR
	Doxygen internal (ignore this). More...

Functions
SUB	init_csource (BYVAL_AS_EmitterIF_PTR)
SUB	init_doxy (BYVAL_AS_EmitterIF_PTR)
	Initialize the DoxygenTemplates EmitterIF. More...
SUB	init_gtk (BYVAL_AS_EmitterIF_PTR)
	Initialize the GtkDocTemplates EmitterIF. More...
SUB	init_lfn (BYVAL_AS_EmitterIF_PTR)
	Initialize the FunctionNames EmitterIF. More...
SUB	init_syntax (BYVAL_AS_EmitterIF_PTR)

Variables
const	LFN_FILE = "fbdoc.lfn"
	File name for list of function names (caller / callees graphs) More...
const	LFN_SEP = !"\n"
	Separator for entries in file fbdoc.lfn (one character!). More...
common Options_PTR	OPT
	The global struct for all parameters read from the command line. More...

Detailed Description

Header file for options.

This file contains the declaration of the Options class. It's used to scan options and parameters in the command line and to control execution.

Definition in file fbdoc_options.bi.

Macro Definition Documentation

ERROUT

#define ERROUT

(

_T_

)

/* PRINT #OPT->Efnr, PROJ_NAME & ": " & _T_ */

Emit an error message to STDERR

Definition at line 19 of file fbdoc_options.bi.

MSG_LINE

#define MSG_LINE

(

_T_

)

/* PRINT #OPT->Efnr, NL; SPC(38 - LEN(_T_)); _T_; " -->"; */

Emit a message to STDERR

Definition at line 22 of file fbdoc_options.bi.

MSG_CONT

#define MSG_CONT

(

_T_

)

/* PRINT #OPT->Efnr, " " & _T_; */

Emit a message to STDERR

Definition at line 25 of file fbdoc_options.bi.

MSG_END

#define MSG_END

(

_T_

)

/* PRINT #OPT->Efnr, _T_ */

Emit a message to STDERR

Definition at line 28 of file fbdoc_options.bi.

Typedef Documentation

Options_PTR

typedef Options* Options_PTR

Doxygen internal (ignore this).

Definition at line 171 of file fbdoc_options.bi.

Function Documentation

init_csource()

SUB init_csource

(

BYVAL_AS_EmitterIF_PTR

)

init_doxy()

SUB init_doxy

(

BYVAL_AS_EmitterIF_PTR

Emi

)

Initialize the DoxygenTemplates EmitterIF.

Parameters

Emi	The EmitterIF to initialize

FIXME

Since

0.4.0

Definition at line 240 of file fbdoc_emit_doxy.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

init_gtk()

SUB init_gtk

(

BYVAL_AS_EmitterIF_PTR

Emi

)

Initialize the GtkDocTemplates EmitterIF.

Parameters

Emi	The EmitterIF to initialize

FIXME

Since

0.4.0

< we use the standard error emitter here

Definition at line 209 of file fbdoc_emit_gtk.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

init_lfn()

SUB init_lfn

(

BYVAL_AS_EmitterIF_PTR

Emi

)

Initialize the FunctionNames EmitterIF.

Parameters

Emi	The EmitterIF to initialize

FIXME

Since

0.4.0

Definition at line 127 of file fbdoc_emit_lfn.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

init_syntax()

SUB init_syntax

(

BYVAL_AS_EmitterIF_PTR

)

Here is the caller graph for this function:

Variable Documentation

LFN_FILE

const LFN_FILE = "fbdoc.lfn"

File name for list of function names (caller / callees graphs)

Definition at line 14 of file fbdoc_options.bi.

LFN_SEP

const LFN_SEP = !"\n"

Separator for entries in file fbdoc.lfn (one character!).

Definition at line 15 of file fbdoc_options.bi.

OPT

common Options_PTR OPT

The global struct for all parameters read from the command line.

Definition at line 173 of file fbdoc_options.bi.