Module: IRB

Defined in:
lib/irb.rb,
lib/irb/help.rb,
lib/irb/init.rb,
lib/irb/color.rb,
lib/irb/frame.rb,
lib/irb/locale.rb,
lib/irb/cmd/nop.rb,
lib/irb/context.rb,
lib/irb/version.rb,
lib/irb/cmd/chws.rb,
lib/irb/cmd/fork.rb,
lib/irb/cmd/help.rb,
lib/irb/cmd/info.rb,
lib/irb/cmd/load.rb,
lib/irb/lc/error.rb,
lib/irb/notifier.rb,
lib/irb/inspector.rb,
lib/irb/workspace.rb,
lib/irb/cmd/pushws.rb,
lib/irb/cmd/subirb.rb,
lib/irb/completion.rb,
lib/irb/easter-egg.rb,
lib/irb/ext/loader.rb,
lib/irb/ext/tracer.rb,
lib/irb/magic-file.rb,
lib/irb/cmd/measure.rb,
lib/irb/ext/history.rb,
lib/irb/lc/ja/error.rb,
lib/irb/input-method.rb,
lib/irb/src_encoding.rb,
lib/irb/ext/change-ws.rb,
lib/irb/ext/multi-irb.rb,
lib/irb/output-method.rb,
lib/irb/ext/use-loader.rb,
lib/irb/ext/workspaces.rb,
lib/irb/extend-command.rb,
lib/irb/ext/save-history.rb,
lib/irb/lc/ja/encoding_aliases.rb

Overview

:stopdoc:

Defined Under Namespace

Modules: Color, ContextExtender, ExtendCommand, ExtendCommandBundle, HistorySavingAbility, InputCompletor, IrbLoader, MethodExtender, Notifier Classes: Abort, CantChangeBinding, CantReturnToNormalMode, CantShiftToMultiIrbMode, Canvas, Context, DefaultEncodings, FileInputMethod, Frame, History, IllegalParameter, IllegalRCGenerator, InputMethod, Inspector, Irb, IrbAlreadyDead, IrbSwitchedToCurrentThread, JobManager, LoadAbort, Locale, NoSuchJob, NotImplementedError, OutputMethod, ReidlineInputMethod, RubyModel, StdioInputMethod, StdioOutputMethod, UndefinedPromptMode, UnrecognizedSwitch, Vec, WorkSpace

Constant Summary collapse

IRBRC_EXT =
"rc"
VERSION =

:nodoc:

"1.3.0"
STDIN_FILE_NAME =

:nodoc:

"(line)"

Class Method Summary collapse

Class Method Details

.confObject

Displays current configuration.

Modifying the configuration is achieved by sending a message to IRB.conf.

See IRB@Configuration for more information.



367
368
369
# File 'lib/irb.rb', line 367

def IRB.conf
  @CONF
end

.CurrentContextObject

The current Context in this session



384
385
386
# File 'lib/irb.rb', line 384

def IRB.CurrentContext
  IRB.conf[:MAIN_CONTEXT]
end

.default_src_encodingObject



4
5
6
# File 'lib/irb/src_encoding.rb', line 4

def self.default_src_encoding
  return __ENCODING__
end

.delete_callerObject



180
181
# File 'lib/irb/workspace.rb', line 180

def IRB.delete_caller
end

.init_config(ap_path) ⇒ Object



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
# File 'lib/irb/init.rb', line 29

