path: root/src/normalise.hh

#ifndef __NORMALISE_H
#define __NORMALISE_H

#include "fstate.hh"


/* Normalise an fstate-expression, that is, return an equivalent
   slice.  (For the meaning of `pending', see expandId()). */
FSId normaliseFState(FSId id, FSIdSet pending = FSIdSet());

/* Realise a Slice in the file system. */
void realiseSlice(const FSId & id, FSIdSet pending = FSIdSet());

/* Get the list of root (output) paths of the given
   fstate-expression. */
Strings fstatePaths(const FSId & id);

/* Get the list of paths that are required to realise the given
   expression.  For a derive expression, this is the union of
   requisites of the inputs; for a slice expression, it is the path of
   each element in the slice.  If `includeExprs' is true, include the
   paths of the Nix expressions themselves.  If `includeSuccessors' is
   true, include the requisites of successors. */
Strings fstateRequisites(const FSId & id,
    bool includeExprs, bool includeSuccessors);

/* Return the list of the ids of all known fstate-expressions whose
   output ids are completely contained in `ids'. */
FSIds findGenerators(const FSIds & ids);

/* Register a successor. */
void registerSuccessor(const FSId & id1, const FSId & id2);


#endif /* !__NORMALISE_H */