Skip to content

Commit 2640e01

Browse files
koukou
committed
Use Ruby's true/false for C bool
GitHub: fix GH-130 Reported by Benoit Daloze. Thanks!!!
1 parent d4feb57 commit 2640e01

File tree

10 files changed

+125
-23
lines changed

10 files changed

+125
-23
lines changed

‎ext/fiddle/closure.c‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,20 @@ with_gvl_callback(void *ptr)
139139
rb_ary_push(params,
140140
rb_str_new_cstr(*((const char **)(x->args[i]))));
141141
break;
142+
case TYPE_BOOL:
143+
if (sizeof(bool) == sizeof(char)) {
144+
rb_ary_push(params, CBOOL2RBBOOL(*(unsigned char *)x->args[i]));
145+
} else if (sizeof(bool) == sizeof(short)) {
146+
rb_ary_push(params, CBOOL2RBBOOL(*(unsigned short *)x->args[i]));
147+
} else if (sizeof(bool) == sizeof(int)) {
148+
rb_ary_push(params, CBOOL2RBBOOL(*(unsigned int *)x->args[i]));
149+
} else if (sizeof(bool) == sizeof(long)) {
150+
rb_ary_push(params, CBOOL2RBBOOL(*(unsigned long *)x->args[i]));
151+
} else {
152+
rb_raise(rb_eNotImpError, "bool isn't supported: %u",
153+
(unsigned int)sizeof(bool));
154+
}
155+
break;
142156
default:
143157
rb_raise(rb_eRuntimeError, "closure args: %d", type);
144158
}
@@ -188,6 +202,13 @@ with_gvl_callback(void *ptr)
188202
/* Dangerous. Callback must keep reference of the String. */
189203
*((const char **)(x->resp)) = StringValueCStr(ret);
190204
break;
205+
case TYPE_BOOL:
206+
if (sizeof(bool) == sizeof(long)) {
207+
*(unsigned long *)x->resp = RB_TEST(ret);
208+
} else {
209+
*(ffi_arg *)x->resp = RB_TEST(ret);
210+
}
211+
break;
191212
default:
192213
rb_raise(rb_eRuntimeError, "closure retval: %d", type);
193214
}

‎ext/fiddle/conversions.c‎

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,6 @@
22

33
#include <fiddle.h>
44

5-
VALUE
6-
rb_fiddle_type_bool(void)
7-
{
8-
if (sizeof(bool) == sizeof(char)) {
9-
return INT2NUM(TYPE_UCHAR);
10-
} else if (sizeof(bool) == sizeof(short)) {
11-
return INT2NUM(TYPE_USHORT);
12-
} else if (sizeof(bool) == sizeof(int)) {
13-
return INT2NUM(TYPE_UINT);
14-
} else if (sizeof(bool) == sizeof(long)) {
15-
return INT2NUM(TYPE_ULONG);
16-
} else {
17-
rb_raise(rb_eNotImpError,
18-
"bool isn't supported: %u",
19-
(unsigned int)sizeof(bool));
20-
return RUBY_Qnil;
21-
}
22-
}
23-
245
VALUE
256
rb_fiddle_type_ensure(VALUE type)
267
{
@@ -168,7 +149,7 @@ rb_fiddle_type_ensure(VALUE type)
168149
return INT2NUM(TYPE_UINTPTR_T);
169150
}
170151
else if (type_id == bool_id) {
171-
return rb_fiddle_type_bool();
152+
return INT2NUM(TYPE_BOOL);
172153
}
173154
else {
174155
type = original_type;
@@ -213,6 +194,21 @@ rb_fiddle_int_to_ffi_type(int type)
213194
return &ffi_type_double;
214195
case TYPE_CONST_STRING:
215196
return &ffi_type_pointer;
197+
case TYPE_BOOL:
198+
signed_p = 0;
199+
if (sizeof(bool) == sizeof(char)) {
200+
return rb_ffi_type_of(char);
201+
} else if (sizeof(bool) == sizeof(short)) {
202+
return rb_ffi_type_of(short);
203+
return INT2NUM(TYPE_USHORT);
204+
} else if (sizeof(bool) == sizeof(int)) {
205+
return rb_ffi_type_of(int);
206+
} else if (sizeof(bool) == sizeof(long)) {
207+
return rb_ffi_type_of(long);
208+
} else {
209+
rb_raise(rb_eNotImpError, "bool isn't supported: %u",
210+
(unsigned int)sizeof(bool));
211+
}
216212
default:
217213
rb_raise(rb_eRuntimeError, "unknown type %d", type);
218214
}
@@ -284,8 +280,23 @@ rb_fiddle_value_to_generic(int type, VALUE *src, fiddle_generic *dst)
284280
dst->pointer = rb_string_value_cstr(src);
285281
}
286282
break;
283+
case TYPE_BOOL:
284+
if (sizeof(bool) == sizeof(char)) {
285+
dst->uchar = RB_TEST(*src);
286+
} else if (sizeof(bool) == sizeof(short)) {
287+
dst->ushort = RB_TEST(*src);
288+
} else if (sizeof(bool) == sizeof(int)) {
289+
dst->uint = RB_TEST(*src);
290+
} else if (sizeof(bool) == sizeof(long)) {
291+
dst->ulong = RB_TEST(*src);
292+
} else {
293+
rb_raise(rb_eNotImpError, "bool isn't supported: %u",
294+
(unsigned int)sizeof(bool));
295+
}
296+
break;
287297
default:
288298
rb_raise(rb_eRuntimeError, "unknown type %d", type);
299+
break;
289300
}
290301
}
291302

