Print file and line in diagnostics

Author: c42f

src/diagnostics.jl

@@ -42,12 +42,26 @@ last_byte(d::Diagnostic)  = d.last_byte
 is_error(d::Diagnostic)   = d.level == :error
 
 function show_diagnostic(io::IO, diagnostic::Diagnostic, source::SourceFile)
-    col,prefix = diagnostic.level == :error   ? (:light_red, "Error")      :
-                 diagnostic.level == :warning ? (:light_yellow, "Warning") :
-                 diagnostic.level == :note    ? (:light_blue, "Note")      :
-                 (:normal, "Info")
-    printstyled(io, "$prefix: ", color=col)
-    print(io, diagnostic.message, ":\n")
+    color,prefix = diagnostic.level == :error   ? (:light_red, "Error")      :
+                   diagnostic.level == :warning ? (:light_yellow, "Warning") :
+                   diagnostic.level == :note    ? (:light_blue, "Note")      :
+                   (:normal, "Info")
+    line, col = source_location(source, first_byte(diagnostic))
+    linecol = "$line:$col"
+    if !isnothing(source.filename)
+        locstr = "$(source.filename):$linecol"
+        if get(io, :color, false)
+            # Also add hyperlinks in color terminals
+            url = "file://$(abspath(source.filename))#$linecol"
+            locstr = "\e]8;;$url\e\\$locstr\e]8;;\e\\"
+        end
+    else
+        locstr = "line $locstr"
+    end
+    print(io, prefix, ": ")
+    printstyled(io, diagnostic.message, color=color)
+    printstyled(io, "\n", "@ $locstr", color=:light_black)
+    print(io, "\n")
 
     p = first_byte(diagnostic)
     q = last_byte(diagnostic)
@@ -66,6 +80,8 @@ function show_diagnostic(io::IO, diagnostic::Diagnostic, source::SourceFile)
 
     hicol = (100,40,40)
 
+    # TODO: show line numbers on left
+
     print(io, source[a:prevind(text, p)])
     # There's two situations, either
     if b >= c

src/parser_api.jl

@@ -47,10 +47,12 @@ struct ParseError <: Exception
 end
 
 function Base.showerror(io::IO, err::ParseError, bt; backtrace=false)
+    println(io, "ParseError:")
     show_diagnostics(io, err.diagnostics, err.source)
 end
 
 function Base.showerror(io::IO, err::ParseError)
+    println(io, "ParseError:")
     show_diagnostics(io, err.diagnostics, err.source)
 end
 
@@ -142,7 +144,7 @@ See [`parse`](@ref) for a more complete and powerful interface to the parser,
 as well as a description of the `version` and `rule` keywords.
 """
 function parseall(::Type{T}, input...; rule=:toplevel, version=VERSION,
-                  ignore_trivia=true, kws...) where {T}
+                  ignore_trivia=true, filename=nothing) where {T}
     stream = ParseStream(input...; version=version)
     if ignore_trivia && rule != :toplevel
         bump_trivia(stream, skip_newlines=true)
@@ -154,20 +156,20 @@ function parseall(::Type{T}, input...; rule=:toplevel, version=VERSION,
         emit_diagnostic(stream, error="unexpected text after parsing $rule")
     end
     if any_error(stream.diagnostics)
-        source = SourceFile(sourcetext(stream, steal_textbuf=true))
+        source = SourceFile(sourcetext(stream, steal_textbuf=true), filename=filename)
         throw(ParseError(source, stream.diagnostics))
     end
     # TODO: Figure out a more satisfying solution to the wrap_toplevel_as_kind
     # mess that we've got here.
     # * It's kind of required for GreenNode, as GreenNode only records spans,
     #   not absolute positions.
     # * Dropping it would be ok for SyntaxNode and Expr...
-    tree = build_tree(T, stream; wrap_toplevel_as_kind=K"toplevel", kws...)
+    tree = build_tree(T, stream; wrap_toplevel_as_kind=K"toplevel", filename=filename)
     if !isempty(stream.diagnostics)
         # Crudely format any warnings to the current logger.
         buf = IOBuffer()
         show_diagnostics(IOContext(buf, stdout), stream,
-                         SourceFile(sourcetext(stream, steal_textbuf=true)))
+                         SourceFile(sourcetext(stream, steal_textbuf=true), filename=filename))
         @warn Text(String(take!(buf)))
     end
     tree

src/syntax_tree.jl

@@ -423,7 +423,7 @@ Base.Expr(node::SyntaxNode) = _to_expr(node)
 
 #-------------------------------------------------------------------------------
 
-function build_tree(::Type{SyntaxNode}, stream::ParseStream; filename="none", kws...)
+function build_tree(::Type{SyntaxNode}, stream::ParseStream; filename=nothing, kws...)
     green_tree = build_tree(GreenNode, stream; kws...)
     source = SourceFile(sourcetext(stream), filename=filename)
     SyntaxNode(source, green_tree, first_byte(stream))

src/utils.jl

@@ -26,11 +26,16 @@ function flisp_parse_all(code; filename="none")
 end
 
 # Really remove line numbers, even from Expr(:toplevel)
-function remove_linenums!(ex)
-    ex = Base.remove_linenums!(ex)
-    if Meta.isexpr(ex, :toplevel)
-        filter!(x->!(x isa LineNumberNode), ex.args)
+remove_linenums!(ex) = ex
+function remove_linenums!(ex::Expr)
+    if ex.head === :block || ex.head === :quote || ex.head === :toplevel
+        filter!(ex.args) do x
+            !(isa(x, Expr) && x.head === :line || isa(x, LineNumberNode))
+        end
     end
-    ex
+    for subex in ex.args
+        subex isa Expr && remove_linenums!(subex)
+    end
+    return ex
 end
 

test/syntax_tree.jl

@@ -15,7 +15,7 @@
             Expr(:(=),
                  Expr(:call, :f),
                  Expr(:block,
-                      LineNumberNode(1, :none),
+                      LineNumberNode(1),
                       :xs))
         # flisp parser quirk: In a for loop the block is not added, despite
         # this defining a short-form function.

test/test_utils.jl

@@ -40,8 +40,8 @@ end
 
 function parsers_agree_on_file(path)
     text = read(path, String)
-    ex = parseall(Expr, text)
-    fl_ex = flisp_parse_all(text)
+    ex = parseall(Expr, text, filename=path)
+    fl_ex = flisp_parse_all(text, filename=path)
     JuliaSyntax.remove_linenums!(ex) == JuliaSyntax.remove_linenums!(fl_ex)
 end