| fb-doc 0.2 documentation tool for FreeBasic

- Main Page
- Tutorial
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Macros | Typedefs | Functions | Variables
fb-doc_emitters.bi File Reference

Header file for EmitterIF. More...

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

Go to the source code of this file.

## Data Structures

class | EmitterIF
| The emitter interface. More...

## Macros

#define | WITH_NEW_EMITTER(_T_)
| Snippet to create a new EmitterIF (for new customized emitter modules) More...

## Typedefs

typedef Parser | Parser_
| Forward declaration. More...
typedef SUB_CDECL | EmitFunc (BYVAL_AS_Parser__PTR)
| Function to emit a peace of code. More...

## Functions

SUB_CDECL | null_emitter (BYVAL_AS_Parser__PTR P)
| An empty emitter to initialize the interface. More...
EmitterIF_PTR | Emitters (-1 TO-1)
| the array for the emitter interfaces More...

## Variables

const VAR | NL = !"\n"
const VAR | COMM_END = NL & NL & "'/" & NL
| the end of an FB comment block (in templates) More...
const VAR | FIXME = "FIXME"
| the text to initialize entry fields (in templates) More...

## Detailed Description

Header file for EmitterIF.

This file contains the declaration of the emitters interface, a UDT (User Defined Type) that contains function pointers. The Parser calls the matching function in the active emitter after scanning a relevant construct. The emitter function extracts the necessary information from the parser data, formats it as desired and sends it to the output stream.

Definition in file fb-doc_emitters.bi.

## Macro Definition Documentation

#define WITH_NEW_EMITTER | ( |  | _T_) |  |

Value:
/* (multi line FreeBasic #MACRO)
REDIM PRESERVE Emitters(UBOUND(Emitters) + 1)
Emitters(UBOUND(Emitters)) = NEW EmitterIF
WITH *Emitters(UBOUND(Emitters))
.Nam = _T_
#ENDMACRO */

Snippet to create a new EmitterIF (for new customized emitter modules)

Definition at line 115 of file fb-doc_emitters.bi.

## Typedef Documentation

typedef Parser Parser_

Forward declaration.

Definition at line 17 of file fb-doc_emitters.bi.

typedef SUB_CDECL EmitFunc(BYVAL_AS_Parser__PTR)

Function to emit a peace of code.

Parameters

  P | the parser calling this handler

Definition at line 21 of file fb-doc_emitters.bi.

## Function Documentation

SUB_CDECL null_emitter | ( | BYVAL_AS_Parser__PTR | P) |  |

An empty emitter to initialize the interface.

Parameters

  P | the parser calling this handler

Definition at line 25 of file fb-doc_emitters.bi.

EmitterIF_PTR Emitters | ( | -1 TO- | 1) |  |

the array for the emitter interfaces

## Variable Documentation

const VAR NL = !"\n"

Definition at line 14 of file fb-doc_emitters.bi.

const VAR COMM_END = NL & NL & "'/" & NL

the end of an FB comment block (in templates)

Definition at line 110 of file fb-doc_emitters.bi.

const VAR FIXME = "FIXME"

the text to initialize entry fields (in templates)

Definition at line 111 of file fb-doc_emitters.bi.