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

}
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=44467b26fd1214bea857ab61f36ffc28b655fd7d'>root</a>/<a href='/guix/log/.mailmap?id=44467b26fd1214bea857ab61f36ffc28b655fd7d'>.mailmap</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/.mailmap?id=44467b26fd1214bea857ab61f36ffc28b655fd7d&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2023-08-16 22:22:06 +0200'>2023-08-16</span></td><td><a href='/guix/commit/.mailmap?id=fce924708c31c09a1b438ae7e8b83d39c492be9a'>Update email addresses for Juliana Sims.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .mailmap: Add an entry for Juliana.
* gnu/packages/admin.scm, gnu/packages/audio.scm,
gnu/packages/build-tools.scm, gnu/packages/scheme.scm: Update Juliana's email.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Juliana Sims</td></tr>
<tr><td><span title='2022-01-11 14:48:00 -0500'>2022-01-11</span></td><td><a href='/guix/commit/.mailmap?id=7f779286df7e8636d901f4734501902cc934a72f'>Update mailmap.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .mailmap: Add entry for Zheng Junjie.
</span></span></td><td>Leo Famulari</td></tr>
<tr><td><span title='2021-11-06 16:03:43 +0100'>2021-11-06</span></td><td><a href='/guix/commit/.mailmap?id=567c4f4495fd1681bc6bd1ca3e9d1a87e120ac61'>Update mailmap and copyright assignments for Liliana Marie Prikler.</a><span class='msg-avail'>...<span class='msg-tooltip'>Use full names everywhere.

* .mailmap: Use full name for Liliana Marie Prikler.
* gnu/packages/zig.scm: Likewise.
</span></span></td><td>Liliana Marie Prikler</td></tr>
<tr><td><span title='2021-09-06 12:15:57 +0200'>2021-09-06</span></td><td><a href='/guix/commit/.mailmap?id=7158f8e4e9f81dbe004789018dcf06a5fe87d602'>Update mailmap.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .mailmap: Add entry for Liliana Marie Prikler.
</span></span></td><td>Liliana Marie Prikler</td></tr>
<tr><td><span title='2021-09-04 12:25:17 +0200'>2021-09-04</span></td><td><a href='/guix/commit/.mailmap?id=1fd0bf60ea261fac426052386029ead0ac68cad1'>Update mailmap.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .mailmap: Alias all my contributions to the same identity.
</span></span></td><td>Marius Bakke</td></tr>
<tr><td><span title='2021-07-27 12:34:56 -0400'>2021-07-27</span></td><td><a href='/guix/commit/.mailmap?id=c0e6e8d25e3750a35bebc80469ee86e7826bd769'>Update mailmap.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .mailmap: Add entry for Christine Lemmer-Webber.
</span></span></td><td>Leo Famulari</td></tr>
<tr><td><span title='2021-07-08 09:48:22 +0200'>2021-07-08</span></td><td><a href='/guix/commit/.mailmap?id=0a04c25482c4d848a6a29711fccf5682319e26aa'>mailmap: Update entries for Matthew James Kraai.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .mailmap: Change name for Matthew James Kraai.
* gnu/packages/lisp-xyz.scm, gnu/packages/python-xyz.scm,
gnu/packages/rust.scm: Likewise.

Signed-off-by: Nicolas Goaziou &lt;mail@nicolasgoaziou.fr&gt;
</span></span></td><td>Matthew James Kraai</td></tr>
<tr><td><span title='2021-06-23 22:29:23 -0500'>2021-06-23</span></td><td><a href='/guix/commit/.mailmap?id=6d388103a4ed8f14f1ac6ac7a2ff22c5fa6b8cd4'>gnu: Add Sollya.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/algebra.scm (sollya): New variable.
* .mailmap: Adjust "proper email" for `git commit`.
</span></span></td><td>Eric Bavier</td></tr>
<tr><td><span title='2021-04-21 18:02:27 -0400'>2021-04-21</span></td><td><a href='/guix/commit/.mailmap?id=449844474da86b5f10a4c5e4f1744e1e3a716d6e'>Update email address for Kei.</a><span class='msg-avail'>...<span class='msg-tooltip'>* .mailmap: Remove obsolete email for Kei.
</span></span></td><td>Kei Kebreau</td></tr>