/home/jeroen/FOX/fox/fox-1.7.33/include/FXDict.h

/********************************************************************************
*                                                                               *
*                  S t r i n g   D i c t i o n a r y    C l a s s               *
*                                                                               *
*********************************************************************************
* Copyright (C) 1998,2012 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 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 Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXDICT_H
#define FXDICT_H

#ifndef FXOBJECT_H
#include "FXObject.h"
#endif

namespace FX {


class FXAPI FXDict : public FXObject {
  FXDECLARE(FXDict)
protected:
  struct Entry {
    FXchar *key;                // Key string
    void   *data;               // Data
    FXint   hash;               // Hash value of key
    FXbool  mark;               // Entry is marked
    };
protected:
  FXArray<Entry> table;         // Hash table
  FXint          used;          // Used entries
  FXint          free;          // Free entries
protected:
  static const Entry init;      // Initialization value
protected:
  static FXint hash(const FXchar* str);
private:
  FXDict(const FXDict&);
  FXDict &operator=(const FXDict&);
protected:

  virtual void *createData(void*);

  virtual void deleteData(void*);
public:

  FXDict();

  FXbool size(FXint m);

  FXint size() const { return table.no(); }

  FXint no() const { return used; }

  void* insert(const FXchar* ky,void* ptr=NULL,FXbool mrk=false);

  void* replace(const FXchar* ky,void* ptr=NULL,FXbool mrk=false);

  void* remove(const FXchar* ky);

  void* find(const FXchar* ky) const;

  FXbool empty(FXint pos) const { return !table[pos].key; }

  const FXchar* key(FXint pos) const { return table[pos].key; }

  void* data(FXint pos) const { return table[pos].data; }

  FXbool mark(FXint pos) const { return table[pos].mark; }

  FXint first() const;

  FXint last() const;


  FXint next(FXint pos) const;

  FXint prev(FXint pos) const;

  void clear();

  virtual ~FXDict();
  };

}

#endif