xstream.h

[詳解]

/*
 * License: MIT license
 * Copyright (c) <2016> <MaskedW [maskedw00@gmail.com]>
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef picox_core_detail_xstream_h_
#define picox_core_detail_xstream_h_


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


typedef int (*XStreamReadFunc)(void* driver, void* dst, size_t size, size_t* nread);


typedef int (*XStreamWriteFunc)(void* driver, const void* src, size_t size, size_t* nwritten);


typedef int (*XStreamSeekFunc)(void* driver, XOffset offset, XSeekMode mode);


typedef int (*XStreamTellFunc)(void* driver, XSize* pos);


typedef int (*XStreamSizeFunc)(void* driver, XSize* size);


typedef int (*XStreamFlushFunc)(void* driver);


typedef int (*XStreamCloseFunc)(void* driver);


typedef const char* (*XStreamErrorStringFunc)(int errcode);


typedef struct XStream
{
    XTag                    tag;

    void*                   driver;

    int                     error;
    XStreamReadFunc         read_func;
    XStreamWriteFunc        write_func;
    XStreamCloseFunc        close_func;
    XStreamFlushFunc        flush_func;
    XStreamSeekFunc         seek_func;
    XStreamTellFunc         tell_func;
    XStreamErrorStringFunc  error_string_func;
} XStream;


#define X_STREAM_TAG        (X_MAKE_TAG('X', 'S', 'T', 'R'))


typedef struct XMemStream
{
    XStream         stream;
    uint8_t*        mem;
    XSize           pos;
    XSize           size;
    XSize           capacity;
} XMemStream;


#define X_MEMSTREAM_TAG     (X_MAKE_TAG('X', 'M', 'M', 'S'))


void xstream_init(XStream* self);


int xstream_read(XStream* self, void* dst, size_t size, size_t* nread);


int xstream_write(XStream* self, const void* src, size_t size, size_t* nwritten);


int xstream_close(XStream* self);


int xstream_flush(XStream* self);


int xstream_seek(XStream* self, XOffset offset, XSeekMode mode);


int xstream_tell(XStream* self, XSize* pos);


int xstream_error(const XStream* self);


const char* xstream_error_string(const XStream* self, int errcode);


int xstream_putc(XStream* self, int c);


int xstream_getc(XStream* self);


int xstream_gets(XStream* self, char* dst, size_t size, char** result, bool* overflow);


int xstream_printf(XStream* self, const char* fmt, ...);


int xstream_vprintf(XStream* self, const char* fmt, va_list args);


void xmemstream_init(XMemStream* self, void* mem, size_t size, size_t capacity);


static inline XMemStream* x_memstream_cast(XStream* stream)
{
    X_ASSERT(stream);
    return (stream->tag == X_MEMSTREAM_TAG) ? (XMemStream*)stream : NULL;
}


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* picox_core_detail_xstream_h_ */