reline 0.3.9 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f903d3b8f902335117d484007dcfbef5e8846061a8eb3c8820f9975c4c85ea5
-  data.tar.gz: 2ccb2d104c5c52b4e4f8ab1dd8a48ceb738fa03826ab62a7b38483d0f4f1288a
+  metadata.gz: bcccc644594f9c2e4b9ae0eb743c2ae293ef084e96a8d9bd032b76825111c01b
+  data.tar.gz: b5ab239a3d20925d4fbd8fb827908fa3e4fa70298a172e32e9b2b4de59dc767e
 SHA512:
-  metadata.gz: d8edd5b7d31464fbc150518f94d45d84466837fe78374dbc127f2226005eb73f2c238f274d685ed42c97db56e906fb90b5e6369dd03dbaeac4b6f2019f36cd68
-  data.tar.gz: 317225a1374e59f3dbb654b67a732fd3daf669fd13cab0673d73e0b952cc8d6fad554c4318366479d162890d0c538ca09cc902a1ad2fad0e42e4684b54f81c3e
+  metadata.gz: 9bce894711da0253bf9b3f0eb192ff64947d591edd00f9094430431eb470fade4d02f3f8b529d364cdd7124d7f5a5203ea755be41dbfda890e37654aca430706
+  data.tar.gz: eed500ad148a1f83e3de03e6d7daaf5d250ba3ea25d47d24070e749dfd44a7d900b83474dd0b427faee74bad883dab97b7af1984a7fb7209e1819fd416d4381b

data/README.md

@@ -15,7 +15,7 @@ Reline is compatible with the API of Ruby's stdlib 'readline', GNU Readline and
 
 It's compatible with the readline standard library.
 
