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


// FIXME: global variables are bad m'kay.
extern bool useCaseHack;


}
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=acb08304c862d65679086a9f160240bfd598289d'>root</a>/<a href='/guix/log/tests?id=acb08304c862d65679086a9f160240bfd598289d'>tests</a>/<a href='/guix/log/tests/guix-shell.sh?id=acb08304c862d65679086a9f160240bfd598289d'>guix-shell.sh</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/guix-shell.sh?id=acb08304c862d65679086a9f160240bfd598289d&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2022-02-18 14:14:38 +0100'>2022-02-18</span></td><td><a href='/guix/commit/tests/guix-shell.sh?id=5a57313918a5c1bd5cf8238c2dcae64a03523952'>profiles: 'profile-derivation' rejects unsupported packages.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2021-12-10 21:49:25 +0100'>2021-12-10</span></td><td><a href='/guix/commit/tests/guix-shell.sh?id=32750e8c3ed38df4cafb39cffa878c6851abc899'>Merge remote-tracking branch 'signed/master' into core-updates</a></td><td>Mathieu Othacehe</td></tr>
<tr><td><span title='2021-12-10 15:32:44 +0100'>2021-12-10</span></td><td><a href='/guix/commit/tests/guix-shell.sh?id=71977101218d1fd5d7f5016cbbcb8710be057d49'>shell: When using '-D -f', '-D' has no effect on remaining packages.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2021-11-18 22:59:40 +0100'>2021-11-18</span></td><td><a href='/guix/commit/tests/guix-shell.sh?id=3ad135625b7c33f9c680943a6b79e4593c308249'>shell: Adjust test to expect C_INCLUDE_PATH, not CPATH.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2021-10-30 19:12:40 +0200'>2021-10-30</span></td><td><a href='/guix/commit/tests/guix-shell.sh?id=98173af5222ab5e879e44ba9521dec5416ba8c60'>shell: Error out when an unauthorized guix.scm/manifest.scm is found.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2021-10-25 19:02:23 +0200'>2021-10-25</span></td><td><a href='/guix/commit/tests/guix-shell.sh?id=746584e0ca200e7bf51b139ceb36c19ea81d6ef1'>shell: By default load the local 'manifest.scm' or 'guix.scm' file.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2021-10-25 18:58:18 +0200'>2021-10-25</span></td><td><a href='/guix/commit/tests/guix-shell.sh?id=80edb7df6586464aa40e84e103f0045452de95db'>Add 'guix shell'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>