-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Quote source as part of error messages
Can be suppressed with the 'brief' compiler option. Moves message formatting code to a separate module.
- Loading branch information
Showing
5 changed files
with
235 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,214 @@ | ||
| %% | ||
| %% %CopyrightBegin% | ||
| %% | ||
| %% Copyright Ericsson AB 1996-2018. All Rights Reserved. | ||
| %% Copyright 2020 Facebook, Inc. and its affiliates. | ||
| %% | ||
| %% Licensed under the Apache License, Version 2.0 (the "License"); | ||
| %% you may not use this file except in compliance with the License. | ||
| %% You may obtain a copy of the License at | ||
| %% | ||
| %% http://www.apache.org/licenses/LICENSE-2.0 | ||
| %% | ||
| %% Unless required by applicable law or agreed to in writing, software | ||
| %% distributed under the License is distributed on an "AS IS" BASIS, | ||
| %% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| %% See the License for the specific language governing permissions and | ||
| %% limitations under the License. | ||
| %% | ||
| %% %CopyrightEnd% | ||
|
|
||
| -module(compile_messages). | ||
|
|
||
| -export([format_messages/4, list_errors/3]). | ||
|
|
||
| -type pos() :: integer() | {integer(), integer()}. | ||
| -type err_warn_info() :: tuple(). | ||
| -type message() :: {Where :: none | {File::string(), pos()}, Text :: iolist()}. | ||
|
|
||
| -spec format_messages(File::string(), Prefix::string(), [err_warn_info()], | ||
| Opts::[term()]) -> [message()]. | ||
|
|
||
| format_messages(F, P, [{none, Mod, E} | Es], Opts) -> | ||
| M = {none, io_lib:format("~ts: ~s~ts\n", [F, P, Mod:format_error(E)])}, | ||
| [M | format_messages(F, P, Es, Opts)]; | ||
| format_messages(F, P, [{Loc, Mod, E} | Es], Opts) -> | ||
| StartLoc = erl_anno:location(Loc), | ||
| EndLoc = | ||
| case erl_anno:end_location(Loc) of | ||
| undefined -> StartLoc; | ||
| Loc2 -> Loc2 | ||
| end, | ||
| Src = quote_source(F, StartLoc, EndLoc, Opts), | ||
| Msg = io_lib:format("~ts:~ts: ~s~ts\n~ts", [ | ||
| F, | ||
| fmt_pos(StartLoc), | ||
| P, | ||
| Mod:format_error(E), | ||
| Src | ||
| ]), | ||
| Pos = | ||
| if | ||
| is_integer(StartLoc) -> {StartLoc, 0}; | ||
| true -> StartLoc | ||
| end, | ||
| [{{F, Pos}, Msg} | format_messages(F, P, Es, Opts)]; | ||
| format_messages(_, _, [], _Opts) -> | ||
| []. | ||
|
|
||
| -spec list_errors(File::string(), [err_warn_info()], Opts::[term()]) -> ok. | ||
|
|
||
| list_errors(F, [{none, Mod, E} | Es], Opts) -> | ||
| io:fwrite("~ts: ~ts\n", [F, Mod:format_error(E)]), | ||
| list_errors(F, Es, Opts); | ||
| list_errors(F, [{{{_, _} = StartLoc, {_, _} = EndLoc}, Mod, E} | Es], Opts) -> | ||
| %% this is the location format used in the type analysis pass | ||
| Src = quote_source(F, StartLoc, EndLoc, Opts), | ||
| io:fwrite("~ts:~ts: ~ts\n~ts", [F, fmt_pos(StartLoc), Mod:format_error(E), Src]), | ||
| list_errors(F, Es, Opts); | ||
| list_errors(F, [{Loc, Mod, E} | Es], Opts) -> | ||
| StartLoc = erl_anno:location(Loc), | ||
| EndLoc = | ||
| case erl_anno:end_location(Loc) of | ||
| undefined -> StartLoc; | ||
| Loc2 -> Loc2 | ||
| end, | ||
| list_errors(F, [{{StartLoc, EndLoc}, Mod, E} | Es], Opts); | ||
| list_errors(_F, [], _Opts) -> | ||
| ok. | ||
|
|
||
| fmt_pos({Line, Col}) -> | ||
| io_lib:format("~w:~w", [Line, Col]); | ||
| fmt_pos(Line) -> | ||
| io_lib:format("~w", [Line]). | ||
|
|
||
| quote_source(File, StartLoc, EndLoc, Opts) -> | ||
| case proplists:get_bool(brief, Opts) of | ||
| true -> ""; | ||
| false -> quote_source_1(File, StartLoc, EndLoc) | ||
| end. | ||
|
|
||
| quote_source_1(File, Line, Loc2) when is_integer(Line) -> | ||
| quote_source_1(File, {Line, 1}, Loc2); | ||
| quote_source_1(File, Loc1, Line) when is_integer(Line) -> | ||
| quote_source_1(File, Loc1, {Line, -1}); | ||
| quote_source_1(File, {StartLine, StartCol}, {EndLine, EndCol}) -> | ||
| case file:read_file(File) of | ||
| {ok, Bin} -> | ||
| Ctx = | ||
| if | ||
| StartLine =:= EndLine -> 0; | ||
| true -> 1 | ||
| end, | ||
| case seek_line(Bin, 1, StartLine - Ctx) of | ||
| {ok, Bin1} -> | ||
| quote_source_2(Bin1, StartLine, StartCol, EndLine, EndCol, Ctx); | ||
| error -> | ||
| "" | ||
| end; | ||
| {error, _} -> | ||
| "" | ||
| end. | ||
|
|
||
| quote_source_2(Bin, StartLine, StartCol, EndLine, EndCol, Ctx) -> | ||
| case take_lines(Bin, StartLine - Ctx, EndLine + Ctx) of | ||
| [] -> | ||
| ""; | ||
| Lines -> | ||
| Lines1 = | ||
| case length(Lines) =< (4 + Ctx) of | ||
| true -> | ||
| Lines; | ||
| false -> | ||
| %% before = context + start line + following line | ||
| %% after = end line + context | ||
| %% (total lines: 3 + 1 + context) | ||
| Before = lists:sublist(Lines, 2 + Ctx), | ||
| After = lists:reverse( | ||
| lists:sublist(lists:reverse(Lines), 1 + Ctx) | ||
| ), | ||
| Before ++ [{0, "..."}] ++ After | ||
| end, | ||
| Lines2 = decorate(Lines1, StartLine, StartCol, EndLine, EndCol), | ||
| [[fmt_line(L, Text) || {L, Text} <- Lines2], $\n] | ||
| end. | ||
|
|
||
| line_prefix() -> | ||
| "% ". | ||
|
|
||
| fmt_line(L, Text) -> | ||
| io_lib:format("~ts~4.ts| ~ts\n", [line_prefix(), line_to_txt(L), Text]). | ||
|
|
||
| line_to_txt(0) -> ""; | ||
| line_to_txt(L) -> integer_to_list(L). | ||
|
|
||
| decorate([{Line, Text} = L | Ls], StartLine, StartCol, EndLine, EndCol) when | ||
| Line =:= StartLine, EndLine =:= StartLine | ||
| -> | ||
| %% start and end on same line | ||
| S = underline(Text, StartCol, EndCol), | ||
| decorate(S, L, Ls, StartLine, StartCol, EndLine, EndCol); | ||
| decorate([{Line, Text} = L | Ls], StartLine, StartCol, EndLine, EndCol) when Line =:= StartLine -> | ||
| %% start with end on separate line | ||
| S = underline(Text, StartCol, string:length(Text) + 1), | ||
| decorate(S, L, Ls, StartLine, StartCol, EndLine, EndCol); | ||
| %% decorate([{Line, Text}=L|Ls], StartLine, StartCol, EndLine, EndCol) | ||
| %% when Line =:= EndLine -> | ||
| %% S = underline(Text, EndCol,EndCol), % just mark end | ||
| %% decorate(S, L, Ls, StartLine, StartCol, EndLine, EndCol); | ||
| decorate([{_Line, _Text} = L | Ls], StartLine, StartCol, EndLine, EndCol) -> | ||
| [L | decorate(Ls, StartLine, StartCol, EndLine, EndCol)]; | ||
| decorate([], _StartLine, _StartCol, _EndLine, _EndCol) -> | ||
| []. | ||
|
|
||
| %% don't produce empty decoration lines | ||
| decorate("", L, Ls, StartLine, StartCol, EndLine, EndCol) -> | ||
| [L | decorate(Ls, StartLine, StartCol, EndLine, EndCol)]; | ||
| decorate(Text, L, Ls, StartLine, StartCol, EndLine, EndCol) -> | ||
| [L, {0, Text} | decorate(Ls, StartLine, StartCol, EndLine, EndCol)]. | ||
|
|
||
| %% End typically points to the first position after the actual region. | ||
| %% If End = Start, we adjust it to Start+1 to mark at least one character | ||
| %% TODO: colorization option | ||
| underline(_Text, Start, End) when End < Start -> | ||
| % no underlining at all if end column is unknown | ||
| ""; | ||
| underline(Text, Start, Start) -> | ||
| underline(Text, Start, Start + 1); | ||
| underline(Text, Start, End) -> | ||
| underline(Text, Start, End, 1). | ||
|
|
||
| underline(<<$\t, Text/binary>>, Start, End, N) when N < Start -> | ||
| [$\t | underline(Text, Start, End, N + 1)]; | ||
| underline(<<_, Text/binary>>, Start, End, N) when N < Start -> | ||
| [$\s | underline(Text, Start, End, N + 1)]; | ||
| underline(_Text, _Start, End, N) -> | ||
| underline_1(N, End). | ||
|
|
||
| underline_1(N, End) when N < End -> | ||
| [$^ | underline_1(N + 1, End)]; | ||
| underline_1(_N, _End) -> | ||
| "". | ||
|
|
||
| seek_line(Bin, L, L) -> {ok, Bin}; | ||
| seek_line(<<$\n, Rest/binary>>, N, L) -> seek_line(Rest, N + 1, L); | ||
| seek_line(<<$\r, $\n, Rest/binary>>, N, L) -> seek_line(Rest, N + 1, L); | ||
| seek_line(<<_, Rest/binary>>, N, L) -> seek_line(Rest, N, L); | ||
| seek_line(<<>>, _, _) -> error. | ||
|
|
||
| take_lines(<<>>, _Here, _To) -> | ||
| []; | ||
| take_lines(Bin, Here, To) when Here =< To -> | ||
| {Line, Rest} = take_line(Bin, <<>>), | ||
| [{Here, Line} | take_lines(Rest, Here + 1, To)]; | ||
| take_lines(_Bin, _Here, _To) -> | ||
| []. | ||
|
|
||
| take_line(<<$\n, Rest/binary>>, Ack) -> | ||
| {Ack, Rest}; | ||
| take_line(<<$\r, $\n, Rest/binary>>, Ack) -> | ||
| {Ack, Rest}; | ||
| take_line(<<B, Rest/binary>>, Ack) -> | ||
| take_line(Rest, <<Ack/binary, B>>); | ||
| take_line(<<>>, Ack) -> | ||
| {Ack, <<>>}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters