Files
mercury/mfilterjavac/mfilterjavac.m
2025-09-01 02:22:47 +02:00

336 lines
11 KiB
Mathematica

%----------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%----------------------------------------------------------------------------%
% Copyright (C) 2013 The University of Melbourne.
% Copyright (C) 2015-2016, 2023-2025 The Mercury team.
% This file may only be copied under the terms of the GNU General
% Public License - see the file COPYING in the Mercury distribution.
%----------------------------------------------------------------------------%
%
% File: mfilterjavac.m
% Author: pbone
%
% This program processes the output of the Java compiler when compiling Java
% code generated by the Mercury compiler. It translates the error contexts
% reported by the Java compiler into the corresponding error contexts in the
% Mercury source file. This is done by looking for special comments inserted
% into the generated Java code by the Mercury compiler.
% (See compiler/mlds_to_java_util.m for details.)
%
%-----------------------------------------------------------------------------%
:- module mfilterjavac.
:- interface.
:- import_module io.
%-----------------------------------------------------------------------------%
:- pred main(io::di, io::uo) is det.
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
:- implementation.
:- import_module char.
:- import_module int.
:- import_module list.
:- import_module map.
:- import_module maybe.
:- import_module string.
%-----------------------------------------------------------------------------%
main(!IO) :-
io.input_stream(InStream, !IO),
io.output_stream(OutStream, !IO),
filter_lines(InStream, OutStream, Result, map.init, !IO),
(
Result = ok
;
Result = error(Error),
io.write_string(io.stderr_stream, "Error: " ++ Error, !IO),
io.set_exit_status(1, !IO)
;
Result = warning(Error),
io.write_string(io.stderr_stream, "Warning: " ++ Error, !IO)
% The exit status is unchanged
).
:- type filter_result
---> ok
; error(string)
; warning(string).
:- pred filter_lines(io.text_input_stream::in, io.text_output_stream::in,
filter_result::out, line_info_cache::in, io::di, io::uo) is det.
filter_lines(InStream, OutStream, Result, !.Cache, !IO) :-
io.read_line_as_string(InStream, LineReadResult, !IO),
(
LineReadResult = ok(Line0),
filter_line(LineResult, Line0, Line, !Cache, !IO),
io.write_string(OutStream, Line, !IO),
filter_lines(InStream, OutStream, ResultLines, !.Cache, !IO),
(
LineResult = ok,
Result = ResultLines
;
LineResult = error(Error),
(
( ResultLines = ok
; ResultLines = warning(_)
),
% We use our warning even if later on a warning is
% generated, ours was first.
Result = warning(Error)
;
ResultLines = error(ErrorLines),
Result = error(ErrorLines)
)
)
;
LineReadResult = eof,
Result = ok
;
LineReadResult = error(Error),
string.format("stdin: %s\n", [s(io.error_message(Error))], ErrorStr),
Result = error(ErrorStr)
).
:- pred filter_line(maybe_error::out, string::in, string::out,
line_info_cache::in, line_info_cache::out, io::di, io::uo) is det.
filter_line(Result, !Line, !Cache, !IO) :-
( if
PartsA = split_at_separator(char.is_whitespace, !.Line),
PartsA = [PartAA | OtherPartsA],
PartsAA = split_at_char(':', PartAA),
PartsAA = [Filename, LineStr, Empty],
string.to_int(LineStr, LineNo),
Empty = ""
then
( if map.search(!.Cache, Filename, MaybeLineInfo) then
(
MaybeLineInfo = yes(LineInfo),
translate_and_output_line(LineInfo, Filename, LineNo,
OtherPartsA, !:Line),
Result = ok
;
MaybeLineInfo = no,
% We raised this error on a previous iteration where
% map.search failed.
Result = ok
)
else
maybe_get_line_info(Filename, MaybeLineInfoErr, !IO),
(
MaybeLineInfoErr = ok(LineInfo),
map.det_insert(Filename, yes(LineInfo), !Cache),
translate_and_output_line(LineInfo, Filename, LineNo,
OtherPartsA, !:Line),
Result = ok
;
MaybeLineInfoErr = error(Error),
map.det_insert(Filename, no, !Cache),
Result = error(Error)
)
)
else
Result = ok
).
:- pred translate_and_output_line(list(line_info)::in, string::in, int::in,
list(string)::in, string::out) is det.
translate_and_output_line(LineInfo, Filename, LineNo, RestParts, OutLine) :-
line_info_translate(LineInfo, Filename, LineNo, MerFileName, MerLineNo),
Rest = string.join_list(" ", RestParts),
string.format("%s:%d: %s\n", [s(MerFileName), i(MerLineNo), s(Rest)],
OutLine).
%-----------------------------------------------------------------------------%
:- type line_info
---> line_info(
li_start :: int, % inclusive
li_end :: int, % not inclusive
li_delta :: int,
li_orig_file :: string
).
:- type line_info_error
---> line_info_error(
li_filename :: string,
li_lineno :: int,
li_error :: line_info_error_type
).
:- type line_info_error_type
---> lie_end_without_beginning
; lie_beginning_without_end
; lie_duplicate_beginning.
:- type line_info_cache == map(string, maybe(list(line_info))).
:- pred line_info_translate(list(line_info)::in, string::in, int::in,
string::out, int::out) is det.
line_info_translate([], Name, Line, Name, Line).
line_info_translate([Info | Infos], Name0, Line0, Name, Line) :-
Info = line_info(Start, End, Delta, File),
( if Line0 < Start then
% No translation.
Name = Name0,
Line = Line0
else if Line0 < End then
Line = Line0 + Delta,
Name = File
else
line_info_translate(Infos, Name0, Line0, Name, Line)
).
:- func error_type_string(line_info_error_type) = string.
error_type_string(lie_end_without_beginning) =
"END token without BEGIN token".
error_type_string(lie_beginning_without_end) =
"BEGIN token without END token".
error_type_string(lie_duplicate_beginning) =
"BEGIN token followed by another BEGIN token".
%----------------------------------------------------------------------------%
:- pred maybe_get_line_info(string::in, maybe_error(list(line_info))::out,
io::di, io::uo) is det.
maybe_get_line_info(Filename, MaybeInfo, !IO) :-
io.read_named_file_as_lines_wf(Filename, ReadResult, !IO),
(
ReadResult = ok(FileLines),
read_line_marks(FileLines, 1, [], MaybeRevMarks),
(
MaybeRevMarks = ok(RevMarks),
list.reverse(RevMarks, Marks),
create_line_info(Filename, Marks, [], MaybeInfo0),
(
MaybeInfo0 = ok(Infos),
MaybeInfo = ok(Infos)
;
MaybeInfo0 = error(LineInfoError),
LineInfoError = line_info_error(ErrFilename, ErrLine, Error),
string.format(
"%s:%d: Error understanding line number declaration: %s",
[s(ErrFilename), i(ErrLine), s(error_type_string(Error))],
StringError),
MaybeInfo = error(StringError)
)
;
MaybeRevMarks = error(Msg),
MaybeInfo = error(format("%s: %s", [s(Filename), s(Msg)]))
)
;
ReadResult = error(_Error),
% We ignore errors here as our parsing of javac's output could cause
% false errors.
MaybeInfo = ok([])
).
:- type line_mark
---> line_mark(
lm_type :: begin_or_end_block,
lm_mer_file :: string,
lm_java_line_no :: int,
lm_mer_line_no :: int
).
:- type begin_or_end_block
---> begin_block
; end_block.
:- pred read_line_marks(list(string)::in, int::in, list(line_mark)::in,
maybe_error(list(line_mark))::out) is det.
read_line_marks([], _, RevMarks0, ok(RevMarks0)).
read_line_marks([Line | Lines], JavaLineNo, RevMarks0, MaybeRevMarks) :-
% The format string in mlds_to_java_util.m specifically uses spaces
% rather than any other whitespace.
Parts = string.split_at_char(' ', strip(Line)),
( if
Parts = ["//", Marker, PathLine],
(
Marker = "MER_FOREIGN_BEGIN",
Type = begin_block
;
Marker = "MER_FOREIGN_END",
Type = end_block
),
PartsB = string.split_at_char(':', PathLine),
PartsB = [MerFile, MerLineNoStr],
string.to_int(MerLineNoStr, MerLineNo)
then
Mark = line_mark(Type, MerFile, JavaLineNo, MerLineNo),
RevMarks = [Mark | RevMarks0]
else
RevMarks = RevMarks0
),
read_line_marks(Lines, JavaLineNo + 1, RevMarks, MaybeRevMarks).
:- pred create_line_info(string::in, list(line_mark)::in, list(line_info)::in,
maybe_error(list(line_info), line_info_error)::out) is det.
create_line_info(_JavaFile, [], RevInfos, ok(Infos)) :-
list.reverse(RevInfos, Infos).
create_line_info(JavaFile, [Mark | Marks0], RevInfos0, MaybeInfos) :-
Mark = line_mark(Type, MerFile, JavaLineNo, MerLineNo),
(
Type = begin_block,
create_line_info_in_block(InfoEnd, Marks0, Marks),
(
InfoEnd = line_info_end(End),
Delta = MerLineNo - JavaLineNo,
Info = line_info(JavaLineNo, End, Delta, MerFile),
RevInfos = [Info | RevInfos0],
create_line_info(JavaFile, Marks, RevInfos, MaybeInfos)
;
InfoEnd = line_info_no_end,
Error = line_info_error(JavaFile, JavaLineNo,
lie_beginning_without_end),
MaybeInfos = error(Error)
;
InfoEnd = line_info_duplicate_begin(SecondBeginLine),
Error = line_info_error(JavaFile, SecondBeginLine,
lie_duplicate_beginning),
MaybeInfos = error(Error)
)
;
Type = end_block,
Error = line_info_error(JavaFile, JavaLineNo,
lie_end_without_beginning),
MaybeInfos = error(Error)
).
:- type line_info_end
---> line_info_end(int)
; line_info_no_end
; line_info_duplicate_begin(int).
:- pred create_line_info_in_block(line_info_end::out,
list(line_mark)::in, list(line_mark)::out) is det.
create_line_info_in_block(line_info_no_end, [], []).
create_line_info_in_block(Info, [Mark | Marks], Marks) :-
Mark = line_mark(Type, _, End, _),
(
Type = begin_block,
Info = line_info_duplicate_begin(End)
;
Type = end_block,
Info = line_info_end(End)
).
%-----------------------------------------------------------------------------%
:- end_module mfilterjavac.
%-----------------------------------------------------------------------------%