Class: Reline::Config
- Inherits:
-
Object
- Object
- Reline::Config
- Defined in:
- lib/reline/config.rb
Defined Under Namespace
Classes: InvalidInputrc
Constant Summary collapse
- KEYSEQ_PATTERN =
/\\(?: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 =
%w{ completion-ignore-case convert-meta disable-completion history-size keyseq-timeout show-all-if-ambiguous show-mode-in-prompt vi-cmd-mode-string vi-ins-mode-string emacs-mode-string enable-bracketed-paste isearch-terminators }
- VARIABLE_NAME_SYMBOLS =
VARIABLE_NAMES.map { |v| :"#{v.tr(?-, ?_)}" }
Instance Attribute Summary collapse
-
#autocompletion ⇒ Object
Returns the value of attribute autocompletion.
-
#test_mode ⇒ Object
readonly
Returns the value of attribute test_mode.
Instance Method Summary collapse
- #add_default_key_binding(keystroke, target) ⇒ Object
- #add_default_key_binding_by_keymap(keymap, keystroke, target) ⇒ Object
- #add_oneshot_key_binding(keystroke, target) ⇒ Object
- #bind_key(key, func_name) ⇒ Object
- #bind_variable(name, value, raw_value) ⇒ Object
- #editing_mode ⇒ Object
- #editing_mode=(val) ⇒ Object
- #editing_mode_is?(*val) ⇒ Boolean
- #handle_directive(directive, file, no, if_stack) ⇒ Object
-
#initialize ⇒ Config
constructor
A new instance of Config.
- #inputrc_path ⇒ Object
- #key_bindings ⇒ Object
- #key_notation_to_code(notation) ⇒ Object
- #keymap ⇒ Object
- #loaded? ⇒ Boolean
- #parse_keyseq(str) ⇒ Object
- #read(file = nil) ⇒ Object
- #read_lines(lines, file = nil) ⇒ Object
- #reset ⇒ Object
- #reset_oneshot_key_bindings ⇒ Object
- #retrieve_string(str) ⇒ Object
Constructor Details
#initialize ⇒ Config
Returns a new instance of Config.
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/reline/config.rb', line 31 def initialize @additional_key_bindings = { # from inputrc emacs: Reline::KeyActor::Base.new, vi_insert: Reline::KeyActor::Base.new, vi_command: Reline::KeyActor::Base.new } @oneshot_key_bindings = Reline::KeyActor::Base.new @editing_mode_label = :emacs @keymap_label = :emacs @keymap_prefix = [] @default_key_bindings = { emacs: Reline::KeyActor::Base.new(Reline::KeyActor::EMACS_MAPPING), vi_insert: Reline::KeyActor::Base.new(Reline::KeyActor::VI_INSERT_MAPPING), vi_command: Reline::KeyActor::Base.new(Reline::KeyActor::VI_COMMAND_MAPPING) } @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) @loaded = false @enable_bracketed_paste = true end |
Instance Attribute Details
#autocompletion ⇒ Object
Returns the value of attribute autocompletion.
29 30 31 |
# File 'lib/reline/config.rb', line 29 def autocompletion @autocompletion end |
#test_mode ⇒ Object (readonly)
Returns the value of attribute test_mode.
2 3 4 |
# File 'lib/reline/config.rb', line 2 def test_mode @test_mode end |
Instance Method Details
#add_default_key_binding(keystroke, target) ⇒ Object
156 157 158 |
# File 'lib/reline/config.rb', line 156 def add_default_key_binding(keystroke, target) add_default_key_binding_by_keymap(@keymap_label, keystroke, target) end |
#add_default_key_binding_by_keymap(keymap, keystroke, target) ⇒ Object
152 153 154 |
# File 'lib/reline/config.rb', line 152 def add_default_key_binding_by_keymap(keymap, keystroke, target) @default_key_bindings[keymap].add(keystroke, target) end |
#add_oneshot_key_binding(keystroke, target) ⇒ Object
141 142 143 144 145 146 |
# File 'lib/reline/config.rb', line 141 def add_oneshot_key_binding(keystroke, target) # IRB sets invalid keystroke [Reline::Key]. We should ignore it. return unless keystroke.all? { |c| c.is_a?(Integer) } @oneshot_key_bindings.add(keystroke, target) end |
#bind_key(key, func_name) ⇒ Object
323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/reline/config.rb', line 323 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, raw_value) ⇒ Object
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/reline/config.rb', line 240 def bind_variable(name, value, raw_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(raw_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(raw_value) when 'vi-ins-mode-string' @vi_ins_mode_string = retrieve_string(raw_value) when 'emacs-mode-string' @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') end end |
#editing_mode ⇒ Object
66 67 68 |
# File 'lib/reline/config.rb', line 66 def editing_mode @default_key_bindings[@editing_mode_label] end |
#editing_mode=(val) ⇒ Object
70 71 72 |
# File 'lib/reline/config.rb', line 70 def editing_mode=(val) @editing_mode_label = val end |
#editing_mode_is?(*val) ⇒ Boolean
74 75 76 |
# File 'lib/reline/config.rb', line 74 def editing_mode_is?(*val) val.any?(@editing_mode_label) end |
#handle_directive(directive, file, no, if_stack) ⇒ Object
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/reline/config.rb', line 205 def handle_directive(directive, file, no, if_stack) directive, args = directive.split(' ') case directive when 'if' condition = false case args 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 << [no, !condition] when 'else' if if_stack.empty? raise InvalidInputrc, "#{file}:#{no}: unmatched else" end if_stack.last[1] = !if_stack.last[1] when 'endif' if if_stack.empty? raise InvalidInputrc, "#{file}:#{no}: unmatched endif" end if_stack.pop when 'include' read(File.(args)) end end |
#inputrc_path ⇒ Object
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/reline/config.rb', line 86 def inputrc_path case ENV['INPUTRC'] when nil, '' else return File.(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.('~/.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.(path) end path = File.('~/.config/readline/inputrc') return path if File.exist?(path) return home_rc_path end |
#key_bindings ⇒ Object
136 137 138 139 |
# File 'lib/reline/config.rb', line 136 def key_bindings # The key bindings for each editing mode will be overwritten by the user-defined ones. Reline::KeyActor::Composite.new([@oneshot_key_bindings, @additional_key_bindings[@editing_mode_label], @default_key_bindings[@editing_mode_label]]) end |
#key_notation_to_code(notation) ⇒ Object
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/reline/config.rb', line 337 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 ⇒ Object
78 79 80 |
# File 'lib/reline/config.rb', line 78 def keymap @default_key_bindings[@keymap_label] end |
#loaded? ⇒ Boolean
82 83 84 |
# File 'lib/reline/config.rb', line 82 def loaded? @loaded end |
#parse_keyseq(str) ⇒ Object
371 372 373 374 375 376 377 |
# File 'lib/reline/config.rb', line 371 def parse_keyseq(str) ret = [] str.scan(KEYSEQ_PATTERN) do ret << key_notation_to_code($&) end ret end |
#read(file = nil) ⇒ Object
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/reline/config.rb', line 116 def read(file = nil) @loaded = true 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. nil end |
#read_lines(lines, file = nil) ⇒ Object
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/reline/config.rb', line 160 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 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, if_stack) next end next if if_stack.any? { |_no, skip| skip } case line 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].add(@keymap_prefix + keystroke, func) end end unless if_stack.empty? raise InvalidInputrc, "#{file}:#{if_stack.last[0]}: unclosed if" end end |
#reset ⇒ Object
59 60 61 62 63 64 |
# File 'lib/reline/config.rb', line 59 def reset if editing_mode_is?(:vi_command) @editing_mode_label = :vi_insert end @oneshot_key_bindings.clear end |
#reset_oneshot_key_bindings ⇒ Object
148 149 150 |
# File 'lib/reline/config.rb', line 148 def reset_oneshot_key_bindings @oneshot_key_bindings.clear end |
#retrieve_string(str) ⇒ Object
318 319 320 321 |
# File 'lib/reline/config.rb', line 318 def retrieve_string(str) str = $1 if str =~ /\A"(.*)"\z/ parse_keyseq(str).map { |c| c.chr(Reline.encoding_system_needs) }.join end |