FilePath类

成员函数文档

QString FilePath::baseName() const

返回不带路径的文件基本名称。

基本名称包含文件中直到（但不包括）第一个'.'字符的所有字符。

[static] QString FilePath::calcRelativePath(QStringView absolutePath, QStringView absoluteAnchorPath)

返回从给定的absoluteAnchorPath到absolutePath的相对路径。两个路径都必须是目录的绝对路径。

示例用法

qDebug() << FilePath::calcRelativePath("/foo/b/ar", "/foo/c");

调试输出将是"../b/ar"。

另请参阅FilePath::isRelativePath()，FilePath::relativePathFrom()和FilePath::relativeChildPath。

Utils::FilePath FilePath::canonicalPath() const

递归解决该文件名中可能存在的符号链接。

在Windows上，还会解决SUBST和重新挂载的NTFS驱动器。与QFileInfo::canonicalFilePath不同，如果路径不存在，此函数不会返回空字符串。

返回规范路径。

Qt::CaseSensitivity FilePath::caseSensitivity() const

返回路径的caseSensitivity。

这目前仅基于宿主操作系统。对于设备路径，总是返回Qt::CaseSensitive。

Utils::FilePath FilePath::chopped(int n) const

返回一个移除了本地路径中前n个字符的路径。示例用法

backup = FilePath("/tmp/example.txt.backup");
real = backup.chopped(7);
assert(real == FilePath("/tmp/example.txt"))

Utils::FilePath FilePath::cleanPath() const

与前QDir::cleanPath()类似的清理路径部分。

• 目录分隔符标准化（即，平台本机分隔符转换为"/"），删除冗余分隔符，并尝试解析"."和".."。
• 保留符号链接。此函数不返回规范路径，而是返回输入的最简版本。例如，"./local"变为"local"，"local/../bin"变为"bin"，"/local/usr/../bin"变为"/local/bin"。

void FilePath::clear()

清除的所有部分。

QString FilePath::completeBaseName() const

返回没有路径的文件的完整基本名称。

完整基本名称包括从文件中最后一个'.'字符之前（不包括'.'字符本身）的所有字符。在".ui.qml"的情况下，它将作为一个后缀处理。

QString FilePath::completeSuffix() const

返回文件的完整后缀（扩展名）。

完整后缀包括从文件中第一个'.'字符之后（不包括'.'字符本身）的所有字符。

bool FilePath::contains(const QString &s) const

返回path()是否包含s。

bool FilePath::createDir() const

在此位置创建一个目录。

如果目录可以被创建，返回true，如果不能，即使目录已经存在也返回false。

另请参阅ensureWritableDir。

QString FilePath::displayName(const QString &args = {}) const

将文件路径转换为相关操作系统的斜杠惯例，并添加方案和主机作为“在”后缀。

这对于GUI中静态的用户界面输出很有用。

如果args不为空，则将其添加到输出路径之后：“ 在 ”。

bool FilePath::endsWith(const QString &str) const

返回 path() 是否以 str 结尾。

Utils::expected_str<void> FilePath::ensureWritableDir() const

在此位置重新使用或创建目录。

如果目录之后可写，则返回 true。

另请参阅 createDir。

bool FilePath::equalsCaseSensitive(const Utils::FilePath &other) const

如果此文件路径在区分大小写的情况下与 other 相等，则返回 true。这在类似 Windows 的 NTFS 这样的半区分大小写的系统上是有用的。

另请参阅 QTCREATORBUG-30846。

bool FilePath::exists() const

返回一个 bool 值，指示具有此 FilePath 的文件或目录是否存在。

[静态] Utils::FilePath FilePath::fromFileInfo(const QFileInfo &info)

从 info 构造一个 FilePath。

[静态] Utils::FilePath FilePath::fromString(const QString &filepath)

从 filepath 构造一个 FilePath。

filepath 的有效性不会被检查。它可以以下形式提供

• /some/absolute/local/path
• some/relative/path
• scheme://host/absolute/path
• scheme://host/./relative/path

  注意： ./ 是路径的正文部分。

在解析 filepath 时，进行一些解码。存在于主机部分中的序列 %25 在主机名中替换为%，存在于主机部分的序列 %2f 在主机名中替换为/。

路径部分可能由几个由 / 分隔的部分组成，独立于平台或文件系统。

要从可能包含反斜杠作为路径分隔符的字符串创建 FilePath 对象，请使用 fromUserInput。

