reline 0.5.9 → 0.6.1

data/lib/reline/version.rb

@@ -1,3 +1,3 @@
 module Reline
-  VERSION = '0.5.9'
+  VERSION = '0.6.1'
 end

data/lib/reline.rb

@@ -6,25 +6,26 @@ require 'reline/key_actor'
 require 'reline/key_stroke'
 require 'reline/line_editor'
 require 'reline/history'
-require 'reline/terminfo'
 require 'reline/io'
 require 'reline/face'
 require 'rbconfig'
 
 module Reline
   # NOTE: For making compatible with the rb-readline gem
-  FILENAME_COMPLETION_PROC = nil
-  USERNAME_COMPLETION_PROC = nil
+  FILENAME_COMPLETION_PROC = nil # :nodoc:
+  USERNAME_COMPLETION_PROC = nil # :nodoc:
 
-  class ConfigEncodingConversionError < StandardError; end
+  class ConfigEncodingConversionError < StandardError; end # :nodoc:
 
-  Key = Struct.new(:char, :combined_char, :with_meta) do
+  # EOF key: { char: nil, method_symbol: nil }
+  # Other key: { char: String, method_symbol: Symbol }
+  Key = Struct.new(:char, :method_symbol, :unused_boolean) do
     # For dialog_proc `key.match?(dialog.name)`
     def match?(sym)
-      combined_char.is_a?(Symbol) && combined_char == sym
+      method_symbol && method_symbol == sym
     end
-  end
-  CursorPos = Struct.new(:x, :y)
+  end # :nodoc:
+  CursorPos = Struct.new(:x, :y) # :nodoc:
   DialogRenderInfo = Struct.new(
     :pos,
     :contents,
@@ -34,7 +35,7 @@ module Reline
     :height,
     :scrollbar,
     keyword_init: true
-  )
+  ) # :nodoc:
 
   class Core
     ATTR_READER_NAMES = %i(
@@ -182,9 +183,7 @@ module Reline
     def output=(val)
       raise TypeError unless val.respond_to?(:write) or val.nil?
       @output = val
-      if io_gate.respond_to?(:output=)
-        io_gate.output = val
-      end
+      io_gate.output = val
     end
 
     def vi_editing_mode
@@ -245,8 +244,8 @@ module Reline
         height: [15, preferred_dialog_height].min,
         face: :completion_dialog
       )
-    }
-    Reline::DEFAULT_DIALOG_CONTEXT = Array.new
+    } # :nodoc:
+    Reline::DEFAULT_DIALOG_CONTEXT = Array.new # :nodoc:
 
     def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
       @mutex.synchronize do
@@ -308,7 +307,8 @@ module Reline
       otio = io_gate.prep
 
       may_req_ambiguous_char_width
-      line_editor.reset(prompt, encoding: encoding)
+      key_stroke.encoding = encoding
+      line_editor.reset(prompt)
       if multiline
         line_editor.multiline_on
         if block_given?
@@ -317,21 +317,23 @@ module Reline
       else
         line_editor.multiline_off
       end
-      line_editor.output = output
       line_editor.completion_proc = completion_proc
       line_editor.completion_append_character = completion_append_character
       line_editor.output_modifier_proc = output_modifier_proc
       line_editor.prompt_proc = prompt_proc
       line_editor.auto_indent_proc = auto_indent_proc
       line_editor.dig_perfect_match_proc = dig_perfect_match_proc
+
+      # Readline calls pre_input_hook just after printing the first prompt.
+      line_editor.print_nomultiline_prompt
       pre_input_hook&.call
+
       unless Reline::IOGate.dumb?
         @dialog_proc_list.each_pair do |name_sym, d|
           line_editor.add_dialog_proc(name_sym, d.dialog_proc, d.context)
         end
       end
 
-      line_editor.print_nomultiline_prompt(prompt)
       line_editor.update_dialogs
       line_editor.rerender
 
@@ -339,22 +341,22 @@ module Reline
         line_editor.set_signal_handlers
         loop do
           read_io(config.keyseq_timeout) { |inputs|
-            line_editor.set_pasting_state(io_gate.in_pasting?)
             inputs.each do |key|
-              if key.char == :bracketed_paste_start
-                text = io_gate.read_bracketed_paste
-                line_editor.insert_pasted_text(text)
-                line_editor.scroll_into_view
-              else
-                line_editor.update(key)
+              case key.method_symbol
+              when :bracketed_paste_start
+                # io_gate is Reline::ANSI because the key :bracketed_paste_start is only assigned in Reline::ANSI
+                key = Reline::Key.new(io_gate.read_bracketed_paste, :insert_multiline_text)
+              when :quoted_insert, :ed_quoted_insert
+                key = Reline::Key.new(io_gate.read_single_char(config.keyseq_timeout), :insert_raw_char)
               end
+              line_editor.set_pasting_state(io_gate.in_pasting?)
+              line_editor.update(key)
             end
           }
           if line_editor.finished?
             line_editor.render_finished
             break
           else
