esiWhen Class Reference

Inheritance diagram for esiWhen:

Collaboration diagram for esiWhen:

Public Types
enum	ESIElementType_t {   ESI_ELEMENT_NONE ,   ESI_ELEMENT_INCLUDE ,   ESI_ELEMENT_COMMENT ,   ESI_ELEMENT_REMOVE ,   ESI_ELEMENT_TRY ,   ESI_ELEMENT_ATTEMPT ,   ESI_ELEMENT_EXCEPT ,   ESI_ELEMENT_VARS ,   ESI_ELEMENT_CHOOSE ,   ESI_ELEMENT_WHEN ,   ESI_ELEMENT_OTHERWISE ,   ESI_ELEMENT_ASSIGN }
typedef RefCount< ESIElement >	Pointer

Public Member Functions
	esiWhen (esiTreeParentPtr aParent, int attributes, const char **attr, ESIVarState *)
	~esiWhen () override
Pointer	makeCacheable () const override
Pointer	makeUsable (esiTreeParentPtr, ESIVarState &) const override
bool	testsTrue () const
void	setTestResult (bool aBool)
void	render (ESISegment::Pointer) override
bool	addElement (ESIElement::Pointer) override
esiProcessResult_t	process (int dovars) override
void	provideData (ESISegment::Pointer, ESIElement *) override
bool	mayFail () const override
void	wontFail ()
void	fail (ESIElement *, char const *anError=nullptr) override
void	makeCachableElements (esiSequence const &old)
void	makeUsableElements (esiSequence const &old, ESIVarState &)
void	finish () override

Static Public Member Functions
static ESIElementType_t	IdentifyElement (const char *)

Public Attributes
Esi::Elements	elements
size_t	processedcount
struct {
unsigned int   dovars:1
}	flags

Protected Attributes
esiTreeParentPtr	parent

Private Member Functions
	MEMPROXY_CLASS (esiWhen)
	esiWhen (esiWhen const &)
void	evaluate ()
int	elementIndex (ESIElement::Pointer anElement) const
esiProcessResult_t	processOne (int, size_t)
size_t	nextElementToProcess () const
void	nextElementToProcess (size_t const &)
bool	finishedProcessing () const
void	processStep (int dovars)

Private Attributes
bool	testValue
char const *	unevaluatedExpression
ESIVarState *	varState
bool	mayFail_
bool	failed
bool const	provideIncrementalData
bool	processing
esiProcessResult_t	processingResult
size_t	nextElementToProcess_

Detailed Description

Definition at line 193 of file Esi.cc.

Member Typedef Documentation

Pointer

typedef RefCount<ESIElement> ESIElement::Pointer

inherited

Definition at line 46 of file Element.h.

Member Enumeration Documentation

ESIElementType_t

enum ESIElement::ESIElementType_t

inherited

Enumerator
ESI_ELEMENT_NONE
ESI_ELEMENT_INCLUDE
ESI_ELEMENT_COMMENT
ESI_ELEMENT_REMOVE
ESI_ELEMENT_TRY
ESI_ELEMENT_ATTEMPT
ESI_ELEMENT_EXCEPT
ESI_ELEMENT_VARS
ESI_ELEMENT_CHOOSE
ESI_ELEMENT_WHEN
ESI_ELEMENT_OTHERWISE
ESI_ELEMENT_ASSIGN

Definition at line 49 of file Element.h.

Constructor & Destructor Documentation

esiWhen() [1/2]

esiWhen::esiWhen	(	esiTreeParentPtr	aParent,
		int	attributes,
		const char **	attr,
		ESIVarState *	aVar
	)

Definition at line 2150 of file Esi.cc.

References assert, cbdataReference, DBG_IMPORTANT, debugs, evaluate(), unevaluatedExpression, varState, and xstrdup.

Referenced by makeCacheable(), and makeUsable().

~esiWhen()

