Files
n8n-openai-adapter/lib/elixir/src/elixir_module.erl
T

570 lines
19 KiB
Erlang

-module(elixir_module).
-export([data_table/1, defs_table/1, is_open/1, delete_doc/6,
compile/4, expand_callback/6, add_beam_chunk/3, format_error/1,
compiler_modules/0]).
-include("elixir.hrl").
-define(lexical_attr, {elixir, lexical_tracker}).
-define(persisted_attr, {elixir, persisted_attributes}).
%% Stores modules currently being defined by the compiler
compiler_modules() ->
case erlang:get(elixir_compiler_modules) of
undefined -> [];
M when is_list(M) -> M
end.
put_compiler_modules([]) ->
erlang:erase(elixir_compiler_modules);
put_compiler_modules(M) when is_list(M) ->
erlang:put(elixir_compiler_modules, M).
%% TABLE METHODS
data_table(Module) ->
ets:lookup_element(elixir_modules, Module, 2).
defs_table(Module) ->
ets:lookup_element(elixir_modules, Module, 3).
is_open(Module) ->
ets:lookup(elixir_modules, Module) /= [].
delete_doc(#{module := Module}, _, _, _, _, _) ->
ets:delete(data_table(Module), doc),
ok.
%% Compilation hook
compile(Module, Block, Vars, #{line := Line} = Env) when is_atom(Module) ->
%% In case we are generating a module from inside a function,
%% we get rid of the lexical tracker information as, at this
%% point, the lexical tracker process is long gone.
LexEnv = case ?m(Env, function) of
nil -> Env#{module := Module};
_ -> Env#{lexical_tracker := nil, function := nil, module := Module}
end,
case ?m(LexEnv, lexical_tracker) of
nil ->
elixir_lexical:run(?m(LexEnv, file), nil, fun(Pid) ->
do_compile(Line, Module, Block, Vars, LexEnv#{lexical_tracker := Pid})
end);
_ ->
do_compile(Line, Module, Block, Vars, LexEnv)
end;
compile(Module, _Block, _Vars, #{line := Line, file := File}) ->
elixir_errors:form_error([{line, Line}], File, ?MODULE, {invalid_module, Module}).
do_compile(Line, Module, Block, Vars, E) ->
File = ?m(E, file),
check_module_availability(Line, File, Module),
CompilerModules = compiler_modules(),
Docs = elixir_compiler:get_opt(docs),
{Data, Defs, Ref} = build(Line, File, Module, Docs, ?m(E, lexical_tracker)),
try
put_compiler_modules([Module|CompilerModules]),
{Result, NE} = eval_form(Line, Module, Data, Block, Vars, E),
PersistedAttrs = ets:lookup_element(Data, ?persisted_attr, 2),
CompileOpts = ets:lookup_element(Data, compile, 2),
OnLoad = ets:lookup_element(Data, 'on_load', 2),
[elixir_locals:record_local(Tuple, Module) || Tuple <- OnLoad],
{AllDefinitions, Unreachable} =
elixir_def:fetch_definitions(File, Module),
{Def, Defp, Defmacro, Defmacrop, Exports, Functions} =
elixir_erl:split_definition(File, Module, AllDefinitions, Unreachable),
Forms0 = functions_form(Line, File, Module, Def, Defp,
Defmacro, Defmacrop, Exports, Functions),
Forms1 = specs_form(Data, Defmacro, Defmacrop, Unreachable, Forms0),
Forms2 = types_form(Data, Forms1),
Forms3 = attributes_form(Line, File, Data, PersistedAttrs, Forms2),
warn_unused_attributes(File, Data, PersistedAttrs),
Location = {elixir_utils:characters_to_list(elixir_utils:relative_to_cwd(File)), Line},
Final = [
{attribute, Line, file, Location},
{attribute, Line, module, Module} | Forms3
],
Binary = load_form(Line, Data, Final, lists:flatten(CompileOpts), NE),
{module, Module, Binary, Result}
catch
error:undef ->
case erlang:get_stacktrace() of
[{Module, Fun, Args, _Info} | _] = Stack when is_list(Args) ->
compile_undef(Module, Fun, length(Args), Stack);
[{Module, Fun, Arity, _Info} | _] = Stack ->
compile_undef(Module, Fun, Arity, Stack);
Stack ->
erlang:raise(error, undef, Stack)
end
after
put_compiler_modules(CompilerModules),
elixir_locals:cleanup(Module),
ets:delete(Data),
ets:delete(Defs),
elixir_code_server:call({undefmodule, Ref})
end.
%% An undef error for a function in the module being compiled might result in an
%% exception message suggesting the current module is not loaded. This is
%% misleading so use a custom reason.
compile_undef(Module, Fun, Arity, Stack) ->
ExMod = 'Elixir.UndefinedFunctionError',
case code:is_loaded(ExMod) of
false ->
erlang:raise(error, undef, Stack);
_ ->
Opts = [{module, Module}, {function, Fun}, {arity, Arity},
{reason, 'function not available'}],
Exception = 'Elixir.UndefinedFunctionError':exception(Opts),
erlang:raise(error, Exception, Stack)
end.
%% Hook that builds both attribute and functions and set up common hooks.
build(Line, File, Module, Docs, Lexical) ->
case elixir_code_server:call({lookup, Module}) of
[{Module, _, _, OldLine, OldFile}] ->
Error = {module_in_definition, Module, OldFile, OldLine},
elixir_errors:form_error([{line, Line}], File, ?MODULE, Error);
_ ->
[]
end,
Data = ets:new(Module, [set, public]),
Defs = ets:new(Module, [duplicate_bag, public]),
Ref = elixir_code_server:call({defmodule, self(),
{Module, Data, Defs, Line, File}}),
OnDefinition =
case Docs of
true -> [{'Elixir.Module', compile_doc}];
_ -> [{elixir_module, delete_doc}]
end,
ets:insert(Data, [
% {Key, Value, Accumulate?, UnreadLine}
{after_compile, [], true, nil},
{before_compile, [], true, nil},
{behaviour, [], true, nil},
{compile, [], true, nil},
{derive, [], true, nil},
{dialyzer, [], true, nil},
{external_resource, [], true, nil},
{moduledoc, nil, false, nil},
{on_definition, OnDefinition, true, nil},
{on_load, [], true, nil},
% Types
{callback, [], true, nil},
{opaque, [], true, nil},
{optional_callbacks, [], true, nil},
{macrocallback, [], true, nil},
{spec, [], true, nil},
{type, [], true, nil},
{typep, [], true, nil}
]),
Persisted = [behaviour, on_load, compile, external_resource, dialyzer, vsn],
ets:insert(Data, {?persisted_attr, Persisted}),
ets:insert(Data, {?lexical_attr, Lexical}),
%% Setup definition related modules
elixir_def:setup(Module),
elixir_locals:setup(Module),
elixir_def_overridable:setup(Module),
{Data, Defs, Ref}.
%% Receives the module representation and evaluates it.
eval_form(Line, Module, Data, Block, Vars, E) ->
{Value, EE} = elixir_compiler:eval_forms(Block, Vars, E),
elixir_def_overridable:store_pending(Module),
EV = elixir_env:linify({Line, EE#{vars := [], export_vars := nil}}),
EC = eval_callbacks(Line, Data, before_compile, [EV], EV),
elixir_def_overridable:store_pending(Module),
{Value, EC}.
eval_callbacks(Line, Data, Name, Args, E) ->
Callbacks = ets:lookup_element(Data, Name, 2),
lists:foldr(fun({M, F}, Acc) ->
expand_callback(Line, M, F, Args, Acc#{vars := [], export_vars := nil},
fun(AM, AF, AA) -> apply(AM, AF, AA) end)
end, E, Callbacks).
%% Return the form with exports and function declarations.
functions_form(Line, File, Module, Def, Defp, Defmacro, Defmacrop, Exports, Body) ->
Pair = {'__info__', 1},
case lists:member(Pair, Def) or lists:member(Pair, Defp) or
lists:member(Pair, Defmacro) or lists:member(Pair, Defmacrop) of
true ->
elixir_errors:form_error([{line, Line}], File, ?MODULE, {internal_function_overridden, Pair});
false ->
{Spec, Info} = add_info_function(Line, Module, Def, Defmacro),
[{attribute, Line, export, lists:sort([{'__info__', 1} | Exports])}, Spec, Info | Body]
end.
%% Add attributes handling to the form
attributes_form(Line, File, Data, PersistedAttrs, Current) ->
Transform = fun(Key, Acc) when is_atom(Key) ->
case ets:lookup(Data, Key) of
[{Key, Values, true, _}] ->
lists:foldl(fun(X, Final) ->
[{attribute, Line, Key, X} | Final]
end, Acc, process_accumulated(Line, File, Key, Values));
[{Key, Value, false, _}] ->
[{attribute, Line, Key, Value} | Acc];
[] ->
Acc
end
end,
lists:foldl(Transform, Current, PersistedAttrs).
process_accumulated(Line, File, external_resource, Values) ->
lists:usort([process_external_resource(Line, File, Value) || Value <- Values]);
process_accumulated(_Line, _File, _Key, Values) ->
Values.
process_external_resource(_Line, _File, Value) when is_binary(Value) ->
Value;
process_external_resource(Line, File, Value) ->
elixir_errors:form_error([{line, Line}], File, ?MODULE, {invalid_external_resource, Value}).
%% Types
types_form(Data, Forms0) ->
case elixir_compiler:get_opt(internal) of
false ->
Types0 = take_type_spec(Data, type) ++
take_type_spec(Data, typep) ++
take_type_spec(Data, opaque),
Types1 = ['Elixir.Kernel.Typespec':translate_type(Kind, Expr, Caller) ||
{Kind, Expr, Caller} <- Types0],
Forms1 = types_attributes(Types1, Forms0),
Forms2 = export_types_attributes(Types1, Forms1),
Forms2;
true ->
Forms0
end.
types_attributes(Types, Forms) ->
Fun = fun({{Kind, _NameArity, Expr}, Line, _Export}, Acc) ->
[{attribute, Line, Kind, Expr} | Acc]
end,
lists:foldl(Fun, Forms, Types).
export_types_attributes(Types, Forms) ->
Fun = fun
({{_Kind, NameArity, _Expr}, Line, true}, Acc) ->
[{attribute, Line, export_type, [NameArity]} | Acc];
({_Type, _Line, false}, Acc) ->
Acc
end,
lists:foldl(Fun, Forms, Types).
%% Specs
specs_form(Data, Defmacro, Defmacrop, Unreachable, Forms) ->
case elixir_compiler:get_opt(internal) of
false ->
Specs0 = take_type_spec(Data, spec) ++
take_type_spec(Data, callback) ++
take_type_spec(Data, macrocallback),
Specs1 = ['Elixir.Kernel.Typespec':translate_spec(Kind, Expr, Caller) ||
{Kind, Expr, Caller} <- Specs0],
Specs2 = lists:flatmap(fun(Spec) ->
translate_macro_spec(Spec, Defmacro, Defmacrop)
end, Specs1),
Specs3 = lists:filter(fun({{_Kind, NameArity, _Spec}, _Line}) ->
not lists:member(NameArity, Unreachable)
end, Specs2),
optional_callbacks_attributes(take_type_spec(Data, optional_callbacks), Specs3) ++
specs_attributes(Forms, Specs3);
true ->
Forms
end.
specs_attributes(Forms, Specs) ->
Dict = lists:foldl(fun({{Kind, NameArity, Spec}, Line}, Acc) ->
dict:append({Kind, NameArity}, {Spec, Line}, Acc)
end, dict:new(), Specs),
dict:fold(fun({Kind, NameArity}, ExprsLines, Acc) ->
{Exprs, Lines} = lists:unzip(ExprsLines),
Line = lists:min(Lines),
[{attribute, Line, Kind, {NameArity, Exprs}} | Acc]
end, Forms, Dict).
translate_macro_spec({{spec, NameArity, Spec}, Line}, Defmacro, Defmacrop) ->
case lists:member(NameArity, Defmacrop) of
true -> [];
false ->
case lists:member(NameArity, Defmacro) of
true ->
{Name, Arity} = NameArity,
[{{spec, {elixir_utils:macro_name(Name), Arity + 1}, spec_for_macro(Spec)}, Line}];
false ->
[{{spec, NameArity, Spec}, Line}]
end
end;
translate_macro_spec({{callback, NameArity, Spec}, Line}, _Defmacro, _Defmacrop) ->
[{{callback, NameArity, Spec}, Line}].
spec_for_macro({type, Line, 'fun', [{type, _, product, Args} | T]}) ->
NewArgs = [{type, Line, term, []} | Args],
{type, Line, 'fun', [{type, Line, product, NewArgs} | T]};
spec_for_macro(Else) ->
Else.
optional_callbacks_attributes(OptionalCallbacksTypespec, Specs) ->
% We only take the specs of the callbacks (which are both callbacks and
% macrocallbacks).
Callbacks = [NameArity || {{callback, NameArity, _Spec}, _Line} <- Specs],
[{attribute, Line, optional_callbacks, macroify_callback_names(NamesArities, Callbacks)} ||
{Line, NamesArities} <- OptionalCallbacksTypespec].
macroify_callback_names(NamesArities, Callbacks) ->
lists:map(fun({Name, Arity} = NameArity) ->
MacroNameArity = {elixir_utils:macro_name(Name), Arity + 1},
case lists:member(MacroNameArity, Callbacks) of
true -> MacroNameArity;
false -> NameArity
end
end, NamesArities).
%% Loads the form into the code server.
load_form(Line, Data, Forms, Opts, E) ->
elixir_compiler:module(Forms, Opts, E, fun(Module, Binary0) ->
Docs = elixir_compiler:get_opt(docs),
Binary = add_docs_chunk(Binary0, Data, Line, Docs),
eval_callbacks(Line, Data, after_compile, [E, Binary], E),
case get(elixir_module_binaries) of
Current when is_list(Current) ->
put(elixir_module_binaries, [{Module, Binary} | Current]),
case get(elixir_compiler_pid) of
undefined ->
ok;
PID ->
Ref = make_ref(),
PID ! {module_available, self(), Ref, get(elixir_compiler_file), Module, Binary},
receive {Ref, ack} -> ok end
end;
_ ->
ok
end,
Binary
end).
add_docs_chunk(Bin, Data, Line, true) ->
ChunkData = term_to_binary({elixir_docs_v1, [
{docs, get_docs(Data)},
{moduledoc, get_moduledoc(Line, Data)},
{callback_docs, get_callback_docs(Data)},
{type_docs, get_type_docs(Data)}
]}),
add_beam_chunk(Bin, "ExDc", ChunkData);
add_docs_chunk(Bin, _, _, _) -> Bin.
get_moduledoc(Line, Data) ->
case ets:lookup_element(Data, moduledoc, 2) of
nil -> {Line, nil};
{DocLine, Doc} -> {DocLine, Doc}
end.
get_docs(Data) ->
lists:usort(ets:select(Data, [{{{doc, '$1'}, '$2', '$3', '$4', '$5'},
[], [{{'$1', '$2', '$3', '$4', '$5'}}]}])).
get_callback_docs(Data) ->
lists:usort(ets:select(Data, [{{{callbackdoc, '$1'}, '$2', '$3', '$4'},
[], [{{'$1', '$2', '$3', '$4'}}]}])).
get_type_docs(Data) ->
lists:usort(ets:select(Data, [{{{typedoc, '$1'}, '$2', '$3', '$4'},
[], [{{'$1', '$2', '$3', '$4'}}]}])).
take_type_spec(Data, Key) ->
case ets:take(Data, Key) of
[{Key, Value, _, _}] -> Value;
[] -> []
end.
check_module_availability(Line, File, Module) ->
Reserved = ['Elixir.Any', 'Elixir.BitString', 'Elixir.Function', 'Elixir.PID',
'Elixir.Reference', 'Elixir.Elixir', 'Elixir'],
case lists:member(Module, Reserved) of
true -> elixir_errors:form_error([{line, Line}], File, ?MODULE, {module_reserved, Module});
false -> ok
end,
case elixir_compiler:get_opt(ignore_module_conflict) of
false ->
case code:ensure_loaded(Module) of
{module, _} ->
elixir_errors:form_warn([{line, Line}], File, ?MODULE, {module_defined, Module});
{error, _} ->
ok
end;
true ->
ok
end.
warn_unused_attributes(File, Data, PersistedAttrs) ->
ReservedAttrs = [after_compile, before_compile, moduledoc, on_definition | PersistedAttrs],
Keys = ets:select(Data, [{{'$1', '_', '_', '$2'}, [{is_atom, '$1'}, {is_integer, '$2'}], [['$1', '$2']]}]),
[elixir_errors:form_warn([{line, Line}], File, ?MODULE, {unused_attribute, Key}) ||
[Key, Line] <- Keys, not lists:member(Key, ReservedAttrs)].
% __INFO__
add_info_function(Line, Module, Def, Defmacro) ->
AllowedArgs =
lists:map(fun(Atom) -> {atom, Line, Atom} end,
[attributes, compile, exports, functions, macros, md5, module]),
Spec =
{attribute, Line, spec, {{'__info__', 1},
[{type, Line, 'fun', [
{type, Line, product, [
{type, Line, union, AllowedArgs}
]},
{type, Line, union, [
{type, Line, atom, []},
{type, Line, list, [
{type, Line, union, [
{type, Line, tuple, [
{type, Line, atom, []},
{type, Line, any, []}
]},
{type, Line, tuple, [
{type, Line, atom, []},
{type, Line, byte, []},
{type, Line, integer, []}
]}
]}
]}
]}
]}]
}},
Info =
{function, 0, '__info__', 1, [
functions_clause(Def),
macros_clause(Defmacro),
info_clause(Module)
]},
{Spec, Info}.
functions_clause(Def) ->
{clause, 0, [{atom, 0, functions}], [], [elixir_utils:elixir_to_erl(lists:sort(Def))]}.
macros_clause(Defmacro) ->
{clause, 0, [{atom, 0, macros}], [], [elixir_utils:elixir_to_erl(lists:sort(Defmacro))]}.
info_clause(Module) ->
Info = {call, 0,
{remote, 0, {atom, 0, erlang}, {atom, 0, get_module_info}},
[{atom, 0, Module}, {var, 0, info}]},
{clause, 0, [{var, 0, info}], [], [Info]}.
% HELPERS
%% Adds custom chunk to a .beam binary
add_beam_chunk(Bin, Id, ChunkData)
when is_binary(Bin), is_list(Id), is_binary(ChunkData) ->
{ok, _, Chunks0} = beam_lib:all_chunks(Bin),
NewChunk = {Id, ChunkData},
Chunks = [NewChunk | Chunks0],
{ok, NewBin} = beam_lib:build_module(Chunks),
NewBin.
%% Expands a callback given by M:F(Args). In case
%% the callback can't be expanded, invokes the given
%% fun passing a possibly expanded AM:AF(Args).
expand_callback(Line, M, F, Args, E, Fun) ->
Meta = [{line, Line}, {required, true}],
{EE, ET} = elixir_dispatch:dispatch_require(Meta, M, F, Args, E, fun(AM, AF, AA) ->
Fun(AM, AF, AA),
{ok, E}
end),
if
is_atom(EE) ->
ET;
true ->
try
{_Value, _Binding, EF, _S} = elixir:eval_forms(EE, [], ET),
EF
catch
Kind:Reason ->
Info = {M, F, length(Args), location(Line, E)},
erlang:raise(Kind, Reason, prune_stacktrace(Info, erlang:get_stacktrace()))
end
end.
location(Line, E) ->
[{file, elixir_utils:characters_to_list(?m(E, file))}, {line, Line}].
%% We've reached the elixir_module or eval internals, skip it with the rest
prune_stacktrace(Info, [{elixir, eval_forms, _, _} | _]) ->
[Info];
prune_stacktrace(Info, [{elixir_module, _, _, _} | _]) ->
[Info];
prune_stacktrace(Info, [H | T]) ->
[H | prune_stacktrace(Info, T)];
prune_stacktrace(Info, []) ->
[Info].
% ERROR HANDLING
format_error({invalid_external_resource, Value}) ->
io_lib:format("expected a string value for @external_resource, got: ~p",
['Elixir.Kernel':inspect(Value)]);
format_error({unused_attribute, typedoc}) ->
"module attribute @typedoc was set but no type follows it";
format_error({unused_attribute, doc}) ->
"module attribute @doc was set but no definition follows it";
format_error({unused_attribute, Attr}) ->
io_lib:format("module attribute @~ts was set but never used", [Attr]);
format_error({internal_function_overridden, {Name, Arity}}) ->
io_lib:format("function ~ts/~B is internal and should not be overridden", [Name, Arity]);
format_error({invalid_module, Module}) ->
io_lib:format("invalid module name: ~ts", ['Elixir.Kernel':inspect(Module)]);
format_error({module_defined, Module}) ->
Extra =
case code:which(Module) of
Path when is_list(Path) ->
io_lib:format(" (current version loaded from ~ts)", [elixir_utils:relative_to_cwd(Path)]);
in_memory ->
" (current version defined in memory)";
_ ->
""
end,
io_lib:format("redefining module ~ts~ts", [elixir_aliases:inspect(Module), Extra]);
format_error({module_reserved, Module}) ->
io_lib:format("module ~ts is reserved and cannot be defined", [elixir_aliases:inspect(Module)]);
format_error({module_in_definition, Module, File, Line}) ->
io_lib:format("cannot define module ~ts because it is currently being defined in ~ts:~B",
[elixir_aliases:inspect(Module), elixir_utils:relative_to_cwd(File), Line]).