#pragma once

#include "types.hh"
#include "serialise.hh"


namespace nix {


/* dumpPath creates a Nix archive of the specified path.  The format
   is as follows:

   IF path points to a REGULAR FILE:
     dump(path) = attrs(
       [ ("type", "regular")
       , ("contents", contents(path))
       ])

   IF path points to a DIRECTORY:
     dump(path) = attrs(
       [ ("type", "directory")
       , ("entries", concat(map(f, sort(entries(path)))))
       ])
       where f(fn) = attrs(
         [ ("name", fn)
         , ("file", dump(path + "/" + fn))
         ])

   where:

     attrs(as) = concat(map(attr, as)) + encN(0)
     attrs((a, b)) = encS(a) + encS(b)

     encS(s) = encN(len(s)) + s + (padding until next 64-bit boundary)

     encN(n) = 64-bit little-endian encoding of n.

     contents(path) = the contents of a regular file.

     sort(strings) = lexicographic sort by 8-bit value (strcmp).

     entries(path) = the entries of a directory, without `.' and
     `..'.

     `+' denotes string concatenation. */

struct PathFilter
{
    virtual ~PathFilter() { }
    virtual bool operator () (const Path & path) { return true; }
};

extern PathFilter defaultPathFilter;

void dumpPath(const Path & path, Sink & sink,
    PathFilter & filter = defaultPathFilter);

struct ParseSink
{
    virtual void createDirectory(const Path & path) { };

    virtual void createRegularFile(const Path & path) { };
    virtual void isExecutable() { };
    virtual void preallocateContents(unsigned long long size) { };
    virtual void receiveContents(unsigned char * data, unsigned int len) { };

    virtual void createSymlink(const Path & path, const string & target) { };
};

void parseDump(ParseSink & sink, Source & source);

void restorePath(const Path & path, Source & source);

}
msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/guix/log/?id=ffdcef5f36196f5e004ca6cb96f5accc0c73fc92'>root</a>/<a href='/guix/log/build-aux?id=ffdcef5f36196f5e004ca6cb96f5accc0c73fc92'>build-aux</a>/<a href='/guix/log/build-aux/build-self.scm?id=ffdcef5f36196f5e004ca6cb96f5accc0c73fc92'>build-self.scm</a></div><div class='content'><table class='list nowrap'><tr class='nohover'><th class='left'>Age</th><th class='left'>Commit message (<a href='/guix/log/build-aux/build-self.scm?id=ffdcef5f36196f5e004ca6cb96f5accc0c73fc92&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2024-07-18 11:18:29 +0100'>2024-07-18</span></td><td><a href='/guix/commit/build-aux/build-self.scm?id=d82ac48b076dca156319c16e78acfadab52fd3e5'>guix: channels: Enable specifiying available builtin builders.</a><span class='msg-avail'>...</span></td><td>Christopher Baines</td></tr>
<tr><td><span title='2021-11-27 00:49:53 +0100'>2021-11-27</span></td><td><a href='/guix/commit/build-aux/build-self.scm?id=5c1ba739d432397e7107021fd6cb3ec01aecfb64'>build-self: Help users to submit useful bug reports.</a><span class='msg-avail'>...</span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2021-04-29 11:24:48 -0400'>2021-04-29</span></td><td><a href='/guix/commit/build-aux/build-self.scm?id=fbc2a52a32ddc664db8ebab420c2e17b1432c744'>download: Use Disarchive as a last resort.</a><span class='msg-avail'>...</span></td><td>Timothy Sample</td></tr>
<tr><td><span title='2021-04-01 14:58:55 +0200'>2021-04-01</span></td><td><a href='/guix/commit/build-aux/build-self.scm?id=a81a19930b2cbe1327e1e82d6210f80846ce2898'>build-self: Take care of the spinner in the parent process.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2021-04-01 14:58:55 +0200'>2021-04-01</span></td><td><a href='/guix/commit/build-aux/build-self.scm?id=1c10c2751a9075db5ab70fd102f0cc5ef2375720'>build-self: Forward sub-process build output to (current-build-output-port).</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>