byebug 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc04cc8b68063ec31b6318a54bd88e1d4ee354be
-  data.tar.gz: 070611b0dbc7fcc7f6fa276b588b32297c5d5588
+  metadata.gz: c587e41bb9bea57e9e9cc27cec5d670fb7d66f81
+  data.tar.gz: b565d9e7848ef7772edfcc9521f4e11accc50ef6
 SHA512:
-  metadata.gz: 1434e8a81a8f62b6af39ba73ba527c44b77c9219d06760ac36cc392d98de069f007d3a3b65f56c3f4db6b6ae3fcd3034fc660d8d9fa01781f677a53df2538bac
-  data.tar.gz: e679189a446359f9d98b18f086472129826218f57d1e1cc0c8d71fa186c146a917b0efafed1c4cc9a991d88f2390fff41c36d160a8f3a4ab2fb23f1ceacd1b90
+  metadata.gz: e8cc31ecfc37cfeac40245ef53ca93eb88f6902821fb698374dd48dbe21c1bb97a203e565c0021cc97aca5b3b67fdc1a18b424cefa945f2dd0dfd75dfb08f0f6
+  data.tar.gz: 8ec279d81317f14ac91289c7a11776b931fe6931069c5acfe39cd422f2cce994b3940abb5548dda6493a3a58fc8a7c2d7f52ad43cb971b7fcda4ad27192c2344

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.1
+
+* Better help system
+* Code cleanup
+* First version compatible with pry-byebug
+
 ## 1.1.0
 
 * Post mortem support

data/Rakefile

@@ -1,4 +1,3 @@
-# -*- Ruby -*-
 require 'rake/testtask'
 require 'rake/extensiontask'
 require 'bundler/gem_tasks'

data/bin/byebug

@@ -7,7 +7,7 @@
 #Command invocation:
 #
 #   byebug [options] [--] [script-options] ruby-script-to-debug
-#   byebug [options] [script-options] [--client]
+#   byebug [options] [script-options]
 #   byebug [--version | --help]
 #
 #=== Options
@@ -18,20 +18,9 @@
 #    front-ends such as GNU Emacs to post this updated information without
 #    having to poll for it.
 #
-#<tt>--client</tt>::
-#    Connect to a remote byebug. Used with another byebug invocation using
-#    <tt>--server</tt>.  See also <tt>--host</tt>, <tt>--port</tt> and
-#    <tt>--cport</tt> options.
-#
-#<tt>--cport=</tt><i>port</i>::
-#    Use port <i>port</i> for access to byebug control.
-#
 #<tt>-d | --debug</tt>::
 #    Set $DEBUG true.
 #
-#<tt>-h | --host=</tt><i>host</i>::
-#    Use host name <i>host</i> for remote debugging.
-#
 #<tt>--help</tt>::
 #      Show invocation help and exit.
 #
@@ -44,9 +33,6 @@
 #<tt>-m | --post-mortem</tt>::
 #    Activate post-mortem mode.
 #
-#<tt>--no-control</tt>::
-#    Do not automatically start control thread.
-#
 #<tt>--no-quit</tt>::
 #    Do not quit when script terminates. Instead rerun the program.
 #
@@ -57,17 +43,9 @@
 #    Don’t execute commands found in any initialization files like
 #    <tt>.byebugrc</tt>.
 #
-#<tt>-p | --port=PORT</tt>::
-#    Use port <i>port</i> for remote debugging.
-#
 #<tt>-r | --require</tt><i>script</i>::
 #    Require the library, before executing your script.
 #
-#<tt>-s | --server</tt>::
-#    Listen for remote connections. Another byebug session accesses using the
-#    <tt>--client</tt>  option. See also the <tt>--host</tt>, <tt>--port</tt>
-#    and <tt>--cport</tt> options
-#
 #<tt>--script</tt>=<i>file</i>::
 #    Run script file <i>file</i>
 #
@@ -82,9 +60,6 @@
 #<tt>--version</tt>::
 #    Show the version number and exit.
 #
-#<tt>-w | --wait</tt>::
-#      Wait for a client connection; implies <tt>-s</tt> option.
-#
 #<tt>-x | --trace</tt>::
 #    Show lines before executing them.
 #
