First version
[3rdparty/ote_partner/tlk.git] / include / lib / console.h
1 /*
2  * Copyright (c) 2008-2009 Travis Geiselbrecht
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __LIB_CONSOLE_H
24 #define __LIB_CONSOLE_H
25
26 #include <sys/types.h>
27 #include <compiler.h>
28
29 /* command args */
30 typedef struct {
31         const char *str;
32         unsigned int u;
33         int i;
34         bool b;
35 } cmd_args;
36
37 typedef int (*console_cmd)(int argc, const cmd_args *argv);
38
39 /* a block of commands to register */
40 typedef struct {
41         const char *cmd_str;
42         const char *help_str;
43         const console_cmd cmd_callback;
44 } cmd;
45
46 typedef struct _cmd_block {
47         struct _cmd_block *next;
48         size_t count;
49         const cmd *list;        
50 } cmd_block;
51
52 /* register a static block of commands at init time */
53 #if WITH_LIB_CONSOLE
54 #define STATIC_COMMAND_START static const cmd _cmd_list[] = {
55 #define STATIC_COMMAND_END(name) }; const cmd_block _cmd_block_##name __SECTION(".commands")= { NULL, sizeof(_cmd_list) / sizeof(_cmd_list[0]), _cmd_list }
56 #define STATIC_COMMAND_START_NAMED(name) static const cmd _cmd_list_##name[] = {
57 #define STATIC_COMMAND_END_NAMED(name) }; const cmd_block _cmd_block_##name __SECTION(".commands")= { NULL, sizeof(_cmd_list_##name) / sizeof(_cmd_list_##name[0]), _cmd_list_##name }
58
59 #define STATIC_COMMAND(command_str, help_str, func) { command_str, help_str, func },
60
61 #else
62
63 /* no command blocks, so null them out */
64 #define STATIC_COMMAND_START
65 #define STATIC_COMMAND_END(name)
66 #define STATIC_COMMAND_START_NAMED(name)
67 #define STATIC_COMMAND_END_NAMED(name)
68
69 #define STATIC_COMMAND(command_str, help_str, func)
70
71 #endif
72
73 #define COMMAND_BLOCK_INIT_ITEM(cmd_block_ptr, cmd_ptr) {(cmd_block_ptr)->next = NULL; (cmd_block_ptr)->count = 1; (cmd_block_ptr)->list = cmd_ptr;}
74
75 /* external api */
76 int console_init(void);
77 void console_start(void);
78 void console_register_commands(cmd_block *block);
79 int console_run_script(const char *string);
80 int console_run_script_locked(const char *string); // special case from inside a command
81 console_cmd console_get_command_handler(const char *command);
82 void console_abort_script(void);
83
84 extern int lastresult;
85
86 #endif
87