Class: IRB::Context

Inherits:
Object show all
Defined in:
lib/irb/context.rb,
lib/irb/ext/tracer.rb,
lib/irb/ext/history.rb,
lib/irb/ext/change-ws.rb,
lib/irb/ext/use-loader.rb,
lib/irb/ext/workspaces.rb,
lib/irb/ext/save-history.rb

Overview

:nodoc:

Constant Summary collapse

NOPRINTING_IVARS =

:nodoc:

["@last_value"]
NO_INSPECTING_IVARS =

:nodoc:

["@irb", "@io"]
IDNAME_IVARS =

:nodoc:

["@prompt_mode"]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(irb, workspace = nil, input_method = nil, output_method = nil) ⇒ Context

Creates a new IRB context.

The optional input_method argument:

nil

uses stdin or Readline

String

uses a File

other

uses this as InputMethod



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

def initialize(irb, workspace = nil, input_method = nil, output_method = nil)
  @irb = irb
  if workspace
    @workspace = workspace
  else
    @workspace = WorkSpace.new
  end
  @thread = Thread.current if defined? Thread

  # copy of default configuration
  @ap_name = IRB.conf[:AP_NAME]
  @rc = IRB.conf[:RC]
  @load_modules = IRB.conf[:LOAD_MODULES]

  @use_readline = IRB.conf[:USE_READLINE]
  @verbose = IRB.conf[:VERBOSE]
  @io = nil

  self.inspect_mode = IRB.conf[:INSPECT_MODE]
  self.use_tracer = IRB.conf[:USE_TRACER] if IRB.conf[:USE_TRACER]
  self.use_loader = IRB.conf[:USE_LOADER] if IRB.conf[:USE_LOADER]
  self.eval_history = IRB.conf[:EVAL_HISTORY] if IRB.conf[:EVAL_HISTORY]

  @ignore_sigint = IRB.conf[:IGNORE_SIGINT]
  @ignore_eof = IRB.conf[:IGNORE_EOF]

  @back_trace_limit = IRB.conf[:BACK_TRACE_LIMIT]

  self.prompt_mode = IRB.conf[:PROMPT_MODE]

  if IRB.conf[:SINGLE_IRB] or !defined?(IRB::JobManager)
    @irb_name = IRB.conf[:IRB_NAME]
  else
    @irb_name = IRB.conf[:IRB_NAME]+"#"+IRB.JobManager.n_jobs.to_s
  end
  @irb_path = "(" + @irb_name + ")"

  case input_method
  when nil
    case use_readline?
    when nil
      if (defined?(ReadlineInputMethod) && STDIN.tty? &&
          IRB.conf[:PROMPT_MODE] != :INF_RUBY)
        @io = ReadlineInputMethod.new
      else
        @io = StdioInputMethod.new
      end
    when false
      @io = StdioInputMethod.new
    when true
      if defined?(ReadlineInputMethod)
        @io = ReadlineInputMethod.new
      else
        @io = StdioInputMethod.new
      end
    end

  when String
    @io = FileInputMethod.new(input_method)
    @irb_name = File.basename(input_method)
    @irb_path = input_method
  else
    @io = input_method
  end
  self.save_history = IRB.conf[:SAVE_HISTORY] if IRB.conf[:SAVE_HISTORY]

  if output_method
    @output_method = output_method
  else
    @output_method = StdioOutputMethod.new
  end

  @echo = IRB.conf[:ECHO]
  if @echo.nil?
    @echo = true
  end
  self.debug_level = IRB.conf[:DEBUG_LEVEL]
end

Instance Attribute Details

#ap_name ⇒ Object

A copy of the default IRB.conf[:AP_NAME]



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

def ap_name
  @ap_name
end

#auto_indent_mode ⇒ Object

Can be either the default IRB.conf[:AUTO_INDENT], or the mode set by #prompt_mode=

To enable auto-indentation in irb:

IRB.conf[:AUTO_INDENT] = true

or

