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