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

#include <xmlp.h>

Collaboration diagram for xml_tag:
Collaboration graph
[legend]

Data Fields

const void * vpValidate
 Set to the context handle as a "magic number" for validating component member function calls. More...
 
exceptionspException
 
void * vpMem
 Handle to the memory component which keeps track of all memory allocations by this xml component. More...
 
void * vpFmt
 Context pointer to a format object used to display printing and non-printing code points. More...
 
void * vpParser
 APG parser context pointer. Kept here for memory clean up use. More...
 
void * vpConv
 A UTF conversion component. Reused in several places. More...
 
void * vpMsgs
 During DTD parsing, this collects errors, all to be reported at the close of the DTD. During element processing (the body of the XML document) it is used to collect warning messages presented to the user at the end of the document. More...
 
void * vpLines
 A lines object context pointer. Used to report the line number location of errors. More...
 
aint uiTrueType
 Used to record the actual data type of the XML input (UTF-8, UTF-16BE or UTF-16LE) More...
 
void * vpVecChars
 Vector of the XML input characters. More...
 
acharacpChars
 Pointer to input characters converted to achar, which in general is not 8-bit characters. More...
 
uint8_t * ucpData
 Points to the data read from an input file, if any. Otherwise, NULL. Needed for vXmlDtor(). More...
 
uint32_t uiChar
 A working value for a single character. Gets overwritten by each Char rule. More...
 
void * vpVecName
 Hold the name from the Name rule. Gets overwritten for each new Name instance. More...
 
void * vpVec32
 A 32-bit work vector of all most parsed data, names, attributes and content. More...
 
void * vpVec8
 A work vector for byte-stream data. More...
 
void * vpVecString
 A work vector for representing ASCII-only character data as a null-terminated string. More...
 
void * vpVecCData
 Temp vector of u32_phrase info for presentation to the caller. More...
 
aint uiSavedOffset
 Offset to the beginning of the declaration being processed. Used for error reporting. More...
 
xmldecl_info sXmlDecl
 For collecting and reporting the XML declaration info. More...
 
abool bStandalone
 True if standalone = "yes", false if standalone = "no". More...
 
abool bExtSubset
 True if an external subset is found, False otherwise. More...
 
aint uiDTDOffset
 Parser offset to the beginning of the DTD. Used for error reporting. More...
 
cdata_id sDtdName
 Offset & length of the DTD name. More...
 
void * vpVecGEDefs
 Vector of named_values for the General Entities declared. More...
 
void * vpVecEntityFrames
 Vector of General Entities stack frames for walking the tree of entity replacement values. More...
 
void * vpVecNotationDecls
 Vector of Notations declared. More...
 
aint uiExternalIds
 The number of external IDs found. More...
 
aint uiPEDecls
 The number of Parameter Entity declarations found. More...
 
aint uiPERefs
 The number of Parameter Entity references found. More...
 
aint uiGEDeclsTotal
 The total number of General Entity declarations. This includes declarations with multiply-defined names and ignored due to existence of Parameter Entities. More...
 
aint uiGEDeclsNotProcessed
 The number of General Entity declarations not processed because of conditionals. Condition: Unread Parameter Entity encountered previously and bStandalone is false (standalone = "no"). More...
 
aint uiElementDecls
 The number of element declarations. More...
 
entity_decl sCurrentEntity
 Holds the current entity declaration information. More...
 
void * vpVecFrame
 A vector for a stack of frames. A frame is pushed for each new element encountered and popped when the element ends. More...
 
element_framespCurrentFrame
 Holds a pointer to the current frame for the element being parsed. More...
 
att_decl sCurrentAttList
 Holds the current attribute list information. More...
 
void * vpVecAttWork
 A vector of work space for normalization of attribute balues. More...
 
void * vpVecAttDecls
 The list of attribute declarations. More...
 
void * vpVecAttList
 A vector of attribute named values. More...
 
