Dir类 参考

Class representing a directory in the file system 更多...

#include <dir.h>

类
struct	Private

Public 成员函数
	Dir ()
	Dir (const std::string &path)
	Dir (const Dir &d)
Dir &	operator= (const Dir &d)
	~Dir ()
void	setPath (const std::string &path)
std::string	path () const
DirIterator	iterator () const
bool	isEmpty (const std::string subdir) const
bool	exists () const
std::string	filePath (const std::string &path, bool acceptsAbsPath=true) const
bool	exists (const std::string &path, bool acceptsAbsPath=true) const
bool	mkdir (const std::string &path, bool acceptsAbsPath=true) const
bool	rmdir (const std::string &path, bool acceptsAbsPath=true) const
bool	remove (const std::string &path, bool acceptsAbsPath=true) const
bool	rename (const std::string &orgName, const std::string &newName, bool acceptsAbsPath=true) const
bool	copy (const std::string &src, const std::string &dest, bool acceptsAbsPath=true) const
std::string	absPath () const
bool	isRelative () const

静态 Public 成员函数
static bool	isRelativePath (const std::string &path)
static std::string	currentDirPath ()
static bool	setCurrent (const std::string &path)
static std::string	cleanDirPath (const std::string &path)

Private 属性
std::unique_ptr< Private >	p

详细描述

Class representing a directory in the file system

在文件 dir.h 第 68 行定义.

构造及析构函数说明

Dir() [1/3]

Dir::Dir

(

)

在文件 dir.cpp 第 142 行定义.

         : p(std::make_unique<Private>())
{
  std::error_code ec;
  p->path = fs::current_path(ec);
}

引用了 p.

Dir() [2/3]

Dir::Dir

(

const std::string &

path

)

在文件 dir.cpp 第 162 行定义.

                              : p(std::make_unique<Private>())
{
  setPath(path);
}

引用了 path() , 以及 setPath().

Dir() [3/3]

Dir::Dir

(

const Dir &

d

)

在文件 dir.cpp 第 148 行定义.

                     : p(std::make_unique<Private>())
{
  p->path = d.p->path;
}

引用了 p.

~Dir()

Dir::~Dir

(

)

在文件 dir.cpp 第 167 行定义.

{
}

成员函数说明

absPath()

std::string Dir::absPath

(

)

const

在文件 dir.cpp 第 305 行定义.

{
  std::error_code ec;
  std::string result = fs::absolute(p->path,ec).string();
  correctPath(result);
  return result;
}

引用了 correctPath() , 以及 p.

被这些函数引用 Htags::execute(), PerlModGenerator::generate(), FormulaManager::generateImages(), parseInput(), Htags::path2URL(), RTFGenerator::preProcessFileInplace(), writeDotGraphFromFile(), writeDotImageMapFromFile() , 以及 DotGraph::writeGraph().

cleanDirPath()

std::string Dir::cleanDirPath ( const std::string &  path )

static

在文件 dir.cpp 第 297 行定义.

{
  std::error_code ec;
  std::string result = fs::path(path).lexically_normal().string();
  correctPath(result);
  return result;
}

引用了 correctPath() , 以及 path().

被这些函数引用 findFileDef() , 以及 resolveSymlink().

copy()

bool Dir::copy	(	const std::string &	src,
		const std::string &	dest,
		bool	acceptsAbsPath = true
	)		const

在文件 dir.cpp 第 272 行定义.

{
  const auto copyOptions = fs::copy_options::overwrite_existing;
  std::error_code ec;
  std::string sn = filePath(srcName,acceptsAbsPath);
  std::string dn = filePath(dstName,acceptsAbsPath);
  fs::copy(sn,dn,copyOptions,ec);
  return !ec;
}

引用了 filePath().

currentDirPath()

std::string Dir::currentDirPath ( )

static

在文件 dir.cpp 第 282 行定义.

{
  std::error_code ec;
  std::string result = fs::current_path(ec).string();
  correctPath(result);
  return result;
}

引用了 correctPath().

被这些函数引用 Htags::execute(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), parseInput(), RTFGenerator::preProcessFileInplace(), setPerlModDoxyfile(), Portable::setShortDir() , 以及 writeDiaGraphFromFile().

exists() [1/2]

bool Dir::exists

(

)

const

在文件 dir.cpp 第 199 行定义.

{
  FileInfo fi(p->path.string());
  return fi.exists() && fi.isDir();
}

引用了 FileInfo::exists(), FileInfo::isDir() , 以及 p.

被这些函数引用 clearSubDirs(), PerlModGenerator::createOutputDir(), createOutputDirectory(), createSubDirs(), Htags::execute(), generateDEF(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), generateTemplateFiles(), RTFGenerator::init(), ManGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), DocbookGenerator::init(), mkdir(), TemplateNodeCreator< TemplateNodeBlock >::mkpath(), parseInput(), DotGraph::prepareDotFile(), RTFGenerator::preProcessFileInplace(), writeDotGraphFromFile(), writeDotImageMapFromFile() , 以及 DotGfxHierarchyTable::writeGraph().

exists() [2/2]

bool Dir::exists	(	const std::string &	path,
		bool	acceptsAbsPath = true
	)		const

在文件 dir.cpp 第 191 行定义.

{
  std::string result = filePath(path,acceptsAbsPath);
  std::error_code ec;
  bool exist = fs::exists(fs::path(result),ec);
  return !ec && exist;
}

引用了 filePath() , 以及 path().

filePath()

std::string Dir::filePath	(	const std::string &	path,
		bool	acceptsAbsPath = true
	)		const

在文件 dir.cpp 第 222 行定义.

