source-path.hh

Go to the documentation of this file.

#pragma once
 
#include "lix/libutil/ref.hh"
#include "lix/libutil/archive.hh"
#include "lix/libutil/canon-path.hh"
#include "lix/libutil/file-system.hh"
#include "lix/libutil/repair-flag.hh"
#include "lix/libutil/input-accessor.hh"
 
namespace nix {
 
class CheckedSourcePath;

struct SourcePath
{
protected:
    CanonPath path;
 
public:
    SourcePath(CanonPath path)
        : path(std::move(path))
    { }
 
    std::string_view baseName() const;

    SourcePath parent() const;
 
    const CanonPath & canonical() const { return path; }
 
    std::string to_string() const
    { return path.abs(); }

    CheckedSourcePath unsafeIntoChecked();

    SourcePath operator + (const CanonPath & x) const
    { return {path + x}; }

    SourcePath operator + (std::string_view c) const
    {  return {path + c}; }
 
    bool operator == (const SourcePath & x) const
    {
        return path == x.path;
    }
 
    bool operator != (const SourcePath & x) const
    {
        return path != x.path;
    }
 
    bool operator < (const SourcePath & x) const
    {
        return path < x.path;
    }
};
 
std::ostream & operator << (std::ostream & str, const SourcePath & path);

class CheckedSourcePath : public SourcePath
{
    friend struct SourcePath;
 
    CheckedSourcePath(CanonPath path): SourcePath(std::move(path)) {}
 
public:
    std::string readFile() const
    { return nix::readFile(path.abs()); }

    bool pathExists() const
    { return nix::pathExists(path.abs()); }

    InputAccessor::Stat lstat() const;

    std::optional<InputAccessor::Stat> maybeLstat() const;

    InputAccessor::Stat stat() const;

    std::optional<InputAccessor::Stat> maybeStat() const;

    InputAccessor::DirEntries readDirectory() const;

    std::string readLink() const
    { return nix::readLink(path.abs()); }

    void dumpPath(
        Sink & sink,
        PathFilter & filter = defaultPathFilter) const
    { sink << nix::dumpPath(path.abs(), filter); }
};
 
inline CheckedSourcePath SourcePath::unsafeIntoChecked()
{
    return CheckedSourcePath(std::move(path));
}
 
}