mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2024-09-21 08:58:04 +03:00
0746951be1
* Finish converting existing comments for internal API docs 99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from #8133 * Fix two things from comments * Use triple-backtick not indent for `dumpPath` * Convert GNU-style `\`..'` quotes to markdown style in API docs This will render correctly.
104 lines
2.7 KiB
C++
104 lines
2.7 KiB
C++
#pragma once
|
|
///@file
|
|
|
|
#include "eval.hh"
|
|
#include "path.hh"
|
|
|
|
#include <string>
|
|
#include <map>
|
|
|
|
|
|
namespace nix {
|
|
|
|
|
|
struct DrvInfo
|
|
{
|
|
public:
|
|
typedef std::map<std::string, std::optional<StorePath>> Outputs;
|
|
|
|
private:
|
|
EvalState * state;
|
|
|
|
mutable std::string name;
|
|
mutable std::string system;
|
|
mutable std::optional<std::optional<StorePath>> drvPath;
|
|
mutable std::optional<StorePath> outPath;
|
|
mutable std::string outputName;
|
|
Outputs outputs;
|
|
|
|
/**
|
|
* Set if we get an AssertionError
|
|
*/
|
|
bool failed = false;
|
|
|
|
Bindings * attrs = nullptr, * meta = nullptr;
|
|
|
|
Bindings * getMeta();
|
|
|
|
bool checkMeta(Value & v);
|
|
|
|
public:
|
|
/**
|
|
* path towards the derivation
|
|
*/
|
|
std::string attrPath;
|
|
|
|
DrvInfo(EvalState & state) : state(&state) { };
|
|
DrvInfo(EvalState & state, std::string attrPath, Bindings * attrs);
|
|
DrvInfo(EvalState & state, ref<Store> store, const std::string & drvPathWithOutputs);
|
|
|
|
std::string queryName() const;
|
|
std::string querySystem() const;
|
|
std::optional<StorePath> queryDrvPath() const;
|
|
StorePath requireDrvPath() const;
|
|
StorePath queryOutPath() const;
|
|
std::string queryOutputName() const;
|
|
/**
|
|
* Return the unordered map of output names to (optional) output paths.
|
|
* The "outputs to install" are determined by `meta.outputsToInstall`.
|
|
*/
|
|
Outputs queryOutputs(bool withPaths = true, bool onlyOutputsToInstall = false);
|
|
|
|
StringSet queryMetaNames();
|
|
Value * queryMeta(const std::string & name);
|
|
std::string queryMetaString(const std::string & name);
|
|
NixInt queryMetaInt(const std::string & name, NixInt def);
|
|
NixFloat queryMetaFloat(const std::string & name, NixFloat def);
|
|
bool queryMetaBool(const std::string & name, bool def);
|
|
void setMeta(const std::string & name, Value * v);
|
|
|
|
/*
|
|
MetaInfo queryMetaInfo(EvalState & state) const;
|
|
MetaValue queryMetaInfo(EvalState & state, const string & name) const;
|
|
*/
|
|
|
|
void setName(const std::string & s) { name = s; }
|
|
void setDrvPath(StorePath path) { drvPath = {{std::move(path)}}; }
|
|
void setOutPath(StorePath path) { outPath = {{std::move(path)}}; }
|
|
|
|
void setFailed() { failed = true; };
|
|
bool hasFailed() { return failed; };
|
|
};
|
|
|
|
|
|
#if HAVE_BOEHMGC
|
|
typedef std::list<DrvInfo, traceable_allocator<DrvInfo>> DrvInfos;
|
|
#else
|
|
typedef std::list<DrvInfo> DrvInfos;
|
|
#endif
|
|
|
|
|
|
/**
|
|
* If value `v` denotes a derivation, return a DrvInfo object
|
|
* describing it. Otherwise return nothing.
|
|
*/
|
|
std::optional<DrvInfo> getDerivation(EvalState & state,
|
|
Value & v, bool ignoreAssertionFailures);
|
|
|
|
void getDerivations(EvalState & state, Value & v, const std::string & pathPrefix,
|
|
Bindings & autoArgs, DrvInfos & drvs,
|
|
bool ignoreAssertionFailures);
|
|
|
|
|
|
}
|