alinta-ffi 1.9.19
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/COPYING +49 -0
- data/LICENSE +24 -0
- data/README.md +112 -0
- data/Rakefile +243 -0
- data/ext/ffi_c/AbstractMemory.c +1109 -0
- data/ext/ffi_c/AbstractMemory.h +175 -0
- data/ext/ffi_c/ArrayType.c +162 -0
- data/ext/ffi_c/ArrayType.h +59 -0
- data/ext/ffi_c/Buffer.c +365 -0
- data/ext/ffi_c/Call.c +517 -0
- data/ext/ffi_c/Call.h +110 -0
- data/ext/ffi_c/ClosurePool.c +283 -0
- data/ext/ffi_c/ClosurePool.h +57 -0
- data/ext/ffi_c/DataConverter.c +91 -0
- data/ext/ffi_c/DynamicLibrary.c +339 -0
- data/ext/ffi_c/DynamicLibrary.h +98 -0
- data/ext/ffi_c/Function.c +998 -0
- data/ext/ffi_c/Function.h +87 -0
- data/ext/ffi_c/FunctionInfo.c +271 -0
- data/ext/ffi_c/LastError.c +184 -0
- data/ext/ffi_c/LastError.h +47 -0
- data/ext/ffi_c/LongDouble.c +63 -0
- data/ext/ffi_c/LongDouble.h +51 -0
- data/ext/ffi_c/MappedType.c +168 -0
- data/ext/ffi_c/MappedType.h +59 -0
- data/ext/ffi_c/MemoryPointer.c +197 -0
- data/ext/ffi_c/MemoryPointer.h +53 -0
- data/ext/ffi_c/MethodHandle.c +358 -0
- data/ext/ffi_c/MethodHandle.h +55 -0
- data/ext/ffi_c/Platform.c +129 -0
- data/ext/ffi_c/Platform.h +45 -0
- data/ext/ffi_c/Pointer.c +508 -0
- data/ext/ffi_c/Pointer.h +63 -0
- data/ext/ffi_c/Struct.c +829 -0
- data/ext/ffi_c/Struct.h +106 -0
- data/ext/ffi_c/StructByReference.c +190 -0
- data/ext/ffi_c/StructByReference.h +50 -0
- data/ext/ffi_c/StructByValue.c +150 -0
- data/ext/ffi_c/StructByValue.h +55 -0
- data/ext/ffi_c/StructLayout.c +698 -0
- data/ext/ffi_c/Thread.c +352 -0
- data/ext/ffi_c/Thread.h +95 -0
- data/ext/ffi_c/Type.c +397 -0
- data/ext/ffi_c/Type.h +62 -0
- data/ext/ffi_c/Types.c +139 -0
- data/ext/ffi_c/Types.h +89 -0
- data/ext/ffi_c/Variadic.c +304 -0
- data/ext/ffi_c/compat.h +78 -0
- data/ext/ffi_c/extconf.rb +71 -0
- data/ext/ffi_c/ffi.c +98 -0
- data/ext/ffi_c/libffi.bsd.mk +40 -0
- data/ext/ffi_c/libffi.darwin.mk +105 -0
- data/ext/ffi_c/libffi.gnu.mk +32 -0
- data/ext/ffi_c/libffi.mk +18 -0
- data/ext/ffi_c/libffi.vc.mk +26 -0
- data/ext/ffi_c/libffi.vc64.mk +26 -0
- data/ext/ffi_c/rbffi.h +57 -0
- data/ext/ffi_c/rbffi_endian.h +59 -0
- data/ext/ffi_c/win32/stdbool.h +8 -0
- data/ext/ffi_c/win32/stdint.h +201 -0
- data/ffi.gemspec +23 -0
- data/gen/Rakefile +30 -0
- data/lib/ffi.rb +20 -0
- data/lib/ffi/autopointer.rb +203 -0
- data/lib/ffi/buffer.rb +4 -0
- data/lib/ffi/callback.rb +4 -0
- data/lib/ffi/enum.rb +296 -0
- data/lib/ffi/errno.rb +43 -0
- data/lib/ffi/ffi.rb +44 -0
- data/lib/ffi/io.rb +62 -0
- data/lib/ffi/library.rb +590 -0
- data/lib/ffi/managedstruct.rb +84 -0
- data/lib/ffi/memorypointer.rb +1 -0
- data/lib/ffi/platform.rb +164 -0
- data/lib/ffi/platform/aarch64-linux/types.conf +104 -0
- data/lib/ffi/platform/arm-linux/types.conf +104 -0
- data/lib/ffi/platform/i386-cygwin/types.conf +3 -0
- data/lib/ffi/platform/i386-darwin/types.conf +100 -0
- data/lib/ffi/platform/i386-freebsd/types.conf +152 -0
- data/lib/ffi/platform/i386-gnu/types.conf +107 -0
- data/lib/ffi/platform/i386-linux/types.conf +103 -0
- data/lib/ffi/platform/i386-netbsd/types.conf +126 -0
- data/lib/ffi/platform/i386-openbsd/types.conf +128 -0
- data/lib/ffi/platform/i386-solaris/types.conf +122 -0
- data/lib/ffi/platform/i386-windows/types.conf +105 -0
- data/lib/ffi/platform/ia64-linux/types.conf +104 -0
- data/lib/ffi/platform/mips-linux/types.conf +102 -0
- data/lib/ffi/platform/mips64el-linux/types.conf +104 -0
- data/lib/ffi/platform/mipsel-linux/types.conf +102 -0
- data/lib/ffi/platform/powerpc-aix/types.conf +180 -0
- data/lib/ffi/platform/powerpc-darwin/types.conf +100 -0
- data/lib/ffi/platform/powerpc-linux/types.conf +100 -0
- data/lib/ffi/platform/powerpc64-linux/types.conf +104 -0
- data/lib/ffi/platform/s390-linux/types.conf +102 -0
- data/lib/ffi/platform/s390x-linux/types.conf +102 -0
- data/lib/ffi/platform/sparc-linux/types.conf +102 -0
- data/lib/ffi/platform/sparc-solaris/types.conf +128 -0
- data/lib/ffi/platform/sparc64-linux/types.conf +102 -0
- data/lib/ffi/platform/sparcv9-solaris/types.conf +128 -0
- data/lib/ffi/platform/x86_64-cygwin/types.conf +3 -0
- data/lib/ffi/platform/x86_64-darwin/types.conf +126 -0
- data/lib/ffi/platform/x86_64-freebsd/types.conf +128 -0
- data/lib/ffi/platform/x86_64-linux/types.conf +102 -0
- data/lib/ffi/platform/x86_64-netbsd/types.conf +128 -0
- data/lib/ffi/platform/x86_64-openbsd/types.conf +134 -0
- data/lib/ffi/platform/x86_64-solaris/types.conf +122 -0
- data/lib/ffi/platform/x86_64-windows/types.conf +120 -0
- data/lib/ffi/pointer.rb +161 -0
- data/lib/ffi/struct.rb +371 -0
- data/lib/ffi/struct_layout_builder.rb +227 -0
- data/lib/ffi/tools/const_generator.rb +229 -0
- data/lib/ffi/tools/generator.rb +60 -0
- data/lib/ffi/tools/generator_task.rb +36 -0
- data/lib/ffi/tools/struct_generator.rb +194 -0
- data/lib/ffi/tools/types_generator.rb +134 -0
- data/lib/ffi/types.rb +194 -0
- data/lib/ffi/union.rb +43 -0
- data/lib/ffi/variadic.rb +78 -0
- data/lib/ffi/version.rb +4 -0
- data/libtest/Benchmark.c +52 -0
- data/libtest/BoolTest.c +34 -0
- data/libtest/BufferTest.c +31 -0
- data/libtest/ClosureTest.c +205 -0
- data/libtest/EnumTest.c +51 -0
- data/libtest/FunctionTest.c +70 -0
- data/libtest/GNUmakefile +149 -0
- data/libtest/GlobalVariable.c +62 -0
- data/libtest/LastErrorTest.c +21 -0
- data/libtest/NumberTest.c +132 -0
- data/libtest/PointerTest.c +63 -0
- data/libtest/ReferenceTest.c +23 -0
- data/libtest/StringTest.c +34 -0
- data/libtest/StructTest.c +243 -0
- data/libtest/UnionTest.c +43 -0
- data/libtest/VariadicTest.c +99 -0
- data/spec/ffi/LICENSE.SPECS +22 -0
- data/spec/ffi/async_callback_spec.rb +35 -0
- data/spec/ffi/bitmask_spec.rb +575 -0
- data/spec/ffi/bool_spec.rb +32 -0
- data/spec/ffi/buffer_spec.rb +279 -0
- data/spec/ffi/callback_spec.rb +773 -0
- data/spec/ffi/custom_param_type.rb +37 -0
- data/spec/ffi/custom_type_spec.rb +74 -0
- data/spec/ffi/dup_spec.rb +52 -0
- data/spec/ffi/enum_spec.rb +423 -0
- data/spec/ffi/errno_spec.rb +20 -0
- data/spec/ffi/ffi_spec.rb +28 -0
- data/spec/ffi/fixtures/Benchmark.c +52 -0
- data/spec/ffi/fixtures/BitmaskTest.c +51 -0
- data/spec/ffi/fixtures/BoolTest.c +34 -0
- data/spec/ffi/fixtures/BufferTest.c +31 -0
- data/spec/ffi/fixtures/ClosureTest.c +205 -0
- data/spec/ffi/fixtures/EnumTest.c +51 -0
- data/spec/ffi/fixtures/FunctionTest.c +142 -0
- data/spec/ffi/fixtures/GNUmakefile +149 -0
- data/spec/ffi/fixtures/GlobalVariable.c +62 -0
- data/spec/ffi/fixtures/LastErrorTest.c +21 -0
- data/spec/ffi/fixtures/NumberTest.c +132 -0
- data/spec/ffi/fixtures/PipeHelper.h +21 -0
- data/spec/ffi/fixtures/PipeHelperPosix.c +41 -0
- data/spec/ffi/fixtures/PipeHelperWindows.c +72 -0
- data/spec/ffi/fixtures/PointerTest.c +63 -0
- data/spec/ffi/fixtures/ReferenceTest.c +23 -0
- data/spec/ffi/fixtures/StringTest.c +34 -0
- data/spec/ffi/fixtures/StructTest.c +243 -0
- data/spec/ffi/fixtures/UnionTest.c +43 -0
- data/spec/ffi/fixtures/VariadicTest.c +99 -0
- data/spec/ffi/fixtures/classes.rb +438 -0
- data/spec/ffi/function_spec.rb +97 -0
- data/spec/ffi/io_spec.rb +16 -0
- data/spec/ffi/library_spec.rb +286 -0
- data/spec/ffi/long_double.rb +30 -0
- data/spec/ffi/managed_struct_spec.rb +68 -0
- data/spec/ffi/memorypointer_spec.rb +78 -0
- data/spec/ffi/number_spec.rb +247 -0
- data/spec/ffi/platform_spec.rb +114 -0
- data/spec/ffi/pointer_spec.rb +285 -0
- data/spec/ffi/rbx/attach_function_spec.rb +34 -0
- data/spec/ffi/rbx/memory_pointer_spec.rb +198 -0
- data/spec/ffi/rbx/spec_helper.rb +6 -0
- data/spec/ffi/rbx/struct_spec.rb +18 -0
- data/spec/ffi/spec_helper.rb +93 -0
- data/spec/ffi/string_spec.rb +118 -0
- data/spec/ffi/strptr_spec.rb +50 -0
- data/spec/ffi/struct_by_ref_spec.rb +43 -0
- data/spec/ffi/struct_callback_spec.rb +69 -0
- data/spec/ffi/struct_initialize_spec.rb +35 -0
- data/spec/ffi/struct_packed_spec.rb +50 -0
- data/spec/ffi/struct_spec.rb +882 -0
- data/spec/ffi/typedef_spec.rb +91 -0
- data/spec/ffi/union_spec.rb +67 -0
- data/spec/ffi/variadic_spec.rb +132 -0
- data/spec/spec.opts +4 -0
- metadata +309 -0
data/lib/ffi/struct.rb
ADDED
@@ -0,0 +1,371 @@
|
|
1
|
+
#
|
2
|
+
# Copyright (C) 2008-2010 Wayne Meissner
|
3
|
+
# Copyright (C) 2008, 2009 Andrea Fazzi
|
4
|
+
# Copyright (C) 2008, 2009 Luc Heinrich
|
5
|
+
#
|
6
|
+
# This file is part of ruby-ffi.
|
7
|
+
#
|
8
|
+
# All rights reserved.
|
9
|
+
#
|
10
|
+
# Redistribution and use in source and binary forms, with or without
|
11
|
+
# modification, are permitted provided that the following conditions are met:
|
12
|
+
#
|
13
|
+
# * Redistributions of source code must retain the above copyright notice, this
|
14
|
+
# list of conditions and the following disclaimer.
|
15
|
+
# * Redistributions in binary form must reproduce the above copyright notice
|
16
|
+
# this list of conditions and the following disclaimer in the documentation
|
17
|
+
# and/or other materials provided with the distribution.
|
18
|
+
# * Neither the name of the Ruby FFI project nor the names of its contributors
|
19
|
+
# may be used to endorse or promote products derived from this software
|
20
|
+
# without specific prior written permission.
|
21
|
+
#
|
22
|
+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
23
|
+
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
24
|
+
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
25
|
+
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
|
26
|
+
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
27
|
+
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
28
|
+
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
29
|
+
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
30
|
+
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
31
|
+
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
32
|
+
#
|
33
|
+
|
34
|
+
require 'ffi/platform'
|
35
|
+
require 'ffi/struct_layout_builder'
|
36
|
+
|
37
|
+
module FFI
|
38
|
+
|
39
|
+
class StructLayout
|
40
|
+
|
41
|
+
# @return [Array<Array(Symbol, Numeric)>
|
42
|
+
# Get an array of tuples (field name, offset of the field).
|
43
|
+
def offsets
|
44
|
+
members.map { |m| [ m, self[m].offset ] }
|
45
|
+
end
|
46
|
+
|
47
|
+
# @return [Numeric]
|
48
|
+
# Get the offset of a field.
|
49
|
+
def offset_of(field_name)
|
50
|
+
self[field_name].offset
|
51
|
+
end
|
52
|
+
|
53
|
+
# An enum {Field} in a {StructLayout}.
|
54
|
+
class Enum < Field
|
55
|
+
|
56
|
+
# @param [AbstractMemory] ptr pointer on a {Struct}
|
57
|
+
# @return [Object]
|
58
|
+
# Get an object of type {#type} from memory pointed by +ptr+.
|
59
|
+
def get(ptr)
|
60
|
+
type.find(ptr.get_int(offset))
|
61
|
+
end
|
62
|
+
|
63
|
+
# @param [AbstractMemory] ptr pointer on a {Struct}
|
64
|
+
# @param value
|
65
|
+
# @return [nil]
|
66
|
+
# Set +value+ into memory pointed by +ptr+.
|
67
|
+
def put(ptr, value)
|
68
|
+
ptr.put_int(offset, type.find(value))
|
69
|
+
end
|
70
|
+
|
71
|
+
end
|
72
|
+
|
73
|
+
class InnerStruct < Field
|
74
|
+
def get(ptr)
|
75
|
+
type.struct_class.new(ptr.slice(self.offset, self.size))
|
76
|
+
end
|
77
|
+
|
78
|
+
def put(ptr, value)
|
79
|
+
raise TypeError, "wrong value type (expected #{type.struct_class})" unless value.is_a?(type.struct_class)
|
80
|
+
ptr.slice(self.offset, self.size).__copy_from__(value.pointer, self.size)
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
class Mapped < Field
|
85
|
+
def initialize(name, offset, type, orig_field)
|
86
|
+
super(name, offset, type)
|
87
|
+
@orig_field = orig_field
|
88
|
+
end
|
89
|
+
|
90
|
+
def get(ptr)
|
91
|
+
type.from_native(@orig_field.get(ptr), nil)
|
92
|
+
end
|
93
|
+
|
94
|
+
def put(ptr, value)
|
95
|
+
@orig_field.put(ptr, type.to_native(value, nil))
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
|
101
|
+
class Struct
|
102
|
+
|
103
|
+
# Get struct size
|
104
|
+
# @return [Numeric]
|
105
|
+
def size
|
106
|
+
self.class.size
|
107
|
+
end
|
108
|
+
|
109
|
+
# @return [Fixnum] Struct alignment
|
110
|
+
def alignment
|
111
|
+
self.class.alignment
|
112
|
+
end
|
113
|
+
alias_method :align, :alignment
|
114
|
+
|
115
|
+
# (see FFI::StructLayout#offset_of)
|
116
|
+
def offset_of(name)
|
117
|
+
self.class.offset_of(name)
|
118
|
+
end
|
119
|
+
|
120
|
+
# (see FFI::StructLayout#members)
|
121
|
+
def members
|
122
|
+
self.class.members
|
123
|
+
end
|
124
|
+
|
125
|
+
# @return [Array]
|
126
|
+
# Get array of values from Struct fields.
|
127
|
+
def values
|
128
|
+
members.map { |m| self[m] }
|
129
|
+
end
|
130
|
+
|
131
|
+
# (see FFI::StructLayout#offsets)
|
132
|
+
def offsets
|
133
|
+
self.class.offsets
|
134
|
+
end
|
135
|
+
|
136
|
+
# Clear the struct content.
|
137
|
+
# @return [self]
|
138
|
+
def clear
|
139
|
+
pointer.clear
|
140
|
+
self
|
141
|
+
end
|
142
|
+
|
143
|
+
# Get {Pointer} to struct content.
|
144
|
+
# @return [AbstractMemory]
|
145
|
+
def to_ptr
|
146
|
+
pointer
|
147
|
+
end
|
148
|
+
|
149
|
+
# Get struct size
|
150
|
+
# @return [Numeric]
|
151
|
+
def self.size
|
152
|
+
defined?(@layout) ? @layout.size : defined?(@size) ? @size : 0
|
153
|
+
end
|
154
|
+
|
155
|
+
# set struct size
|
156
|
+
# @param [Numeric] size
|
157
|
+
# @return [size]
|
158
|
+
def self.size=(size)
|
159
|
+
raise ArgumentError, "Size already set" if defined?(@size) || defined?(@layout)
|
160
|
+
@size = size
|
161
|
+
end
|
162
|
+
|
163
|
+
# @return (see Struct#alignment)
|
164
|
+
def self.alignment
|
165
|
+
@layout.alignment
|
166
|
+
end
|
167
|
+
|
168
|
+
# (see FFI::Type#members)
|
169
|
+
def self.members
|
170
|
+
@layout.members
|
171
|
+
end
|
172
|
+
|
173
|
+
# (see FFI::StructLayout#offsets)
|
174
|
+
def self.offsets
|
175
|
+
@layout.offsets
|
176
|
+
end
|
177
|
+
|
178
|
+
# (see FFI::StructLayout#offset_of)
|
179
|
+
def self.offset_of(name)
|
180
|
+
@layout.offset_of(name)
|
181
|
+
end
|
182
|
+
|
183
|
+
def self.in
|
184
|
+
ptr(:in)
|
185
|
+
end
|
186
|
+
|
187
|
+
def self.out
|
188
|
+
ptr(:out)
|
189
|
+
end
|
190
|
+
|
191
|
+
def self.ptr(flags = :inout)
|
192
|
+
@ref_data_type ||= Type::Mapped.new(StructByReference.new(self))
|
193
|
+
end
|
194
|
+
|
195
|
+
def self.val
|
196
|
+
@val_data_type ||= StructByValue.new(self)
|
197
|
+
end
|
198
|
+
|
199
|
+
def self.by_value
|
200
|
+
self.val
|
201
|
+
end
|
202
|
+
|
203
|
+
def self.by_ref(flags = :inout)
|
204
|
+
self.ptr(flags)
|
205
|
+
end
|
206
|
+
|
207
|
+
class ManagedStructConverter < StructByReference
|
208
|
+
|
209
|
+
# @param [Struct] struct_class
|
210
|
+
def initialize(struct_class)
|
211
|
+
super(struct_class)
|
212
|
+
|
213
|
+
raise NoMethodError, "release() not implemented for class #{struct_class}" unless struct_class.respond_to? :release
|
214
|
+
@method = struct_class.method(:release)
|
215
|
+
end
|
216
|
+
|
217
|
+
# @param [Pointer] ptr
|
218
|
+
# @param [nil] ctx
|
219
|
+
# @return [Struct]
|
220
|
+
def from_native(ptr, ctx)
|
221
|
+
struct_class.new(AutoPointer.new(ptr, @method))
|
222
|
+
end
|
223
|
+
end
|
224
|
+
|
225
|
+
def self.auto_ptr
|
226
|
+
@managed_type ||= Type::Mapped.new(ManagedStructConverter.new(self))
|
227
|
+
end
|
228
|
+
|
229
|
+
|
230
|
+
class << self
|
231
|
+
public
|
232
|
+
|
233
|
+
# @return [StructLayout]
|
234
|
+
# @overload layout
|
235
|
+
# @return [StructLayout]
|
236
|
+
# Get struct layout.
|
237
|
+
# @overload layout(*spec)
|
238
|
+
# @param [Array<Symbol, Integer>,Array(Hash)] spec
|
239
|
+
# @return [StructLayout]
|
240
|
+
# Create struct layout from +spec+.
|
241
|
+
# @example Creating a layout from an array +spec+
|
242
|
+
# class MyStruct < Struct
|
243
|
+
# layout :field1, :int,
|
244
|
+
# :field2, :pointer,
|
245
|
+
# :field3, :string
|
246
|
+
# end
|
247
|
+
# @example Creating a layout from an array +spec+ with offset
|
248
|
+
# class MyStructWithOffset < Struct
|
249
|
+
# layout :field1, :int,
|
250
|
+
# :field2, :pointer, 6, # set offset to 6 for this field
|
251
|
+
# :field3, :string
|
252
|
+
# end
|
253
|
+
# @example Creating a layout from a hash +spec+ (Ruby 1.9 only)
|
254
|
+
# class MyStructFromHash < Struct
|
255
|
+
# layout :field1 => :int,
|
256
|
+
# :field2 => :pointer,
|
257
|
+
# :field3 => :string
|
258
|
+
# end
|
259
|
+
# @example Creating a layout with pointers to functions
|
260
|
+
# class MyFunctionTable < Struct
|
261
|
+
# layout :function1, callback([:int, :int], :int),
|
262
|
+
# :function2, callback([:pointer], :void),
|
263
|
+
# :field3, :string
|
264
|
+
# end
|
265
|
+
# @note Creating a layout from a hash +spec+ is supported only for Ruby 1.9.
|
266
|
+
def layout(*spec)
|
267
|
+
#raise RuntimeError, "struct layout already defined for #{self.inspect}" if defined?(@layout)
|
268
|
+
return @layout if spec.size == 0
|
269
|
+
|
270
|
+
builder = StructLayoutBuilder.new
|
271
|
+
builder.union = self < Union
|
272
|
+
builder.packed = @packed if defined?(@packed)
|
273
|
+
builder.alignment = @min_alignment if defined?(@min_alignment)
|
274
|
+
|
275
|
+
if spec[0].kind_of?(Hash)
|
276
|
+
hash_layout(builder, spec)
|
277
|
+
else
|
278
|
+
array_layout(builder, spec)
|
279
|
+
end
|
280
|
+
builder.size = @size if defined?(@size) && @size > builder.size
|
281
|
+
cspec = builder.build
|
282
|
+
@layout = cspec unless self == Struct
|
283
|
+
@size = cspec.size
|
284
|
+
return cspec
|
285
|
+
end
|
286
|
+
|
287
|
+
|
288
|
+
protected
|
289
|
+
|
290
|
+
def callback(params, ret)
|
291
|
+
mod = enclosing_module
|
292
|
+
FFI::CallbackInfo.new(find_type(ret, mod), params.map { |e| find_type(e, mod) })
|
293
|
+
end
|
294
|
+
|
295
|
+
def packed(packed = 1)
|
296
|
+
@packed = packed
|
297
|
+
end
|
298
|
+
alias :pack :packed
|
299
|
+
|
300
|
+
def aligned(alignment = 1)
|
301
|
+
@min_alignment = alignment
|
302
|
+
end
|
303
|
+
alias :align :aligned
|
304
|
+
|
305
|
+
def enclosing_module
|
306
|
+
begin
|
307
|
+
mod = self.name.split("::")[0..-2].inject(Object) { |obj, c| obj.const_get(c) }
|
308
|
+
(mod < FFI::Library || mod < FFI::Struct || mod.respond_to?(:find_type)) ? mod : nil
|
309
|
+
rescue Exception
|
310
|
+
nil
|
311
|
+
end
|
312
|
+
end
|
313
|
+
|
314
|
+
|
315
|
+
def find_field_type(type, mod = enclosing_module)
|
316
|
+
if type.kind_of?(Class) && type < Struct
|
317
|
+
FFI::Type::Struct.new(type)
|
318
|
+
|
319
|
+
elsif type.kind_of?(Class) && type < FFI::StructLayout::Field
|
320
|
+
type
|
321
|
+
|
322
|
+
elsif type.kind_of?(::Array)
|
323
|
+
FFI::Type::Array.new(find_field_type(type[0]), type[1])
|
324
|
+
|
325
|
+
else
|
326
|
+
find_type(type, mod)
|
327
|
+
end
|
328
|
+
end
|
329
|
+
|
330
|
+
def find_type(type, mod = enclosing_module)
|
331
|
+
if mod
|
332
|
+
mod.find_type(type)
|
333
|
+
end || FFI.find_type(type)
|
334
|
+
end
|
335
|
+
|
336
|
+
private
|
337
|
+
|
338
|
+
# @param [StructLayoutBuilder] builder
|
339
|
+
# @param [Hash] spec
|
340
|
+
# @return [builder]
|
341
|
+
# Add hash +spec+ to +builder+.
|
342
|
+
def hash_layout(builder, spec)
|
343
|
+
spec[0].each do |name, type|
|
344
|
+
builder.add name, find_field_type(type), nil
|
345
|
+
end
|
346
|
+
end
|
347
|
+
|
348
|
+
# @param [StructLayoutBuilder] builder
|
349
|
+
# @param [Array<Symbol, Integer>] spec
|
350
|
+
# @return [builder]
|
351
|
+
# Add array +spec+ to +builder+.
|
352
|
+
def array_layout(builder, spec)
|
353
|
+
i = 0
|
354
|
+
while i < spec.size
|
355
|
+
name, type = spec[i, 2]
|
356
|
+
i += 2
|
357
|
+
|
358
|
+
# If the next param is a Integer, it specifies the offset
|
359
|
+
if spec[i].kind_of?(Integer)
|
360
|
+
offset = spec[i]
|
361
|
+
i += 1
|
362
|
+
else
|
363
|
+
offset = nil
|
364
|
+
end
|
365
|
+
|
366
|
+
builder.add name, find_field_type(type), offset
|
367
|
+
end
|
368
|
+
end
|
369
|
+
end
|
370
|
+
end
|
371
|
+
end
|
@@ -0,0 +1,227 @@
|
|
1
|
+
#
|
2
|
+
# Copyright (C) 2008-2010 Wayne Meissner
|
3
|
+
#
|
4
|
+
# This file is part of ruby-ffi.
|
5
|
+
#
|
6
|
+
# All rights reserved.
|
7
|
+
#
|
8
|
+
# Redistribution and use in source and binary forms, with or without
|
9
|
+
# modification, are permitted provided that the following conditions are met:
|
10
|
+
#
|
11
|
+
# * Redistributions of source code must retain the above copyright notice, this
|
12
|
+
# list of conditions and the following disclaimer.
|
13
|
+
# * Redistributions in binary form must reproduce the above copyright notice
|
14
|
+
# this list of conditions and the following disclaimer in the documentation
|
15
|
+
# and/or other materials provided with the distribution.
|
16
|
+
# * Neither the name of the Ruby FFI project nor the names of its contributors
|
17
|
+
# may be used to endorse or promote products derived from this software
|
18
|
+
# without specific prior written permission.
|
19
|
+
#
|
20
|
+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
21
|
+
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
22
|
+
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
23
|
+
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
|
24
|
+
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
25
|
+
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
26
|
+
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
27
|
+
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
28
|
+
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
29
|
+
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
30
|
+
#
|
31
|
+
|
32
|
+
module FFI
|
33
|
+
|
34
|
+
# Build a {StructLayout struct layout}.
|
35
|
+
class StructLayoutBuilder
|
36
|
+
attr_reader :size
|
37
|
+
attr_reader :alignment
|
38
|
+
|
39
|
+
def initialize
|
40
|
+
@size = 0
|
41
|
+
@alignment = 1
|
42
|
+
@min_alignment = 1
|
43
|
+
@packed = false
|
44
|
+
@union = false
|
45
|
+
@fields = Array.new
|
46
|
+
end
|
47
|
+
|
48
|
+
# Set size attribute with +size+ only if +size+ is greater than attribute value.
|
49
|
+
# @param [Numeric] size
|
50
|
+
def size=(size)
|
51
|
+
@size = size if size > @size
|
52
|
+
end
|
53
|
+
|
54
|
+
# Set alignment attribute with +align+ only if it is greater than attribute value.
|
55
|
+
# @param [Numeric] align
|
56
|
+
def alignment=(align)
|
57
|
+
@alignment = align if align > @alignment
|
58
|
+
@min_alignment = align
|
59
|
+
end
|
60
|
+
|
61
|
+
# Set union attribute.
|
62
|
+
# Set to +true+ to build a {Union} instead of a {Struct}.
|
63
|
+
# @param [Boolean] is_union
|
64
|
+
# @return [is_union]
|
65
|
+
def union=(is_union)
|
66
|
+
@union = is_union
|
67
|
+
end
|
68
|
+
|
69
|
+
# Building a {Union} or a {Struct} ?
|
70
|
+
#
|
71
|
+
# @return [Boolean]
|
72
|
+
#
|
73
|
+
def union?
|
74
|
+
@union
|
75
|
+
end
|
76
|
+
|
77
|
+
# Set packed attribute
|
78
|
+
# @overload packed=(packed) Set alignment and packed attributes to
|
79
|
+
# +packed+.
|
80
|
+
#
|
81
|
+
# @param [Fixnum] packed
|
82
|
+
#
|
83
|
+
# @return [packed]
|
84
|
+
# @overload packed=(packed) Set packed attribute.
|
85
|
+
# @param packed
|
86
|
+
#
|
87
|
+
# @return [0,1]
|
88
|
+
#
|
89
|
+
def packed=(packed)
|
90
|
+
if packed.is_a?(0.class)
|
91
|
+
@alignment = packed
|
92
|
+
@packed = packed
|
93
|
+
else
|
94
|
+
@packed = packed ? 1 : 0
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
|
99
|
+
# List of number types
|
100
|
+
NUMBER_TYPES = [
|
101
|
+
Type::INT8,
|
102
|
+
Type::UINT8,
|
103
|
+
Type::INT16,
|
104
|
+
Type::UINT16,
|
105
|
+
Type::INT32,
|
106
|
+
Type::UINT32,
|
107
|
+
Type::LONG,
|
108
|
+
Type::ULONG,
|
109
|
+
Type::INT64,
|
110
|
+
Type::UINT64,
|
111
|
+
Type::FLOAT32,
|
112
|
+
Type::FLOAT64,
|
113
|
+
Type::LONGDOUBLE,
|
114
|
+
Type::BOOL,
|
115
|
+
]
|
116
|
+
|
117
|
+
# @param [String, Symbol] name name of the field
|
118
|
+
# @param [Array, DataConverter, Struct, StructLayout::Field, Symbol, Type] type type of the field
|
119
|
+
# @param [Numeric, nil] offset
|
120
|
+
# @return [self]
|
121
|
+
# Add a field to the builder.
|
122
|
+
# @note Setting +offset+ to +nil+ or +-1+ is equivalent to +0+.
|
123
|
+
def add(name, type, offset = nil)
|
124
|
+
|
125
|
+
if offset.nil? || offset == -1
|
126
|
+
offset = @union ? 0 : align(@size, @packed ? [ @packed, type.alignment ].min : [ @min_alignment, type.alignment ].max)
|
127
|
+
end
|
128
|
+
|
129
|
+
#
|
130
|
+
# If a FFI::Type type was passed in as the field arg, try and convert to a StructLayout::Field instance
|
131
|
+
#
|
132
|
+
field = type.is_a?(StructLayout::Field) ? type : field_for_type(name, offset, type)
|
133
|
+
@fields << field
|
134
|
+
@alignment = [ @alignment, field.alignment ].max unless @packed
|
135
|
+
@size = [ @size, field.size + (@union ? 0 : field.offset) ].max
|
136
|
+
|
137
|
+
return self
|
138
|
+
end
|
139
|
+
|
140
|
+
# @param (see #add)
|
141
|
+
# @return (see #add)
|
142
|
+
# Same as {#add}.
|
143
|
+
# @see #add
|
144
|
+
def add_field(name, type, offset = nil)
|
145
|
+
add(name, type, offset)
|
146
|
+
end
|
147
|
+
|
148
|
+
# @param (see #add)
|
149
|
+
# @return (see #add)
|
150
|
+
# Add a struct as a field to the builder.
|
151
|
+
def add_struct(name, type, offset = nil)
|
152
|
+
add(name, Type::Struct.new(type), offset)
|
153
|
+
end
|
154
|
+
|
155
|
+
# @param name (see #add)
|
156
|
+
# @param type (see #add)
|
157
|
+
# @param [Numeric] count array length
|
158
|
+
# @param offset (see #add)
|
159
|
+
# @return (see #add)
|
160
|
+
# Add an array as a field to the builder.
|
161
|
+
def add_array(name, type, count, offset = nil)
|
162
|
+
add(name, Type::Array.new(type, count), offset)
|
163
|
+
end
|
164
|
+
|
165
|
+
# @return [StructLayout]
|
166
|
+
# Build and return the struct layout.
|
167
|
+
def build
|
168
|
+
# Add tail padding if the struct is not packed
|
169
|
+
size = @packed ? @size : align(@size, @alignment)
|
170
|
+
|
171
|
+
layout = StructLayout.new(@fields, size, @alignment)
|
172
|
+
layout.__union! if @union
|
173
|
+
layout
|
174
|
+
end
|
175
|
+
|
176
|
+
private
|
177
|
+
|
178
|
+
# @param [Numeric] offset
|
179
|
+
# @param [Numeric] align
|
180
|
+
# @return [Numeric]
|
181
|
+
def align(offset, align)
|
182
|
+
align + ((offset - 1) & ~(align - 1));
|
183
|
+
end
|
184
|
+
|
185
|
+
# @param (see #add)
|
186
|
+
# @return [StructLayout::Field]
|
187
|
+
def field_for_type(name, offset, type)
|
188
|
+
field_class = case
|
189
|
+
when type.is_a?(Type::Function)
|
190
|
+
StructLayout::Function
|
191
|
+
|
192
|
+
when type.is_a?(Type::Struct)
|
193
|
+
StructLayout::InnerStruct
|
194
|
+
|
195
|
+
when type.is_a?(Type::Array)
|
196
|
+
StructLayout::Array
|
197
|
+
|
198
|
+
when type.is_a?(FFI::Enum)
|
199
|
+
StructLayout::Enum
|
200
|
+
|
201
|
+
when NUMBER_TYPES.include?(type)
|
202
|
+
StructLayout::Number
|
203
|
+
|
204
|
+
when type == Type::POINTER
|
205
|
+
StructLayout::Pointer
|
206
|
+
|
207
|
+
when type == Type::STRING
|
208
|
+
StructLayout::String
|
209
|
+
|
210
|
+
when type.is_a?(Class) && type < StructLayout::Field
|
211
|
+
type
|
212
|
+
|
213
|
+
when type.is_a?(DataConverter)
|
214
|
+
return StructLayout::Mapped.new(name, offset, Type::Mapped.new(type), field_for_type(name, offset, type.native_type))
|
215
|
+
|
216
|
+
when type.is_a?(Type::Mapped)
|
217
|
+
return StructLayout::Mapped.new(name, offset, type, field_for_type(name, offset, type.native_type))
|
218
|
+
|
219
|
+
else
|
220
|
+
raise TypeError, "invalid struct field type #{type.inspect}"
|
221
|
+
end
|
222
|
+
|
223
|
+
field_class.new(name, offset, type)
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
end
|