1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
|
/* TUI layout window management.
Copyright (C) 1998-2020 Free Software Foundation, Inc.
Contributed by Hewlett-Packard Company.
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/>. */
#include "defs.h"
#include "arch-utils.h"
#include "command.h"
#include "symtab.h"
#include "frame.h"
#include "source.h"
#include "cli/cli-cmds.h"
#include "cli/cli-decode.h"
#include <ctype.h>
#include "tui/tui.h"
#include "tui/tui-command.h"
#include "tui/tui-data.h"
#include "tui/tui-wingeneral.h"
#include "tui/tui-stack.h"
#include "tui/tui-regs.h"
#include "tui/tui-win.h"
#include "tui/tui-winsource.h"
#include "tui/tui-disasm.h"
#include "tui/tui-layout.h"
#include "tui/tui-source.h"
#include "gdb_curses.h"
static void tui_layout_command (const char *, int);
static void extract_display_start_addr (struct gdbarch **, CORE_ADDR *);
/* The layouts. */
static std::vector<std::unique_ptr<tui_layout_split>> layouts;
/* The layout that is currently applied. */
static std::unique_ptr<tui_layout_base> applied_layout;
/* The "skeleton" version of the layout that is currently applied. */
static tui_layout_split *applied_skeleton;
/* The two special "regs" layouts. Note that these aren't registered
as commands and so can never be deleted. */
static tui_layout_split *src_regs_layout;
static tui_layout_split *asm_regs_layout;
/* See tui-layout.h. */
void
tui_apply_current_layout ()
{
applied_layout->apply (0, 0, tui_term_width (), tui_term_height ());
}
/* See tui-layout. */
void
tui_adjust_window_height (struct tui_win_info *win, int new_height)
{
applied_layout->adjust_size (win->name (), new_height);
}
/* Set the current layout to LAYOUT. */
static void
tui_set_layout (tui_layout_split *layout)
{
struct gdbarch *gdbarch;
CORE_ADDR addr;
extract_display_start_addr (&gdbarch, &addr);
tui_make_all_invisible ();
applied_skeleton = layout;
applied_layout = layout->clone ();
tui_apply_current_layout ();
tui_delete_invisible_windows ();
if (gdbarch == nullptr && TUI_DISASM_WIN != nullptr)
tui_get_begin_asm_address (&gdbarch, &addr);
tui_update_source_windows_with_addr (gdbarch, addr);
}
/* See tui-layout.h. */
void
tui_add_win_to_layout (enum tui_win_type type)
{
gdb_assert (type == SRC_WIN || type == DISASSEM_WIN);
/* If the window already exists, no need to add it. */
if (tui_win_list[type] != nullptr)
return;
/* If the window we are trying to replace doesn't exist, we're
done. */
enum tui_win_type other = type == SRC_WIN ? DISASSEM_WIN : SRC_WIN;
if (tui_win_list[other] == nullptr)
return;
const char *name = type == SRC_WIN ? SRC_NAME : DISASSEM_NAME;
applied_layout->replace_window (tui_win_list[other]->name (), name);
tui_apply_current_layout ();
tui_delete_invisible_windows ();
}
/* Find LAYOUT in the "layouts" global and return its index. */
static size_t
find_layout (tui_layout_split *layout)
{
for (size_t i = 0; i < layouts.size (); ++i)
{
if (layout == layouts[i].get ())
return i;
}
gdb_assert_not_reached (_("layout not found!?"));
}
/* Function to set the layout. */
static void
tui_apply_layout (struct cmd_list_element *command,
const char *args, int from_tty)
{
tui_layout_split *layout
= (tui_layout_split *) get_cmd_context (command);
/* Make sure the curses mode is enabled. */
tui_enable ();
tui_set_layout (layout);
}
/* See tui-layout.h. */
void
tui_next_layout ()
{
size_t index = find_layout (applied_skeleton);
++index;
if (index == layouts.size ())
index = 0;
tui_set_layout (layouts[index].get ());
}
/* Implement the "layout next" command. */
static void
tui_next_layout_command (const char *arg, int from_tty)
{
tui_enable ();
tui_next_layout ();
}
/* See tui-layout.h. */
void
tui_set_initial_layout ()
{
tui_set_layout (layouts[0].get ());
}
/* Implement the "layout prev" command. */
static void
tui_prev_layout_command (const char *arg, int from_tty)
{
tui_enable ();
size_t index = find_layout (applied_skeleton);
if (index == 0)
index = layouts.size ();
--index;
tui_set_layout (layouts[index].get ());
}
/* See tui-layout.h. */
void
tui_regs_layout ()
{
/* If there's already a register window, we're done. */
if (TUI_DATA_WIN != nullptr)
return;
tui_set_layout (TUI_DISASM_WIN != nullptr
? asm_regs_layout
: src_regs_layout);
}
/* Implement the "layout regs" command. */
static void
tui_regs_layout_command (const char *arg, int from_tty)
{
tui_enable ();
tui_regs_layout ();
}
/* See tui-layout.h. */
void
tui_remove_some_windows ()
{
tui_win_info *focus = tui_win_with_focus ();
if (strcmp (focus->name (), "cmd") == 0)
{
/* Try leaving the source or disassembly window. If neither
exists, just do nothing. */
focus = TUI_SRC_WIN;
if (focus == nullptr)
focus = TUI_DISASM_WIN;
if (focus == nullptr)
return;
}
applied_layout->remove_windows (focus->name ());
tui_apply_current_layout ();
}
static void
extract_display_start_addr (struct gdbarch **gdbarch_p, CORE_ADDR *addr_p)
{
struct gdbarch *gdbarch = nullptr;
CORE_ADDR addr = 0;
CORE_ADDR pc;
struct symtab_and_line cursal = get_current_source_symtab_and_line ();
if (TUI_SRC_WIN != nullptr)
{
gdbarch = TUI_SRC_WIN->gdbarch;
find_line_pc (cursal.symtab,
TUI_SRC_WIN->start_line_or_addr.u.line_no,
&pc);
addr = pc;
}
else if (TUI_DISASM_WIN != nullptr)
{
gdbarch = TUI_DISASM_WIN->gdbarch;
addr = TUI_DISASM_WIN->start_line_or_addr.u.addr;
}
*gdbarch_p = gdbarch;
*addr_p = addr;
}
void
tui_gen_win_info::resize (int height_, int width_,
int origin_x_, int origin_y_)
{
if (width == width_ && height == height_
&& x == origin_x_ && y == origin_y_
&& handle != nullptr)
return;
width = width_;
height = height_;
x = origin_x_;
y = origin_y_;
if (handle != nullptr)
{
#ifdef HAVE_WRESIZE
wresize (handle.get (), height, width);
mvwin (handle.get (), y, x);
wmove (handle.get (), 0, 0);
#else
handle.reset (nullptr);
#endif
}
if (handle == nullptr)
make_window ();
rerender ();
}
/* Helper function that returns a TUI window, given its name. */
static tui_gen_win_info *
tui_get_window_by_name (const std::string &name)
{
if (name == "src")
{
if (tui_win_list[SRC_WIN] == nullptr)
tui_win_list[SRC_WIN] = new tui_source_window ();
return tui_win_list[SRC_WIN];
}
else if (name == "cmd")
{
if (tui_win_list[CMD_WIN] == nullptr)
tui_win_list[CMD_WIN] = new tui_cmd_window ();
return tui_win_list[CMD_WIN];
}
else if (name == "regs")
{
if (tui_win_list[DATA_WIN] == nullptr)
tui_win_list[DATA_WIN] = new tui_data_window ();
return tui_win_list[DATA_WIN];
}
else if (name == "asm")
{
if (tui_win_list[DISASSEM_WIN] == nullptr)
tui_win_list[DISASSEM_WIN] = new tui_disasm_window ();
return tui_win_list[DISASSEM_WIN];
}
else
{
gdb_assert (name == "status");
return tui_locator_win_info_ptr ();
}
}
/* See tui-layout.h. */
std::unique_ptr<tui_layout_base>
tui_layout_window::clone () const
{
tui_layout_window *result = new tui_layout_window (m_contents.c_str ());
return std::unique_ptr<tui_layout_base> (result);
}
/* See tui-layout.h. */
void
tui_layout_window::apply (int x_, int y_, int width_, int height_)
{
x = x_;
y = y_;
width = width_;
height = height_;
gdb_assert (m_window != nullptr);
m_window->resize (height, width, x, y);
}
/* See tui-layout.h. */
void
tui_layout_window::get_sizes (int *min_height, int *max_height)
{
if (m_window == nullptr)
m_window = tui_get_window_by_name (m_contents);
*min_height = m_window->min_height ();
*max_height = m_window->max_height ();
}
/* See tui-layout.h. */
bool
tui_layout_window::top_boxed_p () const
{
gdb_assert (m_window != nullptr);
return m_window->can_box ();
}
/* See tui-layout.h. */
bool
tui_layout_window::bottom_boxed_p () const
{
gdb_assert (m_window != nullptr);
return m_window->can_box ();
}
/* See tui-layout.h. */
void
tui_layout_window::replace_window (const char *name, const char *new_window)
{
if (m_contents == name)
{
m_contents = new_window;
if (m_window != nullptr)
{
m_window->make_visible (false);
m_window = tui_get_window_by_name (m_contents);
}
}
}
/* See tui-layout.h. */
tui_layout_split *
tui_layout_split::add_split (int weight)
{
tui_layout_split *result = new tui_layout_split ();
split s = {weight, std::unique_ptr<tui_layout_base> (result)};
m_splits.push_back (std::move (s));
return result;
}
/* See tui-layout.h. */
void
tui_layout_split::add_window (const char *name, int weight)
{
tui_layout_window *result = new tui_layout_window (name);
split s = {weight, std::unique_ptr<tui_layout_base> (result)};
m_splits.push_back (std::move (s));
}
/* See tui-layout.h. */
std::unique_ptr<tui_layout_base>
tui_layout_split::clone () const
{
tui_layout_split *result = new tui_layout_split ();
for (const split &item : m_splits)
{
std::unique_ptr<tui_layout_base> next = item.layout->clone ();
split s = {item.weight, std::move (next)};
result->m_splits.push_back (std::move (s));
}
return std::unique_ptr<tui_layout_base> (result);
}
/* See tui-layout.h. */
void
tui_layout_split::get_sizes (int *min_height, int *max_height)
{
*min_height = 0;
*max_height = 0;
for (const split &item : m_splits)
{
int new_min, new_max;
item.layout->get_sizes (&new_min, &new_max);
*min_height += new_min;
*max_height += new_max;
}
}
/* See tui-layout.h. */
bool
tui_layout_split::top_boxed_p () const
{
if (m_splits.empty ())
return false;
return m_splits[0].layout->top_boxed_p ();
}
/* See tui-layout.h. */
bool
tui_layout_split::bottom_boxed_p () const
{
if (m_splits.empty ())
return false;
return m_splits.back ().layout->top_boxed_p ();
}
/* See tui-layout.h. */
void
tui_layout_split::set_weights_from_heights ()
{
for (int i = 0; i < m_splits.size (); ++i)
m_splits[i].weight = m_splits[i].layout->height;
}
/* See tui-layout.h. */
bool
tui_layout_split::adjust_size (const char *name, int new_height)
{
/* Look through the children. If one is a layout holding the named
window, we're done; or if one actually is the named window,
update it. */
int found_index = -1;
for (int i = 0; i < m_splits.size (); ++i)
{
if (m_splits[i].layout->adjust_size (name, new_height))
return true;
const char *win_name = m_splits[i].layout->get_name ();
if (win_name != nullptr && strcmp (name, win_name) == 0)
{
found_index = i;
break;
}
}
if (found_index == -1)
return false;
if (m_splits[found_index].layout->height == new_height)
return true;
set_weights_from_heights ();
int delta = m_splits[found_index].weight - new_height;
m_splits[found_index].weight = new_height;
/* Distribute the "delta" over the next window; but if the next
window cannot hold it all, keep going until we either find a
window that does, or until we loop all the way around. */
for (int i = 0; delta != 0 && i < m_splits.size () - 1; ++i)
{
int index = (found_index + 1 + i) % m_splits.size ();
int new_min, new_max;
m_splits[index].layout->get_sizes (&new_min, &new_max);
if (delta < 0)
{
/* The primary window grew, so we are trying to shrink other
windows. */
int available = m_splits[index].weight - new_min;
int shrink_by = std::min (available, -delta);
m_splits[index].weight -= shrink_by;
delta += shrink_by;
}
else
{
/* The primary window shrank, so we are trying to grow other
windows. */
int available = new_max - m_splits[index].weight;
int grow_by = std::min (available, delta);
m_splits[index].weight += grow_by;
delta -= grow_by;
}
}
if (delta != 0)
{
warning (_("Invalid window height specified"));
/* Effectively undo any modifications made here. */
set_weights_from_heights ();
}
else
{
/* Simply re-apply the updated layout. */
apply (x, y, width, height);
}
return true;
}
/* See tui-layout.h. */
void
tui_layout_split::apply (int x_, int y_, int width_, int height_)
{
x = x_;
y = y_;
width = width_;
height = height_;
struct height_info
{
int height;
int min_height;
int max_height;
/* True if this window will share a box border with the previous
window in the list. */
bool share_box;
};
std::vector<height_info> info (m_splits.size ());
/* Step 1: Find the min and max height of each sub-layout.
Fixed-sized layouts are given their desired height, and then the
remaining space is distributed among the remaining windows
according to the weights given. */
int available_height = height;
int last_index = -1;
int total_weight = 0;
for (int i = 0; i < m_splits.size (); ++i)
{
bool cmd_win_already_exists = TUI_CMD_WIN != nullptr;
/* Always call get_sizes, to ensure that the window is
instantiated. This is a bit gross but less gross than adding
special cases for this in other places. */
m_splits[i].layout->get_sizes (&info[i].min_height, &info[i].max_height);
if (!m_applied
&& cmd_win_already_exists
&& m_splits[i].layout->get_name () != nullptr
&& strcmp (m_splits[i].layout->get_name (), "cmd") == 0)
{
/* If this layout has never been applied, then it means the
user just changed the layout. In this situation, it's
desirable to keep the size of the command window the
same. Setting the min and max heights this way ensures
that the resizing step, below, does the right thing with
this window. */
info[i].min_height = TUI_CMD_WIN->height;
info[i].max_height = TUI_CMD_WIN->height;
}
if (info[i].min_height == info[i].max_height)
available_height -= info[i].min_height;
else
{
last_index = i;
total_weight += m_splits[i].weight;
}
/* Two adjacent boxed windows will share a border, making a bit
more height available. */
if (i > 0
&& m_splits[i - 1].layout->bottom_boxed_p ()
&& m_splits[i].layout->top_boxed_p ())
info[i].share_box = true;
}
/* Step 2: Compute the height of each sub-layout. Fixed-sized items
are given their fixed size, while others are resized according to
their weight. */
int used_height = 0;
for (int i = 0; i < m_splits.size (); ++i)
{
/* Compute the height and clamp to the allowable range. */
info[i].height = available_height * m_splits[i].weight / total_weight;
if (info[i].height > info[i].max_height)
info[i].height = info[i].max_height;
if (info[i].height < info[i].min_height)
info[i].height = info[i].min_height;
/* If there is any leftover height, just redistribute it to the
last resizeable window, by dropping it from the allocated
height. We could try to be fancier here perhaps, by
redistributing this height among all windows, not just the
last window. */
if (info[i].min_height != info[i].max_height)
{
used_height += info[i].height;
if (info[i].share_box)
--used_height;
}
}
/* Allocate any leftover height. */
if (available_height >= used_height && last_index != -1)
info[last_index].height += available_height - used_height;
/* Step 3: Resize. */
int height_accum = 0;
for (int i = 0; i < m_splits.size (); ++i)
{
/* If we fall off the bottom, just make allocations overlap.
GIGO. */
if (height_accum + info[i].height > height)
height_accum = height - info[i].height;
else if (info[i].share_box)
--height_accum;
m_splits[i].layout->apply (x, y + height_accum, width, info[i].height);
height_accum += info[i].height;
}
m_applied = true;
}
/* See tui-layout.h. */
void
tui_layout_split::remove_windows (const char *name)
{
for (int i = 0; i < m_splits.size (); ++i)
{
const char *this_name = m_splits[i].layout->get_name ();
if (this_name == nullptr)
m_splits[i].layout->remove_windows (name);
else
{
if (strcmp (this_name, name) == 0
|| strcmp (this_name, "cmd") == 0)
{
/* Keep. */
}
m_splits.erase (m_splits.begin () + i);
--i;
}
}
}
/* See tui-layout.h. */
void
tui_layout_split::replace_window (const char *name, const char *new_window)
{
for (auto &item : m_splits)
item.layout->replace_window (name, new_window);
}
/* Destroy the layout associated with SELF. */
static void
destroy_layout (struct cmd_list_element *self, void *context)
{
tui_layout_split *layout = (tui_layout_split *) context;
size_t index = find_layout (layout);
layouts.erase (layouts.begin () + index);
}
/* List holding the sub-commands of "layout". */
static struct cmd_list_element *layout_list;
/* Add a "layout" command with name NAME that switches to LAYOUT. */
static void
add_layout_command (const char *name, tui_layout_split *layout)
{
struct cmd_list_element *cmd;
gdb::unique_xmalloc_ptr<char> doc (xstrprintf (_("Apply the \"%s\" layout"),
name));
cmd = add_cmd (name, class_tui, nullptr, doc.get (), &layout_list);
set_cmd_context (cmd, layout);
/* There is no API to set this. */
cmd->func = tui_apply_layout;
cmd->destroyer = destroy_layout;
cmd->doc_allocated = 1;
doc.release ();
layouts.emplace_back (layout);
}
/* Initialize the standard layouts. */
static void
initialize_layouts ()
{
tui_layout_split *layout;
layout = new tui_layout_split ();
layout->add_window ("src", 2);
layout->add_window ("status", 0);
layout->add_window ("cmd", 1);
add_layout_command ("src", layout);
layout = new tui_layout_split ();
layout->add_window ("asm", 2);
layout->add_window ("status", 0);
layout->add_window ("cmd", 1);
add_layout_command ("asm", layout);
layout = new tui_layout_split ();
layout->add_window ("src", 1);
layout->add_window ("asm", 1);
layout->add_window ("status", 0);
layout->add_window ("cmd", 1);
add_layout_command ("split", layout);
layout = new tui_layout_split ();
layout->add_window ("regs", 1);
layout->add_window ("src", 1);
layout->add_window ("status", 0);
layout->add_window ("cmd", 1);
layouts.emplace_back (layout);
src_regs_layout = layout;
layout = new tui_layout_split ();
layout->add_window ("regs", 1);
layout->add_window ("asm", 1);
layout->add_window ("status", 0);
layout->add_window ("cmd", 1);
layouts.emplace_back (layout);
asm_regs_layout = layout;
}
/* Base command for "layout". */
static void
tui_layout_command (const char *layout_name, int from_tty)
{
help_list (layout_list, "layout ", all_commands, gdb_stdout);
}
/* Function to initialize gdb commands, for tui window layout
manipulation. */
void _initialize_tui_layout ();
void
_initialize_tui_layout ()
{
add_prefix_cmd ("layout", class_tui, tui_layout_command, _("\
Change the layout of windows.\n\
Usage: layout prev | next | LAYOUT-NAME"),
&layout_list, "layout ", 0, &cmdlist);
add_cmd ("next", class_tui, tui_next_layout_command,
_("Apply the next TUI layout"),
&layout_list);
add_cmd ("prev", class_tui, tui_prev_layout_command,
_("Apply the previous TUI layout"),
&layout_list);
add_cmd ("regs", class_tui, tui_regs_layout_command,
_("Apply the TUI register layout"),
&layout_list);
initialize_layouts ();
}
|