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 enum command_mode
  39 {
  40         COMMAND_EXEC,
  41         COMMAND_CONFIG,
  42         COMMAND_ANY,
  43 };
  44
  45 typedef struct command_context_s
  46 {
  47         enum command_mode mode;
  48         struct command_s *commands;
  49         int current_target;
  50         /* Execute a command.
  51          *
  52          * If the command fails, it *MUST* return a value != ERROR_OK
  53          * (many commands break this rule, patches welcome!)
  54          *
  55          * This is *especially* important for commands such as writing
  56          * to flash or verifying memory. The reason is that those commands
  57          * can be used by programs to determine if the operation succeded
  58          * or not. If the operation failed, then a program can try
  59          * an alternative approach.
  60          *
  61          * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
  62          * printing out the syntax of the command.
  63          */
  64         int (*output_handler)(struct command_context_s *context, const char* line);
  65         void *output_handler_priv;
  66 } command_context_t;
  67
  68 typedef struct command_s
  69 {
  70         char *name;
  71         struct command_s *parent;
  72         struct command_s *children;
  73         int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
  74         enum command_mode mode;
  75         struct command_s *next;
  76 } command_t;
  77
  78 extern command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help);
  79 extern int unregister_command(command_context_t *context, char *name);
  80 extern int unregister_all_commands(command_context_t *context);
  81 extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv);
  82 extern command_context_t* copy_command_context(command_context_t* context);
  83 extern int command_context_mode(command_context_t *context, enum command_mode mode);
  84 extern command_context_t* command_init(void);
  85 extern int command_done(command_context_t *context);
  86
  87 extern void command_print(command_context_t *context, const char *format, ...)
  88                 __attribute__ ((format (printf, 2, 3)));
  89 extern void command_print_sameline(command_context_t *context, const char *format, ...)
  90                 __attribute__ ((format (printf, 2, 3)));
  91 extern int command_run_line(command_context_t *context, char *line);
  92 extern int command_run_linef(command_context_t *context, const char *format, ...)
  93                 __attribute__ ((format (printf, 2, 3)));
  94 extern void command_output_text(command_context_t *context, const char *data);
  95
  96 extern void process_jim_events(void);
  97
  98 #define         ERROR_COMMAND_CLOSE_CONNECTION          (-600)
  99 #define         ERROR_COMMAND_SYNTAX_ERROR                      (-601)
 100 #define         ERROR_COMMAND_NOTFOUND                          (-602)
 101 #define         ERROR_COMMAND_ARGUMENT_INVALID          (-603)
 102 #define         ERROR_COMMAND_ARGUMENT_OVERFLOW         (-604)
 103 #define         ERROR_COMMAND_ARGUMENT_UNDERFLOW        (-605)
 104
 105 extern int fast_and_dangerous;
 106
 107 extern Jim_Interp *interp;
 108
 109 void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
 110
 111 long jim_global_long(const char *variable);
 112
 113 int parse_ulong(const char *str, unsigned long *ul);
 114 int parse_ullong(const char *str, unsigned long long *ul);
 115
 116 int parse_long(const char *str, long *ul);
 117 int parse_llong(const char *str, long long *ul);
 118
 119 #define DECLARE_PARSE_WRAPPER(name, type) \
 120         int parse##name(const char *str, type *ul)
 121
 122 DECLARE_PARSE_WRAPPER(_uint, unsigned);
 123 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
 124 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
 125 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
 126
 127 DECLARE_PARSE_WRAPPER(_int, int);
 128 DECLARE_PARSE_WRAPPER(_s32, int32_t);
 129 DECLARE_PARSE_WRAPPER(_s16, int16_t);
 130 DECLARE_PARSE_WRAPPER(_s8, int8_t);
 131
 132 void script_debug(Jim_Interp *interp, const char *cmd, int argc, Jim_Obj *const *argv);
 133
 134 #endif /* COMMAND_H */