esiWhen::~esiWhen ( )

override

Definition at line 2184 of file Esi.cc.

References cbdataReferenceDone, safe_free, unevaluatedExpression, and varState.

esiWhen() [2/2]

esiWhen::esiWhen ( esiWhen const &  old )

private

Definition at line 2209 of file Esi.cc.

References unevaluatedExpression, and xstrdup.

Member Function Documentation

addElement()

bool esiSequence::addElement ( ESIElement::Pointer  element )

overridevirtualinherited

Reimplemented from ESIElement.

Definition at line 148 of file Sequence.cc.

References DBG_CRITICAL, debugs, esiSequence::elements, RefCount< C >::getRaw(), and ESISegment::ListTransfer().

Referenced by esiSequence::makeCachableElements(), and esiSequence::makeUsableElements().

elementIndex()

int esiSequence::elementIndex ( ESIElement::Pointer  anElement ) const

privateinherited

Definition at line 177 of file Sequence.cc.

References esiSequence::elements.

Referenced by esiSequence::provideData().

evaluate()

void esiWhen::evaluate ( )

private

Definition at line 2193 of file Esi.cc.

References assert, ESIExpression::Evaluate(), ESIVarState::extractChar(), ESIVarState::feedData(), safe_free, setTestResult(), unevaluatedExpression, and varState.

Referenced by esiWhen(), and makeUsable().

fail()

void esiSequence::fail ( ESIElement *  , char const *  anError = nullptr  )

overridevirtualinherited

Reimplemented from esiTreeParent.

Definition at line 307 of file Sequence.cc.

References debugs, esiSequence::elements, esiTreeParent::fail(), esiSequence::failed, FinishAllElements(), esiSequence::parent, and esiSequence::processing.

finish()

void esiSequence::finish ( )

overridevirtualinherited

Implements ESIElement.

Definition at line 104 of file Sequence.cc.

References debugs, esiSequence::elements, FinishAllElements(), and esiSequence::parent.

finishedProcessing()

bool esiSequence::finishedProcessing ( ) const

privateinherited

Definition at line 60 of file Sequence.cc.

References esiSequence::elements, and esiSequence::nextElementToProcess().

Referenced by esiSequence::process().

IdentifyElement()

ESIElement::ESIElementType_t ESIElement::IdentifyElement ( const char *  el )

staticinherited

Definition at line 852 of file Esi.cc.

References assert, ESIElement::ESI_ELEMENT_ASSIGN, ESIElement::ESI_ELEMENT_ATTEMPT, ESIElement::ESI_ELEMENT_CHOOSE, ESIElement::ESI_ELEMENT_COMMENT, ESIElement::ESI_ELEMENT_EXCEPT, ESIElement::ESI_ELEMENT_INCLUDE, ESIElement::ESI_ELEMENT_NONE, ESIElement::ESI_ELEMENT_OTHERWISE, ESIElement::ESI_ELEMENT_REMOVE, ESIElement::ESI_ELEMENT_TRY, ESIElement::ESI_ELEMENT_VARS, and ESIElement::ESI_ELEMENT_WHEN.

Referenced by ESIContext::end(), and ESIContext::start().

makeCachableElements()

void esiSequence::makeCachableElements ( esiSequence const &  old )

inherited

Definition at line 336 of file Sequence.cc.

References esiSequence::addElement(), assert, esiSequence::elements, and RefCount< C >::getRaw().

Referenced by esiSequence::makeCacheable().

makeCacheable()

ESIElement::Pointer esiWhen::makeCacheable ( ) const

overridevirtual

Implements ESIElement.

Definition at line 2220 of file Esi.cc.

References esiWhen().

makeUsable()

ESIElement::Pointer esiWhen::makeUsable ( esiTreeParentPtr  newParent, ESIVarState &  newVarState  ) const

overridevirtual

Implements ESIElement.

Definition at line 2226 of file Esi.cc.

