src/helper/command.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23 #ifndef COMMAND_H
  24 #define COMMAND_H
  25
  26 #include "types.h"
  27
  28 /* Integrate the JIM TCL interpretor into the command processing. */
  29 #if BUILD_ECOSBOARD
  30 #include <stdio.h>
  31 #include <stdarg.h>
  32 /* Jim is provied by eCos */
  33 #include <cyg/jimtcl/jim.h>
  34 #else
  35 #include "jim.h"
  36 #endif
  37
  38 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
  39  * used for __attribute__((format( ... ))), with GCC v4.4 or later
  40  */
  41 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
  42 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
  43 #else
  44 #define PRINTF_ATTRIBUTE_FORMAT printf
  45 #endif
  46
  47 enum command_mode
  48 {
  49         COMMAND_EXEC,
  50         COMMAND_CONFIG,
  51         COMMAND_ANY,
  52 };
  53
  54 typedef struct command_context_s
  55 {
  56         enum command_mode mode;
  57         struct command_s *commands;
  58         int current_target;
  59         /* Execute a command.
  60          *
  61          * If the command fails, it *MUST* return a value != ERROR_OK
  62          * (many commands break this rule, patches welcome!)
  63          *
  64          * This is *especially* important for commands such as writing
  65          * to flash or verifying memory. The reason is that those commands
  66          * can be used by programs to determine if the operation succeded
  67          * or not. If the operation failed, then a program can try
  68          * an alternative approach.
  69          *
  70          * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
  71          * printing out the syntax of the command.
  72          */
  73         int (*output_handler)(struct command_context_s *context, const char* line);
  74         void *output_handler_priv;
  75 } command_context_t;
  76
  77 typedef struct command_s
  78 {
  79         char *name;
  80         struct command_s *parent;
  81         struct command_s *children;
  82         int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
  83         enum command_mode mode;
  84         struct command_s *next;
  85 } command_t;
  86
  87 /**
  88  * @param c The command to be named.
  89  * @param delim The character to place between command names.
  90  * @returns A malloc'd string containing the full command name,
  91  * which may include one or more ancestor components.  Multiple names
  92  * are separated by single spaces.  The caller must free() the string
  93  * when done with it.
  94  */
  95 char *command_name(struct command_s *c, char delim);
  96
  97 command_t* register_command(command_context_t *context,
  98                 command_t *parent, char *name,
  99                 int (*handler)(struct command_context_s *context,
 100                                 char* name, char** args, int argc),
 101                 enum command_mode mode, char *help);
 102
 103 int unregister_command(command_context_t *context, char *name);
 104 int unregister_all_commands(command_context_t *context);
 105
 106 void command_set_output_handler(command_context_t* context,
 107                 int (*output_handler)(struct command_context_s *context,
 108                 const char* line), void *priv);
 109
 110 command_context_t* copy_command_context(command_context_t* context);
 111
 112 int command_context_mode(command_context_t *context, enum command_mode mode);
 113
 114 command_context_t* command_init(void);
 115 int command_done(command_context_t *context);
 116
 117 void command_print(command_context_t *context, const char *format, ...)
 118                 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 119 void command_print_sameline(command_context_t *context, const char *format, ...)
 120                 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 121 int command_run_line(command_context_t *context, char *line);
 122 int command_run_linef(command_context_t *context, const char *format, ...)
 123                 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 124 void command_output_text(command_context_t *context, const char *data);
 125
 126 void process_jim_events(void);
 127
 128 #define         ERROR_COMMAND_CLOSE_CONNECTION          (-600)
 129 #define         ERROR_COMMAND_SYNTAX_ERROR                      (-601)
 130 #define         ERROR_COMMAND_NOTFOUND                          (-602)
 131 #define         ERROR_COMMAND_ARGUMENT_INVALID          (-603)
 132 #define         ERROR_COMMAND_ARGUMENT_OVERFLOW         (-604)
 133 #define         ERROR_COMMAND_ARGUMENT_UNDERFLOW        (-605)
 134
 135 extern int fast_and_dangerous;
 136
 137 extern Jim_Interp *interp;
 138
 139 void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
 140
 141 long jim_global_long(const char *variable);
 142
 143 int parse_ulong(const char *str, unsigned long *ul);
 144 int parse_ullong(const char *str, unsigned long long *ul);
 145
 146 int parse_long(const char *str, long *ul);
 147 int parse_llong(const char *str, long long *ul);
 148
 149 #define DECLARE_PARSE_WRAPPER(name, type) \
 150         int parse##name(const char *str, type *ul)
 151
 152 DECLARE_PARSE_WRAPPER(_uint, unsigned);
 153 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
 154 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
 155 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
 156
 157 DECLARE_PARSE_WRAPPER(_int, int);
 158 DECLARE_PARSE_WRAPPER(_s32, int32_t);
 159 DECLARE_PARSE_WRAPPER(_s16, int16_t);
 160 DECLARE_PARSE_WRAPPER(_s8, int8_t);
 161
 162 /**
 163  * @brief parses the string @a in into @a out as a @a type, or prints
 164  * a command error and passes the error code to the caller.  If an error
 165  * does occur, the calling function will return the error code produced
 166  * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
 167  *
 168  * This function may cause the calling function to return immediately,
 169  * so it should be used carefully to avoid leaking resources.  In most
 170  * situations, parsing should be completed in full before proceding
 171  * to allocate resources, and this strategy will most prevents leaks.
 172  */
 173 #define COMMAND_PARSE_NUMBER(type, in, out) \
 174         do { \
 175                 int retval = parse_##type(in, &(out)); \
 176                 if (ERROR_OK != retval) { \
 177                         command_print(cmd_ctx, stringify(out) \
 178                                 " option value ('%s') is not valid", in); \
 179                         return retval; \
 180                 } \
 181         } while (0)
 182
 183 void script_debug(Jim_Interp *interp, const char *cmd,
 184                 unsigned argc, Jim_Obj *const *argv);
 185
 186 #endif /* COMMAND_H */