irb_context.auto_indent_mode = true

or

IRB.CurrentContext.auto_indent_mode = true

See IRB@Configuration for more information.



181
182
183
 
# File 'lib/irb/context.rb', line 181

def auto_indent_mode
  @auto_indent_mode
end

#back_trace_limit ⇒ Object

The limit of backtrace lines displayed as top n and tail n.

The default value is 16.

Can also be set using the --back-trace-limit command line option.

See IRB@Command+line+options for more command line options.



226
227
228
 
# File 'lib/irb/context.rb', line 226

def back_trace_limit
  @back_trace_limit
end

#debug_level ⇒ Object

The debug level of irb

See #debug_level= for more information.



217
218
219
 
# File 'lib/irb/context.rb', line 217

def debug_level
  @debug_level
end

#echo ⇒ Object Also known as: echo?

Whether to echo the return value to output or not.

Uses IRB.conf if available, or defaults to true.

puts "hello"
# hello
#=> nil
IRB.CurrentContext.echo = false
puts "omg"
# omg



209
210
211
 
# File 'lib/irb/context.rb', line 209

def echo
  @echo
end

#eval_history ⇒ Object

The command result history limit.



34
35
36
 
# File 'lib/irb/ext/history.rb', line 34

def eval_history
  @eval_history
end

#ignore_eof ⇒ Object Also known as: ignore_eof?

Whether ^D (control-d) will be ignored or not.

If set to false, ^D will quit irb.



198
199
200
 
# File 'lib/irb/context.rb', line 198

def ignore_eof
  @ignore_eof
end

#ignore_sigint ⇒ Object Also known as: ignore_sigint?

Whether ^C (control-c) will be ignored or not.

If set to false, ^C will quit irb.

If set to true,

  • during input: cancel input then return to top level.

  • during execute: abandon current execution.



194
195
196
 
# File 'lib/irb/context.rb', line 194

def ignore_sigint
  @ignore_sigint
end

#inspect_mode ⇒ Object

A copy of the default IRB.conf[:INSPECT_MODE]



147
148
149
 
# File 'lib/irb/context.rb', line 147

def inspect_mode
  @inspect_mode
end

#io ⇒ Object

The current input method

Can be either StdioInputMethod, ReadlineInputMethod, FileInputMethod or other specified when the context is created. See ::new for more information on input_method.



123
124
125
 
# File 'lib/irb/context.rb', line 123

def io
  @io
end

#irb ⇒ Object

Current irb session



126
127
128
 
# File 'lib/irb/context.rb', line 126

def irb
  @irb
end

#irb_name ⇒ Object

Can be either name from IRB.conf[:IRB_NAME], or the number of the current job set by JobManager, such as irb#2



135
136
137
 
# File 'lib/irb/context.rb', line 135

def irb_name
  @irb_name
end

#irb_path ⇒ Object

Can be either the #irb_name surrounded by parenthesis, or the input_method passed to Context.new



138
139
140
 
# File 'lib/irb/context.rb', line 138

def irb_path
  @irb_path
end

#last_value ⇒ Object (readonly)

The return value of the last statement evaluated.



259
260
261
 
# File 'lib/irb/context.rb', line 259

def last_value
  @last_value
end

#load_modules ⇒ Object

A copy of the default IRB.conf[:LOAD_MODULES]



132
133
134
 
# File 'lib/irb/context.rb', line 132

def load_modules
  @load_modules
end

#prompt_c ⇒ Object

IRB prompt for continuated statement (e.g. immediately after an if)

See IRB@Customizing+the+IRB+Prompt for more information.



162
163
164
 
# File 'lib/irb/context.rb', line 162

def prompt_c
  @prompt_c
end

#prompt_i ⇒ Object

Standard IRB prompt

See IRB@Customizing+the+IRB+Prompt for more information.



154
155
156
 
# File 'lib/irb/context.rb', line 154

def prompt_i
  @prompt_i
end

#prompt_mode ⇒ Object

