vox-etf 0.1.0

data/ext/vox/erlpack/sysdep.h

@@ -0,0 +1,170 @@
+/************************************************
+ *   MIT License
+ *
+ *    Copyright (c) 2017 Discord
+ *
+ *   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.
+ ************************************************/
+
+/*
+ * MessagePack system dependencies modified for erlpack.
+ *
+ * Copyright (C) 2008-2010 FURUHASHI Sadayuki
+ *
+ *    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.
+ */
+#ifndef ERLPACK_SYSDEP_H__
+#define ERLPACK_SYSDEP_H__
+
+#include <stdlib.h>
+#include <stddef.h>
+#if defined(_MSC_VER) && _MSC_VER < 1600
+typedef __int8 int8_t;
+typedef unsigned __int8 uint8_t;
+typedef __int16 int16_t;
+typedef unsigned __int16 uint16_t;
+typedef __int32 int32_t;
+typedef unsigned __int32 uint32_t;
+typedef __int64 int64_t;
+typedef unsigned __int64 uint64_t;
+#elif defined(_MSC_VER) // && _MSC_VER >= 1600
+#include <stdint.h>
+#else
+#include <stdint.h>
+#include <stdbool.h>
+#endif
+
+#if defined(__linux__)
+#include <endian.h>
+#endif
+
+#ifdef _WIN32
+
+#ifdef __cplusplus
+/* numeric_limits<T>::min,max */
+#ifdef max
+#undef max
+#endif
+#ifdef min
+#undef min
+#endif
+#endif
+
+#else
+#include <arpa/inet.h> /* __BYTE_ORDER */
+#endif
+
+#if !defined(__LITTLE_ENDIAN__) && !defined(__BIG_ENDIAN__)
+#if __BYTE_ORDER == __LITTLE_ENDIAN
+#define __LITTLE_ENDIAN__
+#elif __BYTE_ORDER == __BIG_ENDIAN
+#define __BIG_ENDIAN__
+#elif _WIN32
+#define __LITTLE_ENDIAN__
+#endif
+#endif
+
+#ifdef __LITTLE_ENDIAN__
+
+#ifdef _WIN32
+#if defined(ntohs)
+#define _erlpack_be16(x) ntohs(x)
+#elif defined(_byteswap_ushort) || (defined(_MSC_VER) && _MSC_VER >= 1400)
+#define _erlpack_be16(x) ((uint16_t)_byteswap_ushort((unsigned short)x))
+#else
+#define _erlpack_be16(x) (   \
+    ((((uint16_t)x) << 8)) | \
+    ((((uint16_t)x) >> 8)))
+#endif
+#else
+#define _erlpack_be16(x) ntohs(x)
+#endif
+
+#ifdef _WIN32
+#if defined(ntohl)
+#define _erlpack_be32(x) ntohl(x)
+#elif defined(_byteswap_ulong) || (defined(_MSC_VER) && _MSC_VER >= 1400)
+#define _erlpack_be32(x) ((uint32_t)_byteswap_ulong((unsigned long)x))
+#else
+#define _erlpack_be32(x)                    \
+    (((((uint32_t)x) << 24)) |              \
+     ((((uint32_t)x) << 8) & 0x00ff0000U) | \
+     ((((uint32_t)x) >> 8) & 0x0000ff00U) | \
+     ((((uint32_t)x) >> 24)))
+#endif
+#else
+#define _erlpack_be32(x) ntohl(x)
+#endif
+
+#if defined(_byteswap_uint64) || (defined(_MSC_VER) && _MSC_VER >= 1400)
+#define _erlpack_be64(x) (_byteswap_uint64(x))
+#elif defined(bswap_64)
+#define _erlpack_be64(x) bswap_64(x)
+#elif defined(__DARWIN_OSSwapInt64)
+#define _erlpack_be64(x) __DARWIN_OSSwapInt64(x)
+#elif defined(__linux__)
+#define _erlpack_be64(x) be64toh(x)
+#else
+#define _erlpack_be64(x)                               \
+    (((((uint64_t)x) << 56)) |                         \
+     ((((uint64_t)x) << 40) & 0x00ff000000000000ULL) | \
+     ((((uint64_t)x) << 24) & 0x0000ff0000000000ULL) | \
+     ((((uint64_t)x) << 8) & 0x000000ff00000000ULL) |  \
+     ((((uint64_t)x) >> 8) & 0x00000000ff000000ULL) |  \
+     ((((uint64_t)x) >> 24) & 0x0000000000ff0000ULL) | \
+     ((((uint64_t)x) >> 40) & 0x000000000000ff00ULL) | \
+     ((((uint64_t)x) >> 56)))
+#endif
+
+#else
+#define _erlpack_be16(x) (x)
+#define _erlpack_be32(x) (x)
+#define _erlpack_be64(x) (x)
+#endif
+
+#define _erlpack_store16(to, num)          \
+    do                                     \
+    {                                      \
+        uint16_t val = _erlpack_be16(num); \
+        memcpy(to, &val, 2);               \
+    } while (0)
+#define _erlpack_store32(to, num)          \
+    do                                     \
+    {                                      \
+        uint32_t val = _erlpack_be32(num); \
+        memcpy(to, &val, 4);               \
+    } while (0)
+#define _erlpack_store64(to, num)          \
+    do                                     \
+    {                                      \
+        uint64_t val = _erlpack_be64(num); \
+        memcpy(to, &val, 8);               \
+    } while (0)
+
+#endif /* sysdep.h */

