ini_document类 参考

INI文档类 更多...

#include <ini_value.hpp>

类 ini_document 继承关系图:

Public 成员函数
	ini_document ()
	构造函数
	ini_document (ini_document &&other) noexcept=default
	移动构造函数
ini_document &	operator= (ini_document &&other) noexcept=default
	移动赋值运算符
void	add_section (const string &name, unique_ptr< ini_section > section)
	添加节
const ini_section *	get_section (const string &name) const
	获取常量节指针
ini_section *	get_section (const string &name)
	获取节指针
bool	has_section (const string &name) const
	检查节是否存在
const unordered_map< string, unique_ptr< ini_section > > &	get_sections () const noexcept
	获取所有节的常量引用
const ini_section *	get_global_section () const noexcept
	获取全局节的常量指针
ini_section *	get_global_section () noexcept
	获取全局节的指针
string	get_string (const string &section, const string &key, const string &default_value="") const
	获取字符串值
int	get_int (const string &section, const string &key, int default_value=0) const
	获取整数值
double	get_double (const string &section, const string &key, double default_value=0.0) const
	获取双精度浮点值
bool	get_bool (const string &section, const string &key, bool default_value=false) const
	获取布尔值
string	to_string () const
	转换为字符串
Public 成员函数 继承自 istringify< ini_document >
constexpr string	to_string () const
	转换为字符串

详细描述

INI文档类

管理整个INI配置文件，包含多个节(section)和一个全局节。 提供节的增删改查操作和类型安全的属性访问接口。

在文件 ini_value.hpp 第 361 行定义.

构造及析构函数说明

ini_document() [1/2]

ini_document::ini_document ( )

inline

构造函数

创建空文档，初始化全局节。

在文件 ini_value.hpp 第 372 行定义.

引用了 make_unique().

被这些函数引用 ini_document() , 以及 operator=().

ini_document() [2/2]

ini_document::ini_document ( ini_document && other )

defaultnoexcept

移动构造函数

参数

other

源文档

引用了 ini_document().

成员函数说明

add_section()

void ini_document::add_section ( const string & name, unique_ptr< ini_section > section )

inline

添加节

参数

name	节名称
section	节智能指针

如果名称为空，则设置为全局节。

在文件 ini_value.hpp 第 398 行定义.

引用了 move() , 以及 name().

get_bool()

bool ini_document::get_bool ( const string & section, const string & key, bool default_value = false ) const

inlinenodiscard

获取布尔值

参数

section	节名称
key	属性键名
default_value	默认值

返回

指定属性的布尔值

在文件 ini_value.hpp 第 514 行定义.

引用了 ini_section::get_bool() , 以及 get_section().

get_double()

double ini_document::get_double ( const string & section, const string & key, double default_value = 0.0 ) const

inlinenodiscard

获取双精度浮点值

参数

section	节名称
key	属性键名
default_value	默认值

返回

指定属性的双精度浮点值

在文件 ini_value.hpp 第 502 行定义.

引用了 ini_section::get_double() , 以及 get_section().

get_global_section() [1/2]

const ini_section * ini_document::get_global_section ( ) const

inlinenodiscardnoexcept

获取全局节的常量指针

返回

全局节的常量指针

在文件 ini_value.hpp 第 462 行定义.

get_global_section() [2/2]

ini_section * ini_document::get_global_section ( )

inlinenodiscardnoexcept

获取全局节的指针

返回

全局节的指针

在文件 ini_value.hpp 第 468 行定义.

get_int()

int ini_document::get_int ( const string & section, const string & key, int default_value = 0 ) const

inlinenodiscard

获取整数值

参数

section	节名称
key	属性键名
default_value	默认值

返回

指定属性的整数值

在文件 ini_value.hpp 第 490 行定义.

引用了 ini_section::get_int() , 以及 get_section().

get_section() [1/2]

ini_section * ini_document::get_section ( const string & name )

inlinenodiscard

获取节指针

参数

name

节名称

返回

节的指针，不存在返回nullptr

在文件 ini_value.hpp 第 427 行定义.

引用了 name().

get_section() [2/2]

const ini_section * ini_document::get_section ( const string & name ) const

inlinenodiscard

获取常量节指针

参数

name

节名称

返回

节的常量指针，不存在返回nullptr

在文件 ini_value.hpp 第 411 行定义.

引用了 name().

被这些函数引用 get_bool(), get_double(), get_int() , 以及 get_string().

get_sections()

const unordered_map< string, unique_ptr< ini_section > > & ini_document::get_sections ( ) const

inlinenodiscardnoexcept

获取所有节的常量引用

返回

节映射表的常量引用

在文件 ini_value.hpp 第 454 行定义.

get_string()

string ini_document::get_string ( const string & section, const string & key, const string & default_value = "" ) const

inlinenodiscard

获取字符串值

参数

section	节名称
key	属性键名
default_value	默认值

返回

指定属性的字符串值

在文件 ini_value.hpp 第 477 行定义.

引用了 get_section() , 以及 ini_section::get_string().

has_section()

bool ini_document::has_section ( const string & name ) const

inlinenodiscard

检查节是否存在

参数

name

节名称

返回

是否存在

在文件 ini_value.hpp 第 443 行定义.

引用了 name().

operator=()

ini_document & ini_document::operator= ( ini_document && other )

defaultnoexcept

移动赋值运算符

参数

other

源文档

返回

自身引用

引用了 ini_document().

to_string()

string ini_document::to_string ( ) const

nodiscard

转换为字符串

返回

整个文档的字符串表示

---

该类的文档由以下文件生成:

• ini_value.hpp