1/* Part of SWI-Prolog 2 3 Author: Jan Wielemaker 4 E-mail: J.Wielemaker@vu.nl 5 WWW: http://www.swi-prolog.org 6 Copyright (c) 2006-2017, University of Amsterdam 7 VU University Amsterdam 8 All rights reserved. 9 10 Redistribution and use in source and binary forms, with or without 11 modification, are permitted provided that the following conditions 12 are met: 13 14 1. Redistributions of source code must retain the above copyright 15 notice, this list of conditions and the following disclaimer. 16 17 2. Redistributions in binary form must reproduce the above copyright 18 notice, this list of conditions and the following disclaimer in 19 the documentation and/or other materials provided with the 20 distribution. 21 22 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 25 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 26 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 27 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 28 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 30 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 32 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 POSSIBILITY OF SUCH DAMAGE. 34*/ 35 36:- module(error, 37 [ type_error/2, % +Type, +Term 38 domain_error/2, % +Domain, +Term 39 existence_error/2, % +Type, +Term 40 existence_error/3, % +Type, +Term, +Set 41 permission_error/3, % +Action, +Type, +Term 42 instantiation_error/1, % +Term 43 uninstantiation_error/1, % +Term 44 representation_error/1, % +Reason 45 syntax_error/1, % +Culprit 46 resource_error/1, % +Culprit 47 48 must_be/2, % +Type, +Term 49 is_of_type/2, % +Type, +Term 50 current_type/3 % ?Type, @Var, -Body 51 ]). 52:- set_prolog_flag(generate_debug_info, false).
70:- multifile 71 has_type/2. 72 73 /******************************* 74 * ISO ERRORS * 75 *******************************/
Suppose an argument must be a non-negative integer. If the actual argument is not an integer, this is a type_error. If it is a negative integer, it is a domain_error.
Typical borderline cases are predicates accepting a compound
term, e.g., point(X,Y). One could argue that the basic type is a
compound-term and any other compound term is a domain error.
Most Prolog programmers consider each compound as a type and
would consider a compoint that is not point(_,_) a type_error.
94type_error(Type, Term) :-
95 throw(error(type_error(Type, Term), _)).
104domain_error(Type, Term) :-
105 throw(error(domain_error(Type, Term), _)).
112existence_error(Type, Term) :-
113 throw(error(existence_error(Type, Term), _)).
123existence_error(Type, Term, Set) :-
124 throw(error(existence_error(Type, Term, Set), _)).
131permission_error(Action, Type, Term) :-
132 throw(error(permission_error(Action, Type, Term), _)).
146instantiation_error(_Term) :-
147 throw(error(instantiation_error, _)).open(File, read, input) cannot succeed because the system
will allocate a new unique stream handle that will never unify
with input.
157uninstantiation_error(Term) :-
158 throw(error(uninstantiation_error(Term), _)).
168representation_error(Reason) :-
169 throw(error(representation_error(Reason), _)).
180syntax_error(Culprit) :-
181 throw(error(syntax_error(Culprit), _)).187resource_error(Culprit) :- 188 throw(error(resource_error(Culprit), _)). 189 190 191 /******************************* 192 * MUST-BE * 193 *******************************/
atom, atomic, between, boolean, callable,
chars, codes, text, compound, constant, float,
integer, nonneg, positive_integer, negative_integer,
nonvar, number, oneof, list, list_or_partial_list,
symbol, var, rational, encoding, dict and string.
Most of these types are defined by an arity-1 built-in predicate of the same name. Below is a brief definition of the other types.
| acyclic | Acyclic term (tree); see acyclic_term/1 |
| any | |
between(FloatL,FloatU) | Number [FloatL..FloatU] |
between(IntL,IntU) | Integer [IntL..IntU] |
| boolean | One of true or false |
| char | Atom of length 1 |
| chars | Proper list of 1-character atoms |
| code | Representation Unicode code point |
| codes | Proper list of Unicode character codes |
| constant | Same as atomic |
| cyclic | Cyclic term (rational tree); see cyclic_term/1 |
| dict | A dictionary term; see is_dict/1 |
| encoding | Valid name for a character encoding; see current_encoding/1 |
| list | A (non-open) list; see is_list/1 |
| negative_integer | Integer < 0 |
| nonneg | Integer >= 0 |
oneof(L) | Ground term that is member of L |
| positive_integer | Integer > 0 |
| proper_list | Same as list |
list(Type) | Proper list with elements of Type |
| list_or_partial_list | A list or an open list (ending in a variable); see is_list_or_partial_list/1 |
| stream | A stream name or valid stream handle; see is_stream/1 |
| symbol | Same as atom |
| text | One of atom, string, chars or codes |
Note: The Windows version can only represent Unicode code points up to 2^16-1. Higher values cause a representation error on most text handling predicates.
240must_be(Type, X) :-
241 ( nonvar(Type),
242 has_type(Type, X)
243 -> true
244 ; nonvar(Type)
245 -> is_not(Type, X)
246 ; instantiation_error(Type)
247 ).257is_not(list, X) :- 258 !, 259 not_a_list(list, X). 260is_not(list(Of), X) :- 261 !, 262 not_a_list(list(Of), X). 263is_not(list_or_partial_list, X) :- 264 !, 265 type_error(list, X). 266is_not(chars, X) :- 267 !, 268 not_a_list(list(char), X). 269is_not(codes, X) :- 270 !, 271 not_a_list(list(code), X). 272is_not(var,X) :- 273 !, 274 uninstantiation_error(X). 275is_not(cyclic, X) :- 276 domain_error(cyclic_term, X). 277is_not(acyclic, X) :- 278 domain_error(acyclic_term, X). 279is_not(Type, X) :- 280 ( var(X) 281 -> instantiation_error(X) 282 ; ground_type(Type), \+ ground(X) 283 -> instantiation_error(X) 284 ; current_type(Type, _Var, _Body) 285 -> type_error(Type, X) 286 ; existence_error(type, Type) 287 ). 288 289ground_type(ground). 290ground_type(oneof(_)). 291ground_type(stream). 292ground_type(text). 293ground_type(string). 294ground_type(rational). 295 296not_a_list(Type, X) :- 297 '$skip_list'(_, X, Rest), 298 ( var(Rest) 299 -> instantiation_error(X) 300 ; Rest == [] 301 -> Type = list(Of), 302 ( nonvar(Of) 303 -> element_is_not(X, Of) 304 ; instantiation_error(Of) 305 ) 306 ; type_error(Type, X) 307 ). 308 309 310element_is_not([H|T], Of) :- 311 has_type(Of, H), 312 !, 313 element_is_not(T, Of). 314element_is_not([H|_], Of) :- 315 !, 316 is_not(Of, H). 317element_is_not(_List, _Of) :- 318 assertion(fail).
324is_of_type(Type, Term) :- 325 nonvar(Type), 326 !, 327 has_type(Type, Term), 328 !. 329is_of_type(Type, _) :- 330 instantiation_error(Type).
336:- '$clausable'(has_type/2). % always allow clause/2 337 338has_type(any, _). 339has_type(atom, X) :- atom(X). 340has_type(atomic, X) :- atomic(X). 341has_type(between(L,U), X) :- ( integer(L) 342 -> integer(X), between(L,U,X) 343 ; number(X), X >= L, X =< U 344 ). 345has_type(boolean, X) :- (X==true;X==false), !. 346has_type(callable, X) :- callable(X). 347has_type(char, X) :- '$is_char'(X). 348has_type(code, X) :- '$is_char_code'(X). 349has_type(chars, X) :- '$is_char_list'(X, _Len). 350has_type(codes, X) :- '$is_code_list'(X, _Len). 351has_type(text, X) :- text(X). 352has_type(compound, X) :- compound(X). 353has_type(constant, X) :- atomic(X). 354has_type(float, X) :- float(X). 355has_type(ground, X) :- ground(X). 356has_type(cyclic, X) :- cyclic_term(X). 357has_type(acyclic, X) :- acyclic_term(X). 358has_type(integer, X) :- integer(X). 359has_type(nonneg, X) :- integer(X), X >= 0. 360has_type(positive_integer, X) :- integer(X), X > 0. 361has_type(negative_integer, X) :- integer(X), X < 0. 362has_type(nonvar, X) :- nonvar(X). 363has_type(number, X) :- number(X). 364has_type(oneof(L), X) :- ground(X), \+ \+ memberchk(X, L). 365has_type(proper_list, X) :- is_list(X). 366has_type(list, X) :- is_list(X). 367has_type(list_or_partial_list, X) :- is_list_or_partial_list(X). 368has_type(symbol, X) :- atom(X). 369has_type(var, X) :- var(X). 370has_type(rational, X) :- rational(X). 371has_type(string, X) :- string(X). 372has_type(stream, X) :- is_stream(X). 373has_type(encoding, X) :- current_encoding(X). 374has_type(dict, X) :- is_dict(X). 375has_type(list(Type), X) :- is_list(X), element_types(X, Type). 376 377text(X) :- 378 ( atom(X) 379 ; string(X) 380 ; '$is_char_list'(X, _) 381 ; '$is_code_list'(X, _) 382 ), 383 !. 384 385element_types(List, Type) :- 386 nonvar(Type), 387 !, 388 element_types_(List, Type). 389element_types(_List, Type) :- 390 instantiation_error(Type). 391 392element_types_([], _). 393element_types_([H|T], Type) :- 394 has_type(Type, H), 395 !, 396 element_types_(T, Type). 397 398is_list_or_partial_list(L0) :- 399 '$skip_list'(_, L0,L), 400 ( var(L) -> true ; L == [] ).
407current_encoding(octet). 408current_encoding(ascii). 409current_encoding(iso_latin_1). 410current_encoding(text). 411current_encoding(utf8). 412current_encoding(unicode_be). 413current_encoding(unicode_le). 414current_encoding(wchar_t).
422current_type(Type, Var, Body) :- 423 clause(has_type(Type, Var), Body0), 424 qualify(Body0, Body). 425 426qualify(Var, VarQ) :- 427 var(Var), 428 !, 429 VarQ = Var. 430qualify((A0,B0), (A,B)) :- 431 qualify(A0, A), 432 qualify(B0, B). 433qualify(G0, G) :- 434 predicate_property(system:G0, built_in), 435 !, 436 G = G0. 437qualify(G, error:G). 438 439 440 /******************************* 441 * SANDBOX * 442 *******************************/ 443 444:- multifile sandbox:safe_primitive/1. 445 446sandbox:safe_primitive(error:current_type(_,_,_))
Error generating support
This module provides predicates to simplify error generation and checking. It's implementation is based on a discussion on the SWI-Prolog mailinglist on best practices in error handling. The utility predicate must_be/2 provides simple run-time type validation. The *_error predicates are simple wrappers around throw/1 to simplify throwing the most common ISO error terms.
library(debug)andlibrary(prolog_stack).