1 /*************************************************************************/ 2 /* dictionary.h */ 3 /*************************************************************************/ 4 /* This file is part of: */ 5 /* GODOT ENGINE */ 6 /* https://godotengine.org */ 7 /*************************************************************************/ 8 /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */ 9 /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */ 10 /* */ 11 /* Permission is hereby granted, free of charge, to any person obtaining */ 12 /* a copy of this software and associated documentation files (the */ 13 /* "Software"), to deal in the Software without restriction, including */ 14 /* without limitation the rights to use, copy, modify, merge, publish, */ 15 /* distribute, sublicense, and/or sell copies of the Software, and to */ 16 /* permit persons to whom the Software is furnished to do so, subject to */ 17 /* the following conditions: */ 18 /* */ 19 /* The above copyright notice and this permission notice shall be */ 20 /* included in all copies or substantial portions of the Software. */ 21 /* */ 22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ 23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ 24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ 25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ 26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ 27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ 28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ 29 /*************************************************************************/ 30 31 #ifndef DICTIONARY_H 32 #define DICTIONARY_H 33 34 #include "core/array.h" 35 #include "core/list.h" 36 #include "core/ustring.h" 37 38 class Variant; 39 40 struct DictionaryPrivate; 41 42 class Dictionary { 43 44 mutable DictionaryPrivate *_p; 45 46 void _ref(const Dictionary &p_from) const; 47 void _unref() const; 48 49 public: 50 void get_key_list(List<Variant> *p_keys) const; 51 Variant get_key_at_index(int p_index) const; 52 Variant get_value_at_index(int p_index) const; 53 54 Variant &operator[](const Variant &p_key); 55 const Variant &operator[](const Variant &p_key) const; 56 57 const Variant *getptr(const Variant &p_key) const; 58 Variant *getptr(const Variant &p_key); 59 60 Variant get_valid(const Variant &p_key) const; 61 Variant get(const Variant &p_key, const Variant &p_default) const; 62 63 int size() const; 64 bool empty() const; 65 void clear(); 66 67 bool has(const Variant &p_key) const; 68 bool has_all(const Array &p_keys) const; 69 70 bool erase(const Variant &p_key); 71 72 bool operator==(const Dictionary &p_dictionary) const; 73 bool operator!=(const Dictionary &p_dictionary) const; 74 75 uint32_t hash() const; 76 void operator=(const Dictionary &p_dictionary); 77 78 const Variant *next(const Variant *p_key = NULL) const; 79 80 Array keys() const; 81 Array values() const; 82 83 Dictionary duplicate(bool p_deep = false) const; 84 85 const void *id() const; 86 87 Dictionary(const Dictionary &p_from); 88 Dictionary(); 89 ~Dictionary(); 90 }; 91 92 #endif // DICTIONARY_H 93