Module: Pry::InputCompleter

Defined in:
lib/pry/completion.rb

Overview

Implements tab completion for Readline in Pry

Constant Summary

ReservedWords =
[
"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" ]
Operators =
[
  "%", "&", "*", "**", "+",  "-",  "/",
  "<", "<<", "<=", "<=>", "==", "===", "=~", ">", ">=", ">>",
  "[]", "[]=", "^", "!", "!=", "!~"
]

Class Method Summary (collapse)

Class Method Details

+ (Object) build_completion_proc(target, commands = [""])

Return a new completion proc for use by Readline.

Parameters:

  • target (Binding)

    The current binding context.

  • commands (Array<String>) (defaults to: [""])

    The array of Pry commands.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
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
# File 'lib/pry/completion.rb', line 44

def self.build_completion_proc(target, commands=[""])
  proc do |input|
    bind = target

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

      candidates = Regexp.instance_methods.collect{|m| m.to_s}
      select_message(receiver, message, candidates)

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

      candidates = Array.instance_methods.collect{|m| m.to_s}
      select_message(receiver, message, candidates)

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

      candidates = Proc.instance_methods.collect{|m| m.to_s}
      candidates |= Hash.instance_methods.collect{|m| m.to_s}
      select_message(receiver, message, candidates)

    when /^(:[^:.]*)$/
      # Symbol
      if Symbol.respond_to?(:all_symbols)
        sym = $1
        candidates = Symbol.all_symbols.collect{|s| ":" + s.id2name}
        candidates.grep(/^#{sym}/)
      else
        []
      end

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

    when /^([A-Z].*)::([^:.]*)$/
      # Constant or class methods
      receiver = $1
      message = Regexp.quote($2)
      begin
        candidates = eval("#{receiver}.constants.collect{|m| m.to_s}", bind)
        candidates |= eval("#{receiver}.methods.collect{|m| m.to_s}", bind)
      rescue RescuableException
        candidates = []
      end
      candidates.grep(/^#{message}/).collect{|e| receiver + "::" + e}

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

      candidates = Symbol.instance_methods.collect{|m| m.to_s}
      select_message(receiver, message, candidates)

    when /^(-?(0[dbo])?[0-9_]+(\.[0-9_]+)?([eE]-?[0-9]+)?)\.([^.]*)$/
      # Numeric
      receiver = $1
      message = Regexp.quote($5)

      begin
        candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
      rescue RescuableException
        candidates = []
      end
      select_message(receiver, message, candidates)

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

      begin
        candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
      rescue RescuableException
        candidates = []
      end
      select_message(receiver, message, candidates)

    when /^(\$[^.]*)$/
      regmessage = Regexp.new(Regexp.quote($1))
      candidates = global_variables.collect{|m| m.to_s}.grep(regmessage)

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

      gv = eval("global_variables", bind).collect{|m| m.to_s}
      lv = eval("local_variables", bind).collect{|m| m.to_s}
      cv = eval("self.class.constants", bind).collect{|m| m.to_s}

      if (gv | lv | cv).include?(receiver) or /^[A-Z]/ =~ receiver && /\./ !~ receiver
        # foo.func and foo is local var. OR
        # Foo::Bar.func
        begin
          candidates = eval("#{receiver}.methods", bind).collect{|m| m.to_s}
        rescue RescuableException
          candidates = []
        end
      else
        # func1.func2
        candidates = []
        ObjectSpace.each_object(Module){|m|
          begin
            name = m.name.to_s
          rescue RescuableException
            name = ""
          end
          next if name != "IRB::Context" and
          /^(IRB|SLex|RubyLex|RubyToken)/ =~ name
          candidates.concat m.instance_methods(false).collect{|x| x.to_s}
        }
        candidates.sort!
        candidates.uniq!
      end
      select_message(receiver, message, candidates)

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

      receiver = ""
      message = Regexp.quote($1)

      candidates = String.instance_methods(true).collect{|m| m.to_s}
      select_message(receiver, message, candidates)

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

      (candidates|ReservedWords|commands).grep(/^#{Regexp.quote(input)}/)
    end
  end
end

+ (Object) select_message(receiver, message, candidates)



190
191
192
193
194
195
196
197
198
199
200
# File 'lib/pry/completion.rb', line 190

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