symbol_table.h

Go to the documentation of this file.

#ifndef SYMBOL_TABLE_CLASS
#define SYMBOL_TABLE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : symbol_table                                                      *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$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 "data_structure_dll.h"

#include <basis/istring.h>

// forward.
class string_set;
template <class contents> class internal_symbol_indexer;
template <class contents> class internal_symbol_info;
template <class contents> class internal_symbol_list;


template <class contents>
class symbol_table
{
public:

  symbol_table(int max_bits = 7);

  symbol_table(const symbol_table<contents> &to_copy);

  ~symbol_table();

  int symbols() const;

  int max_bits() const;  

  void rehash(int max_bits);  

  void hash_appropriately(int max_per_bucket);

  symbol_table &operator =(const symbol_table<contents> &to_copy);

  outcome add(const istring &name, const contents &storage);

  const istring &name(int index) const;

  void names(string_set &to_fill) const;

  contents &operator [] (int index);
  const contents &operator [] (int index) const;

  inline const contents &get(int index) const { return operator[](index); }
  inline contents &use(int index) { return operator[](index); }

  contents *find(const istring &name) const;

  contents *find(const istring &name,
          string_comparator_function *comparator) const;

  int dep_find(const istring &name) const;



  outcome retrieve(int index, istring &symbol_name, contents &contains) const;

  outcome whack(const istring &name);

  outcome zap_index(int index);

  void reset();  //<! removes all symbols from the table.

private:
  internal_symbol_list<contents> *_symbol_list;  
  internal_symbol_indexer<contents> *_tracker;  

  internal_symbol_info<contents> *get_index(int index) const;
};


template <class contents>
bool symbol_table_compare(const symbol_table<contents> &a,
    const symbol_table<contents> &b);

#endif

---