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

}
es/python/sitecustomize.py'>
<input type='hidden' name='id' value='a44569899a54d18a70b62498bec3774f0be3f66b'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>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=a44569899a54d18a70b62498bec3774f0be3f66b'>root</a>/<a href='/guix/log/gnu?id=a44569899a54d18a70b62498bec3774f0be3f66b'>gnu</a>/<a href='/guix/log/gnu/packages?id=a44569899a54d18a70b62498bec3774f0be3f66b'>packages</a>/<a href='/guix/log/gnu/packages/aux-files?id=a44569899a54d18a70b62498bec3774f0be3f66b'>aux-files</a>/<a href='/guix/log/gnu/packages/aux-files/python?id=a44569899a54d18a70b62498bec3774f0be3f66b'>python</a>/<a href='/guix/log/gnu/packages/aux-files/python/sitecustomize.py?id=a44569899a54d18a70b62498bec3774f0be3f66b'>sitecustomize.py</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/packages/aux-files/python/sitecustomize.py?id=a44569899a54d18a70b62498bec3774f0be3f66b&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2022-01-10 11:44:26 -0500'>2022-01-10</span></td><td><a href='/guix/commit/gnu/packages/aux-files/python/sitecustomize.py?id=223cc96e5bb8d7d71f4b769ce722ebbdcebb8289'>sitecustomize.py: Honor .pth files.</a><span class='msg-avail'>...<span class='msg-tooltip'>Fixes &lt;https://issues.guix.gnu.org/52269&gt;.

* gnu/packages/aux-files/python/sitecustomize.py: Use site.addsitedirs to add
the site directories; this takes care of the .pth files.  Make sure the added
items still appear before Python's own 'site-packages' directory.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-11-11 10:31:32 -0500'>2021-11-11</span></td><td><a href='/guix/commit/gnu/packages/aux-files/python/sitecustomize.py?id=874188c0ab2955412519dc917402fefc6dd723fc'>aux-files: sitecustomize: Cleanup and add explanatory comments.</a><span class='msg-avail'>...<span class='msg-tooltip'>Fixes &lt;https://issues.guix.gnu.org/50105&gt;.

* gnu/packages/aux-files/python/sitecustomize.py: Add a comment explaining the
general idea, and use sys.prefix instead of sys.executable.

(major_minor): Use the unpacking operator (*) to provide the arguments.
(site_packages_prefix): Use os.path.join to form the path.
(python_site): Likewise.  Use sys.prefix instead of sys.executable.
(all_sites_raw): Split on os.path.pathsep.
(sys.path): Directly splice the result in the list.

Suggested-by: Hartmut Goebel &lt;h.goebel@crazy-compilers.com&gt;
Reported-by: Mathieu Othacehe &lt;othacehe@gnu.org&gt;
Signed-off-by: Maxim Cournoyer &lt;maxim.cournoyer@gmail.com&gt;
</span></span></td><td>Maxim Cournoyer</td></tr>