文本文档类。可载入文本文件自动识别BOM文件编码，转换为指定编码。
更多...

#include <archives.hpp>

Public 类型
enum	FileEncoding { MultiByte, Utf8, Utf8Bom, Utf16Le, Utf16Be, Utf16 = Utf16Be, Utf32Le, Utf32Be, Utf32 = Utf32Be }
	文件编码更多...

Public 成员函数
	TextArchive (FileEncoding fileEncoding=MultiByte, winux::AnsiString const &contentEncoding="", winux::AnsiString const &mbsEncoding="")
	构造函数1 更多...

void	setFileEncoding (FileEncoding fileEncoding)
	设置文件编码。文件编码当载入文本文件时会自动设置。但如果一开始就只是写文本文档，还是需要手动设置文件编码。更多...

FileEncoding const &	getFileEncoding () const
	获取文件编码更多...

void	setContentEncoding (winux::AnsiString const &contentEncoding)
	设置内容编码。当给文本文档写入内容时，内容默认是什么编码，用这个函数指定。更多...

winux::AnsiString const &	getContentEncoding () const
	获取内容编码更多...

void	setMultiByteEncoding (winux::AnsiString const &mbsEncoding)
	设置多字节编码。当文件编码为多字节时，这个参数指示是哪一个多字节编码。更多...

winux::AnsiString const &	getMultiByteEncoding () const
	获取多字节编码更多...

void	load (winux::String const &filePath, bool isConvert, winux::AnsiString const &targetEncoding="", winux::AnsiString const &mbsEncoding="")
	载入文本文件更多...

void	load (winux::IFile *f, bool isConvert, winux::AnsiString const &targetEncoding="", winux::AnsiString const &mbsEncoding="")
	载入文本文件更多...

void	load (winux::Buffer const &content, bool isConvert, winux::AnsiString const &targetEncoding="", winux::AnsiString const &mbsEncoding="")
	载入指定内容更多...

template<typename _ChTy >
void	write (winux::XString< _ChTy > const &content)
	写入字符串内容更多...

template<typename _ChTy >
void	write (winux::XString< _ChTy > const &content, winux::AnsiString const &encoding)
	写入字符串内容更多...

void	write (winux::Buffer const &content)
	写入内容更多...

void	write (winux::Buffer const &content, winux::AnsiString const &encoding)
	写入内容更多...

void	save (winux::GrowBuffer *output)
	保存本对象的内容到缓冲区更多...

void	save (winux::IFile *f)
	保存本对象的内容到文件更多...

void	save (winux::String const &filePath)
	保存本对象的内容到文件更多...

void	save (winux::GrowBuffer *output, FileEncoding fileEncoding)
	保存本对象的内容到缓冲区更多...

void	save (winux::IFile *f, FileEncoding fileEncoding)
	保存本对象的内容到文件更多...

void	save (winux::String const &filePath, FileEncoding fileEncoding)
	保存本对象的内容到文件更多...

void	saveEx (winux::Buffer const &content, winux::AnsiString const &encoding, winux::GrowBuffer *output, FileEncoding fileEncoding)
	保存内容到缓冲区更多...

void	saveEx (winux::Buffer const &content, winux::AnsiString const &encoding, winux::IFile *f, FileEncoding fileEncoding)
	保存内容到文件对象更多...

void	saveEx (winux::Buffer const &content, winux::AnsiString const &encoding, winux::String const &filePath, FileEncoding fileEncoding)
	保存内容到文件更多...

template<typename _ChTy >
winux::XString< _ChTy >	toString () const
	转成指定字符的字符串更多...

void	clear ()
	清空文本文档的内容更多...

详细描述

文本文档类。可载入文本文件自动识别BOM文件编码，转换为指定编码。

核心参数有三个：
文件编码（如果是直接写文档则需要指定一个文件编码）
内容编码（当给文本文档写入内容时，内容的编码）
多字节编码（当文件编码为多字节时，这个参数指示是哪一个多字节编码）
BOM字节序：
[00 00 FE FF] UTF32BE
[FF FE 00 00] UTF32LE
[FE FF] UTF16BE
[FF FE] UTF16LE
[EF BB BF] UTF8BOM

在文件 archives.hpp 第 190 行定义.

成员枚举类型说明

enum winux::TextArchive::FileEncoding

文件编码

枚举值
MultiByte
Utf8
Utf8Bom
Utf16Le
Utf16Be
Utf16
Utf32Le
Utf32Be
Utf32

在文件 archives.hpp 第 194 行定义.

构造及析构函数说明

winux::TextArchive::TextArchive	(	FileEncoding	fileEncoding = `MultiByte`,
		winux::AnsiString const &	contentEncoding = `""`,
		winux::AnsiString const &	mbsEncoding = `""`
	)

inline

构造函数1

参数

fileEncoding	文件编码，如果是直接写文档则需要指定一个文件编码
contentEncoding	内容编码，当给文本文档写入内容时，内容的编码
mbsEncoding	多字节字符串编码，当文件编码为多字节时，这个参数指示是哪一个多字节编码

在文件 archives.hpp 第 213 行定义.

成员函数说明

void winux::TextArchive::clear ( )

inline

清空文本文档的内容

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

winux::AnsiString const& winux::TextArchive::getContentEncoding ( ) const

inline

获取内容编码

在文件 archives.hpp 第 236 行定义.

FileEncoding const& winux::TextArchive::getFileEncoding ( ) const

inline

获取文件编码

在文件 archives.hpp 第 224 行定义.

winux::AnsiString const& winux::TextArchive::getMultiByteEncoding ( ) const

inline

