Merge pull request #22377 from JuliaLang/sk/rerepl

repl: add a bunch of types to structs and methods

Author: StefanKarpinski

base/LineEdit.jl renamed to base/repl/LineEdit.jl

@@ -15,14 +15,32 @@ abstract type ModeState end
 export run_interface, Prompt, ModalInterface, transition, reset_state, edit_insert, keymap
 
 struct ModalInterface <: TextInterface
-    modes
+    modes::Array{Base.LineEdit.TextInterface,1}
 end
 
+mutable struct Prompt <: TextInterface
+    prompt::String
+    # A string or function to be printed before the prompt. May not change the length of the prompt.
+    # This may be used for changing the color, issuing other terminal escape codes, etc.
+    prompt_prefix::Union{String,Function}
+    # Same as prefix except after the prompt
+    prompt_suffix::Union{String,Function}
+    keymap_dict::Dict{Char}
+    keymap_func_data # ::AbstractREPL
+    complete # ::REPLCompletionProvider
+    on_enter::Function
+    on_done::Function
+    hist # ::REPLHistoryProvider
+    sticky::Bool
+end
+
+show(io::IO, x::Prompt) = show(io, string("Prompt(\"", x.prompt, "\",...)"))
+
 mutable struct MIState
     interface::ModalInterface
-    current_mode
+    current_mode::TextInterface
     aborted::Bool
-    mode_state
+    mode_state::Dict
     kill_buffer::String
     previous_key::Array{Char,1}
     key_repeats::Int
@@ -33,31 +51,13 @@ function show(io::IO, s::MIState)
     print(io, "MI State (", s.current_mode, " active)")
 end
 
-mutable struct Prompt <: TextInterface
-    prompt
-    # A string or function to be printed before the prompt. May not change the length of the prompt.
-    # This may be used for changing the color, issuing other terminal escape codes, etc.
-    prompt_prefix
-    # Same as prefix except after the prompt
-    prompt_suffix
-    keymap_dict
-    keymap_func_data
-    complete
-    on_enter
-    on_done
-    hist
-    sticky::Bool
-end
-
-show(io::IO, x::Prompt) = show(io, string("Prompt(\"", x.prompt, "\",...)"))
-
 struct InputAreaState
     num_rows::Int64
     curs_row::Int64
 end
 
 mutable struct PromptState <: ModeState
-    terminal
+    terminal::AbstractTerminal
     p::Prompt
     input_buffer::IOBuffer
     ias::InputAreaState
@@ -77,11 +77,8 @@ end
 abstract type HistoryProvider end
 abstract type CompletionProvider end
 
-mutable struct EmptyCompletionProvider <: CompletionProvider
-end
-
-mutable struct EmptyHistoryProvider <: HistoryProvider
-end
+struct EmptyCompletionProvider <: CompletionProvider end
+struct EmptyHistoryProvider <: HistoryProvider end
 
 reset_state(::EmptyHistoryProvider) = nothing
 
@@ -970,15 +967,15 @@ function write_response_buffer(s::PromptState, data)
 end
 
 mutable struct SearchState <: ModeState
-    terminal
-    histprompt
+    terminal::AbstractTerminal
+    histprompt # ::HistoryPrompt
     #rsearch (true) or ssearch (false)
     backward::Bool
     query_buffer::IOBuffer
     response_buffer::IOBuffer
     ias::InputAreaState
     #The prompt whose input will be replaced by the matched history
-    parent
+    parent::Prompt
     SearchState(terminal, histprompt, backward, query_buffer, response_buffer) =
         new(terminal, histprompt, backward, query_buffer, response_buffer, InputAreaState(0,0))
 end
@@ -1015,7 +1012,7 @@ end
 
 mutable struct HistoryPrompt{T<:HistoryProvider} <: TextInterface
     hp::T
-    complete
+    complete # ::CompletionProvider
     keymap_dict::Dict{Char,Any}
     HistoryPrompt{T}(hp) where T<:HistoryProvider = new(hp, EmptyCompletionProvider())
 end
