IniFile.h

// 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.

#pragma once

#include <istream>
#include <memory>
#include <map>
#include <string>
#include <string_view>
#include <vector>
#include <cstdint>

#include "Common/File/Path.h"

class VFSInterface;

class ParsedIniLine {
public:
	explicit ParsedIniLine(std::string_view line);

	ParsedIniLine(std::string_view key, std::string_view value) {
		this->key = key;
		this->value = value;
	}
	ParsedIniLine(std::string_view key, std::string_view value, std::string_view comment) {
		this->key = key;
		this->value = value;
		this->comment = comment;
	}
	static ParsedIniLine CommentOnly(std::string_view comment) {
		return ParsedIniLine(std::string_view(), std::string_view(), comment);
	}

	void Reconstruct(std::string *output) const;

	// Having these as views allows a more efficient internal representation, like one joint string.
	std::string_view Key() const { return key; }
	std::string_view Value() const { return value; }
	std::string_view Comment() const { return comment; }

	void SetValue(std::string_view newValue) { value = newValue; }

private:
	std::string key;
	std::string value;
	std::string comment;
};

class Section {
	friend class IniFile;

public:
	Section() {}
	Section(std::string_view name) : name_(name) {}

	bool Exists(std::string_view key) const;
	bool Delete(std::string_view key);

	void Clear();

	std::map<std::string, std::string> ToMap() const;

	ParsedIniLine *GetLine(std::string_view key);
	const ParsedIniLine *GetLine(std::string_view key) const;

	void Set(std::string_view key, const char* newValue);
	void Set(std::string_view key, const std::string& newValue, const std::string& defaultValue);

	void Set(std::string_view key, const std::string &value) {
		Set(key, value.c_str());
	}
	bool Get(std::string_view key, std::string* value, const char* defaultValue) const;

	void Set(std::string_view key, uint32_t newValue);
	void Set(std::string_view key, uint64_t newValue);
	void Set(std::string_view key, float newValue);
	void Set(std::string_view key, const float newValue, const float defaultValue);
	void Set(std::string_view key, double newValue);

	void Set(std::string_view key, int newValue, int defaultValue);
	void Set(std::string_view key, int newValue);

	void Set(std::string_view key, bool newValue, bool defaultValue);
	void Set(std::string_view key, bool newValue) {
		Set(key, newValue ? "True" : "False");
	}
	void Set(std::string_view key, const std::vector<std::string>& newValues);

	// Declare without a body to make it fail to compile. This is to prevent accidentally
	// setting a pointer as a bool. The failure is in the linker unfortunately, but that's better
	// than accidentally succeeding in a bad way.
	template<class T>
	void Set(std::string_view key, T *ptr);

	void AddComment(const std::string &comment);

	bool Get(std::string_view key, int* value, int defaultValue = 0) const;
	bool Get(std::string_view key, uint32_t* value, uint32_t defaultValue = 0) const;
	bool Get(std::string_view key, uint64_t* value, uint64_t defaultValue = 0) const;
	bool Get(std::string_view key, bool* value, bool defaultValue = false) const;
	bool Get(std::string_view key, float* value, float defaultValue = false) const;
	bool Get(std::string_view key, double* value, double defaultValue = false) const;
	bool Get(std::string_view key, std::vector<std::string>& values) const;

	// Return a list of all keys in this section
	bool GetKeys(std::vector<std::string> &keys) const;

	bool operator < (const Section& other) const {
		return name_ < other.name_;
	}

	const std::string &name() const {
		return name_;
	}

	// For reading without copying. Note: You may have to ignore lines with empty keys.
	const std::vector<ParsedIniLine> &Lines() const {
		return lines_;
	}

protected:
	std::vector<ParsedIniLine> lines_;
	std::string name_;
	std::string comment;
};

class IniFile {
public:
	bool Load(const Path &path);
	bool Load(std::istream &istream);
	bool LoadFromVFS(VFSInterface &vfs, const std::string &filename);

	bool Save(const Path &path);

	// Returns true if key exists in section
	bool Exists(const char* sectionName, const char* key) const;

	// These will not create the section if it doesn't exist.
	bool Get(const char* sectionName, const char* key, std::string* value, const char* defaultValue = "");
	bool Get(const char* sectionName, const char* key, int* value, int defaultValue = 0);
	bool Get(const char* sectionName, const char* key, uint32_t* value, uint32_t defaultValue = 0);
	bool Get(const char* sectionName, const char* key, uint64_t* value, uint64_t defaultValue = 0);
	bool Get(const char* sectionName, const char* key, bool* value, bool defaultValue = false);
	bool Get(const char* sectionName, const char* key, std::vector<std::string>& values);

	bool GetKeys(const char* sectionName, std::vector<std::string>& keys) const;

	bool DeleteKey(const char* sectionName, const char* key);
	bool DeleteSection(const char* sectionName);

	void SortSections();

	std::vector<std::unique_ptr<Section>> &Sections() { return sections; }

	bool HasSection(const char *section) { return GetSection(section) != nullptr; }
	const Section* GetSection(const char* section) const;
	Section* GetSection(const char* section);

	Section* GetOrCreateSection(const char* section);

private:
	std::vector<std::unique_ptr<Section>> sections;
};