def IRB.init_config(ap_path)
  # class instance variables
  @TRACER_INITIALIZED = false

  # default configurations
  unless ap_path and @CONF[:AP_NAME]
    ap_path = File.join(File.dirname(File.dirname(__FILE__)), "irb.rb")
  end
  @CONF[:AP_NAME] = File::basename(ap_path, ".rb")

  @CONF[:IRB_NAME] = "irb"
  @CONF[:IRB_LIB_PATH] = File.dirname(__FILE__)

  @CONF[:RC] = true
  @CONF[:LOAD_MODULES] = []
  @CONF[:IRB_RC] = nil

  @CONF[:USE_SINGLELINE] = false unless defined?(ReadlineInputMethod)
  @CONF[:USE_COLORIZE] = true
  @CONF[:INSPECT_MODE] = true
  @CONF[:USE_TRACER] = false
  @CONF[:USE_LOADER] = false
  @CONF[:IGNORE_SIGINT] = true
  @CONF[:IGNORE_EOF] = false
  @CONF[:ECHO] = nil
  @CONF[:ECHO_ON_ASSIGNMENT] = nil
  @CONF[:VERBOSE] = nil

  @CONF[:EVAL_HISTORY] = nil
  @CONF[:SAVE_HISTORY] = 1000

  @CONF[:BACK_TRACE_LIMIT] = 16

  @CONF[:PROMPT] = {
    :NULL => {
      :PROMPT_I => nil,
      :PROMPT_N => nil,
      :PROMPT_S => nil,
      :PROMPT_C => nil,
      :RETURN => "%s\n"
    },
    :DEFAULT => {
      :PROMPT_I => "%N(%m):%03n:%i> ",
      :PROMPT_N => "%N(%m):%03n:%i> ",
      :PROMPT_S => "%N(%m):%03n:%i%l ",
      :PROMPT_C => "%N(%m):%03n:%i* ",
      :RETURN => "=> %s\n"
    },
    :CLASSIC => {
      :PROMPT_I => "%N(%m):%03n:%i> ",
      :PROMPT_N => "%N(%m):%03n:%i> ",
      :PROMPT_S => "%N(%m):%03n:%i%l ",
      :PROMPT_C => "%N(%m):%03n:%i* ",
      :RETURN => "%s\n"
    },
    :SIMPLE => {
      :PROMPT_I => ">> ",
      :PROMPT_N => ">> ",
      :PROMPT_S => "%l> ",
      :PROMPT_C => "?> ",
      :RETURN => "=> %s\n"
    },
    :INF_RUBY => {
      :PROMPT_I => "%N(%m):%03n:%i> ",
      :PROMPT_N => nil,
      :PROMPT_S => nil,
      :PROMPT_C => nil,
      :RETURN => "%s\n",
      :AUTO_INDENT => true
    },
    :XMP => {
      :PROMPT_I => nil,
      :PROMPT_N => nil,
      :PROMPT_S => nil,
      :PROMPT_C => nil,
      :RETURN => "    ==>%s\n"
    }
  }

  @CONF[:PROMPT_MODE] = (STDIN.tty? ? :DEFAULT : :NULL)
  @CONF[:AUTO_INDENT] = true

  @CONF[:CONTEXT_MODE] = 4 # use a copy of TOPLEVEL_BINDING
  @CONF[:SINGLE_IRB] = false

  @CONF[:MEASURE] = false
  @CONF[:MEASURE_PROC] = {}
  @CONF[:MEASURE_PROC][:TIME] = proc { |context, code, line_no, &block|
    time = Time.now
    result = block.()
    now = Time.now
    puts 'processing time: %fs' % (now - time) if IRB.conf[:MEASURE]
    result
  }
  @CONF[:MEASURE_PROC][:STACKPROF] = proc { |context, code, line_no, arg, &block|
    success = false
    begin
      require 'stackprof'
      success = true
    rescue LoadError
      puts 'Please run "gem install stackprof" before measuring by StackProf.'
    end
    if success
      result = nil
      stackprof_result = StackProf.run(mode: arg ? arg : :cpu) do
        result = block.()
      end
      StackProf::Report.new(stackprof_result).print_text if IRB.conf[:MEASURE]
      result
    else
      block.()
    end
  }
  @CONF[:MEASURE_CALLBACKS] = []

  @CONF[:LC_MESSAGES] = Locale.new

  @CONF[:AT_EXIT] = []
end

.init_errorObject



184
185
186
# File 'lib/irb/init.rb', line 184

def IRB.init_error
  @CONF[:LC_MESSAGES].load("irb/error.rb")
end

.initialize_tracerObject

initialize tracing function



30
31
32
33
34
35
36
37
# File 'lib/irb/ext/tracer.rb', line 30

def IRB.initialize_tracer
  Tracer.verbose = false
  Tracer.add_filter {
    |event, file, line, id, binding, *rests|
    /^#{Regexp.quote(@CONF[:IRB_LIB_PATH])}/ !~ file and
      File::basename(file) != "irb.rb"
  }
end

.inspectObject



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
# File 'lib/irb.rb', line 837

def @CONF.inspect
  IRB.version unless self[:VERSION]

  array = []
  for k, v in sort{|a1, a2| a1[0].id2name <=> a2[0].id2name}
    case k
    when :MAIN_CONTEXT, :__TMP__EHV__
      array.push format("CONF[:%s]=...myself...", k.id2name)
    when :PROMPT
      s = v.collect{
        |kk, vv|
        ss = vv.collect{|kkk, vvv| ":#{kkk.id2name}=>#{vvv.inspect}"}
        format(":%s=>{%s}", kk.id2name, ss.join(", "))
      }
      array.push format("CONF[:%s]={%s}", k.id2name, s.join(", "))
    else
      array.push format("CONF[:%s]=%s", k.id2name, v.inspect)
    end
  end
  array.join("\n")
