1/**************************************************************************/
2/* config_file.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 CONFIG_FILE_H
32#define CONFIG_FILE_H
33
34#include "core/io/file_access.h"
35#include "core/object/ref_counted.h"
36#include "core/templates/hash_map.h"
37#include "core/variant/variant_parser.h"
38
39class ConfigFile : public RefCounted {
40 GDCLASS(ConfigFile, RefCounted);
41
42 HashMap<String, HashMap<String, Variant>> values;
43
44 PackedStringArray _get_sections() const;
45 PackedStringArray _get_section_keys(const String &p_section) const;
46 Error _internal_load(const String &p_path, Ref<FileAccess> f);
47 Error _internal_save(Ref<FileAccess> file);
48
49 Error _parse(const String &p_path, VariantParser::Stream *p_stream);
50
51protected:
52 static void _bind_methods();
53
54public:
55 void set_value(const String &p_section, const String &p_key, const Variant &p_value);
56 Variant get_value(const String &p_section, const String &p_key, Variant p_default = Variant()) const;
57
58 bool has_section(const String &p_section) const;
59 bool has_section_key(const String &p_section, const String &p_key) const;
60
61 void get_sections(List<String> *r_sections) const;
62 void get_section_keys(const String &p_section, List<String> *r_keys) const;
63
64 void erase_section(const String &p_section);
65 void erase_section_key(const String &p_section, const String &p_key);
66
67 Error save(const String &p_path);
68 Error load(const String &p_path);
69 Error parse(const String &p_data);
70
71 String encode_to_text() const; // used by exporter
72
73 void clear();
74
75 Error load_encrypted(const String &p_path, const Vector<uint8_t> &p_key);
76 Error load_encrypted_pass(const String &p_path, const String &p_pass);
77
78 Error save_encrypted(const String &p_path, const Vector<uint8_t> &p_key);
79 Error save_encrypted_pass(const String &p_path, const String &p_pass);
80};
81
82#endif // CONFIG_FILE_H
83