forked from SWI-Prolog/packages-cpp
/
test_ffi.pl
259 lines (219 loc) · 10 KB
/
test_ffi.pl
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
% -*- mode: Prolog; coding: utf-8 -*-
/* Part of SWI-Prolog
Author: Peter Ludemann
E-mail: peter.ludemann@gmail.com
WWW: http://www.swi-prolog.org
Copyright (c) 2022, SWI-Prolog Solutions b.v.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
% This tests the C interface and not the C++ interface.
% But it was most convenient to put the test here.
:- module(test_ffi,
[ test_ffi/0
]).
:- use_module(library(debug)).
:- use_module(library(lists)).
:- use_module(library(apply)).
:- autoload(library(aggregate)).
:- use_module(library(plunit)).
:- use_foreign_library(foreign(test_ffi)).
:- encoding(utf8).
test_ffi :-
run_tests([ ffi,
wchar
]).
:- begin_tests(ffi).
test(range1, all(X == [1,2])) :-
range_ffi(1, 3, X).
test(range2, all(X == [-2,-1,0,1,2])) :-
range_ffi(-2, 3, X).
test(range3a, all(X == [-2])) :-
range_ffi(-2, -1, X).
test(range3b, all(X == [0])) :-
range_ffi(0, 1, X).
test(range3c, all(X == [10])) :-
range_ffi(10, 11, X).
test(range4a, fail) :-
range_ffi(1, 1, _X).
test(range4b, fail) :-
range_ffi(0, 0, _X).
test(range4c, fail) :-
range_ffi(-1, -1, _X).
test(range4d, fail) :-
range_ffi(1, 2, 2).
test(range_ffi5, X == 1) :- % Will produce warning if non-deterministic
range_ffi(1, 2, X).
test(range_ffialloc1, all(X == [1,2])) :-
range_ffialloc(1, 3, X).
test(range_ffialloc2, all(X == [-2,-1,0,1,2])) :-
range_ffialloc(-2, 3, X).
test(range_ffialloc3a, all(X == [0])) :-
range_ffialloc(0, 1, X).
test(range_ffialloc3b, all(X == [10])) :-
range_ffialloc(10, 11, X).
test(range_ffialloc3c, all(X == [-2])) :-
range_ffi(-2, -1, X).
test(range_ffialloc4a, fail) :-
range_ffialloc(1, 1, _X).
test(range_ffialloc4a, fail) :-
range_ffialloc(0, 0, _X).
test(range_ffialloc4a, fail) :-
range_ffialloc(-1, -1, _X).
test(range_ffialloc4d, fail) :-
range_ffialloc(1, 2, 2).
test(range_ffialloc5, X == 1) :- % Will produce warning if non-deterministic
range_ffialloc(1, 2, X).
test(range_ffialloc6a, error(type_error(integer,a))) :-
range_ffialloc(a, 10, _).
test(range_ffialloc6b, error(type_error(integer,foo))) :-
range_ffialloc(1, foo, _).
:- end_tests(ffi).
:- begin_tests(wchar).
% The following "wchar" tests are regression tests related
% to https://github.com/SWI-Prolog/packages-pcre/issues/20
test(wchar_1, all(Result == ["//0",
"/ /1",
"/abC/3",
"/Hello World!/12",
"/хелло/5",
"/хелло 世界/8",
"/網目錦へび [àmímé níshíkíhéꜜbì]/26"])) :-
( w_atom_ffi('', Result)
; w_atom_ffi(' ', Result)
; w_atom_ffi('abC', Result)
; w_atom_ffi('Hello World!', Result)
; w_atom_ffi('хелло', Result)
; w_atom_ffi('хелло 世界', Result)
; w_atom_ffi('網目錦へび [àmímé níshíkíhéꜜbì]', Result)
).
test(wchar_2,
[condition(\+ current_prolog_flag(windows, true)), % Windows doesn't like Unicode > 0xffff
all(Result == ["/⛰⛱⛲⛾⛿/5","/\U0001FB00/1","/ᢰᢱ\x18FF\/3","/⻰⻱⻲⻳/4"])]) :-
( w_atom_ffi('⛰⛱⛲⛾⛿', Result)
; w_atom_ffi('\U0001FB00', Result)
; w_atom_ffi('ᢰᢱ\u18FF', Result)
; w_atom_ffi('⻰⻱⻲⻳', Result)
).
test(wchar_2b, % Same as wchar_2, but uses atom_codes
[condition(\+ current_prolog_flag(windows, true)), % Windows doesn't like Unicode > 0xffff
all(Result == [[47, 0x26f0, 0x26f1, 0x26f2, 0x26fe, 0x26ff, 47, 53],
[47, 0x1FB00, 47, 49],
[47, 0x18b0, 0x18b1, 0x18ff, 47, 51],
[47, 0x2ef0, 0x2ef1, 0x2ef2, 0x2ef3, 47, 52]])]) :-
( atom_codes(A, [0x26f0, 0x26f1, 0x26f2, 0x26fe, 0x26ff]),
w_atom_ffi(A, Result0), string_codes(Result0, Result)
; atom_codes(A, [0x1FB00]),
w_atom_ffi(A, Result0), string_codes(Result0, Result)
; atom_codes(A, [0x18b0, 0x18b1, 0x18ff]),
w_atom_ffi(A, Result0), string_codes(Result0, Result)
; atom_codes(A, [0x2ef0, 0x2ef1, 0x2ef2, 0x2ef3]),
w_atom_ffi(A, Result0), string_codes(Result0, Result)
).
test(char_1, all(Result == ["//", "/ /", "/abC/", "/Hello World!/"])) :-
( atom_ffi('', Result)
; atom_ffi(' ', Result)
; atom_ffi('abC', Result)
; atom_ffi('Hello World!', Result)
).
w_atom_ffi(Atom, String) :-
with_output_to(string(String), w_atom_ffi_(current_output, Atom)).
atom_ffi(Atom, String) :-
with_output_to(string(String), atom_ffi_(current_output, Atom)).
:- end_tests(wchar).
:- begin_tests(scan).
test(scan_options, [Options == options(true, 5, foo(bar), [], "")]) :-
ffi_options(Options, [quoted(true), length(5), callback(foo(bar))]).
test(scan_options, [Options == options(true, 5, foo(bar), qqsv, "DESCR")]) :-
ffi_options(Options, [token(qqsv), descr("DESCR"), quoted(true), length(5), callback(foo(bar))]).
test(scan_options, [Options == options(true, 5, foo(bar), qqsv, "DESCR")]) :-
ffi_options(Options, [token(qqsv), descr("DESCR"), quoted(true), length(5), callback(foo(bar)), unknown_option(blah)]).
test(scan_options, [Options == options(true, 5, foo(bar), qqsv, "DESCR")]) :-
ffi_options(Options, options{token:qqsv, descr:"DESCR", quoted:true, length:5, callback:foo(bar)}).
test(scan_options, [Options == options(true, 5, foo(bar), qqsv, "DESCR")]) :-
ffi_options(Options, [token(qqsv), descr("DESCR"), quoted, length(5), callback(foo(bar))]).
test(scan_options, [Options == options(false, 5, foo(bar), qqsv, "DESCR")]) :-
ffi_options(Options, [token(qqsv), descr("DESCR"), length(5), callback(foo(bar))]).
test(scan_options, [error(instantiation_error)]) :-
ffi_options(_Options, [token(qqsv), _, descr("DESCR"), length(5), callback(foo(bar))]).
test(scan_options, [error(type_error(option,123))]) :- % TODO: is this intended behavior?
ffi_options(_Options, [token(qqsv), descr("DESCR"), 123, length(5), callback(foo(bar))]).
test(scan_options, [error(type_error(option,123))]) :- % TODO: is this intended behavior?
ffi_options(_Options, [token(qqsv), 123, descr("DESCR"), length(5), callback(foo(bar))]).
:- end_tests(scan).
:- begin_tests(call).
test(ffi_call) :-
ffi_call(writeln(hello-world), [normal]).
test(ffi_call) :-
ffi_call(writeln(hello-world), [pass_exception]).
test(ffi_call) :-
ffi_call(writeln(hello-world), [catch_exception]).
test(ffi_call, blocked('../src/pl-vmi.c:3088: PL_next_solution___LD: Assertion failed: fr2->clause || true(fr2->predicate, P_FOREIGN)')) :-
ffi_call(writeln(hello-world), [pass_exception,no_cut]).
test(ffi_call, blocked('Invokes debugger - exits Prolog if "leap"')) :-
ffi_call(non_existant_pred(foo), [normal]).
test(ffi_call, error(existence_error(procedure,test_ffi:non_existant_pred/1),_)) :-
ffi_call(non_existant_pred(foo), [pass_exception]).
test(ffi_call, fail) :-
ffi_call(non_existant_pred(foo), [catch_exception]).
test(ffi_call) :-
ffi_call(non_existant_pred(foo), [catch_exception,return_true]).
test(ffi_call, blocked('outputs message "foreign predicate test_ffi:ffi_call_/2 did not clear exception"')) :-
ffi_call(non_existant_pred(foo), [pass_exception,return_true]).
ffi_call(Goal, Flags) :-
query_flags(Flags, CombinedFlag),
ffi_call_(Goal, CombinedFlag).
%! query_flag(?Name, ?Bit)
%
% Flags for PL_open_query(). Check with SWI-Prolog.h. Same code
% appears in test_ffi.pl. This is duplicated to simplify
% installation of these tests in the binary version.
%
% This code is mainly for debugging.
query_flag(debug, I) => I = 0x0001.
query_flag(normal, I) => I = 0x0002.
query_flag(nodebug, I) => I = 0x0004.
query_flag(catch_exception, I) => I = 0x0008.
query_flag(pass_exception, I) => I = 0x0010.
query_flag(allow_yield, I) => I = 0x0020.
query_flag(ext_status, I) => I = 0x0040.
query_flag(deterministic, I) => I = 0x0100.
query_flag(no_cut, I) => I = 0x1000. % defined in test_ffi.c
query_flag(return_true, I) => I = 0x2000. % defined in test_ffi.c
query_flag(clear_exception, I) => I = 0x4000. % defined in test_ffi.c
% TODO: are there any other mutually exclusive flags?
check_query_flag(Flags) :-
query_flag(normal, F1),
query_flag(catch_exception, F2),
query_flag(pass_exception, F3),
Mask is F1 \/ F2 \/ F3,
Bits is popcount(Flags /\ Mask),
( Bits =< 1
-> true
; domain_error(query_flags, Flags)
).
query_flags(Flags, CombinedFlag) :-
maplist(query_flag, Flags, Ints),
aggregate_all(sum(I), member(I, Ints), CombinedFlag),
check_query_flag(CombinedFlag).
:- end_tests(call).