aint uiAttListsNotProcessed
 The number of Attribute List declarations not processed because of the PE conditionals. More...
 
aint uiAttListsDeclared
 The number of Attribute List declarations including empty and not processed. More...
 
pfnEmptyTagCallback pfnEmptyTagCallback
 Pointer to the user's callback function for empty tag porcessing. May be the same as the start tag callback function or may be NULL for no callback. More...
 
void * vpEmptyTagData
 An opaque pointer available for user's use. More...
 
pfnStartTagCallback pfnStartTagCallback
 Pointer to the user's callback function for start tag processing. May be the same as the empty tag callback function or may be NULL for no callback. More...
 
void * vpStartTagData
 An opaque pointer available for user's use. More...
 
pfnEndTagCallback pfnEndTagCallback
 Pointer to the user's callback function for end tag processing. More...
 
void * vpEndTagData
 An opaque pointer available for user's use. More...
 
pfnPICallback pfnPICallback
 Pointer to the user's function for Processing Instruction processing. More...
 
void * vpPIData
 An opaque pointer available for user's use. More...
 
pfnXmlDeclCallback pfnXmlDeclCallback
 Pointer to the user's function for the XML declaration information. More...
 
void * vpXmlDeclData
 An opaque pointer available for user's use. More...
 
pfnDTDCallback pfnDTDCallback
 Pointer to the user's function for the DTD information. More...
 
void * vpCommentData
 An opaque pointer available for user's use. More...
 
pfnCommentCallback pfnCommentCallback
 Pointer to the user's function for the DTD information. More...
 
void * vpDTDData
 An opaque pointer available for user's use. More...
 

Detailed Description

Definition at line 114 of file xmlp.h.

Field Documentation

◆ acpChars

achar* xml_tag::acpChars

Pointer to input characters converted to achar, which in general is not 8-bit characters.

Definition at line 129 of file xmlp.h.

◆ bExtSubset

abool xml_tag::bExtSubset

True if an external subset is found, False otherwise.

Definition at line 146 of file xmlp.h.

◆ bStandalone

abool xml_tag::bStandalone

True if standalone = "yes", false if standalone = "no".

Definition at line 145 of file xmlp.h.

◆ pfnCommentCallback

pfnCommentCallback xml_tag::pfnCommentCallback

Pointer to the user's function for the DTD information.

Definition at line 198 of file xmlp.h.

◆ pfnDTDCallback

pfnDTDCallback xml_tag::pfnDTDCallback

Pointer to the user's function for the DTD information.

Definition at line 195 of file xmlp.h.

◆ pfnEmptyTagCallback

pfnEmptyTagCallback xml_tag::pfnEmptyTagCallback

Pointer to the user's callback function for empty tag porcessing. May be the same as the start tag callback function or may be NULL for no callback.

Definition at line 178 of file xmlp.h.

◆ pfnEndTagCallback

pfnEndTagCallback xml_tag::pfnEndTagCallback

Pointer to the user's callback function for end tag processing.

Definition at line 186 of file xmlp.h.

◆ pfnPICallback

pfnPICallback xml_tag::pfnPICallback

Pointer to the user's function for Processing Instruction processing.

Definition at line 189 of file xmlp.h.

◆ pfnStartTagCallback

pfnStartTagCallback xml_tag::pfnStartTagCallback

Pointer to the user's callback function for start tag processing. May be the same as the empty tag callback function or may be NULL for no callback.

Definition at line 182 of file xmlp.h.

◆ pfnXmlDeclCallback

pfnXmlDeclCallback xml_tag::pfnXmlDeclCallback

Pointer to the user's function for the XML declaration information.

Definition at line 192 of file xmlp.h.

◆ sCurrentAttList

att_decl xml_tag::sCurrentAttList

Holds the current attribute list information.

Depending on its uniqueness and correctness it may be discarded or added to the list at the close of the declaration.

Definition at line 169 of file xmlp.h.

◆ sCurrentEntity

