Version 7.0
Copyright © 2021 Lowell D. Thomas
APG
… an ABNF Parser Generator
Data Fields
fmt_tag Struct Reference

The context for the format object. More...

Collaboration diagram for fmt_tag:
Collaboration graph
[legend]

Data Fields

const void * vpValidate
 A "magic number" used to validate the context. More...
 
exceptionspException
 Pointer to an exception structure to report fatal errors back to the application's catch block. More...
 
void * vpMem
 Pointer to a memory object for allocating all memory associated with this object. More...
 
FILE * spFile
 Pointer to an open file, if the data is from a file byte stream. Otherwise NULL. More...
 
uint8_t * ucpBuf8
 Pointer to a byte buffer for formatting the next byte-stream line. More...
 
uint32_t * uipBuf32
 Pointer to a 32-bit buffer for formatting the next Unicode line. More...
 
char * cpFmtBuf
 Pointer to a temporary, working buffer for formatting the data in the data buffers. More...
 
const uint8_t * ucpChars8
 Pointer to the array of 8-bit bytes to be formatted, if any. Otherwise, NULL. More...
 
const uint32_t * uipChars32
 Pointer to the 32-bit Unicode code points to be formatted, if any. Otherwise, NULL. More...
 
int iStyle
 The display style identifier. One of these.. More...
 
int iIndent
 The number of spaces to indent before displaying data. More...
 
uint64_t(* pfnFill )(struct fmt_tag *)
 Function pointer for filling the temp byte or code point buffer. More...
 
void(* pfnFmt )(struct fmt_tag *, uint64_t)
 Function pointer for. More...
 
uint64_t uiFillLineLen
 formatting the data in the byte or code point buffer. More...
 
uint64_t uiDisplayOffset
 The offset to the first byte or code point to display. More...
 
uint64_t uiLastOffset
 Keeps the offset to the previous line displayed. More...
 
uint64_t uiNextOffset
 Keeps the offset to the next byte or code point to display next. More...
 
uint64_t uiDisplayEnd
 The last byte or code point to display. More...
 
abool bDone
 True if there are no more lines to display. False otherwise. More...
 

Detailed Description

The context for the format object.

For use by the formatting object only.

Definition at line 77 of file format.c.

Field Documentation

◆ bDone

abool fmt_tag::bDone

True if there are no more lines to display. False otherwise.

Definition at line 99 of file format.c.

◆ cpFmtBuf

char* fmt_tag::cpFmtBuf

Pointer to a temporary, working buffer for formatting the data in the data buffers.

Definition at line 85 of file format.c.

◆ iIndent

int fmt_tag::iIndent

The number of spaces to indent before displaying data.

Definition at line 90 of file format.c.

◆ iStyle

int fmt_tag::iStyle

The display style identifier. One of these..

Definition at line 89 of file format.c.

◆ pfnFill

uint64_t(* fmt_tag::pfnFill) (struct fmt_tag *)

Function pointer for filling the temp byte or code point buffer.

Definition at line 91 of file format.c.

◆ pfnFmt

void(* fmt_tag::pfnFmt) (struct fmt_tag *, uint64_t)

Function pointer for.

Definition at line 92 of file format.c.

◆ spException

exception* fmt_tag::spException

Pointer to an exception structure to report fatal errors back to the application's catch block.

Definition at line 79 of file format.c.

◆ spFile

FILE* fmt_tag::spFile

Pointer to an open file, if the data is from a file byte stream. Otherwise NULL.

Definition at line 82 of file format.c.

◆ ucpBuf8

uint8_t* fmt_tag::ucpBuf8

Pointer to a byte buffer for formatting the next byte-stream line.

Definition at line 83 of file format.c.

◆ ucpChars8

const uint8_t* fmt_tag::ucpChars8

Pointer to the array of 8-bit bytes to be formatted, if any. Otherwise, NULL.

Definition at line 86 of file format.c.

◆ uiDisplayEnd

uint64_t fmt_tag::uiDisplayEnd

The last byte or code point to display.

Definition at line 98 of file format.c.

◆ uiDisplayOffset

uint64_t fmt_tag::uiDisplayOffset

The offset to the first byte or code point to display.

Definition at line 95 of file format.c.

◆ uiFillLineLen

uint64_t fmt_tag::uiFillLineLen

formatting the data in the byte or code point buffer.

The max number of data in the buffer (16 for bytes, 8 for code points.)

Definition at line 94 of file format.c.

◆ uiLastOffset

uint64_t fmt_tag::uiLastOffset

Keeps the offset to the previous line displayed.

Definition at line 96 of file format.c.

◆ uiNextOffset

uint64_t fmt_tag::uiNextOffset

Keeps the offset to the next byte or code point to display next.

Definition at line 97 of file format.c.

◆ uipBuf32

uint32_t* fmt_tag::uipBuf32

Pointer to a 32-bit buffer for formatting the next Unicode line.

Definition at line 84 of file format.c.

◆ uipChars32

const uint32_t* fmt_tag::uipChars32

Pointer to the 32-bit Unicode code points to be formatted, if any. Otherwise, NULL.

Definition at line 87 of file format.c.

◆ vpMem

void* fmt_tag::vpMem

Pointer to a memory object for allocating all memory associated with this object.

Definition at line 81 of file format.c.

◆ vpValidate

const void* fmt_tag::vpValidate

A "magic number" used to validate the context.

Definition at line 78 of file format.c.


The documentation for this struct was generated from the following file:
APG Version 7.0 is licensed under the 2-Clause BSD License,
an Open Source Initiative Approved License.