FileInfo Class Reference

Minimal replacement for QFileInfo. More...

#include <src/fileinfo.h>

Public Member Functions
	FileInfo (const std::string &name)
bool	exists () const
size_t	size () const
bool	isWritable () const
bool	isReadable () const
bool	isExecutable () const
bool	isRelative () const
bool	isFile () const
bool	isDir () const
bool	isSymLink () const
std::string	readLink () const
std::string	filePath () const
std::string	absFilePath () const
std::string	fileName () const
std::string	baseName () const
std::string	extension (bool complete) const
std::string	dirPath (bool absPath=true) const

Static Private Member Functions
static void	correctPath (std::string &s)

Private Attributes
std::string	m_name

Detailed Description

Minimal replacement for QFileInfo.

Definition at line 22 of file fileinfo.h.

Constructor & Destructor Documentation

FileInfo()

FileInfo::FileInfo ( const std::string & name )

inlineexplicit

Definition at line 25 of file fileinfo.h.

: m_name(name) {}

References m_name.

Member Function Documentation

absFilePath()

std::string FileInfo::absFilePath

(

)

const

Definition at line 101 of file fileinfo.cpp.

{
  std::string result;
  std::error_code ec;
  fs::path path(m_name);
  if (!path.is_relative())
  {
    result = path.lexically_normal().string();
  }
  else
  {
    result = (fs::current_path(ec) / m_name).lexically_normal().string();
  }
  correctPath(result);
  return result;
}

References correctPath(), and m_name.

Referenced by Preprocessor::addSearchDir(), checkAndOpenFile(), checkMarkdownMainfile(), cleanUpPaths(), determineAbsoluteIncludeName(), dirPath(), findFilePath(), FormulaManager::generateImages(), genericPatternMatch(), getConvertLatexMacro(), openDbConnection(), parseFile(), MarkdownOutlineParser::parseInput(), preProcessFile(), Markdown::Private::processLink(), readConfiguration(), readDir(), readFileOrDirectory(), readTagFile(), resolveLink(), setFileName(), substituteLatexKeywords(), and ClassDefImpl::writeIncludeFilesForSlice().

baseName()

std::string FileInfo::baseName

(

)

const

Definition at line 123 of file fileinfo.cpp.

{
  std::string s = fileName();
  size_t pos = s.find('.');
  return pos!=std::string::npos ? s.substr(0,pos) : s;
}

References fileName().

Referenced by parseMain().

correctPath()

void FileInfo::correctPath ( std::string & s )

staticprivate

Definition at line 96 of file fileinfo.cpp.

{
  std::replace( s.begin(), s.end(), '\\', '/' );
}

Referenced by absFilePath(), and dirPath().

dirPath()

std::string FileInfo::dirPath

(

bool

absPath = true

)

const

Definition at line 137 of file fileinfo.cpp.

{
  std::string result;
  if (absPath)
  {
    result = absFilePath();
  }
  else
  {
    result = m_name;
    correctPath(result);
  }
  size_t pos = result.rfind('/');
  if (pos==std::string::npos)
  {
    return ".";
  }
  else if (pos==0)
  {
    return "/";
  }
  else
  {
    return result.substr(0,pos);
  }
}

References absFilePath(), correctPath(), and m_name.

Referenced by Config::checkAndCorrect(), determineAbsoluteIncludeName(), findFile(), findPackageScope(), initWarningFormat(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), CodeFragmentManager::parseCodeFragment(), readDir(), and readFileOrDirectory().

exists()

bool FileInfo::exists

(

)

const

Definition at line 30 of file fileinfo.cpp.

{
  std::error_code ec;
  bool result = fs::exists(fs::path(m_name),ec);
  return !ec && result;
}

References m_name.

Referenced by Config::checkAndCorrect(), checkAndOpenFile(), checkMarkdownMainfile(), cleanUpPaths(), computeVerifiedDotPath(), copyExtraFiles(), copyIcon(), copyLatexStyleSheet(), copyLogo(), copyStyleSheet(), deliverablesPresent(), determineAbsoluteIncludeName(), Dir::exists(), ExistsOnPath(), extractBoundingBox(), extraLatexStyleSheet(), fileToString(), DocParser::findAndCopyImage(), findFile(), findFilePath(), findPackageScopeFromPath(), CitationManager::generatePage(), RTFGenerator::init(), FormulaManager::initFromRepository(), CitationManager::insertCrossReferencesForBibFile(), insertMapFile(), CitationManager::latexBibFiles(), Htags::loadFilemap(), openDbConnection(), openOutputFile(), parseInput(), Markdown::Private::processLink(), readConfiguration(), readDir(), readFileOrDirectory(), readIncludeFile(), readInputFile(), readTagFile(), readTextFileByName(), runPlantumlContent(), ManGenerator::startDoxyAnchor(), substituteHtmlKeywords(), tryPath(), ClassDefImpl::writeIncludeFilesForSlice(), and HtmlGenerator::writeStyleInfo().

extension()

std::string FileInfo::extension

(

bool

complete

)

const

Definition at line 130 of file fileinfo.cpp.

