src/helper/command.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef COMMAND_H
  21 #define COMMAND_H
  22
  23 #include <stdio.h>
  24
  25 enum command_mode
  26 {
  27         COMMAND_EXEC,
  28         COMMAND_CONFIG,
  29         COMMAND_ANY,
  30 };
  31
  32 typedef struct command_context_s
  33 {
  34         enum command_mode mode;
  35         struct command_s *commands;
  36         int current_target;
  37         /* Execute a command.
  38          *
  39          * If the command fails, it *MUST* return a value != ERROR_OK
  40          * (many commands break this rule, patches welcome!)
  41          *
  42          * This is *especially* important for commands such as writing
  43          * to flash or verifying memory. The reason is that those commands
  44          * can be used by programs to determine if the operation succeded
  45          * or not. If the operation failed, then a program can try
  46          * an alternative approach.
  47          *
  48          * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
  49          * printing out the syntax of the command.
  50          */
  51         int (*output_handler)(struct command_context_s *context, const char* line);
  52         void *output_handler_priv;
  53 } command_context_t;
  54
  55 typedef struct command_s
  56 {
  57         char *name;
  58         struct command_s *parent;
  59         struct command_s *children;
  60         int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
  61         enum command_mode mode;
  62         char *help;
  63         struct command_s *next;
  64 } command_t;
  65
  66 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);
  67 extern int unregister_command(command_context_t *context, char *name);
  68 extern int unregister_all_commands(command_context_t *context);
  69 extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv);
  70 extern command_context_t* copy_command_context(command_context_t* context);
  71 extern command_context_t* command_init();
  72 extern int command_done(command_context_t *context);
  73 extern void command_print(command_context_t *context, char *format, ...);
  74 extern void command_print_sameline(command_context_t *context, char *format, ...);
  75 extern int command_run_line(command_context_t *context, char *line);
  76 extern int command_run_linef(command_context_t *context, char *format, ...);
  77 extern int command_run_line_internal(command_context_t *context, char *line);
  78 extern void command_output_text(command_context_t *context, const char *data);
  79
  80 #define         ERROR_COMMAND_CLOSE_CONNECTION          (-600)
  81 #define         ERROR_COMMAND_SYNTAX_ERROR                      (-601)
  82 #define         ERROR_COMMAND_NOTFOUND                          (-602)
  83
  84 extern int fast_and_dangerous;
  85
  86 #endif /* COMMAND_H */