blink_stream.h

/* Copyright (c) 2016 Cameron Harper
 * 
 * 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 BLINK_STREAM_H
#define BLINK_STREAM_H

 #ifdef __cplusplus
extern "C" {
#endif

/* includes ***********************************************************/

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

/* types **************************************************************/

struct blink_stream_user {
    bool (*read)(void *state, void *out, size_t bytesToRead);
    bool (*write)(void *state, const void *in, size_t bytesToWrite);
    uint32_t (*tell)(void *state);
    bool (*peek)(void *state, void *c);
    bool (*seekCur)(void *state, int32_t offset);
    bool (*seekSet)(void *state, uint32_t offset);
    bool (*eof)(void *state);
};

struct blink_stream {
    enum blink_stream_type {
        BLINK_STREAM_NULL = 0,        
        BLINK_STREAM_BUFFER,          
        BLINK_STREAM_USER,            
        BLINK_STREAM_BOUNDED          
    } type;
    union blink_stream_state {
        struct {
            const uint8_t *in;  
            uint8_t *out;       
            uint32_t max;       
            uint32_t pos;       
            bool eof;
        } buffer;
        struct {
            struct blink_stream_user fn;
            void *state;
        } user;
        struct {
            struct blink_stream *stream;
            uint32_t max;                   
            uint32_t pos;                              
        } bounded;
    } value;
    
};

typedef struct blink_stream * blink_stream_t;


/* function prototypes ************************************************/

bool BLINK_Stream_write(blink_stream_t self, const void *buf, size_t nbyte);

bool BLINK_Stream_read(blink_stream_t self, void *buf, size_t nbyte);

bool BLINK_Stream_peek(blink_stream_t self, void *buf);

blink_stream_t BLINK_Stream_initBufferReadOnly(struct blink_stream *self, const void *buf, uint32_t max);

blink_stream_t BLINK_Stream_initBuffer(struct blink_stream *self, void *buf, uint32_t max);

blink_stream_t BLINK_Stream_initUser(struct blink_stream *self, void *state, struct blink_stream_user fn);

blink_stream_t BLINK_Stream_initBounded(struct blink_stream *self, blink_stream_t stream, uint32_t max);

uint32_t BLINK_Stream_tell(blink_stream_t self);

bool BLINK_Stream_seekSet(blink_stream_t self, uint32_t offset);

bool BLINK_Stream_seekCur(blink_stream_t self, int32_t offset);

bool BLINK_Stream_eof(blink_stream_t self);

size_t BLINK_Stream_max(blink_stream_t self);

#ifdef __cplusplus
}
#endif

#endif