2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* config_file.cpp */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2017-01-01 22:01:57 +01:00
|
|
|
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
|
2017-04-08 00:11:42 +02:00
|
|
|
/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* 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 "config_file.h"
|
|
|
|
#include "os/file_access.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "os/keyboard.h"
|
2015-12-31 04:31:00 +01:00
|
|
|
#include "variant_parser.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-01-11 04:52:51 +01:00
|
|
|
PoolStringArray ConfigFile::_get_sections() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
List<String> s;
|
|
|
|
get_sections(&s);
|
2017-01-11 04:52:51 +01:00
|
|
|
PoolStringArray arr;
|
2014-02-10 02:10:30 +01:00
|
|
|
arr.resize(s.size());
|
2017-03-05 16:44:50 +01:00
|
|
|
int idx = 0;
|
|
|
|
for (const List<String>::Element *E = s.front(); E; E = E->next()) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
arr.set(idx++, E->get());
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return arr;
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
PoolStringArray ConfigFile::_get_section_keys(const String &p_section) const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
List<String> s;
|
2017-03-05 16:44:50 +01:00
|
|
|
get_section_keys(p_section, &s);
|
2017-01-11 04:52:51 +01:00
|
|
|
PoolStringArray arr;
|
2014-02-10 02:10:30 +01:00
|
|
|
arr.resize(s.size());
|
2017-03-05 16:44:50 +01:00
|
|
|
int idx = 0;
|
|
|
|
for (const List<String>::Element *E = s.front(); E; E = E->next()) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
arr.set(idx++, E->get());
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return arr;
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void ConfigFile::set_value(const String &p_section, const String &p_key, const Variant &p_value) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
if (p_value.get_type() == Variant::NIL) {
|
2014-02-10 02:10:30 +01:00
|
|
|
//erase
|
|
|
|
if (!values.has(p_section))
|
|
|
|
return; // ?
|
|
|
|
values[p_section].erase(p_key);
|
|
|
|
if (values[p_section].empty()) {
|
|
|
|
values.erase(p_section);
|
|
|
|
}
|
|
|
|
|
|
|
|
} else {
|
|
|
|
if (!values.has(p_section)) {
|
2017-11-03 14:33:19 +01:00
|
|
|
values[p_section] = OrderedHashMap<String, Variant>();
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
values[p_section][p_key] = p_value;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
Variant ConfigFile::get_value(const String &p_section, const String &p_key, Variant p_default) const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-21 12:32:44 +01:00
|
|
|
if (!values.has(p_section) || !values[p_section].has(p_key)) {
|
|
|
|
if (p_default.get_type() == Variant::NIL) {
|
|
|
|
ERR_EXPLAIN("Couldn't find the given section/key and no default was given");
|
|
|
|
ERR_FAIL_V(p_default);
|
|
|
|
}
|
|
|
|
return p_default;
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
return values[p_section][p_key];
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
bool ConfigFile::has_section(const String &p_section) const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
return values.has(p_section);
|
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
bool ConfigFile::has_section_key(const String &p_section, const String &p_key) const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
if (!values.has(p_section))
|
|
|
|
return false;
|
|
|
|
return values[p_section].has(p_key);
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void ConfigFile::get_sections(List<String> *r_sections) const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-11-04 14:08:21 +01:00
|
|
|
for (OrderedHashMap<String, OrderedHashMap<String, Variant> >::ConstElement E = values.front(); E; E = E.next()) {
|
|
|
|
r_sections->push_back(E.key());
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
void ConfigFile::get_section_keys(const String &p_section, List<String> *r_keys) const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
ERR_FAIL_COND(!values.has(p_section));
|
|
|
|
|
2017-11-03 14:33:19 +01:00
|
|
|
for (OrderedHashMap<String, Variant>::ConstElement E = values[p_section].front(); E; E = E.next()) {
|
|
|
|
r_keys->push_back(E.key());
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void ConfigFile::erase_section(const String &p_section) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-02-01 13:45:45 +01:00
|
|
|
values.erase(p_section);
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Error ConfigFile::save(const String &p_path) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
Error err;
|
2017-03-05 16:44:50 +01:00
|
|
|
FileAccess *file = FileAccess::open(p_path, FileAccess::WRITE, &err);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
if (err) {
|
2016-01-10 13:59:14 +01:00
|
|
|
if (file)
|
|
|
|
memdelete(file);
|
2014-02-10 02:10:30 +01:00
|
|
|
return err;
|
|
|
|
}
|
|
|
|
|
2017-11-04 14:08:21 +01:00
|
|
|
for (OrderedHashMap<String, OrderedHashMap<String, Variant> >::Element E = values.front(); E; E = E.next()) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
if (E != values.front())
|
2014-02-10 02:10:30 +01:00
|
|
|
file->store_string("\n");
|
2017-11-04 14:08:21 +01:00
|
|
|
file->store_string("[" + E.key() + "]\n\n");
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-11-04 14:08:21 +01:00
|
|
|
for (OrderedHashMap<String, Variant>::Element F = E.get().front(); F; F = F.next()) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-12-31 04:31:00 +01:00
|
|
|
String vstr;
|
2017-11-03 14:33:19 +01:00
|
|
|
VariantWriter::write_to_string(F.get(), vstr);
|
|
|
|
file->store_string(F.key() + "=" + vstr + "\n");
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
memdelete(file);
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Error ConfigFile::load(const String &p_path) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
Error err;
|
2017-03-05 16:44:50 +01:00
|
|
|
FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-12-31 04:31:00 +01:00
|
|
|
if (!f)
|
|
|
|
return ERR_CANT_OPEN;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-12-31 04:31:00 +01:00
|
|
|
VariantParser::StreamFile stream;
|
2017-03-05 16:44:50 +01:00
|
|
|
stream.f = f;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-12-31 04:31:00 +01:00
|
|
|
String assign;
|
|
|
|
Variant value;
|
|
|
|
VariantParser::Tag next_tag;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
int lines = 0;
|
2015-12-31 04:31:00 +01:00
|
|
|
String error_text;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-12-31 04:31:00 +01:00
|
|
|
String section;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
while (true) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
assign = Variant();
|
2016-01-07 13:04:44 +01:00
|
|
|
next_tag.fields.clear();
|
2017-03-05 16:44:50 +01:00
|
|
|
next_tag.name = String();
|
2016-01-07 13:04:44 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
err = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, NULL, true);
|
|
|
|
if (err == ERR_FILE_EOF) {
|
2016-01-10 14:00:58 +01:00
|
|
|
memdelete(f);
|
2015-12-31 04:31:00 +01:00
|
|
|
return OK;
|
2017-03-05 16:44:50 +01:00
|
|
|
} else if (err != OK) {
|
|
|
|
ERR_PRINTS("ConfgFile::load - " + p_path + ":" + itos(lines) + " error: " + error_text);
|
2015-12-31 04:31:00 +01:00
|
|
|
memdelete(f);
|
|
|
|
return err;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
if (assign != String()) {
|
|
|
|
set_value(section, assign, value);
|
|
|
|
} else if (next_tag.name != String()) {
|
|
|
|
section = next_tag.name;
|
2015-12-31 04:31:00 +01:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
memdelete(f);
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void ConfigFile::_bind_methods() {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_value", "section", "key", "value"), &ConfigFile::set_value);
|
2017-08-09 13:19:41 +02:00
|
|
|
ClassDB::bind_method(D_METHOD("get_value", "section", "key", "default"), &ConfigFile::get_value, DEFVAL(Variant()));
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("has_section", "section"), &ConfigFile::has_section);
|
|
|
|
ClassDB::bind_method(D_METHOD("has_section_key", "section", "key"), &ConfigFile::has_section_key);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("get_sections"), &ConfigFile::_get_sections);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_section_keys", "section"), &ConfigFile::_get_section_keys);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("erase_section", "section"), &ConfigFile::erase_section);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-08-09 13:19:41 +02:00
|
|
|
ClassDB::bind_method(D_METHOD("load", "path"), &ConfigFile::load);
|
|
|
|
ClassDB::bind_method(D_METHOD("save", "path"), &ConfigFile::save);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ConfigFile::ConfigFile() {
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|