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

}
>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=bf3722f9dbe8a13932aaf9abd0dc399851eaf960'>root</a>/<a href='/guix/log/tests?id=bf3722f9dbe8a13932aaf9abd0dc399851eaf960'>tests</a>/<a href='/guix/log/tests/nar.scm?id=bf3722f9dbe8a13932aaf9abd0dc399851eaf960'>nar.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/tests/nar.scm?id=bf3722f9dbe8a13932aaf9abd0dc399851eaf960&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2019-12-12 17:56:57 +0100'>2019-12-12</span></td><td><a href='/guix/commit/tests/nar.scm?id=12c1afcdbdc984c760d00932bce64288b385bbc9'>serialization: Add 'fold-archive'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2019-01-18 17:51:34 +0100'>2019-01-18</span></td><td><a href='/guix/commit/tests/nar.scm?id=9fe3f11398e858f1d06120bd046cab506efc86dc'>serialization: 'restore-file' errors out upon non-convertible file names.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-11-13 14:59:46 +0100'>2018-11-13</span></td><td><a href='/guix/commit/tests/nar.scm?id=f5a2724ae453f4a4b55ff848f4ad7e30efb6eef8'>deduplication: Restore directory mtime and permissions after deduplication.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-11-13 14:59:46 +0100'>2018-11-13</span></td><td><a href='/guix/commit/tests/nar.scm?id=8390869811f56f5b2ff947efb9d48bcf219a0444'>tests: Check file canonicalization for 'restore-file-set'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-11-13 14:59:45 +0100'>2018-11-13</span></td><td><a href='/guix/commit/tests/nar.scm?id=3ed56ad09b1d2be15e98d195b56886ec14899518'>tests: Remove check for a feature that appeared in Guile 2.0.10.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-09-04 17:25:11 +0200'>2018-09-04</span></td><td><a href='/guix/commit/tests/nar.scm?id=ca719424455465fca4b872c371daf2a46de88b33'>Switch to Guile-Gcrypt.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-07-19 11:48:04 +0200'>2018-07-19</span></td><td><a href='/guix/commit/tests/nar.scm?id=b94b698d4ed4bc478c56e507d53e5284d4f63073'>serialization: Add 'write-file-tree'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-03-18 00:39:49 +0100'>2017-03-18</span></td><td><a href='/guix/commit/tests/nar.scm?id=36626c556ed75219bce196ac93d148f6b9af984c'>build: Require Guile &gt;= 2.0.9.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-03-08 23:42:52 +0100'>2017-03-08</span></td><td><a href='/guix/commit/tests/nar.scm?id=6f38960055e496193a49d690d7f1b5516b2b8625'>hash: Close or flush sha256 output ports before calling their 'get' procedure.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-06-12 23:55:22 +0200'>2016-06-12</span></td><td><a href='/guix/commit/tests/nar.scm?id=fe585be9aa8f5158a7dfb6477d19ece3d643dec3'>serialization: Add #:select? parameter to 'write-file'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-04-03 14:19:09 +0200'>2016-04-03</span></td><td><a href='/guix/commit/tests/nar.scm?id=a9edb211e733b8b34e67ec3b4450567e9376986f'>build: Add a Guile custom test driver using SRFI-64.</a><span class='msg-avail'>...</span></td><td>Mathieu Lirzin</td></tr>
<tr><td><span title='2015-08-26 00:43:36 +0200'>2015-08-26</span></td><td><a href='/guix/commit/tests/nar.scm?id=fe32241ad5394c12fc70a31de005ec1b563bbb4e'>tests: Work around Btrfs handling of nlink for empty directories.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2015-06-24 18:05:03 +0200'>2015-06-24</span></td><td><a href='/guix/commit/tests/nar.scm?id=8de3df72bc96cc3f7739e61699831557852cea6b'>tests: Move 'file=?' to (guix tests).</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>