@@ -344,6 +355,19 @@ rb_fiddle_generic_to_value(VALUE rettype, fiddle_generic retval)
344355
else {
345356
return Qnil;
346357
}
358+
case TYPE_BOOL:
359+
if (sizeof(bool) == sizeof(char)) {
360+
return CBOOL2RBBOOL((unsigned char)retval.fffi_arg);
361+
} else if (sizeof(bool) == sizeof(short)) {
362+
return CBOOL2RBBOOL((unsigned short)retval.fffi_arg);
363+
} else if (sizeof(bool) == sizeof(int)) {
364+
return CBOOL2RBBOOL((unsigned int)retval.fffi_arg);
365+
} else if (sizeof(bool) == sizeof(long)) {
366+
return CBOOL2RBBOOL(retval.ulong);
367+
} else {
368+
rb_raise(rb_eNotImpError, "bool isn't supported: %u",
369+
(unsigned int)sizeof(bool));
370+
}
347371
default:
348372
rb_raise(rb_eRuntimeError, "unknown type %d", type);
349373
}

‎ext/fiddle/conversions.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ typedef union
2424
void * pointer; /* ffi_type_pointer */
2525
} fiddle_generic;
2626

27-
VALUE rb_fiddle_type_bool(void);
2827
VALUE rb_fiddle_type_ensure(VALUE type);
2928
ffi_type * rb_fiddle_int_to_ffi_type(int type);
3029
void rb_fiddle_value_to_generic(int type, VALUE *src, fiddle_generic *dst);
@@ -51,4 +50,6 @@ VALUE generic_to_value(VALUE rettype, fiddle_generic retval);
5150
# define NUM2PTR(x) ((void*)(NUM2ULL(x)))
5251
#endif
5352

53+
#define CBOOL2RBBOOL(cbool) ((cbool) ? RUBY_Qtrue : RUBY_Qfalse)
54+
5455
#endif

‎ext/fiddle/fiddle.c‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ Init_fiddle(void)
363363
*
364364
* C type - bool
365365
*/
366-
rb_define_const(mFiddleTypes, "BOOL" , rb_fiddle_type_bool());
366+
rb_define_const(mFiddleTypes, "BOOL" , INT2NUM(TYPE_BOOL));
367367

368368
/* Document-const: ALIGN_VOIDP
369369
*
@@ -469,6 +469,12 @@ Init_fiddle(void)
469469
*/
470470
rb_define_const(mFiddle, "ALIGN_UINTPTR_T", INT2NUM(ALIGN_OF(uintptr_t)));
471471

