123456789_123456789_123456789_123456789_123456789_

Class: Reline::Config

Relationships & Source Files
Namespace Children
Exceptions:
Inherits: Object
Defined in: lib/reline/config.rb

Constant Summary

  • KEYSEQ_PATTERN =
    # File 'lib/reline/config.rb', line 4
    /\\(?:C|Control)-[A-Za-z_]|\\(?:M|Meta)-[0-9A-Za-z_]|\\(?:C|Control)-(?:M|Meta)-[A-Za-z_]|\\(?:M|Meta)-(?:C|Control)-[A-Za-z_]|\\e|\\[\\\"\'abdfnrtv]|\\\d{1,3}|\\x\h{1,2}|./
  • VARIABLE_NAMES =
    # File 'lib/reline/config.rb', line 10
    %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
      emacs-mode-string
      enable-bracketed-paste
      isearch-terminators
    }
  • VARIABLE_NAME_SYMBOLS =
    # File 'lib/reline/config.rb', line 43
    VARIABLE_NAMES.map { |v| :"#{v.tr(?-, ?_)}" }

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.newConfig

[ GitHub ]

  
# File 'lib/reline/config.rb', line 50

def initialize
  @additional_key_bindings = {} # from inputrc
  @additional_key_bindings[:emacs] = {}
  @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 = []
  @key_actors = {}
  @key_actors[:emacs] = Reline::KeyActor::Emacs.new
  @key_actors[:vi_insert] = Reline::KeyActor::ViInsert.new
  @key_actors[:vi_command] = Reline::KeyActor::ViCommand.new
  @vi_cmd_mode_string = '(cmd)'
  @vi_ins_mode_string = '(ins)'
  @emacs_mode_string = '@'
  # https://tiswww.case.edu/php/chet/readline/readline.html#IDX25
  @history_size = -1 # unlimited
  @keyseq_timeout = 500
  @test_mode = false
  @autocompletion = false
  @convert_meta = true if seven_bit_encoding?(Reline::IOGate.encoding)
end

Instance Attribute Details

#autocompletion (rw)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 48

attr_accessor :autocompletion

#editing_mode (rw)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 87

def editing_mode
  @key_actors[@editing_mode_label]
end

#editing_mode=(val) (rw)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 91

def editing_mode=(val)
  @editing_mode_label = val
end

#test_mode (readonly)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 2

attr_reader :test_mode

Instance Method Details

#add_default_key_binding(keystroke, target)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 172

def add_default_key_binding(keystroke, target)
  @key_actors[@keymap_label].default_key_bindings[keystroke] = target
end

#add_default_key_binding_by_keymap(keymap, keystroke, target)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 168

def add_default_key_binding_by_keymap(keymap, keystroke, target)
  @key_actors[keymap].default_key_bindings[keystroke] = target
end

#add_oneshot_key_binding(keystroke, target)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 160

def add_oneshot_key_binding(keystroke, target)
  @oneshot_key_bindings[keystroke] = target
end

#bind_key(key, func_name)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 342

def bind_key(key, func_name)
  if key =~ /\A"(.*)"\z/
    keyseq = parse_keyseq($1)
  else
    keyseq = nil
  end
  if func_name =~ /"(.*)"/
    func = parse_keyseq($1)
  else
    func = func_name.tr(?-, ?_).to_sym # It must be macro.
  end
  [keyseq, func]
end

#bind_variable(name, value)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 259