@@ -130,21 +105,14 @@ end
 
 options = OpenStruct.new(
   'annotate'           => Byebug.annotate,
-  'client'             => false,
-  'cport'              => Byebug::PORT + 1,
-  'host'               => nil,
-  'control'            => true,
   'quit'               => true,
   'no_rewrite_program' => false,
   'stop'               => true,
   'nx'                 => false,
-  'port'               => Byebug::PORT,
   'restart_script'     => nil,
   'script'             => nil,
-  'server'             => false,
   'tracing'            => false,
   'verbose_long'       => false,
-  'wait'               => false
 )
 
 def process_options(options)
@@ -158,18 +126,10 @@ EOB
     opts.separator "Options:"
     opts.on("-A", "--annotate LEVEL", Integer, "Set annotation level") {
       |annotate| Byebug.annotate = annotate }
-    opts.on("-c", "--client", "Connect to remote byebug") {
-      options.client = true }
-    opts.on("--cport PORT", Integer, "Port used for control commands") {
-      |cport| options.cport = cport }
     opts.on("-d", "--debug", "Set $DEBUG=true") {
       $DEBUG = true }
-    opts.on('-h', '--host HOST', 'Host name used for remote debugging') {
-      |host| options.host = host }
     opts.on('-I', '--include PATH', String, 'Add PATH to $LOAD_PATH') {
       |path| $LOAD_PATH.unshift(path) }
-    opts.on('--no-control', 'Do not automatically start control thread') {
-      options.control = false }
     opts.on('--no-quit', 'Do not quit when script finishes') {
       options.quit = false }
     opts.on('--no-rewrite-program', 'Don\'t set $0 to the program debugged') {
@@ -178,8 +138,6 @@ EOB
       options.stop = false }
     opts.on('-nx', 'Don\'t run any byebug initialization files') {
       options.nx = true }
