Skip to content

Commit

Permalink
Don't throw errors around, add them to the context (#85)
Browse files Browse the repository at this point in the history 
Provide position info with error/warning when available.
Also added a few clauses to format_error for missing error messages.
  • Loading branch information
@kaos
kaos committed Feb 27, 2014
1 parent 7bfc99e commit c7b2883
Show file tree
Hide file tree
Showing 4 changed files with 143 additions and 55 deletions.
123 changes: 83 additions & 40 deletions src/erlydtl_beam_compiler.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
empty_scope/0, print/3, get_current_file/1, add_errors/2,
add_warnings/2, merge_info/2, call_extension/3,
init_treewalker/1, resolve_variable/2, resolve_variable/3,
reset_parse_trail/2]).
reset_parse_trail/2, load_library/3, load_library/4]).

-include_lib("merl/include/merl.hrl").
-include("erlydtl_ext.hrl").
Expand All @@ -90,9 +90,18 @@ format_error({write_file, Error}) ->
"Failed to write file: ~s",
[file:format_error(Error)]);
format_error(compile_beam) ->
"Failed to compile template to .beam file";
"Failed to compile template to BEAM code";
format_error({unknown_filter, Name, Arity}) ->
io_lib:format("Unknown filter '~s' (arity ~p)", [Name, Arity]);
format_error({filter_args, Name, {Mod, Fun}, Arity}) ->
io_lib:format("Wrong number of arguments to filter '~s' (~p:~p): ~p", [Name, Mod, Fun, Arity]);
format_error({missing_tag, Name, {Mod, Fun}}) ->
io_lib:format("Custom tag '~s' not exported (~p:~p)", [Name, Mod, Fun]);
format_error({bad_tag, Name, {Mod, Fun}, Arity}) ->
io_lib:format("Invalid tag '~s' (~p:~p/~p)", [Name, Mod, Fun, Arity]);
format_error({load_code, Error}) ->
io_lib:format("Failed to load BEAM code: ~p", [Error]);
format_error(Error) ->
%% may be an error thrown from erlydtl_compiler...
erlydtl_compiler:format_error(Error).


