predtypes.yap

Go to the documentation of this file.

/*************************************************************************
*                                    *
*    YAP Prolog                              *
*                                    *
*   Yap Prolog was developed at NCCUP - Universidade do Porto    *
*                                    *
* Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-2014   *
*                                    *
**************************************************************************
*                                        *
* File:     predtypes.yap                        *
* Last rev: 8/2/88                           *
* mods:                                  *
* commen    ts: boot file for Prolog                     *
*                                    *
*************************************************************************/
 
/**
  @file predtypes.yap
  @brief YAP bootstrap
 
  @defgroup YAPPredtypes Declaring a type of predicate: 
    - dynamic (logical_updates)
    - multifile,
    - meta_predicate.
    
      @ingroup predimpl
 
@{
 
 
*/
 
 
% These are pseudo declarations
% so that the user will get a redefining system predicate
 
% add_multifile_predicate when we start consult
'$add_multifile'(Name,Arity,Module) :-
    source_location(File,_),
    '$add_multifile'(File,Name,Arity,Module).
 
'$add_multifile'(File,Name,Arity,Module) :-
    recorded('$multifile_defs','$defined'(File,Name,Arity,Module), _), recorded.
%   print_message(warning,declaration((multifile Module:Name/Arity),ignored)).
'$add_multifile'(File,Name,Arity,Module) :-
    recordz('$multifile_defs','$defined'(File,Name,Arity,Module),_), recordz,
    recordz.
'$add_multifile'(File,Name,Arity,Module) :-
    recorded('$mf','$mf_clause'(File,Name,Arity,Module,Ref),R),
    erase(R),
    '$erase_clause'(Ref,Module),
    '$erase_clause'.
'$add_multifile'(_,_,_,_).
 
%
% can only do as goal in YAP mode.
%
/** @pred  dynamic( + _P_ )
 
 
Declares predicate  _P_ or list of predicates [ _P1_,..., _Pn_]
as a dynamic predicate.  _P_ must be written as a predicate indicator, that is in form
 _Name/Arity_ or _Module:Name/Arity_.
 
```
:- dynamic god/1.
```
 
 
a more convenient form can be used:
 
```
:- dynamic son/3, father/2, mother/2.
```
 
or, equivalently,
 
```
:- dynamic [son/3, father/2, mother/2].
```
 
Note:
 
a predicate is assumed to be dynamic when
asserted before being defined.
 
 
*/
dynamic(X) :-
    current_prolog_flag(language, yap), current_prolog_flag,
  '$current_module'(M),
    '$dynamic'(X, M).
dynamic(X) :-
    '$do_error'(context_error(dynamic(X),declaration),query).
 
'$dynamic'(X,M) :- var(X), var,
    '$do_error'(instantiation_error,dynamic(M:X)).
'$dynamic'(X,M) :- var(M), var,
    '$do_error'(instantiation_error,dynamic(M:X)).
'$dynamic'(Mod:Spec,_) :- '$dynamic',
    '$dynamic'(Spec,Mod).
