alinta-ffi 1.9.19

Sign up to get free protection for your applications and to get access to all the features.
Files changed (195) hide show
  1. checksums.yaml +7 -0
  2. data/COPYING +49 -0
  3. data/LICENSE +24 -0
  4. data/README.md +112 -0
  5. data/Rakefile +243 -0
  6. data/ext/ffi_c/AbstractMemory.c +1109 -0
  7. data/ext/ffi_c/AbstractMemory.h +175 -0
  8. data/ext/ffi_c/ArrayType.c +162 -0
  9. data/ext/ffi_c/ArrayType.h +59 -0
  10. data/ext/ffi_c/Buffer.c +365 -0
  11. data/ext/ffi_c/Call.c +517 -0
  12. data/ext/ffi_c/Call.h +110 -0
  13. data/ext/ffi_c/ClosurePool.c +283 -0
  14. data/ext/ffi_c/ClosurePool.h +57 -0
  15. data/ext/ffi_c/DataConverter.c +91 -0
  16. data/ext/ffi_c/DynamicLibrary.c +339 -0
  17. data/ext/ffi_c/DynamicLibrary.h +98 -0
  18. data/ext/ffi_c/Function.c +998 -0
  19. data/ext/ffi_c/Function.h +87 -0
  20. data/ext/ffi_c/FunctionInfo.c +271 -0
  21. data/ext/ffi_c/LastError.c +184 -0
  22. data/ext/ffi_c/LastError.h +47 -0
  23. data/ext/ffi_c/LongDouble.c +63 -0
  24. data/ext/ffi_c/LongDouble.h +51 -0
  25. data/ext/ffi_c/MappedType.c +168 -0
  26. data/ext/ffi_c/MappedType.h +59 -0
  27. data/ext/ffi_c/MemoryPointer.c +197 -0
  28. data/ext/ffi_c/MemoryPointer.h +53 -0
  29. data/ext/ffi_c/MethodHandle.c +358 -0
  30. data/ext/ffi_c/MethodHandle.h +55 -0
  31. data/ext/ffi_c/Platform.c +129 -0
  32. data/ext/ffi_c/Platform.h +45 -0
  33. data/ext/ffi_c/Pointer.c +508 -0
  34. data/ext/ffi_c/Pointer.h +63 -0
  35. data/ext/ffi_c/Struct.c +829 -0
  36. data/ext/ffi_c/Struct.h +106 -0
  37. data/ext/ffi_c/StructByReference.c +190 -0
  38. data/ext/ffi_c/StructByReference.h +50 -0
  39. data/ext/ffi_c/StructByValue.c +150 -0
  40. data/ext/ffi_c/StructByValue.h +55 -0
  41. data/ext/ffi_c/StructLayout.c +698 -0
  42. data/ext/ffi_c/Thread.c +352 -0
  43. data/ext/ffi_c/Thread.h +95 -0
  44. data/ext/ffi_c/Type.c +397 -0
  45. data/ext/ffi_c/Type.h +62 -0
  46. data/ext/ffi_c/Types.c +139 -0
  47. data/ext/ffi_c/Types.h +89 -0
  48. data/ext/ffi_c/Variadic.c +304 -0
  49. data/ext/ffi_c/compat.h +78 -0
  50. data/ext/ffi_c/extconf.rb +71 -0
  51. data/ext/ffi_c/ffi.c +98 -0
  52. data/ext/ffi_c/libffi.bsd.mk +40 -0
  53. data/ext/ffi_c/libffi.darwin.mk +105 -0
  54. data/ext/ffi_c/libffi.gnu.mk +32 -0
  55. data/ext/ffi_c/libffi.mk +18 -0
  56. data/ext/ffi_c/libffi.vc.mk +26 -0
  57. data/ext/ffi_c/libffi.vc64.mk +26 -0
  58. data/ext/ffi_c/rbffi.h +57 -0
  59. data/ext/ffi_c/rbffi_endian.h +59 -0
  60. data/ext/ffi_c/win32/stdbool.h +8 -0
  61. data/ext/ffi_c/win32/stdint.h +201 -0
  62. data/ffi.gemspec +23 -0
  63. data/gen/Rakefile +30 -0
  64. data/lib/ffi.rb +20 -0
  65. data/lib/ffi/autopointer.rb +203 -0
  66. data/lib/ffi/buffer.rb +4 -0
  67. data/lib/ffi/callback.rb +4 -0
  68. data/lib/ffi/enum.rb +296 -0
  69. data/lib/ffi/errno.rb +43 -0
  70. data/lib/ffi/ffi.rb +44 -0
  71. data/lib/ffi/io.rb +62 -0
  72. data/lib/ffi/library.rb +590 -0
  73. data/lib/ffi/managedstruct.rb +84 -0
  74. data/lib/ffi/memorypointer.rb +1 -0
  75. data/lib/ffi/platform.rb +164 -0
  76. data/lib/ffi/platform/aarch64-linux/types.conf +104 -0
  77. data/lib/ffi/platform/arm-linux/types.conf +104 -0
  78. data/lib/ffi/platform/i386-cygwin/types.conf +3 -0
  79. data/lib/ffi/platform/i386-darwin/types.conf +100 -0
  80. data/lib/ffi/platform/i386-freebsd/types.conf +152 -0
  81. data/lib/ffi/platform/i386-gnu/types.conf +107 -0
  82. data/lib/ffi/platform/i386-linux/types.conf +103 -0
  83. data/lib/ffi/platform/i386-netbsd/types.conf +126 -0
  84. data/lib/ffi/platform/i386-openbsd/types.conf +128 -0
  85. data/lib/ffi/platform/i386-solaris/types.conf +122 -0
  86. data/lib/ffi/platform/i386-windows/types.conf +105 -0
  87. data/lib/ffi/platform/ia64-linux/types.conf +104 -0
  88. data/lib/ffi/platform/mips-linux/types.conf +102 -0
  89. data/lib/ffi/platform/mips64el-linux/types.conf +104 -0
  90. data/lib/ffi/platform/mipsel-linux/types.conf +102 -0
  91. data/lib/ffi/platform/powerpc-aix/types.conf +180 -0
  92. data/lib/ffi/platform/powerpc-darwin/types.conf +100 -0
  93. data/lib/ffi/platform/powerpc-linux/types.conf +100 -0
  94. data/lib/ffi/platform/powerpc64-linux/types.conf +104 -0
  95. data/lib/ffi/platform/s390-linux/types.conf +102 -0
  96. data/lib/ffi/platform/s390x-linux/types.conf +102 -0
  97. data/lib/ffi/platform/sparc-linux/types.conf +102 -0
  98. data/lib/ffi/platform/sparc-solaris/types.conf +128 -0
  99. data/lib/ffi/platform/sparc64-linux/types.conf +102 -0
  100. data/lib/ffi/platform/sparcv9-solaris/types.conf +128 -0
  101. data/lib/ffi/platform/x86_64-cygwin/types.conf +3 -0
  102. data/lib/ffi/platform/x86_64-darwin/types.conf +126 -0
  103. data/lib/ffi/platform/x86_64-freebsd/types.conf +128 -0
  104. data/lib/ffi/platform/x86_64-linux/types.conf +102 -0
  105. data/lib/ffi/platform/x86_64-netbsd/types.conf +128 -0
  106. data/lib/ffi/platform/x86_64-openbsd/types.conf +134 -0
  107. data/lib/ffi/platform/x86_64-solaris/types.conf +122 -0
  108. data/lib/ffi/platform/x86_64-windows/types.conf +120 -0
  109. data/lib/ffi/pointer.rb +161 -0
  110. data/lib/ffi/struct.rb +371 -0
  111. data/lib/ffi/struct_layout_builder.rb +227 -0
  112. data/lib/ffi/tools/const_generator.rb +229 -0
  113. data/lib/ffi/tools/generator.rb +60 -0
  114. data/lib/ffi/tools/generator_task.rb +36 -0
  115. data/lib/ffi/tools/struct_generator.rb +194 -0
  116. data/lib/ffi/tools/types_generator.rb +134 -0
  117. data/lib/ffi/types.rb +194 -0
  118. data/lib/ffi/union.rb +43 -0
  119. data/lib/ffi/variadic.rb +78 -0
  120. data/lib/ffi/version.rb +4 -0
  121. data/libtest/Benchmark.c +52 -0
  122. data/libtest/BoolTest.c +34 -0
  123. data/libtest/BufferTest.c +31 -0
  124. data/libtest/ClosureTest.c +205 -0
  125. data/libtest/EnumTest.c +51 -0
  126. data/libtest/FunctionTest.c +70 -0
  127. data/libtest/GNUmakefile +149 -0
  128. data/libtest/GlobalVariable.c +62 -0
  129. data/libtest/LastErrorTest.c +21 -0
  130. data/libtest/NumberTest.c +132 -0
  131. data/libtest/PointerTest.c +63 -0
  132. data/libtest/ReferenceTest.c +23 -0
  133. data/libtest/StringTest.c +34 -0
  134. data/libtest/StructTest.c +243 -0
  135. data/libtest/UnionTest.c +43 -0
  136. data/libtest/VariadicTest.c +99 -0
  137. data/spec/ffi/LICENSE.SPECS +22 -0
  138. data/spec/ffi/async_callback_spec.rb +35 -0
  139. data/spec/ffi/bitmask_spec.rb +575 -0
  140. data/spec/ffi/bool_spec.rb +32 -0
  141. data/spec/ffi/buffer_spec.rb +279 -0
  142. data/spec/ffi/callback_spec.rb +773 -0
  143. data/spec/ffi/custom_param_type.rb +37 -0
  144. data/spec/ffi/custom_type_spec.rb +74 -0
  145. data/spec/ffi/dup_spec.rb +52 -0
  146. data/spec/ffi/enum_spec.rb +423 -0
  147. data/spec/ffi/errno_spec.rb +20 -0
  148. data/spec/ffi/ffi_spec.rb +28 -0
  149. data/spec/ffi/fixtures/Benchmark.c +52 -0
  150. data/spec/ffi/fixtures/BitmaskTest.c +51 -0
  151. data/spec/ffi/fixtures/BoolTest.c +34 -0
  152. data/spec/ffi/fixtures/BufferTest.c +31 -0
  153. data/spec/ffi/fixtures/ClosureTest.c +205 -0
  154. data/spec/ffi/fixtures/EnumTest.c +51 -0
  155. data/spec/ffi/fixtures/FunctionTest.c +142 -0
  156. data/spec/ffi/fixtures/GNUmakefile +149 -0
  157. data/spec/ffi/fixtures/GlobalVariable.c +62 -0
  158. data/spec/ffi/fixtures/LastErrorTest.c +21 -0
  159. data/spec/ffi/fixtures/NumberTest.c +132 -0
  160. data/spec/ffi/fixtures/PipeHelper.h +21 -0
  161. data/spec/ffi/fixtures/PipeHelperPosix.c +41 -0
  162. data/spec/ffi/fixtures/PipeHelperWindows.c +72 -0
  163. data/spec/ffi/fixtures/PointerTest.c +63 -0
  164. data/spec/ffi/fixtures/ReferenceTest.c +23 -0
  165. data/spec/ffi/fixtures/StringTest.c +34 -0
  166. data/spec/ffi/fixtures/StructTest.c +243 -0
  167. data/spec/ffi/fixtures/UnionTest.c +43 -0
  168. data/spec/ffi/fixtures/VariadicTest.c +99 -0
  169. data/spec/ffi/fixtures/classes.rb +438 -0
  170. data/spec/ffi/function_spec.rb +97 -0
  171. data/spec/ffi/io_spec.rb +16 -0
  172. data/spec/ffi/library_spec.rb +286 -0
  173. data/spec/ffi/long_double.rb +30 -0
  174. data/spec/ffi/managed_struct_spec.rb +68 -0
  175. data/spec/ffi/memorypointer_spec.rb +78 -0
  176. data/spec/ffi/number_spec.rb +247 -0
  177. data/spec/ffi/platform_spec.rb +114 -0
  178. data/spec/ffi/pointer_spec.rb +285 -0
  179. data/spec/ffi/rbx/attach_function_spec.rb +34 -0
  180. data/spec/ffi/rbx/memory_pointer_spec.rb +198 -0
  181. data/spec/ffi/rbx/spec_helper.rb +6 -0
  182. data/spec/ffi/rbx/struct_spec.rb +18 -0
  183. data/spec/ffi/spec_helper.rb +93 -0
  184. data/spec/ffi/string_spec.rb +118 -0
  185. data/spec/ffi/strptr_spec.rb +50 -0
  186. data/spec/ffi/struct_by_ref_spec.rb +43 -0
  187. data/spec/ffi/struct_callback_spec.rb +69 -0
  188. data/spec/ffi/struct_initialize_spec.rb +35 -0
  189. data/spec/ffi/struct_packed_spec.rb +50 -0
  190. data/spec/ffi/struct_spec.rb +882 -0
  191. data/spec/ffi/typedef_spec.rb +91 -0
  192. data/spec/ffi/union_spec.rb +67 -0
  193. data/spec/ffi/variadic_spec.rb +132 -0
  194. data/spec/spec.opts +4 -0
  195. metadata +309 -0
