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

}
>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=5dec941818b8a65ff2c1b8f1ed893c256a26e86c'>root</a>/<a href='/guix/log/gnu?id=5dec941818b8a65ff2c1b8f1ed893c256a26e86c'>gnu</a>/<a href='/guix/log/gnu/system?id=5dec941818b8a65ff2c1b8f1ed893c256a26e86c'>system</a>/<a href='/guix/log/gnu/system/examples?id=5dec941818b8a65ff2c1b8f1ed893c256a26e86c'>examples</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/system/examples?id=5dec941818b8a65ff2c1b8f1ed893c256a26e86c&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2022-08-09 15:16:06 +0200'>2022-08-09</span></td><td><a href='/guix/commit/gnu/system/examples?id=fdafd404325413da4d5fdd717c84e57a51c60fe2'>maint: Use a pretty version string in ISO and VM images.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/system/examples/vm-image.tmpl: Use the 'GUIX_DISPLAYED_VERSION'
environment variable in 'label'.
* gnu/system/install.scm (%installation-os): Likewise.
* Makefile.am (release): Set 'GUIX_DISPLAYED_VERSION'.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2022-08-09 15:16:06 +0200'>2022-08-09</span></td><td><a href='/guix/commit/gnu/system/examples?id=95a03aa5c507d48e2cde19ea007b8f90a4e0108a'>system: install: Always use 'current-guix'.</a><span class='msg-avail'>...<span class='msg-tooltip'>Fixes &lt;https://issues.guix.gnu.org/53210&gt;.
Reported by Mathieu Othacehe &lt;othacehe@gnu.org&gt;.

* gnu/system/install.scm (%installation-services): Set 'guix' to
use (current-guix) in 'guix-configuration'.
* gnu/system/examples/vm-image.tmpl: Likewise.
* gnu/tests/install.scm (operating-system-with-current-guix): Remove.
(run-install, installation-os-for-gui-tests): Remove its uses.
* Makefile.am (release): Remove intermediate use of
'update-guix-package.scm' and subsequent 'git commit' invocation.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2022-01-06 18:54:59 -0800'>2022-01-06</span></td><td><a href='/guix/commit/gnu/system/examples?id=79260c8695cc5e3cd64f5b01e262369d5a67f141'>services: Consistently use SDDM rather than GDM on non-x86_64.</a><span class='msg-avail'>...<span class='msg-tooltip'>This is a follow-up to 49599fab564f203b8e92d32e9b28c99e99849bfb.

Fixes: &lt;https://issues.guix.gnu.org/52908&gt;.

* gnu/services/xorg.scm (set-xorg-configuration)[login-manager-service-type]:
When the current system or target system begins with the string "x86_64", use
gdm-service-type as before; otherwise, use sddm-service-type.
* gnu/system/examples/vm-image.tmpl (services): Add sddm-service-type to the
list of service types to remove.
</span></span></td><td>Chris Marusich</td></tr>
<tr><td><span title='2022-01-05 21:46:41 +0100'>2022-01-05</span></td><td><a href='/guix/commit/gnu/system/examples?id=0fea9aec59f8f328c269d585d849a8f954e39aae'>doc: Only use GDM and GNOME on x86_64.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/system/examples/desktop.tmpl: Only use gnome-desktop-service-type and
the default login manager in set-xorg-configuration when the target system is
x86_64.
</span></span></td><td>Ricardo Wurmus</td></tr>
<tr><td><span title='2021-12-19 23:39:55 +0100'>2021-12-19</span></td><td><a href='/guix/commit/gnu/system/examples?id=9c42d1fa0023849f4cc62cea73469a08c1ab1fdd'>doc: Add group configuration example</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/system/examples/desktop.tmpl: Add group configuration example.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Denis 'GNUtoo' Carikli</td></tr>
<tr><td><span title='2021-11-23 10:24:28 +0100'>2021-11-23</span></td><td><a href='/guix/commit/gnu/system/examples?id=9685c0637decec77880cec65547a2e57c300761a'>doc: Add new Swap Space section.</a><span class='msg-avail'>...<span class='msg-tooltip'>* doc/guix.texi (operating-system Reference): Update swap-devices.
* doc/guix.texi (Swap Space): Add it.
* gnu/system/examples/desktop.tmpl: Add swap-devices example.

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