Expand Down Expand Up @@ -179,13 +188,20 @@ compile_to_binary(DjangoParseTree, CheckSum, Context) ->
try body_ast(DjangoParseTree, init_treewalker(Context)) of
{{BodyAst, BodyInfo}, BodyTreeWalker} ->
try custom_tags_ast(BodyInfo#ast_info.custom_tags, BodyTreeWalker) of
{{CustomTagsAst, CustomTagsInfo}, CustomTagsTreeWalker} ->
{{CustomTagsAst, CustomTagsInfo},
#treewalker{
context=#dtl_context{
errors=#error_info{ list=Errors }
} }=CustomTagsTreeWalker}
when length(Errors) == 0 ->
Forms = forms(
{BodyAst, BodyInfo},
{CustomTagsAst, CustomTagsInfo},
CheckSum,
CustomTagsTreeWalker),
compile_forms(Forms, CustomTagsTreeWalker#treewalker.context)
compile_forms(Forms, CustomTagsTreeWalker#treewalker.context);
{_, #treewalker{ context=Context1 }} ->
Context1
catch
throw:Error -> ?ERR(Error, BodyTreeWalker#treewalker.context)
end
Expand Down Expand Up @@ -243,7 +259,7 @@ load_code(Module, Bin, Context) ->
code:purge(Module),
case code:load_binary(Module, atom_to_list(Module) ++ ".erl", Bin) of
{module, Module} -> Context;
Error -> ?WARN({load, Error}, Context)
Error -> ?WARN({load_code, Error}, Context)
end.

maybe_debug_template(Forms, Context) ->
Expand Down Expand Up @@ -357,7 +373,7 @@ custom_tags_clauses_ast1([Tag|CustomTags], ExcludeTags, ClauseAcc, InfoAcc, Tree
CustomTags, [Tag|ExcludeTags], [Clause|ClauseAcc],
merge_info(BodyAstInfo, InfoAcc), TreeWalker1);
{error, Reason} ->
throw(Reason)
empty_ast(?ERR(Reason, TreeWalker))
end;
false ->
case call_extension(TreeWalker, custom_tag_ast, [Tag, TreeWalker]) of
Expand Down Expand Up @@ -495,7 +511,7 @@ body_ast([{'extends', {string_literal, _Pos, String}} | ThisParseTree], #treewal
File = full_path(unescape_string_literal(String), Context#dtl_context.doc_root),
case lists:member(File, Context#dtl_context.parse_trail) of
true ->
throw(circular_include);
empty_ast(?ERR(circular_include, TreeWalker));
_ ->
case parse_file(File, Context) of
{ok, ParentParseTree, CheckSum} ->
Expand All @@ -520,7 +536,7 @@ body_ast([{'extends', {string_literal, _Pos, String}} | ThisParseTree], #treewal
})),
{Info, reset_parse_trail(Context#dtl_context.parse_trail, TreeWalker1)};
{error, Reason} ->
throw(Reason)
empty_ast(?ERR(Reason, TreeWalker))
end
end;

Expand Down Expand Up @@ -621,6 +637,10 @@ body_ast(DjangoParseTree, BodyScope, TreeWalker) ->
({'include_only', {string_literal, _, File}, Args}, TW) ->
{Info, IncTW} = include_ast(unescape_string_literal(File), Args, [], TW),
{Info, restore_scope(TW, IncTW)};
({'load_libs', Libs}, TW) ->
load_libs_ast(Libs, TW);
({'load_from_lib', What, Lib}, TW) ->
load_from_lib_ast(What, Lib, TW);
({'regroup', {ListVariable, Grouper, {identifier, _, NewVariable}}}, TW) ->
regroup_ast(ListVariable, Grouper, NewVariable, TW);
('end_regroup', TW) ->
Expand All @@ -633,7 +653,7 @@ body_ast(DjangoParseTree, BodyScope, TreeWalker) ->
include_ast(unescape_string_literal(FileName), [], Context#dtl_context.local_scopes, TW);
({'string', _Pos, String}, TW) ->
string_ast(String, TW);
({'tag', {identifier, _, Name}, Args}, TW) ->
({'tag', Name, Args}, TW) ->
tag_ast(Name, Args, TW);
({'templatetag', {_, _, TagName}}, TW) ->
templatetag_ast(TagName, TW);
Expand All @@ -647,8 +667,8 @@ body_ast(DjangoParseTree, BodyScope, TreeWalker) ->
scope_as(Name, Contents, TW);
({'extension', Tag}, TW) ->
extension_ast(Tag, TW);
({'extends', _}, _TW) ->
throw(unexpected_extends_tag);
({'extends', _}, TW) ->
empty_ast(?ERR(unexpected_extends_tag, TW));
(ValueToken, TW) ->
{{ValueAst,ValueInfo},ValueTW} = value_ast(ValueToken, true, true, TW),
{{format(ValueAst, ValueTW),ValueInfo},ValueTW}
Expand Down Expand Up @@ -724,7 +744,7 @@ value_ast(ValueToken, AsString, EmptyIfUndefined, TreeWalker) ->
extension_ast(Tag, TreeWalker) ->
case call_extension(TreeWalker, compile_ast, [Tag, TreeWalker]) of
undefined ->
throw({unknown_extension, Tag});
empty_ast(?WARN({unknown_extension, Tag}, TreeWalker));
Result ->
Result
end.
Expand Down Expand Up @@ -911,7 +931,8 @@ include_ast(File, ArgList, Scopes, #treewalker{ context=Context }=TreeWalker) ->

{{BodyAst, merge_info(BodyInfo, ArgInfo)},
reset_parse_trail(C#dtl_context.parse_trail, TreeWalker2)};
{error, Reason} -> throw(Reason)
{error, Reason} ->
empty_ast(?ERR(Reason, TreeWalker))
end.

%% include at run-time
Expand Down Expand Up @@ -1000,29 +1021,32 @@ filter_ast_noescape(Variable, Filter, TreeWalker) ->
{{VarValue, Info2}, TreeWalker3} = filter_ast1(Filter, ValueAst, TreeWalker2),
{{VarValue, merge_info(Info1, Info2)}, TreeWalker3}.

filter_ast1({{identifier, _, Name}, Args}, ValueAst, TreeWalker) ->
{{ArgsAst, ArgsInfo}, TreeWalker2} =
filter_ast1({{identifier, Pos, Name}, Args}, ValueAst, TreeWalker) ->
{{ArgsAst, ArgsInfo}, TreeWalker1} =
lists:foldr(
fun (Arg, {{AccAst, AccInfo}, AccTreeWalker}) ->
{{ArgAst, ArgInfo}, ArgTreeWalker} = value_ast(Arg, false, false, AccTreeWalker),
{{[ArgAst|AccAst], merge_info(ArgInfo, AccInfo)}, ArgTreeWalker}
end,
{{[], #ast_info{}}, TreeWalker},
Args),
FilterAst = filter_ast2(Name, [ValueAst|ArgsAst], TreeWalker2#treewalker.context),
{{FilterAst, ArgsInfo}, TreeWalker2}.
case filter_ast2(Name, [ValueAst|ArgsAst], TreeWalker1#treewalker.context) of
{ok, FilterAst} ->
{{FilterAst, ArgsInfo}, TreeWalker1};
Error ->
empty_ast(?WARN({Pos, Error}, TreeWalker1))
end.

filter_ast2(Name, Args, #dtl_context{ filters = Filters }) ->
case proplists:get_value(Name, Filters) of
{Mod, Fun}=Filter ->
case erlang:function_exported(Mod, Fun, length(Args)) of
true -> ?Q("'@Mod@':'@Fun@'(_@Args)");
true -> {ok, ?Q("'@Mod@':'@Fun@'(_@Args)")};
false ->
throw({filter_args, Name, Filter, Args})
{filter_args, Name, Filter, length(Args)}
end;
undefined ->
%% TODO: when we don't throw errors, this could be a warning..
throw({unknown_filter, Name, length(Args)})
{unknown_filter, Name, length(Args)}
end.

search_for_escape_filter(Variable, Filter, #dtl_context{auto_escape = on}) ->
Expand Down Expand Up @@ -1319,6 +1343,20 @@ spaceless_ast(Contents, TreeWalker) ->
{{Ast, Info}, TreeWalker1} = body_ast(Contents, TreeWalker),
{{?Q("erlydtl_runtime:spaceless(_@Ast)"), Info}, TreeWalker1}.

load_libs_ast(Libs, TreeWalker) ->
TreeWalker1 = lists:foldl(
fun ({identifier, Pos, Lib}, TW) ->
load_library(Pos, Lib, TW)
end,
TreeWalker, Libs),
empty_ast(TreeWalker1).

load_from_lib_ast(What, {identifier, Pos, Lib}, TreeWalker) ->
Names = lists:foldl(
fun ({identifier, _, Name}, Acc) -> [Name|Acc] end,
[], What),
empty_ast(load_library(Pos, Lib, Names, TreeWalker)).


%%-------------------------------------------------------------------
%% Custom tags
Expand All @@ -1341,33 +1379,38 @@ interpret_args(Args, TreeWalker) ->

tag_ast(Name, Args, TreeWalker) ->
{{InterpretedArgs, AstInfo1}, TreeWalker1} = interpret_args(Args, TreeWalker),
{RenderAst, RenderInfo} = custom_tags_modules_ast(Name, InterpretedArgs, TreeWalker#treewalker.context),
{{RenderAst, merge_info(AstInfo1, RenderInfo)}, TreeWalker1}.

custom_tags_modules_ast(Name, InterpretedArgs,
#dtl_context{
tags = Tags,
module = Module,
is_compiling_dir=IsCompilingDir }) ->
{{RenderAst, RenderInfo}, TreeWalker2} = custom_tags_modules_ast(Name, InterpretedArgs, TreeWalker1),
{{RenderAst, merge_info(AstInfo1, RenderInfo)}, TreeWalker2}.

custom_tags_modules_ast({identifier, Pos, Name}, InterpretedArgs,
#treewalker{
context=#dtl_context{
tags = Tags,
module = Module,
is_compiling_dir=IsCompilingDir
}
}=TreeWalker) ->
case proplists:get_value(Name, Tags) of
{Mod, Fun}=Tag ->
case lists:max([0] ++ [I || {N,I} <- Mod:module_info(exports), N =:= Fun]) of
case lists:max([-1] ++ [I || {N,I} <- Mod:module_info(exports), N =:= Fun]) of
2 ->
{?Q("'@Mod@':'@Fun@'([_@InterpretedArgs], RenderOptions)"), #ast_info{}};
{{?Q("'@Mod@':'@Fun@'([_@InterpretedArgs], RenderOptions)"),
#ast_info{}}, TreeWalker};
1 ->
{?Q("'@Mod@':'@Fun@'([_@InterpretedArgs])"), #ast_info{}};
0 ->
throw({custom_tag_not_exported, Name, Tag});
{{?Q("'@Mod@':'@Fun@'([_@InterpretedArgs])"),
#ast_info{}}, TreeWalker};
-1 ->
empty_ast(?WARN({Pos, {missing_tag, Name, Tag}}, TreeWalker));
I ->
throw({unsupported_custom_tag_fun, {Module, Name, I}})
empty_ast(?WARN({Pos, {bad_tag, Name, Tag, I}}, TreeWalker))
end;
undefined ->
if IsCompilingDir ->
{?Q("'@Module@':'@Name@'([_@InterpretedArgs], RenderOptions)"),
#ast_info{ custom_tags = [Name] }};
{{?Q("'@Module@':'@Name@'([_@InterpretedArgs], RenderOptions)"),
#ast_info{ custom_tags = [Name] }}, TreeWalker};
true ->
{?Q("render_tag(_@Name@, [_@InterpretedArgs], RenderOptions)"),
#ast_info{ custom_tags = [Name] }}
{{?Q("render_tag(_@Name@, [_@InterpretedArgs], RenderOptions)"),
#ast_info{ custom_tags = [Name] }}, TreeWalker}
end
end.

Expand Down
5 changes: 3 additions & 2 deletions src/erlydtl_compiler.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ format_error({read_file, File, Error}) ->
io_lib:format(
"Failed to include file ~s: ~s",
[File, file:format_error(Error)]);
format_error(Other) ->
io_lib:format("## Error description for ~p not implemented.", [Other]).
format_error(Error) ->
erlydtl_compiler_utils:format_error(Error).



%%====================================================================
Expand Down
65 changes: 53 additions & 12 deletions src/erlydtl_compiler_utils.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@
get_current_file/1,
init_treewalker/1,
load_library/2,
load_library/3,
load_library/4,
merge_info/2,
print/3,
to_string/2,
Expand Down Expand Up @@ -105,6 +107,8 @@ get_current_file(#treewalker{ context=Context }) ->
get_current_file(#dtl_context{ parse_trail=[File|_] }) -> File;
get_current_file(#dtl_context{ doc_root=Root }) -> Root.

add_error(Module, Error, #treewalker{ context=Context }=TreeWalker) ->
TreeWalker#treewalker{ context=add_error(Module, Error, Context) };
add_error(Module, Error, #dtl_context{
errors=#error_info{ report=Report, list=Es }=Ei
}=Context) ->
Expand All @@ -116,11 +120,15 @@ add_error(Module, Error, #dtl_context{
errors=Ei#error_info{ list=[Item|Es] }
}.

add_errors(Errors, #treewalker{ context=Context }=TreeWalker) ->
TreeWalker#treewalker{ context=add_errors(Errors, Context) };
add_errors(Errors, Context) ->
lists:foldl(
fun (E, C) -> add_error(?MODULE, E, C) end,
Context, Errors).

add_warning(Module, Warning, #treewalker{ context=Context }=TreeWalker) ->
TreeWalker#treewalker{ context=add_warning(Module, Warning, Context) };
add_warning(Module, Warning, #dtl_context{ warnings=warnings_as_errors }=Context) ->
add_error(Module, Warning, Context);
add_warning(Module, Warning, #dtl_context{
Expand All @@ -134,6 +142,8 @@ add_warning(Module, Warning, #dtl_context{
warnings=Wi#error_info{ list=[Item|Ws] }
}.

add_warnings(Warnings, #treewalker{ context=Context }=TreeWalker) ->
TreeWalker#treewalker{ context=add_warnings(Warnings, Context) };
add_warnings(Warnings, Context) ->
lists:foldl(
fun (W, C) -> add_warning(?MODULE, W, C) end,
Expand Down Expand Up @@ -227,24 +237,39 @@ reset_parse_trail(ParseTrail, #treewalker{ context=Context }=TreeWalker) ->
reset_parse_trail(ParseTrail, Context) ->
Context#dtl_context{ parse_trail=ParseTrail }.

load_library(Lib, #treewalker{ context=Context }=TreeWalker) ->
TreeWalker#treewalker{ context=load_library(Lib, Context) };
load_library(Lib, Context) ->
Mod = lib_module(Lib, Context),
add_filters(
[{Name, lib_function(Mod, Filter)}
|| {Name, Filter} <- Mod:inventory(filters)],
add_tags(
[{Name, lib_function(Mod, Tag)}
|| {Name, Tag} <- Mod:inventory(tags)],
Context)).
load_library(Lib, Context) -> load_library(none, Lib, [], Context).
load_library(Pos, Lib, Context) -> load_library(Pos, Lib, [], Context).

load_library(Pos, Lib, Accept, #treewalker{ context=Context }=TreeWalker) ->
TreeWalker#treewalker{ context=load_library(Pos, Lib, Accept, Context) };
load_library(Pos, Lib, Accept, Context) ->
case lib_module(Lib, Context) of
{ok, Mod} ->
add_filters(
[{Name, lib_function(Mod, Filter)}
|| {Name, Filter} <- Mod:inventory(filters),
Accept =:= [] orelse lists:member(Name, Accept)
],
add_tags(
[{Name, lib_function(Mod, Tag)}
|| {Name, Tag} <- Mod:inventory(tags),
Accept =:= [] orelse lists:member(Name, Accept)
],
Context));
Error ->
?WARN({Pos, Error}, Context)
end.

add_filters(Load, #dtl_context{ filters=Filters }=Context) ->
Context#dtl_context{ filters=Load ++ Filters }.

add_tags(Load, #dtl_context{ tags=Tags }=Context) ->
Context#dtl_context{ tags=Load ++ Tags }.

format_error({load_library, Name, Mod, Reason}) ->
io_lib:format("Failed to load library '~s' from '~s' (~s)", [Name, Mod, Reason]);
format_error({unknown_extension, Tag}) ->
io_lib:format("Unhandled extension: ~p", [Tag]);
format_error(Other) ->
io_lib:format("## Error description for ~p not implemented.", [Other]).

Expand Down Expand Up @@ -290,6 +315,9 @@ get_error_item(Report, Prefix, File, Error, DefaultModule) ->
ErrorItem
end.

compose_error_desc({{Line, Col}=Pos, ErrorDesc}, Module)
when is_integer(Line), is_integer(Col), is_atom(Module) ->
{Pos, Module, ErrorDesc};
compose_error_desc({Line, ErrorDesc}, Module)
when is_integer(Line) ->
{Line, Module, ErrorDesc};
Expand Down Expand Up @@ -378,7 +406,20 @@ split_ast(Split, [Ast|Rest], Acc) ->
split_ast(Split, Rest, [Ast|Acc]).

lib_module(Name, #dtl_context{ libraries=Libs }) ->
proplists:get_value(Name, Libs, Name).
Mod = proplists:get_value(Name, Libs, Name),
case code:ensure_loaded(Mod) of
{module, Mod} ->
IsLib = case proplists:get_value(behaviour, Mod:module_info(attributes)) of
Behaviours when is_list(Behaviours) ->
lists:member(erlydtl_library, Behaviours);
_ -> false
end,
if IsLib -> {ok, Mod};
true -> {load_library, Name, Mod, "not a library"}
end;
{error, Reason} ->
{load_library, Name, Mod, Reason}
end.

lib_function(_, {Mod, Fun}) ->
lib_function(Mod, Fun);
Expand Down
Loading

0 comments on commit c7b2883

Please sign in to comment.