end

.Inspector(inspect, init = nil) ⇒ Object

Convenience method to create a new Inspector, using the given inspect proc, and optional init proc and passes them to Inspector.new

irb(main):001:0> ins = IRB::Inspector(proc{ |v| "omg! #{v}" })
irb(main):001:0> IRB.CurrentContext.inspect_mode = ins # => omg! #<IRB::Inspector:0x007f46f7ba7d28>
irb(main):001:0> "what?" #=> omg! what?


24
25
26
# File 'lib/irb/inspector.rb', line 24

def IRB::Inspector(inspect, init = nil)
  Inspector.new(inspect, init)
end

.irb(file = nil, *main) ⇒ Object

Creates a new IRB session, see Irb.new.

The optional file argument is given to Context.new, along with the workspace created with the remaining arguments, see WorkSpace.new



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
# File 'lib/irb/ext/multi-irb.rb', line 189

def IRB.irb(file = nil, *main)
  workspace = WorkSpace.new(*main)
  parent_thread = Thread.current
  Thread.start do
    begin
      irb = Irb.new(workspace, file)
    rescue
      print "Subirb can't start with context(self): ", workspace.main.inspect, "\n"
      print "return to main irb\n"
      Thread.pass
      Thread.main.wakeup
      Thread.exit
    end
    @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
    @JobManager.insert(irb)
    @JobManager.current_job = irb
    begin
      system_exit = false
      catch(:IRB_EXIT) do
        irb.eval_input
      end
    rescue SystemExit
      system_exit = true
      raise
      #fail
    ensure
      unless system_exit
        @JobManager.delete(irb)
        if @JobManager.current_job == irb
          if parent_thread.alive?
            @JobManager.current_job = @JobManager.irb(parent_thread)
            parent_thread.run
          else
            @JobManager.current_job = @JobManager.main_irb
            @JobManager.main_thread.run
          end
        end
      end
    end
  end
  Thread.stop
  @JobManager.current_job = @JobManager.irb(Thread.current)
end

.irb_abort(irb, exception = Abort) ⇒ Object

Aborts then interrupts irb.

Will raise an Abort exception, or the given exception.



416
417
418
419
420
421
422
# File 'lib/irb.rb', line 416

def IRB.irb_abort(irb, exception = Abort)
  if defined? Thread
    irb.context.thread.raise exception, "abort then interrupt!"
  else
    raise exception, "abort then interrupt!"
  end
end

.irb_at_exitObject

Calls each event hook of IRB.conf[:AT_EXIT] when the current session quits.



404
405
406
# File 'lib/irb.rb', line 404

def IRB.irb_at_exit
  @CONF[:AT_EXIT].each{|hook| hook.call}
end

.irb_exit(irb, ret) ⇒ Object

Quits irb



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

def IRB.irb_exit(irb, ret)
  throw :IRB_EXIT, ret
end

.JobManagerObject

The current JobManager in the session



176
177
178
# File 'lib/irb/ext/multi-irb.rb', line 176

def IRB.JobManager
  @JobManager
end

.load_modulesObject

loading modules



361
362
363
364
365
366
367
368
369
# File 'lib/irb/init.rb', line 361

def IRB.load_modules
  for m in @CONF[:LOAD_MODULES]
    begin
      require m
    rescue LoadError => err
      warn "#{err.class}: #{err}", uplevel: 0
    end
  end
end

.parse_opts(argv: ::ARGV) ⇒ Object

option analyzing



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
# File 'lib/irb/init.rb', line 189