def bind_variable(name, value)
  case name
  when 'history-size'
    begin
      @history_size = Integer(value)
    rescue ArgumentError
      @history_size = 500
    end
  when 'bell-style'
    @bell_style =
      case value
      when 'none', 'off'
        :none
      when 'audible', 'on'
        :audible
      when 'visible'
        :visible
      else
        :audible
      end
  when 'comment-begin'
    @comment_begin = value.dup
  when 'completion-query-items'
    @completion_query_items = value.to_i
  when 'isearch-terminators'
    @isearch_terminators = retrieve_string(value)
  when 'editing-mode'
    case value
    when 'emacs'
      @editing_mode_label = :emacs
      @keymap_label = :emacs
      @keymap_prefix = []
    when 'vi'
      @editing_mode_label = :vi_insert
      @keymap_label = :vi_insert
      @keymap_prefix = []
    end
  when 'keymap'
    case value
    when 'emacs', 'emacs-standard'
      @keymap_label = :emacs
      @keymap_prefix = []
    when 'emacs-ctlx'
      @keymap_label = :emacs
      @keymap_prefix = [?\C-x.ord]
    when 'emacs-meta'
      @keymap_label = :emacs
      @keymap_prefix = [?\e.ord]
    when 'vi', 'vi-move', 'vi-command'
      @keymap_label = :vi_command
      @keymap_prefix = []
    when 'vi-insert'
      @keymap_label = :vi_insert
      @keymap_prefix = []
    end
  when 'keyseq-timeout'
    @keyseq_timeout = value.to_i
  when 'show-mode-in-prompt'
    case value
    when 'off'
      @show_mode_in_prompt = false
    when 'on'
      @show_mode_in_prompt = true
    else
      @show_mode_in_prompt = false
    end
  when 'vi-cmd-mode-string'
    @vi_cmd_mode_string = retrieve_string(value)
  when 'vi-ins-mode-string'
    @vi_ins_mode_string = retrieve_string(value)
  when 'emacs-mode-string'
    @emacs_mode_string = retrieve_string(value)
  when *VARIABLE_NAMES then
    variable_name = :"@#{name.tr(?-, ?_)}"
    instance_variable_set(variable_name, value.nil? || value == '1' || value == 'on')
  end
end

#default_inputrc_path (private)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 129

private def default_inputrc_path
  @default_inputrc_path ||= inputrc_path
end

#editing_mode_is?(*val) ⇒ Boolean

[ GitHub ]

  
# File 'lib/reline/config.rb', line 95

def editing_mode_is?(*val)
  val.any?(@editing_mode_label)
end

#handle_directive(directive, file, no)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 229

def handle_directive(directive, file, no)
  directive, args = directive.split(' ')
  case directive
  when 'if'
    condition = false
    case args
    when 'mode'
    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
  when 'else'
    if @if_stack.empty?
      raise InvalidInputrc, "#{file}:#{no}: unmatched else"
    end
    @skip_section = !@skip_section
  when 'endif'
    if @if_stack.empty?
      raise InvalidInputrc, "#{file}:#{no}: unmatched endif"
    end
    @skip_section = @if_stack.pop
  when 'include'
    read(File.expand_path(args))
  end
end

#inputrc_path

[ GitHub ]

  
# File 'lib/reline/config.rb', line 103

def inputrc_path
  case ENV['INPUTRC']
  when nil, ''
  else
    return File.expand_path(ENV['INPUTRC'])
  end

  # In the XDG Specification, if ~/.config/readline/inputrc exists, then
  # ~/.inputrc should not be read, but for compatibility with GNU Readline,
  # if ~/.inputrc exists, then it is given priority.
  home_rc_path = File.expand_path('~/.inputrc')
  return home_rc_path if File.exist?(home_rc_path)

  case path = ENV['XDG_CONFIG_HOME']
  when nil, ''
  else
    path = File.join(path, 'readline/inputrc')
    return path if File.exist?(path) and path == File.expand_path(path)
  end

  path = File.expand_path('~/.config/readline/inputrc')
  return path if File.exist?(path)

  return home_rc_path
end

#key_bindings

[ GitHub ]

  
# File 'lib/reline/config.rb', line 152

def key_bindings
  # The key bindings for each editing mode will be overwritten by the user-defined ones.
  kb = @key_actors[@editing_mode_label].default_key_bindings.dup
  kb.merge!(@additional_key_bindings[@editing_mode_label])
  kb.merge!(@oneshot_key_bindings)
  kb
end

#key_notation_to_code(notation)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 356

