环境变量文档类更多...

#include <env_value.hpp>

类 env_document 继承关系图:

Public 成员函数
	env_document ()=default
	默认构造函数
	env_document (env_document &&other) noexcept=default
	移动构造函数
env_document &	operator= (env_document &&other) noexcept=default
	移动赋值运算符
void	add_variable (const string &name, unique_ptr< env_variable > variable)
	添加变量
void	set_variable (const string &name, string value, env_variable::quote_type quote=env_variable::None, bool exported=false)
	设置变量
NEFORCE_NODISCARD const env_variable *	get_variable (const string &name) const
	获取常量变量指针
NEFORCE_NODISCARD env_variable *	get_variable (const string &name)
	获取变量指针
NEFORCE_NODISCARD bool	has_variable (const string &name) const
	检查变量是否存在
void	remove_variable (const string &name)
	移除变量
NEFORCE_NODISCARD const unordered_map< string, unique_ptr< env_variable > > &	get_variables () const noexcept
	获取所有变量的常量引用
void	add_comment (string comment) noexcept
	添加注释
NEFORCE_NODISCARD const vector< string > &	get_comments () const noexcept
	获取所有注释
NEFORCE_NODISCARD string	get_string (const string &name, const string &default_value="") const
	获取字符串值
NEFORCE_NODISCARD int	get_int (const string &name, const int default_value=0) const
	获取整数值
NEFORCE_NODISCARD int64_t	get_int64 (const string &name, const int64_t default_value=0) const
	获取64位整数值
NEFORCE_NODISCARD double	get_double (const string &name, const double default_value=0.0) const
	获取双精度浮点值
NEFORCE_NODISCARD bool	get_bool (const string &name, const bool default_value=false) const
	获取布尔值
NEFORCE_NODISCARD string	to_string () const
	转换为字符串
Public 成员函数继承自 istringify< env_document >
NEFORCE_NODISCARD NEFORCE_CONSTEXPR20 string	to_string () const
	转换为字符串

详细描述

环境变量文档类

管理多个环境变量和相关注释，提供变量的增删改查操作。支持将整个文档序列化为字符串。

在文件 env_value.hpp 第 229 行定义.

构造及析构函数说明

◆ env_document()

env_document::env_document ( env_document && other )

defaultnoexcept

移动构造函数

参数

other 源文档

引用了 env_document().

成员函数说明

◆ add_comment()

void env_document::add_comment ( string comment )

inlinenoexcept

添加注释

参数

comment 注释内容

在文件 env_value.hpp 第 328 行定义.

引用了 move().

◆ add_variable()

void env_document::add_variable	(	const string &	name,
		unique_ptr< env_variable >	variable )

inline

添加变量

参数

name	变量名
variable	变量智能指针

在文件 env_value.hpp 第 261 行定义.

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

◆ get_bool()

NEFORCE_NODISCARD bool env_document::get_bool	(	const string &	name,
		const bool	default_value = false ) const

inline

获取布尔值

参数

name	变量名
default_value	默认值

返回: 变量的布尔值

在文件 env_value.hpp 第 386 行定义.

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

◆ get_comments()

NEFORCE_NODISCARD const vector< string > & env_document::get_comments ( ) const

inlinenoexcept

获取所有注释

返回: 注释列表的常量引用

在文件 env_value.hpp 第 334 行定义.

◆ get_double()

NEFORCE_NODISCARD double env_document::get_double	(	const string &	name,
		const double	default_value = 0.0 ) const

inline

获取双精度浮点值

参数

name	变量名
default_value	默认值

返回: 变量的双精度浮点值

在文件 env_value.hpp 第 375 行定义.

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

◆ get_int()

NEFORCE_NODISCARD int env_document::get_int	(	const string &	name,
		const int	default_value = 0 ) const

inline

获取整数值

参数

name	变量名
default_value	默认值

返回: 变量的整数值

在文件 env_value.hpp 第 353 行定义.

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

◆ get_int64()

NEFORCE_NODISCARD int64_t env_document::get_int64	(	const string &	name,
		const int64_t	default_value = 0 ) const

inline

获取64位整数值

参数

name	变量名
default_value	默认值

返回: 变量的64位整数值

在文件 env_value.hpp 第 364 行定义.

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

◆ get_string()

NEFORCE_NODISCARD string env_document::get_string	(	const string &	name,
		const string &	default_value = "" ) const

inline

获取字符串值

参数

name	变量名
default_value	默认值

返回: 变量的字符串值

在文件 env_value.hpp 第 342 行定义.

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

◆ get_variable() [1/2]

NEFORCE_NODISCARD env_variable * env_document::get_variable ( const string & name )

inline

获取变量指针

参数

name 变量名

返回: 变量的指针，不存在返回nullptr

在文件 env_value.hpp 第 295 行定义.

引用了 name().

◆ get_variable() [2/2]

NEFORCE_NODISCARD const env_variable * env_document::get_variable ( const string & name ) const

inline

获取常量变量指针

参数

name 变量名

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

在文件 env_value.hpp 第 282 行定义.

引用了 name().

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

◆ get_variables()

NEFORCE_NODISCARD const unordered_map< string, unique_ptr< env_variable > > & env_document::get_variables ( ) const

inlinenoexcept

获取所有变量的常量引用

返回: 变量映射表的常量引用

在文件 env_value.hpp 第 320 行定义.

◆ has_variable()

NEFORCE_NODISCARD bool env_document::has_variable ( const string & name ) const

inline

检查变量是否存在

参数

name 变量名

返回: 是否存在

在文件 env_value.hpp 第 308 行定义.

引用了 name().

◆ operator=()

env_document & env_document::operator= ( env_document && other )

defaultnoexcept

移动赋值运算符

参数

other 源文档

返回: 自身引用

引用了 env_document().

◆ remove_variable()

void env_document::remove_variable ( const string & name )

inline

移除变量

参数

name 要移除的变量名

在文件 env_value.hpp 第 314 行定义.

引用了 name().

◆ set_variable()

void env_document::set_variable	(	const string &	name,
		string	value,
		env_variable::quote_type	quote = env_variable::None,
		bool	exported = false )

inline

设置变量

参数

name	变量名
value	变量值
quote	引号类型，默认为无引号
exported	是否导出，默认为false

在文件 env_value.hpp 第 272 行定义.

引用了 make_unique(), move(), name() , 以及 env_variable::None.

◆ to_string()

NEFORCE_NODISCARD string env_document::to_string ( ) const

转换为字符串

返回: 整个文档的字符串表示

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

env_value.hpp

Public 成员函数

详细描述

构造及析构函数说明

◆ env_document()

成员函数说明

◆ add_comment()

◆ add_variable()

◆ get_bool()

◆ get_comments()

◆ get_double()

◆ get_int()

◆ get_int64()

◆ get_string()

◆ get_variable() [1/2]

◆ get_variable() [2/2]

◆ get_variables()

◆ has_variable()

◆ operator=()

◆ remove_variable()

◆ set_variable()

◆ to_string()