byebug 11.1.3 → 13.0.0

data/ext/byebug/byebug.c

@@ -136,26 +136,32 @@ cleanup(debug_context_t *dc)
 
 #define EVENT_TEARDOWN cleanup(dc);
 
-#define EVENT_SETUP                                     \
-  debug_context_t *dc;                                  \
-  VALUE context;                                        \
-  rb_trace_arg_t *trace_arg;                            \
-                                                        \
-  UNUSED(data);                                         \
-                                                        \
-  if (!is_living_thread(rb_thread_current()))           \
-    return;                                             \
-                                                        \
-  thread_context_lookup(rb_thread_current(), &context); \
-  Data_Get_Struct(context, debug_context_t, dc);        \
-                                                        \
-  trace_arg = rb_tracearg_from_tracepoint(trace_point); \
-  if (verbose == Qtrue)                                 \
-    trace_print(trace_arg, dc, 0, 0);                   \
-                                                        \
-  if (CTX_FL_TEST(dc, CTX_FL_IGNORE))                   \
-    return;                                             \
-                                                        \
+#define EVENT_SETUP                                              \
+  debug_context_t *dc;                                           \
+  VALUE context;                                                 \
+  rb_trace_arg_t *trace_arg;                                     \
+                                                                 \
+  UNUSED(data);                                                  \
+                                                                 \
+  if (!is_living_thread(rb_thread_current()))                    \
+    return;                                                      \
+                                                                 \
+  thread_context_lookup(rb_thread_current(), &context);          \
+  dc = debug_context_ptr(context);                               \
+                                                                 \
+  trace_arg = rb_tracearg_from_tracepoint(trace_point);          \
+  if (verbose == Qtrue)                                          \
+    trace_print(trace_arg, dc, 0, 0);                            \
+                                                                 \
+  if (CTX_FL_TEST(dc, CTX_FL_IGNORE))                            \
+    return;                                                      \
+                                                                 \
+  VALUE rb_path = rb_tracearg_path(trace_arg);                   \
+  const char *path = NIL_P(rb_path) ? "" : RSTRING_PTR(rb_path); \
+                                                                 \
+  if (!strncmp(path, "<internal:", strlen("<internal:")))        \
+    return;                                                      \
+                                                                 \
   acquire_lock(dc);
 
 
@@ -436,7 +442,7 @@ raise_event(VALUE trace_point, void *data)
     pm_context = context_dup(dc);
     rb_ivar_set(raised_exception, rb_intern("@__bb_context"), pm_context);
 
-    Data_Get_Struct(pm_context, debug_context_t, new_dc);
+    new_dc = debug_context_ptr(pm_context);
     rb_debug_inspector_open(context_backtrace_set, (void *)new_dc);
   }
 
@@ -562,13 +568,13 @@ Contexts(VALUE self)
     rb_ary_push(new_list, context);
   }
 
-  Data_Get_Struct(threads, threads_table_t, t_tbl);
+  t_tbl = threads_table_ptr(threads);
   st_clear(t_tbl->tbl);
 
   for (i = 0; i < RARRAY_LENINT(new_list); i++)
   {
     context = rb_ary_entry(new_list, i);
-    Data_Get_Struct(context, debug_context_t, dc);
+    dc = debug_context_ptr(context);
     st_insert(t_tbl->tbl, dc->thread, context);
   }
 
