ffi_wide_char 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35e9d63072d1d64f405b5afcbadccdf5a7f4b9588bc29df8b4c7408dcc7ffa2b
+  data.tar.gz: 706e4afc78179893f6373b56bae428673658e576991630fe7cd9434ba289eac1
+SHA512:
+  metadata.gz: 312c5b9691424a0accf6b2757c3721e5281c92cf5b162a4fc4dd4d4f729cbc4694b18bc80c845ab70d93a9c4857fd1c5c371e402481669d1ee1e2b57cb7a4197
+  data.tar.gz: e6dd3b9c58ca7c992ddb048c89f7d7fb1b2cb45d95bbb1cceee669c4aef14bcea32be450c4254e8960f9a331149fe7533422bfed94b2213741a452a21de9703d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Thach Nguyen
+
+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.

data/lib/ffi_wide_char/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FfiWideChar
+  module LibC
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    # Converts a string of multibyte characters to a wide character array
+    # size_t mbstowcs (wchar_t *wstring, const char *string, size_t size)
+    attach_function :mbstowcs, %i[pointer string size_t], :size_t
+  end
+end

data/lib/ffi_wide_char/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FfiWideChar
+  VERSION = '1.0.0'
+end

data/lib/ffi_wide_char.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+require 'ffi_wide_char/api'
+require 'ffi_wide_char/version'
+
+module FfiWideChar
+  class InvalidMultibyteCharError < StandardError; end
+  class UnsupportedWCharEncodingError < StandardError; end
+
+  DEFAULT_ENC = 'UTF-16LE'
+  ENCODINGS   = {
+    "!\x00@\x00\x00\x00" => DEFAULT_ENC,
+    "\x00!\x00@\x00\x00" => 'UTF-16BE',
+    "!\x00\x00\x00@\x00" => 'UTF-32LE',
+    "\x00\x00\x00!\x00\x00" => 'UTF-32BE'
+  }.freeze
+
+  W_CHAR_ENC  = nil
+  W_CHAR_SIZE = 2
+  W_CHAR_FUNC = :get_uint16
+
+  # Detect `wchar_t` encoding.
+  # @return [String] Name of the wide-string encoding.
+  def self.detect_encoding
+    return W_CHAR_ENC if W_CHAR_ENC
+
+    ptr = FFI::MemoryPointer.new(:uint8, 6)
+    ret = LibC.mbstowcs(ptr, '!@', 3)
+    raise InvalidMultibyteCharError if ret.negative?
+
+    enc = ENCODINGS[str = ptr.get_bytes(0, 6)]
+    raise UnsupportedWCharEncodingError, str.inspect unless enc
+
+    redefine_const(:W_CHAR_ENC, enc)
+    redefine_const(:W_CHAR_SIZE, enc.include?('32') ? 4 : 2)
+    redefine_const(:W_CHAR_FUNC, W_CHAR_SIZE == 4 ? :get_int32 : :get_uint16)
+
+    enc
+  end
+
+  # Look for a null terminating characters; if found, read up to that null (exclusive)
+  # @param ptr [Pointer] A wide-string pointer.
+  # @return [String] Decoded wide-string.
+  def self.read_wide_string(ptr)
+    return nil unless ptr
+
+    sz = (ptr.size || 0) - W_CHAR_SIZE
+    len = 0
+    len += W_CHAR_SIZE while (sz.negative? || len < sz) && ptr.send(W_CHAR_FUNC, len) != 0
+
+    ptr.get_bytes(0, len).force_encoding(W_CHAR_ENC || DEFAULT_ENC)
+  end
+
+  # Convert a Ruby string into a C native wide-string.
+  # @param str [String] A Ruby string.
+  # @return [String] C native wide-string.
+  def self.to_wide_string(str)
+    str&.encode(W_CHAR_ENC || DEFAULT_ENC)
+  end
+
+  def self.redefine_const(name, value)
+    send(:remove_const, name) if const_defined?(name)
+    const_set name, value
+  end
+
+  private_class_method :redefine_const
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ffi_wide_char
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thach Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.64'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.64'
+description: Convert from/to C native `wchar_t` string to used for FFI binding libraries.
+email:
+- nthachus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/ffi_wide_char.rb
+- lib/ffi_wide_char/api.rb
+- lib/ffi_wide_char/version.rb
+homepage: https://github.com/nthachus/ffi_wide_char
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nthachus/ffi_wide_char
+  source_code_uri: https://github.com/nthachus/ffi_wide_char
+  changelog_uri: https://github.com/nthachus/ffi_wide_char
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Provides methods to convert from/to FFI wide-string.
+test_files: []