144 lines
4.2 KiB
Prolog
144 lines
4.2 KiB
Prolog
/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
Written September 2018 by Markus Triska (triska@metalevel.at)
|
|
I place this code in the public domain. Use it in any way you want.
|
|
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
|
|
|
|
:- module(error, [must_be/2,
|
|
can_be/2,
|
|
instantiation_error/1,
|
|
domain_error/3,
|
|
type_error/3
|
|
]).
|
|
|
|
/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
must_be(Type, Term)
|
|
|
|
This predicate is intended for type-checks of built-in predicates.
|
|
|
|
It asserts that Term is:
|
|
|
|
1) instantiated *and*
|
|
2) instantiated to an instance of the given Type.
|
|
|
|
It corresponds to usage mode +Term.
|
|
|
|
Currently, the following types are supported:
|
|
|
|
- atom
|
|
- boolean
|
|
- character
|
|
- chars
|
|
- integer
|
|
- list
|
|
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
|
|
|
|
must_be(Type, Term) :-
|
|
must_be_(type, Type),
|
|
must_be_(Type, Term).
|
|
|
|
must_be_(Type, _) :-
|
|
var(Type),
|
|
instantiation_error(must_be/2).
|
|
must_be_(var, Term) :-
|
|
( var(Term) -> true
|
|
; throw(error(uninstantiation_error(Term), must_be/2))
|
|
).
|
|
must_be_(integer, Term) :- check_(integer, integer, Term).
|
|
must_be_(atom, Term) :- check_(atom, atom, Term).
|
|
must_be_(character, T) :- check_(error:character, character, T).
|
|
must_be_(chars, Ls) :-
|
|
must_be(list, Ls),
|
|
( '$is_partial_string'(Ls) ->
|
|
% The expected case (success) uses a very fast test.
|
|
% We cannot use partial_string/1 from library(iso_ext),
|
|
% because that library itself imports library(error).
|
|
true
|
|
; all_characters(Ls)
|
|
).
|
|
must_be_(list, Term) :- check_(error:ilist, list, Term).
|
|
must_be_(type, Term) :- check_(error:type, type, Term).
|
|
must_be_(boolean, Term) :- check_(error:boolean, boolean, Term).
|
|
|
|
% We cannot use maplist(must_be(character), Cs), because library(lists)
|
|
% uses library(error), so importing it would create a cyclic dependency.
|
|
|
|
all_characters([]).
|
|
all_characters([C|Cs]) :-
|
|
must_be(character, C),
|
|
all_characters(Cs).
|
|
|
|
check_(Pred, Type, Term) :-
|
|
( var(Term) -> instantiation_error(must_be/2)
|
|
; call(Pred, Term) -> true
|
|
; type_error(Type, Term, must_be/2)
|
|
).
|
|
|
|
boolean(B) :- ( B == true ; B == false ).
|
|
|
|
character(C) :-
|
|
atom(C),
|
|
atom_length(C, 1).
|
|
|
|
ilist(Ls) :-
|
|
'$skip_max_list'(_, _, Ls, Rs),
|
|
( var(Rs) ->
|
|
instantiation_error(must_be/2)
|
|
; Rs == []
|
|
).
|
|
|
|
type(type).
|
|
type(integer).
|
|
type(atom).
|
|
type(character).
|
|
type(chars).
|
|
type(list).
|
|
type(var).
|
|
type(boolean).
|
|
|
|
/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
can_be(Type, Term)
|
|
|
|
This predicate is intended for type-checks of built-in predicates.
|
|
|
|
It asserts that there is a substitution which, if applied to Term,
|
|
makes it an instance of Type.
|
|
|
|
It corresponds to usage mode ?Term.
|
|
|
|
It supports the same types as must_be/2.
|
|
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
|
|
|
|
|
|
can_be(Type, Term) :-
|
|
must_be(type, Type),
|
|
( var(Term) -> true
|
|
; can_(Type, Term) -> true
|
|
; type_error(Type, Term, can_be/2)
|
|
).
|
|
|
|
can_(integer, Term) :- integer(Term).
|
|
can_(atom, Term) :- atom(Term).
|
|
can_(character, T) :- character(T).
|
|
can_(chars, Ls) :- '$is_partial_string'(Ls).
|
|
can_(list, Term) :- list_or_partial_list(Term).
|
|
can_(boolean, Term) :- boolean(Term).
|
|
|
|
list_or_partial_list(Ls) :-
|
|
'$skip_max_list'(_, _, Ls, Rs),
|
|
( var(Rs) -> true
|
|
; Rs == []
|
|
).
|
|
|
|
/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
Shorthands for throwing ISO errors.
|
|
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
|
|
|
|
instantiation_error(Context) :-
|
|
throw(error(instantiation_error, Context)).
|
|
|
|
domain_error(Type, Term, Context) :-
|
|
throw(error(domain_error(Type, Term), Context)).
|
|
|
|
type_error(Type, Term, Context) :-
|
|
throw(error(type_error(Type, Term), Context)).
|