{
  std::string fn = fileName();
  size_t pos = complete ? fn.find('.') : fn.rfind('.');
  return pos!=std::string::npos ? fn.substr(pos+1) : std::string();
}

References fileName().

Referenced by getLanguageFromFileName().

fileName()

std::string FileInfo::fileName

(

)

const

Definition at line 118 of file fileinfo.cpp.

{
  return fs::path(m_name).filename().string();
}

References m_name.

Referenced by baseName(), copyExtraFiles(), copyIcon(), copyLatexStyleSheet(), copyLogo(), copyStyleSheet(), FormulaManager::createLatexFile(), extension(), extraLatexStyleSheet(), FormulaManager::generateImages(), genericPatternMatch(), RTFGenerator::init(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), CodeFragmentManager::parseCodeFragment(), MarkdownOutlineParser::parseInput(), Markdown::Private::processLink(), readDir(), readFileOrDirectory(), substituteHtmlKeywords(), substituteLatexKeywords(), and HtmlGenerator::writeStyleInfo().

filePath()

std::string FileInfo::filePath

(

)

const

Definition at line 91 of file fileinfo.cpp.

{
  return m_name;
}

References m_name.

Referenced by genericPatternMatch(), and openOutputFile().

isDir()

bool FileInfo::isDir

(

)

const

Definition at line 70 of file fileinfo.cpp.

{
  std::error_code ec;
  fs::file_status status = fs::status(m_name,ec);
  return !ec && fs::is_directory(std::move(status));
}

References m_name.

Referenced by Preprocessor::addSearchDir(), Config::checkAndCorrect(), cleanUpPaths(), copyExtraFiles(), copyIcon(), copyLatexStyleSheet(), copyLogo(), copyStyleSheet(), determineAbsoluteIncludeName(), Dir::exists(), readDir(), readFileOrDirectory(), and resolveSymlink().

isExecutable()

bool FileInfo::isExecutable

(

)

const

Definition at line 51 of file fileinfo.cpp.

{
  std::error_code ec;
  fs::file_status status = fs::status(m_name,ec);
  return !ec && (status.permissions() & fs::perms::owner_exec)!=fs::perms::none;
}

References m_name.

isFile()

bool FileInfo::isFile

(

)

const

Definition at line 63 of file fileinfo.cpp.

{
  std::error_code ec;
  fs::file_status status = fs::status(m_name,ec);
  return !ec && fs::is_regular_file(std::move(status));
}

References m_name.

Referenced by Config::checkAndCorrect(), checkAndOpenFile(), computeVerifiedDotPath(), fileToString(), readDir(), readFileOrDirectory(), readIncludeFile(), readTagFile(), runPlantumlContent(), tryPath(), and HtmlGenerator::writeStyleInfo().

isReadable()

bool FileInfo::isReadable

(

)

const

Definition at line 44 of file fileinfo.cpp.

{
  std::error_code ec;
  fs::file_status status = fs::status(m_name,ec);
  return !ec && (status.permissions() & fs::perms::owner_read)!=fs::perms::none;
}

References m_name.

Referenced by Htags::loadFilemap(), Markdown::Private::processLink(), readDir(), readFileOrDirectory(), and HtmlGenerator::writeStyleInfo().

isRelative()

bool FileInfo::isRelative

(

)

const

Definition at line 58 of file fileinfo.cpp.

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

References m_name.

Referenced by resolveSymlink().

isSymLink()

bool FileInfo::isSymLink

(

)

const

Definition at line 77 of file fileinfo.cpp.

{
  std::error_code ec;
  fs::file_status status = fs::symlink_status(m_name,ec);
  return !ec && fs::is_symlink(std::move(status));
}

References m_name.

Referenced by DocParser::findAndCopyImage(), readDir(), readFileOrDirectory(), and resolveSymlink().

isWritable()

bool FileInfo::isWritable

(

)

const

Definition at line 37 of file fileinfo.cpp.

{
  std::error_code ec;
  fs::file_status status = fs::status(m_name,ec);
  return !ec && (status.permissions() & fs::perms::owner_write)!=fs::perms::none;
}

References m_name.

readLink()

std::string FileInfo::readLink

(

)

const

Definition at line 84 of file fileinfo.cpp.

{
  std::error_code ec;
  fs::path targetPath =  fs::read_symlink(fs::path(m_name));
  return !ec ? targetPath.string() : std::string();
}

References m_name.

Referenced by resolveSymlink().

size()

size_t FileInfo::size

(

)

const

Definition at line 23 of file fileinfo.cpp.

{
  std::error_code ec;
  size_t result = static_cast<size_t>(fs::file_size(fs::path(m_name),ec));
  return ec ? 0 : result;
}

References m_name.

Referenced by deliverablesPresent(), insertMapFile(), and readInputFile().

Member Data Documentation

m_name

std::string FileInfo::m_name

private

Definition at line 44 of file fileinfo.h.

Referenced by absFilePath(), dirPath(), exists(), FileInfo(), fileName(), filePath(), isDir(), isExecutable(), isFile(), isReadable(), isRelative(), isSymLink(), isWritable(), readLink(), and size().

---

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

• src/fileinfo.h
• src/fileinfo.cpp