The phrase matching results. More...

#include <apgex.h>

Collaboration diagram for apgex_result:

[legend]

Data Fields
apgex_phrase *	spResult
	The matched phrase. NULL if no match. More...

apgex_phrase *	spLeftContext
	The phrase prefix. More...

apgex_phrase *	spRightContext
	The phrase suffix. More...

apgex_rule *	spRules
	The phrases matched by all enabled rules and/or UDTs. NULL if no match. More...

aint	uiLastIndex
	The last index following the last pattern match attempt. More...

aint	uiRuleCount
	The number of combined rules and UDTs in the pattern. More...

aint	uiNodeHits
	The number of parser node hits. More...

aint	uiTreeDepth
	The maximum parsing tree depth. More...

Detailed Description

The phrase matching results.

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 72 of file apgex.h.

Field Documentation

◆ spLeftContext

apgex_phrase* apgex_result::spLeftContext

The phrase prefix.

This is the portion of the source string preceding the matched phrase. NULL if no match.

Definition at line 74 of file apgex.h.

◆ spResult

apgex_phrase* apgex_result::spResult

The matched phrase. NULL if no match.

Definition at line 73 of file apgex.h.

◆ spRightContext

apgex_phrase* apgex_result::spRightContext

The phrase suffix.

This is the portion of the source string following the matched phrase. NULL if no match.

Definition at line 77 of file apgex.h.

◆ spRules

apgex_rule* apgex_result::spRules

The phrases matched by all enabled rules and/or UDTs. NULL if no match.

Definition at line 80 of file apgex.h.

◆ uiLastIndex

aint apgex_result::uiLastIndex

The last index following the last pattern match attempt.

Definition at line 81 of file apgex.h.

◆ uiNodeHits

aint apgex_result::uiNodeHits

The number of parser node hits.

Definition at line 83 of file apgex.h.

◆ uiRuleCount

aint apgex_result::uiRuleCount

The number of combined rules and UDTs in the pattern.

Definition at line 82 of file apgex.h.

◆ uiTreeDepth

aint apgex_result::uiTreeDepth

The maximum parsing tree depth.

Definition at line 84 of file apgex.h.

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

apgex/apgex.h

Data Fields