Introduce a new class Reline::Face to configure character attributes

lib/reline.rb

@@ -8,6 +8,7 @@
 require 'reline/line_editor'
 require 'reline/history'
 require 'reline/terminfo'
+require 'reline/face'
 require 'rbconfig'
 
 module Reline
@@ -37,10 +38,8 @@ def match?(other)
   DialogRenderInfo = Struct.new(
     :pos,
     :contents,
-    :bg_color,
-    :pointer_bg_color,
-    :fg_color,
-    :pointer_fg_color,
+    :face,
+    :bg_color, # For the time being, this line should stay here for the compatibility with IRB.
     :width,
     :height,
     :scrollbar,
@@ -261,10 +260,7 @@ def get_screen_size
         contents: result,
         scrollbar: true,
         height: [15, preferred_dialog_height].min,
-        bg_color: 46,
-        pointer_bg_color: 45,
-        fg_color: 37,
-        pointer_fg_color: 37
+        face: :completion_dialog
       )
     }
     Reline::DEFAULT_DIALOG_CONTEXT = Array.new
@@ -604,4 +600,16 @@ def self.line_editor
   io
 end
 
+Reline::Face.config(:default) do |face|
+  face.define :normal_line, :default
+  face.define :enhanced_line, :default
+  face.define :scrollbar, :default
+end
+
+Reline::Face.config(:completion_dialog) do |face|
+  face.define :normal_line, :white_display, :cyan_background
+  face.define :enhanced_line, :white_display, :magenta_background
+  face.define :scrollbar, :white_display, :cyan_background
+end
+
 Reline::HISTORY = Reline::History.new(Reline.core.config)

lib/reline/face.rb