def IRB.parse_opts(argv: ::ARGV)
  load_path = []
  while opt = argv.shift
    case opt
    when "-f"
      @CONF[:RC] = false
    when "-d"
      $DEBUG = true
      $VERBOSE = true
    when "-w"
      Warning[:deprecated] = $VERBOSE = true
    when /^-W(.+)?/
      opt = $1 || argv.shift
      case opt
      when "0"
        $VERBOSE = nil
      when "1"
        $VERBOSE = false
      else
        Warning[:deprecated] = $VERBOSE = true
      end
    when /^-r(.+)?/
      opt = $1 || argv.shift
      @CONF[:LOAD_MODULES].push opt if opt
    when /^-I(.+)?/
      opt = $1 || argv.shift
      load_path.concat(opt.split(File::PATH_SEPARATOR)) if opt
    when '-U'
      set_encoding("UTF-8", "UTF-8")
    when /^-E(.+)?/, /^--encoding(?:=(.+))?/
      opt = $1 || argv.shift
      set_encoding(*opt.split(':', 2))
    when "--inspect"
      if /^-/ !~ argv.first
        @CONF[:INSPECT_MODE] = argv.shift
      else
        @CONF[:INSPECT_MODE] = true
      end
    when "--noinspect"
      @CONF[:INSPECT_MODE] = false
    when "--singleline", "--readline", "--legacy"
      @CONF[:USE_SINGLELINE] = true
    when "--nosingleline", "--noreadline"
      @CONF[:USE_SINGLELINE] = false
    when "--multiline", "--reidline"
      @CONF[:USE_MULTILINE] = true
    when "--nomultiline", "--noreidline"
      @CONF[:USE_MULTILINE] = false
    when "--echo"
      @CONF[:ECHO] = true
    when "--noecho"
      @CONF[:ECHO] = false
    when "--echo-on-assignment"
      @CONF[:ECHO_ON_ASSIGNMENT] = true
    when "--noecho-on-assignment"
      @CONF[:ECHO_ON_ASSIGNMENT] = false
    when "--truncate-echo-on-assignment"
      @CONF[:ECHO_ON_ASSIGNMENT] = :truncate
    when "--verbose"
      @CONF[:VERBOSE] = true
    when "--noverbose"
      @CONF[:VERBOSE] = false
    when "--colorize"
      @CONF[:USE_COLORIZE] = true
    when "--nocolorize"
      @CONF[:USE_COLORIZE] = false
    when /^--prompt-mode(?:=(.+))?/, /^--prompt(?:=(.+))?/
      opt = $1 || argv.shift
      prompt_mode = opt.upcase.tr("-", "_").intern
      @CONF[:PROMPT_MODE] = prompt_mode
    when "--noprompt"
      @CONF[:PROMPT_MODE] = :NULL
    when "--inf-ruby-mode"
      @CONF[:PROMPT_MODE] = :INF_RUBY
    when "--sample-book-mode", "--simple-prompt"
      @CONF[:PROMPT_MODE] = :SIMPLE
    when "--tracer"
      @CONF[:USE_TRACER] = true
    when /^--back-trace-limit(?:=(.+))?/
      @CONF[:BACK_TRACE_LIMIT] = ($1 || argv.shift).to_i
    when /^--context-mode(?:=(.+))?/
      @CONF[:CONTEXT_MODE] = ($1 || argv.shift).to_i
    when "--single-irb"
      @CONF[:SINGLE_IRB] = true
    when "-v", "--version"
      print IRB.version, "\n"
      exit 0
    when "-h", "--help"
      require_relative "help"
      IRB.print_usage
      exit 0
    when "--"
      if opt = argv.shift
        @CONF[:SCRIPT] = opt
        $0 = opt
      end
      break
    when /^-/
      fail UnrecognizedSwitch, opt
    else
      @CONF[:SCRIPT] = opt
      $0 = opt
      break
    end
  end
  load_path.collect! do |path|
    /\A\.\// =~ path ? path : File.expand_path(path)
  end
  $LOAD_PATH.unshift(*load_path)

end

Outputs the irb help message, see IRB@Command+line+options.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# File 'lib/irb/help.rb', line 17

