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


}
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=8f895c52c6fd4bf1a19113a503865d511a101bea'>root</a>/<a href='/guix/log/gnu?id=8f895c52c6fd4bf1a19113a503865d511a101bea'>gnu</a>/<a href='/guix/log/gnu/services?id=8f895c52c6fd4bf1a19113a503865d511a101bea'>services</a>/<a href='/guix/log/gnu/services/nix.scm?id=8f895c52c6fd4bf1a19113a503865d511a101bea'>nix.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<tr><td><span title='2019-06-10 23:11:07 +0200'>2019-06-10</span></td><td><a href='/guix/commit/gnu/artwork.scm?id=226a3605d6cabeb7<tr><td><span title='2024-06-02 18:04:34 +0300'>2024-06-02</span></td><td><a href='/guix/commit/gnu/services/nix.scm?id=bc06affabcf68bbe93e9afee13bef8cc8c6336a2'>services: nix: Fix activation.</a><span class='msg-avail'>...<span class='msg-tooltip'>This commit follows 797be0ea5c3703ad96<tr><td><span title='2019-03-05 23:08:53 +0100'>2019-03-05</span></td><td><a href='/guix/commit/gnu/artwork.scm?id=5387971a9ecf511e1dbbac992af3808437e58d56'>artwork: Update snapshot to b975164.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/artwork.scm (%artwork-repository): Update to b975164.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2019-02-10 23:25:01 +0100'>2019-02-10</span></td><td><a href='/guix/commit/gnu/artwork.scm?id=5e6a5aeebd7b735e5d5f2eed496cc1c7e8a5b4c9'>artwork: Update snapshot to e951905.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/artwork.scm (%artwork-repository): Update to e951905.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-11-05 00:08:47 +0100'>2018-11-05</span></td><td><a href='/guix/commit/gnu/artwork.scm?id=688d1a01e45eb1277a6337987bfd53f3fe3<tr><td><span title='2022-12-15 10:13:24 +0000'>2022-12-15</span></td><td><a href='/guix/commit/gnu/services/nix.scm?id=f4dc53881b79b324ce7da731ac579a41c5078a48'>services: nix: Fix nix-shepherd-service.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/services/nix.scm (nix-shepherd-service): Un-gexp build-directory.
</span></span></td><td>Christopher Baines</td></tr>
<tr><td><span title='2022-12-13 17:46:39 +0100'>2022-12-13</span></td><td><a href='/guix/commit/gnu/services/nix.scm?id=22acc0b0291cc067a6a3ce36c7ca8e5f68fe4db6'>services: nix: Add more configuration fields.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/services/nix.scm (&lt;nix-configuration&gt;)[build-directory]: New field.
(nix-service-etc, nix-shepherd-service): Take them into account.
* doc/guix.texi (Nix): Update it.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Petr Hodina</td></tr>