git.gag.com Git - fw/openocd/blob - 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 /* Integrate the JIM TCL interpretor into the command processing. */
  27 #if BUILD_ECOSBOARD
  28 #include <stdio.h>
  29 #include <stdarg.h>
  30 /* Jim is provied by eCos */
  31 #include <cyg/jimtcl/jim.h>
  32 #else
  33 #define JIM_EMBEDDED
  34 #include "jim.h"
  35 #endif
  36
  37 enum command_mode
  38 {
  39         COMMAND_EXEC,
  40         COMMAND_CONFIG,
  41         COMMAND_ANY,
  42 };
  43
  44 typedef struct command_context_s
  45 {
  46         enum command_mode mode;
  47         struct command_s *commands;
  48         int current_target;
  49         /* Execute a command.
  50          *
  51          * If the command fails, it *MUST* return a value != ERROR_OK
  52          * (many commands break this rule, patches welcome!)
  53          *
  54          * This is *especially* important for commands such as writing
  55          * to flash or verifying memory. The reason is that those commands
  56          * can be used by programs to determine if the operation succeded
  57          * or not. If the operation failed, then a program can try
  58          * an alternative approach.
  59          *
  60          * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
  61          * printing out the syntax of the command.
  62          */
  63         int (*output_handler)(struct command_context_s *context, const char* line);
  64         void *output_handler_priv;
  65 } command_context_t;
  66
  67 typedef struct command_s
  68 {
  69         char *name;
  70         struct command_s *parent;
  71         struct command_s *children;
  72         int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
  73         enum command_mode mode;
  74         struct command_s *next;
  75 } command_t;
  76
  77 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);
  78 extern int unregister_command(command_context_t *context, char *name);
  79 extern int unregister_all_commands(command_context_t *context);
  80 extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv);
  81 extern command_context_t* copy_command_context(command_context_t* context);
  82 extern int command_context_mode(command_context_t *context, enum command_mode mode);
  83 extern command_context_t* command_init(void);
  84 extern int command_done(command_context_t *context);
  85 extern void command_print(command_context_t *context, char *format, ...);
  86 extern void command_print_sameline(command_context_t *context, char *format, ...);
  87 extern int command_run_line(command_context_t *context, char *line);
  88 extern int command_run_linef(command_context_t *context, char *format, ...);
  89 extern void command_output_text(command_context_t *context, const char *data);
  90
  91 extern void process_jim_events(void);
  92
  93 #define         ERROR_COMMAND_CLOSE_CONNECTION          (-600)
  94 #define         ERROR_COMMAND_SYNTAX_ERROR                      (-601)
  95 #define         ERROR_COMMAND_NOTFOUND                          (-602)
  96
  97 extern int fast_and_dangerous;
  98
  99 extern Jim_Interp *interp;
 100
 101 void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
 102
 103 long jim_global_long(const char *variable);
 104
 105 #endif /* COMMAND_H */