1/*  Part of Extended Tools for SWI-Prolog
    2
    3    Author:        Edison Mera Menendez
    4    E-mail:        efmera@gmail.com
    5    WWW:           https://github.com/edisonm/xtools
    6    Copyright (C): 2015, Process Design Center, Breda, The Netherlands.
    7    All rights reserved.
    8
    9    Redistribution and use in source and binary forms, with or without
   10    modification, are permitted provided that the following conditions
   11    are met:
   12
   13    1. Redistributions of source code must retain the above copyright
   14       notice, this list of conditions and the following disclaimer.
   15
   16    2. Redistributions in binary form must reproduce the above copyright
   17       notice, this list of conditions and the following disclaimer in
   18       the documentation and/or other materials provided with the
   19       distribution.
   20
   21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   32    POSSIBILITY OF SUCH DAMAGE.
   33*/
   34
   35:- module(called_from, [called_from/1,
   36                        called_from/2,
   37                        called_from/5,
   38                        collect_called_from/5,
   39                        collect_called_from/6,
   40                        current_called_from/5,
   41                        current_used_from/6,
   42                        used_predicates/2,
   43                        used_predicates/3
   44                       ]).   45
   46:- use_module(library(assertions)).   47:- use_module(library(normalize_head)).   48:- use_module(library(normalize_pi)).   49:- use_module(library(codewalk)).   50:- use_module(library(extra_location)).   51:- use_module(library(location_utils)).   52:- use_module(library(from_utils)).   53
   54:- multifile
   55    prolog:message//1.   56
   57:- dynamic called_from_db/5.   58
   59prolog:message(acheck(called_from(MsgLoc, Args))) -->
   60        MsgLoc,
   61        ['~w called from ~w'-Args].
   62
   63called_from(Ref) :-
   64        called_from(Ref, _).
   65
   66called_from(Ref, Caller) :-
   67    ( called_from(Ref, _CM, Caller, [], Sorted),
   68      maplist(print_call_point, Sorted),
   69      fail
   70    ; cleanup_loc_dynamic(_, _, dynamic(_, _, _), _),
   71      retractall(called_from_db(_, _, _, _, _))
   72    ).
   73
   74called_from(Ref, CM, Caller, Options, Pairs) :-
   75    normalize_head(Ref, M:H),
   76    collect_called_from(H, M, CM, Caller, Options, Pairs).
   77
   78collect_called_from(H, M, CM, Caller, Options, Sorted) :-
   79    collect_called_from(H, M, CM, Caller, Options),
   80    findall(Loc-[M:F/A, CPI], ( current_called_from(H, M, CM, From, C),
   81                                functor(H, F, A),
   82                                normalize_pi(C, CPI),
   83                                from_location(From, Loc)
   84                              ), Pairs),
   85    keysort(Pairs, Sorted).
   86
   87collect_called_from(Ref, M, CM, Caller, Options1) :-
   88    cleanup_loc_dynamic(_, _, dynamic(_, _, _), _),
   89    retractall(called_from_db(_, _, _, _, _)),
   90    merge_options([source(true),
   91                   infer_meta_predicates(false),
   92                   autoload(false),
   93                   evaluate(false),
   94                   method(prolog),
   95                   trace_reference(_:Ref),
   96                   module_class([user, system, library]),
   97                   on_trace(collect_call_point(M, CM, Caller))],
   98                  Options1, Options),
   99    walk_code(Options).
  100
  101current_called_from(H, M, CM, From, Caller) :-
  102    current_used_from([retract, query], H, M, CM, From, Caller).
  103
  104current_used_from(DynTypes, H, M, CM, From, Caller) :-
  105    ( called_from_db(H, M, CM, Caller, From)
  106    ; loc_dynamic(H, M, dynamic(Type, CM, Caller), From),
  107      memberchk(Type, DynTypes)
  108    ; loc_declaration(H, CM, goal, From),
  109      predicate_property(CM:H, implementation_module(M))
  110    ; curr_prop_asr(head, CM:H, From, _),
  111      predicate_property(CM:H, implementation_module(M)),
  112      Caller = '<assertion>'(M:H)
  113    ).
  114
  115:- public collect_call_point/6.  116:- meta_predicate collect_call_point(?, ?, ?, +, +, +).  117collect_call_point(IM, M, Caller, MGoal, Caller, From) :-
  118    ignore(record_location_dynamic(MGoal, IM, From)),
  119    MGoal = M:Goal,
  120    predicate_property(MGoal, implementation_module(IM)),
  121    update_fact_from(called_from_db(Goal, IM, M, Caller), From).
  122
  123print_call_point(L-A) :-
  124    print_message(information, acheck(called_from(L, A))).
  125
  126% used_predicates(+Module, +Context, -PIL) is det
  127%
  128% Unifies PIL with a list of predicates implemented in the module Module,
  129% actually being used in the context Context.  Note that this would be different
  130% than the imported predicates.
  131%
  132used_predicates(Module, Context, PIL) :-
  133    collect_called_from(_, Module, Context, _, [source(false)]),
  134    findall(F/A,
  135            ( current_called_from(H, Module, Context, _, _),
  136              functor(H, F, A)
  137            ), PIU),
  138    sort(PIU, PIL).
  139
  140used_predicates(Module, Groups) :-
  141    collect_called_from(_, Module, _, _, [source(false)]),
  142    findall(Context-(F/A),
  143            ( current_called_from(H, Module, Context, _, _),
  144              functor(H, F, A)
  145            ), Pairs),
  146    sort(Pairs, Sorted),
  147    group_pairs_by_key(Sorted, Groups)