tree.h

Go to the documentation of this file.

#ifndef TREE_CLASS
#define TREE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : tree                                                              *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1992-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "node.h"
#include "path.h"

#include <basis/enhance_cpp.h>

namespace nodes {


class tree : public node
{
public:
  tree();

  virtual ~tree();

  DEFINE_CLASS_NAME("tree");

  virtual tree *branch(int branch_number) const;

  virtual int which(tree *branch_to_find) const;

  virtual int branches() const;

  virtual tree *parent() const;

  virtual tree *root() const;

  virtual int depth() const;

  virtual void attach(tree *new_branch);

  virtual void insert(int branch_place, tree *new_branch);

  virtual basis::outcome prune(tree *branch_to_cut);

  virtual basis::outcome prune_index(int branch_to_cut);

  enum traversal_directions { prefix, infix, postfix, to_branches,
          reverse_branches };

  enum elevator_directions { TOWARD_ROOT, AWAY_FROM_ROOT };

  class iterator : public path
  {
  public:
    iterator(const tree *initial, traversal_directions direction);
    ~iterator();

    tree *next();

    void whack(tree *to_whack);

    traversal_directions _order;
    elevator_directions _aim;

  private:
    bool next_node(tree *&to_return);

  };
  
  iterator start(traversal_directions direction) const;

  virtual bool generate_path(path &to_follow) const;

private:
  // unavailable.
  tree(const tree &);
  tree &operator =(const tree &);
};

} // namespace.

#endif