#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=e13354a7ca5a0d5e28e02c4cfce6fecb1ab770e4'>root</a>/<a href='/guix/log/doc?id=e13354a7ca5a0d5e28e02c4cfce6fecb1ab770e4'>doc</a>/<a href='/guix/log/doc/htmlxref.cnf?id=e13354a7ca5a0d5e28e02c4cfce6fecb1ab770e4'>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=e13354a7ca5a0d5e28e02c4cfce6fecb1ab770e4&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2019-05-04 23:07:38 +0200'>2019-05-04</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=e8f8363cdebb24dc359cadba7ae0a689fb21fb99'>doc: Update htmlxref.cnf.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-07-05 22:16:10 +0200'>2018-07-05</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=c35f77c5a07690fc9d369ed4b751a5a9e5de6cf1'>doc: Update URL of the Emacs-Guix manual.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-07-05 22:13:23 +0200'>2018-07-05</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=56b4dabc2ba3446ff212e0d4d9e2df15fc25e88f'>doc: Mention translations of the manual.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-05-30 18:30:39 +0300'>2017-05-30</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=f753c2829913a9bb61dc266f4b1db8275e34a461'>doc: htmlxref: Fix link to Emacs-Guix manual.</a><span class='msg-avail'>...</span></td><td>Alex Kost</td></tr>
<tr><td><span title='2017-05-04 22:45:53 +0300'>2017-05-04</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=8ca0c88a894c685b624757e38ee7663534f03460'>doc: Add references to Emacs-Guix manual.</a><span class='msg-avail'>...</span></td><td>Alex Kost</td></tr>
<tr><td><span title='2016-12-29 23:40:24 +0300'>2016-12-29</span></td><td><a href='/guix/commit/doc/htmlxref.cnf?id=deb6276dda81a69da38e842d269c5370a28fa5cf'>Remove Emacs interface.</a><span class='msg-avail'>...</span></td><td>Alex Kost</td></tr>