Rudiments
dictionary.h
1 // Copyright (c) 1999-2018 David Muse
2 // See the COPYING file for more information.
3 
4 #ifndef RUDIMENTS_DICTIONARY_H
5 #define RUDIMENTS_DICTIONARY_H
6 
7 #include <rudiments/private/dictionaryincludes.h>
8 
11 template <class keytype, class valuetype>
13  public:
16  dictionarynode(keytype key, valuetype value);
17 
21  virtual ~dictionarynode();
22 
24  void setKey(keytype key);
25 
27  void setValue(valuetype value);
28 
30  keytype getKey() const;
31 
33  valuetype getValue() const;
34 
38  int32_t compare(keytype testkey) const;
39 
43  int32_t compare(
44  dictionarynode<keytype,valuetype> *testnode) const;
45 
48  void print() const;
49 
50  #include <rudiments/private/dictionarynode.h>
51 };
52 
62 template <class keytype, class valuetype>
63 class dictionary {
64  public:
66  dictionary();
67 
78  dictionary(bool trackinsertionorder);
79 
84  virtual ~dictionary();
85 
106  bool setTrackInsertionOrder(bool trackinsertionorder);
107 
110  bool getTrackInsertionOrder();
111 
115  void setValue(keytype key, valuetype value);
116 
122  void setValues(keytype *keys, valuetype *values);
123  void setValues(keytype const *keys, valuetype const *values);
124 
130  void setValues(keytype *keys, valuetype *values,
131  uint64_t count);
132  void setValues(keytype const *keys, valuetype const *values,
133  uint64_t count);
134 
140 
144  bool getValue(keytype key, valuetype *value);
145 
149 
154  valuetype getValue(keytype key);
155 
159  bool remove(keytype key);
160 
165  bool removeAndDelete(keytype key);
166 
172  bool removeAndArrayDelete(keytype key);
173 
178  bool removeAndDeleteKey(keytype key);
179 
185  bool removeAndArrayDeleteKey(keytype key);
186 
191  bool removeAndDeleteValue(keytype key);
192 
198  bool removeAndArrayDeleteValue(keytype key);
199 
203  bool removeAndDeleteKeyAndArrayDeleteValue(keytype key);
204 
208  bool removeAndArrayDeleteKeyAndDeleteValue(keytype key);
209 
213 
218  bool removeAndDelete(
220 
228 
233  bool removeAndDeleteKey(
235 
243 
250 
258 
264 
270 
277 
280 
283 
287  void clear();
288 
292  void clearAndDelete();
293 
297  void clearAndArrayDelete();
298 
302  void clearAndDeleteKeys();
303 
308 
312  void clearAndDeleteValues();
313 
318 
323 
328 
330  void print();
331 
332  #include <rudiments/private/dictionary.h>
333 };
334 
335 
336 // ideally I'd use typdefs for these but older compilers can't handle them
337 #define namevaluepairsnode dictionarynode< char *, char * >
338 #define namevaluepairs dictionary< char *, char * >
339 #define constnamevaluepairsnode dictionarynode< const char *, const char * >
340 #define constnamevaluepairs dictionary< const char *, const char * >
341 
342 #include <rudiments/private/dictionaryinlines.h>
343 
344 #endif
void print() const
linkedlist< keytype > * getKeys()
valuetype getValue() const
void clear()
Definition: avltree.h:77
void clearAndDeleteKeysAndArrayDeleteValues()
void clearAndDeleteKeys()
void setValues(keytype *keys, valuetype *values)
void setValue(valuetype value)
Definition: linkedlist.h:60
Definition: dictionary.h:12
bool getValue(keytype key, valuetype *value)
void clearAndArrayDelete()
virtual ~dictionarynode()
bool removeAndDeleteKeyAndArrayDeleteValue(keytype key)
bool removeAndArrayDeleteKey(keytype key)
Definition: dictionary.h:63
linkedlist< dictionarynode< keytype, valuetype > * > * getList()
bool remove(keytype key)
int32_t compare(keytype testkey) const
void clearAndArrayDeleteKeys()
bool removeAndArrayDelete(keytype key)
void setKey(keytype key)
void print()
void setValue(keytype key, valuetype value)
void clearAndDelete()
avltree< dictionarynode< keytype, valuetype > * > * getTree()
bool setTrackInsertionOrder(bool trackinsertionorder)
bool getTrackInsertionOrder()
bool removeAndArrayDeleteValue(keytype key)
bool removeAndDelete(keytype key)
bool removeAndDeleteValue(keytype key)
dictionarynode(keytype key, valuetype value)
void clearAndDeleteValues()
bool removeAndArrayDeleteKeyAndDeleteValue(keytype key)
keytype getKey() const
dictionarynode< keytype, valuetype > * getNode(keytype key)
void clearAndArrayDeleteKeysAndDeleteValues()
bool removeAndDeleteKey(keytype key)
virtual ~dictionary()
void clearAndArrayDeleteValues()