runger_byebug 11.2.0

data/lib/byebug/remote/server.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "socket"
+
+module Byebug
+  module Remote
+    #
+    # Server for remote debugging
+    #
+    class Server
+      attr_reader :actual_port, :wait_connection
+
+      def initialize(wait_connection:, &block)
+        @thread = nil
+        @wait_connection = wait_connection
+        @main_loop = block
+      end
+
+      #
+      # Start the remote debugging server
+      #
+      def start(host, port)
+        return if @thread
+
+        if wait_connection
+          mutex = Mutex.new
+          proceed = ConditionVariable.new
+        end
+
+        server = TCPServer.new(host, port)
+        @actual_port = server.addr[1]
+
+        yield if block_given?
+
+        @thread = DebugThread.new do
+          while (session = server.accept)
+            @main_loop.call(session)
+
+            mutex.synchronize { proceed.signal } if wait_connection
+          end
+        end
+
+        mutex.synchronize { proceed.wait(mutex) } if wait_connection
+      end
+    end
+  end
+end

data/lib/byebug/remote.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "socket"
+require_relative "processors/control_processor"
+require_relative "remote/server"
+require_relative "remote/client"
+
+#
+# Remote debugging functionality.
+#
+module Byebug
+  # Port number used for remote debugging
+  PORT = 8989 unless defined?(PORT)
+
+  class << self
+    # If in remote mode, wait for the remote connection
+    attr_accessor :wait_connection
+
+    # The actual port that the server is started at
+    def actual_port
+      server.actual_port
+    end
+
+    # The actual port that the control server is started at
+    def actual_control_port
+      control.actual_port
+    end
+
+    #
+    # Interrupts the current thread
+    #
+    def interrupt
+      current_context.interrupt
+    end
+
+    #
+    # Starts the remote server main thread
+    #
+    def start_server(host = nil, port = PORT)
+      start_control(host, port.zero? ? 0 : port + 1)
+
+      server.start(host, port)
+    end
+
+    #
+    # Starts the remote server control thread
+    #
+    def start_control(host = nil, port = PORT + 1)
+      control.start(host, port)
+    end
+
+    #
+    # Connects to the remote byebug
+    #
+    def start_client(host = "localhost", port = PORT)
+      client.start(host, port)
+    end
+
+    def parse_host_and_port(host_port_spec)
+      location = host_port_spec.split(":")
+      location[1] ? [location[0], location[1].to_i] : ["localhost", location[0]]
+    end
+
+    private
+
+    def client
+      @client ||= Remote::Client.new(Context.interface)
+    end
+
+    def server
+      @server ||= Remote::Server.new(wait_connection: wait_connection) do |s|
+        Context.interface = RemoteInterface.new(s)
+      end
+    end
+
+    def control
+      @control ||= Remote::Server.new(wait_connection: false) do |s|
+        context = Byebug.current_context
+        interface = RemoteInterface.new(s)
+
+        ControlProcessor.new(context, interface).process_commands
+      end
+    end
+  end
+end

