Dir Class Reference

Class representing a directory in the file system. More...

#include <src/dir.h>

Classes
struct	Private

Public Member Functions
	Dir ()
	Dir (const std::string &path)
	Dir (const Dir &d)
Dir &	operator= (const Dir &d)
	Dir (Dir &&d)
Dir &	operator= (Dir &&d)
	~Dir ()
void	setPath (const std::string &path)
std::string	path () const
DirIterator	iterator () const
bool	empty (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

Static Public Member Functions
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 Attributes
std::unique_ptr< Private >	p

Detailed Description

Class representing a directory in the file system.

Definition at line 72 of file dir.h.

Constructor & Destructor Documentation

Dir() [1/4]

Dir::Dir

(

)

Definition at line 195 of file dir.cpp.

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

References p.

Referenced by Dir(), Dir(), operator=(), and operator=().

Dir() [2/4]

Dir::Dir

(

const std::string &

path

)

Definition at line 226 of file dir.cpp.

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

References p, path(), and setPath().

Dir() [3/4]

Dir::Dir

(

const Dir &

d

)

Definition at line 201 of file dir.cpp.

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

References Dir(), and p.

Dir() [4/4]

Dir::Dir

(

Dir &&

d

)

Definition at line 215 of file dir.cpp.

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

References Dir(), and p.

~Dir()

Dir::~Dir

(

)

Definition at line 231 of file dir.cpp.

{
}

Member Function Documentation

absPath()

std::string Dir::absPath

(

)

const

Definition at line 370 of file dir.cpp.

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

References correctPath(), and p.

Referenced by Htags::execute(), PerlModGenerator::generate(), FormulaManager::generateImages(), parseInput(), Htags::path2URL(), RTFGenerator::preProcessFileInplace(), writeDotGraphFromFile(), writeDotImageMapFromFile(), and DotGraph::writeGraph().

cleanDirPath()

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

static

Definition at line 363 of file dir.cpp.

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

References correctPath(), and path().

Referenced by FileNameLinkedMap::findFileDef(), resolveSymlink(), and FileNameLinkedMap::showFileDefMatches().

copy()

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

Definition at line 336 of file dir.cpp.

{
  const auto &copyOptions = fs::copy_options::overwrite_existing;
  std::error_code ec, ec_perm;
  std::string sn = filePath(srcName,acceptsAbsPath);
  std::string dn = filePath(dstName,acceptsAbsPath);
  fs::copy(sn,dn,copyOptions,ec);
  // make sure the destination is writable for the owner (see issue #11600)
  fs::permissions(dn, fs::perms::owner_write, fs::perm_options::add, ec_perm);
  return !ec;
}

References filePath().

currentDirPath()

std::string Dir::currentDirPath ( )

static

Definition at line 348 of file dir.cpp.

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

References correctPath().

Referenced by Config::checkAndCorrect(), Htags::execute(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), parseInput(), RTFGenerator::preProcessFileInplace(), DotRunner::run(), runHtmlHelpCompiler(), runQHelpGenerator(), setPerlModDoxyfile(), Portable::setShortDir(), and writeDiaGraphFromFile().

empty()

bool Dir::empty

(

const std::string &

subdir

)

const

Definition at line 269 of file dir.cpp.

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

References path().

Referenced by clearSubDirs().

exists() [1/2]

bool Dir::exists

(

)

const

Definition at line 263 of file dir.cpp.

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

References FileInfo::exists(), FileInfo::isDir(), and p.

Referenced by clearSubDirs(), PerlModGenerator::createOutputDir(), createOutputDirectory(), createSubDirs(), Htags::execute(), generateDEF(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), DocbookGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), ManGenerator::init(), RTFGenerator::init(), initWarningFormat(), mkdir(), parseInput(), DotGraph::prepareDotFile(), RTFGenerator::preProcessFileInplace(), writeDotGraphFromFile(), writeDotImageMapFromFile(), and DotGfxHierarchyTable::writeGraph().

