godot/core/variant/dictionary.cpp

/**************************************************************************/
/*  dictionary.cpp                                                        */
/**************************************************************************/
/*                         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.                 */
/**************************************************************************/

#include "dictionary.h"

#include "core/templates/hash_map.h"
#include "core/templates/safe_refcount.h"
#include "core/variant/container_type_validate.h"
#include "core/variant/variant.h"
// required in this order by VariantInternal, do not remove this comment.
#include "core/object/class_db.h"
#include "core/object/object.h"
#include "core/variant/type_info.h"
#include "core/variant/variant_internal.h"

struct DictionaryPrivate { … };

void Dictionary::get_key_list(List<Variant> *p_keys) const { … }

Variant Dictionary::get_key_at_index(int p_index) const { … }

Variant Dictionary::get_value_at_index(int p_index) const { … }

// WARNING: This operator does not validate the value type. For scripting/extensions this is
// done in `variant_setget.cpp`. Consider using `set()` if the data might be invalid.
Variant &Dictionary::operator[](const Variant &p_key) { … }

const Variant &Dictionary::operator[](const Variant &p_key) const { … }

const Variant *Dictionary::getptr(const Variant &p_key) const { … }

// WARNING: This method does not validate the value type.
Variant *Dictionary::getptr(const Variant &p_key) { … }

Variant Dictionary::get_valid(const Variant &p_key) const { … }

Variant Dictionary::get(const Variant &p_key, const Variant &p_default) const { … }

Variant Dictionary::get_or_add(const Variant &p_key, const Variant &p_default) { … }

bool Dictionary::set(const Variant &p_key, const Variant &p_value) { … }

int Dictionary::size() const { … }

bool Dictionary::is_empty() const { … }

bool Dictionary::has(const Variant &p_key) const { … }

bool Dictionary::has_all(const Array &p_keys) const { … }

Variant Dictionary::find_key(const Variant &p_value) const { … }

bool Dictionary::erase(const Variant &p_key) { … }

bool Dictionary::operator==(const Dictionary &p_dictionary) const { … }

bool Dictionary::operator!=(const Dictionary &p_dictionary) const { … }

bool Dictionary::recursive_equal(const Dictionary &p_dictionary, int recursion_count) const { … }

void Dictionary::_ref(const Dictionary &p_from) const { … }

void Dictionary::clear() { … }

void Dictionary::sort() { … }

void Dictionary::merge(const Dictionary &p_dictionary, bool p_overwrite) { … }

Dictionary Dictionary::merged(const Dictionary &p_dictionary, bool p_overwrite) const { … }

void Dictionary::_unref() const { … }

uint32_t Dictionary::hash() const { … }

uint32_t Dictionary::recursive_hash(int recursion_count) const { … }

Array Dictionary::keys() const { … }

Array Dictionary::values() const { … }

void Dictionary::assign(const Dictionary &p_dictionary) { … }

const Variant *Dictionary::next(const Variant *p_key) const { … }

Dictionary Dictionary::duplicate(bool p_deep) const { … }

void Dictionary::make_read_only() { … }
bool Dictionary::is_read_only() const { … }

Dictionary Dictionary::recursive_duplicate(bool p_deep, int recursion_count) const { … }

void Dictionary::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) { … }

bool Dictionary::is_typed() const { … }

bool Dictionary::is_typed_key() const { … }

bool Dictionary::is_typed_value() const { … }

bool Dictionary::is_same_typed(const Dictionary &p_other) const { … }

bool Dictionary::is_same_typed_key(const Dictionary &p_other) const { … }

bool Dictionary::is_same_typed_value(const Dictionary &p_other) const { … }

uint32_t Dictionary::get_typed_key_builtin() const { … }

uint32_t Dictionary::get_typed_value_builtin() const { … }

StringName Dictionary::get_typed_key_class_name() const { … }

StringName Dictionary::get_typed_value_class_name() const { … }

Variant Dictionary::get_typed_key_script() const { … }

Variant Dictionary::get_typed_value_script() const { … }

void Dictionary::operator=(const Dictionary &p_dictionary) { … }

const void *Dictionary::id() const { … }

Dictionary::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) { … }

Dictionary::Dictionary(const Dictionary &p_from) { … }

Dictionary::Dictionary() { … }

Dictionary::Dictionary(std::initializer_list<KeyValue<Variant, Variant>> p_init) { … }

Dictionary::~Dictionary() { … }