/
callback_spec.rb
867 lines (738 loc) · 25.1 KB
/
callback_spec.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
#
# This file is part of ruby-ffi.
# For licensing, see LICENSE.SPECS
#
require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
describe "Callback" do
# module LibC
# extend FFI::Library
# callback :qsort_cmp, [ :pointer, :pointer ], :int
# attach_function :qsort, [ :pointer, :int, :int, :qsort_cmp ], :int
# end
# it "arguments get passed correctly" do
# p = MemoryPointer.new(:int, 2)
# p.put_array_of_int32(0, [ 1 , 2 ])
# args = []
# cmp = proc do |p1, p2| args.push(p1.get_int(0)); args.push(p2.get_int(0)); 0; end
# # this is a bit dodgey, as it relies on qsort passing the args in order
# LibC.qsort(p, 2, 4, cmp)
# args.should == [ 1, 2 ]
# end
#
# it "Block can be substituted for Callback as last argument" do
# p = MemoryPointer.new(:int, 2)
# p.put_array_of_int32(0, [ 1 , 2 ])
# args = []
# # this is a bit dodgey, as it relies on qsort passing the args in order
# LibC.qsort(p, 2, 4) do |p1, p2|
# args.push(p1.get_int(0))
# args.push(p2.get_int(0))
# 0
# end
# args.should == [ 1, 2 ]
# end
module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
class S8F32S32 < FFI::Struct
layout :s8, :char, :f32, :float, :s32, :int
end
callback :cbVrS8, [ ], :char
callback :cbVrU8, [ ], :uchar
callback :cbVrS16, [ ], :short
callback :cbVrU16, [ ], :ushort
callback :cbVrS32, [ ], :int
callback :cbVrU32, [ ], :uint
callback :cbVrL, [ ], :long
callback :cbVrUL, [ ], :ulong
callback :cbVrS64, [ ], :long_long
callback :cbVrU64, [ ], :ulong_long
callback :cbVrP, [], :pointer
callback :cbVrZ, [], :bool
callback :cbCrV, [ :char ], :void
callback :cbSrV, [ :short ], :void
callback :cbIrV, [ :int ], :void
callback :cbLrV, [ :long ], :void
callback :cbULrV, [ :ulong ], :void
callback :cbLrV, [ :long_long ], :void
callback :cbVrT, [ ], S8F32S32.by_value
callback :cbTrV, [ S8F32S32.by_value ], :void
callback :cbYrV, [ S8F32S32.ptr ], :void
callback :cbVrY, [ ], S8F32S32.ptr
attach_function :testCallbackVrS8, :testClosureVrB, [ :cbVrS8 ], :char
attach_function :testCallbackVrU8, :testClosureVrB, [ :cbVrU8 ], :uchar
attach_function :testCallbackVrS16, :testClosureVrS, [ :cbVrS16 ], :short
attach_function :testCallbackVrU16, :testClosureVrS, [ :cbVrU16 ], :ushort
attach_function :testCallbackVrS32, :testClosureVrI, [ :cbVrS32 ], :int
attach_function :testCallbackVrU32, :testClosureVrI, [ :cbVrU32 ], :uint
attach_function :testCallbackVrL, :testClosureVrL, [ :cbVrL ], :long
attach_function :testCallbackVrZ, :testClosureVrZ, [ :cbVrZ ], :bool
attach_function :testCallbackVrUL, :testClosureVrL, [ :cbVrUL ], :ulong
attach_function :testCallbackVrS64, :testClosureVrLL, [ :cbVrS64 ], :long_long
attach_function :testCallbackVrU64, :testClosureVrLL, [ :cbVrU64 ], :ulong_long
attach_function :testCallbackVrP, :testClosureVrP, [ :cbVrP ], :pointer
attach_function :testCallbackVrY, :testClosureVrP, [ :cbVrY ], S8F32S32.ptr
attach_function :testCallbackVrT, :testClosureVrT, [ :cbVrT ], S8F32S32.by_value
attach_function :testCallbackTrV, :testClosureTrV, [ :cbTrV, S8F32S32.ptr ], :void
attach_variable :cbVrS8, :gvar_pointer, :cbVrS8
attach_variable :pVrS8, :gvar_pointer, :pointer
attach_function :testGVarCallbackVrS8, :testClosureVrB, [ :pointer ], :char
attach_function :testOptionalCallbackCrV, :testOptionalClosureBrV, [ :cbCrV, :char ], :void
end
it "returning :char (0)" do
expect(LibTest.testCallbackVrS8 { 0 }).to eq(0)
end
it "returning :char (127)" do
expect(LibTest.testCallbackVrS8 { 127 }).to eq(127)
end
it "returning :char (-128)" do
expect(LibTest.testCallbackVrS8 { -128 }).to eq(-128)
end
# test wrap around
it "returning :char (128)" do
expect(LibTest.testCallbackVrS8 { 128 }).to eq(-128)
end
it "returning :char (255)" do
expect(LibTest.testCallbackVrS8 { 0xff }).to eq(-1)
end
it "returning :uchar (0)" do
expect(LibTest.testCallbackVrU8 { 0 }).to eq(0)
end
it "returning :uchar (0xff)" do
expect(LibTest.testCallbackVrU8 { 0xff }).to eq(0xff)
end
it "returning :uchar (-1)" do
expect(LibTest.testCallbackVrU8 { -1 }).to eq(0xff)
end
it "returning :uchar (128)" do
expect(LibTest.testCallbackVrU8 { 128 }).to eq(128)
end
it "returning :uchar (-128)" do
expect(LibTest.testCallbackVrU8 { -128 }).to eq(128)
end
it "returning :short (0)" do
expect(LibTest.testCallbackVrS16 { 0 }).to eq(0)
end
it "returning :short (0x7fff)" do
expect(LibTest.testCallbackVrS16 { 0x7fff }).to eq(0x7fff)
end
# test wrap around
it "returning :short (0x8000)" do
expect(LibTest.testCallbackVrS16 { 0x8000 }).to eq(-0x8000)
end
it "returning :short (0xffff)" do
expect(LibTest.testCallbackVrS16 { 0xffff }).to eq(-1)
end
it "returning :ushort (0)" do
expect(LibTest.testCallbackVrU16 { 0 }).to eq(0)
end
it "returning :ushort (0x7fff)" do
expect(LibTest.testCallbackVrU16 { 0x7fff }).to eq(0x7fff)
end
it "returning :ushort (0x8000)" do
expect(LibTest.testCallbackVrU16 { 0x8000 }).to eq(0x8000)
end
it "returning :ushort (0xffff)" do
expect(LibTest.testCallbackVrU16 { 0xffff }).to eq(0xffff)
end
it "returning :ushort (-1)" do
expect(LibTest.testCallbackVrU16 { -1 }).to eq(0xffff)
end
it "returning :int (0)" do
expect(LibTest.testCallbackVrS32 { 0 }).to eq(0)
end
it "returning :int (0x7fffffff)" do
expect(LibTest.testCallbackVrS32 { 0x7fffffff }).to eq(0x7fffffff)
end
# test wrap around
it "returning :int (-0x80000000)" do
expect(LibTest.testCallbackVrS32 { -0x80000000 }).to eq(-0x80000000)
end
it "returning :int (-1)" do
expect(LibTest.testCallbackVrS32 { -1 }).to eq(-1)
end
it "returning :uint (0)" do
expect(LibTest.testCallbackVrU32 { 0 }).to eq(0)
end
it "returning :uint (0x7fffffff)" do
expect(LibTest.testCallbackVrU32 { 0x7fffffff }).to eq(0x7fffffff)
end
# test wrap around
it "returning :uint (0x80000000)" do
expect(LibTest.testCallbackVrU32 { 0x80000000 }).to eq(0x80000000)
end
it "returning :uint (0xffffffff)" do
expect(LibTest.testCallbackVrU32 { 0xffffffff }).to eq(0xffffffff)
end
it "returning :uint (-1)" do
expect(LibTest.testCallbackVrU32 { -1 }).to eq(0xffffffff)
end
it "returning :long (0)" do
expect(LibTest.testCallbackVrL { 0 }).to eq(0)
end
it "returning :long (0x7fffffff)" do
expect(LibTest.testCallbackVrL { 0x7fffffff }).to eq(0x7fffffff)
end
# test wrap around
it "returning :long (-0x80000000)" do
expect(LibTest.testCallbackVrL { -0x80000000 }).to eq(-0x80000000)
end
it "returning :long (-1)" do
expect(LibTest.testCallbackVrL { -1 }).to eq(-1)
end
it "returning :ulong (0)" do
expect(LibTest.testCallbackVrUL { 0 }).to eq(0)
end
it "returning :ulong (0x7fffffff)" do
expect(LibTest.testCallbackVrUL { 0x7fffffff }).to eq(0x7fffffff)
end
# test wrap around
it "returning :ulong (0x80000000)" do
expect(LibTest.testCallbackVrUL { 0x80000000 }).to eq(0x80000000)
end
it "returning :ulong (0xffffffff)" do
expect(LibTest.testCallbackVrUL { 0xffffffff }).to eq(0xffffffff)
end
it "Callback returning :ulong (-1)" do
if FFI::Platform::LONG_SIZE == 32
expect(LibTest.testCallbackVrUL { -1 }).to eq(0xffffffff)
else
expect(LibTest.testCallbackVrUL { -1 }).to eq(0xffffffffffffffff)
end
end
it "returning :long_long (0)" do
expect(LibTest.testCallbackVrS64 { 0 }).to eq(0)
end
it "returning :long_long (0x7fffffffffffffff)" do
expect(LibTest.testCallbackVrS64 { 0x7fffffffffffffff }).to eq(0x7fffffffffffffff)
end
# test wrap around
it "returning :long_long (-0x8000000000000000)" do
expect(LibTest.testCallbackVrS64 { -0x8000000000000000 }).to eq(-0x8000000000000000)
end
it "returning :long_long (-1)" do
expect(LibTest.testCallbackVrS64 { -1 }).to eq(-1)
end
it "returning bool" do
expect(LibTest.testCallbackVrZ { true }).to be true
end
it "returning :pointer (nil)" do
expect(LibTest.testCallbackVrP { nil }).to be_null
end
it "returning :pointer (MemoryPointer)" do
p = FFI::MemoryPointer.new :long
expect(LibTest.testCallbackVrP { p }).to eq(p)
end
it "returning struct by value" do
skip "Segfault on 32 bit MINGW" if RUBY_PLATFORM == 'i386-mingw32'
s = LibTest::S8F32S32.new
s[:s8] = 0x12
s[:s32] = 0x1eefbeef
s[:f32] = 1.234567
ret = LibTest.testCallbackVrT { s }
expect(ret[:s8]).to eq(s[:s8])
expect(ret[:f32]).to eq(s[:f32])
expect(ret[:s32]).to eq(s[:s32])
end
it "struct by value parameter" do
s = LibTest::S8F32S32.new
s[:s8] = 0x12
s[:s32] = 0x1eefbeef
s[:f32] = 1.234567
s2 = LibTest::S8F32S32.new
LibTest.testCallbackTrV(s) do |struct|
s2[:s8] = struct[:s8]
s2[:f32] = struct[:f32]
s2[:s32] = struct[:s32]
end
expect(s2[:s8]).to eql 0x12
expect(s2[:s32]).to eql 0x1eefbeef
expect(s2[:f32]).to be_within(0.0000001).of 1.234567
end
it "global variable" do
proc = Proc.new { 0x1e }
LibTest.cbVrS8 = proc
expect(LibTest.testGVarCallbackVrS8(LibTest.pVrS8)).to eq(0x1e)
end
describe "When the callback is considered optional by the underlying library" do
it "should handle receiving 'nil' in place of the closure" do
expect(LibTest.testOptionalCallbackCrV(nil, 13)).to be_nil
end
end
describe 'when inlined' do
it 'could be anonymous' do
module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
attach_function :testAnonymousCallbackVrS8, :testClosureVrB, [ callback([ ], :char) ], :char
end
expect(LibTest.testAnonymousCallbackVrS8 { 0 }).to eq(0)
end
end
describe "as return value" do
it "should not blow up when a callback is defined that returns a callback" do
expect(module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
callback :cb_return_type_1, [ :short ], :short
callback :cb_lookup_1, [ :short ], :cb_return_type_1
attach_function :testReturnsCallback_1, :testReturnsClosure, [ :cb_lookup_1, :short ], :cb_return_type_1
end).to be_an_instance_of FFI::Function
end
it "should return a callback" do
module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
callback :cb_return_type, [ :int ], :int
callback :cb_lookup, [ ], :cb_return_type
attach_function :testReturnsCallback, :testReturnsClosure, [ :cb_lookup, :int ], :int
end
lookup_proc_called = false
return_proc_called = false
return_proc = Proc.new do |a|
return_proc_called = true
a * 2
end
lookup_proc = Proc.new do
lookup_proc_called = true
return_proc
end
val = LibTest.testReturnsCallback(lookup_proc, 0x1234)
expect(val).to eq(0x1234 * 2)
expect(lookup_proc_called).to be true
expect(return_proc_called).to be true
end
it "should return a method callback" do
module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
callback :cb_return_type, [ :int ], :int
callback :cb_lookup, [ ], :cb_return_type
attach_function :testReturnsCallback_2, :testReturnsClosure, [ :cb_lookup, :int ], :int
end
module MethodCallback
def self.lookup
method(:perform)
end
def self.perform num
num * 2
end
end
expect(LibTest.testReturnsCallback_2(MethodCallback.method(:lookup), 0x1234)).to eq(0x2468)
end
it 'should not blow up when a callback takes a callback as argument' do
expect(module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
callback :cb_argument, [ :int ], :int
callback :cb_with_cb_argument, [ :cb_argument, :int ], :int
attach_function :testCallbackAsArgument_2, :testArgumentClosure, [ :cb_with_cb_argument, :int ], :int
end).to be_an_instance_of FFI::Function
end
it 'should be able to use the callback argument' do
module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
callback :cb_argument, [ :int ], :int
callback :cb_with_cb_argument, [ :cb_argument, :int ], :int
attach_function :testCallbackAsArgument, :testArgumentClosure, [ :cb_with_cb_argument, :cb_argument, :int ], :int
end
callback_arg_called = false
callback_with_callback_arg_called = false
callback_arg = Proc.new do |val|
callback_arg_called = true
val * 2
end
callback_with_callback_arg = Proc.new do |cb, val|
callback_with_callback_arg_called = true
cb.call(val)
end
val = LibTest.testCallbackAsArgument(callback_with_callback_arg, callback_arg, 0xff1)
expect(val).to eq(0xff1 * 2)
expect(callback_arg_called).to be true
expect(callback_with_callback_arg_called).to be true
end
it 'function returns callable object' do
module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
callback :funcptr, [ :int ], :int
attach_function :testReturnsFunctionPointer, [ ], :funcptr
end
f = LibTest.testReturnsFunctionPointer
expect(f.call(3)).to eq(6)
end
end
end
describe "Callback with " do
#
# Test callbacks that take an argument, returning void
#
module LibTest
extend FFI::Library
ffi_lib TestLibrary::PATH
class S8F32S32 < FFI::Struct
layout :s8, :char, :f32, :float, :s32, :int
end
callback :cbS8rV, [ :char ], :void
callback :cbU8rV, [ :uchar ], :void
callback :cbS16rV, [ :short ], :void
callback :cbU16rV, [ :ushort ], :void
callback :cbZrV, [ :bool ], :void
callback :cbS32rV, [ :int ], :void
callback :cbU32rV, [ :uint ], :void
callback :cbLrV, [ :long ], :void
callback :cbULrV, [ :ulong ], :void
callback :cbArV, [ :string ], :void
callback :cbPrV, [ :pointer], :void
callback :cbYrV, [ S8F32S32.ptr ], :void
callback :cbS64rV, [ :long_long ], :void
attach_function :testCallbackCrV, :testClosureBrV, [ :cbS8rV, :char ], :void
attach_function :testCallbackU8rV, :testClosureBrV, [ :cbU8rV, :uchar ], :void
attach_function :testCallbackSrV, :testClosureSrV, [ :cbS16rV, :short ], :void
attach_function :testCallbackU16rV, :testClosureSrV, [ :cbU16rV, :ushort ], :void
attach_function :testCallbackZrV, :testClosureZrV, [ :cbZrV, :bool ], :void
attach_function :testCallbackIrV, :testClosureIrV, [ :cbS32rV, :int ], :void
attach_function :testCallbackU32rV, :testClosureIrV, [ :cbU32rV, :uint ], :void
attach_function :testCallbackLrV, :testClosureLrV, [ :cbLrV, :long ], :void
attach_function :testCallbackULrV, :testClosureULrV, [ :cbULrV, :ulong ], :void
attach_function :testCallbackLLrV, :testClosureLLrV, [ :cbS64rV, :long_long ], :void
attach_function :testCallbackArV, :testClosurePrV, [ :cbArV, :string ], :void
attach_function :testCallbackPrV, :testClosurePrV, [ :cbPrV, :pointer], :void
attach_function :testCallbackYrV, :testClosurePrV, [ :cbYrV, S8F32S32.in ], :void
end
it "function with Callback plus another arg should raise error if no arg given" do
expect { LibTest.testCallbackCrV { |*a| }}.to raise_error
end
it ":char (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackCrV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":char (127) argument" do
v = 0xdeadbeef
LibTest.testCallbackCrV(127) { |i| v = i }
expect(v).to eq(127)
end
it ":char (-128) argument" do
v = 0xdeadbeef
LibTest.testCallbackCrV(-128) { |i| v = i }
expect(v).to eq(-128)
end
it ":char (-1) argument" do
v = 0xdeadbeef
LibTest.testCallbackCrV(-1) { |i| v = i }
expect(v).to eq(-1)
end
it ":uchar (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackU8rV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":uchar (127) argument" do
v = 0xdeadbeef
LibTest.testCallbackU8rV(127) { |i| v = i }
expect(v).to eq(127)
end
it ":uchar (128) argument" do
v = 0xdeadbeef
LibTest.testCallbackU8rV(128) { |i| v = i }
expect(v).to eq(128)
end
it ":uchar (255) argument" do
v = 0xdeadbeef
LibTest.testCallbackU8rV(255) { |i| v = i }
expect(v).to eq(255)
end
it ":short (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackSrV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":short (0x7fff) argument" do
v = 0xdeadbeef
LibTest.testCallbackSrV(0x7fff) { |i| v = i }
expect(v).to eq(0x7fff)
end
it ":short (-0x8000) argument" do
v = 0xdeadbeef
LibTest.testCallbackSrV(-0x8000) { |i| v = i }
expect(v).to eq(-0x8000)
end
it ":short (-1) argument" do
v = 0xdeadbeef
LibTest.testCallbackSrV(-1) { |i| v = i }
expect(v).to eq(-1)
end
it ":ushort (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackU16rV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":ushort (0x7fff) argument" do
v = 0xdeadbeef
LibTest.testCallbackU16rV(0x7fff) { |i| v = i }
expect(v).to eq(0x7fff)
end
it ":ushort (0x8000) argument" do
v = 0xdeadbeef
LibTest.testCallbackU16rV(0x8000) { |i| v = i }
expect(v).to eq(0x8000)
end
it ":ushort (0xffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackU16rV(0xffff) { |i| v = i }
expect(v).to eq(0xffff)
end
it ":bool (true) argument" do
v = false
LibTest.testCallbackZrV(true) { |i| v = i }
expect(v).to be true
end
it ":int (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackIrV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":int (0x7fffffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackIrV(0x7fffffff) { |i| v = i }
expect(v).to eq(0x7fffffff)
end
it ":int (-0x80000000) argument" do
v = 0xdeadbeef
LibTest.testCallbackIrV(-0x80000000) { |i| v = i }
expect(v).to eq(-0x80000000)
end
it ":int (-1) argument" do
v = 0xdeadbeef
LibTest.testCallbackIrV(-1) { |i| v = i }
expect(v).to eq(-1)
end
it ":uint (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackU32rV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":uint (0x7fffffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackU32rV(0x7fffffff) { |i| v = i }
expect(v).to eq(0x7fffffff)
end
it ":uint (0x80000000) argument" do
v = 0xdeadbeef
LibTest.testCallbackU32rV(0x80000000) { |i| v = i }
expect(v).to eq(0x80000000)
end
it ":uint (0xffffffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackU32rV(0xffffffff) { |i| v = i }
expect(v).to eq(0xffffffff)
end
it ":long (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackLrV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":long (0x7fffffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackLrV(0x7fffffff) { |i| v = i }
expect(v).to eq(0x7fffffff)
end
it ":long (-0x80000000) argument" do
v = 0xdeadbeef
LibTest.testCallbackLrV(-0x80000000) { |i| v = i }
expect(v).to eq(-0x80000000)
end
it ":long (-1) argument" do
v = 0xdeadbeef
LibTest.testCallbackLrV(-1) { |i| v = i }
expect(v).to eq(-1)
end
it ":ulong (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackULrV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":ulong (0x7fffffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackULrV(0x7fffffff) { |i| v = i }
expect(v).to eq(0x7fffffff)
end
it ":ulong (0x80000000) argument" do
v = 0xdeadbeef
LibTest.testCallbackULrV(0x80000000) { |i| v = i }
expect(v).to eq(0x80000000)
end
it ":ulong (0xffffffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackULrV(0xffffffff) { |i| v = i }
expect(v).to eq(0xffffffff)
end
it ":long_long (0) argument" do
v = 0xdeadbeef
LibTest.testCallbackLLrV(0) { |i| v = i }
expect(v).to eq(0)
end
it ":long_long (0x7fffffffffffffff) argument" do
v = 0xdeadbeef
LibTest.testCallbackLLrV(0x7fffffffffffffff) { |i| v = i }
expect(v).to eq(0x7fffffffffffffff)
end
it ":long_long (-0x8000000000000000) argument" do
v = 0xdeadbeef
LibTest.testCallbackLLrV(-0x8000000000000000) { |i| v = i }
expect(v).to eq(-0x8000000000000000)
end
it ":long_long (-1) argument" do
v = 0xdeadbeef
LibTest.testCallbackLLrV(-1) { |i| v = i }
expect(v).to eq(-1)
end
it ":string argument" do
v = nil
LibTest.testCallbackArV("Hello, World") { |i| v = i }
expect(v).to eq("Hello, World")
end
it ":string (nil) argument" do
v = "Hello, World"
LibTest.testCallbackArV(nil) { |i| v = i }
expect(v).to be_nil
end
it ":pointer argument" do
v = nil
magic = FFI::Pointer.new(0xdeadbeef)
LibTest.testCallbackPrV(magic) { |i| v = i }
expect(v).to eq(magic)
end
it ":pointer (nil) argument" do
v = "Hello, World"
LibTest.testCallbackPrV(nil) { |i| v = i }
expect(v).to eq(FFI::Pointer::NULL)
end
it "struct by reference argument" do
v = nil
magic = LibTest::S8F32S32.new
LibTest.testCallbackYrV(magic) { |i| v = i }
expect(v.class).to eq(magic.class)
expect(v.pointer).to eq(magic.pointer)
end
it "struct by reference argument with nil value" do
v = LibTest::S8F32S32.new
LibTest.testCallbackYrV(nil) { |i| v = i }
expect(v.is_a?(FFI::Struct)).to be true
expect(v.pointer).to eq(FFI::Pointer::NULL)
end
it "varargs parameters are rejected" do
expect {
Module.new do
extend FFI::Library
ffi_lib TestLibrary::PATH
callback :cbVrL, [ :varargs ], :long
end
}.to raise_error(ArgumentError)
end
#
# Test stdcall convention with function and callback.
# This is Windows 32-bit only.
#
if FFI::Platform::OS =~ /windows|cygwin/ && FFI::Platform::ARCH == 'i386'
module LibTestStdcall
extend FFI::Library
ffi_lib TestLibrary::PATH
ffi_convention :stdcall
callback :cbStdcall, [ :pointer, :long ], :void
attach_function :testCallbackStdcall, 'testClosureStdcall', [ :pointer, :cbStdcall, :long ], :bool
end
it "stdcall convention" do
v = 0xdeadbeef
po = FFI::MemoryPointer.new :long
pr = proc{|a,i| v = a,i; i }
res = LibTestStdcall.testCallbackStdcall(po, pr, 0x7fffffff)
expect(v).to eq([po, 0x7fffffff])
expect(res).to be true
end
end
end
describe "Callback interop" do
require 'fiddle'
require 'fiddle/import'
require 'timeout'
module LibTestFFI
extend FFI::Library
ffi_lib TestLibrary::PATH
attach_function :testCallbackVrV, :testClosureVrV, [ :pointer ], :void
attach_function :testCallbackVrV_blocking, :testClosureVrV, [ :pointer ], :void, blocking: true
end
module LibTestFiddle
extend Fiddle::Importer
dlload TestLibrary::PATH
extern 'void testClosureVrV(void *fp)'
end
def assert_callback_in_same_thread_called_once
called = 0
thread = nil
yield proc {
called += 1
thread = Thread.current
}
expect(called).to eq(1)
expect(thread).to eq(Thread.current)
end
it "from ffi to ffi" do
assert_callback_in_same_thread_called_once do |block|
func = FFI::Function.new(:void, [:pointer], &block)
LibTestFFI.testCallbackVrV(FFI::Pointer.new(func.to_i))
end
end
it "from ffi to ffi with blocking:true" do
assert_callback_in_same_thread_called_once do |block|
func = FFI::Function.new(:void, [:pointer], &block)
LibTestFFI.testCallbackVrV_blocking(FFI::Pointer.new(func.to_i))
end
end
# https://github.com/ffi/ffi/issues/527
if RUBY_VERSION.split('.').map(&:to_i).pack("C*") >= [2,3,0].pack("C*") || RUBY_PLATFORM =~ /java/
it "from fiddle to ffi" do
assert_callback_in_same_thread_called_once do |block|
func = FFI::Function.new(:void, [:pointer], &block)
LibTestFiddle.testClosureVrV(Fiddle::Pointer[func.to_i])
end
end
end
it "from ffi to fiddle" do
assert_callback_in_same_thread_called_once do |block|
func = LibTestFiddle.bind_function(:cbVrV, Fiddle::TYPE_VOID, [], &block)
LibTestFFI.testCallbackVrV(FFI::Pointer.new(func.to_i))
end
end
it "from ffi to fiddle with blocking:true" do
assert_callback_in_same_thread_called_once do |block|
func = LibTestFiddle.bind_function(:cbVrV, Fiddle::TYPE_VOID, [], &block)
LibTestFFI.testCallbackVrV_blocking(FFI::Pointer.new(func.to_i))
end
end
it "from fiddle to fiddle" do
assert_callback_in_same_thread_called_once do |block|
func = LibTestFiddle.bind_function(:cbVrV, Fiddle::TYPE_VOID, [], &block)
LibTestFiddle.testClosureVrV(Fiddle::Pointer[func.to_i])
end
end
# https://github.com/ffi/ffi/issues/527
if RUBY_ENGINE == 'ruby' && RUBY_VERSION.split('.').map(&:to_i).pack("C*") >= [2,3,0].pack("C*")
it "C outside ffi call stack does not deadlock [#527]" do
path = File.join(File.dirname(__FILE__), "embed-test/embed-test.rb")
pid = spawn(RbConfig.ruby, "-Ilib", path, { [:out, :err] => "embed-test.log" })
begin
Timeout.timeout(10){ Process.wait(pid) }
rescue Timeout::Error
Process.kill(9, pid)
raise
else
if $?.exitstatus != 0
raise "external process failed:\n#{ File.read("embed-test.log") }"
end
end
end
end
end