gdb/stack.h

   1 /* Stack manipulation commands, for GDB the GNU Debugger.
   2
   3    Copyright (C) 2003-2022 Free Software Foundation, Inc.
   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 STACK_H
  21 #define STACK_H
  22
  23 /* Access method used by the MI -stack-select-frame command to switch to
  24    frame FI.  This differs from SELECT_FRAME in that the observers for a
  25    user selected context change will be triggered.  */
  26
  27 void select_frame_for_mi (struct frame_info *fi);
  28
  29 gdb::unique_xmalloc_ptr<char> find_frame_funname (struct frame_info *frame,
  30                                                   enum language *funlang,
  31                                                   struct symbol **funcp);
  32
  33 typedef gdb::function_view<void (const char *print_name, struct symbol *sym)>
  34      iterate_over_block_arg_local_vars_cb;
  35
  36 void iterate_over_block_arg_vars (const struct block *block,
  37                                   iterate_over_block_arg_local_vars_cb cb);
  38
  39 void iterate_over_block_local_vars (const struct block *block,
  40                                     iterate_over_block_arg_local_vars_cb cb);
  41
  42 /* Initialize *WHAT to be a copy of the user desired print what frame info.
  43    If !WHAT.has_value (), the printing function chooses a default set of
  44    information to print, otherwise the printing function should print
  45    the relevant information.  */
  46
  47 void get_user_print_what_frame_info (gdb::optional<enum print_what> *what);
  48
  49 /* Return true if we should display the address in addition to the location,
  50    because we are in the middle of a statement.  */
  51
  52 bool frame_show_address (struct frame_info *frame, struct symtab_and_line sal);
  53
  54 /* Forget the last sal we displayed.  */
  55
  56 void clear_last_displayed_sal (void);
  57
  58 /* Is our record of the last sal we displayed valid?  If not, the
  59    get_last_displayed_* functions will return NULL or 0, as appropriate.  */
  60
  61 bool last_displayed_sal_is_valid (void);
  62
  63 /* Get the pspace of the last sal we displayed, if it's valid, otherwise
  64    return nullptr.  */
  65
  66 struct program_space* get_last_displayed_pspace (void);
  67
  68 /* Get the address of the last sal we displayed, if it's valid, otherwise
  69    return an address of 0.  */
  70
  71 CORE_ADDR get_last_displayed_addr (void);
  72
  73 /* Get the symtab of the last sal we displayed, if it's valid, otherwise
  74    return nullptr.  */
  75
  76 struct symtab* get_last_displayed_symtab (void);
  77
  78 /* Get the line of the last sal we displayed, if it's valid, otherwise
  79    return 0.  */
  80
  81 int get_last_displayed_line (void);
  82
  83 /* Get the last sal we displayed, if it's valid, otherwise return a
  84    symtab_and_line constructed in its default state.  */
  85
  86 symtab_and_line get_last_displayed_sal ();
  87
  88 /* Completer for the "frame apply all" command.  */
  89 void frame_apply_all_cmd_completer (struct cmd_list_element *ignore,
  90                                     completion_tracker &tracker,
  91                                     const char *text, const char */*word*/);
  92
  93 #endif /* #ifndef STACK_H */