@@ -677,7 +683,7 @@ Stoppable(VALUE self)
   context = Current_context(self);
   if (!NIL_P(context))
   {
-    Data_Get_Struct(context, debug_context_t, dc);
+    dc = debug_context_ptr(context);
 
     if (dc->steps > 0)
       return Qfalse;
@@ -731,7 +737,7 @@ Debug_load(int argc, VALUE *argv, VALUE self)
   Start(self);
 
   context = Current_context(self);
-  Data_Get_Struct(context, debug_context_t, dc);
+  dc = debug_context_ptr(context);
 
   dc->calced_stack_size = 1;
 
@@ -854,7 +860,7 @@ Add_catchpoint(VALUE self, VALUE value)
 }
 
 /*
- *   Document-class: Byebug
+ *   Document-module: Byebug
  *
  *   == Summary
  *

data/ext/byebug/byebug.h

@@ -116,6 +116,7 @@ extern void byebug_remove_from_locked(VALUE thread);
 /* functions from threads.c */
 extern void Init_threads_table(VALUE mByebug);
 extern VALUE create_threads_table(void);
+extern threads_table_t *threads_table_ptr(VALUE thrads);
 extern void thread_context_lookup(VALUE thread, VALUE *context);
 extern int is_living_thread(VALUE thread);
 extern void acquire_lock(debug_context_t *dc);
@@ -128,6 +129,7 @@ extern VALUE next_thread;
 /* functions from context.c */
 extern void Init_byebug_context(VALUE mByebug);
 extern VALUE byebug_context_create(VALUE thread);
+extern debug_context_t *debug_context_ptr(VALUE context);
 extern VALUE context_dup(debug_context_t *context);
 extern void byebug_reset_stepping_stop_points(debug_context_t *context);
 extern VALUE call_with_debug_inspector(struct call_with_inspection_data *data);

data/ext/byebug/context.c

@@ -15,6 +15,25 @@ byebug_reset_stepping_stop_points(debug_context_t *context)
   context->steps_out = -1;
 }
 