另请参阅 toString 和 fromUserInput。

[静态] Utils::FilePath FilePath::fromStringWithExtension(const QString &filepath, const QString &defaultExtension)

从 filepath 构造一个 FilePath。如果 filepath 本身没有扩展名，则将 defaultExtension 添加到它。

filepath 的有效性不会被检查。

[静态] Utils::FilePath FilePath::fromUrl(const QUrl &url)

从 url 构造一个 FilePath。

另请参阅 toVariant。

[静态] Utils::FilePath FilePath::fromUserInput(const QString &filePath)

从参数filePath构造一个FilePath。

路径filePath将被清理，并将~替换为首页。

[静态] Utils::FilePath FilePath::fromUtf8(const char *filename, int filenameSize = -1)

从UTF-8编码的filename参数构造一个FilePath。

filename参数的有效性将不会进行检查。

[静态] Utils::FilePath FilePath::from Variant(const QVariant &variant)

从variant参数构造一个FilePath。

另请参阅 toVariant。

bool FilePath::isChildOf(const Utils::FilePath &s) const

返回FilePath是否是s的子目录。

bool FilePath::isEmpty() const

检查路径 path() 是否为空。

如果 path() 为空，则返回 true。忽略该部分的主机和方案。

bool FilePath::isExecutableFile() const

返回一个bool值，表示该文件是否为可执行文件。

bool FilePath::isNewerThan(const QDateTime &timeStamp) const

检查该文件是否比timeStamp新。

要比较的时间戳timestamp。如果此文件是目录，则函数将递归检查所有文件，并在其中至少有一个文件比timestamp新时返回true。如果这是单个文件，如果文件比timestamp新，则返回true。

返回文件路径中是否至少有一个文件的日期比timestamp新。

bool FilePath::isRelativePath() const

检查路径是否为相对路径。

如果路径是相对的，则返回 true。

bool FilePath::isWritableDir() const

返回一个bool值，表示该目录是否是可写的。

bool FilePath::isWritableFile() const

返回一个bool值，表示该文件是否是可写的。

void FilePath::iterateDirectory(const Utils::FilePath::IterateDirCallback &callBack, const Utils::FileFilter &filter) const

对匹配filter的目录条目执行callBack。

QString FilePath::nativePath() const

返回一个QString，将其传递给目标系统原生命令，不包括设备前缀。

将分隔符转换为该路径所属系统的本地格式。

Utils::FilePath FilePath::parentDir() const

找到文件路径的父目录。

如果文件路径已经是根目录，则返回空文件路径。

返回最后一个段被移除的文件路径。

QChar FilePath::pathComponentSeparator() const

返回该路径的路径组件分隔符。

返回路径的分隔符。

QChar FilePath::pathListSeparator() const

返回该路径所属设备的路径列表分隔符。

返回该路径设备的路径列表分隔符。

std::optional<Utils::FilePath> FilePath::refersToExecutableFile(Utils::FilePath::MatchScope matchScope) const

返回一个布尔值，表示是否可能启动一个具有此FilePath本地路径的过程。

这通常等同于isExecutableFile()。在Windows上，它可能根据matchScope附加各种后缀。

Utils::FilePath FilePath::relativeChildPath(const Utils::FilePath &parent) const

从parent到此的相对路径。

如果没有此是parent的子路径，则返回空的FilePath。这是parent相对于父路径的路径计算。也就是说，永远不会返回以"../"开头的路径

如果没有此是parent的子路径，则返回此到parent的相对路径。

Utils::FilePath FilePath::relativePathFrom(const Utils::FilePath &anchor) const

返回从给定anchor到FilePath的相对路径。在这种情况下，FilePath和anchor可以是文件或目录。示例用法

FilePath filePath("/foo/b/ar/file.txt");
FilePath relativePath = filePath.relativePathFrom("/foo/c");
qDebug() << relativePath

调试输出将是"../b/ar/file.txt"。

bool FilePath::removeRecursively(QString *error = nullptr) const

递归删除此filePath所指的目录及其子目录。

返回一个布尔值，指示操作是否成功。

Utils::FilePath FilePath::resolvePath(const Utils::FilePath &tail) const

如果尾部是相对路径，则将其追加到此次路径中。

如果尾部是绝对路径，则返回尾部，否则返回此路径 + 尾部。

