ESIElement Class Reference

#include <Element.h>

Inheritance diagram for ESIElement:

Collaboration diagram for ESIElement:

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
virtual bool	addElement (ESIElement::Pointer)
virtual void	render (ESISegment::Pointer)=0
virtual esiProcessResult_t	process (int)
virtual bool	mayFail () const
virtual Pointer	makeCacheable () const =0
virtual Pointer	makeUsable (esiTreeParentPtr, ESIVarState &) const =0
virtual void	finish ()=0
virtual void	provideData (ESISegment::Pointer, ESIElement *)
virtual void	fail (ESIElement *, char const *=nullptr)

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

Detailed Description

Definition at line 42 of file Element.h.

Member Typedef Documentation

Pointer

typedef RefCount<ESIElement> ESIElement::Pointer

Definition at line 46 of file Element.h.

Member Enumeration Documentation

ESIElementType_t

enum ESIElement::ESIElementType_t

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.

Member Function Documentation

addElement()

virtual bool ESIElement::addElement ( ESIElement::Pointer  )

inlinevirtual

Reimplemented in ESIAssign, esiRemove, esiTry, esiChoose, and esiSequence.

Definition at line 64 of file Element.h.

References debugs.

Referenced by ESIContext::addLiteral(), and ESIContext::addStackElement().

fail()

virtual void esiTreeParent::fail ( ESIElement *  , char const *  = nullptr  )

inlinevirtualinherited

Reimplemented in esiTry, esiChoose, esiSequence, and ESIContext.

Definition at line 33 of file Element.h.

Referenced by esiChoose::fail(), esiSequence::fail(), esiTry::notifyParent(), esiChoose::process(), and ESIInclude::subRequestDone().

finish()

virtual void ESIElement::finish ( )

pure virtual

Implemented in ESIAssign, esiComment, esiRemove, esiTry, esiChoose, ESIInclude, esiLiteral, and esiSequence.

Referenced by esiChoose::fail(), esiTry::finish(), esiChoose::finish(), FinishAnElement(), ESIContext::finishChildren(), esiChoose::NULLUnChosen(), esiChoose::process(), and ESIContext::updateCachedAST().

IdentifyElement()

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

static

Definition at line 852 of file Esi.cc.

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

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

makeCacheable()

virtual Pointer ESIElement::makeCacheable ( ) const

pure virtual

Implemented in ESIAssign, esiComment, esiRemove, esiTry, esiChoose, esiWhen, ESIInclude, esiLiteral, and esiSequence.

Referenced by ESIAssign::makeCacheable(), esiTry::makeCacheable(), esiChoose::makeCacheable(), and ESIContext::updateCachedAST().

makeUsable()

virtual Pointer ESIElement::makeUsable ( esiTreeParentPtr  , ESIVarState &    ) const

pure virtual

Implemented in ESIAssign, esiComment, esiRemove, esiTry, esiChoose, esiWhen, ESIInclude, esiLiteral, and esiSequence.

Referenced by ESIContext::getCachedAST(), ESIAssign::makeUsable(), esiTry::makeUsable(), and esiChoose::makeUsable().

mayFail()

virtual bool ESIElement::mayFail ( ) const

inlinevirtual

Reimplemented in esiSequence.

Definition at line 77 of file Element.h.

Referenced by ESIContext::send().

process()

virtual esiProcessResult_t ESIElement::process ( int  )

inlinevirtual

Reimplemented in ESIAssign, esiTry, esiChoose, ESIInclude, esiLiteral, and esiSequence.

Definition at line 72 of file Element.h.

References debugs, and ESI_PROCESS_COMPLETE.

Referenced by ESIContext::process(), esiTry::process(), and esiChoose::process().

provideData()

virtual void esiTreeParent::provideData ( ESISegment::Pointer  , ESIElement *    )

inlinevirtualinherited

Reimplemented in ESIAssign, esiTry, esiChoose, esiSequence, and ESIContext.

Definition at line 28 of file Element.h.

References assert.

Referenced by esiTry::notifyParent(), esiSequence::process(), esiTry::provideData(), esiChoose::provideData(), and ESIInclude::subRequestDone().

render()

virtual void ESIElement::render ( ESISegment::Pointer  )

pure virtual

Implemented in ESIAssign, esiComment, esiRemove, esiTry, esiChoose, ESIInclude, esiLiteral, and esiSequence.

Referenced by ESIContext::kick(), esiTry::render(), and esiChoose::render().

---

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

• src/esi/Element.h
• src/esi/Esi.cc