php-src/phpdbg_help.c

/*
   +----------------------------------------------------------------------+
   | PHP Version 5                                                        |
   +----------------------------------------------------------------------+
   | Copyright (c) 1997-2013 The PHP Group                                |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | http://www.php.net/license/3_01.txt                                  |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Authors: Felipe Pena <felipe@php.net>                                |
   | Authors: Joe Watkins <joe.watkins@live.co.uk>                        |
   +----------------------------------------------------------------------+
*/

#include <stdio.h>
#include "zend.h"
#include "phpdbg.h"
#include "phpdbg_help.h"

PHPDBG_HELP(exec) /* {{{ */
{
	printf("Will attempt execution, if compilation has not yet taken place, it occurs now.\n");
	printf("The execution context must be set before execution can take place\n");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(step) /* {{{ */
{
    printf("You can enable and disable stepping at any phpdbg prompt during execution\n");
    printf("For example:\n");
    printf("\tphpdbg> stepping 1\n");
    printf("Will enable stepping\n");
    printf("While stepping is enabled you are presented with a prompt after the execution of each opcode\n");
    return SUCCESS;
} /* }}} */

PHPDBG_HELP(next) /* {{{ */
{
	printf("While stepping through execution, use the next command to step back into the vm and execute the next opcode");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(compile) /* {{{ */
{
	printf("Pre-compilation of the execution context provides the opportunity to inspect the opcodes before they are executed\n");
	printf("The execution context must be set for compilation to succeed\n");
	printf("If errors occur during compilation they must be resolved before execution can take place.\n");
	printf("You do not need to exit phpdbg to retry compilation\n");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(print) /* {{{ */
{
	printf("By default, print will show information about the current execution environment\n");
	printf("To show specific information pass an expression to print, for example:\n");
	printf("\tphpdbg> print opcodes[0]\n");
	printf("Will show the opline @ 0\n");
	printf("Available print commands:\n");
	printf("\tNone\n");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(run) /* {{{ */
{
	printf("Run the code inside the debug vm, you should have break points and variables set before running\n");
	printf("The execution context must not be set, but not necessarily compiled before execution occurs\n");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(eval) /* {{{ */
{
	printf("Access to eval() allows you to change the environment during execution, careful though !!");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(break) /* {{{ */
{
	printf("Setting a breakpoint stops execution at a specific stage, the syntax is:\n");
	printf("\tfile:line\n");
	printf("[more to come]\n");
	printf("For example:\n");
	printf("\tphpdbg> break test.php:1\n");
	printf("Will break execution on line 1 of test.php\n");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(cont) /* {{{ */
{
	printf("Continues execution after a breakpoint is met\n");
	printf("[Warnings about using stepping and break points here]\n");
	return SUCCESS;
} /* }}} */

PHPDBG_HELP(back) /* {{{ */
{
	printf("The backtrace is gathered with the default debug_backtrace functionality.\n");
	printf("You can set the limit on the trace, for example:\n");
	printf("\tphpdbg> back 5\n");
	printf("Will limit the number of frames to 5, the default is no limit\n");
	return SUCCESS;
} /* }}} */