entity_decl xml_tag::sCurrentEntity

Holds the current entity declaration information.

May be saved or discarded, depending on final processing.

Definition at line 160 of file xmlp.h.

◆ sDtdName

cdata_id xml_tag::sDtdName

Offset & length of the DTD name.

Definition at line 148 of file xmlp.h.

◆ spCurrentFrame

element_frame* xml_tag::spCurrentFrame

Holds a pointer to the current frame for the element being parsed.

Definition at line 166 of file xmlp.h.

◆ spException

exception* xml_tag::spException

Definition at line 116 of file xmlp.h.

◆ sXmlDecl

xmldecl_info xml_tag::sXmlDecl

For collecting and reporting the XML declaration info.

Definition at line 142 of file xmlp.h.

◆ ucpData

uint8_t* xml_tag::ucpData

Points to the data read from an input file, if any. Otherwise, NULL. Needed for vXmlDtor().

Definition at line 130 of file xmlp.h.

◆ uiAttListsDeclared

aint xml_tag::uiAttListsDeclared

The number of Attribute List declarations including empty and not processed.

Definition at line 175 of file xmlp.h.

◆ uiAttListsNotProcessed

aint xml_tag::uiAttListsNotProcessed

The number of Attribute List declarations not processed because of the PE conditionals.

Definition at line 174 of file xmlp.h.

◆ uiChar

uint32_t xml_tag::uiChar

A working value for a single character. Gets overwritten by each Char rule.

Definition at line 133 of file xmlp.h.

◆ uiDTDOffset

aint xml_tag::uiDTDOffset

Parser offset to the beginning of the DTD. Used for error reporting.

Definition at line 147 of file xmlp.h.

◆ uiElementDecls

aint xml_tag::uiElementDecls

The number of element declarations.

Definition at line 159 of file xmlp.h.

◆ uiExternalIds

aint xml_tag::uiExternalIds

The number of external IDs found.

Definition at line 152 of file xmlp.h.

◆ uiGEDeclsNotProcessed

aint xml_tag::uiGEDeclsNotProcessed

The number of General Entity declarations not processed because of conditionals. Condition: Unread Parameter Entity encountered previously and bStandalone is false (standalone = "no").

Definition at line 157 of file xmlp.h.

◆ uiGEDeclsTotal

aint xml_tag::uiGEDeclsTotal

The total number of General Entity declarations. This includes declarations with multiply-defined names and ignored due to existence of Parameter Entities.

Definition at line 155 of file xmlp.h.

◆ uiPEDecls

aint xml_tag::uiPEDecls

The number of Parameter Entity declarations found.

Definition at line 153 of file xmlp.h.

◆ uiPERefs

aint xml_tag::uiPERefs

The number of Parameter Entity references found.

Definition at line 154 of file xmlp.h.

◆ uiSavedOffset

aint xml_tag::uiSavedOffset

Offset to the beginning of the declaration being processed. Used for error reporting.

Definition at line 139 of file xmlp.h.

◆ uiTrueType

aint xml_tag::uiTrueType

Used to record the actual data type of the XML input (UTF-8, UTF-16BE or UTF-16LE)

Definition at line 127 of file xmlp.h.

◆ vpCommentData

void* xml_tag::vpCommentData

An opaque pointer available for user's use.

It is presented to the callback function for the caller's use.

Definition at line 196 of file xmlp.h.

◆ vpConv

void* xml_tag::vpConv

A UTF conversion component. Reused in several places.

Definition at line 120 of file xmlp.h.

◆ vpDTDData

void* xml_tag::vpDTDData

An opaque pointer available for user's use.

Definition at line 199 of file xmlp.h.

◆ vpEmptyTagData

void* xml_tag::vpEmptyTagData

An opaque pointer available for user's use.

It is presented to the callback function for the caller's use.

Definition at line 180 of file xmlp.h.

◆ vpEndTagData

void* xml_tag::vpEndTagData

