aboutsummaryrefslogtreecommitdiff
path: root/nix/libutil/archive.hh
blob: 9b83a5f288ff8f94a5cbb666bc8db78ed2c0a828 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#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);

}
0e2fe20d5f1fe'>tests: Update (guix build store-copy) tests....Ludovic Courtès 2018-09-09Merge branch 'master' into core-updatesMarius Bakke 2018-09-08gexp: 'file-union' accepts directory names....Ludovic Courtès 2018-07-26gexp: Remove backward compatibility hack for 'imported-files'....Ludovic Courtès 2018-07-19gexp: 'imported-files/derivation' can copy files instead of symlinking....Ludovic Courtès 2018-07-19gexp: 'imported-files' no longer creates a derivation by default....Ludovic Courtès 2018-07-13tests: Don't rely on temporary directories being permanent....Leo Famulari 2018-06-14store-copy: 'read-reference-graph' returns a list of records....Ludovic Courtès 2018-06-01gexp: Add 'with-extensions'....Ludovic Courtès 2018-04-11gexp: 'scheme-file' can splice expressions....Ludovic Courtès 2018-03-23gexp: 'program-file' has a new #:module-path parameter....Ludovic Courtès 2018-03-23gexp: 'gexp->script' and 'gexp->file' have a new #:module-path parameter....Ludovic Courtès