|
Doxygen
|
Selects the filesystem implementation used by doxygen. More...
#include <src/fswrapper.h>
Go to the source code of this file.
Functions | |
| fs::path | toFsPath (const std::string &s) |
| Converts a UTF-8 encoded string into a path. | |
| std::string | fromFsPath (const fs::path &p) |
| Converts a path into a UTF-8 encoded string. | |
Selects the filesystem implementation used by doxygen.
The standard library's std::filesystem is used when it is available and usable without extra link libraries. Otherwise the bundled ghc::filesystem (deps/filesystem) is used as a fallback, in particular for:
Defining DOXYGEN_USE_GHC_FILESYSTEM forces the use of ghc::filesystem.
Doxygen uses UTF-8 encoded std::string paths everywhere. ghc::filesystem treats narrow strings as UTF-8 on all platforms, but std::filesystem uses the active (ANSI) code page on Windows. Always convert between strings and paths using toFsPath() and fromFsPath(), so non-ASCII file names keep working on Windows.
Definition in file fswrapper.h.
|
inline |
Converts a path into a UTF-8 encoded string.
Definition at line 78 of file fswrapper.h.
Referenced by FileInfo::absFilePath(), Dir::absPath(), Dir::cleanDirPath(), Dir::currentDirPath(), Dir::exists(), FileInfo::fileName(), Dir::filePath(), Dir::iterator(), Dir::path(), DirEntry::path(), and FileInfo::readLink().
|
inline |
Converts a UTF-8 encoded string into a path.
Definition at line 64 of file fswrapper.h.
Referenced by FileInfo::absFilePath(), Dir::cleanDirPath(), Dir::copy(), Dir::empty(), Dir::exists(), FileInfo::exists(), FileInfo::fileName(), Dir::filePath(), FileInfo::isDir(), FileInfo::isExecutable(), FileInfo::isFile(), FileInfo::isReadable(), FileInfo::isRelative(), Dir::isRelativePath(), FileInfo::isSymLink(), FileInfo::isWritable(), Dir::mkdir(), Portable::openInputStream(), Portable::openOutputStream(), DirIterator::Private::Private(), FileInfo::readLink(), Dir::remove(), Dir::rename(), Dir::setCurrent(), Dir::setPath(), and FileInfo::size().