@@ -0,0 +1,63 @@
1
+ /*
2
+ * Copyright (c) 2008, 2009, Wayne Meissner
3
+ *
4
+ * Copyright (c) 2008-2013, Ruby FFI project contributors
5
+ * All rights reserved.
6
+ *
7
+ * Redistribution and use in source and binary forms, with or without
8
+ * modification, are permitted provided that the following conditions are met:
9
+ * * Redistributions of source code must retain the above copyright
10
+ * notice, this list of conditions and the following disclaimer.
11
+ * * Redistributions in binary form must reproduce the above copyright
12
+ * notice, this list of conditions and the following disclaimer in the
13
+ * documentation and/or other materials provided with the distribution.
14
+ * * Neither the name of the Ruby FFI project nor the
15
+ * names of its contributors may be used to endorse or promote products
16
+ * derived from this software without specific prior written permission.
17
+ *
18
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21
+ * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
22
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
+ */
29
+
30
+ #ifndef RBFFI_POINTER_H
31
+ #define RBFFI_POINTER_H
32
+
33
+ #ifndef _MSC_VER
34
+ # include <stdbool.h>
35
+ #else
36
+ # include "win32/stdbool.h"
37
+ #endif
38
+
39
+ #ifdef __cplusplus
40
+ extern "C" {
41
+ #endif
42
+
43
+ #include "AbstractMemory.h"
44
+
45
+ extern void rbffi_Pointer_Init(VALUE moduleFFI);
46
+ extern VALUE rbffi_Pointer_NewInstance(void* addr);
47
+ extern VALUE rbffi_PointerClass;
48
+ extern VALUE rbffi_NullPointerSingleton;
49
+
50
+ typedef struct Pointer {
51
+ AbstractMemory memory;
52
+ VALUE rbParent;
53
+ char* storage; /* start of malloc area */
54
+ bool autorelease;
55
+ bool allocated;
56
+ } Pointer;
57
+
58
+ #ifdef __cplusplus
59
+ }
60
+ #endif
61
+
62
+ #endif /* RBFFI_POINTER_H */
63
+
@@ -0,0 +1,829 @@
1
+ /*
2
+ * Copyright (c) 2008, 2009, Wayne Meissner
3
+ * Copyright (C) 2009 Luc Heinrich <luc@honk-honk.com>
4
+ *
5
+ * Copyright (c) 2008-2013, Ruby FFI project contributors
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
+ * * Redistributions of source code must retain the above copyright
11
+ * notice, this list of conditions and the following disclaimer.
12
+ * * Redistributions in binary form must reproduce the above copyright
13
+ * notice, this list of conditions and the following disclaimer in the
14
+ * documentation and/or other materials provided with the distribution.
15
+ * * Neither the name of the Ruby FFI project nor the
16
+ * names of its contributors may be used to endorse or promote products
17
+ * derived from this software without specific prior written permission.
18
+ *
19
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22
+ * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
23
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
+ */
30
+
31
+ #include <sys/types.h>
32
+ #ifndef _MSC_VER
33
+ # include <sys/param.h>
34
+ # include <stdint.h>
35
+ # include <stdbool.h>
36
+ #else
37
+ # include "win32/stdbool.h"
38
+ # include "win32/stdint.h"
39
+ #endif
40
+ #include <ruby.h>
41
+ #include "rbffi.h"
42
+ #include "compat.h"
43
+ #include "AbstractMemory.h"
44
+ #include "Pointer.h"
45
+ #include "MemoryPointer.h"
46
+ #include "Function.h"
47
+ #include "Types.h"
48
+ #include "Function.h"
49
+ #include "StructByValue.h"
50
+ #include "ArrayType.h"
51
+ #include "MappedType.h"
52
+ #include "Struct.h"
53
+
54
+ typedef struct InlineArray_ {
55
+ VALUE rbMemory;
56
+ VALUE rbField;
57
+
58
+ AbstractMemory* memory;
59
+ StructField* field;
60
+ MemoryOp *op;
61
+ Type* componentType;
62
+ ArrayType* arrayType;
63
+ int length;
64
+ } InlineArray;
65
+
66
+
67
+ static void struct_mark(Struct *);
68
+ static void struct_free(Struct *);
69
+ static VALUE struct_class_layout(VALUE klass);
70
+ static void struct_malloc(Struct* s);
71
+ static void inline_array_mark(InlineArray *);
72
+ static void store_reference_value(StructField* f, Struct* s, VALUE value);
73
+
74
+ VALUE rbffi_StructClass = Qnil;
75
+
76
+ VALUE rbffi_StructInlineArrayClass = Qnil;
77
+ VALUE rbffi_StructLayoutCharArrayClass = Qnil;
78
+
79
+ static ID id_pointer_ivar = 0, id_layout_ivar = 0;
80
+ static ID id_get = 0, id_put = 0, id_to_ptr = 0, id_to_s = 0, id_layout = 0;
81
+
82
+ static inline char*
83
+ memory_address(VALUE self)
84
+ {
85
+ return ((AbstractMemory *)DATA_PTR((self)))->address;
86
+ }
87
+
88
+ static VALUE
89
+ struct_allocate(VALUE klass)
90
+ {
91
+ Struct* s;
92
+ VALUE obj = Data_Make_Struct(klass, Struct, struct_mark, struct_free, s);
93
+
94
+ s->rbPointer = Qnil;
95
+ s->rbLayout = Qnil;
96
+
97
+ return obj;
98
+ }
99
+
100
+ /*
101
+ * call-seq: initialize
102
+ * @overload initialize(pointer, *args)
103
+ * @param [AbstractMemory] pointer
104
+ * @param [Array] args
105
+ * @return [self]
106
+ */
107
+ static VALUE
108
+ struct_initialize(int argc, VALUE* argv, VALUE self)
109
+ {
110
+ Struct* s;
111
+ VALUE rbPointer = Qnil, rest = Qnil, klass = CLASS_OF(self);
112
+ int nargs;
113
+
114
+ Data_Get_Struct(self, Struct, s);
115
+
116
+ nargs = rb_scan_args(argc, argv, "01*", &rbPointer, &rest);
117
+
118
+ /* Call up into ruby code to adjust the layout */
119
+ if (nargs > 1) {
120
+ s->rbLayout = rb_funcall2(CLASS_OF(self), id_layout, (int) RARRAY_LEN(rest), RARRAY_PTR(rest));
121
+ } else {
122
+ s->rbLayout = struct_class_layout(klass);
123
+ }
124
+
125
+ if (!rb_obj_is_kind_of(s->rbLayout, rbffi_StructLayoutClass)) {
126
+ rb_raise(rb_eRuntimeError, "Invalid Struct layout");
127
+ }
128
+
129
+ Data_Get_Struct(s->rbLayout, StructLayout, s->layout);
130
+
131
+ if (rbPointer != Qnil) {
132
+ s->pointer = MEMORY(rbPointer);
133
+ s->rbPointer = rbPointer;
134
+ } else {
135
+ struct_malloc(s);
136
+ }
137
+
138
+ return self;
139
+ }
140
+
141
+ /*
142
+ * call-seq: initialize_copy(other)
143
+ * @return [nil]
144
+ * DO NOT CALL THIS METHOD
145
+ */
146
+ static VALUE
147
+ struct_initialize_copy(VALUE self, VALUE other)
148
+ {
149
+ Struct* src;
150
+ Struct* dst;
151
+
152
+ Data_Get_Struct(self, Struct, dst);
153
+ Data_Get_Struct(other, Struct, src);
154
+ if (dst == src) {
155
+ return self;
156
+ }
157
+
158
+ dst->rbLayout = src->rbLayout;
159
+ dst->layout = src->layout;
160
+
161
+ /*
162
+ * A new MemoryPointer instance is allocated here instead of just calling
163
+ * #dup on rbPointer, since the Pointer may not know its length, or may
164
+ * be longer than just this struct.
165
+ */
166
+ if (src->pointer->address != NULL) {
167
+ dst->rbPointer = rbffi_MemoryPointer_NewInstance(1, src->layout->size, false);
168
+ dst->pointer = MEMORY(dst->rbPointer);
169
+ memcpy(dst->pointer->address, src->pointer->address, src->layout->size);
170
+ } else {
171
+ dst->rbPointer = src->rbPointer;
172
+ dst->pointer = src->pointer;
173
+ }
174
+
175
+ if (src->layout->referenceFieldCount > 0) {
176
+ dst->rbReferences = ALLOC_N(VALUE, dst->layout->referenceFieldCount);
177
+ memcpy(dst->rbReferences, src->rbReferences, dst->layout->referenceFieldCount * sizeof(VALUE));
178
+ }
179
+
180
+ return self;
181
+ }
182
+
183
+ static VALUE
184
+ struct_class_layout(VALUE klass)
185
+ {
186
+ VALUE layout;
187
+ if (!rb_ivar_defined(klass, id_layout_ivar)) {
188
+ rb_raise(rb_eRuntimeError, "no Struct layout configured for %s", rb_class2name(klass));
189
+ }
190
+
191
+ layout = rb_ivar_get(klass, id_layout_ivar);
192
+ if (!rb_obj_is_kind_of(layout, rbffi_StructLayoutClass)) {
193
+ rb_raise(rb_eRuntimeError, "invalid Struct layout for %s", rb_class2name(klass));
194
+ }
195
+
196
+ return layout;
197
+ }
198
+
199
+ static StructLayout*
200
+ struct_layout(VALUE self)
201
+ {
202
+ Struct* s = (Struct *) DATA_PTR(self);
203
+ if (s->layout != NULL) {
204
+ return s->layout;
205
+ }
206
+
207
+ if (s->layout == NULL) {
208
+ s->rbLayout = struct_class_layout(CLASS_OF(self));
209
+ Data_Get_Struct(s->rbLayout, StructLayout, s->layout);
210
+ }
211
+
212
+ return s->layout;
213
+ }
214
+
215
+ static Struct*
216
+ struct_validate(VALUE self)
217
+ {
218
+ Struct* s;
219
+ Data_Get_Struct(self, Struct, s);
220
+
221
+ if (struct_layout(self) == NULL) {
222
+ rb_raise(rb_eRuntimeError, "struct layout == null");
223
+ }
224
+
225
+ if (s->pointer == NULL) {
226
+ struct_malloc(s);
227
+ }
228
+
229
+ return s;
230
+ }
231
+
232
+ static void
233
+ struct_malloc(Struct* s)
234
+ {
235
+ if (s->rbPointer == Qnil) {
236
+ s->rbPointer = rbffi_MemoryPointer_NewInstance(s->layout->size, 1, true);
237
+
238
+ } else if (!rb_obj_is_kind_of(s->rbPointer, rbffi_AbstractMemoryClass)) {
239
+ rb_raise(rb_eRuntimeError, "invalid pointer in struct");
240
+ }
241
+
242
+ s->pointer = (AbstractMemory *) DATA_PTR(s->rbPointer);
243
+ }
244
+
245
+ static void
246
+ struct_mark(Struct *s)
247
+ {
248
+ rb_gc_mark(s->rbPointer);
249
+ rb_gc_mark(s->rbLayout);
250
+ if (s->rbReferences != NULL) {
251
+ rb_gc_mark_locations(&s->rbReferences[0], &s->rbReferences[s->layout->referenceFieldCount]);
252
+ }
253
+ }
254
+
255
+ static void
256
+ struct_free(Struct* s)
257
+ {
258
+ xfree(s->rbReferences);
259
+ xfree(s);
260
+ }
261
+
262
+
263
+ static void
264
+ store_reference_value(StructField* f, Struct* s, VALUE value)
265
+ {
266
+ if (unlikely(f->referenceIndex == -1)) {
267
+ rb_raise(rb_eRuntimeError, "put_reference_value called for non-reference type");
268
+ return;
269
+ }
270
+ if (s->rbReferences == NULL) {
271
+ int i;
272
+ s->rbReferences = ALLOC_N(VALUE, s->layout->referenceFieldCount);
273
+ for (i = 0; i < s->layout->referenceFieldCount; ++i) {
274
+ s->rbReferences[i] = Qnil;
275
+ }
276
+ }
277
+
278
+ s->rbReferences[f->referenceIndex] = value;
279
+ }
280
+
281
+
282
+ static VALUE
283
+ struct_field(Struct* s, VALUE fieldName)
284
+ {
285
+ StructLayout* layout = s->layout;
286
+ VALUE rbField;
287
+
288
+ if (likely(SYMBOL_P(fieldName) && st_lookup(layout->fieldSymbolTable, fieldName, (st_data_t *) &rbField))) {
289
+ return rbField;
290
+ }
291
+
292
+ // TODO does this ever return anything?
293
+ rbField = rb_hash_aref(layout->rbFieldMap, fieldName);
294
+ if (rbField == Qnil) {
295
+ VALUE str = rb_funcall2(fieldName, id_to_s, 0, NULL);
296
+ rb_raise(rb_eArgError, "No such field '%s'", StringValuePtr(str));
297
+ }
298
+
299
+ return rbField;
300
+ }
301
+
302
+ /*
303
+ * call-seq: struct[field_name]
304
+ * @param field_name field to access
305
+ * Acces to a Struct field.
306
+ */
307
+ static VALUE
308
+ struct_aref(VALUE self, VALUE fieldName)
309
+ {
310
+ Struct* s;
311
+ VALUE rbField;
312
+ StructField* f;
313
+
314
+ s = struct_validate(self);
315
+
316
+ rbField = struct_field(s, fieldName);
317
+ f = (StructField *) DATA_PTR(rbField);
318
+
319
+ if (f->get != NULL) {
320
+ return (*f->get)(f, s);
321
+
322
+ } else if (f->memoryOp != NULL) {
323
+ return (*f->memoryOp->get)(s->pointer, f->offset);
324
+
325
+ } else {
326
+
327
+ /* call up to the ruby code to fetch the value */
328
+ return rb_funcall2(rbField, id_get, 1, &s->rbPointer);
329
+ }
330
+ }
331
+
332
+ /*
333
+ * call-seq: []=(field_name, value)
334
+ * @param field_name field to access
335
+ * @param value value to set to +field_name+
336
+ * @return [value]
337
+ * Set a field in Struct.
338
+ */
339
+ static VALUE
340
+ struct_aset(VALUE self, VALUE fieldName, VALUE value)
341
+ {
342
+ Struct* s;
343
+ VALUE rbField;
344
+ StructField* f;
345
+
346
+
347
+ s = struct_validate(self);
348
+
349
+ rbField = struct_field(s, fieldName);
350
+ f = (StructField *) DATA_PTR(rbField);
351
+ if (f->put != NULL) {
352
+ (*f->put)(f, s, value);
353
+
354
+ } else if (f->memoryOp != NULL) {
355
+
356
+ (*f->memoryOp->put)(s->pointer, f->offset, value);
357
+
358
+ } else {
359
+ /* call up to the ruby code to set the value */
360
+ VALUE argv[2];
361
+ argv[0] = s->rbPointer;
362
+ argv[1] = value;
363
+ rb_funcall2(rbField, id_put, 2, argv);
364
+ }
365
+
366
+ if (f->referenceRequired) {
367
+ store_reference_value(f, s, value);
368
+ }
369
+
370
+ return value;
371
+ }
372
+
373
+ /*
374
+ * call-seq: pointer= pointer
375
+ * @param [AbstractMemory] pointer
376
+ * @return [self]
377
+ * Make Struct point to +pointer+.
378
+ */
379
+ static VALUE
380
+ struct_set_pointer(VALUE self, VALUE pointer)
381
+ {
382
+ Struct* s;
383
+ StructLayout* layout;
384
+ AbstractMemory* memory;
385
+
386
+ if (!rb_obj_is_kind_of(pointer, rbffi_AbstractMemoryClass)) {
387
+ rb_raise(rb_eTypeError, "wrong argument type %s (expected Pointer or Buffer)",
388
+ rb_obj_classname(pointer));
389
+ return Qnil;
390
+ }
391
+
392
+
393
+ Data_Get_Struct(self, Struct, s);
394
+ Data_Get_Struct(pointer, AbstractMemory, memory);
395
+ layout = struct_layout(self);
396
+
397
+ if ((int) layout->base.ffiType->size > memory->size) {
398
+ rb_raise(rb_eArgError, "memory of %ld bytes too small for struct %s (expected at least %ld)",
399
+ memory->size, rb_obj_classname(self), (long) layout->base.ffiType->size);
400
+ }
401
+
402
+ s->pointer = MEMORY(pointer);
403
+ s->rbPointer = pointer;
404
+ rb_ivar_set(self, id_pointer_ivar, pointer);
405
+
406
+ return self;
407
+ }
408
+
409
+ /*
410
+ * call-seq: pointer
411
+ * @return [AbstractMemory]
412
+ * Get pointer to Struct contents.
413
+ */
414
+ static VALUE
415
+ struct_get_pointer(VALUE self)
416
+ {
417
+ Struct* s;
418
+
419
+ Data_Get_Struct(self, Struct, s);
420
+
421
+ return s->rbPointer;
422
+ }
423
+
424
+ /*
425
+ * call-seq: layout= layout
426
+ * @param [StructLayout] layout
427
+ * @return [self]
428
+ * Set the Struct's layout.
429
+ */
430
+ static VALUE
431
+ struct_set_layout(VALUE self, VALUE layout)
432
+ {
433
+ Struct* s;
434
+ Data_Get_Struct(self, Struct, s);
435
+
436
+ if (!rb_obj_is_kind_of(layout, rbffi_StructLayoutClass)) {
437
+ rb_raise(rb_eTypeError, "wrong argument type %s (expected %s)",
438
+ rb_obj_classname(layout), rb_class2name(rbffi_StructLayoutClass));
439
+ return Qnil;
440
+ }
441
+
442
+ Data_Get_Struct(layout, StructLayout, s->layout);
443
+ rb_ivar_set(self, id_layout_ivar, layout);
444
+
445
+ return self;
446
+ }
447
+
448
+ /*
449
+ * call-seq: layout
450
+ * @return [StructLayout]
451
+ * Get the Struct's layout.
452
+ */
453
+ static VALUE
454
+ struct_get_layout(VALUE self)
455
+ {
456
+ Struct* s;
457
+
458
+ Data_Get_Struct(self, Struct, s);
459
+
460
+ return s->rbLayout;
461
+ }
462
+
463
+ /*
464
+ * call-seq: null?
465
+ * @return [Boolean]
466
+ * Test if Struct's pointer is NULL
467
+ */
468
+ static VALUE
469
+ struct_null_p(VALUE self)
470
+ {
471
+ Struct* s;
472
+
473
+ Data_Get_Struct(self, Struct, s);
474
+
475
+ return s->pointer->address == NULL ? Qtrue : Qfalse;
476
+ }
477
+
478
+ /*
479
+ * (see Pointer#order)
480
+ */
481
+ static VALUE
482
+ struct_order(int argc, VALUE* argv, VALUE self)
483
+ {
484
+ Struct* s;
485
+
486
+ Data_Get_Struct(self, Struct, s);
487
+ if (argc == 0) {
488
+ return rb_funcall(s->rbPointer, rb_intern("order"), 0);
489
+
490
+ } else {
491
+ VALUE retval = rb_obj_dup(self);
492
+ VALUE rbPointer = rb_funcall2(s->rbPointer, rb_intern("order"), argc, argv);
493
+ struct_set_pointer(retval, rbPointer);
494
+
495
+ return retval;
496
+ }
497
+ }
498
+
499
+ static VALUE
500
+ inline_array_allocate(VALUE klass)
501
+ {
502
+ InlineArray* array;
503
+ VALUE obj;
504
+
505
+ obj = Data_Make_Struct(klass, InlineArray, inline_array_mark, -1, array);
506
+ array->rbField = Qnil;
507
+ array->rbMemory = Qnil;
508
+
509
+ return obj;
510
+ }
511
+
512
+ static void
513
+ inline_array_mark(InlineArray* array)
514
+ {
515
+ rb_gc_mark(array->rbField);
516
+ rb_gc_mark(array->rbMemory);
517
+ }
518
+
519
+ /*
520
+ * Document-method: FFI::Struct::InlineArray#initialize
521
+ * call-seq: initialize(memory, field)
522
+ * @param [AbstractMemory] memory
523
+ * @param [StructField] field
524
+ * @return [self]
525
+ */
526
+ static VALUE
527
+ inline_array_initialize(VALUE self, VALUE rbMemory, VALUE rbField)
528
+ {
529
+ InlineArray* array;
530
+
531
+ Data_Get_Struct(self, InlineArray, array);
532
+ array->rbMemory = rbMemory;
533
+ array->rbField = rbField;
534
+
535
+ Data_Get_Struct(rbMemory, AbstractMemory, array->memory);
536
+ Data_Get_Struct(rbField, StructField, array->field);
537
+ Data_Get_Struct(array->field->rbType, ArrayType, array->arrayType);
538
+ Data_Get_Struct(array->arrayType->rbComponentType, Type, array->componentType);
539
+
540
+ array->op = get_memory_op(array->componentType);
541
+ if (array->op == NULL && array->componentType->nativeType == NATIVE_MAPPED) {
542
+ array->op = get_memory_op(((MappedType *) array->componentType)->type);
543
+ }
544
+
545
+ array->length = array->arrayType->length;
546
+
547
+ return self;
548
+ }
549
+
550
+ /*
551
+ * call-seq: size
552
+ * @return [Numeric]
553
+ * Get size
554
+ */
555
+ static VALUE
556
+ inline_array_size(VALUE self)
557
+ {
558
+ InlineArray* array;
559
+
560
+ Data_Get_Struct(self, InlineArray, array);
561
+
562
+ return UINT2NUM(((ArrayType *) array->field->type)->length);
563
+ }
564
+
565
+ static int
566
+ inline_array_offset(InlineArray* array, int index)
567
+ {
568
+ if (index < 0 || (index >= array->length && array->length > 0)) {
569
+ rb_raise(rb_eIndexError, "index %d out of bounds", index);
570
+ }
571
+
572
+ return (int) array->field->offset + (index * (int) array->componentType->ffiType->size);
573
+ }
574
+
575
+ /*
576
+ * call-seq: [](index)
577
+ * @param [Numeric] index
578
+ * @return [Type, Struct]
579
+ */
580
+ static VALUE
581
+ inline_array_aref(VALUE self, VALUE rbIndex)
582
+ {
583
+ InlineArray* array;
584
+
585
+ Data_Get_Struct(self, InlineArray, array);
586
+
587
+ if (array->op != NULL) {
588
+ VALUE rbNativeValue = array->op->get(array->memory,
589
+ inline_array_offset(array, NUM2INT(rbIndex)));
590
+ if (unlikely(array->componentType->nativeType == NATIVE_MAPPED)) {
591
+ return rb_funcall(((MappedType *) array->componentType)->rbConverter,
592
+ rb_intern("from_native"), 2, rbNativeValue, Qnil);
593
+ } else {
594
+ return rbNativeValue;
595
+ }
596
+
597
+ } else if (array->componentType->nativeType == NATIVE_STRUCT) {
598
+ VALUE rbOffset = INT2NUM(inline_array_offset(array, NUM2INT(rbIndex)));
599
+ VALUE rbLength = INT2NUM(array->componentType->ffiType->size);
600
+ VALUE rbPointer = rb_funcall(array->rbMemory, rb_intern("slice"), 2, rbOffset, rbLength);
601
+
602
+ return rb_class_new_instance(1, &rbPointer, ((StructByValue *) array->componentType)->rbStructClass);
603
+ } else {
604
+
605
+ rb_raise(rb_eArgError, "get not supported for %s", rb_obj_classname(array->arrayType->rbComponentType));
606
+ return Qnil;
607
+ }
608
+ }
609
+
610
+ /*
611
+ * call-seq: []=(index, value)
612
+ * @param [Numeric] index
613
+ * @param [Type, Struct]
614
+ * @return [value]
615
+ */
616
+ static VALUE
617
+ inline_array_aset(VALUE self, VALUE rbIndex, VALUE rbValue)
618
+ {
619
+ InlineArray* array;
620
+
621
+ Data_Get_Struct(self, InlineArray, array);
622
+
623
+ if (array->op != NULL) {
624
+ if (unlikely(array->componentType->nativeType == NATIVE_MAPPED)) {
625
+ rbValue = rb_funcall(((MappedType *) array->componentType)->rbConverter,
626
+ rb_intern("to_native"), 2, rbValue, Qnil);
627
+ }
628
+ array->op->put(array->memory, inline_array_offset(array, NUM2INT(rbIndex)),
629
+ rbValue);
630
+
631
+ } else if (array->componentType->nativeType == NATIVE_STRUCT) {
632
+ int offset = inline_array_offset(array, NUM2INT(rbIndex));
633
+ Struct* s;
634
+
635
+ if (!rb_obj_is_kind_of(rbValue, rbffi_StructClass)) {
636
+ rb_raise(rb_eTypeError, "argument not an instance of struct");
637
+ return Qnil;
638
+ }
639
+
640
+ checkWrite(array->memory);
641
+ checkBounds(array->memory, offset, array->componentType->ffiType->size);
642
+
643
+ Data_Get_Struct(rbValue, Struct, s);
644
+ checkRead(s->pointer);
645
+ checkBounds(s->pointer, 0, array->componentType->ffiType->size);
646
+
647
+ memcpy(array->memory->address + offset, s->pointer->address, array->componentType->ffiType->size);
648
+
649
+ } else {
650
+ ArrayType* arrayType;
651
+ Data_Get_Struct(array->field->rbType, ArrayType, arrayType);
652
+
653
+ rb_raise(rb_eArgError, "set not supported for %s", rb_obj_classname(arrayType->rbComponentType));
654
+ return Qnil;
655
+ }
656
+
657
+ return rbValue;
658
+ }
659
+
660
+ /*
661
+ * call-seq: each
662
+ * Yield block for each element of +self+.
663
+ */
664
+ static VALUE
665
+ inline_array_each(VALUE self)
666
+ {
667
+ InlineArray* array;
668
+
669
+ int i;
670
+
671
+ Data_Get_Struct(self, InlineArray, array);
672
+
673
+ for (i = 0; i < array->length; ++i) {
674
+ rb_yield(inline_array_aref(self, INT2FIX(i)));
675
+ }
676
+
677
+ return self;
678
+ }
679
+
680
+ /*
681
+ * call-seq: to_a
682
+ * @return [Array]
683
+ * Convert +self+ to an array.
684
+ */
685
+ static VALUE
686
+ inline_array_to_a(VALUE self)
687
+ {
688
+ InlineArray* array;
689
+ VALUE obj;
690
+ int i;
691
+
692
+ Data_Get_Struct(self, InlineArray, array);
693
+ obj = rb_ary_new2(array->length);
694
+
695
+
696
+ for (i = 0; i < array->length; ++i) {
697
+ rb_ary_push(obj, inline_array_aref(self, INT2FIX(i)));
698
+ }
699
+
700
+ return obj;
701
+ }
702
+
703
+ /*
704
+ * Document-method: FFI::StructLayout::CharArray#to_s
705
+ * call-seq: to_s
706
+ * @return [String]
707
+ * Convert +self+ to a string.
708
+ */
709
+ static VALUE
710
+ inline_array_to_s(VALUE self)
711
+ {
712
+ InlineArray* array;
713
+ VALUE argv[2];
714
+
715
+ Data_Get_Struct(self, InlineArray, array);
716
+
717
+ if (array->componentType->nativeType != NATIVE_INT8 && array->componentType->nativeType != NATIVE_UINT8) {
718
+ VALUE dummy = Qnil;
719
+ return rb_call_super(0, &dummy);
720
+ }
721
+
722
+ argv[0] = UINT2NUM(array->field->offset);
723
+ argv[1] = UINT2NUM(array->length);
724
+
725
+ return rb_funcall2(array->rbMemory, rb_intern("get_string"), 2, argv);
726
+ }
727
+
728
+ /*
729
+ * call-seq: to_ptr
730
+ * @return [AbstractMemory]
731
+ * Get pointer to +self+ content.
732
+ */
733
+ static VALUE
734
+ inline_array_to_ptr(VALUE self)
735
+ {
736
+ InlineArray* array;
737
+
738
+ Data_Get_Struct(self, InlineArray, array);
739
+
740
+ return rb_funcall(array->rbMemory, rb_intern("slice"), 2,
741
+ UINT2NUM(array->field->offset), UINT2NUM(array->arrayType->base.ffiType->size));
742
+ }
743
+
744
+
745
+ void
746
+ rbffi_Struct_Init(VALUE moduleFFI)
747
+ {
748
+ VALUE StructClass;
749
+
750
+ rbffi_StructLayout_Init(moduleFFI);
751
+
752
+ /*
753
+ * Document-class: FFI::Struct
754
+ *
755
+ * A FFI::Struct means to mirror a C struct.
756
+ *
757
+ * A Struct is defined as:
758
+ * class MyStruct < FFI::Struct
759
+ * layout :value1, :int,
760
+ * :value2, :double
761
+ * end
762
+ * and is used as:
763
+ * my_struct = MyStruct.new
764
+ * my_struct[:value1] = 12
765
+ *
766
+ * For more information, see http://github.com/ffi/ffi/wiki/Structs
767
+ */
768
+ rbffi_StructClass = rb_define_class_under(moduleFFI, "Struct", rb_cObject);
769
+ StructClass = rbffi_StructClass; // put on a line alone to help RDoc
770
+ rb_global_variable(&rbffi_StructClass);
771
+
772
+ /*
773
+ * Document-class: FFI::Struct::InlineArray
774
+ */
775
+ rbffi_StructInlineArrayClass = rb_define_class_under(rbffi_StructClass, "InlineArray", rb_cObject);
776
+ rb_global_variable(&rbffi_StructInlineArrayClass);
777
+
778
+ /*
779
+ * Document-class: FFI::StructLayout::CharArray < FFI::Struct::InlineArray
780
+ */
781
+ rbffi_StructLayoutCharArrayClass = rb_define_class_under(rbffi_StructLayoutClass, "CharArray",
782
+ rbffi_StructInlineArrayClass);
783
+ rb_global_variable(&rbffi_StructLayoutCharArrayClass);
784
+
785
+
786
+ rb_define_alloc_func(StructClass, struct_allocate);
787
+ rb_define_method(StructClass, "initialize", struct_initialize, -1);
788
+ rb_define_method(StructClass, "initialize_copy", struct_initialize_copy, 1);
789
+ rb_define_method(StructClass, "order", struct_order, -1);
790
+
791
+ rb_define_alias(rb_singleton_class(StructClass), "alloc_in", "new");
792
+ rb_define_alias(rb_singleton_class(StructClass), "alloc_out", "new");
793
+ rb_define_alias(rb_singleton_class(StructClass), "alloc_inout", "new");
794
+ rb_define_alias(rb_singleton_class(StructClass), "new_in", "new");
795
+ rb_define_alias(rb_singleton_class(StructClass), "new_out", "new");
796
+ rb_define_alias(rb_singleton_class(StructClass), "new_inout", "new");
797
+
798
+ rb_define_method(StructClass, "pointer", struct_get_pointer, 0);
799
+ rb_define_private_method(StructClass, "pointer=", struct_set_pointer, 1);
800
+
801
+ rb_define_method(StructClass, "layout", struct_get_layout, 0);
802
+ rb_define_private_method(StructClass, "layout=", struct_set_layout, 1);
803
+
804
+ rb_define_method(StructClass, "[]", struct_aref, 1);
805
+ rb_define_method(StructClass, "[]=", struct_aset, 2);
806
+ rb_define_method(StructClass, "null?", struct_null_p, 0);
807
+
808
+ rb_include_module(rbffi_StructInlineArrayClass, rb_mEnumerable);
809
+ rb_define_alloc_func(rbffi_StructInlineArrayClass, inline_array_allocate);
810
+ rb_define_method(rbffi_StructInlineArrayClass, "initialize", inline_array_initialize, 2);
811
+ rb_define_method(rbffi_StructInlineArrayClass, "[]", inline_array_aref, 1);
812
+ rb_define_method(rbffi_StructInlineArrayClass, "[]=", inline_array_aset, 2);
813
+ rb_define_method(rbffi_StructInlineArrayClass, "each", inline_array_each, 0);
814
+ rb_define_method(rbffi_StructInlineArrayClass, "size", inline_array_size, 0);
815
+ rb_define_method(rbffi_StructInlineArrayClass, "to_a", inline_array_to_a, 0);
816
+ rb_define_method(rbffi_StructInlineArrayClass, "to_ptr", inline_array_to_ptr, 0);
817
+
818
+ rb_define_method(rbffi_StructLayoutCharArrayClass, "to_s", inline_array_to_s, 0);
819
+ rb_define_alias(rbffi_StructLayoutCharArrayClass, "to_str", "to_s");
820
+
821
+ id_pointer_ivar = rb_intern("@pointer");
822
+ id_layout_ivar = rb_intern("@layout");
823
+ id_layout = rb_intern("layout");
824
+ id_get = rb_intern("get");
825
+ id_put = rb_intern("put");
826
+ id_to_ptr = rb_intern("to_ptr");
827
+ id_to_s = rb_intern("to_s");
828
+ }
829
+