lix/src/libexpr/flake/flake.hh

122 lines
3 KiB
C++
Raw Normal View History

2019-06-04 17:45:16 +00:00
#pragma once
2019-02-12 17:23:11 +00:00
#include "types.hh"
#include "flakeref.hh"
#include "lockfile.hh"
2019-02-12 17:23:11 +00:00
namespace nix {
struct Value;
class EvalState;
namespace flake {
2019-04-30 09:03:31 +00:00
static const size_t FLAG_REGISTRY = 0;
static const size_t USER_REGISTRY = 1;
static const size_t GLOBAL_REGISTRY = 2;
2019-02-12 17:23:11 +00:00
struct FlakeRegistry
{
2019-04-08 17:03:00 +00:00
std::map<FlakeRef, FlakeRef> entries;
2019-02-12 17:23:11 +00:00
};
typedef std::vector<std::shared_ptr<FlakeRegistry>> Registries;
std::shared_ptr<FlakeRegistry> readRegistry(const Path &);
2019-03-29 15:18:25 +00:00
void writeRegistry(const FlakeRegistry &, const Path &);
2019-03-21 08:30:16 +00:00
2019-03-10 06:05:05 +00:00
Path getUserRegistryPath();
enum HandleLockFile : unsigned int
{ AllPure // Everything is handled 100% purely
, TopRefUsesRegistries // The top FlakeRef uses the registries, apart from that, everything happens 100% purely
, UpdateLockFile // Update the existing lockfile and write it to file
, UseUpdatedLockFile // `UpdateLockFile` without writing to file
, RecreateLockFile // Recreate the lockfile from scratch and write it to file
, UseNewLockFile // `RecreateLockFile` without writing to file
};
struct SourceInfo
{
// Immutable flakeref that this source tree was obtained from.
FlakeRef resolvedRef;
Path storePath;
// Number of ancestors of the most recent commit.
std::optional<uint64_t> revCount;
// NAR hash of the store path.
Hash narHash;
// A stable timestamp of this source tree. For Git and GitHub
// flakes, the commit date (not author date!) of the most recent
// commit.
std::optional<time_t> lastModified;
SourceInfo(const FlakeRef & resolvRef) : resolvedRef(resolvRef) {};
};
struct FlakeInput
{
FlakeRef ref;
bool isFlake = true;
FlakeInput(const FlakeRef & ref) : ref(ref) {};
};
2019-02-21 05:53:01 +00:00
struct Flake
{
FlakeRef originalRef;
2019-02-21 05:53:01 +00:00
std::string description;
SourceInfo sourceInfo;
std::map<FlakeId, FlakeInput> inputs;
Value * vOutputs; // FIXME: gc
2019-07-11 11:54:53 +00:00
unsigned int edition;
2019-05-22 12:31:40 +00:00
Flake(const FlakeRef & origRef, const SourceInfo & sourceInfo)
: originalRef(origRef), sourceInfo(sourceInfo) {};
};
Flake getFlake(EvalState &, const FlakeRef &);
/* If 'allowLookup' is true, then resolve 'flakeRef' using the
registries. */
FlakeRef maybeLookupFlake(
EvalState & state,
const FlakeRef & flakeRef,
bool allowLookup);
/* Fingerprint of a locked flake; used as a cache key. */
typedef Hash Fingerprint;
2019-04-19 12:23:35 +00:00
struct ResolvedFlake
{
2019-03-29 15:18:25 +00:00
Flake flake;
LockFile lockFile;
ResolvedFlake(Flake && flake, LockFile && lockFile)
: flake(flake), lockFile(lockFile) {}
Fingerprint getFingerprint() const;
};
ResolvedFlake resolveFlake(EvalState &, const FlakeRef &, HandleLockFile);
2019-04-16 12:27:54 +00:00
void callFlake(EvalState & state,
const Flake & flake,
const LockedInputs & inputs,
Value & v);
void callFlake(EvalState & state,
const ResolvedFlake & resFlake,
Value & v);
void updateLockFile(EvalState &, const FlakeRef & flakeRef, bool recreateLockFile);
void gitCloneFlake(FlakeRef flakeRef, EvalState &, Registries, const Path & destDir);
2019-03-21 08:30:16 +00:00
2019-02-12 17:23:11 +00:00
}
}