cbor 0.5.6.2

data/ext/cbor/buffer_class.c

@@ -0,0 +1,516 @@
+/*
+ * CBOR for Ruby
+ *
+ * Copyright (C) 2013 Carsten Bormann
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License").
+ *
+ * Based on:
+ ***********/
+/*
+ * MessagePack for Ruby
+ *
+ * Copyright (C) 2008-2013 Sadayuki Furuhashi
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include "compat.h"
+#include "ruby.h"
+#include "buffer.h"
+#include "buffer_class.h"
+
+VALUE cMessagePack_Buffer;
+
+static ID s_read;
+static ID s_readpartial;
+static ID s_write;
+static ID s_append;
+static ID s_close;
+
+#define BUFFER(from, name) \
+    msgpack_buffer_t *name = NULL; \
+    Data_Get_Struct(from, msgpack_buffer_t, name); \
+    if(name == NULL) { \
+        rb_raise(rb_eArgError, "NULL found for " # name " when shouldn't be."); \
+    }
+
+#define CHECK_STRING_TYPE(value) \
+    value = rb_check_string_type(value); \
+    if( NIL_P(value) ) { \
+        rb_raise(rb_eTypeError, "instance of String needed"); \
+    }
+
+static void Buffer_free(void* data)
+{
+    if(data == NULL) {
+        return;
+    }
+    msgpack_buffer_t* b = (msgpack_buffer_t*) data;
+    msgpack_buffer_destroy(b);
+    free(b);
+}
+
+static VALUE Buffer_alloc(VALUE klass)
+{
+    msgpack_buffer_t* b = ALLOC_N(msgpack_buffer_t, 1);
+    msgpack_buffer_init(b);
+
+    return Data_Wrap_Struct(klass, msgpack_buffer_mark, Buffer_free, b);
+}
+
+static ID get_partial_read_method(VALUE io)
+{
+    if(rb_respond_to(io, s_readpartial)) {
+        return s_readpartial;
+    } else if(rb_respond_to(io, s_read)) {
+        return s_read;
+    } else {
+        return s_read;
+    }
+}
+
+static ID get_write_all_method(VALUE io)
+{
+    if(rb_respond_to(io, s_write)) {
+        return s_write;
+    } else if(rb_respond_to(io, s_append)) {
+        return s_append;
+    } else {
+        return s_write;
+    }
+}
+
+void MessagePack_Buffer_initialize(msgpack_buffer_t* b, VALUE io, VALUE options)
+{
+    b->io = io;
+    b->io_partial_read_method = get_partial_read_method(io);
+    b->io_write_all_method = get_write_all_method(io);
+
+    if(options != Qnil) {
+        VALUE v;
+
+        v = rb_hash_aref(options, ID2SYM(rb_intern("read_reference_threshold")));
+        if(v != Qnil) {
+            msgpack_buffer_set_read_reference_threshold(b, NUM2ULONG(v));
+        }
+
+        v = rb_hash_aref(options, ID2SYM(rb_intern("write_reference_threshold")));
+        if(v != Qnil) {
+            msgpack_buffer_set_write_reference_threshold(b, NUM2ULONG(v));
+        }
+
+        v = rb_hash_aref(options, ID2SYM(rb_intern("io_buffer_size")));
+        if(v != Qnil) {
+            msgpack_buffer_set_io_buffer_size(b, NUM2ULONG(v));
+        }
+    }
+}
+
+VALUE MessagePack_Buffer_wrap(msgpack_buffer_t* b, VALUE owner)
+{
+    b->owner = owner;
+    return Data_Wrap_Struct(cMessagePack_Buffer, msgpack_buffer_mark, NULL, b);
+}
+
+static VALUE Buffer_initialize(int argc, VALUE* argv, VALUE self)
+{
+    VALUE io = Qnil;
+    VALUE options = Qnil;
+
+    if(argc == 0 || (argc == 1 && argv[0] == Qnil)) {
+        /* Qnil */
+
+    } else if(argc == 1) {
+        VALUE v = argv[0];
+        if(rb_type(v) == T_HASH) {
+            options = v;
+        } else {
+            io = v;
+        }
+
+    } else if(argc == 2) {
+        io = argv[0];
+        options = argv[1];
+        if(rb_type(options) != T_HASH) {
+            rb_raise(rb_eArgError, "expected Hash but found %s.", rb_obj_classname(io));
+        }
+
+    } else {
+        rb_raise(rb_eArgError, "wrong number of arguments (%d for 0..1)", argc);
+    }
+
+    BUFFER(self, b);
+
+    MessagePack_Buffer_initialize(b, io, options);
+
+    return self;
+}
+
+static VALUE Buffer_clear(VALUE self)
+{
+    BUFFER(self, b);
+    msgpack_buffer_clear(b);
+    return Qnil;
+}
+
+static VALUE Buffer_size(VALUE self)
+{
+    BUFFER(self, b);
+    size_t size = msgpack_buffer_all_readable_size(b);
+    return SIZET2NUM(size);
+}
+
+static VALUE Buffer_empty_p(VALUE self)
+{
+    BUFFER(self, b);
+    if(msgpack_buffer_top_readable_size(b) == 0) {
+        return Qtrue;
+    } else {
+        return Qfalse;
+    }
+}
+
+static VALUE Buffer_write(VALUE self, VALUE string_or_buffer)
+{
+    BUFFER(self, b);
+
+    VALUE string = string_or_buffer;  // TODO optimize if string_or_buffer is a Buffer
+    StringValue(string);
+
+    size_t length = msgpack_buffer_append_string(b, string);
+
+    return SIZET2NUM(length);
+}
+
+static VALUE Buffer_append(VALUE self, VALUE string_or_buffer)
+{
+    BUFFER(self, b);
+
+    VALUE string = string_or_buffer;  // TODO optimize if string_or_buffer is a Buffer
+    StringValue(string);
+
+    msgpack_buffer_append_string(b, string);
+
+    return self;
+}
+
+
+#define MAKE_EMPTY_STRING(orig) \
+    if(orig == Qnil) { \
+        orig = rb_str_buf_new(0); \
+    } else { \
+        rb_str_resize(orig, 0); \
+    }
+
+static VALUE read_until_eof_rescue(VALUE args)
+{
+    msgpack_buffer_t* b = (void*) ((VALUE*) args)[0];
+    VALUE out = ((VALUE*) args)[1];
+    unsigned long max = ((VALUE*) args)[2];
+    size_t* sz = (void*) ((VALUE*) args)[3];
+
+    while(true) {
+        size_t rl;
+        if(max == 0) {
+            if(out == Qnil) {
+                rl = msgpack_buffer_skip(b, b->io_buffer_size);
+            } else {
+                rl = msgpack_buffer_read_to_string(b, out, b->io_buffer_size);
+            }
+            if(rl == 0) {
+                break;
+            }
+            *sz += rl;
+
+        } else {
+            if(out == Qnil) {
+                rl = msgpack_buffer_skip(b, max);
+            } else {
+                rl = msgpack_buffer_read_to_string(b, out, max);
+            }
+            if(rl == 0) {
+                break;
+            }
+            *sz += rl;
+            if(max <= rl) {
+                break;
+            } else {
+                max -= rl;
+            }
+        }
+    }
+
+    return Qnil;
+}
+
+static VALUE read_until_eof_error(VALUE args)
+{
+    /* ignore EOFError */
+    UNUSED(args);
+    return Qnil;
+}
+
+static inline size_t read_until_eof(msgpack_buffer_t* b, VALUE out, unsigned long max)
+{
+    if(msgpack_buffer_has_io(b)) {
+        size_t sz = 0;
+        VALUE args[4] = { (VALUE)(void*) b, out, (VALUE) max, (VALUE)(void*) &sz };
+        rb_rescue2(read_until_eof_rescue, (VALUE)(void*) args,
+                read_until_eof_error, (VALUE)(void*) args,
+                rb_eEOFError, NULL);
+        return sz;
+
+    } else {
+        if(max == 0) {
+            max = ULONG_MAX;
+        }
+        if(out == Qnil) {
+            return msgpack_buffer_skip_nonblock(b, max);
+        } else {
+            return msgpack_buffer_read_to_string_nonblock(b, out, max);
+        }
+    }
+}
+
+static inline VALUE read_all(msgpack_buffer_t* b, VALUE out)
+{
+#ifndef DISABLE_BUFFER_READ_TO_S_OPTIMIZE
+    if(out == Qnil && !msgpack_buffer_has_io(b)) {
+        /* same as to_s && clear; optimize */
+        VALUE str = msgpack_buffer_all_as_string(b);
+        msgpack_buffer_clear(b);
+        return str;
+    }
+#endif
+    MAKE_EMPTY_STRING(out);
+    read_until_eof(b, out, 0);
+    return out;
+}
+
+static VALUE Buffer_skip(VALUE self, VALUE sn)
+{
+    BUFFER(self, b);
+
+    unsigned long n = FIX2ULONG(sn);
+
+    /* do nothing */
+    if(n == 0) {
+        return ULONG2NUM(0);
+    }
+
+    size_t sz = read_until_eof(b, Qnil, n);
+    return ULONG2NUM(sz);
+}
+
+static VALUE Buffer_skip_all(VALUE self, VALUE sn)
+{
+    BUFFER(self, b);
+
+    unsigned long n = FIX2ULONG(sn);
+
+    /* do nothing */
+    if(n == 0) {
+        return self;
+    }
+
+    if(!msgpack_buffer_ensure_readable(b, n)) {
+        rb_raise(rb_eEOFError, "end of buffer reached");
+    }
+
+    msgpack_buffer_skip_nonblock(b, n);
+
+    return self;
+}
+
+static VALUE Buffer_read_all(int argc, VALUE* argv, VALUE self)
+{
+    VALUE out = Qnil;
+    unsigned long n = 0;
+    bool all = false;
+
+    switch(argc) {
+    case 2:
+        out = argv[1];
+        /* pass through */
+    case 1:
+        n = FIX2ULONG(argv[0]);
+        break;
+    case 0:
+        all = true;
+        break;
+    default:
+        rb_raise(rb_eArgError, "wrong number of arguments (%d for 0..2)", argc);
+    }
+
+    BUFFER(self, b);
+
+    if(out != Qnil) {
+        CHECK_STRING_TYPE(out);
+    }
+
+    if(all) {
+        return read_all(b, out);
+    }
+
+    if(n == 0) {
+        /* do nothing */
+        MAKE_EMPTY_STRING(out);
+        return out;
+    }
+
+    if(!msgpack_buffer_ensure_readable(b, n)) {
+        rb_raise(rb_eEOFError, "end of buffer reached");
+    }
+
+    MAKE_EMPTY_STRING(out);
+    msgpack_buffer_read_to_string_nonblock(b, out, n);
+
+    return out;
+}
+
+static VALUE Buffer_read(int argc, VALUE* argv, VALUE self)
+{
+    VALUE out = Qnil;
+    unsigned long n = -1;
+    bool all = false;
+
+    switch(argc) {
+    case 2:
+        out = argv[1];
+        /* pass through */
+    case 1:
+        n = FIX2ULONG(argv[0]);
+        break;
+    case 0:
+        all = true;
+        break;
+    default:
+        rb_raise(rb_eArgError, "wrong number of arguments (%d for 0..2)", argc);
+    }
+
+    BUFFER(self, b);
+
+    if(out != Qnil) {
+        CHECK_STRING_TYPE(out);
+    }
+
+    if(all) {
+        return read_all(b, out);
+    }
+
+    if(n == 0) {
+        /* do nothing */
+        MAKE_EMPTY_STRING(out);
+        return out;
+    }
+
+#ifndef DISABLE_BUFFER_READ_TO_S_OPTIMIZE
+    if(!msgpack_buffer_has_io(b) && out == Qnil &&
+            msgpack_buffer_all_readable_size(b) <= n) {
+        /* same as to_s && clear; optimize */
+        VALUE str = msgpack_buffer_all_as_string(b);
+        msgpack_buffer_clear(b);
+
+        if(RSTRING_LEN(str) == 0) {
+            return Qnil;
+        } else {
+            return str;
+        }
+    }
+#endif
+
+    MAKE_EMPTY_STRING(out);
+    read_until_eof(b, out, n);
+
+    if(RSTRING_LEN(out) == 0) {
+        return Qnil;
+    } else {
+        return out;
+    }
+}
+
+static VALUE Buffer_to_str(VALUE self)
+{
+    BUFFER(self, b);
+    return msgpack_buffer_all_as_string(b);
+}
+
+static VALUE Buffer_to_a(VALUE self)
+{
+    BUFFER(self, b);
+    return msgpack_buffer_all_as_string_array(b);
+}
+
+static VALUE Buffer_flush(VALUE self)
+{
+    BUFFER(self, b);
+    msgpack_buffer_flush(b);
+    return self;
+}
+
+static VALUE Buffer_io(VALUE self)
+{
+    BUFFER(self, b);
+    return b->io;
+}
+
+static VALUE Buffer_close(VALUE self)
+{
+    BUFFER(self, b);
+    if(b->io != Qnil) {
+        return rb_funcall(b->io, s_close, 0);
+    }
+    return Qnil;
+}
+
+static VALUE Buffer_write_to(VALUE self, VALUE io)
+{
+    BUFFER(self, b);
+    size_t sz = msgpack_buffer_flush_to_io(b, io, s_write, true);
+    return ULONG2NUM(sz);
+}
+
+void MessagePack_Buffer_module_init(VALUE mMessagePack)
+{
+    s_read = rb_intern("read");
+    s_readpartial = rb_intern("readpartial");
+    s_write = rb_intern("write");
+    s_append = rb_intern("<<");
+    s_close = rb_intern("close");
+
+    msgpack_buffer_static_init();
+
+    cMessagePack_Buffer = rb_define_class_under(mMessagePack, "Buffer", rb_cObject);
+
+    rb_define_alloc_func(cMessagePack_Buffer, Buffer_alloc);
+
+    rb_define_method(cMessagePack_Buffer, "initialize", Buffer_initialize, -1);
+    rb_define_method(cMessagePack_Buffer, "clear", Buffer_clear, 0);
+    rb_define_method(cMessagePack_Buffer, "size", Buffer_size, 0);
+    rb_define_method(cMessagePack_Buffer, "empty?", Buffer_empty_p, 0);
+    rb_define_method(cMessagePack_Buffer, "write", Buffer_write, 1);
+    rb_define_method(cMessagePack_Buffer, "<<", Buffer_append, 1);
+    rb_define_method(cMessagePack_Buffer, "skip", Buffer_skip, 1);
+    rb_define_method(cMessagePack_Buffer, "skip_all", Buffer_skip_all, 1);
+    rb_define_method(cMessagePack_Buffer, "read", Buffer_read, -1);
+    rb_define_method(cMessagePack_Buffer, "read_all", Buffer_read_all, -1);
+    rb_define_method(cMessagePack_Buffer, "io", Buffer_io, 0);
+    rb_define_method(cMessagePack_Buffer, "flush", Buffer_flush, 0);
+    rb_define_method(cMessagePack_Buffer, "close", Buffer_close, 0);
+    rb_define_method(cMessagePack_Buffer, "write_to", Buffer_write_to, 1);
+    rb_define_method(cMessagePack_Buffer, "to_str", Buffer_to_str, 0);
+    rb_define_alias(cMessagePack_Buffer, "to_s", "to_str");
+    rb_define_method(cMessagePack_Buffer, "to_a", Buffer_to_a, 0);
+}
+