ffi-native 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2304bce31312de2e522ea76375e8683d6d95b85f4e5ac70075cc7ce08690fc3
+  data.tar.gz: 31ffd16c41c38d6b9e6e0c94d562128057f08074491badab7d0e30b8384c91ba
+SHA512:
+  metadata.gz: 49a5c875caef86c53ec7e2fab2bd66137b203a6a612d65d08c237d7dfcbb0966778ac99fe890d5fa4aeff3b4c43326c00eb0094a099908a1803d294e2c5c8816
+  data.tar.gz: 6851a3a9d0b6028e925dfa0094c73207a21414bdee6129c441a529b5f5fd571e91e51f94384ea02b295213686416f78862ce424bed37ee5f40021ae14fb7637a

data/lib/ffi/native/config_tool.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2023, by Samuel Williams.
+
+require 'shellwords'
+
+require_relative 'loader'
+
+module FFI
+	module Native
+		module ConfigTool
+			extend Loader
+			
+			def ffi_load_using_config_tool(command, search_paths: [], names: [], **options)
+				return false unless output = ::IO.popen(command).read
+				
+				arguments = ::Shellwords.split(output)
+				search_paths = search_paths.dup
+				names = names.dup
+				
+				arguments.each do |argument|
+					if match = argument.match(/\A(-[lL])(.*)\z/)
+						command, value = match.captures
+						case command
+						when '-L'
+							search_paths << value
+						when '-l'
+							names << value
+						end
+					elsif File.directory?(argument)
+						# Assume it's a search path:
+						search_paths << argument
+					end
+				end
+				
+				result = false
+				
+				# Load all specified libraries:
+				names.each do |name|
+					result = ffi_load(name, search_paths: search_paths, **options) || result
+				end
+				
+				return result
+			rescue Errno::ENOENT
+				return nil
+			end
+		end
+	end
+end

