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

}
ion 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=139da51753717a06692bd87a754f54b4e60f4fcd'>root</a>/<a href='/guix/log/doc?id=139da51753717a06692bd87a754f54b4e60f4fcd'>doc</a>/<a href='/guix/log/doc/htmlxref.cnf?id=139da51753717a06692bd87a754f54b4e60f4fcd'>htmlxref.cnf</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/doc/htmlxref.cnf?id=139da51753717a06692bd87a754f54b4e60f4fcd&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2022-08-05 00:14:29 +0200'>2022-08-05</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=f9a267c6d266355b48bd12288f4414eaf4db8b33'>doc: Fix Guix manual URLs in 'htmlxref.cnf'.</a><span class='msg-avail'>...<span class='msg-tooltip'>Fixes a regression introduced in
868da34d54365023223a4ff7520043ba55ad64e8.

* doc/htmlxref.cnf (GUIX): Remove "/guix".
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2022-06-16 21:52:49 -0400'>2022-06-16</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=ec7a75034421654d2ece2ba20033b44d345547f0'>doc: Remove obsolete comment from htmlxref.cnf.</a><span class='msg-avail'>...<span class='msg-tooltip'>This is follow up to &lt;https://issues.guix.gnu.org/55290&gt;.

* doc/htmlxref.cnf (geiser): Delete obsolete comment.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2022-04-08 19:59:25 +0200'>2022-04-08</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=868da34d54365023223a4ff7520043ba55ad64e8'>doc: Fix cookbook URLs in htmlxref.cnf.</a><span class='msg-avail'>...<span class='msg-tooltip'>Reported by Greg Hogan &lt;code@greghogan.com&gt;.

* doc/htmlxref.cnf (GUIX_ROOT): New variable.
(GUIX, GUIX_COOKBOOK): Adjust.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2021-10-04 16:36:58 +0200'>2021-10-04</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=1267c2e9efdb6e324ce1c7b1fcef242f8208a61f'>doc: Update htmlxref.cnf.</a><span class='msg-avail'>...<span class='msg-tooltip'>Update and fix broken references to cuirass, git, and guix-cookbook.

* doc/htmlxref.cnf: Update from Texinfo.  Factorize Guix manuals.
(cuirass, git, guix-cookbook, guix-cookbook.de, guix-cookbook.fr): New
entries.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Sarah Morgensen</td></tr>
<tr><td><span title='2021-04-24 16:46:22 +0200'>2021-04-24</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=1ebd086286c3825cfae31e75f8394986f1a18736'>doc: Fix cross-reference URL to translated manual.</a><span class='msg-avail'>...<span class='msg-tooltip'>* doc/htmlxref.cnf: Fix translated manual URL.
</span></span></td><td>Julien Lepiller</td></tr>
<tr><td><span title='2020-01-12 00:19:10 +0100'>2020-01-12</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=30d83f445b70ebce7f01eaa91c8f418ff0a98321'>doc: Update htmlxref.cnf.</a><span class='msg-avail'>...<span class='msg-tooltip'>* doc/htmlxref.cnf: Update from Texinfo.  Add entries for "mes",
"guix.ru", and "guix.zh_CN".
</span></span></td><td>Ludovic Courtès</td></tr>