data/lib/byebug/runner.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "English"
+require_relative "core"
+require_relative "version"
+require_relative "helpers/bin"
+require_relative "helpers/parse"
+require_relative "helpers/string"
+require_relative "option_setter"
+require_relative "processors/control_processor"
+
+module Byebug
+  #
+  # Responsible for starting the debugger when started from the command line.
+  #
+  class Runner
+    include Helpers::BinHelper
+    include Helpers::ParseHelper
+    include Helpers::StringHelper
+
+    #
+    # Special working modes that don't actually start the debugger.
+    #
+    attr_reader :help, :version, :remote
+
+    #
+    # Signals that we should exit after the debugged program is finished.
+    #
+    attr_accessor :quit
+
+    #
+    # Signals that we should stop before program starts
+    #
+    attr_accessor :stop
+
+    #
+    # Signals that we should run rc scripts before program starts
+    #
+    attr_writer :init_script
+
+    #
+    # @param stop [Boolean] Whether the runner should stop right before
+    # starting the program.
+    #
+    # @param quit [Boolean] Whether the runner should quit right after
+    # finishing the program.
+    #
+    def initialize(stop = true, quit = true)
+      @stop = stop
+      @quit = quit
+    end
+
+    def help=(text)
+      @help ||= text
+
+      interface.puts("#{text}\n")
+    end
+
+    def version=(number)
+      @version ||= number
+
+      interface.puts prettify <<-VERSION
+        Running byebug #{number}
+      VERSION
+    end
+
+    def remote=(host_and_port)
+      @remote ||= Byebug.parse_host_and_port(host_and_port)
+
+      Byebug.start_client(*@remote)
+    end
+
+    def init_script
+      defined?(@init_script) ? @init_script : true
+    end
+
+    #
+    # Usage banner.
+    #
+    def banner
+      prettify <<-BANNER
+        byebug #{Byebug::VERSION}
+
+        Usage: byebug [options] <script.rb> -- <script.rb parameters>
+      BANNER
+    end
+
+    #
+    # Starts byebug to debug a program.
+    #
+    def run
+      Byebug.mode = :standalone
+
+      option_parser.order!($ARGV)
+      return if non_script_option? || error_in_script?
+
+      $PROGRAM_NAME = program
+
+      Byebug.run_init_script if init_script
+
+      loop do
+        debug_program
+
+        break if quit
+
+        ControlProcessor.new(nil, interface).process_commands
+      end
+    end
+
+    def interface
+      @interface ||= Context.interface
+    end
+
+    #
+    # Processes options passed from the command line.
+    #
+    def option_parser
+      @option_parser ||= OptionParser.new(banner, 25) do |opts|
+        opts.banner = banner
+
+        OptionSetter.new(self, opts).setup
+      end
+    end
+
+    def program
+      @program ||= begin
+                     candidate = which($ARGV.shift)
+
+                     if [which("ruby"), RbConfig.ruby].include?(candidate)
+                       which($ARGV.shift)
+                     else
+                       candidate
+                     end
+                   end
+    end
+
+    #
+    # An option that doesn't need a script specified was given
+    #
+    def non_script_option?
+      version || help || remote
+    end
+
+    #
+    # There is an error with the specified script
+    #
+    def error_in_script?
+      no_script? || non_existing_script? || invalid_script?
+    end
+
+    #
+    # No script to debug specified
+    #
+    def no_script?
+      return false unless $ARGV.empty?
+
+      print_error("You must specify a program to debug")
+      true
+    end
+
+    #
+    # Extracts debugged program from command line args.
+    #
+    def non_existing_script?
+      return false if program
+
+      print_error("The script doesn't exist")
+      true
+    end
+
+    #
+    # Checks the debugged script has correct syntax
+    #
+    def invalid_script?
+      return false if syntax_valid?(File.read(program))
+
+      print_error("The script has incorrect syntax")
+      true
+    end
+
+    #
+    # Debugs a script only if syntax checks okay.
+    #
+    def debug_program
+      error = Byebug.debug_load(program, stop)
+      puts "#{error}\n#{error.backtrace}" if error
+    end
+
+    #
+    # Prints an error message and a help string
+    #
+    def print_error(msg)
+      interface.errmsg(msg)
+      interface.puts(option_parser.help)
+    end
+  end
+end

