Class: IRB::Context

Inherits:
Object show all
Defined in:
lib/irb/context.rb,
lib/irb/ext/tracer.rb,
lib/irb/ext/change-ws.rb,
lib/irb/ext/use-loader.rb,
lib/irb/ext/workspaces.rb,
lib/irb/ext/eval_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) ⇒ Context

Creates a new IRB context.

The optional input_method argument:

nil

uses stdin or Reline or Readline

String

uses a File

other

uses this as InputMethod



23
24
25
26
27
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
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
# File 'lib/irb/context.rb', line 23

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

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

  if IRB.conf.has_key?(:USE_SINGLELINE)
    @use_singleline = IRB.conf[:USE_SINGLELINE]
  elsif IRB.conf.has_key?(:USE_READLINE) # backward compatibility
    @use_singleline = IRB.conf[:USE_READLINE]
  else
    @use_singleline = nil
  end
  if IRB.conf.has_key?(:USE_MULTILINE)
    @use_multiline = IRB.conf[:USE_MULTILINE]
  elsif IRB.conf.has_key?(:USE_RELINE) # backward compatibility
    warn <<~MSG.strip
      USE_RELINE is deprecated, please use USE_MULTILINE instead.
    MSG
    @use_multiline = IRB.conf[:USE_RELINE]
  elsif IRB.conf.has_key?(:USE_REIDLINE)
    warn <<~MSG.strip
      USE_REIDLINE is deprecated, please use USE_MULTILINE instead.
    MSG
    @use_multiline = IRB.conf[:USE_REIDLINE]
  else
    @use_multiline = nil
  end
  @use_autocomplete = IRB.conf[:USE_AUTOCOMPLETE]
  @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
    @io = nil
    case use_multiline?
    when nil
      if STDIN.tty? && IRB.conf[:PROMPT_MODE] != :INF_RUBY && !use_singleline?
        # Both of multiline mode and singleline mode aren't specified.
        @io = RelineInputMethod.new(build_completor)
      else
        @io = nil
      end
    when false
      @io = nil
    when true
      @io = RelineInputMethod.new(build_completor)
    end
    unless @io
      case use_singleline?
      when nil
        if (defined?(ReadlineInputMethod) && STDIN.tty? &&
            IRB.conf[:PROMPT_MODE] != :INF_RUBY)
          @io = ReadlineInputMethod.new
        else
          @io = nil
        end
      when false
        @io = nil
      when true
        if defined?(ReadlineInputMethod)
          @io = ReadlineInputMethod.new
        else
          @io = nil
        end
      else
        @io = nil
      end
    end
    @io = StdioInputMethod.new unless @io

  when '-'
    @io = FileInputMethod.new($stdin)
    @irb_name = '-'
    @irb_path = '-'
  when String
    @io = FileInputMethod.new(input_method)
    @irb_name = File.basename(input_method)
    @irb_path = input_method
  else
    @io = input_method
  end
  @extra_doc_dirs = IRB.conf[:EXTRA_DOC_DIRS]

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

  @echo_on_assignment = IRB.conf[:ECHO_ON_ASSIGNMENT]
  if @echo_on_assignment.nil?
    @echo_on_assignment = :truncate
  end

  @newline_before_multiline_output = IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT]
  if @newline_before_multiline_output.nil?
    @newline_before_multiline_output = true
  end

  @user_aliases = IRB.conf[:COMMAND_ALIASES].dup
  @command_aliases = @user_aliases.merge(KEYWORD_ALIASES)
end

Instance Attribute Details

#ap_nameObject

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



236
237
238
# File 'lib/irb/context.rb', line 236

def ap_name
  @ap_name
end

#auto_indent_modeObject

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

To disable auto-indentation in irb:

IRB.conf[:AUTO_INDENT] = false

or

irb_context.auto_indent_mode = false

or

IRB.CurrentContext.auto_indent_mode = false

See IRB@Configuration for more information.



306
307
308
# File 'lib/irb/context.rb', line 306

def auto_indent_mode
  @auto_indent_mode
end

#back_trace_limitObject

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.



397
398
399
# File 'lib/irb/context.rb', line 397

def back_trace_limit
  @back_trace_limit
end

#command_aliasesObject

User-defined IRB command aliases



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

def command_aliases
  @command_aliases
end

#echoObject Also known as: echo?

Whether to echo the return value to output or not.

Uses IRB.conf[:ECHO] if available, or defaults to true.

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


337
338
339
# File 'lib/irb/context.rb', line 337

def echo
  @echo
end

#echo_on_assignmentObject Also known as: echo_on_assignment?

Whether to echo for assignment expressions.

If set to false, the value of assignment will not be shown.

If set to true, the value of assignment will be shown.

If set to :truncate, the value of assignment will be shown and truncated.

It defaults to :truncate.

a = "omg"
#=> omg

a = "omg" * 10
#=> omgomgomgomgomgomgomg...

IRB.CurrentContext.echo_on_assignment = false
a = "omg"

IRB.CurrentContext.echo_on_assignment = true
a = "omg" * 10
#=> omgomgomgomgomgomgomgomgomgomg

