symbol_tree.h

Go to the documentation of this file.

#ifndef SYMBOL_TREE_CLASS
#define SYMBOL_TREE_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : symbol_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 "tree.h"
 
#include <basis/astring.h>
#include <basis/definitions.h>
 
namespace nodes {
 
// forward.
class symbol_tree_associations;
 
 
class symbol_tree : public tree
{
public:
  symbol_tree(const basis::astring &node_name, int estimated_elements = 100);
 
  virtual ~symbol_tree();
 
  DEFINE_CLASS_NAME("symbol_tree");
 
  int children() const;  
 
  const basis::astring &name() const;  
 
  int estimated_elements() const;  
 
  symbol_tree *branch(int index) const;  
 
  void rehash(int estimated_elements);
 
  void hash_appropriately(int estimated_elements);
 
  bool add(symbol_tree *to_add);
 
  virtual basis::outcome prune(tree *to_zap);
 
  enum find_methods { just_branches, recurse_downward, recurse_upward };
 
  symbol_tree *find(const basis::astring &to_find,
          find_methods how,
          basis::string_comparator_function *comp = NULL_POINTER);
 
  void sort();
 
  basis::astring text_form() const;
 
private:
  symbol_tree_associations *_associations;  
  basis::astring *_name;  
};
 
} // namespace.
 
#endif