Dictionary.h

Go to the documentation of this file.

/*
 * Dictionary.h
 *
 * Smalltalk like class library for C++
 * Growable collection of key-value pairs, not index-accessible. Header.
 *
 * Copyright (c) 2003 Milan Cermak
 */
/*
 * 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 2.1 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef __DICTIONARY_H
#define __DICTIONARY_H

#include <stlib/Set.h>

namespace Core {

class Association;
class KeysAndValuesIterator;
class String;
class Visitor;

class Dictionary : public Set
{
  public:
    Dictionary(int length = 2);

    /* Class-accessing protocol */
    virtual String *className(void) const;

    /* Accessing protocol */
    virtual Object *at(Object *key);
    virtual Object *at(Object *key, Object *ifAbsentValue);
    virtual Object *at(const char* key);
    virtual Object *at(const char* key, const char *ifAbsentValue);
    virtual void put(Object *key, Object *value);
    virtual void put(const char* key, Object* value);
    virtual void put(const char* key, const char* value);
    virtual Object *keyAtValue(Object *value);
    virtual Object *keyAtValue(Object *value, Object *ifAbsentKey);

    /* Adding protocol */
    virtual void add(Object *obj);

    /* Copying protocol */
    virtual Object *copy(void);
    virtual Object *copyEmpty(long size);

    /* Enumeration protocol */
    virtual KeysAndValuesIterator *keysAndValuesIterator(void) const;

    /* Removing protocol */
    virtual Object *remove(Object *);
    virtual Object *removeKey(Object *key);

    /* Testing protocol */
    virtual bool includes(Object *obj);
    virtual bool includesKey(Object *key);

    /* Visiting protocol */
    virtual void visitBy(Visitor *visitor);

    /* Private protocol */
    virtual int findKey(Object *key);
    virtual int findKeyOrNil(Object *key);

  protected:
    virtual void changeCapacity(long newCapacity);
    virtual void fixCollisionsFrom(int index);
    virtual void noCheckAdd(Association *object);
};

};

#endif /* __DICTIONARY_H */

---