A copy of the default IRB.conf[:PROMPT_MODE]



150
151
152
 
# File 'lib/irb/context.rb', line 150

def prompt_mode
  @prompt_mode
end

#prompt_n ⇒ Object

See IRB@Customizing+the+IRB+Prompt for more information.



164
165
166
 
# File 'lib/irb/context.rb', line 164

def prompt_n
  @prompt_n
end

#prompt_s ⇒ Object

IRB prompt for continuated strings

See IRB@Customizing+the+IRB+Prompt for more information.



158
159
160
 
# File 'lib/irb/context.rb', line 158

def prompt_s
  @prompt_s
end

#rc ⇒ Object Also known as: rc?

A copy of the default IRB.conf[:RC]



130
131
132
 
# File 'lib/irb/context.rb', line 130

def rc
  @rc
end

#return_format ⇒ Object

The format of the return statement, set by #prompt_mode= using the :RETURN of the mode passed to set the current #prompt_mode.



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

def return_format
  @return_format
end

#thread ⇒ Object (readonly)

The current thread in this context



117
118
119
 
# File 'lib/irb/context.rb', line 117

def thread
  @thread
end

#use_readline ⇒ Object Also known as: use_readline?

Whether Readline is enabled or not.

A copy of the default IRB.conf[:USE_READLINE]

See #use_readline= for more information.



145
146
147
 
# File 'lib/irb/context.rb', line 145

def use_readline
  @use_readline
end

#use_tracer ⇒ Object Also known as: use_tracer?

Whether Tracer is used when evaluating statements in this context.

See lib/tracer.rb for more information.



30
31
32
 
# File 'lib/irb/ext/tracer.rb', line 30

def use_tracer
  @use_tracer
end

#verbose ⇒ Object

Whether verbose messages are displayed or not.

A copy of the default IRB.conf[:VERBOSE]



213
214
215
 
# File 'lib/irb/context.rb', line 213

def verbose
  @verbose
end

#workspace ⇒ Object

WorkSpace in the current context



115
116
117
 
# File 'lib/irb/context.rb', line 115

def workspace
  @workspace
end

#workspace_home ⇒ Object (readonly)

The toplevel workspace, see #home_workspace



113
114
115
 
# File 'lib/irb/context.rb', line 113

def workspace_home
  @workspace_home
end

Instance Method Details

#__exit__ ⇒ Object 



392
 
# File 'lib/irb/context.rb', line 392

alias __exit__ exit

#__inspect__ ⇒ Object 



402
 
# File 'lib/irb/context.rb', line 402

alias __inspect__ inspect

#_set_last_value ⇒ Object

Sets the return value from the last statement evaluated in this context to #last_value. See #set_last_value



20
21
22
23
 
# File 'lib/irb/ext/history.rb', line 20

def set_last_value(value)
  @last_value = value
  @workspace.local_variable_set :_, value
end

#change_workspace(*_main) ⇒ Object

Changes the current workspace to given object or binding.

If the optional argument is omitted, the workspace will be #home_workspace which is inherited from TOPLEVEL_BINDING or the main object, IRB.conf[:MAIN_CONTEXT] when irb was initialized.

See IRB::WorkSpace.new for more information.



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/irb/ext/change-ws.rb', line 32

def change_workspace(*_main)
  if _main.empty?
    @workspace = home_workspace
    return main
  end

  @workspace = WorkSpace.new(_main[0])

  if !(class<<main;ancestors;end).include?(ExtendCommandBundle)
    main.extend ExtendCommandBundle
  end
end

#debug? ⇒ Boolean

Whether or not debug mode is enabled, see #debug_level=.

Returns:

  • (Boolean) 


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

def debug?
  @debug_level > 0
end

#evaluate(line, line_no, exception: nil) ⇒ Object

:nodoc:



379
380
381
382
383
384
385
386
 
# File 'lib/irb/context.rb', line 379