@@ -1024,16 +1021,16 @@ HistoryPrompt(hp::T) where T<:HistoryProvider = HistoryPrompt{T}(hp)
 init_state(terminal, p::HistoryPrompt) = SearchState(terminal, p, true, IOBuffer(), IOBuffer())
 
 mutable struct PrefixSearchState <: ModeState
-    terminal
-    histprompt
+    terminal::AbstractTerminal
+    histprompt # ::HistoryPrompt
     prefix::String
     response_buffer::IOBuffer
     ias::InputAreaState
     indent::Int
     # The modal interface state, if present
-    mi
+    mi::MIState
     #The prompt whose input will be replaced by the matched history
-    parent
+    parent::Prompt
     PrefixSearchState(terminal, histprompt, prefix, response_buffer) =
         new(terminal, histprompt, prefix, response_buffer, InputAreaState(0,0), 0)
 end
@@ -1055,7 +1052,7 @@ input_string(s::PrefixSearchState) = String(s.response_buffer)
 mutable struct PrefixHistoryPrompt{T<:HistoryProvider} <: TextInterface
     hp::T
     parent_prompt::Prompt
-    complete
+    complete # ::CompletionProvider
     keymap_dict::Dict{Char,Any}
     PrefixHistoryPrompt{T}(hp, parent_prompt) where T<:HistoryProvider =
         new(hp, parent_prompt, EmptyCompletionProvider())

base/REPL.jl renamed to base/repl/REPL.jl

@@ -8,6 +8,7 @@ using ..LineEdit
 using ..REPLCompletions
 
 export
+    AbstractREPL,
     BasicREPL,
     LineEditREPL,
     StreamREPL
@@ -172,7 +173,7 @@ struct REPLBackendRef
     response_channel::Channel
 end
 
-function run_repl(repl::AbstractREPL, consumer = x->nothing)
+function run_repl(repl::AbstractREPL, consumer::Function = x->nothing)
     repl_channel = Channel(1)
     response_channel = Channel(1)
     backend = start_repl_backend(repl_channel, response_channel)
@@ -254,8 +255,8 @@ mutable struct LineEditREPL <: AbstractREPL
     in_help::Bool
     envcolors::Bool
     waserror::Bool
