xref: /php-src/sapi/phpdbg/phpdbg_help.h (revision d46dea16)
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Authors: Felipe Pena <felipe@php.net>                                |
14    | Authors: Joe Watkins <joe.watkins@live.co.uk>                        |
15    | Authors: Bob Weinand <bwoebi@php.net>                                |
16    +----------------------------------------------------------------------+
17 */
18 
19 #ifndef PHPDBG_HELP_H
20 #define PHPDBG_HELP_H
21 
22 #include "TSRM.h"
23 #include "phpdbg.h"
24 #include "phpdbg_cmd.h"
25 
26 #define PHPDBG_HELP(name) PHPDBG_COMMAND(help_##name)
27 
28 /**
29  * Helper Forward Declarations
30  */
31 PHPDBG_HELP(aliases);
32 
33 extern const phpdbg_command_t phpdbg_help_commands[];
34 
35 #define phpdbg_help_header() \
36 	phpdbg_notice("version", "version=\"%s\"", "Welcome to phpdbg, the interactive PHP debugger, v%s", PHPDBG_VERSION);
37 #define phpdbg_help_footer() \
38 	phpdbg_notice("issues", "url=\"%s\"", "Please report bugs to <%s>", PHPDBG_ISSUES);
39 
40 typedef struct _phpdbg_help_text_t {
41 	char *key;
42 	char *text;
43 } phpdbg_help_text_t;
44 
45 extern const phpdbg_help_text_t phpdbg_help_text[];
46 
47 extern void phpdbg_do_help_cmd(const char *type);
48 #endif /* PHPDBG_HELP_H */
49