def evaluate(line, line_no, exception: nil) # :nodoc:
  @line_no = line_no
  if exception
    line = "begin ::Kernel.raise _; rescue _.class; #{line}; end"
    @workspace.local_variable_set(:_, exception)
  end
  set_last_value(@workspace.evaluate(self, line, irb_path, line_no))
end

#exit(ret = 0) ⇒ Object

Exits the current session, see IRB.irb_exit



394
395
396
 
# File 'lib/irb/context.rb', line 394

def exit(ret = 0)
  IRB.irb_exit(@irb, ret)
end

#file_input? ⇒ Boolean

Whether #io uses a File for the input_method passed when creating the current context, see ::new

Returns:

  • (Boolean) 


293
294
295
 
# File 'lib/irb/context.rb', line 293

def file_input?
  @io.class == FileInputMethod
end

#history_file ⇒ Object

A copy of the default IRB.conf[:HISTORY_FILE]



50
51
52
 
# File 'lib/irb/ext/save-history.rb', line 50

def history_file
  IRB.conf[:HISTORY_FILE]
end

#history_file=(hist) ⇒ Object

Set IRB.conf[:HISTORY_FILE] to the given hist.



55
56
57
 
# File 'lib/irb/ext/save-history.rb', line 55

def history_file=(hist)
  IRB.conf[:HISTORY_FILE] = hist
end

#home_workspace ⇒ Object

Inherited from TOPLEVEL_BINDING.



17
18
19
20
21
22
23
 
# File 'lib/irb/ext/change-ws.rb', line 17

def home_workspace
  if defined? @home_workspace
    @home_workspace
  else
    @home_workspace = @workspace
  end
end

#init_save_history ⇒ Object

:nodoc:



19
20
21
22
23
 
# File 'lib/irb/ext/save-history.rb', line 19

def init_save_history# :nodoc:
  unless (class<<@io;self;end).include?(HistorySavingAbility)
    @io.extend(HistorySavingAbility)
  end
end

#inspect ⇒ Object Also known as: to_s

:nodoc:



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/irb/context.rb', line 403

def inspect # :nodoc:
  array = []
  for ivar in instance_variables.sort{|e1, e2| e1 <=> e2}
    ivar = ivar.to_s
    name = ivar.sub(/^@(.*)$/, '\1')
    val = instance_eval(ivar)
    case ivar
    when *NOPRINTING_IVARS
      array.push format("conf.%s=%s", name, "...")
    when *NO_INSPECTING_IVARS
      array.push format("conf.%s=%s", name, val.to_s)
    when *IDNAME_IVARS
      array.push format("conf.%s=:%s", name, val.id2name)
    else
      array.push format("conf.%s=%s", name, val.inspect)
    end
  end
  array.join("\n")
end

#inspect? ⇒ Boolean

Whether #inspect_mode is set or not, see #inspect_mode= for more detail.

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/irb/context.rb', line 287

def inspect?
  @inspect_mode.nil? or @inspect_mode
end

#inspect_last_value ⇒ Object

:nodoc:



388
389
390
 
# File 'lib/irb/context.rb', line 388

def inspect_last_value # :nodoc:
  @inspect_method.inspect_value(@last_value)
end

#irb_level ⇒ Object

Size of the current WorkSpace stack



17
18
19
 
# File 'lib/irb/ext/workspaces.rb', line 17

def irb_level
  workspace_stack.size
end

#main ⇒ Object

The top-level workspace, see WorkSpace#main



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

def main
  @workspace.main
end

#pop_workspace ⇒ Object

Removes the last element from the current #workspaces stack and returns it, or nil if the current workspace stack is empty.

Also, see #push_workspace.



58
59
60
61
62
63
64
 
# File 'lib/irb/ext/workspaces.rb', line 58

def pop_workspace
  if workspaces.empty?
    print "workspace stack empty\n"
    return
  end
  @workspace = workspaces.pop
end

#prompting? ⇒ Boolean

Whether #verbose? is true, and input_method is either StdioInputMethod or ReadlineInputMethod, see #io for more information.