472+
/* Document-const: ALIGN_BOOL
473+
*
474+
* The alignment size of a bool
475+
*/
476+
rb_define_const(mFiddle, "ALIGN_BOOL", INT2NUM(ALIGN_OF(bool)));
477+
472478
/* Document-const: WINDOWS
473479
*
474480
* Returns a boolean regarding whether the host is WIN32

‎ext/fiddle/fiddle.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@
126126
#define TYPE_DOUBLE 8
127127
#define TYPE_VARIADIC 9
128128
#define TYPE_CONST_STRING 10
129+
#define TYPE_BOOL 11
129130

130131
#define TYPE_INT8_T TYPE_CHAR
131132
#define TYPE_UINT8_T -TYPE_INT8_T

‎lib/fiddle/import.rb‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,8 @@ def sizeof(ty)
119119
return SIZEOF_VOIDP
120120
when TYPE_CONST_STRING
121121
return SIZEOF_CONST_STRING
122+
when TYPE_BOOL
123+
return SIZEOF_BOOL
122124
else
123125
if defined?(TYPE_LONG_LONG) and
124126
ty == TYPE_LONG_LONG

‎lib/fiddle/pack.rb‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ module PackInfo # :nodoc: all
1515
TYPE_USHORT => ALIGN_SHORT,
1616
TYPE_UINT => ALIGN_INT,
1717
TYPE_ULONG => ALIGN_LONG,
18+
TYPE_BOOL => ALIGN_BOOL,
1819
}
1920

2021
PACK_MAP = {
@@ -30,6 +31,16 @@ module PackInfo # :nodoc: all
3031
TYPE_UINT => "I!",
3132
TYPE_ULONG => "L!",
3233
}
34+
case SIZEOF_BOOL
35+
when SIZEOF_CHAR
36+
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_UCHAR]
37+
when SIZEOF_SHORT
38+
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_USHORT]
39+
when SIZEOF_INT
40+
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_UINT]
41+
when SIZEOF_LONG
42+
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_ULONG]
43+
end
3344

3445
SIZE_MAP = {
3546
TYPE_VOIDP => SIZEOF_VOIDP,
@@ -43,6 +54,7 @@ module PackInfo # :nodoc: all
4354
TYPE_USHORT => SIZEOF_SHORT,
4455
TYPE_UINT => SIZEOF_INT,
4556
TYPE_ULONG => SIZEOF_LONG,
57+
TYPE_BOOL => SIZEOF_BOOL,
4658
}
4759
if defined?(TYPE_LONG_LONG)
4860
ALIGN_MAP[TYPE_LONG_LONG] = ALIGN_MAP[TYPE_ULONG_LONG] = ALIGN_LONG_LONG

‎test/fiddle/test_c_struct_entry.rb‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
module Fiddle
99
class TestCStructEntity < TestCase
1010
def test_class_size
11-
types = [TYPE_DOUBLE, TYPE_CHAR]
11+
types = [TYPE_DOUBLE, TYPE_CHAR, TYPE_DOUBLE, TYPE_BOOL]
1212

1313
size = CStructEntity.size types
1414

@@ -20,6 +20,12 @@ def test_class_size
2020
expected = PackInfo.align expected, alignments[1]
2121
expected += PackInfo::SIZE_MAP[TYPE_CHAR]
2222

23+
expected = PackInfo.align expected, alignments[2]
24+
expected += PackInfo::SIZE_MAP[TYPE_DOUBLE]
25+
26+
expected = PackInfo.align expected, alignments[3]
27+
expected += PackInfo::SIZE_MAP[TYPE_BOOL]
28+
2329
expected = PackInfo.align expected, alignments.max
2430

2531
assert_equal expected, size

‎test/fiddle/test_closure.rb‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,18 @@ def call(string)
8181
end
8282
end
8383

84+
def test_bool
85+
closure_class = Class.new(Closure) do
86+
def call(bool)
87+
not bool
88+
end
89+
end
90+
closure_class.create(:bool, [:bool]) do |closure|
91+
func = Function.new(closure, [:bool], :bool)
92+
assert_equal(false, func.call(true))
93+
end
94+
end
95+
8496
def test_free
8597
Closure.create(:int, [:void]) do |closure|
8698
assert(!closure.freed?)

‎test/fiddle/test_func.rb‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,5 +145,22 @@ def to_str
145145
assert_equal("string: He, const string: World, uint: 29\n",
146146
output_buffer[0, written])
147147
end
148+
149+
def test_rb_memory_view_available_p
150+
omit "MemoryView is unavailable" unless defined? Fiddle::MemoryView
151+
libruby = Fiddle.dlopen(nil)
152+
case Fiddle::SIZEOF_VOIDP
153+
when Fiddle::SIZEOF_LONG_LONG
154+
value_type = -Fiddle::TYPE_LONG_LONG
155+
else
156+
value_type = -Fiddle::TYPE_LONG
157+
end
158+
rb_memory_view_available_p =
159+
Function.new(libruby["rb_memory_view_available_p"],
160+
[value_type],
161+
:bool,
162+
need_gvl: true)
163+
assert_equal(false, rb_memory_view_available_p.call(Fiddle::Qnil))
164+
end
148165
end
149166
end if defined?(Fiddle)

0 commit comments

Comments
 (0)