Class: Reline::Core

Inherits:
Object
  • Object
show all
Defined in:
lib/reline.rb

Constant Summary collapse

ATTR_READER_NAMES = 
%i(
  completion_append_character
  basic_word_break_characters
  completer_word_break_characters
  basic_quote_characters
  completer_quote_characters
  filename_quote_characters
  special_prefixes
  completion_proc
  output_modifier_proc
  prompt_proc
  auto_indent_proc
  pre_input_hook
  dig_perfect_match_proc
).each(&method(:attr_reader))

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Core

Returns a new instance of Core.

Yields:

  • (_self)

Yield Parameters:

  • _self (Reline::Core) —

    the object that the method was called on



42
43
44
45
46
47
 
# File 'lib/reline.rb', line 42

def initialize
  self.output = STDOUT
  yield self
  @completion_quote_character = nil
  @bracketed_paste_finished = false
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



36
37
38
 
# File 'lib/reline.rb', line 36

def config
  @config
end

#key_stroke ⇒ Object

Returns the value of attribute key_stroke.



37
38
39
 
# File 'lib/reline.rb', line 37

def key_stroke
  @key_stroke
end

#last_incremental_search ⇒ Object

Returns the value of attribute last_incremental_search.



39
40
41
 
# File 'lib/reline.rb', line 39

def last_incremental_search
  @last_incremental_search
end

#line_editor ⇒ Object

Returns the value of attribute line_editor.



38
39
40
 
# File 'lib/reline.rb', line 38

def line_editor
  @line_editor
end

#output ⇒ Object

Returns the value of attribute output.



40
41
42
 
# File 'lib/reline.rb', line 40

def output
  @output
end

Instance Method Details

#ambiguous_width ⇒ Object 



358
359
360
361
 
# File 'lib/reline.rb', line 358

def ambiguous_width
  may_req_ambiguous_char_width unless defined? @ambiguous_width
  @ambiguous_width
end

#auto_indent_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


116
117
118
119
 
# File 'lib/reline.rb', line 116

def auto_indent_proc=(p)
  raise ArgumentError unless p.respond_to?(:call) or p.nil?
  @auto_indent_proc = p
end

#basic_quote_characters=(v) ⇒ Object 



73
74
75
 
# File 'lib/reline.rb', line 73

def basic_quote_characters=(v)
  @basic_quote_characters = v.encode(Reline::IOGate.encoding)
end

#basic_word_break_characters=(v) ⇒ Object 



65
66
67
 
# File 'lib/reline.rb', line 65

def basic_word_break_characters=(v)
  @basic_word_break_characters = v.encode(Reline::IOGate.encoding)
end

#completer_quote_characters=(v) ⇒ Object 



77
78
79
 
# File 'lib/reline.rb', line 77

def completer_quote_characters=(v)
  @completer_quote_characters = v.encode(Reline::IOGate.encoding)
end

#completer_word_break_characters=(v) ⇒ Object 



69
70
71
 
# File 'lib/reline.rb', line 69

def completer_word_break_characters=(v)
  @completer_word_break_characters = v.encode(Reline::IOGate.encoding)
end

#completion_append_character=(val) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/reline.rb', line 53

def completion_append_character=(val)
  if val.nil?
    @completion_append_character = nil
  elsif val.size == 1
    @completion_append_character = val.encode(Reline::IOGate.encoding)
  elsif val.size > 1
    @completion_append_character = val[0].encode(Reline::IOGate.encoding)
  else
    @completion_append_character = nil
  end
end

#completion_case_fold ⇒ Object 



93
94
95
 
# File 'lib/reline.rb', line 93

def completion_case_fold
  @config.completion_ignore_case
end

#completion_case_fold=(v) ⇒ Object 



89
90
91
 
# File 'lib/reline.rb', line 89

def completion_case_fold=(v)
  @config.completion_ignore_case = v
end

#completion_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


101
102
103
104
 
# File 'lib/reline.rb', line 101

def completion_proc=(p)
  raise ArgumentError unless p.respond_to?(:call) or p.nil?
  @completion_proc = p
end