References esiWhen(), cbdataReference, evaluate(), esiSequence::makeUsableElements(), esiSequence::parent, and varState.

makeUsableElements()

void esiSequence::makeUsableElements ( esiSequence const &  old, ESIVarState &  newVarState  )

inherited

Definition at line 347 of file Sequence.cc.

References esiSequence::addElement(), assert, esiSequence::elements, and RefCount< C >::getRaw().

Referenced by makeUsable(), and esiSequence::makeUsable().

mayFail()

bool esiSequence::mayFail ( ) const

overridevirtualinherited

Reimplemented from ESIElement.

Definition at line 66 of file Sequence.cc.

References esiSequence::failed, and esiSequence::mayFail_.

MEMPROXY_CLASS()

esiWhen::MEMPROXY_CLASS ( esiWhen  )

private

nextElementToProcess() [1/2]

size_t esiSequence::nextElementToProcess ( ) const

privateinherited

Definition at line 48 of file Sequence.cc.

References esiSequence::nextElementToProcess_.

Referenced by esiSequence::finishedProcessing(), esiSequence::process(), and esiSequence::processStep().

nextElementToProcess() [2/2]

void esiSequence::nextElementToProcess ( size_t const &  aSizeT )

privateinherited

Definition at line 54 of file Sequence.cc.

References esiSequence::nextElementToProcess_.

process()

esiProcessResult_t esiSequence::process ( int  dovars )

overridevirtualinherited

Reimplemented from ESIElement.

Definition at line 238 of file Sequence.cc.

References assert, debugs, esiSequence::dovars, esiSequence::elements, ESI_PROCESS_COMPLETE, ESI_PROCESS_FAILED, ESI_PROCESS_PENDING_WONTFAIL, ESISegmentFreeList(), esiSequence::failed, FinishAllElements(), esiSequence::finishedProcessing(), esiSequence::flags, RefCount< C >::getRaw(), ESISegment::len, ESISegment::next, esiSequence::nextElementToProcess(), esiSequence::parent, esiSequence::processedcount, esiSequence::processing, esiSequence::processingResult, esiSequence::processStep(), esiTreeParent::provideData(), esiSequence::provideIncrementalData, esiSequence::render(), and esiSequence::wontFail().

Referenced by esiSequence::processOne(), and esiSequence::provideData().

processOne()

esiProcessResult_t esiSequence::processOne ( int  dovars, size_t  index  )

privateinherited

Definition at line 200 of file Sequence.cc.

References debugs, esiSequence::dovars, esiSequence::elements, ESI_PROCESS_COMPLETE, ESI_PROCESS_FAILED, ESI_PROCESS_PENDING_MAYFAIL, ESI_PROCESS_PENDING_WONTFAIL, fatal(), esiSequence::process(), and esiSequence::processedcount.

Referenced by esiSequence::processStep().

processStep()

void esiSequence::processStep ( int  dovars )

privateinherited

Definition at line 187 of file Sequence.cc.

References debugs, esiSequence::dovars, esiSequence::nextElementToProcess(), esiSequence::processingResult, and esiSequence::processOne().

Referenced by esiSequence::process().

provideData()

void esiSequence::provideData ( ESISegment::Pointer  data, ESIElement *  source  )

overridevirtualinherited

Reimplemented from esiTreeParent.

Definition at line 112 of file Sequence.cc.

References assert, debugs, esiSequence::elementIndex(), esiSequence::elements, ESI_PROCESS_FAILED, FinishAnElement(), esiSequence::flags, RefCount< C >::getRaw(), esiSequence::process(), and esiSequence::processing.

render()

void esiSequence::render ( ESISegment::Pointer  output )

overridevirtualinherited

Implements ESIElement.

Definition at line 82 of file Sequence.cc.

References assert, debugs, esiSequence::elements, FinishAnElement(), ESISegment::next, esiSequence::processedcount, and ESISegment::tail().

