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/object_base.h>

namespace nodes {

// forward.
class symbol_tree_associations;


class NODES_CLASS_STYLE symbol_tree : public tree
{
public:
  symbol_tree(const istring &node_name, int max_bits = 2);

  virtual ~symbol_tree();

  IMPLEMENT_CLASS_NAME("symbol_tree");

  int children() const;  

  const istring &name() const;  

  int max_bits() const;  

  symbol_tree *branch(int index) const;  

  void rehash(int max_bits);

  void hash_appropriately(int max_per_bucket);

  bool add(symbol_tree *to_add);

  virtual outcome prune(tree *to_zap);

  enum find_methods { just_branches, recurse_downward, recurse_upward };

  symbol_tree *find(const istring &to_find,
          find_methods how = just_branches,
          string_comparator_function *comp = NIL);

  void sort();

  istring text_form() const;

private:
  symbol_tree_associations *_associations;  
  istring *_name;  
};

} // namespace.

#endif

---