antlr/include/antlr/AST.hpp

Go to the documentation of this file.

#ifndef INC_AST_hpp__
#define INC_AST_hpp__

/* ANTLR Translator Generator
 * Project led by Terence Parr at http://www.jGuru.com
 * Software rights: http://www.antlr.org/license.html
 *
 * $Id: //depot/code/org.antlr/release/antlr-2.7.7/lib/cpp/antlr/AST.hpp#2 $
 */

#include <antlr/config.hpp>
#include <antlr/ASTRefCount.hpp>
#include <antlr/Token.hpp>
#include <vector>
#include <string>

#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE
namespace antlr {
#endif

struct ASTRef;

class ANTLR_API AST {
public:
        AST() : ref(0) {}
        AST(const AST&) : ref(0) {}
        virtual ~AST() {}

        virtual const char* typeName( void ) const = 0;
        virtual RefAST clone( void ) const = 0;
        virtual bool equals(RefAST t) const = 0;
        virtual bool equalsList(RefAST t) const = 0;

        virtual bool equalsListPartial(RefAST t) const = 0;
        virtual bool equalsTree(RefAST t) const = 0;
        virtual bool equalsTreePartial(RefAST t) const = 0;

        virtual ANTLR_USE_NAMESPACE(std)vector<RefAST> findAll(RefAST t) = 0;

        virtual ANTLR_USE_NAMESPACE(std)vector<RefAST> findAllPartial(RefAST t) = 0;

        virtual void addChild(RefAST c) = 0;
        virtual size_t getNumberOfChildren() const = 0;

        virtual RefAST getFirstChild() const = 0;
        virtual RefAST getNextSibling() const = 0;

        virtual ANTLR_USE_NAMESPACE(std)string getText() const = 0;
        virtual int getType() const = 0;

        virtual void initialize(int t, const ANTLR_USE_NAMESPACE(std)string& txt) = 0;
        virtual void initialize(RefAST t) = 0;
        virtual void initialize(RefToken t) = 0;

#ifdef ANTLR_SUPPORT_XML

        virtual void initialize( ANTLR_USE_NAMESPACE(std)istream& in ) = 0;
#endif

        virtual void setFirstChild(RefAST c) = 0;
        virtual void setNextSibling(RefAST n) = 0;

        virtual void setText(const ANTLR_USE_NAMESPACE(std)string& txt) = 0;
        virtual void setType(int type) = 0;

        virtual ANTLR_USE_NAMESPACE(std)string toString() const = 0;

        virtual ANTLR_USE_NAMESPACE(std)string toStringList() const = 0;
        virtual ANTLR_USE_NAMESPACE(std)string toStringTree() const = 0;

#ifdef ANTLR_SUPPORT_XML

        virtual bool attributesToStream( ANTLR_USE_NAMESPACE(std)ostream& out ) const = 0;

        virtual void toStream( ANTLR_USE_NAMESPACE(std)ostream &out ) const = 0;

        friend ANTLR_USE_NAMESPACE(std)ostream& operator<<( ANTLR_USE_NAMESPACE(std)ostream& output, const RefAST& ast );
#endif

private:
        friend struct ASTRef;
        ASTRef* ref;

        AST(RefAST other);
        AST& operator=(const AST& other);
        AST& operator=(RefAST other);
};

#ifdef ANTLR_SUPPORT_XML
inline ANTLR_USE_NAMESPACE(std)ostream& operator<<( ANTLR_USE_NAMESPACE(std)ostream& output, const RefAST& ast )
{
        ast->toStream(output);
        return output;
}
#endif

extern ANTLR_API RefAST nullAST;
extern ANTLR_API AST* const nullASTptr;

#ifdef NEEDS_OPERATOR_LESS_THAN
// RK: apparently needed by MSVC and a SUN CC, up to and including
// 2.7.2 this was undefined ?
inline bool operator<( RefAST l, RefAST r )
{
        return nullAST == l ? ( nullAST == r ? false : true ) : l->getType() < r->getType();
}
#endif

#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE
}
#endif

#endif //INC_AST_hpp__

---