+static void context_mark(void *data);
+
+static const rb_data_type_t debug_context_type = {
+  "Byebug::Context",
+  {
+    context_mark,
+    RUBY_NEVER_FREE,
+  },
+};
+
+debug_context_t *
+debug_context_ptr(VALUE self)
+{
+  debug_context_t *context;
+
+  TypedData_Get_Struct(self, debug_context_t, &debug_context_type, context);
+  return context;
+}
+
 /*
  *  call-seq:
  *    context.dead? -> bool
@@ -25,9 +44,8 @@ byebug_reset_stepping_stop_points(debug_context_t *context)
 static inline VALUE
 Context_dead(VALUE self)
 {
-  debug_context_t *context;
+  debug_context_t *context = debug_context_ptr(self);
 
-  Data_Get_Struct(self, debug_context_t, context);
   return CTX_FL_TEST(context, CTX_FL_DEAD) ? Qtrue : Qfalse;
 }
 
@@ -58,7 +76,8 @@ dc_stack_size(debug_context_t *context)
 extern VALUE
 byebug_context_create(VALUE thread)
 {
-  debug_context_t *context = ALLOC(debug_context_t);
+  debug_context_t *context;
+  VALUE obj = TypedData_Make_Struct(cContext, debug_context_t, &debug_context_type, context);
 
   context->flags = 0;
   context->thnum = ++thnum_max;
@@ -72,20 +91,21 @@ byebug_context_create(VALUE thread)
   if (rb_obj_class(thread) == cDebugThread)
     CTX_FL_SET(context, CTX_FL_IGNORE);
 
-  return Data_Wrap_Struct(cContext, context_mark, 0, context);
+  return obj;
 }
 
 extern VALUE
 context_dup(debug_context_t *context)
 {
-  debug_context_t *new_context = ALLOC(debug_context_t);
+  debug_context_t *new_context;
+  VALUE obj = TypedData_Make_Struct(cContext, debug_context_t, &debug_context_type, new_context);
 
   memcpy(new_context, context, sizeof(debug_context_t));
   byebug_reset_stepping_stop_points(new_context);
   new_context->backtrace = context->backtrace;
   CTX_FL_SET(new_context, CTX_FL_DEAD);
 
-  return Data_Wrap_Struct(cContext, context_mark, 0, new_context);
+  return obj;
 }
 
 
@@ -204,14 +224,13 @@ call_with_debug_inspector(struct call_with_inspection_data *data)
                    (VALUE)data);
 }
 
-#define FRAME_SETUP                                \
-  debug_context_t *context;                        \
-  VALUE frame_no;                                  \
-  int frame_n;                                     \
-  Data_Get_Struct(self, debug_context_t, context); \
-  if (!rb_scan_args(argc, argv, "01", &frame_no))  \
-    frame_n = 0;                                   \
-  else                                             \
+#define FRAME_SETUP                                   \
+  debug_context_t *context = debug_context_ptr(self); \
+  VALUE frame_no;                                     \
+  int frame_n;                                        \
+  if (!rb_scan_args(argc, argv, "01", &frame_no))     \
+    frame_n = 0;                                      \
+  else                                                \
     frame_n = FIX2INT(frame_no);
 
 /*
@@ -325,9 +344,8 @@ Context_frame_self(int argc, VALUE *argv, VALUE self)
 static inline VALUE
 Context_ignored(VALUE self)
 {
-  debug_context_t *context;
+  debug_context_t *context = debug_context_ptr(self);
 
-  Data_Get_Struct(self, debug_context_t, context);
   return CTX_FL_TEST(context, CTX_FL_IGNORE) ? Qtrue : Qfalse;
 }
 
@@ -340,9 +358,7 @@ Context_ignored(VALUE self)
 static VALUE
 Context_resume(VALUE self)
 {
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   if (!CTX_FL_TEST(context, CTX_FL_SUSPEND))
     return Qnil;
@@ -364,9 +380,7 @@ Context_resume(VALUE self)
 static inline VALUE
 Context_backtrace(VALUE self)
 {
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   return dc_backtrace(context);
 }
@@ -374,11 +388,9 @@ Context_backtrace(VALUE self)
 static VALUE
 Context_stop_reason(VALUE self)
 {
-  debug_context_t *context;
+  debug_context_t *context = debug_context_ptr(self);
   const char *symbol;
 
-  Data_Get_Struct(self, debug_context_t, context);
-
   if (CTX_FL_TEST(context, CTX_FL_DEAD))
     symbol = "post-mortem";
   else
@@ -412,9 +424,7 @@ Context_step_into(int argc, VALUE *argv, VALUE self)
 {
   VALUE steps, v_frame;
   int n_args, from_frame;
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   if (context->calced_stack_size == 0)
     rb_raise(rb_eRuntimeError, "No frames collected.");
@@ -452,13 +462,11 @@ Context_step_out(int argc, VALUE *argv, VALUE self)
 {
   int n_args, n_frames;
   VALUE v_frames, force;
-  debug_context_t *context;
+  debug_context_t *context = debug_context_ptr(self);
 
   n_args = rb_scan_args(argc, argv, "02", &v_frames, &force);
   n_frames = n_args == 0 ? 1 : FIX2INT(v_frames);
 
-  Data_Get_Struct(self, debug_context_t, context);
-
   if (n_frames < 0 || n_frames > context->calced_stack_size)
     rb_raise(rb_eRuntimeError,
              "You want to finish %d frames, but stack size is only %d",
@@ -485,9 +493,7 @@ Context_step_over(int argc, VALUE *argv, VALUE self)
 {
   int n_args, frame;
   VALUE lines, v_frame;
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   if (context->calced_stack_size == 0)
     rb_raise(rb_eRuntimeError, "No frames collected.");
@@ -515,9 +521,7 @@ static VALUE
 Context_suspend(VALUE self)
 {
   VALUE status;
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   status = rb_funcall(context->thread, rb_intern("status"), 0);
 
@@ -542,9 +546,7 @@ Context_suspend(VALUE self)
 static VALUE
 Context_switch(VALUE self)
 {
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   next_thread = context->thread;
 
@@ -564,9 +566,7 @@ Context_switch(VALUE self)
 static VALUE
 Context_is_suspended(VALUE self)
 {
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   return CTX_FL_TEST(context, CTX_FL_SUSPEND) ? Qtrue : Qfalse;
 }
@@ -580,9 +580,8 @@ Context_is_suspended(VALUE self)
 static inline VALUE
 Context_thnum(VALUE self)
 {
-  debug_context_t *context;
+  debug_context_t *context = debug_context_ptr(self);
 
-  Data_Get_Struct(self, debug_context_t, context);
   return INT2FIX(context->thnum);
 }
 
@@ -595,9 +594,8 @@ Context_thnum(VALUE self)
 static inline VALUE
 Context_thread(VALUE self)
 {
-  debug_context_t *context;
+  debug_context_t *context = debug_context_ptr(self);
 
-  Data_Get_Struct(self, debug_context_t, context);
   return context->thread;
 }
 
@@ -610,9 +608,8 @@ Context_thread(VALUE self)
 static VALUE
 Context_tracing(VALUE self)
 {
-  debug_context_t *context;
+  debug_context_t *context = debug_context_ptr(self);
 
-  Data_Get_Struct(self, debug_context_t, context);
   return CTX_FL_TEST(context, CTX_FL_TRACING) ? Qtrue : Qfalse;
 }
 
@@ -625,9 +622,7 @@ Context_tracing(VALUE self)
 static VALUE
 Context_set_tracing(VALUE self, VALUE value)
 {
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
+  debug_context_t *context = debug_context_ptr(self);
 
   if (RTEST(value))
     CTX_FL_SET(context, CTX_FL_TRACING);
@@ -658,6 +653,7 @@ void
 Init_byebug_context(VALUE mByebug)
 {
   cContext = rb_define_class_under(mByebug, "Context", rb_cObject);
+  rb_undef_alloc_func(cContext);
 
   rb_define_method(cContext, "backtrace", Context_backtrace, 0);
   rb_define_method(cContext, "dead?", Context_dead, 0);

data/ext/byebug/threads.c

@@ -42,6 +42,14 @@ t_tbl_free(void *data)
   xfree(t_tbl);
 }
 
+static const rb_data_type_t threads_table_type = {
+  "Byebug::ThreadsTable",
+  {
+    t_tbl_mark,
+    t_tbl_free,
+  },
+};
+
 /*
  *  Creates a numeric hash whose keys are the currently active threads and
  *  whose values are their associated contexts.
@@ -50,10 +58,19 @@ VALUE
 create_threads_table(void)
 {
   threads_table_t *t_tbl;
+  VALUE tbl = TypedData_Make_Struct(cThreadsTable, threads_table_t, &threads_table_type, t_tbl);
 
-  t_tbl = ALLOC(threads_table_t);
   t_tbl->tbl = st_init_numtable();
-  return Data_Wrap_Struct(cThreadsTable, t_tbl_mark, t_tbl_free, t_tbl);
+  return tbl;
+}
+
+threads_table_t *
+threads_table_ptr(VALUE threads)
+{
+  threads_table_t *t_tbl;
+
+  TypedData_Get_Struct(threads, threads_table_t, &threads_table_type, t_tbl);
+  return t_tbl;
 }
 
 /*
@@ -100,9 +117,7 @@ is_living_thread(VALUE thread)
 static void
 cleanup_dead_threads(void)
 {
-  threads_table_t *t_tbl;
-
-  Data_Get_Struct(threads, threads_table_t, t_tbl);
+  threads_table_t *t_tbl = threads_table_ptr(threads);
   st_foreach(t_tbl->tbl, check_thread_i, 0);
 }
 
@@ -112,9 +127,7 @@ cleanup_dead_threads(void)
 void
 thread_context_lookup(VALUE thread, VALUE *context)
 {
-  threads_table_t *t_tbl;
-
-  Data_Get_Struct(threads, threads_table_t, t_tbl);
+  threads_table_t *t_tbl = threads_table_ptr(threads);
 
   if (!st_lookup(t_tbl->tbl, thread, context) || !*context)
   {
@@ -180,8 +193,16 @@ release_lock(void)
 static VALUE
 Unlock(VALUE self)
 {
+  debug_context_t *dc;
+  VALUE context;
+
   UNUSED(self);
 
+  thread_context_lookup(rb_thread_current(), &context);
+  dc = debug_context_ptr(context);
+
+  CTX_FL_SET(dc, CTX_FL_IGNORE);
+
   release_lock();
 
   return locker;
@@ -205,10 +226,12 @@ Lock(VALUE self)
     rb_raise(rb_eRuntimeError, "Current thread is dead!");
 
   thread_context_lookup(rb_thread_current(), &context);
-  Data_Get_Struct(context, debug_context_t, dc);
+  dc = debug_context_ptr(context);
 
   acquire_lock(dc);
 
+  CTX_FL_UNSET(dc, CTX_FL_IGNORE);
+
   return locker;
 }
 
@@ -224,6 +247,7 @@ void
 Init_threads_table(VALUE mByebug)
 {
   cThreadsTable = rb_define_class_under(mByebug, "ThreadsTable", rb_cObject);
+  rb_undef_alloc_func(cThreadsTable);
 
   rb_define_module_function(mByebug, "unlock", Unlock, 0);
   rb_define_module_function(mByebug, "lock", Lock, 0);

data/lib/byebug/breakpoint.rb

@@ -53,11 +53,7 @@ module Byebug
       name = "#{Time.new.to_i}_#{rand(2**31)}"
       iseq = RubyVM::InstructionSequence.compile(File.read(filename), name)
 
-      if iseq.respond_to?(:each_child)
-        potential_lines_with_trace_points(iseq, {})
-      else
-        potential_lines_without_trace_points(iseq, {})
-      end
+      potential_lines_with_trace_points(iseq, {})
     end
 
     def self.potential_lines_with_trace_points(iseq, lines)
@@ -71,19 +67,6 @@ module Byebug
 
     private_class_method :potential_lines_with_trace_points
 
-    def self.potential_lines_without_trace_points(iseq, lines)
-      iseq.disasm.each_line do |line|
-        res = /^\d+ (?<insn>\w+)\s+.+\(\s*(?<lineno>\d+)\)$/.match(line)
-        next unless res && res[:insn] == "trace"
-
-        lines[res[:lineno].to_i] = true
-      end
-
-      lines.keys
-    end
-
-    private_class_method :potential_lines_without_trace_points
-
     #
     # Returns true if a breakpoint could be set in line number +lineno+ in file
     # name +filename.

data/lib/byebug/commands/break.rb

@@ -23,13 +23,15 @@ module Byebug
 
     def self.description
       <<-DESCRIPTION
-        b[reak] [<file>:]<line> [if <expr>]
+        b[reak] [[<file>:]<line> [if <expr>]]
         b[reak] [<module>::...]<class>(.|#)<method> [if <expr>]
 
+        #{short_description}
+
         They can be specified by line or method and an expression can be added
         for conditionally enabled breakpoints.
-
-        #{short_description}
+        for conditionally enabled breakpoints. Without arguments create a
+        a breakpoint in the current line.
       DESCRIPTION
     end
 
@@ -38,9 +40,9 @@ module Byebug
     end
 
     def execute
-      return puts(help) unless @match[1]
+      b = line_breakpoint(frame.line.to_s) unless @match[1]
 
-      b = line_breakpoint(@match[1]) || method_breakpoint(@match[1])
+      b ||= line_breakpoint(@match[1]) || method_breakpoint(@match[1])
       return errmsg(pr("break.errors.location")) unless b
 
       return puts(pr("break.created", id: b.id, file: b.source, line: b.pos)) if syntax_valid?(@match[2])

data/lib/byebug/commands/enable/breakpoints.rb

@@ -31,7 +31,7 @@ module Byebug
       end
 
       def self.short_description
-        "Enable all or specific breakpoints"
+        "Enable all or specific breakpoints."
       end
 
       def execute

data/lib/byebug/commands/finish.rb

@@ -42,7 +42,7 @@ module Byebug
         n_frames = 1
       end
 
-      force = n_frames.zero? ? true : false
+      force = n_frames.zero? || false
       context.step_out(context.frame.pos + n_frames, force)
       context.frame = 0
       processor.proceed!

data/lib/byebug/commands/help.rb

@@ -42,7 +42,7 @@ module Byebug
     private
 
     def help_for_all
-      puts(processor.command_list.to_s)
+      puts(processor.command_list.to_s) # rubocop:disable Lint/RedundantStringCoercion
     end
 
     def help_for(input, cmd)

data/lib/byebug/commands/info.rb

@@ -31,7 +31,7 @@ module Byebug
     end
 
     def self.short_description
-      "Shows several informations about the program being debugged"
+      "Shows short description and information about the program being debugged"
     end
   end
 end

data/lib/byebug/commands/irb.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "../command"
-require "irb"
 require "English"
 
 module Byebug
@@ -30,6 +29,8 @@ module Byebug
     def execute
       return errmsg(pr("base.errors.only_local")) unless processor.interface.instance_of?(LocalInterface)
 
+      require "irb"
+
       # @todo IRB tries to parse $ARGV so we must clear it (see #197). Add a
       #   test case for it so we can remove this comment.
       with_clean_argv { IRB.start }

data/lib/byebug/commands/set.rb

@@ -58,7 +58,7 @@ module Byebug
 
       setting.value = value
 
-      puts setting.to_s
+      puts setting
     end
 
     private

data/lib/byebug/commands/step.rb

@@ -7,7 +7,7 @@ module Byebug
   #
   # Implements the step functionality.
   #
-  # Allows the user the continue execution until the next instruction, possibily
+  # Allows the user the continue execution until the next instruction, possibly
   # in a different frame. Use step to step into method calls or blocks.
   #
   class StepCommand < Command

data/lib/byebug/commands/thread/current.rb

@@ -26,7 +26,7 @@ module Byebug
       end
 
       def self.short_description
-        "Shows current thread information"
+        "Shows current thread information."
       end
 
       def execute

data/lib/byebug/commands/thread/list.rb

@@ -26,7 +26,7 @@ module Byebug
       end
 
       def self.short_description
-        "Lists all threads"
+        "Lists all threads."
       end
 
       def execute

data/lib/byebug/commands/thread/resume.rb

@@ -26,7 +26,7 @@ module Byebug
       end
 
       def self.short_description
-        "Resumes execution of the specified thread"
+        "Resumes execution of the specified thread."
       end
 
       def execute

data/lib/byebug/commands/thread/stop.rb

@@ -26,7 +26,7 @@ module Byebug
       end
 
       def self.short_description
-        "Stops the execution of the specified thread"
+        "Stops the execution of the specified thread."
       end
 
       def execute

data/lib/byebug/commands/tracevar.rb

@@ -4,7 +4,7 @@ require_relative "../command"
 
 module Byebug
   #
-  # Show (and possibily stop) at every line that changes a global variable.
+  # Show (and possibly stop) at every line that changes a global variable.
   #
   class TracevarCommand < Command
     def self.regexp

data/lib/byebug/commands/untracevar.rb

@@ -20,7 +20,7 @@ module Byebug
     end
 
     def self.short_description
-      "Stops tracing a global variable"
+      "Stops tracing a global variable."
     end
 
     def execute
@@ -29,7 +29,7 @@ module Byebug
         untrace_var(:"#{var}")
         puts pr("trace.messages.undo", var: var)
       else
-        errmsg pr("trace.errors.not_global", var: var)
+        errmsg pr("trace.errors.var_is_not_global", name: var)
       end
     end
   end