[thirdparty/binutils-gdb.git] / gdb / stack.h

/* Stack manipulation commands, for GDB the GNU Debugger.

   Copyright (C) 2003-2019 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef STACK_H
#define STACK_H

/* Access method used by the MI -stack-select-frame command to switch to
   frame FI.  This differs from SELECT_FRAME in that the observers for a
   user selected context change will be triggered.  */

void select_frame_for_mi (struct frame_info *fi);

gdb::unique_xmalloc_ptr<char> find_frame_funname (struct frame_info *frame,
						  enum language *funlang,
						  struct symbol **funcp);

typedef void (*iterate_over_block_arg_local_vars_cb) (const char *print_name,
						      struct symbol *sym,
						      void *cb_data);

void iterate_over_block_arg_vars (const struct block *block,
				  iterate_over_block_arg_local_vars_cb cb,
				  void *cb_data);

void iterate_over_block_local_vars (const struct block *block,
				    iterate_over_block_arg_local_vars_cb cb,
				    void *cb_data);

/* Initialize *WHAT to be a copy of the user desired print what frame info.
   If !WHAT.has_value (), the printing function chooses a default set of
   information to print, otherwise the printing function should print
   the relevant information.  */

void get_user_print_what_frame_info (gdb::optional<enum print_what> *what);

/* Return 1 if we should display the address in addition to the location,
   because we are in the middle of a statement.  */

int frame_show_address (struct frame_info *frame, struct symtab_and_line sal);

/* Get or set the last displayed symtab and line, which is, e.g. where we set a
 * breakpoint when `break' is supplied with no arguments.  */
void clear_last_displayed_sal (void);
int last_displayed_sal_is_valid (void);
struct program_space* get_last_displayed_pspace (void);
CORE_ADDR get_last_displayed_addr (void);
struct symtab* get_last_displayed_symtab (void);
int get_last_displayed_line (void);
symtab_and_line get_last_displayed_sal ();

/* Completer for the "frame apply all" command.  */
void frame_apply_all_cmd_completer (struct cmd_list_element *ignore,
				    completion_tracker &tracker,
				    const char *text, const char */*word*/);

#endif /* #ifndef STACK_H */
Commit	Line	Data
b9362cc7 AC	1	/* Stack manipulation commands, for GDB the GNU Debugger.
b9362cc7 AC	2
42a4f53d	3	Copyright (C) 2003-2019 Free Software Foundation, Inc.
b9362cc7 AC	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
a9762ec7	9	the Free Software Foundation; either version 3 of the License, or
b9362cc7 AC	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
a9762ec7	18	along with this program. If not, see <http://www.gnu.org/licenses/>. */
b9362cc7 AC	19
	20	#ifndef STACK_H
	21	#define STACK_H
	22
f67ffa6a AB	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);
b9362cc7	28
c6dc63a1 TT	29	gdb::unique_xmalloc_ptr<char> find_frame_funname (struct frame_info *frame,
	30	enum language *funlang,
	31	struct symbol **funcp);
f8f6f20b	32
3e43a32a	33	typedef void (iterate_over_block_arg_local_vars_cb) (const char print_name,
2c58c0a9 PA	34	struct symbol *sym,
	35	void *cb_data);
	36
3977b71f	37	void iterate_over_block_arg_vars (const struct block *block,
2c58c0a9 PA	38	iterate_over_block_arg_local_vars_cb cb,
	39	void *cb_data);
	40
3977b71f	41	void iterate_over_block_local_vars (const struct block *block,
2c58c0a9 PA	42	iterate_over_block_arg_local_vars_cb cb,
	43	void *cb_data);
	44
4b5e8d19 PW	45	/* Initialize *WHAT to be a copy of the user desired print what frame info.
	46	If !WHAT.has_value (), the printing function chooses a default set of
	47	information to print, otherwise the printing function should print
	48	the relevant information. */
	49
	50	void get_user_print_what_frame_info (gdb::optional<enum print_what> *what);
	51
	52	/* Return 1 if we should display the address in addition to the location,
	53	because we are in the middle of a statement. */
	54
	55	int frame_show_address (struct frame_info *frame, struct symtab_and_line sal);
	56
1bfeeb0f JL	57	/* Get or set the last displayed symtab and line, which is, e.g. where we set a
	58	* breakpoint when `break' is supplied with no arguments. */
	59	void clear_last_displayed_sal (void);
	60	int last_displayed_sal_is_valid (void);
	61	struct program_space* get_last_displayed_pspace (void);
	62	CORE_ADDR get_last_displayed_addr (void);
	63	struct symtab* get_last_displayed_symtab (void);
	64	int get_last_displayed_line (void);
51abb421	65	symtab_and_line get_last_displayed_sal ();
1bfeeb0f	66
5d707134 PA	67	/* Completer for the "frame apply all" command. */
	68	void frame_apply_all_cmd_completer (struct cmd_list_element *ignore,
	69	completion_tracker &tracker,
	70	const char text, const char /word/);
	71
b9362cc7	72	#endif /* #ifndef STACK_H */