expressionTree.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: expressionTree.h,v 1.12 2005/10/23 12:02:18 oliver Exp $
//

#ifndef BALL_KERNEL_EXPRESSIONTREE_H
#define BALL_KERNEL_EXPRESSIONTREE_H

#ifndef BALL_KERNEL_EXPRESSIONPREDICATE_H
# include <BALL/KERNEL/expressionPredicate.h>
#endif

namespace BALL
{

  class BALL_EXPORT ExpressionTree
  {
    public:

    BALL_CREATE(ExpressionTree)

    

    enum Type
    { 
      INVALID = 0,
      LEAF,
      OR,
      AND
    };

      
    ExpressionTree();
      
    ExpressionTree(const ExpressionTree& tree);

    ExpressionTree(ExpressionPredicate* predicate, bool negate = false);

    ExpressionTree(Type type, list<const ExpressionTree*> children, bool negate = false);

    virtual ~ExpressionTree();


    
    virtual bool operator () (const Atom& atom) const;

    bool operator == (const ExpressionTree& tree) const;

    bool operator != (const ExpressionTree& tree) const;



    void setType(Type type) ;

    Type getType() const;
    
    void setNegate(bool negate);

    bool getNegate() const;

    void setPredicate(ExpressionPredicate* predicate);

    ExpressionPredicate* getPredicate() const;

    void appendChild(const ExpressionTree* child);

    const list<const ExpressionTree*>& getChildren() const;



    ExpressionTree& operator = (const ExpressionTree& tree);

    virtual void clear();


    void dump(std::ostream& is = std::cout, Size depth = 0) const;

    
    protected:
    
    /*_ A helper function for operator == () that compares the children of
        a node.
    */
    bool compareChildren_(const ExpressionTree& tree) const;

    /*_ The type of this node.
    */
    Type                        type_;
    
    /*_ Negation flag. If set, the value of this node will be negated.
    */
    bool                        negate_;
    
    /*_ A pointer to the predicate that this node represents.
    */
    ExpressionPredicate*        predicate_;
    
    /*_ A list containing pointers to the children of this node. 
    */
    list<const ExpressionTree*> children_;

  };

}

#endif // BALL_KERNEL_EXPRESSIONTREE_H