176 lines
5.7 KiB
Erlang
176 lines
5.7 KiB
Erlang
%% Module responsible for tracking invocations of module calls.
|
|
-module(elixir_locals).
|
|
-export([
|
|
setup/1, cleanup/1, cache_env/1, get_cached_env/1,
|
|
record_local/2, record_local/3, record_import/4,
|
|
record_definition/3, record_defaults/4,
|
|
ensure_no_import_conflict/4, warn_unused_local/3, format_error/1
|
|
]).
|
|
-export([macro_for/3, local_for/3, local_for/4]).
|
|
|
|
-include("elixir.hrl").
|
|
-define(attr, {elixir, locals_tracker}).
|
|
-define(tracker, 'Elixir.Module.LocalsTracker').
|
|
|
|
macro_for(Module, Name, Arity) ->
|
|
Tuple = {Name, Arity},
|
|
try elixir_def:lookup_clauses(Module, Tuple) of
|
|
{Kind, Ann, [_ | _] = Clauses} when Kind == defmacro; Kind == defmacrop ->
|
|
fun() -> get_function(Ann, Module, Clauses) end;
|
|
_ ->
|
|
false
|
|
catch
|
|
error:badarg -> false
|
|
end.
|
|
|
|
local_for(Module, Name, Arity) ->
|
|
local_for(Module, Name, Arity, nil).
|
|
local_for(Module, Name, Arity, Given) ->
|
|
Tuple = {Name, Arity},
|
|
case elixir_def:lookup_clauses(Module, Tuple) of
|
|
{Kind, Ann, [_ | _] = Clauses} when Given == nil; Kind == Given ->
|
|
get_function(Ann, Module, Clauses);
|
|
_ ->
|
|
{current_stacktrace, [_ | T]} = erlang:process_info(self(), current_stacktrace),
|
|
erlang:raise(error, undef, [{Module, Name, Arity, []} | T])
|
|
end.
|
|
|
|
get_function(Ann, Module, Clauses) ->
|
|
RewrittenClauses = [rewrite_clause(Clause, Module) || Clause <- Clauses],
|
|
Fun = {'fun', Ann, {clauses, RewrittenClauses}},
|
|
{value, Result, _Binding} = erl_eval:exprs([Fun], []),
|
|
Result.
|
|
|
|
rewrite_clause({call, Ann1, {atom, Ann2, RawName}, Args}, Module) ->
|
|
Remote = {remote, Ann1,
|
|
{atom, Ann2, ?MODULE},
|
|
{atom, Ann2, local_for}
|
|
},
|
|
|
|
%% If we have a macro, its arity in the table is
|
|
%% actually one less than in the function call
|
|
{Name, Arity} = case atom_to_list(RawName) of
|
|
"MACRO-" ++ Rest -> {list_to_atom(Rest), length(Args) - 1};
|
|
_ -> {RawName, length(Args)}
|
|
end,
|
|
|
|
FunCall = {call, Ann1, Remote, [
|
|
{atom, Ann2, Module}, {atom, Ann2, Name}, {integer, Ann2, Arity}
|
|
]},
|
|
{call, Ann1, FunCall, Args};
|
|
|
|
rewrite_clause(Tuple, Module) when is_tuple(Tuple) ->
|
|
list_to_tuple(rewrite_clause(tuple_to_list(Tuple), Module));
|
|
|
|
rewrite_clause(List, Module) when is_list(List) ->
|
|
[rewrite_clause(Item, Module) || Item <- List];
|
|
|
|
rewrite_clause(Else, _) -> Else.
|
|
|
|
%% TRACKING
|
|
|
|
setup(Module) ->
|
|
case elixir_compiler:get_opt(internal) of
|
|
false ->
|
|
{ok, Pid} = ?tracker:start_link(),
|
|
ets:insert(elixir_module:data_table(Module), {?attr, Pid}),
|
|
ok;
|
|
true ->
|
|
ok
|
|
end.
|
|
|
|
cleanup(Module) ->
|
|
if_tracker(Module, fun(Pid) -> unlink(Pid), ?tracker:stop(Pid), ok end).
|
|
|
|
record_local(Tuple, Module) when is_atom(Module) ->
|
|
if_tracker(Module, fun(Pid) -> ?tracker:add_local(Pid, Tuple), ok end).
|
|
record_local(Tuple, _Module, Function)
|
|
when Function == nil; Function == Tuple -> ok;
|
|
record_local(Tuple, Module, Function) ->
|
|
if_tracker(Module, fun(Pid) -> ?tracker:add_local(Pid, Function, Tuple), ok end).
|
|
|
|
record_import(_Tuple, Receiver, Module, _Function)
|
|
when Module == nil; Module == Receiver -> false;
|
|
record_import(Tuple, Receiver, Module, Function) ->
|
|
if_tracker(Module, fun(Pid) -> ?tracker:add_import(Pid, Function, Receiver, Tuple), ok end).
|
|
|
|
record_definition(Tuple, Kind, Module) ->
|
|
if_tracker(Module, fun(Pid) -> ?tracker:add_definition(Pid, Kind, Tuple), ok end).
|
|
|
|
record_defaults(_Tuple, _Kind, _Module, 0) ->
|
|
ok;
|
|
record_defaults(Tuple, Kind, Module, Defaults) ->
|
|
if_tracker(Module, fun(Pid) -> ?tracker:add_defaults(Pid, Kind, Tuple, Defaults), ok end).
|
|
|
|
if_tracker(Module, Callback) ->
|
|
if_tracker(Module, ok, Callback).
|
|
|
|
if_tracker(Module, Default, Callback) ->
|
|
try ets:lookup_element(elixir_module:data_table(Module), ?attr, 2) of
|
|
Pid -> Callback(Pid)
|
|
catch
|
|
error:badarg -> Default
|
|
end.
|
|
|
|
%% CACHING
|
|
|
|
cache_env(#{module := Module} = RE) ->
|
|
E = RE#{line := nil, vars := []},
|
|
try ets:lookup_element(elixir_module:data_table(Module), ?attr, 2) of
|
|
Pid ->
|
|
{Pid, ?tracker:cache_env(Pid, E)}
|
|
catch
|
|
error:badarg ->
|
|
{Escaped, _} = elixir_quote:escape(E, false),
|
|
Escaped
|
|
end.
|
|
|
|
get_cached_env({Pid, Ref}) -> ?tracker:get_cached_env(Pid, Ref);
|
|
get_cached_env(Env) -> Env.
|
|
|
|
%% ERROR HANDLING
|
|
|
|
ensure_no_import_conflict(_Line, _File, 'Elixir.Kernel', _All) ->
|
|
ok;
|
|
ensure_no_import_conflict(Line, File, Module, All) ->
|
|
if_tracker(Module, ok, fun(Pid) ->
|
|
_ = [ begin
|
|
elixir_errors:form_error([{line, Line}], File, ?MODULE, {function_conflict, Error})
|
|
end || Error <- ?tracker:collect_imports_conflicts(Pid, All) ],
|
|
ok
|
|
end).
|
|
|
|
warn_unused_local(File, Module, Private) ->
|
|
if_tracker(Module, [], fun(Pid) ->
|
|
Args = [{Fun, Kind, Defaults} ||
|
|
{Fun, Kind, _Line, true, Defaults} <- Private],
|
|
|
|
{Unreachable, Warnings} = ?tracker:collect_unused_locals(Pid, Args),
|
|
|
|
[begin
|
|
{_, _, Line, _, _} = lists:keyfind(element(2, Error), 1, Private),
|
|
elixir_errors:form_warn([{line, Line}], File, ?MODULE, Error)
|
|
end || Error <- Warnings ],
|
|
|
|
Unreachable
|
|
end).
|
|
|
|
format_error({function_conflict, {Receivers, Name, Arity}}) ->
|
|
io_lib:format("imported ~ts.~ts/~B conflicts with local function",
|
|
[elixir_aliases:inspect(hd(Receivers)), Name, Arity]);
|
|
|
|
format_error({unused_args, {Name, Arity}}) ->
|
|
io_lib:format("default arguments in ~ts/~B are never used", [Name, Arity]);
|
|
|
|
format_error({unused_args, {Name, Arity}, 1}) ->
|
|
io_lib:format("the first default argument in ~ts/~B is never used", [Name, Arity]);
|
|
|
|
format_error({unused_args, {Name, Arity}, Count}) ->
|
|
io_lib:format("the first ~B default arguments in ~ts/~B are never used", [Count, Name, Arity]);
|
|
|
|
format_error({unused_def, {Name, Arity}, defp}) ->
|
|
io_lib:format("function ~ts/~B is unused", [Name, Arity]);
|
|
|
|
format_error({unused_def, {Name, Arity}, defmacrop}) ->
|
|
io_lib:format("macro ~ts/~B is unused", [Name, Arity]).
|