php-src/phpdbg.h

/*
   +----------------------------------------------------------------------+
   | 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: Joe Watkins <joe.watkins@live.co.uk>                        |
   +----------------------------------------------------------------------+
*/

#ifndef PHPDBG_H
#define PHPDBG_H

#include "php.h"
#include "php_globals.h"
#include "php_variables.h"
#include "php_getopt.h"
#include "zend_builtin_functions.h"
#include "zend_extensions.h"
#include "zend_modules.h"
#include "zend_globals.h"
#include "zend_ini_scanner.h"
#include "zend_stream.h"
#include "SAPI.h"
#include <fcntl.h>
#include <sys/types.h>
#if defined(_WIN32) && !defined(__MINGW32__)
# include <windows.h>
# include "config.w32.h"
#else
# include "php_config.h"
#endif
#ifndef O_BINARY
#	define O_BINARY 0
#endif
#include "php_main.h"

#ifdef ZTS
# include "TSRM.h"
#endif

#ifdef HAVE_LIBREADLINE
#   include <readline/readline.h>
#   include <readline/history.h>
#endif

#ifdef ZTS
# define PHPDBG_G(v) TSRMG(phpdbg_globals_id, zend_phpdbg_globals *, v)
#else
# define PHPDBG_G(v) (phpdbg_globals.v)
#endif

#define PHPDBG_NEXT 2

/* {{{ tables */
#define PHPDBG_BREAK_FILE       0
#define PHPDBG_BREAK_SYM        1
#define PHPDBG_BREAK_OPLINE     2
#define PHPDBG_BREAK_METHOD     3
#define PHPDBG_BREAK_COND       4
#define PHPDBG_BREAK_TABLES     5 /* }}} */

/* {{{ flags */
#define PHPDBG_HAS_FILE_BP      (1<<1)
#define PHPDBG_HAS_SYM_BP       (1<<2)
#define PHPDBG_HAS_OPLINE_BP    (1<<3)
#define PHPDBG_HAS_METHOD_BP    (1<<4)
#define PHPDBG_HAS_COND_BP      (1<<5)
#define PHPDBG_BP_MASK          (PHPDBG_HAS_FILE_BP|PHPDBG_HAS_SYM_BP|PHPDBG_HAS_METHOD_BP|PHPDBG_HAS_OPLINE_BP|PHPDBG_HAS_COND_BP)

#define PHPDBG_IN_COND_BP       (1<<6)
#define PHPDBG_IN_EVAL          (1<<7)

#define PHPDBG_IS_STEPPING      (1<<8)
#define PHPDBG_IS_QUIET         (1<<9)
#define PHPDBG_IS_QUITTING      (1<<10)
#define PHPDBG_IS_COLOURED      (1<<11)
#define PHPDBG_IS_CLEANING      (1<<12)

#ifndef _WIN32
#   define PHPDBG_DEFAULT_FLAGS    (PHPDBG_IS_QUIET|PHPDBG_IS_COLOURED)
#else
#   define PHPDBG_DEFAULT_FLAGS    (PHPDBG_IS_QUIET)
#endif /* }}} */

/* {{{ strings */
#define PHPDBG_ISSUES "http://github.com/krakjoe/phpdbg/issues"
#define PHPDBG_VERSION "0.0.2-dev" /* }}} */

typedef struct _phpdbg_command_t phpdbg_command_t;

/* {{{ Command and Parameter */
typedef enum {
	EMPTY_PARAM = 0,
	ADDR_PARAM,
	FILE_PARAM,
	METHOD_PARAM,
	STR_PARAM,
	NUMERIC_PARAM
} phpdbg_param_type;

typedef struct _phpdbg_param {
    phpdbg_param_type type;
	long num;
	zend_ulong addr;
	struct {
		char *name;
		long line;
	} file;
	struct {
		char *class;
		char *name;
	} method;
	char *str;
	size_t len;
} phpdbg_param_t;

typedef int (*phpdbg_command_handler_t)(phpdbg_param_t *param TSRMLS_DC);

struct _phpdbg_command_t {
	const char *name;                   /* Command name */
	size_t name_len;                    /* Command name length */
	const char *tip;                    /* Menu tip */
	size_t tip_len;                     /* Menu tip length */
	char alias;                         /* Alias */
	phpdbg_command_handler_t handler;   /* Command handler */
	const phpdbg_command_t *subs;       /* Sub Commands */
};

ZEND_BEGIN_MODULE_GLOBALS(phpdbg)
    HashTable bp[PHPDBG_BREAK_TABLES];  /* break points */
	char *exec;                         /* file to execute */
	size_t exec_len;                    /* size of exec */
	zend_op_array *ops;                 /* op_array */
	zval *retval;                       /* return value */
	int bp_count;                       /* breakpoint count */
	int vmret;                          /* return from last opcode handler execution */
	phpdbg_command_t *last;             /* last command */
	phpdbg_param_t   *lparam;           /* last param */
	zend_ulong flags;                   /* phpdbg flags */
	FILE *oplog;                        /* opline log */
ZEND_END_MODULE_GLOBALS(phpdbg)

phpdbg_param_type phpdbg_parse_param(const char*, size_t, phpdbg_param_t* TSRMLS_DC);
void phpdbg_clear_param(phpdbg_param_t * TSRMLS_DC);
const char* phpdbg_get_param_type(phpdbg_param_t *param TSRMLS_DC);
/* }}} */

#endif /* PHPDBG_H */