data/lib/ffi/native/library.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2023, by Samuel Williams.
+
+require 'ffi'
+
+module FFI
+	module Native
+		module Library
+			def self.extended(target)
+				raise "Must only be extended by module, got #{target}!" unless target.kind_of?(Module)
+				
+				target.instance_variable_set(:@ffi_libraries, Array.new)
+				target.instance_variable_set(:@ffi_calling_convention, :default)
+				target.instance_variable_set(:@ffi_type_map, Hash.new)
+				target.instance_variable_set(:@ffi_enumerations, FFI::Enums.new)
+			end
+			
+			DEFAULT_FLAGS = FFI::DynamicLibrary::RTLD_LAZY | FFI::DynamicLibrary::RTLD_LOCAL
+			
+			def ffi_open_library(name = nil, flags: DEFAULT_FLAGS)
+				@ffi_libraries << DynamicLibrary.open(name, flags)
+				
+				return true
+			rescue LoadError, RuntimeError
+				# TruffleRuby raises a RuntimeError if the library can't be found.
+				return nil
+			end
+			
+			def ffi_calling_convention(value = nil)
+				if value
+					@ffi_calling_convention = value
+				end
+				
+				return @ffi_calling_convention
+			end
+			
+			def ffi_attach_function(name, argument_types, return_type = :void, as: name, **options)
+				argument_types = argument_types.map{|type| self.ffi_find_type(type)}
+				return_type = self.ffi_find_type(return_type)
+				
+				options[:convention] ||= @ffi_calling_convention
+				options[:type_map] ||= @ffi_type_map
+				options[:enums] ||= @ffi_enumerations
+				
+				invoker = nil
+				
+				@ffi_libraries.each do |library|
+					function = nil
+					
+					ffi_function_names(name, argument_types).each do |function_name|
+						break if function = library.find_function(function_name.to_s)
+					end
+					
+					if function
+						if argument_types.length > 0 && argument_types.last == FFI::NativeType::VARARGS
+							invoker = VariadicInvoker.new(function, argument_types, return_type, options)
+						else
+							invoker = Function.new(return_type, argument_types, function, options)
+						end
+						
+						break
+					end
+				end
+				
+				if invoker
+					invoker.attach(self, as.to_s)
+					return true
+				else
+					raise FFI::NotFoundError.new(name, @ffi_libraries)
+				end
+			end
+			
+			def ffi_attach_variable(name, type, as: name)
+				address = @ffi_libraries.find do |library|
+					begin
+						library.find_variable(name)
+					rescue LoadError
+					end
+				end
+				
+				if address.nil? || address.null?
+					raise FFI::NotFoundError.new(name, @ffi_libraries)
+				end
+				
+				if type.is_a?(Class) && type < FFI::Struct
+					variable = type.new(address)
+					
+					self.define_singleton_method(as) do
+						variable
+					end
+				else
+					container_type = Class.new(FFI::Struct)
+					container_type.layout :value, self.ffi_find_type(type)
+					container = container_type.new(address)
+					
+					self.define_singleton_method(as) do
+						container[:value]
+					end
+					
+					self.define_singleton_method(:"#{as}=") do |value|
+						container[:value] = value
+					end
+				end
+				
+				return true
+			end
+			
+			def ffi_callback(argument_types, return_type, **options)
+				argument_types = argument_types.map{|type| self.ffi_find_type(type)}
+				return_type = self.ffi_find_type(return_type)
+				
+				if argument_types.include?(FFI::Type::VARARGS)
+					raise ArgumentError, "Callbacks cannot have variadic parameters!"
+				end
+				
+				options[:convention] ||= @ffi_calling_convention
+				options[:enums] ||= @ffi_enumerations
+				
+				if return_type == Type::STRING
+					raise TypeError, "String is not allowed as return type of callbacks!"
+				end
+				
+				return FFI::CallbackInfo.new(return_type, argument_types, options)
+			end
+			
+			def ffi_define_callback(name, *arguments, **options)
+				callback = ffi_callback(*arguments, **options)
+				
+				ffi_define_type(name, callback)
+				
+				return callback
+			end
+			
+			def ffi_define_type(name, value)
+				case value
+				when FFI::Type
+					@ffi_type_map[name] = value
+				when FFI::DataConverter
+					@ffi_type_map[name] = FFI::Type::Mapped.new(value)
+				else
+					@ffi_type_map[name] = self.ffi_find_type(value)
+				end
+			end
+			
+			def ffi_define_enumeration(name, *arguments)
+				native_type = arguments.first.kind_of?(FFI::Type) ? arguments.shift : nil
+				
+				ffi_define_generic_enumeration(name, FFI::Enum, native_type, *arguments)
+			end
+			
+			def ffi_define_bitmask(name, *arguments)
+				native_type = arguments.first.kind_of?(FFI::Type) ? arguments.shift : nil
+				
+				ffi_define_generic_enumeration(name, FFI::Bitmask, native_type, *arguments)
+			end
+			
+			def ffi_find_type(argument)
+				if argument.kind_of?(Type)
+					return argument
+				end
+				
+				if type = @ffi_type_map[argument]
+					return type
+				end
+				
+				if argument.is_a?(Class) && argument < Struct
+					return Type::POINTER
+				end
+				
+				if argument.is_a?(DataConverter)
+					# Cache the mapped type:
+					return ffi_define_type(argument, Type::Mapped.new(argument))
+				end
+				
+				if argument
+					return FFI.find_type(argument)
+				end
+			end
+			
+		private
+			
+			def ffi_define_generic_enumeration(name, klass, native_type, values)
+				enumeration = nil
+				
+				if native_type
+					enumeration = klass.new(native_type, values, name)
+				else
+					enumeration = klass.new(values, name)
+				end
+				
+				@ffi_enumerations << enumeration
+				
+				ffi_define_type(name, enumeration)
+				
+				return enumeration
+			end
+			
+			def ffi_function_names(name, argument_types)
+				result = [name]
+				
+				if @ffi_calling_convention == :stdcall
+					# Get the size of each parameter:
+					size = argument_types.inject(0) do |total, argument|
+						size = argument.size
+						
+						# The size must be a multiple of 4:
+						size += (4 - size) % 4
+						
+						total + size
+					end
+					
+					# win32 naming convention:
+					result << "_#{name.to_s}@#{size}"
+					
+					# win64 naming convention:
+					result << "#{name.to_s}@#{size}"
+				end
+				
+				return result
+			end
+		end
+	end
+end

