gdb/mi/mi-parse.h

   1 /* MI Command Set - MI Command Parser.
   2    Copyright (C) 2000, 2007 Free Software Foundation, Inc.
   3    Contributed by Cygnus Solutions (a Red Hat company).
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20    Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef MI_PARSE_H
  23 #define MI_PARSE_H
  24
  25 #include <sys/time.h>
  26
  27 /* MI parser */
  28
  29 /* Timestamps for current command and last asynchronous command.  */
  30 struct mi_timestamp {
  31   struct timeval wallclock;
  32   struct timeval utime;
  33   struct timeval stime;
  34 };
  35
  36 enum mi_command_type
  37   {
  38     MI_COMMAND, CLI_COMMAND
  39   };
  40
  41 struct mi_parse
  42   {
  43     enum mi_command_type op;
  44     char *command;
  45     char *token;
  46     const struct mi_cmd *cmd;
  47     struct mi_timestamp *cmd_start;
  48     char *args;
  49     char **argv;
  50     int argc;
  51   };
  52
  53 /* Attempts to parse CMD returning a ``struct mi_command''.  If CMD is
  54    invalid, an error mesage is reported (MI format) and NULL is
  55    returned. For a CLI_COMMAND, COMMAND, TOKEN and OP are initialized.
  56    For an MI_COMMAND COMMAND, TOKEN, ARGS and OP are
  57    initialized. Un-initialized fields are zero. */
  58
  59 extern struct mi_parse *mi_parse (char *cmd);
  60
  61 /* Free a command returned by mi_parse_command. */
  62
  63 extern void mi_parse_free (struct mi_parse *cmd);
  64
  65 #endif