derived-path.hh

Go to the documentation of this file.

#pragma once
 
#include "lix/libutil/config.hh"
#include "lix/libstore/path.hh"
#include "lix/libstore/outputs-spec.hh"
#include "lix/libutil/comparator.hh"
#include "lix/libutil/json-fwd.hh"
#include "lix/libutil/ref.hh"
#include "lix/libutil/result.hh"
 
#include <kj/async.h>
#include <variant>
 
namespace nix {
 
class Store;

struct DerivedPathOpaque {
    StorePath path;
 
    std::string to_string(const Store & store) const;
    static DerivedPathOpaque parse(const Store & store, std::string_view);
    kj::Promise<Result<JSON>> toJSON(const Store & store) const;
 
    GENERATE_CMP(DerivedPathOpaque, me->path);
};
 
struct SingleDerivedPath;

struct SingleDerivedPathBuilt {
    ref<SingleDerivedPath> drvPath;
    OutputName output;

    const StorePath & getBaseStorePath() const;

    std::string to_string(const Store & store) const;
    std::string to_string_legacy(const Store & store) const;
    static SingleDerivedPathBuilt parse(
        const Store & store, ref<SingleDerivedPath> drvPath,
        OutputNameView outputs,
        const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
    kj::Promise<Result<JSON>> toJSON(Store & store) const;
 
    DECLARE_CMP(SingleDerivedPathBuilt);
};
 
namespace derived_path::detail {
using SingleDerivedPathRaw = std::variant<
    DerivedPathOpaque,
    SingleDerivedPathBuilt
>;
}

struct SingleDerivedPath : derived_path::detail::SingleDerivedPathRaw {
    using Raw = derived_path::detail::SingleDerivedPathRaw;
    using Raw::Raw;
 
    using Opaque = DerivedPathOpaque;
    using Built = SingleDerivedPathBuilt;
 
    inline const Raw & raw() const {
        return static_cast<const Raw &>(*this);
    }

    const StorePath & getBaseStorePath() const;

    std::string to_string(const Store & store) const;
    std::string to_string_legacy(const Store & store) const;
    static SingleDerivedPath parse(
        const Store & store,
        std::string_view,
        const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
    static SingleDerivedPath parseLegacy(
        const Store & store,
        std::string_view,
        const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
    kj::Promise<Result<JSON>> toJSON(Store & store) const;
};
 
static inline ref<SingleDerivedPath> makeConstantStorePathRef(StorePath drvPath)
{
    return make_ref<SingleDerivedPath>(SingleDerivedPath::Opaque { drvPath });
}

struct DerivedPathBuilt {
    ref<SingleDerivedPath> drvPath;
    OutputsSpec outputs;

    const StorePath & getBaseStorePath() const;

    std::string to_string(const Store & store) const;
    std::string to_string_legacy(const Store & store) const;
    static DerivedPathBuilt parse(
        const Store & store, ref<SingleDerivedPath>,
        std::string_view,
        const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
    kj::Promise<Result<JSON>> toJSON(Store & store) const;
 
    DECLARE_CMP(DerivedPathBuilt);
};
 
namespace derived_path::detail {
using DerivedPathRaw = std::variant<
    DerivedPathOpaque,
    DerivedPathBuilt
>;
}

struct DerivedPath : derived_path::detail::DerivedPathRaw {
    using Raw = derived_path::detail::DerivedPathRaw;
    using Raw::Raw;
 
    using Opaque = DerivedPathOpaque;
    using Built = DerivedPathBuilt;
 
    inline const Raw & raw() const {
        return static_cast<const Raw &>(*this);
    }

    const StorePath & getBaseStorePath() const;

    std::string to_string(const Store & store) const;
    std::string to_string_legacy(const Store & store) const;
    static DerivedPath parse(
        const Store & store,
        std::string_view,
        const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
    static DerivedPath parseLegacy(
        const Store & store,
        std::string_view,
        const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);

    static DerivedPath fromSingle(const SingleDerivedPath &);
 
    kj::Promise<Result<JSON>> toJSON(Store & store) const;
};
 
typedef std::vector<DerivedPath> DerivedPaths;

void drvRequireExperiment(
    const SingleDerivedPath & drv,
    const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
}