path.h

Go to the documentation of this file.

#ifndef PATH_CLASS
#define PATH_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : path                                                              *
*  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 <basis/contracts.h>
#include <basis/enhance_cpp.h>
#include <basis/outcome.h>
 
namespace nodes {
 
// forward:
class node;
class path_node_stack;
 
 
class path : public virtual basis::nameable
{
public:
  path(const node *root);
 
  path(const path &to_copy);
 
  ~path();
 
  DEFINE_CLASS_NAME("path");
 
  path &operator =(const path &to_copy);
 
  int size() const;
 
  node *root() const;
 
  node *current() const;
  node *follow() const;
 
  node *pop();
 
  basis::outcome push(node *to_add);
 
  basis::outcome push(int index);
 
  bool generate_path(node *to_locate, path &to_follow) const;
 
  node *operator [] (int index) const;
 
private:
  path_node_stack *_stack;  
};
 
} // namespace.
 
#endif