ruby-debug 技术文档

1. 安装指南

系统要求

• Ruby 1.8.4 或更高版本。
• 需要 C 编译器、Ruby 开发头文件以及 Make 程序，以便在安装时编译 ruby-debug-base 扩展。
• 对于 Windows 用户，除非在 cygwin 或 mingw 下运行，否则需要安装 Microsoft Visual C++ 6.0 (VC6)。

安装步骤

1. 使用 RubyGem 安装 ruby-debug：

   gem install ruby-debug
   

   这将自动安装 ruby-debug-base 作为依赖项。

2. 如果需要 Emacs 支持和参考手册，请安装 ruby-debug-extra：

   sh ./configure
   make
   make test # 可选，但建议执行
   sudo make install
   

Windows 安装步骤

1. 确保安装了 Microsoft Visual C++ 6.0 (VC6)。
2. 设置适当的环境变量。
3. 运行 nmake。
4. 将 ruby_debug.so 复制到 win32 目录。
5. 进入 ruby_debug 根目录。
6. 运行 rake win32_gem。
7. 生成的文件名为 rdebug-debug-base-0.10.0-mswin32.gem。

2. 项目使用说明

使用方式

ruby-debug 提供了两种运行方式：

1. 使用 rdebug 可执行文件

$ rdebug <your-script>

通过这种方式启动脚本时，调试器会在脚本文件的第一行代码处停止，允许你设置断点。

2. 使用 ruby-debug API

在代码中使用 ruby-debug API 来中断代码执行：

require 'ruby-debug' ; Debugger.start
...
def your_method
  ...
  debugger
  ...
end

或者：

require 'ruby-debug' ; 
Debugger.start do 
  ...
  debugger
end

当执行 Kernel#debugger 方法时，调试器会被激活，允许你检查和逐步执行代码。

3. 项目 API 使用文档

Debugger.start

启动调试器。可以在代码中任何地方调用此方法来启动调试器。

debugger

在代码中插入此方法，当执行到该行时，调试器会被激活，允许你进行调试操作。

4. 项目安装方式

通过 RubyGem 安装

gem install ruby-debug

手动编译安装

对于需要额外功能的用户，可以手动编译安装 ruby-debug-extra：

sh ./configure
make
make test # 可选，但建议执行
sudo make install

Windows 特定安装

对于 Windows 用户，需要使用 nmake 进行编译，并生成特定版本的 gem 文件。

---

通过以上文档，用户可以了解如何安装、使用 ruby-debug，并掌握其 API 的基本用法。