{
  std::string result;
  if (acceptsAbsPath && !isRelativePath(path))
  {
    result = path;
  }
  else
  {
    result = (p->path / path).string();
  }
  correctPath(result);
  return result;
}

引用了 correctPath(), isRelativePath(), p , 以及 path().

被这些函数引用 copy(), exists(), mkdir(), remove() , 以及 rename().

isEmpty()

bool Dir::isEmpty

(

const std::string

subdir

)

const

在文件 dir.cpp 第 205 行定义.

{
  fs::path pth = path();
  pth /= subdir;
  return fs::is_empty(pth);
}

引用了 path().

被这些函数引用 clearSubDirs().

isRelative()

bool Dir::isRelative

(

)

const

在文件 dir.cpp 第 212 行定义.

{
  return isRelativePath(p->path.string());
}

引用了 isRelativePath() , 以及 p.

isRelativePath()

bool Dir::isRelativePath ( const std::string &  path )

static

在文件 dir.cpp 第 217 行定义.

{
  return fs::path(path).is_relative();
}

引用了 path().

被这些函数引用 filePath() , 以及 isRelative().

iterator()

DirIterator Dir::iterator

(

)

const

在文件 dir.cpp 第 181 行定义.

{
  return DirIterator(p->path.string());
}

引用了 p.

被这些函数引用 readDir().

mkdir()

bool Dir::mkdir	(	const std::string &	path,
		bool	acceptsAbsPath = true
	)		const

在文件 dir.cpp 第 237 行定义.

{
  std::error_code ec;
  std::string result = filePath(path,acceptsAbsPath);
  if (exists(path,acceptsAbsPath))
  {
    return true;
  }
  else
  {
    return fs::create_directory(result,ec);
  }
}

引用了 exists(), filePath() , 以及 path().

被这些函数引用 PerlModGenerator::createOutputDir(), createOutputDirectory(), createSubDirs(), generateDEF(), generateOutput(), CitationManager::generatePage(), generateTemplateFiles(), RTFGenerator::init(), ManGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), DocbookGenerator::init(), TemplateNodeCreator< TemplateNodeBlock >::mkpath() , 以及 parseInput().

operator=()

Dir & Dir::operator=

(

const Dir &

d

)

在文件 dir.cpp 第 153 行定义.

{
  if (&d!=this)
  {
    p->path = d.p->path;
  }
  return *this;
}

引用了 p.

path()

std::string Dir::path

(

)

const

在文件 dir.cpp 第 176 行定义.

{
  return p->path.string();
}

引用了 p.

被这些函数引用 cleanDirPath(), Dir(), exists(), filePath(), isEmpty(), isRelativePath(), mkdir(), DotGraph::prepareDotFile(), remove(), rmdir(), setCurrent() , 以及 setPath().

remove()

bool Dir::remove	(	const std::string &	path,
		bool	acceptsAbsPath = true
	)		const

在文件 dir.cpp 第 256 行定义.

{
  std::error_code ec;
  std::string result = filePath(path,acceptsAbsPath);
  return fs::remove(result,ec);
}

引用了 filePath() , 以及 path().

被这些函数引用 determineInkscapeVersion(), exitDoxygen(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), getMscImageMapFromFile(), openOutputFile(), preProcessFile(), RTFGenerator::preProcessFileInplace(), resetPDFSize(), rmdir(), DotFilePatcher::run(), stopDoxygen(), HtmlDocVisitor::visit(), LatexDocVisitor::visit(), DocbookDocVisitor::visit(), RTFDocVisitor::visit() , 以及 writeDotImageMapFromFile().

rename()

bool Dir::rename	(	const std::string &	orgName,
		const std::string &	newName,
		bool	acceptsAbsPath = true
	)		const

在文件 dir.cpp 第 263 行定义.

{
  std::error_code ec;
  std::string fn1 = filePath(orgName,acceptsAbsPath);
  std::string fn2 = filePath(newName,acceptsAbsPath);
  fs::rename(fn1,fn2,ec);
  return !ec;
}

引用了 filePath().

被这些函数引用 openOutputFile(), RTFGenerator::preProcessFileInplace(), resetPDFSize() , 以及 DotFilePatcher::run().

rmdir()

bool Dir::rmdir	(	const std::string &	path,
		bool	acceptsAbsPath = true
	)		const

在文件 dir.cpp 第 251 行定义.

{
  return remove(path,acceptsAbsPath);
}

引用了 path() , 以及 remove().

被这些函数引用 clearSubDirs() , 以及 CitationManager::generatePage().

setCurrent()

bool Dir::setCurrent ( const std::string &  path )

static

在文件 dir.cpp 第 290 行定义.

{
  std::error_code ec;
  fs::current_path(path,ec);
  return !ec;
}

引用了 path().

被这些函数引用 Htags::execute(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), RTFGenerator::preProcessFileInplace(), Portable::setShortDir() , 以及 writeDiaGraphFromFile().

setPath()

void Dir::setPath

(

const std::string &

path

)

在文件 dir.cpp 第 171 行定义.

{
  p->path = path;
}

引用了 p , 以及 path().

被这些函数引用 PerlModGenerator::createOutputDir(), Dir(), Htags::execute(), TemplateNodeCreator< TemplateNodeBlock >::mkpath() , 以及 parseInput().

类成员变量说明

p

std::unique_ptr<Private> Dir::p

private

在文件 dir.h 第 101 行定义.

被这些函数引用 absPath(), Dir(), exists(), filePath(), isRelative(), iterator(), operator=(), path() , 以及 setPath().

---

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

• src/dir.h
• src/dir.cpp