janet/src/core/buffer.c

/*
* Copyright (c) 2018 Calvin Rose
*
* 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.
*/

#include <janet/janet.h>
#include "gc.h"

/* Initialize a buffer */
JanetBuffer *janet_buffer_init(JanetBuffer *buffer, int32_t capacity) {
    uint8_t *data = NULL;
    if (capacity > 0) {
        data = malloc(sizeof(uint8_t) * capacity);
        if (NULL == data) {
            JANET_OUT_OF_MEMORY;
        }
    }
    buffer->count = 0;
    buffer->capacity = capacity;
    buffer->data = data;
    return buffer;
}

/* Deinitialize a buffer (free data memory) */
void janet_buffer_deinit(JanetBuffer *buffer) {
    free(buffer->data);
}

/* Initialize a buffer */
JanetBuffer *janet_buffer(int32_t capacity) {
    JanetBuffer *buffer = janet_gcalloc(JANET_MEMORY_BUFFER, sizeof(JanetBuffer));
    return janet_buffer_init(buffer, capacity);
}

/* Ensure that the buffer has enough internal capacity */
void janet_buffer_ensure(JanetBuffer *buffer, int32_t capacity, int32_t growth) {
    uint8_t *new_data;
    uint8_t *old = buffer->data;
    if (capacity <= buffer->capacity) return;
    capacity *= growth;
    new_data = realloc(old, capacity * sizeof(uint8_t));
    if (NULL == new_data) {
        JANET_OUT_OF_MEMORY;
    }
    buffer->data = new_data;
    buffer->capacity = capacity;
}

/* Ensure that the buffer has enough internal capacity */
void janet_buffer_setcount(JanetBuffer *buffer, int32_t count) {
    if (count < 0)
        return;
    if (count > buffer->count) {
        int32_t oldcount = buffer->count;
        janet_buffer_ensure(buffer, count, 1);
        memset(buffer->data + oldcount, 0, count - oldcount);
    }
    buffer->count = count;
}

/* Adds capacity for enough extra bytes to the buffer. Ensures that the
 * next n bytes pushed to the buffer will not cause a reallocation */
int janet_buffer_extra(JanetBuffer *buffer, int32_t n) {
    /* Check for buffer overflow */
    if ((int64_t)n + buffer->count > INT32_MAX) {
        return -1;
    }
    int32_t new_size = buffer->count + n;
    if (new_size > buffer->capacity) {
        int32_t new_capacity = new_size * 2;
        uint8_t *new_data = realloc(buffer->data, new_capacity * sizeof(uint8_t));
        if (NULL == new_data) {
            JANET_OUT_OF_MEMORY;
        }
        buffer->data = new_data;
        buffer->capacity = new_capacity;
    }
    return 0;
}

/* Push a cstring to buffer */
int janet_buffer_push_cstring(JanetBuffer *buffer, const char *cstring) {
    int32_t len = 0;
    while (cstring[len]) ++len;
    return janet_buffer_push_bytes(buffer, (const uint8_t *) cstring, len);
}

/* Push multiple bytes into the buffer */
int janet_buffer_push_bytes(JanetBuffer *buffer, const uint8_t *string, int32_t length) {
    if (janet_buffer_extra(buffer, length)) return -1;
    memcpy(buffer->data + buffer->count, string, length);
    buffer->count += length;
    return 0;
}

int janet_buffer_push_string(JanetBuffer *buffer, const uint8_t *string) {
    return janet_buffer_push_bytes(buffer, string, janet_string_length(string));
}

/* Push a single byte to the buffer */
int janet_buffer_push_u8(JanetBuffer *buffer, uint8_t byte) {
    if (janet_buffer_extra(buffer, 1)) return -1;
    buffer->data[buffer->count] = byte;
    buffer->count++;
    return 0;
}

/* Push a 16 bit unsigned integer to the buffer */
int janet_buffer_push_u16(JanetBuffer *buffer, uint16_t x) {
    if (janet_buffer_extra(buffer, 2)) return -1;
    buffer->data[buffer->count] = x & 0xFF;
    buffer->data[buffer->count + 1] = (x >> 8) & 0xFF;
    buffer->count += 2;
    return 0;
}

/* Push a 32 bit unsigned integer to the buffer */
int janet_buffer_push_u32(JanetBuffer *buffer, uint32_t x) {
    if (janet_buffer_extra(buffer, 4)) return -1;
    buffer->data[buffer->count] = x & 0xFF;
    buffer->data[buffer->count + 1] = (x >> 8) & 0xFF;
    buffer->data[buffer->count + 2] = (x >> 16) & 0xFF;
    buffer->data[buffer->count + 3] = (x >> 24) & 0xFF;
    buffer->count += 4;
    return 0;
}

