godot/core/io/config_file.h

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

83 lines
3.9 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* config_file.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 01:10:30 +00:00
#ifndef CONFIG_FILE_H
#define CONFIG_FILE_H
#include "core/io/file_access.h"
2021-06-04 16:03:15 +00:00
#include "core/object/ref_counted.h"
#include "core/templates/hash_map.h"
#include "core/variant/variant_parser.h"
2014-02-10 01:10:30 +00:00
2021-06-04 16:03:15 +00:00
class ConfigFile : public RefCounted {
GDCLASS(ConfigFile, RefCounted);
2014-02-10 01:10:30 +00:00
HashMap<String, HashMap<String, Variant>> values;
2014-02-10 01:10:30 +00:00
PackedStringArray _get_sections() const;
PackedStringArray _get_section_keys(const String &p_section) const;
Error _internal_load(const String &p_path, Ref<FileAccess> f);
Error _internal_save(Ref<FileAccess> file);
2014-02-10 01:10:30 +00:00
2020-02-10 08:19:00 +00:00
Error _parse(const String &p_path, VariantParser::Stream *p_stream);
2014-02-10 01:10:30 +00:00
protected:
static void _bind_methods();
public:
void set_value(const String &p_section, const String &p_key, const Variant &p_value);
Variant get_value(const String &p_section, const String &p_key, const Variant &p_default = Variant()) const;
2014-02-10 01:10:30 +00:00
bool has_section(const String &p_section) const;
bool has_section_key(const String &p_section, const String &p_key) const;
void get_sections(List<String> *r_sections) const;
void get_section_keys(const String &p_section, List<String> *r_keys) const;
void erase_section(const String &p_section);
void erase_section_key(const String &p_section, const String &p_key);
2014-02-10 01:10:30 +00:00
Error save(const String &p_path);
Error load(const String &p_path);
2020-02-10 08:19:00 +00:00
Error parse(const String &p_data);
2014-02-10 01:10:30 +00:00
String encode_to_text() const; // used by exporter
void clear();
Error load_encrypted(const String &p_path, const Vector<uint8_t> &p_key);
Error load_encrypted_pass(const String &p_path, const String &p_pass);
Error save_encrypted(const String &p_path, const Vector<uint8_t> &p_key);
Error save_encrypted_pass(const String &p_path, const String &p_pass);
2014-02-10 01:10:30 +00:00
};
#endif // CONFIG_FILE_H