1/**************************************************************************/
2/* dictionary.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
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/string/ustring.h"
35#include "core/templates/list.h"
36#include "core/variant/array.h"
37
38class Variant;
39
40struct DictionaryPrivate;
41
42class Dictionary {
43 mutable DictionaryPrivate *_p;
44
45 void _ref(const Dictionary &p_from) const;
46 void _unref() const;
47
48public:
49 void get_key_list(List<Variant> *p_keys) const;
50 Variant get_key_at_index(int p_index) const;
51 Variant get_value_at_index(int p_index) const;
52
53 Variant &operator[](const Variant &p_key);
54 const Variant &operator[](const Variant &p_key) const;
55
56 const Variant *getptr(const Variant &p_key) const;
57 Variant *getptr(const Variant &p_key);
58
59 Variant get_valid(const Variant &p_key) const;
60 Variant get(const Variant &p_key, const Variant &p_default) const;
61
62 int size() const;
63 bool is_empty() const;
64 void clear();
65 void merge(const Dictionary &p_dictionary, bool p_overwrite = false);
66
67 bool has(const Variant &p_key) const;
68 bool has_all(const Array &p_keys) const;
69 Variant find_key(const Variant &p_value) const;
70
71 bool erase(const Variant &p_key);
72
73 bool operator==(const Dictionary &p_dictionary) const;
74 bool operator!=(const Dictionary &p_dictionary) const;
75 bool recursive_equal(const Dictionary &p_dictionary, int recursion_count) const;
76
77 uint32_t hash() const;
78 uint32_t recursive_hash(int recursion_count) const;
79 void operator=(const Dictionary &p_dictionary);
80
81 const Variant *next(const Variant *p_key = nullptr) const;
82
83 Array keys() const;
84 Array values() const;
85
86 Dictionary duplicate(bool p_deep = false) const;
87 Dictionary recursive_duplicate(bool p_deep, int recursion_count) const;
88
89 void make_read_only();
90 bool is_read_only() const;
91
92 const void *id() const;
93
94 Dictionary(const Dictionary &p_from);
95 Dictionary();
96 ~Dictionary();
97};
98
99#endif // DICTIONARY_H
100