Module: IRB

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

Overview

:stopdoc:

Defined Under Namespace

Modules: ContextExtender, ExtendCommand, ExtendCommandBundle, HistorySavingAbility, InputCompletor, IrbLoader, MethodExtender, Notifier Classes: Abort, Context, DefaultEncodings, FileInputMethod, Frame, History, InputMethod, Inspector, Irb, JobManager, LoadAbort, Locale, OutputMethod, SLex, StdioInputMethod, StdioOutputMethod, WorkSpace

Constant Summary collapse

FEATURE_IOPT_CHANGE_VERSION =
"1.9.0"
IRBRC_EXT =
"rc"
STDIN_FILE_NAME =

:nodoc:

"(line)"

Class Method Summary collapse

Class Method Details

.confObject

Displays current configuration.

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

See [email protected] for more information.


353
354
355
# File 'lib/irb.rb', line 353

def IRB.conf
  @CONF
end

.CurrentContextObject

The current Context in this session


372
373
374
# File 'lib/irb.rb', line 372

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

.delete_callerObject


111
112
# File 'lib/irb/workspace.rb', line 111

def IRB.delete_caller
end

.init_config(ap_path) ⇒ Object


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

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[:MATH_MODE] = false
  @CONF[:USE_READLINE] = false unless defined?(ReadlineInputMethod)
  @CONF[:INSPECT_MODE] = true
  @CONF[:USE_TRACER] = false
  @CONF[:USE_LOADER] = false
  @CONF[:IGNORE_SIGINT] = true
  @CONF[:IGNORE_EOF] = false
  @CONF[:ECHO] = nil
  @CONF[:VERBOSE] = nil

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

  @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 => nil,
	:PROMPT_C => "?> ",
	:RETURN => "=> %s\n"
    },
    :INF_RUBY => {
	:PROMPT_I => "%N(%m):%03n:%i> ",
#	:PROMPT_N => "%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] = false

  @CONF[:CONTEXT_MODE] = 3 # use binding in function on TOPLEVEL_BINDING
  @CONF[:SINGLE_IRB] = false

#    @CONF[:LC_MESSAGES] = "en"
  @CONF[:LC_MESSAGES] = Locale.new

  @CONF[:AT_EXIT] = []

  @CONF[:DEBUG_LEVEL] = 0
end

.init_errorObject


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

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

.initialize_tracerObject

initialize tracing function


16
17
18
19
20
21
22
23
# File 'lib/irb/ext/tracer.rb', line 16

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


683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
# File 'lib/irb.rb', line 683

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?

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

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


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

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.


418
419
420
421
422
423
424
# File 'lib/irb.rb', line 418

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 when the current session quits.


406
407
408
# File 'lib/irb.rb', line 406

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

.irb_exit(irb, ret) ⇒ Object

Quits irb


411
412
413
# File 'lib/irb.rb', line 411

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

.JobManagerObject

The current JobManager in the session


178
179
180
# File 'lib/irb/ext/multi-irb.rb', line 178

def IRB.JobManager
  @JobManager
end

.load_modulesObject

loading modules


283
284
285
286
287
288
289
290
291
# File 'lib/irb/init.rb', line 283

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

.parse_optsObject

option analyzing


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

def IRB.parse_opts
  load_path = []
  while opt = ARGV.shift
    case opt
    when "-f"
	@CONF[:RC] = false
    when "-m"
	@CONF[:MATH_MODE] = true
    when "-d"
	$DEBUG = true
	$VERBOSE = true
    when "-w"
	$VERBOSE = true
    when /^-W(.+)?/
	opt = $1 || ARGV.shift
	case opt
	when "0"
 $VERBOSE = nil
	when "1"
 $VERBOSE = false
	else
 $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 "--readline"
	@CONF[:USE_READLINE] = true
    when "--noreadline"
	@CONF[:USE_READLINE] = false
    when "--echo"
	@CONF[:ECHO] = true
    when "--noecho"
	@CONF[:ECHO] = false
    when "--verbose"
	@CONF[:VERBOSE] = true
    when "--noverbose"
	@CONF[:VERBOSE] = 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 /^--irb_debug(?:=(.+))?/
	@CONF[:DEBUG_LEVEL] = ($1 || ARGV.shift).to_i
    when "-v", "--version"
	print IRB.version, "\n"
	exit 0
    when "-h", "--help"
	require "irb/help"
	IRB.print_usage
	exit 0
    when "--"
	if opt = ARGV.shift
 @CONF[:SCRIPT] = opt
 $0 = opt
	end
      break
    when /^-/
	IRB.fail UnrecognizedSwitch, opt
    else
	@CONF[:SCRIPT] = opt
	$0 = opt
	break
    end
  end
  if RUBY_VERSION >= FEATURE_IOPT_CHANGE_VERSION
    load_path.collect! do |path|
	/\A\.\// =~ path ? path : File.expand_path(path)
    end
  end
  $LOAD_PATH.unshift(*load_path)

end

Outputs the irb help message, see [email protected]+line+options.


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

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


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/irb/init.rb', line 249

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
    IRB.fail IllegalRCNameGenerator
  end
end

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

enumerate possible rc-file base name generators

Yields:

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

268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/irb/init.rb', line 268

def IRB.rc_file_generators
  if irbrc = ENV["IRBRC"]
    yield proc{|rc| rc == "rc" ? irbrc : irbrc+rc}
  end
  if home = ENV["HOME"]
    yield proc{|rc| home+"/.irb#{rc}"}
  end
  home = Dir.pwd
  yield proc{|rc| home+"/.irb#{rc}"}
  yield proc{|rc| home+"/irb#{rc.sub(/\A_?/, '.')}"}
  yield proc{|rc| home+"/_irb#{rc}"}
  yield proc{|rc| home+"/$irb#{rc}"}
end

.run_configObject

running config


233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/irb/init.rb', line 233

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 [email protected][0, [email protected].size - 2]
 print "\t", err, "\n"
	end
    end
  end
end

.setup(ap_path) ⇒ Object

initialize config


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

def IRB.setup(ap_path)
  IRB.init_config(ap_path)
  IRB.init_error
  IRB.parse_opts
  IRB.run_config
  IRB.load_modules

  unless @CONF[:PROMPT][@CONF[:PROMPT_MODE]]
    IRB.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


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

def IRB.start(ap_path = nil)
  $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

  @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
  @CONF[:MAIN_CONTEXT] = irb.context

  trap("SIGINT") do
    irb.signal_handle
  end

  begin
    catch(:IRB_EXIT) do
      irb.eval_input
    end
  ensure
    irb_at_exit
  end
#    print "\n"
end

.versionObject

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


359
360
361
362
363
364
365
# File 'lib/irb.rb', line 359

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

  require "irb/version"
  rv = @RELEASE_VERSION.sub(/\.0/, "")
  @CONF[:VERSION] = format("irb %s(%s)", rv, @LAST_UPDATE_DATE)
end