Class: Reline::Core

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

Defined Under Namespace

Classes: DialogProc

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



68
69
70
71
72
73
74
 
# File 'lib/reline.rb', line 68

def initialize
  self.output = STDOUT
  @mutex = Mutex.new
  @dialog_proc_list = {}
  yield self
  @completion_quote_character = nil
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



57
58
59
 
# File 'lib/reline.rb', line 57

def config
  @config
end

#key_stroke ⇒ Object

Returns the value of attribute key_stroke.



58
59
60
 
# File 'lib/reline.rb', line 58

def key_stroke
  @key_stroke
end

#last_incremental_search ⇒ Object

Returns the value of attribute last_incremental_search.



60
61
62
 
# File 'lib/reline.rb', line 60

def last_incremental_search
  @last_incremental_search
end

#line_editor ⇒ Object

Returns the value of attribute line_editor.



59
60
61
 
# File 'lib/reline.rb', line 59

def line_editor
  @line_editor
end

#output ⇒ Object

Returns the value of attribute output.



61
62
63
 
# File 'lib/reline.rb', line 61

def output
  @output
end

Instance Method Details

#add_dialog_proc(name_sym, p, context = nil) ⇒ Object

Raises:

  • (ArgumentError) 


162
163
164
165
166
167
168
169
170
 
# File 'lib/reline.rb', line 162

def add_dialog_proc(name_sym, p, context = nil)
  raise ArgumentError unless name_sym.instance_of?(Symbol)
  if p.nil?
    @dialog_proc_list.delete(name_sym)
  else
    raise ArgumentError unless p.respond_to?(:call)
    @dialog_proc_list[name_sym] = DialogProc.new(p, context)
  end
end

#ambiguous_width ⇒ Object 



409
410
411
412
 
# File 'lib/reline.rb', line 409

def ambiguous_width
  may_req_ambiguous_char_width unless defined? @ambiguous_width
  @ambiguous_width
end

#auto_indent_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


147
148
149
150
 
# File 'lib/reline.rb', line 147

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 



104
105
106
 
# File 'lib/reline.rb', line 104

def basic_quote_characters=(v)
  @basic_quote_characters = v.encode(encoding)
end

#basic_word_break_characters=(v) ⇒ Object 



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

def basic_word_break_characters=(v)
  @basic_word_break_characters = v.encode(encoding)
end

#completer_quote_characters=(v) ⇒ Object 



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

def completer_quote_characters=(v)
  @completer_quote_characters = v.encode(encoding)
end

#completer_word_break_characters=(v) ⇒ Object 



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

def completer_word_break_characters=(v)
  @completer_word_break_characters = v.encode(encoding)
end

#completion_append_character=(val) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/reline.rb', line 84

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

#completion_case_fold ⇒ Object 



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

def completion_case_fold
  @config.completion_ignore_case
end

#completion_case_fold=(v) ⇒ Object 



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

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

#completion_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


132
133
134
135
 
# File 'lib/reline.rb', line 132

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

#completion_quote_character ⇒ Object 



128
129
130
 
# File 'lib/reline.rb', line 128

def completion_quote_character
  @completion_quote_character
end

#dialog_proc(name_sym) ⇒ Object 



172
173
174
 
# File 'lib/reline.rb', line 172

def dialog_proc(name_sym)
  @dialog_proc_list[name_sym]
end

#dig_perfect_match_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


156
157
158
159
 
# File 'lib/reline.rb', line 156

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 



194
195
196
197
 
# File 'lib/reline.rb', line 194

def emacs_editing_mode
  config.editing_mode = :emacs
  nil
end

#emacs_editing_mode? ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'lib/reline.rb', line 203

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

#encoding ⇒ Object 



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

def encoding
  io_gate.encoding
end

#filename_quote_characters=(v) ⇒ Object 



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

def filename_quote_characters=(v)
  @filename_quote_characters = v.encode(encoding)
end

#get_screen_size ⇒ Object 



207
208
209
 
# File 'lib/reline.rb', line 207

def get_screen_size
  io_gate.get_screen_size
end

#input=(val) ⇒ Object

Raises:

  • (TypeError) 


176
177
178
179
180
181
 
# File 'lib/reline.rb', line 176

def input=(val)
  raise TypeError unless val.respond_to?(:getc) or val.nil?
  if val.respond_to?(:getc) && io_gate.respond_to?(:input=)
    io_gate.input = val
  end
end

#io_gate ⇒ Object 



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

def io_gate
  Reline::IOGate
end

#output_modifier_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


137
138
139
140
 
# File 'lib/reline.rb', line 137

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 



152
153
154
 
# File 'lib/reline.rb', line 152

def pre_input_hook=(p)
  @pre_input_hook = p
end

#prompt_proc=(p) ⇒ Object

Raises:

  • (ArgumentError) 


142
143
144
145
 
# File 'lib/reline.rb', line 142

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

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/reline.rb', line 276

def readline(prompt = '', add_hist = false)
  @mutex.synchronize do
    io_gate.with_raw_input do
      inner_readline(prompt, add_hist, false)
    end

    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
end

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



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
 
# File 'lib/reline.rb', line 250

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

    io_gate.with_raw_input do
      inner_readline(prompt, add_hist, true, &confirm_multiline_termination)
    end

    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

    if line_editor.eof?
      line_editor.reset_line
      # Return nil if the input is aborted by C-d.
      nil
    else
      whole_buffer
    end
  end
end

#special_prefixes=(v) ⇒ Object 



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

def special_prefixes=(v)
  @special_prefixes = v.encode(encoding)
end

#vi_editing_mode ⇒ Object 



189
190
191
192
 
# File 'lib/reline.rb', line 189

def vi_editing_mode
  config.editing_mode = :vi_insert
  nil
end

#vi_editing_mode? ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/reline.rb', line 199

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