-See [the document of readline stdlib](https://ruby-doc.org/stdlib/libdoc/readline/rdoc/Readline.html) or [bin/example](https://github.com/ruby/reline/blob/master/bin/example).
+See [the document of readline stdlib](https://ruby-doc.org/stdlib/exts/readline/Readline.html) or [bin/example](https://github.com/ruby/reline/blob/master/bin/example).
 
 ### Multi-line editing mode
 
@@ -55,6 +55,13 @@ end
 
 See also: [test/reline/yamatanooroti/multiline_repl](https://github.com/ruby/reline/blob/master/test/reline/yamatanooroti/multiline_repl)
 
+## Documentation
+
+### Reline::Face
+
+You can modify the text color and text decorations in your terminal emulator.
+See [doc/reline/face.md](./doc/reline/face.md)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/reline.

data/lib/reline/ansi.rb

@@ -3,6 +3,8 @@ require 'io/wait'
 require_relative 'terminfo'
 
 class Reline::ANSI
+  RESET_COLOR = "\e[0m"
+
   CAPNAME_KEY_BINDINGS = {
     'khome' => :ed_move_to_beg,
     'kend'  => :ed_move_to_end,
@@ -43,6 +45,7 @@ class Reline::ANSI
   end
 
   def self.set_default_key_bindings(config, allow_terminfo: true)
+    set_bracketed_paste_key_bindings(config)
     set_default_key_bindings_ansi_cursor(config)
     if allow_terminfo && Reline::Terminfo.enabled?
       set_default_key_bindings_terminfo(config)
@@ -64,6 +67,12 @@ class Reline::ANSI
     end
   end
 
+  def self.set_bracketed_paste_key_bindings(config)
+    [:emacs, :vi_insert, :vi_command].each do |keymap|
+      config.add_default_key_binding_by_keymap(keymap, START_BRACKETED_PASTE.bytes, :bracketed_paste_start)
+    end
+  end
+
   def self.set_default_key_bindings_ansi_cursor(config)
     ANSI_CURSOR_KEY_BINDINGS.each do |char, (default_func, modifiers)|
       bindings = [["\e[#{char}", default_func]] # CSI + char
@@ -149,7 +158,11 @@ class Reline::ANSI
   end
 
   def self.with_raw_input
-    @@input.raw { yield }
+    if @@input.tty?
+      @@input.raw(intr: true) { yield }
+    else
+      yield
+    end
   end
 
   @@buf = []
@@ -157,11 +170,13 @@ class Reline::ANSI
     unless @@buf.empty?
       return @@buf.shift
     end
-    until c = @@input.raw(intr: true) { @@input.wait_readable(0.1) && @@input.getbyte }
-      timeout_second -= 0.1
+    until @@input.wait_readable(0.01)
+      timeout_second -= 0.01
       return nil if timeout_second <= 0
-      Reline.core.line_editor.resize
+
+      Reline.core.line_editor.handle_signal
     end
+    c = @@input.getbyte
     (c == 0x16 && @@input.raw(min: 0, time: 0, &:getbyte)) || c
   rescue Errno::EIO
     # Maybe the I/O has been closed.
@@ -170,46 +185,26 @@ class Reline::ANSI
     nil
   end
 
-  @@in_bracketed_paste_mode = false
-  START_BRACKETED_PASTE = String.new("\e[200~,", encoding: Encoding::ASCII_8BIT)
-  END_BRACKETED_PASTE = String.new("\e[200~.", encoding: Encoding::ASCII_8BIT)
-  def self.getc_with_bracketed_paste(timeout_second)
+  START_BRACKETED_PASTE = String.new("\e[200~", encoding: Encoding::ASCII_8BIT)
+  END_BRACKETED_PASTE = String.new("\e[201~", encoding: Encoding::ASCII_8BIT)
+  def self.read_bracketed_paste
     buffer = String.new(encoding: Encoding::ASCII_8BIT)
-    buffer << inner_getc(timeout_second)
-    while START_BRACKETED_PASTE.start_with?(buffer) or END_BRACKETED_PASTE.start_with?(buffer) do
-      if START_BRACKETED_PASTE == buffer
-        @@in_bracketed_paste_mode = true
-        return inner_getc(timeout_second)
-      elsif END_BRACKETED_PASTE == buffer
-        @@in_bracketed_paste_mode = false
-        ungetc(-1)
-        return inner_getc(timeout_second)
-      end
-      succ_c = inner_getc(Reline.core.config.keyseq_timeout)
-
-      if succ_c
-        buffer << succ_c
-      else
-        break
-      end
+    until buffer.end_with?(END_BRACKETED_PASTE)
+      c = inner_getc(Float::INFINITY)
+      break unless c
+      buffer << c
     end
-    buffer.bytes.reverse_each do |ch|
-      ungetc ch
-    end
-    inner_getc(timeout_second)
+    string = buffer.delete_suffix(END_BRACKETED_PASTE).force_encoding(encoding)
+    string.valid_encoding? ? string : ''
   end
 
   # if the usage expects to wait indefinitely, use Float::INFINITY for timeout_second
   def self.getc(timeout_second)
-    if Reline.core.config.enable_bracketed_paste
-      getc_with_bracketed_paste(timeout_second)
-    else
-      inner_getc(timeout_second)
-    end
+    inner_getc(timeout_second)
   end
 
   def self.in_pasting?
-    @@in_bracketed_paste_mode or (not empty_buffer?)
+    not empty_buffer?
   end
 
   def self.empty_buffer?
@@ -240,7 +235,7 @@ class Reline::ANSI
     s = [ENV["LINES"].to_i, ENV["COLUMNS"].to_i]
     return s if s[0] > 0 && s[1] > 0
     [24, 80]
-  rescue Errno::ENOTTY
+  rescue Errno::ENOTTY, Errno::ENODEV
     [24, 80]
   end
 
@@ -276,7 +271,7 @@ class Reline::ANSI
         buf = @@output.pread(@@output.pos, 0)
         row = buf.count("\n")
         column = buf.rindex("\n") ? (buf.size - buf.rindex("\n")) - 1 : 0
-      rescue Errno::ESPIPE
+      rescue Errno::ESPIPE, IOError
         # Just returns column 1 for ambiguous width because this I/O is not
         # tty and can't seek.
         row = 0
@@ -307,7 +302,7 @@ class Reline::ANSI
   end
 
   def self.hide_cursor
-    if Reline::Terminfo.enabled?
+    if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
       begin
         @@output.write Reline::Terminfo.tigetstr('civis')
       rescue Reline::Terminfo::TerminfoError
@@ -319,7 +314,7 @@ class Reline::ANSI
   end
 
   def self.show_cursor
-    if Reline::Terminfo.enabled?
+    if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
       begin
         @@output.write Reline::Terminfo.tigetstr('cnorm')
       rescue Reline::Terminfo::TerminfoError
@@ -353,11 +348,15 @@ class Reline::ANSI
   end
 
   def self.prep
+    # Enable bracketed paste
+    @@output.write "\e[?2004h" if Reline.core.config.enable_bracketed_paste
     retrieve_keybuffer
     nil
   end
 
   def self.deprep(otio)
+    # Disable bracketed paste
+    @@output.write "\e[?2004l" if Reline.core.config.enable_bracketed_paste
     Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler
   end
 end

data/lib/reline/config.rb

@@ -8,31 +8,12 @@ class Reline::Config
   end
 
   VARIABLE_NAMES = %w{
-    bind-tty-special-chars
-    blink-matching-paren
-    byte-oriented
     completion-ignore-case
     convert-meta
     disable-completion
-    enable-keypad
-    expand-tilde
-    history-preserve-point
     history-size
-    horizontal-scroll-mode
-    input-meta
     keyseq-timeout
-    mark-directories
-    mark-modified-lines
-    mark-symlinked-directories
-    match-hidden-files
-    meta-flag
-    output-meta
-    page-completions
-    prefer-visible-bell
-    print-completions-horizontally
     show-all-if-ambiguous
-    show-all-if-unmodified
-    visible-stats
     show-mode-in-prompt
     vi-cmd-mode-string
     vi-ins-mode-string
@@ -53,8 +34,6 @@ class Reline::Config
     @additional_key_bindings[:vi_insert] = {}
     @additional_key_bindings[:vi_command] = {}
     @oneshot_key_bindings = {}
-    @skip_section = nil
-    @if_stack = nil
     @editing_mode_label = :emacs
     @keymap_label = :emacs
     @keymap_prefix = []
@@ -71,17 +50,15 @@ class Reline::Config
     @test_mode = false
     @autocompletion = false
     @convert_meta = true if seven_bit_encoding?(Reline::IOGate.encoding)
+    @loaded = false
+    @enable_bracketed_paste = true
   end
 
   def reset
     if editing_mode_is?(:vi_command)
       @editing_mode_label = :vi_insert
     end
-    @additional_key_bindings.keys.each do |key|
-      @additional_key_bindings[key].clear
-    end
     @oneshot_key_bindings.clear
-    reset_default_key_bindings
   end
 
   def editing_mode
@@ -100,6 +77,10 @@ class Reline::Config
     @key_actors[@keymap_label]
   end
 
+  def loaded?
+    @loaded
+  end
+
   def inputrc_path
     case ENV['INPUTRC']
     when nil, ''
@@ -131,6 +112,7 @@ class Reline::Config
   end
 
   def read(file = nil)
+    @loaded = true
     file ||= default_inputrc_path
     begin
       if file.respond_to?(:readlines)
@@ -173,12 +155,6 @@ class Reline::Config
     @key_actors[@keymap_label].default_key_bindings[keystroke] = target
   end
 
-  def reset_default_key_bindings
-    @key_actors.values.each do |ka|
-      ka.reset_default_key_bindings
-    end
-  end
-
   def read_lines(lines, file = nil)
     if not lines.empty? and lines.first.encoding != Reline.encoding_system_needs
       begin
@@ -190,9 +166,7 @@ class Reline::Config
         end
       end
     end
-    conditions = [@skip_section, @if_stack]
-    @skip_section = nil
-    @if_stack = []
+    if_stack = []
 
     lines.each_with_index do |line, no|
       next if line.match(/\A\s*#/)
@@ -201,62 +175,67 @@ class Reline::Config
 
       line = line.chomp.lstrip
       if line.start_with?('$')
-        handle_directive(line[1..-1], file, no)
+        handle_directive(line[1..-1], file, no, if_stack)
         next
       end
 
-      next if @skip_section
+      next if if_stack.any? { |_no, skip| skip }
 
       case line
-      when /^set +([^ ]+) +([^ ]+)/i
-        var, value = $1.downcase, $2
-        bind_variable(var, value)
+      when /^set +([^ ]+) +(.+)/i
+        # value ignores everything after a space, raw_value does not.
+        var, value, raw_value = $1.downcase, $2.partition(' ').first, $2
+        bind_variable(var, value, raw_value)
         next
       when /\s*("#{KEYSEQ_PATTERN}+")\s*:\s*(.*)\s*$/o
         key, func_name = $1, $2
+        func_name = func_name.split.first
         keystroke, func = bind_key(key, func_name)
         next unless keystroke
         @additional_key_bindings[@keymap_label][@keymap_prefix + keystroke] = func
       end
     end
-    unless @if_stack.empty?
-      raise InvalidInputrc, "#{file}:#{@if_stack.last[1]}: unclosed if"
+    unless if_stack.empty?
+      raise InvalidInputrc, "#{file}:#{if_stack.last[0]}: unclosed if"
     end
-  ensure
-    @skip_section, @if_stack = conditions
   end
 
-  def handle_directive(directive, file, no)
+  def handle_directive(directive, file, no, if_stack)
     directive, args = directive.split(' ')
     case directive
     when 'if'
       condition = false
       case args
-      when 'mode'
+      when /^mode=(vi|emacs)$/i
+        mode = $1.downcase
+        # NOTE: mode=vi means vi-insert mode
+        mode = 'vi_insert' if mode == 'vi'
+        if @editing_mode_label == mode.to_sym
+          condition = true
+        end
       when 'term'
       when 'version'
       else # application name
         condition = true if args == 'Ruby'
         condition = true if args == 'Reline'
       end
-      @if_stack << [file, no, @skip_section]
-      @skip_section = !condition
+      if_stack << [no, !condition]
     when 'else'
-      if @if_stack.empty?
+      if if_stack.empty?
         raise InvalidInputrc, "#{file}:#{no}: unmatched else"
       end
-      @skip_section = !@skip_section
+      if_stack.last[1] = !if_stack.last[1]
     when 'endif'
-      if @if_stack.empty?
+      if if_stack.empty?
         raise InvalidInputrc, "#{file}:#{no}: unmatched endif"
       end
-      @skip_section = @if_stack.pop
+      if_stack.pop
     when 'include'
       read(File.expand_path(args))
     end
   end
 
-  def bind_variable(name, value)
+  def bind_variable(name, value, raw_value)
     case name
     when 'history-size'
       begin
@@ -281,7 +260,7 @@ class Reline::Config
     when 'completion-query-items'
       @completion_query_items = value.to_i
     when 'isearch-terminators'
-      @isearch_terminators = retrieve_string(value)
+      @isearch_terminators = retrieve_string(raw_value)
     when 'editing-mode'
       case value
       when 'emacs'
@@ -323,11 +302,11 @@ class Reline::Config
         @show_mode_in_prompt = false
       end
     when 'vi-cmd-mode-string'
-      @vi_cmd_mode_string = retrieve_string(value)
+      @vi_cmd_mode_string = retrieve_string(raw_value)
     when 'vi-ins-mode-string'
-      @vi_ins_mode_string = retrieve_string(value)
+      @vi_ins_mode_string = retrieve_string(raw_value)
     when 'emacs-mode-string'
-      @emacs_mode_string = retrieve_string(value)
+      @emacs_mode_string = retrieve_string(raw_value)
     when *VARIABLE_NAMES then
       variable_name = :"@#{name.tr(?-, ?_)}"
       instance_variable_set(variable_name, value.nil? || value == '1' || value == 'on')

data/lib/reline/face.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+class Reline::Face
+  SGR_PARAMETERS = {
+    foreground: {
+      black: 30,
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      magenta: 35,
+      cyan: 36,
+      white: 37,
+      bright_black: 90,
+      gray: 90,
+      bright_red: 91,
+      bright_green: 92,
+      bright_yellow: 93,
+      bright_blue: 94,
+      bright_magenta: 95,
+      bright_cyan: 96,
+      bright_white: 97
+    },
+    background: {
+      black: 40,
+      red: 41,
+      green: 42,
+      yellow: 43,
+      blue: 44,
+      magenta: 45,
+      cyan: 46,
+      white: 47,
+      bright_black: 100,
+      gray: 100,
+      bright_red: 101,
+      bright_green: 102,
+      bright_yellow: 103,
+      bright_blue: 104,
+      bright_magenta: 105,
+      bright_cyan: 106,
+      bright_white: 107,
+    },
+    style: {
+      reset: 0,
+      bold: 1,
+      faint: 2,
+      italicized: 3,
+      underlined: 4,
+      slowly_blinking: 5,
+      blinking: 5,
+      rapidly_blinking: 6,
+      negative: 7,
+      concealed: 8,
+      crossed_out: 9
+    }
+  }.freeze
+
+  class Config
+    ESSENTIAL_DEFINE_NAMES = %i(default enhanced scrollbar).freeze
+    RESET_SGR = "\e[0m".freeze
+
+    def initialize(name, &block)
+      @definition = {}
+      block.call(self)
+      ESSENTIAL_DEFINE_NAMES.each do |name|
+        @definition[name] ||= { style: :reset, escape_sequence: RESET_SGR }
+      end
+    end
+
+    attr_reader :definition
+
+    def define(name, **values)
+      values[:escape_sequence] = format_to_sgr(values.to_a).freeze
+      @definition[name] = values
+    end
+
+    def reconfigure
+      @definition.each_value do |values|
+        values.delete(:escape_sequence)
+        values[:escape_sequence] = format_to_sgr(values.to_a).freeze
+      end
+    end
+
+    def [](name)
+      @definition.dig(name, :escape_sequence) or raise ArgumentError, "unknown face: #{name}"
+    end
+
+    private
+
+    def sgr_rgb(key, value)
+      return nil unless rgb_expression?(value)
+      if Reline::Face.truecolor?
+        sgr_rgb_truecolor(key, value)
+      else
+        sgr_rgb_256color(key, value)
+      end
+    end
+
+    def sgr_rgb_truecolor(key, value)
+      case key
+      when :foreground
+        "38;2;"
+      when :background
+        "48;2;"
+      end + value[1, 6].scan(/../).map(&:hex).join(";")
+    end
+
+    def sgr_rgb_256color(key, value)
+      # 256 colors are
+      # 0..15: standard colors, hight intensity colors
+      # 16..232: 216 colors (R, G, B each 6 steps)
+      # 233..255: grayscale colors (24 steps)
+      # This methods converts rgb_expression to 216 colors
+      rgb = value[1, 6].scan(/../).map(&:hex)
+      # Color steps are [0, 95, 135, 175, 215, 255]
+      r, g, b = rgb.map { |v| v <= 95 ? v / 48 : (v - 35) / 40 }
+      color = (16 + 36 * r + 6 * g + b)
+      case key
+      when :foreground
+        "38;5;#{color}"
+      when :background
+        "48;5;#{color}"
+      end
+    end
+
+    def format_to_sgr(ordered_values)
+      sgr = "\e[" + ordered_values.map do |key_value|
+        key, value = key_value
+        case key
+        when :foreground, :background
+          case value
+          when Symbol
+            SGR_PARAMETERS[key][value]
+          when String
+            sgr_rgb(key, value)
+          end
+        when :style
+          [ value ].flatten.map do |style_name|
+            SGR_PARAMETERS[:style][style_name]
+          end.then do |sgr_parameters|
+            sgr_parameters.include?(nil) ? nil : sgr_parameters
+          end
+        end.then do |rendition_expression|
+          unless rendition_expression
+            raise ArgumentError, "invalid SGR parameter: #{value.inspect}"
+          end
+          rendition_expression
+        end
+      end.join(';') + "m"
+      sgr == RESET_SGR ? RESET_SGR : RESET_SGR + sgr
+    end
+
+    def rgb_expression?(color)
+      color.respond_to?(:match?) and color.match?(/\A#[0-9a-fA-F]{6}\z/)
+    end
+  end
+
+  private_constant :SGR_PARAMETERS, :Config
+
+  def self.truecolor?
+    @force_truecolor || %w[truecolor 24bit].include?(ENV['COLORTERM'])
+  end
+
+  def self.force_truecolor
+    @force_truecolor = true
+    @configs&.each_value(&:reconfigure)
+  end
+
+  def self.[](name)
+    @configs[name]
+  end
+
+  def self.config(name, &block)
+    @configs ||= {}
+    @configs[name] = Config.new(name, &block)
+  end
+
+  def self.configs
+    @configs.transform_values(&:definition)
+  end
+
+  def self.load_initial_configs
+    config(:default) do |conf|
+      conf.define :default, style: :reset
+      conf.define :enhanced, style: :reset
+      conf.define :scrollbar, style: :reset
+    end
+    config(:completion_dialog) do |conf|
+      conf.define :default, foreground: :bright_white, background: :gray
+      conf.define :enhanced, foreground: :black, background: :white
+      conf.define :scrollbar, foreground: :white, background: :gray
+    end
+  end
+
+  def self.reset_to_initial_configs
+    @configs = {}
+    load_initial_configs
+  end
+end

data/lib/reline/general_io.rb

@@ -1,6 +1,8 @@
 require 'io/wait'
 
 class Reline::GeneralIO
+  RESET_COLOR = '' # Do not send color reset sequence
+
   def self.reset(encoding: nil)
     @@pasting = false
     if encoding
@@ -44,6 +46,7 @@ class Reline::GeneralIO
     end
     c = nil
     loop do
+      Reline.core.line_editor.handle_signal
       result = @@input.wait_readable(0.1)
       next if result.nil?
       c = @@input.read(1)
@@ -57,7 +60,7 @@ class Reline::GeneralIO
   end
 
   def self.get_screen_size
-    [1, 1]
+    [24, 80]
   end
 
   def self.cursor_pos
@@ -100,14 +103,6 @@ class Reline::GeneralIO
     @@pasting
   end
 
-  def self.start_pasting
-    @@pasting = true
-  end
-
-  def self.finish_pasting
-    @@pasting = false
-  end
-
   def self.prep
   end
 

data/lib/reline/history.rb

@@ -62,7 +62,7 @@ class Reline::History < Array
   private def check_index(index)
     index += size if index < 0
     if index < -2147483648 or 2147483647 < index
-      raise RangeError.new("integer #{index} too big to convert to `int'")
+      raise RangeError.new("integer #{index} too big to convert to 'int'")
     end
     # If history_size is negative, history size is unlimited.
     if @config.history_size.positive?

data/lib/reline/key_actor/base.rb

@@ -12,8 +12,4 @@ class Reline::KeyActor::Base
   def default_key_bindings
     @default_key_bindings
   end
-
-  def reset_default_key_bindings
-    @default_key_bindings.clear
-  end
 end