Skip to content

In the highlighter, add include/extends navigation points #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mworrell merged 3 commits into from
Mar 25, 2026
Merged

In the highlighter, add include/extends navigation points #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bca7b88
In the highlighter, add include/extends navigation points
mworrell Mar 25, 2026
bcc0e57
Cleanup, add attribute escapes, add test.
mworrell Mar 25, 2026
15e5766
Fix test
mworrell Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 63 additions & 8 deletions src/template_compiler_highlight.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,12 @@ highlight_binary(Bin, Filename, DebugPoints) when is_binary(Bin) ->
{ok, RawTokens} ->
SourceIndex = source_index(Bin),
Annotations = annotations(Bin, RawTokens, SourceIndex),
{ok, iolist_to_binary(render_document(Bin, SourceIndex, Annotations, debug_points_map(DebugPoints)))};
{ok, iolist_to_binary(render_document(
Bin,
SourceIndex,
Annotations,
debug_points_map(DebugPoints),
build_nav_events(RawTokens)))};
{error, _} = Error ->
Error
end.
Expand Down Expand Up @@ -262,15 +267,15 @@ split_annotation(#{start := Start, stop := Stop, kind := Kind}, #{lines := Lines
[],
lists:zip(Lines, Starts)).

render_document(Bin, SourceIndex, Annotations, DebugPointMap) ->
Events = build_events(Annotations, DebugPointMap, SourceIndex),
render_document(Bin, SourceIndex, Annotations, DebugPointMap, NavEvents) ->
Events = build_events(Annotations, DebugPointMap, NavEvents, SourceIndex),
[
<<"<pre class=\"template-compiler-highlight\" style=\"">>, ?STYLE_PRE, <<"\"><code>">>,
render_lines(Bin, SourceIndex, Events, 1),
<<"</code></pre>">>
].

build_events(Annotations, DebugPointMap, SourceIndex) ->
build_events(Annotations, DebugPointMap, NavEvents, SourceIndex) ->
{OpenMap, CloseMap} = lists:foldl(
fun(#{start := Start, stop := Stop, kind := Kind}, Acc) ->
{OpenAcc, CloseAcc} = Acc,
Expand All @@ -282,10 +287,12 @@ build_events(Annotations, DebugPointMap, SourceIndex) ->
{#{}, #{}},
Annotations),
DebugEvents = build_debug_events(DebugPointMap, SourceIndex),
NavEventMap = build_nav_event_map(NavEvents, SourceIndex),
#{
open => OpenMap,
close => CloseMap,
checkbox => DebugEvents
checkbox => DebugEvents,
nav => NavEventMap
}.

build_debug_events(DebugPointMap, SourceIndex) when is_map(DebugPointMap) ->
Expand All @@ -304,6 +311,43 @@ build_debug_events(DebugPointMap, SourceIndex) when is_map(DebugPointMap) ->
#{},
DebugPointMap).

build_nav_events(RawTokens) ->
build_nav_events(RawTokens, undefined, []).

build_nav_events([], _TagPos, Acc) ->
lists:reverse(Acc);
build_nav_events([{open_tag, SrcPos, _} | Rest], _TagPos, Acc) ->
build_nav_events(Rest, SrcPos, Acc);
build_nav_events([{optional_keyword, _SrcPos, _} | Rest], TagPos, Acc) ->
build_nav_events(Rest, TagPos, Acc);
build_nav_events([{all_keyword, _SrcPos, _} | Rest], TagPos, Acc) ->
build_nav_events(Rest, TagPos, Acc);
build_nav_events([{include_keyword, _SrcPos, _} | Rest], {_Filename, _Line, _Col} = TagPos, Acc) ->
build_nav_events(Rest, undefined, [ {include, TagPos} | Acc ]);
build_nav_events([{catinclude_keyword, _SrcPos, _} | Rest], {_Filename, _Line, _Col} = TagPos, Acc) ->
build_nav_events(Rest, undefined, [ {include, TagPos} | Acc ]);
build_nav_events([{extends_keyword, _SrcPos, _} | Rest], {_Filename, _Line, _Col} = TagPos, Acc) ->
build_nav_events(Rest, undefined, [ {extends, TagPos} | Acc ]);
build_nav_events([{overrules_keyword, _SrcPos, _} | Rest], {_Filename, _Line, _Col} = TagPos, Acc) ->
build_nav_events(Rest, undefined, [ {overrules, TagPos} | Acc ]);
build_nav_events([{close_tag, _SrcPos, _} | Rest], _TagPos, Acc) ->
build_nav_events(Rest, undefined, Acc);
build_nav_events([_ | Rest], TagPos, Acc) ->
build_nav_events(Rest, TagPos, Acc).

