// IniFile // Taken from Dolphin but relicensed by me, Henrik Rydgard, under the MIT // license as I wrote the whole thing originally and it has barely changed. #include #include #ifndef _MSC_VER #include #endif #include #include #include #include #include #include #include "Common/Data/Format/IniFile.h" #include "Common/File/VFS/VFS.h" #include "Common/File/FileUtil.h" #include "Common/Data/Text/Parsers.h" #ifdef _WIN32 #include "Common/Data/Encoding/Utf8.h" #endif #include "Common/StringUtils.h" static bool ParseLineKey(const std::string &line, size_t &pos, std::string *keyOut) { std::string key = ""; while (pos < line.size()) { size_t next = line.find_first_of("=#", pos); if (next == line.npos || next == 0) { // Key never ended or empty, invalid. return false; } else if (line[next] == '#') { if (line[next - 1] != '\\') { // Value commented out before =, so not valid. return false; } // Escaped. key += line.substr(pos, next - pos - 1) + "#"; pos = next + 1; } else if (line[next] == '=') { // Hurray, done. key += line.substr(pos, next - pos); pos = next + 1; break; } } if (keyOut) { *keyOut = StripSpaces(key); } return true; } static bool ParseLineValue(const std::string &line, size_t &pos, std::string *valueOut) { std::string value = ""; std::string strippedLine = StripSpaces(line.substr(pos)); if (strippedLine[0] == '"' && strippedLine[strippedLine.size()-1] == '"') { // Don't remove comment if is surrounded by " " value += line.substr(pos); pos = line.npos; // Won't enter the while below } while (pos < line.size()) { size_t next = line.find('#', pos); if (next == line.npos) { value += line.substr(pos); pos = line.npos; break; } else if (line[next - 1] != '\\') { // It wasn't escaped, so finish before the #. value += line.substr(pos, next - pos); // Include the comment's # in pos. pos = next; break; } else { // Escaped. value += line.substr(pos, next - pos - 1) + "#"; pos = next + 1; } } if (valueOut) { *valueOut = StripQuotes(StripSpaces(value)); } return true; } static bool ParseLineComment(const std::string& line, size_t &pos, std::string *commentOut) { // Don't bother with anything if we don't need the comment data. if (commentOut) { // Include any whitespace/formatting in the comment. size_t commentStartPos = pos; if (commentStartPos != line.npos) { while (commentStartPos > 0 && line[commentStartPos - 1] <= ' ') { --commentStartPos; } *commentOut = line.substr(commentStartPos); } else { // There was no comment. commentOut->clear(); } } pos = line.npos; return true; } // Ugh, this is ugly. static bool ParseLine(const std::string& line, std::string* keyOut, std::string* valueOut, std::string* commentOut) { // Rules: // 1. A line starting with ; is commented out. // 2. A # in a line (and all the space before it) is the comment. // 3. A \# in a line is not part of a comment and becomes # in the value. // 4. Whitespace around values is removed. // 5. Double quotes around values is removed. // 6. Value surrounded by double quotes don't parsed to strip comment. if (line.size() < 2 || line[0] == ';') return false; size_t pos = 0; if (!ParseLineKey(line, pos, keyOut)) return false; if (!ParseLineValue(line, pos, valueOut)) return false; if (!ParseLineComment(line, pos, commentOut)) return false; return true; } static std::string EscapeComments(const std::string &value) { std::string result = ""; for (size_t pos = 0; pos < value.size(); ) { size_t next = value.find('#', pos); if (next == value.npos) { result += value.substr(pos); pos = value.npos; } else { result += value.substr(pos, next - pos) + "\\#"; pos = next + 1; } } return result; } void Section::Clear() { lines.clear(); } std::string* Section::GetLine(const char* key, std::string* valueOut, std::string* commentOut) { for (std::vector::iterator iter = lines.begin(); iter != lines.end(); ++iter) { std::string& line = *iter; std::string lineKey; ParseLine(line, &lineKey, valueOut, commentOut); if (!strcasecmp(lineKey.c_str(), key)) return &line; } return 0; } const std::string* Section::GetLine(const char* key, std::string* valueOut, std::string* commentOut) const { for (std::vector::const_iterator iter = lines.begin(); iter != lines.end(); ++iter) { const std::string& line = *iter; std::string lineKey; ParseLine(line, &lineKey, valueOut, commentOut); if (!strcasecmp(lineKey.c_str(), key)) return &line; } return 0; } void Section::Set(const char* key, uint32_t newValue) { Set(key, StringFromFormat("0x%08x", newValue).c_str()); } void Section::Set(const char* key, uint64_t newValue) { Set(key, StringFromFormat("0x%016lx", newValue).c_str()); } void Section::Set(const char* key, float newValue) { Set(key, StringFromFormat("%f", newValue).c_str()); } void Section::Set(const char* key, double newValue) { Set(key, StringFromFormat("%f", newValue).c_str()); } void Section::Set(const char* key, int newValue) { Set(key, StringFromInt(newValue).c_str()); } void Section::Set(const char* key, const char* newValue) { std::string value, commented; std::string* line = GetLine(key, &value, &commented); if (line) { // Change the value - keep the key and comment *line = StripSpaces(key) + " = " + EscapeComments(newValue) + commented; } else { // The key did not already exist in this section - let's add it. lines.emplace_back(std::string(key) + " = " + EscapeComments(newValue)); } } void Section::Set(const char* key, const std::string& newValue, const std::string& defaultValue) { if (newValue != defaultValue) Set(key, newValue); else Delete(key); } bool Section::Get(const char* key, std::string* value, const char* defaultValue) const { const std::string* line = GetLine(key, value, 0); if (!line) { if (defaultValue) { *value = defaultValue; } return false; } return true; } void Section::Set(const char* key, const float newValue, const float defaultValue) { if (newValue != defaultValue) Set(key, newValue); else Delete(key); } void Section::Set(const char* key, int newValue, int defaultValue) { if (newValue != defaultValue) Set(key, newValue); else Delete(key); } void Section::Set(const char* key, bool newValue, bool defaultValue) { if (newValue != defaultValue) Set(key, newValue); else Delete(key); } void Section::Set(const char* key, const std::vector& newValues) { std::string temp; // Join the strings with , std::vector::const_iterator it; for (it = newValues.begin(); it != newValues.end(); ++it) { temp += (*it) + ","; } // remove last , if (temp.length()) temp.resize(temp.length() - 1); Set(key, temp.c_str()); } void Section::AddComment(const std::string &comment) { lines.emplace_back("# " + comment); } bool Section::Get(const char* key, std::vector& values) const { std::string temp; bool retval = Get(key, &temp, 0); if (!retval || temp.empty()) { return false; } // ignore starting , if any size_t subStart = temp.find_first_not_of(","); size_t subEnd; // split by , while (subStart != std::string::npos) { // Find next , subEnd = temp.find_first_of(",", subStart); if (subStart != subEnd) // take from first char until next , values.push_back(StripSpaces(temp.substr(subStart, subEnd - subStart))); // Find the next non , char subStart = temp.find_first_not_of(",", subEnd); } return true; } bool Section::Get(const char* key, int* value, int defaultValue) const { std::string temp; bool retval = Get(key, &temp, 0); if (retval && TryParse(temp.c_str(), value)) return true; *value = defaultValue; return false; } bool Section::Get(const char* key, uint32_t* value, uint32_t defaultValue) const { std::string temp; bool retval = Get(key, &temp, 0); if (retval && TryParse(temp, value)) return true; *value = defaultValue; return false; } bool Section::Get(const char* key, uint64_t* value, uint64_t defaultValue) const { std::string temp; bool retval = Get(key, &temp, 0); if (retval && TryParse(temp, value)) return true; *value = defaultValue; return false; } bool Section::Get(const char* key, bool* value, bool defaultValue) const { std::string temp; bool retval = Get(key, &temp, 0); if (retval && TryParse(temp.c_str(), value)) return true; *value = defaultValue; return false; } bool Section::Get(const char* key, float* value, float defaultValue) const { std::string temp; bool retval = Get(key, &temp, 0); if (retval && TryParse(temp.c_str(), value)) return true; *value = defaultValue; return false; } bool Section::Get(const char* key, double* value, double defaultValue) const { std::string temp; bool retval = Get(key, &temp, 0); if (retval && TryParse(temp.c_str(), value)) return true; *value = defaultValue; return false; } bool Section::Exists(const char *key) const { for (std::vector::const_iterator iter = lines.begin(); iter != lines.end(); ++iter) { std::string lineKey; ParseLine(*iter, &lineKey, NULL, NULL); if (!strcasecmp(lineKey.c_str(), key)) return true; } return false; } std::map Section::ToMap() const { std::map outMap; for (std::vector::const_iterator iter = lines.begin(); iter != lines.end(); ++iter) { std::string lineKey, lineValue; if (ParseLine(*iter, &lineKey, &lineValue, NULL)) { outMap[lineKey] = lineValue; } } return outMap; } bool Section::Delete(const char *key) { std::string* line = GetLine(key, 0, 0); for (std::vector::iterator liter = lines.begin(); liter != lines.end(); ++liter) { if (line == &*liter) { lines.erase(liter); return true; } } return false; } // IniFile const Section* IniFile::GetSection(const char* sectionName) const { for (std::vector
::const_iterator iter = sections.begin(); iter != sections.end(); ++iter) if (!strcasecmp(iter->name().c_str(), sectionName)) return (&(*iter)); return 0; } Section* IniFile::GetSection(const char* sectionName) { for (std::vector
::iterator iter = sections.begin(); iter != sections.end(); ++iter) if (!strcasecmp(iter->name().c_str(), sectionName)) return (&(*iter)); return 0; } Section* IniFile::GetOrCreateSection(const char* sectionName) { Section* section = GetSection(sectionName); if (!section) { sections.push_back(Section(sectionName)); section = §ions[sections.size() - 1]; } return section; } bool IniFile::DeleteSection(const char* sectionName) { Section* s = GetSection(sectionName); if (!s) return false; for (std::vector
::iterator iter = sections.begin(); iter != sections.end(); ++iter) { if (&(*iter) == s) { sections.erase(iter); return true; } } return false; } bool IniFile::Exists(const char* sectionName, const char* key) const { const Section* section = GetSection(sectionName); if (!section) return false; return section->Exists(key); } void IniFile::SetLines(const char* sectionName, const std::vector &lines) { Section* section = GetOrCreateSection(sectionName); section->lines.clear(); for (std::vector::const_iterator iter = lines.begin(); iter != lines.end(); ++iter) { section->lines.push_back(*iter); } } bool IniFile::DeleteKey(const char* sectionName, const char* key) { Section* section = GetSection(sectionName); if (!section) return false; std::string* line = section->GetLine(key, 0, 0); for (std::vector::iterator liter = section->lines.begin(); liter != section->lines.end(); ++liter) { if (line == &(*liter)) { section->lines.erase(liter); return true; } } return false; //shouldn't happen } // Return a list of all keys in a section bool IniFile::GetKeys(const char* sectionName, std::vector& keys) const { const Section* section = GetSection(sectionName); if (!section) return false; keys.clear(); for (std::vector::const_iterator liter = section->lines.begin(); liter != section->lines.end(); ++liter) { std::string key; ParseLine(*liter, &key, 0, 0); if (!key.empty()) keys.push_back(key); } return true; } // Return a list of all lines in a section bool IniFile::GetLines(const char* sectionName, std::vector& lines, const bool remove_comments) const { const Section* section = GetSection(sectionName); if (!section) return false; lines.clear(); for (std::vector::const_iterator iter = section->lines.begin(); iter != section->lines.end(); ++iter) { std::string line = StripSpaces(*iter); if (remove_comments) { int commentPos = (int)line.find('#'); if (commentPos == 0) { continue; } if (commentPos != (int)std::string::npos) { line = StripSpaces(line.substr(0, commentPos)); } } lines.push_back(line); } return true; } void IniFile::SortSections() { std::sort(sections.begin(), sections.end()); } bool IniFile::Load(const Path &path) { sections.clear(); sections.push_back(Section("")); // first section consists of the comments before the first real section // Open file std::string data; if (!File::ReadFileToString(true, path, data)) { return false; } std::stringstream sstream(data); bool success = Load(sstream); return success; } bool IniFile::LoadFromVFS(const std::string &filename) { size_t size; uint8_t *data = g_VFS.ReadFile(filename.c_str(), &size); if (!data) return false; std::string str((const char*)data, size); delete [] data; std::stringstream sstream(str); return Load(sstream); } bool IniFile::Load(std::istream &in) { // Maximum number of letters in a line static const int MAX_BYTES = 1024*32; while (!(in.eof() || in.fail())) { char templine[MAX_BYTES]; in.getline(templine, MAX_BYTES); std::string line = templine; // Remove UTF-8 byte order marks. if (line.substr(0, 3) == "\xEF\xBB\xBF") { line = line.substr(3); } #ifndef _WIN32 // Check for CRLF eol and convert it to LF if (!line.empty() && line.at(line.size()-1) == '\r') { line.erase(line.size()-1); } #endif if (!line.empty()) { size_t sectionNameEnd = std::string::npos; if (line[0] == '[') { sectionNameEnd = line.find(']'); } if (sectionNameEnd != std::string::npos) { // New section! std::string sub = line.substr(1, sectionNameEnd - 1); sections.push_back(Section(sub)); if (sectionNameEnd + 1 < line.size()) { sections[sections.size() - 1].comment = line.substr(sectionNameEnd + 1); } } else { if (sections.empty()) { sections.push_back(Section("")); } sections[sections.size() - 1].lines.push_back(line); } } } return true; } bool IniFile::Save(const Path &filename) { FILE *file = File::OpenCFile(filename, "w"); if (!file) { return false; } // UTF-8 byte order mark. To make sure notepad doesn't go nuts. // TODO: Do we still need this? It's annoying. fprintf(file, "\xEF\xBB\xBF"); for (const Section §ion : sections) { if (!section.name().empty() && (!section.lines.empty() || !section.comment.empty())) { fprintf(file, "[%s]%s\n", section.name().c_str(), section.comment.c_str()); } for (const std::string &s : section.lines) { fprintf(file, "%s\n", s.c_str()); } } fclose(file); return true; } bool IniFile::Get(const char* sectionName, const char* key, std::string* value, const char* defaultValue) { Section* section = GetSection(sectionName); if (!section) { if (defaultValue) { *value = defaultValue; } return false; } return section->Get(key, value, defaultValue); } bool IniFile::Get(const char *sectionName, const char* key, std::vector& values) { Section *section = GetSection(sectionName); if (!section) return false; return section->Get(key, values); } bool IniFile::Get(const char* sectionName, const char* key, int* value, int defaultValue) { Section *section = GetSection(sectionName); if (!section) { *value = defaultValue; return false; } else { return section->Get(key, value, defaultValue); } } bool IniFile::Get(const char* sectionName, const char* key, uint32_t* value, uint32_t defaultValue) { Section *section = GetSection(sectionName); if (!section) { *value = defaultValue; return false; } else { return section->Get(key, value, defaultValue); } } bool IniFile::Get(const char* sectionName, const char* key, uint64_t* value, uint64_t defaultValue) { Section *section = GetSection(sectionName); if (!section) { *value = defaultValue; return false; } else { return section->Get(key, value, defaultValue); } } bool IniFile::Get(const char* sectionName, const char* key, bool* value, bool defaultValue) { Section *section = GetSection(sectionName); if (!section) { *value = defaultValue; return false; } else { return section->Get(key, value, defaultValue); } } // Unit test. TODO: Move to the real unit test framework. /* int main() { IniFile ini; ini.Load("my.ini"); ini.Set("Hej", "A", "amaskdfl"); ini.Set("Mossa", "A", "amaskdfl"); ini.Set("Aissa", "A", "amaskdfl"); //ini.Read("my.ini"); std::string x; ini.Get("Hej", "B", &x, "boo"); ini.DeleteKey("Mossa", "A"); ini.DeleteSection("Mossa"); ini.SortSections(); ini.Save("my.ini"); //UpdateVars(ini); return 0; } */