git.sur5r.net Git - openocd/blob - 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 "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                 .help = "<address> [enable|disable] - an example command",
  62         },
  63         {
  64                 .name = "baz",
  65                 .handler = &handle_foo_command,
  66                 .mode = COMMAND_ANY,
  67                 .help = "<address> [enable|disable] - a sample command",
  68         },
  69         {
  70                 .name = "flag",
  71                 .handler = &handle_flag_command,
  72                 .mode = COMMAND_ANY,
  73                 .help = "[on|off] - set a flag",
  74         },
  75         COMMAND_REGISTRATION_DONE
  76 };
  77
  78 int foo_register_commands(struct command_context *cmd_ctx)
  79 {
  80         // register several commands under the foo command
  81         struct command *cmd = COMMAND_REGISTER(cmd_ctx, NULL, "foo",
  82                         NULL, COMMAND_ANY, "example command handler skeleton");
  83
  84
  85         return register_commands(cmd_ctx, cmd, foo_command_handlers);
  86 }
  87
  88 static COMMAND_HELPER(handle_hello_args, const char **sep, const char **name)
  89 {
  90         if (CMD_ARGC > 1)
  91         {
  92                 LOG_ERROR("%s: too many arguments", CMD_NAME);
  93                 return ERROR_COMMAND_SYNTAX_ERROR;
  94         }
  95         if (1 == CMD_ARGC)
  96         {
  97                 *sep = " ";
  98                 *name = CMD_ARGV[0];
  99         }
 100         else
 101                 *sep = *name = "";
 102
 103         return ERROR_OK;
 104 }
 105 COMMAND_HANDLER(handle_hello_command)
 106 {
 107         const char *sep, *name;
 108         int retval = CALL_COMMAND_HANDLER(handle_hello_args, &sep, &name);
 109         if (ERROR_OK == retval)
 110                 command_print(CMD_CTX, "Greetings%s%s!", sep, name);
 111         return retval;
 112 }
 113
 114 static const struct command_registration hello_command_handlers[] = {
 115         {
 116                 .name = "hello",
 117                 .handler = &handle_hello_command,
 118                 .mode = COMMAND_ANY,
 119                 .help = "prints a warm welcome",
 120                 .usage = "[<name>]",
 121         },
 122         COMMAND_REGISTRATION_DONE
 123 };
 124
 125 int hello_register_commands(struct command_context *cmd_ctx)
 126 {
 127         foo_register_commands(cmd_ctx);
 128
 129         return register_commands(cmd_ctx, NULL, hello_command_handlers);
 130 }