Module: IRB::InputCompletor

Defined in:
lib/irb/completion.rb

Overview

:nodoc:

Constant Summary collapse

ReservedWords =

Set of reserved words used by Ruby, you should not use these for constants or variables

%w[
  __ENCODING__ __LINE__ __FILE__
  BEGIN END
  alias and
  begin break
  case class
  def defined? do
  else elsif end ensure
  false for
  if in
  module
  next nil not
  or
  redo rescue retry return
  self super
  then true
  undef unless until
  when while
  yield
]
BASIC_WORD_BREAK_CHARACTERS = 
" \t\n`><=;|&{("
CompletionRequireProc = 
lambda { |target, preposing = nil, postposing = nil|
  if target =~ /\A(['"])([^'"]+)\Z/
    quote = $1
    actual_target = $2
  else
    return nil # It's not String literal
  end
  tokens = RubyLex.ripper_lex_without_warning(preposing.gsub(/\s*\z/, ''))
  tok = nil
  tokens.reverse_each do |t|
    unless [:on_lparen, :on_sp, :on_ignored_sp, :on_nl, :on_ignored_nl, :on_comment].include?(t.event)
      tok = t
      break
    end
  end
  result = []
  if tok && tok.event == :on_ident && tok.state == Ripper::EXPR_CMDARG
    case tok.tok
    when 'require'
      result = retrieve_files_to_require_from_load_path.select { |path|
        path.start_with?(actual_target)
      }.map { |path|
        quote + path
      }
    when 'require_relative'
      result = retrieve_files_to_require_relative_from_current_dir.select { |path|
        path.start_with?(actual_target)
      }.map { |path|
        quote + path
      }
    end
  end
  result
}
CompletionProc = 
lambda { |target, preposing = nil, postposing = nil|
  if preposing && postposing
    result = CompletionRequireProc.(target, preposing, postposing)
    unless result
      result = retrieve_completion_data(target).compact.map{ |i| i.encode(Encoding.default_external) }
    end
    result
  else
    retrieve_completion_data(target).compact.map{ |i| i.encode(Encoding.default_external) }
  end
}
PerfectMatchedProc = 
->(matched, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding) {
  begin
    require 'rdoc'
  rescue LoadError
    return
  end

  RDocRIDriver ||= RDoc::RI::Driver.new

  if matched =~ /\A(?:::)?RubyVM/ and not ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
    IRB.__send__(:easter_egg)
    return
  end

  namespace = retrieve_completion_data(matched, bind: bind, doc_namespace: true)
  return unless namespace

  if namespace.is_a?(Array)
    out = RDoc::Markup::Document.new
    namespace.each do |m|
      begin
        RDocRIDriver.add_method(out, m)
      rescue RDoc::RI::Driver::NotFoundError
      end
    end
    RDocRIDriver.display(out)
  else
    begin
      RDocRIDriver.display_names([namespace])
    rescue RDoc::RI::Driver::NotFoundError
    end
  end
}
Operators =

Set of available operators in Ruby

%w[% & * ** + - / < << <= <=> == === =~ > >= >> [] []= ^ ! != !~]

Class Method Summary collapse

Class Method Details

.ignored_modules ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/irb/completion.rb', line 378

def self.ignored_modules
  # We could cache the result, but this is very fast already.
  # By using this approach, we avoid Module#name calls, which are
  # relatively slow when there are a lot of anonymous modules defined.
  s = {}

  scanner = lambda do |m|
    next if s.include?(m) # IRB::ExtendCommandBundle::EXCB recurses.
    s[m] = true
    m.constants(false).each do |c|
      value = m.const_get(c)
      scanner.call(value) if value.is_a?(Module)
    end
  end

  %i(IRB RubyLex).each do |sym|
    next unless Object.const_defined?(sym)
    scanner.call(Object.const_get(sym))
  end

  s.delete(IRB::Context) if defined?(IRB::Context)

  s
end

.retrieve_completion_data(input, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding, doc_namespace: false) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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
204
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
239
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
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/irb/completion.rb', line 106

def self.retrieve_completion_data(input, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding, doc_namespace: false)
  case input
  when /^((["'`]).*\2)\.([^.]*)$/
    # String
    receiver = $1
    message = $3

    candidates = String.instance_methods.collect{|m| m.to_s}
    if doc_namespace
      "String.#{message}"
    else
      select_message(receiver, message, candidates)
    end

  when /^(\/[^\/]*\/)\.([^.]*)$/
    # Regexp
    receiver = $1
    message = $2

    candidates = Regexp.instance_methods.collect{|m| m.to_s}
    if doc_namespace
      "Regexp.#{message}"
    else
      select_message(receiver, message, candidates)
    end

  when /^([^\]]*\])\.([^.]*)$/
    # Array
    receiver = $1
    message = $2

    candidates = Array.instance_methods.collect{|m| m.to_s}
    if doc_namespace
      "Array.#{message}"
    else
      select_message(receiver, message, candidates)
    end

  when /^([^\}]*\})\.([^.]*)$/
    # Proc or Hash
    receiver = $1
    message = $2

    proc_candidates = Proc.instance_methods.collect{|m| m.to_s}
    hash_candidates = Hash.instance_methods.collect{|m| m.to_s}
    if doc_namespace
      ["Proc.#{message}", "Hash.#{message}"]
    else
      select_message(receiver, message, proc_candidates | hash_candidates)
    end

  when /^(:[^:.]*)$/
    # Symbol
    return nil if doc_namespace
    sym = $1
    candidates = Symbol.all_symbols.collect do |s|
      ":" + s.id2name.encode(Encoding.default_external)
    rescue Encoding::UndefinedConversionError
      # ignore
    end
    candidates.grep(/^#{Regexp.quote(sym)}/)

  when /^::([A-Z][^:\.\(]*)$/
    # Absolute Constant or class methods
    receiver = $1
    candidates = Object.constants.collect{|m| m.to_s}
    if doc_namespace
      candidates.find { |i| i == receiver }
    else
      candidates.grep(/^#{receiver}/).collect{|e| "::" + e}
    end

  when /^([A-Z].*)::([^:.]*)$/
    # Constant or class methods
    receiver = $1
    message = $2
    begin
      candidates = eval("#{receiver}.constants.collect{|m| m.to_s}", bind)
      candidates |= eval("#{receiver}.methods.collect{|m| m.to_s}", bind)
    rescue Exception
      candidates = []
    end
    if doc_namespace
      "#{receiver}::#{message}"
    else
      select_message(receiver, message, candidates, "::")
    end

  when /^(:[^:.]+)(\.|::)([^.]*)$/
    # Symbol
    receiver = $1
    sep = $2
    message = $3

    candidates = Symbol.instance_methods.collect{|m| m.to_s}
    if doc_namespace
      "Symbol.#{message}"
    else
      select_message(receiver, message, candidates, sep)
    end

  when /^(?<num>-?(?:0[dbo])?[0-9_]+(?:\.[0-9_]+)?(?:(?:[eE][+-]?[0-9]+)?i?|r)?)(?<sep>\.|::)(?<mes>[^.]*)$/
    # Numeric
    receiver = $~[:num]
    sep = $~[:sep]
    message = $~[:mes]

    begin
      instance = eval(receiver, bind)
      if doc_namespace
        "#{instance.class.name}.#{message}"
      else
        candidates = instance.methods.collect{|m| m.to_s}
        select_message(receiver, message, candidates, sep)
      end
    rescue Exception
      if doc_namespace
        nil
      else
        candidates = []
      end
    end

  when /^(-?0x[0-9a-fA-F_]+)(\.|::)([^.]*)$/
    # Numeric(0xFFFF)
    receiver = $1
    sep = $2
    message = $3

    begin
      instance = eval(receiver, bind)
      if doc_namespace
        "#{instance.class.name}.#{message}"
      else
        candidates = instance.methods.collect{|m| m.to_s}
        select_message(receiver, message, candidates, sep)
      end
    rescue Exception
      if doc_namespace
        nil
      else
        candidates = []
      end
    end

  when /^(\$[^.]*)$/
    # global var
    gvar = $1
    all_gvars = global_variables.collect{|m| m.to_s}
    if doc_namespace
      all_gvars.find{ |i| i == gvar }
    else
      all_gvars.grep(Regexp.new(Regexp.quote(gvar)))
    end

  when /^([^."].*)(\.|::)([^.]*)$/
    # variable.func or func.func
    receiver = $1
    sep = $2
    message = $3

    gv = eval("global_variables", bind).collect{|m| m.to_s}.push("true", "false", "nil")
    lv = eval("local_variables", bind).collect{|m| m.to_s}
    iv = eval("instance_variables", bind).collect{|m| m.to_s}
    cv = eval("self.class.constants", bind).collect{|m| m.to_s}

    if (gv | lv | iv | cv).include?(receiver) or /^[A-Z]/ =~ receiver && /\./ !~ receiver
      # foo.func and foo is var. OR
      # foo::func and foo is var. OR
      # foo::Const and foo is var. OR
      # Foo::Bar.func
      begin
        candidates = []
        rec = eval(receiver, bind)
        if sep == "::" and rec.kind_of?(Module)
          candidates = rec.constants.collect{|m| m.to_s}
        end
        candidates |= rec.methods.collect{|m| m.to_s}
      rescue Exception
        candidates = []
      end
    else
      # func1.func2
      candidates = []
      to_ignore = ignored_modules
      ObjectSpace.each_object(Module){|m|
        next if (to_ignore.include?(m) rescue true)
        candidates.concat m.instance_methods(false).collect{|x| x.to_s}
      }
      candidates.sort!
      candidates.uniq!
    end
    if doc_namespace
      "#{rec.class.name}#{sep}#{candidates.find{ |i| i == message }}"
    else
      select_message(receiver, message, candidates, sep)
    end

  when /^\.([^.]*)$/
    # unknown(maybe String)

    receiver = ""
    message = $1

    candidates = String.instance_methods(true).collect{|m| m.to_s}
    if doc_namespace
      "String.#{candidates.find{ |i| i == message }}"
    else
      select_message(receiver, message, candidates)
    end

  else
    candidates = eval("methods | private_methods | local_variables | instance_variables | self.class.constants", bind).collect{|m| m.to_s}
    candidates |= ReservedWords

    if doc_namespace
      candidates.find{ |i| i == input }
    else
      candidates.grep(/^#{Regexp.quote(input)}/)
    end
  end
end

.retrieve_files_to_require_from_load_path ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/irb/completion.rb', line 41

def self.retrieve_files_to_require_from_load_path
  @@files_from_load_path ||= $LOAD_PATH.flat_map { |path|
    begin
      Dir.glob("**/*.{rb,#{RbConfig::CONFIG['DLEXT']}}", base: path)
    rescue Errno::ENOENT
      []
    end
  }.uniq.map { |path|
    path.sub(/\.(rb|#{RbConfig::CONFIG['DLEXT']})\z/, '')
  }
end

.retrieve_files_to_require_relative_from_current_dir ⇒ Object 



53
54
55
56
57
 
# File 'lib/irb/completion.rb', line 53

def self.retrieve_files_to_require_relative_from_current_dir
  @@files_from_current_dir ||= Dir.glob("**/*.{rb,#{RbConfig::CONFIG['DLEXT']}}", base: '.').map { |path|
    path.sub(/\.(rb|#{RbConfig::CONFIG['DLEXT']})\z/, '')
  }
end

.select_message(receiver, message, candidates, sep = ".") ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/irb/completion.rb', line 366

def self.select_message(receiver, message, candidates, sep = ".")
  candidates.grep(/^#{Regexp.quote(message)}/).collect do |e|
    case e
    when /^[a-zA-Z_]/
      receiver + sep + e
    when /^[0-9]/
    when *Operators
      #receiver + " " + e
    end
  end
end