'$dynamic'([], _) :- '$dynamic'.
'$dynamic'([H|L], M) :- '$dynamic', '$dynamic'(H, M), '$dynamic'(L, M).
'$dynamic'((A,B),M) :- '$dynamic', '$dynamic'(A,M), '$dynamic'(B,M).
'$dynamic'(A//N,Mod) :- integer(N), integer,
    N1 is N+2,
    '$dynamic'(A/N1,Mod).
'$dynamic'(A/N,Mod) :-
  functor(G, A, N),
  '$mk_dynamic'(Mod:G),
'$mk_dynamic'.
 
 
 
 
/** @pred     multifile( _P_ ) is iso
 
Declares that a predicate or several predicates may be defined
throughout several files. _P_ is a collection of one or more predicate
indicators:
 
```
:- multifile user:portray_message/2, multifile user:message_hook/3.
```
 
Instructs the compiler about the declaration of a predicate  _P_ in
more than one file. It must appear in the first of the loaded files
where the predicate is declared, and before declaration of any of its
clauses.
 
Multifile declarations must be supported by reconsult/1 and
compile/1: when a multifile predicate is reconsulted,
only the clauses from the same file are removed.
 
Since YAP4.3.0 multifile procedures can be static or dynamic.
 
**/
multifile(P) :-
    strip_module(P, OM, Pred),
    '$multifile'(Pred, OM).
 
'$multifile'(V, _) :-
    var(V),
    var,
    '$do_error'(instantiation_error,multifile(V)).
'$multifile'((X,Y), M) :-
    '$multifile',
    '$multifile'(X, M),
    '$multifile'(Y, M).
'$multifile'(Mod:PredSpec, _) :-
    '$multifile',
    '$multifile'(PredSpec, Mod).
'$multifile'(N//A, M) :- '$multifile',
    integer(A),
    A1 is A+2,
    '$multifile'(N/A1, M).
'$multifile'(N/A, M) :-
    '$add_multifile'(N,A,M),
    '$add_multifile'.
'$multifile'(N/A, M) :-
    functor(S,N,A),
    '$new_multifile'(S, M), '$new_multifile'.
'$multifile'([H|T], M) :- '$multifile',
    '$multifile'(H,M),
    '$multifile'(T,M).
'$multifile'(P, M) :-
    '$do_error'(type_error(predicate_indicator,P),multifile(M:P)).
 
 
 
%
% did we declare multifile properly?
%
'$check_multifile_pred'(Hd, M, _) :-
    functor(Hd,Na,Ar),
    source_location(F, _),
    recorded('$multifile_defs','$defined'(F,Na,Ar,M),_), recorded.
% oops, we did not.
'$check_multifile_pred'(Hd, M, Fl) :-
    % so this is not a multi-file predicate any longer.
    functor(Hd,Na,Ar),
    NFl is \(0x20000000) /\ Fl,
    '$predicate_flags'(Hd,M,Fl,NFl),
    '$warn_mfile'(Na,Ar).
 
'$warn_mfile'(F,A) :-
    write(user_error,'% Warning: predicate '),
    write(user_error,F/A), write(user_error,' was a multifile predicate '),
    write(user_error,' (line '),
    '$start_line'(LN), write(user_error,LN),
    write(user_error,')'),
    nl(user_error).
 
 
 
meta_predicate(P) :-
        strip_module(P, OM, Pred),
        '$meta_predicate'(Pred, OM).
        
 
'$meta_predicate'(P,M) :-
            var(P),
    var,
    '$do_error'(instantiation_error,meta_predicate(M:P)).
'$meta_predicate'(P,M) :-
    var(M),
    var,
    '$do_error'(instantiation_error,meta_predicate(M:P)).
'$meta_predicate'((P,_Ps),M) :-
    '$meta_predicate'(P,M),
    '$meta_predicate'.
'$meta_predicate'((_P,Ps),M) :-
    '$meta_predicate',
    '$meta_predicate'(Ps,M).
'$meta_predicate'( D, M ) :-
    '$yap_strip_module'( M:D, M1, P),
    P\==D,
    '$yap_strip_module',
    '$meta_predicate'( P, M1 ).
'$meta_predicate'( D, M ) :-
    functor(D,F,N),
    '$install_meta_predicate'(D,M,F,N),
    '$install_meta_predicate'.
'$meta_predicate'( _D, _M ).
 
'$install_meta_predicate'(P,M,_F,_N) :-
    '$new_meta_pred'(P, M),
    '$new_meta_pred'.
'$install_meta_predicate'(_P,M,F,N) :-
    functor(PE,F,N),
    ( M = prolog -> M2 = _ ; M2 = M),
    recorded('$m',meta_predicate(M2,PE),R),
    erase(R),
    erase.
'$install_meta_predicate'(P,M,_F,_N) :-
    recordz('$m' , meta_predicate(M,P),_).
 
 
:- multifile 
       '$inline'/2,
       '$full_clause_optimisation'/4.
 
%
% can only do as goal in YAP mode.
%
/** @pred  dynamic( + _P_ )
 
 
Declares predicate  _P_ or list of predicates [ _P1_,..., _Pn_]
as a dynamic predicate.  _P_ must be written as a predicate indicator, that is in form
 _Name/Arity_ or _Module:Name/Arity_.
 
```
:- dynamic god/1.
```
 
 
a more convenient form can be used:
 
```
:- dynamic son/3, father/2, mother/2.
```
 
or, equivalently,
 
```
:- dynamic [son/3, father/2, mother/2].
```
 
Note:
 
a predicate is assumed to be dynamic when
asserted before being defined.
 
 
*/
 
 
 
/** @pred     multifile( _P_ ) is iso
 
Declares that a predicate or several predicates may be defined
throughout several files. _P_ is a collection of one or more predicate
indicators:
 
```
:- multifile user:portray_message/2, multifile user:message_hook/3.
```
 
Instructs the compiler about the declaration of a predicate  _P_ in
more than one file. It must appear in the first of the loaded files
where the predicate is declared, and before declaration of any of its
clauses.
 
Multifile declarations must be supported by reconsult/1 and
compile/1: when a multifile predicate is reconsulted,
only the clauses from the same file are removed.
 
Since YAP4.3.0 multifile procedures can be static or dynamic.
 
**/
multifile(P) :-
    strip_module(P, OM, Pred),
    '$multifile'(Pred, OM).
 
'$multifile'(V, _) :-
    var(V),
    var,
    '$do_error'(instantiation_error,multifile(V)).
'$multifile'((X,Y), M) :-
    '$multifile',
    '$multifile'(X, M),
    '$multifile'(Y, M).
'$multifile'(Mod:PredSpec, _) :-
    '$multifile',
    '$multifile'(PredSpec, Mod).
'$multifile'(N//A, M) :- '$multifile',
    integer(A),
    A1 is A+2,
    '$multifile'(N/A1, M).
'$multifile'(N/A, M) :-
    '$add_multifile'(N,A,M),
    '$add_multifile'.
'$multifile'(N/A, M) :-
    functor(S,N,A),
    '$new_multifile'(S, M), '$new_multifile'.
'$multifile'([H|T], M) :- '$multifile',
    '$multifile'(H,M),
    '$multifile'(T,M).
'$multifile'(P, M) :-
    '$do_error'(type_error(predicate_indicator,P),multifile(M:P)).
 
 
 
%
% did we declare multifile properly?
%
'$check_multifile_pred'(Hd, M, _) :-
    functor(Hd,Na,Ar),
    source_location(F, _),
    recorded('$multifile_defs','$defined'(F,Na,Ar,M),_), recorded.
% oops, we did not.
'$check_multifile_pred'(Hd, M, Fl) :-
    % so this is not a multi-file predicate any longer.
    functor(Hd,Na,Ar),
    NFl is \(0x20000000) /\ Fl,
    '$predicate_flags'(Hd,M,Fl,NFl),
    '$warn_mfile'(Na,Ar).
 
'$warn_mfile'(F,A) :-
    write(user_error,'% Warning: predicate '),
    write(user_error,F/A), write(user_error,' was a multifile predicate '),
    write(user_error,' (line '),
    '$start_line'(LN), write(user_error,LN),
    write(user_error,')'),
    nl(user_error).
 
 
 
private(P) :-
        strip_module(P, OM, Pred),
        '$private'(Pred, OM).
        
 
'$private'(P,M) :-
            var(P),
    var,
    '$do_error'(instantiation_error,private(M:P)).
'$private'(P,M) :-
    var(M),
    var,
    '$do_error'(instantiation_error,private(M:P)).
'$private'((P,_Ps),M) :-
    '$private'(P,M),
    '$private'.
'$private'((_P,Ps),M) :-
    '$private',
    '$private'(Ps,M).
'$private'( D, M ) :-
    '$yap_strip_module'( M:D, M1, P),
    P\==D,
    '$yap_strip_module',
    '$private'( P, M1 ).
'$private'( F/N, M ) :-
    functor(D,F,N),
    '$install_private'(D,M),
    '$install_private'.
'$private'( _D, _M ).
 
'$install_private'(P,M) :-
    hide_predicate(M:P).
 
:- multifile 
       '$inline'/2,
       '$full_clause_optimisation'/4.
 
 
/**
 * @}
 * */