Class: IRB::RelineInputMethod
- Inherits:
-
StdioInputMethod
- Object
- InputMethod
- StdioInputMethod
- IRB::RelineInputMethod
- Includes:
- HistorySavingAbility
- Defined in:
- lib/irb/input-method.rb
Direct Known Subclasses
Constant Summary collapse
- HISTORY =
Reline::HISTORY
Constants inherited from InputMethod
InputMethod::BASIC_WORD_BREAK_CHARACTERS
Instance Attribute Summary
Attributes inherited from InputMethod
Instance Method Summary collapse
- #auto_indent(&block) ⇒ Object
- #check_termination(&block) ⇒ Object
- #completion_info ⇒ Object
- #display_document(matched) ⇒ Object
- #dynamic_prompt(&block) ⇒ Object
-
#eof? ⇒ Boolean
Whether the end of this input method has been reached, returns
true
if there is no more data to read. -
#gets ⇒ Object
Reads the next line from this input method.
-
#initialize(completor) ⇒ RelineInputMethod
constructor
Creates a new input method object using Reline.
-
#inspect ⇒ Object
For debug message.
- #prompting? ⇒ Boolean
- #rdoc_ri_driver ⇒ Object
- #retrieve_doc_namespace(matched) ⇒ Object
- #show_doc_dialog_proc ⇒ Object
Methods included from HistorySavingAbility
#load_history, #reset_history_counter, #save_history, #support_history_saving?
Methods inherited from StdioInputMethod
#encoding, #line, #readable_after_eof?
Methods inherited from InputMethod
#readable_after_eof?, #support_history_saving?, #winsize
Constructor Details
permalink #initialize(completor) ⇒ RelineInputMethod
Creates a new input method object using Reline
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 |
# File 'lib/irb/input-method.rb', line 254 def initialize(completor) IRB.__send__(:set_encoding, Reline.encoding_system_needs.name, override: false) super() @eof = false @completor = completor Reline.basic_word_break_characters = BASIC_WORD_BREAK_CHARACTERS Reline.completion_append_character = nil Reline.completer_quote_characters = '' Reline.completion_proc = ->(target, preposing, postposing) { bind = IRB.conf[:MAIN_CONTEXT].workspace.binding @completion_params = [preposing, target, postposing, bind] @completor.completion_candidates(preposing, target, postposing, bind: bind) } Reline.output_modifier_proc = proc do |input, complete:| IRB.CurrentContext.colorize_input(input, complete: complete) end Reline.dig_perfect_match_proc = ->(matched) { display_document(matched) } Reline.autocompletion = IRB.conf[:USE_AUTOCOMPLETE] if IRB.conf[:USE_AUTOCOMPLETE] begin require 'rdoc' Reline.add_dialog_proc(:show_doc, show_doc_dialog_proc, Reline::DEFAULT_DIALOG_CONTEXT) rescue LoadError end end end |
Instance Method Details
permalink #auto_indent(&block) ⇒ Object
[View source]
298 299 300 |
# File 'lib/irb/input-method.rb', line 298 def auto_indent(&block) @auto_indent_proc = block end |
permalink #check_termination(&block) ⇒ Object
[View source]
290 291 292 |
# File 'lib/irb/input-method.rb', line 290 def check_termination(&block) @check_termination_proc = block end |
permalink #completion_info ⇒ Object
[View source]
285 286 287 288 |
# File 'lib/irb/input-method.rb', line 285 def completion_info = Reline.autocompletion ? 'Autocomplete' : 'Tab Complete' "#{}, #{@completor.inspect}" end |
permalink #display_document(matched) ⇒ Object
[View source]
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 |
# File 'lib/irb/input-method.rb', line 439 def display_document(matched) driver = rdoc_ri_driver return unless driver if matched =~ /\A(?:::)?RubyVM/ and not ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER'] IRB.__send__(:easter_egg) return end namespace = retrieve_doc_namespace(matched) return unless namespace if namespace.is_a?(Array) out = RDoc::Markup::Document.new namespace.each do |m| begin driver.add_method(out, m) rescue RDoc::RI::Driver::NotFoundError end end driver.display(out) else begin driver.display_names([namespace]) rescue RDoc::RI::Driver::NotFoundError end end end |
permalink #dynamic_prompt(&block) ⇒ Object
[View source]
294 295 296 |
# File 'lib/irb/input-method.rb', line 294 def dynamic_prompt(&block) @prompt_proc = block end |
permalink #eof? ⇒ Boolean
Whether the end of this input method has been reached, returns true
if there is no more data to read.
See IO#eof? for more information.
489 490 491 |
# File 'lib/irb/input-method.rb', line 489 def eof? @eof end |
permalink #gets ⇒ Object
Reads the next line from this input method.
See IO#gets for more information.
471 472 473 474 475 476 477 478 479 480 481 482 483 |
# File 'lib/irb/input-method.rb', line 471 def gets Reline.input = @stdin Reline.output = @stdout Reline.prompt_proc = @prompt_proc Reline.auto_indent_proc = @auto_indent_proc if @auto_indent_proc if l = Reline.readmultiline(@prompt, false, &@check_termination_proc) Reline::HISTORY.push(l) if !l.empty? @line[@line_no += 1] = l + "\n" else @eof = true l end end |
permalink #inspect ⇒ Object
For debug message
498 499 500 501 502 503 504 |
# File 'lib/irb/input-method.rb', line 498 def inspect config = Reline::Config.new str = "RelineInputMethod with Reline #{Reline::VERSION}" inputrc_path = File.(config.inputrc_path) str += " and #{inputrc_path}" if File.exist?(inputrc_path) str end |
permalink #prompting? ⇒ Boolean
493 494 495 |
# File 'lib/irb/input-method.rb', line 493 def prompting? true end |
permalink #rdoc_ri_driver ⇒ Object
[View source]
307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/irb/input-method.rb', line 307 def rdoc_ri_driver return @rdoc_ri_driver if defined?(@rdoc_ri_driver) begin require 'rdoc' rescue LoadError @rdoc_ri_driver = nil else = {} [:extra_doc_dirs] = IRB.conf[:EXTRA_DOC_DIRS] unless IRB.conf[:EXTRA_DOC_DIRS].empty? @rdoc_ri_driver = RDoc::RI::Driver.new() end end |
permalink #retrieve_doc_namespace(matched) ⇒ Object
[View source]
302 303 304 305 |
# File 'lib/irb/input-method.rb', line 302 def retrieve_doc_namespace(matched) preposing, _target, postposing, bind = @completion_params @completor.doc_namespace(preposing, matched, postposing, bind: bind) end |
permalink #show_doc_dialog_proc ⇒ Object
[View source]
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 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 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 |
# File 'lib/irb/input-method.rb', line 321 def show_doc_dialog_proc input_method = self # self is changed in the lambda below. ->() { dialog.trap_key = nil alt_d = [ [27, 100], # Normal Alt+d when convert-meta isn't used. # When option/alt is not configured as a meta key in terminal emulator, # option/alt + d will send a unicode character depend on OS keyboard setting. [195, 164], # "ä" in somewhere (FIXME: environment information is unknown). [226, 136, 130] # "∂" Alt+d on Mac keyboard. ] if just_cursor_moving and completion_journey_data.nil? return nil end cursor_pos_to_render, result, pointer, autocomplete_dialog = context.pop(4) return nil if result.nil? or pointer.nil? or pointer < 0 name = input_method.retrieve_doc_namespace(result[pointer]) # Use first one because document dialog does not support multiple namespaces. name = name.first if name.is_a?(Array) show_easter_egg = name&.match?(/\ARubyVM/) && !ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER'] driver = input_method.rdoc_ri_driver if key.match?(dialog.name) if show_easter_egg IRB.__send__(:easter_egg) else # RDoc::RI::Driver#display_names uses pager command internally. # Some pager command like `more` doesn't use alternate screen # so we need to turn on and off alternate screen manually. begin print "\e[?1049h" driver.display_names([name]) rescue RDoc::RI::Driver::NotFoundError ensure print "\e[?1049l" end end end begin name = driver.(name) rescue RDoc::RI::Driver::NotFoundError return nil rescue return nil # unknown error end doc = nil used_for_class = false if not name =~ /#|\./ found, klasses, includes, extends = driver.classes_and_includes_and_extends_for(name) if not found.empty? doc = driver.class_document(name, found, klasses, includes, extends) used_for_class = true end end unless used_for_class doc = RDoc::Markup::Document.new begin driver.add_method(doc, name) rescue RDoc::RI::Driver::NotFoundError doc = nil rescue return nil # unknown error end end return nil if doc.nil? width = 40 right_x = cursor_pos_to_render.x + autocomplete_dialog.width if right_x + width > screen_width right_width = screen_width - (right_x + 1) left_x = autocomplete_dialog.column - width left_x = 0 if left_x < 0 left_width = width > autocomplete_dialog.column ? autocomplete_dialog.column : width if right_width.positive? and left_width.positive? if right_width >= left_width width = right_width x = right_x else width = left_width x = left_x end elsif right_width.positive? and left_width <= 0 width = right_width x = right_x elsif right_width <= 0 and left_width.positive? width = left_width x = left_x else # Both are negative width. return nil end else x = right_x end formatter = RDoc::Markup::ToAnsi.new formatter.width = width dialog.trap_key = alt_d mod_key = RUBY_PLATFORM.match?(/darwin/) ? "Option" : "Alt" if show_easter_egg type = STDOUT.external_encoding == Encoding::UTF_8 ? :unicode : :ascii contents = IRB.send(:easter_egg_logo, type).split("\n") = "Press #{mod_key}+d to see more" contents[0][0, .size] = else = "Press #{mod_key}+d to read the full document" contents = [] + doc.accept(formatter).split("\n") end contents = contents.take(preferred_dialog_height) y = cursor_pos_to_render.y Reline::DialogRenderInfo.new(pos: Reline::CursorPos.new(x, y), contents: contents, width: width, bg_color: '49') } end |