To set the behaviour of showing on assignment in irb:

IRB.conf[:ECHO_ON_ASSIGNMENT] = :truncate or true or false

or

irb_context.echo_on_assignment = :truncate or true or false

or

IRB.CurrentContext.echo_on_assignment = :truncate or true or false


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

def echo_on_assignment
  @echo_on_assignment
end

#eval_historyObject

The command result history limit. This method is not available until #eval_history= was called with non-nil value (directly or via setting IRB.conf[:EVAL_HISTORY] in .irbrc).



31
32
33
# File 'lib/irb/ext/eval_history.rb', line 31

def eval_history
  @eval_history
end

#extra_doc_dirsObject

Specify the installation locations of the ri file to be displayed in the document dialog.



326
327
328
# File 'lib/irb/context.rb', line 326

def extra_doc_dirs
  @extra_doc_dirs
end

#ignore_eofObject Also known as: ignore_eof?

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

If set to false, ^D will quit irb.



323
324
325
# File 'lib/irb/context.rb', line 323

def ignore_eof
  @ignore_eof
end

#ignore_sigintObject 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.



319
320
321
# File 'lib/irb/context.rb', line 319

def ignore_sigint
  @ignore_sigint
end

#inspect_modeObject

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



261
262
263
# File 'lib/irb/context.rb', line 261

def inspect_mode
  @inspect_mode
end

#ioObject

The current input method.

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



231
232
233
# File 'lib/irb/context.rb', line 231

def io
  @io
end

#irbObject

Current irb session.



234
235
236
# File 'lib/irb/context.rb', line 234

def irb
  @irb
end

#irb_nameObject

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



243
244
245
# File 'lib/irb/context.rb', line 243

def irb_name
  @irb_name
end

#irb_pathObject

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



246
247
248
# File 'lib/irb/context.rb', line 246

def irb_path
  @irb_path
end

#last_valueObject (readonly)

The return value of the last statement evaluated.



453
454
455
# File 'lib/irb/context.rb', line 453

def last_value
  @last_value
end

#load_modulesObject

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



240
241
242
# File 'lib/irb/context.rb', line 240

def load_modules
  @load_modules
end

#newline_before_multiline_outputObject Also known as: newline_before_multiline_output?

Whether a newline is put before multiline output.

Uses IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT] if available, or defaults to true.

"abc\ndef"
#=>
abc
def
IRB.CurrentContext.newline_before_multiline_output = false
"abc\ndef"
#=> abc
def


386
387
388
# File 'lib/irb/context.rb', line 386

def newline_before_multiline_output
  @newline_before_multiline_output
end

#prompt_cObject

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

See Custom Prompts for more information.



276
277
278
# File 'lib/irb/context.rb', line 276

def prompt_c
  @prompt_c
end

#prompt_iObject

Standard IRB prompt.

See Custom Prompts for more information.



268
269
270
# File 'lib/irb/context.rb', line 268

def prompt_i
  @prompt_i
end

#prompt_modeObject

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



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

def prompt_mode
  @prompt_mode
end

#prompt_sObject

IRB prompt for continuated strings.

See Custom Prompts for more information.



272
273
274
# File 'lib/irb/context.rb', line 272

def prompt_s
  @prompt_s
end

#rcObject Also known as: rc?

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



238
239
240
# File 'lib/irb/context.rb', line 238

def rc
  @rc
end

#return_formatObject

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



309
310
311
# File 'lib/irb/context.rb', line 309

def return_format
  @return_format
end

#threadObject (readonly)

The current thread in this context.



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

def thread
  @thread
end

#use_autocompleteObject (readonly) Also known as: use_autocomplete?

Whether colorization is enabled or not.

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



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

def use_autocomplete
  @use_autocomplete
end

#use_multilineObject (readonly) Also known as: use_multiline?, use_reline, use_reline?

Whether multiline editor mode is enabled or not.

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



251
252
253
# File 'lib/irb/context.rb', line 251

def use_multiline
  @use_multiline
end

#use_singlelineObject (readonly) Also known as: use_singleline?, use_readline, use_readline?

Whether singleline editor mode is enabled or not.

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



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

def use_singleline
  @use_singleline
end

#use_tracerObject Also known as: use_tracer?

Whether Tracer is used when evaluating statements in this context.

See lib/tracer.rb for more information.



37
38
39
# File 'lib/irb/ext/tracer.rb', line 37

def use_tracer
  @use_tracer
end

#verboseObject

Whether verbose messages are displayed or not.

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



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

def verbose
  @verbose
end

#with_debuggerObject

Returns the value of attribute with_debugger.



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

def with_debugger
  @with_debugger
end

#workspaceObject

WorkSpace in the current context.



223
224
225
# File 'lib/irb/context.rb', line 223

def workspace
  @workspace
end

#workspace_homeObject (readonly)

The toplevel workspace, see #home_workspace



221
222
223
# File 'lib/irb/context.rb', line 221

def workspace_home
  @workspace_home
end

Instance Method Details

#__inspect__Object



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

