1/*  Part of SWI-Prolog
2
3    Author:        Jan Wielemaker & Paulo Moura
4    E-mail:        J.Wielemaker@cs.vu.nl
5    WWW:           http://www.swi-prolog.org
6    Copyright (c)  2007-2012, University of Amsterdam,
7                              Paulo Moura,
8                              VU University Amsterdam
9    All rights reserved.
10
11    Redistribution and use in source and binary forms, with or without
12    modification, are permitted provided that the following conditions
13    are met:
14
15    1. Redistributions of source code must retain the above copyright
16       notice, this list of conditions and the following disclaimer.
17
18    2. Redistributions in binary form must reproduce the above copyright
19       notice, this list of conditions and the following disclaimer in
20       the documentation and/or other materials provided with the
21       distribution.
22
23    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34    POSSIBILITY OF SUCH DAMAGE.
35*/
36
37:- module(iso_predicates,
38	  [ iso_builtin_predicate/1,	% ?Term
39	    iso_builtin_function/1	% ?Term
40	  ]).
41
42/** <module> Define ISO builtin predicates
43
44This module describes the ISO  core   standard  built-in  predicates. It
45originates from Logtalk. Note that, although  the artistic license would
46allow redistribution under a new name and   interface  using the GPL, we
47preserve the original license.
48
49@author  Paulo Moura
50@author  Jan Wielemaker
51@licence GPL+SWI-exception or Artistic 2.0
52@see	 predicate_property/2, property =iso=.
53*/
54
55%%	iso_builtin_predicate(?Head:callable) is nondet.
56%
57%	True if Head describes  a  builtin   defined  by  the ISO Prolog
58%	standard (ISO/IEC 1321 l-l).
59
60iso_builtin_predicate(true).
61iso_builtin_predicate(fail).
62iso_builtin_predicate(call(_)).
63iso_builtin_predicate(!).
64iso_builtin_predicate((Goal; _)) :-
65	(   var(Goal)
66	->  true
67	;   Goal \= '*->'(_,_)		% exclude SWI's soft-cut.
68	).
69iso_builtin_predicate((_, _)).
70iso_builtin_predicate((_ -> _)).
71iso_builtin_predicate(catch(_, _, _)).
72iso_builtin_predicate(throw(_)).
73
74iso_builtin_predicate((_ = _)).
75iso_builtin_predicate((_ \= _)).
76iso_builtin_predicate(unify_with_occurs_check(_, _)).
77
78iso_builtin_predicate(var(_)).
79iso_builtin_predicate(nonvar(_)).
80iso_builtin_predicate(atom(_)).
81iso_builtin_predicate(atomic(_)).
82iso_builtin_predicate(number(_)).
83iso_builtin_predicate(integer(_)).
84iso_builtin_predicate(float(_)).
85iso_builtin_predicate(compound(_)).
86
87iso_builtin_predicate((_ @=< _)).
88iso_builtin_predicate((_ @< _)).
89iso_builtin_predicate((_ @>= _)).
90iso_builtin_predicate((_ @> _)).
91iso_builtin_predicate((_ == _)).
92iso_builtin_predicate((_ \== _)).
93
94iso_builtin_predicate(functor(_, _, _)).
95iso_builtin_predicate(arg(_, _, _)).
96iso_builtin_predicate(_ =.. _).
97iso_builtin_predicate(copy_term(_, _)).
98
99iso_builtin_predicate(_ is _).
100
101iso_builtin_predicate((_ =< _)).
102iso_builtin_predicate((_ < _)).
103iso_builtin_predicate((_ >= _)).
104iso_builtin_predicate((_ > _)).
105iso_builtin_predicate((_ =:= _)).
106iso_builtin_predicate((_ =\= _)).
107
108iso_builtin_predicate(clause(_, _)).
109iso_builtin_predicate(current_predicate(_)).
110
111iso_builtin_predicate(asserta(_)).
112iso_builtin_predicate(assertz(_)).
113iso_builtin_predicate(retract(_)).
114iso_builtin_predicate(abolish(_)).
115
116iso_builtin_predicate(findall(_, _, _)).
117iso_builtin_predicate(bagof(_, _, _)).
118iso_builtin_predicate(setof(_, _, _)).
119
120iso_builtin_predicate(current_input(_)).
121iso_builtin_predicate(current_output(_)).
122iso_builtin_predicate(set_input(_)).
123iso_builtin_predicate(set_output(_)).
124iso_builtin_predicate(open(_, _, _, _)).
125iso_builtin_predicate(open(_, _, _)).
126iso_builtin_predicate(close(_, _)).
127iso_builtin_predicate(close(_)).
128iso_builtin_predicate(flush_output(_)).
129iso_builtin_predicate(flush_output).
130iso_builtin_predicate(stream_property(_, _)).
131iso_builtin_predicate(at_end_of_stream).
132iso_builtin_predicate(at_end_of_stream(_)).
133iso_builtin_predicate(set_stream_position(_, _)).
134
135iso_builtin_predicate(get_char(_, _)).
136iso_builtin_predicate(get_char(_)).
137iso_builtin_predicate(get_code(_, _)).
138iso_builtin_predicate(get_code(_)).
139iso_builtin_predicate(peek_char(_, _)).
140iso_builtin_predicate(peek_char(_)).
141iso_builtin_predicate(peek_code(_, _)).
142iso_builtin_predicate(peek_code(_)).
143iso_builtin_predicate(put_char(_, _)).
144iso_builtin_predicate(put_char(_)).
145iso_builtin_predicate(put_code(_, _)).
146iso_builtin_predicate(put_code(_)).
147iso_builtin_predicate(nl).
148iso_builtin_predicate(nl(_)).
149
150iso_builtin_predicate(get_byte(_, _)).
151iso_builtin_predicate(get_byte(_)).
152iso_builtin_predicate(peek_byte(_, _)).
153iso_builtin_predicate(peek_byte(_)).
154iso_builtin_predicate(put_byte(_, _)).
155iso_builtin_predicate(put_byte(_)).
156
157iso_builtin_predicate(read_term(_, _, _)).
158iso_builtin_predicate(read_term(_, _)).
159iso_builtin_predicate(read(_)).
160iso_builtin_predicate(read(_, _)).
161iso_builtin_predicate(write_term(_, _, _)).
162iso_builtin_predicate(write_term(_, _)).
163iso_builtin_predicate(write(_)).
164iso_builtin_predicate(write(_, _)).
165iso_builtin_predicate(writeq(_)).
166iso_builtin_predicate(writeq(_, _)).
167iso_builtin_predicate(write_canonical(_)).
168iso_builtin_predicate(write_canonical(_, _)).
169iso_builtin_predicate(op(_, _, _)).
170iso_builtin_predicate(current_op(_, _, _)).
171iso_builtin_predicate(char_conversion(_, _)).
172iso_builtin_predicate(current_char_conversion(_, _)).
173
174iso_builtin_predicate(\+ _).
175iso_builtin_predicate(once(_)).
176iso_builtin_predicate(repeat).
177
178iso_builtin_predicate(atom_length(_, _)).
179iso_builtin_predicate(atom_concat(_, _, _)).
180iso_builtin_predicate(sub_atom(_, _, _, _, _)).
181iso_builtin_predicate(atom_chars(_, _)).
182iso_builtin_predicate(atom_codes(_, _)).
183iso_builtin_predicate(char_code(_, _)).
184iso_builtin_predicate(number_chars(_, _)).
185iso_builtin_predicate(number_codes(_, _)).
186
187iso_builtin_predicate(set_prolog_flag(_, _)).
188iso_builtin_predicate(current_prolog_flag(_, _)).
189iso_builtin_predicate(halt).
190iso_builtin_predicate(halt(_)).
191
192%	ISO wg17 proposal on threads
193%	Note that the list below only contains the predicates that are
194%	-in my opinion- beyond discussion.
195
196iso_builtin_predicate(thread_create(_,_,_)).
197iso_builtin_predicate(thread_self(_)).
198iso_builtin_predicate(thread_join(_,_)).
199iso_builtin_predicate(thread_detach(_)).
200iso_builtin_predicate(thread_signal(_,_)).
201iso_builtin_predicate(thread_property(_,_)).
202iso_builtin_predicate(mutex_create(_,_)).
203iso_builtin_predicate(mutex_destroy(_)).
204iso_builtin_predicate(with_mutex(_,_)).
205iso_builtin_predicate(mutex_lock(_)).
206iso_builtin_predicate(mutex_unlock(_)).
207iso_builtin_predicate(mutex_trylock(_)).
208iso_builtin_predicate(mutex_property(_,_)).
209iso_builtin_predicate(message_queue_create(_,_)).
210iso_builtin_predicate(message_queue_destroy(_)).
211iso_builtin_predicate(message_queue_property(_,_)).
212iso_builtin_predicate(thread_send_message(_,_)).
213iso_builtin_predicate(thread_get_message(_)).
214iso_builtin_predicate(thread_get_message(_,_)).
215iso_builtin_predicate(thread_peek_message(_)).
216iso_builtin_predicate(thread_peek_message(_,_)).
217
218%	Predicates from ISO/IEC DTR 13211-1:2006
219%	Note that predicates not supported yet by YAP are not in here.
220
221%iso_builtin_predicate(subsumes(_,_)).
222iso_builtin_predicate(callable(_)).
223iso_builtin_predicate(ground(_)).
224iso_builtin_predicate(compare(_, _, _)).
225iso_builtin_predicate(numbervars(_,_,_)).
226iso_builtin_predicate(predicate_property(_,_)).
227iso_builtin_predicate(retractall(_)).
228%iso_builtin_predicate(forall(_,_)).
229iso_builtin_predicate(call(_,_)).
230iso_builtin_predicate(call(_,_,_)).
231iso_builtin_predicate(call(_,_,_,_)).
232%iso_builtin_predicate(call_cleanup(_,_)).
233%iso_builtin_predicate(append(_,_,_)).
234iso_builtin_predicate(length(_,_)).
235%iso_builtin_predicate(member(_,_)).
236iso_builtin_predicate(sort(_,_)).
237iso_builtin_predicate(keysort(_,_)).
238
239%%	iso_builtin_function(?Head:callable) is nondet.
240%
241%	True if Head describes a builtin  arithmetic function as defined
242%	by the ISO Prolog standard (ISO/IEC 1321 l-l).
243
244iso_builtin_function(_ + _).
245iso_builtin_function(_ - _).
246iso_builtin_function(_ * _).
247iso_builtin_function(_ // _).
248iso_builtin_function(_ / _).
249iso_builtin_function(_ rem _).
250iso_builtin_function(_ mod _).
251iso_builtin_function(_ ** _).
252iso_builtin_function(_ >> _).
253iso_builtin_function(_ << _).
254iso_builtin_function(_ /\ _).
255iso_builtin_function(_ \/ _).
256iso_builtin_function(- _).
257iso_builtin_function(+ _).
258iso_builtin_function(min(_,_)).
259iso_builtin_function(max(_,_)).
260iso_builtin_function(abs(_)).
261iso_builtin_function(sign(_)).
262iso_builtin_function(float_integer_part(_)).
263iso_builtin_function(float_fractional_part(_)).
264iso_builtin_function(float(_)).
265iso_builtin_function(floor(_)).
266iso_builtin_function(truncate(_)).
267iso_builtin_function(round(_)).
268iso_builtin_function(ceiling(_)).
269iso_builtin_function(sin(_)).
270iso_builtin_function(cos(_)).
271iso_builtin_function(asin(_)).
272iso_builtin_function(acos(_)).
273iso_builtin_function(atan(_)).
274iso_builtin_function(atan2(_,_)).
275iso_builtin_function(exp(_)).
276iso_builtin_function(log(_)).
277iso_builtin_function(sqrt(_)).
278iso_builtin_function(\(_)).
279