// Copyright (c) 2020 Lv Decai, Shenzhen, China.
// Filename: IniFile.h
// Version: 1.0
// Release date: 2020年10月11日
// License: MIT (http://opensource.org/licenses/MIT)

#pragma once

#include "../CommonCpp.h"
#include "IOption.h"

NAMESPACE_BEGIN;

// INI 配置文件访问类
class COMMON_API CIniFile : public IOption
{
public:
	// 构造函数
	explicit CIniFile(PCTSTR sIniFilePath);

	// 重新设置 INI 配置文件路径
	void SetFilePath(PCTSTR sIniFilePath);

	// 读取区段列表
	void GetSectionList(list<CString>& lstSection);

	// 读取指定区段中的键列表
	void GetKeyList(PCTSTR sSection, list<CString>& lstKey);

	// 获取整数类型的选项值
	// 返回值:如果选项值存在则返回选项值,否则返回缺省值
	virtual int GetInt(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 缺省值
		int iDefaultValue = 0);

	// 获取浮点数类型的选项值
	// 返回值:如果选项值存在则返回选项值,否则返回缺省值
	virtual double GetFloat(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 缺省值
		double fDefaultValue = 0.0);

	// 获取字符串类型的选项值
	// 返回值:如果选项值存在则返回选项值,否则返回缺省值
	virtual CString GetString(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 缺省值
		PCTSTR sDefaultValue = _T(""));

	// 获取字符串列表类型的选项值
	// 返回值:选项值参数的引用
	virtual list<CString>& GetList(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 选项值
		list<CString>& lstOption,
		// 列表元素的分隔符
		PCTSTR sElementDivision = _T(","));

	// 设置整数类型的选项值
	// 返回值:设置是否成功
	virtual BOOL SetInt(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 选项值
		int iValue);

	// 设置浮点数类型的选项值
	// 返回值:设置是否成功
	virtual BOOL SetFloat(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 选项值
		double fValue);

	// 设置字符串类型的选项值
	// 返回值:设置是否成功
	virtual BOOL SetString(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 选项值
		PCTSTR sValue);

	// 设置字符串列表类型的选项值
	// 返回值:设置是否成功
	virtual BOOL SetList(
		// 选项所属类别名
		PCTSTR sCategory,
		// 选项名
		PCTSTR sKey,
		// 选项值
		const list<CString>& lstValue,
		// 列表元素的分隔符
		PCTSTR sElementDivision = _T(","));

private:
	// INI 配置文件路径
	CString m_sIniFilePath;
};

NAMESPACE_END;