alias __inspect__ inspect

#_set_last_valueObject

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



14
15
16
17
# File 'lib/irb/ext/eval_history.rb', line 14

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.



26
27
28
29
30
31
32
33
34
35
36
37
# File 'lib/irb/ext/change-ws.rb', line 26

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

#evaluate(line, line_no) ⇒ Object

:nodoc:



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'lib/irb/context.rb', line 545

def evaluate(line, line_no) # :nodoc:
  @line_no = line_no
  result = nil

  if IRB.conf[:MEASURE] && IRB.conf[:MEASURE_CALLBACKS].empty?
    IRB.set_measure_callback
  end

  if IRB.conf[:MEASURE] && !IRB.conf[:MEASURE_CALLBACKS].empty?
    last_proc = proc do
      result = @workspace.evaluate(line, irb_path, line_no)
    end
    IRB.conf[:MEASURE_CALLBACKS].inject(last_proc) do |chain, item|
      _name, callback, arg = item
      proc do
        callback.(self, line, line_no, arg) do
          chain.call
        end
      end
    end.call
  else
    result = @workspace.evaluate(line, irb_path, line_no)
  end

  set_last_value(result)
end

#file_input?Boolean

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

Returns:

  • (Boolean)


487
488
489
# File 'lib/irb/context.rb', line 487

def file_input?
  @io.class == FileInputMethod
end

#history_fileObject

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



206
207
208
# File 'lib/irb/context.rb', line 206

def history_file
  IRB.conf[:HISTORY_FILE]
end

#history_file=(hist) ⇒ Object

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



211
212
213
# File 'lib/irb/context.rb', line 211

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

#home_workspaceObject

Inherited from TOPLEVEL_BINDING.



11
12
13
14
15
16
17
# File 'lib/irb/ext/change-ws.rb', line 11

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

#inspectObject Also known as: to_s

:nodoc:



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
# File 'lib/irb/context.rb', line 581

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)


481
482
483
# File 'lib/irb/context.rb', line 481

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

#inspect_last_valueObject

:nodoc:



572
573
574
# File 'lib/irb/context.rb', line 572

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

#irb_levelObject

Size of the current WorkSpace stack



11
12
13
# File 'lib/irb/ext/workspaces.rb', line 11

def irb_level
  workspace_stack.size
end

#local_variablesObject

:nodoc:



603
604
605
# File 'lib/irb/context.rb', line 603

def local_variables # :nodoc:
  workspace.binding.local_variables
end

#mainObject

The top-level workspace, see WorkSpace#main



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

def main
  @workspace.main
end

#pop_workspaceObject

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.



52
53
54
55
56
57
58
# File 'lib/irb/ext/workspaces.rb', line 52

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

#prompt_nObject

TODO: Remove this when developing v2.0



279
280
281
282
# File 'lib/irb/context.rb', line 279

def prompt_n
  warn "IRB::Context#prompt_n is deprecated and will be removed in the next major release."
  ""
end

#prompt_n=(_) ⇒ Object

TODO: Remove this when developing v2.0



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

def prompt_n=(_)
  warn "IRB::Context#prompt_n= is deprecated and will be removed in the next major release."
  ""
end

#prompting?Boolean

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

Returns:

  • (Boolean)


446
447
448
449
450
# File 'lib/irb/context.rb', line 446

def prompting?
  verbose? || (STDIN.tty? && @io.kind_of?(StdioInputMethod) ||
               @io.kind_of?(RelineInputMethod) ||
               (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.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/irb/ext/workspaces.rb', line 29

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_historyObject



201
202
203
# File 'lib/irb/context.rb', line 201

def save_history
  IRB.conf[:SAVE_HISTORY]
end

#save_history=(val) ⇒ Object



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

def save_history=(val)
  IRB.conf[:SAVE_HISTORY] = val
end

#set_last_value(value) ⇒ Object

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



457
458
459
460
# File 'lib/irb/context.rb', line 457

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

#symbol_alias?(command) ⇒ Boolean

Return true if it’s aliased from the argument and it’s not an identifier.

Returns:

  • (Boolean)


608
609
610
611
# File 'lib/irb/context.rb', line 608

def symbol_alias?(command)
  return nil if command.match?(/\A\w+\z/)
  command_aliases.key?(command.to_sym)
end

#transform_args?(command) ⇒ Boolean

Return true if the command supports transforming args

Returns:

  • (Boolean)


614
615
616
617
# File 'lib/irb/context.rb', line 614

def transform_args?(command)
  command = command_aliases.fetch(command.to_sym, command)
  ExtendCommandBundle.load_command(command)&.respond_to?(:transform_args)
end

#use_loaderObject 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).



37
38
39
# File 'lib/irb/ext/use-loader.rb', line 37

def use_loader
  IRB.conf[:USE_LOADER]
end

#use_loader=(opt) ⇒ Object

Sets IRB.conf[:USE_LOADER]

See #use_loader for more information.



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

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)


427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
# File 'lib/irb/context.rb', line 427

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

#workspacesObject

WorkSpaces in the current stack



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

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