OpalParser.h

Go to the documentation of this file.

#ifndef OPAL_OpalParser_HH
#define OPAL_OpalParser_HH

// ------------------------------------------------------------------------
// $RCSfile: OpalParser.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class OpalParser:
//
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:33:43 $
// $Author: Andreas Adelmann $
//
// ------------------------------------------------------------------------

#include "Parser/Parser.h"
#include "MemoryManagement/Pointer.h"
#include <string>
#include <vector>

class Object;
class Token;
class Statement;


// Class OpalParser
// ------------------------------------------------------------------------
//  The parser reads a command name and keyword and looks up the keyword
//  in the main directory.  If it finds an object, it makes a clone with the
//  name read and calls the parser for the cloned object.  If that parser
//  succeeds, it calls the clone's execute() function.  As required, it
//  first updates the data structure to ensure that everything is up-to-date.
//  Optionally, command execution is also traced.
//
//  Derived parsers may have their own directory, thus changing the set
//  of recognized commands.

class OpalParser: public Parser {

public:

    OpalParser();
    virtual ~OpalParser();

    virtual void parse(Statement &) const;

    virtual Statement *readStatement(TokenStream *) const;

    //  Read, parse, and execute statements one at a time.
    virtual void run() const;

    //  Switch to given stream, then read, parse, and execute statements
    //  one at a time. Used for CALL statements and macros.
    virtual void run(TokenStream *) const;

    //  Causes [tt]run()[/tt] to return when the next statement should be
    //  read.
    void stop() const;

    static Token readToken();

protected:

    void execute(Object *, const std::string &) const;

    virtual Object *find(const std::string &) const;

    virtual void parseAction(Statement &) const;

    virtual void parseAssign(Statement &) const;

    virtual void parseDefine(Statement &) const;

    virtual void parseEnd(Statement &) const;

    virtual void parseMacro(const std::string &name, Statement &) const;

    virtual void printHelp(const std::string &) const;

private:

    // Not implemented.
    OpalParser(const OpalParser &);
    void operator=(const OpalParser &);

    // Parse a bracketed token list into statement.
    static void parseBracketList(char close, Statement &);

    // Parse a token list into statement.
    static void parseTokenList(Statement &);

    // get hint on cause of error
    static std::string getHint(const std::string &, const std::string & = "attribute");

    // This flag is set by all commands which return from a mode.
    mutable bool stopFlag;

    // The stack of input streams ("CALL", "MACRO", etc.).
    static std::vector<Pointer<TokenStream> > inputStack;
};

#endif // OPAL_OpalParser_HH