Detailed information about the apgex object after vApgexPattern() has been called. More...

#include <apgex.h>

Collaboration diagram for apgex_properties:

Data Fields
void *	vpParser
	Pointer to the parser object context. More...

void *	vpAst
	Pointer to the AST object context. NULL unless the `a` flag is used. More...

void *	vpTrace
	Pointer to the trace object context. NULL unless the `t` flag is used. More...

const char *	cpFlags
	The original string of flags from vApgexPattern(). More...

const char *	cpPattern
	Internally preserve copy of the SABNF grammar defining the string to match. NULL if the pattern is defined with vApgexPatternParser(). More...

apg_phrase	sOriginalSource
	The original source or input string as a phrase. More...

apg_phrase	sLastSource
	The last source or input string as a phrase - may be different from original if sApgexReplace() or sApgexReplaceFunc() has been called. More...

apgex_phrase	sLastMatch
	The last-matched phrase. Same as `spResult` from the last call to sApgexExec(). More...

apgex_phrase	sLeftContext
	The left context of the last match - that is the phrase prefix to the matched phrase. More...

apgex_phrase	sRightContext
	The right context of the last match - that is the phrase suffix to the matched phrase. More...

aint	uiLastIndex
	The index of the character in the input string where the attempted pattern match begins. Use vApgexSetLastIndex() to manually override the defaults. More...

abool	bDefaultMode
	True if the `cpFlags` parameter in vApgexPattern() is NULL or empty. More...

abool	bGlobalMode
	True if the `g` flag is set prior to any occurrence of `y` in the `cpFlags` string. More...

abool	bPpptMode
	True if the `p` flag is set. The parser will use Partially-Predictive Parsing Tables. More...

abool	bStickyMode
	True if the `y` flag is set prior to any occurrence of `g` in the `cpFlags` string. More...

abool	bTraceMode
	True if the `t` flag is set in the `cpFlags` string. More...

abool	bTraceHtmlMode
	True if the `th` flags ar set for HTML trace output in the `cpFlags` string. More...

Detailed Description

Detailed information about the apgex object after vApgexPattern() has been called.

Note that all data pointers in this structure are, in general, valid only until the next function call on the apgex object. If the application needs to retain any phrases or other pointer data for future use it must make a copy of it into its own memory space.

Definition at line 94 of file apgex.h.

Field Documentation

◆ bDefaultMode

abool apgex_properties::bDefaultMode

True if the cpFlags parameter in vApgexPattern() is NULL or empty.

Definition at line 110 of file apgex.h.

◆ bGlobalMode

abool apgex_properties::bGlobalMode

True if the g flag is set prior to any occurrence of y in the cpFlags string.

Definition at line 111 of file apgex.h.

◆ bPpptMode

abool apgex_properties::bPpptMode

True if the p flag is set. The parser will use Partially-Predictive Parsing Tables.

Definition at line 112 of file apgex.h.

◆ bStickyMode

abool apgex_properties::bStickyMode

True if the y flag is set prior to any occurrence of g in the cpFlags string.

Definition at line 113 of file apgex.h.

◆ bTraceHtmlMode

abool apgex_properties::bTraceHtmlMode

True if the th flags ar set for HTML trace output in the cpFlags string.

Definition at line 115 of file apgex.h.

◆ bTraceMode

abool apgex_properties::bTraceMode

True if the t flag is set in the cpFlags string.

Definition at line 114 of file apgex.h.

◆ cpFlags

const char* apgex_properties::cpFlags

The original string of flags from vApgexPattern().

Definition at line 98 of file apgex.h.

◆ cpPattern

const char* apgex_properties::cpPattern

Internally preserve copy of the SABNF grammar defining the string to match. NULL if the pattern is defined with vApgexPatternParser().

Definition at line 99 of file apgex.h.

◆ sLastMatch

apgex_phrase apgex_properties::sLastMatch

The last-matched phrase. Same as spResult from the last call to sApgexExec().

Definition at line 104 of file apgex.h.

◆ sLastSource

apg_phrase apgex_properties::sLastSource

The last source or input string as a phrase - may be different from original if sApgexReplace() or sApgexReplaceFunc() has been called.

Definition at line 102 of file apgex.h.

◆ sLeftContext

apgex_phrase apgex_properties::sLeftContext

The left context of the last match - that is the phrase prefix to the matched phrase.

Definition at line 106 of file apgex.h.

◆ sOriginalSource

apg_phrase apgex_properties::sOriginalSource

The original source or input string as a phrase.

Definition at line 101 of file apgex.h.

◆ sRightContext

apgex_phrase apgex_properties::sRightContext

The right context of the last match - that is the phrase suffix to the matched phrase.

Definition at line 107 of file apgex.h.

◆ uiLastIndex

aint apgex_properties::uiLastIndex

The index of the character in the input string where the attempted pattern match begins. Use vApgexSetLastIndex() to manually override the defaults.

Definition at line 108 of file apgex.h.

◆ vpAst

void* apgex_properties::vpAst

Pointer to the AST object context. NULL unless the a flag is used.

Definition at line 96 of file apgex.h.

◆ vpParser

void* apgex_properties::vpParser

Pointer to the parser object context.

Definition at line 95 of file apgex.h.

◆ vpTrace

void* apgex_properties::vpTrace

Pointer to the trace object context. NULL unless the t flag is used.

Definition at line 97 of file apgex.h.

The documentation for this struct was generated from the following file:

apgex/apgex.h

Data Fields