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

}
'>
<option value='grep'>log 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=f72a1253a18798a25245b4124c1da35ed993e0d1'>root</a>/<a href='/guix/log/gnu?id=f72a1253a18798a25245b4124c1da35ed993e0d1'>gnu</a>/<a href='/guix/log/gnu/packages?id=f72a1253a18798a25245b4124c1da35ed993e0d1'>packages</a>/<a href='/guix/log/gnu/packages/electronics.scm?id=f72a1253a18798a25245b4124c1da35ed993e0d1'>electronics.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/packages/electronics.scm?id=f72a1253a18798a25245b4124c1da35ed993e0d1&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2021-04-20 11:13:07 +0200'>2021-04-20</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=a10177737136b9416949cdbf1cf76566eb3bd86b'>gnu: xoscope: Update to 2.3.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/electronics.scm (xoscope): Update to 2.3.
[native-inputs]: Add m4.
[inputs]: Substitute gtk+ for gtk+-2.
</span></span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2021-03-09 15:24:51 +0100'>2021-03-09</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=1e4b80ad65c4dc2cf51a8c7c2b76863cd2821e5a'>gnu: sigrok-cli: Update to 0.7.2.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/electronics.scm (sigrok-cli): Update to 0.7.2.
</span></span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2021-02-19 15:45:18 -0500'>2021-02-19</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=ffe4f87c87a28a9b4ea5e2f389932f3591e21b2b'>gnu: Add xoscope.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/electronics.scm (xoscope): New variable.
</span></span></td><td>Leo Famulari</td></tr>
<tr><td><span title='2021-02-19 15:45:18 -0500'>2021-02-19</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=c35157f78ef9a59db2d751d39d18b640414f04b2'>gnu: Add comedilib.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/electronics.scm (comedilib): New variable.
</span></span></td><td>Leo Famulari</td></tr>
<tr><td><span title='2021-01-10 14:23:20 +0200'>2021-01-10</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=d0fff8f840afc17be40bdc49bff52ed08d5a1a7b'>gnu: pulseview: Fix qt-5.15 compatibility.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/electronics.scm (pulseview)[source]: Add patch.
* gnu/packages/patches/pulseview-qt515-compat.patch: New file.
* gnu/local.mk (dist_patch_DATA): Register it.
</span></span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2021-01-10 14:05:03 +0200'>2021-01-10</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=a481c55dc91b9048fee2ef2317827e8d6b88679f'>gnu: pulseview: Update to 0.4.2.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/electronics.scm (pulseview): Update to 0.4.2.
[source]: Use https.
</span></span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2020-12-21 17:47:36 +0100'>2020-12-21</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=c626e281b4c7b522da6962bc045fe6372b18ac10'>gnu: sdcc: Move to embedded.scm.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/embedded.scm: Add sdcc from sdcc.scm.
* gnu/packages/electronics.scm: Update #:use-module directive.
* gnu/packages/sdcc.scm: Delete file.
* gnu/local.mk: Remove it.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Simon South</td></tr>
<tr><td><span title='2020-09-05 22:30:04 +0300'>2020-09-05</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=de3c03a47160dec355d9b19ad5ca210d90c15fd7'>Merge remote-tracking branch 'origin/master' into staging</a></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2020-07-25 18:47:55 +0200'>2020-07-25</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=406f3f9b8afe77823b11932586e32e259f1b9242'>gnu: libsigrok: Remove unused input.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/electronics.scm (libsigrok)[native-inputs]: Remove CHECK.
</span></span></td><td>Marius Bakke</td></tr>
<tr><td><span title='2020-07-25 16:16:11 +0200'>2020-07-25</span></td><td><a href='/guix/commit/gnu/packages/electronics.scm?id=e1409c764f554b688efe07c04bf90198daeca258'>gnu: check: Update to 0.15.1.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/check.scm (check): Update to 0.15.1.
(check-0.14): New public variable.
* gnu/packages/backup.scm (burp)[native-inputs]: Change from CHECK to
CHECK-0.14.
* gnu/packages/bioinformatics.scm (libsbml)[native-inputs]: Likewise.
* gnu/packages/databases.scm (recutils)[native-inputs]: Likewise.
* gnu/packages/electronics.scm (libsigrokdecode)[native-inputs]: Likewise.
* gnu/packages/enlightenment.scm (efl, edi)[native-inputs]: Likewise.
* gnu/packages/gnome.scm (gdm)[inputs]: Likewise.
* gnu/packages/gtk.scm (girara)[native-inputs]: Likewise.
* gnu/packages/messaging.scm (pidgin)[native-inputs]: Likewise.
* gnu/packages/networking.scm (iodine)[native-inputs]: Likewise.
* gnu/packages/pulseaudio.scm (pulseaudio)[native-inputs]: Likewise.
* gnu/packages/sssd.scm (sssd)[native-inputs]: Likewise.
* gnu/packages/web.scm (libwapcaplet)[native-inputs]: Likewise.
</span></span></td><td>Marius Bakke</td></tr>