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

}
mitter'>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=ca6e688883c1ddf756c285dff9cf524b5955852d'>root</a>/<a href='/guix/log/tests?id=ca6e688883c1ddf756c285dff9cf524b5955852d'>tests</a>/<a href='/guix/log/tests/cran.scm?id=ca6e688883c1ddf756c285dff9cf524b5955852d'>cran.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/tests/cran.scm?id=ca6e688883c1ddf756c285dff9cf524b5955852d&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2021-12-18 04:09:47 +0100'>2021-12-18</span></td><td><a href='/guix/commit/tests/cran.scm?id=10ceb3e84654e024f14a4b048e7d68492ed9dc7c'>import: cran: Fix description-&gt;package test.</a><span class='msg-avail'>...<span class='msg-tooltip'>This follows up on commit 5cd1019488c44081aaf030fbe8bc357d78daef23.

* tests/cran.scm (description): Include a very long line.
(description-&gt;package): Update the golden description to match the
paragraph filling now performed by BEAUTIFY-DESCRIPTION.
</span></span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2021-07-11 00:49:16 +0200'>2021-07-11</span></td><td><a href='/guix/commit/tests/cran.scm?id=aa6921634b4ea9988af0e37bfbb56780c431ef64'>import: cran: Emit new-style package inputs.</a><span class='msg-avail'>...<span class='msg-tooltip'>* guix/import/cran.scm (format-inputs): Emit symbols or
'specification-&gt;package' calls.
(maybe-inputs): Wrap in 'list' instead of 'quasiquote'.
* tests/cran.scm ("description-&gt;package"): Adjust accordingly.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2020-01-16 23:14:05 +0100'>2020-01-16</span></td><td><a href='/guix/commit/tests/cran.scm?id=cfd1ed84013df85f0e473884ef4038b4bd7120d4'>import: cran: Avoid uses of '@@' in the tests.</a><span class='msg-avail'>...<span class='msg-tooltip'>* guix/import/cran.scm (description-&gt;alist, description-&gt;package): Export.
&lt;top level&gt;: Set! 'listify'.
* tests/cran.scm (description-alist, "description-&gt;package"): Remove use
of '@@' to access the relevant bindings.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-05-13 12:40:20 +0200'>2017-05-13</span></td><td><a href='/guix/commit/tests/cran.scm?id=db427602d8f993ee0025fa68d1af274aa8d69ab9'>import: cran: Robustify cran-package?.</a><span class='msg-avail'>...<span class='msg-tooltip'>* guix/import/cran.scm (package-&gt;upstream-name): Return #f if url
  start and end index could not be determined.
  (cran-package?): Check if the upstream-name can be extracted from
  given package.
* tests/cran.scm: Add "r-minimal is not a cran package" to make sure that
  r-minimal is not detected as a cran package.

This fixes a failure of guix refresh on r-minimal because no
upsteam-name can be determined from ".../R-version.tar.gz" uri.
</span></span></td><td>Mathieu Othacehe</td></tr>
<tr><td><span title='2017-03-08 23:42:52 +0100'>2017-03-08</span></td><td><a href='/guix/commit/tests/cran.scm?id=dd420bf3430eb644b93ca224da4c0a3f5db7a42f'>tests: Avoid zero-expression 'begin' form.</a><span class='msg-avail'>...<span class='msg-tooltip'>* tests/cran.scm ("description-&gt;package"): Add body after the expected
pattern in 'match'.
</span></span></td><td>Ludovic Courtès</td></tr>