JDHankle/riviera - Githubissues

Riviera Beta

Riviera is a software package that interfaces Emacs to DBGp protocol with which you can debug running scripts interactive. At this present DBGp protocol are supported in several script languages with help of custom extensions.

PHP with Xdebug 2.0.*
Perl, Python, Ruby and Tcl with Komodo Debugger Extensions

Currently Riviera implements the following features.

continuation commands: run/stop/step-in/step-over/step-out
set/unset/listing breakpoints
expression evaluation
STDOUT/STDERR redirection
backtrace listing
variable inspection

REQUIREMENTS

[server side]

DBGp protocol enabled script engine, like:
- PHP with Xdebug
- Python with Komode Debugger Extension
- etc.

[client side]

Emacs22.1 or later

INSTALLATION

[server side]

To debug PHP scripts, you'll need to install PHP, Xdebug and optionally a web server. Please visit their official sites to get packages and instructions of installation and configuration. PHP: http://php.net Xdebug: http://xdebug.org
To debug Perl, Python, Ruby and Tcl with Riviera, Komodo Debugging Extensions will give you a big help. Distribution: http://aspn.activestate.com/ASPN/Downloads/Komodo/RemoteDebugging Documentation: http://aspn.activestate.com/ASPN/Reference/Products/Komodo/komodo-doc-debugger.html

[client side]

Unpack Riviera source code package and change directory to the unpacked directory.

a. run `make'(or `gmake', depends on your environment). b. If you are an administrator, Run: sudo make install b' Or Run: SITELISP=$HOME/path/to/install make install a. Byte compile 'dbgp.el'. b. Byte compile `riviera.el'. c. Copy `dbgp.elc', `riviera.elc' and entire `tree-widget' directory to any directory where Emacs can find.(Or add the path to `load-path' list) 2. Insert autoload hooks into your .Emacs file. -> (autoload 'riviera "riviera" "PHP Remote Debugger for Emacs" t) 3. Restart Emacs. DEBUGGING --------- Here is an illustration on PHP debugging. 1. Run Emacs. 2. Start riviera, type: M-x riviera 3. Access to the target PHP script page with any browser. You may need to add a query parameter `XDEBUG_SESSION_START' if you configured Xdebug to require manual trigger to start a remote debugging session. e.g.) http://www.example.com/test.php?XDEBUG_SESSION_START=1 4. Soon the server and Riviera establish a debugging session connection. Then Emacs loads the script source code of the entry page in a buffer. 5. Now the buffer is under the minor-mode 'riviera-mode'. You can control the debugger with several keys. spc step into/step over i step into o step over r step out g run c run to cursor b set a breakpoint at a line B set a breakpoint interactively u unset a breakpoint at a line U clear all breakpoints \C-c b display breakpoint list > set redirection mode \C-u t change redirection mode d display backtrace t display backtrace v display context variables \C-c f visit script file w where q stop When you hit any unbound key of `riviera-mode', Riviera will ask you to edit the original script file. Say yes and Riviera will attempts to load the script file via `TRAMP'. 6. If you felt you'd debugged enough, it's time to quit Riviera. To quit Riviera, type: M-x riviera-end Known Issues ------------ * This version is not tested with Xdebug 2.1.* yet. * There are some issues related Xdebug, version of at least 2.0.3. - Xdebug does not support STDERR command feature so that STDERR redirection feature does not work expectedly. - Xdebug does not implement `dbgp:' scheme feature so that with `step-in' command into a lambda function (you can create it with `create_function' in PHP) the cursor position is located at invalid line. - Xdebug may tell invalid line number on breaking by `return' type breakpoint. To this case Riviera indicates the cursor at the top of the file in where the current breakpoint exists. - Xdebug unexpectedly breaks on returning from class/instance method if there is a `call' type breakpoint to the method. - If Xdebug is not loaded not as `zend_extension', some feature do not work as expectedly (e.g. step_into).