-    opts.on('-p', '--port PORT', Integer, 'Port used for remote debugging') {
-      |port| options.port = port }
     opts.on('-r', '--require SCRIPT', String, 'Require library before script') {
       |name| if name == 'debug'
         puts 'byebug not compatible with Ruby\'s \'debug\' lib, option ignored'
@@ -202,10 +160,6 @@ EOB
         exit
       end
     end
-    opts.on('-s', '--server', 'Listen for remote connections') {
-      options.server = true }
-    opts.on('-w', '--wait', 'Wait for a client connection, implies -s option') {
-      options.wait = true }
     opts.on('-x', '--trace', 'Turn on line tracing') {
       options.tracing = true }
     opts.separator ''
@@ -256,80 +210,63 @@ rescue StandardError => e
   exit(-1)
 end
 
-if options.client
-  Byebug.start_client(options.host, options.port)
-else
-  if ARGV.empty?
-    exit if $VERBOSE and not options.verbose_long
-    puts opts
-    puts
-    puts 'Must specify a script to run'
-    exit(-1)
-  end
-
-  # save script name
-  prog_script = ARGV.shift
-  prog_script = whence_file(prog_script) unless File.exist?(prog_script)
-  Byebug::PROG_SCRIPT = File.expand_path prog_script
-
-  # install interruption handler
-  trap('INT') { Byebug.interrupt_last }
+if ARGV.empty?
+  exit if $VERBOSE and not options.verbose_long
+  puts opts
+  puts
+  puts 'Must specify a script to run'
+  exit(-1)
+end
 
-  # set options
-  Byebug.wait_connection = options.wait
+# save script name
+prog_script = ARGV.shift
+prog_script = whence_file(prog_script) unless File.exist?(prog_script)
+Byebug::PROG_SCRIPT = File.expand_path prog_script
 
-  if options.server
-    Byebug.start_remote(options.host, [options.port, options.cport]) do
-      Byebug.run_init_script(StringIO.new) unless options.nx
-    end
-    debug_program(options)
-  else
-    # Set up trace hook for byebug
-    Byebug.start
+# install interruption handler
+trap('INT') { Byebug.interrupt_last }
 
-    # start control thread
-    Byebug.start_control(options.host, options.cport) if options.control
+# Set up trace hook for byebug
+Byebug.start
 
-    # load initrc script (e.g. .byebugrc)
-    Byebug.run_init_script(StringIO.new) unless options.nx
+# load initrc script (e.g. .byebugrc)
+Byebug.run_init_script(StringIO.new) unless options.nx
 
-    # run restore-settings startup script if specified
-    if options.restart_script
-      require 'fileutils'
-      Byebug.run_script(options.restart_script)
-      FileUtils.rm(options.restart_script)
-    end
+# run restore-settings startup script if specified
+if options.restart_script
+  require 'fileutils'
+  Byebug.run_script(options.restart_script)
+  FileUtils.rm(options.restart_script)
+end
 
-    # run startup script if specified
-    if options.script
-      Byebug.run_script(options.script)
-    end
+# run startup script if specified
+if options.script
+  Byebug.run_script(options.script)
+end
 
-    options.stop = false if options.tracing
-    Byebug.current_context.tracing = options.tracing
+options.stop = false if options.tracing
+Byebug.tracing = options.tracing
 
-    if !options.quit
-      if Byebug.started?
-        until Byebug.stop do end
-      end
-      begin
-        debug_program(options)
-      rescue SyntaxError
-        puts $!.backtrace.map{|l| "\t#{l}"}.join("\n")
-        puts "Uncaught Syntax Error\n"
-      rescue
-        print $!.backtrace.map{|l| "\t#{l}"}.join("\n"), "\n"
-        print "Uncaught exception: #{$!}\n"
-      end
-      print "The program finished.\n" unless
-        Byebug.annotate.to_i > 1 # annotate has its own way
-      interface = Byebug::LocalInterface.new
-      # Not sure if ControlCommandProcessor is really the right
-      # thing to use. CommandProcessor requires a state.
-      processor = Byebug::ControlCommandProcessor.new(interface)
-      processor.process_commands
-    else
-      debug_program(options)
-    end
+if !options.quit
+  if Byebug.started?
+    until Byebug.stop do end
   end
+  begin
+    debug_program(options)
+  rescue SyntaxError
+    puts $!.backtrace.map{|l| "\t#{l}"}.join("\n")
+    puts "Uncaught Syntax Error\n"
+  rescue
+    print $!.backtrace.map{|l| "\t#{l}"}.join("\n"), "\n"
+    print "Uncaught exception: #{$!}\n"
+  end
+  print "The program finished.\n" unless
+    Byebug.annotate.to_i > 1 # annotate has its own way
+  interface = Byebug::LocalInterface.new
+  # Not sure if ControlCommandProcessor is really the right
+  # thing to use. CommandProcessor requires a state.
+  processor = Byebug::ControlCommandProcessor.new(interface)
+  processor.process_commands
+else
+  debug_program(options)
 end

data/byebug.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 10.0.4'
   s.add_development_dependency 'rake-compiler', '~> 0.8.3'
   s.add_development_dependency 'mocha', '~> 0.13.3'
-  s.add_development_dependency 'minitest', '~> 4.7.3'
+  s.add_development_dependency 'minitest', '~> 4.7.4'
 
   s.license = "BSD"
 end

data/ext/byebug/byebug.c

@@ -2,14 +2,12 @@
 
 static VALUE mByebug; /* Ruby Byebug Module object */
 static VALUE cContext;
-static VALUE cDebugThread;
 
 static VALUE tracing     = Qfalse;
 static VALUE post_mortem = Qfalse;
 static VALUE debug       = Qfalse;
-static VALUE locker      = Qnil;
 
-static VALUE contexts;
+static VALUE context;
 static VALUE catchpoints;
 static VALUE breakpoints;
 
@@ -29,8 +27,8 @@ tp_inspect(VALUE trace_point) {
         ID2SYM(rb_intern("specified_line")) == event)
     {
        VALUE sym = rb_tracearg_method_id(trace_arg);
-       if (!NIL_P(sym))
-         return rb_sprintf("%"PRIsVALUE"@%"PRIsVALUE":%d in `%"PRIsVALUE"'",
+       if (NIL_P(sym)) sym = rb_str_new_cstr("<main>");
+       return rb_sprintf("%"PRIsVALUE"@%"PRIsVALUE":%d in `%"PRIsVALUE"'",
                            rb_tracearg_event(trace_arg),
                            rb_tracearg_path(trace_arg),
                            FIX2INT(rb_tracearg_lineno(trace_arg)),
@@ -54,78 +52,23 @@ tp_inspect(VALUE trace_point) {
 }
 
 static VALUE
-Byebug_thread_context(VALUE self, VALUE thread)
+Byebug_context(VALUE self)
 {
-  VALUE context;
-
-  context = rb_hash_aref(contexts, thread);
   if (context == Qnil) {
-    context = Context_create(thread, cDebugThread);
-    rb_hash_aset(contexts, thread, context);
+    context = Context_create();
   }
   return context;
 }
 
-static VALUE
-Byebug_current_context(VALUE self)
-{
-  return Byebug_thread_context(self, rb_thread_current());
-}
-
-/*
-static int
-remove_dead_threads(VALUE thread, VALUE context, VALUE ignored)
-{
-  return (IS_THREAD_ALIVE(thread)) ? ST_CONTINUE : ST_DELETE;
-}
-*/
-
 static void
 cleanup(debug_context_t *context)
 {
-  VALUE thread;
-
   context->stop_reason = CTX_STOP_NONE;
-
-  /* release a lock */
-  locker = Qnil;
-
-  /* let the next thread run */
-  thread = remove_from_locked();
-  if(thread != Qnil)
-    rb_thread_run(thread);
 }
 
 static int
-check_start_processing(debug_context_t *context, VALUE thread)
+check_start_processing(debug_context_t *context)
 {
-  /* return if thread is marked as 'ignored' */
-  if(CTX_FL_TEST(context, CTX_FL_IGNORE)) return 0;
-
-  while(1)
-  {
-    /* halt execution of the current thread if byebug is activated in another */
-    while(locker != Qnil && locker != thread)
-    {
-      add_to_locked(thread);
-      rb_thread_stop();
-    }
-
-    /* stop the current thread if it's marked as suspended */
-    if(CTX_FL_TEST(context, CTX_FL_SUSPEND) && locker != thread)
-    {
-      CTX_FL_SET(context, CTX_FL_WAS_RUNNING);
-      rb_thread_stop();
-    }
-    else break;
-  }
-
-  /* return if the current thread is the locker */
-  if(locker != Qnil) return 0;
-
-  /* only the current thread can proceed */
-  locker = thread;
-
   /* ignore a skipped section of code */
   if(CTX_FL_TEST(context, CTX_FL_SKIPPED)) {
     cleanup(context);
@@ -166,9 +109,9 @@ call_at_line(debug_context_t *context, char *file, int line,
   VALUE path, lineno, method_id, defined_class, binding, self;             \
   VALUE context_object;                                                    \
   debug_context_t *context;                                                \
-  context_object = Byebug_current_context(mByebug);                        \
+  context_object = Byebug_context(mByebug);                                \
   Data_Get_Struct(context_object, debug_context_t, context);               \
-  if (!check_start_processing(context, rb_thread_current())) return;       \
+  if (!check_start_processing(context)) return;                            \
   load_frame_info(trace_point, &path, &lineno, &method_id, &defined_class, \
                                &binding, &self);                           \
   if (debug == Qtrue)                                                      \
@@ -201,17 +144,18 @@ process_line_event(VALUE trace_point, void *data)
 
   if (context->dest_frame == -1 || context->stack_size == context->dest_frame)
   {
-    if (moved || !CTX_FL_TEST(context, CTX_FL_FORCE_MOVE)) {
-      context->stop_next = context->stop_next <= 0 ? -1 : context->stop_next-1;
-      context->stop_line = context->stop_line <= 0 ? -1 : context->stop_line-1;
+    if (moved || !CTX_FL_TEST(context, CTX_FL_FORCE_MOVE))
+    {
+      context->steps = context->steps <= 0 ? -1 : context->steps - 1;
+      context->lines = context->lines <= 0 ? -1 : context->lines - 1;
     }
   }
   else if (context->stack_size < context->dest_frame)
   {
-      context->stop_next = 0;
+      context->steps = 0;
   }
 
-  if (context->stop_next == 0 || context->stop_line == 0)
+  if (context->steps == 0 || context->lines == 0)
   {
     context->stop_reason = CTX_STOP_STEP;
     reset_stepping_stop_points(context);
@@ -250,8 +194,8 @@ process_return_event(VALUE trace_point, void *data)
 
   if (context->stack_size == context->stop_frame)
   {
-      context->stop_next = 1;
-      context->stop_frame = 0;
+      context->steps      = 1;
+      context->stop_frame = -1;
   }
   pop_frame(context);
 
@@ -348,7 +292,6 @@ Byebug_setup_tracepoints(VALUE self)
 {
   if (catchpoints != Qnil) return Qnil;
 
-  contexts = rb_hash_new();
   breakpoints = rb_ary_new();
   catchpoints = rb_hash_new();
 
@@ -389,7 +332,7 @@ Byebug_setup_tracepoints(VALUE self)
 static VALUE
 Byebug_remove_tracepoints(VALUE self)
 {
-  contexts = Qnil;
+  context = Qnil;
   breakpoints = Qnil;
   catchpoints = Qnil;
 
@@ -420,13 +363,6 @@ Byebug_remove_tracepoints(VALUE self)
   return Qnil;
 }
 
-static int
-values_i(VALUE key, VALUE value, VALUE ary)
-{
-    rb_ary_push(ary, value);
-    return ST_CONTINUE;
-}
-
 #define BYEBUG_STARTED (catchpoints != Qnil)
 static VALUE
 Byebug_started(VALUE self)
@@ -470,7 +406,7 @@ set_current_skipped_status(VALUE status)
   VALUE context_object;
   debug_context_t *context;
 
-  context_object = Byebug_current_context(mByebug);
+  context_object = Byebug_context(mByebug);
   Data_Get_Struct(context_object, debug_context_t, context);
   if (status)
     CTX_FL_SET(context, CTX_FL_SKIPPED);
@@ -493,10 +429,10 @@ Byebug_load(int argc, VALUE *argv, VALUE self)
 
     Byebug_start(self);
 
-    context_object = Byebug_current_context(self);
+    context_object = Byebug_context(self);
     Data_Get_Struct(context_object, debug_context_t, context);
     context->stack_size = 0;
-    if (RTEST(stop)) context->stop_next = 1;
+    if (RTEST(stop)) context->steps = 1;
 
     /* Initializing $0 to the script's path */
     ruby_script(RSTRING_PTR(file));
@@ -571,21 +507,6 @@ Byebug_set_post_mortem(VALUE self, VALUE value)
   return value;
 }
 
-static VALUE
-Byebug_contexts(VALUE self)
-{
-  VALUE ary;
-
-  ary = rb_ary_new();
-
-  /* check that all contexts point to alive threads */
-  /*rb_hash_foreach(contexts, remove_dead_threads, self);*/
-
-  rb_hash_foreach(contexts, values_i, ary);
-
-  return ary;
-}
-
 static VALUE
 Byebug_breakpoints(VALUE self)
 {
@@ -626,9 +547,7 @@ Init_byebug()
                                      Byebug_setup_tracepoints, 0);
   rb_define_module_function(mByebug, "remove_tracepoints",
                                      Byebug_remove_tracepoints, 0);
-  rb_define_module_function(mByebug, "current_context",
-                                     Byebug_current_context, 0);
-  rb_define_module_function(mByebug, "contexts", Byebug_contexts, 0);
+  rb_define_module_function(mByebug, "context", Byebug_context, 0);
   rb_define_module_function(mByebug, "breakpoints", Byebug_breakpoints, 0);
   rb_define_module_function(mByebug, "add_catchpoint",
                                      Byebug_add_catchpoint, 1);
@@ -647,13 +566,11 @@ Init_byebug()
 
   Init_breakpoint(mByebug);
 
-  cDebugThread  = rb_define_class_under(mByebug, "DebugThread", rb_cThread);
-  contexts = Qnil;
+  context = Qnil;
   catchpoints = Qnil;
   breakpoints = Qnil;
 
-  rb_global_variable(&locker);
   rb_global_variable(&breakpoints);
   rb_global_variable(&catchpoints);
-  rb_global_variable(&contexts);
+  rb_global_variable(&context);
 }