An opaque pointer available for user's use.

It is presented to the callback function for the caller's use.

Definition at line 187 of file xmlp.h.

◆ vpFmt

void* xml_tag::vpFmt

Context pointer to a format object used to display printing and non-printing code points.

Definition at line 118 of file xmlp.h.

◆ vpLines

void* xml_tag::vpLines

A lines object context pointer. Used to report the line number location of errors.

Definition at line 124 of file xmlp.h.

◆ vpMem

void* xml_tag::vpMem

Handle to the memory component which keeps track of all memory allocations by this xml component.

Definition at line 117 of file xmlp.h.

◆ vpMsgs

void* xml_tag::vpMsgs

During DTD parsing, this collects errors, all to be reported at the close of the DTD. During element processing (the body of the XML document) it is used to collect warning messages presented to the user at the end of the document.

Definition at line 121 of file xmlp.h.

◆ vpParser

void* xml_tag::vpParser

APG parser context pointer. Kept here for memory clean up use.

Definition at line 119 of file xmlp.h.

◆ vpPIData

void* xml_tag::vpPIData

An opaque pointer available for user's use.

It is presented to the callback function for the caller's use.

Definition at line 190 of file xmlp.h.

◆ vpStartTagData

void* xml_tag::vpStartTagData

An opaque pointer available for user's use.

It is presented to the callback function for the caller's use.

Definition at line 184 of file xmlp.h.

◆ vpValidate

const void* xml_tag::vpValidate

Set to the context handle as a "magic number" for validating component member function calls.

Definition at line 115 of file xmlp.h.

◆ vpVec32

void* xml_tag::vpVec32

A 32-bit work vector of all most parsed data, names, attributes and content.

Definition at line 135 of file xmlp.h.

◆ vpVec8

void* xml_tag::vpVec8

A work vector for byte-stream data.

Definition at line 136 of file xmlp.h.

◆ vpVecAttDecls

void* xml_tag::vpVecAttDecls

The list of attribute declarations.

Definition at line 172 of file xmlp.h.

◆ vpVecAttList

void* xml_tag::vpVecAttList

A vector of attribute named values.

Definition at line 173 of file xmlp.h.

◆ vpVecAttWork

void* xml_tag::vpVecAttWork

A vector of work space for normalization of attribute balues.

Definition at line 171 of file xmlp.h.

◆ vpVecCData

void* xml_tag::vpVecCData

Temp vector of u32_phrase info for presentation to the caller.

Definition at line 138 of file xmlp.h.

◆ vpVecChars

void* xml_tag::vpVecChars

Vector of the XML input characters.

Definition at line 128 of file xmlp.h.

◆ vpVecEntityFrames

void* xml_tag::vpVecEntityFrames

Vector of General Entities stack frames for walking the tree of entity replacement values.

Definition at line 150 of file xmlp.h.

◆ vpVecFrame

void* xml_tag::vpVecFrame

A vector for a stack of frames. A frame is pushed for each new element encountered and popped when the element ends.

Definition at line 164 of file xmlp.h.

◆ vpVecGEDefs

void* xml_tag::vpVecGEDefs

Vector of named_values for the General Entities declared.

Definition at line 149 of file xmlp.h.

◆ vpVecName

void* xml_tag::vpVecName

Hold the name from the Name rule. Gets overwritten for each new Name instance.

Definition at line 134 of file xmlp.h.

◆ vpVecNotationDecls

void* xml_tag::vpVecNotationDecls

Vector of Notations declared.

Definition at line 151 of file xmlp.h.

◆ vpVecString

void* xml_tag::vpVecString

A work vector for representing ASCII-only character data as a null-terminated string.

Definition at line 137 of file xmlp.h.

◆ vpXmlDeclData

void* xml_tag::vpXmlDeclData

An opaque pointer available for user's use.

It is presented to the callback function for the caller's use.

Definition at line 193 of file xmlp.h.


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.