build_nav_event_map(NavEvents, SourceIndex) ->
lists:foldl(
fun({Type, SrcPos}, Acc) ->
case safe_srcpos_to_offset(SourceIndex, SrcPos) of
{ok, Offset} ->
map_prepend(Offset, nav_anchor(Type, SrcPos), Acc);
error ->
Acc
end
end,
#{},
NavEvents).

span_open(text) ->
span_open_style(?STYLE_TEXT);
span_open(delim) ->
Expand Down Expand Up @@ -341,6 +385,15 @@ debug_checkbox({Filename, Line, Col}) ->
<<"</label>">>
].

nav_anchor(Type, {_Filename, Line, Col}) ->
[
<<"<span class=\"template-compiler-nav-anchor\" data-template-nav-enabled=\"1\" data-template-nav=\"">>,
escape_attr(atom_to_binary(Type, utf8)),
<<"\" data-line=\"">>, integer_to_binary(Line),
<<"\" data-column=\"">>, integer_to_binary(Col),
<<"\"></span>">>
].

render_lines(_Bin, #{lines := [], starts := []}, _Events, _LineNo) ->
[];
render_lines(Bin, #{lines := [Line], starts := [Start]}, Events, LineNo) ->
Expand Down Expand Up @@ -370,18 +423,20 @@ render_segment(Line, Start, End, Cursor, [Pos | Rest], Events) ->
render_segment(Line, Start, End, Pos, Rest, Events)
].

emit_at(Pos, #{open := OpenMap, close := CloseMap, checkbox := CheckboxMap}) ->
emit_at(Pos, #{open := OpenMap, close := CloseMap, checkbox := CheckboxMap, nav := NavMap}) ->
[
lists:reverse(maps:get(Pos, CloseMap, [])),
lists:reverse(maps:get(Pos, NavMap, [])),
lists:reverse(maps:get(Pos, CheckboxMap, [])),
lists:reverse(maps:get(Pos, OpenMap, []))
].

relevant_positions(Start, End, #{open := OpenMap, close := CloseMap, checkbox := CheckboxMap}) ->
relevant_positions(Start, End, #{open := OpenMap, close := CloseMap, checkbox := CheckboxMap, nav := NavMap}) ->
lists:usort(
[ Pos || Pos <- maps:keys(OpenMap), Start =< Pos, Pos =< End ] ++
[ Pos || Pos <- maps:keys(CloseMap), Start =< Pos, Pos =< End ] ++
[ Pos || Pos <- maps:keys(CheckboxMap), Start =< Pos, Pos =< End ]).
[ Pos || Pos <- maps:keys(CheckboxMap), Start =< Pos, Pos =< End ] ++
[ Pos || Pos <- maps:keys(NavMap), Start =< Pos, Pos =< End ]).

map_prepend(Key, Value, Map) ->
Map#{ Key => [Value | maps:get(Key, Map, [])] }.
Expand Down
31 changes: 31 additions & 0 deletions test/template_compiler_highlight_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ groups() ->
,highlight_trans_tag_test
,highlight_unicode_trans_tag_test
,highlight_single_quote_include_test
,highlight_nav_anchor_include_test
,highlight_nav_anchor_extends_overrules_test
,highlight_escape_text_test
,highlight_escape_string_literal_test
,highlight_module_test
Expand Down Expand Up @@ -158,6 +160,35 @@ highlight_single_quote_include_test(_Config) ->
{_, _} = binary:match(Html, <<"%}">>),
ok.

highlight_nav_anchor_include_test(_Config) ->
Template = <<"{% include 'a.tpl' %}">>,
{ok, Html} = template_compiler:highlight_binary(Template, <<"nav_include.tpl">>),
{_, _} = binary:match(Html, <<"template-compiler-nav-anchor">>),
assert_in_order(Html, [
<<"data-template-nav=\"include\"">>,
<<"data-line=\"1\"">>,
<<"data-column=\"1\"">>,
<<"<span style=\"color:#0f766e;font-weight:600;\">include</span>">>
]),
{_, _} = binary:match(Html, <<"&#39;a.tpl&#39;">>),
ok.

highlight_nav_anchor_extends_overrules_test(_Config) ->
Template = <<"{% extends \"base.tpl\" %}\n{% overrules %}">>,
{ok, Html} = template_compiler:highlight_binary(Template, <<"nav_extends_overrules.tpl">>),
assert_in_order(Html, [
<<"data-template-nav=\"extends\"">>,
<<"data-line=\"1\"">>,
<<"data-column=\"1\"">>,
<<"extends">>,
<<"data-template-nav=\"overrules\"">>,
<<"data-line=\"2\"">>,
<<"data-column=\"1\"">>,
<<"overrules">>
]),
{_, _} = binary:match(Html, <<"&quot;base.tpl&quot;">>),
ok.

highlight_escape_text_test(_Config) ->
Template = <<"<script>alert(\"x\")</script>&'">>,
{ok, Html} = template_compiler:highlight_binary(Template, <<"escape_text.tpl">>),
Expand Down
Loading