summaryrefslogtreecommitdiff
path: root/spec/ffi/enum_spec.rb
blob: 3b2c2747fc48225965786c8aaa143ddf19fc5c71 (plain)
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
#
# This file is part of ruby-ffi.
#
# This code is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License version 3 only, as
# published by the Free Software Foundation.
#
# This code is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
# version 3 for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# version 3 along with this work.  If not, see <http://www.gnu.org/licenses/>.
#

require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))

module TestEnum0
  extend FFI::Library
end

module TestEnum1
  extend FFI::Library
  ffi_lib TestLibrary::PATH

  enum [:c1, :c2, :c3, :c4]
  enum [:c5, 42, :c6, :c7, :c8]
  enum [:c9, 42, :c10, :c11, 4242, :c12]
  enum [:c13, 42, :c14, 4242, :c15, 424242, :c16, 42424242]
  
  attach_function :test_untagged_enum, [:int], :int
end

module TestEnum3
  extend FFI::Library
  ffi_lib TestLibrary::PATH

  enum :enum_type1, [:c1, :c2, :c3, :c4]
  enum :enum_type2, [:c5, 42, :c6, :c7, :c8]
  enum :enum_type3, [:c9, 42, :c10, :c11, 4242, :c12]
  enum :enum_type4, [:c13, 42, :c14, 4242, :c15, 424242, :c16, 42424242]

  attach_function :test_tagged_typedef_enum1, [:enum_type1], :enum_type1
  attach_function :test_tagged_typedef_enum2, [:enum_type2], :enum_type2
  attach_function :test_tagged_typedef_enum3, [:enum_type3], :enum_type3
  attach_function :test_tagged_typedef_enum4, [:enum_type4], :enum_type4
end

describe "A library with no enum defined" do
  it "returns nil when asked for an enum" do
    TestEnum0.enum_type(:foo).should == nil
  end
end

describe "An untagged enum" do
  it "constants can be used as function parameters and return value" do
    TestEnum1.test_untagged_enum(:c1).should == 0
    TestEnum1.test_untagged_enum(:c2).should == 1
    TestEnum1.test_untagged_enum(:c3).should == 2
    TestEnum1.test_untagged_enum(:c4).should == 3
    TestEnum1.test_untagged_enum(:c5).should == 42
    TestEnum1.test_untagged_enum(:c6).should == 43
    TestEnum1.test_untagged_enum(:c7).should == 44
    TestEnum1.test_untagged_enum(:c8).should == 45
    TestEnum1.test_untagged_enum(:c9).should == 42
    TestEnum1.test_untagged_enum(:c10).should == 43
    TestEnum1.test_untagged_enum(:c11).should == 4242
    TestEnum1.test_untagged_enum(:c12).should == 4243
    TestEnum1.test_untagged_enum(:c13).should == 42
    TestEnum1.test_untagged_enum(:c14).should == 4242
    TestEnum1.test_untagged_enum(:c15).should == 424242
    TestEnum1.test_untagged_enum(:c16).should == 42424242
  end
end

describe "A tagged typedef enum" do
  it "is accessible through its tag" do
    TestEnum3.enum_type(:enum_type1).should_not == nil
    TestEnum3.enum_type(:enum_type2).should_not == nil
    TestEnum3.enum_type(:enum_type3).should_not == nil
    TestEnum3.enum_type(:enum_type4).should_not == nil
  end
  it "contains enum constants" do
    TestEnum3.enum_type(:enum_type1).symbols.length.should == 4
    TestEnum3.enum_type(:enum_type2).symbols.length.should == 4
    TestEnum3.enum_type(:enum_type3).symbols.length.should == 4
    TestEnum3.enum_type(:enum_type4).symbols.length.should == 4
  end
  it "constants can be used as function parameters and return value" do
    TestEnum3.test_tagged_typedef_enum1(:c1).should == :c1
    TestEnum3.test_tagged_typedef_enum1(:c2).should == :c2
    TestEnum3.test_tagged_typedef_enum1(:c3).should == :c3
    TestEnum3.test_tagged_typedef_enum1(:c4).should == :c4
    TestEnum3.test_tagged_typedef_enum2(:c5).should == :c5
    TestEnum3.test_tagged_typedef_enum2(:c6).should == :c6
    TestEnum3.test_tagged_typedef_enum2(:c7).should == :c7
    TestEnum3.test_tagged_typedef_enum2(:c8).should == :c8
    TestEnum3.test_tagged_typedef_enum3(:c9).should == :c9
    TestEnum3.test_tagged_typedef_enum3(:c10).should == :c10
    TestEnum3.test_tagged_typedef_enum3(:c11).should == :c11
    TestEnum3.test_tagged_typedef_enum3(:c12).should == :c12
    TestEnum3.test_tagged_typedef_enum4(:c13).should == :c13
    TestEnum3.test_tagged_typedef_enum4(:c14).should == :c14
    TestEnum3.test_tagged_typedef_enum4(:c15).should == :c15
    TestEnum3.test_tagged_typedef_enum4(:c16).should == :c16
  end

  it "integers can be used instead of constants" do
    TestEnum3.test_tagged_typedef_enum1(0).should == :c1
    TestEnum3.test_tagged_typedef_enum1(1).should == :c2
    TestEnum3.test_tagged_typedef_enum1(2).should == :c3
    TestEnum3.test_tagged_typedef_enum1(3).should == :c4
    TestEnum3.test_tagged_typedef_enum2(42).should == :c5
    TestEnum3.test_tagged_typedef_enum2(43).should == :c6
    TestEnum3.test_tagged_typedef_enum2(44).should == :c7
    TestEnum3.test_tagged_typedef_enum2(45).should == :c8
    TestEnum3.test_tagged_typedef_enum3(42).should == :c9
    TestEnum3.test_tagged_typedef_enum3(43).should == :c10
    TestEnum3.test_tagged_typedef_enum3(4242).should == :c11
    TestEnum3.test_tagged_typedef_enum3(4243).should == :c12
    TestEnum3.test_tagged_typedef_enum4(42).should == :c13
    TestEnum3.test_tagged_typedef_enum4(4242).should == :c14
    TestEnum3.test_tagged_typedef_enum4(424242).should == :c15
    TestEnum3.test_tagged_typedef_enum4(42424242).should == :c16
  end
