gdb/linespec.h

   1 /* Header for GDB line completion.
   2    Copyright (C) 2000-2017 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 #if !defined (LINESPEC_H)
  18 #define LINESPEC_H 1
  19
  20 struct symtab;
  21
  22 #include "location.h"
  23 #include "vec.h"
  24
  25 /* Flags to pass to decode_line_1 and decode_line_full.  */
  26
  27 enum decode_line_flags
  28   {
  29     /* Set this flag if you want the resulting SALs to describe the
  30        first line of indicated functions.  */
  31     DECODE_LINE_FUNFIRSTLINE = 1,
  32
  33     /* Set this flag if you want "list mode".  In this mode, a
  34        FILE:LINE linespec will always return a result, and such
  35        linespecs will not be expanded to all matches.  */
  36     DECODE_LINE_LIST_MODE = 2
  37   };
  38
  39 /* decode_line_full returns a vector of these.  */
  40
  41 struct linespec_sals
  42 {
  43   /* This is the location corresponding to the sals contained in this
  44      object.  It can be passed as the FILTER argument to future calls
  45      to decode_line_full.  This is freed by the linespec_result
  46      destructor.  */
  47   char *canonical;
  48
  49   /* Sals.  */
  50   std::vector<symtab_and_line> sals;
  51 };
  52
  53 /* An instance of this may be filled in by decode_line_1.  The caller
  54    must make copies of any data that it needs to keep.  */
  55
  56 struct linespec_result
  57 {
  58   linespec_result () = default;
  59   ~linespec_result ();
  60
  61   linespec_result (const linespec_result &) = delete;
  62   linespec_result &operator= (const linespec_result &) = delete;
  63
  64   /* If true, the linespec should be displayed to the user.  This
  65      is used by "unusual" linespecs where the ordinary `info break'
  66      display mechanism would do the wrong thing.  */
  67   bool special_display = false;
  68
  69   /* If true, the linespec result should be considered to be a
  70      "pre-expanded" multi-location linespec.  A pre-expanded linespec
  71      holds all matching locations in a single linespec_sals
  72      object.  */
  73   bool pre_expanded = false;
  74
  75   /* If PRE_EXPANDED is non-zero, this is set to the location entered
  76      by the user.  */
  77   event_location_up location;
  78
  79   /* The sals.  The vector will be freed by the destructor.  */
  80   std::vector<linespec_sals> lsals;
  81 };
  82
  83 /* Decode a linespec using the provided default symtab and line.  */
  84
  85 extern std::vector<symtab_and_line>
  86         decode_line_1 (const struct event_location *location, int flags,
  87                        struct program_space *search_pspace,
  88                        struct symtab *default_symtab, int default_line);
  89
  90 /* Parse LOCATION and return results.  This is the "full"
  91    interface to this module, which handles multiple results
  92    properly.
  93
  94    For FLAGS, see decode_line_flags.  DECODE_LINE_LIST_MODE is not
  95    valid for this function.
  96
  97    If SEARCH_PSPACE is not NULL, symbol search is restricted to just
  98    that program space.
  99
 100    DEFAULT_SYMTAB and DEFAULT_LINE describe the default location.
 101    DEFAULT_SYMTAB can be NULL, in which case the current symtab and
 102    line are used.
 103
 104    CANONICAL is where the results are stored.  It must not be NULL.
 105
 106    SELECT_MODE must be one of the multiple_symbols_* constants, or
 107    NULL.  It determines how multiple results will be handled.  If
 108    NULL, the appropriate CLI value will be used.
 109
 110    FILTER can either be NULL or a string holding a canonical name.
 111    This is only valid when SELECT_MODE is multiple_symbols_all.
 112
 113    Multiple results are handled differently depending on the
 114    arguments:
 115
 116    . With multiple_symbols_cancel, an exception is thrown.
 117
 118    . With multiple_symbols_ask, a menu is presented to the user.  The
 119    user may select none, in which case an exception is thrown; or all,
 120    which is handled like multiple_symbols_all, below.  Otherwise,
 121    CANONICAL->SALS will have one entry for each name the user chose.
 122
 123    . With multiple_symbols_all, CANONICAL->SALS will have a single
 124    entry describing all the matching locations.  If FILTER is
 125    non-NULL, then only locations whose canonical name is equal (in the
 126    strcmp sense) to FILTER will be returned; all others will be
 127    filtered out.  */
 128
 129 extern void decode_line_full (const struct event_location *location, int flags,
 130                               struct program_space *search_pspace,
 131                               struct symtab *default_symtab, int default_line,
 132                               struct linespec_result *canonical,
 133                               const char *select_mode,
 134                               const char *filter);
 135
 136 /* Given a string, return the line specified by it, using the current
 137    source symtab and line as defaults.
 138    This is for commands like "list" and "breakpoint".  */
 139
 140 extern std::vector<symtab_and_line> decode_line_with_current_source (char *, int);
 141
 142 /* Given a string, return the line specified by it, using the last displayed
 143    codepoint's values as defaults, or nothing if they aren't valid.  */
 144
 145 extern std::vector<symtab_and_line> decode_line_with_last_displayed (char *, int);
 146
 147 /* Does P represent one of the keywords?  If so, return
 148    the keyword.  If not, return NULL.  */
 149
 150 extern const char *linespec_lexer_lex_keyword (const char *p);
 151
 152 /* Parse a line offset from STRING.  */
 153
 154 extern struct line_offset linespec_parse_line_offset (const char *string);
 155
 156 /* Return the quote characters permitted by the linespec parser.  */
 157
 158 extern const char *get_gdb_linespec_parser_quote_characters (void);
 159
 160 /* Does STRING represent an Ada operator?  If so, return the length
 161    of the decoded operator name.  If not, return 0.  */
 162
 163 extern int is_ada_operator (const char *string);
 164
 165 /* Find an instance of the character C in the string S that is outside
 166    of all parenthesis pairs, single-quoted strings, and double-quoted
 167    strings.  Also, ignore the char within a template name, like a ','
 168    within foo<int, int>.  */
 169
 170 extern const char *find_toplevel_char (const char *s, char c);
 171
 172 /* Find the end of the (first) linespec pointed to by *STRINGP.
 173    STRINGP will be advanced to this point.  */
 174
 175 extern void linespec_lex_to_end (char **stringp);
 176
 177 extern const char * const linespec_keywords[];
 178
 179 /* Complete a linespec.  */
 180
 181 extern void linespec_complete (completion_tracker &tracker,
 182                                const char *text);
 183
 184 /* Complete a function symbol, in linespec mode.  If SOURCE_FILENAME
 185    is non-NULL, limits completion to the list of functions defined in
 186    source files that match SOURCE_FILENAME.  */
 187
 188 extern void linespec_complete_function (completion_tracker &tracker,
 189                                         const char *function,
 190                                         const char *source_filename);
 191
 192 /* Complete a label symbol, in linespec mode.  Only labels of
 193    functions named FUNCTION_NAME are considered.  If SOURCE_FILENAME
 194    is non-NULL, limits completion to labels of functions defined in
 195    source files that match SOURCE_FILENAME.  */
 196
 197 extern void linespec_complete_label (completion_tracker &tracker,
 198                                      const struct language_defn *language,
 199                                      const char *source_filename,
 200                                      const char *function_name,
 201                                      const char *label_name);
 202
 203 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
 204    advancing EXP_PTR past any parsed text.  */
 205
 206 extern CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
 207 #endif /* defined (LINESPEC_H) */