Om
Public Member Functions | Private Member Functions | List of all members
Om::Language::Program Class Referenceabstract

The Program implementation. More...

#include "program.hpp"

+ Inheritance diagram for Om::Language::Program:
+ Collaboration diagram for Om::Language::Program:

Public Member Functions

virtual ~Program ()=0
 
virtual void Clear ()=0
 
virtual bool Equals (Program const &) const =0
 
virtual std::auto_ptr< Om::Source::Source< Element const > > GetElementRange () const =0
 
virtual std::auto_ptr< ProgramGiveProgram ()
 Returns a new Program populated with the contents of this. More...
 
virtual std::auto_ptr< ProgramGiveProgram () const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual bool IsEmpty () const =0
 
- Public Member Functions inherited from Om::Language::Consumer
virtual ~Consumer ()=0
 
template<typename TheOperator , typename TheSeparator >
void Parse (Reader &)
 
virtual void ParseElements (Reader &)=0
 
virtual void ParseQuotedElements (Reader &)=0
 
void TakeElement (Null &)
 Takes a Null Element, which is disregarded. More...
 
void TakeElement (Null const &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void TakeElement (Operand &)=0
 Takes a non-empty Element, which gets copied or swapped. More...
 
virtual void TakeElement (Operand const &)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void TakeElement (Operator &)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void TakeElement (Operator const &)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void TakeElement (Separator &)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void TakeElement (Separator const &)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void TakeElements (Producer &)=0
 Takes each Element of the argument. More...
 
virtual void TakeElements (Producer const &)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void TakeQuotedElements (Producer &)=0
 Constructs and takes an Operand, which takes each Element from the argument Producer. More...
 
virtual void TakeQuotedElements (Producer const &)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
- Public Member Functions inherited from Om::Giveable
virtual ~Giveable ()=0
 
- Public Member Functions inherited from Om::Copyable
virtual ~Copyable ()=0
 
virtual std::auto_ptr< CopyableCopy () const =0
 
- Public Member Functions inherited from Om::Moveable
virtual ~Moveable ()=0
 
virtual std::auto_ptr< MoveableMove ()=0
 
- Public Member Functions inherited from Om::Language::Producer
virtual ~Producer ()=0
 
virtual void GiveElements (Consumer &)=0
 Gives each contained Element to the argument. More...
 
virtual void GiveElements (Consumer &) const =0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
- Public Member Functions inherited from Om::Shareable< ThisOwnerCount >
virtual ~Shareable ()=0
 
ThisOwnerCount GetOwnerCount () const
 

Private Member Functions

Programoperator= (Program const &)
 

Additional Inherited Members

- Protected Member Functions inherited from Om::Shareable< ThisOwnerCount >
 Shareable ()
 
 Shareable (Shareable const &)
 
Shareableoperator= (Shareable const &)
 

Detailed Description

A Program is a Giveable, Shareable Producer and Consumer whose entire state is represented by an Element collection.

Each concrete derivation must have a GetName() function that returns a null-terminated, NFD-normalized UTF-8 string to be used as a corresponding Operator name.

Definition at line 58 of file program.hpp.

Constructor & Destructor Documentation

◆ ~Program()

virtual Om::Language::Program::~Program ( )
pure virtual

Member Function Documentation

◆ Clear()

virtual void Om::Language::Program::Clear ( )
pure virtual

◆ Equals()

virtual bool Om::Language::Program::Equals ( Program const &  ) const
pure virtual

◆ GetElementRange()

virtual std::auto_ptr< Om::Source::Source<Element const> > Om::Language::Program::GetElementRange ( ) const
pure virtual
Returns
A non-null owner pointer to a new Element range.

◆ GiveProgram() [1/2]

virtual std::auto_ptr<Program> Om::Language::Program::GiveProgram ( )
virtual

◆ GiveProgram() [2/2]

virtual std::auto_ptr<Program> Om::Language::Program::GiveProgram ( ) const
virtual

◆ IsEmpty()

virtual bool Om::Language::Program::IsEmpty ( ) const
pure virtual
Returns
True if there is no Element.

◆ operator=()

Program& Om::Language::Program::operator= ( Program const &  )
private

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