介绍

目录操作类，提供文件和目录操作功能

基础信息

头文件:	include <tpDir.h>
Cmake:	None
发布版本:	V0.1.0
继承类:
派生类:

Public 类型

enum Filter {
       Dirs = 0x001, Files = 0x002, Drives = 0x004,
       NoSymLinks = 0x008, AllEntries = Dirs | Files | Drives, TypeMask = 0x00f,
       Hidden = 0x100, AccessMask = 0x3F0, AllDirs = 0x400,
       CaseSensitive = 0x800, NoDot = 0x2000, NoDotDot = 0x4000,
       NoDotAndDotDot = NoDot | NoDotDot, NoFilter = -1
}

enum SortFlag {
       Name = 0x00, Time = 0x01, Size = 0x02,
       Unsorted = 0x03, DirsFirst = 0x04, Reversed = 0x08,
       DirsLast = 0x20, Type = 0x80, NoSort = -1
}

Public 成员函数

	tpDir()	默认构造函数，创建空目录对象
	tpDir(const tpString &path)	构造函数，指定初始路径
	~tpDir()	析构函数，清理资源
	setPath(const tpString &path)	设置目录路径
tpString	path() const	获取当前设置的目录路径
tpString	absolutePath() const	获取目录的绝对路径
tpString	canonicalPath() const	获取目录的规范路径（解析所有符号链接和相对路径）
tpString	dirName() const	获取目录名称
tpString	filePath(const tpString &fileName) const	获取指定文件在目录中的完整路径
tpString	absoluteFilePath(const tpString &fileName) const	获取指定文件的绝对路径
tpString	relativeFilePath(const tpString &fileName) const	获取相对于当前目录的相对路径
tpFileInfoList	entryInfoList(Filters filters=NoFilter, SortFlags sort=NoSort) const	获取目录下的文件信息列表
	mkdir(const tpString &dirName) const	在当前目录下创建子目录
	exists() const	检查目录是否存在
	remove(const tpString &fileName)	删除目录下的文件
	removeRecursively()	递归删除目录及其所有内容
	mkpath(const tpString &dirPath)	静态方法：递归创建目录

成员枚举类型说明

enum tpDir::Filter

名称	值	描述
Dirs	0x001	包含目录
Files	0x002	包含文件
Drives	0x004	包含驱动器
NoSymLinks	0x008	排除符号链接
AllEntries	Dirs	Files
TypeMask	0x00f	类型过滤掩码
Hidden	0x100	包含隐藏文件和目录
AccessMask	0x3F0	访问权限过滤掩码
AllDirs	0x400	包含所有目录（包括.和..）
CaseSensitive	0x800	区分大小写的过滤
NoDot	0x2000	排除当前目录(.)
NoDotDot	0x4000	排除上级目录(..)
NoDotAndDotDot	NoDot	NoDotDot
NoFilter	-1	无过滤条件

enum tpDir::SortFlag

名称	值	描述
Name	0x00	按名称排序
Time	0x01	按修改时间排序
Size	0x02	按文件大小排序
Unsorted	0x03	不排序（文件系统原始顺序）
DirsFirst	0x04	目录排在文件前
Reversed	0x08	反向排序
DirsLast	0x20	目录排在文件后
Type	0x80	按文件类型排序
NoSort	-1	无排序

成员函数说明

tpDir::tpDir()

点击查看...

默认构造函数，创建空目录对象

tpDir::tpDir(const tpString &path)

点击查看...

构造函数，指定初始路径

tpDir::~tpDir()

点击查看...

析构函数，清理资源

void tpDir::setPath(const tpString &path)

点击查看...

设置目录路径

tpString tpDir::path() const

点击查看...

获取当前设置的目录路径
返回值：目录路径

tpString tpDir::absolutePath() const

点击查看...

获取目录的绝对路径
返回值：绝对路径

tpString tpDir::canonicalPath() const

点击查看...

获取目录的规范路径（解析所有符号链接和相对路径）
返回值：规范路径

tpString tpDir::dirName() const

点击查看...

获取目录名称
返回值：目录名称

tpString tpDir::filePath(const tpString &fileName) const

点击查看...

获取指定文件在目录中的完整路径
返回值：文件在目录中的完整路径

tpString tpDir::absoluteFilePath(const tpString &fileName) const

点击查看...

获取指定文件的绝对路径
返回值：文件的绝对路径

tpString tpDir::relativeFilePath(const tpString &fileName) const

点击查看...

获取相对于当前目录的相对路径
返回值：相对于当前目录的相对路径

tpFileInfoList tpDir::entryInfoList(Filters filters=NoFilter, SortFlags sort=NoSort) const

点击查看...

获取目录下的文件信息列表
返回值：文件信息列表

bool tpDir::mkdir(const tpString &dirName) const

点击查看...

在当前目录下创建子目录
返回值：创建成功返回true，否则返回false

bool tpDir::exists() const

点击查看...

检查目录是否存在
返回值：存在返回true，否则返回false

bool tpDir::remove(const tpString &fileName)

点击查看...

删除目录下的文件
返回值：删除成功返回true，否则返回false

bool tpDir::removeRecursively()

点击查看...

递归删除目录及其所有内容
返回值：删除成功返回true，否则返回false

static bool tpDir::mkpath(const tpString &dirPath)

点击查看...

静态方法：递归创建目录
返回值：创建成功返回true，否则返回false