// -*-C++-*- 

/*  inc/containers/Dictionary.hpp  */


/*
 * Author: Philogelos A. <Philogelos@yahoo.com>
 * Maintainer: Philogelos A.
 * Keywords: C++, library, containers
 *
 * Copyright (C) 1998 Philogelos A.
 *
 * This file is part of Quercus Robusta.
 *
 * Quercus Robusta 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, or (at your option)
 * any later version.
 *
 * This software 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 software; see the file COPYING.LIB.  If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */



#ifndef __DICTIONARY_HPP__
#define __DICTIONARY_HPP__

/* $Id: Dictionary.hpp,v 1.2 1999/03/03 19:09:14 philogelos Exp $ */

#include "containers/ModifiableContainer.hpp"
#include "containers/MutableContainer.hpp"
#include "containers/PositionFactory.hpp"
#include "Integer.hpp"
#include "Map.hpp"
#include "defines.h"

typedef Top DictKey;

/**

   @author Philogelos
   @created
*/
abstract class Dictionary : public ModifiableContainer,
					   public MutableContainer
{
  /**
   */
 public: virtual boolean isSuchKey( const DictKey *aKey ) const = 0;
 public: virtual Enumeration *getKeyEnumeration() const = 0;
 public: virtual Top *setValueAtKey( const DictKey *aKey, Top *aValue ) = 0;
 public: virtual Top *getValueAtKey( const DictKey *aKey ) const = 0;
 public: virtual void addKey( const DictKey *aKey, Top *aValue ) = 0;
 public: virtual Top *removeKey( const DictKey *aKey ) = 0;
};


class DictPositionMap : public Map,
						virtual public Object
{
public: DictPositionMap( Dictionary *aDict );
public: virtual ~DictPositionMap();

public: virtual Top *apply( Top *anArg );

protected: Dictionary *dict;
};

class DictPositionFactory : public PositionFactory,
							virtual public Object
{
public: DictPositionFactory( Dictionary *aDict );
public: virtual ~DictPositionFactory();

public: virtual MutablePosition *createPosition();

protected: Dictionary *dict;
protected: Integer *count;
};

/* $Log: Dictionary.hpp,v $
 * Revision 1.2  1999/03/03 19:09:14  philogelos
 * Put sources under GNU Library License
 *
 * Revision 1.1  1999/02/28 15:35:09  philogelos
 * Dictionaries added and tested
 * */

/* __DICTIONARY_HPP__ */
#endif