data/lib/byebug/setting.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "helpers/string"
+
+module Byebug
+  #
+  # Parent class for all byebug settings.
+  #
+  class Setting
+    attr_accessor :value
+
+    DEFAULT = false
+
+    def initialize
+      @value = self.class::DEFAULT
+    end
+
+    def boolean?
+      [true, false].include?(value)
+    end
+
+    def integer?
+      Integer(value) ? true : false
+    rescue ArgumentError
+      false
+    end
+
+    def help
+      prettify(banner)
+    end
+
+    def to_sym
+      name = self.class.name.gsub(/^Byebug::/, "").gsub(/Setting$/, "")
+      name.gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym
+    end
+
+    def to_s
+      "#{to_sym} is #{value ? 'on' : 'off'}\n"
+    end
+
+    class << self
+      def settings
+        @settings ||= {}
+      end
+
+      def [](name)
+        settings[name].value
+      end
+
+      def []=(name, value)
+        settings[name].value = value
+      end
+
+      def find(shortcut)
+        abbr = /^no/.match?(shortcut) ? shortcut[2..-1] : shortcut
+        matches = settings.select do |key, value|
+          key =~ (value.boolean? ? /#{abbr}/ : /#{shortcut}/)
+        end
+        matches.size == 1 ? matches.values.first : nil
+      end
+
+      #
+      # @todo DRY this up. Very similar code exists in the CommandList class
+      #
+      def help_all
+        output = "  List of supported settings:\n\n"
+        width = settings.keys.max_by(&:size).size
+        settings.each_value do |sett|
+          output += format(
+            "  %<name>-#{width}s -- %<description>s\n",
+            name: sett.to_sym,
+            description: sett.banner
+          )
+        end
+        output + "\n"
+      end
+    end
+  end
+end

data/lib/byebug/settings/autoirb.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+require_relative "../commands/irb"
+
+module Byebug
+  #
+  # Setting for automatically invoking IRB on every stop.
+  #
+  class AutoirbSetting < Setting
+    DEFAULT = 0
+
+    def initialize
+      IrbCommand.always_run = DEFAULT
+    end
+
+    def banner
+      "Invoke IRB on every stop"
+    end
+
+    def value=(val)
+      IrbCommand.always_run = val ? 1 : 0
+    end
+
+    def value
+      IrbCommand.always_run == 1
+    end
+  end
+end

data/lib/byebug/settings/autolist.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+require_relative "../commands/list"
+
+module Byebug
+  #
+  # Setting for automatically listing source code on every stop.
+  #
+  class AutolistSetting < Setting
+    DEFAULT = 1
+
+    def initialize
+      ListCommand.always_run = DEFAULT
+    end
+
+    def banner
+      "Invoke list command on every stop"
+    end
+
+    def value=(val)
+      ListCommand.always_run = val ? 1 : 0
+    end
+
+    def value
+      ListCommand.always_run == 1
+    end
+  end
+end

data/lib/byebug/settings/autopry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+require_relative "../commands/pry"
+
+module Byebug
+  #
+  # Setting for automatically invoking Pry on every stop.
+  #
+  class AutoprySetting < Setting
+    DEFAULT = 0
+
+    def initialize
+      PryCommand.always_run = DEFAULT
+    end
+
+    def banner
+      "Invoke Pry on every stop"
+    end
+
+    def value=(val)
+      PryCommand.always_run = val ? 1 : 0
+    end
+
+    def value
+      PryCommand.always_run == 1
+    end
+  end
+end

data/lib/byebug/settings/autosave.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting for automatically saving previously entered commands to history
+  # when exiting the debugger.
+  #
+  class AutosaveSetting < Setting
+    DEFAULT = true
+
+    def banner
+      "Automatically save command history record on exit"
+    end
+  end
+end

data/lib/byebug/settings/basename.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Command to display short paths in file names.
+  #
+  # For example, when displaying source code information.
+  #
+  class BasenameSetting < Setting
+    def banner
+      "<file>:<line> information after every stop uses short paths"
+    end
+  end
+end

data/lib/byebug/settings/callstyle.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to customize the verbosity level for stack frames.
+  #
+  class CallstyleSetting < Setting
+    DEFAULT = "long"
+
+    def banner
+      "Set how you want method call parameters to be displayed"
+    end
+
+    def to_s
+      "Frame display callstyle is '#{value}'"
+    end
+  end
+end

data/lib/byebug/settings/fullpath.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to display full paths in backtraces.
+  #
+  class FullpathSetting < Setting
+    DEFAULT = true
+
+    def banner
+      "Display full file names in backtraces"
+    end
+  end
+end

data/lib/byebug/settings/histfile.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to customize the file where byebug's history is saved.
+  #
+  class HistfileSetting < Setting
+    DEFAULT = File.expand_path(".byebug_history")
+
+    def banner
+      "File where cmd history is saved to. Default: ./.byebug_history"
+    end
+
+    def to_s
+      "The command history file is #{value}\n"
+    end
+  end
+end

data/lib/byebug/settings/histsize.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to customize the number of byebug commands to be saved in history.
+  #
+  class HistsizeSetting < Setting
+    DEFAULT = 256
+
+    def banner
+      "Maximum number of commands that can be stored in byebug history"
+    end
+
+    def to_s
+      "Maximum size of byebug's command history is #{value}"
+    end
+  end
+end

data/lib/byebug/settings/linetrace.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to enable/disable linetracing.
+  #
+  class LinetraceSetting < Setting
+    def banner
+      "Enable line execution tracing"
+    end
+
+    def value=(val)
+      Byebug.tracing = val
+    end
+
+    def value
+      Byebug.tracing?
+    end
+  end
+end

data/lib/byebug/settings/listsize.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to customize the number of source code lines to be displayed every
+  # time the "list" command is invoked.
+  #
+  class ListsizeSetting < Setting
+    DEFAULT = 10
+
+    def banner
+      "Set number of source lines to list by default"
+    end
+
+    def to_s
+      "Number of source lines to list is #{value}\n"
+    end
+  end
+end

data/lib/byebug/settings/post_mortem.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to enable/disable post_mortem mode, i.e., a debugger prompt after
+  # program termination by unhandled exception.
+  #
+  class PostMortemSetting < Setting
+    def initialize
+      Byebug.post_mortem = DEFAULT
+    end
+
+    def banner
+      "Enable/disable post-mortem mode"
+    end
+
+    def value=(val)
+      Byebug.post_mortem = val
+    end
+
+    def value
+      Byebug.post_mortem?
+    end
+  end
+end

data/lib/byebug/settings/savefile.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "../setting"
+
+module Byebug
+  #
+  # Setting to customize the file where byebug's settings are saved.
+  #
+  class SavefileSetting < Setting
+    DEFAULT = File.expand_path("#{ENV['HOME'] || '.'}/.byebug_save")
+
+    def banner
+      "File where settings are saved to. Default: ~/.byebug_save"
+    end
+
+    def to_s
+      "The settings file is #{value}\n"
+    end
+  end
+end