mi-parse.h revision 1.7 
1/* MI Command Set - MI Command Parser.
2   Copyright (C) 2000-2017 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 MI_PARSE_H
21#define MI_PARSE_H
22
23#include "run-time-clock.h"
24#include <chrono>
25#include "mi-cmds.h"  /* For enum print_values.  */
26
27/* MI parser */
28
29/* Timestamps for current command and last asynchronous command.  */
30struct 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
37enum mi_command_type
38  {
39    MI_COMMAND, CLI_COMMAND
40  };
41
42struct mi_parse
43  {
44    mi_parse ();
45    ~mi_parse ();
46
47    mi_parse (const mi_parse &) = delete;
48    mi_parse &operator= (const mi_parse &) = delete;
49
50    enum mi_command_type op;
51    char *command;
52    char *token;
53    const struct mi_cmd *cmd;
54    struct mi_timestamp *cmd_start;
55    char *args;
56    char **argv;
57    int argc;
58    int all;
59    int thread_group; /* At present, the same as inferior number.  */
60    int thread;
61    int frame;
62
63    /* The language that should be used to evaluate the MI command.
64       Ignored if set to language_unknown.  */
65    enum language language;
66  };
67
68/* Attempts to parse CMD returning a ``struct mi_parse''.  If CMD is
69   invalid, an exception is thrown.  For an MI_COMMAND COMMAND, ARGS
70   and OP are initialized.  Un-initialized fields are zero.  *TOKEN is
71   set to the token, even if an exception is thrown.  It is allocated
72   with xmalloc; it must either be freed with xfree, or assigned to
73   the TOKEN field of the resultant mi_parse object, to be freed by
74   mi_parse_free.  */
75
76extern std::unique_ptr<struct mi_parse> mi_parse (const char *cmd,
77						  char **token);
78
79/* Parse a string argument into a print_values value.  */
80
81enum print_values mi_parse_print_values (const char *name);
82
83#endif
84