/* Push a 64 bit unsigned integer to the buffer */
int janet_buffer_push_u64(JanetBuffer *buffer, uint64_t x) {
    if (janet_buffer_extra(buffer, 8)) return -1;
    buffer->data[buffer->count] = x & 0xFF;
    buffer->data[buffer->count + 1] = (x >> 8) & 0xFF;
    buffer->data[buffer->count + 2] = (x >> 16) & 0xFF;
    buffer->data[buffer->count + 3] = (x >> 24) & 0xFF;
    buffer->data[buffer->count + 4] = (x >> 32) & 0xFF;
    buffer->data[buffer->count + 5] = (x >> 40) & 0xFF;
    buffer->data[buffer->count + 6] = (x >> 48) & 0xFF;
    buffer->data[buffer->count + 7] = (x >> 56) & 0xFF;
    buffer->count += 8;
    return 0;
}

/* C functions */

static int cfun_new(JanetArgs args) {
    int32_t cap;
    JanetBuffer *buffer;
    JANET_FIXARITY(args, 1);
    JANET_ARG_INTEGER(cap, args, 0);
    buffer = janet_buffer(cap);
    JANET_RETURN_BUFFER(args, buffer);
}

static int cfun_u8(JanetArgs args) {
    int32_t i;
    JanetBuffer *buffer;
    JANET_MINARITY(args, 1);
    JANET_ARG_BUFFER(buffer, args, 0);
    for (i = 1; i < args.n; i++) {
        int32_t integer;
        JANET_ARG_INTEGER(integer, args, i);
        if (janet_buffer_push_u8(buffer, (uint8_t) (integer & 0xFF)))
            JANET_THROW(args, "buffer overflow");
    }
    JANET_RETURN(args, args.v[0]);
}

static int cfun_int(JanetArgs args) {
    int32_t i;
    JanetBuffer *buffer;
    JANET_MINARITY(args, 1);
    JANET_ARG_BUFFER(buffer, args, 0);
    for (i = 1; i < args.n; i++) {
        int32_t integer;
        JANET_ARG_INTEGER(integer, args, i);
        if (janet_buffer_push_u32(buffer, (uint32_t) integer))
            JANET_THROW(args, "buffer overflow");
    }
    JANET_RETURN(args, args.v[0]);
}

static int cfun_chars(JanetArgs args) {
    int32_t i;
    JanetBuffer *buffer;
    JANET_MINARITY(args, 1);
    JANET_ARG_BUFFER(buffer, args, 0);
    for (i = 1; i < args.n; i++) {
        int32_t len;
        const uint8_t *str;
        JANET_ARG_BYTES(str, len, args, i);
        if (janet_buffer_push_bytes(buffer, str, len))
            JANET_THROW(args, "buffer overflow");
    }
    JANET_RETURN(args, args.v[0]);
}

static int cfun_clear(JanetArgs args) {
    JanetBuffer *buffer;
    JANET_FIXARITY(args, 1);
    JANET_ARG_BUFFER(buffer, args, 0);
    buffer->count = 0;
    JANET_RETURN(args, args.v[0]);
}

static int cfun_popn(JanetArgs args) {
    JanetBuffer *buffer;
    int32_t n;
    JANET_FIXARITY(args, 2);
    JANET_ARG_BUFFER(buffer, args, 0);
    JANET_ARG_INTEGER(n, args, 1);
    if (buffer->count < n) {
        buffer->count = 0;
    } else {
        buffer->count -= n;
    }
    JANET_RETURN(args, args.v[0]);
}

static int cfun_slice(JanetArgs args) {
    const uint8_t *data;
    int32_t len, start, end;
    JanetBuffer *ret;
    JANET_ARG_BYTES(data, len, args, 0);
    /* Get start */
    if (args.n < 2) {
        start = 0;
    } else if (janet_checktype(args.v[1], JANET_INTEGER)) {
        start = janet_unwrap_integer(args.v[1]);
    } else {
        JANET_THROW(args, "expected integer");
    }
    /* Get end */
    if (args.n < 3) {
        end = -1;
    } else if (janet_checktype(args.v[2], JANET_INTEGER)) {
        end = janet_unwrap_integer(args.v[2]);
    } else {
        JANET_THROW(args, "expected integer");
    }
    if (start < 0) start = len + start;
    if (end < 0) end = len + end + 1;
    if (end >= start) {
        ret = janet_buffer(end - start);
        memcpy(ret->data, data + start, end - start);
        ret->count = end - start;
    } else {
        ret = janet_buffer(0);
    }
    JANET_RETURN_BUFFER(args, ret);
}

static const JanetReg cfuns[] = {
    {"buffer.new", cfun_new, NULL},
    {"buffer.push-byte", cfun_u8, NULL},
    {"buffer.push-integer", cfun_int, NULL},
    {"buffer.push-string", cfun_chars, NULL},
    {"buffer.popn", cfun_popn, NULL},
    {"buffer.clear", cfun_clear, NULL},
    {"buffer.slice", cfun_slice, NULL},
    {NULL, NULL, NULL}
};

int janet_lib_buffer(JanetArgs args) {
    JanetTable *env = janet_env(args);
    janet_cfuns(env, NULL, cfuns);
    return 0;
}