-            line_editor.set_pasting_state(io_gate.in_pasting?)
             line_editor.rerender
           end
         end
@@ -409,7 +411,7 @@ module Reline
     end
 
     private def may_req_ambiguous_char_width
-      @ambiguous_width = 2 if io_gate.dumb? || !STDIN.tty? || !STDOUT.tty?
+      @ambiguous_width = 1 if io_gate.dumb? || !STDIN.tty? || !STDOUT.tty?
       return if defined? @ambiguous_width
       io_gate.move_cursor_column(0)
       begin
@@ -418,7 +420,7 @@ module Reline
         # LANG=C
         @ambiguous_width = 1
       else
-        @ambiguous_width = io_gate.cursor_pos.x
+        @ambiguous_width = io_gate.cursor_pos.x == 2 ? 2 : 1
       end
       io_gate.move_cursor_column(0)
       io_gate.erase_after_cursor
@@ -437,6 +439,17 @@ module Reline
   }
   def_single_delegators :core, :input=, :output=
   def_single_delegators :core, :vi_editing_mode, :emacs_editing_mode
+
+  ##
+  # :singleton-method: readmultiline
+  # :call-seq:
+  #   readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination) -> string or nil
+  def_single_delegators :core, :readmultiline
+
+  ##
+  # :singleton-method: readline
+  # :call-seq:
+  #   readline(prompt = '', add_hist = false) -> string or nil
   def_single_delegators :core, :readline
   def_single_delegators :core, :completion_case_fold, :completion_case_fold=
   def_single_delegators :core, :completion_quote_character
@@ -457,8 +470,8 @@ module Reline
   def_single_delegator :line_editor, :byte_pointer, :point
   def_single_delegator :line_editor, :byte_pointer=, :point=
 
-  def self.insert_text(*args, &block)
-    line_editor.insert_text(*args, &block)
+  def self.insert_text(text)
+    line_editor.insert_multiline_text(text)
     self
   end
 
@@ -472,19 +485,18 @@ module Reline
   def_single_delegators :core, :dialog_proc
   def_single_delegators :core, :autocompletion, :autocompletion=
 
-  def_single_delegators :core, :readmultiline
   def_instance_delegators self, :readmultiline
   private :readmultiline
 
