add a toggle for showing lowered code and refactor printing a bit (#116)

* use kwdef

* add a toggle for lowered code and refactor printing a bit

Author: KristofferC

README.md

@@ -48,6 +48,7 @@ Basic Commands:
 - `o`: open the current line in an editor
 - `q`: quit the debugger, returning `nothing`
 - `C`: toggle compiled mode
+- `L`: toggle showing lowered code instead of source code
 
 Advanced commands:
 - `nc`: step to the next call

src/Debugger.jl

@@ -37,26 +37,27 @@ using .LineNumbers: SourceFile, compute_line
 # watch expressions between invocations of the debugger interface
 const WATCH_LIST = []
 
-mutable struct DebuggerState
+Base.@kwdef mutable struct DebuggerState
     frame::Union{Nothing, Frame}
-    level::Int
-    broke_on_error::Bool
-    watch_list::Vector
-    mode
-    repl
-    terminal
-    main_mode
-    julia_prompt::Ref{LineEdit.Prompt}
-    standard_keymap
-    overall_result
+    level::Int = 1
+    broke_on_error::Bool = false
+    watch_list::Vector = WATCH_LIST
+    lowered_status::Bool = false
+    mode = finish_and_return!
+    repl = nothing
+    terminal = nothing
+    main_mode = nothing
+    julia_prompt::Ref{LineEdit.Prompt} = Ref{LineEdit.Prompt}()
+    standard_keymap = nothing
+    overall_result = nothing
 end
-DebuggerState(stack, repl, terminal) = DebuggerState(stack, 1, false, WATCH_LIST, finish_and_return!, repl, terminal, nothing, Ref{LineEdit.Prompt}(), nothing, nothing)
-DebuggerState(stack, repl) = DebuggerState(stack, repl, nothing)
 
 function toggle_mode(state)
     state.mode = (state.mode === finish_and_return! ? (state.mode = Compiled()) : (state.mode = finish_and_return!))
 end
 
+toggle_lowered(state) = state.lowered_status = !state.lowered_status
+
 function active_frame(state)
     frame = state.frame
     for i in 1:(state.level - 1)

src/commands.jl

@@ -42,7 +42,9 @@ function execute_command(state::DebuggerState, ::Union{Val{:c},Val{:nc},Val{:n},
                 state.broke_on_error = true
             end
         end
-        JuliaInterpreter.maybe_next_call!(state.frame)
+        if pc_expr(state.frame) === nothing # happens when stopping for @bp
+            JuliaInterpreter.maybe_next_call!(state.frame)
+        end
         return true
     end
 end

src/printing.jl

@@ -91,25 +91,25 @@ function print_next_expr(io::IO, frame::Frame)
     println(io)
 end
 
-function breakpoint_linenumbers(frame::Frame)
+function breakpoint_linenumbers(frame::Frame; lowered=false)
     framecode = frame.framecode
     breakpoint_lines = Dict{Int, BreakpointState}()
     for stmtidx in 1:length(framecode.breakpoints)
         isassigned(framecode.breakpoints, stmtidx) || continue
         bp = framecode.breakpoints[stmtidx]
-        line = JuliaInterpreter.linenumber(frame, stmtidx)
+        line = lowered ? stmtidx : JuliaInterpreter.linenumber(frame, stmtidx)
         breakpoint_lines[line] = bp 
     end
     return breakpoint_lines
 end
 
-function print_status(io::IO, frame::Frame)
+function print_status(io::IO, frame::Frame; force_lowered=false)
     # Buffer to avoid flickering
     outbuf = IOContext(IOBuffer(), io)
     printstyled(outbuf, "In ", locdesc(frame), "\n")
     loc = locinfo(frame)
 
-    if loc !== nothing
+    if loc !== nothing && !force_lowered
         data = if isa(loc, BufferLocInfo)
                 loc.data
             else
@@ -124,6 +124,8 @@ function print_status(io::IO, frame::Frame)
     print(io, String(take!(outbuf.io)))
 end
 
+const NUM_SOURCE_LINES_UP_DOWN = Ref(5)
+
 function print_codeinfo(io::IO, frame::Frame)
     buf = IOBuffer()
     src = frame.framecode.src
@@ -133,27 +135,13 @@ function print_codeinfo(io::IO, frame::Frame)
     code = filter!(split(String(take!(buf)), '\n')) do line
         !(line == "CodeInfo(" || line == ")" || isempty(line))
     end
-
+    startline, endline = max(1, active_line - NUM_SOURCE_LINES_UP_DOWN[] + 1), min(length(code), active_line + NUM_SOURCE_LINES_UP_DOWN[]-1)
+    code = code[startline:endline]
     code .= replace.(code, Ref(r"\$\(QuoteNode\((.+?)\)\)" => s"\1"))
-
-    for (lineno, line) in enumerate(code)
-        (lineno < active_line - 3 || lineno > active_line + 2) && continue
-
-        color = (lineno < active_line) ? :white : :normal
-        if lineno == active_line
-            printstyled(io, rpad(lineno, 4), color = :yellow)
-        else
-            printstyled(io, rpad(lineno, 4), color = color)
-        end
-        printstyled(io, line, color = color)
-        println(io)
-    end
-    println(io)
+    breakpoint_lines = breakpoint_linenumbers(frame; lowered=true)
+    print_lines(io, code, active_line, breakpoint_lines, startline)
 end
 
-
-const NUM_SOURCE_LINES_UP_DOWN = Ref(5)
-
 """
 Determine the offsets in the source code to print, based on the offset of the
 currently highlighted part of the code, and the start and stop line of the
@@ -164,7 +152,7 @@ function compute_source_offsets(code::String, offset::Integer, startline::Intege
     if offsetline - NUM_SOURCE_LINES_UP_DOWN[] > length(file.offsets) || startline > length(file.offsets)
         return -1, -1
     end
-    startoffset = max(file.offsets[max(offsetline - NUM_SOURCE_LINES_UP_DOWN[], 1)], startline == 0 ? 0 : file.offsets[startline])
+    startoffset = max(file.offsets[max(offsetline - NUM_SOURCE_LINES_UP_DOWN[] + 1, 1)], startline == 0 ? 0 : file.offsets[startline])
     stopoffset = lastindex(code)-1
     if offsetline + NUM_SOURCE_LINES_UP_DOWN[] < lastindex(file.offsets)
         stopoffset = min(stopoffset, file.offsets[offsetline + NUM_SOURCE_LINES_UP_DOWN[]] - 1)
@@ -237,16 +225,16 @@ function print_sourcecode(io::IO, code::String, line::Integer, defline::Integer,
 
     # Compute necessary data for line numbering
     startline = compute_line(file, startoffset)
-    stopline = compute_line(file, stopoffset)
-    current_line = line
-    stoplinelength = ndigits(stopline)
 
     code = split(code[(startoffset+1):(stopoffset+1)],'\n')
-    lineno = startline
+    print_lines(io, code, line, breakpoint_lines, startline)
+end
 
+function print_lines(io, code, current_line, breakpoint_lines, startline)
     if !isempty(code) && isempty(code[end])
         pop!(code)
     end
+    stopline = startline + length(code) - 1
 
     # Count indentation level (only count spaces for now)
     min_indentation = typemax(Int)
@@ -262,7 +250,8 @@ function print_sourcecode(io::IO, code::String, line::Integer, defline::Integer,
     for i in 1:length(code)
         code[i] = code[i][min_indentation+1:end]
     end
-
+    lineno = startline
+    stoplinelength = ndigits(stopline)
     for textline in code
         break_on_line = haskey(breakpoint_lines, lineno)
         prefix = (" ", :normal)

src/repl.jl

@@ -1,7 +1,7 @@
 
 promptname(level, name) = "$level|$name> "
 function RunDebugger(frame, repl = Base.active_repl, terminal = Base.active_repl.t; initial_continue=false)
-    state = DebuggerState(frame, repl, terminal)
+    state = DebuggerState(; frame=frame, repl=repl, terminal=terminal)
 
     # Setup debug panel
     normal_prefix = Sys.iswindows() ? "\e[33m" : "\e[38;5;166m"
@@ -53,7 +53,7 @@ function RunDebugger(frame, repl = Base.active_repl, terminal = Base.active_repl
             return false
         end
         if do_print_status
-            print_status(Base.pipe_writer(terminal), active_frame(state))
+            print_status(Base.pipe_writer(terminal), active_frame(state); force_lowered = state.lowered_status)
         end
         return true
     end
@@ -79,7 +79,17 @@ function RunDebugger(frame, repl = Base.active_repl, terminal = Base.active_repl
             else
                 LineEdit.edit_insert(s,key)
             end
+        end,
+        "L" => function (s, args...)
+        if isempty(s) || position(LineEdit.buffer(s)) == 0
+            toggle_lowered(state)
+            println(Base.pipe_writer(terminal))
+            print_status(Base.pipe_writer(terminal), active_frame(state); force_lowered=state.lowered_status)
+            LineEdit.write_prompt(state.terminal, panel)
+        else
+            LineEdit.edit_insert(s,key)
         end
+    end
     )
 
     state.standard_keymap = Dict{Any,Any}[skeymap, LineEdit.history_keymap, LineEdit.default_keymap, LineEdit.escape_defaults]
@@ -89,7 +99,7 @@ function RunDebugger(frame, repl = Base.active_repl, terminal = Base.active_repl
         execute_command(state, Val(:c), "c")
         state.frame === nothing && return state.overall_result
     end
-    print_status(Base.pipe_writer(terminal), active_frame(state))
+    print_status(Base.pipe_writer(terminal), active_frame(state); force_lowered=state.lowered_status)
     REPL.run_interface(terminal, LineEdit.ModalInterface([panel,search_prompt]))
 
     return state.overall_result

test/ui.jl

@@ -27,6 +27,7 @@ end
 include_string(@__MODULE__, """
 function my_gcd_noinfo(a::T, b::T) where T<:Union{Int8,UInt8,Int16,UInt16,Int32,UInt32,Int64,UInt64,Int128,UInt128}
     a == 0 && return abs(b)
+    Debugger.@bp
     b == 0 && return abs(a)
     za = trailing_zeros(a)
     zb = trailing_zeros(b)
@@ -47,7 +48,6 @@ function my_gcd_noinfo(a::T, b::T) where T<:Union{Int8,UInt8,Int16,UInt16,Int32,
 end
 """, "nope.jl")
 
-
 function outer(a, b, c, d)
     inner_kw(a, b; c = c)
 end

test/ui/history_gcd.multiout

@@ -2107,7 +2107,6 @@
 |1|debug> c
 |Hit breakpoint:
 |In my_gcd(a, b) at ui.jl:5
-|  8  zb = trailing_zeros(b)
 |  9  k = min(za, zb)
 | 10  u = unsigned(abs(a >> za))
 | 11  v = unsigned(abs(b >> zb))
@@ -2219,7 +2218,6 @@
 |EEEEEEEEEA
 |AAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAAAAAAAA
-|AAAAAAAAAAAAAAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
@@ -2331,7 +2329,6 @@
 |1|debug> c
 |Hit breakpoint:
 |In my_gcd(a, b) at ui.jl:5
-|  8  zb = trailing_zeros(b)
 |  9  k = min(za, zb)
 | 10  u = unsigned(abs(a >> za))
 | 11  v = unsigned(abs(b >> zb))
@@ -2443,7 +2440,6 @@
 |EEEEEEEEEA
 |AAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAAAAAAAA
-|AAAAAAAAAAAAAAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
 |AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA