Public API Reference

csutil/strhash.h

Go to the documentation of this file.

/*
    Copyright (C) 2002 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_STRHASH_H__
#define __CS_STRHASH_H__

#include "csextern.h"
#include "csutil/hash.h"
#include "csutil/mempool.h"
#include "iutil/strset.h"

class CS_CRYSTALSPACE_EXPORT csStringHash
{
private:
  typedef csHash<csStringID, char const*> HashType;
  HashType registry;
  csMemoryPool pool;

  void Copy(csStringHash const&);

public:
  typedef HashType::ConstGlobalIterator GlobalIterator;

public:
  csStringHash (size_t size = 23);
  csStringHash (csStringHash const& h) { Copy(h); }
  ~csStringHash ();
  csStringHash& operator=(csStringHash const& h) { Copy(h); return *this; }

  const char* Register (const char* s, csStringID id = 0);

  csStringID Request (const char* s) const;

  const char* Request (csStringID id) const;

  bool Contains(char const* s) const
  { return Request(s) != csInvalidStringID; }

  bool Contains(csStringID id) const
  { return Request(id) != 0; }

  bool Delete(char const* s);

  bool Delete(csStringID id);

  void Empty ();

  /*CS_DEPRECATED_METHOD("Use Empty() instead.")*/
  void Clear ()
  { Empty(); }

  size_t GetSize () const
  { return registry.GetSize (); }

  bool IsEmpty() const
  { return GetSize() == 0; }

  GlobalIterator GetIterator () const
  { return registry.GetIterator(); }
};

#endif // __CS_STRHASH_H__

---