Doc/examples: clarify usage messages
[fw/openocd] / src / hello.c
1 /***************************************************************************
2  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
3  *                                                                         *
4  *   This program is free software; you can redistribute it and/or modify  *
5  *   it under the terms of the GNU General Public License as published by  *
6  *   the Free Software Foundation; either version 2 of the License, or     *
7  *   (at your option) any later version.                                   *
8  *                                                                         *
9  *   This program is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU General Public License for more details.                          *
13  *                                                                         *
14  *   You should have received a copy of the GNU General Public License     *
15  *   along with this program; if not, write to the                         *
16  *   Free Software Foundation, Inc.,                                       *
17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
18  ***************************************************************************/
19
20 #ifdef HAVE_CONFIG_H
21 #include <config.h>
22 #endif
23 #include <helper/log.h>
24
25 COMMAND_HANDLER(handle_foo_command)
26 {
27         if (CMD_ARGC < 1 || CMD_ARGC > 2)
28         {
29                 LOG_ERROR("%s: incorrect number of arguments", CMD_NAME);
30                 return ERROR_COMMAND_SYNTAX_ERROR;
31         }
32
33         uint32_t address;
34         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
35
36         const char *msg = "<unchanged>";
37         if (CMD_ARGC == 2)
38         {
39                 bool enable;
40                 COMMAND_PARSE_ENABLE(CMD_ARGV[1], enable);
41                 msg = enable ? "enable" : "disable";
42         }
43
44         LOG_INFO("%s: address=0x%8.8" PRIx32 " enabled=%s", CMD_NAME, address, msg);
45         return ERROR_OK;
46 }
47
48 static bool foo_flag;
49
50 COMMAND_HANDLER(handle_flag_command)
51 {
52         return CALL_COMMAND_HANDLER(handle_command_parse_bool,
53                         &foo_flag, "foo flag");
54 }
55
56 static const struct command_registration foo_command_handlers[] = {
57         {
58                 .name = "bar",
59                 .handler = &handle_foo_command,
60                 .mode = COMMAND_ANY,
61                 .usage = "address ['enable'|'disable']",
62                 .help = "an example command",
63         },
64         {
65                 .name = "baz",
66                 .handler = &handle_foo_command,
67                 .mode = COMMAND_ANY,
68                 .usage = "address ['enable'|'disable']",
69                 .help = "a sample command",
70         },
71         {
72                 .name = "flag",
73                 .handler = &handle_flag_command,
74                 .mode = COMMAND_ANY,
75                 .usage = "[on|off]",
76                 .help = "set a flag",
77         },
78         COMMAND_REGISTRATION_DONE
79 };
80
81 static COMMAND_HELPER(handle_hello_args, const char **sep, const char **name)
82 {
83         if (CMD_ARGC > 1)
84         {
85                 LOG_ERROR("%s: too many arguments", CMD_NAME);
86                 return ERROR_COMMAND_SYNTAX_ERROR;
87         }
88         if (1 == CMD_ARGC)
89         {
90                 *sep = " ";
91                 *name = CMD_ARGV[0];
92         }
93         else
94                 *sep = *name = "";
95
96         return ERROR_OK;
97 }
98 COMMAND_HANDLER(handle_hello_command)
99 {
100         const char *sep, *name;
101         int retval = CALL_COMMAND_HANDLER(handle_hello_args, &sep, &name);
102         if (ERROR_OK == retval)
103                 command_print(CMD_CTX, "Greetings%s%s!", sep, name);
104         return retval;
105 }
106
107 const struct command_registration hello_command_handlers[] = {
108         {
109                 .name = "hello",
110                 .handler = handle_hello_command,
111                 .mode = COMMAND_ANY,
112                 .help = "prints a warm welcome",
113                 .usage = "[name]",
114         },
115         {
116                 .name = "foo",
117                 .mode = COMMAND_ANY,
118                 .help = "example command handler skeleton",
119
120                 .chain = foo_command_handlers,
121         },
122         COMMAND_REGISTRATION_DONE
123 };
124
125 int hello_register_commands(struct command_context *cmd_ctx)
126 {
127         return register_commands(cmd_ctx, NULL, hello_command_handlers);
128 }