Update copyright year range in all GDB files
[binutils-gdb.git] / gdb / tui / tui-stack.h
1 /* TUI display locator.
2
3 Copyright (C) 1998-2021 Free Software Foundation, Inc.
4
5 Contributed by Hewlett-Packard Company.
6
7 This file is part of GDB.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21
22 #ifndef TUI_TUI_STACK_H
23 #define TUI_TUI_STACK_H
24
25 #include "tui/tui-data.h"
26
27 struct frame_info;
28
29 /* Locator window class. */
30
31 struct tui_locator_window : public tui_win_info
32 {
33 tui_locator_window () = default;
34
35 const char *name () const override
36 {
37 return STATUS_NAME;
38 }
39
40 int max_height () const override
41 {
42 return 1;
43 }
44
45 int min_height () const override
46 {
47 return 1;
48 }
49
50 bool can_box () const override
51 {
52 return false;
53 }
54
55 bool can_focus () const override
56 {
57 return false;
58 }
59
60 void rerender () override;
61
62 /* Update the locator, with the provided arguments.
63
64 Returns true if any of the locator's fields were actually
65 changed, and false otherwise. */
66 bool set_locator_info (struct gdbarch *gdbarch,
67 const struct symtab_and_line &sal,
68 const char *procname);
69
70 /* Set the full_name portion of the locator. */
71 void set_locator_fullname (const char *fullname);
72
73 std::string full_name;
74 std::string proc_name;
75 int line_no = 0;
76 CORE_ADDR addr = 0;
77 /* Architecture associated with code at this location. */
78 struct gdbarch *gdbarch = nullptr;
79
80 protected:
81
82 void do_scroll_vertical (int n) override
83 {
84 }
85
86 void do_scroll_horizontal (int n) override
87 {
88 }
89
90 private:
91
92 /* Create the status line to display as much information as we can
93 on this single line: target name, process number, current
94 function, current line, current PC, SingleKey mode. */
95
96 std::string make_status_line () const;
97 };
98
99 extern void tui_update_locator_fullname (struct symtab *symtab);
100 extern void tui_show_locator_content (void);
101 extern bool tui_show_frame_info (struct frame_info *);
102
103 #endif /* TUI_TUI_STACK_H */