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