exists() [2/2]

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

Definition at line 255 of file dir.cpp.

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

References filePath(), and path().

filePath()

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

Definition at line 286 of file dir.cpp.

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

References correctPath(), isRelativePath(), p, and path().

Referenced by copy(), exists(), mkdir(), preProcessFile(), RTFGenerator::preProcessFileInplace(), remove(), and rename().

isRelative()

bool Dir::isRelative

(

)

const

Definition at line 276 of file dir.cpp.

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

References isRelativePath(), and p.

isRelativePath()

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

static

Definition at line 281 of file dir.cpp.

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

References path().

Referenced by filePath(), and isRelative().

iterator()

DirIterator Dir::iterator

(

)

const

Definition at line 245 of file dir.cpp.

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

References p.

Referenced by readDir().

mkdir()

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

Definition at line 301 of file dir.cpp.

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

References exists(), filePath(), and path().

Referenced by PerlModGenerator::createOutputDir(), createOutputDirectory(), createSubDirs(), generateDEF(), generateOutput(), CitationManager::generatePage(), DocbookGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), ManGenerator::init(), RTFGenerator::init(), initWarningFormat(), and parseInput().

operator=() [1/2]

Dir & Dir::operator=

(

const Dir &

d

)

Definition at line 206 of file dir.cpp.

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

References Dir(), and p.

operator=() [2/2]

Dir & Dir::operator=

(

Dir &&

d

)

Definition at line 220 of file dir.cpp.

{
  std::exchange(p->path,d.p->path);
  return *this;
}

References Dir(), and p.

path()

std::string Dir::path

(

)

const

Definition at line 240 of file dir.cpp.

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

References p.

Referenced by cleanDirPath(), Dir(), empty(), exists(), filePath(), isRelativePath(), mkdir(), DotGraph::prepareDotFile(), remove(), rmdir(), setCurrent(), and setPath().

remove()

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

Definition at line 320 of file dir.cpp.

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

References filePath(), and path().

Referenced by cleanupInlineGraphs(), determineInkscapeVersion(), exitDoxygen(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), getMscImageMapFromFile(), openDbConnection(), openOutputFile(), RTFGenerator::preProcessFileInplace(), resetPDFSize(), rmdir(), DotFilePatcher::run(), runPlantumlContent(), stopDoxygen(), writeDiaGraphFromFile(), writeDotImageMapFromFile(), ClassDiagram::writeFigure(), and writeMscGraphFromFile().

rename()

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

Definition at line 327 of file dir.cpp.

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

References filePath().

Referenced by openOutputFile(), RTFGenerator::preProcessFileInplace(), resetPDFSize(), DotFilePatcher::run(), and DotRunner::run().

rmdir()

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

Definition at line 315 of file dir.cpp.

{
  return remove(path,acceptsAbsPath);
}

References path(), and remove().

Referenced by clearSubDirs(), and CitationManager::generatePage().

setCurrent()

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

static

Definition at line 356 of file dir.cpp.

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

References path().

Referenced by Htags::execute(), FormulaManager::generateImages(), CitationManager::generatePage(), RTFGenerator::preProcessFileInplace(), DotRunner::run(), runHtmlHelpCompiler(), runQHelpGenerator(), Portable::setShortDir(), and writeDiaGraphFromFile().

setPath()

void Dir::setPath

(

const std::string &

path

)

Definition at line 235 of file dir.cpp.

{
  p->path = path;
}

References p, and path().

Referenced by PerlModGenerator::createOutputDir(), Dir(), Htags::execute(), and parseInput().

Member Data Documentation

p

std::unique_ptr<Private> Dir::p

private

Definition at line 108 of file dir.h.

Referenced by absPath(), Dir(), Dir(), Dir(), Dir(), exists(), filePath(), isRelative(), iterator(), operator=(), operator=(), path(), and setPath().

---

The documentation for this class was generated from the following files:

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