Utils::FilePath FilePath::resolvePath(const QString &tail) const

如果尾部是相对路径，则将其追加到此次路径中。

如果尾部是绝对路径，则返回尾部，否则返回此路径 + 尾部。

Utils::FilePath FilePath::resolveSymlinks() const

如果是符号链接，则递归解析符号链接。

要解析路径中的任何位置的符号链接，请参阅 canonicalPath。与 QFileInfo::canonicalFilePath 不同，此函数即使符号链接悬空，也会返回预期的最深目标文件。

返回符号链接目标文件路径。

Utils::FilePath FilePath::searchInDirectories(const Utils::FilePaths &dirs, const Utils::FilePathPredicate &filter = {}, Utils::FilePath::MatchScope matchScope = WithAnySuffix) const

在由 dirs 指定并由 filter 匹配的每个目录条目中搜索与该对象对应的二进制文件，匹配文件路径的 matchScope。

示例用法

binary = FilePath::fromUrl("docker://123/./make);
fullPath = binary.searchInDirectories(binary.deviceEnvironment().path());
assert(fullPath == FilePath::fromUrl("docker://123/usr/bin/make"))

QString FilePath::shortNativePath() const

将路径转换为可能缩短的路径，并使用本地分隔符。

类似于 QDir::toNativeSeparators，但在UNIX系统上给定绝对路径时使用前缀 '~' 而不是 $HOME。

返回可能缩短的路径，并使用本地分隔符。

bool FilePath::startsWith(const QString &s) const

返回 path() 是否以 s 开头。

bool FilePath::startsWithDriveLetter() const

检查 FilePath 是否以驱动器字母开头。返回 FilePath 是否以驱动器字母开头

QStringView FilePath::suffixView() const

返回文件的后缀（扩展名）。

后缀由文件中最后一个小数点之后的（但不包括）所有字符组成。在 ".ui.qml" 的情况下，它将视为一个后缀。

Utils::FilePath FilePath::symLinkTarget() const

如果不是符号链接，则返回空的 FilePath。

QString FilePath::toFSPathString() const

返回一个用于传递给基于 QString 的 API 的 QString。

这使用了 /__qtc_devices__/host/path 设置。

此方法在大多数情况下也适用于远程设置和 QDir/QFileInfo 等，但比直接使用 FilePath 要慢，并且仅在难以或不可能适当移植到 FilePath 时才应使用，例如使用不使用 FilePath 的外部基于 Qt 的库时。

另请参阅：fromUserInput()。

QFileInfo FilePath::toFileInfo() const

返回一个QFileInfo。

QString FilePath::toString() const

返回一个QString，以便通过基于QString的API进行传递。

这使用scheme://host/path设置，与fromString一起用于通过代码路径在QString中传递FilePath。

该结果在与cQDir和QFileInfo一起使用时没有用处，并且会在某些操作（如QFileInfo::canonicalFile）中销毁。

另请参阅toFSPathString。

QString FilePath::toUserOutput() const

返回一个包含设备前缀的用于显示给用户的QString。

将分隔符转换为该路径所属系统的本地格式。

QVariant FilePath::toVariant() const

将FilePath作为一个variant返回。

用于类型无关的内联接口，如QAbstractItemModel中的存储。

Utils::FilePath FilePath::withNewMappedPath(const Utils::FilePath &newPath) const

返回一个与当前对象在同一设备上的对应于newPath对象的路径。

这可能涉及特定设备的转换，如将Windows样式的路径转换为具有适当文件系统大小写或处理驱动器字母的Unix样式的路径：C:/dev/src -> /c/dev/src

示例用法

localDir = FilePath("/tmp/workingdir");
executable = FilePath::fromUrl("docker://123/bin/ls")
realDir = executable.withNewMappedPath(localDir)
assert(realDir == FilePath::fromUrl("docker://123/tmp/workingdir"))

Utils::FilePath FilePath::withNewPath(const QString &newPath) const

返回一个在同一设备上的具有本地路径newPath的FilePath。

示例用法

devicePath = FilePath("docker://123/tmp");
newPath = devicePath.withNewPath("/bin/ls");
assert(realDir == FilePath::fromUrl("docker://123/bin/ls"))

QString FilePath::withTildeHomePath() const

在Linux/Mac上，在清理此路径后将其在toString()结果中的用户主目录替换为~。

如果路径不是主目录的子目录，或者在Windows上运行时，返回输入