byebug 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+tmp
+vendor/bundle
+
+.rvmrc
+.gdbinit
+.gdb_history
+.bundle
+.tags
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+before_script: rake compile
+rvm:
+- 1.9.2
+- 1.9.3
+- 2.0.0
+matrix:
+  allow_failures:
+  - rvm: 2.0.0

data/AUTHORS

@@ -0,0 +1,10 @@
+Author:
+Kent Sibilev
+
+Contributors:
+Markus Barchfeld
+R. Bernstein
+Anders Lindgren
+
+Contributor and maintainer:
+Mark Moseley

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+Thanks for trying out this project! [See here for contribution guidelines.](http://tagaholic.me/contributing.html)

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 David Rodríguez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,5 @@
+## Description
+
+Experimenting with github and ruby and mixing
+[debugger](https://github.com/cldwalker/debugger) and
+[debase](https://github.com/denofevil/debase) into a 2.0 compatible debugger.

data/Rakefile

@@ -0,0 +1,28 @@
+# -*- Ruby -*-
+require 'rake/testtask'
+require 'rake/extensiontask'
+require 'rubygems/package_task'
+
+Rake::ExtensionTask.new('byebug')
+
+SO_NAME = "byebug.so"
+
+desc "Run MiniTest suite"
+task :test do
+  Rake::TestTask.new(:test) do |t|
+    t.test_files = FileList["test/*_test.rb"]
+    t.verbose = true
+  end
+end
+
+desc "Test everything - same as test."
+task :check => :test
+
+base_spec = eval(File.read('byebug.gemspec'), binding, 'byebug.gemspec')
+
+# Rake task to build the default package
+Gem::PackageTask.new(base_spec) do |pkg|
+  pkg.need_tar = true
+end
+
+task :default => :test

data/bin/byebug

@@ -0,0 +1,395 @@
+#!/usr/bin/env ruby
+
+#=== Summary
+#
+#A command-line front-end to <tt>byebug</tt>
+#
+#Command invocation:
+#
+#   byebug [options] [--] [script-options] ruby-script-to-debug
+#   byebug [options] [script-options] [--client]
+#   byebug [--version | --help]
+#
+#=== Options
+#
+#<tt>-A | --annotate</tt> <i>level</i>::
+#    Set gdb-style annotation to <i>level</i>, a number.  Additional
+#    information is output automatically when program state is
+#    changed. This can be used by 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 rdebug invocation
+#    using <tt>--server</tt>.  See also <tt>--host</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>--emacs</tt>::
+#    Activates full GNU Emacs mode. Is the equivalent of setting the
+#    options <tt>--emacs-basic --annotate=3 --no-stop --no-control
+#    --post-mortem</tt>.
+#
+#<tt>--emacs-basic</tt>::
+#     Activates GNU Emacs mode. Byebug prompts are prefaced with two
+#     octal 032 characters.
+#
+#<tt>-h | --host=</tt><i>host</i>::
+#     Use host name <i>host</i> for remote debugging.
+#
+#<tt>-I | --include</tt> <i>path</i>
+#     Add <i>path</i> to <tt>$LOAD_PATH</tt>
+#
+#<tt>-m | --post-mortem</tt>::
+#     Activate post-mortem mode.
+#
+#<tt>--no-control</tt>::
+#      Do not automatically start control thread.
+#
+#<tt>--no-stop</tt>::
+#      Do not stop when script is loaded.
+#
+#<tt>-p | --port=PORT</tt>::
+#      Host name used for remote debugging.
+#
+#<tt>-r | --require</tt><i>script</i>::
+#      Require the library, before executing your script.
+#
+#<tt>--script</tt> <i>file</i>::
+#      Run byebug script file <i>file</i>
+#
+#<tt>-x | --trace</tt>::
+#      Show lines before executing them.
+#
+#<tt>--no-quit</tt>::
+#      Do not quit when script terminates. Instead rerun the
+#      program.
+#
+#<tt>--version</tt>::
+#      Show the version number and exit.
+#
+#<tt>--verbose</tt>::
+#      Turn on verbose mode.
+#
+#<tt>--v</tt>::
+#      Print the version number, then turn on verbose mode if
+#      a script name is given. If no script name is given
+#     just exit after printing the version number.
+#
+#<tt>--nx</tt>::
+#      Don’t execute commands  found in any initialization
+#      files, e.g. <tt>.rdebugrc</tt>.
+#
+#<tt>--keep-frame-binding</tt>::
+#      Keep frame bindings.
+#
+#<tt>--script=</tt><i>file</i>::
+#      Name of the script file to run
+#
+#<tt>-s | --server</tt>::
+#      Listen for remote connections. Another rdebug session
+#      accesses using the <tt>--client</tt>  option. See also the
+#      <tt>--host</tt>, <tt>--port</tt> and <tt>--cport</tt> options
+#
+#<tt>-w | --wait</tt>::
+#      Wait for a client connection; implies <tt>-s</tt> option.
+#
+#<tt>--help</tt>::
+#      Show invocation help and exit.
+
+require 'optparse'
+require 'ostruct'
+require File.dirname(__FILE__) + "/../lib/byebug"
+
+def debug_program(options)
+  # Make sure Ruby script syntax checks okay.
+  # Otherwise we get a load message that looks like rdebug has a problem.
+  output = `ruby -c "#{Byebug::PROG_SCRIPT}" 2>&1`
+  if $?.exitstatus != 0 and RUBY_PLATFORM !~ /mswin/
+    puts output
+    exit $?.exitstatus
+  end
+  print "\032\032starting\n" if Byebug.annotate and Byebug.annotate > 2
+
+  # Record where we are we can know if the call stack has been truncated or not.
+  Byebug.start_sentinal=caller(0)[1]
+
+  bt = Byebug.debug_load(Byebug::PROG_SCRIPT, options.stop)
+  if bt
+    print bt.backtrace.map{|l| "\t#{l}"}.join("\n"), "\n"
+    print "Uncaught exception: #{bt}\n"
+  end
+end
+
+# Do a shell-like path lookup for prog_script and return the results.
+# If we can't find anything return prog_script.
+def whence_file(prog_script)
+  if prog_script.index(File::SEPARATOR)
+    # Don't search since this name has path separator components
+    return prog_script
+  end
+  for dirname in ENV['PATH'].split(File::PATH_SEPARATOR) do
+    prog_script_try = File.join(dirname, prog_script)
+    return prog_script_try if File.exist?(prog_script_try)
+  end
+  # Failure
+  return prog_script
+end
+
+options = OpenStruct.new(
+  'annotate'           => Byebug.annotate,
+  'client'             => false,
+  'control'            => true,
+  'cport'              => Byebug::PORT + 1,
+  'host'               => nil,
+  '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)
+  program = File.basename($0)
+  opts = OptionParser.new do |opts|
+    opts.banner = <<EOB
+#{program} #{Byebug::VERSION}
+Usage: #{program} [options] <script.rb> -- <script.rb parameters>
+EOB
+    opts.separator ""
+    opts.separator "Options:"
+    opts.on("-A", "--annotate LEVEL", Integer, "Set annotation level") do
+      |annotate|
+        Byebug.annotate = annotate
+    end
+    opts.on("-c", "--client", "Connect to remote byebug") do
+      options.client = true
+    end
+    opts.on("--cport PORT", Integer, "Port used for control commands") do
+      |cport|
+      options.cport = cport
+    end
+    opts.on("-d", "--debug", "Set $DEBUG=true") {$DEBUG = true}
+    opts.on("--emacs LEVEL", Integer,
+            "Activates full Emacs support at annotation level LEVEL") do
+      |level|
+      Byebug.annotate = level.to_i
+      ENV['EMACS'] = '1'
+      ENV['COLUMNS'] = '120' if ENV['COLUMNS'].to_i < 120
+      options.control = false
+      options.quit = false
+    end
+    opts.on('--emacs-basic', 'Activates basic Emacs mode') do
+      ENV['EMACS'] = '1'
+    end
+    opts.on('-h', '--host HOST', 'Host name used for remote debugging') do
+      |host|
+      options.host = host
+    end
+    opts.on('-I', '--include PATH', String, 'Add PATH to $LOAD_PATH') do |path|
+      $LOAD_PATH.unshift(path)
+    end
+    opts.on('--no-control', 'Do not automatically start control thread') do
+      options.control = false
+    end
+    opts.on('--no-quit', 'Do not quit when script finishes') do
+      options.quit = false
+    end
+    opts.on('--no-rewrite-program',
+            'Do not set $0 to the program being debugged') do
+      options.no_rewrite_program = true
+    end
+    opts.on('--no-stop', 'Do not stop when script is loaded') do
+      options.stop = false
+    end
+    opts.on('-nx', 'Not run byebug initialization files (e.g. .rdebugrc') do
+      options.nx = true
+    end
+    opts.on('-p', '--port PORT', Integer, 'Port used for remote debugging') do
+      |port|
+      options.port = port
+    end
+    opts.on('-r', '--require SCRIPT', String,
+            'Require the library, before executing your script') do |name|
+      if name == 'debug'
+        puts "byebug is not compatible with Ruby's 'debug' library. This option is ignored."
+      else
+        require name
+      end
+    end
+    opts.on('--restart-script FILE', String,
+            'Name of the script file to run. Erased after read') do
+      |restart_script|
+      options.restart_script = restart_script
+      unless File.exists?(options.restart_script)
+        puts "Script file '#{options.restart_script}' is not found"
+        exit
+      end
+    end
+    opts.on('--script FILE', String, 'Name of the script file to run') do
+      |script|
+      options.script = script
+      unless File.exists?(options.script)
+        puts "Script file '#{options.script}' is not found"
+        exit
+      end
+    end
+    opts.on('-s', '--server', 'Listen for remote connections') do
+      options.server = true
+    end
+    opts.on('-w', '--wait', 'Wait for a client connection, implies -s option') do
+      options.wait = true
+    end
+    opts.on('-x', '--trace', 'Turn on line tracing') {options.tracing = true}
+    opts.separator ''
+    opts.separator 'Common options:'
+    opts.on_tail('--help', 'Show this message') do
+      puts opts
+      exit
+    end
+    opts.on_tail('--version',
+                 'Print the version') do
+      puts "byebug #{Byebug::VERSION}"
+      exit
+    end
+    opts.on('--verbose', 'Turn on verbose mode') do
+      $VERBOSE = true
+      options.verbose_long = true
+    end
+    opts.on_tail('-v',
+                 'Print version number, then turn on verbose mode') do
+      puts "byebug #{Byebug::VERSION}"
+      $VERBOSE = true
+    end
+  end
+  return opts
+end
+
+# What file is used for byebug startup commands.
+unless defined?(OPTS_INITFILE)
+  if RUBY_PLATFORM =~ /mswin/
+    # Of course MS Windows has to be different
+    OPTS_INITFILE = 'rdbopt.ini'
+    HOME_DIR =  (ENV['HOME'] ||
+                 ENV['HOMEDRIVE'].to_s + ENV['HOMEPATH'].to_s).to_s
+  else
+    OPTS_INITFILE = '.rdboptrc'
+    HOME_DIR = ENV['HOME'].to_s
+  end
+end
+begin
+  initfile = File.join(HOME_DIR, OPTS_INITFILE)
+  eval(File.read(initfile)) if
+    File.exist?(initfile)
+rescue
+end
+
+opts = process_options(options)
+begin
+  if not defined? Byebug::ARGV
+    Byebug::ARGV = ARGV.clone
+  end
+  rdebug_path = File.expand_path($0)
+  if RUBY_PLATFORM =~ /mswin/
+    rdebug_path += '.cmd' unless rdebug_path =~ /\.cmd$/i
+  end
+  Byebug::RDEBUG_SCRIPT = rdebug_path
+  Byebug::RDEBUG_FILE = __FILE__
+  Byebug::INITIAL_DIR = Dir.pwd
+  opts.parse! ARGV
+rescue StandardError => e
+  puts opts
+  puts
+  puts e.message
+  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 }
+
+  # set options
+  Byebug.wait_connection = options.wait
+
+  if options.server
+    # start remote mode
+    Byebug.start_remote(options.host, [options.port, options.cport]) do
+      # load initrc script
+      Byebug.run_init_script(StringIO.new) unless options.nx
+    end
+    debug_program(options)
+  else
+    # Set up trace hook for byebug
+    Byebug.start
+
+    # start control thread
+    Byebug.start_control(options.host, options.cport) if options.control
+
+    # load initrc script (e.g. .rdebugrc)
+    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 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
+
+    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
+  end
+end