#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);

}
ue='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=7dcc4d70ee44271b5437a0d773e356039ab75b9c'>root</a>/<a href='/guix/log/gnu?id=7dcc4d70ee44271b5437a0d773e356039ab75b9c'>gnu</a>/<a href='/guix/log/gnu/machine.scm?id=7dcc4d70ee44271b5437a0d773e356039ab75b9c'>machine.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/gnu/machine.scm?id=7dcc4d70ee44271b5437a0d773e356039ab75b9c&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2022-02-08 13:34:02 +0100'>2022-02-08</span></td><td><a href='/guix/commit/gnu/machine.scm?id=ab7114191d4599e36958c2ec18491618bf0cc6a9'>gnu: Fix typo.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/machine.scm: Fix typo in top-level comment.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>jgart</td></tr>
17 11:49:08 +0100'>2020-02-17</span></td><td><a href='/guix/commit/bootstrap?id=3dd311e3a059131ef245417106d4fb659222ef3c'>bootstrap: Fix typo.</a><span class='msg-avail'>...<span class='msg-tooltip'>* bootstrap: Substitute ‘guix-cookbook’ for copy/pasted ‘guix-manual’.

Reported-by: jetomit on #guix
</span></span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2019-09-18 11:38:14 +0200'>2019-09-18</span></td><td><a href='/guix/commit/bootstrap?id=7bc46ecc34ceb042ff890e5d306d0a2a736e891d'>doc: Add Guix Cookbook.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .gitignore: Update ignore list.
* Makefile.am (assert-no-store-file-names): Exclude the cookbook.
* bootstrap: Generate po files for cookbook translations.
* doc/guix-cookbook.texi: New file.
* doc/local.mk (info_TEXINFOS): Add it; add a rule to build cookbook
translations.
* po/doc/local.mk (DOC_COOKBOOK_PO_FILES): New variable.
(EXTRA_DIST): Add cookbook pot file and po files.
(doc-po-update-cookbook-%): New target.
(doc-pot-update): Also update cookbook pot file.
(doc-po-update): Also update cookbook po files.
</span></span></td><td>Ricardo Wurmus</td></tr>