def key_notation_to_code(notation)
  case notation
  when /\\(?:C|Control)-([A-Za-z_])/
    (1 + $1.downcase.ord - ?a.ord)
  when /\\(?:M|Meta)-([0-9A-Za-z_])/
    modified_key = $1
    case $1
    when /[0-9]/
      ?\M-0.bytes.first + (modified_key.ord - ?0.ord)
    when /[A-Z]/
      ?\M-A.bytes.first + (modified_key.ord - ?A.ord)
    when /[a-z]/
      ?\M-a.bytes.first + (modified_key.ord - ?a.ord)
    end
  when /\\(?:C|Control)-(?:M|Meta)-[A-Za-z_]/, /\\(?:M|Meta)-(?:C|Control)-[A-Za-z_]/
  # 129 M-^A
  when /\\(\d{1,3})/ then $1.to_i(8) # octal
  when /\\x(\h{1,2})/ then $1.to_i(16) # hexadecimal
  when "\\e" then ?\e.ord
  when "\\\\" then ?\\.ord
  when "\\\"" then ?".ord
  when "\\'" then ?'.ord
  when "\\a" then ?\a.ord
  when "\\b" then ?\b.ord
  when "\\d" then ?\d.ord
  when "\\f" then ?\f.ord
  when "\\n" then ?\n.ord
  when "\\r" then ?\r.ord
  when "\\t" then ?\t.ord
  when "\\v" then ?\v.ord
  else notation.ord
  end
end

#keymap

[ GitHub ]

  
# File 'lib/reline/config.rb', line 99

def keymap
  @key_actors[@keymap_label]
end

#parse_keyseq(str)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 390

def parse_keyseq(str)
  ret = []
  str.scan(KEYSEQ_PATTERN) do
    ret << key_notation_to_code($&)
  end
  ret
end

#read(file = nil)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 133

def read(file = nil)
  file ||= default_inputrc_path
  begin
    if file.respond_to?(:readlines)
      lines = file.readlines
    else
      lines = File.readlines(file)
    end
  rescue Errno::ENOENT
    return nil
  end

  read_lines(lines, file)
  self
rescue InvalidInputrc => e
  warn e.message
  nil
end

#read_lines(lines, file = nil)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 182

def read_lines(lines, file = nil)
  if not lines.empty? and lines.first.encoding != Reline.encoding_system_needs
    begin
      lines = lines.map do |l|
        l.encode(Reline.encoding_system_needs)
      rescue Encoding::UndefinedConversionError
        mes = "The inputrc encoded in #{lines.first.encoding.name} can't be converted to the locale #{Reline.encoding_system_needs.name}."
        raise Reline::ConfigEncodingConversionError.new(mes)
      end
    end
  end
  conditions = [@skip_section, @if_stack]
  @skip_section = nil
  @if_stack = []

  lines.each_with_index do |line, no|
    next if line.match(/\A\s*#/)

    no += 1

    line = line.chomp.lstrip
    if line.start_with?('$')
      handle_directive(line[1..-1], file, no)
      next
    end

    next if @skip_section

    case line
    when /^set +([^ ]+) +([^ ]+)/i
      var, value = $1.downcase, $2
      bind_variable(var, value)
      next
    when /\s*("#{KEYSEQ_PATTERN}+")\s*:\s*(.*)\s*$/o
      key, func_name = $1, $2
      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"
  end
ensure
  @skip_section, @if_stack = conditions
end

#reset

[ GitHub ]

  
# File 'lib/reline/config.rb', line 76

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

#reset_default_key_bindings

[ GitHub ]

  
# File 'lib/reline/config.rb', line 176

def reset_default_key_bindings
  @key_actors.values.each do |ka|
    ka.reset_default_key_bindings
  end
end

#reset_oneshot_key_bindings

[ GitHub ]

  
# File 'lib/reline/config.rb', line 164

def reset_oneshot_key_bindings
  @oneshot_key_bindings.clear
end

#retrieve_string(str)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 337

def retrieve_string(str)
  str = $1 if str =~ /\A"(.*)"\z/
  parse_keyseq(str).map { |c| c.chr(Reline.encoding_system_needs) }.join
end

#seven_bit_encoding?(encoding) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/reline/config.rb', line 398

private def seven_bit_encoding?(encoding)
  encoding == Encoding::US_ASCII
end