Polaris: Dictionary.h Source File

Dictionary.h Go to the documentation of this file. /// /// #ifndef _DICTIONARY_H #define _DICTIONARY_H /// /// file Dictionary.h /// /// \class Dictionary /// \brief A hashtable based on strings /// \defgroup C /// \ingroup C++ CVDL /// Polaris /// \see Dictionary/Data.h /// \see Dictionary.cc /// \see Dictionary.h /// /// \endcode /// \section Description Description /// The Dictionary is used to store objects which can be retrieved /// based upon a string tag. In order to guarnatee that the /// objects in the Dictionary have the appropriate fields, the /// the class used in the Dictionary template (T) must be /// derived from Definition. /// #include "ClassNames.h" #include "Definition.h" #include "Collection/Database.h" #include "String.h" /// #include "macros.h" /// void dict_abort(const char *tag); /// template <class T> class Dictionary : public Database<String,T> { friend class Definition; public: INLINE Dictionary(); INLINE Dictionary(const Dictionary<T> &dict); INLINE Dictionary<T> & operator = (const Dictionary<T> &dict); virtual INLINE ~Dictionary(); ///< virtual Dictionary<T> *clone() const; virtual INLINE void del(const char *tag); virtual INLINE void ins(T *elem); virtual INLINE void ins(T *elem, int replace_if_already_exists); ///< Insert item into the dictionary. ///< The meaning of the replace_if_already_exists is: ///< replace_if_already_exists != 0 : ///< If an item already exists in the dictionary with ///< the same tag as item, the old item is deleted ///< and is replaced by item. ///< replace_if_already_exists == 0 : ///< If an item already exists in the dictionary with ///< the same tag as item, an error message is ///< displayed and the program is aborted. virtual INLINE const T *find_ref(const char *tag) const; virtual INLINE T *find_ref(const char *tag); virtual INLINE const T *find(const char *tag) const; virtual INLINE T *find(const char *tag); virtual INLINE const T &operator[] (const char *tag) const; virtual INLINE T &operator[] (const char *tag); virtual INLINE T *grab(const char *tag); ///< Remove and return (does NOT delete) the item in the dictionary ///< which has this tag. Returns 0 if none was found virtual INLINE const T *arb_ref() const; virtual INLINE T *arb_ref(); ///< Returns pointer to arbitrary element (or 0 if dictionary is empty) virtual INLINE T *grab_arb(); ///< Removes and returns pointer to arbitrary element (or returns 0 if ///< dictionary is empty) virtual INLINE void print(ostream &o) const; ///< Print the elements of the dictionary. virtual INLINE void rename(const char *tag, const char *new_tag); ///< Rename the member of this class whose tag is 'tag' to the ///< new tag 'new_tag' (and automatically reindex it). ///< An error occurs if there is not item in the dictionary ///< with the tag 'tag' OR if there is already an item in ///< the dictionary with the tag 'new_tag'. }; template <class T> INLINE Dictionary<T>::Dictionary() { #ifdef CLASS_INSTANCE_REGISTRY register_instance(DICTIONARY, sizeof(Dictionary), this); #endif } template <class T> INLINE Dictionary<T>::Dictionary(const Dictionary<T> &other) { #ifdef CLASS_INSTANCE_REGISTRY register_instance(DICTIONARY, sizeof(Dictionary), this); #endif *this = other; } template <class T> INLINE Dictionary<T> & Dictionary<T>::operator = (const Dictionary<T> &other) { Database<String,T>::operator = (other); return *this; } template <class T> INLINE Dictionary<T>::~Dictionary() { #ifdef CLASS_INSTANCE_REGISTRY unregister_instance(DICTIONARY, this); #endif } template <class T> INLINE void Dictionary<T>::ins(T *elem) { Dictionary<T>::ins(elem,0); } template <class T> INLINE void Dictionary<T>::ins(T *elem, int replace_if_already_exists) { if (member(elem->tag_ref())) { if (! replace_if_already_exists) p_abort( "inserting an element that already exists" ); del(elem->tag_ref()); } String s = elem->tag_ref(); Database<String,T>::ins( s, elem ); } template <class T> INLINE void Dictionary<T>::del(const char *tag) { String s = tag; Database<String,T>::del(s); } template <class T> INLINE const T * Dictionary<T>::find_ref(const char *tag) const { const String & tag_str = tag; return Database<String,T>::find_ref(tag_str); } template <class T> INLINE T * Dictionary<T>::find_ref(const char *tag) { String tag_str(tag); return Database<String,T>::find_ref(tag_str); } template <class T> INLINE const T * Dictionary<T>::find(const char *tag) const { return find_ref(tag); } template <class T> INLINE T * Dictionary<T>::find(const char *tag) { return find_ref(tag); } template <class T> INLINE const T & Dictionary<T>::operator[] (const char *tag) const { const T *found = find_ref(tag); if (!found) dict_abort(tag); return *found; } template <class T> INLINE T & Dictionary<T>::operator[] (const char *tag) { T *found = find_ref(tag); if (!found) dict_abort(tag); return *found; } template <class T> INLINE T * Dictionary<T>::grab(const char *tag) { String key = tag; return (T *) Database<String,T>::grab(key); } template <class T> INLINE const T * Dictionary<T>::arb_ref() const { const String *key = arb_key_ref(); if (key == 0) return 0; return find_ref( *key ); } template <class T> INLINE T * Dictionary<T>::arb_ref() { const String *key = arb_key_ref(); if (key == 0) return 0; return find_ref( *key ); } template <class T> INLINE T * Dictionary<T>::grab_arb() { T *el = arb_ref(); if (el != 0) return grab( el->tag_ref() ); return 0; } template <class T> INLINE void Dictionary<T>::rename(const char *tag, const char *new_tag) { String key = tag; T *el = grab( key ); el->rename( new_tag ); ins( el ); } template <class T> INLINE void Dictionary<T>::print(ostream &o) const { Database<String,T>::print(o, ": ", ", "); } ///< This interface is for testing purposes only. It invokes a non-virtual ///< member function to print a representation of the data structure at this ///< level of the Collection hierarchy, and, since it is not a class member ///< function, it must be explicitly instantiated before use. template <class T> ostream & operator << (ostream & o, const Dictionary<T> &dict) { dict.print(o); return o; } #include "DictionaryIter.h" #endif

© 1995-2005 University of Illinois, Urbana-Champaign. All rights reserved.  Fri Mar 25 23:05:44 2005