获取多字节编码

在文件 archives.hpp 第 248 行定义.

void winux::TextArchive::load	(	winux::String const &	filePath,
		bool	isConvert,
		winux::AnsiString const &	targetEncoding = `""`,
		winux::AnsiString const &	mbsEncoding = `""`
	)

inline

载入文本文件

参数

filePath	文件路径
isConvert	是否转换编码
targetEncoding	转换到此编码
mbsEncoding	多字节编码

在文件 archives.hpp 第 259 行定义.

函数调用图:

void winux::TextArchive::load	(	winux::IFile *	f,
		bool	isConvert,
		winux::AnsiString const &	targetEncoding = `""`,
		winux::AnsiString const &	mbsEncoding = `""`
	)

inline

载入文本文件

参数

f	文件对象
isConvert	是否转换编码
targetEncoding	转换到此编码
mbsEncoding	多字节编码

在文件 archives.hpp 第 270 行定义.

函数调用图:

void winux::TextArchive::load	(	winux::Buffer const &	content,
		bool	isConvert,
		winux::AnsiString const &	targetEncoding = `""`,
		winux::AnsiString const &	mbsEncoding = `""`
	)

inline

载入指定内容

参数

content	载入的内容
isConvert	是否转换编码
targetEncoding	转换到此编码
mbsEncoding	多字节编码

在文件 archives.hpp 第 283 行定义.

函数调用图:

void winux::TextArchive::save ( winux::GrowBuffer * output )

inline

保存本对象的内容到缓冲区

在文件 archives.hpp 第 326 行定义.

void winux::TextArchive::save ( winux::IFile * f )

inline

保存本对象的内容到文件

在文件 archives.hpp 第 332 行定义.

void winux::TextArchive::save ( winux::String const & filePath )

inline

保存本对象的内容到文件

在文件 archives.hpp 第 338 行定义.

void winux::TextArchive::save	(	winux::GrowBuffer *	output,
		FileEncoding	fileEncoding
	)

inline

保存本对象的内容到缓冲区

参数

output	缓冲区
fileEncoding	文件编码

在文件 archives.hpp 第 347 行定义.

void winux::TextArchive::save	(	winux::IFile *	f,
		FileEncoding	fileEncoding
	)

inline

保存本对象的内容到文件

参数

f	文件对象
fileEncoding	文件编码

在文件 archives.hpp 第 356 行定义.

void winux::TextArchive::save	(	winux::String const &	filePath,
		FileEncoding	fileEncoding
	)

inline

保存本对象的内容到文件

参数

filePath	文件路径
fileEncoding	文件编码

在文件 archives.hpp 第 365 行定义.

void winux::TextArchive::saveEx	(	winux::Buffer const &	content,
		winux::AnsiString const &	encoding,
		winux::GrowBuffer *	output,
		FileEncoding	fileEncoding
	)

保存内容到缓冲区

参数

content	内容
encoding	内容的编码
output	输出的缓冲区
fileEncoding	文件编码

void winux::TextArchive::saveEx	(	winux::Buffer const &	content,
		winux::AnsiString const &	encoding,
		winux::IFile *	f,
		FileEncoding	fileEncoding
	)

inline

保存内容到文件对象

参数

content	内容
encoding	内容的编码
f	输出的文件对象
fileEncoding	文件编码

在文件 archives.hpp 第 384 行定义.

函数调用图:

void winux::TextArchive::saveEx	(	winux::Buffer const &	content,
		winux::AnsiString const &	encoding,
		winux::String const &	filePath,
		FileEncoding	fileEncoding
	)

inline

保存内容到文件

参数

content	内容
encoding	内容的编码
filePath	输出的文件路径
fileEncoding	文件编码

在文件 archives.hpp 第 397 行定义.

void winux::TextArchive::setContentEncoding ( winux::AnsiString const & contentEncoding )

inline

设置内容编码。当给文本文档写入内容时，内容默认是什么编码，用这个函数指定。

在文件 archives.hpp 第 230 行定义.

void winux::TextArchive::setFileEncoding ( FileEncoding fileEncoding )

inline

设置文件编码。文件编码当载入文本文件时会自动设置。但如果一开始就只是写文本文档，还是需要手动设置文件编码。

在文件 archives.hpp 第 218 行定义.

void winux::TextArchive::setMultiByteEncoding ( winux::AnsiString const & mbsEncoding )

inline

设置多字节编码。当文件编码为多字节时，这个参数指示是哪一个多字节编码。

在文件 archives.hpp 第 242 行定义.

template<typename _ChTy >

winux::XString<_ChTy> winux::TextArchive::toString ( ) const

inline

转成指定字符的字符串

在文件 archives.hpp 第 405 行定义.

template<typename _ChTy >

void winux::TextArchive::write ( winux::XString< _ChTy > const & content )

inline

写入字符串内容

在文件 archives.hpp 第 294 行定义.

template<typename _ChTy >

void winux::TextArchive::write	(	winux::XString< _ChTy > const &	content,
		winux::AnsiString const &	encoding
	)

inline

写入字符串内容

参数

content	字符串内容
encoding	字符串内容的编码

在文件 archives.hpp 第 304 行定义.

void winux::TextArchive::write ( winux::Buffer const & content )

inline

写入内容

在文件 archives.hpp 第 310 行定义.

void winux::TextArchive::write	(	winux::Buffer const &	content,
		winux::AnsiString const &	encoding
	)

inline

写入内容

参数

content	内容
encoding	内容的编码

在文件 archives.hpp 第 319 行定义.

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

archives.hpp

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

构造及析构函数说明

成员函数说明