#completion_quote_character ⇒ Object 



97
98
99
 
# File 'lib/reline.rb', line 97

def completion_quote_character
  @completion_quote_character
end

#dig_perfect_match_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


125
126
127
128
 
# File 'lib/reline.rb', line 125

def dig_perfect_match_proc=(p)
  raise ArgumentError unless p.respond_to?(:call) or p.nil?
  @dig_perfect_match_proc = p
end

#emacs_editing_mode ⇒ Object 



154
155
156
157
 
# File 'lib/reline.rb', line 154

def emacs_editing_mode
  config.editing_mode = :emacs
  nil
end

#emacs_editing_mode? ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/reline.rb', line 163

def emacs_editing_mode?
  config.editing_mode_is?(:emacs)
end

#encoding ⇒ Object 



49
50
51
 
# File 'lib/reline.rb', line 49

def encoding
  Reline::IOGate.encoding
end

#filename_quote_characters=(v) ⇒ Object 



81
82
83
 
# File 'lib/reline.rb', line 81

def filename_quote_characters=(v)
  @filename_quote_characters = v.encode(Reline::IOGate.encoding)
end

#get_screen_size ⇒ Object 



167
168
169
 
# File 'lib/reline.rb', line 167

def get_screen_size
  Reline::IOGate.get_screen_size
end

#input=(val) ⇒ Object

Raises:

  • (TypeError) 


130
131
132
133
134
135
136
137
138
139
 
# File 'lib/reline.rb', line 130

def input=(val)
  raise TypeError unless val.respond_to?(:getc) or val.nil?
  if val.respond_to?(:getc)
    if defined?(Reline::ANSI) and Reline::IOGate == Reline::ANSI
      Reline::ANSI.input = val
    elsif Reline::IOGate == Reline::GeneralIO
      Reline::GeneralIO.input = val
    end
  end
end

#output_modifier_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


106
107
108
109
 
# File 'lib/reline.rb', line 106

def output_modifier_proc=(p)
  raise ArgumentError unless p.respond_to?(:call) or p.nil?
  @output_modifier_proc = p
end

#pre_input_hook=(p) ⇒ Object 



121
122
123
 
# File 'lib/reline.rb', line 121

def pre_input_hook=(p)
  @pre_input_hook = p
end

#prompt_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


111
112
113
114
 
# File 'lib/reline.rb', line 111

def prompt_proc=(p)
  raise ArgumentError unless p.respond_to?(:call) or p.nil?
  @prompt_proc = p
end

#readline(prompt = '', add_hist = false) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/reline.rb', line 187

def readline(prompt = '', add_hist = false)
  inner_readline(prompt, add_hist, false)

  line = line_editor.line.dup
  line.taint if RUBY_VERSION < '2.7'
  if add_hist and line and line.chomp("\n").size > 0
    Reline::HISTORY << line.chomp("\n")
  end

  line_editor.reset_line if line_editor.line.nil?
  line
end

#readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/reline.rb', line 171

def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
  unless confirm_multiline_termination
    raise ArgumentError.new('#readmultiline needs block to confirm multiline termination')
  end
  inner_readline(prompt, add_hist, true, &confirm_multiline_termination)

  whole_buffer = line_editor.whole_buffer.dup
  whole_buffer.taint if RUBY_VERSION < '2.7'
  if add_hist and whole_buffer and whole_buffer.chomp("\n").size > 0
    Reline::HISTORY << whole_buffer
  end

  line_editor.reset_line if line_editor.whole_buffer.nil?
  whole_buffer
end

#special_prefixes=(v) ⇒ Object 



85
86
87
 
# File 'lib/reline.rb', line 85

def special_prefixes=(v)
  @special_prefixes = v.encode(Reline::IOGate.encoding)
end

#vi_editing_mode ⇒ Object 



149
150
151
152
 
# File 'lib/reline.rb', line 149

def vi_editing_mode
  config.editing_mode = :vi_insert
  nil
end

#vi_editing_mode? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/reline.rb', line 159

def vi_editing_mode?
  config.editing_mode_is?(:vi_insert, :vi_command)
end