FileInfo类 参考

Minimal replacement for QFileInfo. 更多...

#include <fileinfo.h>

Public 成员函数
	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

静态 Private 成员函数
static void	correctPath (std::string &s)

Private 属性
std::string	m_name

详细描述

Minimal replacement for QFileInfo.

在文件 fileinfo.h 第 22 行定义.

构造及析构函数说明

FileInfo()

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

inlineexplicit

在文件 fileinfo.h 第 38 行定义.

成员函数说明

absFilePath()

std::string FileInfo::absFilePath

(

)

const

在文件 fileinfo.cpp 第 101 行定义.

{
  std::string result;
  std::error_code ec;
  fs::path path(m_name);
  if (fs::exists(path,ec))
  {
    result = fs::canonical(path,ec).string();
  }
  else
  {
    result = (fs::current_path(ec) / m_name).string();
  }
  correctPath(result);
  return result;
}

引用了 correctPath() , 以及 m_name.

被这些函数引用 dirPath(), FormulaManager::generateImages(), getConvertLatexMacro(), markdownFileNameToId(), parseFile(), MarkdownOutlineParser::parseInput(), patternMatch(), Markdown::processLink(), readConfiguration(), readDir(), readFileOrDirectory(), readTagFile(), resolveLink(), substituteLatexKeywords() , 以及 ClassDefImpl::writeIncludeFilesForSlice().

baseName()

std::string FileInfo::baseName

(

)

const

在文件 fileinfo.cpp 第 123 行定义.

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

引用了 fileName().

correctPath()

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

staticprivate

在文件 fileinfo.cpp 第 96 行定义.

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

引用了 reg::replace().

被这些函数引用 absFilePath() , 以及 dirPath().

dirPath()

std::string FileInfo::dirPath

(

bool

absPath = true

)

const

在文件 fileinfo.cpp 第 137 行定义.

{
  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);
  }
}

引用了 absFilePath(), correctPath() , 以及 m_name.

被这些函数引用 readDir(), readFileOrDirectory(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit() , 以及 XmlDocVisitor::visit().

exists()

bool FileInfo::exists

(

)

const

在文件 fileinfo.cpp 第 30 行定义.

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

引用了 m_name.

被这些函数引用 copyExtraFiles(), copyLatexStyleSheet(), copyLogo(), copyStyleSheet(), deliverablesPresent(), Dir::exists(), ExistsOnPath(), extraLatexStyleSheet(), fileToString(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), CitationManager::generatePage(), CitationManager::insertCrossReferencesForBibFile(), insertMapFile(), CitationManager::latexBibFiles(), Htags::loadFilemap(), openOutputFile(), parseInput(), Markdown::processLink(), readConfiguration(), readDir(), readFileOrDirectory(), readInputFile(), readTagFile(), DocParser::readTextFileByName(), runPlantumlContent(), ManGenerator::startDoxyAnchor(), substituteHtmlKeywords(), ClassDefImpl::writeIncludeFilesForSlice() , 以及 HtmlGenerator::writeStyleInfo().

extension()

std::string FileInfo::extension

(

bool

complete

)

const

在文件 fileinfo.cpp 第 130 行定义.

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

引用了 fileName().

被这些函数引用 getLanguageFromFileName().

fileName()

std::string FileInfo::fileName

(

)

const

在文件 fileinfo.cpp 第 118 行定义.

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

引用了 m_name.

被这些函数引用 baseName(), copyExtraFiles(), copyLatexStyleSheet(), copyLogo(), copyStyleSheet(), extension(), extraLatexStyleSheet(), FormulaManager::generateImages(), openOutputFile(), MarkdownOutlineParser::parseInput(), patternMatch(), Markdown::processLink(), readDir(), readFileOrDirectory(), substituteHtmlKeywords(), substituteLatexKeywords(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), XmlDocVisitor::visit() , 以及 HtmlGenerator::writeStyleInfo().

filePath()

std::string FileInfo::filePath

(

)

const

在文件 fileinfo.cpp 第 91 行定义.

{
  return m_name;
}

引用了 m_name.

被这些函数引用 patternMatch().

isDir()

bool FileInfo::isDir

(

)

const

在文件 fileinfo.cpp 第 70 行定义.

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

引用了 m_name.

被这些函数引用 Dir::exists(), readDir(), readFileOrDirectory() , 以及 resolveSymlink().

isExecutable()

bool FileInfo::isExecutable

(

)

const

在文件 fileinfo.cpp 第 51 行定义.

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

引用了 m_name.

isFile()

bool FileInfo::isFile

(

)

const

在文件 fileinfo.cpp 第 63 行定义.

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

引用了 m_name.

被这些函数引用 fileToString(), readDir(), readFileOrDirectory(), readTagFile() , 以及 HtmlGenerator::writeStyleInfo().

isReadable()

bool FileInfo::isReadable

(

)

const

在文件 fileinfo.cpp 第 44 行定义.

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

引用了 m_name.

被这些函数引用 Htags::loadFilemap(), Markdown::processLink(), readDir(), readFileOrDirectory() , 以及 HtmlGenerator::writeStyleInfo().

isRelative()

bool FileInfo::isRelative

(

)

const

在文件 fileinfo.cpp 第 58 行定义.

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

引用了 m_name.

被这些函数引用 resolveSymlink().

isSymLink()

bool FileInfo::isSymLink

(

)

const

在文件 fileinfo.cpp 第 77 行定义.

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

引用了 m_name.

被这些函数引用 DocParser::findAndCopyImage(), readDir(), readFileOrDirectory() , 以及 resolveSymlink().

isWritable()

bool FileInfo::isWritable

(

)

const

在文件 fileinfo.cpp 第 37 行定义.

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

引用了 m_name.

readLink()

std::string FileInfo::readLink

(

)

const

在文件 fileinfo.cpp 第 84 行定义.

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

引用了 m_name.

被这些函数引用 resolveSymlink().

size()

size_t FileInfo::size

(

)

const

在文件 fileinfo.cpp 第 23 行定义.

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

引用了 m_name.

被这些函数引用 deliverablesPresent(), fileToString(), insertMapFile(), TemplateEngine::Private::loadByName(), parseFile() , 以及 readInputFile().

类成员变量说明

m_name

std::string FileInfo::m_name

private

在文件 fileinfo.h 第 57 行定义.

被这些函数引用 absFilePath(), dirPath(), exists(), fileName(), filePath(), isDir(), isExecutable(), isFile(), isReadable(), isRelative(), isSymLink(), isWritable(), readLink() , 以及 size().

---

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

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