@@ -0,0 +1,120 @@
+class Reline::Face
+  SGR_PARAMETERS = {
+    # Display
+    black_display: 30,
+    red_display: 31,
+    green_display: 32,
+    yellow_display: 33,
+    blue_display: 34,
+    magenta_display: 35,
+    cyan_display: 36,
+    white_display: 37,
+    bright_black_display: 90,
+    gray_display: 90,
+    bright_red_display: 91,
+    bright_green_display: 92,
+    bright_yellow_display: 93,
+    bright_blue_display: 94,
+    bright_magenta_display: 95,
+    bright_cyan_display: 96,
+    bright_white_display: 97,
+    # Background
+    black_background: 40,
+    red_background: 41,
+    green_background: 42,
+    yellow_background: 43,
+    blue_background: 44,
+    magenta_background: 45,
+    cyan_background: 46,
+    white_background: 47,
+    bright_black_background: 100,
+    gray_background: 100,
+    bright_red_background: 101,
+    bright_green_background: 102,
+    bright_yellow_background: 103,
+    bright_blue_background: 104,
+    bright_magenta_background: 105,
+    bright_cyan_background: 106,
+    bright_white_background: 107,
+    # Style
+    default: 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 FaceConfig
+    def initialize(name, &block)
+      @name = name
+      block.call(self)
+      define(:default) unless self.respond_to?(:default)
+    end
+
+    def define(name, *sgr_values)
+      sgr_values.each do |value|
+        sgr_valid?(value) or raise ArgumentError, "invalid SGR parameter: #{value.inspect}"
+      end
+      sgr = "\e[" + sgr_values.map { |value|
+        case value
+        when Symbol
+          SGR_PARAMETERS[value]
+        when Hash
+          key, v = value.first
+          sgr_rgb(key, v)
+        end
+      }.join(';') + "m"
+      define_singleton_method(name) { sgr }
+    end
+
+    private
+
+    def sgr_rgb(key, value)
+      case key
+      when :display
+       "38;2;"
+      when :background
+        "48;2;"
+      end + value[1, 6].scan(/../).map(&:hex).join(";")
+    end
+
+    def sgr_valid?(sgr_value)
+      case sgr_value
+      when Symbol
+        SGR_PARAMETERS.keys.include?(sgr_value)
+      when Hash
+        sgr_value.count == 1 or return false
+        key, value = sgr_value.first
+        %i(display background).include?(key) or return false
+        rgb?(value) or return false
+      else
+        false
+      end
+    end
+
+    def rgb?(color)
+      color.respond_to?(:match?) and color.match?(/\A#[0-9a-fA-F]{6}\z/)
+    end
+  end
+
+  CONFIGS = {}
+
+  private_constant :SGR_PARAMETERS, :FaceConfig, :CONFIGS
+
+  def self.[](name)
+    CONFIGS[name]
+  end
+
+  def self.config(name, override = true, &block)
+    return if CONFIGS[name] && !override
+    CONFIGS[name] = FaceConfig.new(name, &block)
+  end
+
+end
+

lib/reline/line_editor.rb

@@ -827,27 +827,23 @@ def add_dialog_proc(name, p, context = nil)
       dialog.column = 0
       dialog.width = @screen_size.last
     end
+    face = Reline::Face[dialog_render_info.face || :default]
+    scrollbar_sgr = face.scrollbar
+    normal_line_sgr = face.normal_line
     dialog.contents = contents.map.with_index do |item, i|
-      if i == pointer
-        fg_color = dialog_render_info.pointer_fg_color
-        bg_color = dialog_render_info.pointer_bg_color
-      else
-        fg_color = dialog_render_info.fg_color
-        bg_color = dialog_render_info.bg_color
-      end
+      line_sgr = i == pointer ? face.enhanced_line : normal_line_sgr
       str_width = dialog.width - (scrollbar_pos.nil? ? 0 : @block_elem_width)
       str = padding_space_with_escape_sequences(Reline::Unicode.take_range(item, 0, str_width), str_width)
-      colored_content = "\e[#{bg_color}m\e[#{fg_color}m#{str}"
+      colored_content = "#{line_sgr}#{str}"
       if scrollbar_pos
-        color_seq = "\e[37m"
         if scrollbar_pos <= (i * 2) and (i * 2 + 1) < (scrollbar_pos + bar_height)
-          colored_content + color_seq + @full_block
+          colored_content + scrollbar_sgr + @full_block
         elsif scrollbar_pos <= (i * 2) and (i * 2) < (scrollbar_pos + bar_height)
-          colored_content + color_seq + @upper_half_block
+          colored_content + scrollbar_sgr + @upper_half_block
         elsif scrollbar_pos <= (i * 2 + 1) and (i * 2) < (scrollbar_pos + bar_height)
-          colored_content + color_seq + @lower_half_block
+          colored_content + scrollbar_sgr + @lower_half_block
         else
-          colored_content + color_seq + ' ' * @block_elem_width
+          colored_content + scrollbar_sgr + ' ' * @block_elem_width
         end
       else
         colored_content

test/reline/test_face.rb

@@ -0,0 +1,106 @@
+require_relative 'helper'
+
+class Reline::Face::Test < Reline::TestCase
+  class WithSetupTest < self
+    def setup
+      Reline::Face.config(:my_config) do |face|
+        face.define :normal_line, :blue_display
+        face.define :enhanced_line, { display: "#FF1020" }, :black_background, :bold, :underlined
+      end
+      Reline::Face.config(:another_config) do |face|
+        face.define :another_label, :red_display
+      end
+      @face = Reline::Face[:my_config]
+    end
+
+    def test_my_config_line
+      assert_equal "\e[34m", @face.normal_line
+    end
+
+    def test_my_config_enhanced_line
+      assert_equal "\e[38;2;255;16;32;40;1;4m", @face.enhanced_line
+    end
+
+    def test_my_config_default
+      assert_equal "\e[m", @face.default
+    end
+
+    def test_not_respond_to_another_label
+      assert_equal false, @face.respond_to?(:another_label)
+    end
+
+    def test_existing_confit_override_default
+      Reline::Face.config(:my_config) do |face|
+        face.define :normal_line, :red_display
+      end
+      assert_equal "\e[31m", Reline::Face[:my_config].normal_line
+    end
+
+    def test_existing_config_override_false
+      Reline::Face.config(:my_config, false) do |face|
+        face.define :normal_line, :red_display
+      end
+      assert_equal "\e[34m", Reline::Face[:my_config].normal_line
+    end
+
+    def test_new_config_override_false
+      Reline::Face.config(:new_config, false) do |face|
+        face.define :normal_line, :red_display
+      end
+      assert_equal "\e[31m", Reline::Face[:new_config].normal_line
+    end
+  end
+
+  class WithoutSetupTest < self
+    def test_invalid_display_name
+      assert_raise ArgumentError do
+        Reline::Face.config(:invalid_config) do |face|
+          face.define :normal_line, :invalid_display
+        end
+      end
+    end
+
+    def test_invalid_background_name
+      assert_raise ArgumentError do
+        Reline::Face.config(:invalid_config) do |face|
+          face.define :normal_line, :invalid_background
+        end
+      end
+    end
+
+    def test_private_constants
+      [:SGR_PARAMETER, :FaceConfig, :CONFIGS].each do |name|
+        assert_equal false, Reline::Face.constants.include?(name)
+      end
+    end
+   end
+
+  class FaceConfigTest < self
+    def setup
+      @face_config = Reline::Face.const_get(:FaceConfig).new(:my_config) { }
+    end
+
+    def test_rgb?
+      assert_equal true, @face_config.send(:rgb?, "#FFFFFF")
+    end
+
+    def test_invalid_rgb?
+      assert_equal false, @face_config.send(:rgb?, "FFFFFF")
+      assert_equal false, @face_config.send(:rgb?, "#FFFFF")
+    end
+
+    def test_sgr_valid?
+      assert_equal true, @face_config.send(:sgr_valid?, :white_display)
+      assert_equal true, @face_config.send(:sgr_valid?, { display: "#ffffff" })
+    end
+
+    def test_invalid_sgr_valid?
+      assert_equal false, @face_config.send(:sgr_valid?, { invalid_key: "#ffffff" })
+    end
+
+    def test_sgr_rgb
+      assert_equal "38;2;255;255;255", @face_config.send(:sgr_rgb, :display, "#ffffff")
+      assert_equal "48;2;18;52;86", @face_config.send(:sgr_rgb, :background, "#123456")
+    end
+  end
+end

test/reline/yamatanooroti/multiline_repl

@@ -120,7 +120,7 @@ opt.on('--dialog VAL') { |v|
     if v.include?('alt-scrollbar')
       scrollbar = true
     end
-    Reline::DialogRenderInfo.new(pos: cursor_pos, contents: contents, height: height, scrollbar: scrollbar)
+    Reline::DialogRenderInfo.new(pos: cursor_pos, contents: contents, height: height, scrollbar: scrollbar, face: :completion_dialog)
   })
   if v.include?('alt-scrollbar')
     ENV['RELINE_ALT_SCROLLBAR'] = '1'