1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
// Copyright 2008 Dolphin Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <algorithm>
#include <list>
#include <map>
#include <string>
#include <string_view>
#include <vector>
#include "Common/CommonTypes.h"
#include "Common/StringUtil.h"
namespace Common
{
class IniFile
{
public:
class Section
{
friend class IniFile;
public:
Section();
explicit Section(std::string name_);
bool Exists(std::string_view key) const;
bool Delete(std::string_view key);
void Set(const std::string& key, std::string new_value);
template <typename T>
void Set(const std::string& key, T&& new_value)
{
Set(key, ValueToString(std::forward<T>(new_value)));
}
template <typename T>
void Set(const std::string& key, T&& new_value, const std::common_type_t<T>& default_value)
{
if (new_value != default_value)
Set(key, std::forward<T>(new_value));
else
Delete(key);
}
bool Get(std::string_view key, std::string* value,
const std::string& default_value = NULL_STRING) const;
template <typename T>
bool Get(std::string_view key, T* value, const std::common_type_t<T>& default_value = {}) const
{
std::string temp;
bool retval = Get(key, &temp);
if (retval && TryParse(temp, value))
return true;
*value = default_value;
return false;
}
void SetLines(std::vector<std::string> lines);
bool GetLines(std::vector<std::string>* lines, const bool remove_comments = true) const;
bool operator<(const Section& other) const { return name < other.name; }
using SectionMap = std::map<std::string, std::string, CaseInsensitiveLess>;
const std::string& GetName() const { return name; }
const SectionMap& GetValues() const { return values; }
bool HasLines() const { return !m_lines.empty(); }
protected:
std::string name;
std::vector<std::string> keys_order;
SectionMap values;
std::vector<std::string> m_lines;
};
IniFile();
~IniFile();
/**
* Loads sections and keys.
* @param filename filename of the ini file which should be loaded
* @param keep_current_data If true, "extends" the currently loaded list of sections and keys with
* the loaded data (and replaces existing entries). If false, existing data will be erased.
* @warning Using any other operations than "Get*" and "Exists" is untested and will behave
* unexpectedly
* @todo This really is just a hack to support having two levels of gameinis (defaults and
* user-specified) and should eventually be replaced with a less stupid system.
*/
bool Load(const std::string& filename, bool keep_current_data = false);
bool Save(const std::string& filename);
bool Exists(std::string_view section_name) const;
// Returns true if key exists in section
bool Exists(std::string_view section_name, std::string_view key) const;
template <typename T>
bool GetIfExists(std::string_view section_name, std::string_view key, T* value)
{
if (Exists(section_name, key))
return GetOrCreateSection(section_name)->Get(key, value);
return false;
}
template <typename T>
bool GetIfExists(std::string_view section_name, std::string_view key, T* value, T default_value)
{
if (Exists(section_name, key))
return GetOrCreateSection(section_name)->Get(key, value, default_value);
*value = default_value;
return false;
}
bool GetKeys(std::string_view section_name, std::vector<std::string>* keys) const;
void SetLines(std::string_view section_name, std::vector<std::string> lines);
bool GetLines(std::string_view section_name, std::vector<std::string>* lines,
bool remove_comments = true) const;
bool DeleteKey(std::string_view section_name, std::string_view key);
bool DeleteSection(std::string_view section_name);
void SortSections();
Section* GetOrCreateSection(std::string_view section_name);
const Section* GetSection(std::string_view section_name) const;
Section* GetSection(std::string_view section_name);
// This function is related to parsing data from lines of INI files
// It's used outside of IniFile, which is why it is exposed publicly
// In particular it is used in PostProcessing for its configuration
static void ParseLine(std::string_view line, std::string* keyOut, std::string* valueOut);
const std::list<Section>& GetSections() const { return sections; }
private:
std::list<Section> sections;
static const std::string& NULL_STRING;
};
} // namespace Common
|