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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
|
// Copyright 2008 Dolphin Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#include "Common/IniFile.h"
#include <algorithm>
#include <cstddef>
#include <fstream>
#include <map>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "Common/FileUtil.h"
#include "Common/StringUtil.h"
namespace Common
{
void IniFile::ParseLine(std::string_view line, std::string* keyOut, std::string* valueOut)
{
if (line.empty() || line.front() == '#')
return;
size_t firstEquals = line.find('=');
if (firstEquals != std::string::npos)
{
// Yes, a valid line!
*keyOut = StripWhitespace(line.substr(0, firstEquals));
if (valueOut)
{
*valueOut = StripQuotes(StripWhitespace(line.substr(firstEquals + 1, std::string::npos)));
}
}
}
const std::string& IniFile::NULL_STRING = "";
IniFile::Section::Section() = default;
IniFile::Section::Section(std::string name_) : name{std::move(name_)}
{
}
void IniFile::Section::Set(const std::string& key, std::string new_value)
{
const auto result = values.insert_or_assign(key, std::move(new_value));
const bool insertion_occurred = result.second;
if (insertion_occurred)
keys_order.push_back(key);
}
bool IniFile::Section::Get(std::string_view key, std::string* value,
const std::string& default_value) const
{
const auto it = values.find(key);
if (it != values.end())
{
*value = it->second;
return true;
}
if (&default_value != &NULL_STRING)
{
*value = default_value;
return true;
}
return false;
}
bool IniFile::Section::Exists(std::string_view key) const
{
return values.contains(key);
}
bool IniFile::Section::Delete(std::string_view key)
{
const auto it = values.find(key);
if (it == values.end())
return false;
values.erase(it);
keys_order.erase(std::ranges::find_if(
keys_order, [&](std::string_view v) { return CaseInsensitiveEquals(key, v); }));
return true;
}
void IniFile::Section::SetLines(std::vector<std::string> lines)
{
m_lines = std::move(lines);
}
bool IniFile::Section::GetLines(std::vector<std::string>* lines, const bool remove_comments) const
{
for (const std::string& line : m_lines)
{
std::string_view stripped_line = StripWhitespace(line);
if (remove_comments)
{
size_t commentPos = stripped_line.find('#');
if (commentPos == 0)
{
continue;
}
if (commentPos != std::string::npos)
{
stripped_line = StripWhitespace(stripped_line.substr(0, commentPos));
}
}
lines->emplace_back(stripped_line);
}
return true;
}
// IniFile
IniFile::IniFile() = default;
IniFile::~IniFile() = default;
const IniFile::Section* IniFile::GetSection(std::string_view section_name) const
{
for (const Section& sect : sections)
{
if (CaseInsensitiveEquals(sect.name, section_name))
return §
}
return nullptr;
}
IniFile::Section* IniFile::GetSection(std::string_view section_name)
{
for (Section& sect : sections)
{
if (CaseInsensitiveEquals(sect.name, section_name))
return §
}
return nullptr;
}
IniFile::Section* IniFile::GetOrCreateSection(std::string_view section_name)
{
Section* section = GetSection(section_name);
if (!section)
{
sections.emplace_back(std::string(section_name));
section = §ions.back();
}
return section;
}
bool IniFile::DeleteSection(std::string_view section_name)
{
Section* s = GetSection(section_name);
if (!s)
return false;
for (auto iter = sections.begin(); iter != sections.end(); ++iter)
{
if (&(*iter) == s)
{
sections.erase(iter);
return true;
}
}
return false;
}
bool IniFile::Exists(std::string_view section_name) const
{
return GetSection(section_name) != nullptr;
}
bool IniFile::Exists(std::string_view section_name, std::string_view key) const
{
const Section* section = GetSection(section_name);
if (!section)
return false;
return section->Exists(key);
}
void IniFile::SetLines(std::string_view section_name, std::vector<std::string> lines)
{
Section* section = GetOrCreateSection(section_name);
section->SetLines(std::move(lines));
}
bool IniFile::DeleteKey(std::string_view section_name, std::string_view key)
{
Section* section = GetSection(section_name);
if (!section)
return false;
return section->Delete(key);
}
// Return a list of all keys in a section
bool IniFile::GetKeys(std::string_view section_name, std::vector<std::string>* keys) const
{
const Section* section = GetSection(section_name);
if (!section)
{
return false;
}
*keys = section->keys_order;
return true;
}
// Return a list of all lines in a section
bool IniFile::GetLines(std::string_view section_name, std::vector<std::string>* lines,
const bool remove_comments) const
{
lines->clear();
const Section* section = GetSection(section_name);
if (!section)
return false;
return section->GetLines(lines, remove_comments);
}
void IniFile::SortSections()
{
sections.sort();
}
bool IniFile::Load(const std::string& filename, bool keep_current_data)
{
if (!keep_current_data)
sections.clear();
// first section consists of the comments before the first real section
// Open file
std::ifstream in;
File::OpenFStream(in, filename, std::ios::in);
if (in.fail())
return false;
Section* current_section = nullptr;
bool first_line = true;
while (!in.eof())
{
std::string line_str;
if (!std::getline(in, line_str))
{
if (in.eof())
return true;
else
return false;
}
std::string_view line = line_str;
// Skips the UTF-8 BOM at the start of files. Notepad likes to add this.
if (first_line && line.substr(0, 3) == "\xEF\xBB\xBF")
line.remove_prefix(3);
first_line = false;
#ifndef _WIN32
// Check for CRLF eol and convert it to LF
if (!line.empty() && line.back() == '\r')
line.remove_suffix(1);
#endif
if (!line.empty())
{
if (line[0] == '[')
{
size_t endpos = line.find(']');
if (endpos != std::string::npos)
{
// New section!
std::string_view sub = line.substr(1, endpos - 1);
current_section = GetOrCreateSection(sub);
}
}
else
{
if (current_section)
{
std::string key, value;
ParseLine(line, &key, &value);
// Lines starting with '$', '*' or '+' are kept verbatim.
// Kind of a hack, but the support for raw lines inside an
// INI is a hack anyway.
if ((key.empty() && value.empty()) ||
(!line.empty() && (line[0] == '$' || line[0] == '+' || line[0] == '*')))
{
current_section->m_lines.emplace_back(line);
}
else
{
current_section->Set(key, value);
}
}
}
}
}
in.close();
return true;
}
bool IniFile::Save(const std::string& filename)
{
std::ofstream out;
std::string temp = File::GetTempFilenameForAtomicWrite(filename);
File::OpenFStream(out, temp, std::ios::out);
if (out.fail())
{
return false;
}
for (const Section& section : sections)
{
if (!section.keys_order.empty() || !section.m_lines.empty())
out << '[' << section.name << ']' << std::endl;
if (section.keys_order.empty())
{
for (const std::string& s : section.m_lines)
out << s << std::endl;
}
else
{
for (const std::string& kvit : section.keys_order)
{
auto pair = section.values.find(kvit);
out << pair->first << " = " << pair->second << std::endl;
}
}
}
out.close();
return File::RenameSync(temp, filename);
}
// Unit test. TODO: Move to the real unit test framework.
/*
int main()
{
IniFile ini;
ini.Load("my.ini");
ini.Set("Hello", "A", "amaskdfl");
ini.Set("Moss", "A", "amaskdfl");
ini.Set("Aissa", "A", "amaskdfl");
//ini.Read("my.ini");
std::string x;
ini.Get("Hello", "B", &x, "boo");
ini.DeleteKey("Moss", "A");
ini.DeleteSection("Moss");
ini.SortSections();
ini.Save("my.ini");
//UpdateVars(ini);
return 0;
}
*/
} // namespace Common
|