Class: Thread::Backtrace::Location

Inherits:
Object
  • Object
show all
Defined in:
vm_backtrace.c

Instance Method Summary collapse

Instance Method Details

#absolute_path ⇒ Object

Returns the full file path of this frame.

Same as #path, except that it will return absolute path even if the frame is in the main script.



381
382
383
384
385
 
# File 'vm_backtrace.c', line 381

static VALUE
location_absolute_path_m(VALUE self)
{
    return location_realpath(location_ptr(self));
}

#base_label ⇒ Object

Returns the base label of this frame.

Usually same as #label, without decoration.



283
284
285
286
287
 
# File 'vm_backtrace.c', line 283

static VALUE
location_base_label_m(VALUE self)
{
    return location_base_label(location_ptr(self));
}

#inspect ⇒ Object

Returns the same as calling inspect on the string representation of #to_str



448
449
450
451
452
 
# File 'vm_backtrace.c', line 448

static VALUE
location_inspect_m(VALUE self)
{
    return rb_str_inspect(location_to_str(location_ptr(self)));
}

#label ⇒ Object

Returns the label of this frame.

Usually consists of method, class, module, etc names with decoration.

Consider the following example:

def foo

puts caller_locations(0).first.label

1.times do
  puts caller_locations(0).first.label

  1.times do
    puts caller_locations(0).first.label
  end

end

end

The result of calling foo is this:

label: foo label: block in foo label: block (2 levels) in foo



258
259
260
261
262
 
# File 'vm_backtrace.c', line 258

static VALUE
location_label_m(VALUE self)
{
    return location_label(location_ptr(self));
}

#lineno ⇒ Object

Returns the line number of this frame.

For example, using caller_locations.rb from Thread::Backtrace::Location

loc = c(0..1).first loc.lineno #=> 2



211
212
213
214
215
 
# File 'vm_backtrace.c', line 211

static VALUE
location_lineno_m(VALUE self)
{
    return INT2FIX(location_lineno(location_ptr(self)));
}

#path ⇒ Object

Returns the file name of this frame. This will generally be an absolute path, unless the frame is in the main script, in which case it will be the script location passed on the command line.

For example, using caller_locations.rb from Thread::Backtrace::Location

loc = c(0..1).first loc.path #=> caller_locations.rb



313
314
315
316
317
318
 
# File 'vm_backtrace.c', line 313

static VALUE
location_path_m(VALUE self)
{
    const rb_iseq_t *iseq = location_iseq(location_ptr(self));
    return iseq ? rb_iseq_path(iseq) : Qnil;
}

#to_s ⇒ Object

Returns a Kernel#caller style string representing this frame.



438
439
440
441
442
 
# File 'vm_backtrace.c', line 438

static VALUE
location_to_str_m(VALUE self)
{
    return location_to_str(location_ptr(self));
}