Returns:

  • (Boolean) 


253
254
255
256
 
# File 'lib/irb/context.rb', line 253

def prompting?
  verbose? || (STDIN.tty? && @io.kind_of?(StdioInputMethod) ||
               (defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)))
end

#push_workspace(*_main) ⇒ Object

Creates a new workspace with the given object or binding, and appends it onto the current #workspaces stack.

See IRB::Context#change_workspace and IRB::WorkSpace.new for more information.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/irb/ext/workspaces.rb', line 35

def push_workspace(*_main)
  if _main.empty?
    if workspaces.empty?
      print "No other workspace\n"
      return nil
    end
    ws = workspaces.pop
    workspaces.push @workspace
    @workspace = ws
    return workspaces
  end

  workspaces.push @workspace
  @workspace = WorkSpace.new(@workspace.binding, _main[0])
  if !(class<<main;ancestors;end).include?(ExtendCommandBundle)
    main.extend ExtendCommandBundle
  end
end

#save_history ⇒ Object

A copy of the default IRB.conf[:SAVE_HISTORY]



26
27
28
 
# File 'lib/irb/ext/save-history.rb', line 26

def save_history
  IRB.conf[:SAVE_HISTORY]
end

#save_history=(val) ⇒ Object

Sets IRB.conf[:SAVE_HISTORY] to the given val and calls #init_save_history with this context.

Will store the number of val entries of history in the #history_file

Add the following to your .irbrc to change the number of history entries stored to 1000:

IRB.conf[:SAVE_HISTORY] = 1000



40
41
42
43
44
45
46
47
 
# File 'lib/irb/ext/save-history.rb', line 40

def save_history=(val)
  IRB.conf[:SAVE_HISTORY] = val
  if val
    main_context = IRB.conf[:MAIN_CONTEXT]
    main_context = self unless main_context
    main_context.init_save_history
  end
end

#set_last_value(value) ⇒ Object

Sets the return value from the last statement evaluated in this context to #last_value.



263
264
265
266
 
# File 'lib/irb/context.rb', line 263

def set_last_value(value)
  @last_value = value
  @workspace.local_variable_set :_, value
end

#use_loader ⇒ Object Also known as: use_loader?

Returns whether irb‘s own file reader method is used by load/require or not.

This mode is globally affected (irb-wide).



41
42
43
 
# File 'lib/irb/ext/use-loader.rb', line 41

def use_loader
  IRB.conf[:USE_LOADER]
end

#use_loader=(opt) ⇒ Object

Sets IRB.conf

See #use_loader for more information.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/irb/ext/use-loader.rb', line 50

def use_loader=(opt)

  if IRB.conf[:USE_LOADER] != opt
    IRB.conf[:USE_LOADER] = opt
    if opt
      if !$".include?("irb/cmd/load")
      end
      (class<<@workspace.main;self;end).instance_eval {
        alias_method :load, :irb_load
        alias_method :require, :irb_require
      }
    else
      (class<<@workspace.main;self;end).instance_eval {
        alias_method :load, :__original__load__IRB_use_loader__
        alias_method :require, :__original__require__IRB_use_loader__
      }
    end
  end
  print "Switch to load/require#{unless use_loader; ' non';end} trace mode.\n" if verbose?
  opt
end

#verbose? ⇒ Boolean

Returns whether messages are displayed or not.

Returns:

  • (Boolean) 


237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/irb/context.rb', line 237

def verbose?
  if @verbose.nil?
    if defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)
      false
    elsif !STDIN.tty? or @io.kind_of?(FileInputMethod)
      true
    else
      false
    end
  else
    @verbose
  end
end

#workspaces ⇒ Object

WorkSpaces in the current stack



22
23
24
25
26
27
28
 
# File 'lib/irb/ext/workspaces.rb', line 22

def workspaces
  if defined? @workspaces
    @workspaces
  else
    @workspaces = []
  end
end