Module: Debugger
- Defined in:
- ext/ruby_debug.c
Constant Summary collapse
- VERSION =
rb_str_new2(DEBUG_VERSION)
Class Method Summary collapse
-
.add_breakpoint(source, pos, condition = nil) ⇒ Object
Adds a new breakpoint.
-
.catchpoint(string) ⇒ String
Sets catchpoint.
-
.breakpoints ⇒ Array
Returns an Array of Breakpoint objects; all the breakpoints that have been created.
-
.catchpoints ⇒ Hash
Returns a current catchpoints, which is a hash exception names that will trigger a debugger when raised.
-
.contexts ⇒ Array
Returns an array of all contexts.
-
.current_context ⇒ Object
Returns current context.
-
.debug ⇒ Object
:nodoc:.
-
.debug=(value) ⇒ Object
:nodoc:.
-
.debug_at_exit { ... } ⇒ Proc
Register
at_exit
hook which is escaped from the debugger. -
.debug_load(file, stop = false, increment_start = false) ⇒ nil
Same as Kernel#load but resets current context’s frames.
-
.keep_frame_binding=(bool) ⇒ Object
Setting to
true
will make the debugger create frame bindings. -
.keep_frame_binding? ⇒ Boolean
Returns
true
if the debugger will collect frame bindings. -
.last_interrupted ⇒ Object
Returns last debugged context.
-
.post_mortem=(bool) ⇒ Object
Sets post-moterm flag.
-
.post_mortem? ⇒ Boolean
Returns
true
if post-moterm debugging is enabled. -
.remove_breakpoint(id) ⇒ Object
Removes breakpoint by its id.
-
.resume ⇒ Debugger
Resumes all contexts.
-
.skip { ... } ⇒ Object?
The code inside of the block is escaped from the debugger.
-
.start_ ⇒ Object
This method is internal and activates the debugger.
-
.started? ⇒ Boolean
Returns
true
the debugger is started. -
.stop ⇒ Boolean
This method disables the debugger.
-
.suspend ⇒ Debugger
Suspends all contexts.
-
.thread_context(thread) ⇒ Object
Returns context of the thread passed as an argument.
-
.tracing ⇒ Boolean
Returns
true
if the global tracing is activated. -
.tracing=(bool) ⇒ Object
Sets the global tracing flag.
-
.track_frame_args=(bool) ⇒ Object
Setting to
true
will make the debugger save argument info on calls. -
.track_fame_args? ⇒ Boolean
Returns
true
if the debugger track frame argument values on calls.
Class Method Details
.add_breakpoint(source, pos, condition = nil) ⇒ Object
Adds a new breakpoint. source is a name of a file or a class. pos is a line number or a method name if source is a class name. condition is a string which is evaluated to true
when this breakpoint is activated.
2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 |
# File 'ext/ruby_debug.c', line 2241
static VALUE
debug_add_breakpoint(int argc, VALUE *argv, VALUE self)
{
VALUE result;
debug_check_started();
result = create_breakpoint_from_args(argc, argv, ++bkp_count);
rb_ary_push(rdebug_breakpoints, result);
return result;
}
|
.catchpoint(string) ⇒ String
Sets catchpoint. Returns the string passed.
245 246 247 248 249 250 251 252 253 254 255 |
# File 'ext/breakpoint.c', line 245
VALUE
rdebug_add_catchpoint(VALUE self, VALUE value)
{
debug_check_started();
if (TYPE(value) != T_STRING) {
rb_raise(rb_eTypeError, "value of a catchpoint must be String");
}
rb_hash_aset(rdebug_catchpoints, rb_str_dup(value), INT2FIX(0));
return value;
}
|
.breakpoints ⇒ Array
Returns an Array of Breakpoint objects; all the breakpoints that have been created.
2223 2224 2225 2226 2227 2228 2229 |
# File 'ext/ruby_debug.c', line 2223
static VALUE
debug_breakpoints(VALUE self)
{
debug_check_started();
return rdebug_breakpoints;
}
|
.catchpoints ⇒ Hash
Returns a current catchpoints, which is a hash exception names that will trigger a debugger when raised. The values are the number of times taht catchpoint was hit, initially 0.
231 232 233 234 235 236 237 |
# File 'ext/breakpoint.c', line 231
VALUE
debug_catchpoints(VALUE self)
{
debug_check_started();
return rdebug_catchpoints;
}
|
.contexts ⇒ Array
Returns an array of all contexts.
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 |
# File 'ext/ruby_debug.c', line 1143
static VALUE
debug_contexts(VALUE self)
{
volatile VALUE list;
volatile VALUE new_list;
VALUE thread, context;
threads_table_t *threads_table;
debug_context_t *debug_context;
int i;
debug_check_started();
new_list = rb_ary_new();
list = rb_funcall(rb_cThread, idList, 0);
for(i = 0; i < RARRAY(list)->len; i++)
{
thread = rb_ary_entry(list, i);
thread_context_lookup(thread, &context, NULL);
rb_ary_push(new_list, context);
}
threads_table_clear(rdebug_threads_tbl);
Data_Get_Struct(rdebug_threads_tbl, threads_table_t, threads_table);
for(i = 0; i < RARRAY(new_list)->len; i++)
{
context = rb_ary_entry(new_list, i);
Data_Get_Struct(context, debug_context_t, debug_context);
st_insert(threads_table->tbl, debug_context->thread_id, context);
}
return new_list;
}
|
.current_context ⇒ Object
Returns current context. Note: Debugger.current_context.thread == Thread.current
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 |
# File 'ext/ruby_debug.c', line 1108
static VALUE
debug_current_context(VALUE self)
{
VALUE thread, context;
debug_check_started();
thread = rb_thread_current();
thread_context_lookup(thread, &context, NULL);
return context;
}
|
.debug ⇒ Object
:nodoc:
1354 1355 1356 1357 1358 |
# File 'ext/ruby_debug.c', line 1354
static VALUE
debug_debug(VALUE self)
{
return debug;
}
|
.debug=(value) ⇒ Object
:nodoc:
1361 1362 1363 1364 1365 1366 |
# File 'ext/ruby_debug.c', line 1361
static VALUE
debug_set_debug(VALUE self, VALUE value)
{
debug = RTEST(value) ? Qtrue : Qfalse;
return value;
}
|
.debug_at_exit { ... } ⇒ Proc
Register at_exit
hook which is escaped from the debugger. FOR INTERNAL USE ONLY.
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 |
# File 'ext/ruby_debug.c', line 1491
static VALUE
debug_at_exit(VALUE self)
{
VALUE proc;
if (!rb_block_given_p())
rb_raise(rb_eArgError, "called without a block");
proc = rb_block_proc();
rb_set_end_proc(debug_at_exit_i, proc);
return proc;
}
|
.debug_load(file, stop = false, increment_start = false) ⇒ nil
Same as Kernel#load but resets current context’s frames. stop
parameter forces the debugger to stop at the first line of code in the file
increment_start
determines if start_count should be incremented. When
control threads are used, they have to be set up before loading the
debugger; so here +increment_start+ will be false.
FOR INTERNAL USE ONLY.
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 |
# File 'ext/ruby_debug.c', line 1386
static VALUE
debug_debug_load(int argc, VALUE *argv, VALUE self)
{
VALUE file, stop, context, increment_start;
debug_context_t *debug_context;
int state = 0;
if(rb_scan_args(argc, argv, "12", &file, &stop, &increment_start) == 1)
{
stop = Qfalse;
increment_start = Qtrue;
}
debug_start(self);
if (Qfalse == increment_start) start_count--;
context = debug_current_context(self);
Data_Get_Struct(context, debug_context_t, debug_context);
debug_context->stack_size = 0;
if(RTEST(stop))
debug_context->stop_next = 1;
/* Initializing $0 to the script's path */
ruby_script(RSTRING(file)->ptr);
rb_load_protect(file, 0, &state);
if (0 != state) {
VALUE errinfo = ruby_errinfo;
debug_suspend(self);
reset_stepping_stop_points(debug_context);
ruby_errinfo = Qnil;
return errinfo;
}
/* We should run all at_exit handler's in order to provide,
* for instance, a chance to run all defined test cases */
rb_exec_end_proc();
/* We could have issued a Debugger.stop inside the debug
session. */
if (start_count > 0) {
debug_stop(self);
}
return Qnil;
}
|
.keep_frame_binding=(bool) ⇒ Object
Setting to true
will make the debugger create frame bindings.
1346 1347 1348 1349 1350 1351 |
# File 'ext/ruby_debug.c', line 1346
static VALUE
debug_set_keep_frame_binding(VALUE self, VALUE value)
{
keep_frame_binding = RTEST(value) ? Qtrue : Qfalse;
return value;
}
|
.keep_frame_binding? ⇒ Boolean
Returns true
if the debugger will collect frame bindings.
1334 1335 1336 1337 1338 |
# File 'ext/ruby_debug.c', line 1334
static VALUE
debug_keep_frame_binding(VALUE self)
{
return keep_frame_binding;
}
|
.last_interrupted ⇒ Object
Returns last debugged context.
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 |
# File 'ext/ruby_debug.c', line 1087
static VALUE
debug_last_interrupted(VALUE self)
{
VALUE result = Qnil;
threads_table_t *threads_table;
debug_check_started();
Data_Get_Struct(rdebug_threads_tbl, threads_table_t, threads_table);
st_foreach(threads_table->tbl, find_last_context_func, (st_data_t)&result);
return result;
}
|
.post_mortem=(bool) ⇒ Object
Sets post-moterm flag. FOR INTERNAL USE ONLY.
1294 1295 1296 1297 1298 1299 1300 1301 |
# File 'ext/ruby_debug.c', line 1294
static VALUE
debug_set_post_mortem(VALUE self, VALUE value)
{
debug_check_started();
post_mortem = RTEST(value) ? Qtrue : Qfalse;
return value;
}
|
.post_mortem? ⇒ Boolean
Returns true
if post-moterm debugging is enabled.
1281 1282 1283 1284 1285 |
# File 'ext/ruby_debug.c', line 1281
static VALUE
debug_post_mortem(VALUE self)
{
return post_mortem;
}
|
.remove_breakpoint(id) ⇒ Object
Removes breakpoint by its id. id is an identificator of a breakpoint.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'ext/breakpoint.c', line 200
VALUE
rdebug_remove_breakpoint(VALUE self, VALUE id_value)
{
int i;
int id;
VALUE breakpoint;
debug_breakpoint_t *debug_breakpoint;
id = FIX2INT(id_value);
for( i = 0; i < RARRAY(rdebug_breakpoints)->len; i += 1 )
{
breakpoint = rb_ary_entry(rdebug_breakpoints, i);
Data_Get_Struct(breakpoint, debug_breakpoint_t, debug_breakpoint);
if(debug_breakpoint->id == id)
{
rb_ary_delete_at(rdebug_breakpoints, i);
return breakpoint;
}
}
return Qnil;
}
|
.resume ⇒ Debugger
Resumes all contexts.
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 |
# File 'ext/ruby_debug.c', line 1219
static VALUE
debug_resume(VALUE self)
{
VALUE current, context;
VALUE saved_crit;
VALUE context_list;
debug_context_t *debug_context;
int i;
debug_check_started();
saved_crit = rb_thread_critical;
rb_thread_critical = Qtrue;
context_list = debug_contexts(self);
thread_context_lookup(rb_thread_current(), ¤t, NULL);
for(i = 0; i < RARRAY(context_list)->len; i++)
{
context = rb_ary_entry(context_list, i);
if(current == context)
continue;
Data_Get_Struct(context, debug_context_t, debug_context);
context_resume_0(debug_context);
}
rb_thread_critical = saved_crit;
rb_thread_schedule();
return self;
}
|
.skip { ... } ⇒ Object?
The code inside of the block is escaped from the debugger.
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 |
# File 'ext/ruby_debug.c', line 1452
static VALUE
debug_skip(VALUE self)
{
if (!rb_block_given_p()) {
rb_raise(rb_eArgError, "called without a block");
}
if(!IS_STARTED)
return rb_yield(Qnil);
set_current_skipped_status(Qtrue);
return rb_ensure(rb_yield, Qnil, set_current_skipped_status, Qfalse);
}
|
.start_ ⇒ Boolean .start_ { ... } ⇒ Boolean
This method is internal and activates the debugger. Use Debugger.start (from lib/ruby-debug-base.rb
) instead.
The return value is the value of !Debugger.started? before issuing the start
; That is, true
is returned, unless debugger was previously started.
If a block is given, it starts debugger and yields to block. When the block is finished executing it stops the debugger with Debugger.stop method. Inside the block you will probably want to have a call to Debugger.debugger. For example:
Debugger.start{debugger; foo} # Stop inside of foo
Also, ruby-debug only allows one invocation of debugger at a time; nested Debugger.start’s have no effect and you can’t use this inside the debugger itself.
Note that if you want to completely remove the debugger hook, you must call Debugger.stop as many times as you called Debugger.start method.
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 |
# File 'ext/ruby_debug.c', line 1014
static VALUE
debug_start(VALUE self)
{
VALUE result;
start_count++;
if(IS_STARTED)
result = Qfalse;
else
{
locker = Qnil;
rdebug_breakpoints = rb_ary_new();
rdebug_catchpoints = rb_hash_new();
rdebug_threads_tbl = threads_table_create();
rb_add_event_hook(debug_event_hook, RUBY_EVENT_ALL);
result = Qtrue;
}
if(rb_block_given_p())
rb_ensure(rb_yield, self, debug_stop_i, self);
return result;
}
|
.started? ⇒ Boolean
Returns true
the debugger is started.
325 326 327 328 329 |
# File 'ext/ruby_debug.c', line 325
static VALUE
debug_is_started(VALUE self)
{
return IS_STARTED ? Qtrue : Qfalse;
}
|
.stop ⇒ Boolean
This method disables the debugger. It returns true
if the debugger is disabled, otherwise it returns false
.
Note that if you want to complete remove the debugger hook, you must call Debugger.stop as many times as you called Debugger.start method.
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 |
# File 'ext/ruby_debug.c', line 1050
static VALUE
debug_stop(VALUE self)
{
debug_check_started();
start_count--;
if(start_count)
return Qfalse;
rb_remove_event_hook(debug_event_hook);
locker = Qnil;
rdebug_breakpoints = Qnil;
rdebug_threads_tbl = Qnil;
return Qtrue;
}
|
.suspend ⇒ Debugger
Suspends all contexts.
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 |
# File 'ext/ruby_debug.c', line 1181
static VALUE
debug_suspend(VALUE self)
{
VALUE current, context;
VALUE saved_crit;
VALUE context_list;
debug_context_t *debug_context;
int i;
debug_check_started();
saved_crit = rb_thread_critical;
rb_thread_critical = Qtrue;
context_list = debug_contexts(self);
thread_context_lookup(rb_thread_current(), ¤t, NULL);
for(i = 0; i < RARRAY(context_list)->len; i++)
{
context = rb_ary_entry(context_list, i);
if(current == context)
continue;
Data_Get_Struct(context, debug_context_t, debug_context);
context_suspend_0(debug_context);
}
rb_thread_critical = saved_crit;
if(rb_thread_critical == Qfalse)
rb_thread_schedule();
return self;
}
|
.thread_context(thread) ⇒ Object
Returns context of the thread passed as an argument.
1127 1128 1129 1130 1131 1132 1133 1134 1135 |
# File 'ext/ruby_debug.c', line 1127
static VALUE
debug_thread_context(VALUE self, VALUE thread)
{
VALUE context;
debug_check_started();
thread_context_lookup(thread, &context, NULL);
return context;
}
|
.tracing ⇒ Boolean
Returns true
if the global tracing is activated.
1256 1257 1258 1259 1260 |
# File 'ext/ruby_debug.c', line 1256
static VALUE
debug_tracing(VALUE self)
{
return tracing;
}
|
.tracing=(bool) ⇒ Object
Sets the global tracing flag.
1268 1269 1270 1271 1272 1273 |
# File 'ext/ruby_debug.c', line 1268
static VALUE
debug_set_tracing(VALUE self, VALUE value)
{
tracing = RTEST(value) ? Qtrue : Qfalse;
return value;
}
|
.track_frame_args=(bool) ⇒ Object
Setting to true
will make the debugger save argument info on calls.
1321 1322 1323 1324 1325 1326 |
# File 'ext/ruby_debug.c', line 1321
static VALUE
debug_set_track_frame_args(VALUE self, VALUE value)
{
track_frame_args = RTEST(value) ? Qtrue : Qfalse;
return value;
}
|
.track_fame_args? ⇒ Boolean
Returns true
if the debugger track frame argument values on calls.
1309 1310 1311 1312 1313 |
# File 'ext/ruby_debug.c', line 1309
static VALUE
debug_track_frame_args(VALUE self)
{
return track_frame_args;
}
|