data/ext/vox/etf.cpp

@@ -0,0 +1,35 @@
+#include "ruby.h"
+#include "encoder.hpp"
+#include "decoder.hpp"
+#include "etf.hpp"
+
+// Decode an ETF term from a ruby string
+// @param self [Object] Vox::ETF
+// @param input [Rice::String] The ETF term to be decoded.
+// @return [Rice::Object] Whatever the term is, as a ruby object.
+VALUE decode(VALUE self, VALUE input)
+{
+    Check_Type(input, T_STRING);
+
+    etf::decoder decoder(input);
+    return decoder.decode_term();
+}
+
+VALUE encode(VALUE self, VALUE input)
+{
+    etf::encoder enc;
+    enc.encode_object(input);
+    return enc.r_string();
+}
+
+/*
+ Method called when the shared object is required in ruby.
+ Sets up modules and binds methods.
+*/
+extern "C" void Init_etf()
+{
+    VALUE mVox = rb_define_module("Vox");
+    VALUE mETF = rb_define_module_under(mVox, "ETF");
+    rb_define_singleton_method(mETF, "decode", reinterpret_cast<VALUE (*)(...)>(decode), 1);
+    rb_define_singleton_method(mETF, "encode", reinterpret_cast<VALUE (*)(...)>(encode), 1);
+}

data/ext/vox/etf.hpp

@@ -0,0 +1,58 @@
+#pragma once
+
+#include "./etf_reader.hpp"
+
+#define ETF_VERSION 131
+
+// Term IDs, first byte of any term.
+enum term
+{
+    new_float = 70,
+    bit_binary = 77,
+    atom_cache = 82,
+    new_pid = 88,
+    new_port = 89,
+    newer_reference = 90,
+    small_integer = 97,
+    integer = 98,
+    // annoying
+    etf_float = 99,
+    atom = 100,
+    reference = 101,
+    port = 102,
+    pid = 103,
+    small_tuple = 104,
+    large_tuple = 105,
+    nil = 106,
+    string = 107,
+    list = 108,
+    binary = 109,
+    small_big = 110,
+    large_big = 111,
+    new_fun = 112,
+    // annoying
+    etf_export = 113,
+    new_reference = 114,
+    small_atom = 115,
+    map = 116,
+    fun = 117,
+    atom_utf8 = 118,
+    small_atom_utf8 = 119
+};
+
+VALUE decode(VALUE self, VALUE input);
+inline VALUE decode_small_tuple(etf_reader *reader);
+inline VALUE decode_large_tuple(etf_reader *reader);
+inline VALUE decode_map(etf_reader *reader);
+inline VALUE decode_list(etf_reader *reader);
+inline VALUE decode_binary(etf_reader *reader);
+inline VALUE decode_string(etf_reader *reader);
+inline VALUE decode_atom(etf_reader *reader);
+inline VALUE decode_small_atom(etf_reader *reader);
+inline VALUE decode_small_bignum(etf_reader *reader);
+inline VALUE decode_large_bignum(etf_reader *reader);
+
+VALUE encode(VALUE self, VALUE input);
+
+// Setup function for ruby FFI.
+extern "C" void Init_etf();

data/ext/vox/extconf.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require('mkmf-rice')
+
+find_header('ruby.h')
+find_header('zlib.h')
+find_header('stddef.h')
+find_header('stdlib.h')
+find_header('stdint.h')
+find_header('limits.h')
+find_header('string.h')
+
+create_makefile('vox/etf')

data/lib/vox/etf/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Vox
+  module ETF
+    VERSION = '0.1.0'
+  end
+end

data/vox-etf.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative('lib/vox/etf/version')
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vox-etf'
+  spec.version       = Vox::ETF::VERSION
+  spec.authors       = ['Matthew Carey']
+  spec.email         = ['matthew.b.carey@gmail.com']
+
+  spec.summary       = 'ETF decoding/encoding for vox.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/swarley/vox-etf'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/swarley/vox-etf'
+  spec.metadata['changelog_uri'] = 'https://github.com/swarley/vox-etf/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.start_with?('spec/') }
+    end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions << 'ext/vox/extconf.rb'
+
+  spec.add_dependency 'rice', '~> 2.2.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rake-compiler', '~> 1.1.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.90.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.43.2'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: vox-etf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Carey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.43.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.43.2
+description: ETF decoding/encoding for vox.
+email:
+- matthew.b.carey@gmail.com
+executables: []
+extensions:
+- ext/vox/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- ext/vox/decoder.hpp
+- ext/vox/encoder.hpp
+- ext/vox/erlpack/constants.h
+- ext/vox/erlpack/encoder.h
+- ext/vox/erlpack/sysdep.h
+- ext/vox/etf.cpp
+- ext/vox/etf.hpp
+- ext/vox/extconf.rb
+- lib/vox/etf/version.rb
+- vox-etf.gemspec
+homepage: https://github.com/swarley/vox-etf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/swarley/vox-etf
+  source_code_uri: https://github.com/swarley/vox-etf
+  changelog_uri: https://github.com/swarley/vox-etf/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ETF decoding/encoding for vox.
+test_files: []