Add o command to open current (file, line) in an editor. (#100)

Author: fredrikekre

Manifest.toml

@@ -5,9 +5,9 @@ uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 
 [[CodeTracking]]
 deps = ["InteractiveUtils", "Test", "UUIDs"]
-git-tree-sha1 = "983f5f7a57c604322917ab8bc5b86ba914d3c345"
+git-tree-sha1 = "2c46bc2429c88b43d80caf53151f22b85ba5a4b2"
 uuid = "da1fd8a2-8d9e-5ec2-8556-3022fb5608a2"
-version = "0.3.2"
+version = "0.3.4"
 
 [[Crayons]]
 deps = ["Test"]
@@ -41,11 +41,11 @@ uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 
 [[JuliaInterpreter]]
 deps = ["CodeTracking", "InteractiveUtils", "Random", "UUIDs"]
-git-tree-sha1 = "9c1dfb5bb6b9f5fedcc873e9cbe6fe8765f70701"
+git-tree-sha1 = "1d4df77f80cb7ff450ac0c59e0b906a3713537b2"
 repo-rev = "master"
 repo-url = "https://github.com/JuliaDebug/JuliaInterpreter.jl.git"
 uuid = "aa1ae85d-cabe-5617-a682-6adf51b2e16a"
-version = "0.2.0"
+version = "0.2.1"
 
 [[LibGit2]]
 uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"

Project.toml

@@ -6,6 +6,7 @@ version = "0.1.0"
 CodeTracking = "da1fd8a2-8d9e-5ec2-8556-3022fb5608a2"
 Crayons = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"
 Highlights = "eafb193a-b7ab-5a9e-9068-77385905fa72"
+InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 JuliaInterpreter = "aa1ae85d-cabe-5617-a682-6adf51b2e16a"
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"

README.md

@@ -28,7 +28,7 @@ end
 ```
 
 This interface allows for manipulating program execution, such as stepping in and
-out of functions, line stepping, showing local variables, and evaluating code in 
+out of functions, line stepping, showing local variables, and evaluating code in
 the context of functions.
 
 Basic Commands:
@@ -45,6 +45,7 @@ Basic Commands:
     - `w add expr`: add an expression to the watch list
     - `w`: show all watch expressions evaluated in the current function's context
     - `w rm [i::Int]`: remove all or the `i`:th watch expression
+- `o`: open the current line in an editor
 - `q`: quit the debugger, returning `nothing`
 
 Advanced commands:
@@ -69,7 +70,7 @@ julia> @run sin(2.0)
 Hit breakpoint: abs(x::Float64) in Base at float.jl:522, line 522
 In abs(x) at float.jl:522
 522   abs(x::Float64) = abs_float(x)
-523   
+523
 524   """
 
 About to run: (abs_float)(2.0)
@@ -97,7 +98,7 @@ Breaking on error: string_index_err(s::AbstractString, i::Integer) in Base at st
 In string_index_err(s, i) at strings/string.jl:12
 12  @noinline string_index_err(s::AbstractString, i::Integer) =
 13      throw(StringIndexError(s, Int(i)))
-14  
+14
 
 About to run: (throw)(StringIndexError("αβ", 2))
 1|debug> bt

src/Debugger.jl

@@ -2,6 +2,7 @@ module Debugger
 
 using Highlights
 using Crayons
+import InteractiveUtils
 
 using Markdown
 using Base.Meta: isexpr

src/commands.jl

@@ -148,6 +148,7 @@ function execute_command(state::DebuggerState, ::Val{:?}, cmd::AbstractString)
         - `w add expr`: add an expression to the watch list\\
         - `w`: show all watch expressions evaluated in the current function's context\\
         - `w rm [i::Int]`: remove all or the `i`:th watch expression\\
+    - `o`: open the current line in an editor\\
     - `q`: quit the debugger, returning `nothing`\\
     Advanced commands:\\
     - `nc`: step to the next call\\
@@ -157,3 +158,19 @@ function execute_command(state::DebuggerState, ::Val{:?}, cmd::AbstractString)
     """)
     return false
 end
+
+function execute_command(state::DebuggerState, ::Val{:o}, cmd::AbstractString)
+    frame = active_frame(state)
+    loc = JuliaInterpreter.whereis(frame)
+    if loc === nothing
+        printstyled(stderr, "Could not find source location\n"; color=:red)
+        return false
+    end
+    file, line = loc
+    if !isfile(file)
+        printstyled(stderr, "Could not find file: $(repr(file))\n"; color=:red)
+        return false
+    end
+    InteractiveUtils.edit(file, line)
+    return false
+end

test/misc.jl

@@ -65,10 +65,24 @@ try
     st = chomp(sprint(Debugger.print_status, frame; context = :color => true))
     x_1_plus_1_colored = "\e[39m\e[97mx\e[39m\e[97m \e[39m\e[91m=\e[39m\e[97m \e[39m1\e[97m \e[39m\e[91m+\e[39m\e[97m \e[39m1\e[97m"
     @test occursin(x_1_plus_1_colored, st)
-finally 
+finally
     Debugger.set_highlight(Debugger.HIGHLIGHT_OFF)
 end
 
 frame = @make_frame Test.eval(1)
 desc = Debugger.locdesc(frame)
 @test occursin(Sys.STDLIB, desc)
+
+import InteractiveUtils
+@testset "`o` command" begin
+    g() = nothing
+    LINE = (@__LINE__) - 1
+    frame = Debugger.@make_frame g()
+    state = dummy_state(frame)
+    JuliaInterpreter.breakpoint(InteractiveUtils.edit)
+    frame, bp = JuliaInterpreter.@interpret execute_command(state, Val{:o}(), "o")
+    JuliaInterpreter.remove()
+    locals = JuliaInterpreter.locals(frame)
+    @test JuliaInterpreter.Variable(@__FILE__, :file, false) in locals
+    @test JuliaInterpreter.Variable(LINE, :line, false) in locals
+end