werkzeugkiste::files namespace

File system utilities (mainly targeted for GNU/Linux systems).

Contents

Classes

class IOError
Indicates an I/O error (e.g. invalid path or missing permissions).
class AsciiFileIterator

Functions

auto ReadAsciiFile(std::string_view filename) -> std::vector<std::string> WERKZEUGKISTE_FILES_EXPORT
Reads all lines of the plain text file.
auto CatAsciiFile(std::string_view filename) -> std::string WERKZEUGKISTE_FILES_EXPORT
Reads the plain text file into a single string.
auto Exists(const std::string& name) -> WERKZEUGKISTE_FILES_EXPORT bool
auto IsDir(const std::string& path) -> WERKZEUGKISTE_FILES_EXPORT bool
auto Basename(std::string_view path) -> WERKZEUGKISTE_FILES_EXPORT std::optional<std::string>
auto Extension(std::string_view path) -> WERKZEUGKISTE_FILES_EXPORT std::optional<std::string>
auto FullFile(std::string_view p1, std::string_view p2) -> WERKZEUGKISTE_FILES_EXPORT std::string
auto FullFile(const std::vector<std::string>& path_tokens) -> WERKZEUGKISTE_FILES_EXPORT std::string
auto FullFile(std::initializer_list<std::string_view> path_tokens) -> WERKZEUGKISTE_FILES_EXPORT std::string
auto Parent(std::string_view path) -> WERKZEUGKISTE_FILES_EXPORT std::string
auto DirName(const std::string& path) -> WERKZEUGKISTE_FILES_EXPORT std::string
TODO doc.
auto IsAbsolute(std::string_view path) -> WERKZEUGKISTE_FILES_EXPORT bool
Returns true if the given path is absolute.

Function documentation

std::vector<std::string> WERKZEUGKISTE_FILES_EXPORT werkzeugkiste::files::ReadAsciiFile(std::string_view filename)
#include <werkzeugkiste/files/fileio.h>

Reads all lines of the plain text file.

std::string WERKZEUGKISTE_FILES_EXPORT werkzeugkiste::files::CatAsciiFile(std::string_view filename)
#include <werkzeugkiste/files/fileio.h>

Reads the plain text file into a single string.

WERKZEUGKISTE_FILES_EXPORT bool werkzeugkiste::files::Exists(const std::string& name)
#include <werkzeugkiste/files/filesys.h>

WERKZEUGKISTE_FILES_EXPORT bool werkzeugkiste::files::IsDir(const std::string& path)
#include <werkzeugkiste/files/filesys.h>

WERKZEUGKISTE_FILES_EXPORT std::optional<std::string> werkzeugkiste::files::Basename(std::string_view path)
#include <werkzeugkiste/files/filesys.h>

WERKZEUGKISTE_FILES_EXPORT std::optional<std::string> werkzeugkiste::files::Extension(std::string_view path)
#include <werkzeugkiste/files/filesys.h>

WERKZEUGKISTE_FILES_EXPORT std::string werkzeugkiste::files::FullFile(std::string_view p1, std::string_view p2)
#include <werkzeugkiste/files/filesys.h>

WERKZEUGKISTE_FILES_EXPORT std::string werkzeugkiste::files::FullFile(const std::vector<std::string>& path_tokens)
#include <werkzeugkiste/files/filesys.h>

WERKZEUGKISTE_FILES_EXPORT std::string werkzeugkiste::files::FullFile(std::initializer_list<std::string_view> path_tokens)
#include <werkzeugkiste/files/filesys.h>

WERKZEUGKISTE_FILES_EXPORT std::string werkzeugkiste::files::Parent(std::string_view path)
#include <werkzeugkiste/files/filesys.h>

Splits the string by the system's path delimiter (fwd or bwd slash) and returns the parent entry. For example:

  • /path/to/foo --> /path/to
  • /path/to/foo.h --> /path/to

WERKZEUGKISTE_FILES_EXPORT std::string werkzeugkiste::files::DirName(const std::string& path)
#include <werkzeugkiste/files/filesys.h>

TODO doc.

WERKZEUGKISTE_FILES_EXPORT bool werkzeugkiste::files::IsAbsolute(std::string_view path)
#include <werkzeugkiste/files/filesys.h>

Returns true if the given path is absolute.

Only supported on Linux, Unix & Apple systems.