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

}
>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=b2504b1205aa77bcc4c1d0b2c4b402c07982cd7a'>root</a>/<a href='/guix/log/etc?id=b2504b1205aa77bcc4c1d0b2c4b402c07982cd7a'>etc</a>/<a href='/guix/log/etc/completion?id=b2504b1205aa77bcc4c1d0b2c4b402c07982cd7a'>completion</a>/<a href='/guix/log/etc/completion/bash?id=b2504b1205aa77bcc4c1d0b2c4b402c07982cd7a'>bash</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/etc/completion/bash?id=b2504b1205aa77bcc4c1d0b2c4b402c07982cd7a&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2019-04-29 10:13:44 +0200'>2019-04-29</span></td><td><a href='/guix/commit/etc/completion/bash?id=d824cfbabeb0780c9ea7a6dab02c47b6a4d029c6'>guix package: Add 'install', 'remove', and 'upgrade' aliases.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-11-06 00:04:11 +0100'>2018-11-06</span></td><td><a href='/guix/commit/etc/completion/bash?id=7082873ea2771ebef900333e0fa7468d6395f330'>bash completion: Restore completion of available packages for 'guix build'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-07-03 06:58:51 +0300'>2018-07-03</span></td><td><a href='/guix/commit/etc/completion/bash?id=3a15d0aa9c55881ddc3a21570350a743c28a6c92'>bash completion: Complete files names after 'guix weather -m'.</a><span class='msg-avail'>...</span></td><td>Oleg Pykhalov</td></tr>
<tr><td><span title='2018-07-03 06:58:51 +0300'>2018-07-03</span></td><td><a href='/guix/commit/etc/completion/bash?id=9b0a755f642542dd96065ad05ec9d844d8077fd7'>bash completion: Complete files names after 'guix build -L'.</a><span class='msg-avail'>...</span></td><td>Oleg Pykhalov</td></tr>
<tr><td><span title='2018-06-16 21:23:11 +0300'>2018-06-16</span></td><td><a href='/guix/commit/etc/completion/bash?id=bba0fa2499eefab02cacfed9958dc498abfd484d'>Add guix-daemon Bash completion file.</a><span class='msg-avail'>...</span></td><td>Oleg Pykhalov</td></tr>
<tr><td><span title='2018-02-17 22:23:07 +0300'>2018-02-17</span></td><td><a href='/guix/commit/etc/completion/bash?id=f5f916792c7069a22d95c5b7c68bcf3bbb86e451'>bash completion: Complete files names after 'guix package -m'.</a><span class='msg-avail'>...</span></td><td>Oleg Pykhalov</td></tr>
<tr><td><span title='2017-08-22 23:13:42 +0200'>2017-08-22</span></td><td><a href='/guix/commit/etc/completion/bash?id=ed8634c404410ed5e0d3ab06e43bd50d4eed9c42'>bash completion: Complete files names after 'guix download'.</a><span class='msg-avail'>...</span></td><td>Marius Bakke</td></tr>
<tr><td><span title='2017-02-07 00:08:10 +0100'>2017-02-07</span></td><td><a href='/guix/commit/etc/completion/bash?id=f2c66fbe1f01b720741e0fe2bfa619ca2862a6b8'>bash completion: Complete subcommands for the current word.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-02-07 00:08:10 +0100'>2017-02-07</span></td><td><a href='/guix/commit/etc/completion/bash?id=a93c1c59218aac49382c35fe23d1e0f021e6e676'>bash completion: Properly complete 'guix container exec'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-02-07 00:08:10 +0100'>2017-02-07</span></td><td><a href='/guix/commit/etc/completion/bash?id=e109ed3922f2a3ff68a77f727ead27f2eb4a82ab'>bash completion: Complete file names after 'guix system COMMAND'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-02-07 00:08:10 +0100'>2017-02-07</span></td><td><a href='/guix/commit/etc/completion/bash?id=3454f7edf9eb2901115cab522d980df712fa4078'>bash completion: Complete 'guix gc' with file names.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-09-07 17:33:48 +0200'>2016-09-07</span></td><td><a href='/guix/commit/etc/completion/bash?id=f07f7d86145c10539709ca43cb0c201b6f935005'>bash completion: Complete subcommands and their options.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2016-09-07 16:22:25 +0200'>2016-09-07</span></td><td><a href='/guix/commit/etc/completion/bash?id=e9006d06a04e60db1ca78283b6c7e951d5a477fd'>bash completion: Redirect 'guix' stderr to /dev/null.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>