godot/core/variant/dictionary.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

128 lines
5.4 KiB
C++
Raw Normal View History

2014-02-10 09:10:30 +08:00
/**************************************************************************/
/* dictionary.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
2014-02-10 09:10:30 +08:00
#ifndef DICTIONARY_H
#define DICTIONARY_H
#include "core/string/ustring.h"
#include "core/templates/list.h"
#include "core/templates/pair.h"
#include "core/variant/array.h"
2014-02-10 09:10:30 +08:00
class Variant;
struct ContainerType;
2014-02-10 09:10:30 +08:00
struct DictionaryPrivate;
class Dictionary {
mutable DictionaryPrivate *_p;
void _ref(const Dictionary &p_from) const;
void _unref() const;
public:
2014-02-10 09:10:30 +08:00
void get_key_list(List<Variant> *p_keys) const;
Variant get_key_at_index(int p_index) const;
Variant get_value_at_index(int p_index) const;
2014-02-10 09:10:30 +08:00
Variant &operator[](const Variant &p_key);
const Variant &operator[](const Variant &p_key) const;
const Variant *getptr(const Variant &p_key) const;
Variant *getptr(const Variant &p_key);
Variant get_valid(const Variant &p_key) const;
Variant get(const Variant &p_key, const Variant &p_default) const;
Variant get_or_add(const Variant &p_key, const Variant &p_default);
bool set(const Variant &p_key, const Variant &p_value);
2014-02-10 09:10:30 +08:00
int size() const;
2020-12-15 20:04:21 +08:00
bool is_empty() const;
2014-02-10 09:10:30 +08:00
void clear();
void sort();
2022-04-05 00:46:55 +08:00
void merge(const Dictionary &p_dictionary, bool p_overwrite = false);
Dictionary merged(const Dictionary &p_dictionary, bool p_overwrite = false) const;
2014-02-10 09:10:30 +08:00
bool has(const Variant &p_key) const;
2016-04-05 00:37:43 +08:00
bool has_all(const Array &p_keys) const;
2022-08-06 01:08:27 +08:00
Variant find_key(const Variant &p_value) const;
2016-04-05 00:37:43 +08:00
bool erase(const Variant &p_key);
2014-02-10 09:10:30 +08:00
bool operator==(const Dictionary &p_dictionary) const;
bool operator!=(const Dictionary &p_dictionary) const;
bool recursive_equal(const Dictionary &p_dictionary, int recursion_count) const;
2014-02-10 09:10:30 +08:00
uint32_t hash() const;
uint32_t recursive_hash(int recursion_count) const;
2014-02-10 09:10:30 +08:00
void operator=(const Dictionary &p_dictionary);
2023-06-25 02:03:28 +08:00
void assign(const Dictionary &p_dictionary);
2020-04-02 07:20:12 +08:00
const Variant *next(const Variant *p_key = nullptr) const;
2014-02-10 09:10:30 +08:00
Array keys() const;
2016-06-05 20:20:52 +08:00
Array values() const;
2014-02-10 09:10:30 +08:00
Dictionary duplicate(bool p_deep = false) const;
Dictionary recursive_duplicate(bool p_deep, int recursion_count) const;
void set_typed(const ContainerType &p_key_type, const ContainerType &p_value_type);
2023-06-25 02:03:28 +08:00
void set_typed(uint32_t p_key_type, const StringName &p_key_class_name, const Variant &p_key_script, uint32_t p_value_type, const StringName &p_value_class_name, const Variant &p_value_script);
2023-06-25 02:03:28 +08:00
bool is_typed() const;
bool is_typed_key() const;
bool is_typed_value() const;
bool is_same_typed(const Dictionary &p_other) const;
bool is_same_typed_key(const Dictionary &p_other) const;
bool is_same_typed_value(const Dictionary &p_other) const;
ContainerType get_key_type() const;
ContainerType get_value_type() const;
2023-06-25 02:03:28 +08:00
uint32_t get_typed_key_builtin() const;
uint32_t get_typed_value_builtin() const;
StringName get_typed_key_class_name() const;
StringName get_typed_value_class_name() const;
Variant get_typed_key_script() const;
Variant get_typed_value_script() const;
void make_read_only();
bool is_read_only() const;
const void *id() const;
2023-06-25 02:03:28 +08:00
Dictionary(const Dictionary &p_base, uint32_t p_key_type, const StringName &p_key_class_name, const Variant &p_key_script, uint32_t p_value_type, const StringName &p_value_class_name, const Variant &p_value_script);
2014-02-10 09:10:30 +08:00
Dictionary(const Dictionary &p_from);
Dictionary(std::initializer_list<KeyValue<Variant, Variant>> p_init);
Dictionary();
2014-02-10 09:10:30 +08:00
~Dictionary();
};
#endif // DICTIONARY_H