vrmlshapetoken Class Reference

vrmlshapetoken evaluates itself on the stream. This consumes one or more tokens and iterates the stream. More...

#include <vrmlshapeparse.h>

Inheritance diagram for vrmlshapetoken:

Collaboration diagram for vrmlshapetoken:

List of all members.

Public Member Functions
	vrmlshapetoken (stringc &id_)
	A token is identified through a string id.
virtual	~vrmlshapetoken ()
	Destructor.
void	eval (bool &handled, vrmlshapeparse &p) const
	If the current token in the parser is this token then the work is forwarded to eval( vrmlshapeparse& p).
virtual void	eval (vrmlshapeparse &p) const =0
	The current token in the token stream is evaluated.
void	consumescope (vrmlshapeparse &p, stringc &left, stringc &right) const
	The scope between left and right tokens is consumed by incrementing the token stream when encountering these tokens, else forward to depth(vrmlshapeparse &).
virtual void	depth (vrmlshapeparse &p) const
	This is over ridden to interpret the scope.
Public Attributes
stringc	id
	A token identity.

---

Detailed Description

vrmlshapetoken evaluates itself on the stream. This consumes one or more tokens and iterates the stream.

This base class implements general behaviour and work is forwarded to the derived classes with virtual functions.

I would call this design a pattern but have no idea how to label it so I will describe it.

The eval(bool &, vrmlshapeparse &) calles eval(vrmlshapeparse &) if the current token in the parser is this token as matched with id. So a derived class overloads eval(vrmlshapeparse &) to capture this situation.

As the data is heirachical eval(vrmlshapeparse &) uses consumescope(..) to remove the scope tokens from the stream and interpret inside the scope by forwarding this to depth(vrmlshapeparse &).

Definition at line 35 of file vrmlshapeparse.h.

---

Constructor & Destructor Documentation

vrmlshapetoken::vrmlshapetoken

(

stringc &

id_

)

[inline]

A token is identified through a string id.

Definition at line 43 of file vrmlshapeparse.h.

    : id(id_) {}

virtual vrmlshapetoken::~vrmlshapetoken

(

)

[inline, virtual]

Destructor.

Definition at line 47 of file vrmlshapeparse.h.

{}

---

Member Function Documentation

void vrmlshapetoken::consumescope	(	vrmlshapeparse &	p,
		stringc &	left,
		stringc &	right
	)			const

The scope between left and right tokens is consumed by incrementing the token stream when encountering these tokens, else forward to depth(vrmlshapeparse &).

Definition at line 39 of file vrmlshapeparse.cpp.

References vrmlshapeparse::tokenstream.

Referenced by vrmlshapeShape::eval(), vrmlshapeIndexedLineSet::eval(), vrmlshapeMaterial::eval(), and vrmlshapeIndexedFaceSet::eval().

{
  ++p.tokenstream;
  // Insist that client knows what they are
  // doing and is expecting the scope.
  assert(p.tokenstream()==left);

  int count = 1;

  ++p.tokenstream;
  while ((count>0) && !p.tokenstream)
  {
    stringc & s(p.tokenstream());
    if (s==left)
    {
      ++count;
      ++p.tokenstream;
    }
    else
    {
      if (s==right)
      {
        --count;
        ++p.tokenstream;
      }
      else
        depth(p);
    };
  }
}

void vrmlshapetoken::depth

(

vrmlshapeparse &

p

)

const [virtual]

This is over ridden to interpret the scope.

You could see this as the meat in the sandwich. The token stream must be incremented.

Reimplemented in vrmlshapeShape, vrmlshapeIndexedLineSet, vrmlshapeIndexedFaceSet, and vrmlshapeMaterial.

Definition at line 33 of file vrmlshapeparse.cpp.

References vrmlshapeparse::tokenstream.

{ 
  ++p.tokenstream; 
}

virtual void vrmlshapetoken::eval

(

vrmlshapeparse &

p

)

const [pure virtual]

The current token in the token stream is evaluated.

Implemented in vrmlshapeShape, vrmlshapeIndexedLineSet, vrmlshapeIndexedFaceSet, vrmlshapeMaterial, vrmlshapediffuseColor, vrmlshapeemissiveColor, vrmlshapeambientIntensity, vrmlshapepoint, vrmlshapeNormal, and vrmlshapecoordIndex.

void vrmlshapetoken::eval	(	bool &	handled,
		vrmlshapeparse &	p
	)			const

If the current token in the parser is this token then the work is forwarded to eval( vrmlshapeparse& p).

Definition at line 76 of file vrmlshapeparse.cpp.

References dbg, and vrmlshapeparse::tokenstream.

{
  assert(!p.tokenstream);

#ifdef DEBUG_VRMLSHAPEPARSE
//messagefile("debug.txt")() << p.tokenstream() << "==" << id << endl;
dbg() << p.tokenstream() << "==" << id << endl;
#endif

  if (p.tokenstream()==id)
  {
    handled = true;
    this->eval(p);
  }
  else
    handled = false;
}

---

Member Data Documentation

stringc vrmlshapetoken::id

A token identity.

Definition at line 40 of file vrmlshapeparse.h.

---

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

• vrml/vrmlshapeparse.h
• vrml/vrmlshapeparse.cpp