-    specialdisplay
-    interface
+    specialdisplay::Union{Void,Display}
+    interface::ModalInterface
     backendref::REPLBackendRef
     LineEditREPL(t,hascolor,prompt_color,input_color,answer_color,shell_color,help_color,history_file,in_shell,in_help,envcolors) =
         new(t,true,prompt_color,input_color,answer_color,shell_color,help_color,history_file,in_shell,
@@ -266,20 +267,19 @@ specialdisplay(r::LineEditREPL) = r.specialdisplay
 specialdisplay(r::AbstractREPL) = nothing
 terminal(r::LineEditREPL) = r.t
 
-LineEditREPL(t::TextTerminal, envcolors = false) =  LineEditREPL(t,
-                                              true,
-                                              Base.text_colors[:green],
-                                              Base.input_color(),
-                                              Base.answer_color(),
-                                              Base.text_colors[:red],
-                                              Base.text_colors[:yellow],
-                                              false, false, false, envcolors)
-
-mutable struct REPLCompletionProvider <: CompletionProvider; end
-
-mutable struct ShellCompletionProvider <: CompletionProvider; end
+LineEditREPL(t::TextTerminal, envcolors::Bool=false) =
+    LineEditREPL(t, true,
+        Base.text_colors[:green],
+        Base.input_color(),
+        Base.answer_color(),
+        Base.text_colors[:red],
+        Base.text_colors[:yellow],
+        false, false, false, envcolors
+    )
 
-struct LatexCompletions <: CompletionProvider; end
+mutable struct REPLCompletionProvider <: CompletionProvider end
+mutable struct ShellCompletionProvider <: CompletionProvider end
+struct LatexCompletions <: CompletionProvider end
 
 beforecursor(buf::IOBuffer) = String(buf.data[1:buf.ptr-1])
 
@@ -305,16 +305,15 @@ function complete_line(c::LatexCompletions, s)
     return ret, partial[range], should_complete
 end
 
-
 mutable struct REPLHistoryProvider <: HistoryProvider
     history::Array{String,1}
-    history_file
+    history_file::Union{Void,IO}
     start_idx::Int
     cur_idx::Int
     last_idx::Int
     last_buffer::IOBuffer
-    last_mode
-    mode_mapping
+    last_mode::Union{Void,Prompt}
+    mode_mapping::Dict
     modes::Array{Symbol,1}
 end
 REPLHistoryProvider(mode_mapping) =
@@ -619,7 +618,9 @@ end
 
 backend(r::AbstractREPL) = r.backendref
 
-send_to_backend(ast, backend::REPLBackendRef) = send_to_backend(ast, backend.repl_channel, backend.response_channel)
+send_to_backend(ast, backend::REPLBackendRef) =
+    send_to_backend(ast, backend.repl_channel, backend.response_channel)
+
 function send_to_backend(ast, req, rep)
     put!(req, (ast, 1))
     return take!(rep) # (val, bt)
@@ -661,7 +662,7 @@ function prepare_next(repl::LineEditREPL)
     println(terminal(repl))
 end
 
-function mode_keymap(julia_prompt)
+function mode_keymap(julia_prompt::Prompt)
     AnyDict(
     '\b' => function (s,o...)
         if isempty(s) || position(LineEdit.buffer(s)) == 0
@@ -689,7 +690,11 @@ repl_filename(repl, hp) = "REPL"
 const JL_PROMPT_PASTE = Ref(true)
 enable_promptpaste(v::Bool) = JL_PROMPT_PASTE[] = v
 
-function setup_interface(repl::LineEditREPL; hascolor = repl.hascolor, extra_repl_keymap = Dict{Any,Any}[])
+function setup_interface(
+    repl::LineEditREPL;
+    hascolor::Bool = repl.hascolor,
+    extra_repl_keymap::Vector{<:Dict} = Dict{Any,Any}[]
+)
     ###
     #
     # This function returns the main interface that describes the REPL
@@ -932,7 +937,7 @@ function setup_interface(repl::LineEditREPL; hascolor = repl.hascolor, extra_rep
     ModalInterface([julia_prompt, shell_mode, help_mode, search_prompt, prefix_prompt])
 end
 
-function run_frontend(repl::LineEditREPL, backend)
+function run_frontend(repl::LineEditREPL, backend::REPLBackendRef)
     d = REPLDisplay(repl)
     dopushdisplay = repl.specialdisplay === nothing && !in(d,Base.Multimedia.displays)
     dopushdisplay && pushdisplay(d)
@@ -975,7 +980,7 @@ input_color(r::StreamREPL) = r.input_color
 
 # heuristic function to decide if the presence of a semicolon
 # at the end of the expression was intended for suppressing output
-function ends_with_semicolon(line)
+function ends_with_semicolon(line::AbstractString)
     match = rsearch(line, ';')
     if match != 0
         # state for comment parser, assuming that the `;` isn't in a string or comment
@@ -1057,7 +1062,7 @@ function run_frontend(repl::StreamREPL, backend::REPLBackendRef)
     dopushdisplay && popdisplay(d)
 end
 
-function start_repl_server(port)
+function start_repl_server(port::Int)
     listen(port) do server, status
         client = accept(server)
         run_repl(client)

base/REPLCompletions.jl renamed to base/repl/REPLCompletions.jl

@@ -3,6 +3,7 @@
 module Terminals
 
 export
+    AbstractTerminal,
     TextTerminal,
     UnixTerminal,
     TerminalBuffer,
@@ -33,11 +34,15 @@ import Base:
     read,
     readuntil
 
+## AbstractTerminal: abstract supertype of all terminals ##
+
+abstract type AbstractTerminal <: Base.AbstractPipe end
+
 ## TextTerminal ##
 
-abstract type TextTerminal <: Base.AbstractPipe end
+abstract type TextTerminal <: AbstractTerminal end
 
-# INTERFACE
+# Terminal interface:
 pipe_reader(::TextTerminal) = error("Unimplemented")
 pipe_writer(::TextTerminal) = error("Unimplemented")
 displaysize(::TextTerminal) = error("Unimplemented")
@@ -95,7 +100,7 @@ pipe_reader(t::UnixTerminal) = t.in_stream
 pipe_writer(t::UnixTerminal) = t.out_stream
 
 mutable struct TerminalBuffer <: UnixTerminal
-    out_stream::Base.IO
+    out_stream::IO
 end
 
 mutable struct TTYTerminal <: UnixTerminal
@@ -113,22 +118,17 @@ cmove_right(t::UnixTerminal, n) = write(t.out_stream, "$(CSI)$(n)C")
 cmove_left(t::UnixTerminal, n) = write(t.out_stream, "$(CSI)$(n)D")
 cmove_line_up(t::UnixTerminal, n) = (cmove_up(t, n); cmove_col(t, 1))
 cmove_line_down(t::UnixTerminal, n) = (cmove_down(t, n); cmove_col(t, 1))
-cmove_col(t::UnixTerminal, n) = (write(t.out_stream, '\r'); n > 1 && cmove_right(t, n - 1))
+cmove_col(t::UnixTerminal, n) = (write(t.out_stream, '\r'); n > 1 && cmove_right(t, n-1))
 
 if is_windows()
     function raw!(t::TTYTerminal,raw::Bool)
         check_open(t.in_stream)
         if Base.ispty(t.in_stream)
-            run(if raw
-                    `stty raw -echo onlcr -ocrnl opost`
-                else
-                    `stty sane`
-                end,t.in_stream,t.out_stream,t.err_stream)
+            run((raw ? `stty raw -echo onlcr -ocrnl opost` : `stty sane`),
+                t.in_stream, t.out_stream, t.err_stream)
             true
         else
-            ccall(:jl_tty_set_mode,
-                 Int32, (Ptr{Void},Int32),
-                 t.in_stream.handle, raw) != -1
+            ccall(:jl_tty_set_mode, Int32, (Ptr{Void},Int32), t.in_stream.handle, raw) != -1
         end
     end
 else
@@ -148,9 +148,7 @@ end
 @eval clear_line(t::UnixTerminal) = write(t.out_stream, $"\r$(CSI)0K")
 #beep(t::UnixTerminal) = write(t.err_stream,"\x7")
 
-function Base.displaysize(t::UnixTerminal)
-    return displaysize(t.out_stream)
-end
+Base.displaysize(t::UnixTerminal) = displaysize(t.out_stream)
 
 if is_windows()
     hascolor(t::TTYTerminal) = true

base/Terminals.jl renamed to base/repl/Terminals.jl

@@ -360,10 +360,10 @@ using .I18n
 
 # frontend
 include("initdefs.jl")
-include("Terminals.jl")
-include("LineEdit.jl")
-include("REPLCompletions.jl")
-include("REPL.jl")
+include("repl/Terminals.jl")
+include("repl/LineEdit.jl")
+include("repl/REPLCompletions.jl")
+include("repl/REPL.jl")
 include("client.jl")
 
 # Stack frames and traces

base/emoji_symbols.jl renamed to base/repl/emoji_symbols.jl

@@ -202,7 +202,7 @@ end
 atreplinit(customize_keys)
 ```
 
-Users should refer to `base/LineEdit.jl` to discover the available actions on key input.
+Users should refer to `LineEdit.jl` to discover the available actions on key input.
 
 ## Tab completion