gdb/mi/mi-parse.h

   1 /* MI Command Set - MI Command Parser.
   2    Copyright (C) 2000-2024 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 3 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, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GDB_MI_MI_PARSE_H
  21 #define GDB_MI_MI_PARSE_H
  22
  23 #include "gdbsupport/run-time-clock.h"
  24 #include <chrono>
  25 #include "mi-cmds.h"
  26
  27 /* MI parser */
  28
  29 /* Timestamps for current command and last asynchronous command.  */
  30 struct mi_timestamp
  31 {
  32   std::chrono::steady_clock::time_point wallclock;
  33   user_cpu_time_clock::time_point utime;
  34   system_cpu_time_clock::time_point stime;
  35 };
  36
  37 enum mi_command_type
  38 {
  39   MI_COMMAND, CLI_COMMAND
  40 };
  41
  42 struct mi_parse
  43 {
  44   /* Attempt to parse CMD creating a ``struct mi_parse''.  If CMD is
  45      invalid, an exception is thrown.  For an MI_COMMAND COMMAND, ARGS
  46      and OP are initialized.  Un-initialized fields are zero.  *TOKEN is
  47      set to the token, even if an exception is thrown.  */
  48   mi_parse (const char *cmd, std::string *token);
  49
  50   /* Create an mi_parse object given the command name and a vector
  51      of arguments.  Unlike with the other constructor, here the
  52      arguments are treated "as is" -- no escape processing is
  53      done.  */
  54   mi_parse (gdb::unique_xmalloc_ptr<char> command,
  55             std::vector<gdb::unique_xmalloc_ptr<char>> args);
  56
  57   ~mi_parse ();
  58
  59   DISABLE_COPY_AND_ASSIGN (mi_parse);
  60
  61   /* Split the arguments into argc/argv and store the result.  */
  62   void parse_argv ();
  63
  64   /* Return the full argument string, as used by commands which are
  65      implemented as CLI commands.  */
  66   const char *args ();
  67
  68   enum mi_command_type op = MI_COMMAND;
  69   /* This is not std::string because it avoids a copy in the Python
  70      API case.  */
  71   gdb::unique_xmalloc_ptr<char> command;
  72   std::string token;
  73   const struct mi_command *cmd = nullptr;
  74   struct mi_timestamp *cmd_start = nullptr;
  75   char **argv = nullptr;
  76   int argc = 0;
  77   int all = 0;
  78   int thread_group = -1; /* At present, the same as inferior number.  */
  79   int thread = -1;
  80   int frame = -1;
  81
  82   /* The language that should be used to evaluate the MI command.
  83      Ignored if set to language_unknown.  */
  84   enum language language = language_unknown;
  85
  86 private:
  87
  88   /* Helper methods for parsing arguments.  Each takes the argument
  89      to be parsed.  It will either set a member of this object, or
  90      throw an exception on error.  In each case, *ENDP, if non-NULL,
  91      will be updated to just after the argument text.  */
  92   void set_thread_group (const char *arg, char **endp);
  93   void set_thread (const char *arg, char **endp);
  94   void set_frame (const char *arg, char **endp);
  95   void set_language (const char *arg, const char **endp);
  96
  97   std::string m_args;
  98 };
  99
 100 /* Parse a string argument into a print_values value.  */
 101
 102 enum print_values mi_parse_print_values (const char *name);
 103
 104 #endif /* GDB_MI_MI_PARSE_H */