Referenced by esiSequence::process().

setTestResult()

void esiWhen::setTestResult ( bool  aBool )

inline

Definition at line 205 of file Esi.cc.

References testValue.

Referenced by evaluate().

testsTrue()

bool esiWhen::testsTrue ( ) const

inline

Definition at line 203 of file Esi.cc.

References testValue.

Referenced by esiChoose::addElement(), and esiChoose::selectElement().

wontFail()

void esiSequence::wontFail ( )

inherited

Definition at line 75 of file Sequence.cc.

References assert, esiSequence::failed, and esiSequence::mayFail_.

Referenced by esiSequence::process().

Member Data Documentation

dovars

unsigned int esiSequence::dovars

inherited

Definition at line 43 of file Sequence.h.

Referenced by esiSequence::esiSequence(), esiSequence::process(), esiSequence::processOne(), and esiSequence::processStep().

elements

Esi::Elements esiSequence::elements

inherited

Definition at line 39 of file Sequence.h.

Referenced by esiSequence::~esiSequence(), esiSequence::addElement(), esiSequence::elementIndex(), esiSequence::fail(), esiSequence::finish(), esiSequence::finishedProcessing(), esiSequence::makeCachableElements(), esiSequence::makeCacheable(), esiSequence::makeUsable(), esiSequence::makeUsableElements(), esiSequence::process(), esiSequence::processOne(), esiSequence::provideData(), and esiSequence::render().

failed

bool esiSequence::failed

privateinherited

Definition at line 54 of file Sequence.h.

Referenced by esiSequence::fail(), esiSequence::makeCacheable(), esiSequence::makeUsable(), esiSequence::mayFail(), esiSequence::process(), and esiSequence::wontFail().

struct { ... } esiSequence::flags

Referenced by esiSequence::esiSequence(), ESIVar::ESIVar(), esiSequence::process(), and esiSequence::provideData().

mayFail_

bool esiSequence::mayFail_

privateinherited

Definition at line 53 of file Sequence.h.

Referenced by esiSequence::mayFail(), and esiSequence::wontFail().

nextElementToProcess_

size_t esiSequence::nextElementToProcess_

privateinherited

Definition at line 59 of file Sequence.h.

Referenced by esiSequence::nextElementToProcess().

parent

esiTreeParentPtr esiSequence::parent

protectedinherited

Definition at line 49 of file Sequence.h.

Referenced by esiSequence::fail(), esiSequence::finish(), makeUsable(), esiSequence::makeUsable(), and esiSequence::process().

processedcount

size_t esiSequence::processedcount

inherited

Definition at line 40 of file Sequence.h.

Referenced by esiSequence::makeCacheable(), esiSequence::makeUsable(), esiSequence::process(), esiSequence::processOne(), and esiSequence::render().

processing

bool esiSequence::processing

privateinherited

Definition at line 57 of file Sequence.h.

Referenced by esiSequence::fail(), esiSequence::process(), and esiSequence::provideData().

processingResult

esiProcessResult_t esiSequence::processingResult

privateinherited

Definition at line 58 of file Sequence.h.

Referenced by esiSequence::process(), and esiSequence::processStep().

provideIncrementalData

bool const esiSequence::provideIncrementalData

privateinherited

Definition at line 56 of file Sequence.h.

Referenced by esiSequence::process().

testValue

bool esiWhen::testValue

private

Definition at line 209 of file Esi.cc.

Referenced by setTestResult(), and testsTrue().

unevaluatedExpression

char const* esiWhen::unevaluatedExpression

private

Definition at line 210 of file Esi.cc.

Referenced by esiWhen(), ~esiWhen(), and evaluate().

varState

ESIVarState* esiWhen::varState

private

Definition at line 211 of file Esi.cc.

Referenced by esiWhen(), ~esiWhen(), evaluate(), and makeUsable().

---

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

• src/esi/Esi.cc