end

describe "All enums" do
  it "have autonumbered constants when defined with names only" do
    TestEnum1.enum_value(:c1).should == 0
    TestEnum1.enum_value(:c2).should == 1
    TestEnum1.enum_value(:c3).should == 2
    TestEnum1.enum_value(:c4).should == 3

    TestEnum3.enum_value(:c1).should == 0
    TestEnum3.enum_value(:c2).should == 1
    TestEnum3.enum_value(:c3).should == 2
    TestEnum3.enum_value(:c4).should == 3
  end
  it "can have an explicit first constant and autonumbered subsequent constants" do
    TestEnum1.enum_value(:c5).should == 42
    TestEnum1.enum_value(:c6).should == 43
    TestEnum1.enum_value(:c7).should == 44
    TestEnum1.enum_value(:c8).should == 45

    TestEnum3.enum_value(:c5).should == 42
    TestEnum3.enum_value(:c6).should == 43
    TestEnum3.enum_value(:c7).should == 44
    TestEnum3.enum_value(:c8).should == 45
  end
  it "can have a mix of explicit and autonumbered constants" do
    TestEnum1.enum_value(:c9).should  == 42
    TestEnum1.enum_value(:c10).should == 43
    TestEnum1.enum_value(:c11).should == 4242
    TestEnum1.enum_value(:c12).should == 4243

    TestEnum3.enum_value(:c9).should  == 42
    TestEnum3.enum_value(:c10).should == 43
    TestEnum3.enum_value(:c11).should == 4242
    TestEnum3.enum_value(:c12).should == 4243
  end
  it "can have all its constants explicitely valued" do
    TestEnum1.enum_value(:c13).should == 42
    TestEnum1.enum_value(:c14).should == 4242
    TestEnum1.enum_value(:c15).should == 424242
    TestEnum1.enum_value(:c16).should == 42424242
    
    TestEnum3.enum_value(:c13).should == 42
    TestEnum3.enum_value(:c14).should == 4242
    TestEnum3.enum_value(:c15).should == 424242
    TestEnum3.enum_value(:c16).should == 42424242
  end
  it "return the constant corresponding to a specific value" do
    enum = TestEnum3.enum_type(:enum_type1)
    enum[0].should == :c1
    enum[1].should == :c2
    enum[2].should == :c3
    enum[3].should == :c4

    enum = TestEnum3.enum_type(:enum_type2)
    enum[42].should == :c5
    enum[43].should == :c6
    enum[44].should == :c7
    enum[45].should == :c8

    enum = TestEnum3.enum_type(:enum_type3)
    enum[42].should == :c9
    enum[43].should == :c10
    enum[4242].should == :c11
    enum[4243].should == :c12

    enum = TestEnum3.enum_type(:enum_type4)
    enum[42].should == :c13
    enum[4242].should == :c14
    enum[424242].should == :c15
    enum[42424242].should == :c16
  end
  it "return nil for values that don't have a symbol" do
    enum = TestEnum3.enum_type(:enum_type1)
    enum[-1].should == nil
    enum[4].should == nil

    enum = TestEnum3.enum_type(:enum_type2)
    enum[0].should == nil
    enum[41].should == nil
    enum[46].should == nil

    enum = TestEnum3.enum_type(:enum_type3)
    enum[0].should == nil
    enum[41].should == nil
    enum[44].should == nil
    enum[4241].should == nil
    enum[4244].should == nil

    enum = TestEnum3.enum_type(:enum_type4)
    enum[0].should == nil
    enum[41].should == nil
    enum[43].should == nil
    enum[4241].should == nil
    enum[4243].should == nil
    enum[424241].should == nil
    enum[424243].should == nil
    enum[42424241].should == nil
    enum[42424243].should == nil
  end

  it "duplicate enum keys rejected" do
    lambda { enum [ :a, 0xfee1dead, :b, 0xdeadbeef, :a, 0 ] }.should raise_error
  end
end