#pragma once

#include "types.hh"


namespace nix {


/* Abstract destination of binary data. */
struct Sink 
{
    virtual ~Sink() { }
    virtual void operator () (const unsigned char * data, size_t len) = 0;
};


/* A buffered abstract sink. */
struct BufferedSink : Sink
{
    size_t bufSize, bufPos;
    unsigned char * buffer;

    BufferedSink(size_t bufSize = 32 * 1024)
        : bufSize(bufSize), bufPos(0), buffer(0) { }
    ~BufferedSink();

    void operator () (const unsigned char * data, size_t len);
    
    void flush();
    
    virtual void write(const unsigned char * data, size_t len) = 0;
};


/* Abstract source of binary data. */
struct Source
{
    virtual ~Source() { }
    
    /* Store exactly ‘len’ bytes in the buffer pointed to by ‘data’.
       It blocks until all the requested data is available, or throws
       an error if it is not going to be available.   */
    void operator () (unsigned char * data, size_t len);

    /* Store up to ‘len’ in the buffer pointed to by ‘data’, and
       return the number of bytes stored.  If blocks until at least
       one byte is available. */
    virtual size_t read(unsigned char * data, size_t len) = 0;
};


/* A buffered abstract source. */
struct BufferedSource : Source
{
    size_t bufSize, bufPosIn, bufPosOut;
    unsigned char * buffer;

    BufferedSource(size_t bufSize = 32 * 1024)
        : bufSize(bufSize), bufPosIn(0), bufPosOut(0), buffer(0) { }
    ~BufferedSource();
    
    size_t read(unsigned char * data, size_t len);
    
    /* Underlying read call, to be overridden. */
    virtual size_t readUnbuffered(unsigned char * data, size_t len) = 0;

    bool hasData();
};


/* A sink that writes data to a file descriptor. */
struct FdSink : BufferedSink
{
    int fd;
    bool warn;
    size_t written;

    FdSink() : fd(-1), warn(false), written(0) { }
    FdSink(int fd) : fd(fd), warn(false), written(0) { }
    ~FdSink();
    
    void write(const unsigned char * data, size_t len);
};


/* A source that reads data from a file descriptor. */
struct FdSource : BufferedSource
{
    int fd;
    FdSource() : fd(-1) { }
    FdSource(int fd) : fd(fd) { }
    size_t readUnbuffered(unsigned char * data, size_t len);
};


/* A sink that writes data to a string. */
struct StringSink : Sink
{
    string s;
    void operator () (const unsigned char * data, size_t len);
};


/* A source that reads data from a string. */
struct StringSource : Source
{
    const string & s;
    size_t pos;
    StringSource(const string & _s) : s(_s), pos(0) { }
    size_t read(unsigned char * data, size_t len);    
};


void writePadding(size_t len, Sink & sink);
void writeInt(unsigned int n, Sink & sink);
void writeLongLong(unsigned long long n, Sink & sink);
void writeString(const unsigned char * buf, size_t len, Sink & sink);
void writeString(const string & s, Sink & sink);
template<class T> void writeStrings(const T & ss, Sink & sink);

void readPadding(size_t len, Source & source);
unsigned int readInt(Source & source);
unsigned long long readLongLong(Source & source);
size_t readString(unsigned char * buf, size_t max, Source & source);
string readString(Source & source);
template<class T> T readStrings(Source & source);


MakeError(SerialisationError, Error)


}
-package' changes.</a><span class='msg-avail'>...<span class='msg-tooltip'>This is a followup to a8dccd4bdc1e58219d4ba08fe1649bf0b8325f44, which
broke the test.

* guix/import/opam.scm (get-opam-repository): Prevent inlining.
* tests/opam.scm ("opam-&gt;guix-package"): Mock 'get-opam-repository'.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2020-12-08 16:40:30 +0100'>2020-12-08</span></td><td><a href='/guix/commit/tests/opam.scm?id=15ee1b8317adeb74938f3bb7f0c7cb635a818292'>guix: opam: Pass default repository to recursive importer.</a><span class='msg-avail'>...<span class='msg-tooltip'>* guix/import/opam.scm (opam-&gt;guix-package): Rename #:repository key
to #:repo.
(opam-recursive-import): Pass #:repo keyword.
* tests/opam.scm (opam-&gt;guix-package): Rename #:repository to #:repo.
</span></span></td><td>Julien Lepiller</td></tr>
<tr><td><span title='2020-10-02 00:44:14 +0200'>2020-10-02</span></td><td><a href='/guix/commit/tests/opam.scm?id=23dc21f05b54ef63daaea9eb301cfddbc4c82ddb'>tests: opam: Test additional syntax.</a><span class='msg-avail'>...<span class='msg-tooltip'>* tests/opam.scm (test-comment): New test.
(test-lists): Add more tests for complex list patterns.
</span></span></td><td>Julien Lepiller</td></tr>
<tr><td><span title='2020-10-02 00:30:23 +0200'>2020-10-02</span></td><td><a href='/guix/commit/tests/opam.scm?id=ad05537e32173403d034a0d552092f566abd05a5'>tests: opam: Factorize tests.</a><span class='msg-avail'>...<span class='msg-tooltip'>* tests/opam.scm: Remove duplicate code.
</span></span></td><td>Julien Lepiller</td></tr>
<tr><td><span title='2020-01-17 14:22:07 +0100'>2020-01-17</span></td><td><a href='/guix/commit/tests/opam.scm?id=282f91790a5bbd0d9b3223c4bfd45b66e418c200'>import: opam: Avoid uses of '@@' in tests.</a><span class='msg-avail'>...<span class='msg-tooltip'>* guix/import/opam.scm (string-pat, multiline-string, list-pat)
(dict, condition): Export.
(opam-fetch): Add optional 'repository' parameter.
(opam-&gt;guix-package): Add #:repository parameter and pass it to
'opam-fetch'.
* tests/opam.scm ("opam-&gt;guix-package"): Remove use of 'mock' and pass
TEST-REPO to 'opam-&gt;guix-package' instead.
("parse-strings", "parse-multiline-strings")
("parse-lists", "parse-dicts", "parse-conditions"): Remove uses of '@@',
which are no longer needed.
</span></span></td><td>Ludovic Courtès</td></tr>