mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
755d99e878
This helps to reduce repetition in code. Instead of doing "TYPE_*"
everywhere, you can do `include Fiddle::Types`, and write the type name
directly.
This PR is to help reduce repetition when writing Fiddle code. Right now
we have to type `TYPE_` everywhere, and you also have to include all of
`Fiddle` to access `TYPE_*` constants. With this change, you can just
include `Fiddle::Types` and it will shorten your code and also you only
have to include those constants.
Here is an example before:
```ruby
require "fiddle"
module MMAP
# All Fiddle constants included
include Fiddle
def self.make_function name, args, ret
ptr = Handle::DEFAULT[name]
func = Function.new ptr, args, ret, name: name
define_singleton_method name, &func.to_proc
end
make_function "munmap", [TYPE_VOIDP, # addr
TYPE_SIZE_T], # len
TYPE_INT
make_function "mmap", [TYPE_VOIDP,
TYPE_SIZE_T,
TYPE_INT,
TYPE_INT,
TYPE_INT,
TYPE_INT], TYPE_VOIDP
make_function "mprotect", [TYPE_VOIDP, TYPE_SIZE_T, TYPE_INT], TYPE_INT
end
```
After:
```ruby
require "fiddle"
module MMAP
# Only type names included
include Fiddle::Types
def self.make_function name, args, ret
ptr = Fiddle::Handle::DEFAULT[name]
func = Fiddle::Function.new ptr, args, ret, name: name
define_singleton_method name, &func.to_proc
end
make_function "munmap", [VOIDP, # addr
SIZE_T], # len
INT
make_function "mmap", [VOIDP, SIZE_T, INT, INT, INT, INT], VOIDP
make_function "mprotect", [VOIDP, SIZE_T, INT], INT
end
```
We only need to import the type names, and you don't have to type
`TYPE_` over and over. I think this makes Fiddle code easier to read.
49fa7233e5
Co-authored-by: Sutou Kouhei <kou@clear-code.com>
74 lines
2.2 KiB
Ruby
74 lines
2.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'fiddle.so'
|
|
require 'fiddle/closure'
|
|
require 'fiddle/function'
|
|
require 'fiddle/version'
|
|
|
|
module Fiddle
|
|
if WINDOWS
|
|
# Returns the last win32 +Error+ of the current executing +Thread+ or nil
|
|
# if none
|
|
def self.win32_last_error
|
|
Thread.current[:__FIDDLE_WIN32_LAST_ERROR__]
|
|
end
|
|
|
|
# Sets the last win32 +Error+ of the current executing +Thread+ to +error+
|
|
def self.win32_last_error= error
|
|
Thread.current[:__FIDDLE_WIN32_LAST_ERROR__] = error
|
|
end
|
|
|
|
# Returns the last win32 socket +Error+ of the current executing
|
|
# +Thread+ or nil if none
|
|
def self.win32_last_socket_error
|
|
Thread.current[:__FIDDLE_WIN32_LAST_SOCKET_ERROR__]
|
|
end
|
|
|
|
# Sets the last win32 socket +Error+ of the current executing
|
|
# +Thread+ to +error+
|
|
def self.win32_last_socket_error= error
|
|
Thread.current[:__FIDDLE_WIN32_LAST_SOCKET_ERROR__] = error
|
|
end
|
|
end
|
|
|
|
# Returns the last +Error+ of the current executing +Thread+ or nil if none
|
|
def self.last_error
|
|
Thread.current[:__FIDDLE_LAST_ERROR__]
|
|
end
|
|
|
|
# Sets the last +Error+ of the current executing +Thread+ to +error+
|
|
def self.last_error= error
|
|
Thread.current[:__DL2_LAST_ERROR__] = error
|
|
Thread.current[:__FIDDLE_LAST_ERROR__] = error
|
|
end
|
|
|
|
# call-seq: dlopen(library) => Fiddle::Handle
|
|
#
|
|
# Creates a new handler that opens +library+, and returns an instance of
|
|
# Fiddle::Handle.
|
|
#
|
|
# If +nil+ is given for the +library+, Fiddle::Handle::DEFAULT is used, which
|
|
# is the equivalent to RTLD_DEFAULT. See <code>man 3 dlopen</code> for more.
|
|
#
|
|
# lib = Fiddle.dlopen(nil)
|
|
#
|
|
# The default is dependent on OS, and provide a handle for all libraries
|
|
# already loaded. For example, in most cases you can use this to access
|
|
# +libc+ functions, or ruby functions like +rb_str_new+.
|
|
#
|
|
# See Fiddle::Handle.new for more.
|
|
def dlopen library
|
|
Fiddle::Handle.new library
|
|
end
|
|
module_function :dlopen
|
|
|
|
# Add constants for backwards compat
|
|
|
|
RTLD_GLOBAL = Handle::RTLD_GLOBAL # :nodoc:
|
|
RTLD_LAZY = Handle::RTLD_LAZY # :nodoc:
|
|
RTLD_NOW = Handle::RTLD_NOW # :nodoc:
|
|
|
|
Fiddle::Types.constants.each do |type|
|
|
const_set "TYPE_#{type}", Fiddle::Types.const_get(type)
|
|
end
|
|
end
|