-  def self.encoding_system_needs
+  def self.encoding_system_needs # :nodoc:
     self.core.encoding
   end
 
   def self.core
     @core ||= Core.new { |core|
       core.config = Reline::Config.new
-      core.key_stroke = Reline::KeyStroke.new(core.config)
-      core.line_editor = Reline::LineEditor.new(core.config, core.encoding)
+      core.key_stroke = Reline::KeyStroke.new(core.config, core.encoding)
+      core.line_editor = Reline::LineEditor.new(core.config)
 
       core.basic_word_break_characters = " \t\n`><=;|&{("
       core.completer_word_break_characters = " \t\n`><=;|&{("
@@ -509,7 +521,7 @@ end
 Reline::IOGate = Reline::IO.decide_io_gate
 
 # Deprecated
-Reline::GeneralIO = Reline::Dumb.new
+Reline::GeneralIO = Reline::Dumb.new # :nodoc:
 
 Reline::Face.load_initial_configs
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: reline
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.1
 platform: ruby
 authors:
 - aycabta
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: io-console
@@ -51,7 +50,6 @@ files:
 - lib/reline/key_stroke.rb
 - lib/reline/kill_ring.rb
 - lib/reline/line_editor.rb
-- lib/reline/terminfo.rb
 - lib/reline/unicode.rb
 - lib/reline/unicode/east_asian_width.rb
 - lib/reline/version.rb
@@ -63,7 +61,6 @@ metadata:
   bug_tracker_uri: https://github.com/ruby/reline/issues
   changelog_uri: https://github.com/ruby/reline/releases
   source_code_uri: https://github.com/ruby/reline
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,8 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Alternative GNU Readline or Editline implementation by pure Ruby.
 test_files: []

data/lib/reline/terminfo.rb

@@ -1,158 +0,0 @@
-begin
-  # Ignore warning `Add fiddle to your Gemfile or gemspec` in Ruby 3.4.
-  # terminfo.rb and ansi.rb supports fiddle unavailable environment.
-  verbose, $VERBOSE = $VERBOSE, nil
-  require 'fiddle'
-  require 'fiddle/import'
-rescue LoadError
-  module Reline::Terminfo
-    def self.curses_dl
-      false
-    end
-  end
-ensure
-  $VERBOSE = verbose
-end
-
-module Reline::Terminfo
-  extend Fiddle::Importer
-
-  class TerminfoError < StandardError; end
-
-  def self.curses_dl_files
-    case RUBY_PLATFORM
-    when /mingw/, /mswin/
-      # aren't supported
-      []
-    when /cygwin/
-      %w[cygncursesw-10.dll cygncurses-10.dll]
-    when /darwin/
-      %w[libncursesw.dylib libcursesw.dylib libncurses.dylib libcurses.dylib]
-    else
-      %w[libncursesw.so libcursesw.so libncurses.so libcurses.so]
-    end
-  end
-
-  @curses_dl = false
-  def self.curses_dl
-    return @curses_dl unless @curses_dl == false
-    if Fiddle.const_defined?(:TYPE_VARIADIC)
-      curses_dl_files.each do |curses_name|
-        result = Fiddle::Handle.new(curses_name)
-      rescue Fiddle::DLError
-        next
-      else
-        @curses_dl = result
-        break
-      end
-    end
-    @curses_dl = nil if @curses_dl == false
-    @curses_dl
-  end
-end if not Reline.const_defined?(:Terminfo) or not Reline::Terminfo.respond_to?(:curses_dl)
-
-module Reline::Terminfo
-  dlload curses_dl
-  #extern 'int setupterm(char *term, int fildes, int *errret)'
-  @setupterm = Fiddle::Function.new(curses_dl['setupterm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_INT, Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
-  #extern 'char *tigetstr(char *capname)'
-  @tigetstr = Fiddle::Function.new(curses_dl['tigetstr'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_VOIDP)
-  begin
-    #extern 'char *tiparm(const char *str, ...)'
-    @tiparm = Fiddle::Function.new(curses_dl['tiparm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VARIADIC], Fiddle::TYPE_VOIDP)
-  rescue Fiddle::DLError
-    # OpenBSD lacks tiparm
-    #extern 'char *tparm(const char *str, ...)'
-    @tiparm = Fiddle::Function.new(curses_dl['tparm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VARIADIC], Fiddle::TYPE_VOIDP)
-  end
-  begin
-    #extern 'int tigetflag(char *str)'
-    @tigetflag = Fiddle::Function.new(curses_dl['tigetflag'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
-  rescue Fiddle::DLError
-    # OpenBSD lacks tigetflag
-    #extern 'int tgetflag(char *str)'
-    @tigetflag = Fiddle::Function.new(curses_dl['tgetflag'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
-  end
-  begin
-    #extern 'int tigetnum(char *str)'
-    @tigetnum = Fiddle::Function.new(curses_dl['tigetnum'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
-  rescue Fiddle::DLError
-    # OpenBSD lacks tigetnum
-    #extern 'int tgetnum(char *str)'
-    @tigetnum = Fiddle::Function.new(curses_dl['tgetnum'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
-  end
-
-  def self.setupterm(term, fildes)
-    errret_int = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INT)
-    ret = @setupterm.(term, fildes, errret_int)
-    case ret
-    when 0 # OK
-      @term_supported = true
-    when -1 # ERR
-      @term_supported = false
-    end
-  end
-
-  class StringWithTiparm < String
-    def tiparm(*args) # for method chain
-      Reline::Terminfo.tiparm(self, *args)
-    end
-  end
-
-  def self.tigetstr(capname)
-    raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
-    capability = @tigetstr.(capname)
-    case capability.to_i
-    when 0, -1
-      raise TerminfoError, "can't find capability: #{capname}"
-    end
-    StringWithTiparm.new(capability.to_s)
-  end
-
-  def self.tiparm(str, *args)
-    new_args = []
-    args.each do |a|
-      new_args << Fiddle::TYPE_INT << a
-    end
-    @tiparm.(str, *new_args).to_s
-  end
-
-  def self.tigetflag(capname)
-    raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
-    flag = @tigetflag.(capname).to_i
-    case flag
-    when -1
-      raise TerminfoError, "not boolean capability: #{capname}"
-    when 0
-      raise TerminfoError, "can't find capability: #{capname}"
-    end
-    flag
-  end
-
-  def self.tigetnum(capname)
-    raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
-    num = @tigetnum.(capname).to_i
-    case num
-    when -2
-      raise TerminfoError, "not numeric capability: #{capname}"
-    when -1
-      raise TerminfoError, "can't find capability: #{capname}"
-    end
-    num
-  end
-
-  # NOTE: This means Fiddle and curses are enabled.
-  def self.enabled?
-    true
-  end
-
-  def self.term_supported?
-    @term_supported
-  end
-end if Reline::Terminfo.curses_dl
-
-module Reline::Terminfo
-  def self.enabled?
-    false
-  end
-end unless Reline::Terminfo.curses_dl