data/lib/ffi/native/loader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2023, by Samuel Williams.
+
+require 'ffi'
+
+module FFI
+	module Native
+		module Loader
+			def ffi_find_library_path(libname, search_paths)
+				search_paths.each do |search_path|
+					full_path = File.join(search_path, libname)
+					if File.exist?(full_path)
+						return full_path
+					end
+				end
+				
+				return nil
+			end
+			
+			def ffi_load(name, search_paths: nil, **options)
+				# Try to load the library directly:
+				return true if ffi_open_library(name, **options)
+				
+				# If that fails, try to load it from the specified search paths:
+				if search_paths&.any?
+					name = FFI.map_library_name(name)
+					
+					if path = ffi_find_library_path(name, search_paths)
+						return true if ffi_open_library(path, **options)
+					end
+				end
+				
+				return nil
+			end
+			
+			def ffi_load_failure(message)
+				raise LoadError, message
+			end
+		end
+	end
+end

data/lib/ffi/native/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2023, by Samuel Williams.
+
+begin
+	require 'ffi'
+rescue LoadError
+	# Ignore.
+	
+	# The FFI gem has the following in `ffi.rb`, so we need to be careful about load order:
+	# Object.send(:remove_const, :FFI) if defined?(::FFI)
+end
+
+module FFI
+	module Native
+		VERSION = "0.4.0"
+	end
+end

data/lib/ffi/native.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2023, by Samuel Williams.
+
+require_relative 'native/version'
+require_relative 'native/library'
+require_relative 'native/loader'
+
+module FFI
+	module Native
+		def self.included(target)
+			target.extend(Library)
+			target.extend(Loader)
+		end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2021-2023, by Samuel Williams.  
+
+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/readme.md

@@ -0,0 +1,35 @@
+# FFI::Native
+
+A modern interface for building foreign function interfaces for Ruby using the standard [ffi](https://github.com/ffi/ffi) gem.
+
+[![Development Status](https://github.com/ioquatix/ffi-native/workflows/Test/badge.svg)](https://github.com/ioquatix/ffi-native/actions?workflow=Test)
+
+## Contributing
+
+1.  Fork it
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+3.  Commit your changes (`git commit -am 'Add some feature'`)
+4.  Push to the branch (`git push origin my-new-feature`)
+5.  Create new Pull Request
+
+## License
+
+Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+
+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.

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: ffi-native
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2023-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ffi/native.rb
+- lib/ffi/native/config_tool.rb
+- lib/ffi/native/library.rb
+- lib/ffi/native/loader.rb
+- lib/ffi/native/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/ioquatix/ffi-native
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []

metadata.gz.sig

@@ -0,0 +1,5 @@
++9��SP��}�7o����;t��Cd��R;r�6V泉�jGQpZ��3"�@?���W���.���,G:�7�S4QA��[�78%9��U=–���n�8�5�*�Dq�#������u�m&�q]�����d��X�
+Ґ�EVǔ��!DO&�� �=�K
+�ϽX�9��qN0�� #�U�&e�}�Cp�0���"�+E0�W:�<3ܘ�5���8~�'D������W���_��.:�xjh��RŊ������$�0�2w��g�Lu�g0h�V2N��k�
+����4絝$��0O���̜������p߇]x�`��~u��
+�U�\^�~