def IRB.print_usage
  lc = IRB.conf[:LC_MESSAGES]
  path = lc.find("irb/help-message")
  space_line = false
  IRB::MagicFile.open(path){|f|
    f.each_line do |l|
      if /^\s*$/ =~ l
        lc.puts l unless space_line
        space_line = true
        next
      end
      space_line = false

      l.sub!(/#.*$/, "")
      next if /^\s*$/ =~ l
      lc.puts l
    end
  }
end

.rc_file(ext = IRBRC_EXT) ⇒ Object



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/irb/init.rb', line 318

def IRB.rc_file(ext = IRBRC_EXT)
  if !@CONF[:RC_NAME_GENERATOR]
    rc_file_generators do |rcgen|
      @CONF[:RC_NAME_GENERATOR] ||= rcgen
      if File.exist?(rcgen.call(IRBRC_EXT))
        @CONF[:RC_NAME_GENERATOR] = rcgen
        break
      end
    end
  end
  case rc_file = @CONF[:RC_NAME_GENERATOR].call(ext)
  when String
    return rc_file
  else
    fail IllegalRCNameGenerator
  end
end

.rc_file_generators {|proc{|rc| current_dir+"/.config/irb/irb#{rc}"}| ... } ⇒ Object

enumerate possible rc-file base name generators

Yields:

  • (proc{|rc| current_dir+"/.config/irb/irb#{rc}"})


337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/irb/init.rb', line 337

def IRB.rc_file_generators
  if irbrc = ENV["IRBRC"]
    yield proc{|rc| rc == "rc" ? irbrc : irbrc+rc}
  end
  if xdg_config_home = ENV["XDG_CONFIG_HOME"]
    irb_home = File.join(xdg_config_home, "irb")
    unless File.exist? irb_home
      require 'fileutils'
      FileUtils.mkdir_p irb_home
    end
    yield proc{|rc| irb_home + "/irb#{rc}"}
  end
  if home = ENV["HOME"]
    yield proc{|rc| home+"/.irb#{rc}"}
  end
  current_dir = Dir.pwd
  yield proc{|rc| current_dir+"/.config/irb/irb#{rc}"}
  yield proc{|rc| current_dir+"/.irb#{rc}"}
  yield proc{|rc| current_dir+"/irb#{rc.sub(/\A_?/, '.')}"}
  yield proc{|rc| current_dir+"/_irb#{rc}"}
  yield proc{|rc| current_dir+"/$irb#{rc}"}
end

.run_configObject

running config



302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'lib/irb/init.rb', line 302

def IRB.run_config
  if @CONF[:RC]
    begin
      load rc_file
    rescue LoadError, Errno::ENOENT
    rescue # StandardError, ScriptError
      print "load error: #{rc_file}\n"
      print $!.class, ": ", $!, "\n"
      for err in $@[0, $@.size - 2]
        print "\t", err, "\n"
      end
    end
  end
end

.set_measure_callback(type = nil, arg = nil) ⇒ Object



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
# File 'lib/irb/init.rb', line 149

def IRB.set_measure_callback(type = nil, arg = nil)
  added = nil
  if type
    type_sym = type.upcase.to_sym
    if IRB.conf[:MEASURE_PROC][type_sym]
      added = [type_sym, IRB.conf[:MEASURE_PROC][type_sym], arg]
    end
  elsif IRB.conf[:MEASURE_PROC][:CUSTOM]
    added = [:CUSTOM, IRB.conf[:MEASURE_PROC][:CUSTOM], arg]
  else
    added = [:TIME, IRB.conf[:MEASURE_PROC][:TIME], arg]
  end
  if added
    found = IRB.conf[:MEASURE_CALLBACKS].find{ |m| m[0] == added[0] && m[2] == added[2] }
    if found
      # already added
      nil
    else
      IRB.conf[:MEASURE_CALLBACKS] << added if added
      added
    end
  else
    nil
  end
end

.setup(ap_path, argv: ::ARGV) ⇒ Object

initialize config



16
17
18
19
20
21
22
23
24
25
26
# File 'lib/irb/init.rb', line 16

def IRB.setup(ap_path, argv: ::ARGV)
  IRB.init_config(ap_path)
  IRB.init_error
  IRB.parse_opts(argv: argv)
  IRB.run_config
  IRB.load_modules

  unless @CONF[:PROMPT][@CONF[:PROMPT_MODE]]
    fail UndefinedPromptMode, @CONF[:PROMPT_MODE]
  end
end

.start(ap_path = nil) ⇒ Object

Initializes IRB and creates a new Irb.irb object at the TOPLEVEL_BINDING



389
390
391
392
393
394
395
396
397
398
399
400
401
# File 'lib/irb.rb', line 389

def IRB.start(ap_path = nil)
  STDOUT.sync = true
  $0 = File::basename(ap_path, ".rb") if ap_path

  IRB.setup(ap_path)

  if @CONF[:SCRIPT]
    irb = Irb.new(nil, @CONF[:SCRIPT])
  else
    irb = Irb.new
  end
  irb.run(@CONF)
end

.unset_measure_callback(type = nil) ⇒ Object



175
176
177
178
179
180
181
182
# File 'lib/irb/init.rb', line 175

def IRB.unset_measure_callback(type = nil)
  if type.nil?
    IRB.conf[:MEASURE_CALLBACKS].clear
  else
    type_sym = type.upcase.to_sym
    IRB.conf[:MEASURE_CALLBACKS].reject!{ |t, | t == type_sym }
  end
end

.versionObject

Returns the current version of IRB, including release version and last updated date.



373
374
375
376
377
# File 'lib/irb.rb', line 373

def IRB.version
  if v = @CONF[:VERSION] then return v end

  @CONF[:VERSION] = format("irb %s (%s)", @RELEASE_VERSION, @LAST_UPDATE_DATE)
end