ffi-module 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5eb3b1aa3f99163ffd15dddc88852709b31677be988ebd0c2d3758866f19d43
+  data.tar.gz: 138e20272596fe28a109d49634f3357e7c544fe3b266ccc158dfcfc44906efff
+SHA512:
+  metadata.gz: bd1516bf65a1d8d19bd4a972f03e47ef078441f6c5927eb699a79428bb727b740e62193f810cce6c2ebc4d4e1e39d90abcf38a076da04c8d4e628af4e1a3ae50
+  data.tar.gz: e194ca5bd89f3c75716e50b9f389803c73b0a5136e7eef766c43a1b31f0d193e2e097bd93373454d458fdd5057d20042b955b4e8c88b81053ce5aac8038d6dcc

data/lib/ffi/module.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# 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.
+
+require_relative 'module/version'
+require_relative 'module/library'
+require_relative 'module/loader'
+
+module FFI
+	module Module
+		def self.included(target)
+			target.extend(Library)
+			target.extend(Loader)
+		end
+	end
+end

data/lib/ffi/module/config_tool.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# 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.
+
+require 'shellwords'
+
+require_relative 'loader'
+
+module FFI
+	module Module
+		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)
+				
+				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
+					else
+						# Assume it's a search path:
+						search_paths << value
+					end
+				end
+				
+				# Load all specified libraries:
+				names.each do |name|
+					ffi_load(name, search_paths: search_paths, **options)
+				end
+			end
+		end
+	end
+end

data/lib/ffi/module/library.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+# 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.
+
+require 'ffi'
+
+module FFI
+	module Module
+		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
+				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, cname, argument_types, return_type = :void, **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(cname, 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, name.to_s)
+					return true
+				else
+					raise FFI::NotFoundError.new(cname, @ffi_libraries)
+				end
+			end
+			
+			def ffi_attach_variable(name, cname, type)
+				address = @ffi_libraries.find do |library|
+					begin
+						library.find_variable(cname)
+					rescue LoadError
+					end
+				end
+				
+				if address.nil? || address.null?
+					raise FFI::NotFoundError.new(cname, @ffi_libraries)
+				end
+				
+				if type.is_a?(Class) && type < FFI::Struct
+					variable = type.new(address)
+					
+					self.define_singleton_method(name) 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(name) do
+						container[:value]
+					end
+					
+					self.define_singleton_method(:"#{name}=") 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 type
+				when FFI::Type
+					@ffi_type_map[name] = type
+				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_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_generic_enumeration(name, FFI::Bitmask, native_type, arguments)
+			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
+			
+			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
+		end
+	end
+end

data/lib/ffi/module/loader.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# 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.
+
+require 'ffi'
+
+module FFI
+	module Module
+		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_load_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(library_name, search_paths)
+						if library = ffi_load_library(path, **options)
+							libraries << library
+						end
+					end
+					
+					return true if ffi_load_library(name, **options)
+				end
+				
+				return nil
+			end
+		end
+	end
+end

data/lib/ffi/module/version.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# 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.
+
+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 Module
+		VERSION = "0.1.0"
+	end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: ffi-module
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-03 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: 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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ffi/module.rb
+- lib/ffi/module/config_tool.rb
+- lib/ffi/module/library.rb
+- lib/ffi/module/loader.rb
+- lib/ffi/module/version.rb
+homepage: https://github.com/ioquatix/ffi-module
+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.2.3
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []