180814287SRaphael Isemann //===-- IOHandlerCursesGUI.cpp --------------------------------------------===// 27caa17caSRaphael Isemann // 37caa17caSRaphael Isemann // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 47caa17caSRaphael Isemann // See https://llvm.org/LICENSE.txt for license information. 57caa17caSRaphael Isemann // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 67caa17caSRaphael Isemann // 77caa17caSRaphael Isemann //===----------------------------------------------------------------------===// 87caa17caSRaphael Isemann 97caa17caSRaphael Isemann #include "lldb/Core/IOHandlerCursesGUI.h" 1059998b7bSJonas Devlieghere #include "lldb/Host/Config.h" 117caa17caSRaphael Isemann 12a4304f96SJonas Devlieghere #if LLDB_ENABLE_CURSES 13c952ec15SLuboš Luňák #if CURSES_HAVE_NCURSES_CURSES_H 14c952ec15SLuboš Luňák #include <ncurses/curses.h> 15c952ec15SLuboš Luňák #include <ncurses/panel.h> 16c952ec15SLuboš Luňák #else 177caa17caSRaphael Isemann #include <curses.h> 187caa17caSRaphael Isemann #include <panel.h> 197caa17caSRaphael Isemann #endif 20c952ec15SLuboš Luňák #endif 217caa17caSRaphael Isemann 227caa17caSRaphael Isemann #if defined(__APPLE__) 237caa17caSRaphael Isemann #include <deque> 247caa17caSRaphael Isemann #endif 257caa17caSRaphael Isemann #include <string> 267caa17caSRaphael Isemann 277caa17caSRaphael Isemann #include "lldb/Core/Debugger.h" 287caa17caSRaphael Isemann #include "lldb/Core/StreamFile.h" 294631afdeSRaphael Isemann #include "lldb/Core/ValueObjectUpdater.h" 307caa17caSRaphael Isemann #include "lldb/Host/File.h" 31*5e79a001SLuboš Luňák #include "lldb/Utility/AnsiTerminal.h" 327caa17caSRaphael Isemann #include "lldb/Utility/Predicate.h" 337caa17caSRaphael Isemann #include "lldb/Utility/Status.h" 347caa17caSRaphael Isemann #include "lldb/Utility/StreamString.h" 357caa17caSRaphael Isemann #include "lldb/Utility/StringList.h" 367caa17caSRaphael Isemann #include "lldb/lldb-forward.h" 377caa17caSRaphael Isemann 387caa17caSRaphael Isemann #include "lldb/Interpreter/CommandCompletions.h" 397caa17caSRaphael Isemann #include "lldb/Interpreter/CommandInterpreter.h" 4018c25cd3SOmar Emara #include "lldb/Interpreter/OptionGroupPlatform.h" 417caa17caSRaphael Isemann 42a4304f96SJonas Devlieghere #if LLDB_ENABLE_CURSES 437caa17caSRaphael Isemann #include "lldb/Breakpoint/BreakpointLocation.h" 447caa17caSRaphael Isemann #include "lldb/Core/Module.h" 450321dbc8SOmar Emara #include "lldb/Core/PluginManager.h" 467caa17caSRaphael Isemann #include "lldb/Core/ValueObject.h" 477caa17caSRaphael Isemann #include "lldb/Core/ValueObjectRegister.h" 487caa17caSRaphael Isemann #include "lldb/Symbol/Block.h" 49b26e1efcSOmar Emara #include "lldb/Symbol/CompileUnit.h" 507caa17caSRaphael Isemann #include "lldb/Symbol/Function.h" 517caa17caSRaphael Isemann #include "lldb/Symbol/Symbol.h" 527caa17caSRaphael Isemann #include "lldb/Symbol/VariableList.h" 537caa17caSRaphael Isemann #include "lldb/Target/Process.h" 547caa17caSRaphael Isemann #include "lldb/Target/RegisterContext.h" 557caa17caSRaphael Isemann #include "lldb/Target/StackFrame.h" 567caa17caSRaphael Isemann #include "lldb/Target/StopInfo.h" 577caa17caSRaphael Isemann #include "lldb/Target/Target.h" 587caa17caSRaphael Isemann #include "lldb/Target/Thread.h" 597caa17caSRaphael Isemann #include "lldb/Utility/State.h" 607caa17caSRaphael Isemann #endif 617caa17caSRaphael Isemann 627caa17caSRaphael Isemann #include "llvm/ADT/StringRef.h" 637caa17caSRaphael Isemann 647caa17caSRaphael Isemann #ifdef _WIN32 657caa17caSRaphael Isemann #include "lldb/Host/windows/windows.h" 667caa17caSRaphael Isemann #endif 677caa17caSRaphael Isemann 687caa17caSRaphael Isemann #include <memory> 697caa17caSRaphael Isemann #include <mutex> 707caa17caSRaphael Isemann 7176e47d48SRaphael Isemann #include <cassert> 7276e47d48SRaphael Isemann #include <cctype> 7376e47d48SRaphael Isemann #include <cerrno> 7476e47d48SRaphael Isemann #include <cstdint> 7576e47d48SRaphael Isemann #include <cstdio> 7676e47d48SRaphael Isemann #include <cstring> 7729cc50e1SOmar Emara #include <functional> 787caa17caSRaphael Isemann #include <type_traits> 797caa17caSRaphael Isemann 807caa17caSRaphael Isemann using namespace lldb; 817caa17caSRaphael Isemann using namespace lldb_private; 827caa17caSRaphael Isemann using llvm::StringRef; 837caa17caSRaphael Isemann 847caa17caSRaphael Isemann // we may want curses to be disabled for some builds for instance, windows 85a4304f96SJonas Devlieghere #if LLDB_ENABLE_CURSES 867caa17caSRaphael Isemann 87d95d2a8eSOmar Emara #define KEY_CTRL_A 1 88d95d2a8eSOmar Emara #define KEY_CTRL_E 5 89d95d2a8eSOmar Emara #define KEY_CTRL_K 11 907caa17caSRaphael Isemann #define KEY_RETURN 10 917caa17caSRaphael Isemann #define KEY_ESCAPE 27 92d95d2a8eSOmar Emara #define KEY_DELETE 127 937caa17caSRaphael Isemann 9429cc50e1SOmar Emara #define KEY_SHIFT_TAB (KEY_MAX + 1) 95945cde8bSOmar Emara #define KEY_ALT_ENTER (KEY_MAX + 2) 9629cc50e1SOmar Emara 977caa17caSRaphael Isemann namespace curses { 987caa17caSRaphael Isemann class Menu; 997caa17caSRaphael Isemann class MenuDelegate; 1007caa17caSRaphael Isemann class Window; 1017caa17caSRaphael Isemann class WindowDelegate; 1027caa17caSRaphael Isemann typedef std::shared_ptr<Menu> MenuSP; 1037caa17caSRaphael Isemann typedef std::shared_ptr<MenuDelegate> MenuDelegateSP; 1047caa17caSRaphael Isemann typedef std::shared_ptr<Window> WindowSP; 1057caa17caSRaphael Isemann typedef std::shared_ptr<WindowDelegate> WindowDelegateSP; 1067caa17caSRaphael Isemann typedef std::vector<MenuSP> Menus; 1077caa17caSRaphael Isemann typedef std::vector<WindowSP> Windows; 1087caa17caSRaphael Isemann typedef std::vector<WindowDelegateSP> WindowDelegates; 1097caa17caSRaphael Isemann 1107caa17caSRaphael Isemann #if 0 1117caa17caSRaphael Isemann type summary add -s "x=${var.x}, y=${var.y}" curses::Point 1127caa17caSRaphael Isemann type summary add -s "w=${var.width}, h=${var.height}" curses::Size 1137caa17caSRaphael Isemann type summary add -s "${var.origin%S} ${var.size%S}" curses::Rect 1147caa17caSRaphael Isemann #endif 1157caa17caSRaphael Isemann 1167caa17caSRaphael Isemann struct Point { 1177caa17caSRaphael Isemann int x; 1187caa17caSRaphael Isemann int y; 1197caa17caSRaphael Isemann 1207caa17caSRaphael Isemann Point(int _x = 0, int _y = 0) : x(_x), y(_y) {} 1217caa17caSRaphael Isemann 1227caa17caSRaphael Isemann void Clear() { 1237caa17caSRaphael Isemann x = 0; 1247caa17caSRaphael Isemann y = 0; 1257caa17caSRaphael Isemann } 1267caa17caSRaphael Isemann 1277caa17caSRaphael Isemann Point &operator+=(const Point &rhs) { 1287caa17caSRaphael Isemann x += rhs.x; 1297caa17caSRaphael Isemann y += rhs.y; 1307caa17caSRaphael Isemann return *this; 1317caa17caSRaphael Isemann } 1327caa17caSRaphael Isemann 1337caa17caSRaphael Isemann void Dump() { printf("(x=%i, y=%i)\n", x, y); } 1347caa17caSRaphael Isemann }; 1357caa17caSRaphael Isemann 1367caa17caSRaphael Isemann bool operator==(const Point &lhs, const Point &rhs) { 1377caa17caSRaphael Isemann return lhs.x == rhs.x && lhs.y == rhs.y; 1387caa17caSRaphael Isemann } 1397caa17caSRaphael Isemann 1407caa17caSRaphael Isemann bool operator!=(const Point &lhs, const Point &rhs) { 1417caa17caSRaphael Isemann return lhs.x != rhs.x || lhs.y != rhs.y; 1427caa17caSRaphael Isemann } 1437caa17caSRaphael Isemann 1447caa17caSRaphael Isemann struct Size { 1457caa17caSRaphael Isemann int width; 1467caa17caSRaphael Isemann int height; 1477caa17caSRaphael Isemann Size(int w = 0, int h = 0) : width(w), height(h) {} 1487caa17caSRaphael Isemann 1497caa17caSRaphael Isemann void Clear() { 1507caa17caSRaphael Isemann width = 0; 1517caa17caSRaphael Isemann height = 0; 1527caa17caSRaphael Isemann } 1537caa17caSRaphael Isemann 1547caa17caSRaphael Isemann void Dump() { printf("(w=%i, h=%i)\n", width, height); } 1557caa17caSRaphael Isemann }; 1567caa17caSRaphael Isemann 1577caa17caSRaphael Isemann bool operator==(const Size &lhs, const Size &rhs) { 1587caa17caSRaphael Isemann return lhs.width == rhs.width && lhs.height == rhs.height; 1597caa17caSRaphael Isemann } 1607caa17caSRaphael Isemann 1617caa17caSRaphael Isemann bool operator!=(const Size &lhs, const Size &rhs) { 1627caa17caSRaphael Isemann return lhs.width != rhs.width || lhs.height != rhs.height; 1637caa17caSRaphael Isemann } 1647caa17caSRaphael Isemann 1657caa17caSRaphael Isemann struct Rect { 1667caa17caSRaphael Isemann Point origin; 1677caa17caSRaphael Isemann Size size; 1687caa17caSRaphael Isemann 1697caa17caSRaphael Isemann Rect() : origin(), size() {} 1707caa17caSRaphael Isemann 1717caa17caSRaphael Isemann Rect(const Point &p, const Size &s) : origin(p), size(s) {} 1727caa17caSRaphael Isemann 1737caa17caSRaphael Isemann void Clear() { 1747caa17caSRaphael Isemann origin.Clear(); 1757caa17caSRaphael Isemann size.Clear(); 1767caa17caSRaphael Isemann } 1777caa17caSRaphael Isemann 1787caa17caSRaphael Isemann void Dump() { 1797caa17caSRaphael Isemann printf("(x=%i, y=%i), w=%i, h=%i)\n", origin.x, origin.y, size.width, 1807caa17caSRaphael Isemann size.height); 1817caa17caSRaphael Isemann } 1827caa17caSRaphael Isemann 1837caa17caSRaphael Isemann void Inset(int w, int h) { 1847caa17caSRaphael Isemann if (size.width > w * 2) 1857caa17caSRaphael Isemann size.width -= w * 2; 1867caa17caSRaphael Isemann origin.x += w; 1877caa17caSRaphael Isemann 1887caa17caSRaphael Isemann if (size.height > h * 2) 1897caa17caSRaphael Isemann size.height -= h * 2; 1907caa17caSRaphael Isemann origin.y += h; 1917caa17caSRaphael Isemann } 1927caa17caSRaphael Isemann 1937caa17caSRaphael Isemann // Return a status bar rectangle which is the last line of this rectangle. 1947caa17caSRaphael Isemann // This rectangle will be modified to not include the status bar area. 1957caa17caSRaphael Isemann Rect MakeStatusBar() { 1967caa17caSRaphael Isemann Rect status_bar; 1977caa17caSRaphael Isemann if (size.height > 1) { 1987caa17caSRaphael Isemann status_bar.origin.x = origin.x; 1997caa17caSRaphael Isemann status_bar.origin.y = size.height; 2007caa17caSRaphael Isemann status_bar.size.width = size.width; 2017caa17caSRaphael Isemann status_bar.size.height = 1; 2027caa17caSRaphael Isemann --size.height; 2037caa17caSRaphael Isemann } 2047caa17caSRaphael Isemann return status_bar; 2057caa17caSRaphael Isemann } 2067caa17caSRaphael Isemann 2077caa17caSRaphael Isemann // Return a menubar rectangle which is the first line of this rectangle. This 2087caa17caSRaphael Isemann // rectangle will be modified to not include the menubar area. 2097caa17caSRaphael Isemann Rect MakeMenuBar() { 2107caa17caSRaphael Isemann Rect menubar; 2117caa17caSRaphael Isemann if (size.height > 1) { 2127caa17caSRaphael Isemann menubar.origin.x = origin.x; 2137caa17caSRaphael Isemann menubar.origin.y = origin.y; 2147caa17caSRaphael Isemann menubar.size.width = size.width; 2157caa17caSRaphael Isemann menubar.size.height = 1; 2167caa17caSRaphael Isemann ++origin.y; 2177caa17caSRaphael Isemann --size.height; 2187caa17caSRaphael Isemann } 2197caa17caSRaphael Isemann return menubar; 2207caa17caSRaphael Isemann } 2217caa17caSRaphael Isemann 2227caa17caSRaphael Isemann void HorizontalSplitPercentage(float top_percentage, Rect &top, 2237caa17caSRaphael Isemann Rect &bottom) const { 2247caa17caSRaphael Isemann float top_height = top_percentage * size.height; 2257caa17caSRaphael Isemann HorizontalSplit(top_height, top, bottom); 2267caa17caSRaphael Isemann } 2277caa17caSRaphael Isemann 2287caa17caSRaphael Isemann void HorizontalSplit(int top_height, Rect &top, Rect &bottom) const { 2297caa17caSRaphael Isemann top = *this; 2307caa17caSRaphael Isemann if (top_height < size.height) { 2317caa17caSRaphael Isemann top.size.height = top_height; 2327caa17caSRaphael Isemann bottom.origin.x = origin.x; 2337caa17caSRaphael Isemann bottom.origin.y = origin.y + top.size.height; 2347caa17caSRaphael Isemann bottom.size.width = size.width; 2357caa17caSRaphael Isemann bottom.size.height = size.height - top.size.height; 2367caa17caSRaphael Isemann } else { 2377caa17caSRaphael Isemann bottom.Clear(); 2387caa17caSRaphael Isemann } 2397caa17caSRaphael Isemann } 2407caa17caSRaphael Isemann 2417caa17caSRaphael Isemann void VerticalSplitPercentage(float left_percentage, Rect &left, 2427caa17caSRaphael Isemann Rect &right) const { 2437caa17caSRaphael Isemann float left_width = left_percentage * size.width; 2447caa17caSRaphael Isemann VerticalSplit(left_width, left, right); 2457caa17caSRaphael Isemann } 2467caa17caSRaphael Isemann 2477caa17caSRaphael Isemann void VerticalSplit(int left_width, Rect &left, Rect &right) const { 2487caa17caSRaphael Isemann left = *this; 2497caa17caSRaphael Isemann if (left_width < size.width) { 2507caa17caSRaphael Isemann left.size.width = left_width; 2517caa17caSRaphael Isemann right.origin.x = origin.x + left.size.width; 2527caa17caSRaphael Isemann right.origin.y = origin.y; 2537caa17caSRaphael Isemann right.size.width = size.width - left.size.width; 2547caa17caSRaphael Isemann right.size.height = size.height; 2557caa17caSRaphael Isemann } else { 2567caa17caSRaphael Isemann right.Clear(); 2577caa17caSRaphael Isemann } 2587caa17caSRaphael Isemann } 2597caa17caSRaphael Isemann }; 2607caa17caSRaphael Isemann 2617caa17caSRaphael Isemann bool operator==(const Rect &lhs, const Rect &rhs) { 2627caa17caSRaphael Isemann return lhs.origin == rhs.origin && lhs.size == rhs.size; 2637caa17caSRaphael Isemann } 2647caa17caSRaphael Isemann 2657caa17caSRaphael Isemann bool operator!=(const Rect &lhs, const Rect &rhs) { 2667caa17caSRaphael Isemann return lhs.origin != rhs.origin || lhs.size != rhs.size; 2677caa17caSRaphael Isemann } 2687caa17caSRaphael Isemann 2697caa17caSRaphael Isemann enum HandleCharResult { 2707caa17caSRaphael Isemann eKeyNotHandled = 0, 2717caa17caSRaphael Isemann eKeyHandled = 1, 2727caa17caSRaphael Isemann eQuitApplication = 2 2737caa17caSRaphael Isemann }; 2747caa17caSRaphael Isemann 2757caa17caSRaphael Isemann enum class MenuActionResult { 2767caa17caSRaphael Isemann Handled, 2777caa17caSRaphael Isemann NotHandled, 2787caa17caSRaphael Isemann Quit // Exit all menus and quit 2797caa17caSRaphael Isemann }; 2807caa17caSRaphael Isemann 2817caa17caSRaphael Isemann struct KeyHelp { 2827caa17caSRaphael Isemann int ch; 2837caa17caSRaphael Isemann const char *description; 2847caa17caSRaphael Isemann }; 2857caa17caSRaphael Isemann 2864a8e4b5cSLuboš Luňák // COLOR_PAIR index names 2874a8e4b5cSLuboš Luňák enum { 2884a8e4b5cSLuboš Luňák // First 16 colors are 8 black background and 8 blue background colors, 2894a8e4b5cSLuboš Luňák // needed by OutputColoredStringTruncated(). 2904a8e4b5cSLuboš Luňák BlackOnBlack = 1, 2914a8e4b5cSLuboš Luňák RedOnBlack, 2924a8e4b5cSLuboš Luňák GreenOnBlack, 2934a8e4b5cSLuboš Luňák YellowOnBlack, 2944a8e4b5cSLuboš Luňák BlueOnBlack, 2954a8e4b5cSLuboš Luňák MagentaOnBlack, 2964a8e4b5cSLuboš Luňák CyanOnBlack, 2974a8e4b5cSLuboš Luňák WhiteOnBlack, 2984a8e4b5cSLuboš Luňák BlackOnBlue, 2994a8e4b5cSLuboš Luňák RedOnBlue, 3004a8e4b5cSLuboš Luňák GreenOnBlue, 3014a8e4b5cSLuboš Luňák YellowOnBlue, 3024a8e4b5cSLuboš Luňák BlueOnBlue, 3034a8e4b5cSLuboš Luňák MagentaOnBlue, 3044a8e4b5cSLuboš Luňák CyanOnBlue, 3054a8e4b5cSLuboš Luňák WhiteOnBlue, 3064a8e4b5cSLuboš Luňák // Other colors, as needed. 3074a8e4b5cSLuboš Luňák BlackOnWhite, 3084a8e4b5cSLuboš Luňák MagentaOnWhite, 3094a8e4b5cSLuboš Luňák LastColorPairIndex = MagentaOnWhite 3104a8e4b5cSLuboš Luňák }; 3114a8e4b5cSLuboš Luňák 3127caa17caSRaphael Isemann class WindowDelegate { 3137caa17caSRaphael Isemann public: 3147caa17caSRaphael Isemann virtual ~WindowDelegate() = default; 3157caa17caSRaphael Isemann 3167caa17caSRaphael Isemann virtual bool WindowDelegateDraw(Window &window, bool force) { 3177caa17caSRaphael Isemann return false; // Drawing not handled 3187caa17caSRaphael Isemann } 3197caa17caSRaphael Isemann 3207caa17caSRaphael Isemann virtual HandleCharResult WindowDelegateHandleChar(Window &window, int key) { 3217caa17caSRaphael Isemann return eKeyNotHandled; 3227caa17caSRaphael Isemann } 3237caa17caSRaphael Isemann 3247caa17caSRaphael Isemann virtual const char *WindowDelegateGetHelpText() { return nullptr; } 3257caa17caSRaphael Isemann 3267caa17caSRaphael Isemann virtual KeyHelp *WindowDelegateGetKeyHelp() { return nullptr; } 3277caa17caSRaphael Isemann }; 3287caa17caSRaphael Isemann 3297caa17caSRaphael Isemann class HelpDialogDelegate : public WindowDelegate { 3307caa17caSRaphael Isemann public: 3317caa17caSRaphael Isemann HelpDialogDelegate(const char *text, KeyHelp *key_help_array); 3327caa17caSRaphael Isemann 3337caa17caSRaphael Isemann ~HelpDialogDelegate() override; 3347caa17caSRaphael Isemann 3357caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override; 3367caa17caSRaphael Isemann 3377caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int key) override; 3387caa17caSRaphael Isemann 3397caa17caSRaphael Isemann size_t GetNumLines() const { return m_text.GetSize(); } 3407caa17caSRaphael Isemann 3417caa17caSRaphael Isemann size_t GetMaxLineLength() const { return m_text.GetMaxStringLength(); } 3427caa17caSRaphael Isemann 3437caa17caSRaphael Isemann protected: 3447caa17caSRaphael Isemann StringList m_text; 34528c878aeSShafik Yaghmour int m_first_visible_line = 0; 3467caa17caSRaphael Isemann }; 3477caa17caSRaphael Isemann 34829cc50e1SOmar Emara // A surface is an abstraction for something than can be drawn on. The surface 34929cc50e1SOmar Emara // have a width, a height, a cursor position, and a multitude of drawing 35029cc50e1SOmar Emara // operations. This type should be sub-classed to get an actually useful ncurses 35179e950a2SOmar Emara // object, such as a Window or a Pad. 35229cc50e1SOmar Emara class Surface { 3537caa17caSRaphael Isemann public: 35479e950a2SOmar Emara enum class Type { Window, Pad }; 35579e950a2SOmar Emara 35628c878aeSShafik Yaghmour Surface(Surface::Type type) : m_type(type) {} 3577caa17caSRaphael Isemann 35829cc50e1SOmar Emara WINDOW *get() { return m_window; } 35929cc50e1SOmar Emara 36029cc50e1SOmar Emara operator WINDOW *() { return m_window; } 36129cc50e1SOmar Emara 36279e950a2SOmar Emara Surface SubSurface(Rect bounds) { 36379e950a2SOmar Emara Surface subSurface(m_type); 36479e950a2SOmar Emara if (m_type == Type::Pad) 36579e950a2SOmar Emara subSurface.m_window = 36679e950a2SOmar Emara ::subpad(m_window, bounds.size.height, bounds.size.width, 36779e950a2SOmar Emara bounds.origin.y, bounds.origin.x); 36879e950a2SOmar Emara else 36979e950a2SOmar Emara subSurface.m_window = 37079e950a2SOmar Emara ::derwin(m_window, bounds.size.height, bounds.size.width, 37179e950a2SOmar Emara bounds.origin.y, bounds.origin.x); 37279e950a2SOmar Emara return subSurface; 37379e950a2SOmar Emara } 37479e950a2SOmar Emara 37529cc50e1SOmar Emara // Copy a region of the surface to another surface. 37629cc50e1SOmar Emara void CopyToSurface(Surface &target, Point source_origin, Point target_origin, 37729cc50e1SOmar Emara Size size) { 37829cc50e1SOmar Emara ::copywin(m_window, target.get(), source_origin.y, source_origin.x, 37929cc50e1SOmar Emara target_origin.y, target_origin.x, 38029cc50e1SOmar Emara target_origin.y + size.height - 1, 38129cc50e1SOmar Emara target_origin.x + size.width - 1, false); 3827caa17caSRaphael Isemann } 3837caa17caSRaphael Isemann 38429cc50e1SOmar Emara int GetCursorX() const { return getcurx(m_window); } 38529cc50e1SOmar Emara int GetCursorY() const { return getcury(m_window); } 38629cc50e1SOmar Emara void MoveCursor(int x, int y) { ::wmove(m_window, y, x); } 3877caa17caSRaphael Isemann 3887caa17caSRaphael Isemann void AttributeOn(attr_t attr) { ::wattron(m_window, attr); } 3897caa17caSRaphael Isemann void AttributeOff(attr_t attr) { ::wattroff(m_window, attr); } 39029cc50e1SOmar Emara 391fc0e8fb7SLuboš Luňák int GetMaxX() const { return getmaxx(m_window); } 392fc0e8fb7SLuboš Luňák int GetMaxY() const { return getmaxy(m_window); } 393fc0e8fb7SLuboš Luňák int GetWidth() const { return GetMaxX(); } 394fc0e8fb7SLuboš Luňák int GetHeight() const { return GetMaxY(); } 39529cc50e1SOmar Emara Size GetSize() const { return Size(GetWidth(), GetHeight()); } 39629cc50e1SOmar Emara // Get a zero origin rectangle width the surface size. 39729cc50e1SOmar Emara Rect GetFrame() const { return Rect(Point(), GetSize()); } 39829cc50e1SOmar Emara 39929cc50e1SOmar Emara void Clear() { ::wclear(m_window); } 40029cc50e1SOmar Emara void Erase() { ::werase(m_window); } 40129cc50e1SOmar Emara 4027caa17caSRaphael Isemann void SetBackground(int color_pair_idx) { 4037caa17caSRaphael Isemann ::wbkgd(m_window, COLOR_PAIR(color_pair_idx)); 4047caa17caSRaphael Isemann } 4057caa17caSRaphael Isemann 40629cc50e1SOmar Emara void PutChar(int ch) { ::waddch(m_window, ch); } 40729cc50e1SOmar Emara void PutCString(const char *s, int len = -1) { ::waddnstr(m_window, s, len); } 40829cc50e1SOmar Emara 40914406ca0SLuboš Luňák void PutCStringTruncated(int right_pad, const char *s, int len = -1) { 4107caa17caSRaphael Isemann int bytes_left = GetWidth() - GetCursorX(); 4117caa17caSRaphael Isemann if (bytes_left > right_pad) { 4127caa17caSRaphael Isemann bytes_left -= right_pad; 41314406ca0SLuboš Luňák ::waddnstr(m_window, s, len < 0 ? bytes_left : std::min(bytes_left, len)); 4147caa17caSRaphael Isemann } 4157caa17caSRaphael Isemann } 4167caa17caSRaphael Isemann 4177caa17caSRaphael Isemann void Printf(const char *format, ...) __attribute__((format(printf, 2, 3))) { 4187caa17caSRaphael Isemann va_list args; 4197caa17caSRaphael Isemann va_start(args, format); 4203b7795aeSRaphael Isemann vw_printw(m_window, format, args); 4217caa17caSRaphael Isemann va_end(args); 4227caa17caSRaphael Isemann } 4237caa17caSRaphael Isemann 424fc0e8fb7SLuboš Luňák void PrintfTruncated(int right_pad, const char *format, ...) 425fc0e8fb7SLuboš Luňák __attribute__((format(printf, 3, 4))) { 426fc0e8fb7SLuboš Luňák va_list args; 427fc0e8fb7SLuboš Luňák va_start(args, format); 428fc0e8fb7SLuboš Luňák StreamString strm; 429fc0e8fb7SLuboš Luňák strm.PrintfVarArg(format, args); 430fc0e8fb7SLuboš Luňák va_end(args); 431fc0e8fb7SLuboš Luňák PutCStringTruncated(right_pad, strm.GetData()); 432fc0e8fb7SLuboš Luňák } 433fc0e8fb7SLuboš Luňák 43429cc50e1SOmar Emara void VerticalLine(int n, chtype v_char = ACS_VLINE) { 43529cc50e1SOmar Emara ::wvline(m_window, v_char, n); 43629cc50e1SOmar Emara } 43729cc50e1SOmar Emara void HorizontalLine(int n, chtype h_char = ACS_HLINE) { 43829cc50e1SOmar Emara ::whline(m_window, h_char, n); 43929cc50e1SOmar Emara } 44029cc50e1SOmar Emara void Box(chtype v_char = ACS_VLINE, chtype h_char = ACS_HLINE) { 44129cc50e1SOmar Emara ::box(m_window, v_char, h_char); 44229cc50e1SOmar Emara } 44329cc50e1SOmar Emara 44429cc50e1SOmar Emara void TitledBox(const char *title, chtype v_char = ACS_VLINE, 44529cc50e1SOmar Emara chtype h_char = ACS_HLINE) { 44629cc50e1SOmar Emara Box(v_char, h_char); 44729cc50e1SOmar Emara int title_offset = 2; 44829cc50e1SOmar Emara MoveCursor(title_offset, 0); 44929cc50e1SOmar Emara PutChar('['); 45029cc50e1SOmar Emara PutCString(title, GetWidth() - title_offset); 45129cc50e1SOmar Emara PutChar(']'); 45229cc50e1SOmar Emara } 45329cc50e1SOmar Emara 45429cc50e1SOmar Emara void Box(const Rect &bounds, chtype v_char = ACS_VLINE, 45529cc50e1SOmar Emara chtype h_char = ACS_HLINE) { 45629cc50e1SOmar Emara MoveCursor(bounds.origin.x, bounds.origin.y); 45729cc50e1SOmar Emara VerticalLine(bounds.size.height); 45829cc50e1SOmar Emara HorizontalLine(bounds.size.width); 45929cc50e1SOmar Emara PutChar(ACS_ULCORNER); 46029cc50e1SOmar Emara 46129cc50e1SOmar Emara MoveCursor(bounds.origin.x + bounds.size.width - 1, bounds.origin.y); 46229cc50e1SOmar Emara VerticalLine(bounds.size.height); 46329cc50e1SOmar Emara PutChar(ACS_URCORNER); 46429cc50e1SOmar Emara 46529cc50e1SOmar Emara MoveCursor(bounds.origin.x, bounds.origin.y + bounds.size.height - 1); 46629cc50e1SOmar Emara HorizontalLine(bounds.size.width); 46729cc50e1SOmar Emara PutChar(ACS_LLCORNER); 46829cc50e1SOmar Emara 46929cc50e1SOmar Emara MoveCursor(bounds.origin.x + bounds.size.width - 1, 47029cc50e1SOmar Emara bounds.origin.y + bounds.size.height - 1); 47129cc50e1SOmar Emara PutChar(ACS_LRCORNER); 47229cc50e1SOmar Emara } 47329cc50e1SOmar Emara 47429cc50e1SOmar Emara void TitledBox(const Rect &bounds, const char *title, 47529cc50e1SOmar Emara chtype v_char = ACS_VLINE, chtype h_char = ACS_HLINE) { 47629cc50e1SOmar Emara Box(bounds, v_char, h_char); 47729cc50e1SOmar Emara int title_offset = 2; 47829cc50e1SOmar Emara MoveCursor(bounds.origin.x + title_offset, bounds.origin.y); 47929cc50e1SOmar Emara PutChar('['); 48029cc50e1SOmar Emara PutCString(title, bounds.size.width - title_offset); 48129cc50e1SOmar Emara PutChar(']'); 482fc0e8fb7SLuboš Luňák } 483fc0e8fb7SLuboš Luňák 48414406ca0SLuboš Luňák // Curses doesn't allow direct output of color escape sequences, but that's 48514406ca0SLuboš Luňák // how we get source lines from the Highligher class. Read the line and 486dcd4589aSLuboš Luňák // convert color escape sequences to curses color attributes. Use 487dcd4589aSLuboš Luňák // first_skip_count to skip leading visible characters. Returns false if all 488dcd4589aSLuboš Luňák // visible characters were skipped due to first_skip_count. 489dcd4589aSLuboš Luňák bool OutputColoredStringTruncated(int right_pad, StringRef string, 490dcd4589aSLuboš Luňák size_t skip_first_count, 49114406ca0SLuboš Luňák bool use_blue_background) { 49214406ca0SLuboš Luňák attr_t saved_attr; 49314406ca0SLuboš Luňák short saved_pair; 494dcd4589aSLuboš Luňák bool result = false; 4959dbdaea9SSterling Augustine wattr_get(m_window, &saved_attr, &saved_pair, nullptr); 49614406ca0SLuboš Luňák if (use_blue_background) 4974a8e4b5cSLuboš Luňák ::wattron(m_window, COLOR_PAIR(WhiteOnBlue)); 49814406ca0SLuboš Luňák while (!string.empty()) { 499*5e79a001SLuboš Luňák size_t esc_pos = string.find(ANSI_ESC_START); 50014406ca0SLuboš Luňák if (esc_pos == StringRef::npos) { 501dcd4589aSLuboš Luňák string = string.substr(skip_first_count); 502dcd4589aSLuboš Luňák if (!string.empty()) { 50314406ca0SLuboš Luňák PutCStringTruncated(right_pad, string.data(), string.size()); 504dcd4589aSLuboš Luňák result = true; 505dcd4589aSLuboš Luňák } 50614406ca0SLuboš Luňák break; 50714406ca0SLuboš Luňák } 50814406ca0SLuboš Luňák if (esc_pos > 0) { 509dcd4589aSLuboš Luňák if (skip_first_count > 0) { 510dcd4589aSLuboš Luňák int skip = std::min(esc_pos, skip_first_count); 511dcd4589aSLuboš Luňák string = string.substr(skip); 512dcd4589aSLuboš Luňák skip_first_count -= skip; 513dcd4589aSLuboš Luňák esc_pos -= skip; 514dcd4589aSLuboš Luňák } 515dcd4589aSLuboš Luňák if (esc_pos > 0) { 51614406ca0SLuboš Luňák PutCStringTruncated(right_pad, string.data(), esc_pos); 517dcd4589aSLuboš Luňák result = true; 51814406ca0SLuboš Luňák string = string.drop_front(esc_pos); 51914406ca0SLuboš Luňák } 520dcd4589aSLuboš Luňák } 521*5e79a001SLuboš Luňák bool consumed = string.consume_front(ANSI_ESC_START); 52214406ca0SLuboš Luňák assert(consumed); 52314406ca0SLuboš Luňák UNUSED_IF_ASSERT_DISABLED(consumed); 52414406ca0SLuboš Luňák // This is written to match our Highlighter classes, which seem to 52514406ca0SLuboš Luňák // generate only foreground color escape sequences. If necessary, this 52614406ca0SLuboš Luňák // will need to be extended. 52714406ca0SLuboš Luňák // Only 8 basic foreground colors and reset, our Highlighter doesn't use 52814406ca0SLuboš Luňák // anything else. 52914406ca0SLuboš Luňák int value; 53014406ca0SLuboš Luňák if (!!string.consumeInteger(10, value) || // Returns false on success. 531*5e79a001SLuboš Luňák !(value == 0 || 532*5e79a001SLuboš Luňák (value >= ANSI_FG_COLOR_BLACK && value <= ANSI_FG_COLOR_WHITE))) { 53314406ca0SLuboš Luňák llvm::errs() << "No valid color code in color escape sequence.\n"; 53414406ca0SLuboš Luňák continue; 53514406ca0SLuboš Luňák } 536*5e79a001SLuboš Luňák if (!string.consume_front(ANSI_ESC_END)) { 537*5e79a001SLuboš Luňák llvm::errs() << "Missing '" << ANSI_ESC_END 538*5e79a001SLuboš Luňák << "' in color escape sequence.\n"; 53914406ca0SLuboš Luňák continue; 54014406ca0SLuboš Luňák } 54114406ca0SLuboš Luňák if (value == 0) { // Reset. 5429dbdaea9SSterling Augustine wattr_set(m_window, saved_attr, saved_pair, nullptr); 54314406ca0SLuboš Luňák if (use_blue_background) 5444a8e4b5cSLuboš Luňák ::wattron(m_window, COLOR_PAIR(WhiteOnBlue)); 54514406ca0SLuboš Luňák } else { 54614406ca0SLuboš Luňák // Mapped directly to first 16 color pairs (black/blue background). 547*5e79a001SLuboš Luňák ::wattron(m_window, COLOR_PAIR(value - ANSI_FG_COLOR_BLACK + 1 + 548*5e79a001SLuboš Luňák (use_blue_background ? 8 : 0))); 54914406ca0SLuboš Luňák } 55014406ca0SLuboš Luňák } 5519dbdaea9SSterling Augustine wattr_set(m_window, saved_attr, saved_pair, nullptr); 552dcd4589aSLuboš Luňák return result; 55314406ca0SLuboš Luňák } 55414406ca0SLuboš Luňák 55529cc50e1SOmar Emara protected: 55679e950a2SOmar Emara Type m_type; 55728c878aeSShafik Yaghmour WINDOW *m_window = nullptr; 55829cc50e1SOmar Emara }; 55929cc50e1SOmar Emara 56029cc50e1SOmar Emara class Pad : public Surface { 56129cc50e1SOmar Emara public: 56279e950a2SOmar Emara Pad(Size size) : Surface(Surface::Type::Pad) { 56379e950a2SOmar Emara m_window = ::newpad(size.height, size.width); 56479e950a2SOmar Emara } 56529cc50e1SOmar Emara 56629cc50e1SOmar Emara ~Pad() { ::delwin(m_window); } 56729cc50e1SOmar Emara }; 56829cc50e1SOmar Emara 56929cc50e1SOmar Emara class Window : public Surface { 57029cc50e1SOmar Emara public: 57129cc50e1SOmar Emara Window(const char *name) 57279e950a2SOmar Emara : Surface(Surface::Type::Window), m_name(name), m_panel(nullptr), 57379e950a2SOmar Emara m_parent(nullptr), m_subwindows(), m_delegate_sp(), 57479e950a2SOmar Emara m_curr_active_window_idx(UINT32_MAX), 57529cc50e1SOmar Emara m_prev_active_window_idx(UINT32_MAX), m_delete(false), 57629cc50e1SOmar Emara m_needs_update(true), m_can_activate(true), m_is_subwin(false) {} 57729cc50e1SOmar Emara 57829cc50e1SOmar Emara Window(const char *name, WINDOW *w, bool del = true) 57979e950a2SOmar Emara : Surface(Surface::Type::Window), m_name(name), m_panel(nullptr), 58079e950a2SOmar Emara m_parent(nullptr), m_subwindows(), m_delegate_sp(), 58179e950a2SOmar Emara m_curr_active_window_idx(UINT32_MAX), 58229cc50e1SOmar Emara m_prev_active_window_idx(UINT32_MAX), m_delete(del), 58329cc50e1SOmar Emara m_needs_update(true), m_can_activate(true), m_is_subwin(false) { 58429cc50e1SOmar Emara if (w) 58529cc50e1SOmar Emara Reset(w); 58629cc50e1SOmar Emara } 58729cc50e1SOmar Emara 58829cc50e1SOmar Emara Window(const char *name, const Rect &bounds) 58979e950a2SOmar Emara : Surface(Surface::Type::Window), m_name(name), m_parent(nullptr), 59079e950a2SOmar Emara m_subwindows(), m_delegate_sp(), m_curr_active_window_idx(UINT32_MAX), 59129cc50e1SOmar Emara m_prev_active_window_idx(UINT32_MAX), m_delete(true), 59229cc50e1SOmar Emara m_needs_update(true), m_can_activate(true), m_is_subwin(false) { 59329cc50e1SOmar Emara Reset(::newwin(bounds.size.height, bounds.size.width, bounds.origin.y, 59429cc50e1SOmar Emara bounds.origin.y)); 59529cc50e1SOmar Emara } 59629cc50e1SOmar Emara 59729cc50e1SOmar Emara virtual ~Window() { 59829cc50e1SOmar Emara RemoveSubWindows(); 59929cc50e1SOmar Emara Reset(); 60029cc50e1SOmar Emara } 60129cc50e1SOmar Emara 60229cc50e1SOmar Emara void Reset(WINDOW *w = nullptr, bool del = true) { 60329cc50e1SOmar Emara if (m_window == w) 60429cc50e1SOmar Emara return; 60529cc50e1SOmar Emara 60629cc50e1SOmar Emara if (m_panel) { 60729cc50e1SOmar Emara ::del_panel(m_panel); 60829cc50e1SOmar Emara m_panel = nullptr; 60929cc50e1SOmar Emara } 61029cc50e1SOmar Emara if (m_window && m_delete) { 61129cc50e1SOmar Emara ::delwin(m_window); 61229cc50e1SOmar Emara m_window = nullptr; 61329cc50e1SOmar Emara m_delete = false; 61429cc50e1SOmar Emara } 61529cc50e1SOmar Emara if (w) { 61629cc50e1SOmar Emara m_window = w; 61729cc50e1SOmar Emara m_panel = ::new_panel(m_window); 61829cc50e1SOmar Emara m_delete = del; 61929cc50e1SOmar Emara } 62029cc50e1SOmar Emara } 6210321dbc8SOmar Emara 62229cc50e1SOmar Emara // Get the rectangle in our parent window 62329cc50e1SOmar Emara Rect GetBounds() const { return Rect(GetParentOrigin(), GetSize()); } 6240321dbc8SOmar Emara 6250321dbc8SOmar Emara Rect GetCenteredRect(int width, int height) { 6260321dbc8SOmar Emara Size size = GetSize(); 6270321dbc8SOmar Emara width = std::min(size.width, width); 6280321dbc8SOmar Emara height = std::min(size.height, height); 6290321dbc8SOmar Emara int x = (size.width - width) / 2; 6300321dbc8SOmar Emara int y = (size.height - height) / 2; 6310321dbc8SOmar Emara return Rect(Point(x, y), Size(width, height)); 6320321dbc8SOmar Emara } 6330321dbc8SOmar Emara 63429cc50e1SOmar Emara int GetChar() { return ::wgetch(m_window); } 63529cc50e1SOmar Emara Point GetParentOrigin() const { return Point(GetParentX(), GetParentY()); } 63629cc50e1SOmar Emara int GetParentX() const { return getparx(m_window); } 63729cc50e1SOmar Emara int GetParentY() const { return getpary(m_window); } 63829cc50e1SOmar Emara void MoveWindow(int x, int y) { MoveWindow(Point(x, y)); } 63929cc50e1SOmar Emara void Resize(int w, int h) { ::wresize(m_window, h, w); } 64029cc50e1SOmar Emara void Resize(const Size &size) { 64129cc50e1SOmar Emara ::wresize(m_window, size.height, size.width); 64229cc50e1SOmar Emara } 64329cc50e1SOmar Emara void MoveWindow(const Point &origin) { 64429cc50e1SOmar Emara const bool moving_window = origin != GetParentOrigin(); 64529cc50e1SOmar Emara if (m_is_subwin && moving_window) { 64629cc50e1SOmar Emara // Can't move subwindows, must delete and re-create 64729cc50e1SOmar Emara Size size = GetSize(); 64829cc50e1SOmar Emara Reset(::subwin(m_parent->m_window, size.height, size.width, origin.y, 64929cc50e1SOmar Emara origin.x), 65029cc50e1SOmar Emara true); 65129cc50e1SOmar Emara } else { 65229cc50e1SOmar Emara ::mvwin(m_window, origin.y, origin.x); 65329cc50e1SOmar Emara } 65429cc50e1SOmar Emara } 65529cc50e1SOmar Emara 65629cc50e1SOmar Emara void SetBounds(const Rect &bounds) { 65729cc50e1SOmar Emara const bool moving_window = bounds.origin != GetParentOrigin(); 65829cc50e1SOmar Emara if (m_is_subwin && moving_window) { 65929cc50e1SOmar Emara // Can't move subwindows, must delete and re-create 66029cc50e1SOmar Emara Reset(::subwin(m_parent->m_window, bounds.size.height, bounds.size.width, 66129cc50e1SOmar Emara bounds.origin.y, bounds.origin.x), 66229cc50e1SOmar Emara true); 66329cc50e1SOmar Emara } else { 66429cc50e1SOmar Emara if (moving_window) 66529cc50e1SOmar Emara MoveWindow(bounds.origin); 66629cc50e1SOmar Emara Resize(bounds.size); 66729cc50e1SOmar Emara } 66829cc50e1SOmar Emara } 66929cc50e1SOmar Emara 6707caa17caSRaphael Isemann void Touch() { 6717caa17caSRaphael Isemann ::touchwin(m_window); 6727caa17caSRaphael Isemann if (m_parent) 6737caa17caSRaphael Isemann m_parent->Touch(); 6747caa17caSRaphael Isemann } 6757caa17caSRaphael Isemann 6767caa17caSRaphael Isemann WindowSP CreateSubWindow(const char *name, const Rect &bounds, 6777caa17caSRaphael Isemann bool make_active) { 6787caa17caSRaphael Isemann auto get_window = [this, &bounds]() { 6797caa17caSRaphael Isemann return m_window 6807caa17caSRaphael Isemann ? ::subwin(m_window, bounds.size.height, bounds.size.width, 6817caa17caSRaphael Isemann bounds.origin.y, bounds.origin.x) 6827caa17caSRaphael Isemann : ::newwin(bounds.size.height, bounds.size.width, 6837caa17caSRaphael Isemann bounds.origin.y, bounds.origin.x); 6847caa17caSRaphael Isemann }; 6857caa17caSRaphael Isemann WindowSP subwindow_sp = std::make_shared<Window>(name, get_window(), true); 6867caa17caSRaphael Isemann subwindow_sp->m_is_subwin = subwindow_sp.operator bool(); 6877caa17caSRaphael Isemann subwindow_sp->m_parent = this; 6887caa17caSRaphael Isemann if (make_active) { 6897caa17caSRaphael Isemann m_prev_active_window_idx = m_curr_active_window_idx; 6907caa17caSRaphael Isemann m_curr_active_window_idx = m_subwindows.size(); 6917caa17caSRaphael Isemann } 6927caa17caSRaphael Isemann m_subwindows.push_back(subwindow_sp); 6937caa17caSRaphael Isemann ::top_panel(subwindow_sp->m_panel); 6947caa17caSRaphael Isemann m_needs_update = true; 6957caa17caSRaphael Isemann return subwindow_sp; 6967caa17caSRaphael Isemann } 6977caa17caSRaphael Isemann 6987caa17caSRaphael Isemann bool RemoveSubWindow(Window *window) { 6997caa17caSRaphael Isemann Windows::iterator pos, end = m_subwindows.end(); 7007caa17caSRaphael Isemann size_t i = 0; 7017caa17caSRaphael Isemann for (pos = m_subwindows.begin(); pos != end; ++pos, ++i) { 7027caa17caSRaphael Isemann if ((*pos).get() == window) { 7037caa17caSRaphael Isemann if (m_prev_active_window_idx == i) 7047caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 7057caa17caSRaphael Isemann else if (m_prev_active_window_idx != UINT32_MAX && 7067caa17caSRaphael Isemann m_prev_active_window_idx > i) 7077caa17caSRaphael Isemann --m_prev_active_window_idx; 7087caa17caSRaphael Isemann 7097caa17caSRaphael Isemann if (m_curr_active_window_idx == i) 7107caa17caSRaphael Isemann m_curr_active_window_idx = UINT32_MAX; 7117caa17caSRaphael Isemann else if (m_curr_active_window_idx != UINT32_MAX && 7127caa17caSRaphael Isemann m_curr_active_window_idx > i) 7137caa17caSRaphael Isemann --m_curr_active_window_idx; 7147caa17caSRaphael Isemann window->Erase(); 7157caa17caSRaphael Isemann m_subwindows.erase(pos); 7167caa17caSRaphael Isemann m_needs_update = true; 7177caa17caSRaphael Isemann if (m_parent) 7187caa17caSRaphael Isemann m_parent->Touch(); 7197caa17caSRaphael Isemann else 7207caa17caSRaphael Isemann ::touchwin(stdscr); 7217caa17caSRaphael Isemann return true; 7227caa17caSRaphael Isemann } 7237caa17caSRaphael Isemann } 7247caa17caSRaphael Isemann return false; 7257caa17caSRaphael Isemann } 7267caa17caSRaphael Isemann 7277caa17caSRaphael Isemann WindowSP FindSubWindow(const char *name) { 7287caa17caSRaphael Isemann Windows::iterator pos, end = m_subwindows.end(); 7297caa17caSRaphael Isemann size_t i = 0; 7307caa17caSRaphael Isemann for (pos = m_subwindows.begin(); pos != end; ++pos, ++i) { 7317caa17caSRaphael Isemann if ((*pos)->m_name == name) 7327caa17caSRaphael Isemann return *pos; 7337caa17caSRaphael Isemann } 7347caa17caSRaphael Isemann return WindowSP(); 7357caa17caSRaphael Isemann } 7367caa17caSRaphael Isemann 7377caa17caSRaphael Isemann void RemoveSubWindows() { 7387caa17caSRaphael Isemann m_curr_active_window_idx = UINT32_MAX; 7397caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 7407caa17caSRaphael Isemann for (Windows::iterator pos = m_subwindows.begin(); 7417caa17caSRaphael Isemann pos != m_subwindows.end(); pos = m_subwindows.erase(pos)) { 7427caa17caSRaphael Isemann (*pos)->Erase(); 7437caa17caSRaphael Isemann } 7447caa17caSRaphael Isemann if (m_parent) 7457caa17caSRaphael Isemann m_parent->Touch(); 7467caa17caSRaphael Isemann else 7477caa17caSRaphael Isemann ::touchwin(stdscr); 7487caa17caSRaphael Isemann } 7497caa17caSRaphael Isemann 7507caa17caSRaphael Isemann // Window drawing utilities 7517caa17caSRaphael Isemann void DrawTitleBox(const char *title, const char *bottom_message = nullptr) { 7527caa17caSRaphael Isemann attr_t attr = 0; 7537caa17caSRaphael Isemann if (IsActive()) 7544a8e4b5cSLuboš Luňák attr = A_BOLD | COLOR_PAIR(BlackOnWhite); 7557caa17caSRaphael Isemann else 7567caa17caSRaphael Isemann attr = 0; 7577caa17caSRaphael Isemann if (attr) 7587caa17caSRaphael Isemann AttributeOn(attr); 7597caa17caSRaphael Isemann 7607caa17caSRaphael Isemann Box(); 7617caa17caSRaphael Isemann MoveCursor(3, 0); 7627caa17caSRaphael Isemann 7637caa17caSRaphael Isemann if (title && title[0]) { 7647caa17caSRaphael Isemann PutChar('<'); 7657caa17caSRaphael Isemann PutCString(title); 7667caa17caSRaphael Isemann PutChar('>'); 7677caa17caSRaphael Isemann } 7687caa17caSRaphael Isemann 7697caa17caSRaphael Isemann if (bottom_message && bottom_message[0]) { 7707caa17caSRaphael Isemann int bottom_message_length = strlen(bottom_message); 7717caa17caSRaphael Isemann int x = GetWidth() - 3 - (bottom_message_length + 2); 7727caa17caSRaphael Isemann 7737caa17caSRaphael Isemann if (x > 0) { 7747caa17caSRaphael Isemann MoveCursor(x, GetHeight() - 1); 7757caa17caSRaphael Isemann PutChar('['); 7767caa17caSRaphael Isemann PutCString(bottom_message); 7777caa17caSRaphael Isemann PutChar(']'); 7787caa17caSRaphael Isemann } else { 7797caa17caSRaphael Isemann MoveCursor(1, GetHeight() - 1); 7807caa17caSRaphael Isemann PutChar('['); 781fc0e8fb7SLuboš Luňák PutCStringTruncated(1, bottom_message); 7827caa17caSRaphael Isemann } 7837caa17caSRaphael Isemann } 7847caa17caSRaphael Isemann if (attr) 7857caa17caSRaphael Isemann AttributeOff(attr); 7867caa17caSRaphael Isemann } 7877caa17caSRaphael Isemann 7887caa17caSRaphael Isemann virtual void Draw(bool force) { 7897caa17caSRaphael Isemann if (m_delegate_sp && m_delegate_sp->WindowDelegateDraw(*this, force)) 7907caa17caSRaphael Isemann return; 7917caa17caSRaphael Isemann 7927caa17caSRaphael Isemann for (auto &subwindow_sp : m_subwindows) 7937caa17caSRaphael Isemann subwindow_sp->Draw(force); 7947caa17caSRaphael Isemann } 7957caa17caSRaphael Isemann 7967caa17caSRaphael Isemann bool CreateHelpSubwindow() { 7977caa17caSRaphael Isemann if (m_delegate_sp) { 7987caa17caSRaphael Isemann const char *text = m_delegate_sp->WindowDelegateGetHelpText(); 7997caa17caSRaphael Isemann KeyHelp *key_help = m_delegate_sp->WindowDelegateGetKeyHelp(); 8007caa17caSRaphael Isemann if ((text && text[0]) || key_help) { 8017caa17caSRaphael Isemann std::unique_ptr<HelpDialogDelegate> help_delegate_up( 8027caa17caSRaphael Isemann new HelpDialogDelegate(text, key_help)); 8037caa17caSRaphael Isemann const size_t num_lines = help_delegate_up->GetNumLines(); 8047caa17caSRaphael Isemann const size_t max_length = help_delegate_up->GetMaxLineLength(); 8057caa17caSRaphael Isemann Rect bounds = GetBounds(); 8067caa17caSRaphael Isemann bounds.Inset(1, 1); 8077caa17caSRaphael Isemann if (max_length + 4 < static_cast<size_t>(bounds.size.width)) { 8087caa17caSRaphael Isemann bounds.origin.x += (bounds.size.width - max_length + 4) / 2; 8097caa17caSRaphael Isemann bounds.size.width = max_length + 4; 8107caa17caSRaphael Isemann } else { 8117caa17caSRaphael Isemann if (bounds.size.width > 100) { 8127caa17caSRaphael Isemann const int inset_w = bounds.size.width / 4; 8137caa17caSRaphael Isemann bounds.origin.x += inset_w; 8147caa17caSRaphael Isemann bounds.size.width -= 2 * inset_w; 8157caa17caSRaphael Isemann } 8167caa17caSRaphael Isemann } 8177caa17caSRaphael Isemann 8187caa17caSRaphael Isemann if (num_lines + 2 < static_cast<size_t>(bounds.size.height)) { 8197caa17caSRaphael Isemann bounds.origin.y += (bounds.size.height - num_lines + 2) / 2; 8207caa17caSRaphael Isemann bounds.size.height = num_lines + 2; 8217caa17caSRaphael Isemann } else { 8227caa17caSRaphael Isemann if (bounds.size.height > 100) { 8237caa17caSRaphael Isemann const int inset_h = bounds.size.height / 4; 8247caa17caSRaphael Isemann bounds.origin.y += inset_h; 8257caa17caSRaphael Isemann bounds.size.height -= 2 * inset_h; 8267caa17caSRaphael Isemann } 8277caa17caSRaphael Isemann } 8287caa17caSRaphael Isemann WindowSP help_window_sp; 8297caa17caSRaphael Isemann Window *parent_window = GetParent(); 8307caa17caSRaphael Isemann if (parent_window) 8317caa17caSRaphael Isemann help_window_sp = parent_window->CreateSubWindow("Help", bounds, true); 8327caa17caSRaphael Isemann else 8337caa17caSRaphael Isemann help_window_sp = CreateSubWindow("Help", bounds, true); 8347caa17caSRaphael Isemann help_window_sp->SetDelegate( 8357caa17caSRaphael Isemann WindowDelegateSP(help_delegate_up.release())); 8367caa17caSRaphael Isemann return true; 8377caa17caSRaphael Isemann } 8387caa17caSRaphael Isemann } 8397caa17caSRaphael Isemann return false; 8407caa17caSRaphael Isemann } 8417caa17caSRaphael Isemann 8427caa17caSRaphael Isemann virtual HandleCharResult HandleChar(int key) { 8437caa17caSRaphael Isemann // Always check the active window first 8447caa17caSRaphael Isemann HandleCharResult result = eKeyNotHandled; 8457caa17caSRaphael Isemann WindowSP active_window_sp = GetActiveWindow(); 8467caa17caSRaphael Isemann if (active_window_sp) { 8477caa17caSRaphael Isemann result = active_window_sp->HandleChar(key); 8487caa17caSRaphael Isemann if (result != eKeyNotHandled) 8497caa17caSRaphael Isemann return result; 8507caa17caSRaphael Isemann } 8517caa17caSRaphael Isemann 8527caa17caSRaphael Isemann if (m_delegate_sp) { 8537caa17caSRaphael Isemann result = m_delegate_sp->WindowDelegateHandleChar(*this, key); 8547caa17caSRaphael Isemann if (result != eKeyNotHandled) 8557caa17caSRaphael Isemann return result; 8567caa17caSRaphael Isemann } 8577caa17caSRaphael Isemann 8587caa17caSRaphael Isemann // Then check for any windows that want any keys that weren't handled. This 8597caa17caSRaphael Isemann // is typically only for a menubar. Make a copy of the subwindows in case 8607caa17caSRaphael Isemann // any HandleChar() functions muck with the subwindows. If we don't do 8617caa17caSRaphael Isemann // this, we can crash when iterating over the subwindows. 8627caa17caSRaphael Isemann Windows subwindows(m_subwindows); 8637caa17caSRaphael Isemann for (auto subwindow_sp : subwindows) { 8647caa17caSRaphael Isemann if (!subwindow_sp->m_can_activate) { 8657caa17caSRaphael Isemann HandleCharResult result = subwindow_sp->HandleChar(key); 8667caa17caSRaphael Isemann if (result != eKeyNotHandled) 8677caa17caSRaphael Isemann return result; 8687caa17caSRaphael Isemann } 8697caa17caSRaphael Isemann } 8707caa17caSRaphael Isemann 8717caa17caSRaphael Isemann return eKeyNotHandled; 8727caa17caSRaphael Isemann } 8737caa17caSRaphael Isemann 8747caa17caSRaphael Isemann WindowSP GetActiveWindow() { 8757caa17caSRaphael Isemann if (!m_subwindows.empty()) { 8767caa17caSRaphael Isemann if (m_curr_active_window_idx >= m_subwindows.size()) { 8777caa17caSRaphael Isemann if (m_prev_active_window_idx < m_subwindows.size()) { 8787caa17caSRaphael Isemann m_curr_active_window_idx = m_prev_active_window_idx; 8797caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 8807caa17caSRaphael Isemann } else if (IsActive()) { 8817caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 8827caa17caSRaphael Isemann m_curr_active_window_idx = UINT32_MAX; 8837caa17caSRaphael Isemann 8847caa17caSRaphael Isemann // Find first window that wants to be active if this window is active 8857caa17caSRaphael Isemann const size_t num_subwindows = m_subwindows.size(); 8867caa17caSRaphael Isemann for (size_t i = 0; i < num_subwindows; ++i) { 8877caa17caSRaphael Isemann if (m_subwindows[i]->GetCanBeActive()) { 8887caa17caSRaphael Isemann m_curr_active_window_idx = i; 8897caa17caSRaphael Isemann break; 8907caa17caSRaphael Isemann } 8917caa17caSRaphael Isemann } 8927caa17caSRaphael Isemann } 8937caa17caSRaphael Isemann } 8947caa17caSRaphael Isemann 8957caa17caSRaphael Isemann if (m_curr_active_window_idx < m_subwindows.size()) 8967caa17caSRaphael Isemann return m_subwindows[m_curr_active_window_idx]; 8977caa17caSRaphael Isemann } 8987caa17caSRaphael Isemann return WindowSP(); 8997caa17caSRaphael Isemann } 9007caa17caSRaphael Isemann 9017caa17caSRaphael Isemann bool GetCanBeActive() const { return m_can_activate; } 9027caa17caSRaphael Isemann 9037caa17caSRaphael Isemann void SetCanBeActive(bool b) { m_can_activate = b; } 9047caa17caSRaphael Isemann 9057caa17caSRaphael Isemann void SetDelegate(const WindowDelegateSP &delegate_sp) { 9067caa17caSRaphael Isemann m_delegate_sp = delegate_sp; 9077caa17caSRaphael Isemann } 9087caa17caSRaphael Isemann 9097caa17caSRaphael Isemann Window *GetParent() const { return m_parent; } 9107caa17caSRaphael Isemann 9117caa17caSRaphael Isemann bool IsActive() const { 9127caa17caSRaphael Isemann if (m_parent) 9137caa17caSRaphael Isemann return m_parent->GetActiveWindow().get() == this; 9147caa17caSRaphael Isemann else 9157caa17caSRaphael Isemann return true; // Top level window is always active 9167caa17caSRaphael Isemann } 9177caa17caSRaphael Isemann 9187caa17caSRaphael Isemann void SelectNextWindowAsActive() { 9197caa17caSRaphael Isemann // Move active focus to next window 9207a63dc53SLuboš Luňák const int num_subwindows = m_subwindows.size(); 9217a63dc53SLuboš Luňák int start_idx = 0; 9227a63dc53SLuboš Luňák if (m_curr_active_window_idx != UINT32_MAX) { 9237caa17caSRaphael Isemann m_prev_active_window_idx = m_curr_active_window_idx; 9247a63dc53SLuboš Luňák start_idx = m_curr_active_window_idx + 1; 9257a63dc53SLuboš Luňák } 9267a63dc53SLuboš Luňák for (int idx = start_idx; idx < num_subwindows; ++idx) { 9277caa17caSRaphael Isemann if (m_subwindows[idx]->GetCanBeActive()) { 9287caa17caSRaphael Isemann m_curr_active_window_idx = idx; 9297a63dc53SLuboš Luňák return; 9307caa17caSRaphael Isemann } 9317caa17caSRaphael Isemann } 9327a63dc53SLuboš Luňák for (int idx = 0; idx < start_idx; ++idx) { 9337caa17caSRaphael Isemann if (m_subwindows[idx]->GetCanBeActive()) { 9347caa17caSRaphael Isemann m_curr_active_window_idx = idx; 9357caa17caSRaphael Isemann break; 9367caa17caSRaphael Isemann } 9377caa17caSRaphael Isemann } 9387caa17caSRaphael Isemann } 9397a63dc53SLuboš Luňák 9407a63dc53SLuboš Luňák void SelectPreviousWindowAsActive() { 9417a63dc53SLuboš Luňák // Move active focus to previous window 9427a63dc53SLuboš Luňák const int num_subwindows = m_subwindows.size(); 9437a63dc53SLuboš Luňák int start_idx = num_subwindows - 1; 9447a63dc53SLuboš Luňák if (m_curr_active_window_idx != UINT32_MAX) { 9457caa17caSRaphael Isemann m_prev_active_window_idx = m_curr_active_window_idx; 9467a63dc53SLuboš Luňák start_idx = m_curr_active_window_idx - 1; 9477a63dc53SLuboš Luňák } 9487a63dc53SLuboš Luňák for (int idx = start_idx; idx >= 0; --idx) { 9497a63dc53SLuboš Luňák if (m_subwindows[idx]->GetCanBeActive()) { 9507a63dc53SLuboš Luňák m_curr_active_window_idx = idx; 9517a63dc53SLuboš Luňák return; 9527a63dc53SLuboš Luňák } 9537a63dc53SLuboš Luňák } 9547a63dc53SLuboš Luňák for (int idx = num_subwindows - 1; idx > start_idx; --idx) { 9557caa17caSRaphael Isemann if (m_subwindows[idx]->GetCanBeActive()) { 9567caa17caSRaphael Isemann m_curr_active_window_idx = idx; 9577caa17caSRaphael Isemann break; 9587caa17caSRaphael Isemann } 9597caa17caSRaphael Isemann } 9607caa17caSRaphael Isemann } 9617caa17caSRaphael Isemann 9627caa17caSRaphael Isemann const char *GetName() const { return m_name.c_str(); } 9637caa17caSRaphael Isemann 9647caa17caSRaphael Isemann protected: 9657caa17caSRaphael Isemann std::string m_name; 9667caa17caSRaphael Isemann PANEL *m_panel; 9677caa17caSRaphael Isemann Window *m_parent; 9687caa17caSRaphael Isemann Windows m_subwindows; 9697caa17caSRaphael Isemann WindowDelegateSP m_delegate_sp; 9707caa17caSRaphael Isemann uint32_t m_curr_active_window_idx; 9717caa17caSRaphael Isemann uint32_t m_prev_active_window_idx; 9727caa17caSRaphael Isemann bool m_delete; 9737caa17caSRaphael Isemann bool m_needs_update; 9747caa17caSRaphael Isemann bool m_can_activate; 9757caa17caSRaphael Isemann bool m_is_subwin; 9767caa17caSRaphael Isemann 9777caa17caSRaphael Isemann private: 978eaebcbc6SKonrad Kleine Window(const Window &) = delete; 979eaebcbc6SKonrad Kleine const Window &operator=(const Window &) = delete; 9807caa17caSRaphael Isemann }; 9817caa17caSRaphael Isemann 98229cc50e1SOmar Emara ///////// 98329cc50e1SOmar Emara // Forms 98429cc50e1SOmar Emara ///////// 98529cc50e1SOmar Emara 98629cc50e1SOmar Emara // A scroll context defines a vertical region that needs to be visible in a 98729cc50e1SOmar Emara // scrolling area. The region is defined by the index of the start and end lines 98829cc50e1SOmar Emara // of the region. The start and end lines may be equal, in which case, the 98929cc50e1SOmar Emara // region is a single line. 99029cc50e1SOmar Emara struct ScrollContext { 99129cc50e1SOmar Emara int start; 99229cc50e1SOmar Emara int end; 99329cc50e1SOmar Emara 99429cc50e1SOmar Emara ScrollContext(int line) : start(line), end(line) {} 99529cc50e1SOmar Emara ScrollContext(int _start, int _end) : start(_start), end(_end) {} 99629cc50e1SOmar Emara 99729cc50e1SOmar Emara void Offset(int offset) { 99829cc50e1SOmar Emara start += offset; 99929cc50e1SOmar Emara end += offset; 100029cc50e1SOmar Emara } 100129cc50e1SOmar Emara }; 100229cc50e1SOmar Emara 100329cc50e1SOmar Emara class FieldDelegate { 100429cc50e1SOmar Emara public: 100529cc50e1SOmar Emara virtual ~FieldDelegate() = default; 100629cc50e1SOmar Emara 100729cc50e1SOmar Emara // Returns the number of lines needed to draw the field. The draw method will 100829cc50e1SOmar Emara // be given a surface that have exactly this number of lines. 100929cc50e1SOmar Emara virtual int FieldDelegateGetHeight() = 0; 101029cc50e1SOmar Emara 101129cc50e1SOmar Emara // Returns the scroll context in the local coordinates of the field. By 101229cc50e1SOmar Emara // default, the scroll context spans the whole field. Bigger fields with 101329cc50e1SOmar Emara // internal navigation should override this method to provide a finer context. 101429cc50e1SOmar Emara // Typical override methods would first get the scroll context of the internal 101529cc50e1SOmar Emara // element then add the offset of the element in the field. 101629cc50e1SOmar Emara virtual ScrollContext FieldDelegateGetScrollContext() { 101729cc50e1SOmar Emara return ScrollContext(0, FieldDelegateGetHeight() - 1); 101829cc50e1SOmar Emara } 101929cc50e1SOmar Emara 102029cc50e1SOmar Emara // Draw the field in the given subpad surface. The surface have a height that 102129cc50e1SOmar Emara // is equal to the height returned by FieldDelegateGetHeight(). If the field 102229cc50e1SOmar Emara // is selected in the form window, then is_selected will be true. 102379e950a2SOmar Emara virtual void FieldDelegateDraw(Surface &surface, bool is_selected) = 0; 102429cc50e1SOmar Emara 102529cc50e1SOmar Emara // Handle the key that wasn't handled by the form window or a container field. 102629cc50e1SOmar Emara virtual HandleCharResult FieldDelegateHandleChar(int key) { 102729cc50e1SOmar Emara return eKeyNotHandled; 102829cc50e1SOmar Emara } 102929cc50e1SOmar Emara 103029cc50e1SOmar Emara // This is executed once the user exists the field, that is, once the user 103129cc50e1SOmar Emara // navigates to the next or the previous field. This is particularly useful to 103229cc50e1SOmar Emara // do in-field validation and error setting. Fields with internal navigation 103329cc50e1SOmar Emara // should call this method on their fields. 10342d303e67SKazu Hirata virtual void FieldDelegateExitCallback() {} 103529cc50e1SOmar Emara 103629cc50e1SOmar Emara // Fields may have internal navigation, for instance, a List Field have 103729cc50e1SOmar Emara // multiple internal elements, which needs to be navigated. To allow for this 103829cc50e1SOmar Emara // mechanism, the window shouldn't handle the navigation keys all the time, 103929cc50e1SOmar Emara // and instead call the key handing method of the selected field. It should 104029cc50e1SOmar Emara // only handle the navigation keys when the field contains a single element or 104129cc50e1SOmar Emara // have the last or first element selected depending on if the user is 104229cc50e1SOmar Emara // navigating forward or backward. Additionally, once a field is selected in 104329cc50e1SOmar Emara // the forward or backward direction, its first or last internal element 104429cc50e1SOmar Emara // should be selected. The following methods implements those mechanisms. 104529cc50e1SOmar Emara 104629cc50e1SOmar Emara // Returns true if the first element in the field is selected or if the field 104729cc50e1SOmar Emara // contains a single element. 104829cc50e1SOmar Emara virtual bool FieldDelegateOnFirstOrOnlyElement() { return true; } 104929cc50e1SOmar Emara 105029cc50e1SOmar Emara // Returns true if the last element in the field is selected or if the field 105129cc50e1SOmar Emara // contains a single element. 105229cc50e1SOmar Emara virtual bool FieldDelegateOnLastOrOnlyElement() { return true; } 105329cc50e1SOmar Emara 105429cc50e1SOmar Emara // Select the first element in the field if multiple elements exists. 10552d303e67SKazu Hirata virtual void FieldDelegateSelectFirstElement() {} 105629cc50e1SOmar Emara 105729cc50e1SOmar Emara // Select the last element in the field if multiple elements exists. 10582d303e67SKazu Hirata virtual void FieldDelegateSelectLastElement() {} 10590321dbc8SOmar Emara 106080ac12b7SOmar Emara // Returns true if the field has an error, false otherwise. 106180ac12b7SOmar Emara virtual bool FieldDelegateHasError() { return false; } 106280ac12b7SOmar Emara 10630321dbc8SOmar Emara bool FieldDelegateIsVisible() { return m_is_visible; } 10640321dbc8SOmar Emara 10650321dbc8SOmar Emara void FieldDelegateHide() { m_is_visible = false; } 10660321dbc8SOmar Emara 10670321dbc8SOmar Emara void FieldDelegateShow() { m_is_visible = true; } 10680321dbc8SOmar Emara 10690321dbc8SOmar Emara protected: 10700321dbc8SOmar Emara bool m_is_visible = true; 107129cc50e1SOmar Emara }; 107229cc50e1SOmar Emara 10730321dbc8SOmar Emara typedef std::unique_ptr<FieldDelegate> FieldDelegateUP; 107429cc50e1SOmar Emara 107529cc50e1SOmar Emara class TextFieldDelegate : public FieldDelegate { 107629cc50e1SOmar Emara public: 10779ef7de7cSOmar Emara TextFieldDelegate(const char *label, const char *content, bool required) 107828c878aeSShafik Yaghmour : m_label(label), m_required(required) { 107929cc50e1SOmar Emara if (content) 108029cc50e1SOmar Emara m_content = content; 108129cc50e1SOmar Emara } 108229cc50e1SOmar Emara 108329cc50e1SOmar Emara // Text fields are drawn as titled boxes of a single line, with a possible 108429cc50e1SOmar Emara // error messages at the end. 108529cc50e1SOmar Emara // 108629cc50e1SOmar Emara // __[Label]___________ 108729cc50e1SOmar Emara // | | 108829cc50e1SOmar Emara // |__________________| 108929cc50e1SOmar Emara // - Error message if it exists. 109029cc50e1SOmar Emara 109129cc50e1SOmar Emara // The text field has a height of 3 lines. 2 lines for borders and 1 line for 109229cc50e1SOmar Emara // the content. 109329cc50e1SOmar Emara int GetFieldHeight() { return 3; } 109429cc50e1SOmar Emara 109529cc50e1SOmar Emara // The text field has a full height of 3 or 4 lines. 3 lines for the actual 109629cc50e1SOmar Emara // field and an optional line for an error if it exists. 109729cc50e1SOmar Emara int FieldDelegateGetHeight() override { 109829cc50e1SOmar Emara int height = GetFieldHeight(); 109980ac12b7SOmar Emara if (FieldDelegateHasError()) 110029cc50e1SOmar Emara height++; 110129cc50e1SOmar Emara return height; 110229cc50e1SOmar Emara } 110329cc50e1SOmar Emara 110429cc50e1SOmar Emara // Get the cursor X position in the surface coordinate. 110529cc50e1SOmar Emara int GetCursorXPosition() { return m_cursor_position - m_first_visibile_char; } 110629cc50e1SOmar Emara 110729cc50e1SOmar Emara int GetContentLength() { return m_content.length(); } 110829cc50e1SOmar Emara 110979e950a2SOmar Emara void DrawContent(Surface &surface, bool is_selected) { 1110d95d2a8eSOmar Emara UpdateScrolling(surface.GetWidth()); 1111d95d2a8eSOmar Emara 111229cc50e1SOmar Emara surface.MoveCursor(0, 0); 111329cc50e1SOmar Emara const char *text = m_content.c_str() + m_first_visibile_char; 111429cc50e1SOmar Emara surface.PutCString(text, surface.GetWidth()); 111529cc50e1SOmar Emara 111629cc50e1SOmar Emara // Highlight the cursor. 111729cc50e1SOmar Emara surface.MoveCursor(GetCursorXPosition(), 0); 111829cc50e1SOmar Emara if (is_selected) 111929cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 112029cc50e1SOmar Emara if (m_cursor_position == GetContentLength()) 112129cc50e1SOmar Emara // Cursor is past the last character. Highlight an empty space. 112229cc50e1SOmar Emara surface.PutChar(' '); 112329cc50e1SOmar Emara else 112429cc50e1SOmar Emara surface.PutChar(m_content[m_cursor_position]); 112529cc50e1SOmar Emara if (is_selected) 112629cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 112729cc50e1SOmar Emara } 112829cc50e1SOmar Emara 112979e950a2SOmar Emara void DrawField(Surface &surface, bool is_selected) { 113029cc50e1SOmar Emara surface.TitledBox(m_label.c_str()); 113129cc50e1SOmar Emara 113229cc50e1SOmar Emara Rect content_bounds = surface.GetFrame(); 113329cc50e1SOmar Emara content_bounds.Inset(1, 1); 113479e950a2SOmar Emara Surface content_surface = surface.SubSurface(content_bounds); 113529cc50e1SOmar Emara 113629cc50e1SOmar Emara DrawContent(content_surface, is_selected); 113729cc50e1SOmar Emara } 113829cc50e1SOmar Emara 113979e950a2SOmar Emara void DrawError(Surface &surface) { 114080ac12b7SOmar Emara if (!FieldDelegateHasError()) 114129cc50e1SOmar Emara return; 114229cc50e1SOmar Emara surface.MoveCursor(0, 0); 114329cc50e1SOmar Emara surface.AttributeOn(COLOR_PAIR(RedOnBlack)); 114429cc50e1SOmar Emara surface.PutChar(ACS_DIAMOND); 114529cc50e1SOmar Emara surface.PutChar(' '); 114629cc50e1SOmar Emara surface.PutCStringTruncated(1, GetError().c_str()); 114729cc50e1SOmar Emara surface.AttributeOff(COLOR_PAIR(RedOnBlack)); 114829cc50e1SOmar Emara } 114929cc50e1SOmar Emara 115079e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 115129cc50e1SOmar Emara Rect frame = surface.GetFrame(); 115229cc50e1SOmar Emara Rect field_bounds, error_bounds; 115329cc50e1SOmar Emara frame.HorizontalSplit(GetFieldHeight(), field_bounds, error_bounds); 115479e950a2SOmar Emara Surface field_surface = surface.SubSurface(field_bounds); 115579e950a2SOmar Emara Surface error_surface = surface.SubSurface(error_bounds); 115629cc50e1SOmar Emara 115729cc50e1SOmar Emara DrawField(field_surface, is_selected); 115829cc50e1SOmar Emara DrawError(error_surface); 115929cc50e1SOmar Emara } 116029cc50e1SOmar Emara 1161d95d2a8eSOmar Emara // Get the position of the last visible character. 1162d95d2a8eSOmar Emara int GetLastVisibleCharPosition(int width) { 1163d95d2a8eSOmar Emara int position = m_first_visibile_char + width - 1; 1164d95d2a8eSOmar Emara return std::min(position, GetContentLength()); 1165d95d2a8eSOmar Emara } 1166d95d2a8eSOmar Emara 1167d95d2a8eSOmar Emara void UpdateScrolling(int width) { 1168d95d2a8eSOmar Emara if (m_cursor_position < m_first_visibile_char) { 1169d95d2a8eSOmar Emara m_first_visibile_char = m_cursor_position; 1170d95d2a8eSOmar Emara return; 1171d95d2a8eSOmar Emara } 1172d95d2a8eSOmar Emara 1173d95d2a8eSOmar Emara if (m_cursor_position > GetLastVisibleCharPosition(width)) 1174d95d2a8eSOmar Emara m_first_visibile_char = m_cursor_position - (width - 1); 1175d95d2a8eSOmar Emara } 1176d95d2a8eSOmar Emara 117729cc50e1SOmar Emara // The cursor is allowed to move one character past the string. 117829cc50e1SOmar Emara // m_cursor_position is in range [0, GetContentLength()]. 117929cc50e1SOmar Emara void MoveCursorRight() { 118029cc50e1SOmar Emara if (m_cursor_position < GetContentLength()) 118129cc50e1SOmar Emara m_cursor_position++; 118229cc50e1SOmar Emara } 118329cc50e1SOmar Emara 118429cc50e1SOmar Emara void MoveCursorLeft() { 118529cc50e1SOmar Emara if (m_cursor_position > 0) 118629cc50e1SOmar Emara m_cursor_position--; 118729cc50e1SOmar Emara } 118829cc50e1SOmar Emara 1189d95d2a8eSOmar Emara void MoveCursorToStart() { m_cursor_position = 0; } 1190d95d2a8eSOmar Emara 1191d95d2a8eSOmar Emara void MoveCursorToEnd() { m_cursor_position = GetContentLength(); } 119229cc50e1SOmar Emara 119329cc50e1SOmar Emara void ScrollLeft() { 119429cc50e1SOmar Emara if (m_first_visibile_char > 0) 119529cc50e1SOmar Emara m_first_visibile_char--; 119629cc50e1SOmar Emara } 119729cc50e1SOmar Emara 1198d95d2a8eSOmar Emara // Insert a character at the current cursor position and advance the cursor 1199d95d2a8eSOmar Emara // position. 120029cc50e1SOmar Emara void InsertChar(char character) { 120129cc50e1SOmar Emara m_content.insert(m_cursor_position, 1, character); 120229cc50e1SOmar Emara m_cursor_position++; 1203d95d2a8eSOmar Emara ClearError(); 120429cc50e1SOmar Emara } 120529cc50e1SOmar Emara 120629cc50e1SOmar Emara // Remove the character before the cursor position, retreat the cursor 1207d95d2a8eSOmar Emara // position, and scroll left. 1208d95d2a8eSOmar Emara void RemovePreviousChar() { 120929cc50e1SOmar Emara if (m_cursor_position == 0) 121029cc50e1SOmar Emara return; 121129cc50e1SOmar Emara 121229cc50e1SOmar Emara m_content.erase(m_cursor_position - 1, 1); 121329cc50e1SOmar Emara m_cursor_position--; 121429cc50e1SOmar Emara ScrollLeft(); 1215d95d2a8eSOmar Emara ClearError(); 1216d95d2a8eSOmar Emara } 1217d95d2a8eSOmar Emara 1218d95d2a8eSOmar Emara // Remove the character after the cursor position. 1219d95d2a8eSOmar Emara void RemoveNextChar() { 1220d95d2a8eSOmar Emara if (m_cursor_position == GetContentLength()) 1221d95d2a8eSOmar Emara return; 1222d95d2a8eSOmar Emara 1223d95d2a8eSOmar Emara m_content.erase(m_cursor_position, 1); 1224d95d2a8eSOmar Emara ClearError(); 1225d95d2a8eSOmar Emara } 1226d95d2a8eSOmar Emara 1227d95d2a8eSOmar Emara // Clear characters from the current cursor position to the end. 1228d95d2a8eSOmar Emara void ClearToEnd() { 1229d95d2a8eSOmar Emara m_content.erase(m_cursor_position); 1230d95d2a8eSOmar Emara ClearError(); 1231d95d2a8eSOmar Emara } 1232d95d2a8eSOmar Emara 1233d95d2a8eSOmar Emara void Clear() { 1234d95d2a8eSOmar Emara m_content.clear(); 1235d95d2a8eSOmar Emara m_cursor_position = 0; 1236d95d2a8eSOmar Emara ClearError(); 123729cc50e1SOmar Emara } 123829cc50e1SOmar Emara 123929cc50e1SOmar Emara // True if the key represents a char that can be inserted in the field 124029cc50e1SOmar Emara // content, false otherwise. 1241698e2106SOmar Emara virtual bool IsAcceptableChar(int key) { 1242698e2106SOmar Emara // The behavior of isprint is undefined when the value is not representable 1243698e2106SOmar Emara // as an unsigned char. So explicitly check for non-ascii key codes. 1244698e2106SOmar Emara if (key > 127) 1245698e2106SOmar Emara return false; 1246698e2106SOmar Emara return isprint(key); 1247698e2106SOmar Emara } 124829cc50e1SOmar Emara 124929cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 125029cc50e1SOmar Emara if (IsAcceptableChar(key)) { 125129cc50e1SOmar Emara ClearError(); 125229cc50e1SOmar Emara InsertChar((char)key); 125329cc50e1SOmar Emara return eKeyHandled; 125429cc50e1SOmar Emara } 125529cc50e1SOmar Emara 125629cc50e1SOmar Emara switch (key) { 1257d95d2a8eSOmar Emara case KEY_HOME: 1258d95d2a8eSOmar Emara case KEY_CTRL_A: 1259d95d2a8eSOmar Emara MoveCursorToStart(); 1260d95d2a8eSOmar Emara return eKeyHandled; 1261d95d2a8eSOmar Emara case KEY_END: 1262d95d2a8eSOmar Emara case KEY_CTRL_E: 1263d95d2a8eSOmar Emara MoveCursorToEnd(); 1264d95d2a8eSOmar Emara return eKeyHandled; 126529cc50e1SOmar Emara case KEY_RIGHT: 1266d95d2a8eSOmar Emara case KEY_SF: 126729cc50e1SOmar Emara MoveCursorRight(); 126829cc50e1SOmar Emara return eKeyHandled; 126929cc50e1SOmar Emara case KEY_LEFT: 1270d95d2a8eSOmar Emara case KEY_SR: 127129cc50e1SOmar Emara MoveCursorLeft(); 127229cc50e1SOmar Emara return eKeyHandled; 127329cc50e1SOmar Emara case KEY_BACKSPACE: 1274d95d2a8eSOmar Emara case KEY_DELETE: 1275d95d2a8eSOmar Emara RemovePreviousChar(); 1276d95d2a8eSOmar Emara return eKeyHandled; 1277d95d2a8eSOmar Emara case KEY_DC: 1278d95d2a8eSOmar Emara RemoveNextChar(); 1279d95d2a8eSOmar Emara return eKeyHandled; 1280d95d2a8eSOmar Emara case KEY_EOL: 1281d95d2a8eSOmar Emara case KEY_CTRL_K: 1282d95d2a8eSOmar Emara ClearToEnd(); 1283d95d2a8eSOmar Emara return eKeyHandled; 1284d95d2a8eSOmar Emara case KEY_DL: 1285d95d2a8eSOmar Emara case KEY_CLEAR: 1286d95d2a8eSOmar Emara Clear(); 128729cc50e1SOmar Emara return eKeyHandled; 128829cc50e1SOmar Emara default: 128929cc50e1SOmar Emara break; 129029cc50e1SOmar Emara } 129129cc50e1SOmar Emara return eKeyNotHandled; 129229cc50e1SOmar Emara } 129329cc50e1SOmar Emara 129480ac12b7SOmar Emara bool FieldDelegateHasError() override { return !m_error.empty(); } 129580ac12b7SOmar Emara 12969ef7de7cSOmar Emara void FieldDelegateExitCallback() override { 12979ef7de7cSOmar Emara if (!IsSpecified() && m_required) 12989ef7de7cSOmar Emara SetError("This field is required!"); 12999ef7de7cSOmar Emara } 13009ef7de7cSOmar Emara 13019ef7de7cSOmar Emara bool IsSpecified() { return !m_content.empty(); } 13029ef7de7cSOmar Emara 130329cc50e1SOmar Emara void ClearError() { m_error.clear(); } 130429cc50e1SOmar Emara 130529cc50e1SOmar Emara const std::string &GetError() { return m_error; } 130629cc50e1SOmar Emara 130729cc50e1SOmar Emara void SetError(const char *error) { m_error = error; } 130829cc50e1SOmar Emara 130929cc50e1SOmar Emara const std::string &GetText() { return m_content; } 131029cc50e1SOmar Emara 131182507f17SOmar Emara void SetText(const char *text) { 131282507f17SOmar Emara if (text == nullptr) { 131382507f17SOmar Emara m_content.clear(); 131482507f17SOmar Emara return; 131582507f17SOmar Emara } 131682507f17SOmar Emara m_content = text; 131782507f17SOmar Emara } 131882507f17SOmar Emara 131929cc50e1SOmar Emara protected: 132029cc50e1SOmar Emara std::string m_label; 13219ef7de7cSOmar Emara bool m_required; 132229cc50e1SOmar Emara // The position of the top left corner character of the border. 132329cc50e1SOmar Emara std::string m_content; 132429cc50e1SOmar Emara // The cursor position in the content string itself. Can be in the range 132529cc50e1SOmar Emara // [0, GetContentLength()]. 132628c878aeSShafik Yaghmour int m_cursor_position = 0; 132729cc50e1SOmar Emara // The index of the first visible character in the content. 132828c878aeSShafik Yaghmour int m_first_visibile_char = 0; 132929cc50e1SOmar Emara // Optional error message. If empty, field is considered to have no error. 133029cc50e1SOmar Emara std::string m_error; 133129cc50e1SOmar Emara }; 133229cc50e1SOmar Emara 133329cc50e1SOmar Emara class IntegerFieldDelegate : public TextFieldDelegate { 133429cc50e1SOmar Emara public: 13359ef7de7cSOmar Emara IntegerFieldDelegate(const char *label, int content, bool required) 13369ef7de7cSOmar Emara : TextFieldDelegate(label, std::to_string(content).c_str(), required) {} 133729cc50e1SOmar Emara 133829cc50e1SOmar Emara // Only accept digits. 133929cc50e1SOmar Emara bool IsAcceptableChar(int key) override { return isdigit(key); } 134029cc50e1SOmar Emara 134129cc50e1SOmar Emara // Returns the integer content of the field. 134229cc50e1SOmar Emara int GetInteger() { return std::stoi(m_content); } 134329cc50e1SOmar Emara }; 134429cc50e1SOmar Emara 134529cc50e1SOmar Emara class FileFieldDelegate : public TextFieldDelegate { 134629cc50e1SOmar Emara public: 13479ef7de7cSOmar Emara FileFieldDelegate(const char *label, const char *content, bool need_to_exist, 13489ef7de7cSOmar Emara bool required) 13499ef7de7cSOmar Emara : TextFieldDelegate(label, content, required), 13509ef7de7cSOmar Emara m_need_to_exist(need_to_exist) {} 135129cc50e1SOmar Emara 135229cc50e1SOmar Emara void FieldDelegateExitCallback() override { 13539ef7de7cSOmar Emara TextFieldDelegate::FieldDelegateExitCallback(); 13549ef7de7cSOmar Emara if (!IsSpecified()) 13559ef7de7cSOmar Emara return; 13569ef7de7cSOmar Emara 1357a98f394eSOmar Emara if (!m_need_to_exist) 1358a98f394eSOmar Emara return; 1359a98f394eSOmar Emara 1360a98f394eSOmar Emara FileSpec file = GetResolvedFileSpec(); 1361a98f394eSOmar Emara if (!FileSystem::Instance().Exists(file)) { 136229cc50e1SOmar Emara SetError("File doesn't exist!"); 136329cc50e1SOmar Emara return; 136429cc50e1SOmar Emara } 136529cc50e1SOmar Emara if (FileSystem::Instance().IsDirectory(file)) { 136629cc50e1SOmar Emara SetError("Not a file!"); 136729cc50e1SOmar Emara return; 136829cc50e1SOmar Emara } 136929cc50e1SOmar Emara } 137029cc50e1SOmar Emara 1371a98f394eSOmar Emara FileSpec GetFileSpec() { 1372a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1373a98f394eSOmar Emara return file_spec; 1374a98f394eSOmar Emara } 1375a98f394eSOmar Emara 1376a98f394eSOmar Emara FileSpec GetResolvedFileSpec() { 1377a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1378a98f394eSOmar Emara FileSystem::Instance().Resolve(file_spec); 1379a98f394eSOmar Emara return file_spec; 1380a98f394eSOmar Emara } 1381a98f394eSOmar Emara 138229cc50e1SOmar Emara const std::string &GetPath() { return m_content; } 138329cc50e1SOmar Emara 138429cc50e1SOmar Emara protected: 138529cc50e1SOmar Emara bool m_need_to_exist; 138629cc50e1SOmar Emara }; 138729cc50e1SOmar Emara 138829cc50e1SOmar Emara class DirectoryFieldDelegate : public TextFieldDelegate { 138929cc50e1SOmar Emara public: 139029cc50e1SOmar Emara DirectoryFieldDelegate(const char *label, const char *content, 13919ef7de7cSOmar Emara bool need_to_exist, bool required) 13929ef7de7cSOmar Emara : TextFieldDelegate(label, content, required), 13939ef7de7cSOmar Emara m_need_to_exist(need_to_exist) {} 139429cc50e1SOmar Emara 139529cc50e1SOmar Emara void FieldDelegateExitCallback() override { 13969ef7de7cSOmar Emara TextFieldDelegate::FieldDelegateExitCallback(); 13979ef7de7cSOmar Emara if (!IsSpecified()) 13989ef7de7cSOmar Emara return; 13999ef7de7cSOmar Emara 1400a98f394eSOmar Emara if (!m_need_to_exist) 1401a98f394eSOmar Emara return; 1402a98f394eSOmar Emara 1403a98f394eSOmar Emara FileSpec file = GetResolvedFileSpec(); 1404a98f394eSOmar Emara if (!FileSystem::Instance().Exists(file)) { 140529cc50e1SOmar Emara SetError("Directory doesn't exist!"); 140629cc50e1SOmar Emara return; 140729cc50e1SOmar Emara } 140829cc50e1SOmar Emara if (!FileSystem::Instance().IsDirectory(file)) { 140929cc50e1SOmar Emara SetError("Not a directory!"); 141029cc50e1SOmar Emara return; 141129cc50e1SOmar Emara } 141229cc50e1SOmar Emara } 141329cc50e1SOmar Emara 1414a98f394eSOmar Emara FileSpec GetFileSpec() { 1415a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1416a98f394eSOmar Emara return file_spec; 1417a98f394eSOmar Emara } 1418a98f394eSOmar Emara 1419a98f394eSOmar Emara FileSpec GetResolvedFileSpec() { 1420a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1421a98f394eSOmar Emara FileSystem::Instance().Resolve(file_spec); 1422a98f394eSOmar Emara return file_spec; 1423a98f394eSOmar Emara } 1424a98f394eSOmar Emara 142529cc50e1SOmar Emara const std::string &GetPath() { return m_content; } 142629cc50e1SOmar Emara 142729cc50e1SOmar Emara protected: 142829cc50e1SOmar Emara bool m_need_to_exist; 142929cc50e1SOmar Emara }; 143029cc50e1SOmar Emara 1431ed5b4dbdSOmar Emara class ArchFieldDelegate : public TextFieldDelegate { 1432ed5b4dbdSOmar Emara public: 1433ed5b4dbdSOmar Emara ArchFieldDelegate(const char *label, const char *content, bool required) 1434ed5b4dbdSOmar Emara : TextFieldDelegate(label, content, required) {} 1435ed5b4dbdSOmar Emara 1436ed5b4dbdSOmar Emara void FieldDelegateExitCallback() override { 1437ed5b4dbdSOmar Emara TextFieldDelegate::FieldDelegateExitCallback(); 1438ed5b4dbdSOmar Emara if (!IsSpecified()) 1439ed5b4dbdSOmar Emara return; 1440ed5b4dbdSOmar Emara 1441ed5b4dbdSOmar Emara if (!GetArchSpec().IsValid()) 1442ed5b4dbdSOmar Emara SetError("Not a valid arch!"); 1443ed5b4dbdSOmar Emara } 1444ed5b4dbdSOmar Emara 1445ed5b4dbdSOmar Emara const std::string &GetArchString() { return m_content; } 1446ed5b4dbdSOmar Emara 1447ed5b4dbdSOmar Emara ArchSpec GetArchSpec() { return ArchSpec(GetArchString()); } 1448ed5b4dbdSOmar Emara }; 1449ed5b4dbdSOmar Emara 145029cc50e1SOmar Emara class BooleanFieldDelegate : public FieldDelegate { 145129cc50e1SOmar Emara public: 145229cc50e1SOmar Emara BooleanFieldDelegate(const char *label, bool content) 145329cc50e1SOmar Emara : m_label(label), m_content(content) {} 145429cc50e1SOmar Emara 145529cc50e1SOmar Emara // Boolean fields are drawn as checkboxes. 145629cc50e1SOmar Emara // 145729cc50e1SOmar Emara // [X] Label or [ ] Label 145829cc50e1SOmar Emara 145929cc50e1SOmar Emara // Boolean fields are have a single line. 146029cc50e1SOmar Emara int FieldDelegateGetHeight() override { return 1; } 146129cc50e1SOmar Emara 146279e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 146329cc50e1SOmar Emara surface.MoveCursor(0, 0); 146429cc50e1SOmar Emara surface.PutChar('['); 146529cc50e1SOmar Emara if (is_selected) 146629cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 146729cc50e1SOmar Emara surface.PutChar(m_content ? ACS_DIAMOND : ' '); 146829cc50e1SOmar Emara if (is_selected) 146929cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 147029cc50e1SOmar Emara surface.PutChar(']'); 147129cc50e1SOmar Emara surface.PutChar(' '); 147229cc50e1SOmar Emara surface.PutCString(m_label.c_str()); 147329cc50e1SOmar Emara } 147429cc50e1SOmar Emara 147529cc50e1SOmar Emara void ToggleContent() { m_content = !m_content; } 147629cc50e1SOmar Emara 147729cc50e1SOmar Emara void SetContentToTrue() { m_content = true; } 147829cc50e1SOmar Emara 147929cc50e1SOmar Emara void SetContentToFalse() { m_content = false; } 148029cc50e1SOmar Emara 148129cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 148229cc50e1SOmar Emara switch (key) { 148329cc50e1SOmar Emara case 't': 148429cc50e1SOmar Emara case '1': 148529cc50e1SOmar Emara SetContentToTrue(); 148629cc50e1SOmar Emara return eKeyHandled; 148729cc50e1SOmar Emara case 'f': 148829cc50e1SOmar Emara case '0': 148929cc50e1SOmar Emara SetContentToFalse(); 149029cc50e1SOmar Emara return eKeyHandled; 149129cc50e1SOmar Emara case ' ': 149229cc50e1SOmar Emara case '\r': 149329cc50e1SOmar Emara case '\n': 149429cc50e1SOmar Emara case KEY_ENTER: 149529cc50e1SOmar Emara ToggleContent(); 149629cc50e1SOmar Emara return eKeyHandled; 149729cc50e1SOmar Emara default: 149829cc50e1SOmar Emara break; 149929cc50e1SOmar Emara } 150029cc50e1SOmar Emara return eKeyNotHandled; 150129cc50e1SOmar Emara } 150229cc50e1SOmar Emara 150329cc50e1SOmar Emara // Returns the boolean content of the field. 150429cc50e1SOmar Emara bool GetBoolean() { return m_content; } 150529cc50e1SOmar Emara 150629cc50e1SOmar Emara protected: 150729cc50e1SOmar Emara std::string m_label; 150829cc50e1SOmar Emara bool m_content; 150929cc50e1SOmar Emara }; 151029cc50e1SOmar Emara 151129cc50e1SOmar Emara class ChoicesFieldDelegate : public FieldDelegate { 151229cc50e1SOmar Emara public: 151329cc50e1SOmar Emara ChoicesFieldDelegate(const char *label, int number_of_visible_choices, 151429cc50e1SOmar Emara std::vector<std::string> choices) 151529cc50e1SOmar Emara : m_label(label), m_number_of_visible_choices(number_of_visible_choices), 151628c878aeSShafik Yaghmour m_choices(choices) {} 151729cc50e1SOmar Emara 151829cc50e1SOmar Emara // Choices fields are drawn as titles boxses of a number of visible choices. 151929cc50e1SOmar Emara // The rest of the choices become visible as the user scroll. The selected 152029cc50e1SOmar Emara // choice is denoted by a diamond as the first character. 152129cc50e1SOmar Emara // 152229cc50e1SOmar Emara // __[Label]___________ 152329cc50e1SOmar Emara // |-Choice 1 | 152429cc50e1SOmar Emara // | Choice 2 | 152529cc50e1SOmar Emara // | Choice 3 | 152629cc50e1SOmar Emara // |__________________| 152729cc50e1SOmar Emara 152829cc50e1SOmar Emara // Choices field have two border characters plus the number of visible 152929cc50e1SOmar Emara // choices. 153029cc50e1SOmar Emara int FieldDelegateGetHeight() override { 153129cc50e1SOmar Emara return m_number_of_visible_choices + 2; 153229cc50e1SOmar Emara } 153329cc50e1SOmar Emara 153429cc50e1SOmar Emara int GetNumberOfChoices() { return m_choices.size(); } 153529cc50e1SOmar Emara 153629cc50e1SOmar Emara // Get the index of the last visible choice. 153729cc50e1SOmar Emara int GetLastVisibleChoice() { 153829cc50e1SOmar Emara int index = m_first_visibile_choice + m_number_of_visible_choices; 153929cc50e1SOmar Emara return std::min(index, GetNumberOfChoices()) - 1; 154029cc50e1SOmar Emara } 154129cc50e1SOmar Emara 154279e950a2SOmar Emara void DrawContent(Surface &surface, bool is_selected) { 154329cc50e1SOmar Emara int choices_to_draw = GetLastVisibleChoice() - m_first_visibile_choice + 1; 154429cc50e1SOmar Emara for (int i = 0; i < choices_to_draw; i++) { 154529cc50e1SOmar Emara surface.MoveCursor(0, i); 154629cc50e1SOmar Emara int current_choice = m_first_visibile_choice + i; 154729cc50e1SOmar Emara const char *text = m_choices[current_choice].c_str(); 154829cc50e1SOmar Emara bool highlight = is_selected && current_choice == m_choice; 154929cc50e1SOmar Emara if (highlight) 155029cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 155129cc50e1SOmar Emara surface.PutChar(current_choice == m_choice ? ACS_DIAMOND : ' '); 155229cc50e1SOmar Emara surface.PutCString(text); 155329cc50e1SOmar Emara if (highlight) 155429cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 155529cc50e1SOmar Emara } 155629cc50e1SOmar Emara } 155729cc50e1SOmar Emara 155879e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 1559e160b398SOmar Emara UpdateScrolling(); 1560e160b398SOmar Emara 156129cc50e1SOmar Emara surface.TitledBox(m_label.c_str()); 156229cc50e1SOmar Emara 156329cc50e1SOmar Emara Rect content_bounds = surface.GetFrame(); 156429cc50e1SOmar Emara content_bounds.Inset(1, 1); 156579e950a2SOmar Emara Surface content_surface = surface.SubSurface(content_bounds); 156629cc50e1SOmar Emara 156729cc50e1SOmar Emara DrawContent(content_surface, is_selected); 156829cc50e1SOmar Emara } 156929cc50e1SOmar Emara 157029cc50e1SOmar Emara void SelectPrevious() { 157129cc50e1SOmar Emara if (m_choice > 0) 157229cc50e1SOmar Emara m_choice--; 157329cc50e1SOmar Emara } 157429cc50e1SOmar Emara 157529cc50e1SOmar Emara void SelectNext() { 157629cc50e1SOmar Emara if (m_choice < GetNumberOfChoices() - 1) 157729cc50e1SOmar Emara m_choice++; 157829cc50e1SOmar Emara } 157929cc50e1SOmar Emara 1580e160b398SOmar Emara void UpdateScrolling() { 1581e160b398SOmar Emara if (m_choice > GetLastVisibleChoice()) { 1582e160b398SOmar Emara m_first_visibile_choice = m_choice - (m_number_of_visible_choices - 1); 1583e160b398SOmar Emara return; 158429cc50e1SOmar Emara } 158529cc50e1SOmar Emara 1586e160b398SOmar Emara if (m_choice < m_first_visibile_choice) 1587e160b398SOmar Emara m_first_visibile_choice = m_choice; 158829cc50e1SOmar Emara } 158929cc50e1SOmar Emara 159029cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 159129cc50e1SOmar Emara switch (key) { 159229cc50e1SOmar Emara case KEY_UP: 159329cc50e1SOmar Emara SelectPrevious(); 159429cc50e1SOmar Emara return eKeyHandled; 159529cc50e1SOmar Emara case KEY_DOWN: 159629cc50e1SOmar Emara SelectNext(); 159729cc50e1SOmar Emara return eKeyHandled; 159829cc50e1SOmar Emara default: 159929cc50e1SOmar Emara break; 160029cc50e1SOmar Emara } 160129cc50e1SOmar Emara return eKeyNotHandled; 160229cc50e1SOmar Emara } 160329cc50e1SOmar Emara 160429cc50e1SOmar Emara // Returns the content of the choice as a string. 160529cc50e1SOmar Emara std::string GetChoiceContent() { return m_choices[m_choice]; } 160629cc50e1SOmar Emara 160729cc50e1SOmar Emara // Returns the index of the choice. 160829cc50e1SOmar Emara int GetChoice() { return m_choice; } 160929cc50e1SOmar Emara 1610d2edca62SPavel Labath void SetChoice(llvm::StringRef choice) { 1611e160b398SOmar Emara for (int i = 0; i < GetNumberOfChoices(); i++) { 1612e160b398SOmar Emara if (choice == m_choices[i]) { 1613e160b398SOmar Emara m_choice = i; 1614e160b398SOmar Emara return; 1615e160b398SOmar Emara } 1616e160b398SOmar Emara } 1617e160b398SOmar Emara } 1618e160b398SOmar Emara 161929cc50e1SOmar Emara protected: 162029cc50e1SOmar Emara std::string m_label; 162129cc50e1SOmar Emara int m_number_of_visible_choices; 162229cc50e1SOmar Emara std::vector<std::string> m_choices; 162329cc50e1SOmar Emara // The index of the selected choice. 162428c878aeSShafik Yaghmour int m_choice = 0; 162529cc50e1SOmar Emara // The index of the first visible choice in the field. 162628c878aeSShafik Yaghmour int m_first_visibile_choice = 0; 162729cc50e1SOmar Emara }; 162829cc50e1SOmar Emara 1629e160b398SOmar Emara class PlatformPluginFieldDelegate : public ChoicesFieldDelegate { 1630e160b398SOmar Emara public: 1631e160b398SOmar Emara PlatformPluginFieldDelegate(Debugger &debugger) 1632e160b398SOmar Emara : ChoicesFieldDelegate("Platform Plugin", 3, GetPossiblePluginNames()) { 1633e160b398SOmar Emara PlatformSP platform_sp = debugger.GetPlatformList().GetSelectedPlatform(); 1634e160b398SOmar Emara if (platform_sp) 1635d2edca62SPavel Labath SetChoice(platform_sp->GetPluginName()); 1636e160b398SOmar Emara } 1637e160b398SOmar Emara 1638e160b398SOmar Emara std::vector<std::string> GetPossiblePluginNames() { 1639e160b398SOmar Emara std::vector<std::string> names; 1640e160b398SOmar Emara size_t i = 0; 1641a458ef4fSPavel Labath for (llvm::StringRef name = 1642a458ef4fSPavel Labath PluginManager::GetPlatformPluginNameAtIndex(i++); 1643a458ef4fSPavel Labath !name.empty(); name = PluginManager::GetProcessPluginNameAtIndex(i++)) 1644a458ef4fSPavel Labath names.push_back(name.str()); 1645e160b398SOmar Emara return names; 1646e160b398SOmar Emara } 1647e160b398SOmar Emara 1648e160b398SOmar Emara std::string GetPluginName() { 1649e160b398SOmar Emara std::string plugin_name = GetChoiceContent(); 1650e160b398SOmar Emara return plugin_name; 1651e160b398SOmar Emara } 1652e160b398SOmar Emara }; 1653e160b398SOmar Emara 1654c93dc259SOmar Emara class ProcessPluginFieldDelegate : public ChoicesFieldDelegate { 1655c93dc259SOmar Emara public: 1656c93dc259SOmar Emara ProcessPluginFieldDelegate() 1657c93dc259SOmar Emara : ChoicesFieldDelegate("Process Plugin", 3, GetPossiblePluginNames()) {} 1658c93dc259SOmar Emara 1659c93dc259SOmar Emara std::vector<std::string> GetPossiblePluginNames() { 1660c93dc259SOmar Emara std::vector<std::string> names; 1661c93dc259SOmar Emara names.push_back("<default>"); 1662c93dc259SOmar Emara 1663c93dc259SOmar Emara size_t i = 0; 16645f4980f0SPavel Labath for (llvm::StringRef name = PluginManager::GetProcessPluginNameAtIndex(i++); 16655f4980f0SPavel Labath !name.empty(); name = PluginManager::GetProcessPluginNameAtIndex(i++)) 16665f4980f0SPavel Labath names.push_back(name.str()); 1667c93dc259SOmar Emara return names; 1668c93dc259SOmar Emara } 1669c93dc259SOmar Emara 1670c93dc259SOmar Emara std::string GetPluginName() { 1671c93dc259SOmar Emara std::string plugin_name = GetChoiceContent(); 1672c93dc259SOmar Emara if (plugin_name == "<default>") 1673c93dc259SOmar Emara return ""; 1674c93dc259SOmar Emara return plugin_name; 1675c93dc259SOmar Emara } 1676c93dc259SOmar Emara }; 1677c93dc259SOmar Emara 167882507f17SOmar Emara class LazyBooleanFieldDelegate : public ChoicesFieldDelegate { 167982507f17SOmar Emara public: 168082507f17SOmar Emara LazyBooleanFieldDelegate(const char *label, const char *calculate_label) 168182507f17SOmar Emara : ChoicesFieldDelegate(label, 3, GetPossibleOptions(calculate_label)) {} 168282507f17SOmar Emara 168382507f17SOmar Emara static constexpr const char *kNo = "No"; 168482507f17SOmar Emara static constexpr const char *kYes = "Yes"; 168582507f17SOmar Emara 168682507f17SOmar Emara std::vector<std::string> GetPossibleOptions(const char *calculate_label) { 168782507f17SOmar Emara std::vector<std::string> options; 168882507f17SOmar Emara options.push_back(calculate_label); 168982507f17SOmar Emara options.push_back(kYes); 169082507f17SOmar Emara options.push_back(kNo); 169182507f17SOmar Emara return options; 169282507f17SOmar Emara } 169382507f17SOmar Emara 169482507f17SOmar Emara LazyBool GetLazyBoolean() { 169582507f17SOmar Emara std::string choice = GetChoiceContent(); 169682507f17SOmar Emara if (choice == kNo) 169782507f17SOmar Emara return eLazyBoolNo; 169882507f17SOmar Emara else if (choice == kYes) 169982507f17SOmar Emara return eLazyBoolYes; 170082507f17SOmar Emara else 170182507f17SOmar Emara return eLazyBoolCalculate; 170282507f17SOmar Emara } 170382507f17SOmar Emara }; 170482507f17SOmar Emara 170529cc50e1SOmar Emara template <class T> class ListFieldDelegate : public FieldDelegate { 170629cc50e1SOmar Emara public: 170729cc50e1SOmar Emara ListFieldDelegate(const char *label, T default_field) 170828c878aeSShafik Yaghmour : m_label(label), m_default_field(default_field), 170929cc50e1SOmar Emara m_selection_type(SelectionType::NewButton) {} 171029cc50e1SOmar Emara 171129cc50e1SOmar Emara // Signify which element is selected. If a field or a remove button is 171229cc50e1SOmar Emara // selected, then m_selection_index signifies the particular field that 171329cc50e1SOmar Emara // is selected or the field that the remove button belongs to. 171429cc50e1SOmar Emara enum class SelectionType { Field, RemoveButton, NewButton }; 171529cc50e1SOmar Emara 171629cc50e1SOmar Emara // A List field is drawn as a titled box of a number of other fields of the 171729cc50e1SOmar Emara // same type. Each field has a Remove button next to it that removes the 171829cc50e1SOmar Emara // corresponding field. Finally, the last line contains a New button to add a 171929cc50e1SOmar Emara // new field. 172029cc50e1SOmar Emara // 172129cc50e1SOmar Emara // __[Label]___________ 172229cc50e1SOmar Emara // | Field 0 [Remove] | 172329cc50e1SOmar Emara // | Field 1 [Remove] | 172429cc50e1SOmar Emara // | Field 2 [Remove] | 172529cc50e1SOmar Emara // | [New] | 172629cc50e1SOmar Emara // |__________________| 172729cc50e1SOmar Emara 172829cc50e1SOmar Emara // List fields have two lines for border characters, 1 line for the New 172929cc50e1SOmar Emara // button, and the total height of the available fields. 173029cc50e1SOmar Emara int FieldDelegateGetHeight() override { 173129cc50e1SOmar Emara // 2 border characters. 173229cc50e1SOmar Emara int height = 2; 173329cc50e1SOmar Emara // Total height of the fields. 173429cc50e1SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 173529cc50e1SOmar Emara height += m_fields[i].FieldDelegateGetHeight(); 173629cc50e1SOmar Emara } 173729cc50e1SOmar Emara // A line for the New button. 173829cc50e1SOmar Emara height++; 173929cc50e1SOmar Emara return height; 174029cc50e1SOmar Emara } 174129cc50e1SOmar Emara 174229cc50e1SOmar Emara ScrollContext FieldDelegateGetScrollContext() override { 174329cc50e1SOmar Emara int height = FieldDelegateGetHeight(); 174429cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) 174529cc50e1SOmar Emara return ScrollContext(height - 2, height - 1); 174629cc50e1SOmar Emara 174729cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 174829cc50e1SOmar Emara ScrollContext context = field.FieldDelegateGetScrollContext(); 174929cc50e1SOmar Emara 175029cc50e1SOmar Emara // Start at 1 because of the top border. 175129cc50e1SOmar Emara int offset = 1; 175229cc50e1SOmar Emara for (int i = 0; i < m_selection_index; i++) { 175329cc50e1SOmar Emara offset += m_fields[i].FieldDelegateGetHeight(); 175429cc50e1SOmar Emara } 175529cc50e1SOmar Emara context.Offset(offset); 175629cc50e1SOmar Emara 175729cc50e1SOmar Emara // If the scroll context is touching the top border, include it in the 175829cc50e1SOmar Emara // context to show the label. 175929cc50e1SOmar Emara if (context.start == 1) 176029cc50e1SOmar Emara context.start--; 176129cc50e1SOmar Emara 176229cc50e1SOmar Emara // If the scroll context is touching the new button, include it as well as 176329cc50e1SOmar Emara // the bottom border in the context. 176429cc50e1SOmar Emara if (context.end == height - 3) 176529cc50e1SOmar Emara context.end += 2; 176629cc50e1SOmar Emara 176729cc50e1SOmar Emara return context; 176829cc50e1SOmar Emara } 176929cc50e1SOmar Emara 177079e950a2SOmar Emara void DrawRemoveButton(Surface &surface, int highlight) { 177129cc50e1SOmar Emara surface.MoveCursor(1, surface.GetHeight() / 2); 177229cc50e1SOmar Emara if (highlight) 177329cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 177429cc50e1SOmar Emara surface.PutCString("[Remove]"); 177529cc50e1SOmar Emara if (highlight) 177629cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 177729cc50e1SOmar Emara } 177829cc50e1SOmar Emara 177979e950a2SOmar Emara void DrawFields(Surface &surface, bool is_selected) { 178029cc50e1SOmar Emara int line = 0; 178129cc50e1SOmar Emara int width = surface.GetWidth(); 178229cc50e1SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 178329cc50e1SOmar Emara int height = m_fields[i].FieldDelegateGetHeight(); 178429cc50e1SOmar Emara Rect bounds = Rect(Point(0, line), Size(width, height)); 178529cc50e1SOmar Emara Rect field_bounds, remove_button_bounds; 178629cc50e1SOmar Emara bounds.VerticalSplit(bounds.size.width - sizeof(" [Remove]"), 178729cc50e1SOmar Emara field_bounds, remove_button_bounds); 178879e950a2SOmar Emara Surface field_surface = surface.SubSurface(field_bounds); 178979e950a2SOmar Emara Surface remove_button_surface = surface.SubSurface(remove_button_bounds); 179029cc50e1SOmar Emara 179129cc50e1SOmar Emara bool is_element_selected = m_selection_index == i && is_selected; 179229cc50e1SOmar Emara bool is_field_selected = 179329cc50e1SOmar Emara is_element_selected && m_selection_type == SelectionType::Field; 179429cc50e1SOmar Emara bool is_remove_button_selected = 179529cc50e1SOmar Emara is_element_selected && 179629cc50e1SOmar Emara m_selection_type == SelectionType::RemoveButton; 179729cc50e1SOmar Emara m_fields[i].FieldDelegateDraw(field_surface, is_field_selected); 179829cc50e1SOmar Emara DrawRemoveButton(remove_button_surface, is_remove_button_selected); 179929cc50e1SOmar Emara 180029cc50e1SOmar Emara line += height; 180129cc50e1SOmar Emara } 180229cc50e1SOmar Emara } 180329cc50e1SOmar Emara 180479e950a2SOmar Emara void DrawNewButton(Surface &surface, bool is_selected) { 180529cc50e1SOmar Emara const char *button_text = "[New]"; 180629cc50e1SOmar Emara int x = (surface.GetWidth() - sizeof(button_text) - 1) / 2; 180729cc50e1SOmar Emara surface.MoveCursor(x, 0); 180829cc50e1SOmar Emara bool highlight = 180929cc50e1SOmar Emara is_selected && m_selection_type == SelectionType::NewButton; 181029cc50e1SOmar Emara if (highlight) 181129cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 181229cc50e1SOmar Emara surface.PutCString(button_text); 181329cc50e1SOmar Emara if (highlight) 181429cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 181529cc50e1SOmar Emara } 181629cc50e1SOmar Emara 181779e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 181829cc50e1SOmar Emara surface.TitledBox(m_label.c_str()); 181929cc50e1SOmar Emara 182029cc50e1SOmar Emara Rect content_bounds = surface.GetFrame(); 182129cc50e1SOmar Emara content_bounds.Inset(1, 1); 182229cc50e1SOmar Emara Rect fields_bounds, new_button_bounds; 182329cc50e1SOmar Emara content_bounds.HorizontalSplit(content_bounds.size.height - 1, 182429cc50e1SOmar Emara fields_bounds, new_button_bounds); 182579e950a2SOmar Emara Surface fields_surface = surface.SubSurface(fields_bounds); 182679e950a2SOmar Emara Surface new_button_surface = surface.SubSurface(new_button_bounds); 182729cc50e1SOmar Emara 182829cc50e1SOmar Emara DrawFields(fields_surface, is_selected); 182929cc50e1SOmar Emara DrawNewButton(new_button_surface, is_selected); 183029cc50e1SOmar Emara } 183129cc50e1SOmar Emara 183229cc50e1SOmar Emara void AddNewField() { 183329cc50e1SOmar Emara m_fields.push_back(m_default_field); 183429cc50e1SOmar Emara m_selection_index = GetNumberOfFields() - 1; 183529cc50e1SOmar Emara m_selection_type = SelectionType::Field; 183629cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 183729cc50e1SOmar Emara field.FieldDelegateSelectFirstElement(); 183829cc50e1SOmar Emara } 183929cc50e1SOmar Emara 184029cc50e1SOmar Emara void RemoveField() { 184129cc50e1SOmar Emara m_fields.erase(m_fields.begin() + m_selection_index); 184229cc50e1SOmar Emara if (m_selection_index != 0) 184329cc50e1SOmar Emara m_selection_index--; 184429cc50e1SOmar Emara 184529cc50e1SOmar Emara if (GetNumberOfFields() > 0) { 184629cc50e1SOmar Emara m_selection_type = SelectionType::Field; 184729cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 184829cc50e1SOmar Emara field.FieldDelegateSelectFirstElement(); 184929cc50e1SOmar Emara } else 185029cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 185129cc50e1SOmar Emara } 185229cc50e1SOmar Emara 18530321dbc8SOmar Emara HandleCharResult SelectNext(int key) { 185429cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) 185529cc50e1SOmar Emara return eKeyNotHandled; 185629cc50e1SOmar Emara 185729cc50e1SOmar Emara if (m_selection_type == SelectionType::RemoveButton) { 185829cc50e1SOmar Emara if (m_selection_index == GetNumberOfFields() - 1) { 185929cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 186029cc50e1SOmar Emara return eKeyHandled; 186129cc50e1SOmar Emara } 186229cc50e1SOmar Emara m_selection_index++; 186329cc50e1SOmar Emara m_selection_type = SelectionType::Field; 186429cc50e1SOmar Emara FieldDelegate &next_field = m_fields[m_selection_index]; 186529cc50e1SOmar Emara next_field.FieldDelegateSelectFirstElement(); 186629cc50e1SOmar Emara return eKeyHandled; 186729cc50e1SOmar Emara } 186829cc50e1SOmar Emara 186929cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 187029cc50e1SOmar Emara if (!field.FieldDelegateOnLastOrOnlyElement()) { 187129cc50e1SOmar Emara return field.FieldDelegateHandleChar(key); 187229cc50e1SOmar Emara } 187329cc50e1SOmar Emara 187429cc50e1SOmar Emara field.FieldDelegateExitCallback(); 187529cc50e1SOmar Emara 187629cc50e1SOmar Emara m_selection_type = SelectionType::RemoveButton; 187729cc50e1SOmar Emara return eKeyHandled; 187829cc50e1SOmar Emara } 187929cc50e1SOmar Emara 188029cc50e1SOmar Emara HandleCharResult SelectPrevious(int key) { 188129cc50e1SOmar Emara if (FieldDelegateOnFirstOrOnlyElement()) 188229cc50e1SOmar Emara return eKeyNotHandled; 188329cc50e1SOmar Emara 188429cc50e1SOmar Emara if (m_selection_type == SelectionType::RemoveButton) { 188529cc50e1SOmar Emara m_selection_type = SelectionType::Field; 188629cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 188729cc50e1SOmar Emara field.FieldDelegateSelectLastElement(); 188829cc50e1SOmar Emara return eKeyHandled; 188929cc50e1SOmar Emara } 189029cc50e1SOmar Emara 189129cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) { 189229cc50e1SOmar Emara m_selection_type = SelectionType::RemoveButton; 189329cc50e1SOmar Emara m_selection_index = GetNumberOfFields() - 1; 189429cc50e1SOmar Emara return eKeyHandled; 189529cc50e1SOmar Emara } 189629cc50e1SOmar Emara 189729cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 189829cc50e1SOmar Emara if (!field.FieldDelegateOnFirstOrOnlyElement()) { 189929cc50e1SOmar Emara return field.FieldDelegateHandleChar(key); 190029cc50e1SOmar Emara } 190129cc50e1SOmar Emara 190229cc50e1SOmar Emara field.FieldDelegateExitCallback(); 190329cc50e1SOmar Emara 190429cc50e1SOmar Emara m_selection_type = SelectionType::RemoveButton; 190529cc50e1SOmar Emara m_selection_index--; 190629cc50e1SOmar Emara return eKeyHandled; 190729cc50e1SOmar Emara } 190829cc50e1SOmar Emara 190928a76049SOmar Emara // If the last element of the field is selected and it didn't handle the key. 191028a76049SOmar Emara // Select the next field or new button if the selected field is the last one. 191128a76049SOmar Emara HandleCharResult SelectNextInList(int key) { 191228a76049SOmar Emara assert(m_selection_type == SelectionType::Field); 191328a76049SOmar Emara 191428a76049SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 191528a76049SOmar Emara if (field.FieldDelegateHandleChar(key) == eKeyHandled) 191628a76049SOmar Emara return eKeyHandled; 191728a76049SOmar Emara 191828a76049SOmar Emara if (!field.FieldDelegateOnLastOrOnlyElement()) 191928a76049SOmar Emara return eKeyNotHandled; 192028a76049SOmar Emara 192128a76049SOmar Emara field.FieldDelegateExitCallback(); 192228a76049SOmar Emara 192328a76049SOmar Emara if (m_selection_index == GetNumberOfFields() - 1) { 192428a76049SOmar Emara m_selection_type = SelectionType::NewButton; 192528a76049SOmar Emara return eKeyHandled; 192628a76049SOmar Emara } 192728a76049SOmar Emara 192828a76049SOmar Emara m_selection_index++; 192928a76049SOmar Emara FieldDelegate &next_field = m_fields[m_selection_index]; 193028a76049SOmar Emara next_field.FieldDelegateSelectFirstElement(); 193128a76049SOmar Emara return eKeyHandled; 193228a76049SOmar Emara } 193328a76049SOmar Emara 193429cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 193529cc50e1SOmar Emara switch (key) { 193629cc50e1SOmar Emara case '\r': 193729cc50e1SOmar Emara case '\n': 193829cc50e1SOmar Emara case KEY_ENTER: 193929cc50e1SOmar Emara switch (m_selection_type) { 194029cc50e1SOmar Emara case SelectionType::NewButton: 194129cc50e1SOmar Emara AddNewField(); 194229cc50e1SOmar Emara return eKeyHandled; 194329cc50e1SOmar Emara case SelectionType::RemoveButton: 194429cc50e1SOmar Emara RemoveField(); 194529cc50e1SOmar Emara return eKeyHandled; 194628a76049SOmar Emara case SelectionType::Field: 194728a76049SOmar Emara return SelectNextInList(key); 194829cc50e1SOmar Emara } 194929cc50e1SOmar Emara break; 195029cc50e1SOmar Emara case '\t': 195128a76049SOmar Emara return SelectNext(key); 195229cc50e1SOmar Emara case KEY_SHIFT_TAB: 195328a76049SOmar Emara return SelectPrevious(key); 195429cc50e1SOmar Emara default: 195529cc50e1SOmar Emara break; 195629cc50e1SOmar Emara } 195729cc50e1SOmar Emara 195829cc50e1SOmar Emara // If the key wasn't handled and one of the fields is selected, pass the key 195929cc50e1SOmar Emara // to that field. 196029cc50e1SOmar Emara if (m_selection_type == SelectionType::Field) { 196129cc50e1SOmar Emara return m_fields[m_selection_index].FieldDelegateHandleChar(key); 196229cc50e1SOmar Emara } 196329cc50e1SOmar Emara 196429cc50e1SOmar Emara return eKeyNotHandled; 196529cc50e1SOmar Emara } 196629cc50e1SOmar Emara 196729cc50e1SOmar Emara bool FieldDelegateOnLastOrOnlyElement() override { 196829cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) { 196929cc50e1SOmar Emara return true; 197029cc50e1SOmar Emara } 197129cc50e1SOmar Emara return false; 197229cc50e1SOmar Emara } 197329cc50e1SOmar Emara 197429cc50e1SOmar Emara bool FieldDelegateOnFirstOrOnlyElement() override { 197529cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton && 197629cc50e1SOmar Emara GetNumberOfFields() == 0) 197729cc50e1SOmar Emara return true; 197829cc50e1SOmar Emara 197929cc50e1SOmar Emara if (m_selection_type == SelectionType::Field && m_selection_index == 0) { 198029cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 198129cc50e1SOmar Emara return field.FieldDelegateOnFirstOrOnlyElement(); 198229cc50e1SOmar Emara } 198329cc50e1SOmar Emara 198429cc50e1SOmar Emara return false; 198529cc50e1SOmar Emara } 198629cc50e1SOmar Emara 198729cc50e1SOmar Emara void FieldDelegateSelectFirstElement() override { 198829cc50e1SOmar Emara if (GetNumberOfFields() == 0) { 198929cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 199029cc50e1SOmar Emara return; 199129cc50e1SOmar Emara } 199229cc50e1SOmar Emara 199329cc50e1SOmar Emara m_selection_type = SelectionType::Field; 199429cc50e1SOmar Emara m_selection_index = 0; 199529cc50e1SOmar Emara } 199629cc50e1SOmar Emara 199729cc50e1SOmar Emara void FieldDelegateSelectLastElement() override { 199829cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 199929cc50e1SOmar Emara } 200029cc50e1SOmar Emara 200129cc50e1SOmar Emara int GetNumberOfFields() { return m_fields.size(); } 200229cc50e1SOmar Emara 200329cc50e1SOmar Emara // Returns the form delegate at the current index. 200429cc50e1SOmar Emara T &GetField(int index) { return m_fields[index]; } 200529cc50e1SOmar Emara 200629cc50e1SOmar Emara protected: 200729cc50e1SOmar Emara std::string m_label; 200829cc50e1SOmar Emara // The default field delegate instance from which new field delegates will be 200929cc50e1SOmar Emara // created though a copy. 201029cc50e1SOmar Emara T m_default_field; 201129cc50e1SOmar Emara std::vector<T> m_fields; 201228c878aeSShafik Yaghmour int m_selection_index = 0; 201329cc50e1SOmar Emara // See SelectionType class enum. 201429cc50e1SOmar Emara SelectionType m_selection_type; 201529cc50e1SOmar Emara }; 201629cc50e1SOmar Emara 201782507f17SOmar Emara class ArgumentsFieldDelegate : public ListFieldDelegate<TextFieldDelegate> { 201882507f17SOmar Emara public: 201982507f17SOmar Emara ArgumentsFieldDelegate() 202082507f17SOmar Emara : ListFieldDelegate("Arguments", 202182507f17SOmar Emara TextFieldDelegate("Argument", "", false)) {} 202282507f17SOmar Emara 202382507f17SOmar Emara Args GetArguments() { 202482507f17SOmar Emara Args arguments; 202582507f17SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 202682507f17SOmar Emara arguments.AppendArgument(GetField(i).GetText()); 202782507f17SOmar Emara } 202882507f17SOmar Emara return arguments; 202982507f17SOmar Emara } 203082507f17SOmar Emara 203182507f17SOmar Emara void AddArguments(const Args &arguments) { 203282507f17SOmar Emara for (size_t i = 0; i < arguments.GetArgumentCount(); i++) { 203382507f17SOmar Emara AddNewField(); 203482507f17SOmar Emara TextFieldDelegate &field = GetField(GetNumberOfFields() - 1); 203582507f17SOmar Emara field.SetText(arguments.GetArgumentAtIndex(i)); 203682507f17SOmar Emara } 203782507f17SOmar Emara } 203882507f17SOmar Emara }; 203982507f17SOmar Emara 204062bd3315SOmar Emara template <class KeyFieldDelegateType, class ValueFieldDelegateType> 204162bd3315SOmar Emara class MappingFieldDelegate : public FieldDelegate { 204262bd3315SOmar Emara public: 204362bd3315SOmar Emara MappingFieldDelegate(KeyFieldDelegateType key_field, 204462bd3315SOmar Emara ValueFieldDelegateType value_field) 204562bd3315SOmar Emara : m_key_field(key_field), m_value_field(value_field), 204662bd3315SOmar Emara m_selection_type(SelectionType::Key) {} 204762bd3315SOmar Emara 204862bd3315SOmar Emara // Signify which element is selected. The key field or its value field. 204962bd3315SOmar Emara enum class SelectionType { Key, Value }; 205062bd3315SOmar Emara 205162bd3315SOmar Emara // A mapping field is drawn as two text fields with a right arrow in between. 205262bd3315SOmar Emara // The first field stores the key of the mapping and the second stores the 205362bd3315SOmar Emara // value if the mapping. 205462bd3315SOmar Emara // 205562bd3315SOmar Emara // __[Key]_____________ __[Value]___________ 205662bd3315SOmar Emara // | | > | | 205762bd3315SOmar Emara // |__________________| |__________________| 205862bd3315SOmar Emara // - Error message if it exists. 205962bd3315SOmar Emara 206062bd3315SOmar Emara // The mapping field has a height that is equal to the maximum height between 206162bd3315SOmar Emara // the key and value fields. 206262bd3315SOmar Emara int FieldDelegateGetHeight() override { 206362bd3315SOmar Emara return std::max(m_key_field.FieldDelegateGetHeight(), 206462bd3315SOmar Emara m_value_field.FieldDelegateGetHeight()); 206562bd3315SOmar Emara } 206662bd3315SOmar Emara 206779e950a2SOmar Emara void DrawArrow(Surface &surface) { 206862bd3315SOmar Emara surface.MoveCursor(0, 1); 206962bd3315SOmar Emara surface.PutChar(ACS_RARROW); 207062bd3315SOmar Emara } 207162bd3315SOmar Emara 207279e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 207362bd3315SOmar Emara Rect bounds = surface.GetFrame(); 207462bd3315SOmar Emara Rect key_field_bounds, arrow_and_value_field_bounds; 207562bd3315SOmar Emara bounds.VerticalSplit(bounds.size.width / 2, key_field_bounds, 207662bd3315SOmar Emara arrow_and_value_field_bounds); 207762bd3315SOmar Emara Rect arrow_bounds, value_field_bounds; 207862bd3315SOmar Emara arrow_and_value_field_bounds.VerticalSplit(1, arrow_bounds, 207962bd3315SOmar Emara value_field_bounds); 208062bd3315SOmar Emara 208179e950a2SOmar Emara Surface key_field_surface = surface.SubSurface(key_field_bounds); 208279e950a2SOmar Emara Surface arrow_surface = surface.SubSurface(arrow_bounds); 208379e950a2SOmar Emara Surface value_field_surface = surface.SubSurface(value_field_bounds); 208462bd3315SOmar Emara 208562bd3315SOmar Emara bool key_is_selected = 208662bd3315SOmar Emara m_selection_type == SelectionType::Key && is_selected; 208762bd3315SOmar Emara m_key_field.FieldDelegateDraw(key_field_surface, key_is_selected); 208862bd3315SOmar Emara DrawArrow(arrow_surface); 208962bd3315SOmar Emara bool value_is_selected = 209062bd3315SOmar Emara m_selection_type == SelectionType::Value && is_selected; 209162bd3315SOmar Emara m_value_field.FieldDelegateDraw(value_field_surface, value_is_selected); 209262bd3315SOmar Emara } 209362bd3315SOmar Emara 209462bd3315SOmar Emara HandleCharResult SelectNext(int key) { 209562bd3315SOmar Emara if (FieldDelegateOnLastOrOnlyElement()) 209662bd3315SOmar Emara return eKeyNotHandled; 209762bd3315SOmar Emara 209862bd3315SOmar Emara if (!m_key_field.FieldDelegateOnLastOrOnlyElement()) { 209962bd3315SOmar Emara return m_key_field.FieldDelegateHandleChar(key); 210062bd3315SOmar Emara } 210162bd3315SOmar Emara 210262bd3315SOmar Emara m_key_field.FieldDelegateExitCallback(); 210362bd3315SOmar Emara m_selection_type = SelectionType::Value; 210462bd3315SOmar Emara m_value_field.FieldDelegateSelectFirstElement(); 210562bd3315SOmar Emara return eKeyHandled; 210662bd3315SOmar Emara } 210762bd3315SOmar Emara 210862bd3315SOmar Emara HandleCharResult SelectPrevious(int key) { 210962bd3315SOmar Emara if (FieldDelegateOnFirstOrOnlyElement()) 211062bd3315SOmar Emara return eKeyNotHandled; 211162bd3315SOmar Emara 211262bd3315SOmar Emara if (!m_value_field.FieldDelegateOnFirstOrOnlyElement()) { 211362bd3315SOmar Emara return m_value_field.FieldDelegateHandleChar(key); 211462bd3315SOmar Emara } 211562bd3315SOmar Emara 211662bd3315SOmar Emara m_value_field.FieldDelegateExitCallback(); 211762bd3315SOmar Emara m_selection_type = SelectionType::Key; 211862bd3315SOmar Emara m_key_field.FieldDelegateSelectLastElement(); 211962bd3315SOmar Emara return eKeyHandled; 212062bd3315SOmar Emara } 212162bd3315SOmar Emara 212228a76049SOmar Emara // If the value field is selected, pass the key to it. If the key field is 212328a76049SOmar Emara // selected, its last element is selected, and it didn't handle the key, then 212428a76049SOmar Emara // select its corresponding value field. 212528a76049SOmar Emara HandleCharResult SelectNextField(int key) { 212628a76049SOmar Emara if (m_selection_type == SelectionType::Value) { 212728a76049SOmar Emara return m_value_field.FieldDelegateHandleChar(key); 212828a76049SOmar Emara } 212928a76049SOmar Emara 213028a76049SOmar Emara if (m_key_field.FieldDelegateHandleChar(key) == eKeyHandled) 213128a76049SOmar Emara return eKeyHandled; 213228a76049SOmar Emara 213328a76049SOmar Emara if (!m_key_field.FieldDelegateOnLastOrOnlyElement()) 213428a76049SOmar Emara return eKeyNotHandled; 213528a76049SOmar Emara 213628a76049SOmar Emara m_key_field.FieldDelegateExitCallback(); 213728a76049SOmar Emara m_selection_type = SelectionType::Value; 213828a76049SOmar Emara m_value_field.FieldDelegateSelectFirstElement(); 213928a76049SOmar Emara return eKeyHandled; 214028a76049SOmar Emara } 214128a76049SOmar Emara 214262bd3315SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 214362bd3315SOmar Emara switch (key) { 214428a76049SOmar Emara case KEY_RETURN: 214528a76049SOmar Emara return SelectNextField(key); 214662bd3315SOmar Emara case '\t': 214728a76049SOmar Emara return SelectNext(key); 214862bd3315SOmar Emara case KEY_SHIFT_TAB: 214928a76049SOmar Emara return SelectPrevious(key); 215062bd3315SOmar Emara default: 215162bd3315SOmar Emara break; 215262bd3315SOmar Emara } 215362bd3315SOmar Emara 215462bd3315SOmar Emara // If the key wasn't handled, pass the key to the selected field. 215562bd3315SOmar Emara if (m_selection_type == SelectionType::Key) 215662bd3315SOmar Emara return m_key_field.FieldDelegateHandleChar(key); 215762bd3315SOmar Emara else 215862bd3315SOmar Emara return m_value_field.FieldDelegateHandleChar(key); 215962bd3315SOmar Emara 216062bd3315SOmar Emara return eKeyNotHandled; 216162bd3315SOmar Emara } 216262bd3315SOmar Emara 216362bd3315SOmar Emara bool FieldDelegateOnFirstOrOnlyElement() override { 216462bd3315SOmar Emara return m_selection_type == SelectionType::Key; 216562bd3315SOmar Emara } 216662bd3315SOmar Emara 216762bd3315SOmar Emara bool FieldDelegateOnLastOrOnlyElement() override { 216862bd3315SOmar Emara return m_selection_type == SelectionType::Value; 216962bd3315SOmar Emara } 217062bd3315SOmar Emara 217162bd3315SOmar Emara void FieldDelegateSelectFirstElement() override { 217262bd3315SOmar Emara m_selection_type = SelectionType::Key; 217362bd3315SOmar Emara } 217462bd3315SOmar Emara 217562bd3315SOmar Emara void FieldDelegateSelectLastElement() override { 217662bd3315SOmar Emara m_selection_type = SelectionType::Value; 217762bd3315SOmar Emara } 217862bd3315SOmar Emara 217962bd3315SOmar Emara bool FieldDelegateHasError() override { 218062bd3315SOmar Emara return m_key_field.FieldDelegateHasError() || 218162bd3315SOmar Emara m_value_field.FieldDelegateHasError(); 218262bd3315SOmar Emara } 218362bd3315SOmar Emara 218462bd3315SOmar Emara KeyFieldDelegateType &GetKeyField() { return m_key_field; } 218562bd3315SOmar Emara 218662bd3315SOmar Emara ValueFieldDelegateType &GetValueField() { return m_value_field; } 218762bd3315SOmar Emara 218862bd3315SOmar Emara protected: 218962bd3315SOmar Emara KeyFieldDelegateType m_key_field; 219062bd3315SOmar Emara ValueFieldDelegateType m_value_field; 219162bd3315SOmar Emara // See SelectionType class enum. 219262bd3315SOmar Emara SelectionType m_selection_type; 219362bd3315SOmar Emara }; 219462bd3315SOmar Emara 219562bd3315SOmar Emara class EnvironmentVariableNameFieldDelegate : public TextFieldDelegate { 219662bd3315SOmar Emara public: 219762bd3315SOmar Emara EnvironmentVariableNameFieldDelegate(const char *content) 219862bd3315SOmar Emara : TextFieldDelegate("Name", content, true) {} 219962bd3315SOmar Emara 220062bd3315SOmar Emara // Environment variable names can't contain an equal sign. 220162bd3315SOmar Emara bool IsAcceptableChar(int key) override { 220262bd3315SOmar Emara return TextFieldDelegate::IsAcceptableChar(key) && key != '='; 220362bd3315SOmar Emara } 220462bd3315SOmar Emara 220562bd3315SOmar Emara const std::string &GetName() { return m_content; } 220662bd3315SOmar Emara }; 220762bd3315SOmar Emara 220862bd3315SOmar Emara class EnvironmentVariableFieldDelegate 220962bd3315SOmar Emara : public MappingFieldDelegate<EnvironmentVariableNameFieldDelegate, 221062bd3315SOmar Emara TextFieldDelegate> { 221162bd3315SOmar Emara public: 221262bd3315SOmar Emara EnvironmentVariableFieldDelegate() 221362bd3315SOmar Emara : MappingFieldDelegate( 221462bd3315SOmar Emara EnvironmentVariableNameFieldDelegate(""), 221562bd3315SOmar Emara TextFieldDelegate("Value", "", /*required=*/false)) {} 221662bd3315SOmar Emara 221762bd3315SOmar Emara const std::string &GetName() { return GetKeyField().GetName(); } 221862bd3315SOmar Emara 221962bd3315SOmar Emara const std::string &GetValue() { return GetValueField().GetText(); } 222082507f17SOmar Emara 222182507f17SOmar Emara void SetName(const char *name) { return GetKeyField().SetText(name); } 222282507f17SOmar Emara 222382507f17SOmar Emara void SetValue(const char *value) { return GetValueField().SetText(value); } 222462bd3315SOmar Emara }; 222562bd3315SOmar Emara 222662bd3315SOmar Emara class EnvironmentVariableListFieldDelegate 222762bd3315SOmar Emara : public ListFieldDelegate<EnvironmentVariableFieldDelegate> { 222862bd3315SOmar Emara public: 222982507f17SOmar Emara EnvironmentVariableListFieldDelegate(const char *label) 223082507f17SOmar Emara : ListFieldDelegate(label, EnvironmentVariableFieldDelegate()) {} 223182507f17SOmar Emara 223282507f17SOmar Emara Environment GetEnvironment() { 223382507f17SOmar Emara Environment environment; 223482507f17SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 223582507f17SOmar Emara environment.insert( 223682507f17SOmar Emara std::make_pair(GetField(i).GetName(), GetField(i).GetValue())); 223782507f17SOmar Emara } 223882507f17SOmar Emara return environment; 223982507f17SOmar Emara } 224082507f17SOmar Emara 224182507f17SOmar Emara void AddEnvironmentVariables(const Environment &environment) { 224282507f17SOmar Emara for (auto &variable : environment) { 224382507f17SOmar Emara AddNewField(); 224482507f17SOmar Emara EnvironmentVariableFieldDelegate &field = 224582507f17SOmar Emara GetField(GetNumberOfFields() - 1); 224682507f17SOmar Emara field.SetName(variable.getKey().str().c_str()); 224782507f17SOmar Emara field.SetValue(variable.getValue().c_str()); 224882507f17SOmar Emara } 224982507f17SOmar Emara } 225062bd3315SOmar Emara }; 225162bd3315SOmar Emara 225229cc50e1SOmar Emara class FormAction { 225329cc50e1SOmar Emara public: 225429cc50e1SOmar Emara FormAction(const char *label, std::function<void(Window &)> action) 225529cc50e1SOmar Emara : m_action(action) { 225629cc50e1SOmar Emara if (label) 225729cc50e1SOmar Emara m_label = label; 225829cc50e1SOmar Emara } 225929cc50e1SOmar Emara 226029cc50e1SOmar Emara // Draw a centered [Label]. 226179e950a2SOmar Emara void Draw(Surface &surface, bool is_selected) { 226229cc50e1SOmar Emara int x = (surface.GetWidth() - m_label.length()) / 2; 226329cc50e1SOmar Emara surface.MoveCursor(x, 0); 226429cc50e1SOmar Emara if (is_selected) 226529cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 226629cc50e1SOmar Emara surface.PutChar('['); 226729cc50e1SOmar Emara surface.PutCString(m_label.c_str()); 226829cc50e1SOmar Emara surface.PutChar(']'); 226929cc50e1SOmar Emara if (is_selected) 227029cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 227129cc50e1SOmar Emara } 227229cc50e1SOmar Emara 227329cc50e1SOmar Emara void Execute(Window &window) { m_action(window); } 227429cc50e1SOmar Emara 227529cc50e1SOmar Emara const std::string &GetLabel() { return m_label; } 227629cc50e1SOmar Emara 227729cc50e1SOmar Emara protected: 227829cc50e1SOmar Emara std::string m_label; 227929cc50e1SOmar Emara std::function<void(Window &)> m_action; 228029cc50e1SOmar Emara }; 228129cc50e1SOmar Emara 228229cc50e1SOmar Emara class FormDelegate { 228329cc50e1SOmar Emara public: 228424f9a2f5SShafik Yaghmour FormDelegate() = default; 228529cc50e1SOmar Emara 228629cc50e1SOmar Emara virtual ~FormDelegate() = default; 228729cc50e1SOmar Emara 22880321dbc8SOmar Emara virtual std::string GetName() = 0; 22890321dbc8SOmar Emara 22902d303e67SKazu Hirata virtual void UpdateFieldsVisibility() {} 22910321dbc8SOmar Emara 22920321dbc8SOmar Emara FieldDelegate *GetField(uint32_t field_index) { 22930321dbc8SOmar Emara if (field_index < m_fields.size()) 22940321dbc8SOmar Emara return m_fields[field_index].get(); 22950321dbc8SOmar Emara return nullptr; 22960321dbc8SOmar Emara } 229729cc50e1SOmar Emara 229829cc50e1SOmar Emara FormAction &GetAction(int action_index) { return m_actions[action_index]; } 229929cc50e1SOmar Emara 230029cc50e1SOmar Emara int GetNumberOfFields() { return m_fields.size(); } 230129cc50e1SOmar Emara 230229cc50e1SOmar Emara int GetNumberOfActions() { return m_actions.size(); } 230329cc50e1SOmar Emara 230429cc50e1SOmar Emara bool HasError() { return !m_error.empty(); } 230529cc50e1SOmar Emara 230629cc50e1SOmar Emara void ClearError() { m_error.clear(); } 230729cc50e1SOmar Emara 230829cc50e1SOmar Emara const std::string &GetError() { return m_error; } 230929cc50e1SOmar Emara 231029cc50e1SOmar Emara void SetError(const char *error) { m_error = error; } 231129cc50e1SOmar Emara 231280ac12b7SOmar Emara // If all fields are valid, true is returned. Otherwise, an error message is 231380ac12b7SOmar Emara // set and false is returned. This method is usually called at the start of an 231480ac12b7SOmar Emara // action that requires valid fields. 231580ac12b7SOmar Emara bool CheckFieldsValidity() { 231680ac12b7SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 2317945cde8bSOmar Emara GetField(i)->FieldDelegateExitCallback(); 231880ac12b7SOmar Emara if (GetField(i)->FieldDelegateHasError()) { 231980ac12b7SOmar Emara SetError("Some fields are invalid!"); 232080ac12b7SOmar Emara return false; 232180ac12b7SOmar Emara } 232280ac12b7SOmar Emara } 232380ac12b7SOmar Emara return true; 232480ac12b7SOmar Emara } 232580ac12b7SOmar Emara 232629cc50e1SOmar Emara // Factory methods to create and add fields of specific types. 232729cc50e1SOmar Emara 23289ef7de7cSOmar Emara TextFieldDelegate *AddTextField(const char *label, const char *content, 23299ef7de7cSOmar Emara bool required) { 23309ef7de7cSOmar Emara TextFieldDelegate *delegate = 23319ef7de7cSOmar Emara new TextFieldDelegate(label, content, required); 23320321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 233329cc50e1SOmar Emara return delegate; 233429cc50e1SOmar Emara } 233529cc50e1SOmar Emara 233629cc50e1SOmar Emara FileFieldDelegate *AddFileField(const char *label, const char *content, 23379ef7de7cSOmar Emara bool need_to_exist, bool required) { 233829cc50e1SOmar Emara FileFieldDelegate *delegate = 23399ef7de7cSOmar Emara new FileFieldDelegate(label, content, need_to_exist, required); 23400321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 234129cc50e1SOmar Emara return delegate; 234229cc50e1SOmar Emara } 234329cc50e1SOmar Emara 234429cc50e1SOmar Emara DirectoryFieldDelegate *AddDirectoryField(const char *label, 234529cc50e1SOmar Emara const char *content, 23469ef7de7cSOmar Emara bool need_to_exist, bool required) { 234729cc50e1SOmar Emara DirectoryFieldDelegate *delegate = 23489ef7de7cSOmar Emara new DirectoryFieldDelegate(label, content, need_to_exist, required); 23490321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 235029cc50e1SOmar Emara return delegate; 235129cc50e1SOmar Emara } 235229cc50e1SOmar Emara 2353ed5b4dbdSOmar Emara ArchFieldDelegate *AddArchField(const char *label, const char *content, 2354ed5b4dbdSOmar Emara bool required) { 2355ed5b4dbdSOmar Emara ArchFieldDelegate *delegate = 2356ed5b4dbdSOmar Emara new ArchFieldDelegate(label, content, required); 2357ed5b4dbdSOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 2358ed5b4dbdSOmar Emara return delegate; 2359ed5b4dbdSOmar Emara } 2360ed5b4dbdSOmar Emara 23619ef7de7cSOmar Emara IntegerFieldDelegate *AddIntegerField(const char *label, int content, 23629ef7de7cSOmar Emara bool required) { 23639ef7de7cSOmar Emara IntegerFieldDelegate *delegate = 23649ef7de7cSOmar Emara new IntegerFieldDelegate(label, content, required); 23650321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 236629cc50e1SOmar Emara return delegate; 236729cc50e1SOmar Emara } 236829cc50e1SOmar Emara 236929cc50e1SOmar Emara BooleanFieldDelegate *AddBooleanField(const char *label, bool content) { 237029cc50e1SOmar Emara BooleanFieldDelegate *delegate = new BooleanFieldDelegate(label, content); 23710321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 237229cc50e1SOmar Emara return delegate; 237329cc50e1SOmar Emara } 237429cc50e1SOmar Emara 237582507f17SOmar Emara LazyBooleanFieldDelegate *AddLazyBooleanField(const char *label, 237682507f17SOmar Emara const char *calculate_label) { 237782507f17SOmar Emara LazyBooleanFieldDelegate *delegate = 237882507f17SOmar Emara new LazyBooleanFieldDelegate(label, calculate_label); 237982507f17SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 238082507f17SOmar Emara return delegate; 238182507f17SOmar Emara } 238282507f17SOmar Emara 238329cc50e1SOmar Emara ChoicesFieldDelegate *AddChoicesField(const char *label, int height, 238429cc50e1SOmar Emara std::vector<std::string> choices) { 238529cc50e1SOmar Emara ChoicesFieldDelegate *delegate = 238629cc50e1SOmar Emara new ChoicesFieldDelegate(label, height, choices); 23870321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 238829cc50e1SOmar Emara return delegate; 238929cc50e1SOmar Emara } 239029cc50e1SOmar Emara 2391e160b398SOmar Emara PlatformPluginFieldDelegate *AddPlatformPluginField(Debugger &debugger) { 2392e160b398SOmar Emara PlatformPluginFieldDelegate *delegate = 2393e160b398SOmar Emara new PlatformPluginFieldDelegate(debugger); 2394e160b398SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 2395e160b398SOmar Emara return delegate; 2396e160b398SOmar Emara } 2397e160b398SOmar Emara 2398c93dc259SOmar Emara ProcessPluginFieldDelegate *AddProcessPluginField() { 2399c93dc259SOmar Emara ProcessPluginFieldDelegate *delegate = new ProcessPluginFieldDelegate(); 2400c93dc259SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 2401c93dc259SOmar Emara return delegate; 2402c93dc259SOmar Emara } 2403c93dc259SOmar Emara 240429cc50e1SOmar Emara template <class T> 240529cc50e1SOmar Emara ListFieldDelegate<T> *AddListField(const char *label, T default_field) { 240629cc50e1SOmar Emara ListFieldDelegate<T> *delegate = 240729cc50e1SOmar Emara new ListFieldDelegate<T>(label, default_field); 24080321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 240929cc50e1SOmar Emara return delegate; 241029cc50e1SOmar Emara } 241129cc50e1SOmar Emara 241282507f17SOmar Emara ArgumentsFieldDelegate *AddArgumentsField() { 241382507f17SOmar Emara ArgumentsFieldDelegate *delegate = new ArgumentsFieldDelegate(); 241482507f17SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 241582507f17SOmar Emara return delegate; 241682507f17SOmar Emara } 241782507f17SOmar Emara 241862bd3315SOmar Emara template <class K, class V> 241962bd3315SOmar Emara MappingFieldDelegate<K, V> *AddMappingField(K key_field, V value_field) { 242062bd3315SOmar Emara MappingFieldDelegate<K, V> *delegate = 242162bd3315SOmar Emara new MappingFieldDelegate<K, V>(key_field, value_field); 242262bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 242362bd3315SOmar Emara return delegate; 242462bd3315SOmar Emara } 242562bd3315SOmar Emara 242662bd3315SOmar Emara EnvironmentVariableNameFieldDelegate * 242762bd3315SOmar Emara AddEnvironmentVariableNameField(const char *content) { 242862bd3315SOmar Emara EnvironmentVariableNameFieldDelegate *delegate = 242962bd3315SOmar Emara new EnvironmentVariableNameFieldDelegate(content); 243062bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 243162bd3315SOmar Emara return delegate; 243262bd3315SOmar Emara } 243362bd3315SOmar Emara 243462bd3315SOmar Emara EnvironmentVariableFieldDelegate *AddEnvironmentVariableField() { 243562bd3315SOmar Emara EnvironmentVariableFieldDelegate *delegate = 243662bd3315SOmar Emara new EnvironmentVariableFieldDelegate(); 243762bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 243862bd3315SOmar Emara return delegate; 243962bd3315SOmar Emara } 244062bd3315SOmar Emara 244182507f17SOmar Emara EnvironmentVariableListFieldDelegate * 244282507f17SOmar Emara AddEnvironmentVariableListField(const char *label) { 244362bd3315SOmar Emara EnvironmentVariableListFieldDelegate *delegate = 244482507f17SOmar Emara new EnvironmentVariableListFieldDelegate(label); 244562bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 244662bd3315SOmar Emara return delegate; 244762bd3315SOmar Emara } 244862bd3315SOmar Emara 244929cc50e1SOmar Emara // Factory methods for adding actions. 245029cc50e1SOmar Emara 245129cc50e1SOmar Emara void AddAction(const char *label, std::function<void(Window &)> action) { 245229cc50e1SOmar Emara m_actions.push_back(FormAction(label, action)); 245329cc50e1SOmar Emara } 245429cc50e1SOmar Emara 245529cc50e1SOmar Emara protected: 24560321dbc8SOmar Emara std::vector<FieldDelegateUP> m_fields; 245729cc50e1SOmar Emara std::vector<FormAction> m_actions; 245829cc50e1SOmar Emara // Optional error message. If empty, form is considered to have no error. 245929cc50e1SOmar Emara std::string m_error; 246029cc50e1SOmar Emara }; 246129cc50e1SOmar Emara 246229cc50e1SOmar Emara typedef std::shared_ptr<FormDelegate> FormDelegateSP; 246329cc50e1SOmar Emara 246429cc50e1SOmar Emara class FormWindowDelegate : public WindowDelegate { 246529cc50e1SOmar Emara public: 246628c878aeSShafik Yaghmour FormWindowDelegate(FormDelegateSP &delegate_sp) : m_delegate_sp(delegate_sp) { 24670321dbc8SOmar Emara assert(m_delegate_sp->GetNumberOfActions() > 0); 24680321dbc8SOmar Emara if (m_delegate_sp->GetNumberOfFields() > 0) 24690321dbc8SOmar Emara m_selection_type = SelectionType::Field; 24700321dbc8SOmar Emara else 24710321dbc8SOmar Emara m_selection_type = SelectionType::Action; 24720321dbc8SOmar Emara } 247329cc50e1SOmar Emara 247429cc50e1SOmar Emara // Signify which element is selected. If a field or an action is selected, 247529cc50e1SOmar Emara // then m_selection_index signifies the particular field or action that is 247629cc50e1SOmar Emara // selected. 247729cc50e1SOmar Emara enum class SelectionType { Field, Action }; 247829cc50e1SOmar Emara 247929cc50e1SOmar Emara // A form window is padded by one character from all sides. First, if an error 248029cc50e1SOmar Emara // message exists, it is drawn followed by a separator. Then one or more 248129cc50e1SOmar Emara // fields are drawn. Finally, all available actions are drawn on a single 248229cc50e1SOmar Emara // line. 248329cc50e1SOmar Emara // 248429cc50e1SOmar Emara // ___<Form Name>_________________________________________________ 248529cc50e1SOmar Emara // | | 248629cc50e1SOmar Emara // | - Error message if it exists. | 248729cc50e1SOmar Emara // |-------------------------------------------------------------| 248829cc50e1SOmar Emara // | Form elements here. | 248929cc50e1SOmar Emara // | Form actions here. | 249029cc50e1SOmar Emara // | | 249129cc50e1SOmar Emara // |______________________________________[Press Esc to cancel]__| 249229cc50e1SOmar Emara // 249329cc50e1SOmar Emara 249429cc50e1SOmar Emara // One line for the error and another for the horizontal line. 249529cc50e1SOmar Emara int GetErrorHeight() { 249629cc50e1SOmar Emara if (m_delegate_sp->HasError()) 249729cc50e1SOmar Emara return 2; 249829cc50e1SOmar Emara return 0; 249929cc50e1SOmar Emara } 250029cc50e1SOmar Emara 250129cc50e1SOmar Emara // Actions span a single line. 250229cc50e1SOmar Emara int GetActionsHeight() { 250329cc50e1SOmar Emara if (m_delegate_sp->GetNumberOfActions() > 0) 250429cc50e1SOmar Emara return 1; 250529cc50e1SOmar Emara return 0; 250629cc50e1SOmar Emara } 250729cc50e1SOmar Emara 250829cc50e1SOmar Emara // Get the total number of needed lines to draw the contents. 250929cc50e1SOmar Emara int GetContentHeight() { 251029cc50e1SOmar Emara int height = 0; 251129cc50e1SOmar Emara height += GetErrorHeight(); 251229cc50e1SOmar Emara for (int i = 0; i < m_delegate_sp->GetNumberOfFields(); i++) { 25130321dbc8SOmar Emara if (!m_delegate_sp->GetField(i)->FieldDelegateIsVisible()) 25140321dbc8SOmar Emara continue; 251529cc50e1SOmar Emara height += m_delegate_sp->GetField(i)->FieldDelegateGetHeight(); 251629cc50e1SOmar Emara } 251729cc50e1SOmar Emara height += GetActionsHeight(); 251829cc50e1SOmar Emara return height; 251929cc50e1SOmar Emara } 252029cc50e1SOmar Emara 252129cc50e1SOmar Emara ScrollContext GetScrollContext() { 252229cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) 252329cc50e1SOmar Emara return ScrollContext(GetContentHeight() - 1); 252429cc50e1SOmar Emara 25250321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 252629cc50e1SOmar Emara ScrollContext context = field->FieldDelegateGetScrollContext(); 252729cc50e1SOmar Emara 252829cc50e1SOmar Emara int offset = GetErrorHeight(); 252929cc50e1SOmar Emara for (int i = 0; i < m_selection_index; i++) { 25300321dbc8SOmar Emara if (!m_delegate_sp->GetField(i)->FieldDelegateIsVisible()) 25310321dbc8SOmar Emara continue; 253229cc50e1SOmar Emara offset += m_delegate_sp->GetField(i)->FieldDelegateGetHeight(); 253329cc50e1SOmar Emara } 253429cc50e1SOmar Emara context.Offset(offset); 253529cc50e1SOmar Emara 253629cc50e1SOmar Emara // If the context is touching the error, include the error in the context as 253729cc50e1SOmar Emara // well. 253829cc50e1SOmar Emara if (context.start == GetErrorHeight()) 253929cc50e1SOmar Emara context.start = 0; 254029cc50e1SOmar Emara 254129cc50e1SOmar Emara return context; 254229cc50e1SOmar Emara } 254329cc50e1SOmar Emara 254479e950a2SOmar Emara void UpdateScrolling(Surface &surface) { 254529cc50e1SOmar Emara ScrollContext context = GetScrollContext(); 254629cc50e1SOmar Emara int content_height = GetContentHeight(); 254729cc50e1SOmar Emara int surface_height = surface.GetHeight(); 254829cc50e1SOmar Emara int visible_height = std::min(content_height, surface_height); 254929cc50e1SOmar Emara int last_visible_line = m_first_visible_line + visible_height - 1; 255029cc50e1SOmar Emara 255129cc50e1SOmar Emara // If the last visible line is bigger than the content, then it is invalid 255229cc50e1SOmar Emara // and needs to be set to the last line in the content. This can happen when 255329cc50e1SOmar Emara // a field has shrunk in height. 255429cc50e1SOmar Emara if (last_visible_line > content_height - 1) { 255529cc50e1SOmar Emara m_first_visible_line = content_height - visible_height; 255629cc50e1SOmar Emara } 255729cc50e1SOmar Emara 255829cc50e1SOmar Emara if (context.start < m_first_visible_line) { 255929cc50e1SOmar Emara m_first_visible_line = context.start; 256029cc50e1SOmar Emara return; 256129cc50e1SOmar Emara } 256229cc50e1SOmar Emara 256329cc50e1SOmar Emara if (context.end > last_visible_line) { 256429cc50e1SOmar Emara m_first_visible_line = context.end - visible_height + 1; 256529cc50e1SOmar Emara } 256629cc50e1SOmar Emara } 256729cc50e1SOmar Emara 256879e950a2SOmar Emara void DrawError(Surface &surface) { 256929cc50e1SOmar Emara if (!m_delegate_sp->HasError()) 257029cc50e1SOmar Emara return; 257129cc50e1SOmar Emara surface.MoveCursor(0, 0); 257229cc50e1SOmar Emara surface.AttributeOn(COLOR_PAIR(RedOnBlack)); 257329cc50e1SOmar Emara surface.PutChar(ACS_DIAMOND); 257429cc50e1SOmar Emara surface.PutChar(' '); 257529cc50e1SOmar Emara surface.PutCStringTruncated(1, m_delegate_sp->GetError().c_str()); 257629cc50e1SOmar Emara surface.AttributeOff(COLOR_PAIR(RedOnBlack)); 257729cc50e1SOmar Emara 257829cc50e1SOmar Emara surface.MoveCursor(0, 1); 257929cc50e1SOmar Emara surface.HorizontalLine(surface.GetWidth()); 258029cc50e1SOmar Emara } 258129cc50e1SOmar Emara 258279e950a2SOmar Emara void DrawFields(Surface &surface) { 258329cc50e1SOmar Emara int line = 0; 258429cc50e1SOmar Emara int width = surface.GetWidth(); 258529cc50e1SOmar Emara bool a_field_is_selected = m_selection_type == SelectionType::Field; 258629cc50e1SOmar Emara for (int i = 0; i < m_delegate_sp->GetNumberOfFields(); i++) { 25870321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(i); 25880321dbc8SOmar Emara if (!field->FieldDelegateIsVisible()) 25890321dbc8SOmar Emara continue; 259029cc50e1SOmar Emara bool is_field_selected = a_field_is_selected && m_selection_index == i; 259129cc50e1SOmar Emara int height = field->FieldDelegateGetHeight(); 259229cc50e1SOmar Emara Rect bounds = Rect(Point(0, line), Size(width, height)); 259379e950a2SOmar Emara Surface field_surface = surface.SubSurface(bounds); 259429cc50e1SOmar Emara field->FieldDelegateDraw(field_surface, is_field_selected); 259529cc50e1SOmar Emara line += height; 259629cc50e1SOmar Emara } 259729cc50e1SOmar Emara } 259829cc50e1SOmar Emara 259979e950a2SOmar Emara void DrawActions(Surface &surface) { 260029cc50e1SOmar Emara int number_of_actions = m_delegate_sp->GetNumberOfActions(); 260129cc50e1SOmar Emara int width = surface.GetWidth() / number_of_actions; 260229cc50e1SOmar Emara bool an_action_is_selected = m_selection_type == SelectionType::Action; 260329cc50e1SOmar Emara int x = 0; 260429cc50e1SOmar Emara for (int i = 0; i < number_of_actions; i++) { 260529cc50e1SOmar Emara bool is_action_selected = an_action_is_selected && m_selection_index == i; 260629cc50e1SOmar Emara FormAction &action = m_delegate_sp->GetAction(i); 260729cc50e1SOmar Emara Rect bounds = Rect(Point(x, 0), Size(width, 1)); 260879e950a2SOmar Emara Surface action_surface = surface.SubSurface(bounds); 260929cc50e1SOmar Emara action.Draw(action_surface, is_action_selected); 261029cc50e1SOmar Emara x += width; 261129cc50e1SOmar Emara } 261229cc50e1SOmar Emara } 261329cc50e1SOmar Emara 261479e950a2SOmar Emara void DrawElements(Surface &surface) { 261529cc50e1SOmar Emara Rect frame = surface.GetFrame(); 261629cc50e1SOmar Emara Rect fields_bounds, actions_bounds; 261729cc50e1SOmar Emara frame.HorizontalSplit(surface.GetHeight() - GetActionsHeight(), 261829cc50e1SOmar Emara fields_bounds, actions_bounds); 261979e950a2SOmar Emara Surface fields_surface = surface.SubSurface(fields_bounds); 262079e950a2SOmar Emara Surface actions_surface = surface.SubSurface(actions_bounds); 262129cc50e1SOmar Emara 262229cc50e1SOmar Emara DrawFields(fields_surface); 262329cc50e1SOmar Emara DrawActions(actions_surface); 262429cc50e1SOmar Emara } 262529cc50e1SOmar Emara 262629cc50e1SOmar Emara // Contents are first drawn on a pad. Then a subset of that pad is copied to 262729cc50e1SOmar Emara // the derived window starting at the first visible line. This essentially 262829cc50e1SOmar Emara // provides scrolling functionality. 262979e950a2SOmar Emara void DrawContent(Surface &surface) { 263029cc50e1SOmar Emara UpdateScrolling(surface); 263129cc50e1SOmar Emara 263229cc50e1SOmar Emara int width = surface.GetWidth(); 263329cc50e1SOmar Emara int height = GetContentHeight(); 263429cc50e1SOmar Emara Pad pad = Pad(Size(width, height)); 263529cc50e1SOmar Emara 263629cc50e1SOmar Emara Rect frame = pad.GetFrame(); 263729cc50e1SOmar Emara Rect error_bounds, elements_bounds; 263829cc50e1SOmar Emara frame.HorizontalSplit(GetErrorHeight(), error_bounds, elements_bounds); 263979e950a2SOmar Emara Surface error_surface = pad.SubSurface(error_bounds); 264079e950a2SOmar Emara Surface elements_surface = pad.SubSurface(elements_bounds); 264129cc50e1SOmar Emara 264229cc50e1SOmar Emara DrawError(error_surface); 264329cc50e1SOmar Emara DrawElements(elements_surface); 264429cc50e1SOmar Emara 264529cc50e1SOmar Emara int copy_height = std::min(surface.GetHeight(), pad.GetHeight()); 264629cc50e1SOmar Emara pad.CopyToSurface(surface, Point(0, m_first_visible_line), Point(), 264729cc50e1SOmar Emara Size(width, copy_height)); 264829cc50e1SOmar Emara } 264929cc50e1SOmar Emara 2650945cde8bSOmar Emara void DrawSubmitHint(Surface &surface, bool is_active) { 2651945cde8bSOmar Emara surface.MoveCursor(2, surface.GetHeight() - 1); 2652945cde8bSOmar Emara if (is_active) 2653945cde8bSOmar Emara surface.AttributeOn(A_BOLD | COLOR_PAIR(BlackOnWhite)); 2654945cde8bSOmar Emara surface.Printf("[Press Alt+Enter to %s]", 2655945cde8bSOmar Emara m_delegate_sp->GetAction(0).GetLabel().c_str()); 2656945cde8bSOmar Emara if (is_active) 2657945cde8bSOmar Emara surface.AttributeOff(A_BOLD | COLOR_PAIR(BlackOnWhite)); 2658945cde8bSOmar Emara } 2659945cde8bSOmar Emara 266029cc50e1SOmar Emara bool WindowDelegateDraw(Window &window, bool force) override { 26610321dbc8SOmar Emara m_delegate_sp->UpdateFieldsVisibility(); 266229cc50e1SOmar Emara 266329cc50e1SOmar Emara window.Erase(); 266429cc50e1SOmar Emara 26650321dbc8SOmar Emara window.DrawTitleBox(m_delegate_sp->GetName().c_str(), 2666945cde8bSOmar Emara "Press Esc to Cancel"); 2667945cde8bSOmar Emara DrawSubmitHint(window, window.IsActive()); 266829cc50e1SOmar Emara 266929cc50e1SOmar Emara Rect content_bounds = window.GetFrame(); 267029cc50e1SOmar Emara content_bounds.Inset(2, 2); 267179e950a2SOmar Emara Surface content_surface = window.SubSurface(content_bounds); 267229cc50e1SOmar Emara 267329cc50e1SOmar Emara DrawContent(content_surface); 267429cc50e1SOmar Emara return true; 267529cc50e1SOmar Emara } 267629cc50e1SOmar Emara 26770321dbc8SOmar Emara void SkipNextHiddenFields() { 26780321dbc8SOmar Emara while (true) { 26790321dbc8SOmar Emara if (m_delegate_sp->GetField(m_selection_index)->FieldDelegateIsVisible()) 26800321dbc8SOmar Emara return; 26810321dbc8SOmar Emara 26820321dbc8SOmar Emara if (m_selection_index == m_delegate_sp->GetNumberOfFields() - 1) { 26830321dbc8SOmar Emara m_selection_type = SelectionType::Action; 26840321dbc8SOmar Emara m_selection_index = 0; 26850321dbc8SOmar Emara return; 26860321dbc8SOmar Emara } 26870321dbc8SOmar Emara 26880321dbc8SOmar Emara m_selection_index++; 26890321dbc8SOmar Emara } 26900321dbc8SOmar Emara } 26910321dbc8SOmar Emara 26920321dbc8SOmar Emara HandleCharResult SelectNext(int key) { 269329cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) { 269429cc50e1SOmar Emara if (m_selection_index < m_delegate_sp->GetNumberOfActions() - 1) { 269529cc50e1SOmar Emara m_selection_index++; 269629cc50e1SOmar Emara return eKeyHandled; 269729cc50e1SOmar Emara } 269829cc50e1SOmar Emara 269929cc50e1SOmar Emara m_selection_index = 0; 270029cc50e1SOmar Emara m_selection_type = SelectionType::Field; 27010321dbc8SOmar Emara SkipNextHiddenFields(); 27020321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27030321dbc8SOmar Emara FieldDelegate *next_field = m_delegate_sp->GetField(m_selection_index); 270429cc50e1SOmar Emara next_field->FieldDelegateSelectFirstElement(); 27050321dbc8SOmar Emara } 270629cc50e1SOmar Emara return eKeyHandled; 270729cc50e1SOmar Emara } 270829cc50e1SOmar Emara 27090321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 271029cc50e1SOmar Emara if (!field->FieldDelegateOnLastOrOnlyElement()) { 271129cc50e1SOmar Emara return field->FieldDelegateHandleChar(key); 271229cc50e1SOmar Emara } 271329cc50e1SOmar Emara 271429cc50e1SOmar Emara field->FieldDelegateExitCallback(); 271529cc50e1SOmar Emara 271629cc50e1SOmar Emara if (m_selection_index == m_delegate_sp->GetNumberOfFields() - 1) { 271729cc50e1SOmar Emara m_selection_type = SelectionType::Action; 271829cc50e1SOmar Emara m_selection_index = 0; 271929cc50e1SOmar Emara return eKeyHandled; 272029cc50e1SOmar Emara } 272129cc50e1SOmar Emara 272229cc50e1SOmar Emara m_selection_index++; 27230321dbc8SOmar Emara SkipNextHiddenFields(); 272429cc50e1SOmar Emara 27250321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27260321dbc8SOmar Emara FieldDelegate *next_field = m_delegate_sp->GetField(m_selection_index); 272729cc50e1SOmar Emara next_field->FieldDelegateSelectFirstElement(); 27280321dbc8SOmar Emara } 272929cc50e1SOmar Emara 273029cc50e1SOmar Emara return eKeyHandled; 273129cc50e1SOmar Emara } 273229cc50e1SOmar Emara 27330321dbc8SOmar Emara void SkipPreviousHiddenFields() { 27340321dbc8SOmar Emara while (true) { 27350321dbc8SOmar Emara if (m_delegate_sp->GetField(m_selection_index)->FieldDelegateIsVisible()) 27360321dbc8SOmar Emara return; 27370321dbc8SOmar Emara 27380321dbc8SOmar Emara if (m_selection_index == 0) { 27390321dbc8SOmar Emara m_selection_type = SelectionType::Action; 27400321dbc8SOmar Emara m_selection_index = 0; 27410321dbc8SOmar Emara return; 27420321dbc8SOmar Emara } 27430321dbc8SOmar Emara 27440321dbc8SOmar Emara m_selection_index--; 27450321dbc8SOmar Emara } 27460321dbc8SOmar Emara } 27470321dbc8SOmar Emara 27480321dbc8SOmar Emara HandleCharResult SelectPrevious(int key) { 274929cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) { 275029cc50e1SOmar Emara if (m_selection_index > 0) { 275129cc50e1SOmar Emara m_selection_index--; 275229cc50e1SOmar Emara return eKeyHandled; 275329cc50e1SOmar Emara } 275429cc50e1SOmar Emara m_selection_index = m_delegate_sp->GetNumberOfFields() - 1; 275529cc50e1SOmar Emara m_selection_type = SelectionType::Field; 27560321dbc8SOmar Emara SkipPreviousHiddenFields(); 27570321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27580321dbc8SOmar Emara FieldDelegate *previous_field = 275929cc50e1SOmar Emara m_delegate_sp->GetField(m_selection_index); 276029cc50e1SOmar Emara previous_field->FieldDelegateSelectLastElement(); 27610321dbc8SOmar Emara } 276229cc50e1SOmar Emara return eKeyHandled; 276329cc50e1SOmar Emara } 276429cc50e1SOmar Emara 27650321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 276629cc50e1SOmar Emara if (!field->FieldDelegateOnFirstOrOnlyElement()) { 276729cc50e1SOmar Emara return field->FieldDelegateHandleChar(key); 276829cc50e1SOmar Emara } 276929cc50e1SOmar Emara 277029cc50e1SOmar Emara field->FieldDelegateExitCallback(); 277129cc50e1SOmar Emara 277229cc50e1SOmar Emara if (m_selection_index == 0) { 277329cc50e1SOmar Emara m_selection_type = SelectionType::Action; 277429cc50e1SOmar Emara m_selection_index = m_delegate_sp->GetNumberOfActions() - 1; 277529cc50e1SOmar Emara return eKeyHandled; 277629cc50e1SOmar Emara } 277729cc50e1SOmar Emara 277829cc50e1SOmar Emara m_selection_index--; 27790321dbc8SOmar Emara SkipPreviousHiddenFields(); 278029cc50e1SOmar Emara 27810321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27820321dbc8SOmar Emara FieldDelegate *previous_field = 278329cc50e1SOmar Emara m_delegate_sp->GetField(m_selection_index); 278429cc50e1SOmar Emara previous_field->FieldDelegateSelectLastElement(); 27850321dbc8SOmar Emara } 278629cc50e1SOmar Emara 278729cc50e1SOmar Emara return eKeyHandled; 278829cc50e1SOmar Emara } 278929cc50e1SOmar Emara 2790945cde8bSOmar Emara void ExecuteAction(Window &window, int index) { 2791945cde8bSOmar Emara FormAction &action = m_delegate_sp->GetAction(index); 279229cc50e1SOmar Emara action.Execute(window); 27930321dbc8SOmar Emara if (m_delegate_sp->HasError()) { 279429cc50e1SOmar Emara m_first_visible_line = 0; 279529cc50e1SOmar Emara m_selection_index = 0; 279629cc50e1SOmar Emara m_selection_type = SelectionType::Field; 279729cc50e1SOmar Emara } 27980321dbc8SOmar Emara } 279929cc50e1SOmar Emara 2800292f0133SOmar Emara // Always return eKeyHandled to absorb all events since forms are always 2801292f0133SOmar Emara // added as pop-ups that should take full control until canceled or submitted. 280229cc50e1SOmar Emara HandleCharResult WindowDelegateHandleChar(Window &window, int key) override { 280329cc50e1SOmar Emara switch (key) { 280429cc50e1SOmar Emara case '\r': 280529cc50e1SOmar Emara case '\n': 280629cc50e1SOmar Emara case KEY_ENTER: 280729cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) { 2808945cde8bSOmar Emara ExecuteAction(window, m_selection_index); 280929cc50e1SOmar Emara return eKeyHandled; 281029cc50e1SOmar Emara } 281129cc50e1SOmar Emara break; 2812945cde8bSOmar Emara case KEY_ALT_ENTER: 2813945cde8bSOmar Emara ExecuteAction(window, 0); 2814945cde8bSOmar Emara return eKeyHandled; 281529cc50e1SOmar Emara case '\t': 2816292f0133SOmar Emara SelectNext(key); 2817292f0133SOmar Emara return eKeyHandled; 281829cc50e1SOmar Emara case KEY_SHIFT_TAB: 2819292f0133SOmar Emara SelectPrevious(key); 2820292f0133SOmar Emara return eKeyHandled; 282129cc50e1SOmar Emara case KEY_ESCAPE: 282229cc50e1SOmar Emara window.GetParent()->RemoveSubWindow(&window); 282329cc50e1SOmar Emara return eKeyHandled; 282429cc50e1SOmar Emara default: 282529cc50e1SOmar Emara break; 282629cc50e1SOmar Emara } 282729cc50e1SOmar Emara 282829cc50e1SOmar Emara // If the key wasn't handled and one of the fields is selected, pass the key 282929cc50e1SOmar Emara // to that field. 283029cc50e1SOmar Emara if (m_selection_type == SelectionType::Field) { 28310321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 2832292f0133SOmar Emara if (field->FieldDelegateHandleChar(key) == eKeyHandled) 2833292f0133SOmar Emara return eKeyHandled; 283429cc50e1SOmar Emara } 283529cc50e1SOmar Emara 2836292f0133SOmar Emara // If the key wasn't handled by the possibly selected field, handle some 2837292f0133SOmar Emara // extra keys for navigation. 2838292f0133SOmar Emara switch (key) { 2839292f0133SOmar Emara case KEY_DOWN: 2840292f0133SOmar Emara SelectNext(key); 2841292f0133SOmar Emara return eKeyHandled; 2842292f0133SOmar Emara case KEY_UP: 2843292f0133SOmar Emara SelectPrevious(key); 2844292f0133SOmar Emara return eKeyHandled; 2845292f0133SOmar Emara default: 2846292f0133SOmar Emara break; 2847292f0133SOmar Emara } 2848292f0133SOmar Emara 2849292f0133SOmar Emara return eKeyHandled; 285029cc50e1SOmar Emara } 285129cc50e1SOmar Emara 285229cc50e1SOmar Emara protected: 285329cc50e1SOmar Emara FormDelegateSP m_delegate_sp; 285429cc50e1SOmar Emara // The index of the currently selected SelectionType. 285528c878aeSShafik Yaghmour int m_selection_index = 0; 285629cc50e1SOmar Emara // See SelectionType class enum. 285729cc50e1SOmar Emara SelectionType m_selection_type; 285829cc50e1SOmar Emara // The first visible line from the pad. 285928c878aeSShafik Yaghmour int m_first_visible_line = 0; 286029cc50e1SOmar Emara }; 286129cc50e1SOmar Emara 28620321dbc8SOmar Emara /////////////////////////// 28630321dbc8SOmar Emara // Form Delegate Instances 28640321dbc8SOmar Emara /////////////////////////// 28650321dbc8SOmar Emara 28660321dbc8SOmar Emara class DetachOrKillProcessFormDelegate : public FormDelegate { 28670321dbc8SOmar Emara public: 28680321dbc8SOmar Emara DetachOrKillProcessFormDelegate(Process *process) : m_process(process) { 28690321dbc8SOmar Emara SetError("There is a running process, either detach or kill it."); 28700321dbc8SOmar Emara 28710321dbc8SOmar Emara m_keep_stopped_field = 28720321dbc8SOmar Emara AddBooleanField("Keep process stopped when detaching.", false); 28730321dbc8SOmar Emara 28740321dbc8SOmar Emara AddAction("Detach", [this](Window &window) { Detach(window); }); 28750321dbc8SOmar Emara AddAction("Kill", [this](Window &window) { Kill(window); }); 28760321dbc8SOmar Emara } 28770321dbc8SOmar Emara 28780321dbc8SOmar Emara std::string GetName() override { return "Detach/Kill Process"; } 28790321dbc8SOmar Emara 28800321dbc8SOmar Emara void Kill(Window &window) { 28810321dbc8SOmar Emara Status destroy_status(m_process->Destroy(false)); 28820321dbc8SOmar Emara if (destroy_status.Fail()) { 28830321dbc8SOmar Emara SetError("Failed to kill process."); 28840321dbc8SOmar Emara return; 28850321dbc8SOmar Emara } 28860321dbc8SOmar Emara window.GetParent()->RemoveSubWindow(&window); 28870321dbc8SOmar Emara } 28880321dbc8SOmar Emara 28890321dbc8SOmar Emara void Detach(Window &window) { 28900321dbc8SOmar Emara Status detach_status(m_process->Detach(m_keep_stopped_field->GetBoolean())); 28910321dbc8SOmar Emara if (detach_status.Fail()) { 28920321dbc8SOmar Emara SetError("Failed to detach from process."); 28930321dbc8SOmar Emara return; 28940321dbc8SOmar Emara } 28950321dbc8SOmar Emara window.GetParent()->RemoveSubWindow(&window); 28960321dbc8SOmar Emara } 28970321dbc8SOmar Emara 28980321dbc8SOmar Emara protected: 28990321dbc8SOmar Emara Process *m_process; 29000321dbc8SOmar Emara BooleanFieldDelegate *m_keep_stopped_field; 29010321dbc8SOmar Emara }; 29020321dbc8SOmar Emara 29030321dbc8SOmar Emara class ProcessAttachFormDelegate : public FormDelegate { 29040321dbc8SOmar Emara public: 29050321dbc8SOmar Emara ProcessAttachFormDelegate(Debugger &debugger, WindowSP main_window_sp) 29060321dbc8SOmar Emara : m_debugger(debugger), m_main_window_sp(main_window_sp) { 29070321dbc8SOmar Emara std::vector<std::string> types; 29080321dbc8SOmar Emara types.push_back(std::string("Name")); 29090321dbc8SOmar Emara types.push_back(std::string("PID")); 29100321dbc8SOmar Emara m_type_field = AddChoicesField("Attach By", 2, types); 29119ef7de7cSOmar Emara m_pid_field = AddIntegerField("PID", 0, true); 29120321dbc8SOmar Emara m_name_field = 29139ef7de7cSOmar Emara AddTextField("Process Name", GetDefaultProcessName().c_str(), true); 29140321dbc8SOmar Emara m_continue_field = AddBooleanField("Continue once attached.", false); 29150321dbc8SOmar Emara m_wait_for_field = AddBooleanField("Wait for process to launch.", false); 29160321dbc8SOmar Emara m_include_existing_field = 29170321dbc8SOmar Emara AddBooleanField("Include existing processes.", false); 29180321dbc8SOmar Emara m_show_advanced_field = AddBooleanField("Show advanced settings.", false); 2919c93dc259SOmar Emara m_plugin_field = AddProcessPluginField(); 29200321dbc8SOmar Emara 29210321dbc8SOmar Emara AddAction("Attach", [this](Window &window) { Attach(window); }); 29220321dbc8SOmar Emara } 29230321dbc8SOmar Emara 29240321dbc8SOmar Emara std::string GetName() override { return "Attach Process"; } 29250321dbc8SOmar Emara 29260321dbc8SOmar Emara void UpdateFieldsVisibility() override { 29270321dbc8SOmar Emara if (m_type_field->GetChoiceContent() == "Name") { 29280321dbc8SOmar Emara m_pid_field->FieldDelegateHide(); 29290321dbc8SOmar Emara m_name_field->FieldDelegateShow(); 29300321dbc8SOmar Emara m_wait_for_field->FieldDelegateShow(); 29310321dbc8SOmar Emara if (m_wait_for_field->GetBoolean()) 29320321dbc8SOmar Emara m_include_existing_field->FieldDelegateShow(); 29330321dbc8SOmar Emara else 29340321dbc8SOmar Emara m_include_existing_field->FieldDelegateHide(); 29350321dbc8SOmar Emara } else { 29360321dbc8SOmar Emara m_pid_field->FieldDelegateShow(); 29370321dbc8SOmar Emara m_name_field->FieldDelegateHide(); 29380321dbc8SOmar Emara m_wait_for_field->FieldDelegateHide(); 29390321dbc8SOmar Emara m_include_existing_field->FieldDelegateHide(); 29400321dbc8SOmar Emara } 29410321dbc8SOmar Emara if (m_show_advanced_field->GetBoolean()) 29420321dbc8SOmar Emara m_plugin_field->FieldDelegateShow(); 29430321dbc8SOmar Emara else 29440321dbc8SOmar Emara m_plugin_field->FieldDelegateHide(); 29450321dbc8SOmar Emara } 29460321dbc8SOmar Emara 29470321dbc8SOmar Emara // Get the basename of the target's main executable if available, empty string 29480321dbc8SOmar Emara // otherwise. 29490321dbc8SOmar Emara std::string GetDefaultProcessName() { 29500321dbc8SOmar Emara Target *target = m_debugger.GetSelectedTarget().get(); 29510321dbc8SOmar Emara if (target == nullptr) 29520321dbc8SOmar Emara return ""; 29530321dbc8SOmar Emara 29540321dbc8SOmar Emara ModuleSP module_sp = target->GetExecutableModule(); 29550321dbc8SOmar Emara if (!module_sp->IsExecutable()) 29560321dbc8SOmar Emara return ""; 29570321dbc8SOmar Emara 29580321dbc8SOmar Emara return module_sp->GetFileSpec().GetFilename().AsCString(); 29590321dbc8SOmar Emara } 29600321dbc8SOmar Emara 29610321dbc8SOmar Emara bool StopRunningProcess() { 29620321dbc8SOmar Emara ExecutionContext exe_ctx = 29630321dbc8SOmar Emara m_debugger.GetCommandInterpreter().GetExecutionContext(); 29640321dbc8SOmar Emara 29650321dbc8SOmar Emara if (!exe_ctx.HasProcessScope()) 29660321dbc8SOmar Emara return false; 29670321dbc8SOmar Emara 29680321dbc8SOmar Emara Process *process = exe_ctx.GetProcessPtr(); 29690321dbc8SOmar Emara if (!(process && process->IsAlive())) 29700321dbc8SOmar Emara return false; 29710321dbc8SOmar Emara 29720321dbc8SOmar Emara FormDelegateSP form_delegate_sp = 29730321dbc8SOmar Emara FormDelegateSP(new DetachOrKillProcessFormDelegate(process)); 29740321dbc8SOmar Emara Rect bounds = m_main_window_sp->GetCenteredRect(85, 8); 29750321dbc8SOmar Emara WindowSP form_window_sp = m_main_window_sp->CreateSubWindow( 29760321dbc8SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 29770321dbc8SOmar Emara WindowDelegateSP window_delegate_sp = 29780321dbc8SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 29790321dbc8SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 29800321dbc8SOmar Emara 29810321dbc8SOmar Emara return true; 29820321dbc8SOmar Emara } 29830321dbc8SOmar Emara 29840321dbc8SOmar Emara Target *GetTarget() { 29850321dbc8SOmar Emara Target *target = m_debugger.GetSelectedTarget().get(); 29860321dbc8SOmar Emara 29870321dbc8SOmar Emara if (target != nullptr) 29880321dbc8SOmar Emara return target; 29890321dbc8SOmar Emara 29900321dbc8SOmar Emara TargetSP new_target_sp; 29910321dbc8SOmar Emara m_debugger.GetTargetList().CreateTarget( 29920321dbc8SOmar Emara m_debugger, "", "", eLoadDependentsNo, nullptr, new_target_sp); 29930321dbc8SOmar Emara 29940321dbc8SOmar Emara target = new_target_sp.get(); 29950321dbc8SOmar Emara 29960321dbc8SOmar Emara if (target == nullptr) 29970321dbc8SOmar Emara SetError("Failed to create target."); 29980321dbc8SOmar Emara 29990321dbc8SOmar Emara m_debugger.GetTargetList().SetSelectedTarget(new_target_sp); 30000321dbc8SOmar Emara 30010321dbc8SOmar Emara return target; 30020321dbc8SOmar Emara } 30030321dbc8SOmar Emara 30040321dbc8SOmar Emara ProcessAttachInfo GetAttachInfo() { 30050321dbc8SOmar Emara ProcessAttachInfo attach_info; 30060321dbc8SOmar Emara attach_info.SetContinueOnceAttached(m_continue_field->GetBoolean()); 30070321dbc8SOmar Emara if (m_type_field->GetChoiceContent() == "Name") { 30080321dbc8SOmar Emara attach_info.GetExecutableFile().SetFile(m_name_field->GetText(), 30090321dbc8SOmar Emara FileSpec::Style::native); 30100321dbc8SOmar Emara attach_info.SetWaitForLaunch(m_wait_for_field->GetBoolean()); 30110321dbc8SOmar Emara if (m_wait_for_field->GetBoolean()) 30120321dbc8SOmar Emara attach_info.SetIgnoreExisting(!m_include_existing_field->GetBoolean()); 30130321dbc8SOmar Emara } else { 30140321dbc8SOmar Emara attach_info.SetProcessID(m_pid_field->GetInteger()); 30150321dbc8SOmar Emara } 3016c93dc259SOmar Emara attach_info.SetProcessPluginName(m_plugin_field->GetPluginName()); 30170321dbc8SOmar Emara 30180321dbc8SOmar Emara return attach_info; 30190321dbc8SOmar Emara } 30200321dbc8SOmar Emara 30210321dbc8SOmar Emara void Attach(Window &window) { 30220321dbc8SOmar Emara ClearError(); 30230321dbc8SOmar Emara 302480ac12b7SOmar Emara bool all_fields_are_valid = CheckFieldsValidity(); 302580ac12b7SOmar Emara if (!all_fields_are_valid) 302680ac12b7SOmar Emara return; 302780ac12b7SOmar Emara 30280321dbc8SOmar Emara bool process_is_running = StopRunningProcess(); 30290321dbc8SOmar Emara if (process_is_running) 30300321dbc8SOmar Emara return; 30310321dbc8SOmar Emara 30320321dbc8SOmar Emara Target *target = GetTarget(); 30330321dbc8SOmar Emara if (HasError()) 30340321dbc8SOmar Emara return; 30350321dbc8SOmar Emara 30360321dbc8SOmar Emara StreamString stream; 30370321dbc8SOmar Emara ProcessAttachInfo attach_info = GetAttachInfo(); 30380321dbc8SOmar Emara Status status = target->Attach(attach_info, &stream); 30390321dbc8SOmar Emara 30400321dbc8SOmar Emara if (status.Fail()) { 30410321dbc8SOmar Emara SetError(status.AsCString()); 30420321dbc8SOmar Emara return; 30430321dbc8SOmar Emara } 30440321dbc8SOmar Emara 30450321dbc8SOmar Emara ProcessSP process_sp(target->GetProcessSP()); 30460321dbc8SOmar Emara if (!process_sp) { 30470321dbc8SOmar Emara SetError("Attached sucessfully but target has no process."); 30480321dbc8SOmar Emara return; 30490321dbc8SOmar Emara } 30500321dbc8SOmar Emara 30510321dbc8SOmar Emara if (attach_info.GetContinueOnceAttached()) 30520321dbc8SOmar Emara process_sp->Resume(); 30530321dbc8SOmar Emara 30540321dbc8SOmar Emara window.GetParent()->RemoveSubWindow(&window); 30550321dbc8SOmar Emara } 30560321dbc8SOmar Emara 30570321dbc8SOmar Emara protected: 30580321dbc8SOmar Emara Debugger &m_debugger; 30590321dbc8SOmar Emara WindowSP m_main_window_sp; 30600321dbc8SOmar Emara 30610321dbc8SOmar Emara ChoicesFieldDelegate *m_type_field; 30620321dbc8SOmar Emara IntegerFieldDelegate *m_pid_field; 30630321dbc8SOmar Emara TextFieldDelegate *m_name_field; 30640321dbc8SOmar Emara BooleanFieldDelegate *m_continue_field; 30650321dbc8SOmar Emara BooleanFieldDelegate *m_wait_for_field; 30660321dbc8SOmar Emara BooleanFieldDelegate *m_include_existing_field; 30670321dbc8SOmar Emara BooleanFieldDelegate *m_show_advanced_field; 3068c93dc259SOmar Emara ProcessPluginFieldDelegate *m_plugin_field; 30690321dbc8SOmar Emara }; 30700321dbc8SOmar Emara 307118c25cd3SOmar Emara class TargetCreateFormDelegate : public FormDelegate { 307218c25cd3SOmar Emara public: 307318c25cd3SOmar Emara TargetCreateFormDelegate(Debugger &debugger) : m_debugger(debugger) { 307418c25cd3SOmar Emara m_executable_field = AddFileField("Executable", "", /*need_to_exist=*/true, 307518c25cd3SOmar Emara /*required=*/true); 307618c25cd3SOmar Emara m_core_file_field = AddFileField("Core File", "", /*need_to_exist=*/true, 307718c25cd3SOmar Emara /*required=*/false); 307818c25cd3SOmar Emara m_symbol_file_field = AddFileField( 307918c25cd3SOmar Emara "Symbol File", "", /*need_to_exist=*/true, /*required=*/false); 308018c25cd3SOmar Emara m_show_advanced_field = AddBooleanField("Show advanced settings.", false); 308118c25cd3SOmar Emara m_remote_file_field = AddFileField( 308218c25cd3SOmar Emara "Remote File", "", /*need_to_exist=*/false, /*required=*/false); 308318c25cd3SOmar Emara m_arch_field = AddArchField("Architecture", "", /*required=*/false); 308418c25cd3SOmar Emara m_platform_field = AddPlatformPluginField(debugger); 308518c25cd3SOmar Emara m_load_dependent_files_field = 308618c25cd3SOmar Emara AddChoicesField("Load Dependents", 3, GetLoadDependentFilesChoices()); 308718c25cd3SOmar Emara 308818c25cd3SOmar Emara AddAction("Create", [this](Window &window) { CreateTarget(window); }); 308918c25cd3SOmar Emara } 309018c25cd3SOmar Emara 309118c25cd3SOmar Emara std::string GetName() override { return "Create Target"; } 309218c25cd3SOmar Emara 309318c25cd3SOmar Emara void UpdateFieldsVisibility() override { 309418c25cd3SOmar Emara if (m_show_advanced_field->GetBoolean()) { 309518c25cd3SOmar Emara m_remote_file_field->FieldDelegateShow(); 309618c25cd3SOmar Emara m_arch_field->FieldDelegateShow(); 309718c25cd3SOmar Emara m_platform_field->FieldDelegateShow(); 309818c25cd3SOmar Emara m_load_dependent_files_field->FieldDelegateShow(); 309918c25cd3SOmar Emara } else { 310018c25cd3SOmar Emara m_remote_file_field->FieldDelegateHide(); 310118c25cd3SOmar Emara m_arch_field->FieldDelegateHide(); 310218c25cd3SOmar Emara m_platform_field->FieldDelegateHide(); 310318c25cd3SOmar Emara m_load_dependent_files_field->FieldDelegateHide(); 310418c25cd3SOmar Emara } 310518c25cd3SOmar Emara } 310618c25cd3SOmar Emara 310718c25cd3SOmar Emara static constexpr const char *kLoadDependentFilesNo = "No"; 310818c25cd3SOmar Emara static constexpr const char *kLoadDependentFilesYes = "Yes"; 310918c25cd3SOmar Emara static constexpr const char *kLoadDependentFilesExecOnly = "Executable only"; 311018c25cd3SOmar Emara 311118c25cd3SOmar Emara std::vector<std::string> GetLoadDependentFilesChoices() { 311218c25cd3SOmar Emara std::vector<std::string> load_depentents_options; 311318c25cd3SOmar Emara load_depentents_options.push_back(kLoadDependentFilesExecOnly); 311418c25cd3SOmar Emara load_depentents_options.push_back(kLoadDependentFilesYes); 311518c25cd3SOmar Emara load_depentents_options.push_back(kLoadDependentFilesNo); 311618c25cd3SOmar Emara return load_depentents_options; 311718c25cd3SOmar Emara } 311818c25cd3SOmar Emara 311918c25cd3SOmar Emara LoadDependentFiles GetLoadDependentFiles() { 312018c25cd3SOmar Emara std::string choice = m_load_dependent_files_field->GetChoiceContent(); 312118c25cd3SOmar Emara if (choice == kLoadDependentFilesNo) 312218c25cd3SOmar Emara return eLoadDependentsNo; 312318c25cd3SOmar Emara if (choice == kLoadDependentFilesYes) 312418c25cd3SOmar Emara return eLoadDependentsYes; 312518c25cd3SOmar Emara return eLoadDependentsDefault; 312618c25cd3SOmar Emara } 312718c25cd3SOmar Emara 312818c25cd3SOmar Emara OptionGroupPlatform GetPlatformOptions() { 312918c25cd3SOmar Emara OptionGroupPlatform platform_options(false); 313018c25cd3SOmar Emara platform_options.SetPlatformName(m_platform_field->GetPluginName().c_str()); 313118c25cd3SOmar Emara return platform_options; 313218c25cd3SOmar Emara } 313318c25cd3SOmar Emara 313418c25cd3SOmar Emara TargetSP GetTarget() { 313518c25cd3SOmar Emara OptionGroupPlatform platform_options = GetPlatformOptions(); 313618c25cd3SOmar Emara TargetSP target_sp; 313718c25cd3SOmar Emara Status status = m_debugger.GetTargetList().CreateTarget( 313818c25cd3SOmar Emara m_debugger, m_executable_field->GetPath(), 313918c25cd3SOmar Emara m_arch_field->GetArchString(), GetLoadDependentFiles(), 314018c25cd3SOmar Emara &platform_options, target_sp); 314118c25cd3SOmar Emara 314218c25cd3SOmar Emara if (status.Fail()) { 314318c25cd3SOmar Emara SetError(status.AsCString()); 314418c25cd3SOmar Emara return nullptr; 314518c25cd3SOmar Emara } 314618c25cd3SOmar Emara 314718c25cd3SOmar Emara m_debugger.GetTargetList().SetSelectedTarget(target_sp); 314818c25cd3SOmar Emara 314918c25cd3SOmar Emara return target_sp; 315018c25cd3SOmar Emara } 315118c25cd3SOmar Emara 315218c25cd3SOmar Emara void SetSymbolFile(TargetSP target_sp) { 315318c25cd3SOmar Emara if (!m_symbol_file_field->IsSpecified()) 315418c25cd3SOmar Emara return; 315518c25cd3SOmar Emara 315618c25cd3SOmar Emara ModuleSP module_sp(target_sp->GetExecutableModule()); 315718c25cd3SOmar Emara if (!module_sp) 315818c25cd3SOmar Emara return; 315918c25cd3SOmar Emara 316018c25cd3SOmar Emara module_sp->SetSymbolFileFileSpec( 316118c25cd3SOmar Emara m_symbol_file_field->GetResolvedFileSpec()); 316218c25cd3SOmar Emara } 316318c25cd3SOmar Emara 316418c25cd3SOmar Emara void SetCoreFile(TargetSP target_sp) { 316518c25cd3SOmar Emara if (!m_core_file_field->IsSpecified()) 316618c25cd3SOmar Emara return; 316718c25cd3SOmar Emara 316818c25cd3SOmar Emara FileSpec core_file_spec = m_core_file_field->GetResolvedFileSpec(); 316918c25cd3SOmar Emara 317018c25cd3SOmar Emara FileSpec core_file_directory_spec; 317118c25cd3SOmar Emara core_file_directory_spec.GetDirectory() = core_file_spec.GetDirectory(); 317218c25cd3SOmar Emara target_sp->AppendExecutableSearchPaths(core_file_directory_spec); 317318c25cd3SOmar Emara 317418c25cd3SOmar Emara ProcessSP process_sp(target_sp->CreateProcess( 317518c25cd3SOmar Emara m_debugger.GetListener(), llvm::StringRef(), &core_file_spec, false)); 317618c25cd3SOmar Emara 317718c25cd3SOmar Emara if (!process_sp) { 317818c25cd3SOmar Emara SetError("Unable to find process plug-in for core file!"); 317918c25cd3SOmar Emara return; 318018c25cd3SOmar Emara } 318118c25cd3SOmar Emara 318218c25cd3SOmar Emara Status status = process_sp->LoadCore(); 318318c25cd3SOmar Emara if (status.Fail()) { 318418c25cd3SOmar Emara SetError("Can't find plug-in for core file!"); 318518c25cd3SOmar Emara return; 318618c25cd3SOmar Emara } 318718c25cd3SOmar Emara } 318818c25cd3SOmar Emara 318918c25cd3SOmar Emara void SetRemoteFile(TargetSP target_sp) { 319018c25cd3SOmar Emara if (!m_remote_file_field->IsSpecified()) 319118c25cd3SOmar Emara return; 319218c25cd3SOmar Emara 319318c25cd3SOmar Emara ModuleSP module_sp(target_sp->GetExecutableModule()); 319418c25cd3SOmar Emara if (!module_sp) 319518c25cd3SOmar Emara return; 319618c25cd3SOmar Emara 319718c25cd3SOmar Emara FileSpec remote_file_spec = m_remote_file_field->GetFileSpec(); 319818c25cd3SOmar Emara module_sp->SetPlatformFileSpec(remote_file_spec); 319918c25cd3SOmar Emara } 320018c25cd3SOmar Emara 320118c25cd3SOmar Emara void RemoveTarget(TargetSP target_sp) { 320218c25cd3SOmar Emara m_debugger.GetTargetList().DeleteTarget(target_sp); 320318c25cd3SOmar Emara } 320418c25cd3SOmar Emara 320518c25cd3SOmar Emara void CreateTarget(Window &window) { 320618c25cd3SOmar Emara ClearError(); 320718c25cd3SOmar Emara 320818c25cd3SOmar Emara bool all_fields_are_valid = CheckFieldsValidity(); 320918c25cd3SOmar Emara if (!all_fields_are_valid) 321018c25cd3SOmar Emara return; 321118c25cd3SOmar Emara 321218c25cd3SOmar Emara TargetSP target_sp = GetTarget(); 321318c25cd3SOmar Emara if (HasError()) 321418c25cd3SOmar Emara return; 321518c25cd3SOmar Emara 321618c25cd3SOmar Emara SetSymbolFile(target_sp); 321718c25cd3SOmar Emara if (HasError()) { 321818c25cd3SOmar Emara RemoveTarget(target_sp); 321918c25cd3SOmar Emara return; 322018c25cd3SOmar Emara } 322118c25cd3SOmar Emara 322218c25cd3SOmar Emara SetCoreFile(target_sp); 322318c25cd3SOmar Emara if (HasError()) { 322418c25cd3SOmar Emara RemoveTarget(target_sp); 322518c25cd3SOmar Emara return; 322618c25cd3SOmar Emara } 322718c25cd3SOmar Emara 322818c25cd3SOmar Emara SetRemoteFile(target_sp); 322918c25cd3SOmar Emara if (HasError()) { 323018c25cd3SOmar Emara RemoveTarget(target_sp); 323118c25cd3SOmar Emara return; 323218c25cd3SOmar Emara } 323318c25cd3SOmar Emara 323418c25cd3SOmar Emara window.GetParent()->RemoveSubWindow(&window); 323518c25cd3SOmar Emara } 323618c25cd3SOmar Emara 323718c25cd3SOmar Emara protected: 323818c25cd3SOmar Emara Debugger &m_debugger; 323918c25cd3SOmar Emara 324018c25cd3SOmar Emara FileFieldDelegate *m_executable_field; 324118c25cd3SOmar Emara FileFieldDelegate *m_core_file_field; 324218c25cd3SOmar Emara FileFieldDelegate *m_symbol_file_field; 324318c25cd3SOmar Emara BooleanFieldDelegate *m_show_advanced_field; 324418c25cd3SOmar Emara FileFieldDelegate *m_remote_file_field; 324518c25cd3SOmar Emara ArchFieldDelegate *m_arch_field; 324618c25cd3SOmar Emara PlatformPluginFieldDelegate *m_platform_field; 324718c25cd3SOmar Emara ChoicesFieldDelegate *m_load_dependent_files_field; 324818c25cd3SOmar Emara }; 324918c25cd3SOmar Emara 325082507f17SOmar Emara class ProcessLaunchFormDelegate : public FormDelegate { 325182507f17SOmar Emara public: 325282507f17SOmar Emara ProcessLaunchFormDelegate(Debugger &debugger, WindowSP main_window_sp) 325382507f17SOmar Emara : m_debugger(debugger), m_main_window_sp(main_window_sp) { 325482507f17SOmar Emara 325582507f17SOmar Emara m_arguments_field = AddArgumentsField(); 325682507f17SOmar Emara SetArgumentsFieldDefaultValue(); 325782507f17SOmar Emara m_target_environment_field = 325882507f17SOmar Emara AddEnvironmentVariableListField("Target Environment Variables"); 325982507f17SOmar Emara SetTargetEnvironmentFieldDefaultValue(); 326082507f17SOmar Emara m_working_directory_field = AddDirectoryField( 326182507f17SOmar Emara "Working Directory", GetDefaultWorkingDirectory().c_str(), true, false); 326282507f17SOmar Emara 326382507f17SOmar Emara m_show_advanced_field = AddBooleanField("Show advanced settings.", false); 326482507f17SOmar Emara 326582507f17SOmar Emara m_stop_at_entry_field = AddBooleanField("Stop at entry point.", false); 326682507f17SOmar Emara m_detach_on_error_field = 326782507f17SOmar Emara AddBooleanField("Detach on error.", GetDefaultDetachOnError()); 326882507f17SOmar Emara m_disable_aslr_field = 326982507f17SOmar Emara AddBooleanField("Disable ASLR", GetDefaultDisableASLR()); 327082507f17SOmar Emara m_plugin_field = AddProcessPluginField(); 327182507f17SOmar Emara m_arch_field = AddArchField("Architecture", "", false); 327282507f17SOmar Emara m_shell_field = AddFileField("Shell", "", true, false); 327382507f17SOmar Emara m_expand_shell_arguments_field = 327482507f17SOmar Emara AddBooleanField("Expand shell arguments.", false); 327582507f17SOmar Emara 327682507f17SOmar Emara m_disable_standard_io_field = 327782507f17SOmar Emara AddBooleanField("Disable Standard IO", GetDefaultDisableStandardIO()); 327882507f17SOmar Emara m_standard_output_field = 327982507f17SOmar Emara AddFileField("Standard Output File", "", /*need_to_exist=*/false, 328082507f17SOmar Emara /*required=*/false); 328182507f17SOmar Emara m_standard_error_field = 328282507f17SOmar Emara AddFileField("Standard Error File", "", /*need_to_exist=*/false, 328382507f17SOmar Emara /*required=*/false); 328482507f17SOmar Emara m_standard_input_field = 328582507f17SOmar Emara AddFileField("Standard Input File", "", /*need_to_exist=*/false, 328682507f17SOmar Emara /*required=*/false); 328782507f17SOmar Emara 328882507f17SOmar Emara m_show_inherited_environment_field = 328982507f17SOmar Emara AddBooleanField("Show inherited environment variables.", false); 329082507f17SOmar Emara m_inherited_environment_field = 329182507f17SOmar Emara AddEnvironmentVariableListField("Inherited Environment Variables"); 329282507f17SOmar Emara SetInheritedEnvironmentFieldDefaultValue(); 329382507f17SOmar Emara 329482507f17SOmar Emara AddAction("Launch", [this](Window &window) { Launch(window); }); 329582507f17SOmar Emara } 329682507f17SOmar Emara 329782507f17SOmar Emara std::string GetName() override { return "Launch Process"; } 329882507f17SOmar Emara 329982507f17SOmar Emara void UpdateFieldsVisibility() override { 330082507f17SOmar Emara if (m_show_advanced_field->GetBoolean()) { 330182507f17SOmar Emara m_stop_at_entry_field->FieldDelegateShow(); 330282507f17SOmar Emara m_detach_on_error_field->FieldDelegateShow(); 330382507f17SOmar Emara m_disable_aslr_field->FieldDelegateShow(); 330482507f17SOmar Emara m_plugin_field->FieldDelegateShow(); 330582507f17SOmar Emara m_arch_field->FieldDelegateShow(); 330682507f17SOmar Emara m_shell_field->FieldDelegateShow(); 330782507f17SOmar Emara m_expand_shell_arguments_field->FieldDelegateShow(); 330882507f17SOmar Emara m_disable_standard_io_field->FieldDelegateShow(); 330982507f17SOmar Emara if (m_disable_standard_io_field->GetBoolean()) { 331082507f17SOmar Emara m_standard_input_field->FieldDelegateHide(); 331182507f17SOmar Emara m_standard_output_field->FieldDelegateHide(); 331282507f17SOmar Emara m_standard_error_field->FieldDelegateHide(); 331382507f17SOmar Emara } else { 331482507f17SOmar Emara m_standard_input_field->FieldDelegateShow(); 331582507f17SOmar Emara m_standard_output_field->FieldDelegateShow(); 331682507f17SOmar Emara m_standard_error_field->FieldDelegateShow(); 331782507f17SOmar Emara } 331882507f17SOmar Emara m_show_inherited_environment_field->FieldDelegateShow(); 331982507f17SOmar Emara if (m_show_inherited_environment_field->GetBoolean()) 332082507f17SOmar Emara m_inherited_environment_field->FieldDelegateShow(); 332182507f17SOmar Emara else 332282507f17SOmar Emara m_inherited_environment_field->FieldDelegateHide(); 332382507f17SOmar Emara } else { 332482507f17SOmar Emara m_stop_at_entry_field->FieldDelegateHide(); 332582507f17SOmar Emara m_detach_on_error_field->FieldDelegateHide(); 332682507f17SOmar Emara m_disable_aslr_field->FieldDelegateHide(); 332782507f17SOmar Emara m_plugin_field->FieldDelegateHide(); 332882507f17SOmar Emara m_arch_field->FieldDelegateHide(); 332982507f17SOmar Emara m_shell_field->FieldDelegateHide(); 333082507f17SOmar Emara m_expand_shell_arguments_field->FieldDelegateHide(); 333182507f17SOmar Emara m_disable_standard_io_field->FieldDelegateHide(); 333282507f17SOmar Emara m_standard_input_field->FieldDelegateHide(); 333382507f17SOmar Emara m_standard_output_field->FieldDelegateHide(); 333482507f17SOmar Emara m_standard_error_field->FieldDelegateHide(); 333582507f17SOmar Emara m_show_inherited_environment_field->FieldDelegateHide(); 333682507f17SOmar Emara m_inherited_environment_field->FieldDelegateHide(); 333782507f17SOmar Emara } 333882507f17SOmar Emara } 333982507f17SOmar Emara 334082507f17SOmar Emara // Methods for setting the default value of the fields. 334182507f17SOmar Emara 334282507f17SOmar Emara void SetArgumentsFieldDefaultValue() { 334382507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 334482507f17SOmar Emara if (target == nullptr) 334582507f17SOmar Emara return; 334682507f17SOmar Emara 334782507f17SOmar Emara const Args &target_arguments = 334882507f17SOmar Emara target->GetProcessLaunchInfo().GetArguments(); 334982507f17SOmar Emara m_arguments_field->AddArguments(target_arguments); 335082507f17SOmar Emara } 335182507f17SOmar Emara 335282507f17SOmar Emara void SetTargetEnvironmentFieldDefaultValue() { 335382507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 335482507f17SOmar Emara if (target == nullptr) 335582507f17SOmar Emara return; 335682507f17SOmar Emara 335782507f17SOmar Emara const Environment &target_environment = target->GetTargetEnvironment(); 335882507f17SOmar Emara m_target_environment_field->AddEnvironmentVariables(target_environment); 335982507f17SOmar Emara } 336082507f17SOmar Emara 336182507f17SOmar Emara void SetInheritedEnvironmentFieldDefaultValue() { 336282507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 336382507f17SOmar Emara if (target == nullptr) 336482507f17SOmar Emara return; 336582507f17SOmar Emara 336682507f17SOmar Emara const Environment &inherited_environment = 336782507f17SOmar Emara target->GetInheritedEnvironment(); 336882507f17SOmar Emara m_inherited_environment_field->AddEnvironmentVariables( 336982507f17SOmar Emara inherited_environment); 337082507f17SOmar Emara } 337182507f17SOmar Emara 337282507f17SOmar Emara std::string GetDefaultWorkingDirectory() { 337382507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 337482507f17SOmar Emara if (target == nullptr) 337582507f17SOmar Emara return ""; 337682507f17SOmar Emara 337782507f17SOmar Emara PlatformSP platform = target->GetPlatform(); 337882507f17SOmar Emara return platform->GetWorkingDirectory().GetPath(); 337982507f17SOmar Emara } 338082507f17SOmar Emara 338182507f17SOmar Emara bool GetDefaultDisableASLR() { 338282507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 338382507f17SOmar Emara if (target == nullptr) 338482507f17SOmar Emara return false; 338582507f17SOmar Emara 338682507f17SOmar Emara return target->GetDisableASLR(); 338782507f17SOmar Emara } 338882507f17SOmar Emara 338982507f17SOmar Emara bool GetDefaultDisableStandardIO() { 339082507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 339182507f17SOmar Emara if (target == nullptr) 339282507f17SOmar Emara return true; 339382507f17SOmar Emara 339482507f17SOmar Emara return target->GetDisableSTDIO(); 339582507f17SOmar Emara } 339682507f17SOmar Emara 339782507f17SOmar Emara bool GetDefaultDetachOnError() { 339882507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 339982507f17SOmar Emara if (target == nullptr) 340082507f17SOmar Emara return true; 340182507f17SOmar Emara 340282507f17SOmar Emara return target->GetDetachOnError(); 340382507f17SOmar Emara } 340482507f17SOmar Emara 340582507f17SOmar Emara // Methods for getting the necessary information and setting them to the 340682507f17SOmar Emara // ProcessLaunchInfo. 340782507f17SOmar Emara 340882507f17SOmar Emara void GetExecutableSettings(ProcessLaunchInfo &launch_info) { 340982507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 341082507f17SOmar Emara ModuleSP executable_module = target->GetExecutableModule(); 341182507f17SOmar Emara llvm::StringRef target_settings_argv0 = target->GetArg0(); 341282507f17SOmar Emara 341382507f17SOmar Emara if (!target_settings_argv0.empty()) { 341482507f17SOmar Emara launch_info.GetArguments().AppendArgument(target_settings_argv0); 341582507f17SOmar Emara launch_info.SetExecutableFile(executable_module->GetPlatformFileSpec(), 341682507f17SOmar Emara false); 341782507f17SOmar Emara return; 341882507f17SOmar Emara } 341982507f17SOmar Emara 342082507f17SOmar Emara launch_info.SetExecutableFile(executable_module->GetPlatformFileSpec(), 342182507f17SOmar Emara true); 342282507f17SOmar Emara } 342382507f17SOmar Emara 342482507f17SOmar Emara void GetArguments(ProcessLaunchInfo &launch_info) { 342582507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 342682507f17SOmar Emara Args arguments = m_arguments_field->GetArguments(); 342782507f17SOmar Emara launch_info.GetArguments().AppendArguments(arguments); 342882507f17SOmar Emara } 342982507f17SOmar Emara 343082507f17SOmar Emara void GetEnvironment(ProcessLaunchInfo &launch_info) { 343182507f17SOmar Emara Environment target_environment = 343282507f17SOmar Emara m_target_environment_field->GetEnvironment(); 343382507f17SOmar Emara Environment inherited_environment = 343482507f17SOmar Emara m_inherited_environment_field->GetEnvironment(); 343582507f17SOmar Emara launch_info.GetEnvironment().insert(target_environment.begin(), 343682507f17SOmar Emara target_environment.end()); 343782507f17SOmar Emara launch_info.GetEnvironment().insert(inherited_environment.begin(), 343882507f17SOmar Emara inherited_environment.end()); 343982507f17SOmar Emara } 344082507f17SOmar Emara 344182507f17SOmar Emara void GetWorkingDirectory(ProcessLaunchInfo &launch_info) { 344282507f17SOmar Emara if (m_working_directory_field->IsSpecified()) 344382507f17SOmar Emara launch_info.SetWorkingDirectory( 344482507f17SOmar Emara m_working_directory_field->GetResolvedFileSpec()); 344582507f17SOmar Emara } 344682507f17SOmar Emara 344782507f17SOmar Emara void GetStopAtEntry(ProcessLaunchInfo &launch_info) { 344882507f17SOmar Emara if (m_stop_at_entry_field->GetBoolean()) 344982507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagStopAtEntry); 345082507f17SOmar Emara else 345182507f17SOmar Emara launch_info.GetFlags().Clear(eLaunchFlagStopAtEntry); 345282507f17SOmar Emara } 345382507f17SOmar Emara 345482507f17SOmar Emara void GetDetachOnError(ProcessLaunchInfo &launch_info) { 345582507f17SOmar Emara if (m_detach_on_error_field->GetBoolean()) 345682507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagDetachOnError); 345782507f17SOmar Emara else 345882507f17SOmar Emara launch_info.GetFlags().Clear(eLaunchFlagDetachOnError); 345982507f17SOmar Emara } 346082507f17SOmar Emara 346182507f17SOmar Emara void GetDisableASLR(ProcessLaunchInfo &launch_info) { 346282507f17SOmar Emara if (m_disable_aslr_field->GetBoolean()) 346382507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagDisableASLR); 346482507f17SOmar Emara else 346582507f17SOmar Emara launch_info.GetFlags().Clear(eLaunchFlagDisableASLR); 346682507f17SOmar Emara } 346782507f17SOmar Emara 346882507f17SOmar Emara void GetPlugin(ProcessLaunchInfo &launch_info) { 346982507f17SOmar Emara launch_info.SetProcessPluginName(m_plugin_field->GetPluginName()); 347082507f17SOmar Emara } 347182507f17SOmar Emara 347282507f17SOmar Emara void GetArch(ProcessLaunchInfo &launch_info) { 347382507f17SOmar Emara if (!m_arch_field->IsSpecified()) 347482507f17SOmar Emara return; 347582507f17SOmar Emara 347682507f17SOmar Emara TargetSP target_sp = m_debugger.GetSelectedTarget(); 347782507f17SOmar Emara PlatformSP platform_sp = 347882507f17SOmar Emara target_sp ? target_sp->GetPlatform() : PlatformSP(); 347982507f17SOmar Emara launch_info.GetArchitecture() = Platform::GetAugmentedArchSpec( 348082507f17SOmar Emara platform_sp.get(), m_arch_field->GetArchString()); 348182507f17SOmar Emara } 348282507f17SOmar Emara 348382507f17SOmar Emara void GetShell(ProcessLaunchInfo &launch_info) { 348482507f17SOmar Emara if (!m_shell_field->IsSpecified()) 348582507f17SOmar Emara return; 348682507f17SOmar Emara 348782507f17SOmar Emara launch_info.SetShell(m_shell_field->GetResolvedFileSpec()); 348882507f17SOmar Emara launch_info.SetShellExpandArguments( 348982507f17SOmar Emara m_expand_shell_arguments_field->GetBoolean()); 349082507f17SOmar Emara } 349182507f17SOmar Emara 349282507f17SOmar Emara void GetStandardIO(ProcessLaunchInfo &launch_info) { 349382507f17SOmar Emara if (m_disable_standard_io_field->GetBoolean()) { 349482507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagDisableSTDIO); 349582507f17SOmar Emara return; 349682507f17SOmar Emara } 349782507f17SOmar Emara 349882507f17SOmar Emara FileAction action; 349982507f17SOmar Emara if (m_standard_input_field->IsSpecified()) { 350082507f17SOmar Emara action.Open(STDIN_FILENO, m_standard_input_field->GetFileSpec(), true, 350182507f17SOmar Emara false); 350282507f17SOmar Emara launch_info.AppendFileAction(action); 350382507f17SOmar Emara } 350482507f17SOmar Emara if (m_standard_output_field->IsSpecified()) { 350582507f17SOmar Emara action.Open(STDOUT_FILENO, m_standard_output_field->GetFileSpec(), false, 350682507f17SOmar Emara true); 350782507f17SOmar Emara launch_info.AppendFileAction(action); 350882507f17SOmar Emara } 350982507f17SOmar Emara if (m_standard_error_field->IsSpecified()) { 351082507f17SOmar Emara action.Open(STDERR_FILENO, m_standard_error_field->GetFileSpec(), false, 351182507f17SOmar Emara true); 351282507f17SOmar Emara launch_info.AppendFileAction(action); 351382507f17SOmar Emara } 351482507f17SOmar Emara } 351582507f17SOmar Emara 351682507f17SOmar Emara void GetInheritTCC(ProcessLaunchInfo &launch_info) { 351782507f17SOmar Emara if (m_debugger.GetSelectedTarget()->GetInheritTCC()) 351882507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagInheritTCCFromParent); 351982507f17SOmar Emara } 352082507f17SOmar Emara 352182507f17SOmar Emara ProcessLaunchInfo GetLaunchInfo() { 352282507f17SOmar Emara ProcessLaunchInfo launch_info; 352382507f17SOmar Emara 352482507f17SOmar Emara GetExecutableSettings(launch_info); 352582507f17SOmar Emara GetArguments(launch_info); 352682507f17SOmar Emara GetEnvironment(launch_info); 352782507f17SOmar Emara GetWorkingDirectory(launch_info); 352882507f17SOmar Emara GetStopAtEntry(launch_info); 352982507f17SOmar Emara GetDetachOnError(launch_info); 353082507f17SOmar Emara GetDisableASLR(launch_info); 353182507f17SOmar Emara GetPlugin(launch_info); 353282507f17SOmar Emara GetArch(launch_info); 353382507f17SOmar Emara GetShell(launch_info); 353482507f17SOmar Emara GetStandardIO(launch_info); 353582507f17SOmar Emara GetInheritTCC(launch_info); 353682507f17SOmar Emara 353782507f17SOmar Emara return launch_info; 353882507f17SOmar Emara } 353982507f17SOmar Emara 354082507f17SOmar Emara bool StopRunningProcess() { 354182507f17SOmar Emara ExecutionContext exe_ctx = 354282507f17SOmar Emara m_debugger.GetCommandInterpreter().GetExecutionContext(); 354382507f17SOmar Emara 354482507f17SOmar Emara if (!exe_ctx.HasProcessScope()) 354582507f17SOmar Emara return false; 354682507f17SOmar Emara 354782507f17SOmar Emara Process *process = exe_ctx.GetProcessPtr(); 354882507f17SOmar Emara if (!(process && process->IsAlive())) 354982507f17SOmar Emara return false; 355082507f17SOmar Emara 355182507f17SOmar Emara FormDelegateSP form_delegate_sp = 355282507f17SOmar Emara FormDelegateSP(new DetachOrKillProcessFormDelegate(process)); 355382507f17SOmar Emara Rect bounds = m_main_window_sp->GetCenteredRect(85, 8); 355482507f17SOmar Emara WindowSP form_window_sp = m_main_window_sp->CreateSubWindow( 355582507f17SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 355682507f17SOmar Emara WindowDelegateSP window_delegate_sp = 355782507f17SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 355882507f17SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 355982507f17SOmar Emara 356082507f17SOmar Emara return true; 356182507f17SOmar Emara } 356282507f17SOmar Emara 356382507f17SOmar Emara Target *GetTarget() { 356482507f17SOmar Emara Target *target = m_debugger.GetSelectedTarget().get(); 356582507f17SOmar Emara 356682507f17SOmar Emara if (target == nullptr) { 356782507f17SOmar Emara SetError("No target exists!"); 356882507f17SOmar Emara return nullptr; 356982507f17SOmar Emara } 357082507f17SOmar Emara 357182507f17SOmar Emara ModuleSP exe_module_sp = target->GetExecutableModule(); 357282507f17SOmar Emara 357382507f17SOmar Emara if (exe_module_sp == nullptr) { 357482507f17SOmar Emara SetError("No executable in target!"); 357582507f17SOmar Emara return nullptr; 357682507f17SOmar Emara } 357782507f17SOmar Emara 357882507f17SOmar Emara return target; 357982507f17SOmar Emara } 358082507f17SOmar Emara 358182507f17SOmar Emara void Launch(Window &window) { 358282507f17SOmar Emara ClearError(); 358382507f17SOmar Emara 358482507f17SOmar Emara bool all_fields_are_valid = CheckFieldsValidity(); 358582507f17SOmar Emara if (!all_fields_are_valid) 358682507f17SOmar Emara return; 358782507f17SOmar Emara 358882507f17SOmar Emara bool process_is_running = StopRunningProcess(); 358982507f17SOmar Emara if (process_is_running) 359082507f17SOmar Emara return; 359182507f17SOmar Emara 359282507f17SOmar Emara Target *target = GetTarget(); 359382507f17SOmar Emara if (HasError()) 359482507f17SOmar Emara return; 359582507f17SOmar Emara 359682507f17SOmar Emara StreamString stream; 359782507f17SOmar Emara ProcessLaunchInfo launch_info = GetLaunchInfo(); 359882507f17SOmar Emara Status status = target->Launch(launch_info, &stream); 359982507f17SOmar Emara 360082507f17SOmar Emara if (status.Fail()) { 360182507f17SOmar Emara SetError(status.AsCString()); 360282507f17SOmar Emara return; 360382507f17SOmar Emara } 360482507f17SOmar Emara 360582507f17SOmar Emara ProcessSP process_sp(target->GetProcessSP()); 360682507f17SOmar Emara if (!process_sp) { 360782507f17SOmar Emara SetError("Launched successfully but target has no process!"); 360882507f17SOmar Emara return; 360982507f17SOmar Emara } 361082507f17SOmar Emara 361182507f17SOmar Emara window.GetParent()->RemoveSubWindow(&window); 361282507f17SOmar Emara } 361382507f17SOmar Emara 361482507f17SOmar Emara protected: 361582507f17SOmar Emara Debugger &m_debugger; 361682507f17SOmar Emara WindowSP m_main_window_sp; 361782507f17SOmar Emara 361882507f17SOmar Emara ArgumentsFieldDelegate *m_arguments_field; 361982507f17SOmar Emara EnvironmentVariableListFieldDelegate *m_target_environment_field; 362082507f17SOmar Emara DirectoryFieldDelegate *m_working_directory_field; 362182507f17SOmar Emara 362282507f17SOmar Emara BooleanFieldDelegate *m_show_advanced_field; 362382507f17SOmar Emara 362482507f17SOmar Emara BooleanFieldDelegate *m_stop_at_entry_field; 362582507f17SOmar Emara BooleanFieldDelegate *m_detach_on_error_field; 362682507f17SOmar Emara BooleanFieldDelegate *m_disable_aslr_field; 362782507f17SOmar Emara ProcessPluginFieldDelegate *m_plugin_field; 362882507f17SOmar Emara ArchFieldDelegate *m_arch_field; 362982507f17SOmar Emara FileFieldDelegate *m_shell_field; 363082507f17SOmar Emara BooleanFieldDelegate *m_expand_shell_arguments_field; 363182507f17SOmar Emara BooleanFieldDelegate *m_disable_standard_io_field; 363282507f17SOmar Emara FileFieldDelegate *m_standard_input_field; 363382507f17SOmar Emara FileFieldDelegate *m_standard_output_field; 363482507f17SOmar Emara FileFieldDelegate *m_standard_error_field; 363582507f17SOmar Emara 363682507f17SOmar Emara BooleanFieldDelegate *m_show_inherited_environment_field; 363782507f17SOmar Emara EnvironmentVariableListFieldDelegate *m_inherited_environment_field; 363882507f17SOmar Emara }; 363982507f17SOmar Emara 36403c11e572SOmar Emara //////////// 36413c11e572SOmar Emara // Searchers 36423c11e572SOmar Emara //////////// 36433c11e572SOmar Emara 36443c11e572SOmar Emara class SearcherDelegate { 36453c11e572SOmar Emara public: 364624f9a2f5SShafik Yaghmour SearcherDelegate() = default; 36473c11e572SOmar Emara 36483c11e572SOmar Emara virtual ~SearcherDelegate() = default; 36493c11e572SOmar Emara 36503c11e572SOmar Emara virtual int GetNumberOfMatches() = 0; 36513c11e572SOmar Emara 36523c11e572SOmar Emara // Get the string that will be displayed for the match at the input index. 36533c11e572SOmar Emara virtual const std::string &GetMatchTextAtIndex(int index) = 0; 36543c11e572SOmar Emara 36553c11e572SOmar Emara // Update the matches of the search. This is executed every time the text 36563c11e572SOmar Emara // field handles an event. 36573c11e572SOmar Emara virtual void UpdateMatches(const std::string &text) = 0; 36583c11e572SOmar Emara 36593c11e572SOmar Emara // Execute the user callback given the index of some match. This is executed 36603c11e572SOmar Emara // once the user selects a match. 36613c11e572SOmar Emara virtual void ExecuteCallback(int match_index) = 0; 36623c11e572SOmar Emara }; 36633c11e572SOmar Emara 36643c11e572SOmar Emara typedef std::shared_ptr<SearcherDelegate> SearcherDelegateSP; 36653c11e572SOmar Emara 36663c11e572SOmar Emara class SearcherWindowDelegate : public WindowDelegate { 36673c11e572SOmar Emara public: 36683c11e572SOmar Emara SearcherWindowDelegate(SearcherDelegateSP &delegate_sp) 366928c878aeSShafik Yaghmour : m_delegate_sp(delegate_sp), m_text_field("Search", "", false) { 36703c11e572SOmar Emara ; 36713c11e572SOmar Emara } 36723c11e572SOmar Emara 36733c11e572SOmar Emara // A completion window is padded by one character from all sides. A text field 36743c11e572SOmar Emara // is first drawn for inputting the searcher request, then a list of matches 36753c11e572SOmar Emara // are displayed in a scrollable list. 36763c11e572SOmar Emara // 36773c11e572SOmar Emara // ___<Searcher Window Name>____________________________ 36783c11e572SOmar Emara // | | 36793c11e572SOmar Emara // | __[Search]_______________________________________ | 36803c11e572SOmar Emara // | | | | 36813c11e572SOmar Emara // | |_______________________________________________| | 36823c11e572SOmar Emara // | - Match 1. | 36833c11e572SOmar Emara // | - Match 2. | 36843c11e572SOmar Emara // | - ... | 36853c11e572SOmar Emara // | | 36863c11e572SOmar Emara // |____________________________[Press Esc to Cancel]__| 36873c11e572SOmar Emara // 36883c11e572SOmar Emara 36893c11e572SOmar Emara // Get the index of the last visible match. Assuming at least one match 36903c11e572SOmar Emara // exists. 36913c11e572SOmar Emara int GetLastVisibleMatch(int height) { 36923c11e572SOmar Emara int index = m_first_visible_match + height; 36933c11e572SOmar Emara return std::min(index, m_delegate_sp->GetNumberOfMatches()) - 1; 36943c11e572SOmar Emara } 36953c11e572SOmar Emara 36963c11e572SOmar Emara int GetNumberOfVisibleMatches(int height) { 36973c11e572SOmar Emara return GetLastVisibleMatch(height) - m_first_visible_match + 1; 36983c11e572SOmar Emara } 36993c11e572SOmar Emara 37003c11e572SOmar Emara void UpdateScrolling(Surface &surface) { 37013c11e572SOmar Emara if (m_selected_match < m_first_visible_match) { 37023c11e572SOmar Emara m_first_visible_match = m_selected_match; 37033c11e572SOmar Emara return; 37043c11e572SOmar Emara } 37053c11e572SOmar Emara 37063c11e572SOmar Emara int height = surface.GetHeight(); 37073c11e572SOmar Emara int last_visible_match = GetLastVisibleMatch(height); 37083c11e572SOmar Emara if (m_selected_match > last_visible_match) { 37093c11e572SOmar Emara m_first_visible_match = m_selected_match - height + 1; 37103c11e572SOmar Emara } 37113c11e572SOmar Emara } 37123c11e572SOmar Emara 37133c11e572SOmar Emara void DrawMatches(Surface &surface) { 37143c11e572SOmar Emara if (m_delegate_sp->GetNumberOfMatches() == 0) 37153c11e572SOmar Emara return; 37163c11e572SOmar Emara 37173c11e572SOmar Emara UpdateScrolling(surface); 37183c11e572SOmar Emara 37193c11e572SOmar Emara int count = GetNumberOfVisibleMatches(surface.GetHeight()); 37203c11e572SOmar Emara for (int i = 0; i < count; i++) { 37213c11e572SOmar Emara surface.MoveCursor(1, i); 37223c11e572SOmar Emara int current_match = m_first_visible_match + i; 37233c11e572SOmar Emara if (current_match == m_selected_match) 37243c11e572SOmar Emara surface.AttributeOn(A_REVERSE); 37253c11e572SOmar Emara surface.PutCString( 37263c11e572SOmar Emara m_delegate_sp->GetMatchTextAtIndex(current_match).c_str()); 37273c11e572SOmar Emara if (current_match == m_selected_match) 37283c11e572SOmar Emara surface.AttributeOff(A_REVERSE); 37293c11e572SOmar Emara } 37303c11e572SOmar Emara } 37313c11e572SOmar Emara 37323c11e572SOmar Emara void DrawContent(Surface &surface) { 37333c11e572SOmar Emara Rect content_bounds = surface.GetFrame(); 37343c11e572SOmar Emara Rect text_field_bounds, matchs_bounds; 37353c11e572SOmar Emara content_bounds.HorizontalSplit(m_text_field.FieldDelegateGetHeight(), 37363c11e572SOmar Emara text_field_bounds, matchs_bounds); 37373c11e572SOmar Emara Surface text_field_surface = surface.SubSurface(text_field_bounds); 37383c11e572SOmar Emara Surface matches_surface = surface.SubSurface(matchs_bounds); 37393c11e572SOmar Emara 37403c11e572SOmar Emara m_text_field.FieldDelegateDraw(text_field_surface, true); 37413c11e572SOmar Emara DrawMatches(matches_surface); 37423c11e572SOmar Emara } 37433c11e572SOmar Emara 37443c11e572SOmar Emara bool WindowDelegateDraw(Window &window, bool force) override { 37453c11e572SOmar Emara window.Erase(); 37463c11e572SOmar Emara 37473c11e572SOmar Emara window.DrawTitleBox(window.GetName(), "Press Esc to Cancel"); 37483c11e572SOmar Emara 37493c11e572SOmar Emara Rect content_bounds = window.GetFrame(); 37503c11e572SOmar Emara content_bounds.Inset(2, 2); 37513c11e572SOmar Emara Surface content_surface = window.SubSurface(content_bounds); 37523c11e572SOmar Emara 37533c11e572SOmar Emara DrawContent(content_surface); 37543c11e572SOmar Emara return true; 37553c11e572SOmar Emara } 37563c11e572SOmar Emara 37573c11e572SOmar Emara void SelectNext() { 37583c11e572SOmar Emara if (m_selected_match != m_delegate_sp->GetNumberOfMatches() - 1) 37593c11e572SOmar Emara m_selected_match++; 37603c11e572SOmar Emara } 37613c11e572SOmar Emara 37623c11e572SOmar Emara void SelectPrevious() { 37633c11e572SOmar Emara if (m_selected_match != 0) 37643c11e572SOmar Emara m_selected_match--; 37653c11e572SOmar Emara } 37663c11e572SOmar Emara 37673c11e572SOmar Emara void ExecuteCallback(Window &window) { 37683c11e572SOmar Emara m_delegate_sp->ExecuteCallback(m_selected_match); 37693c11e572SOmar Emara window.GetParent()->RemoveSubWindow(&window); 37703c11e572SOmar Emara } 37713c11e572SOmar Emara 37723c11e572SOmar Emara void UpdateMatches() { 37733c11e572SOmar Emara m_delegate_sp->UpdateMatches(m_text_field.GetText()); 37743c11e572SOmar Emara m_selected_match = 0; 37753c11e572SOmar Emara } 37763c11e572SOmar Emara 37773c11e572SOmar Emara HandleCharResult WindowDelegateHandleChar(Window &window, int key) override { 37783c11e572SOmar Emara switch (key) { 37793c11e572SOmar Emara case '\r': 37803c11e572SOmar Emara case '\n': 37813c11e572SOmar Emara case KEY_ENTER: 37823c11e572SOmar Emara ExecuteCallback(window); 37833c11e572SOmar Emara return eKeyHandled; 37843c11e572SOmar Emara case '\t': 37853c11e572SOmar Emara case KEY_DOWN: 37863c11e572SOmar Emara SelectNext(); 37873c11e572SOmar Emara return eKeyHandled; 37883c11e572SOmar Emara case KEY_SHIFT_TAB: 37893c11e572SOmar Emara case KEY_UP: 37903c11e572SOmar Emara SelectPrevious(); 37913c11e572SOmar Emara return eKeyHandled; 37923c11e572SOmar Emara case KEY_ESCAPE: 37933c11e572SOmar Emara window.GetParent()->RemoveSubWindow(&window); 37943c11e572SOmar Emara return eKeyHandled; 37953c11e572SOmar Emara default: 37963c11e572SOmar Emara break; 37973c11e572SOmar Emara } 37983c11e572SOmar Emara 37993c11e572SOmar Emara if (m_text_field.FieldDelegateHandleChar(key) == eKeyHandled) 38003c11e572SOmar Emara UpdateMatches(); 38013c11e572SOmar Emara 38023c11e572SOmar Emara return eKeyHandled; 38033c11e572SOmar Emara } 38043c11e572SOmar Emara 38053c11e572SOmar Emara protected: 38063c11e572SOmar Emara SearcherDelegateSP m_delegate_sp; 38073c11e572SOmar Emara TextFieldDelegate m_text_field; 38083c11e572SOmar Emara // The index of the currently selected match. 380928c878aeSShafik Yaghmour int m_selected_match = 0; 38103c11e572SOmar Emara // The index of the first visible match. 381128c878aeSShafik Yaghmour int m_first_visible_match = 0; 38123c11e572SOmar Emara }; 38133c11e572SOmar Emara 38143c11e572SOmar Emara ////////////////////////////// 38153c11e572SOmar Emara // Searcher Delegate Instances 38163c11e572SOmar Emara ////////////////////////////// 38173c11e572SOmar Emara 38183c11e572SOmar Emara // This is a searcher delegate wrapper around CommandCompletions common 38193c11e572SOmar Emara // callbacks. The callbacks are only given the match string. The completion_mask 38203c11e572SOmar Emara // can be a combination of CommonCompletionTypes. 38213c11e572SOmar Emara class CommonCompletionSearcherDelegate : public SearcherDelegate { 38223c11e572SOmar Emara public: 38233c11e572SOmar Emara typedef std::function<void(const std::string &)> CallbackType; 38243c11e572SOmar Emara 38253c11e572SOmar Emara CommonCompletionSearcherDelegate(Debugger &debugger, uint32_t completion_mask, 38263c11e572SOmar Emara CallbackType callback) 38273c11e572SOmar Emara : m_debugger(debugger), m_completion_mask(completion_mask), 38283c11e572SOmar Emara m_callback(callback) {} 38293c11e572SOmar Emara 38303c11e572SOmar Emara int GetNumberOfMatches() override { return m_matches.GetSize(); } 38313c11e572SOmar Emara 38323c11e572SOmar Emara const std::string &GetMatchTextAtIndex(int index) override { 38333c11e572SOmar Emara return m_matches[index]; 38343c11e572SOmar Emara } 38353c11e572SOmar Emara 38363c11e572SOmar Emara void UpdateMatches(const std::string &text) override { 38373c11e572SOmar Emara CompletionResult result; 38383c11e572SOmar Emara CompletionRequest request(text.c_str(), text.size(), result); 38393c11e572SOmar Emara CommandCompletions::InvokeCommonCompletionCallbacks( 38403c11e572SOmar Emara m_debugger.GetCommandInterpreter(), m_completion_mask, request, 38413c11e572SOmar Emara nullptr); 38423c11e572SOmar Emara result.GetMatches(m_matches); 38433c11e572SOmar Emara } 38443c11e572SOmar Emara 38453c11e572SOmar Emara void ExecuteCallback(int match_index) override { 38463c11e572SOmar Emara m_callback(m_matches[match_index]); 38473c11e572SOmar Emara } 38483c11e572SOmar Emara 38493c11e572SOmar Emara protected: 38503c11e572SOmar Emara Debugger &m_debugger; 38513c11e572SOmar Emara // A compound mask from CommonCompletionTypes. 38523c11e572SOmar Emara uint32_t m_completion_mask; 38533c11e572SOmar Emara // A callback to execute once the user selects a match. The match is passed to 38543c11e572SOmar Emara // the callback as a string. 38553c11e572SOmar Emara CallbackType m_callback; 38563c11e572SOmar Emara StringList m_matches; 38573c11e572SOmar Emara }; 38583c11e572SOmar Emara 38593c11e572SOmar Emara //////// 38603c11e572SOmar Emara // Menus 38613c11e572SOmar Emara //////// 38623c11e572SOmar Emara 38637caa17caSRaphael Isemann class MenuDelegate { 38647caa17caSRaphael Isemann public: 38657caa17caSRaphael Isemann virtual ~MenuDelegate() = default; 38667caa17caSRaphael Isemann 38677caa17caSRaphael Isemann virtual MenuActionResult MenuDelegateAction(Menu &menu) = 0; 38687caa17caSRaphael Isemann }; 38697caa17caSRaphael Isemann 38707caa17caSRaphael Isemann class Menu : public WindowDelegate { 38717caa17caSRaphael Isemann public: 38727caa17caSRaphael Isemann enum class Type { Invalid, Bar, Item, Separator }; 38737caa17caSRaphael Isemann 38747caa17caSRaphael Isemann // Menubar or separator constructor 38757caa17caSRaphael Isemann Menu(Type type); 38767caa17caSRaphael Isemann 38777caa17caSRaphael Isemann // Menuitem constructor 38787caa17caSRaphael Isemann Menu(const char *name, const char *key_name, int key_value, 38797caa17caSRaphael Isemann uint64_t identifier); 38807caa17caSRaphael Isemann 38817caa17caSRaphael Isemann ~Menu() override = default; 38827caa17caSRaphael Isemann 38837caa17caSRaphael Isemann const MenuDelegateSP &GetDelegate() const { return m_delegate_sp; } 38847caa17caSRaphael Isemann 38857caa17caSRaphael Isemann void SetDelegate(const MenuDelegateSP &delegate_sp) { 38867caa17caSRaphael Isemann m_delegate_sp = delegate_sp; 38877caa17caSRaphael Isemann } 38887caa17caSRaphael Isemann 38897caa17caSRaphael Isemann void RecalculateNameLengths(); 38907caa17caSRaphael Isemann 38917caa17caSRaphael Isemann void AddSubmenu(const MenuSP &menu_sp); 38927caa17caSRaphael Isemann 38937caa17caSRaphael Isemann int DrawAndRunMenu(Window &window); 38947caa17caSRaphael Isemann 38957caa17caSRaphael Isemann void DrawMenuTitle(Window &window, bool highlight); 38967caa17caSRaphael Isemann 38977caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override; 38987caa17caSRaphael Isemann 38997caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int key) override; 39007caa17caSRaphael Isemann 39017caa17caSRaphael Isemann MenuActionResult ActionPrivate(Menu &menu) { 39027caa17caSRaphael Isemann MenuActionResult result = MenuActionResult::NotHandled; 39037caa17caSRaphael Isemann if (m_delegate_sp) { 39047caa17caSRaphael Isemann result = m_delegate_sp->MenuDelegateAction(menu); 39057caa17caSRaphael Isemann if (result != MenuActionResult::NotHandled) 39067caa17caSRaphael Isemann return result; 39077caa17caSRaphael Isemann } else if (m_parent) { 39087caa17caSRaphael Isemann result = m_parent->ActionPrivate(menu); 39097caa17caSRaphael Isemann if (result != MenuActionResult::NotHandled) 39107caa17caSRaphael Isemann return result; 39117caa17caSRaphael Isemann } 39127caa17caSRaphael Isemann return m_canned_result; 39137caa17caSRaphael Isemann } 39147caa17caSRaphael Isemann 39157caa17caSRaphael Isemann MenuActionResult Action() { 39167caa17caSRaphael Isemann // Call the recursive action so it can try to handle it with the menu 39177caa17caSRaphael Isemann // delegate, and if not, try our parent menu 39187caa17caSRaphael Isemann return ActionPrivate(*this); 39197caa17caSRaphael Isemann } 39207caa17caSRaphael Isemann 39217caa17caSRaphael Isemann void SetCannedResult(MenuActionResult result) { m_canned_result = result; } 39227caa17caSRaphael Isemann 39237caa17caSRaphael Isemann Menus &GetSubmenus() { return m_submenus; } 39247caa17caSRaphael Isemann 39257caa17caSRaphael Isemann const Menus &GetSubmenus() const { return m_submenus; } 39267caa17caSRaphael Isemann 39277caa17caSRaphael Isemann int GetSelectedSubmenuIndex() const { return m_selected; } 39287caa17caSRaphael Isemann 39297caa17caSRaphael Isemann void SetSelectedSubmenuIndex(int idx) { m_selected = idx; } 39307caa17caSRaphael Isemann 39317caa17caSRaphael Isemann Type GetType() const { return m_type; } 39327caa17caSRaphael Isemann 39337caa17caSRaphael Isemann int GetStartingColumn() const { return m_start_col; } 39347caa17caSRaphael Isemann 39357caa17caSRaphael Isemann void SetStartingColumn(int col) { m_start_col = col; } 39367caa17caSRaphael Isemann 39377caa17caSRaphael Isemann int GetKeyValue() const { return m_key_value; } 39387caa17caSRaphael Isemann 39397caa17caSRaphael Isemann std::string &GetName() { return m_name; } 39407caa17caSRaphael Isemann 39417caa17caSRaphael Isemann int GetDrawWidth() const { 39427caa17caSRaphael Isemann return m_max_submenu_name_length + m_max_submenu_key_name_length + 8; 39437caa17caSRaphael Isemann } 39447caa17caSRaphael Isemann 39457caa17caSRaphael Isemann uint64_t GetIdentifier() const { return m_identifier; } 39467caa17caSRaphael Isemann 39477caa17caSRaphael Isemann void SetIdentifier(uint64_t identifier) { m_identifier = identifier; } 39487caa17caSRaphael Isemann 39497caa17caSRaphael Isemann protected: 39507caa17caSRaphael Isemann std::string m_name; 39517caa17caSRaphael Isemann std::string m_key_name; 39527caa17caSRaphael Isemann uint64_t m_identifier; 39537caa17caSRaphael Isemann Type m_type; 39547caa17caSRaphael Isemann int m_key_value; 39557caa17caSRaphael Isemann int m_start_col; 39567caa17caSRaphael Isemann int m_max_submenu_name_length; 39577caa17caSRaphael Isemann int m_max_submenu_key_name_length; 39587caa17caSRaphael Isemann int m_selected; 39597caa17caSRaphael Isemann Menu *m_parent; 39607caa17caSRaphael Isemann Menus m_submenus; 39617caa17caSRaphael Isemann WindowSP m_menu_window_sp; 39627caa17caSRaphael Isemann MenuActionResult m_canned_result; 39637caa17caSRaphael Isemann MenuDelegateSP m_delegate_sp; 39647caa17caSRaphael Isemann }; 39657caa17caSRaphael Isemann 39667caa17caSRaphael Isemann // Menubar or separator constructor 39677caa17caSRaphael Isemann Menu::Menu(Type type) 39687caa17caSRaphael Isemann : m_name(), m_key_name(), m_identifier(0), m_type(type), m_key_value(0), 39697caa17caSRaphael Isemann m_start_col(0), m_max_submenu_name_length(0), 39707caa17caSRaphael Isemann m_max_submenu_key_name_length(0), m_selected(0), m_parent(nullptr), 39717caa17caSRaphael Isemann m_submenus(), m_canned_result(MenuActionResult::NotHandled), 39727caa17caSRaphael Isemann m_delegate_sp() {} 39737caa17caSRaphael Isemann 39747caa17caSRaphael Isemann // Menuitem constructor 39757caa17caSRaphael Isemann Menu::Menu(const char *name, const char *key_name, int key_value, 39767caa17caSRaphael Isemann uint64_t identifier) 39777caa17caSRaphael Isemann : m_name(), m_key_name(), m_identifier(identifier), m_type(Type::Invalid), 39787caa17caSRaphael Isemann m_key_value(key_value), m_start_col(0), m_max_submenu_name_length(0), 39797caa17caSRaphael Isemann m_max_submenu_key_name_length(0), m_selected(0), m_parent(nullptr), 39807caa17caSRaphael Isemann m_submenus(), m_canned_result(MenuActionResult::NotHandled), 39817caa17caSRaphael Isemann m_delegate_sp() { 39827caa17caSRaphael Isemann if (name && name[0]) { 39837caa17caSRaphael Isemann m_name = name; 39847caa17caSRaphael Isemann m_type = Type::Item; 39857caa17caSRaphael Isemann if (key_name && key_name[0]) 39867caa17caSRaphael Isemann m_key_name = key_name; 39877caa17caSRaphael Isemann } else { 39887caa17caSRaphael Isemann m_type = Type::Separator; 39897caa17caSRaphael Isemann } 39907caa17caSRaphael Isemann } 39917caa17caSRaphael Isemann 39927caa17caSRaphael Isemann void Menu::RecalculateNameLengths() { 39937caa17caSRaphael Isemann m_max_submenu_name_length = 0; 39947caa17caSRaphael Isemann m_max_submenu_key_name_length = 0; 39957caa17caSRaphael Isemann Menus &submenus = GetSubmenus(); 39967caa17caSRaphael Isemann const size_t num_submenus = submenus.size(); 39977caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 39987caa17caSRaphael Isemann Menu *submenu = submenus[i].get(); 39997caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_name_length) < submenu->m_name.size()) 40007caa17caSRaphael Isemann m_max_submenu_name_length = submenu->m_name.size(); 40017caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_key_name_length) < 40027caa17caSRaphael Isemann submenu->m_key_name.size()) 40037caa17caSRaphael Isemann m_max_submenu_key_name_length = submenu->m_key_name.size(); 40047caa17caSRaphael Isemann } 40057caa17caSRaphael Isemann } 40067caa17caSRaphael Isemann 40077caa17caSRaphael Isemann void Menu::AddSubmenu(const MenuSP &menu_sp) { 40087caa17caSRaphael Isemann menu_sp->m_parent = this; 40097caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_name_length) < menu_sp->m_name.size()) 40107caa17caSRaphael Isemann m_max_submenu_name_length = menu_sp->m_name.size(); 40117caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_key_name_length) < 40127caa17caSRaphael Isemann menu_sp->m_key_name.size()) 40137caa17caSRaphael Isemann m_max_submenu_key_name_length = menu_sp->m_key_name.size(); 40147caa17caSRaphael Isemann m_submenus.push_back(menu_sp); 40157caa17caSRaphael Isemann } 40167caa17caSRaphael Isemann 40177caa17caSRaphael Isemann void Menu::DrawMenuTitle(Window &window, bool highlight) { 40187caa17caSRaphael Isemann if (m_type == Type::Separator) { 40197caa17caSRaphael Isemann window.MoveCursor(0, window.GetCursorY()); 40207caa17caSRaphael Isemann window.PutChar(ACS_LTEE); 40217caa17caSRaphael Isemann int width = window.GetWidth(); 40227caa17caSRaphael Isemann if (width > 2) { 40237caa17caSRaphael Isemann width -= 2; 40247caa17caSRaphael Isemann for (int i = 0; i < width; ++i) 40257caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 40267caa17caSRaphael Isemann } 40277caa17caSRaphael Isemann window.PutChar(ACS_RTEE); 40287caa17caSRaphael Isemann } else { 40297caa17caSRaphael Isemann const int shortcut_key = m_key_value; 40307caa17caSRaphael Isemann bool underlined_shortcut = false; 4031daa1c6d9SLuboš Luňák const attr_t highlight_attr = A_REVERSE; 40327caa17caSRaphael Isemann if (highlight) 4033daa1c6d9SLuboš Luňák window.AttributeOn(highlight_attr); 4034f5eaa2afSRaphael Isemann if (llvm::isPrint(shortcut_key)) { 40357caa17caSRaphael Isemann size_t lower_pos = m_name.find(tolower(shortcut_key)); 40367caa17caSRaphael Isemann size_t upper_pos = m_name.find(toupper(shortcut_key)); 40377caa17caSRaphael Isemann const char *name = m_name.c_str(); 40387caa17caSRaphael Isemann size_t pos = std::min<size_t>(lower_pos, upper_pos); 40397caa17caSRaphael Isemann if (pos != std::string::npos) { 40407caa17caSRaphael Isemann underlined_shortcut = true; 40417caa17caSRaphael Isemann if (pos > 0) { 40427caa17caSRaphael Isemann window.PutCString(name, pos); 40437caa17caSRaphael Isemann name += pos; 40447caa17caSRaphael Isemann } 40457caa17caSRaphael Isemann const attr_t shortcut_attr = A_UNDERLINE | A_BOLD; 40467caa17caSRaphael Isemann window.AttributeOn(shortcut_attr); 40477caa17caSRaphael Isemann window.PutChar(name[0]); 40487caa17caSRaphael Isemann window.AttributeOff(shortcut_attr); 40497caa17caSRaphael Isemann name++; 40507caa17caSRaphael Isemann if (name[0]) 40517caa17caSRaphael Isemann window.PutCString(name); 40527caa17caSRaphael Isemann } 40537caa17caSRaphael Isemann } 40547caa17caSRaphael Isemann 40557caa17caSRaphael Isemann if (!underlined_shortcut) { 40567caa17caSRaphael Isemann window.PutCString(m_name.c_str()); 40577caa17caSRaphael Isemann } 40587caa17caSRaphael Isemann 40597caa17caSRaphael Isemann if (highlight) 4060daa1c6d9SLuboš Luňák window.AttributeOff(highlight_attr); 40617caa17caSRaphael Isemann 40627caa17caSRaphael Isemann if (m_key_name.empty()) { 4063f5eaa2afSRaphael Isemann if (!underlined_shortcut && llvm::isPrint(m_key_value)) { 40644a8e4b5cSLuboš Luňák window.AttributeOn(COLOR_PAIR(MagentaOnWhite)); 40657caa17caSRaphael Isemann window.Printf(" (%c)", m_key_value); 40664a8e4b5cSLuboš Luňák window.AttributeOff(COLOR_PAIR(MagentaOnWhite)); 40677caa17caSRaphael Isemann } 40687caa17caSRaphael Isemann } else { 40694a8e4b5cSLuboš Luňák window.AttributeOn(COLOR_PAIR(MagentaOnWhite)); 40707caa17caSRaphael Isemann window.Printf(" (%s)", m_key_name.c_str()); 40714a8e4b5cSLuboš Luňák window.AttributeOff(COLOR_PAIR(MagentaOnWhite)); 40727caa17caSRaphael Isemann } 40737caa17caSRaphael Isemann } 40747caa17caSRaphael Isemann } 40757caa17caSRaphael Isemann 40767caa17caSRaphael Isemann bool Menu::WindowDelegateDraw(Window &window, bool force) { 40777caa17caSRaphael Isemann Menus &submenus = GetSubmenus(); 40787caa17caSRaphael Isemann const size_t num_submenus = submenus.size(); 40797caa17caSRaphael Isemann const int selected_idx = GetSelectedSubmenuIndex(); 40807caa17caSRaphael Isemann Menu::Type menu_type = GetType(); 40817caa17caSRaphael Isemann switch (menu_type) { 40827caa17caSRaphael Isemann case Menu::Type::Bar: { 40834a8e4b5cSLuboš Luňák window.SetBackground(BlackOnWhite); 40847caa17caSRaphael Isemann window.MoveCursor(0, 0); 40857caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 40867caa17caSRaphael Isemann Menu *menu = submenus[i].get(); 40877caa17caSRaphael Isemann if (i > 0) 40887caa17caSRaphael Isemann window.PutChar(' '); 40897caa17caSRaphael Isemann menu->SetStartingColumn(window.GetCursorX()); 40907caa17caSRaphael Isemann window.PutCString("| "); 40917caa17caSRaphael Isemann menu->DrawMenuTitle(window, false); 40927caa17caSRaphael Isemann } 40937caa17caSRaphael Isemann window.PutCString(" |"); 40947caa17caSRaphael Isemann } break; 40957caa17caSRaphael Isemann 40967caa17caSRaphael Isemann case Menu::Type::Item: { 40977caa17caSRaphael Isemann int y = 1; 40987caa17caSRaphael Isemann int x = 3; 40997caa17caSRaphael Isemann // Draw the menu 41007caa17caSRaphael Isemann int cursor_x = 0; 41017caa17caSRaphael Isemann int cursor_y = 0; 41027caa17caSRaphael Isemann window.Erase(); 41034a8e4b5cSLuboš Luňák window.SetBackground(BlackOnWhite); 41047caa17caSRaphael Isemann window.Box(); 41057caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 41067caa17caSRaphael Isemann const bool is_selected = (i == static_cast<size_t>(selected_idx)); 41077caa17caSRaphael Isemann window.MoveCursor(x, y + i); 41087caa17caSRaphael Isemann if (is_selected) { 41097caa17caSRaphael Isemann // Remember where we want the cursor to be 41107caa17caSRaphael Isemann cursor_x = x - 1; 41117caa17caSRaphael Isemann cursor_y = y + i; 41127caa17caSRaphael Isemann } 41137caa17caSRaphael Isemann submenus[i]->DrawMenuTitle(window, is_selected); 41147caa17caSRaphael Isemann } 41157caa17caSRaphael Isemann window.MoveCursor(cursor_x, cursor_y); 41167caa17caSRaphael Isemann } break; 41177caa17caSRaphael Isemann 41187caa17caSRaphael Isemann default: 41197caa17caSRaphael Isemann case Menu::Type::Separator: 41207caa17caSRaphael Isemann break; 41217caa17caSRaphael Isemann } 41227caa17caSRaphael Isemann return true; // Drawing handled... 41237caa17caSRaphael Isemann } 41247caa17caSRaphael Isemann 41257caa17caSRaphael Isemann HandleCharResult Menu::WindowDelegateHandleChar(Window &window, int key) { 41267caa17caSRaphael Isemann HandleCharResult result = eKeyNotHandled; 41277caa17caSRaphael Isemann 41287caa17caSRaphael Isemann Menus &submenus = GetSubmenus(); 41297caa17caSRaphael Isemann const size_t num_submenus = submenus.size(); 41307caa17caSRaphael Isemann const int selected_idx = GetSelectedSubmenuIndex(); 41317caa17caSRaphael Isemann Menu::Type menu_type = GetType(); 41327caa17caSRaphael Isemann if (menu_type == Menu::Type::Bar) { 41337caa17caSRaphael Isemann MenuSP run_menu_sp; 41347caa17caSRaphael Isemann switch (key) { 41357caa17caSRaphael Isemann case KEY_DOWN: 41367caa17caSRaphael Isemann case KEY_UP: 41377caa17caSRaphael Isemann // Show last menu or first menu 41387caa17caSRaphael Isemann if (selected_idx < static_cast<int>(num_submenus)) 41397caa17caSRaphael Isemann run_menu_sp = submenus[selected_idx]; 41407caa17caSRaphael Isemann else if (!submenus.empty()) 41417caa17caSRaphael Isemann run_menu_sp = submenus.front(); 41427caa17caSRaphael Isemann result = eKeyHandled; 41437caa17caSRaphael Isemann break; 41447caa17caSRaphael Isemann 41457caa17caSRaphael Isemann case KEY_RIGHT: 41467caa17caSRaphael Isemann ++m_selected; 41477caa17caSRaphael Isemann if (m_selected >= static_cast<int>(num_submenus)) 41487caa17caSRaphael Isemann m_selected = 0; 41497caa17caSRaphael Isemann if (m_selected < static_cast<int>(num_submenus)) 41507caa17caSRaphael Isemann run_menu_sp = submenus[m_selected]; 41517caa17caSRaphael Isemann else if (!submenus.empty()) 41527caa17caSRaphael Isemann run_menu_sp = submenus.front(); 41537caa17caSRaphael Isemann result = eKeyHandled; 41547caa17caSRaphael Isemann break; 41557caa17caSRaphael Isemann 41567caa17caSRaphael Isemann case KEY_LEFT: 41577caa17caSRaphael Isemann --m_selected; 41587caa17caSRaphael Isemann if (m_selected < 0) 41597caa17caSRaphael Isemann m_selected = num_submenus - 1; 41607caa17caSRaphael Isemann if (m_selected < static_cast<int>(num_submenus)) 41617caa17caSRaphael Isemann run_menu_sp = submenus[m_selected]; 41627caa17caSRaphael Isemann else if (!submenus.empty()) 41637caa17caSRaphael Isemann run_menu_sp = submenus.front(); 41647caa17caSRaphael Isemann result = eKeyHandled; 41657caa17caSRaphael Isemann break; 41667caa17caSRaphael Isemann 41677caa17caSRaphael Isemann default: 41687caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 41697caa17caSRaphael Isemann if (submenus[i]->GetKeyValue() == key) { 41707caa17caSRaphael Isemann SetSelectedSubmenuIndex(i); 41717caa17caSRaphael Isemann run_menu_sp = submenus[i]; 41727caa17caSRaphael Isemann result = eKeyHandled; 41737caa17caSRaphael Isemann break; 41747caa17caSRaphael Isemann } 41757caa17caSRaphael Isemann } 41767caa17caSRaphael Isemann break; 41777caa17caSRaphael Isemann } 41787caa17caSRaphael Isemann 41797caa17caSRaphael Isemann if (run_menu_sp) { 41807caa17caSRaphael Isemann // Run the action on this menu in case we need to populate the menu with 41817caa17caSRaphael Isemann // dynamic content and also in case check marks, and any other menu 41827caa17caSRaphael Isemann // decorations need to be calculated 41837caa17caSRaphael Isemann if (run_menu_sp->Action() == MenuActionResult::Quit) 41847caa17caSRaphael Isemann return eQuitApplication; 41857caa17caSRaphael Isemann 41867caa17caSRaphael Isemann Rect menu_bounds; 41877caa17caSRaphael Isemann menu_bounds.origin.x = run_menu_sp->GetStartingColumn(); 41887caa17caSRaphael Isemann menu_bounds.origin.y = 1; 41897caa17caSRaphael Isemann menu_bounds.size.width = run_menu_sp->GetDrawWidth(); 41907caa17caSRaphael Isemann menu_bounds.size.height = run_menu_sp->GetSubmenus().size() + 2; 41917caa17caSRaphael Isemann if (m_menu_window_sp) 41927caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(m_menu_window_sp.get()); 41937caa17caSRaphael Isemann 41947caa17caSRaphael Isemann m_menu_window_sp = window.GetParent()->CreateSubWindow( 41957caa17caSRaphael Isemann run_menu_sp->GetName().c_str(), menu_bounds, true); 41967caa17caSRaphael Isemann m_menu_window_sp->SetDelegate(run_menu_sp); 41977caa17caSRaphael Isemann } 41987caa17caSRaphael Isemann } else if (menu_type == Menu::Type::Item) { 41997caa17caSRaphael Isemann switch (key) { 42007caa17caSRaphael Isemann case KEY_DOWN: 42017caa17caSRaphael Isemann if (m_submenus.size() > 1) { 42027caa17caSRaphael Isemann const int start_select = m_selected; 42037caa17caSRaphael Isemann while (++m_selected != start_select) { 42047caa17caSRaphael Isemann if (static_cast<size_t>(m_selected) >= num_submenus) 42057caa17caSRaphael Isemann m_selected = 0; 42067caa17caSRaphael Isemann if (m_submenus[m_selected]->GetType() == Type::Separator) 42077caa17caSRaphael Isemann continue; 42087caa17caSRaphael Isemann else 42097caa17caSRaphael Isemann break; 42107caa17caSRaphael Isemann } 42117caa17caSRaphael Isemann return eKeyHandled; 42127caa17caSRaphael Isemann } 42137caa17caSRaphael Isemann break; 42147caa17caSRaphael Isemann 42157caa17caSRaphael Isemann case KEY_UP: 42167caa17caSRaphael Isemann if (m_submenus.size() > 1) { 42177caa17caSRaphael Isemann const int start_select = m_selected; 42187caa17caSRaphael Isemann while (--m_selected != start_select) { 42197caa17caSRaphael Isemann if (m_selected < static_cast<int>(0)) 42207caa17caSRaphael Isemann m_selected = num_submenus - 1; 42217caa17caSRaphael Isemann if (m_submenus[m_selected]->GetType() == Type::Separator) 42227caa17caSRaphael Isemann continue; 42237caa17caSRaphael Isemann else 42247caa17caSRaphael Isemann break; 42257caa17caSRaphael Isemann } 42267caa17caSRaphael Isemann return eKeyHandled; 42277caa17caSRaphael Isemann } 42287caa17caSRaphael Isemann break; 42297caa17caSRaphael Isemann 42307caa17caSRaphael Isemann case KEY_RETURN: 42317caa17caSRaphael Isemann if (static_cast<size_t>(selected_idx) < num_submenus) { 42327caa17caSRaphael Isemann if (submenus[selected_idx]->Action() == MenuActionResult::Quit) 42337caa17caSRaphael Isemann return eQuitApplication; 42347caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 42357caa17caSRaphael Isemann return eKeyHandled; 42367caa17caSRaphael Isemann } 42377caa17caSRaphael Isemann break; 42387caa17caSRaphael Isemann 42397caa17caSRaphael Isemann case KEY_ESCAPE: // Beware: pressing escape key has 1 to 2 second delay in 42407caa17caSRaphael Isemann // case other chars are entered for escaped sequences 42417caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 42427caa17caSRaphael Isemann return eKeyHandled; 42437caa17caSRaphael Isemann 42447caa17caSRaphael Isemann default: 42457caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 42467caa17caSRaphael Isemann Menu *menu = submenus[i].get(); 42477caa17caSRaphael Isemann if (menu->GetKeyValue() == key) { 42487caa17caSRaphael Isemann SetSelectedSubmenuIndex(i); 42497caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 42507caa17caSRaphael Isemann if (menu->Action() == MenuActionResult::Quit) 42517caa17caSRaphael Isemann return eQuitApplication; 42527caa17caSRaphael Isemann return eKeyHandled; 42537caa17caSRaphael Isemann } 42547caa17caSRaphael Isemann } 42557caa17caSRaphael Isemann break; 42567caa17caSRaphael Isemann } 42577caa17caSRaphael Isemann } else if (menu_type == Menu::Type::Separator) { 42587caa17caSRaphael Isemann } 42597caa17caSRaphael Isemann return result; 42607caa17caSRaphael Isemann } 42617caa17caSRaphael Isemann 42627caa17caSRaphael Isemann class Application { 42637caa17caSRaphael Isemann public: 426428c878aeSShafik Yaghmour Application(FILE *in, FILE *out) : m_window_sp(), m_in(in), m_out(out) {} 42657caa17caSRaphael Isemann 42667caa17caSRaphael Isemann ~Application() { 42677caa17caSRaphael Isemann m_window_delegates.clear(); 42687caa17caSRaphael Isemann m_window_sp.reset(); 42697caa17caSRaphael Isemann if (m_screen) { 42707caa17caSRaphael Isemann ::delscreen(m_screen); 42717caa17caSRaphael Isemann m_screen = nullptr; 42727caa17caSRaphael Isemann } 42737caa17caSRaphael Isemann } 42747caa17caSRaphael Isemann 42757caa17caSRaphael Isemann void Initialize() { 42767caa17caSRaphael Isemann m_screen = ::newterm(nullptr, m_out, m_in); 42777caa17caSRaphael Isemann ::start_color(); 42787caa17caSRaphael Isemann ::curs_set(0); 42797caa17caSRaphael Isemann ::noecho(); 42807caa17caSRaphael Isemann ::keypad(stdscr, TRUE); 42817caa17caSRaphael Isemann } 42827caa17caSRaphael Isemann 42837caa17caSRaphael Isemann void Terminate() { ::endwin(); } 42847caa17caSRaphael Isemann 42857caa17caSRaphael Isemann void Run(Debugger &debugger) { 42867caa17caSRaphael Isemann bool done = false; 42877caa17caSRaphael Isemann int delay_in_tenths_of_a_second = 1; 42887caa17caSRaphael Isemann 428918c25cd3SOmar Emara // Alas the threading model in curses is a bit lame so we need to resort 429018c25cd3SOmar Emara // to polling every 0.5 seconds. We could poll for stdin ourselves and 429118c25cd3SOmar Emara // then pass the keys down but then we need to translate all of the escape 42927caa17caSRaphael Isemann // sequences ourselves. So we resort to polling for input because we need 42937caa17caSRaphael Isemann // to receive async process events while in this loop. 42947caa17caSRaphael Isemann 429518c25cd3SOmar Emara halfdelay(delay_in_tenths_of_a_second); // Poll using some number of 429618c25cd3SOmar Emara // tenths of seconds seconds when 429718c25cd3SOmar Emara // calling Window::GetChar() 42987caa17caSRaphael Isemann 42997caa17caSRaphael Isemann ListenerSP listener_sp( 43007caa17caSRaphael Isemann Listener::MakeListener("lldb.IOHandler.curses.Application")); 43017caa17caSRaphael Isemann ConstString broadcaster_class_process(Process::GetStaticBroadcasterClass()); 43027caa17caSRaphael Isemann debugger.EnableForwardEvents(listener_sp); 43037caa17caSRaphael Isemann 43042f1b24b7SLuboš Luňák m_update_screen = true; 43057caa17caSRaphael Isemann #if defined(__APPLE__) 43067caa17caSRaphael Isemann std::deque<int> escape_chars; 43077caa17caSRaphael Isemann #endif 43087caa17caSRaphael Isemann 43097caa17caSRaphael Isemann while (!done) { 43102f1b24b7SLuboš Luňák if (m_update_screen) { 43117caa17caSRaphael Isemann m_window_sp->Draw(false); 43127caa17caSRaphael Isemann // All windows should be calling Window::DeferredRefresh() instead of 43137caa17caSRaphael Isemann // Window::Refresh() so we can do a single update and avoid any screen 43147caa17caSRaphael Isemann // blinking 43157caa17caSRaphael Isemann update_panels(); 43167caa17caSRaphael Isemann 43177caa17caSRaphael Isemann // Cursor hiding isn't working on MacOSX, so hide it in the top left 43187caa17caSRaphael Isemann // corner 43197caa17caSRaphael Isemann m_window_sp->MoveCursor(0, 0); 43207caa17caSRaphael Isemann 43217caa17caSRaphael Isemann doupdate(); 43222f1b24b7SLuboš Luňák m_update_screen = false; 43237caa17caSRaphael Isemann } 43247caa17caSRaphael Isemann 43257caa17caSRaphael Isemann #if defined(__APPLE__) 43267caa17caSRaphael Isemann // Terminal.app doesn't map its function keys correctly, F1-F4 default 43277caa17caSRaphael Isemann // to: \033OP, \033OQ, \033OR, \033OS, so lets take care of this here if 43287caa17caSRaphael Isemann // possible 43297caa17caSRaphael Isemann int ch; 43307caa17caSRaphael Isemann if (escape_chars.empty()) 43317caa17caSRaphael Isemann ch = m_window_sp->GetChar(); 43327caa17caSRaphael Isemann else { 43337caa17caSRaphael Isemann ch = escape_chars.front(); 43347caa17caSRaphael Isemann escape_chars.pop_front(); 43357caa17caSRaphael Isemann } 43367caa17caSRaphael Isemann if (ch == KEY_ESCAPE) { 43377caa17caSRaphael Isemann int ch2 = m_window_sp->GetChar(); 43387caa17caSRaphael Isemann if (ch2 == 'O') { 43397caa17caSRaphael Isemann int ch3 = m_window_sp->GetChar(); 43407caa17caSRaphael Isemann switch (ch3) { 43417caa17caSRaphael Isemann case 'P': 43427caa17caSRaphael Isemann ch = KEY_F(1); 43437caa17caSRaphael Isemann break; 43447caa17caSRaphael Isemann case 'Q': 43457caa17caSRaphael Isemann ch = KEY_F(2); 43467caa17caSRaphael Isemann break; 43477caa17caSRaphael Isemann case 'R': 43487caa17caSRaphael Isemann ch = KEY_F(3); 43497caa17caSRaphael Isemann break; 43507caa17caSRaphael Isemann case 'S': 43517caa17caSRaphael Isemann ch = KEY_F(4); 43527caa17caSRaphael Isemann break; 43537caa17caSRaphael Isemann default: 43547caa17caSRaphael Isemann escape_chars.push_back(ch2); 43557caa17caSRaphael Isemann if (ch3 != -1) 43567caa17caSRaphael Isemann escape_chars.push_back(ch3); 43577caa17caSRaphael Isemann break; 43587caa17caSRaphael Isemann } 43597caa17caSRaphael Isemann } else if (ch2 != -1) 43607caa17caSRaphael Isemann escape_chars.push_back(ch2); 43617caa17caSRaphael Isemann } 43627caa17caSRaphael Isemann #else 43637caa17caSRaphael Isemann int ch = m_window_sp->GetChar(); 43647caa17caSRaphael Isemann 43657caa17caSRaphael Isemann #endif 43667caa17caSRaphael Isemann if (ch == -1) { 43677caa17caSRaphael Isemann if (feof(m_in) || ferror(m_in)) { 43687caa17caSRaphael Isemann done = true; 43697caa17caSRaphael Isemann } else { 43707caa17caSRaphael Isemann // Just a timeout from using halfdelay(), check for events 43717caa17caSRaphael Isemann EventSP event_sp; 43727caa17caSRaphael Isemann while (listener_sp->PeekAtNextEvent()) { 43737caa17caSRaphael Isemann listener_sp->GetEvent(event_sp, std::chrono::seconds(0)); 43747caa17caSRaphael Isemann 43757caa17caSRaphael Isemann if (event_sp) { 43767caa17caSRaphael Isemann Broadcaster *broadcaster = event_sp->GetBroadcaster(); 43777caa17caSRaphael Isemann if (broadcaster) { 43787caa17caSRaphael Isemann // uint32_t event_type = event_sp->GetType(); 43797caa17caSRaphael Isemann ConstString broadcaster_class( 43807caa17caSRaphael Isemann broadcaster->GetBroadcasterClass()); 43817caa17caSRaphael Isemann if (broadcaster_class == broadcaster_class_process) { 43822f1b24b7SLuboš Luňák m_update_screen = true; 43837caa17caSRaphael Isemann continue; // Don't get any key, just update our view 43847caa17caSRaphael Isemann } 43857caa17caSRaphael Isemann } 43867caa17caSRaphael Isemann } 43877caa17caSRaphael Isemann } 43887caa17caSRaphael Isemann } 43897caa17caSRaphael Isemann } else { 43907caa17caSRaphael Isemann HandleCharResult key_result = m_window_sp->HandleChar(ch); 43917caa17caSRaphael Isemann switch (key_result) { 43927caa17caSRaphael Isemann case eKeyHandled: 43932f1b24b7SLuboš Luňák m_update_screen = true; 43947caa17caSRaphael Isemann break; 43957caa17caSRaphael Isemann case eKeyNotHandled: 43968739445eSLuboš Luňák if (ch == 12) { // Ctrl+L, force full redraw 43978739445eSLuboš Luňák redrawwin(m_window_sp->get()); 43982f1b24b7SLuboš Luňák m_update_screen = true; 43998739445eSLuboš Luňák } 44007caa17caSRaphael Isemann break; 44017caa17caSRaphael Isemann case eQuitApplication: 44027caa17caSRaphael Isemann done = true; 44037caa17caSRaphael Isemann break; 44047caa17caSRaphael Isemann } 44057caa17caSRaphael Isemann } 44067caa17caSRaphael Isemann } 44077caa17caSRaphael Isemann 44087caa17caSRaphael Isemann debugger.CancelForwardEvents(listener_sp); 44097caa17caSRaphael Isemann } 44107caa17caSRaphael Isemann 44117caa17caSRaphael Isemann WindowSP &GetMainWindow() { 44127caa17caSRaphael Isemann if (!m_window_sp) 44137caa17caSRaphael Isemann m_window_sp = std::make_shared<Window>("main", stdscr, false); 44147caa17caSRaphael Isemann return m_window_sp; 44157caa17caSRaphael Isemann } 44167caa17caSRaphael Isemann 44172f1b24b7SLuboš Luňák void TerminalSizeChanged() { 44182f1b24b7SLuboš Luňák ::endwin(); 44192f1b24b7SLuboš Luňák ::refresh(); 44202f1b24b7SLuboš Luňák Rect content_bounds = m_window_sp->GetFrame(); 44212f1b24b7SLuboš Luňák m_window_sp->SetBounds(content_bounds); 44222f1b24b7SLuboš Luňák if (WindowSP menubar_window_sp = m_window_sp->FindSubWindow("Menubar")) 44232f1b24b7SLuboš Luňák menubar_window_sp->SetBounds(content_bounds.MakeMenuBar()); 44242f1b24b7SLuboš Luňák if (WindowSP status_window_sp = m_window_sp->FindSubWindow("Status")) 44252f1b24b7SLuboš Luňák status_window_sp->SetBounds(content_bounds.MakeStatusBar()); 44262f1b24b7SLuboš Luňák 44272f1b24b7SLuboš Luňák WindowSP source_window_sp = m_window_sp->FindSubWindow("Source"); 44282f1b24b7SLuboš Luňák WindowSP variables_window_sp = m_window_sp->FindSubWindow("Variables"); 44292f1b24b7SLuboš Luňák WindowSP registers_window_sp = m_window_sp->FindSubWindow("Registers"); 44302f1b24b7SLuboš Luňák WindowSP threads_window_sp = m_window_sp->FindSubWindow("Threads"); 44312f1b24b7SLuboš Luňák 44322f1b24b7SLuboš Luňák Rect threads_bounds; 44332f1b24b7SLuboš Luňák Rect source_variables_bounds; 44342f1b24b7SLuboš Luňák content_bounds.VerticalSplitPercentage(0.80, source_variables_bounds, 44352f1b24b7SLuboš Luňák threads_bounds); 44362f1b24b7SLuboš Luňák if (threads_window_sp) 44372f1b24b7SLuboš Luňák threads_window_sp->SetBounds(threads_bounds); 44382f1b24b7SLuboš Luňák else 44392f1b24b7SLuboš Luňák source_variables_bounds = content_bounds; 44402f1b24b7SLuboš Luňák 44412f1b24b7SLuboš Luňák Rect source_bounds; 44422f1b24b7SLuboš Luňák Rect variables_registers_bounds; 44432f1b24b7SLuboš Luňák source_variables_bounds.HorizontalSplitPercentage( 44442f1b24b7SLuboš Luňák 0.70, source_bounds, variables_registers_bounds); 44452f1b24b7SLuboš Luňák if (variables_window_sp || registers_window_sp) { 44462f1b24b7SLuboš Luňák if (variables_window_sp && registers_window_sp) { 44472f1b24b7SLuboš Luňák Rect variables_bounds; 44482f1b24b7SLuboš Luňák Rect registers_bounds; 44492f1b24b7SLuboš Luňák variables_registers_bounds.VerticalSplitPercentage( 44502f1b24b7SLuboš Luňák 0.50, variables_bounds, registers_bounds); 44512f1b24b7SLuboš Luňák variables_window_sp->SetBounds(variables_bounds); 44522f1b24b7SLuboš Luňák registers_window_sp->SetBounds(registers_bounds); 44532f1b24b7SLuboš Luňák } else if (variables_window_sp) { 44542f1b24b7SLuboš Luňák variables_window_sp->SetBounds(variables_registers_bounds); 44552f1b24b7SLuboš Luňák } else { 44562f1b24b7SLuboš Luňák registers_window_sp->SetBounds(variables_registers_bounds); 44572f1b24b7SLuboš Luňák } 44582f1b24b7SLuboš Luňák } else { 44592f1b24b7SLuboš Luňák source_bounds = source_variables_bounds; 44602f1b24b7SLuboš Luňák } 44612f1b24b7SLuboš Luňák 44622f1b24b7SLuboš Luňák source_window_sp->SetBounds(source_bounds); 44632f1b24b7SLuboš Luňák 44642f1b24b7SLuboš Luňák touchwin(stdscr); 44652f1b24b7SLuboš Luňák redrawwin(m_window_sp->get()); 44662f1b24b7SLuboš Luňák m_update_screen = true; 44672f1b24b7SLuboš Luňák } 44682f1b24b7SLuboš Luňák 44697caa17caSRaphael Isemann protected: 44707caa17caSRaphael Isemann WindowSP m_window_sp; 44717caa17caSRaphael Isemann WindowDelegates m_window_delegates; 447228c878aeSShafik Yaghmour SCREEN *m_screen = nullptr; 44737caa17caSRaphael Isemann FILE *m_in; 44747caa17caSRaphael Isemann FILE *m_out; 44752f1b24b7SLuboš Luňák bool m_update_screen = false; 44767caa17caSRaphael Isemann }; 44777caa17caSRaphael Isemann 44787caa17caSRaphael Isemann } // namespace curses 44797caa17caSRaphael Isemann 44807caa17caSRaphael Isemann using namespace curses; 44817caa17caSRaphael Isemann 44827caa17caSRaphael Isemann struct Row { 44834631afdeSRaphael Isemann ValueObjectUpdater value; 44847caa17caSRaphael Isemann Row *parent; 44857caa17caSRaphael Isemann // The process stop ID when the children were calculated. 4486f7e04b71SJordan Rupprecht uint32_t children_stop_id = 0; 4487f7e04b71SJordan Rupprecht int row_idx = 0; 4488f7e04b71SJordan Rupprecht int x = 1; 4489f7e04b71SJordan Rupprecht int y = 1; 44907caa17caSRaphael Isemann bool might_have_children; 4491f7e04b71SJordan Rupprecht bool expanded = false; 4492f7e04b71SJordan Rupprecht bool calculated_children = false; 44937caa17caSRaphael Isemann std::vector<Row> children; 44947caa17caSRaphael Isemann 44957caa17caSRaphael Isemann Row(const ValueObjectSP &v, Row *p) 44964631afdeSRaphael Isemann : value(v), parent(p), 4497f7e04b71SJordan Rupprecht might_have_children(v ? v->MightHaveChildren() : false) {} 44987caa17caSRaphael Isemann 44997caa17caSRaphael Isemann size_t GetDepth() const { 45007caa17caSRaphael Isemann if (parent) 45017caa17caSRaphael Isemann return 1 + parent->GetDepth(); 45027caa17caSRaphael Isemann return 0; 45037caa17caSRaphael Isemann } 45047caa17caSRaphael Isemann 45057caa17caSRaphael Isemann void Expand() { expanded = true; } 45067caa17caSRaphael Isemann 45077caa17caSRaphael Isemann std::vector<Row> &GetChildren() { 45087caa17caSRaphael Isemann ProcessSP process_sp = value.GetProcessSP(); 45097caa17caSRaphael Isemann auto stop_id = process_sp->GetStopID(); 45107caa17caSRaphael Isemann if (process_sp && stop_id != children_stop_id) { 45117caa17caSRaphael Isemann children_stop_id = stop_id; 45127caa17caSRaphael Isemann calculated_children = false; 45137caa17caSRaphael Isemann } 45147caa17caSRaphael Isemann if (!calculated_children) { 45157caa17caSRaphael Isemann children.clear(); 45167caa17caSRaphael Isemann calculated_children = true; 45177caa17caSRaphael Isemann ValueObjectSP valobj = value.GetSP(); 45187caa17caSRaphael Isemann if (valobj) { 45197caa17caSRaphael Isemann const size_t num_children = valobj->GetNumChildren(); 45207caa17caSRaphael Isemann for (size_t i = 0; i < num_children; ++i) { 45217caa17caSRaphael Isemann children.push_back(Row(valobj->GetChildAtIndex(i, true), this)); 45227caa17caSRaphael Isemann } 45237caa17caSRaphael Isemann } 45247caa17caSRaphael Isemann } 45257caa17caSRaphael Isemann return children; 45267caa17caSRaphael Isemann } 45277caa17caSRaphael Isemann 45287caa17caSRaphael Isemann void Unexpand() { 45297caa17caSRaphael Isemann expanded = false; 45307caa17caSRaphael Isemann calculated_children = false; 45317caa17caSRaphael Isemann children.clear(); 45327caa17caSRaphael Isemann } 45337caa17caSRaphael Isemann 45347caa17caSRaphael Isemann void DrawTree(Window &window) { 45357caa17caSRaphael Isemann if (parent) 45367caa17caSRaphael Isemann parent->DrawTreeForChild(window, this, 0); 45377caa17caSRaphael Isemann 45387caa17caSRaphael Isemann if (might_have_children) { 45397caa17caSRaphael Isemann // It we can get UTF8 characters to work we should try to use the 45407caa17caSRaphael Isemann // "symbol" UTF8 string below 45417caa17caSRaphael Isemann // const char *symbol = ""; 45427caa17caSRaphael Isemann // if (row.expanded) 45437caa17caSRaphael Isemann // symbol = "\xe2\x96\xbd "; 45447caa17caSRaphael Isemann // else 45457caa17caSRaphael Isemann // symbol = "\xe2\x96\xb7 "; 45467caa17caSRaphael Isemann // window.PutCString (symbol); 45477caa17caSRaphael Isemann 45487caa17caSRaphael Isemann // The ACS_DARROW and ACS_RARROW don't look very nice they are just a 'v' 45497caa17caSRaphael Isemann // or '>' character... 45507caa17caSRaphael Isemann // if (expanded) 45517caa17caSRaphael Isemann // window.PutChar (ACS_DARROW); 45527caa17caSRaphael Isemann // else 45537caa17caSRaphael Isemann // window.PutChar (ACS_RARROW); 45547caa17caSRaphael Isemann // Since we can't find any good looking right arrow/down arrow symbols, 45557caa17caSRaphael Isemann // just use a diamond... 45567caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 45577caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 45587caa17caSRaphael Isemann } 45597caa17caSRaphael Isemann } 45607caa17caSRaphael Isemann 45617caa17caSRaphael Isemann void DrawTreeForChild(Window &window, Row *child, uint32_t reverse_depth) { 45627caa17caSRaphael Isemann if (parent) 45637caa17caSRaphael Isemann parent->DrawTreeForChild(window, this, reverse_depth + 1); 45647caa17caSRaphael Isemann 45657caa17caSRaphael Isemann if (&GetChildren().back() == child) { 45667caa17caSRaphael Isemann // Last child 45677caa17caSRaphael Isemann if (reverse_depth == 0) { 45687caa17caSRaphael Isemann window.PutChar(ACS_LLCORNER); 45697caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 45707caa17caSRaphael Isemann } else { 45717caa17caSRaphael Isemann window.PutChar(' '); 45727caa17caSRaphael Isemann window.PutChar(' '); 45737caa17caSRaphael Isemann } 45747caa17caSRaphael Isemann } else { 45757caa17caSRaphael Isemann if (reverse_depth == 0) { 45767caa17caSRaphael Isemann window.PutChar(ACS_LTEE); 45777caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 45787caa17caSRaphael Isemann } else { 45797caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 45807caa17caSRaphael Isemann window.PutChar(' '); 45817caa17caSRaphael Isemann } 45827caa17caSRaphael Isemann } 45837caa17caSRaphael Isemann } 45847caa17caSRaphael Isemann }; 45857caa17caSRaphael Isemann 45867caa17caSRaphael Isemann struct DisplayOptions { 45877caa17caSRaphael Isemann bool show_types; 45887caa17caSRaphael Isemann }; 45897caa17caSRaphael Isemann 45907caa17caSRaphael Isemann class TreeItem; 45917caa17caSRaphael Isemann 45927caa17caSRaphael Isemann class TreeDelegate { 45937caa17caSRaphael Isemann public: 45947caa17caSRaphael Isemann TreeDelegate() = default; 45957caa17caSRaphael Isemann virtual ~TreeDelegate() = default; 45967caa17caSRaphael Isemann 45977caa17caSRaphael Isemann virtual void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) = 0; 45987caa17caSRaphael Isemann virtual void TreeDelegateGenerateChildren(TreeItem &item) = 0; 4599a94fbb25SMuhammad Omair Javaid virtual void TreeDelegateUpdateSelection(TreeItem &root, int &selection_index, 46002d303e67SKazu Hirata TreeItem *&selected_item) {} 4601b26e1efcSOmar Emara // This is invoked when a tree item is selected. If true is returned, the 4602b26e1efcSOmar Emara // views are updated. 4603b26e1efcSOmar Emara virtual bool TreeDelegateItemSelected(TreeItem &item) = 0; 4604a94fbb25SMuhammad Omair Javaid virtual bool TreeDelegateExpandRootByDefault() { return false; } 4605b26e1efcSOmar Emara // This is mostly useful for root tree delegates. If false is returned, 4606b26e1efcSOmar Emara // drawing will be skipped completely. This is needed, for instance, in 4607b26e1efcSOmar Emara // skipping drawing of the threads tree if there is no running process. 4608b26e1efcSOmar Emara virtual bool TreeDelegateShouldDraw() { return true; } 46097caa17caSRaphael Isemann }; 46107caa17caSRaphael Isemann 46117caa17caSRaphael Isemann typedef std::shared_ptr<TreeDelegate> TreeDelegateSP; 46127caa17caSRaphael Isemann 46137caa17caSRaphael Isemann class TreeItem { 46147caa17caSRaphael Isemann public: 46157caa17caSRaphael Isemann TreeItem(TreeItem *parent, TreeDelegate &delegate, bool might_have_children) 461628c878aeSShafik Yaghmour : m_parent(parent), m_delegate(delegate), m_children(), 461728c878aeSShafik Yaghmour m_might_have_children(might_have_children) { 4618a94fbb25SMuhammad Omair Javaid if (m_parent == nullptr) 4619a94fbb25SMuhammad Omair Javaid m_is_expanded = m_delegate.TreeDelegateExpandRootByDefault(); 4620a94fbb25SMuhammad Omair Javaid } 46217caa17caSRaphael Isemann 46227caa17caSRaphael Isemann TreeItem &operator=(const TreeItem &rhs) { 46237caa17caSRaphael Isemann if (this != &rhs) { 46247caa17caSRaphael Isemann m_parent = rhs.m_parent; 46257caa17caSRaphael Isemann m_delegate = rhs.m_delegate; 46267caa17caSRaphael Isemann m_user_data = rhs.m_user_data; 46277caa17caSRaphael Isemann m_identifier = rhs.m_identifier; 46287caa17caSRaphael Isemann m_row_idx = rhs.m_row_idx; 46297caa17caSRaphael Isemann m_children = rhs.m_children; 46307caa17caSRaphael Isemann m_might_have_children = rhs.m_might_have_children; 46317caa17caSRaphael Isemann m_is_expanded = rhs.m_is_expanded; 46327caa17caSRaphael Isemann } 46337caa17caSRaphael Isemann return *this; 46347caa17caSRaphael Isemann } 46357caa17caSRaphael Isemann 46365312139fSEric Christopher TreeItem(const TreeItem &) = default; 46375312139fSEric Christopher 46387caa17caSRaphael Isemann size_t GetDepth() const { 46397caa17caSRaphael Isemann if (m_parent) 46407caa17caSRaphael Isemann return 1 + m_parent->GetDepth(); 46417caa17caSRaphael Isemann return 0; 46427caa17caSRaphael Isemann } 46437caa17caSRaphael Isemann 46447caa17caSRaphael Isemann int GetRowIndex() const { return m_row_idx; } 46457caa17caSRaphael Isemann 46467caa17caSRaphael Isemann void ClearChildren() { m_children.clear(); } 46477caa17caSRaphael Isemann 46487caa17caSRaphael Isemann void Resize(size_t n, const TreeItem &t) { m_children.resize(n, t); } 46497caa17caSRaphael Isemann 46507caa17caSRaphael Isemann TreeItem &operator[](size_t i) { return m_children[i]; } 46517caa17caSRaphael Isemann 46527caa17caSRaphael Isemann void SetRowIndex(int row_idx) { m_row_idx = row_idx; } 46537caa17caSRaphael Isemann 46547caa17caSRaphael Isemann size_t GetNumChildren() { 46557caa17caSRaphael Isemann m_delegate.TreeDelegateGenerateChildren(*this); 46567caa17caSRaphael Isemann return m_children.size(); 46577caa17caSRaphael Isemann } 46587caa17caSRaphael Isemann 46597caa17caSRaphael Isemann void ItemWasSelected() { m_delegate.TreeDelegateItemSelected(*this); } 46607caa17caSRaphael Isemann 46617caa17caSRaphael Isemann void CalculateRowIndexes(int &row_idx) { 46627caa17caSRaphael Isemann SetRowIndex(row_idx); 46637caa17caSRaphael Isemann ++row_idx; 46647caa17caSRaphael Isemann 46657caa17caSRaphael Isemann const bool expanded = IsExpanded(); 46667caa17caSRaphael Isemann 46677caa17caSRaphael Isemann // The root item must calculate its children, or we must calculate the 46687caa17caSRaphael Isemann // number of children if the item is expanded 46697caa17caSRaphael Isemann if (m_parent == nullptr || expanded) 46707caa17caSRaphael Isemann GetNumChildren(); 46717caa17caSRaphael Isemann 46727caa17caSRaphael Isemann for (auto &item : m_children) { 46737caa17caSRaphael Isemann if (expanded) 46747caa17caSRaphael Isemann item.CalculateRowIndexes(row_idx); 46757caa17caSRaphael Isemann else 46767caa17caSRaphael Isemann item.SetRowIndex(-1); 46777caa17caSRaphael Isemann } 46787caa17caSRaphael Isemann } 46797caa17caSRaphael Isemann 46807caa17caSRaphael Isemann TreeItem *GetParent() { return m_parent; } 46817caa17caSRaphael Isemann 46827caa17caSRaphael Isemann bool IsExpanded() const { return m_is_expanded; } 46837caa17caSRaphael Isemann 46847caa17caSRaphael Isemann void Expand() { m_is_expanded = true; } 46857caa17caSRaphael Isemann 46867caa17caSRaphael Isemann void Unexpand() { m_is_expanded = false; } 46877caa17caSRaphael Isemann 46887caa17caSRaphael Isemann bool Draw(Window &window, const int first_visible_row, 46897caa17caSRaphael Isemann const uint32_t selected_row_idx, int &row_idx, int &num_rows_left) { 46907caa17caSRaphael Isemann if (num_rows_left <= 0) 46917caa17caSRaphael Isemann return false; 46927caa17caSRaphael Isemann 46937caa17caSRaphael Isemann if (m_row_idx >= first_visible_row) { 46947caa17caSRaphael Isemann window.MoveCursor(2, row_idx + 1); 46957caa17caSRaphael Isemann 46967caa17caSRaphael Isemann if (m_parent) 46977caa17caSRaphael Isemann m_parent->DrawTreeForChild(window, this, 0); 46987caa17caSRaphael Isemann 46997caa17caSRaphael Isemann if (m_might_have_children) { 47007caa17caSRaphael Isemann // It we can get UTF8 characters to work we should try to use the 47017caa17caSRaphael Isemann // "symbol" UTF8 string below 47027caa17caSRaphael Isemann // const char *symbol = ""; 47037caa17caSRaphael Isemann // if (row.expanded) 47047caa17caSRaphael Isemann // symbol = "\xe2\x96\xbd "; 47057caa17caSRaphael Isemann // else 47067caa17caSRaphael Isemann // symbol = "\xe2\x96\xb7 "; 47077caa17caSRaphael Isemann // window.PutCString (symbol); 47087caa17caSRaphael Isemann 47097caa17caSRaphael Isemann // The ACS_DARROW and ACS_RARROW don't look very nice they are just a 47107caa17caSRaphael Isemann // 'v' or '>' character... 47117caa17caSRaphael Isemann // if (expanded) 47127caa17caSRaphael Isemann // window.PutChar (ACS_DARROW); 47137caa17caSRaphael Isemann // else 47147caa17caSRaphael Isemann // window.PutChar (ACS_RARROW); 47157caa17caSRaphael Isemann // Since we can't find any good looking right arrow/down arrow symbols, 47167caa17caSRaphael Isemann // just use a diamond... 47177caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 47187caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 47197caa17caSRaphael Isemann } 47207caa17caSRaphael Isemann bool highlight = (selected_row_idx == static_cast<size_t>(m_row_idx)) && 47217caa17caSRaphael Isemann window.IsActive(); 47227caa17caSRaphael Isemann 47237caa17caSRaphael Isemann if (highlight) 47247caa17caSRaphael Isemann window.AttributeOn(A_REVERSE); 47257caa17caSRaphael Isemann 47267caa17caSRaphael Isemann m_delegate.TreeDelegateDrawTreeItem(*this, window); 47277caa17caSRaphael Isemann 47287caa17caSRaphael Isemann if (highlight) 47297caa17caSRaphael Isemann window.AttributeOff(A_REVERSE); 47307caa17caSRaphael Isemann ++row_idx; 47317caa17caSRaphael Isemann --num_rows_left; 47327caa17caSRaphael Isemann } 47337caa17caSRaphael Isemann 47347caa17caSRaphael Isemann if (num_rows_left <= 0) 47357caa17caSRaphael Isemann return false; // We are done drawing... 47367caa17caSRaphael Isemann 47377caa17caSRaphael Isemann if (IsExpanded()) { 47387caa17caSRaphael Isemann for (auto &item : m_children) { 47397caa17caSRaphael Isemann // If we displayed all the rows and item.Draw() returns false we are 47407caa17caSRaphael Isemann // done drawing and can exit this for loop 47417caa17caSRaphael Isemann if (!item.Draw(window, first_visible_row, selected_row_idx, row_idx, 47427caa17caSRaphael Isemann num_rows_left)) 47437caa17caSRaphael Isemann break; 47447caa17caSRaphael Isemann } 47457caa17caSRaphael Isemann } 47467caa17caSRaphael Isemann return num_rows_left >= 0; // Return true if not done drawing yet 47477caa17caSRaphael Isemann } 47487caa17caSRaphael Isemann 47497caa17caSRaphael Isemann void DrawTreeForChild(Window &window, TreeItem *child, 47507caa17caSRaphael Isemann uint32_t reverse_depth) { 47517caa17caSRaphael Isemann if (m_parent) 47527caa17caSRaphael Isemann m_parent->DrawTreeForChild(window, this, reverse_depth + 1); 47537caa17caSRaphael Isemann 47547caa17caSRaphael Isemann if (&m_children.back() == child) { 47557caa17caSRaphael Isemann // Last child 47567caa17caSRaphael Isemann if (reverse_depth == 0) { 47577caa17caSRaphael Isemann window.PutChar(ACS_LLCORNER); 47587caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 47597caa17caSRaphael Isemann } else { 47607caa17caSRaphael Isemann window.PutChar(' '); 47617caa17caSRaphael Isemann window.PutChar(' '); 47627caa17caSRaphael Isemann } 47637caa17caSRaphael Isemann } else { 47647caa17caSRaphael Isemann if (reverse_depth == 0) { 47657caa17caSRaphael Isemann window.PutChar(ACS_LTEE); 47667caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 47677caa17caSRaphael Isemann } else { 47687caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 47697caa17caSRaphael Isemann window.PutChar(' '); 47707caa17caSRaphael Isemann } 47717caa17caSRaphael Isemann } 47727caa17caSRaphael Isemann } 47737caa17caSRaphael Isemann 47747caa17caSRaphael Isemann TreeItem *GetItemForRowIndex(uint32_t row_idx) { 47757caa17caSRaphael Isemann if (static_cast<uint32_t>(m_row_idx) == row_idx) 47767caa17caSRaphael Isemann return this; 47777caa17caSRaphael Isemann if (m_children.empty()) 47787caa17caSRaphael Isemann return nullptr; 47797caa17caSRaphael Isemann if (IsExpanded()) { 47807caa17caSRaphael Isemann for (auto &item : m_children) { 47817caa17caSRaphael Isemann TreeItem *selected_item_ptr = item.GetItemForRowIndex(row_idx); 47827caa17caSRaphael Isemann if (selected_item_ptr) 47837caa17caSRaphael Isemann return selected_item_ptr; 47847caa17caSRaphael Isemann } 47857caa17caSRaphael Isemann } 47867caa17caSRaphael Isemann return nullptr; 47877caa17caSRaphael Isemann } 47887caa17caSRaphael Isemann 47897caa17caSRaphael Isemann void *GetUserData() const { return m_user_data; } 47907caa17caSRaphael Isemann 47917caa17caSRaphael Isemann void SetUserData(void *user_data) { m_user_data = user_data; } 47927caa17caSRaphael Isemann 47937caa17caSRaphael Isemann uint64_t GetIdentifier() const { return m_identifier; } 47947caa17caSRaphael Isemann 47957caa17caSRaphael Isemann void SetIdentifier(uint64_t identifier) { m_identifier = identifier; } 47967caa17caSRaphael Isemann 4797b26e1efcSOmar Emara const std::string &GetText() const { return m_text; } 4798b26e1efcSOmar Emara 4799b26e1efcSOmar Emara void SetText(const char *text) { 4800b26e1efcSOmar Emara if (text == nullptr) { 4801b26e1efcSOmar Emara m_text.clear(); 4802b26e1efcSOmar Emara return; 4803b26e1efcSOmar Emara } 4804b26e1efcSOmar Emara m_text = text; 4805b26e1efcSOmar Emara } 4806b26e1efcSOmar Emara 48077caa17caSRaphael Isemann void SetMightHaveChildren(bool b) { m_might_have_children = b; } 48087caa17caSRaphael Isemann 48097caa17caSRaphael Isemann protected: 48107caa17caSRaphael Isemann TreeItem *m_parent; 48117caa17caSRaphael Isemann TreeDelegate &m_delegate; 481228c878aeSShafik Yaghmour void *m_user_data = nullptr; 481328c878aeSShafik Yaghmour uint64_t m_identifier = 0; 4814b26e1efcSOmar Emara std::string m_text; 481528c878aeSShafik Yaghmour int m_row_idx = -1; // Zero based visible row index, -1 if not visible or for 481628c878aeSShafik Yaghmour // the root item 48177caa17caSRaphael Isemann std::vector<TreeItem> m_children; 48187caa17caSRaphael Isemann bool m_might_have_children; 481928c878aeSShafik Yaghmour bool m_is_expanded = false; 48207caa17caSRaphael Isemann }; 48217caa17caSRaphael Isemann 48227caa17caSRaphael Isemann class TreeWindowDelegate : public WindowDelegate { 48237caa17caSRaphael Isemann public: 48247caa17caSRaphael Isemann TreeWindowDelegate(Debugger &debugger, const TreeDelegateSP &delegate_sp) 48257caa17caSRaphael Isemann : m_debugger(debugger), m_delegate_sp(delegate_sp), 482628c878aeSShafik Yaghmour m_root(nullptr, *delegate_sp, true) {} 48277caa17caSRaphael Isemann 48287caa17caSRaphael Isemann int NumVisibleRows() const { return m_max_y - m_min_y; } 48297caa17caSRaphael Isemann 48307caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 48317caa17caSRaphael Isemann m_min_x = 2; 48327caa17caSRaphael Isemann m_min_y = 1; 48337caa17caSRaphael Isemann m_max_x = window.GetWidth() - 1; 48347caa17caSRaphael Isemann m_max_y = window.GetHeight() - 1; 48357caa17caSRaphael Isemann 48367caa17caSRaphael Isemann window.Erase(); 48377caa17caSRaphael Isemann window.DrawTitleBox(window.GetName()); 48387caa17caSRaphael Isemann 4839b26e1efcSOmar Emara if (!m_delegate_sp->TreeDelegateShouldDraw()) { 4840b26e1efcSOmar Emara m_selected_item = nullptr; 4841b26e1efcSOmar Emara return true; 4842b26e1efcSOmar Emara } 4843b26e1efcSOmar Emara 48447caa17caSRaphael Isemann const int num_visible_rows = NumVisibleRows(); 48457caa17caSRaphael Isemann m_num_rows = 0; 48467caa17caSRaphael Isemann m_root.CalculateRowIndexes(m_num_rows); 4847a94fbb25SMuhammad Omair Javaid m_delegate_sp->TreeDelegateUpdateSelection(m_root, m_selected_row_idx, 4848a94fbb25SMuhammad Omair Javaid m_selected_item); 48497caa17caSRaphael Isemann 48507caa17caSRaphael Isemann // If we unexpanded while having something selected our total number of 48517caa17caSRaphael Isemann // rows is less than the num visible rows, then make sure we show all the 48527caa17caSRaphael Isemann // rows by setting the first visible row accordingly. 48537caa17caSRaphael Isemann if (m_first_visible_row > 0 && m_num_rows < num_visible_rows) 48547caa17caSRaphael Isemann m_first_visible_row = 0; 48557caa17caSRaphael Isemann 48567caa17caSRaphael Isemann // Make sure the selected row is always visible 48577caa17caSRaphael Isemann if (m_selected_row_idx < m_first_visible_row) 48587caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx; 48597caa17caSRaphael Isemann else if (m_first_visible_row + num_visible_rows <= m_selected_row_idx) 48607caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx - num_visible_rows + 1; 48617caa17caSRaphael Isemann 48627caa17caSRaphael Isemann int row_idx = 0; 48637caa17caSRaphael Isemann int num_rows_left = num_visible_rows; 48647caa17caSRaphael Isemann m_root.Draw(window, m_first_visible_row, m_selected_row_idx, row_idx, 48657caa17caSRaphael Isemann num_rows_left); 48667caa17caSRaphael Isemann // Get the selected row 48677caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 48687caa17caSRaphael Isemann 48697caa17caSRaphael Isemann return true; // Drawing handled 48707caa17caSRaphael Isemann } 48717caa17caSRaphael Isemann 48727caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 48737caa17caSRaphael Isemann return "Thread window keyboard shortcuts:"; 48747caa17caSRaphael Isemann } 48757caa17caSRaphael Isemann 48767caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 48777caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 48787caa17caSRaphael Isemann {KEY_UP, "Select previous item"}, 48797caa17caSRaphael Isemann {KEY_DOWN, "Select next item"}, 48807caa17caSRaphael Isemann {KEY_RIGHT, "Expand the selected item"}, 48817caa17caSRaphael Isemann {KEY_LEFT, 48827caa17caSRaphael Isemann "Unexpand the selected item or select parent if not expanded"}, 48837caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 48847caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 48857caa17caSRaphael Isemann {'h', "Show help dialog"}, 48867caa17caSRaphael Isemann {' ', "Toggle item expansion"}, 48877caa17caSRaphael Isemann {',', "Page up"}, 48887caa17caSRaphael Isemann {'.', "Page down"}, 48897caa17caSRaphael Isemann {'\0', nullptr}}; 48907caa17caSRaphael Isemann return g_source_view_key_help; 48917caa17caSRaphael Isemann } 48927caa17caSRaphael Isemann 48937caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int c) override { 48947caa17caSRaphael Isemann switch (c) { 48957caa17caSRaphael Isemann case ',': 48967caa17caSRaphael Isemann case KEY_PPAGE: 48977caa17caSRaphael Isemann // Page up key 48987caa17caSRaphael Isemann if (m_first_visible_row > 0) { 48997caa17caSRaphael Isemann if (m_first_visible_row > m_max_y) 49007caa17caSRaphael Isemann m_first_visible_row -= m_max_y; 49017caa17caSRaphael Isemann else 49027caa17caSRaphael Isemann m_first_visible_row = 0; 49037caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 49047caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49057caa17caSRaphael Isemann if (m_selected_item) 49067caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49077caa17caSRaphael Isemann } 49087caa17caSRaphael Isemann return eKeyHandled; 49097caa17caSRaphael Isemann 49107caa17caSRaphael Isemann case '.': 49117caa17caSRaphael Isemann case KEY_NPAGE: 49127caa17caSRaphael Isemann // Page down key 49137caa17caSRaphael Isemann if (m_num_rows > m_max_y) { 49147caa17caSRaphael Isemann if (m_first_visible_row + m_max_y < m_num_rows) { 49157caa17caSRaphael Isemann m_first_visible_row += m_max_y; 49167caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 49177caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49187caa17caSRaphael Isemann if (m_selected_item) 49197caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49207caa17caSRaphael Isemann } 49217caa17caSRaphael Isemann } 49227caa17caSRaphael Isemann return eKeyHandled; 49237caa17caSRaphael Isemann 49247caa17caSRaphael Isemann case KEY_UP: 49257caa17caSRaphael Isemann if (m_selected_row_idx > 0) { 49267caa17caSRaphael Isemann --m_selected_row_idx; 49277caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49287caa17caSRaphael Isemann if (m_selected_item) 49297caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49307caa17caSRaphael Isemann } 49317caa17caSRaphael Isemann return eKeyHandled; 49327caa17caSRaphael Isemann 49337caa17caSRaphael Isemann case KEY_DOWN: 49347caa17caSRaphael Isemann if (m_selected_row_idx + 1 < m_num_rows) { 49357caa17caSRaphael Isemann ++m_selected_row_idx; 49367caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49377caa17caSRaphael Isemann if (m_selected_item) 49387caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49397caa17caSRaphael Isemann } 49407caa17caSRaphael Isemann return eKeyHandled; 49417caa17caSRaphael Isemann 49427caa17caSRaphael Isemann case KEY_RIGHT: 49437caa17caSRaphael Isemann if (m_selected_item) { 49447caa17caSRaphael Isemann if (!m_selected_item->IsExpanded()) 49457caa17caSRaphael Isemann m_selected_item->Expand(); 49467caa17caSRaphael Isemann } 49477caa17caSRaphael Isemann return eKeyHandled; 49487caa17caSRaphael Isemann 49497caa17caSRaphael Isemann case KEY_LEFT: 49507caa17caSRaphael Isemann if (m_selected_item) { 49517caa17caSRaphael Isemann if (m_selected_item->IsExpanded()) 49527caa17caSRaphael Isemann m_selected_item->Unexpand(); 49537caa17caSRaphael Isemann else if (m_selected_item->GetParent()) { 49547caa17caSRaphael Isemann m_selected_row_idx = m_selected_item->GetParent()->GetRowIndex(); 49557caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49567caa17caSRaphael Isemann if (m_selected_item) 49577caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49587caa17caSRaphael Isemann } 49597caa17caSRaphael Isemann } 49607caa17caSRaphael Isemann return eKeyHandled; 49617caa17caSRaphael Isemann 49627caa17caSRaphael Isemann case ' ': 49637caa17caSRaphael Isemann // Toggle expansion state when SPACE is pressed 49647caa17caSRaphael Isemann if (m_selected_item) { 49657caa17caSRaphael Isemann if (m_selected_item->IsExpanded()) 49667caa17caSRaphael Isemann m_selected_item->Unexpand(); 49677caa17caSRaphael Isemann else 49687caa17caSRaphael Isemann m_selected_item->Expand(); 49697caa17caSRaphael Isemann } 49707caa17caSRaphael Isemann return eKeyHandled; 49717caa17caSRaphael Isemann 49727caa17caSRaphael Isemann case 'h': 49737caa17caSRaphael Isemann window.CreateHelpSubwindow(); 49747caa17caSRaphael Isemann return eKeyHandled; 49757caa17caSRaphael Isemann 49767caa17caSRaphael Isemann default: 49777caa17caSRaphael Isemann break; 49787caa17caSRaphael Isemann } 49797caa17caSRaphael Isemann return eKeyNotHandled; 49807caa17caSRaphael Isemann } 49817caa17caSRaphael Isemann 49827caa17caSRaphael Isemann protected: 49837caa17caSRaphael Isemann Debugger &m_debugger; 49847caa17caSRaphael Isemann TreeDelegateSP m_delegate_sp; 49857caa17caSRaphael Isemann TreeItem m_root; 498628c878aeSShafik Yaghmour TreeItem *m_selected_item = nullptr; 498728c878aeSShafik Yaghmour int m_num_rows = 0; 498828c878aeSShafik Yaghmour int m_selected_row_idx = 0; 498928c878aeSShafik Yaghmour int m_first_visible_row = 0; 499028c878aeSShafik Yaghmour int m_min_x = 0; 499128c878aeSShafik Yaghmour int m_min_y = 0; 499228c878aeSShafik Yaghmour int m_max_x = 0; 499328c878aeSShafik Yaghmour int m_max_y = 0; 49947caa17caSRaphael Isemann }; 49957caa17caSRaphael Isemann 4996b26e1efcSOmar Emara // A tree delegate that just draws the text member of the tree item, it doesn't 4997b26e1efcSOmar Emara // have any children or actions. 4998b26e1efcSOmar Emara class TextTreeDelegate : public TreeDelegate { 4999b26e1efcSOmar Emara public: 5000b26e1efcSOmar Emara TextTreeDelegate() : TreeDelegate() {} 5001b26e1efcSOmar Emara 5002b26e1efcSOmar Emara ~TextTreeDelegate() override = default; 5003b26e1efcSOmar Emara 5004b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5005b26e1efcSOmar Emara window.PutCStringTruncated(1, item.GetText().c_str()); 5006b26e1efcSOmar Emara } 5007b26e1efcSOmar Emara 5008b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override {} 5009b26e1efcSOmar Emara 5010b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5011b26e1efcSOmar Emara }; 5012b26e1efcSOmar Emara 50137caa17caSRaphael Isemann class FrameTreeDelegate : public TreeDelegate { 50147caa17caSRaphael Isemann public: 50157caa17caSRaphael Isemann FrameTreeDelegate() : TreeDelegate() { 50167caa17caSRaphael Isemann FormatEntity::Parse( 50177caa17caSRaphael Isemann "frame #${frame.index}: {${function.name}${function.pc-offset}}}", 50187caa17caSRaphael Isemann m_format); 50197caa17caSRaphael Isemann } 50207caa17caSRaphael Isemann 50217caa17caSRaphael Isemann ~FrameTreeDelegate() override = default; 50227caa17caSRaphael Isemann 50237caa17caSRaphael Isemann void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 50247caa17caSRaphael Isemann Thread *thread = (Thread *)item.GetUserData(); 50257caa17caSRaphael Isemann if (thread) { 50267caa17caSRaphael Isemann const uint64_t frame_idx = item.GetIdentifier(); 50277caa17caSRaphael Isemann StackFrameSP frame_sp = thread->GetStackFrameAtIndex(frame_idx); 50287caa17caSRaphael Isemann if (frame_sp) { 50297caa17caSRaphael Isemann StreamString strm; 50307caa17caSRaphael Isemann const SymbolContext &sc = 50317caa17caSRaphael Isemann frame_sp->GetSymbolContext(eSymbolContextEverything); 50327caa17caSRaphael Isemann ExecutionContext exe_ctx(frame_sp); 50337caa17caSRaphael Isemann if (FormatEntity::Format(m_format, strm, &sc, &exe_ctx, nullptr, 50347caa17caSRaphael Isemann nullptr, false, false)) { 50357caa17caSRaphael Isemann int right_pad = 1; 5036fc0e8fb7SLuboš Luňák window.PutCStringTruncated(right_pad, strm.GetString().str().c_str()); 50377caa17caSRaphael Isemann } 50387caa17caSRaphael Isemann } 50397caa17caSRaphael Isemann } 50407caa17caSRaphael Isemann } 50417caa17caSRaphael Isemann 50427caa17caSRaphael Isemann void TreeDelegateGenerateChildren(TreeItem &item) override { 50437caa17caSRaphael Isemann // No children for frames yet... 50447caa17caSRaphael Isemann } 50457caa17caSRaphael Isemann 50467caa17caSRaphael Isemann bool TreeDelegateItemSelected(TreeItem &item) override { 50477caa17caSRaphael Isemann Thread *thread = (Thread *)item.GetUserData(); 50487caa17caSRaphael Isemann if (thread) { 50497caa17caSRaphael Isemann thread->GetProcess()->GetThreadList().SetSelectedThreadByID( 50507caa17caSRaphael Isemann thread->GetID()); 50517caa17caSRaphael Isemann const uint64_t frame_idx = item.GetIdentifier(); 50527caa17caSRaphael Isemann thread->SetSelectedFrameByIndex(frame_idx); 50537caa17caSRaphael Isemann return true; 50547caa17caSRaphael Isemann } 50557caa17caSRaphael Isemann return false; 50567caa17caSRaphael Isemann } 50577caa17caSRaphael Isemann 50587caa17caSRaphael Isemann protected: 50597caa17caSRaphael Isemann FormatEntity::Entry m_format; 50607caa17caSRaphael Isemann }; 50617caa17caSRaphael Isemann 50627caa17caSRaphael Isemann class ThreadTreeDelegate : public TreeDelegate { 50637caa17caSRaphael Isemann public: 50647caa17caSRaphael Isemann ThreadTreeDelegate(Debugger &debugger) 506528c878aeSShafik Yaghmour : TreeDelegate(), m_debugger(debugger) { 50667caa17caSRaphael Isemann FormatEntity::Parse("thread #${thread.index}: tid = ${thread.id}{, stop " 50677caa17caSRaphael Isemann "reason = ${thread.stop-reason}}", 50687caa17caSRaphael Isemann m_format); 50697caa17caSRaphael Isemann } 50707caa17caSRaphael Isemann 50717caa17caSRaphael Isemann ~ThreadTreeDelegate() override = default; 50727caa17caSRaphael Isemann 50737caa17caSRaphael Isemann ProcessSP GetProcess() { 50747caa17caSRaphael Isemann return m_debugger.GetCommandInterpreter() 50757caa17caSRaphael Isemann .GetExecutionContext() 50767caa17caSRaphael Isemann .GetProcessSP(); 50777caa17caSRaphael Isemann } 50787caa17caSRaphael Isemann 50797caa17caSRaphael Isemann ThreadSP GetThread(const TreeItem &item) { 50807caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 50817caa17caSRaphael Isemann if (process_sp) 50827caa17caSRaphael Isemann return process_sp->GetThreadList().FindThreadByID(item.GetIdentifier()); 50837caa17caSRaphael Isemann return ThreadSP(); 50847caa17caSRaphael Isemann } 50857caa17caSRaphael Isemann 50867caa17caSRaphael Isemann void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 50877caa17caSRaphael Isemann ThreadSP thread_sp = GetThread(item); 50887caa17caSRaphael Isemann if (thread_sp) { 50897caa17caSRaphael Isemann StreamString strm; 50907caa17caSRaphael Isemann ExecutionContext exe_ctx(thread_sp); 50917caa17caSRaphael Isemann if (FormatEntity::Format(m_format, strm, nullptr, &exe_ctx, nullptr, 50927caa17caSRaphael Isemann nullptr, false, false)) { 50937caa17caSRaphael Isemann int right_pad = 1; 5094fc0e8fb7SLuboš Luňák window.PutCStringTruncated(right_pad, strm.GetString().str().c_str()); 50957caa17caSRaphael Isemann } 50967caa17caSRaphael Isemann } 50977caa17caSRaphael Isemann } 50987caa17caSRaphael Isemann 50997caa17caSRaphael Isemann void TreeDelegateGenerateChildren(TreeItem &item) override { 51007caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 51017caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 51027caa17caSRaphael Isemann StateType state = process_sp->GetState(); 51037caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 51047caa17caSRaphael Isemann ThreadSP thread_sp = GetThread(item); 51057caa17caSRaphael Isemann if (thread_sp) { 51067caa17caSRaphael Isemann if (m_stop_id == process_sp->GetStopID() && 51077caa17caSRaphael Isemann thread_sp->GetID() == m_tid) 51087caa17caSRaphael Isemann return; // Children are already up to date 51097caa17caSRaphael Isemann if (!m_frame_delegate_sp) { 51107caa17caSRaphael Isemann // Always expand the thread item the first time we show it 51117caa17caSRaphael Isemann m_frame_delegate_sp = std::make_shared<FrameTreeDelegate>(); 51127caa17caSRaphael Isemann } 51137caa17caSRaphael Isemann 51147caa17caSRaphael Isemann m_stop_id = process_sp->GetStopID(); 51157caa17caSRaphael Isemann m_tid = thread_sp->GetID(); 51167caa17caSRaphael Isemann 51177caa17caSRaphael Isemann TreeItem t(&item, *m_frame_delegate_sp, false); 51187caa17caSRaphael Isemann size_t num_frames = thread_sp->GetStackFrameCount(); 51197caa17caSRaphael Isemann item.Resize(num_frames, t); 51207caa17caSRaphael Isemann for (size_t i = 0; i < num_frames; ++i) { 51217caa17caSRaphael Isemann item[i].SetUserData(thread_sp.get()); 51227caa17caSRaphael Isemann item[i].SetIdentifier(i); 51237caa17caSRaphael Isemann } 51247caa17caSRaphael Isemann } 51257caa17caSRaphael Isemann return; 51267caa17caSRaphael Isemann } 51277caa17caSRaphael Isemann } 51287caa17caSRaphael Isemann item.ClearChildren(); 51297caa17caSRaphael Isemann } 51307caa17caSRaphael Isemann 51317caa17caSRaphael Isemann bool TreeDelegateItemSelected(TreeItem &item) override { 51327caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 51337caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 51347caa17caSRaphael Isemann StateType state = process_sp->GetState(); 51357caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 51367caa17caSRaphael Isemann ThreadSP thread_sp = GetThread(item); 51377caa17caSRaphael Isemann if (thread_sp) { 51387caa17caSRaphael Isemann ThreadList &thread_list = thread_sp->GetProcess()->GetThreadList(); 51397caa17caSRaphael Isemann std::lock_guard<std::recursive_mutex> guard(thread_list.GetMutex()); 51407caa17caSRaphael Isemann ThreadSP selected_thread_sp = thread_list.GetSelectedThread(); 51417caa17caSRaphael Isemann if (selected_thread_sp->GetID() != thread_sp->GetID()) { 51427caa17caSRaphael Isemann thread_list.SetSelectedThreadByID(thread_sp->GetID()); 51437caa17caSRaphael Isemann return true; 51447caa17caSRaphael Isemann } 51457caa17caSRaphael Isemann } 51467caa17caSRaphael Isemann } 51477caa17caSRaphael Isemann } 51487caa17caSRaphael Isemann return false; 51497caa17caSRaphael Isemann } 51507caa17caSRaphael Isemann 51517caa17caSRaphael Isemann protected: 51527caa17caSRaphael Isemann Debugger &m_debugger; 51537caa17caSRaphael Isemann std::shared_ptr<FrameTreeDelegate> m_frame_delegate_sp; 515428c878aeSShafik Yaghmour lldb::user_id_t m_tid = LLDB_INVALID_THREAD_ID; 515528c878aeSShafik Yaghmour uint32_t m_stop_id = UINT32_MAX; 51567caa17caSRaphael Isemann FormatEntity::Entry m_format; 51577caa17caSRaphael Isemann }; 51587caa17caSRaphael Isemann 51597caa17caSRaphael Isemann class ThreadsTreeDelegate : public TreeDelegate { 51607caa17caSRaphael Isemann public: 51617caa17caSRaphael Isemann ThreadsTreeDelegate(Debugger &debugger) 516228c878aeSShafik Yaghmour : TreeDelegate(), m_thread_delegate_sp(), m_debugger(debugger) { 51637caa17caSRaphael Isemann FormatEntity::Parse("process ${process.id}{, name = ${process.name}}", 51647caa17caSRaphael Isemann m_format); 51657caa17caSRaphael Isemann } 51667caa17caSRaphael Isemann 51677caa17caSRaphael Isemann ~ThreadsTreeDelegate() override = default; 51687caa17caSRaphael Isemann 51697caa17caSRaphael Isemann ProcessSP GetProcess() { 51707caa17caSRaphael Isemann return m_debugger.GetCommandInterpreter() 51717caa17caSRaphael Isemann .GetExecutionContext() 51727caa17caSRaphael Isemann .GetProcessSP(); 51737caa17caSRaphael Isemann } 51747caa17caSRaphael Isemann 5175b26e1efcSOmar Emara bool TreeDelegateShouldDraw() override { 5176b26e1efcSOmar Emara ProcessSP process = GetProcess(); 5177b26e1efcSOmar Emara if (!process) 5178b26e1efcSOmar Emara return false; 5179b26e1efcSOmar Emara 5180b26e1efcSOmar Emara if (StateIsRunningState(process->GetState())) 5181b26e1efcSOmar Emara return false; 5182b26e1efcSOmar Emara 5183b26e1efcSOmar Emara return true; 5184b26e1efcSOmar Emara } 5185b26e1efcSOmar Emara 51867caa17caSRaphael Isemann void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 51877caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 51887caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 51897caa17caSRaphael Isemann StreamString strm; 51907caa17caSRaphael Isemann ExecutionContext exe_ctx(process_sp); 51917caa17caSRaphael Isemann if (FormatEntity::Format(m_format, strm, nullptr, &exe_ctx, nullptr, 51927caa17caSRaphael Isemann nullptr, false, false)) { 51937caa17caSRaphael Isemann int right_pad = 1; 5194fc0e8fb7SLuboš Luňák window.PutCStringTruncated(right_pad, strm.GetString().str().c_str()); 51957caa17caSRaphael Isemann } 51967caa17caSRaphael Isemann } 51977caa17caSRaphael Isemann } 51987caa17caSRaphael Isemann 51997caa17caSRaphael Isemann void TreeDelegateGenerateChildren(TreeItem &item) override { 52007caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 5201a94fbb25SMuhammad Omair Javaid m_update_selection = false; 52027caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 52037caa17caSRaphael Isemann StateType state = process_sp->GetState(); 52047caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 52057caa17caSRaphael Isemann const uint32_t stop_id = process_sp->GetStopID(); 52067caa17caSRaphael Isemann if (m_stop_id == stop_id) 52077caa17caSRaphael Isemann return; // Children are already up to date 52087caa17caSRaphael Isemann 52097caa17caSRaphael Isemann m_stop_id = stop_id; 5210a94fbb25SMuhammad Omair Javaid m_update_selection = true; 52117caa17caSRaphael Isemann 52127caa17caSRaphael Isemann if (!m_thread_delegate_sp) { 52137caa17caSRaphael Isemann // Always expand the thread item the first time we show it 52147caa17caSRaphael Isemann // item.Expand(); 52157caa17caSRaphael Isemann m_thread_delegate_sp = 52167caa17caSRaphael Isemann std::make_shared<ThreadTreeDelegate>(m_debugger); 52177caa17caSRaphael Isemann } 52187caa17caSRaphael Isemann 52197caa17caSRaphael Isemann TreeItem t(&item, *m_thread_delegate_sp, false); 52207caa17caSRaphael Isemann ThreadList &threads = process_sp->GetThreadList(); 52217caa17caSRaphael Isemann std::lock_guard<std::recursive_mutex> guard(threads.GetMutex()); 5222a94fbb25SMuhammad Omair Javaid ThreadSP selected_thread = threads.GetSelectedThread(); 52237caa17caSRaphael Isemann size_t num_threads = threads.GetSize(); 52247caa17caSRaphael Isemann item.Resize(num_threads, t); 52257caa17caSRaphael Isemann for (size_t i = 0; i < num_threads; ++i) { 5226a94fbb25SMuhammad Omair Javaid ThreadSP thread = threads.GetThreadAtIndex(i); 5227a94fbb25SMuhammad Omair Javaid item[i].SetIdentifier(thread->GetID()); 52287caa17caSRaphael Isemann item[i].SetMightHaveChildren(true); 5229a94fbb25SMuhammad Omair Javaid if (selected_thread->GetID() == thread->GetID()) 5230a94fbb25SMuhammad Omair Javaid item[i].Expand(); 52317caa17caSRaphael Isemann } 52327caa17caSRaphael Isemann return; 52337caa17caSRaphael Isemann } 52347caa17caSRaphael Isemann } 52357caa17caSRaphael Isemann item.ClearChildren(); 52367caa17caSRaphael Isemann } 52377caa17caSRaphael Isemann 5238a94fbb25SMuhammad Omair Javaid void TreeDelegateUpdateSelection(TreeItem &root, int &selection_index, 5239a94fbb25SMuhammad Omair Javaid TreeItem *&selected_item) override { 5240a94fbb25SMuhammad Omair Javaid if (!m_update_selection) 5241a94fbb25SMuhammad Omair Javaid return; 5242a94fbb25SMuhammad Omair Javaid 5243a94fbb25SMuhammad Omair Javaid ProcessSP process_sp = GetProcess(); 5244a94fbb25SMuhammad Omair Javaid if (!(process_sp && process_sp->IsAlive())) 5245a94fbb25SMuhammad Omair Javaid return; 5246a94fbb25SMuhammad Omair Javaid 5247a94fbb25SMuhammad Omair Javaid StateType state = process_sp->GetState(); 5248a94fbb25SMuhammad Omair Javaid if (!StateIsStoppedState(state, true)) 5249a94fbb25SMuhammad Omair Javaid return; 5250a94fbb25SMuhammad Omair Javaid 5251a94fbb25SMuhammad Omair Javaid ThreadList &threads = process_sp->GetThreadList(); 5252a94fbb25SMuhammad Omair Javaid std::lock_guard<std::recursive_mutex> guard(threads.GetMutex()); 5253a94fbb25SMuhammad Omair Javaid ThreadSP selected_thread = threads.GetSelectedThread(); 5254a94fbb25SMuhammad Omair Javaid size_t num_threads = threads.GetSize(); 5255a94fbb25SMuhammad Omair Javaid for (size_t i = 0; i < num_threads; ++i) { 5256a94fbb25SMuhammad Omair Javaid ThreadSP thread = threads.GetThreadAtIndex(i); 5257a94fbb25SMuhammad Omair Javaid if (selected_thread->GetID() == thread->GetID()) { 5258a94fbb25SMuhammad Omair Javaid selected_item = &root[i][thread->GetSelectedFrameIndex()]; 5259a94fbb25SMuhammad Omair Javaid selection_index = selected_item->GetRowIndex(); 5260a94fbb25SMuhammad Omair Javaid return; 5261a94fbb25SMuhammad Omair Javaid } 5262a94fbb25SMuhammad Omair Javaid } 5263a94fbb25SMuhammad Omair Javaid } 5264a94fbb25SMuhammad Omair Javaid 52657caa17caSRaphael Isemann bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 52667caa17caSRaphael Isemann 5267a94fbb25SMuhammad Omair Javaid bool TreeDelegateExpandRootByDefault() override { return true; } 5268a94fbb25SMuhammad Omair Javaid 52697caa17caSRaphael Isemann protected: 52707caa17caSRaphael Isemann std::shared_ptr<ThreadTreeDelegate> m_thread_delegate_sp; 52717caa17caSRaphael Isemann Debugger &m_debugger; 527228c878aeSShafik Yaghmour uint32_t m_stop_id = UINT32_MAX; 527328c878aeSShafik Yaghmour bool m_update_selection = false; 52747caa17caSRaphael Isemann FormatEntity::Entry m_format; 52757caa17caSRaphael Isemann }; 52767caa17caSRaphael Isemann 5277b26e1efcSOmar Emara class BreakpointLocationTreeDelegate : public TreeDelegate { 5278b26e1efcSOmar Emara public: 5279b26e1efcSOmar Emara BreakpointLocationTreeDelegate(Debugger &debugger) 5280b26e1efcSOmar Emara : TreeDelegate(), m_debugger(debugger) {} 5281b26e1efcSOmar Emara 5282b26e1efcSOmar Emara ~BreakpointLocationTreeDelegate() override = default; 5283b26e1efcSOmar Emara 5284b26e1efcSOmar Emara Process *GetProcess() { 5285b26e1efcSOmar Emara ExecutionContext exe_ctx( 5286b26e1efcSOmar Emara m_debugger.GetCommandInterpreter().GetExecutionContext()); 5287b26e1efcSOmar Emara return exe_ctx.GetProcessPtr(); 5288b26e1efcSOmar Emara } 5289b26e1efcSOmar Emara 5290b26e1efcSOmar Emara BreakpointLocationSP GetBreakpointLocation(const TreeItem &item) { 5291b26e1efcSOmar Emara Breakpoint *breakpoint = (Breakpoint *)item.GetUserData(); 5292b26e1efcSOmar Emara return breakpoint->GetLocationAtIndex(item.GetIdentifier()); 5293b26e1efcSOmar Emara } 5294b26e1efcSOmar Emara 5295b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5296b26e1efcSOmar Emara BreakpointLocationSP breakpoint_location = GetBreakpointLocation(item); 5297b26e1efcSOmar Emara Process *process = GetProcess(); 5298b26e1efcSOmar Emara StreamString stream; 5299b26e1efcSOmar Emara stream.Printf("%i.%i: ", breakpoint_location->GetBreakpoint().GetID(), 5300b26e1efcSOmar Emara breakpoint_location->GetID()); 5301b26e1efcSOmar Emara Address address = breakpoint_location->GetAddress(); 5302b26e1efcSOmar Emara address.Dump(&stream, process, Address::DumpStyleResolvedDescription, 5303b26e1efcSOmar Emara Address::DumpStyleInvalid); 5304b26e1efcSOmar Emara window.PutCStringTruncated(1, stream.GetString().str().c_str()); 5305b26e1efcSOmar Emara } 5306b26e1efcSOmar Emara 5307b26e1efcSOmar Emara StringList ComputeDetailsList(BreakpointLocationSP breakpoint_location) { 5308b26e1efcSOmar Emara StringList details; 5309b26e1efcSOmar Emara 5310b26e1efcSOmar Emara Address address = breakpoint_location->GetAddress(); 5311b26e1efcSOmar Emara SymbolContext symbol_context; 5312b26e1efcSOmar Emara address.CalculateSymbolContext(&symbol_context); 5313b26e1efcSOmar Emara 5314b26e1efcSOmar Emara if (symbol_context.module_sp) { 5315b26e1efcSOmar Emara StreamString module_stream; 5316b26e1efcSOmar Emara module_stream.PutCString("module = "); 5317b26e1efcSOmar Emara symbol_context.module_sp->GetFileSpec().Dump( 5318b26e1efcSOmar Emara module_stream.AsRawOstream()); 5319b26e1efcSOmar Emara details.AppendString(module_stream.GetString()); 5320b26e1efcSOmar Emara } 5321b26e1efcSOmar Emara 5322b26e1efcSOmar Emara if (symbol_context.comp_unit != nullptr) { 5323b26e1efcSOmar Emara StreamString compile_unit_stream; 5324b26e1efcSOmar Emara compile_unit_stream.PutCString("compile unit = "); 5325b26e1efcSOmar Emara symbol_context.comp_unit->GetPrimaryFile().GetFilename().Dump( 5326b26e1efcSOmar Emara &compile_unit_stream); 5327b26e1efcSOmar Emara details.AppendString(compile_unit_stream.GetString()); 5328b26e1efcSOmar Emara 5329b26e1efcSOmar Emara if (symbol_context.function != nullptr) { 5330b26e1efcSOmar Emara StreamString function_stream; 5331b26e1efcSOmar Emara function_stream.PutCString("function = "); 5332b26e1efcSOmar Emara function_stream.PutCString( 5333b26e1efcSOmar Emara symbol_context.function->GetName().AsCString("<unknown>")); 5334b26e1efcSOmar Emara details.AppendString(function_stream.GetString()); 5335b26e1efcSOmar Emara } 5336b26e1efcSOmar Emara 5337b26e1efcSOmar Emara if (symbol_context.line_entry.line > 0) { 5338b26e1efcSOmar Emara StreamString location_stream; 5339b26e1efcSOmar Emara location_stream.PutCString("location = "); 5340b26e1efcSOmar Emara symbol_context.line_entry.DumpStopContext(&location_stream, true); 5341b26e1efcSOmar Emara details.AppendString(location_stream.GetString()); 5342b26e1efcSOmar Emara } 5343b26e1efcSOmar Emara 5344b26e1efcSOmar Emara } else { 5345b26e1efcSOmar Emara if (symbol_context.symbol) { 5346b26e1efcSOmar Emara StreamString symbol_stream; 5347b26e1efcSOmar Emara if (breakpoint_location->IsReExported()) 5348b26e1efcSOmar Emara symbol_stream.PutCString("re-exported target = "); 5349b26e1efcSOmar Emara else 5350b26e1efcSOmar Emara symbol_stream.PutCString("symbol = "); 5351b26e1efcSOmar Emara symbol_stream.PutCString( 5352b26e1efcSOmar Emara symbol_context.symbol->GetName().AsCString("<unknown>")); 5353b26e1efcSOmar Emara details.AppendString(symbol_stream.GetString()); 5354b26e1efcSOmar Emara } 5355b26e1efcSOmar Emara } 5356b26e1efcSOmar Emara 5357b26e1efcSOmar Emara Process *process = GetProcess(); 5358b26e1efcSOmar Emara 5359b26e1efcSOmar Emara StreamString address_stream; 5360b26e1efcSOmar Emara address.Dump(&address_stream, process, Address::DumpStyleLoadAddress, 5361b26e1efcSOmar Emara Address::DumpStyleModuleWithFileAddress); 5362b26e1efcSOmar Emara details.AppendString(address_stream.GetString()); 5363b26e1efcSOmar Emara 5364b26e1efcSOmar Emara BreakpointSiteSP breakpoint_site = breakpoint_location->GetBreakpointSite(); 5365b26e1efcSOmar Emara if (breakpoint_location->IsIndirect() && breakpoint_site) { 5366b26e1efcSOmar Emara Address resolved_address; 5367b26e1efcSOmar Emara resolved_address.SetLoadAddress(breakpoint_site->GetLoadAddress(), 5368b26e1efcSOmar Emara &breakpoint_location->GetTarget()); 5369b26e1efcSOmar Emara Symbol *resolved_symbol = resolved_address.CalculateSymbolContextSymbol(); 5370b26e1efcSOmar Emara if (resolved_symbol) { 5371b26e1efcSOmar Emara StreamString indirect_target_stream; 5372b26e1efcSOmar Emara indirect_target_stream.PutCString("indirect target = "); 5373b26e1efcSOmar Emara indirect_target_stream.PutCString( 5374b26e1efcSOmar Emara resolved_symbol->GetName().GetCString()); 5375b26e1efcSOmar Emara details.AppendString(indirect_target_stream.GetString()); 5376b26e1efcSOmar Emara } 5377b26e1efcSOmar Emara } 5378b26e1efcSOmar Emara 5379b26e1efcSOmar Emara bool is_resolved = breakpoint_location->IsResolved(); 5380b26e1efcSOmar Emara StreamString resolved_stream; 5381b26e1efcSOmar Emara resolved_stream.Printf("resolved = %s", is_resolved ? "true" : "false"); 5382b26e1efcSOmar Emara details.AppendString(resolved_stream.GetString()); 5383b26e1efcSOmar Emara 5384b26e1efcSOmar Emara bool is_hardware = is_resolved && breakpoint_site->IsHardware(); 5385b26e1efcSOmar Emara StreamString hardware_stream; 5386b26e1efcSOmar Emara hardware_stream.Printf("hardware = %s", is_hardware ? "true" : "false"); 5387b26e1efcSOmar Emara details.AppendString(hardware_stream.GetString()); 5388b26e1efcSOmar Emara 5389b26e1efcSOmar Emara StreamString hit_count_stream; 5390b26e1efcSOmar Emara hit_count_stream.Printf("hit count = %-4u", 5391b26e1efcSOmar Emara breakpoint_location->GetHitCount()); 5392b26e1efcSOmar Emara details.AppendString(hit_count_stream.GetString()); 5393b26e1efcSOmar Emara 5394b26e1efcSOmar Emara return details; 5395b26e1efcSOmar Emara } 5396b26e1efcSOmar Emara 5397b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override { 5398b26e1efcSOmar Emara BreakpointLocationSP breakpoint_location = GetBreakpointLocation(item); 5399b26e1efcSOmar Emara StringList details = ComputeDetailsList(breakpoint_location); 5400b26e1efcSOmar Emara 5401b26e1efcSOmar Emara if (!m_string_delegate_sp) 5402b26e1efcSOmar Emara m_string_delegate_sp = std::make_shared<TextTreeDelegate>(); 5403b26e1efcSOmar Emara TreeItem details_tree_item(&item, *m_string_delegate_sp, false); 5404b26e1efcSOmar Emara 5405b26e1efcSOmar Emara item.Resize(details.GetSize(), details_tree_item); 5406b26e1efcSOmar Emara for (size_t i = 0; i < details.GetSize(); i++) { 5407b26e1efcSOmar Emara item[i].SetText(details.GetStringAtIndex(i)); 5408b26e1efcSOmar Emara } 5409b26e1efcSOmar Emara } 5410b26e1efcSOmar Emara 5411b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5412b26e1efcSOmar Emara 5413b26e1efcSOmar Emara protected: 5414b26e1efcSOmar Emara Debugger &m_debugger; 5415b26e1efcSOmar Emara std::shared_ptr<TextTreeDelegate> m_string_delegate_sp; 5416b26e1efcSOmar Emara }; 5417b26e1efcSOmar Emara 5418b26e1efcSOmar Emara class BreakpointTreeDelegate : public TreeDelegate { 5419b26e1efcSOmar Emara public: 5420b26e1efcSOmar Emara BreakpointTreeDelegate(Debugger &debugger) 5421b26e1efcSOmar Emara : TreeDelegate(), m_debugger(debugger), 5422b26e1efcSOmar Emara m_breakpoint_location_delegate_sp() {} 5423b26e1efcSOmar Emara 5424b26e1efcSOmar Emara ~BreakpointTreeDelegate() override = default; 5425b26e1efcSOmar Emara 5426b26e1efcSOmar Emara BreakpointSP GetBreakpoint(const TreeItem &item) { 5427b26e1efcSOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 5428b26e1efcSOmar Emara BreakpointList &breakpoints = target->GetBreakpointList(false); 5429b26e1efcSOmar Emara return breakpoints.GetBreakpointAtIndex(item.GetIdentifier()); 5430b26e1efcSOmar Emara } 5431b26e1efcSOmar Emara 5432b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5433b26e1efcSOmar Emara BreakpointSP breakpoint = GetBreakpoint(item); 5434b26e1efcSOmar Emara StreamString stream; 5435b26e1efcSOmar Emara stream.Format("{0}: ", breakpoint->GetID()); 5436b26e1efcSOmar Emara breakpoint->GetResolverDescription(&stream); 5437b26e1efcSOmar Emara breakpoint->GetFilterDescription(&stream); 5438b26e1efcSOmar Emara window.PutCStringTruncated(1, stream.GetString().str().c_str()); 5439b26e1efcSOmar Emara } 5440b26e1efcSOmar Emara 5441b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override { 5442b26e1efcSOmar Emara BreakpointSP breakpoint = GetBreakpoint(item); 5443b26e1efcSOmar Emara 5444b26e1efcSOmar Emara if (!m_breakpoint_location_delegate_sp) 5445b26e1efcSOmar Emara m_breakpoint_location_delegate_sp = 5446b26e1efcSOmar Emara std::make_shared<BreakpointLocationTreeDelegate>(m_debugger); 5447b26e1efcSOmar Emara TreeItem breakpoint_location_tree_item( 5448b26e1efcSOmar Emara &item, *m_breakpoint_location_delegate_sp, true); 5449b26e1efcSOmar Emara 5450b26e1efcSOmar Emara item.Resize(breakpoint->GetNumLocations(), breakpoint_location_tree_item); 5451b26e1efcSOmar Emara for (size_t i = 0; i < breakpoint->GetNumLocations(); i++) { 5452b26e1efcSOmar Emara item[i].SetIdentifier(i); 5453b26e1efcSOmar Emara item[i].SetUserData(breakpoint.get()); 5454b26e1efcSOmar Emara } 5455b26e1efcSOmar Emara } 5456b26e1efcSOmar Emara 5457b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5458b26e1efcSOmar Emara 5459b26e1efcSOmar Emara protected: 5460b26e1efcSOmar Emara Debugger &m_debugger; 5461b26e1efcSOmar Emara std::shared_ptr<BreakpointLocationTreeDelegate> 5462b26e1efcSOmar Emara m_breakpoint_location_delegate_sp; 5463b26e1efcSOmar Emara }; 5464b26e1efcSOmar Emara 5465b26e1efcSOmar Emara class BreakpointsTreeDelegate : public TreeDelegate { 5466b26e1efcSOmar Emara public: 5467b26e1efcSOmar Emara BreakpointsTreeDelegate(Debugger &debugger) 5468b26e1efcSOmar Emara : TreeDelegate(), m_debugger(debugger), m_breakpoint_delegate_sp() {} 5469b26e1efcSOmar Emara 5470b26e1efcSOmar Emara ~BreakpointsTreeDelegate() override = default; 5471b26e1efcSOmar Emara 5472b26e1efcSOmar Emara bool TreeDelegateShouldDraw() override { 5473b26e1efcSOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 5474b26e1efcSOmar Emara if (!target) 5475b26e1efcSOmar Emara return false; 5476b26e1efcSOmar Emara 5477b26e1efcSOmar Emara return true; 5478b26e1efcSOmar Emara } 5479b26e1efcSOmar Emara 5480b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5481b26e1efcSOmar Emara window.PutCString("Breakpoints"); 5482b26e1efcSOmar Emara } 5483b26e1efcSOmar Emara 5484b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override { 5485b26e1efcSOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 5486b26e1efcSOmar Emara 5487b26e1efcSOmar Emara BreakpointList &breakpoints = target->GetBreakpointList(false); 5488b26e1efcSOmar Emara std::unique_lock<std::recursive_mutex> lock; 5489b26e1efcSOmar Emara breakpoints.GetListMutex(lock); 5490b26e1efcSOmar Emara 5491b26e1efcSOmar Emara if (!m_breakpoint_delegate_sp) 5492b26e1efcSOmar Emara m_breakpoint_delegate_sp = 5493b26e1efcSOmar Emara std::make_shared<BreakpointTreeDelegate>(m_debugger); 5494b26e1efcSOmar Emara TreeItem breakpoint_tree_item(&item, *m_breakpoint_delegate_sp, true); 5495b26e1efcSOmar Emara 5496b26e1efcSOmar Emara item.Resize(breakpoints.GetSize(), breakpoint_tree_item); 5497b26e1efcSOmar Emara for (size_t i = 0; i < breakpoints.GetSize(); i++) { 5498b26e1efcSOmar Emara item[i].SetIdentifier(i); 5499b26e1efcSOmar Emara } 5500b26e1efcSOmar Emara } 5501b26e1efcSOmar Emara 5502b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5503b26e1efcSOmar Emara 5504b26e1efcSOmar Emara bool TreeDelegateExpandRootByDefault() override { return true; } 5505b26e1efcSOmar Emara 5506b26e1efcSOmar Emara protected: 5507b26e1efcSOmar Emara Debugger &m_debugger; 5508b26e1efcSOmar Emara std::shared_ptr<BreakpointTreeDelegate> m_breakpoint_delegate_sp; 5509b26e1efcSOmar Emara }; 5510b26e1efcSOmar Emara 55117caa17caSRaphael Isemann class ValueObjectListDelegate : public WindowDelegate { 55127caa17caSRaphael Isemann public: 55139494c510SJonas Devlieghere ValueObjectListDelegate() : m_rows() {} 55147caa17caSRaphael Isemann 551528c878aeSShafik Yaghmour ValueObjectListDelegate(ValueObjectList &valobj_list) : m_rows() { 55167caa17caSRaphael Isemann SetValues(valobj_list); 55177caa17caSRaphael Isemann } 55187caa17caSRaphael Isemann 55197caa17caSRaphael Isemann ~ValueObjectListDelegate() override = default; 55207caa17caSRaphael Isemann 55217caa17caSRaphael Isemann void SetValues(ValueObjectList &valobj_list) { 55227caa17caSRaphael Isemann m_selected_row = nullptr; 55237caa17caSRaphael Isemann m_selected_row_idx = 0; 55247caa17caSRaphael Isemann m_first_visible_row = 0; 55257caa17caSRaphael Isemann m_num_rows = 0; 55267caa17caSRaphael Isemann m_rows.clear(); 55277caa17caSRaphael Isemann for (auto &valobj_sp : valobj_list.GetObjects()) 55287caa17caSRaphael Isemann m_rows.push_back(Row(valobj_sp, nullptr)); 55297caa17caSRaphael Isemann } 55307caa17caSRaphael Isemann 55317caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 55327caa17caSRaphael Isemann m_num_rows = 0; 55337caa17caSRaphael Isemann m_min_x = 2; 55347caa17caSRaphael Isemann m_min_y = 1; 55357caa17caSRaphael Isemann m_max_x = window.GetWidth() - 1; 55367caa17caSRaphael Isemann m_max_y = window.GetHeight() - 1; 55377caa17caSRaphael Isemann 55387caa17caSRaphael Isemann window.Erase(); 55397caa17caSRaphael Isemann window.DrawTitleBox(window.GetName()); 55407caa17caSRaphael Isemann 55417caa17caSRaphael Isemann const int num_visible_rows = NumVisibleRows(); 55427caa17caSRaphael Isemann const int num_rows = CalculateTotalNumberRows(m_rows); 55437caa17caSRaphael Isemann 55447caa17caSRaphael Isemann // If we unexpanded while having something selected our total number of 55457caa17caSRaphael Isemann // rows is less than the num visible rows, then make sure we show all the 55467caa17caSRaphael Isemann // rows by setting the first visible row accordingly. 55477caa17caSRaphael Isemann if (m_first_visible_row > 0 && num_rows < num_visible_rows) 55487caa17caSRaphael Isemann m_first_visible_row = 0; 55497caa17caSRaphael Isemann 55507caa17caSRaphael Isemann // Make sure the selected row is always visible 55517caa17caSRaphael Isemann if (m_selected_row_idx < m_first_visible_row) 55527caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx; 55537caa17caSRaphael Isemann else if (m_first_visible_row + num_visible_rows <= m_selected_row_idx) 55547caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx - num_visible_rows + 1; 55557caa17caSRaphael Isemann 55567caa17caSRaphael Isemann DisplayRows(window, m_rows, g_options); 55577caa17caSRaphael Isemann 55587caa17caSRaphael Isemann // Get the selected row 55597caa17caSRaphael Isemann m_selected_row = GetRowForRowIndex(m_selected_row_idx); 55607caa17caSRaphael Isemann // Keep the cursor on the selected row so the highlight and the cursor are 55617caa17caSRaphael Isemann // always on the same line 55627caa17caSRaphael Isemann if (m_selected_row) 55637caa17caSRaphael Isemann window.MoveCursor(m_selected_row->x, m_selected_row->y); 55647caa17caSRaphael Isemann 55657caa17caSRaphael Isemann return true; // Drawing handled 55667caa17caSRaphael Isemann } 55677caa17caSRaphael Isemann 55687caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 55697caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 55707caa17caSRaphael Isemann {KEY_UP, "Select previous item"}, 55717caa17caSRaphael Isemann {KEY_DOWN, "Select next item"}, 55727caa17caSRaphael Isemann {KEY_RIGHT, "Expand selected item"}, 55737caa17caSRaphael Isemann {KEY_LEFT, "Unexpand selected item or select parent if not expanded"}, 55747caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 55757caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 55767caa17caSRaphael Isemann {'A', "Format as annotated address"}, 55777caa17caSRaphael Isemann {'b', "Format as binary"}, 55787caa17caSRaphael Isemann {'B', "Format as hex bytes with ASCII"}, 55797caa17caSRaphael Isemann {'c', "Format as character"}, 55807caa17caSRaphael Isemann {'d', "Format as a signed integer"}, 55817caa17caSRaphael Isemann {'D', "Format selected value using the default format for the type"}, 55827caa17caSRaphael Isemann {'f', "Format as float"}, 55837caa17caSRaphael Isemann {'h', "Show help dialog"}, 55847caa17caSRaphael Isemann {'i', "Format as instructions"}, 55857caa17caSRaphael Isemann {'o', "Format as octal"}, 55867caa17caSRaphael Isemann {'p', "Format as pointer"}, 55877caa17caSRaphael Isemann {'s', "Format as C string"}, 55887caa17caSRaphael Isemann {'t', "Toggle showing/hiding type names"}, 55897caa17caSRaphael Isemann {'u', "Format as an unsigned integer"}, 55907caa17caSRaphael Isemann {'x', "Format as hex"}, 55917caa17caSRaphael Isemann {'X', "Format as uppercase hex"}, 55927caa17caSRaphael Isemann {' ', "Toggle item expansion"}, 55937caa17caSRaphael Isemann {',', "Page up"}, 55947caa17caSRaphael Isemann {'.', "Page down"}, 55957caa17caSRaphael Isemann {'\0', nullptr}}; 55967caa17caSRaphael Isemann return g_source_view_key_help; 55977caa17caSRaphael Isemann } 55987caa17caSRaphael Isemann 55997caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int c) override { 56007caa17caSRaphael Isemann switch (c) { 56017caa17caSRaphael Isemann case 'x': 56027caa17caSRaphael Isemann case 'X': 56037caa17caSRaphael Isemann case 'o': 56047caa17caSRaphael Isemann case 's': 56057caa17caSRaphael Isemann case 'u': 56067caa17caSRaphael Isemann case 'd': 56077caa17caSRaphael Isemann case 'D': 56087caa17caSRaphael Isemann case 'i': 56097caa17caSRaphael Isemann case 'A': 56107caa17caSRaphael Isemann case 'p': 56117caa17caSRaphael Isemann case 'c': 56127caa17caSRaphael Isemann case 'b': 56137caa17caSRaphael Isemann case 'B': 56147caa17caSRaphael Isemann case 'f': 56157caa17caSRaphael Isemann // Change the format for the currently selected item 56167caa17caSRaphael Isemann if (m_selected_row) { 56177caa17caSRaphael Isemann auto valobj_sp = m_selected_row->value.GetSP(); 56187caa17caSRaphael Isemann if (valobj_sp) 56197caa17caSRaphael Isemann valobj_sp->SetFormat(FormatForChar(c)); 56207caa17caSRaphael Isemann } 56217caa17caSRaphael Isemann return eKeyHandled; 56227caa17caSRaphael Isemann 56237caa17caSRaphael Isemann case 't': 56247caa17caSRaphael Isemann // Toggle showing type names 56257caa17caSRaphael Isemann g_options.show_types = !g_options.show_types; 56267caa17caSRaphael Isemann return eKeyHandled; 56277caa17caSRaphael Isemann 56287caa17caSRaphael Isemann case ',': 56297caa17caSRaphael Isemann case KEY_PPAGE: 56307caa17caSRaphael Isemann // Page up key 56317caa17caSRaphael Isemann if (m_first_visible_row > 0) { 56327caa17caSRaphael Isemann if (static_cast<int>(m_first_visible_row) > m_max_y) 56337caa17caSRaphael Isemann m_first_visible_row -= m_max_y; 56347caa17caSRaphael Isemann else 56357caa17caSRaphael Isemann m_first_visible_row = 0; 56367caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 56377caa17caSRaphael Isemann } 56387caa17caSRaphael Isemann return eKeyHandled; 56397caa17caSRaphael Isemann 56407caa17caSRaphael Isemann case '.': 56417caa17caSRaphael Isemann case KEY_NPAGE: 56427caa17caSRaphael Isemann // Page down key 56437caa17caSRaphael Isemann if (m_num_rows > static_cast<size_t>(m_max_y)) { 56447caa17caSRaphael Isemann if (m_first_visible_row + m_max_y < m_num_rows) { 56457caa17caSRaphael Isemann m_first_visible_row += m_max_y; 56467caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 56477caa17caSRaphael Isemann } 56487caa17caSRaphael Isemann } 56497caa17caSRaphael Isemann return eKeyHandled; 56507caa17caSRaphael Isemann 56517caa17caSRaphael Isemann case KEY_UP: 56527caa17caSRaphael Isemann if (m_selected_row_idx > 0) 56537caa17caSRaphael Isemann --m_selected_row_idx; 56547caa17caSRaphael Isemann return eKeyHandled; 56557caa17caSRaphael Isemann 56567caa17caSRaphael Isemann case KEY_DOWN: 56577caa17caSRaphael Isemann if (m_selected_row_idx + 1 < m_num_rows) 56587caa17caSRaphael Isemann ++m_selected_row_idx; 56597caa17caSRaphael Isemann return eKeyHandled; 56607caa17caSRaphael Isemann 56617caa17caSRaphael Isemann case KEY_RIGHT: 56627caa17caSRaphael Isemann if (m_selected_row) { 56637caa17caSRaphael Isemann if (!m_selected_row->expanded) 56647caa17caSRaphael Isemann m_selected_row->Expand(); 56657caa17caSRaphael Isemann } 56667caa17caSRaphael Isemann return eKeyHandled; 56677caa17caSRaphael Isemann 56687caa17caSRaphael Isemann case KEY_LEFT: 56697caa17caSRaphael Isemann if (m_selected_row) { 56707caa17caSRaphael Isemann if (m_selected_row->expanded) 56717caa17caSRaphael Isemann m_selected_row->Unexpand(); 56727caa17caSRaphael Isemann else if (m_selected_row->parent) 56737caa17caSRaphael Isemann m_selected_row_idx = m_selected_row->parent->row_idx; 56747caa17caSRaphael Isemann } 56757caa17caSRaphael Isemann return eKeyHandled; 56767caa17caSRaphael Isemann 56777caa17caSRaphael Isemann case ' ': 56787caa17caSRaphael Isemann // Toggle expansion state when SPACE is pressed 56797caa17caSRaphael Isemann if (m_selected_row) { 56807caa17caSRaphael Isemann if (m_selected_row->expanded) 56817caa17caSRaphael Isemann m_selected_row->Unexpand(); 56827caa17caSRaphael Isemann else 56837caa17caSRaphael Isemann m_selected_row->Expand(); 56847caa17caSRaphael Isemann } 56857caa17caSRaphael Isemann return eKeyHandled; 56867caa17caSRaphael Isemann 56877caa17caSRaphael Isemann case 'h': 56887caa17caSRaphael Isemann window.CreateHelpSubwindow(); 56897caa17caSRaphael Isemann return eKeyHandled; 56907caa17caSRaphael Isemann 56917caa17caSRaphael Isemann default: 56927caa17caSRaphael Isemann break; 56937caa17caSRaphael Isemann } 56947caa17caSRaphael Isemann return eKeyNotHandled; 56957caa17caSRaphael Isemann } 56967caa17caSRaphael Isemann 56977caa17caSRaphael Isemann protected: 56987caa17caSRaphael Isemann std::vector<Row> m_rows; 56999494c510SJonas Devlieghere Row *m_selected_row = nullptr; 57009494c510SJonas Devlieghere uint32_t m_selected_row_idx = 0; 57019494c510SJonas Devlieghere uint32_t m_first_visible_row = 0; 57029494c510SJonas Devlieghere uint32_t m_num_rows = 0; 57037caa17caSRaphael Isemann int m_min_x; 57047caa17caSRaphael Isemann int m_min_y; 57059494c510SJonas Devlieghere int m_max_x = 0; 57069494c510SJonas Devlieghere int m_max_y = 0; 57077caa17caSRaphael Isemann 57087caa17caSRaphael Isemann static Format FormatForChar(int c) { 57097caa17caSRaphael Isemann switch (c) { 57107caa17caSRaphael Isemann case 'x': 57117caa17caSRaphael Isemann return eFormatHex; 57127caa17caSRaphael Isemann case 'X': 57137caa17caSRaphael Isemann return eFormatHexUppercase; 57147caa17caSRaphael Isemann case 'o': 57157caa17caSRaphael Isemann return eFormatOctal; 57167caa17caSRaphael Isemann case 's': 57177caa17caSRaphael Isemann return eFormatCString; 57187caa17caSRaphael Isemann case 'u': 57197caa17caSRaphael Isemann return eFormatUnsigned; 57207caa17caSRaphael Isemann case 'd': 57217caa17caSRaphael Isemann return eFormatDecimal; 57227caa17caSRaphael Isemann case 'D': 57237caa17caSRaphael Isemann return eFormatDefault; 57247caa17caSRaphael Isemann case 'i': 57257caa17caSRaphael Isemann return eFormatInstruction; 57267caa17caSRaphael Isemann case 'A': 57277caa17caSRaphael Isemann return eFormatAddressInfo; 57287caa17caSRaphael Isemann case 'p': 57297caa17caSRaphael Isemann return eFormatPointer; 57307caa17caSRaphael Isemann case 'c': 57317caa17caSRaphael Isemann return eFormatChar; 57327caa17caSRaphael Isemann case 'b': 57337caa17caSRaphael Isemann return eFormatBinary; 57347caa17caSRaphael Isemann case 'B': 57357caa17caSRaphael Isemann return eFormatBytesWithASCII; 57367caa17caSRaphael Isemann case 'f': 57377caa17caSRaphael Isemann return eFormatFloat; 57387caa17caSRaphael Isemann } 57397caa17caSRaphael Isemann return eFormatDefault; 57407caa17caSRaphael Isemann } 57417caa17caSRaphael Isemann 57427caa17caSRaphael Isemann bool DisplayRowObject(Window &window, Row &row, DisplayOptions &options, 57437caa17caSRaphael Isemann bool highlight, bool last_child) { 57447caa17caSRaphael Isemann ValueObject *valobj = row.value.GetSP().get(); 57457caa17caSRaphael Isemann 57467caa17caSRaphael Isemann if (valobj == nullptr) 57477caa17caSRaphael Isemann return false; 57487caa17caSRaphael Isemann 57497caa17caSRaphael Isemann const char *type_name = 57507caa17caSRaphael Isemann options.show_types ? valobj->GetTypeName().GetCString() : nullptr; 57517caa17caSRaphael Isemann const char *name = valobj->GetName().GetCString(); 57527caa17caSRaphael Isemann const char *value = valobj->GetValueAsCString(); 57537caa17caSRaphael Isemann const char *summary = valobj->GetSummaryAsCString(); 57547caa17caSRaphael Isemann 57557caa17caSRaphael Isemann window.MoveCursor(row.x, row.y); 57567caa17caSRaphael Isemann 57577caa17caSRaphael Isemann row.DrawTree(window); 57587caa17caSRaphael Isemann 57597caa17caSRaphael Isemann if (highlight) 57607caa17caSRaphael Isemann window.AttributeOn(A_REVERSE); 57617caa17caSRaphael Isemann 57627caa17caSRaphael Isemann if (type_name && type_name[0]) 5763fc0e8fb7SLuboš Luňák window.PrintfTruncated(1, "(%s) ", type_name); 57647caa17caSRaphael Isemann 57657caa17caSRaphael Isemann if (name && name[0]) 5766fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, name); 57677caa17caSRaphael Isemann 57687caa17caSRaphael Isemann attr_t changd_attr = 0; 57697caa17caSRaphael Isemann if (valobj->GetValueDidChange()) 57704a8e4b5cSLuboš Luňák changd_attr = COLOR_PAIR(RedOnBlack) | A_BOLD; 57717caa17caSRaphael Isemann 57727caa17caSRaphael Isemann if (value && value[0]) { 5773fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, " = "); 57747caa17caSRaphael Isemann if (changd_attr) 57757caa17caSRaphael Isemann window.AttributeOn(changd_attr); 5776fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, value); 57777caa17caSRaphael Isemann if (changd_attr) 57787caa17caSRaphael Isemann window.AttributeOff(changd_attr); 57797caa17caSRaphael Isemann } 57807caa17caSRaphael Isemann 57817caa17caSRaphael Isemann if (summary && summary[0]) { 5782fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, " "); 57837caa17caSRaphael Isemann if (changd_attr) 57847caa17caSRaphael Isemann window.AttributeOn(changd_attr); 5785fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, summary); 57867caa17caSRaphael Isemann if (changd_attr) 57877caa17caSRaphael Isemann window.AttributeOff(changd_attr); 57887caa17caSRaphael Isemann } 57897caa17caSRaphael Isemann 57907caa17caSRaphael Isemann if (highlight) 57917caa17caSRaphael Isemann window.AttributeOff(A_REVERSE); 57927caa17caSRaphael Isemann 57937caa17caSRaphael Isemann return true; 57947caa17caSRaphael Isemann } 57957caa17caSRaphael Isemann 57967caa17caSRaphael Isemann void DisplayRows(Window &window, std::vector<Row> &rows, 57977caa17caSRaphael Isemann DisplayOptions &options) { 57987caa17caSRaphael Isemann // > 0x25B7 57997caa17caSRaphael Isemann // \/ 0x25BD 58007caa17caSRaphael Isemann 58017caa17caSRaphael Isemann bool window_is_active = window.IsActive(); 58027caa17caSRaphael Isemann for (auto &row : rows) { 58037caa17caSRaphael Isemann const bool last_child = row.parent && &rows[rows.size() - 1] == &row; 58047caa17caSRaphael Isemann // Save the row index in each Row structure 58057caa17caSRaphael Isemann row.row_idx = m_num_rows; 58067caa17caSRaphael Isemann if ((m_num_rows >= m_first_visible_row) && 58077caa17caSRaphael Isemann ((m_num_rows - m_first_visible_row) < 58087caa17caSRaphael Isemann static_cast<size_t>(NumVisibleRows()))) { 58097caa17caSRaphael Isemann row.x = m_min_x; 58107caa17caSRaphael Isemann row.y = m_num_rows - m_first_visible_row + 1; 58117caa17caSRaphael Isemann if (DisplayRowObject(window, row, options, 58127caa17caSRaphael Isemann window_is_active && 58137caa17caSRaphael Isemann m_num_rows == m_selected_row_idx, 58147caa17caSRaphael Isemann last_child)) { 58157caa17caSRaphael Isemann ++m_num_rows; 58167caa17caSRaphael Isemann } else { 58177caa17caSRaphael Isemann row.x = 0; 58187caa17caSRaphael Isemann row.y = 0; 58197caa17caSRaphael Isemann } 58207caa17caSRaphael Isemann } else { 58217caa17caSRaphael Isemann row.x = 0; 58227caa17caSRaphael Isemann row.y = 0; 58237caa17caSRaphael Isemann ++m_num_rows; 58247caa17caSRaphael Isemann } 58257caa17caSRaphael Isemann 58267caa17caSRaphael Isemann auto &children = row.GetChildren(); 58277caa17caSRaphael Isemann if (row.expanded && !children.empty()) { 58287caa17caSRaphael Isemann DisplayRows(window, children, options); 58297caa17caSRaphael Isemann } 58307caa17caSRaphael Isemann } 58317caa17caSRaphael Isemann } 58327caa17caSRaphael Isemann 58337caa17caSRaphael Isemann int CalculateTotalNumberRows(std::vector<Row> &rows) { 58347caa17caSRaphael Isemann int row_count = 0; 58357caa17caSRaphael Isemann for (auto &row : rows) { 58367caa17caSRaphael Isemann ++row_count; 58377caa17caSRaphael Isemann if (row.expanded) 58387caa17caSRaphael Isemann row_count += CalculateTotalNumberRows(row.GetChildren()); 58397caa17caSRaphael Isemann } 58407caa17caSRaphael Isemann return row_count; 58417caa17caSRaphael Isemann } 58427caa17caSRaphael Isemann 58437caa17caSRaphael Isemann static Row *GetRowForRowIndexImpl(std::vector<Row> &rows, size_t &row_index) { 58447caa17caSRaphael Isemann for (auto &row : rows) { 58457caa17caSRaphael Isemann if (row_index == 0) 58467caa17caSRaphael Isemann return &row; 58477caa17caSRaphael Isemann else { 58487caa17caSRaphael Isemann --row_index; 58497caa17caSRaphael Isemann auto &children = row.GetChildren(); 58507caa17caSRaphael Isemann if (row.expanded && !children.empty()) { 58517caa17caSRaphael Isemann Row *result = GetRowForRowIndexImpl(children, row_index); 58527caa17caSRaphael Isemann if (result) 58537caa17caSRaphael Isemann return result; 58547caa17caSRaphael Isemann } 58557caa17caSRaphael Isemann } 58567caa17caSRaphael Isemann } 58577caa17caSRaphael Isemann return nullptr; 58587caa17caSRaphael Isemann } 58597caa17caSRaphael Isemann 58607caa17caSRaphael Isemann Row *GetRowForRowIndex(size_t row_index) { 58617caa17caSRaphael Isemann return GetRowForRowIndexImpl(m_rows, row_index); 58627caa17caSRaphael Isemann } 58637caa17caSRaphael Isemann 58647caa17caSRaphael Isemann int NumVisibleRows() const { return m_max_y - m_min_y; } 58657caa17caSRaphael Isemann 58667caa17caSRaphael Isemann static DisplayOptions g_options; 58677caa17caSRaphael Isemann }; 58687caa17caSRaphael Isemann 58697caa17caSRaphael Isemann class FrameVariablesWindowDelegate : public ValueObjectListDelegate { 58707caa17caSRaphael Isemann public: 58717caa17caSRaphael Isemann FrameVariablesWindowDelegate(Debugger &debugger) 587228c878aeSShafik Yaghmour : ValueObjectListDelegate(), m_debugger(debugger) {} 58737caa17caSRaphael Isemann 58747caa17caSRaphael Isemann ~FrameVariablesWindowDelegate() override = default; 58757caa17caSRaphael Isemann 58767caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 58777caa17caSRaphael Isemann return "Frame variable window keyboard shortcuts:"; 58787caa17caSRaphael Isemann } 58797caa17caSRaphael Isemann 58807caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 58817caa17caSRaphael Isemann ExecutionContext exe_ctx( 58827caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext()); 58837caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 58847caa17caSRaphael Isemann Block *frame_block = nullptr; 58857caa17caSRaphael Isemann StackFrame *frame = nullptr; 58867caa17caSRaphael Isemann 58877caa17caSRaphael Isemann if (process) { 58887caa17caSRaphael Isemann StateType state = process->GetState(); 58897caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 58907caa17caSRaphael Isemann frame = exe_ctx.GetFramePtr(); 58917caa17caSRaphael Isemann if (frame) 58927caa17caSRaphael Isemann frame_block = frame->GetFrameBlock(); 58937caa17caSRaphael Isemann } else if (StateIsRunningState(state)) { 58947caa17caSRaphael Isemann return true; // Don't do any updating when we are running 58957caa17caSRaphael Isemann } 58967caa17caSRaphael Isemann } 58977caa17caSRaphael Isemann 58987caa17caSRaphael Isemann ValueObjectList local_values; 58997caa17caSRaphael Isemann if (frame_block) { 59007caa17caSRaphael Isemann // Only update the variables if they have changed 59017caa17caSRaphael Isemann if (m_frame_block != frame_block) { 59027caa17caSRaphael Isemann m_frame_block = frame_block; 59037caa17caSRaphael Isemann 59047caa17caSRaphael Isemann VariableList *locals = frame->GetVariableList(true); 59057caa17caSRaphael Isemann if (locals) { 59067caa17caSRaphael Isemann const DynamicValueType use_dynamic = eDynamicDontRunTarget; 59077caa17caSRaphael Isemann for (const VariableSP &local_sp : *locals) { 59087caa17caSRaphael Isemann ValueObjectSP value_sp = 59097caa17caSRaphael Isemann frame->GetValueObjectForFrameVariable(local_sp, use_dynamic); 59107caa17caSRaphael Isemann if (value_sp) { 59117caa17caSRaphael Isemann ValueObjectSP synthetic_value_sp = value_sp->GetSyntheticValue(); 59127caa17caSRaphael Isemann if (synthetic_value_sp) 59137caa17caSRaphael Isemann local_values.Append(synthetic_value_sp); 59147caa17caSRaphael Isemann else 59157caa17caSRaphael Isemann local_values.Append(value_sp); 59167caa17caSRaphael Isemann } 59177caa17caSRaphael Isemann } 59187caa17caSRaphael Isemann // Update the values 59197caa17caSRaphael Isemann SetValues(local_values); 59207caa17caSRaphael Isemann } 59217caa17caSRaphael Isemann } 59227caa17caSRaphael Isemann } else { 59237caa17caSRaphael Isemann m_frame_block = nullptr; 59247caa17caSRaphael Isemann // Update the values with an empty list if there is no frame 59257caa17caSRaphael Isemann SetValues(local_values); 59267caa17caSRaphael Isemann } 59277caa17caSRaphael Isemann 59287caa17caSRaphael Isemann return ValueObjectListDelegate::WindowDelegateDraw(window, force); 59297caa17caSRaphael Isemann } 59307caa17caSRaphael Isemann 59317caa17caSRaphael Isemann protected: 59327caa17caSRaphael Isemann Debugger &m_debugger; 593328c878aeSShafik Yaghmour Block *m_frame_block = nullptr; 59347caa17caSRaphael Isemann }; 59357caa17caSRaphael Isemann 59367caa17caSRaphael Isemann class RegistersWindowDelegate : public ValueObjectListDelegate { 59377caa17caSRaphael Isemann public: 59387caa17caSRaphael Isemann RegistersWindowDelegate(Debugger &debugger) 59397caa17caSRaphael Isemann : ValueObjectListDelegate(), m_debugger(debugger) {} 59407caa17caSRaphael Isemann 59417caa17caSRaphael Isemann ~RegistersWindowDelegate() override = default; 59427caa17caSRaphael Isemann 59437caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 59447caa17caSRaphael Isemann return "Register window keyboard shortcuts:"; 59457caa17caSRaphael Isemann } 59467caa17caSRaphael Isemann 59477caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 59487caa17caSRaphael Isemann ExecutionContext exe_ctx( 59497caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext()); 59507caa17caSRaphael Isemann StackFrame *frame = exe_ctx.GetFramePtr(); 59517caa17caSRaphael Isemann 59527caa17caSRaphael Isemann ValueObjectList value_list; 59537caa17caSRaphael Isemann if (frame) { 59547caa17caSRaphael Isemann if (frame->GetStackID() != m_stack_id) { 59557caa17caSRaphael Isemann m_stack_id = frame->GetStackID(); 59567caa17caSRaphael Isemann RegisterContextSP reg_ctx(frame->GetRegisterContext()); 59577caa17caSRaphael Isemann if (reg_ctx) { 59587caa17caSRaphael Isemann const uint32_t num_sets = reg_ctx->GetRegisterSetCount(); 59597caa17caSRaphael Isemann for (uint32_t set_idx = 0; set_idx < num_sets; ++set_idx) { 59607caa17caSRaphael Isemann value_list.Append( 59617caa17caSRaphael Isemann ValueObjectRegisterSet::Create(frame, reg_ctx, set_idx)); 59627caa17caSRaphael Isemann } 59637caa17caSRaphael Isemann } 59647caa17caSRaphael Isemann SetValues(value_list); 59657caa17caSRaphael Isemann } 59667caa17caSRaphael Isemann } else { 59677caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 59687caa17caSRaphael Isemann if (process && process->IsAlive()) 59697caa17caSRaphael Isemann return true; // Don't do any updating if we are running 59707caa17caSRaphael Isemann else { 59717caa17caSRaphael Isemann // Update the values with an empty list if there is no process or the 59727caa17caSRaphael Isemann // process isn't alive anymore 59737caa17caSRaphael Isemann SetValues(value_list); 59747caa17caSRaphael Isemann } 59757caa17caSRaphael Isemann } 59767caa17caSRaphael Isemann return ValueObjectListDelegate::WindowDelegateDraw(window, force); 59777caa17caSRaphael Isemann } 59787caa17caSRaphael Isemann 59797caa17caSRaphael Isemann protected: 59807caa17caSRaphael Isemann Debugger &m_debugger; 59817caa17caSRaphael Isemann StackID m_stack_id; 59827caa17caSRaphael Isemann }; 59837caa17caSRaphael Isemann 59847caa17caSRaphael Isemann static const char *CursesKeyToCString(int ch) { 59857caa17caSRaphael Isemann static char g_desc[32]; 59867caa17caSRaphael Isemann if (ch >= KEY_F0 && ch < KEY_F0 + 64) { 59877caa17caSRaphael Isemann snprintf(g_desc, sizeof(g_desc), "F%u", ch - KEY_F0); 59887caa17caSRaphael Isemann return g_desc; 59897caa17caSRaphael Isemann } 59907caa17caSRaphael Isemann switch (ch) { 59917caa17caSRaphael Isemann case KEY_DOWN: 59927caa17caSRaphael Isemann return "down"; 59937caa17caSRaphael Isemann case KEY_UP: 59947caa17caSRaphael Isemann return "up"; 59957caa17caSRaphael Isemann case KEY_LEFT: 59967caa17caSRaphael Isemann return "left"; 59977caa17caSRaphael Isemann case KEY_RIGHT: 59987caa17caSRaphael Isemann return "right"; 59997caa17caSRaphael Isemann case KEY_HOME: 60007caa17caSRaphael Isemann return "home"; 60017caa17caSRaphael Isemann case KEY_BACKSPACE: 60027caa17caSRaphael Isemann return "backspace"; 60037caa17caSRaphael Isemann case KEY_DL: 60047caa17caSRaphael Isemann return "delete-line"; 60057caa17caSRaphael Isemann case KEY_IL: 60067caa17caSRaphael Isemann return "insert-line"; 60077caa17caSRaphael Isemann case KEY_DC: 60087caa17caSRaphael Isemann return "delete-char"; 60097caa17caSRaphael Isemann case KEY_IC: 60107caa17caSRaphael Isemann return "insert-char"; 60117caa17caSRaphael Isemann case KEY_CLEAR: 60127caa17caSRaphael Isemann return "clear"; 60137caa17caSRaphael Isemann case KEY_EOS: 60147caa17caSRaphael Isemann return "clear-to-eos"; 60157caa17caSRaphael Isemann case KEY_EOL: 60167caa17caSRaphael Isemann return "clear-to-eol"; 60177caa17caSRaphael Isemann case KEY_SF: 60187caa17caSRaphael Isemann return "scroll-forward"; 60197caa17caSRaphael Isemann case KEY_SR: 60207caa17caSRaphael Isemann return "scroll-backward"; 60217caa17caSRaphael Isemann case KEY_NPAGE: 60227caa17caSRaphael Isemann return "page-down"; 60237caa17caSRaphael Isemann case KEY_PPAGE: 60247caa17caSRaphael Isemann return "page-up"; 60257caa17caSRaphael Isemann case KEY_STAB: 60267caa17caSRaphael Isemann return "set-tab"; 60277caa17caSRaphael Isemann case KEY_CTAB: 60287caa17caSRaphael Isemann return "clear-tab"; 60297caa17caSRaphael Isemann case KEY_CATAB: 60307caa17caSRaphael Isemann return "clear-all-tabs"; 60317caa17caSRaphael Isemann case KEY_ENTER: 60327caa17caSRaphael Isemann return "enter"; 60337caa17caSRaphael Isemann case KEY_PRINT: 60347caa17caSRaphael Isemann return "print"; 60357caa17caSRaphael Isemann case KEY_LL: 60367caa17caSRaphael Isemann return "lower-left key"; 60377caa17caSRaphael Isemann case KEY_A1: 60387caa17caSRaphael Isemann return "upper left of keypad"; 60397caa17caSRaphael Isemann case KEY_A3: 60407caa17caSRaphael Isemann return "upper right of keypad"; 60417caa17caSRaphael Isemann case KEY_B2: 60427caa17caSRaphael Isemann return "center of keypad"; 60437caa17caSRaphael Isemann case KEY_C1: 60447caa17caSRaphael Isemann return "lower left of keypad"; 60457caa17caSRaphael Isemann case KEY_C3: 60467caa17caSRaphael Isemann return "lower right of keypad"; 60477caa17caSRaphael Isemann case KEY_BTAB: 60487caa17caSRaphael Isemann return "back-tab key"; 60497caa17caSRaphael Isemann case KEY_BEG: 60507caa17caSRaphael Isemann return "begin key"; 60517caa17caSRaphael Isemann case KEY_CANCEL: 60527caa17caSRaphael Isemann return "cancel key"; 60537caa17caSRaphael Isemann case KEY_CLOSE: 60547caa17caSRaphael Isemann return "close key"; 60557caa17caSRaphael Isemann case KEY_COMMAND: 60567caa17caSRaphael Isemann return "command key"; 60577caa17caSRaphael Isemann case KEY_COPY: 60587caa17caSRaphael Isemann return "copy key"; 60597caa17caSRaphael Isemann case KEY_CREATE: 60607caa17caSRaphael Isemann return "create key"; 60617caa17caSRaphael Isemann case KEY_END: 60627caa17caSRaphael Isemann return "end key"; 60637caa17caSRaphael Isemann case KEY_EXIT: 60647caa17caSRaphael Isemann return "exit key"; 60657caa17caSRaphael Isemann case KEY_FIND: 60667caa17caSRaphael Isemann return "find key"; 60677caa17caSRaphael Isemann case KEY_HELP: 60687caa17caSRaphael Isemann return "help key"; 60697caa17caSRaphael Isemann case KEY_MARK: 60707caa17caSRaphael Isemann return "mark key"; 60717caa17caSRaphael Isemann case KEY_MESSAGE: 60727caa17caSRaphael Isemann return "message key"; 60737caa17caSRaphael Isemann case KEY_MOVE: 60747caa17caSRaphael Isemann return "move key"; 60757caa17caSRaphael Isemann case KEY_NEXT: 60767caa17caSRaphael Isemann return "next key"; 60777caa17caSRaphael Isemann case KEY_OPEN: 60787caa17caSRaphael Isemann return "open key"; 60797caa17caSRaphael Isemann case KEY_OPTIONS: 60807caa17caSRaphael Isemann return "options key"; 60817caa17caSRaphael Isemann case KEY_PREVIOUS: 60827caa17caSRaphael Isemann return "previous key"; 60837caa17caSRaphael Isemann case KEY_REDO: 60847caa17caSRaphael Isemann return "redo key"; 60857caa17caSRaphael Isemann case KEY_REFERENCE: 60867caa17caSRaphael Isemann return "reference key"; 60877caa17caSRaphael Isemann case KEY_REFRESH: 60887caa17caSRaphael Isemann return "refresh key"; 60897caa17caSRaphael Isemann case KEY_REPLACE: 60907caa17caSRaphael Isemann return "replace key"; 60917caa17caSRaphael Isemann case KEY_RESTART: 60927caa17caSRaphael Isemann return "restart key"; 60937caa17caSRaphael Isemann case KEY_RESUME: 60947caa17caSRaphael Isemann return "resume key"; 60957caa17caSRaphael Isemann case KEY_SAVE: 60967caa17caSRaphael Isemann return "save key"; 60977caa17caSRaphael Isemann case KEY_SBEG: 60987caa17caSRaphael Isemann return "shifted begin key"; 60997caa17caSRaphael Isemann case KEY_SCANCEL: 61007caa17caSRaphael Isemann return "shifted cancel key"; 61017caa17caSRaphael Isemann case KEY_SCOMMAND: 61027caa17caSRaphael Isemann return "shifted command key"; 61037caa17caSRaphael Isemann case KEY_SCOPY: 61047caa17caSRaphael Isemann return "shifted copy key"; 61057caa17caSRaphael Isemann case KEY_SCREATE: 61067caa17caSRaphael Isemann return "shifted create key"; 61077caa17caSRaphael Isemann case KEY_SDC: 61087caa17caSRaphael Isemann return "shifted delete-character key"; 61097caa17caSRaphael Isemann case KEY_SDL: 61107caa17caSRaphael Isemann return "shifted delete-line key"; 61117caa17caSRaphael Isemann case KEY_SELECT: 61127caa17caSRaphael Isemann return "select key"; 61137caa17caSRaphael Isemann case KEY_SEND: 61147caa17caSRaphael Isemann return "shifted end key"; 61157caa17caSRaphael Isemann case KEY_SEOL: 61167caa17caSRaphael Isemann return "shifted clear-to-end-of-line key"; 61177caa17caSRaphael Isemann case KEY_SEXIT: 61187caa17caSRaphael Isemann return "shifted exit key"; 61197caa17caSRaphael Isemann case KEY_SFIND: 61207caa17caSRaphael Isemann return "shifted find key"; 61217caa17caSRaphael Isemann case KEY_SHELP: 61227caa17caSRaphael Isemann return "shifted help key"; 61237caa17caSRaphael Isemann case KEY_SHOME: 61247caa17caSRaphael Isemann return "shifted home key"; 61257caa17caSRaphael Isemann case KEY_SIC: 61267caa17caSRaphael Isemann return "shifted insert-character key"; 61277caa17caSRaphael Isemann case KEY_SLEFT: 61287caa17caSRaphael Isemann return "shifted left-arrow key"; 61297caa17caSRaphael Isemann case KEY_SMESSAGE: 61307caa17caSRaphael Isemann return "shifted message key"; 61317caa17caSRaphael Isemann case KEY_SMOVE: 61327caa17caSRaphael Isemann return "shifted move key"; 61337caa17caSRaphael Isemann case KEY_SNEXT: 61347caa17caSRaphael Isemann return "shifted next key"; 61357caa17caSRaphael Isemann case KEY_SOPTIONS: 61367caa17caSRaphael Isemann return "shifted options key"; 61377caa17caSRaphael Isemann case KEY_SPREVIOUS: 61387caa17caSRaphael Isemann return "shifted previous key"; 61397caa17caSRaphael Isemann case KEY_SPRINT: 61407caa17caSRaphael Isemann return "shifted print key"; 61417caa17caSRaphael Isemann case KEY_SREDO: 61427caa17caSRaphael Isemann return "shifted redo key"; 61437caa17caSRaphael Isemann case KEY_SREPLACE: 61447caa17caSRaphael Isemann return "shifted replace key"; 61457caa17caSRaphael Isemann case KEY_SRIGHT: 61467caa17caSRaphael Isemann return "shifted right-arrow key"; 61477caa17caSRaphael Isemann case KEY_SRSUME: 61487caa17caSRaphael Isemann return "shifted resume key"; 61497caa17caSRaphael Isemann case KEY_SSAVE: 61507caa17caSRaphael Isemann return "shifted save key"; 61517caa17caSRaphael Isemann case KEY_SSUSPEND: 61527caa17caSRaphael Isemann return "shifted suspend key"; 61537caa17caSRaphael Isemann case KEY_SUNDO: 61547caa17caSRaphael Isemann return "shifted undo key"; 61557caa17caSRaphael Isemann case KEY_SUSPEND: 61567caa17caSRaphael Isemann return "suspend key"; 61577caa17caSRaphael Isemann case KEY_UNDO: 61587caa17caSRaphael Isemann return "undo key"; 61597caa17caSRaphael Isemann case KEY_MOUSE: 61607caa17caSRaphael Isemann return "Mouse event has occurred"; 61617caa17caSRaphael Isemann case KEY_RESIZE: 61627caa17caSRaphael Isemann return "Terminal resize event"; 61637caa17caSRaphael Isemann #ifdef KEY_EVENT 61647caa17caSRaphael Isemann case KEY_EVENT: 61657caa17caSRaphael Isemann return "We were interrupted by an event"; 61667caa17caSRaphael Isemann #endif 61677caa17caSRaphael Isemann case KEY_RETURN: 61687caa17caSRaphael Isemann return "return"; 61697caa17caSRaphael Isemann case ' ': 61707caa17caSRaphael Isemann return "space"; 61717caa17caSRaphael Isemann case '\t': 61727caa17caSRaphael Isemann return "tab"; 61737caa17caSRaphael Isemann case KEY_ESCAPE: 61747caa17caSRaphael Isemann return "escape"; 61757caa17caSRaphael Isemann default: 6176f5eaa2afSRaphael Isemann if (llvm::isPrint(ch)) 61777caa17caSRaphael Isemann snprintf(g_desc, sizeof(g_desc), "%c", ch); 61787caa17caSRaphael Isemann else 61797caa17caSRaphael Isemann snprintf(g_desc, sizeof(g_desc), "\\x%2.2x", ch); 61807caa17caSRaphael Isemann return g_desc; 61817caa17caSRaphael Isemann } 61827caa17caSRaphael Isemann return nullptr; 61837caa17caSRaphael Isemann } 61847caa17caSRaphael Isemann 61857caa17caSRaphael Isemann HelpDialogDelegate::HelpDialogDelegate(const char *text, 61867caa17caSRaphael Isemann KeyHelp *key_help_array) 618728c878aeSShafik Yaghmour : m_text() { 61887caa17caSRaphael Isemann if (text && text[0]) { 61897caa17caSRaphael Isemann m_text.SplitIntoLines(text); 61907caa17caSRaphael Isemann m_text.AppendString(""); 61917caa17caSRaphael Isemann } 61927caa17caSRaphael Isemann if (key_help_array) { 61937caa17caSRaphael Isemann for (KeyHelp *key = key_help_array; key->ch; ++key) { 61947caa17caSRaphael Isemann StreamString key_description; 61957caa17caSRaphael Isemann key_description.Printf("%10s - %s", CursesKeyToCString(key->ch), 61967caa17caSRaphael Isemann key->description); 61977caa17caSRaphael Isemann m_text.AppendString(key_description.GetString()); 61987caa17caSRaphael Isemann } 61997caa17caSRaphael Isemann } 62007caa17caSRaphael Isemann } 62017caa17caSRaphael Isemann 62027caa17caSRaphael Isemann HelpDialogDelegate::~HelpDialogDelegate() = default; 62037caa17caSRaphael Isemann 62047caa17caSRaphael Isemann bool HelpDialogDelegate::WindowDelegateDraw(Window &window, bool force) { 62057caa17caSRaphael Isemann window.Erase(); 62067caa17caSRaphael Isemann const int window_height = window.GetHeight(); 62077caa17caSRaphael Isemann int x = 2; 62087caa17caSRaphael Isemann int y = 1; 62097caa17caSRaphael Isemann const int min_y = y; 62107caa17caSRaphael Isemann const int max_y = window_height - 1 - y; 62117caa17caSRaphael Isemann const size_t num_visible_lines = max_y - min_y + 1; 62127caa17caSRaphael Isemann const size_t num_lines = m_text.GetSize(); 62137caa17caSRaphael Isemann const char *bottom_message; 62147caa17caSRaphael Isemann if (num_lines <= num_visible_lines) 62157caa17caSRaphael Isemann bottom_message = "Press any key to exit"; 62167caa17caSRaphael Isemann else 62177caa17caSRaphael Isemann bottom_message = "Use arrows to scroll, any other key to exit"; 62187caa17caSRaphael Isemann window.DrawTitleBox(window.GetName(), bottom_message); 62197caa17caSRaphael Isemann while (y <= max_y) { 62207caa17caSRaphael Isemann window.MoveCursor(x, y); 62217caa17caSRaphael Isemann window.PutCStringTruncated( 6222fc0e8fb7SLuboš Luňák 1, m_text.GetStringAtIndex(m_first_visible_line + y - min_y)); 62237caa17caSRaphael Isemann ++y; 62247caa17caSRaphael Isemann } 62257caa17caSRaphael Isemann return true; 62267caa17caSRaphael Isemann } 62277caa17caSRaphael Isemann 62287caa17caSRaphael Isemann HandleCharResult HelpDialogDelegate::WindowDelegateHandleChar(Window &window, 62297caa17caSRaphael Isemann int key) { 62307caa17caSRaphael Isemann bool done = false; 62317caa17caSRaphael Isemann const size_t num_lines = m_text.GetSize(); 62327caa17caSRaphael Isemann const size_t num_visible_lines = window.GetHeight() - 2; 62337caa17caSRaphael Isemann 62347caa17caSRaphael Isemann if (num_lines <= num_visible_lines) { 62357caa17caSRaphael Isemann done = true; 62367caa17caSRaphael Isemann // If we have all lines visible and don't need scrolling, then any key 62377caa17caSRaphael Isemann // press will cause us to exit 62387caa17caSRaphael Isemann } else { 62397caa17caSRaphael Isemann switch (key) { 62407caa17caSRaphael Isemann case KEY_UP: 62417caa17caSRaphael Isemann if (m_first_visible_line > 0) 62427caa17caSRaphael Isemann --m_first_visible_line; 62437caa17caSRaphael Isemann break; 62447caa17caSRaphael Isemann 62457caa17caSRaphael Isemann case KEY_DOWN: 62467caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < num_lines) 62477caa17caSRaphael Isemann ++m_first_visible_line; 62487caa17caSRaphael Isemann break; 62497caa17caSRaphael Isemann 62507caa17caSRaphael Isemann case KEY_PPAGE: 62517caa17caSRaphael Isemann case ',': 62527caa17caSRaphael Isemann if (m_first_visible_line > 0) { 62537caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) >= num_visible_lines) 62547caa17caSRaphael Isemann m_first_visible_line -= num_visible_lines; 62557caa17caSRaphael Isemann else 62567caa17caSRaphael Isemann m_first_visible_line = 0; 62577caa17caSRaphael Isemann } 62587caa17caSRaphael Isemann break; 62597caa17caSRaphael Isemann 62607caa17caSRaphael Isemann case KEY_NPAGE: 62617caa17caSRaphael Isemann case '.': 62627caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < num_lines) { 62637caa17caSRaphael Isemann m_first_visible_line += num_visible_lines; 62647caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) > num_lines) 62657caa17caSRaphael Isemann m_first_visible_line = num_lines - num_visible_lines; 62667caa17caSRaphael Isemann } 62677caa17caSRaphael Isemann break; 62687caa17caSRaphael Isemann 62697caa17caSRaphael Isemann default: 62707caa17caSRaphael Isemann done = true; 62717caa17caSRaphael Isemann break; 62727caa17caSRaphael Isemann } 62737caa17caSRaphael Isemann } 62747caa17caSRaphael Isemann if (done) 62757caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 62767caa17caSRaphael Isemann return eKeyHandled; 62777caa17caSRaphael Isemann } 62787caa17caSRaphael Isemann 62797caa17caSRaphael Isemann class ApplicationDelegate : public WindowDelegate, public MenuDelegate { 62807caa17caSRaphael Isemann public: 62817caa17caSRaphael Isemann enum { 62827caa17caSRaphael Isemann eMenuID_LLDB = 1, 62837caa17caSRaphael Isemann eMenuID_LLDBAbout, 62847caa17caSRaphael Isemann eMenuID_LLDBExit, 62857caa17caSRaphael Isemann 62867caa17caSRaphael Isemann eMenuID_Target, 62877caa17caSRaphael Isemann eMenuID_TargetCreate, 62887caa17caSRaphael Isemann eMenuID_TargetDelete, 62897caa17caSRaphael Isemann 62907caa17caSRaphael Isemann eMenuID_Process, 62917caa17caSRaphael Isemann eMenuID_ProcessAttach, 629247d2c7cdSLuboš Luňák eMenuID_ProcessDetachResume, 629347d2c7cdSLuboš Luňák eMenuID_ProcessDetachSuspended, 62947caa17caSRaphael Isemann eMenuID_ProcessLaunch, 62957caa17caSRaphael Isemann eMenuID_ProcessContinue, 62967caa17caSRaphael Isemann eMenuID_ProcessHalt, 62977caa17caSRaphael Isemann eMenuID_ProcessKill, 62987caa17caSRaphael Isemann 62997caa17caSRaphael Isemann eMenuID_Thread, 63007caa17caSRaphael Isemann eMenuID_ThreadStepIn, 63017caa17caSRaphael Isemann eMenuID_ThreadStepOver, 63027caa17caSRaphael Isemann eMenuID_ThreadStepOut, 63037caa17caSRaphael Isemann 63047caa17caSRaphael Isemann eMenuID_View, 63057caa17caSRaphael Isemann eMenuID_ViewBacktrace, 63067caa17caSRaphael Isemann eMenuID_ViewRegisters, 63077caa17caSRaphael Isemann eMenuID_ViewSource, 63087caa17caSRaphael Isemann eMenuID_ViewVariables, 6309b26e1efcSOmar Emara eMenuID_ViewBreakpoints, 63107caa17caSRaphael Isemann 63117caa17caSRaphael Isemann eMenuID_Help, 63127caa17caSRaphael Isemann eMenuID_HelpGUIHelp 63137caa17caSRaphael Isemann }; 63147caa17caSRaphael Isemann 63157caa17caSRaphael Isemann ApplicationDelegate(Application &app, Debugger &debugger) 63167caa17caSRaphael Isemann : WindowDelegate(), MenuDelegate(), m_app(app), m_debugger(debugger) {} 63177caa17caSRaphael Isemann 63187caa17caSRaphael Isemann ~ApplicationDelegate() override = default; 63197caa17caSRaphael Isemann 63207caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 63217caa17caSRaphael Isemann return false; // Drawing not handled, let standard window drawing happen 63227caa17caSRaphael Isemann } 63237caa17caSRaphael Isemann 63247caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int key) override { 63257caa17caSRaphael Isemann switch (key) { 63267caa17caSRaphael Isemann case '\t': 63277caa17caSRaphael Isemann window.SelectNextWindowAsActive(); 63287caa17caSRaphael Isemann return eKeyHandled; 63297caa17caSRaphael Isemann 633029cc50e1SOmar Emara case KEY_SHIFT_TAB: 63317a63dc53SLuboš Luňák window.SelectPreviousWindowAsActive(); 63327a63dc53SLuboš Luňák return eKeyHandled; 63337a63dc53SLuboš Luňák 63347caa17caSRaphael Isemann case 'h': 63357caa17caSRaphael Isemann window.CreateHelpSubwindow(); 63367caa17caSRaphael Isemann return eKeyHandled; 63377caa17caSRaphael Isemann 63387caa17caSRaphael Isemann case KEY_ESCAPE: 63397caa17caSRaphael Isemann return eQuitApplication; 63407caa17caSRaphael Isemann 63417caa17caSRaphael Isemann default: 63427caa17caSRaphael Isemann break; 63437caa17caSRaphael Isemann } 63447caa17caSRaphael Isemann return eKeyNotHandled; 63457caa17caSRaphael Isemann } 63467caa17caSRaphael Isemann 63477caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 63487caa17caSRaphael Isemann return "Welcome to the LLDB curses GUI.\n\n" 63497caa17caSRaphael Isemann "Press the TAB key to change the selected view.\n" 63507caa17caSRaphael Isemann "Each view has its own keyboard shortcuts, press 'h' to open a " 63517caa17caSRaphael Isemann "dialog to display them.\n\n" 63527caa17caSRaphael Isemann "Common key bindings for all views:"; 63537caa17caSRaphael Isemann } 63547caa17caSRaphael Isemann 63557caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 63567caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 63577caa17caSRaphael Isemann {'\t', "Select next view"}, 63587a63dc53SLuboš Luňák {KEY_BTAB, "Select previous view"}, 63597caa17caSRaphael Isemann {'h', "Show help dialog with view specific key bindings"}, 63607caa17caSRaphael Isemann {',', "Page up"}, 63617caa17caSRaphael Isemann {'.', "Page down"}, 63627caa17caSRaphael Isemann {KEY_UP, "Select previous"}, 63637caa17caSRaphael Isemann {KEY_DOWN, "Select next"}, 63647caa17caSRaphael Isemann {KEY_LEFT, "Unexpand or select parent"}, 63657caa17caSRaphael Isemann {KEY_RIGHT, "Expand"}, 63667caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 63677caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 63687caa17caSRaphael Isemann {'\0', nullptr}}; 63697caa17caSRaphael Isemann return g_source_view_key_help; 63707caa17caSRaphael Isemann } 63717caa17caSRaphael Isemann 63727caa17caSRaphael Isemann MenuActionResult MenuDelegateAction(Menu &menu) override { 63737caa17caSRaphael Isemann switch (menu.GetIdentifier()) { 637418c25cd3SOmar Emara case eMenuID_TargetCreate: { 637518c25cd3SOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 637618c25cd3SOmar Emara FormDelegateSP form_delegate_sp = 637718c25cd3SOmar Emara FormDelegateSP(new TargetCreateFormDelegate(m_debugger)); 637818c25cd3SOmar Emara Rect bounds = main_window_sp->GetCenteredRect(80, 19); 637918c25cd3SOmar Emara WindowSP form_window_sp = main_window_sp->CreateSubWindow( 638018c25cd3SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 638118c25cd3SOmar Emara WindowDelegateSP window_delegate_sp = 638218c25cd3SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 638318c25cd3SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 638418c25cd3SOmar Emara return MenuActionResult::Handled; 638518c25cd3SOmar Emara } 63867caa17caSRaphael Isemann case eMenuID_ThreadStepIn: { 63877caa17caSRaphael Isemann ExecutionContext exe_ctx = 63887caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 63897caa17caSRaphael Isemann if (exe_ctx.HasThreadScope()) { 63907caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 63917caa17caSRaphael Isemann if (process && process->IsAlive() && 63927caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 63937caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepIn(true); 63947caa17caSRaphael Isemann } 63957caa17caSRaphael Isemann } 63967caa17caSRaphael Isemann return MenuActionResult::Handled; 63977caa17caSRaphael Isemann 63987caa17caSRaphael Isemann case eMenuID_ThreadStepOut: { 63997caa17caSRaphael Isemann ExecutionContext exe_ctx = 64007caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64017caa17caSRaphael Isemann if (exe_ctx.HasThreadScope()) { 64027caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64037caa17caSRaphael Isemann if (process && process->IsAlive() && 64047caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 64057caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOut(); 64067caa17caSRaphael Isemann } 64077caa17caSRaphael Isemann } 64087caa17caSRaphael Isemann return MenuActionResult::Handled; 64097caa17caSRaphael Isemann 64107caa17caSRaphael Isemann case eMenuID_ThreadStepOver: { 64117caa17caSRaphael Isemann ExecutionContext exe_ctx = 64127caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64137caa17caSRaphael Isemann if (exe_ctx.HasThreadScope()) { 64147caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64157caa17caSRaphael Isemann if (process && process->IsAlive() && 64167caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 64177caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOver(true); 64187caa17caSRaphael Isemann } 64197caa17caSRaphael Isemann } 64207caa17caSRaphael Isemann return MenuActionResult::Handled; 64217caa17caSRaphael Isemann 64220321dbc8SOmar Emara case eMenuID_ProcessAttach: { 64230321dbc8SOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 64240321dbc8SOmar Emara FormDelegateSP form_delegate_sp = FormDelegateSP( 64250321dbc8SOmar Emara new ProcessAttachFormDelegate(m_debugger, main_window_sp)); 64260321dbc8SOmar Emara Rect bounds = main_window_sp->GetCenteredRect(80, 22); 64270321dbc8SOmar Emara WindowSP form_window_sp = main_window_sp->CreateSubWindow( 64280321dbc8SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 64290321dbc8SOmar Emara WindowDelegateSP window_delegate_sp = 64300321dbc8SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 64310321dbc8SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 64320321dbc8SOmar Emara return MenuActionResult::Handled; 64330321dbc8SOmar Emara } 643482507f17SOmar Emara case eMenuID_ProcessLaunch: { 643582507f17SOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 643682507f17SOmar Emara FormDelegateSP form_delegate_sp = FormDelegateSP( 643782507f17SOmar Emara new ProcessLaunchFormDelegate(m_debugger, main_window_sp)); 643882507f17SOmar Emara Rect bounds = main_window_sp->GetCenteredRect(80, 22); 643982507f17SOmar Emara WindowSP form_window_sp = main_window_sp->CreateSubWindow( 644082507f17SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 644182507f17SOmar Emara WindowDelegateSP window_delegate_sp = 644282507f17SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 644382507f17SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 644482507f17SOmar Emara return MenuActionResult::Handled; 644582507f17SOmar Emara } 64460321dbc8SOmar Emara 64477caa17caSRaphael Isemann case eMenuID_ProcessContinue: { 64487caa17caSRaphael Isemann ExecutionContext exe_ctx = 64497caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64507caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 64517caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64527caa17caSRaphael Isemann if (process && process->IsAlive() && 64537caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 64547caa17caSRaphael Isemann process->Resume(); 64557caa17caSRaphael Isemann } 64567caa17caSRaphael Isemann } 64577caa17caSRaphael Isemann return MenuActionResult::Handled; 64587caa17caSRaphael Isemann 64597caa17caSRaphael Isemann case eMenuID_ProcessKill: { 64607caa17caSRaphael Isemann ExecutionContext exe_ctx = 64617caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64627caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 64637caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64647caa17caSRaphael Isemann if (process && process->IsAlive()) 64657caa17caSRaphael Isemann process->Destroy(false); 64667caa17caSRaphael Isemann } 64677caa17caSRaphael Isemann } 64687caa17caSRaphael Isemann return MenuActionResult::Handled; 64697caa17caSRaphael Isemann 64707caa17caSRaphael Isemann case eMenuID_ProcessHalt: { 64717caa17caSRaphael Isemann ExecutionContext exe_ctx = 64727caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64737caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 64747caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64757caa17caSRaphael Isemann if (process && process->IsAlive()) 64767caa17caSRaphael Isemann process->Halt(); 64777caa17caSRaphael Isemann } 64787caa17caSRaphael Isemann } 64797caa17caSRaphael Isemann return MenuActionResult::Handled; 64807caa17caSRaphael Isemann 648147d2c7cdSLuboš Luňák case eMenuID_ProcessDetachResume: 648247d2c7cdSLuboš Luňák case eMenuID_ProcessDetachSuspended: { 64837caa17caSRaphael Isemann ExecutionContext exe_ctx = 64847caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64857caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 64867caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64877caa17caSRaphael Isemann if (process && process->IsAlive()) 648847d2c7cdSLuboš Luňák process->Detach(menu.GetIdentifier() == 648947d2c7cdSLuboš Luňák eMenuID_ProcessDetachSuspended); 64907caa17caSRaphael Isemann } 64917caa17caSRaphael Isemann } 64927caa17caSRaphael Isemann return MenuActionResult::Handled; 64937caa17caSRaphael Isemann 64947caa17caSRaphael Isemann case eMenuID_Process: { 64957caa17caSRaphael Isemann // Populate the menu with all of the threads if the process is stopped 64967caa17caSRaphael Isemann // when the Process menu gets selected and is about to display its 64977caa17caSRaphael Isemann // submenu. 64987caa17caSRaphael Isemann Menus &submenus = menu.GetSubmenus(); 64997caa17caSRaphael Isemann ExecutionContext exe_ctx = 65007caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 65017caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 65027caa17caSRaphael Isemann if (process && process->IsAlive() && 65037caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) { 65047caa17caSRaphael Isemann if (submenus.size() == 7) 65057caa17caSRaphael Isemann menu.AddSubmenu(MenuSP(new Menu(Menu::Type::Separator))); 65067caa17caSRaphael Isemann else if (submenus.size() > 8) 65077caa17caSRaphael Isemann submenus.erase(submenus.begin() + 8, submenus.end()); 65087caa17caSRaphael Isemann 65097caa17caSRaphael Isemann ThreadList &threads = process->GetThreadList(); 65107caa17caSRaphael Isemann std::lock_guard<std::recursive_mutex> guard(threads.GetMutex()); 65117caa17caSRaphael Isemann size_t num_threads = threads.GetSize(); 65127caa17caSRaphael Isemann for (size_t i = 0; i < num_threads; ++i) { 65137caa17caSRaphael Isemann ThreadSP thread_sp = threads.GetThreadAtIndex(i); 65147caa17caSRaphael Isemann char menu_char = '\0'; 65157caa17caSRaphael Isemann if (i < 9) 65167caa17caSRaphael Isemann menu_char = '1' + i; 65177caa17caSRaphael Isemann StreamString thread_menu_title; 65187caa17caSRaphael Isemann thread_menu_title.Printf("Thread %u", thread_sp->GetIndexID()); 65197caa17caSRaphael Isemann const char *thread_name = thread_sp->GetName(); 65207caa17caSRaphael Isemann if (thread_name && thread_name[0]) 65217caa17caSRaphael Isemann thread_menu_title.Printf(" %s", thread_name); 65227caa17caSRaphael Isemann else { 65237caa17caSRaphael Isemann const char *queue_name = thread_sp->GetQueueName(); 65247caa17caSRaphael Isemann if (queue_name && queue_name[0]) 65257caa17caSRaphael Isemann thread_menu_title.Printf(" %s", queue_name); 65267caa17caSRaphael Isemann } 65277caa17caSRaphael Isemann menu.AddSubmenu( 65287caa17caSRaphael Isemann MenuSP(new Menu(thread_menu_title.GetString().str().c_str(), 65297caa17caSRaphael Isemann nullptr, menu_char, thread_sp->GetID()))); 65307caa17caSRaphael Isemann } 65317caa17caSRaphael Isemann } else if (submenus.size() > 7) { 65327caa17caSRaphael Isemann // Remove the separator and any other thread submenu items that were 65337caa17caSRaphael Isemann // previously added 65347caa17caSRaphael Isemann submenus.erase(submenus.begin() + 7, submenus.end()); 65357caa17caSRaphael Isemann } 6536b26e1efcSOmar Emara // Since we are adding and removing items we need to recalculate the 6537b26e1efcSOmar Emara // name lengths 65387caa17caSRaphael Isemann menu.RecalculateNameLengths(); 65397caa17caSRaphael Isemann } 65407caa17caSRaphael Isemann return MenuActionResult::Handled; 65417caa17caSRaphael Isemann 65427caa17caSRaphael Isemann case eMenuID_ViewVariables: { 65437caa17caSRaphael Isemann WindowSP main_window_sp = m_app.GetMainWindow(); 65447caa17caSRaphael Isemann WindowSP source_window_sp = main_window_sp->FindSubWindow("Source"); 65457caa17caSRaphael Isemann WindowSP variables_window_sp = main_window_sp->FindSubWindow("Variables"); 65467caa17caSRaphael Isemann WindowSP registers_window_sp = main_window_sp->FindSubWindow("Registers"); 65477caa17caSRaphael Isemann const Rect source_bounds = source_window_sp->GetBounds(); 65487caa17caSRaphael Isemann 65497caa17caSRaphael Isemann if (variables_window_sp) { 65507caa17caSRaphael Isemann const Rect variables_bounds = variables_window_sp->GetBounds(); 65517caa17caSRaphael Isemann 65527caa17caSRaphael Isemann main_window_sp->RemoveSubWindow(variables_window_sp.get()); 65537caa17caSRaphael Isemann 65547caa17caSRaphael Isemann if (registers_window_sp) { 65557caa17caSRaphael Isemann // We have a registers window, so give all the area back to the 65567caa17caSRaphael Isemann // registers window 65577caa17caSRaphael Isemann Rect registers_bounds = variables_bounds; 65587caa17caSRaphael Isemann registers_bounds.size.width = source_bounds.size.width; 65597caa17caSRaphael Isemann registers_window_sp->SetBounds(registers_bounds); 65607caa17caSRaphael Isemann } else { 65617caa17caSRaphael Isemann // We have no registers window showing so give the bottom area back 65627caa17caSRaphael Isemann // to the source view 65637caa17caSRaphael Isemann source_window_sp->Resize(source_bounds.size.width, 65647caa17caSRaphael Isemann source_bounds.size.height + 65657caa17caSRaphael Isemann variables_bounds.size.height); 65667caa17caSRaphael Isemann } 65677caa17caSRaphael Isemann } else { 65687caa17caSRaphael Isemann Rect new_variables_rect; 65697caa17caSRaphael Isemann if (registers_window_sp) { 65707caa17caSRaphael Isemann // We have a registers window so split the area of the registers 65717caa17caSRaphael Isemann // window into two columns where the left hand side will be the 65727caa17caSRaphael Isemann // variables and the right hand side will be the registers 65737caa17caSRaphael Isemann const Rect variables_bounds = registers_window_sp->GetBounds(); 65747caa17caSRaphael Isemann Rect new_registers_rect; 65757caa17caSRaphael Isemann variables_bounds.VerticalSplitPercentage(0.50, new_variables_rect, 65767caa17caSRaphael Isemann new_registers_rect); 65777caa17caSRaphael Isemann registers_window_sp->SetBounds(new_registers_rect); 65787caa17caSRaphael Isemann } else { 65792f1b24b7SLuboš Luňák // No registers window, grab the bottom part of the source window 65807caa17caSRaphael Isemann Rect new_source_rect; 65817caa17caSRaphael Isemann source_bounds.HorizontalSplitPercentage(0.70, new_source_rect, 65827caa17caSRaphael Isemann new_variables_rect); 65837caa17caSRaphael Isemann source_window_sp->SetBounds(new_source_rect); 65847caa17caSRaphael Isemann } 65857caa17caSRaphael Isemann WindowSP new_window_sp = main_window_sp->CreateSubWindow( 65867caa17caSRaphael Isemann "Variables", new_variables_rect, false); 65877caa17caSRaphael Isemann new_window_sp->SetDelegate( 65887caa17caSRaphael Isemann WindowDelegateSP(new FrameVariablesWindowDelegate(m_debugger))); 65897caa17caSRaphael Isemann } 65907caa17caSRaphael Isemann touchwin(stdscr); 65917caa17caSRaphael Isemann } 65927caa17caSRaphael Isemann return MenuActionResult::Handled; 65937caa17caSRaphael Isemann 65947caa17caSRaphael Isemann case eMenuID_ViewRegisters: { 65957caa17caSRaphael Isemann WindowSP main_window_sp = m_app.GetMainWindow(); 65967caa17caSRaphael Isemann WindowSP source_window_sp = main_window_sp->FindSubWindow("Source"); 65977caa17caSRaphael Isemann WindowSP variables_window_sp = main_window_sp->FindSubWindow("Variables"); 65987caa17caSRaphael Isemann WindowSP registers_window_sp = main_window_sp->FindSubWindow("Registers"); 65997caa17caSRaphael Isemann const Rect source_bounds = source_window_sp->GetBounds(); 66007caa17caSRaphael Isemann 66017caa17caSRaphael Isemann if (registers_window_sp) { 66027caa17caSRaphael Isemann if (variables_window_sp) { 66037caa17caSRaphael Isemann const Rect variables_bounds = variables_window_sp->GetBounds(); 66047caa17caSRaphael Isemann 66057caa17caSRaphael Isemann // We have a variables window, so give all the area back to the 66067caa17caSRaphael Isemann // variables window 66077caa17caSRaphael Isemann variables_window_sp->Resize(variables_bounds.size.width + 66087caa17caSRaphael Isemann registers_window_sp->GetWidth(), 66097caa17caSRaphael Isemann variables_bounds.size.height); 66107caa17caSRaphael Isemann } else { 66117caa17caSRaphael Isemann // We have no variables window showing so give the bottom area back 66127caa17caSRaphael Isemann // to the source view 66137caa17caSRaphael Isemann source_window_sp->Resize(source_bounds.size.width, 66147caa17caSRaphael Isemann source_bounds.size.height + 66157caa17caSRaphael Isemann registers_window_sp->GetHeight()); 66167caa17caSRaphael Isemann } 66177caa17caSRaphael Isemann main_window_sp->RemoveSubWindow(registers_window_sp.get()); 66187caa17caSRaphael Isemann } else { 66197caa17caSRaphael Isemann Rect new_regs_rect; 66207caa17caSRaphael Isemann if (variables_window_sp) { 66217caa17caSRaphael Isemann // We have a variables window, split it into two columns where the 66227caa17caSRaphael Isemann // left hand side will be the variables and the right hand side will 66237caa17caSRaphael Isemann // be the registers 66247caa17caSRaphael Isemann const Rect variables_bounds = variables_window_sp->GetBounds(); 66257caa17caSRaphael Isemann Rect new_vars_rect; 66267caa17caSRaphael Isemann variables_bounds.VerticalSplitPercentage(0.50, new_vars_rect, 66277caa17caSRaphael Isemann new_regs_rect); 66287caa17caSRaphael Isemann variables_window_sp->SetBounds(new_vars_rect); 66297caa17caSRaphael Isemann } else { 66302f1b24b7SLuboš Luňák // No variables window, grab the bottom part of the source window 66317caa17caSRaphael Isemann Rect new_source_rect; 66327caa17caSRaphael Isemann source_bounds.HorizontalSplitPercentage(0.70, new_source_rect, 66337caa17caSRaphael Isemann new_regs_rect); 66347caa17caSRaphael Isemann source_window_sp->SetBounds(new_source_rect); 66357caa17caSRaphael Isemann } 66367caa17caSRaphael Isemann WindowSP new_window_sp = 66377caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Registers", new_regs_rect, false); 66387caa17caSRaphael Isemann new_window_sp->SetDelegate( 66397caa17caSRaphael Isemann WindowDelegateSP(new RegistersWindowDelegate(m_debugger))); 66407caa17caSRaphael Isemann } 66417caa17caSRaphael Isemann touchwin(stdscr); 66427caa17caSRaphael Isemann } 66437caa17caSRaphael Isemann return MenuActionResult::Handled; 66447caa17caSRaphael Isemann 6645b26e1efcSOmar Emara case eMenuID_ViewBreakpoints: { 6646b26e1efcSOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 6647b26e1efcSOmar Emara WindowSP threads_window_sp = main_window_sp->FindSubWindow("Threads"); 6648b26e1efcSOmar Emara WindowSP breakpoints_window_sp = 6649b26e1efcSOmar Emara main_window_sp->FindSubWindow("Breakpoints"); 6650b26e1efcSOmar Emara const Rect threads_bounds = threads_window_sp->GetBounds(); 6651b26e1efcSOmar Emara 6652b26e1efcSOmar Emara // If a breakpoints window already exists, remove it and give the area 6653b26e1efcSOmar Emara // it used to occupy to the threads window. If it doesn't exist, split 6654b26e1efcSOmar Emara // the threads window horizontally into two windows where the top window 6655b26e1efcSOmar Emara // is the threads window and the bottom window is a newly added 6656b26e1efcSOmar Emara // breakpoints window. 6657b26e1efcSOmar Emara if (breakpoints_window_sp) { 6658b26e1efcSOmar Emara threads_window_sp->Resize(threads_bounds.size.width, 6659b26e1efcSOmar Emara threads_bounds.size.height + 6660b26e1efcSOmar Emara breakpoints_window_sp->GetHeight()); 6661b26e1efcSOmar Emara main_window_sp->RemoveSubWindow(breakpoints_window_sp.get()); 6662b26e1efcSOmar Emara } else { 6663b26e1efcSOmar Emara Rect new_threads_bounds, breakpoints_bounds; 6664b26e1efcSOmar Emara threads_bounds.HorizontalSplitPercentage(0.70, new_threads_bounds, 6665b26e1efcSOmar Emara breakpoints_bounds); 6666b26e1efcSOmar Emara threads_window_sp->SetBounds(new_threads_bounds); 6667b26e1efcSOmar Emara breakpoints_window_sp = main_window_sp->CreateSubWindow( 6668b26e1efcSOmar Emara "Breakpoints", breakpoints_bounds, false); 6669b26e1efcSOmar Emara TreeDelegateSP breakpoints_delegate_sp( 6670b26e1efcSOmar Emara new BreakpointsTreeDelegate(m_debugger)); 6671b26e1efcSOmar Emara breakpoints_window_sp->SetDelegate(WindowDelegateSP( 6672b26e1efcSOmar Emara new TreeWindowDelegate(m_debugger, breakpoints_delegate_sp))); 6673b26e1efcSOmar Emara } 6674b26e1efcSOmar Emara touchwin(stdscr); 6675b26e1efcSOmar Emara return MenuActionResult::Handled; 6676b26e1efcSOmar Emara } 6677b26e1efcSOmar Emara 66787caa17caSRaphael Isemann case eMenuID_HelpGUIHelp: 66797caa17caSRaphael Isemann m_app.GetMainWindow()->CreateHelpSubwindow(); 66807caa17caSRaphael Isemann return MenuActionResult::Handled; 66817caa17caSRaphael Isemann 66827caa17caSRaphael Isemann default: 66837caa17caSRaphael Isemann break; 66847caa17caSRaphael Isemann } 66857caa17caSRaphael Isemann 66867caa17caSRaphael Isemann return MenuActionResult::NotHandled; 66877caa17caSRaphael Isemann } 66887caa17caSRaphael Isemann 66897caa17caSRaphael Isemann protected: 66907caa17caSRaphael Isemann Application &m_app; 66917caa17caSRaphael Isemann Debugger &m_debugger; 66927caa17caSRaphael Isemann }; 66937caa17caSRaphael Isemann 66947caa17caSRaphael Isemann class StatusBarWindowDelegate : public WindowDelegate { 66957caa17caSRaphael Isemann public: 66967caa17caSRaphael Isemann StatusBarWindowDelegate(Debugger &debugger) : m_debugger(debugger) { 66977caa17caSRaphael Isemann FormatEntity::Parse("Thread: ${thread.id%tid}", m_format); 66987caa17caSRaphael Isemann } 66997caa17caSRaphael Isemann 67007caa17caSRaphael Isemann ~StatusBarWindowDelegate() override = default; 67017caa17caSRaphael Isemann 67027caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 67037caa17caSRaphael Isemann ExecutionContext exe_ctx = 67047caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 67057caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 67067caa17caSRaphael Isemann Thread *thread = exe_ctx.GetThreadPtr(); 67077caa17caSRaphael Isemann StackFrame *frame = exe_ctx.GetFramePtr(); 67087caa17caSRaphael Isemann window.Erase(); 67094a8e4b5cSLuboš Luňák window.SetBackground(BlackOnWhite); 67107caa17caSRaphael Isemann window.MoveCursor(0, 0); 67117caa17caSRaphael Isemann if (process) { 67127caa17caSRaphael Isemann const StateType state = process->GetState(); 67137caa17caSRaphael Isemann window.Printf("Process: %5" PRIu64 " %10s", process->GetID(), 67147caa17caSRaphael Isemann StateAsCString(state)); 67157caa17caSRaphael Isemann 67167caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 67177caa17caSRaphael Isemann StreamString strm; 67187caa17caSRaphael Isemann if (thread && FormatEntity::Format(m_format, strm, nullptr, &exe_ctx, 67197caa17caSRaphael Isemann nullptr, nullptr, false, false)) { 67207caa17caSRaphael Isemann window.MoveCursor(40, 0); 6721fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, strm.GetString().str().c_str()); 67227caa17caSRaphael Isemann } 67237caa17caSRaphael Isemann 67247caa17caSRaphael Isemann window.MoveCursor(60, 0); 67257caa17caSRaphael Isemann if (frame) 67267caa17caSRaphael Isemann window.Printf("Frame: %3u PC = 0x%16.16" PRIx64, 67277caa17caSRaphael Isemann frame->GetFrameIndex(), 67287caa17caSRaphael Isemann frame->GetFrameCodeAddress().GetOpcodeLoadAddress( 67297caa17caSRaphael Isemann exe_ctx.GetTargetPtr())); 67307caa17caSRaphael Isemann } else if (state == eStateExited) { 67317caa17caSRaphael Isemann const char *exit_desc = process->GetExitDescription(); 67327caa17caSRaphael Isemann const int exit_status = process->GetExitStatus(); 67337caa17caSRaphael Isemann if (exit_desc && exit_desc[0]) 67347caa17caSRaphael Isemann window.Printf(" with status = %i (%s)", exit_status, exit_desc); 67357caa17caSRaphael Isemann else 67367caa17caSRaphael Isemann window.Printf(" with status = %i", exit_status); 67377caa17caSRaphael Isemann } 67387caa17caSRaphael Isemann } 67397caa17caSRaphael Isemann return true; 67407caa17caSRaphael Isemann } 67417caa17caSRaphael Isemann 67427caa17caSRaphael Isemann protected: 67437caa17caSRaphael Isemann Debugger &m_debugger; 67447caa17caSRaphael Isemann FormatEntity::Entry m_format; 67457caa17caSRaphael Isemann }; 67467caa17caSRaphael Isemann 67477caa17caSRaphael Isemann class SourceFileWindowDelegate : public WindowDelegate { 67487caa17caSRaphael Isemann public: 67497caa17caSRaphael Isemann SourceFileWindowDelegate(Debugger &debugger) 67507caa17caSRaphael Isemann : WindowDelegate(), m_debugger(debugger), m_sc(), m_file_sp(), 675128c878aeSShafik Yaghmour m_disassembly_sp(), m_disassembly_range(), m_title() {} 67527caa17caSRaphael Isemann 67537caa17caSRaphael Isemann ~SourceFileWindowDelegate() override = default; 67547caa17caSRaphael Isemann 67557caa17caSRaphael Isemann void Update(const SymbolContext &sc) { m_sc = sc; } 67567caa17caSRaphael Isemann 67577caa17caSRaphael Isemann uint32_t NumVisibleLines() const { return m_max_y - m_min_y; } 67587caa17caSRaphael Isemann 67597caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 67607caa17caSRaphael Isemann return "Source/Disassembly window keyboard shortcuts:"; 67617caa17caSRaphael Isemann } 67627caa17caSRaphael Isemann 67637caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 67647caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 67657caa17caSRaphael Isemann {KEY_RETURN, "Run to selected line with one shot breakpoint"}, 67667caa17caSRaphael Isemann {KEY_UP, "Select previous source line"}, 67677caa17caSRaphael Isemann {KEY_DOWN, "Select next source line"}, 6768dcd4589aSLuboš Luňák {KEY_LEFT, "Scroll to the left"}, 6769dcd4589aSLuboš Luňák {KEY_RIGHT, "Scroll to the right"}, 67707caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 67717caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 67727caa17caSRaphael Isemann {'b', "Set breakpoint on selected source/disassembly line"}, 67737caa17caSRaphael Isemann {'c', "Continue process"}, 67747caa17caSRaphael Isemann {'D', "Detach with process suspended"}, 67757caa17caSRaphael Isemann {'h', "Show help dialog"}, 67767caa17caSRaphael Isemann {'n', "Step over (source line)"}, 67777caa17caSRaphael Isemann {'N', "Step over (single instruction)"}, 6778336c7029SLuboš Luňák {'f', "Step out (finish)"}, 67797caa17caSRaphael Isemann {'s', "Step in (source line)"}, 67807caa17caSRaphael Isemann {'S', "Step in (single instruction)"}, 678113978643SLuboš Luňák {'u', "Frame up"}, 678213978643SLuboš Luňák {'d', "Frame down"}, 67837caa17caSRaphael Isemann {',', "Page up"}, 67847caa17caSRaphael Isemann {'.', "Page down"}, 67857caa17caSRaphael Isemann {'\0', nullptr}}; 67867caa17caSRaphael Isemann return g_source_view_key_help; 67877caa17caSRaphael Isemann } 67887caa17caSRaphael Isemann 67897caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 67907caa17caSRaphael Isemann ExecutionContext exe_ctx = 67917caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 67927caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 67937caa17caSRaphael Isemann Thread *thread = nullptr; 67947caa17caSRaphael Isemann 67957caa17caSRaphael Isemann bool update_location = false; 67967caa17caSRaphael Isemann if (process) { 67977caa17caSRaphael Isemann StateType state = process->GetState(); 67987caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 67997caa17caSRaphael Isemann // We are stopped, so it is ok to 68007caa17caSRaphael Isemann update_location = true; 68017caa17caSRaphael Isemann } 68027caa17caSRaphael Isemann } 68037caa17caSRaphael Isemann 68047caa17caSRaphael Isemann m_min_x = 1; 68057caa17caSRaphael Isemann m_min_y = 2; 68067caa17caSRaphael Isemann m_max_x = window.GetMaxX() - 1; 68077caa17caSRaphael Isemann m_max_y = window.GetMaxY() - 1; 68087caa17caSRaphael Isemann 68097caa17caSRaphael Isemann const uint32_t num_visible_lines = NumVisibleLines(); 68107caa17caSRaphael Isemann StackFrameSP frame_sp; 68117caa17caSRaphael Isemann bool set_selected_line_to_pc = false; 68127caa17caSRaphael Isemann 68137caa17caSRaphael Isemann if (update_location) { 68147caa17caSRaphael Isemann const bool process_alive = process ? process->IsAlive() : false; 68157caa17caSRaphael Isemann bool thread_changed = false; 68167caa17caSRaphael Isemann if (process_alive) { 68177caa17caSRaphael Isemann thread = exe_ctx.GetThreadPtr(); 68187caa17caSRaphael Isemann if (thread) { 68197caa17caSRaphael Isemann frame_sp = thread->GetSelectedFrame(); 68207caa17caSRaphael Isemann auto tid = thread->GetID(); 68217caa17caSRaphael Isemann thread_changed = tid != m_tid; 68227caa17caSRaphael Isemann m_tid = tid; 68237caa17caSRaphael Isemann } else { 68247caa17caSRaphael Isemann if (m_tid != LLDB_INVALID_THREAD_ID) { 68257caa17caSRaphael Isemann thread_changed = true; 68267caa17caSRaphael Isemann m_tid = LLDB_INVALID_THREAD_ID; 68277caa17caSRaphael Isemann } 68287caa17caSRaphael Isemann } 68297caa17caSRaphael Isemann } 68307caa17caSRaphael Isemann const uint32_t stop_id = process ? process->GetStopID() : 0; 68317caa17caSRaphael Isemann const bool stop_id_changed = stop_id != m_stop_id; 68327caa17caSRaphael Isemann bool frame_changed = false; 68337caa17caSRaphael Isemann m_stop_id = stop_id; 68347caa17caSRaphael Isemann m_title.Clear(); 68357caa17caSRaphael Isemann if (frame_sp) { 68367caa17caSRaphael Isemann m_sc = frame_sp->GetSymbolContext(eSymbolContextEverything); 68377caa17caSRaphael Isemann if (m_sc.module_sp) { 68387caa17caSRaphael Isemann m_title.Printf( 68397caa17caSRaphael Isemann "%s", m_sc.module_sp->GetFileSpec().GetFilename().GetCString()); 68407caa17caSRaphael Isemann ConstString func_name = m_sc.GetFunctionName(); 68417caa17caSRaphael Isemann if (func_name) 68427caa17caSRaphael Isemann m_title.Printf("`%s", func_name.GetCString()); 68437caa17caSRaphael Isemann } 68447caa17caSRaphael Isemann const uint32_t frame_idx = frame_sp->GetFrameIndex(); 68457caa17caSRaphael Isemann frame_changed = frame_idx != m_frame_idx; 68467caa17caSRaphael Isemann m_frame_idx = frame_idx; 68477caa17caSRaphael Isemann } else { 68487caa17caSRaphael Isemann m_sc.Clear(true); 68497caa17caSRaphael Isemann frame_changed = m_frame_idx != UINT32_MAX; 68507caa17caSRaphael Isemann m_frame_idx = UINT32_MAX; 68517caa17caSRaphael Isemann } 68527caa17caSRaphael Isemann 68537caa17caSRaphael Isemann const bool context_changed = 68547caa17caSRaphael Isemann thread_changed || frame_changed || stop_id_changed; 68557caa17caSRaphael Isemann 68567caa17caSRaphael Isemann if (process_alive) { 68577caa17caSRaphael Isemann if (m_sc.line_entry.IsValid()) { 68587caa17caSRaphael Isemann m_pc_line = m_sc.line_entry.line; 68597caa17caSRaphael Isemann if (m_pc_line != UINT32_MAX) 68607caa17caSRaphael Isemann --m_pc_line; // Convert to zero based line number... 68617caa17caSRaphael Isemann // Update the selected line if the stop ID changed... 68627caa17caSRaphael Isemann if (context_changed) 68637caa17caSRaphael Isemann m_selected_line = m_pc_line; 68647caa17caSRaphael Isemann 6865532290e6SPavel Labath if (m_file_sp && m_file_sp->GetFileSpec() == m_sc.line_entry.file) { 6866b26e1efcSOmar Emara // Same file, nothing to do, we should either have the lines or 6867b26e1efcSOmar Emara // not (source file missing) 68687caa17caSRaphael Isemann if (m_selected_line >= static_cast<size_t>(m_first_visible_line)) { 68697caa17caSRaphael Isemann if (m_selected_line >= m_first_visible_line + num_visible_lines) 68707caa17caSRaphael Isemann m_first_visible_line = m_selected_line - 10; 68717caa17caSRaphael Isemann } else { 68727caa17caSRaphael Isemann if (m_selected_line > 10) 68737caa17caSRaphael Isemann m_first_visible_line = m_selected_line - 10; 68747caa17caSRaphael Isemann else 68757caa17caSRaphael Isemann m_first_visible_line = 0; 68767caa17caSRaphael Isemann } 68777caa17caSRaphael Isemann } else { 68787caa17caSRaphael Isemann // File changed, set selected line to the line with the PC 68797caa17caSRaphael Isemann m_selected_line = m_pc_line; 68807caa17caSRaphael Isemann m_file_sp = 68817caa17caSRaphael Isemann m_debugger.GetSourceManager().GetFile(m_sc.line_entry.file); 68827caa17caSRaphael Isemann if (m_file_sp) { 68837caa17caSRaphael Isemann const size_t num_lines = m_file_sp->GetNumLines(); 68847caa17caSRaphael Isemann m_line_width = 1; 68857caa17caSRaphael Isemann for (size_t n = num_lines; n >= 10; n = n / 10) 68867caa17caSRaphael Isemann ++m_line_width; 68877caa17caSRaphael Isemann 68887caa17caSRaphael Isemann if (num_lines < num_visible_lines || 68897caa17caSRaphael Isemann m_selected_line < num_visible_lines) 68907caa17caSRaphael Isemann m_first_visible_line = 0; 68917caa17caSRaphael Isemann else 68927caa17caSRaphael Isemann m_first_visible_line = m_selected_line - 10; 68937caa17caSRaphael Isemann } 68947caa17caSRaphael Isemann } 68957caa17caSRaphael Isemann } else { 68967caa17caSRaphael Isemann m_file_sp.reset(); 68977caa17caSRaphael Isemann } 68987caa17caSRaphael Isemann 68997caa17caSRaphael Isemann if (!m_file_sp || m_file_sp->GetNumLines() == 0) { 69007caa17caSRaphael Isemann // Show disassembly 69017caa17caSRaphael Isemann bool prefer_file_cache = false; 69027caa17caSRaphael Isemann if (m_sc.function) { 69037caa17caSRaphael Isemann if (m_disassembly_scope != m_sc.function) { 69047caa17caSRaphael Isemann m_disassembly_scope = m_sc.function; 69057caa17caSRaphael Isemann m_disassembly_sp = m_sc.function->GetInstructions( 6906e9fe788dSJason Molenda exe_ctx, nullptr, !prefer_file_cache); 69077caa17caSRaphael Isemann if (m_disassembly_sp) { 69087caa17caSRaphael Isemann set_selected_line_to_pc = true; 69097caa17caSRaphael Isemann m_disassembly_range = m_sc.function->GetAddressRange(); 69107caa17caSRaphael Isemann } else { 69117caa17caSRaphael Isemann m_disassembly_range.Clear(); 69127caa17caSRaphael Isemann } 69137caa17caSRaphael Isemann } else { 69147caa17caSRaphael Isemann set_selected_line_to_pc = context_changed; 69157caa17caSRaphael Isemann } 69167caa17caSRaphael Isemann } else if (m_sc.symbol) { 69177caa17caSRaphael Isemann if (m_disassembly_scope != m_sc.symbol) { 69187caa17caSRaphael Isemann m_disassembly_scope = m_sc.symbol; 69197caa17caSRaphael Isemann m_disassembly_sp = m_sc.symbol->GetInstructions( 69207caa17caSRaphael Isemann exe_ctx, nullptr, prefer_file_cache); 69217caa17caSRaphael Isemann if (m_disassembly_sp) { 69227caa17caSRaphael Isemann set_selected_line_to_pc = true; 69237caa17caSRaphael Isemann m_disassembly_range.GetBaseAddress() = 69247caa17caSRaphael Isemann m_sc.symbol->GetAddress(); 69257caa17caSRaphael Isemann m_disassembly_range.SetByteSize(m_sc.symbol->GetByteSize()); 69267caa17caSRaphael Isemann } else { 69277caa17caSRaphael Isemann m_disassembly_range.Clear(); 69287caa17caSRaphael Isemann } 69297caa17caSRaphael Isemann } else { 69307caa17caSRaphael Isemann set_selected_line_to_pc = context_changed; 69317caa17caSRaphael Isemann } 69327caa17caSRaphael Isemann } 69337caa17caSRaphael Isemann } 69347caa17caSRaphael Isemann } else { 69357caa17caSRaphael Isemann m_pc_line = UINT32_MAX; 69367caa17caSRaphael Isemann } 69377caa17caSRaphael Isemann } 69387caa17caSRaphael Isemann 69397caa17caSRaphael Isemann const int window_width = window.GetWidth(); 69407caa17caSRaphael Isemann window.Erase(); 69417caa17caSRaphael Isemann window.DrawTitleBox("Sources"); 69427caa17caSRaphael Isemann if (!m_title.GetString().empty()) { 69437caa17caSRaphael Isemann window.AttributeOn(A_REVERSE); 69447caa17caSRaphael Isemann window.MoveCursor(1, 1); 69457caa17caSRaphael Isemann window.PutChar(' '); 6946fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, m_title.GetString().str().c_str()); 69477caa17caSRaphael Isemann int x = window.GetCursorX(); 69487caa17caSRaphael Isemann if (x < window_width - 1) { 69497caa17caSRaphael Isemann window.Printf("%*s", window_width - x - 1, ""); 69507caa17caSRaphael Isemann } 69517caa17caSRaphael Isemann window.AttributeOff(A_REVERSE); 69527caa17caSRaphael Isemann } 69537caa17caSRaphael Isemann 69547caa17caSRaphael Isemann Target *target = exe_ctx.GetTargetPtr(); 69557caa17caSRaphael Isemann const size_t num_source_lines = GetNumSourceLines(); 69567caa17caSRaphael Isemann if (num_source_lines > 0) { 69577caa17caSRaphael Isemann // Display source 69587caa17caSRaphael Isemann BreakpointLines bp_lines; 69597caa17caSRaphael Isemann if (target) { 69607caa17caSRaphael Isemann BreakpointList &bp_list = target->GetBreakpointList(); 69617caa17caSRaphael Isemann const size_t num_bps = bp_list.GetSize(); 69627caa17caSRaphael Isemann for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 69637caa17caSRaphael Isemann BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 69647caa17caSRaphael Isemann const size_t num_bps_locs = bp_sp->GetNumLocations(); 69657caa17caSRaphael Isemann for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; ++bp_loc_idx) { 69667caa17caSRaphael Isemann BreakpointLocationSP bp_loc_sp = 69677caa17caSRaphael Isemann bp_sp->GetLocationAtIndex(bp_loc_idx); 69687caa17caSRaphael Isemann LineEntry bp_loc_line_entry; 69697caa17caSRaphael Isemann if (bp_loc_sp->GetAddress().CalculateSymbolContextLineEntry( 69707caa17caSRaphael Isemann bp_loc_line_entry)) { 69717caa17caSRaphael Isemann if (m_file_sp->GetFileSpec() == bp_loc_line_entry.file) { 69727caa17caSRaphael Isemann bp_lines.insert(bp_loc_line_entry.line); 69737caa17caSRaphael Isemann } 69747caa17caSRaphael Isemann } 69757caa17caSRaphael Isemann } 69767caa17caSRaphael Isemann } 69777caa17caSRaphael Isemann } 69787caa17caSRaphael Isemann 69797caa17caSRaphael Isemann for (size_t i = 0; i < num_visible_lines; ++i) { 69807caa17caSRaphael Isemann const uint32_t curr_line = m_first_visible_line + i; 69817caa17caSRaphael Isemann if (curr_line < num_source_lines) { 69827caa17caSRaphael Isemann const int line_y = m_min_y + i; 69837caa17caSRaphael Isemann window.MoveCursor(1, line_y); 69847caa17caSRaphael Isemann const bool is_pc_line = curr_line == m_pc_line; 69857caa17caSRaphael Isemann const bool line_is_selected = m_selected_line == curr_line; 69865c540c75SLuboš Luňák // Highlight the line as the PC line first (done by passing 69875c540c75SLuboš Luňák // argument to OutputColoredStringTruncated()), then if the selected 69885c540c75SLuboš Luňák // line isn't the same as the PC line, highlight it differently. 69897caa17caSRaphael Isemann attr_t highlight_attr = 0; 69907caa17caSRaphael Isemann attr_t bp_attr = 0; 69915c540c75SLuboš Luňák if (line_is_selected && !is_pc_line) 69925c540c75SLuboš Luňák highlight_attr = A_REVERSE; 69937caa17caSRaphael Isemann 69947caa17caSRaphael Isemann if (bp_lines.find(curr_line + 1) != bp_lines.end()) 69954a8e4b5cSLuboš Luňák bp_attr = COLOR_PAIR(BlackOnWhite); 69967caa17caSRaphael Isemann 69977caa17caSRaphael Isemann if (bp_attr) 69987caa17caSRaphael Isemann window.AttributeOn(bp_attr); 69997caa17caSRaphael Isemann 70007caa17caSRaphael Isemann window.Printf(" %*u ", m_line_width, curr_line + 1); 70017caa17caSRaphael Isemann 70027caa17caSRaphael Isemann if (bp_attr) 70037caa17caSRaphael Isemann window.AttributeOff(bp_attr); 70047caa17caSRaphael Isemann 70057caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 70067caa17caSRaphael Isemann // Mark the line with the PC with a diamond 70077caa17caSRaphael Isemann if (is_pc_line) 70087caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 70097caa17caSRaphael Isemann else 70107caa17caSRaphael Isemann window.PutChar(' '); 70117caa17caSRaphael Isemann 70127caa17caSRaphael Isemann if (highlight_attr) 70137caa17caSRaphael Isemann window.AttributeOn(highlight_attr); 701414406ca0SLuboš Luňák 701514406ca0SLuboš Luňák StreamString lineStream; 701614406ca0SLuboš Luňák m_file_sp->DisplaySourceLines(curr_line + 1, {}, 0, 0, &lineStream); 701714406ca0SLuboš Luňák StringRef line = lineStream.GetString(); 701814406ca0SLuboš Luňák if (line.endswith("\n")) 701914406ca0SLuboš Luňák line = line.drop_back(); 7020dcd4589aSLuboš Luňák bool wasWritten = window.OutputColoredStringTruncated( 70215c540c75SLuboš Luňák 1, line, m_first_visible_column, is_pc_line); 702211b6d2f9SLuboš Luňák if (!wasWritten && (line_is_selected || is_pc_line)) { 702311b6d2f9SLuboš Luňák // Draw an empty space to show the selected/PC line if empty, 7024dcd4589aSLuboš Luňák // or draw '<' if nothing is visible because of scrolling too much 7025dcd4589aSLuboš Luňák // to the right. 7026dcd4589aSLuboš Luňák window.PutCStringTruncated( 7027dcd4589aSLuboš Luňák 1, line.empty() && m_first_visible_column == 0 ? " " : "<"); 7028dcd4589aSLuboš Luňák } 70297caa17caSRaphael Isemann 70307caa17caSRaphael Isemann if (is_pc_line && frame_sp && 70317caa17caSRaphael Isemann frame_sp->GetConcreteFrameIndex() == 0) { 70327caa17caSRaphael Isemann StopInfoSP stop_info_sp; 70337caa17caSRaphael Isemann if (thread) 70347caa17caSRaphael Isemann stop_info_sp = thread->GetStopInfo(); 70357caa17caSRaphael Isemann if (stop_info_sp) { 70367caa17caSRaphael Isemann const char *stop_description = stop_info_sp->GetDescription(); 70377caa17caSRaphael Isemann if (stop_description && stop_description[0]) { 70387caa17caSRaphael Isemann size_t stop_description_len = strlen(stop_description); 70397caa17caSRaphael Isemann int desc_x = window_width - stop_description_len - 16; 7040fc0e8fb7SLuboš Luňák if (desc_x - window.GetCursorX() > 0) 70417caa17caSRaphael Isemann window.Printf("%*s", desc_x - window.GetCursorX(), ""); 704214406ca0SLuboš Luňák window.MoveCursor(window_width - stop_description_len - 16, 7043fc0e8fb7SLuboš Luňák line_y); 70444a8e4b5cSLuboš Luňák const attr_t stop_reason_attr = COLOR_PAIR(WhiteOnBlue); 704514406ca0SLuboš Luňák window.AttributeOn(stop_reason_attr); 7046fc0e8fb7SLuboš Luňák window.PrintfTruncated(1, " <<< Thread %u: %s ", 7047fc0e8fb7SLuboš Luňák thread->GetIndexID(), stop_description); 704814406ca0SLuboš Luňák window.AttributeOff(stop_reason_attr); 70497caa17caSRaphael Isemann } 70507caa17caSRaphael Isemann } else { 70517caa17caSRaphael Isemann window.Printf("%*s", window_width - window.GetCursorX() - 1, ""); 70527caa17caSRaphael Isemann } 70537caa17caSRaphael Isemann } 70547caa17caSRaphael Isemann if (highlight_attr) 70557caa17caSRaphael Isemann window.AttributeOff(highlight_attr); 70567caa17caSRaphael Isemann } else { 70577caa17caSRaphael Isemann break; 70587caa17caSRaphael Isemann } 70597caa17caSRaphael Isemann } 70607caa17caSRaphael Isemann } else { 70617caa17caSRaphael Isemann size_t num_disassembly_lines = GetNumDisassemblyLines(); 70627caa17caSRaphael Isemann if (num_disassembly_lines > 0) { 70637caa17caSRaphael Isemann // Display disassembly 70647caa17caSRaphael Isemann BreakpointAddrs bp_file_addrs; 70657caa17caSRaphael Isemann Target *target = exe_ctx.GetTargetPtr(); 70667caa17caSRaphael Isemann if (target) { 70677caa17caSRaphael Isemann BreakpointList &bp_list = target->GetBreakpointList(); 70687caa17caSRaphael Isemann const size_t num_bps = bp_list.GetSize(); 70697caa17caSRaphael Isemann for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 70707caa17caSRaphael Isemann BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 70717caa17caSRaphael Isemann const size_t num_bps_locs = bp_sp->GetNumLocations(); 70727caa17caSRaphael Isemann for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; 70737caa17caSRaphael Isemann ++bp_loc_idx) { 70747caa17caSRaphael Isemann BreakpointLocationSP bp_loc_sp = 70757caa17caSRaphael Isemann bp_sp->GetLocationAtIndex(bp_loc_idx); 70767caa17caSRaphael Isemann LineEntry bp_loc_line_entry; 70777caa17caSRaphael Isemann const lldb::addr_t file_addr = 70787caa17caSRaphael Isemann bp_loc_sp->GetAddress().GetFileAddress(); 70797caa17caSRaphael Isemann if (file_addr != LLDB_INVALID_ADDRESS) { 70807caa17caSRaphael Isemann if (m_disassembly_range.ContainsFileAddress(file_addr)) 70817caa17caSRaphael Isemann bp_file_addrs.insert(file_addr); 70827caa17caSRaphael Isemann } 70837caa17caSRaphael Isemann } 70847caa17caSRaphael Isemann } 70857caa17caSRaphael Isemann } 70867caa17caSRaphael Isemann 70877caa17caSRaphael Isemann const attr_t selected_highlight_attr = A_REVERSE; 70884a8e4b5cSLuboš Luňák const attr_t pc_highlight_attr = COLOR_PAIR(WhiteOnBlue); 70897caa17caSRaphael Isemann 70907caa17caSRaphael Isemann StreamString strm; 70917caa17caSRaphael Isemann 70927caa17caSRaphael Isemann InstructionList &insts = m_disassembly_sp->GetInstructionList(); 70937caa17caSRaphael Isemann Address pc_address; 70947caa17caSRaphael Isemann 70957caa17caSRaphael Isemann if (frame_sp) 70967caa17caSRaphael Isemann pc_address = frame_sp->GetFrameCodeAddress(); 70977caa17caSRaphael Isemann const uint32_t pc_idx = 70987caa17caSRaphael Isemann pc_address.IsValid() 70997caa17caSRaphael Isemann ? insts.GetIndexOfInstructionAtAddress(pc_address) 71007caa17caSRaphael Isemann : UINT32_MAX; 71017caa17caSRaphael Isemann if (set_selected_line_to_pc) { 71027caa17caSRaphael Isemann m_selected_line = pc_idx; 71037caa17caSRaphael Isemann } 71047caa17caSRaphael Isemann 71057caa17caSRaphael Isemann const uint32_t non_visible_pc_offset = (num_visible_lines / 5); 71067caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) >= num_disassembly_lines) 71077caa17caSRaphael Isemann m_first_visible_line = 0; 71087caa17caSRaphael Isemann 71097caa17caSRaphael Isemann if (pc_idx < num_disassembly_lines) { 71107caa17caSRaphael Isemann if (pc_idx < static_cast<uint32_t>(m_first_visible_line) || 71117caa17caSRaphael Isemann pc_idx >= m_first_visible_line + num_visible_lines) 71127caa17caSRaphael Isemann m_first_visible_line = pc_idx - non_visible_pc_offset; 71137caa17caSRaphael Isemann } 71147caa17caSRaphael Isemann 71157caa17caSRaphael Isemann for (size_t i = 0; i < num_visible_lines; ++i) { 71167caa17caSRaphael Isemann const uint32_t inst_idx = m_first_visible_line + i; 71177caa17caSRaphael Isemann Instruction *inst = insts.GetInstructionAtIndex(inst_idx).get(); 71187caa17caSRaphael Isemann if (!inst) 71197caa17caSRaphael Isemann break; 71207caa17caSRaphael Isemann 71217caa17caSRaphael Isemann const int line_y = m_min_y + i; 71227caa17caSRaphael Isemann window.MoveCursor(1, line_y); 71237caa17caSRaphael Isemann const bool is_pc_line = frame_sp && inst_idx == pc_idx; 71247caa17caSRaphael Isemann const bool line_is_selected = m_selected_line == inst_idx; 7125b26e1efcSOmar Emara // Highlight the line as the PC line first, then if the selected 7126b26e1efcSOmar Emara // line isn't the same as the PC line, highlight it differently 71277caa17caSRaphael Isemann attr_t highlight_attr = 0; 71287caa17caSRaphael Isemann attr_t bp_attr = 0; 71297caa17caSRaphael Isemann if (is_pc_line) 71307caa17caSRaphael Isemann highlight_attr = pc_highlight_attr; 71317caa17caSRaphael Isemann else if (line_is_selected) 71327caa17caSRaphael Isemann highlight_attr = selected_highlight_attr; 71337caa17caSRaphael Isemann 71347caa17caSRaphael Isemann if (bp_file_addrs.find(inst->GetAddress().GetFileAddress()) != 71357caa17caSRaphael Isemann bp_file_addrs.end()) 71364a8e4b5cSLuboš Luňák bp_attr = COLOR_PAIR(BlackOnWhite); 71377caa17caSRaphael Isemann 71387caa17caSRaphael Isemann if (bp_attr) 71397caa17caSRaphael Isemann window.AttributeOn(bp_attr); 71407caa17caSRaphael Isemann 71417caa17caSRaphael Isemann window.Printf(" 0x%16.16llx ", 71427caa17caSRaphael Isemann static_cast<unsigned long long>( 71437caa17caSRaphael Isemann inst->GetAddress().GetLoadAddress(target))); 71447caa17caSRaphael Isemann 71457caa17caSRaphael Isemann if (bp_attr) 71467caa17caSRaphael Isemann window.AttributeOff(bp_attr); 71477caa17caSRaphael Isemann 71487caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 71497caa17caSRaphael Isemann // Mark the line with the PC with a diamond 71507caa17caSRaphael Isemann if (is_pc_line) 71517caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 71527caa17caSRaphael Isemann else 71537caa17caSRaphael Isemann window.PutChar(' '); 71547caa17caSRaphael Isemann 71557caa17caSRaphael Isemann if (highlight_attr) 71567caa17caSRaphael Isemann window.AttributeOn(highlight_attr); 71577caa17caSRaphael Isemann 71587caa17caSRaphael Isemann const char *mnemonic = inst->GetMnemonic(&exe_ctx); 71597caa17caSRaphael Isemann const char *operands = inst->GetOperands(&exe_ctx); 71607caa17caSRaphael Isemann const char *comment = inst->GetComment(&exe_ctx); 71617caa17caSRaphael Isemann 71627caa17caSRaphael Isemann if (mnemonic != nullptr && mnemonic[0] == '\0') 71637caa17caSRaphael Isemann mnemonic = nullptr; 71647caa17caSRaphael Isemann if (operands != nullptr && operands[0] == '\0') 71657caa17caSRaphael Isemann operands = nullptr; 71667caa17caSRaphael Isemann if (comment != nullptr && comment[0] == '\0') 71677caa17caSRaphael Isemann comment = nullptr; 71687caa17caSRaphael Isemann 71697caa17caSRaphael Isemann strm.Clear(); 71707caa17caSRaphael Isemann 71717caa17caSRaphael Isemann if (mnemonic != nullptr && operands != nullptr && comment != nullptr) 71727caa17caSRaphael Isemann strm.Printf("%-8s %-25s ; %s", mnemonic, operands, comment); 71737caa17caSRaphael Isemann else if (mnemonic != nullptr && operands != nullptr) 71747caa17caSRaphael Isemann strm.Printf("%-8s %s", mnemonic, operands); 71757caa17caSRaphael Isemann else if (mnemonic != nullptr) 71767caa17caSRaphael Isemann strm.Printf("%s", mnemonic); 71777caa17caSRaphael Isemann 71787caa17caSRaphael Isemann int right_pad = 1; 7179dcd4589aSLuboš Luňák window.PutCStringTruncated( 7180dcd4589aSLuboš Luňák right_pad, 7181dcd4589aSLuboš Luňák strm.GetString().substr(m_first_visible_column).data()); 71827caa17caSRaphael Isemann 71837caa17caSRaphael Isemann if (is_pc_line && frame_sp && 71847caa17caSRaphael Isemann frame_sp->GetConcreteFrameIndex() == 0) { 71857caa17caSRaphael Isemann StopInfoSP stop_info_sp; 71867caa17caSRaphael Isemann if (thread) 71877caa17caSRaphael Isemann stop_info_sp = thread->GetStopInfo(); 71887caa17caSRaphael Isemann if (stop_info_sp) { 71897caa17caSRaphael Isemann const char *stop_description = stop_info_sp->GetDescription(); 71907caa17caSRaphael Isemann if (stop_description && stop_description[0]) { 71917caa17caSRaphael Isemann size_t stop_description_len = strlen(stop_description); 71927caa17caSRaphael Isemann int desc_x = window_width - stop_description_len - 16; 7193fc0e8fb7SLuboš Luňák if (desc_x - window.GetCursorX() > 0) 71947caa17caSRaphael Isemann window.Printf("%*s", desc_x - window.GetCursorX(), ""); 7195fc0e8fb7SLuboš Luňák window.MoveCursor(window_width - stop_description_len - 15, 7196fc0e8fb7SLuboš Luňák line_y); 7197fc0e8fb7SLuboš Luňák window.PrintfTruncated(1, "<<< Thread %u: %s ", 7198fc0e8fb7SLuboš Luňák thread->GetIndexID(), stop_description); 71997caa17caSRaphael Isemann } 72007caa17caSRaphael Isemann } else { 72017caa17caSRaphael Isemann window.Printf("%*s", window_width - window.GetCursorX() - 1, ""); 72027caa17caSRaphael Isemann } 72037caa17caSRaphael Isemann } 72047caa17caSRaphael Isemann if (highlight_attr) 72057caa17caSRaphael Isemann window.AttributeOff(highlight_attr); 72067caa17caSRaphael Isemann } 72077caa17caSRaphael Isemann } 72087caa17caSRaphael Isemann } 72097caa17caSRaphael Isemann return true; // Drawing handled 72107caa17caSRaphael Isemann } 72117caa17caSRaphael Isemann 72127caa17caSRaphael Isemann size_t GetNumLines() { 72137caa17caSRaphael Isemann size_t num_lines = GetNumSourceLines(); 72147caa17caSRaphael Isemann if (num_lines == 0) 72157caa17caSRaphael Isemann num_lines = GetNumDisassemblyLines(); 72167caa17caSRaphael Isemann return num_lines; 72177caa17caSRaphael Isemann } 72187caa17caSRaphael Isemann 72197caa17caSRaphael Isemann size_t GetNumSourceLines() const { 72207caa17caSRaphael Isemann if (m_file_sp) 72217caa17caSRaphael Isemann return m_file_sp->GetNumLines(); 72227caa17caSRaphael Isemann return 0; 72237caa17caSRaphael Isemann } 72247caa17caSRaphael Isemann 72257caa17caSRaphael Isemann size_t GetNumDisassemblyLines() const { 72267caa17caSRaphael Isemann if (m_disassembly_sp) 72277caa17caSRaphael Isemann return m_disassembly_sp->GetInstructionList().GetSize(); 72287caa17caSRaphael Isemann return 0; 72297caa17caSRaphael Isemann } 72307caa17caSRaphael Isemann 72317caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int c) override { 72327caa17caSRaphael Isemann const uint32_t num_visible_lines = NumVisibleLines(); 72337caa17caSRaphael Isemann const size_t num_lines = GetNumLines(); 72347caa17caSRaphael Isemann 72357caa17caSRaphael Isemann switch (c) { 72367caa17caSRaphael Isemann case ',': 72377caa17caSRaphael Isemann case KEY_PPAGE: 72387caa17caSRaphael Isemann // Page up key 72397caa17caSRaphael Isemann if (static_cast<uint32_t>(m_first_visible_line) > num_visible_lines) 72407caa17caSRaphael Isemann m_first_visible_line -= num_visible_lines; 72417caa17caSRaphael Isemann else 72427caa17caSRaphael Isemann m_first_visible_line = 0; 72437caa17caSRaphael Isemann m_selected_line = m_first_visible_line; 72447caa17caSRaphael Isemann return eKeyHandled; 72457caa17caSRaphael Isemann 72467caa17caSRaphael Isemann case '.': 72477caa17caSRaphael Isemann case KEY_NPAGE: 72487caa17caSRaphael Isemann // Page down key 72497caa17caSRaphael Isemann { 72507caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < num_lines) 72517caa17caSRaphael Isemann m_first_visible_line += num_visible_lines; 72527caa17caSRaphael Isemann else if (num_lines < num_visible_lines) 72537caa17caSRaphael Isemann m_first_visible_line = 0; 72547caa17caSRaphael Isemann else 72557caa17caSRaphael Isemann m_first_visible_line = num_lines - num_visible_lines; 72567caa17caSRaphael Isemann m_selected_line = m_first_visible_line; 72577caa17caSRaphael Isemann } 72587caa17caSRaphael Isemann return eKeyHandled; 72597caa17caSRaphael Isemann 72607caa17caSRaphael Isemann case KEY_UP: 72617caa17caSRaphael Isemann if (m_selected_line > 0) { 72627caa17caSRaphael Isemann m_selected_line--; 72637caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) > m_selected_line) 72647caa17caSRaphael Isemann m_first_visible_line = m_selected_line; 72657caa17caSRaphael Isemann } 72667caa17caSRaphael Isemann return eKeyHandled; 72677caa17caSRaphael Isemann 72687caa17caSRaphael Isemann case KEY_DOWN: 72697caa17caSRaphael Isemann if (m_selected_line + 1 < num_lines) { 72707caa17caSRaphael Isemann m_selected_line++; 72717caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < m_selected_line) 72727caa17caSRaphael Isemann m_first_visible_line++; 72737caa17caSRaphael Isemann } 72747caa17caSRaphael Isemann return eKeyHandled; 72757caa17caSRaphael Isemann 7276dcd4589aSLuboš Luňák case KEY_LEFT: 7277dcd4589aSLuboš Luňák if (m_first_visible_column > 0) 7278dcd4589aSLuboš Luňák --m_first_visible_column; 7279dcd4589aSLuboš Luňák return eKeyHandled; 7280dcd4589aSLuboš Luňák 7281dcd4589aSLuboš Luňák case KEY_RIGHT: 7282dcd4589aSLuboš Luňák ++m_first_visible_column; 7283dcd4589aSLuboš Luňák return eKeyHandled; 7284dcd4589aSLuboš Luňák 72857caa17caSRaphael Isemann case '\r': 72867caa17caSRaphael Isemann case '\n': 72877caa17caSRaphael Isemann case KEY_ENTER: 72887caa17caSRaphael Isemann // Set a breakpoint and run to the line using a one shot breakpoint 72897caa17caSRaphael Isemann if (GetNumSourceLines() > 0) { 72907caa17caSRaphael Isemann ExecutionContext exe_ctx = 72917caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 72927caa17caSRaphael Isemann if (exe_ctx.HasProcessScope() && exe_ctx.GetProcessRef().IsAlive()) { 72937caa17caSRaphael Isemann BreakpointSP bp_sp = exe_ctx.GetTargetRef().CreateBreakpoint( 72947caa17caSRaphael Isemann nullptr, // Don't limit the breakpoint to certain modules 72957caa17caSRaphael Isemann m_file_sp->GetFileSpec(), // Source file 72967caa17caSRaphael Isemann m_selected_line + 72977caa17caSRaphael Isemann 1, // Source line number (m_selected_line is zero based) 72987caa17caSRaphael Isemann 0, // Unspecified column. 72997caa17caSRaphael Isemann 0, // No offset 73007caa17caSRaphael Isemann eLazyBoolCalculate, // Check inlines using global setting 73017caa17caSRaphael Isemann eLazyBoolCalculate, // Skip prologue using global setting, 73027caa17caSRaphael Isemann false, // internal 73037caa17caSRaphael Isemann false, // request_hardware 73047caa17caSRaphael Isemann eLazyBoolCalculate); // move_to_nearest_code 73057caa17caSRaphael Isemann // Make breakpoint one shot 7306cfb96d84SJim Ingham bp_sp->GetOptions().SetOneShot(true); 73077caa17caSRaphael Isemann exe_ctx.GetProcessRef().Resume(); 73087caa17caSRaphael Isemann } 73097caa17caSRaphael Isemann } else if (m_selected_line < GetNumDisassemblyLines()) { 73107caa17caSRaphael Isemann const Instruction *inst = m_disassembly_sp->GetInstructionList() 73117caa17caSRaphael Isemann .GetInstructionAtIndex(m_selected_line) 73127caa17caSRaphael Isemann .get(); 73137caa17caSRaphael Isemann ExecutionContext exe_ctx = 73147caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73157caa17caSRaphael Isemann if (exe_ctx.HasTargetScope()) { 73167caa17caSRaphael Isemann Address addr = inst->GetAddress(); 73177caa17caSRaphael Isemann BreakpointSP bp_sp = exe_ctx.GetTargetRef().CreateBreakpoint( 73187caa17caSRaphael Isemann addr, // lldb_private::Address 73197caa17caSRaphael Isemann false, // internal 73207caa17caSRaphael Isemann false); // request_hardware 73217caa17caSRaphael Isemann // Make breakpoint one shot 7322cfb96d84SJim Ingham bp_sp->GetOptions().SetOneShot(true); 73237caa17caSRaphael Isemann exe_ctx.GetProcessRef().Resume(); 73247caa17caSRaphael Isemann } 73257caa17caSRaphael Isemann } 73267caa17caSRaphael Isemann return eKeyHandled; 73277caa17caSRaphael Isemann 73287caa17caSRaphael Isemann case 'b': // 'b' == toggle breakpoint on currently selected line 7329d6868d9cSLuboš Luňák ToggleBreakpointOnSelectedLine(); 73307caa17caSRaphael Isemann return eKeyHandled; 73317caa17caSRaphael Isemann 73327caa17caSRaphael Isemann case 'D': // 'D' == detach and keep stopped 73337caa17caSRaphael Isemann { 73347caa17caSRaphael Isemann ExecutionContext exe_ctx = 73357caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73367caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) 733747d2c7cdSLuboš Luňák exe_ctx.GetProcessRef().Detach(true); 73387caa17caSRaphael Isemann } 73397caa17caSRaphael Isemann return eKeyHandled; 73407caa17caSRaphael Isemann 73417caa17caSRaphael Isemann case 'c': 73427caa17caSRaphael Isemann // 'c' == continue 73437caa17caSRaphael Isemann { 73447caa17caSRaphael Isemann ExecutionContext exe_ctx = 73457caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73467caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) 73477caa17caSRaphael Isemann exe_ctx.GetProcessRef().Resume(); 73487caa17caSRaphael Isemann } 73497caa17caSRaphael Isemann return eKeyHandled; 73507caa17caSRaphael Isemann 7351336c7029SLuboš Luňák case 'f': 7352336c7029SLuboš Luňák // 'f' == step out (finish) 73537caa17caSRaphael Isemann { 73547caa17caSRaphael Isemann ExecutionContext exe_ctx = 73557caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73567caa17caSRaphael Isemann if (exe_ctx.HasThreadScope() && 73577caa17caSRaphael Isemann StateIsStoppedState(exe_ctx.GetProcessRef().GetState(), true)) { 73587caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOut(); 73597caa17caSRaphael Isemann } 73607caa17caSRaphael Isemann } 73617caa17caSRaphael Isemann return eKeyHandled; 73627caa17caSRaphael Isemann 73637caa17caSRaphael Isemann case 'n': // 'n' == step over 73647caa17caSRaphael Isemann case 'N': // 'N' == step over instruction 73657caa17caSRaphael Isemann { 73667caa17caSRaphael Isemann ExecutionContext exe_ctx = 73677caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73687caa17caSRaphael Isemann if (exe_ctx.HasThreadScope() && 73697caa17caSRaphael Isemann StateIsStoppedState(exe_ctx.GetProcessRef().GetState(), true)) { 73707caa17caSRaphael Isemann bool source_step = (c == 'n'); 73717caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOver(source_step); 73727caa17caSRaphael Isemann } 73737caa17caSRaphael Isemann } 73747caa17caSRaphael Isemann return eKeyHandled; 73757caa17caSRaphael Isemann 73767caa17caSRaphael Isemann case 's': // 's' == step into 73777caa17caSRaphael Isemann case 'S': // 'S' == step into instruction 73787caa17caSRaphael Isemann { 73797caa17caSRaphael Isemann ExecutionContext exe_ctx = 73807caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73817caa17caSRaphael Isemann if (exe_ctx.HasThreadScope() && 73827caa17caSRaphael Isemann StateIsStoppedState(exe_ctx.GetProcessRef().GetState(), true)) { 73837caa17caSRaphael Isemann bool source_step = (c == 's'); 73847caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepIn(source_step); 73857caa17caSRaphael Isemann } 73867caa17caSRaphael Isemann } 73877caa17caSRaphael Isemann return eKeyHandled; 73887caa17caSRaphael Isemann 738913978643SLuboš Luňák case 'u': // 'u' == frame up 739013978643SLuboš Luňák case 'd': // 'd' == frame down 739113978643SLuboš Luňák { 739213978643SLuboš Luňák ExecutionContext exe_ctx = 739313978643SLuboš Luňák m_debugger.GetCommandInterpreter().GetExecutionContext(); 739413978643SLuboš Luňák if (exe_ctx.HasThreadScope()) { 739513978643SLuboš Luňák Thread *thread = exe_ctx.GetThreadPtr(); 739613978643SLuboš Luňák uint32_t frame_idx = thread->GetSelectedFrameIndex(); 739713978643SLuboš Luňák if (frame_idx == UINT32_MAX) 739813978643SLuboš Luňák frame_idx = 0; 739913978643SLuboš Luňák if (c == 'u' && frame_idx + 1 < thread->GetStackFrameCount()) 740013978643SLuboš Luňák ++frame_idx; 740113978643SLuboš Luňák else if (c == 'd' && frame_idx > 0) 740213978643SLuboš Luňák --frame_idx; 740313978643SLuboš Luňák if (thread->SetSelectedFrameByIndex(frame_idx, true)) 740413978643SLuboš Luňák exe_ctx.SetFrameSP(thread->GetSelectedFrame()); 740513978643SLuboš Luňák } 740613978643SLuboš Luňák } 740713978643SLuboš Luňák return eKeyHandled; 740813978643SLuboš Luňák 74097caa17caSRaphael Isemann case 'h': 74107caa17caSRaphael Isemann window.CreateHelpSubwindow(); 74117caa17caSRaphael Isemann return eKeyHandled; 74127caa17caSRaphael Isemann 74137caa17caSRaphael Isemann default: 74147caa17caSRaphael Isemann break; 74157caa17caSRaphael Isemann } 74167caa17caSRaphael Isemann return eKeyNotHandled; 74177caa17caSRaphael Isemann } 74187caa17caSRaphael Isemann 7419d6868d9cSLuboš Luňák void ToggleBreakpointOnSelectedLine() { 7420d6868d9cSLuboš Luňák ExecutionContext exe_ctx = 7421d6868d9cSLuboš Luňák m_debugger.GetCommandInterpreter().GetExecutionContext(); 7422d6868d9cSLuboš Luňák if (!exe_ctx.HasTargetScope()) 7423d6868d9cSLuboš Luňák return; 7424d6868d9cSLuboš Luňák if (GetNumSourceLines() > 0) { 7425d6868d9cSLuboš Luňák // Source file breakpoint. 7426d6868d9cSLuboš Luňák BreakpointList &bp_list = exe_ctx.GetTargetRef().GetBreakpointList(); 7427d6868d9cSLuboš Luňák const size_t num_bps = bp_list.GetSize(); 7428d6868d9cSLuboš Luňák for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 7429d6868d9cSLuboš Luňák BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 7430d6868d9cSLuboš Luňák const size_t num_bps_locs = bp_sp->GetNumLocations(); 7431d6868d9cSLuboš Luňák for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; ++bp_loc_idx) { 7432d6868d9cSLuboš Luňák BreakpointLocationSP bp_loc_sp = 7433d6868d9cSLuboš Luňák bp_sp->GetLocationAtIndex(bp_loc_idx); 7434d6868d9cSLuboš Luňák LineEntry bp_loc_line_entry; 7435d6868d9cSLuboš Luňák if (bp_loc_sp->GetAddress().CalculateSymbolContextLineEntry( 7436d6868d9cSLuboš Luňák bp_loc_line_entry)) { 7437d6868d9cSLuboš Luňák if (m_file_sp->GetFileSpec() == bp_loc_line_entry.file && 7438d6868d9cSLuboš Luňák m_selected_line + 1 == bp_loc_line_entry.line) { 7439d6868d9cSLuboš Luňák bool removed = 7440d6868d9cSLuboš Luňák exe_ctx.GetTargetRef().RemoveBreakpointByID(bp_sp->GetID()); 7441d6868d9cSLuboš Luňák assert(removed); 7442d6868d9cSLuboš Luňák UNUSED_IF_ASSERT_DISABLED(removed); 7443d6868d9cSLuboš Luňák return; // Existing breakpoint removed. 7444d6868d9cSLuboš Luňák } 7445d6868d9cSLuboš Luňák } 7446d6868d9cSLuboš Luňák } 7447d6868d9cSLuboš Luňák } 7448d6868d9cSLuboš Luňák // No breakpoint found on the location, add it. 7449d6868d9cSLuboš Luňák BreakpointSP bp_sp = exe_ctx.GetTargetRef().CreateBreakpoint( 7450d6868d9cSLuboš Luňák nullptr, // Don't limit the breakpoint to certain modules 7451d6868d9cSLuboš Luňák m_file_sp->GetFileSpec(), // Source file 7452d6868d9cSLuboš Luňák m_selected_line + 7453d6868d9cSLuboš Luňák 1, // Source line number (m_selected_line is zero based) 7454d6868d9cSLuboš Luňák 0, // No column specified. 7455d6868d9cSLuboš Luňák 0, // No offset 7456d6868d9cSLuboš Luňák eLazyBoolCalculate, // Check inlines using global setting 7457d6868d9cSLuboš Luňák eLazyBoolCalculate, // Skip prologue using global setting, 7458d6868d9cSLuboš Luňák false, // internal 7459d6868d9cSLuboš Luňák false, // request_hardware 7460d6868d9cSLuboš Luňák eLazyBoolCalculate); // move_to_nearest_code 7461d6868d9cSLuboš Luňák } else { 7462d6868d9cSLuboš Luňák // Disassembly breakpoint. 7463d6868d9cSLuboš Luňák assert(GetNumDisassemblyLines() > 0); 7464d6868d9cSLuboš Luňák assert(m_selected_line < GetNumDisassemblyLines()); 7465d6868d9cSLuboš Luňák const Instruction *inst = m_disassembly_sp->GetInstructionList() 7466d6868d9cSLuboš Luňák .GetInstructionAtIndex(m_selected_line) 7467d6868d9cSLuboš Luňák .get(); 7468d6868d9cSLuboš Luňák Address addr = inst->GetAddress(); 7469d6868d9cSLuboš Luňák // Try to find it. 7470d6868d9cSLuboš Luňák BreakpointList &bp_list = exe_ctx.GetTargetRef().GetBreakpointList(); 7471d6868d9cSLuboš Luňák const size_t num_bps = bp_list.GetSize(); 7472d6868d9cSLuboš Luňák for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 7473d6868d9cSLuboš Luňák BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 7474d6868d9cSLuboš Luňák const size_t num_bps_locs = bp_sp->GetNumLocations(); 7475d6868d9cSLuboš Luňák for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; ++bp_loc_idx) { 7476d6868d9cSLuboš Luňák BreakpointLocationSP bp_loc_sp = 7477d6868d9cSLuboš Luňák bp_sp->GetLocationAtIndex(bp_loc_idx); 7478d6868d9cSLuboš Luňák LineEntry bp_loc_line_entry; 7479d6868d9cSLuboš Luňák const lldb::addr_t file_addr = 7480d6868d9cSLuboš Luňák bp_loc_sp->GetAddress().GetFileAddress(); 7481d6868d9cSLuboš Luňák if (file_addr == addr.GetFileAddress()) { 7482d6868d9cSLuboš Luňák bool removed = 7483d6868d9cSLuboš Luňák exe_ctx.GetTargetRef().RemoveBreakpointByID(bp_sp->GetID()); 7484d6868d9cSLuboš Luňák assert(removed); 7485d6868d9cSLuboš Luňák UNUSED_IF_ASSERT_DISABLED(removed); 7486d6868d9cSLuboš Luňák return; // Existing breakpoint removed. 7487d6868d9cSLuboš Luňák } 7488d6868d9cSLuboš Luňák } 7489d6868d9cSLuboš Luňák } 7490d6868d9cSLuboš Luňák // No breakpoint found on the address, add it. 7491d6868d9cSLuboš Luňák BreakpointSP bp_sp = 7492d6868d9cSLuboš Luňák exe_ctx.GetTargetRef().CreateBreakpoint(addr, // lldb_private::Address 7493d6868d9cSLuboš Luňák false, // internal 7494d6868d9cSLuboš Luňák false); // request_hardware 7495d6868d9cSLuboš Luňák } 7496d6868d9cSLuboš Luňák } 7497d6868d9cSLuboš Luňák 74987caa17caSRaphael Isemann protected: 74997caa17caSRaphael Isemann typedef std::set<uint32_t> BreakpointLines; 75007caa17caSRaphael Isemann typedef std::set<lldb::addr_t> BreakpointAddrs; 75017caa17caSRaphael Isemann 75027caa17caSRaphael Isemann Debugger &m_debugger; 75037caa17caSRaphael Isemann SymbolContext m_sc; 75047caa17caSRaphael Isemann SourceManager::FileSP m_file_sp; 750528c878aeSShafik Yaghmour SymbolContextScope *m_disassembly_scope = nullptr; 75067caa17caSRaphael Isemann lldb::DisassemblerSP m_disassembly_sp; 75077caa17caSRaphael Isemann AddressRange m_disassembly_range; 75087caa17caSRaphael Isemann StreamString m_title; 750928c878aeSShafik Yaghmour lldb::user_id_t m_tid = LLDB_INVALID_THREAD_ID; 751028c878aeSShafik Yaghmour int m_line_width = 4; 751128c878aeSShafik Yaghmour uint32_t m_selected_line = 0; // The selected line 751228c878aeSShafik Yaghmour uint32_t m_pc_line = 0; // The line with the PC 751328c878aeSShafik Yaghmour uint32_t m_stop_id = 0; 751428c878aeSShafik Yaghmour uint32_t m_frame_idx = UINT32_MAX; 751528c878aeSShafik Yaghmour int m_first_visible_line = 0; 751628c878aeSShafik Yaghmour int m_first_visible_column = 0; 751728c878aeSShafik Yaghmour int m_min_x = 0; 751828c878aeSShafik Yaghmour int m_min_y = 0; 751928c878aeSShafik Yaghmour int m_max_x = 0; 752028c878aeSShafik Yaghmour int m_max_y = 0; 75217caa17caSRaphael Isemann }; 75227caa17caSRaphael Isemann 75237caa17caSRaphael Isemann DisplayOptions ValueObjectListDelegate::g_options = {true}; 75247caa17caSRaphael Isemann 75257caa17caSRaphael Isemann IOHandlerCursesGUI::IOHandlerCursesGUI(Debugger &debugger) 75267caa17caSRaphael Isemann : IOHandler(debugger, IOHandler::Type::Curses) {} 75277caa17caSRaphael Isemann 75287caa17caSRaphael Isemann void IOHandlerCursesGUI::Activate() { 75297caa17caSRaphael Isemann IOHandler::Activate(); 75307caa17caSRaphael Isemann if (!m_app_ap) { 753106412daeSJonas Devlieghere m_app_ap = std::make_unique<Application>(GetInputFILE(), GetOutputFILE()); 75327caa17caSRaphael Isemann 75337caa17caSRaphael Isemann // This is both a window and a menu delegate 75347caa17caSRaphael Isemann std::shared_ptr<ApplicationDelegate> app_delegate_sp( 75357caa17caSRaphael Isemann new ApplicationDelegate(*m_app_ap, m_debugger)); 75367caa17caSRaphael Isemann 75377caa17caSRaphael Isemann MenuDelegateSP app_menu_delegate_sp = 75387caa17caSRaphael Isemann std::static_pointer_cast<MenuDelegate>(app_delegate_sp); 75397caa17caSRaphael Isemann MenuSP lldb_menu_sp( 75407caa17caSRaphael Isemann new Menu("LLDB", "F1", KEY_F(1), ApplicationDelegate::eMenuID_LLDB)); 75417caa17caSRaphael Isemann MenuSP exit_menuitem_sp( 75427caa17caSRaphael Isemann new Menu("Exit", nullptr, 'x', ApplicationDelegate::eMenuID_LLDBExit)); 75437caa17caSRaphael Isemann exit_menuitem_sp->SetCannedResult(MenuActionResult::Quit); 75447caa17caSRaphael Isemann lldb_menu_sp->AddSubmenu(MenuSP(new Menu( 75457caa17caSRaphael Isemann "About LLDB", nullptr, 'a', ApplicationDelegate::eMenuID_LLDBAbout))); 75467caa17caSRaphael Isemann lldb_menu_sp->AddSubmenu(MenuSP(new Menu(Menu::Type::Separator))); 75477caa17caSRaphael Isemann lldb_menu_sp->AddSubmenu(exit_menuitem_sp); 75487caa17caSRaphael Isemann 75497caa17caSRaphael Isemann MenuSP target_menu_sp(new Menu("Target", "F2", KEY_F(2), 75507caa17caSRaphael Isemann ApplicationDelegate::eMenuID_Target)); 75517caa17caSRaphael Isemann target_menu_sp->AddSubmenu(MenuSP(new Menu( 75527caa17caSRaphael Isemann "Create", nullptr, 'c', ApplicationDelegate::eMenuID_TargetCreate))); 75537caa17caSRaphael Isemann target_menu_sp->AddSubmenu(MenuSP(new Menu( 75547caa17caSRaphael Isemann "Delete", nullptr, 'd', ApplicationDelegate::eMenuID_TargetDelete))); 75557caa17caSRaphael Isemann 75567caa17caSRaphael Isemann MenuSP process_menu_sp(new Menu("Process", "F3", KEY_F(3), 75577caa17caSRaphael Isemann ApplicationDelegate::eMenuID_Process)); 75587caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 75597caa17caSRaphael Isemann "Attach", nullptr, 'a', ApplicationDelegate::eMenuID_ProcessAttach))); 756047d2c7cdSLuboš Luňák process_menu_sp->AddSubmenu( 756147d2c7cdSLuboš Luňák MenuSP(new Menu("Detach and resume", nullptr, 'd', 756247d2c7cdSLuboš Luňák ApplicationDelegate::eMenuID_ProcessDetachResume))); 756347d2c7cdSLuboš Luňák process_menu_sp->AddSubmenu( 756447d2c7cdSLuboš Luňák MenuSP(new Menu("Detach suspended", nullptr, 's', 756547d2c7cdSLuboš Luňák ApplicationDelegate::eMenuID_ProcessDetachSuspended))); 75667caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 75677caa17caSRaphael Isemann "Launch", nullptr, 'l', ApplicationDelegate::eMenuID_ProcessLaunch))); 75687caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu(Menu::Type::Separator))); 75697caa17caSRaphael Isemann process_menu_sp->AddSubmenu( 75707caa17caSRaphael Isemann MenuSP(new Menu("Continue", nullptr, 'c', 75717caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ProcessContinue))); 75727caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 75737caa17caSRaphael Isemann "Halt", nullptr, 'h', ApplicationDelegate::eMenuID_ProcessHalt))); 75747caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 75757caa17caSRaphael Isemann "Kill", nullptr, 'k', ApplicationDelegate::eMenuID_ProcessKill))); 75767caa17caSRaphael Isemann 75777caa17caSRaphael Isemann MenuSP thread_menu_sp(new Menu("Thread", "F4", KEY_F(4), 75787caa17caSRaphael Isemann ApplicationDelegate::eMenuID_Thread)); 75797caa17caSRaphael Isemann thread_menu_sp->AddSubmenu(MenuSP(new Menu( 75807caa17caSRaphael Isemann "Step In", nullptr, 'i', ApplicationDelegate::eMenuID_ThreadStepIn))); 75817caa17caSRaphael Isemann thread_menu_sp->AddSubmenu( 75827caa17caSRaphael Isemann MenuSP(new Menu("Step Over", nullptr, 'v', 75837caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ThreadStepOver))); 75847caa17caSRaphael Isemann thread_menu_sp->AddSubmenu(MenuSP(new Menu( 75857caa17caSRaphael Isemann "Step Out", nullptr, 'o', ApplicationDelegate::eMenuID_ThreadStepOut))); 75867caa17caSRaphael Isemann 75877caa17caSRaphael Isemann MenuSP view_menu_sp( 75887caa17caSRaphael Isemann new Menu("View", "F5", KEY_F(5), ApplicationDelegate::eMenuID_View)); 75897caa17caSRaphael Isemann view_menu_sp->AddSubmenu( 7590b26e1efcSOmar Emara MenuSP(new Menu("Backtrace", nullptr, 't', 75917caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ViewBacktrace))); 75927caa17caSRaphael Isemann view_menu_sp->AddSubmenu( 75937caa17caSRaphael Isemann MenuSP(new Menu("Registers", nullptr, 'r', 75947caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ViewRegisters))); 75957caa17caSRaphael Isemann view_menu_sp->AddSubmenu(MenuSP(new Menu( 75967caa17caSRaphael Isemann "Source", nullptr, 's', ApplicationDelegate::eMenuID_ViewSource))); 75977caa17caSRaphael Isemann view_menu_sp->AddSubmenu( 75987caa17caSRaphael Isemann MenuSP(new Menu("Variables", nullptr, 'v', 75997caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ViewVariables))); 7600b26e1efcSOmar Emara view_menu_sp->AddSubmenu( 7601b26e1efcSOmar Emara MenuSP(new Menu("Breakpoints", nullptr, 'b', 7602b26e1efcSOmar Emara ApplicationDelegate::eMenuID_ViewBreakpoints))); 76037caa17caSRaphael Isemann 76047caa17caSRaphael Isemann MenuSP help_menu_sp( 76057caa17caSRaphael Isemann new Menu("Help", "F6", KEY_F(6), ApplicationDelegate::eMenuID_Help)); 76067caa17caSRaphael Isemann help_menu_sp->AddSubmenu(MenuSP(new Menu( 76077caa17caSRaphael Isemann "GUI Help", nullptr, 'g', ApplicationDelegate::eMenuID_HelpGUIHelp))); 76087caa17caSRaphael Isemann 76097caa17caSRaphael Isemann m_app_ap->Initialize(); 76107caa17caSRaphael Isemann WindowSP &main_window_sp = m_app_ap->GetMainWindow(); 76117caa17caSRaphael Isemann 76127caa17caSRaphael Isemann MenuSP menubar_sp(new Menu(Menu::Type::Bar)); 76137caa17caSRaphael Isemann menubar_sp->AddSubmenu(lldb_menu_sp); 76147caa17caSRaphael Isemann menubar_sp->AddSubmenu(target_menu_sp); 76157caa17caSRaphael Isemann menubar_sp->AddSubmenu(process_menu_sp); 76167caa17caSRaphael Isemann menubar_sp->AddSubmenu(thread_menu_sp); 76177caa17caSRaphael Isemann menubar_sp->AddSubmenu(view_menu_sp); 76187caa17caSRaphael Isemann menubar_sp->AddSubmenu(help_menu_sp); 76197caa17caSRaphael Isemann menubar_sp->SetDelegate(app_menu_delegate_sp); 76207caa17caSRaphael Isemann 76217caa17caSRaphael Isemann Rect content_bounds = main_window_sp->GetFrame(); 76227caa17caSRaphael Isemann Rect menubar_bounds = content_bounds.MakeMenuBar(); 76237caa17caSRaphael Isemann Rect status_bounds = content_bounds.MakeStatusBar(); 76247caa17caSRaphael Isemann Rect source_bounds; 76257caa17caSRaphael Isemann Rect variables_bounds; 76267caa17caSRaphael Isemann Rect threads_bounds; 76277caa17caSRaphael Isemann Rect source_variables_bounds; 76287caa17caSRaphael Isemann content_bounds.VerticalSplitPercentage(0.80, source_variables_bounds, 76297caa17caSRaphael Isemann threads_bounds); 76307caa17caSRaphael Isemann source_variables_bounds.HorizontalSplitPercentage(0.70, source_bounds, 76317caa17caSRaphael Isemann variables_bounds); 76327caa17caSRaphael Isemann 76337caa17caSRaphael Isemann WindowSP menubar_window_sp = 76347caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Menubar", menubar_bounds, false); 76357caa17caSRaphael Isemann // Let the menubar get keys if the active window doesn't handle the keys 76367caa17caSRaphael Isemann // that are typed so it can respond to menubar key presses. 76377caa17caSRaphael Isemann menubar_window_sp->SetCanBeActive( 76387caa17caSRaphael Isemann false); // Don't let the menubar become the active window 76397caa17caSRaphael Isemann menubar_window_sp->SetDelegate(menubar_sp); 76407caa17caSRaphael Isemann 76417caa17caSRaphael Isemann WindowSP source_window_sp( 76427caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Source", source_bounds, true)); 76437caa17caSRaphael Isemann WindowSP variables_window_sp( 76447caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Variables", variables_bounds, false)); 76457caa17caSRaphael Isemann WindowSP threads_window_sp( 76467caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Threads", threads_bounds, false)); 76477caa17caSRaphael Isemann WindowSP status_window_sp( 76487caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Status", status_bounds, false)); 76497caa17caSRaphael Isemann status_window_sp->SetCanBeActive( 76507caa17caSRaphael Isemann false); // Don't let the status bar become the active window 76517caa17caSRaphael Isemann main_window_sp->SetDelegate( 76527caa17caSRaphael Isemann std::static_pointer_cast<WindowDelegate>(app_delegate_sp)); 76537caa17caSRaphael Isemann source_window_sp->SetDelegate( 76547caa17caSRaphael Isemann WindowDelegateSP(new SourceFileWindowDelegate(m_debugger))); 76557caa17caSRaphael Isemann variables_window_sp->SetDelegate( 76567caa17caSRaphael Isemann WindowDelegateSP(new FrameVariablesWindowDelegate(m_debugger))); 76577caa17caSRaphael Isemann TreeDelegateSP thread_delegate_sp(new ThreadsTreeDelegate(m_debugger)); 76587caa17caSRaphael Isemann threads_window_sp->SetDelegate(WindowDelegateSP( 76597caa17caSRaphael Isemann new TreeWindowDelegate(m_debugger, thread_delegate_sp))); 76607caa17caSRaphael Isemann status_window_sp->SetDelegate( 76617caa17caSRaphael Isemann WindowDelegateSP(new StatusBarWindowDelegate(m_debugger))); 76627caa17caSRaphael Isemann 7663b26e1efcSOmar Emara // Show the main help window once the first time the curses GUI is 7664b26e1efcSOmar Emara // launched 76657caa17caSRaphael Isemann static bool g_showed_help = false; 76667caa17caSRaphael Isemann if (!g_showed_help) { 76677caa17caSRaphael Isemann g_showed_help = true; 76687caa17caSRaphael Isemann main_window_sp->CreateHelpSubwindow(); 76697caa17caSRaphael Isemann } 76707caa17caSRaphael Isemann 767114406ca0SLuboš Luňák // All colors with black background. 767214406ca0SLuboš Luňák init_pair(1, COLOR_BLACK, COLOR_BLACK); 767314406ca0SLuboš Luňák init_pair(2, COLOR_RED, COLOR_BLACK); 767414406ca0SLuboš Luňák init_pair(3, COLOR_GREEN, COLOR_BLACK); 767514406ca0SLuboš Luňák init_pair(4, COLOR_YELLOW, COLOR_BLACK); 767614406ca0SLuboš Luňák init_pair(5, COLOR_BLUE, COLOR_BLACK); 767714406ca0SLuboš Luňák init_pair(6, COLOR_MAGENTA, COLOR_BLACK); 767814406ca0SLuboš Luňák init_pair(7, COLOR_CYAN, COLOR_BLACK); 767914406ca0SLuboš Luňák init_pair(8, COLOR_WHITE, COLOR_BLACK); 768014406ca0SLuboš Luňák // All colors with blue background. 768114406ca0SLuboš Luňák init_pair(9, COLOR_BLACK, COLOR_BLUE); 768214406ca0SLuboš Luňák init_pair(10, COLOR_RED, COLOR_BLUE); 768314406ca0SLuboš Luňák init_pair(11, COLOR_GREEN, COLOR_BLUE); 768414406ca0SLuboš Luňák init_pair(12, COLOR_YELLOW, COLOR_BLUE); 768514406ca0SLuboš Luňák init_pair(13, COLOR_BLUE, COLOR_BLUE); 768614406ca0SLuboš Luňák init_pair(14, COLOR_MAGENTA, COLOR_BLUE); 768714406ca0SLuboš Luňák init_pair(15, COLOR_CYAN, COLOR_BLUE); 768814406ca0SLuboš Luňák init_pair(16, COLOR_WHITE, COLOR_BLUE); 76894a8e4b5cSLuboš Luňák // These must match the order in the color indexes enum. 76904a8e4b5cSLuboš Luňák init_pair(17, COLOR_BLACK, COLOR_WHITE); 76914a8e4b5cSLuboš Luňák init_pair(18, COLOR_MAGENTA, COLOR_WHITE); 76924a8e4b5cSLuboš Luňák static_assert(LastColorPairIndex == 18, "Color indexes do not match."); 769329cc50e1SOmar Emara 769429cc50e1SOmar Emara define_key("\033[Z", KEY_SHIFT_TAB); 7695945cde8bSOmar Emara define_key("\033\015", KEY_ALT_ENTER); 76967caa17caSRaphael Isemann } 76977caa17caSRaphael Isemann } 76987caa17caSRaphael Isemann 76997caa17caSRaphael Isemann void IOHandlerCursesGUI::Deactivate() { m_app_ap->Terminate(); } 77007caa17caSRaphael Isemann 77017caa17caSRaphael Isemann void IOHandlerCursesGUI::Run() { 77027caa17caSRaphael Isemann m_app_ap->Run(m_debugger); 77037caa17caSRaphael Isemann SetIsDone(true); 77047caa17caSRaphael Isemann } 77057caa17caSRaphael Isemann 77067caa17caSRaphael Isemann IOHandlerCursesGUI::~IOHandlerCursesGUI() = default; 77077caa17caSRaphael Isemann 77087caa17caSRaphael Isemann void IOHandlerCursesGUI::Cancel() {} 77097caa17caSRaphael Isemann 77107caa17caSRaphael Isemann bool IOHandlerCursesGUI::Interrupt() { return false; } 77117caa17caSRaphael Isemann 77127caa17caSRaphael Isemann void IOHandlerCursesGUI::GotEOF() {} 77137caa17caSRaphael Isemann 77142f1b24b7SLuboš Luňák void IOHandlerCursesGUI::TerminalSizeChanged() { 77152f1b24b7SLuboš Luňák m_app_ap->TerminalSizeChanged(); 77162f1b24b7SLuboš Luňák } 77172f1b24b7SLuboš Luňák 7718a4304f96SJonas Devlieghere #endif // LLDB_ENABLE_CURSES 7719