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" 317caa17caSRaphael Isemann #include "lldb/Utility/Predicate.h" 327caa17caSRaphael Isemann #include "lldb/Utility/Status.h" 337caa17caSRaphael Isemann #include "lldb/Utility/StreamString.h" 347caa17caSRaphael Isemann #include "lldb/Utility/StringList.h" 357caa17caSRaphael Isemann #include "lldb/lldb-forward.h" 367caa17caSRaphael Isemann 377caa17caSRaphael Isemann #include "lldb/Interpreter/CommandCompletions.h" 387caa17caSRaphael Isemann #include "lldb/Interpreter/CommandInterpreter.h" 3918c25cd3SOmar Emara #include "lldb/Interpreter/OptionGroupPlatform.h" 407caa17caSRaphael Isemann 41a4304f96SJonas Devlieghere #if LLDB_ENABLE_CURSES 427caa17caSRaphael Isemann #include "lldb/Breakpoint/BreakpointLocation.h" 437caa17caSRaphael Isemann #include "lldb/Core/Module.h" 440321dbc8SOmar Emara #include "lldb/Core/PluginManager.h" 457caa17caSRaphael Isemann #include "lldb/Core/ValueObject.h" 467caa17caSRaphael Isemann #include "lldb/Core/ValueObjectRegister.h" 477caa17caSRaphael Isemann #include "lldb/Symbol/Block.h" 48b26e1efcSOmar Emara #include "lldb/Symbol/CompileUnit.h" 497caa17caSRaphael Isemann #include "lldb/Symbol/Function.h" 507caa17caSRaphael Isemann #include "lldb/Symbol/Symbol.h" 517caa17caSRaphael Isemann #include "lldb/Symbol/VariableList.h" 527caa17caSRaphael Isemann #include "lldb/Target/Process.h" 537caa17caSRaphael Isemann #include "lldb/Target/RegisterContext.h" 547caa17caSRaphael Isemann #include "lldb/Target/StackFrame.h" 557caa17caSRaphael Isemann #include "lldb/Target/StopInfo.h" 567caa17caSRaphael Isemann #include "lldb/Target/Target.h" 577caa17caSRaphael Isemann #include "lldb/Target/Thread.h" 587caa17caSRaphael Isemann #include "lldb/Utility/State.h" 597caa17caSRaphael Isemann #endif 607caa17caSRaphael Isemann 617caa17caSRaphael Isemann #include "llvm/ADT/StringRef.h" 627caa17caSRaphael Isemann 637caa17caSRaphael Isemann #ifdef _WIN32 647caa17caSRaphael Isemann #include "lldb/Host/windows/windows.h" 657caa17caSRaphael Isemann #endif 667caa17caSRaphael Isemann 677caa17caSRaphael Isemann #include <memory> 687caa17caSRaphael Isemann #include <mutex> 697caa17caSRaphael Isemann 7076e47d48SRaphael Isemann #include <cassert> 7176e47d48SRaphael Isemann #include <cctype> 7276e47d48SRaphael Isemann #include <cerrno> 7376e47d48SRaphael Isemann #include <cstdint> 7476e47d48SRaphael Isemann #include <cstdio> 7576e47d48SRaphael Isemann #include <cstring> 7629cc50e1SOmar Emara #include <functional> 777caa17caSRaphael Isemann #include <type_traits> 787caa17caSRaphael Isemann 797caa17caSRaphael Isemann using namespace lldb; 807caa17caSRaphael Isemann using namespace lldb_private; 817caa17caSRaphael Isemann using llvm::None; 827caa17caSRaphael Isemann using llvm::Optional; 837caa17caSRaphael Isemann using llvm::StringRef; 847caa17caSRaphael Isemann 857caa17caSRaphael Isemann // we may want curses to be disabled for some builds for instance, windows 86a4304f96SJonas Devlieghere #if LLDB_ENABLE_CURSES 877caa17caSRaphael Isemann 88d95d2a8eSOmar Emara #define KEY_CTRL_A 1 89d95d2a8eSOmar Emara #define KEY_CTRL_E 5 90d95d2a8eSOmar Emara #define KEY_CTRL_K 11 917caa17caSRaphael Isemann #define KEY_RETURN 10 927caa17caSRaphael Isemann #define KEY_ESCAPE 27 93d95d2a8eSOmar Emara #define KEY_DELETE 127 947caa17caSRaphael Isemann 9529cc50e1SOmar Emara #define KEY_SHIFT_TAB (KEY_MAX + 1) 96945cde8bSOmar Emara #define KEY_ALT_ENTER (KEY_MAX + 2) 9729cc50e1SOmar Emara 987caa17caSRaphael Isemann namespace curses { 997caa17caSRaphael Isemann class Menu; 1007caa17caSRaphael Isemann class MenuDelegate; 1017caa17caSRaphael Isemann class Window; 1027caa17caSRaphael Isemann class WindowDelegate; 1037caa17caSRaphael Isemann typedef std::shared_ptr<Menu> MenuSP; 1047caa17caSRaphael Isemann typedef std::shared_ptr<MenuDelegate> MenuDelegateSP; 1057caa17caSRaphael Isemann typedef std::shared_ptr<Window> WindowSP; 1067caa17caSRaphael Isemann typedef std::shared_ptr<WindowDelegate> WindowDelegateSP; 1077caa17caSRaphael Isemann typedef std::vector<MenuSP> Menus; 1087caa17caSRaphael Isemann typedef std::vector<WindowSP> Windows; 1097caa17caSRaphael Isemann typedef std::vector<WindowDelegateSP> WindowDelegates; 1107caa17caSRaphael Isemann 1117caa17caSRaphael Isemann #if 0 1127caa17caSRaphael Isemann type summary add -s "x=${var.x}, y=${var.y}" curses::Point 1137caa17caSRaphael Isemann type summary add -s "w=${var.width}, h=${var.height}" curses::Size 1147caa17caSRaphael Isemann type summary add -s "${var.origin%S} ${var.size%S}" curses::Rect 1157caa17caSRaphael Isemann #endif 1167caa17caSRaphael Isemann 1177caa17caSRaphael Isemann struct Point { 1187caa17caSRaphael Isemann int x; 1197caa17caSRaphael Isemann int y; 1207caa17caSRaphael Isemann 1217caa17caSRaphael Isemann Point(int _x = 0, int _y = 0) : x(_x), y(_y) {} 1227caa17caSRaphael Isemann 1237caa17caSRaphael Isemann void Clear() { 1247caa17caSRaphael Isemann x = 0; 1257caa17caSRaphael Isemann y = 0; 1267caa17caSRaphael Isemann } 1277caa17caSRaphael Isemann 1287caa17caSRaphael Isemann Point &operator+=(const Point &rhs) { 1297caa17caSRaphael Isemann x += rhs.x; 1307caa17caSRaphael Isemann y += rhs.y; 1317caa17caSRaphael Isemann return *this; 1327caa17caSRaphael Isemann } 1337caa17caSRaphael Isemann 1347caa17caSRaphael Isemann void Dump() { printf("(x=%i, y=%i)\n", x, y); } 1357caa17caSRaphael Isemann }; 1367caa17caSRaphael Isemann 1377caa17caSRaphael Isemann bool operator==(const Point &lhs, const Point &rhs) { 1387caa17caSRaphael Isemann return lhs.x == rhs.x && lhs.y == rhs.y; 1397caa17caSRaphael Isemann } 1407caa17caSRaphael Isemann 1417caa17caSRaphael Isemann bool operator!=(const Point &lhs, const Point &rhs) { 1427caa17caSRaphael Isemann return lhs.x != rhs.x || lhs.y != rhs.y; 1437caa17caSRaphael Isemann } 1447caa17caSRaphael Isemann 1457caa17caSRaphael Isemann struct Size { 1467caa17caSRaphael Isemann int width; 1477caa17caSRaphael Isemann int height; 1487caa17caSRaphael Isemann Size(int w = 0, int h = 0) : width(w), height(h) {} 1497caa17caSRaphael Isemann 1507caa17caSRaphael Isemann void Clear() { 1517caa17caSRaphael Isemann width = 0; 1527caa17caSRaphael Isemann height = 0; 1537caa17caSRaphael Isemann } 1547caa17caSRaphael Isemann 1557caa17caSRaphael Isemann void Dump() { printf("(w=%i, h=%i)\n", width, height); } 1567caa17caSRaphael Isemann }; 1577caa17caSRaphael Isemann 1587caa17caSRaphael Isemann bool operator==(const Size &lhs, const Size &rhs) { 1597caa17caSRaphael Isemann return lhs.width == rhs.width && lhs.height == rhs.height; 1607caa17caSRaphael Isemann } 1617caa17caSRaphael Isemann 1627caa17caSRaphael Isemann bool operator!=(const Size &lhs, const Size &rhs) { 1637caa17caSRaphael Isemann return lhs.width != rhs.width || lhs.height != rhs.height; 1647caa17caSRaphael Isemann } 1657caa17caSRaphael Isemann 1667caa17caSRaphael Isemann struct Rect { 1677caa17caSRaphael Isemann Point origin; 1687caa17caSRaphael Isemann Size size; 1697caa17caSRaphael Isemann 1707caa17caSRaphael Isemann Rect() : origin(), size() {} 1717caa17caSRaphael Isemann 1727caa17caSRaphael Isemann Rect(const Point &p, const Size &s) : origin(p), size(s) {} 1737caa17caSRaphael Isemann 1747caa17caSRaphael Isemann void Clear() { 1757caa17caSRaphael Isemann origin.Clear(); 1767caa17caSRaphael Isemann size.Clear(); 1777caa17caSRaphael Isemann } 1787caa17caSRaphael Isemann 1797caa17caSRaphael Isemann void Dump() { 1807caa17caSRaphael Isemann printf("(x=%i, y=%i), w=%i, h=%i)\n", origin.x, origin.y, size.width, 1817caa17caSRaphael Isemann size.height); 1827caa17caSRaphael Isemann } 1837caa17caSRaphael Isemann 1847caa17caSRaphael Isemann void Inset(int w, int h) { 1857caa17caSRaphael Isemann if (size.width > w * 2) 1867caa17caSRaphael Isemann size.width -= w * 2; 1877caa17caSRaphael Isemann origin.x += w; 1887caa17caSRaphael Isemann 1897caa17caSRaphael Isemann if (size.height > h * 2) 1907caa17caSRaphael Isemann size.height -= h * 2; 1917caa17caSRaphael Isemann origin.y += h; 1927caa17caSRaphael Isemann } 1937caa17caSRaphael Isemann 1947caa17caSRaphael Isemann // Return a status bar rectangle which is the last line of this rectangle. 1957caa17caSRaphael Isemann // This rectangle will be modified to not include the status bar area. 1967caa17caSRaphael Isemann Rect MakeStatusBar() { 1977caa17caSRaphael Isemann Rect status_bar; 1987caa17caSRaphael Isemann if (size.height > 1) { 1997caa17caSRaphael Isemann status_bar.origin.x = origin.x; 2007caa17caSRaphael Isemann status_bar.origin.y = size.height; 2017caa17caSRaphael Isemann status_bar.size.width = size.width; 2027caa17caSRaphael Isemann status_bar.size.height = 1; 2037caa17caSRaphael Isemann --size.height; 2047caa17caSRaphael Isemann } 2057caa17caSRaphael Isemann return status_bar; 2067caa17caSRaphael Isemann } 2077caa17caSRaphael Isemann 2087caa17caSRaphael Isemann // Return a menubar rectangle which is the first line of this rectangle. This 2097caa17caSRaphael Isemann // rectangle will be modified to not include the menubar area. 2107caa17caSRaphael Isemann Rect MakeMenuBar() { 2117caa17caSRaphael Isemann Rect menubar; 2127caa17caSRaphael Isemann if (size.height > 1) { 2137caa17caSRaphael Isemann menubar.origin.x = origin.x; 2147caa17caSRaphael Isemann menubar.origin.y = origin.y; 2157caa17caSRaphael Isemann menubar.size.width = size.width; 2167caa17caSRaphael Isemann menubar.size.height = 1; 2177caa17caSRaphael Isemann ++origin.y; 2187caa17caSRaphael Isemann --size.height; 2197caa17caSRaphael Isemann } 2207caa17caSRaphael Isemann return menubar; 2217caa17caSRaphael Isemann } 2227caa17caSRaphael Isemann 2237caa17caSRaphael Isemann void HorizontalSplitPercentage(float top_percentage, Rect &top, 2247caa17caSRaphael Isemann Rect &bottom) const { 2257caa17caSRaphael Isemann float top_height = top_percentage * size.height; 2267caa17caSRaphael Isemann HorizontalSplit(top_height, top, bottom); 2277caa17caSRaphael Isemann } 2287caa17caSRaphael Isemann 2297caa17caSRaphael Isemann void HorizontalSplit(int top_height, Rect &top, Rect &bottom) const { 2307caa17caSRaphael Isemann top = *this; 2317caa17caSRaphael Isemann if (top_height < size.height) { 2327caa17caSRaphael Isemann top.size.height = top_height; 2337caa17caSRaphael Isemann bottom.origin.x = origin.x; 2347caa17caSRaphael Isemann bottom.origin.y = origin.y + top.size.height; 2357caa17caSRaphael Isemann bottom.size.width = size.width; 2367caa17caSRaphael Isemann bottom.size.height = size.height - top.size.height; 2377caa17caSRaphael Isemann } else { 2387caa17caSRaphael Isemann bottom.Clear(); 2397caa17caSRaphael Isemann } 2407caa17caSRaphael Isemann } 2417caa17caSRaphael Isemann 2427caa17caSRaphael Isemann void VerticalSplitPercentage(float left_percentage, Rect &left, 2437caa17caSRaphael Isemann Rect &right) const { 2447caa17caSRaphael Isemann float left_width = left_percentage * size.width; 2457caa17caSRaphael Isemann VerticalSplit(left_width, left, right); 2467caa17caSRaphael Isemann } 2477caa17caSRaphael Isemann 2487caa17caSRaphael Isemann void VerticalSplit(int left_width, Rect &left, Rect &right) const { 2497caa17caSRaphael Isemann left = *this; 2507caa17caSRaphael Isemann if (left_width < size.width) { 2517caa17caSRaphael Isemann left.size.width = left_width; 2527caa17caSRaphael Isemann right.origin.x = origin.x + left.size.width; 2537caa17caSRaphael Isemann right.origin.y = origin.y; 2547caa17caSRaphael Isemann right.size.width = size.width - left.size.width; 2557caa17caSRaphael Isemann right.size.height = size.height; 2567caa17caSRaphael Isemann } else { 2577caa17caSRaphael Isemann right.Clear(); 2587caa17caSRaphael Isemann } 2597caa17caSRaphael Isemann } 2607caa17caSRaphael Isemann }; 2617caa17caSRaphael Isemann 2627caa17caSRaphael Isemann bool operator==(const Rect &lhs, const Rect &rhs) { 2637caa17caSRaphael Isemann return lhs.origin == rhs.origin && lhs.size == rhs.size; 2647caa17caSRaphael Isemann } 2657caa17caSRaphael Isemann 2667caa17caSRaphael Isemann bool operator!=(const Rect &lhs, const Rect &rhs) { 2677caa17caSRaphael Isemann return lhs.origin != rhs.origin || lhs.size != rhs.size; 2687caa17caSRaphael Isemann } 2697caa17caSRaphael Isemann 2707caa17caSRaphael Isemann enum HandleCharResult { 2717caa17caSRaphael Isemann eKeyNotHandled = 0, 2727caa17caSRaphael Isemann eKeyHandled = 1, 2737caa17caSRaphael Isemann eQuitApplication = 2 2747caa17caSRaphael Isemann }; 2757caa17caSRaphael Isemann 2767caa17caSRaphael Isemann enum class MenuActionResult { 2777caa17caSRaphael Isemann Handled, 2787caa17caSRaphael Isemann NotHandled, 2797caa17caSRaphael Isemann Quit // Exit all menus and quit 2807caa17caSRaphael Isemann }; 2817caa17caSRaphael Isemann 2827caa17caSRaphael Isemann struct KeyHelp { 2837caa17caSRaphael Isemann int ch; 2847caa17caSRaphael Isemann const char *description; 2857caa17caSRaphael Isemann }; 2867caa17caSRaphael Isemann 2874a8e4b5cSLuboš Luňák // COLOR_PAIR index names 2884a8e4b5cSLuboš Luňák enum { 2894a8e4b5cSLuboš Luňák // First 16 colors are 8 black background and 8 blue background colors, 2904a8e4b5cSLuboš Luňák // needed by OutputColoredStringTruncated(). 2914a8e4b5cSLuboš Luňák BlackOnBlack = 1, 2924a8e4b5cSLuboš Luňák RedOnBlack, 2934a8e4b5cSLuboš Luňák GreenOnBlack, 2944a8e4b5cSLuboš Luňák YellowOnBlack, 2954a8e4b5cSLuboš Luňák BlueOnBlack, 2964a8e4b5cSLuboš Luňák MagentaOnBlack, 2974a8e4b5cSLuboš Luňák CyanOnBlack, 2984a8e4b5cSLuboš Luňák WhiteOnBlack, 2994a8e4b5cSLuboš Luňák BlackOnBlue, 3004a8e4b5cSLuboš Luňák RedOnBlue, 3014a8e4b5cSLuboš Luňák GreenOnBlue, 3024a8e4b5cSLuboš Luňák YellowOnBlue, 3034a8e4b5cSLuboš Luňák BlueOnBlue, 3044a8e4b5cSLuboš Luňák MagentaOnBlue, 3054a8e4b5cSLuboš Luňák CyanOnBlue, 3064a8e4b5cSLuboš Luňák WhiteOnBlue, 3074a8e4b5cSLuboš Luňák // Other colors, as needed. 3084a8e4b5cSLuboš Luňák BlackOnWhite, 3094a8e4b5cSLuboš Luňák MagentaOnWhite, 3104a8e4b5cSLuboš Luňák LastColorPairIndex = MagentaOnWhite 3114a8e4b5cSLuboš Luňák }; 3124a8e4b5cSLuboš Luňák 3137caa17caSRaphael Isemann class WindowDelegate { 3147caa17caSRaphael Isemann public: 3157caa17caSRaphael Isemann virtual ~WindowDelegate() = default; 3167caa17caSRaphael Isemann 3177caa17caSRaphael Isemann virtual bool WindowDelegateDraw(Window &window, bool force) { 3187caa17caSRaphael Isemann return false; // Drawing not handled 3197caa17caSRaphael Isemann } 3207caa17caSRaphael Isemann 3217caa17caSRaphael Isemann virtual HandleCharResult WindowDelegateHandleChar(Window &window, int key) { 3227caa17caSRaphael Isemann return eKeyNotHandled; 3237caa17caSRaphael Isemann } 3247caa17caSRaphael Isemann 3257caa17caSRaphael Isemann virtual const char *WindowDelegateGetHelpText() { return nullptr; } 3267caa17caSRaphael Isemann 3277caa17caSRaphael Isemann virtual KeyHelp *WindowDelegateGetKeyHelp() { return nullptr; } 3287caa17caSRaphael Isemann }; 3297caa17caSRaphael Isemann 3307caa17caSRaphael Isemann class HelpDialogDelegate : public WindowDelegate { 3317caa17caSRaphael Isemann public: 3327caa17caSRaphael Isemann HelpDialogDelegate(const char *text, KeyHelp *key_help_array); 3337caa17caSRaphael Isemann 3347caa17caSRaphael Isemann ~HelpDialogDelegate() override; 3357caa17caSRaphael Isemann 3367caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override; 3377caa17caSRaphael Isemann 3387caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int key) override; 3397caa17caSRaphael Isemann 3407caa17caSRaphael Isemann size_t GetNumLines() const { return m_text.GetSize(); } 3417caa17caSRaphael Isemann 3427caa17caSRaphael Isemann size_t GetMaxLineLength() const { return m_text.GetMaxStringLength(); } 3437caa17caSRaphael Isemann 3447caa17caSRaphael Isemann protected: 3457caa17caSRaphael Isemann StringList m_text; 3467caa17caSRaphael Isemann int m_first_visible_line; 3477caa17caSRaphael Isemann }; 3487caa17caSRaphael Isemann 34929cc50e1SOmar Emara // A surface is an abstraction for something than can be drawn on. The surface 35029cc50e1SOmar Emara // have a width, a height, a cursor position, and a multitude of drawing 35129cc50e1SOmar Emara // operations. This type should be sub-classed to get an actually useful ncurses 35279e950a2SOmar Emara // object, such as a Window or a Pad. 35329cc50e1SOmar Emara class Surface { 3547caa17caSRaphael Isemann public: 35579e950a2SOmar Emara enum class Type { Window, Pad }; 35679e950a2SOmar Emara 35779e950a2SOmar Emara Surface(Surface::Type type) : m_type(type), m_window(nullptr) {} 3587caa17caSRaphael Isemann 35929cc50e1SOmar Emara WINDOW *get() { return m_window; } 36029cc50e1SOmar Emara 36129cc50e1SOmar Emara operator WINDOW *() { return m_window; } 36229cc50e1SOmar Emara 36379e950a2SOmar Emara Surface SubSurface(Rect bounds) { 36479e950a2SOmar Emara Surface subSurface(m_type); 36579e950a2SOmar Emara if (m_type == Type::Pad) 36679e950a2SOmar Emara subSurface.m_window = 36779e950a2SOmar Emara ::subpad(m_window, bounds.size.height, bounds.size.width, 36879e950a2SOmar Emara bounds.origin.y, bounds.origin.x); 36979e950a2SOmar Emara else 37079e950a2SOmar Emara subSurface.m_window = 37179e950a2SOmar Emara ::derwin(m_window, bounds.size.height, bounds.size.width, 37279e950a2SOmar Emara bounds.origin.y, bounds.origin.x); 37379e950a2SOmar Emara return subSurface; 37479e950a2SOmar Emara } 37579e950a2SOmar Emara 37629cc50e1SOmar Emara // Copy a region of the surface to another surface. 37729cc50e1SOmar Emara void CopyToSurface(Surface &target, Point source_origin, Point target_origin, 37829cc50e1SOmar Emara Size size) { 37929cc50e1SOmar Emara ::copywin(m_window, target.get(), source_origin.y, source_origin.x, 38029cc50e1SOmar Emara target_origin.y, target_origin.x, 38129cc50e1SOmar Emara target_origin.y + size.height - 1, 38229cc50e1SOmar Emara target_origin.x + size.width - 1, false); 3837caa17caSRaphael Isemann } 3847caa17caSRaphael Isemann 38529cc50e1SOmar Emara int GetCursorX() const { return getcurx(m_window); } 38629cc50e1SOmar Emara int GetCursorY() const { return getcury(m_window); } 38729cc50e1SOmar Emara void MoveCursor(int x, int y) { ::wmove(m_window, y, x); } 3887caa17caSRaphael Isemann 3897caa17caSRaphael Isemann void AttributeOn(attr_t attr) { ::wattron(m_window, attr); } 3907caa17caSRaphael Isemann void AttributeOff(attr_t attr) { ::wattroff(m_window, attr); } 39129cc50e1SOmar Emara 392fc0e8fb7SLuboš Luňák int GetMaxX() const { return getmaxx(m_window); } 393fc0e8fb7SLuboš Luňák int GetMaxY() const { return getmaxy(m_window); } 394fc0e8fb7SLuboš Luňák int GetWidth() const { return GetMaxX(); } 395fc0e8fb7SLuboš Luňák int GetHeight() const { return GetMaxY(); } 39629cc50e1SOmar Emara Size GetSize() const { return Size(GetWidth(), GetHeight()); } 39729cc50e1SOmar Emara // Get a zero origin rectangle width the surface size. 39829cc50e1SOmar Emara Rect GetFrame() const { return Rect(Point(), GetSize()); } 39929cc50e1SOmar Emara 40029cc50e1SOmar Emara void Clear() { ::wclear(m_window); } 40129cc50e1SOmar Emara void Erase() { ::werase(m_window); } 40229cc50e1SOmar Emara 4037caa17caSRaphael Isemann void SetBackground(int color_pair_idx) { 4047caa17caSRaphael Isemann ::wbkgd(m_window, COLOR_PAIR(color_pair_idx)); 4057caa17caSRaphael Isemann } 4067caa17caSRaphael Isemann 40729cc50e1SOmar Emara void PutChar(int ch) { ::waddch(m_window, ch); } 40829cc50e1SOmar Emara void PutCString(const char *s, int len = -1) { ::waddnstr(m_window, s, len); } 40929cc50e1SOmar Emara 41014406ca0SLuboš Luňák void PutCStringTruncated(int right_pad, const char *s, int len = -1) { 4117caa17caSRaphael Isemann int bytes_left = GetWidth() - GetCursorX(); 4127caa17caSRaphael Isemann if (bytes_left > right_pad) { 4137caa17caSRaphael Isemann bytes_left -= right_pad; 41414406ca0SLuboš Luňák ::waddnstr(m_window, s, len < 0 ? bytes_left : std::min(bytes_left, len)); 4157caa17caSRaphael Isemann } 4167caa17caSRaphael Isemann } 4177caa17caSRaphael Isemann 4187caa17caSRaphael Isemann void Printf(const char *format, ...) __attribute__((format(printf, 2, 3))) { 4197caa17caSRaphael Isemann va_list args; 4207caa17caSRaphael Isemann va_start(args, format); 4213b7795aeSRaphael Isemann vw_printw(m_window, format, args); 4227caa17caSRaphael Isemann va_end(args); 4237caa17caSRaphael Isemann } 4247caa17caSRaphael Isemann 425fc0e8fb7SLuboš Luňák void PrintfTruncated(int right_pad, const char *format, ...) 426fc0e8fb7SLuboš Luňák __attribute__((format(printf, 3, 4))) { 427fc0e8fb7SLuboš Luňák va_list args; 428fc0e8fb7SLuboš Luňák va_start(args, format); 429fc0e8fb7SLuboš Luňák StreamString strm; 430fc0e8fb7SLuboš Luňák strm.PrintfVarArg(format, args); 431fc0e8fb7SLuboš Luňák va_end(args); 432fc0e8fb7SLuboš Luňák PutCStringTruncated(right_pad, strm.GetData()); 433fc0e8fb7SLuboš Luňák } 434fc0e8fb7SLuboš Luňák 43529cc50e1SOmar Emara void VerticalLine(int n, chtype v_char = ACS_VLINE) { 43629cc50e1SOmar Emara ::wvline(m_window, v_char, n); 43729cc50e1SOmar Emara } 43829cc50e1SOmar Emara void HorizontalLine(int n, chtype h_char = ACS_HLINE) { 43929cc50e1SOmar Emara ::whline(m_window, h_char, n); 44029cc50e1SOmar Emara } 44129cc50e1SOmar Emara void Box(chtype v_char = ACS_VLINE, chtype h_char = ACS_HLINE) { 44229cc50e1SOmar Emara ::box(m_window, v_char, h_char); 44329cc50e1SOmar Emara } 44429cc50e1SOmar Emara 44529cc50e1SOmar Emara void TitledBox(const char *title, chtype v_char = ACS_VLINE, 44629cc50e1SOmar Emara chtype h_char = ACS_HLINE) { 44729cc50e1SOmar Emara Box(v_char, h_char); 44829cc50e1SOmar Emara int title_offset = 2; 44929cc50e1SOmar Emara MoveCursor(title_offset, 0); 45029cc50e1SOmar Emara PutChar('['); 45129cc50e1SOmar Emara PutCString(title, GetWidth() - title_offset); 45229cc50e1SOmar Emara PutChar(']'); 45329cc50e1SOmar Emara } 45429cc50e1SOmar Emara 45529cc50e1SOmar Emara void Box(const Rect &bounds, chtype v_char = ACS_VLINE, 45629cc50e1SOmar Emara chtype h_char = ACS_HLINE) { 45729cc50e1SOmar Emara MoveCursor(bounds.origin.x, bounds.origin.y); 45829cc50e1SOmar Emara VerticalLine(bounds.size.height); 45929cc50e1SOmar Emara HorizontalLine(bounds.size.width); 46029cc50e1SOmar Emara PutChar(ACS_ULCORNER); 46129cc50e1SOmar Emara 46229cc50e1SOmar Emara MoveCursor(bounds.origin.x + bounds.size.width - 1, bounds.origin.y); 46329cc50e1SOmar Emara VerticalLine(bounds.size.height); 46429cc50e1SOmar Emara PutChar(ACS_URCORNER); 46529cc50e1SOmar Emara 46629cc50e1SOmar Emara MoveCursor(bounds.origin.x, bounds.origin.y + bounds.size.height - 1); 46729cc50e1SOmar Emara HorizontalLine(bounds.size.width); 46829cc50e1SOmar Emara PutChar(ACS_LLCORNER); 46929cc50e1SOmar Emara 47029cc50e1SOmar Emara MoveCursor(bounds.origin.x + bounds.size.width - 1, 47129cc50e1SOmar Emara bounds.origin.y + bounds.size.height - 1); 47229cc50e1SOmar Emara PutChar(ACS_LRCORNER); 47329cc50e1SOmar Emara } 47429cc50e1SOmar Emara 47529cc50e1SOmar Emara void TitledBox(const Rect &bounds, const char *title, 47629cc50e1SOmar Emara chtype v_char = ACS_VLINE, chtype h_char = ACS_HLINE) { 47729cc50e1SOmar Emara Box(bounds, v_char, h_char); 47829cc50e1SOmar Emara int title_offset = 2; 47929cc50e1SOmar Emara MoveCursor(bounds.origin.x + title_offset, bounds.origin.y); 48029cc50e1SOmar Emara PutChar('['); 48129cc50e1SOmar Emara PutCString(title, bounds.size.width - title_offset); 48229cc50e1SOmar Emara PutChar(']'); 483fc0e8fb7SLuboš Luňák } 484fc0e8fb7SLuboš Luňák 48514406ca0SLuboš Luňák // Curses doesn't allow direct output of color escape sequences, but that's 48614406ca0SLuboš Luňák // how we get source lines from the Highligher class. Read the line and 487dcd4589aSLuboš Luňák // convert color escape sequences to curses color attributes. Use 488dcd4589aSLuboš Luňák // first_skip_count to skip leading visible characters. Returns false if all 489dcd4589aSLuboš Luňák // visible characters were skipped due to first_skip_count. 490dcd4589aSLuboš Luňák bool OutputColoredStringTruncated(int right_pad, StringRef string, 491dcd4589aSLuboš Luňák size_t skip_first_count, 49214406ca0SLuboš Luňák bool use_blue_background) { 49314406ca0SLuboš Luňák attr_t saved_attr; 49414406ca0SLuboš Luňák short saved_pair; 495dcd4589aSLuboš Luňák bool result = false; 4969dbdaea9SSterling Augustine wattr_get(m_window, &saved_attr, &saved_pair, nullptr); 49714406ca0SLuboš Luňák if (use_blue_background) 4984a8e4b5cSLuboš Luňák ::wattron(m_window, COLOR_PAIR(WhiteOnBlue)); 49914406ca0SLuboš Luňák while (!string.empty()) { 50014406ca0SLuboš Luňák size_t esc_pos = string.find('\x1b'); 50114406ca0SLuboš Luňák if (esc_pos == StringRef::npos) { 502dcd4589aSLuboš Luňák string = string.substr(skip_first_count); 503dcd4589aSLuboš Luňák if (!string.empty()) { 50414406ca0SLuboš Luňák PutCStringTruncated(right_pad, string.data(), string.size()); 505dcd4589aSLuboš Luňák result = true; 506dcd4589aSLuboš Luňák } 50714406ca0SLuboš Luňák break; 50814406ca0SLuboš Luňák } 50914406ca0SLuboš Luňák if (esc_pos > 0) { 510dcd4589aSLuboš Luňák if (skip_first_count > 0) { 511dcd4589aSLuboš Luňák int skip = std::min(esc_pos, skip_first_count); 512dcd4589aSLuboš Luňák string = string.substr(skip); 513dcd4589aSLuboš Luňák skip_first_count -= skip; 514dcd4589aSLuboš Luňák esc_pos -= skip; 515dcd4589aSLuboš Luňák } 516dcd4589aSLuboš Luňák if (esc_pos > 0) { 51714406ca0SLuboš Luňák PutCStringTruncated(right_pad, string.data(), esc_pos); 518dcd4589aSLuboš Luňák result = true; 51914406ca0SLuboš Luňák string = string.drop_front(esc_pos); 52014406ca0SLuboš Luňák } 521dcd4589aSLuboš Luňák } 52214406ca0SLuboš Luňák bool consumed = string.consume_front("\x1b"); 52314406ca0SLuboš Luňák assert(consumed); 52414406ca0SLuboš Luňák UNUSED_IF_ASSERT_DISABLED(consumed); 52514406ca0SLuboš Luňák // This is written to match our Highlighter classes, which seem to 52614406ca0SLuboš Luňák // generate only foreground color escape sequences. If necessary, this 52714406ca0SLuboš Luňák // will need to be extended. 52814406ca0SLuboš Luňák if (!string.consume_front("[")) { 52914406ca0SLuboš Luňák llvm::errs() << "Missing '[' in color escape sequence.\n"; 53014406ca0SLuboš Luňák continue; 53114406ca0SLuboš Luňák } 53214406ca0SLuboš Luňák // Only 8 basic foreground colors and reset, our Highlighter doesn't use 53314406ca0SLuboš Luňák // anything else. 53414406ca0SLuboš Luňák int value; 53514406ca0SLuboš Luňák if (!!string.consumeInteger(10, value) || // Returns false on success. 53614406ca0SLuboš Luňák !(value == 0 || (value >= 30 && value <= 37))) { 53714406ca0SLuboš Luňák llvm::errs() << "No valid color code in color escape sequence.\n"; 53814406ca0SLuboš Luňák continue; 53914406ca0SLuboš Luňák } 54014406ca0SLuboš Luňák if (!string.consume_front("m")) { 54114406ca0SLuboš Luňák llvm::errs() << "Missing 'm' in color escape sequence.\n"; 54214406ca0SLuboš Luňák continue; 54314406ca0SLuboš Luňák } 54414406ca0SLuboš Luňák if (value == 0) { // Reset. 5459dbdaea9SSterling Augustine wattr_set(m_window, saved_attr, saved_pair, nullptr); 54614406ca0SLuboš Luňák if (use_blue_background) 5474a8e4b5cSLuboš Luňák ::wattron(m_window, COLOR_PAIR(WhiteOnBlue)); 54814406ca0SLuboš Luňák } else { 54914406ca0SLuboš Luňák // Mapped directly to first 16 color pairs (black/blue background). 55014406ca0SLuboš Luňák ::wattron(m_window, 55114406ca0SLuboš Luňák COLOR_PAIR(value - 30 + 1 + (use_blue_background ? 8 : 0))); 55214406ca0SLuboš Luňák } 55314406ca0SLuboš Luňák } 5549dbdaea9SSterling Augustine wattr_set(m_window, saved_attr, saved_pair, nullptr); 555dcd4589aSLuboš Luňák return result; 55614406ca0SLuboš Luňák } 55714406ca0SLuboš Luňák 55829cc50e1SOmar Emara protected: 55979e950a2SOmar Emara Type m_type; 56029cc50e1SOmar Emara WINDOW *m_window; 56129cc50e1SOmar Emara }; 56229cc50e1SOmar Emara 56329cc50e1SOmar Emara class Pad : public Surface { 56429cc50e1SOmar Emara public: 56579e950a2SOmar Emara Pad(Size size) : Surface(Surface::Type::Pad) { 56679e950a2SOmar Emara m_window = ::newpad(size.height, size.width); 56779e950a2SOmar Emara } 56829cc50e1SOmar Emara 56929cc50e1SOmar Emara ~Pad() { ::delwin(m_window); } 57029cc50e1SOmar Emara }; 57129cc50e1SOmar Emara 57229cc50e1SOmar Emara class Window : public Surface { 57329cc50e1SOmar Emara public: 57429cc50e1SOmar Emara Window(const char *name) 57579e950a2SOmar Emara : Surface(Surface::Type::Window), m_name(name), m_panel(nullptr), 57679e950a2SOmar Emara m_parent(nullptr), m_subwindows(), m_delegate_sp(), 57779e950a2SOmar Emara m_curr_active_window_idx(UINT32_MAX), 57829cc50e1SOmar Emara m_prev_active_window_idx(UINT32_MAX), m_delete(false), 57929cc50e1SOmar Emara m_needs_update(true), m_can_activate(true), m_is_subwin(false) {} 58029cc50e1SOmar Emara 58129cc50e1SOmar Emara Window(const char *name, WINDOW *w, bool del = true) 58279e950a2SOmar Emara : Surface(Surface::Type::Window), m_name(name), m_panel(nullptr), 58379e950a2SOmar Emara m_parent(nullptr), m_subwindows(), m_delegate_sp(), 58479e950a2SOmar Emara m_curr_active_window_idx(UINT32_MAX), 58529cc50e1SOmar Emara m_prev_active_window_idx(UINT32_MAX), m_delete(del), 58629cc50e1SOmar Emara m_needs_update(true), m_can_activate(true), m_is_subwin(false) { 58729cc50e1SOmar Emara if (w) 58829cc50e1SOmar Emara Reset(w); 58929cc50e1SOmar Emara } 59029cc50e1SOmar Emara 59129cc50e1SOmar Emara Window(const char *name, const Rect &bounds) 59279e950a2SOmar Emara : Surface(Surface::Type::Window), m_name(name), m_parent(nullptr), 59379e950a2SOmar Emara m_subwindows(), m_delegate_sp(), m_curr_active_window_idx(UINT32_MAX), 59429cc50e1SOmar Emara m_prev_active_window_idx(UINT32_MAX), m_delete(true), 59529cc50e1SOmar Emara m_needs_update(true), m_can_activate(true), m_is_subwin(false) { 59629cc50e1SOmar Emara Reset(::newwin(bounds.size.height, bounds.size.width, bounds.origin.y, 59729cc50e1SOmar Emara bounds.origin.y)); 59829cc50e1SOmar Emara } 59929cc50e1SOmar Emara 60029cc50e1SOmar Emara virtual ~Window() { 60129cc50e1SOmar Emara RemoveSubWindows(); 60229cc50e1SOmar Emara Reset(); 60329cc50e1SOmar Emara } 60429cc50e1SOmar Emara 60529cc50e1SOmar Emara void Reset(WINDOW *w = nullptr, bool del = true) { 60629cc50e1SOmar Emara if (m_window == w) 60729cc50e1SOmar Emara return; 60829cc50e1SOmar Emara 60929cc50e1SOmar Emara if (m_panel) { 61029cc50e1SOmar Emara ::del_panel(m_panel); 61129cc50e1SOmar Emara m_panel = nullptr; 61229cc50e1SOmar Emara } 61329cc50e1SOmar Emara if (m_window && m_delete) { 61429cc50e1SOmar Emara ::delwin(m_window); 61529cc50e1SOmar Emara m_window = nullptr; 61629cc50e1SOmar Emara m_delete = false; 61729cc50e1SOmar Emara } 61829cc50e1SOmar Emara if (w) { 61929cc50e1SOmar Emara m_window = w; 62029cc50e1SOmar Emara m_panel = ::new_panel(m_window); 62129cc50e1SOmar Emara m_delete = del; 62229cc50e1SOmar Emara } 62329cc50e1SOmar Emara } 6240321dbc8SOmar Emara 62529cc50e1SOmar Emara // Get the rectangle in our parent window 62629cc50e1SOmar Emara Rect GetBounds() const { return Rect(GetParentOrigin(), GetSize()); } 6270321dbc8SOmar Emara 6280321dbc8SOmar Emara Rect GetCenteredRect(int width, int height) { 6290321dbc8SOmar Emara Size size = GetSize(); 6300321dbc8SOmar Emara width = std::min(size.width, width); 6310321dbc8SOmar Emara height = std::min(size.height, height); 6320321dbc8SOmar Emara int x = (size.width - width) / 2; 6330321dbc8SOmar Emara int y = (size.height - height) / 2; 6340321dbc8SOmar Emara return Rect(Point(x, y), Size(width, height)); 6350321dbc8SOmar Emara } 6360321dbc8SOmar Emara 63729cc50e1SOmar Emara int GetChar() { return ::wgetch(m_window); } 63829cc50e1SOmar Emara Point GetParentOrigin() const { return Point(GetParentX(), GetParentY()); } 63929cc50e1SOmar Emara int GetParentX() const { return getparx(m_window); } 64029cc50e1SOmar Emara int GetParentY() const { return getpary(m_window); } 64129cc50e1SOmar Emara void MoveWindow(int x, int y) { MoveWindow(Point(x, y)); } 64229cc50e1SOmar Emara void Resize(int w, int h) { ::wresize(m_window, h, w); } 64329cc50e1SOmar Emara void Resize(const Size &size) { 64429cc50e1SOmar Emara ::wresize(m_window, size.height, size.width); 64529cc50e1SOmar Emara } 64629cc50e1SOmar Emara void MoveWindow(const Point &origin) { 64729cc50e1SOmar Emara const bool moving_window = origin != GetParentOrigin(); 64829cc50e1SOmar Emara if (m_is_subwin && moving_window) { 64929cc50e1SOmar Emara // Can't move subwindows, must delete and re-create 65029cc50e1SOmar Emara Size size = GetSize(); 65129cc50e1SOmar Emara Reset(::subwin(m_parent->m_window, size.height, size.width, origin.y, 65229cc50e1SOmar Emara origin.x), 65329cc50e1SOmar Emara true); 65429cc50e1SOmar Emara } else { 65529cc50e1SOmar Emara ::mvwin(m_window, origin.y, origin.x); 65629cc50e1SOmar Emara } 65729cc50e1SOmar Emara } 65829cc50e1SOmar Emara 65929cc50e1SOmar Emara void SetBounds(const Rect &bounds) { 66029cc50e1SOmar Emara const bool moving_window = bounds.origin != GetParentOrigin(); 66129cc50e1SOmar Emara if (m_is_subwin && moving_window) { 66229cc50e1SOmar Emara // Can't move subwindows, must delete and re-create 66329cc50e1SOmar Emara Reset(::subwin(m_parent->m_window, bounds.size.height, bounds.size.width, 66429cc50e1SOmar Emara bounds.origin.y, bounds.origin.x), 66529cc50e1SOmar Emara true); 66629cc50e1SOmar Emara } else { 66729cc50e1SOmar Emara if (moving_window) 66829cc50e1SOmar Emara MoveWindow(bounds.origin); 66929cc50e1SOmar Emara Resize(bounds.size); 67029cc50e1SOmar Emara } 67129cc50e1SOmar Emara } 67229cc50e1SOmar Emara 6737caa17caSRaphael Isemann void Touch() { 6747caa17caSRaphael Isemann ::touchwin(m_window); 6757caa17caSRaphael Isemann if (m_parent) 6767caa17caSRaphael Isemann m_parent->Touch(); 6777caa17caSRaphael Isemann } 6787caa17caSRaphael Isemann 6797caa17caSRaphael Isemann WindowSP CreateSubWindow(const char *name, const Rect &bounds, 6807caa17caSRaphael Isemann bool make_active) { 6817caa17caSRaphael Isemann auto get_window = [this, &bounds]() { 6827caa17caSRaphael Isemann return m_window 6837caa17caSRaphael Isemann ? ::subwin(m_window, bounds.size.height, bounds.size.width, 6847caa17caSRaphael Isemann bounds.origin.y, bounds.origin.x) 6857caa17caSRaphael Isemann : ::newwin(bounds.size.height, bounds.size.width, 6867caa17caSRaphael Isemann bounds.origin.y, bounds.origin.x); 6877caa17caSRaphael Isemann }; 6887caa17caSRaphael Isemann WindowSP subwindow_sp = std::make_shared<Window>(name, get_window(), true); 6897caa17caSRaphael Isemann subwindow_sp->m_is_subwin = subwindow_sp.operator bool(); 6907caa17caSRaphael Isemann subwindow_sp->m_parent = this; 6917caa17caSRaphael Isemann if (make_active) { 6927caa17caSRaphael Isemann m_prev_active_window_idx = m_curr_active_window_idx; 6937caa17caSRaphael Isemann m_curr_active_window_idx = m_subwindows.size(); 6947caa17caSRaphael Isemann } 6957caa17caSRaphael Isemann m_subwindows.push_back(subwindow_sp); 6967caa17caSRaphael Isemann ::top_panel(subwindow_sp->m_panel); 6977caa17caSRaphael Isemann m_needs_update = true; 6987caa17caSRaphael Isemann return subwindow_sp; 6997caa17caSRaphael Isemann } 7007caa17caSRaphael Isemann 7017caa17caSRaphael Isemann bool RemoveSubWindow(Window *window) { 7027caa17caSRaphael Isemann Windows::iterator pos, end = m_subwindows.end(); 7037caa17caSRaphael Isemann size_t i = 0; 7047caa17caSRaphael Isemann for (pos = m_subwindows.begin(); pos != end; ++pos, ++i) { 7057caa17caSRaphael Isemann if ((*pos).get() == window) { 7067caa17caSRaphael Isemann if (m_prev_active_window_idx == i) 7077caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 7087caa17caSRaphael Isemann else if (m_prev_active_window_idx != UINT32_MAX && 7097caa17caSRaphael Isemann m_prev_active_window_idx > i) 7107caa17caSRaphael Isemann --m_prev_active_window_idx; 7117caa17caSRaphael Isemann 7127caa17caSRaphael Isemann if (m_curr_active_window_idx == i) 7137caa17caSRaphael Isemann m_curr_active_window_idx = UINT32_MAX; 7147caa17caSRaphael Isemann else if (m_curr_active_window_idx != UINT32_MAX && 7157caa17caSRaphael Isemann m_curr_active_window_idx > i) 7167caa17caSRaphael Isemann --m_curr_active_window_idx; 7177caa17caSRaphael Isemann window->Erase(); 7187caa17caSRaphael Isemann m_subwindows.erase(pos); 7197caa17caSRaphael Isemann m_needs_update = true; 7207caa17caSRaphael Isemann if (m_parent) 7217caa17caSRaphael Isemann m_parent->Touch(); 7227caa17caSRaphael Isemann else 7237caa17caSRaphael Isemann ::touchwin(stdscr); 7247caa17caSRaphael Isemann return true; 7257caa17caSRaphael Isemann } 7267caa17caSRaphael Isemann } 7277caa17caSRaphael Isemann return false; 7287caa17caSRaphael Isemann } 7297caa17caSRaphael Isemann 7307caa17caSRaphael Isemann WindowSP FindSubWindow(const char *name) { 7317caa17caSRaphael Isemann Windows::iterator pos, end = m_subwindows.end(); 7327caa17caSRaphael Isemann size_t i = 0; 7337caa17caSRaphael Isemann for (pos = m_subwindows.begin(); pos != end; ++pos, ++i) { 7347caa17caSRaphael Isemann if ((*pos)->m_name == name) 7357caa17caSRaphael Isemann return *pos; 7367caa17caSRaphael Isemann } 7377caa17caSRaphael Isemann return WindowSP(); 7387caa17caSRaphael Isemann } 7397caa17caSRaphael Isemann 7407caa17caSRaphael Isemann void RemoveSubWindows() { 7417caa17caSRaphael Isemann m_curr_active_window_idx = UINT32_MAX; 7427caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 7437caa17caSRaphael Isemann for (Windows::iterator pos = m_subwindows.begin(); 7447caa17caSRaphael Isemann pos != m_subwindows.end(); pos = m_subwindows.erase(pos)) { 7457caa17caSRaphael Isemann (*pos)->Erase(); 7467caa17caSRaphael Isemann } 7477caa17caSRaphael Isemann if (m_parent) 7487caa17caSRaphael Isemann m_parent->Touch(); 7497caa17caSRaphael Isemann else 7507caa17caSRaphael Isemann ::touchwin(stdscr); 7517caa17caSRaphael Isemann } 7527caa17caSRaphael Isemann 7537caa17caSRaphael Isemann // Window drawing utilities 7547caa17caSRaphael Isemann void DrawTitleBox(const char *title, const char *bottom_message = nullptr) { 7557caa17caSRaphael Isemann attr_t attr = 0; 7567caa17caSRaphael Isemann if (IsActive()) 7574a8e4b5cSLuboš Luňák attr = A_BOLD | COLOR_PAIR(BlackOnWhite); 7587caa17caSRaphael Isemann else 7597caa17caSRaphael Isemann attr = 0; 7607caa17caSRaphael Isemann if (attr) 7617caa17caSRaphael Isemann AttributeOn(attr); 7627caa17caSRaphael Isemann 7637caa17caSRaphael Isemann Box(); 7647caa17caSRaphael Isemann MoveCursor(3, 0); 7657caa17caSRaphael Isemann 7667caa17caSRaphael Isemann if (title && title[0]) { 7677caa17caSRaphael Isemann PutChar('<'); 7687caa17caSRaphael Isemann PutCString(title); 7697caa17caSRaphael Isemann PutChar('>'); 7707caa17caSRaphael Isemann } 7717caa17caSRaphael Isemann 7727caa17caSRaphael Isemann if (bottom_message && bottom_message[0]) { 7737caa17caSRaphael Isemann int bottom_message_length = strlen(bottom_message); 7747caa17caSRaphael Isemann int x = GetWidth() - 3 - (bottom_message_length + 2); 7757caa17caSRaphael Isemann 7767caa17caSRaphael Isemann if (x > 0) { 7777caa17caSRaphael Isemann MoveCursor(x, GetHeight() - 1); 7787caa17caSRaphael Isemann PutChar('['); 7797caa17caSRaphael Isemann PutCString(bottom_message); 7807caa17caSRaphael Isemann PutChar(']'); 7817caa17caSRaphael Isemann } else { 7827caa17caSRaphael Isemann MoveCursor(1, GetHeight() - 1); 7837caa17caSRaphael Isemann PutChar('['); 784fc0e8fb7SLuboš Luňák PutCStringTruncated(1, bottom_message); 7857caa17caSRaphael Isemann } 7867caa17caSRaphael Isemann } 7877caa17caSRaphael Isemann if (attr) 7887caa17caSRaphael Isemann AttributeOff(attr); 7897caa17caSRaphael Isemann } 7907caa17caSRaphael Isemann 7917caa17caSRaphael Isemann virtual void Draw(bool force) { 7927caa17caSRaphael Isemann if (m_delegate_sp && m_delegate_sp->WindowDelegateDraw(*this, force)) 7937caa17caSRaphael Isemann return; 7947caa17caSRaphael Isemann 7957caa17caSRaphael Isemann for (auto &subwindow_sp : m_subwindows) 7967caa17caSRaphael Isemann subwindow_sp->Draw(force); 7977caa17caSRaphael Isemann } 7987caa17caSRaphael Isemann 7997caa17caSRaphael Isemann bool CreateHelpSubwindow() { 8007caa17caSRaphael Isemann if (m_delegate_sp) { 8017caa17caSRaphael Isemann const char *text = m_delegate_sp->WindowDelegateGetHelpText(); 8027caa17caSRaphael Isemann KeyHelp *key_help = m_delegate_sp->WindowDelegateGetKeyHelp(); 8037caa17caSRaphael Isemann if ((text && text[0]) || key_help) { 8047caa17caSRaphael Isemann std::unique_ptr<HelpDialogDelegate> help_delegate_up( 8057caa17caSRaphael Isemann new HelpDialogDelegate(text, key_help)); 8067caa17caSRaphael Isemann const size_t num_lines = help_delegate_up->GetNumLines(); 8077caa17caSRaphael Isemann const size_t max_length = help_delegate_up->GetMaxLineLength(); 8087caa17caSRaphael Isemann Rect bounds = GetBounds(); 8097caa17caSRaphael Isemann bounds.Inset(1, 1); 8107caa17caSRaphael Isemann if (max_length + 4 < static_cast<size_t>(bounds.size.width)) { 8117caa17caSRaphael Isemann bounds.origin.x += (bounds.size.width - max_length + 4) / 2; 8127caa17caSRaphael Isemann bounds.size.width = max_length + 4; 8137caa17caSRaphael Isemann } else { 8147caa17caSRaphael Isemann if (bounds.size.width > 100) { 8157caa17caSRaphael Isemann const int inset_w = bounds.size.width / 4; 8167caa17caSRaphael Isemann bounds.origin.x += inset_w; 8177caa17caSRaphael Isemann bounds.size.width -= 2 * inset_w; 8187caa17caSRaphael Isemann } 8197caa17caSRaphael Isemann } 8207caa17caSRaphael Isemann 8217caa17caSRaphael Isemann if (num_lines + 2 < static_cast<size_t>(bounds.size.height)) { 8227caa17caSRaphael Isemann bounds.origin.y += (bounds.size.height - num_lines + 2) / 2; 8237caa17caSRaphael Isemann bounds.size.height = num_lines + 2; 8247caa17caSRaphael Isemann } else { 8257caa17caSRaphael Isemann if (bounds.size.height > 100) { 8267caa17caSRaphael Isemann const int inset_h = bounds.size.height / 4; 8277caa17caSRaphael Isemann bounds.origin.y += inset_h; 8287caa17caSRaphael Isemann bounds.size.height -= 2 * inset_h; 8297caa17caSRaphael Isemann } 8307caa17caSRaphael Isemann } 8317caa17caSRaphael Isemann WindowSP help_window_sp; 8327caa17caSRaphael Isemann Window *parent_window = GetParent(); 8337caa17caSRaphael Isemann if (parent_window) 8347caa17caSRaphael Isemann help_window_sp = parent_window->CreateSubWindow("Help", bounds, true); 8357caa17caSRaphael Isemann else 8367caa17caSRaphael Isemann help_window_sp = CreateSubWindow("Help", bounds, true); 8377caa17caSRaphael Isemann help_window_sp->SetDelegate( 8387caa17caSRaphael Isemann WindowDelegateSP(help_delegate_up.release())); 8397caa17caSRaphael Isemann return true; 8407caa17caSRaphael Isemann } 8417caa17caSRaphael Isemann } 8427caa17caSRaphael Isemann return false; 8437caa17caSRaphael Isemann } 8447caa17caSRaphael Isemann 8457caa17caSRaphael Isemann virtual HandleCharResult HandleChar(int key) { 8467caa17caSRaphael Isemann // Always check the active window first 8477caa17caSRaphael Isemann HandleCharResult result = eKeyNotHandled; 8487caa17caSRaphael Isemann WindowSP active_window_sp = GetActiveWindow(); 8497caa17caSRaphael Isemann if (active_window_sp) { 8507caa17caSRaphael Isemann result = active_window_sp->HandleChar(key); 8517caa17caSRaphael Isemann if (result != eKeyNotHandled) 8527caa17caSRaphael Isemann return result; 8537caa17caSRaphael Isemann } 8547caa17caSRaphael Isemann 8557caa17caSRaphael Isemann if (m_delegate_sp) { 8567caa17caSRaphael Isemann result = m_delegate_sp->WindowDelegateHandleChar(*this, key); 8577caa17caSRaphael Isemann if (result != eKeyNotHandled) 8587caa17caSRaphael Isemann return result; 8597caa17caSRaphael Isemann } 8607caa17caSRaphael Isemann 8617caa17caSRaphael Isemann // Then check for any windows that want any keys that weren't handled. This 8627caa17caSRaphael Isemann // is typically only for a menubar. Make a copy of the subwindows in case 8637caa17caSRaphael Isemann // any HandleChar() functions muck with the subwindows. If we don't do 8647caa17caSRaphael Isemann // this, we can crash when iterating over the subwindows. 8657caa17caSRaphael Isemann Windows subwindows(m_subwindows); 8667caa17caSRaphael Isemann for (auto subwindow_sp : subwindows) { 8677caa17caSRaphael Isemann if (!subwindow_sp->m_can_activate) { 8687caa17caSRaphael Isemann HandleCharResult result = subwindow_sp->HandleChar(key); 8697caa17caSRaphael Isemann if (result != eKeyNotHandled) 8707caa17caSRaphael Isemann return result; 8717caa17caSRaphael Isemann } 8727caa17caSRaphael Isemann } 8737caa17caSRaphael Isemann 8747caa17caSRaphael Isemann return eKeyNotHandled; 8757caa17caSRaphael Isemann } 8767caa17caSRaphael Isemann 8777caa17caSRaphael Isemann WindowSP GetActiveWindow() { 8787caa17caSRaphael Isemann if (!m_subwindows.empty()) { 8797caa17caSRaphael Isemann if (m_curr_active_window_idx >= m_subwindows.size()) { 8807caa17caSRaphael Isemann if (m_prev_active_window_idx < m_subwindows.size()) { 8817caa17caSRaphael Isemann m_curr_active_window_idx = m_prev_active_window_idx; 8827caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 8837caa17caSRaphael Isemann } else if (IsActive()) { 8847caa17caSRaphael Isemann m_prev_active_window_idx = UINT32_MAX; 8857caa17caSRaphael Isemann m_curr_active_window_idx = UINT32_MAX; 8867caa17caSRaphael Isemann 8877caa17caSRaphael Isemann // Find first window that wants to be active if this window is active 8887caa17caSRaphael Isemann const size_t num_subwindows = m_subwindows.size(); 8897caa17caSRaphael Isemann for (size_t i = 0; i < num_subwindows; ++i) { 8907caa17caSRaphael Isemann if (m_subwindows[i]->GetCanBeActive()) { 8917caa17caSRaphael Isemann m_curr_active_window_idx = i; 8927caa17caSRaphael Isemann break; 8937caa17caSRaphael Isemann } 8947caa17caSRaphael Isemann } 8957caa17caSRaphael Isemann } 8967caa17caSRaphael Isemann } 8977caa17caSRaphael Isemann 8987caa17caSRaphael Isemann if (m_curr_active_window_idx < m_subwindows.size()) 8997caa17caSRaphael Isemann return m_subwindows[m_curr_active_window_idx]; 9007caa17caSRaphael Isemann } 9017caa17caSRaphael Isemann return WindowSP(); 9027caa17caSRaphael Isemann } 9037caa17caSRaphael Isemann 9047caa17caSRaphael Isemann bool GetCanBeActive() const { return m_can_activate; } 9057caa17caSRaphael Isemann 9067caa17caSRaphael Isemann void SetCanBeActive(bool b) { m_can_activate = b; } 9077caa17caSRaphael Isemann 9087caa17caSRaphael Isemann void SetDelegate(const WindowDelegateSP &delegate_sp) { 9097caa17caSRaphael Isemann m_delegate_sp = delegate_sp; 9107caa17caSRaphael Isemann } 9117caa17caSRaphael Isemann 9127caa17caSRaphael Isemann Window *GetParent() const { return m_parent; } 9137caa17caSRaphael Isemann 9147caa17caSRaphael Isemann bool IsActive() const { 9157caa17caSRaphael Isemann if (m_parent) 9167caa17caSRaphael Isemann return m_parent->GetActiveWindow().get() == this; 9177caa17caSRaphael Isemann else 9187caa17caSRaphael Isemann return true; // Top level window is always active 9197caa17caSRaphael Isemann } 9207caa17caSRaphael Isemann 9217caa17caSRaphael Isemann void SelectNextWindowAsActive() { 9227caa17caSRaphael Isemann // Move active focus to next window 9237a63dc53SLuboš Luňák const int num_subwindows = m_subwindows.size(); 9247a63dc53SLuboš Luňák int start_idx = 0; 9257a63dc53SLuboš Luňák if (m_curr_active_window_idx != UINT32_MAX) { 9267caa17caSRaphael Isemann m_prev_active_window_idx = m_curr_active_window_idx; 9277a63dc53SLuboš Luňák start_idx = m_curr_active_window_idx + 1; 9287a63dc53SLuboš Luňák } 9297a63dc53SLuboš Luňák for (int idx = start_idx; idx < num_subwindows; ++idx) { 9307caa17caSRaphael Isemann if (m_subwindows[idx]->GetCanBeActive()) { 9317caa17caSRaphael Isemann m_curr_active_window_idx = idx; 9327a63dc53SLuboš Luňák return; 9337caa17caSRaphael Isemann } 9347caa17caSRaphael Isemann } 9357a63dc53SLuboš Luňák for (int idx = 0; idx < start_idx; ++idx) { 9367caa17caSRaphael Isemann if (m_subwindows[idx]->GetCanBeActive()) { 9377caa17caSRaphael Isemann m_curr_active_window_idx = idx; 9387caa17caSRaphael Isemann break; 9397caa17caSRaphael Isemann } 9407caa17caSRaphael Isemann } 9417caa17caSRaphael Isemann } 9427a63dc53SLuboš Luňák 9437a63dc53SLuboš Luňák void SelectPreviousWindowAsActive() { 9447a63dc53SLuboš Luňák // Move active focus to previous window 9457a63dc53SLuboš Luňák const int num_subwindows = m_subwindows.size(); 9467a63dc53SLuboš Luňák int start_idx = num_subwindows - 1; 9477a63dc53SLuboš Luňák if (m_curr_active_window_idx != UINT32_MAX) { 9487caa17caSRaphael Isemann m_prev_active_window_idx = m_curr_active_window_idx; 9497a63dc53SLuboš Luňák start_idx = m_curr_active_window_idx - 1; 9507a63dc53SLuboš Luňák } 9517a63dc53SLuboš Luňák for (int idx = start_idx; idx >= 0; --idx) { 9527a63dc53SLuboš Luňák if (m_subwindows[idx]->GetCanBeActive()) { 9537a63dc53SLuboš Luňák m_curr_active_window_idx = idx; 9547a63dc53SLuboš Luňák return; 9557a63dc53SLuboš Luňák } 9567a63dc53SLuboš Luňák } 9577a63dc53SLuboš Luňák for (int idx = num_subwindows - 1; idx > start_idx; --idx) { 9587caa17caSRaphael Isemann if (m_subwindows[idx]->GetCanBeActive()) { 9597caa17caSRaphael Isemann m_curr_active_window_idx = idx; 9607caa17caSRaphael Isemann break; 9617caa17caSRaphael Isemann } 9627caa17caSRaphael Isemann } 9637caa17caSRaphael Isemann } 9647caa17caSRaphael Isemann 9657caa17caSRaphael Isemann const char *GetName() const { return m_name.c_str(); } 9667caa17caSRaphael Isemann 9677caa17caSRaphael Isemann protected: 9687caa17caSRaphael Isemann std::string m_name; 9697caa17caSRaphael Isemann PANEL *m_panel; 9707caa17caSRaphael Isemann Window *m_parent; 9717caa17caSRaphael Isemann Windows m_subwindows; 9727caa17caSRaphael Isemann WindowDelegateSP m_delegate_sp; 9737caa17caSRaphael Isemann uint32_t m_curr_active_window_idx; 9747caa17caSRaphael Isemann uint32_t m_prev_active_window_idx; 9757caa17caSRaphael Isemann bool m_delete; 9767caa17caSRaphael Isemann bool m_needs_update; 9777caa17caSRaphael Isemann bool m_can_activate; 9787caa17caSRaphael Isemann bool m_is_subwin; 9797caa17caSRaphael Isemann 9807caa17caSRaphael Isemann private: 981eaebcbc6SKonrad Kleine Window(const Window &) = delete; 982eaebcbc6SKonrad Kleine const Window &operator=(const Window &) = delete; 9837caa17caSRaphael Isemann }; 9847caa17caSRaphael Isemann 98529cc50e1SOmar Emara ///////// 98629cc50e1SOmar Emara // Forms 98729cc50e1SOmar Emara ///////// 98829cc50e1SOmar Emara 98929cc50e1SOmar Emara // A scroll context defines a vertical region that needs to be visible in a 99029cc50e1SOmar Emara // scrolling area. The region is defined by the index of the start and end lines 99129cc50e1SOmar Emara // of the region. The start and end lines may be equal, in which case, the 99229cc50e1SOmar Emara // region is a single line. 99329cc50e1SOmar Emara struct ScrollContext { 99429cc50e1SOmar Emara int start; 99529cc50e1SOmar Emara int end; 99629cc50e1SOmar Emara 99729cc50e1SOmar Emara ScrollContext(int line) : start(line), end(line) {} 99829cc50e1SOmar Emara ScrollContext(int _start, int _end) : start(_start), end(_end) {} 99929cc50e1SOmar Emara 100029cc50e1SOmar Emara void Offset(int offset) { 100129cc50e1SOmar Emara start += offset; 100229cc50e1SOmar Emara end += offset; 100329cc50e1SOmar Emara } 100429cc50e1SOmar Emara }; 100529cc50e1SOmar Emara 100629cc50e1SOmar Emara class FieldDelegate { 100729cc50e1SOmar Emara public: 100829cc50e1SOmar Emara virtual ~FieldDelegate() = default; 100929cc50e1SOmar Emara 101029cc50e1SOmar Emara // Returns the number of lines needed to draw the field. The draw method will 101129cc50e1SOmar Emara // be given a surface that have exactly this number of lines. 101229cc50e1SOmar Emara virtual int FieldDelegateGetHeight() = 0; 101329cc50e1SOmar Emara 101429cc50e1SOmar Emara // Returns the scroll context in the local coordinates of the field. By 101529cc50e1SOmar Emara // default, the scroll context spans the whole field. Bigger fields with 101629cc50e1SOmar Emara // internal navigation should override this method to provide a finer context. 101729cc50e1SOmar Emara // Typical override methods would first get the scroll context of the internal 101829cc50e1SOmar Emara // element then add the offset of the element in the field. 101929cc50e1SOmar Emara virtual ScrollContext FieldDelegateGetScrollContext() { 102029cc50e1SOmar Emara return ScrollContext(0, FieldDelegateGetHeight() - 1); 102129cc50e1SOmar Emara } 102229cc50e1SOmar Emara 102329cc50e1SOmar Emara // Draw the field in the given subpad surface. The surface have a height that 102429cc50e1SOmar Emara // is equal to the height returned by FieldDelegateGetHeight(). If the field 102529cc50e1SOmar Emara // is selected in the form window, then is_selected will be true. 102679e950a2SOmar Emara virtual void FieldDelegateDraw(Surface &surface, bool is_selected) = 0; 102729cc50e1SOmar Emara 102829cc50e1SOmar Emara // Handle the key that wasn't handled by the form window or a container field. 102929cc50e1SOmar Emara virtual HandleCharResult FieldDelegateHandleChar(int key) { 103029cc50e1SOmar Emara return eKeyNotHandled; 103129cc50e1SOmar Emara } 103229cc50e1SOmar Emara 103329cc50e1SOmar Emara // This is executed once the user exists the field, that is, once the user 103429cc50e1SOmar Emara // navigates to the next or the previous field. This is particularly useful to 103529cc50e1SOmar Emara // do in-field validation and error setting. Fields with internal navigation 103629cc50e1SOmar Emara // should call this method on their fields. 103729cc50e1SOmar Emara virtual void FieldDelegateExitCallback() { return; } 103829cc50e1SOmar Emara 103929cc50e1SOmar Emara // Fields may have internal navigation, for instance, a List Field have 104029cc50e1SOmar Emara // multiple internal elements, which needs to be navigated. To allow for this 104129cc50e1SOmar Emara // mechanism, the window shouldn't handle the navigation keys all the time, 104229cc50e1SOmar Emara // and instead call the key handing method of the selected field. It should 104329cc50e1SOmar Emara // only handle the navigation keys when the field contains a single element or 104429cc50e1SOmar Emara // have the last or first element selected depending on if the user is 104529cc50e1SOmar Emara // navigating forward or backward. Additionally, once a field is selected in 104629cc50e1SOmar Emara // the forward or backward direction, its first or last internal element 104729cc50e1SOmar Emara // should be selected. The following methods implements those mechanisms. 104829cc50e1SOmar Emara 104929cc50e1SOmar Emara // Returns true if the first element in the field is selected or if the field 105029cc50e1SOmar Emara // contains a single element. 105129cc50e1SOmar Emara virtual bool FieldDelegateOnFirstOrOnlyElement() { return true; } 105229cc50e1SOmar Emara 105329cc50e1SOmar Emara // Returns true if the last element in the field is selected or if the field 105429cc50e1SOmar Emara // contains a single element. 105529cc50e1SOmar Emara virtual bool FieldDelegateOnLastOrOnlyElement() { return true; } 105629cc50e1SOmar Emara 105729cc50e1SOmar Emara // Select the first element in the field if multiple elements exists. 105829cc50e1SOmar Emara virtual void FieldDelegateSelectFirstElement() { return; } 105929cc50e1SOmar Emara 106029cc50e1SOmar Emara // Select the last element in the field if multiple elements exists. 106129cc50e1SOmar Emara virtual void FieldDelegateSelectLastElement() { return; } 10620321dbc8SOmar Emara 106380ac12b7SOmar Emara // Returns true if the field has an error, false otherwise. 106480ac12b7SOmar Emara virtual bool FieldDelegateHasError() { return false; } 106580ac12b7SOmar Emara 10660321dbc8SOmar Emara bool FieldDelegateIsVisible() { return m_is_visible; } 10670321dbc8SOmar Emara 10680321dbc8SOmar Emara void FieldDelegateHide() { m_is_visible = false; } 10690321dbc8SOmar Emara 10700321dbc8SOmar Emara void FieldDelegateShow() { m_is_visible = true; } 10710321dbc8SOmar Emara 10720321dbc8SOmar Emara protected: 10730321dbc8SOmar Emara bool m_is_visible = true; 107429cc50e1SOmar Emara }; 107529cc50e1SOmar Emara 10760321dbc8SOmar Emara typedef std::unique_ptr<FieldDelegate> FieldDelegateUP; 107729cc50e1SOmar Emara 107829cc50e1SOmar Emara class TextFieldDelegate : public FieldDelegate { 107929cc50e1SOmar Emara public: 10809ef7de7cSOmar Emara TextFieldDelegate(const char *label, const char *content, bool required) 10819ef7de7cSOmar Emara : m_label(label), m_required(required), m_cursor_position(0), 10829ef7de7cSOmar Emara m_first_visibile_char(0) { 108329cc50e1SOmar Emara if (content) 108429cc50e1SOmar Emara m_content = content; 108529cc50e1SOmar Emara } 108629cc50e1SOmar Emara 108729cc50e1SOmar Emara // Text fields are drawn as titled boxes of a single line, with a possible 108829cc50e1SOmar Emara // error messages at the end. 108929cc50e1SOmar Emara // 109029cc50e1SOmar Emara // __[Label]___________ 109129cc50e1SOmar Emara // | | 109229cc50e1SOmar Emara // |__________________| 109329cc50e1SOmar Emara // - Error message if it exists. 109429cc50e1SOmar Emara 109529cc50e1SOmar Emara // The text field has a height of 3 lines. 2 lines for borders and 1 line for 109629cc50e1SOmar Emara // the content. 109729cc50e1SOmar Emara int GetFieldHeight() { return 3; } 109829cc50e1SOmar Emara 109929cc50e1SOmar Emara // The text field has a full height of 3 or 4 lines. 3 lines for the actual 110029cc50e1SOmar Emara // field and an optional line for an error if it exists. 110129cc50e1SOmar Emara int FieldDelegateGetHeight() override { 110229cc50e1SOmar Emara int height = GetFieldHeight(); 110380ac12b7SOmar Emara if (FieldDelegateHasError()) 110429cc50e1SOmar Emara height++; 110529cc50e1SOmar Emara return height; 110629cc50e1SOmar Emara } 110729cc50e1SOmar Emara 110829cc50e1SOmar Emara // Get the cursor X position in the surface coordinate. 110929cc50e1SOmar Emara int GetCursorXPosition() { return m_cursor_position - m_first_visibile_char; } 111029cc50e1SOmar Emara 111129cc50e1SOmar Emara int GetContentLength() { return m_content.length(); } 111229cc50e1SOmar Emara 111379e950a2SOmar Emara void DrawContent(Surface &surface, bool is_selected) { 1114d95d2a8eSOmar Emara UpdateScrolling(surface.GetWidth()); 1115d95d2a8eSOmar Emara 111629cc50e1SOmar Emara surface.MoveCursor(0, 0); 111729cc50e1SOmar Emara const char *text = m_content.c_str() + m_first_visibile_char; 111829cc50e1SOmar Emara surface.PutCString(text, surface.GetWidth()); 111929cc50e1SOmar Emara 112029cc50e1SOmar Emara // Highlight the cursor. 112129cc50e1SOmar Emara surface.MoveCursor(GetCursorXPosition(), 0); 112229cc50e1SOmar Emara if (is_selected) 112329cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 112429cc50e1SOmar Emara if (m_cursor_position == GetContentLength()) 112529cc50e1SOmar Emara // Cursor is past the last character. Highlight an empty space. 112629cc50e1SOmar Emara surface.PutChar(' '); 112729cc50e1SOmar Emara else 112829cc50e1SOmar Emara surface.PutChar(m_content[m_cursor_position]); 112929cc50e1SOmar Emara if (is_selected) 113029cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 113129cc50e1SOmar Emara } 113229cc50e1SOmar Emara 113379e950a2SOmar Emara void DrawField(Surface &surface, bool is_selected) { 113429cc50e1SOmar Emara surface.TitledBox(m_label.c_str()); 113529cc50e1SOmar Emara 113629cc50e1SOmar Emara Rect content_bounds = surface.GetFrame(); 113729cc50e1SOmar Emara content_bounds.Inset(1, 1); 113879e950a2SOmar Emara Surface content_surface = surface.SubSurface(content_bounds); 113929cc50e1SOmar Emara 114029cc50e1SOmar Emara DrawContent(content_surface, is_selected); 114129cc50e1SOmar Emara } 114229cc50e1SOmar Emara 114379e950a2SOmar Emara void DrawError(Surface &surface) { 114480ac12b7SOmar Emara if (!FieldDelegateHasError()) 114529cc50e1SOmar Emara return; 114629cc50e1SOmar Emara surface.MoveCursor(0, 0); 114729cc50e1SOmar Emara surface.AttributeOn(COLOR_PAIR(RedOnBlack)); 114829cc50e1SOmar Emara surface.PutChar(ACS_DIAMOND); 114929cc50e1SOmar Emara surface.PutChar(' '); 115029cc50e1SOmar Emara surface.PutCStringTruncated(1, GetError().c_str()); 115129cc50e1SOmar Emara surface.AttributeOff(COLOR_PAIR(RedOnBlack)); 115229cc50e1SOmar Emara } 115329cc50e1SOmar Emara 115479e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 115529cc50e1SOmar Emara Rect frame = surface.GetFrame(); 115629cc50e1SOmar Emara Rect field_bounds, error_bounds; 115729cc50e1SOmar Emara frame.HorizontalSplit(GetFieldHeight(), field_bounds, error_bounds); 115879e950a2SOmar Emara Surface field_surface = surface.SubSurface(field_bounds); 115979e950a2SOmar Emara Surface error_surface = surface.SubSurface(error_bounds); 116029cc50e1SOmar Emara 116129cc50e1SOmar Emara DrawField(field_surface, is_selected); 116229cc50e1SOmar Emara DrawError(error_surface); 116329cc50e1SOmar Emara } 116429cc50e1SOmar Emara 1165d95d2a8eSOmar Emara // Get the position of the last visible character. 1166d95d2a8eSOmar Emara int GetLastVisibleCharPosition(int width) { 1167d95d2a8eSOmar Emara int position = m_first_visibile_char + width - 1; 1168d95d2a8eSOmar Emara return std::min(position, GetContentLength()); 1169d95d2a8eSOmar Emara } 1170d95d2a8eSOmar Emara 1171d95d2a8eSOmar Emara void UpdateScrolling(int width) { 1172d95d2a8eSOmar Emara if (m_cursor_position < m_first_visibile_char) { 1173d95d2a8eSOmar Emara m_first_visibile_char = m_cursor_position; 1174d95d2a8eSOmar Emara return; 1175d95d2a8eSOmar Emara } 1176d95d2a8eSOmar Emara 1177d95d2a8eSOmar Emara if (m_cursor_position > GetLastVisibleCharPosition(width)) 1178d95d2a8eSOmar Emara m_first_visibile_char = m_cursor_position - (width - 1); 1179d95d2a8eSOmar Emara } 1180d95d2a8eSOmar Emara 118129cc50e1SOmar Emara // The cursor is allowed to move one character past the string. 118229cc50e1SOmar Emara // m_cursor_position is in range [0, GetContentLength()]. 118329cc50e1SOmar Emara void MoveCursorRight() { 118429cc50e1SOmar Emara if (m_cursor_position < GetContentLength()) 118529cc50e1SOmar Emara m_cursor_position++; 118629cc50e1SOmar Emara } 118729cc50e1SOmar Emara 118829cc50e1SOmar Emara void MoveCursorLeft() { 118929cc50e1SOmar Emara if (m_cursor_position > 0) 119029cc50e1SOmar Emara m_cursor_position--; 119129cc50e1SOmar Emara } 119229cc50e1SOmar Emara 1193d95d2a8eSOmar Emara void MoveCursorToStart() { m_cursor_position = 0; } 1194d95d2a8eSOmar Emara 1195d95d2a8eSOmar Emara void MoveCursorToEnd() { m_cursor_position = GetContentLength(); } 119629cc50e1SOmar Emara 119729cc50e1SOmar Emara void ScrollLeft() { 119829cc50e1SOmar Emara if (m_first_visibile_char > 0) 119929cc50e1SOmar Emara m_first_visibile_char--; 120029cc50e1SOmar Emara } 120129cc50e1SOmar Emara 1202d95d2a8eSOmar Emara // Insert a character at the current cursor position and advance the cursor 1203d95d2a8eSOmar Emara // position. 120429cc50e1SOmar Emara void InsertChar(char character) { 120529cc50e1SOmar Emara m_content.insert(m_cursor_position, 1, character); 120629cc50e1SOmar Emara m_cursor_position++; 1207d95d2a8eSOmar Emara ClearError(); 120829cc50e1SOmar Emara } 120929cc50e1SOmar Emara 121029cc50e1SOmar Emara // Remove the character before the cursor position, retreat the cursor 1211d95d2a8eSOmar Emara // position, and scroll left. 1212d95d2a8eSOmar Emara void RemovePreviousChar() { 121329cc50e1SOmar Emara if (m_cursor_position == 0) 121429cc50e1SOmar Emara return; 121529cc50e1SOmar Emara 121629cc50e1SOmar Emara m_content.erase(m_cursor_position - 1, 1); 121729cc50e1SOmar Emara m_cursor_position--; 121829cc50e1SOmar Emara ScrollLeft(); 1219d95d2a8eSOmar Emara ClearError(); 1220d95d2a8eSOmar Emara } 1221d95d2a8eSOmar Emara 1222d95d2a8eSOmar Emara // Remove the character after the cursor position. 1223d95d2a8eSOmar Emara void RemoveNextChar() { 1224d95d2a8eSOmar Emara if (m_cursor_position == GetContentLength()) 1225d95d2a8eSOmar Emara return; 1226d95d2a8eSOmar Emara 1227d95d2a8eSOmar Emara m_content.erase(m_cursor_position, 1); 1228d95d2a8eSOmar Emara ClearError(); 1229d95d2a8eSOmar Emara } 1230d95d2a8eSOmar Emara 1231d95d2a8eSOmar Emara // Clear characters from the current cursor position to the end. 1232d95d2a8eSOmar Emara void ClearToEnd() { 1233d95d2a8eSOmar Emara m_content.erase(m_cursor_position); 1234d95d2a8eSOmar Emara ClearError(); 1235d95d2a8eSOmar Emara } 1236d95d2a8eSOmar Emara 1237d95d2a8eSOmar Emara void Clear() { 1238d95d2a8eSOmar Emara m_content.clear(); 1239d95d2a8eSOmar Emara m_cursor_position = 0; 1240d95d2a8eSOmar Emara ClearError(); 124129cc50e1SOmar Emara } 124229cc50e1SOmar Emara 124329cc50e1SOmar Emara // True if the key represents a char that can be inserted in the field 124429cc50e1SOmar Emara // content, false otherwise. 1245698e2106SOmar Emara virtual bool IsAcceptableChar(int key) { 1246698e2106SOmar Emara // The behavior of isprint is undefined when the value is not representable 1247698e2106SOmar Emara // as an unsigned char. So explicitly check for non-ascii key codes. 1248698e2106SOmar Emara if (key > 127) 1249698e2106SOmar Emara return false; 1250698e2106SOmar Emara return isprint(key); 1251698e2106SOmar Emara } 125229cc50e1SOmar Emara 125329cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 125429cc50e1SOmar Emara if (IsAcceptableChar(key)) { 125529cc50e1SOmar Emara ClearError(); 125629cc50e1SOmar Emara InsertChar((char)key); 125729cc50e1SOmar Emara return eKeyHandled; 125829cc50e1SOmar Emara } 125929cc50e1SOmar Emara 126029cc50e1SOmar Emara switch (key) { 1261d95d2a8eSOmar Emara case KEY_HOME: 1262d95d2a8eSOmar Emara case KEY_CTRL_A: 1263d95d2a8eSOmar Emara MoveCursorToStart(); 1264d95d2a8eSOmar Emara return eKeyHandled; 1265d95d2a8eSOmar Emara case KEY_END: 1266d95d2a8eSOmar Emara case KEY_CTRL_E: 1267d95d2a8eSOmar Emara MoveCursorToEnd(); 1268d95d2a8eSOmar Emara return eKeyHandled; 126929cc50e1SOmar Emara case KEY_RIGHT: 1270d95d2a8eSOmar Emara case KEY_SF: 127129cc50e1SOmar Emara MoveCursorRight(); 127229cc50e1SOmar Emara return eKeyHandled; 127329cc50e1SOmar Emara case KEY_LEFT: 1274d95d2a8eSOmar Emara case KEY_SR: 127529cc50e1SOmar Emara MoveCursorLeft(); 127629cc50e1SOmar Emara return eKeyHandled; 127729cc50e1SOmar Emara case KEY_BACKSPACE: 1278d95d2a8eSOmar Emara case KEY_DELETE: 1279d95d2a8eSOmar Emara RemovePreviousChar(); 1280d95d2a8eSOmar Emara return eKeyHandled; 1281d95d2a8eSOmar Emara case KEY_DC: 1282d95d2a8eSOmar Emara RemoveNextChar(); 1283d95d2a8eSOmar Emara return eKeyHandled; 1284d95d2a8eSOmar Emara case KEY_EOL: 1285d95d2a8eSOmar Emara case KEY_CTRL_K: 1286d95d2a8eSOmar Emara ClearToEnd(); 1287d95d2a8eSOmar Emara return eKeyHandled; 1288d95d2a8eSOmar Emara case KEY_DL: 1289d95d2a8eSOmar Emara case KEY_CLEAR: 1290d95d2a8eSOmar Emara Clear(); 129129cc50e1SOmar Emara return eKeyHandled; 129229cc50e1SOmar Emara default: 129329cc50e1SOmar Emara break; 129429cc50e1SOmar Emara } 129529cc50e1SOmar Emara return eKeyNotHandled; 129629cc50e1SOmar Emara } 129729cc50e1SOmar Emara 129880ac12b7SOmar Emara bool FieldDelegateHasError() override { return !m_error.empty(); } 129980ac12b7SOmar Emara 13009ef7de7cSOmar Emara void FieldDelegateExitCallback() override { 13019ef7de7cSOmar Emara if (!IsSpecified() && m_required) 13029ef7de7cSOmar Emara SetError("This field is required!"); 13039ef7de7cSOmar Emara } 13049ef7de7cSOmar Emara 13059ef7de7cSOmar Emara bool IsSpecified() { return !m_content.empty(); } 13069ef7de7cSOmar Emara 130729cc50e1SOmar Emara void ClearError() { m_error.clear(); } 130829cc50e1SOmar Emara 130929cc50e1SOmar Emara const std::string &GetError() { return m_error; } 131029cc50e1SOmar Emara 131129cc50e1SOmar Emara void SetError(const char *error) { m_error = error; } 131229cc50e1SOmar Emara 131329cc50e1SOmar Emara const std::string &GetText() { return m_content; } 131429cc50e1SOmar Emara 131582507f17SOmar Emara void SetText(const char *text) { 131682507f17SOmar Emara if (text == nullptr) { 131782507f17SOmar Emara m_content.clear(); 131882507f17SOmar Emara return; 131982507f17SOmar Emara } 132082507f17SOmar Emara m_content = text; 132182507f17SOmar Emara } 132282507f17SOmar Emara 132329cc50e1SOmar Emara protected: 132429cc50e1SOmar Emara std::string m_label; 13259ef7de7cSOmar Emara bool m_required; 132629cc50e1SOmar Emara // The position of the top left corner character of the border. 132729cc50e1SOmar Emara std::string m_content; 132829cc50e1SOmar Emara // The cursor position in the content string itself. Can be in the range 132929cc50e1SOmar Emara // [0, GetContentLength()]. 133029cc50e1SOmar Emara int m_cursor_position; 133129cc50e1SOmar Emara // The index of the first visible character in the content. 133229cc50e1SOmar Emara int m_first_visibile_char; 133329cc50e1SOmar Emara // Optional error message. If empty, field is considered to have no error. 133429cc50e1SOmar Emara std::string m_error; 133529cc50e1SOmar Emara }; 133629cc50e1SOmar Emara 133729cc50e1SOmar Emara class IntegerFieldDelegate : public TextFieldDelegate { 133829cc50e1SOmar Emara public: 13399ef7de7cSOmar Emara IntegerFieldDelegate(const char *label, int content, bool required) 13409ef7de7cSOmar Emara : TextFieldDelegate(label, std::to_string(content).c_str(), required) {} 134129cc50e1SOmar Emara 134229cc50e1SOmar Emara // Only accept digits. 134329cc50e1SOmar Emara bool IsAcceptableChar(int key) override { return isdigit(key); } 134429cc50e1SOmar Emara 134529cc50e1SOmar Emara // Returns the integer content of the field. 134629cc50e1SOmar Emara int GetInteger() { return std::stoi(m_content); } 134729cc50e1SOmar Emara }; 134829cc50e1SOmar Emara 134929cc50e1SOmar Emara class FileFieldDelegate : public TextFieldDelegate { 135029cc50e1SOmar Emara public: 13519ef7de7cSOmar Emara FileFieldDelegate(const char *label, const char *content, bool need_to_exist, 13529ef7de7cSOmar Emara bool required) 13539ef7de7cSOmar Emara : TextFieldDelegate(label, content, required), 13549ef7de7cSOmar Emara m_need_to_exist(need_to_exist) {} 135529cc50e1SOmar Emara 135629cc50e1SOmar Emara void FieldDelegateExitCallback() override { 13579ef7de7cSOmar Emara TextFieldDelegate::FieldDelegateExitCallback(); 13589ef7de7cSOmar Emara if (!IsSpecified()) 13599ef7de7cSOmar Emara return; 13609ef7de7cSOmar Emara 1361a98f394eSOmar Emara if (!m_need_to_exist) 1362a98f394eSOmar Emara return; 1363a98f394eSOmar Emara 1364a98f394eSOmar Emara FileSpec file = GetResolvedFileSpec(); 1365a98f394eSOmar Emara if (!FileSystem::Instance().Exists(file)) { 136629cc50e1SOmar Emara SetError("File doesn't exist!"); 136729cc50e1SOmar Emara return; 136829cc50e1SOmar Emara } 136929cc50e1SOmar Emara if (FileSystem::Instance().IsDirectory(file)) { 137029cc50e1SOmar Emara SetError("Not a file!"); 137129cc50e1SOmar Emara return; 137229cc50e1SOmar Emara } 137329cc50e1SOmar Emara } 137429cc50e1SOmar Emara 1375a98f394eSOmar Emara FileSpec GetFileSpec() { 1376a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1377a98f394eSOmar Emara return file_spec; 1378a98f394eSOmar Emara } 1379a98f394eSOmar Emara 1380a98f394eSOmar Emara FileSpec GetResolvedFileSpec() { 1381a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1382a98f394eSOmar Emara FileSystem::Instance().Resolve(file_spec); 1383a98f394eSOmar Emara return file_spec; 1384a98f394eSOmar Emara } 1385a98f394eSOmar Emara 138629cc50e1SOmar Emara const std::string &GetPath() { return m_content; } 138729cc50e1SOmar Emara 138829cc50e1SOmar Emara protected: 138929cc50e1SOmar Emara bool m_need_to_exist; 139029cc50e1SOmar Emara }; 139129cc50e1SOmar Emara 139229cc50e1SOmar Emara class DirectoryFieldDelegate : public TextFieldDelegate { 139329cc50e1SOmar Emara public: 139429cc50e1SOmar Emara DirectoryFieldDelegate(const char *label, const char *content, 13959ef7de7cSOmar Emara bool need_to_exist, bool required) 13969ef7de7cSOmar Emara : TextFieldDelegate(label, content, required), 13979ef7de7cSOmar Emara m_need_to_exist(need_to_exist) {} 139829cc50e1SOmar Emara 139929cc50e1SOmar Emara void FieldDelegateExitCallback() override { 14009ef7de7cSOmar Emara TextFieldDelegate::FieldDelegateExitCallback(); 14019ef7de7cSOmar Emara if (!IsSpecified()) 14029ef7de7cSOmar Emara return; 14039ef7de7cSOmar Emara 1404a98f394eSOmar Emara if (!m_need_to_exist) 1405a98f394eSOmar Emara return; 1406a98f394eSOmar Emara 1407a98f394eSOmar Emara FileSpec file = GetResolvedFileSpec(); 1408a98f394eSOmar Emara if (!FileSystem::Instance().Exists(file)) { 140929cc50e1SOmar Emara SetError("Directory doesn't exist!"); 141029cc50e1SOmar Emara return; 141129cc50e1SOmar Emara } 141229cc50e1SOmar Emara if (!FileSystem::Instance().IsDirectory(file)) { 141329cc50e1SOmar Emara SetError("Not a directory!"); 141429cc50e1SOmar Emara return; 141529cc50e1SOmar Emara } 141629cc50e1SOmar Emara } 141729cc50e1SOmar Emara 1418a98f394eSOmar Emara FileSpec GetFileSpec() { 1419a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1420a98f394eSOmar Emara return file_spec; 1421a98f394eSOmar Emara } 1422a98f394eSOmar Emara 1423a98f394eSOmar Emara FileSpec GetResolvedFileSpec() { 1424a98f394eSOmar Emara FileSpec file_spec(GetPath()); 1425a98f394eSOmar Emara FileSystem::Instance().Resolve(file_spec); 1426a98f394eSOmar Emara return file_spec; 1427a98f394eSOmar Emara } 1428a98f394eSOmar Emara 142929cc50e1SOmar Emara const std::string &GetPath() { return m_content; } 143029cc50e1SOmar Emara 143129cc50e1SOmar Emara protected: 143229cc50e1SOmar Emara bool m_need_to_exist; 143329cc50e1SOmar Emara }; 143429cc50e1SOmar Emara 1435ed5b4dbdSOmar Emara class ArchFieldDelegate : public TextFieldDelegate { 1436ed5b4dbdSOmar Emara public: 1437ed5b4dbdSOmar Emara ArchFieldDelegate(const char *label, const char *content, bool required) 1438ed5b4dbdSOmar Emara : TextFieldDelegate(label, content, required) {} 1439ed5b4dbdSOmar Emara 1440ed5b4dbdSOmar Emara void FieldDelegateExitCallback() override { 1441ed5b4dbdSOmar Emara TextFieldDelegate::FieldDelegateExitCallback(); 1442ed5b4dbdSOmar Emara if (!IsSpecified()) 1443ed5b4dbdSOmar Emara return; 1444ed5b4dbdSOmar Emara 1445ed5b4dbdSOmar Emara if (!GetArchSpec().IsValid()) 1446ed5b4dbdSOmar Emara SetError("Not a valid arch!"); 1447ed5b4dbdSOmar Emara } 1448ed5b4dbdSOmar Emara 1449ed5b4dbdSOmar Emara const std::string &GetArchString() { return m_content; } 1450ed5b4dbdSOmar Emara 1451ed5b4dbdSOmar Emara ArchSpec GetArchSpec() { return ArchSpec(GetArchString()); } 1452ed5b4dbdSOmar Emara }; 1453ed5b4dbdSOmar Emara 145429cc50e1SOmar Emara class BooleanFieldDelegate : public FieldDelegate { 145529cc50e1SOmar Emara public: 145629cc50e1SOmar Emara BooleanFieldDelegate(const char *label, bool content) 145729cc50e1SOmar Emara : m_label(label), m_content(content) {} 145829cc50e1SOmar Emara 145929cc50e1SOmar Emara // Boolean fields are drawn as checkboxes. 146029cc50e1SOmar Emara // 146129cc50e1SOmar Emara // [X] Label or [ ] Label 146229cc50e1SOmar Emara 146329cc50e1SOmar Emara // Boolean fields are have a single line. 146429cc50e1SOmar Emara int FieldDelegateGetHeight() override { return 1; } 146529cc50e1SOmar Emara 146679e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 146729cc50e1SOmar Emara surface.MoveCursor(0, 0); 146829cc50e1SOmar Emara surface.PutChar('['); 146929cc50e1SOmar Emara if (is_selected) 147029cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 147129cc50e1SOmar Emara surface.PutChar(m_content ? ACS_DIAMOND : ' '); 147229cc50e1SOmar Emara if (is_selected) 147329cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 147429cc50e1SOmar Emara surface.PutChar(']'); 147529cc50e1SOmar Emara surface.PutChar(' '); 147629cc50e1SOmar Emara surface.PutCString(m_label.c_str()); 147729cc50e1SOmar Emara } 147829cc50e1SOmar Emara 147929cc50e1SOmar Emara void ToggleContent() { m_content = !m_content; } 148029cc50e1SOmar Emara 148129cc50e1SOmar Emara void SetContentToTrue() { m_content = true; } 148229cc50e1SOmar Emara 148329cc50e1SOmar Emara void SetContentToFalse() { m_content = false; } 148429cc50e1SOmar Emara 148529cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 148629cc50e1SOmar Emara switch (key) { 148729cc50e1SOmar Emara case 't': 148829cc50e1SOmar Emara case '1': 148929cc50e1SOmar Emara SetContentToTrue(); 149029cc50e1SOmar Emara return eKeyHandled; 149129cc50e1SOmar Emara case 'f': 149229cc50e1SOmar Emara case '0': 149329cc50e1SOmar Emara SetContentToFalse(); 149429cc50e1SOmar Emara return eKeyHandled; 149529cc50e1SOmar Emara case ' ': 149629cc50e1SOmar Emara case '\r': 149729cc50e1SOmar Emara case '\n': 149829cc50e1SOmar Emara case KEY_ENTER: 149929cc50e1SOmar Emara ToggleContent(); 150029cc50e1SOmar Emara return eKeyHandled; 150129cc50e1SOmar Emara default: 150229cc50e1SOmar Emara break; 150329cc50e1SOmar Emara } 150429cc50e1SOmar Emara return eKeyNotHandled; 150529cc50e1SOmar Emara } 150629cc50e1SOmar Emara 150729cc50e1SOmar Emara // Returns the boolean content of the field. 150829cc50e1SOmar Emara bool GetBoolean() { return m_content; } 150929cc50e1SOmar Emara 151029cc50e1SOmar Emara protected: 151129cc50e1SOmar Emara std::string m_label; 151229cc50e1SOmar Emara bool m_content; 151329cc50e1SOmar Emara }; 151429cc50e1SOmar Emara 151529cc50e1SOmar Emara class ChoicesFieldDelegate : public FieldDelegate { 151629cc50e1SOmar Emara public: 151729cc50e1SOmar Emara ChoicesFieldDelegate(const char *label, int number_of_visible_choices, 151829cc50e1SOmar Emara std::vector<std::string> choices) 151929cc50e1SOmar Emara : m_label(label), m_number_of_visible_choices(number_of_visible_choices), 152029cc50e1SOmar Emara m_choices(choices), m_choice(0), m_first_visibile_choice(0) {} 152129cc50e1SOmar Emara 152229cc50e1SOmar Emara // Choices fields are drawn as titles boxses of a number of visible choices. 152329cc50e1SOmar Emara // The rest of the choices become visible as the user scroll. The selected 152429cc50e1SOmar Emara // choice is denoted by a diamond as the first character. 152529cc50e1SOmar Emara // 152629cc50e1SOmar Emara // __[Label]___________ 152729cc50e1SOmar Emara // |-Choice 1 | 152829cc50e1SOmar Emara // | Choice 2 | 152929cc50e1SOmar Emara // | Choice 3 | 153029cc50e1SOmar Emara // |__________________| 153129cc50e1SOmar Emara 153229cc50e1SOmar Emara // Choices field have two border characters plus the number of visible 153329cc50e1SOmar Emara // choices. 153429cc50e1SOmar Emara int FieldDelegateGetHeight() override { 153529cc50e1SOmar Emara return m_number_of_visible_choices + 2; 153629cc50e1SOmar Emara } 153729cc50e1SOmar Emara 153829cc50e1SOmar Emara int GetNumberOfChoices() { return m_choices.size(); } 153929cc50e1SOmar Emara 154029cc50e1SOmar Emara // Get the index of the last visible choice. 154129cc50e1SOmar Emara int GetLastVisibleChoice() { 154229cc50e1SOmar Emara int index = m_first_visibile_choice + m_number_of_visible_choices; 154329cc50e1SOmar Emara return std::min(index, GetNumberOfChoices()) - 1; 154429cc50e1SOmar Emara } 154529cc50e1SOmar Emara 154679e950a2SOmar Emara void DrawContent(Surface &surface, bool is_selected) { 154729cc50e1SOmar Emara int choices_to_draw = GetLastVisibleChoice() - m_first_visibile_choice + 1; 154829cc50e1SOmar Emara for (int i = 0; i < choices_to_draw; i++) { 154929cc50e1SOmar Emara surface.MoveCursor(0, i); 155029cc50e1SOmar Emara int current_choice = m_first_visibile_choice + i; 155129cc50e1SOmar Emara const char *text = m_choices[current_choice].c_str(); 155229cc50e1SOmar Emara bool highlight = is_selected && current_choice == m_choice; 155329cc50e1SOmar Emara if (highlight) 155429cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 155529cc50e1SOmar Emara surface.PutChar(current_choice == m_choice ? ACS_DIAMOND : ' '); 155629cc50e1SOmar Emara surface.PutCString(text); 155729cc50e1SOmar Emara if (highlight) 155829cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 155929cc50e1SOmar Emara } 156029cc50e1SOmar Emara } 156129cc50e1SOmar Emara 156279e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 1563e160b398SOmar Emara UpdateScrolling(); 1564e160b398SOmar Emara 156529cc50e1SOmar Emara surface.TitledBox(m_label.c_str()); 156629cc50e1SOmar Emara 156729cc50e1SOmar Emara Rect content_bounds = surface.GetFrame(); 156829cc50e1SOmar Emara content_bounds.Inset(1, 1); 156979e950a2SOmar Emara Surface content_surface = surface.SubSurface(content_bounds); 157029cc50e1SOmar Emara 157129cc50e1SOmar Emara DrawContent(content_surface, is_selected); 157229cc50e1SOmar Emara } 157329cc50e1SOmar Emara 157429cc50e1SOmar Emara void SelectPrevious() { 157529cc50e1SOmar Emara if (m_choice > 0) 157629cc50e1SOmar Emara m_choice--; 157729cc50e1SOmar Emara } 157829cc50e1SOmar Emara 157929cc50e1SOmar Emara void SelectNext() { 158029cc50e1SOmar Emara if (m_choice < GetNumberOfChoices() - 1) 158129cc50e1SOmar Emara m_choice++; 158229cc50e1SOmar Emara } 158329cc50e1SOmar Emara 1584e160b398SOmar Emara void UpdateScrolling() { 1585e160b398SOmar Emara if (m_choice > GetLastVisibleChoice()) { 1586e160b398SOmar Emara m_first_visibile_choice = m_choice - (m_number_of_visible_choices - 1); 1587e160b398SOmar Emara return; 158829cc50e1SOmar Emara } 158929cc50e1SOmar Emara 1590e160b398SOmar Emara if (m_choice < m_first_visibile_choice) 1591e160b398SOmar Emara m_first_visibile_choice = m_choice; 159229cc50e1SOmar Emara } 159329cc50e1SOmar Emara 159429cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 159529cc50e1SOmar Emara switch (key) { 159629cc50e1SOmar Emara case KEY_UP: 159729cc50e1SOmar Emara SelectPrevious(); 159829cc50e1SOmar Emara return eKeyHandled; 159929cc50e1SOmar Emara case KEY_DOWN: 160029cc50e1SOmar Emara SelectNext(); 160129cc50e1SOmar Emara return eKeyHandled; 160229cc50e1SOmar Emara default: 160329cc50e1SOmar Emara break; 160429cc50e1SOmar Emara } 160529cc50e1SOmar Emara return eKeyNotHandled; 160629cc50e1SOmar Emara } 160729cc50e1SOmar Emara 160829cc50e1SOmar Emara // Returns the content of the choice as a string. 160929cc50e1SOmar Emara std::string GetChoiceContent() { return m_choices[m_choice]; } 161029cc50e1SOmar Emara 161129cc50e1SOmar Emara // Returns the index of the choice. 161229cc50e1SOmar Emara int GetChoice() { return m_choice; } 161329cc50e1SOmar Emara 1614e160b398SOmar Emara void SetChoice(const std::string &choice) { 1615e160b398SOmar Emara for (int i = 0; i < GetNumberOfChoices(); i++) { 1616e160b398SOmar Emara if (choice == m_choices[i]) { 1617e160b398SOmar Emara m_choice = i; 1618e160b398SOmar Emara return; 1619e160b398SOmar Emara } 1620e160b398SOmar Emara } 1621e160b398SOmar Emara } 1622e160b398SOmar Emara 162329cc50e1SOmar Emara protected: 162429cc50e1SOmar Emara std::string m_label; 162529cc50e1SOmar Emara int m_number_of_visible_choices; 162629cc50e1SOmar Emara std::vector<std::string> m_choices; 162729cc50e1SOmar Emara // The index of the selected choice. 162829cc50e1SOmar Emara int m_choice; 162929cc50e1SOmar Emara // The index of the first visible choice in the field. 163029cc50e1SOmar Emara int m_first_visibile_choice; 163129cc50e1SOmar Emara }; 163229cc50e1SOmar Emara 1633e160b398SOmar Emara class PlatformPluginFieldDelegate : public ChoicesFieldDelegate { 1634e160b398SOmar Emara public: 1635e160b398SOmar Emara PlatformPluginFieldDelegate(Debugger &debugger) 1636e160b398SOmar Emara : ChoicesFieldDelegate("Platform Plugin", 3, GetPossiblePluginNames()) { 1637e160b398SOmar Emara PlatformSP platform_sp = debugger.GetPlatformList().GetSelectedPlatform(); 1638e160b398SOmar Emara if (platform_sp) 1639e160b398SOmar Emara SetChoice(platform_sp->GetName().AsCString()); 1640e160b398SOmar Emara } 1641e160b398SOmar Emara 1642e160b398SOmar Emara std::vector<std::string> GetPossiblePluginNames() { 1643e160b398SOmar Emara std::vector<std::string> names; 1644e160b398SOmar Emara size_t i = 0; 1645*a458ef4fSPavel Labath for (llvm::StringRef name = 1646*a458ef4fSPavel Labath PluginManager::GetPlatformPluginNameAtIndex(i++); 1647*a458ef4fSPavel Labath !name.empty(); name = PluginManager::GetProcessPluginNameAtIndex(i++)) 1648*a458ef4fSPavel Labath names.push_back(name.str()); 1649e160b398SOmar Emara return names; 1650e160b398SOmar Emara } 1651e160b398SOmar Emara 1652e160b398SOmar Emara std::string GetPluginName() { 1653e160b398SOmar Emara std::string plugin_name = GetChoiceContent(); 1654e160b398SOmar Emara return plugin_name; 1655e160b398SOmar Emara } 1656e160b398SOmar Emara }; 1657e160b398SOmar Emara 1658c93dc259SOmar Emara class ProcessPluginFieldDelegate : public ChoicesFieldDelegate { 1659c93dc259SOmar Emara public: 1660c93dc259SOmar Emara ProcessPluginFieldDelegate() 1661c93dc259SOmar Emara : ChoicesFieldDelegate("Process Plugin", 3, GetPossiblePluginNames()) {} 1662c93dc259SOmar Emara 1663c93dc259SOmar Emara std::vector<std::string> GetPossiblePluginNames() { 1664c93dc259SOmar Emara std::vector<std::string> names; 1665c93dc259SOmar Emara names.push_back("<default>"); 1666c93dc259SOmar Emara 1667c93dc259SOmar Emara size_t i = 0; 1668c93dc259SOmar Emara while (auto name = PluginManager::GetProcessPluginNameAtIndex(i++)) 1669c93dc259SOmar Emara names.push_back(name); 1670c93dc259SOmar Emara return names; 1671c93dc259SOmar Emara } 1672c93dc259SOmar Emara 1673c93dc259SOmar Emara std::string GetPluginName() { 1674c93dc259SOmar Emara std::string plugin_name = GetChoiceContent(); 1675c93dc259SOmar Emara if (plugin_name == "<default>") 1676c93dc259SOmar Emara return ""; 1677c93dc259SOmar Emara return plugin_name; 1678c93dc259SOmar Emara } 1679c93dc259SOmar Emara }; 1680c93dc259SOmar Emara 168182507f17SOmar Emara class LazyBooleanFieldDelegate : public ChoicesFieldDelegate { 168282507f17SOmar Emara public: 168382507f17SOmar Emara LazyBooleanFieldDelegate(const char *label, const char *calculate_label) 168482507f17SOmar Emara : ChoicesFieldDelegate(label, 3, GetPossibleOptions(calculate_label)) {} 168582507f17SOmar Emara 168682507f17SOmar Emara static constexpr const char *kNo = "No"; 168782507f17SOmar Emara static constexpr const char *kYes = "Yes"; 168882507f17SOmar Emara 168982507f17SOmar Emara std::vector<std::string> GetPossibleOptions(const char *calculate_label) { 169082507f17SOmar Emara std::vector<std::string> options; 169182507f17SOmar Emara options.push_back(calculate_label); 169282507f17SOmar Emara options.push_back(kYes); 169382507f17SOmar Emara options.push_back(kNo); 169482507f17SOmar Emara return options; 169582507f17SOmar Emara } 169682507f17SOmar Emara 169782507f17SOmar Emara LazyBool GetLazyBoolean() { 169882507f17SOmar Emara std::string choice = GetChoiceContent(); 169982507f17SOmar Emara if (choice == kNo) 170082507f17SOmar Emara return eLazyBoolNo; 170182507f17SOmar Emara else if (choice == kYes) 170282507f17SOmar Emara return eLazyBoolYes; 170382507f17SOmar Emara else 170482507f17SOmar Emara return eLazyBoolCalculate; 170582507f17SOmar Emara } 170682507f17SOmar Emara }; 170782507f17SOmar Emara 170829cc50e1SOmar Emara template <class T> class ListFieldDelegate : public FieldDelegate { 170929cc50e1SOmar Emara public: 171029cc50e1SOmar Emara ListFieldDelegate(const char *label, T default_field) 171129cc50e1SOmar Emara : m_label(label), m_default_field(default_field), m_selection_index(0), 171229cc50e1SOmar Emara m_selection_type(SelectionType::NewButton) {} 171329cc50e1SOmar Emara 171429cc50e1SOmar Emara // Signify which element is selected. If a field or a remove button is 171529cc50e1SOmar Emara // selected, then m_selection_index signifies the particular field that 171629cc50e1SOmar Emara // is selected or the field that the remove button belongs to. 171729cc50e1SOmar Emara enum class SelectionType { Field, RemoveButton, NewButton }; 171829cc50e1SOmar Emara 171929cc50e1SOmar Emara // A List field is drawn as a titled box of a number of other fields of the 172029cc50e1SOmar Emara // same type. Each field has a Remove button next to it that removes the 172129cc50e1SOmar Emara // corresponding field. Finally, the last line contains a New button to add a 172229cc50e1SOmar Emara // new field. 172329cc50e1SOmar Emara // 172429cc50e1SOmar Emara // __[Label]___________ 172529cc50e1SOmar Emara // | Field 0 [Remove] | 172629cc50e1SOmar Emara // | Field 1 [Remove] | 172729cc50e1SOmar Emara // | Field 2 [Remove] | 172829cc50e1SOmar Emara // | [New] | 172929cc50e1SOmar Emara // |__________________| 173029cc50e1SOmar Emara 173129cc50e1SOmar Emara // List fields have two lines for border characters, 1 line for the New 173229cc50e1SOmar Emara // button, and the total height of the available fields. 173329cc50e1SOmar Emara int FieldDelegateGetHeight() override { 173429cc50e1SOmar Emara // 2 border characters. 173529cc50e1SOmar Emara int height = 2; 173629cc50e1SOmar Emara // Total height of the fields. 173729cc50e1SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 173829cc50e1SOmar Emara height += m_fields[i].FieldDelegateGetHeight(); 173929cc50e1SOmar Emara } 174029cc50e1SOmar Emara // A line for the New button. 174129cc50e1SOmar Emara height++; 174229cc50e1SOmar Emara return height; 174329cc50e1SOmar Emara } 174429cc50e1SOmar Emara 174529cc50e1SOmar Emara ScrollContext FieldDelegateGetScrollContext() override { 174629cc50e1SOmar Emara int height = FieldDelegateGetHeight(); 174729cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) 174829cc50e1SOmar Emara return ScrollContext(height - 2, height - 1); 174929cc50e1SOmar Emara 175029cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 175129cc50e1SOmar Emara ScrollContext context = field.FieldDelegateGetScrollContext(); 175229cc50e1SOmar Emara 175329cc50e1SOmar Emara // Start at 1 because of the top border. 175429cc50e1SOmar Emara int offset = 1; 175529cc50e1SOmar Emara for (int i = 0; i < m_selection_index; i++) { 175629cc50e1SOmar Emara offset += m_fields[i].FieldDelegateGetHeight(); 175729cc50e1SOmar Emara } 175829cc50e1SOmar Emara context.Offset(offset); 175929cc50e1SOmar Emara 176029cc50e1SOmar Emara // If the scroll context is touching the top border, include it in the 176129cc50e1SOmar Emara // context to show the label. 176229cc50e1SOmar Emara if (context.start == 1) 176329cc50e1SOmar Emara context.start--; 176429cc50e1SOmar Emara 176529cc50e1SOmar Emara // If the scroll context is touching the new button, include it as well as 176629cc50e1SOmar Emara // the bottom border in the context. 176729cc50e1SOmar Emara if (context.end == height - 3) 176829cc50e1SOmar Emara context.end += 2; 176929cc50e1SOmar Emara 177029cc50e1SOmar Emara return context; 177129cc50e1SOmar Emara } 177229cc50e1SOmar Emara 177379e950a2SOmar Emara void DrawRemoveButton(Surface &surface, int highlight) { 177429cc50e1SOmar Emara surface.MoveCursor(1, surface.GetHeight() / 2); 177529cc50e1SOmar Emara if (highlight) 177629cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 177729cc50e1SOmar Emara surface.PutCString("[Remove]"); 177829cc50e1SOmar Emara if (highlight) 177929cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 178029cc50e1SOmar Emara } 178129cc50e1SOmar Emara 178279e950a2SOmar Emara void DrawFields(Surface &surface, bool is_selected) { 178329cc50e1SOmar Emara int line = 0; 178429cc50e1SOmar Emara int width = surface.GetWidth(); 178529cc50e1SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 178629cc50e1SOmar Emara int height = m_fields[i].FieldDelegateGetHeight(); 178729cc50e1SOmar Emara Rect bounds = Rect(Point(0, line), Size(width, height)); 178829cc50e1SOmar Emara Rect field_bounds, remove_button_bounds; 178929cc50e1SOmar Emara bounds.VerticalSplit(bounds.size.width - sizeof(" [Remove]"), 179029cc50e1SOmar Emara field_bounds, remove_button_bounds); 179179e950a2SOmar Emara Surface field_surface = surface.SubSurface(field_bounds); 179279e950a2SOmar Emara Surface remove_button_surface = surface.SubSurface(remove_button_bounds); 179329cc50e1SOmar Emara 179429cc50e1SOmar Emara bool is_element_selected = m_selection_index == i && is_selected; 179529cc50e1SOmar Emara bool is_field_selected = 179629cc50e1SOmar Emara is_element_selected && m_selection_type == SelectionType::Field; 179729cc50e1SOmar Emara bool is_remove_button_selected = 179829cc50e1SOmar Emara is_element_selected && 179929cc50e1SOmar Emara m_selection_type == SelectionType::RemoveButton; 180029cc50e1SOmar Emara m_fields[i].FieldDelegateDraw(field_surface, is_field_selected); 180129cc50e1SOmar Emara DrawRemoveButton(remove_button_surface, is_remove_button_selected); 180229cc50e1SOmar Emara 180329cc50e1SOmar Emara line += height; 180429cc50e1SOmar Emara } 180529cc50e1SOmar Emara } 180629cc50e1SOmar Emara 180779e950a2SOmar Emara void DrawNewButton(Surface &surface, bool is_selected) { 180829cc50e1SOmar Emara const char *button_text = "[New]"; 180929cc50e1SOmar Emara int x = (surface.GetWidth() - sizeof(button_text) - 1) / 2; 181029cc50e1SOmar Emara surface.MoveCursor(x, 0); 181129cc50e1SOmar Emara bool highlight = 181229cc50e1SOmar Emara is_selected && m_selection_type == SelectionType::NewButton; 181329cc50e1SOmar Emara if (highlight) 181429cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 181529cc50e1SOmar Emara surface.PutCString(button_text); 181629cc50e1SOmar Emara if (highlight) 181729cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 181829cc50e1SOmar Emara } 181929cc50e1SOmar Emara 182079e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 182129cc50e1SOmar Emara surface.TitledBox(m_label.c_str()); 182229cc50e1SOmar Emara 182329cc50e1SOmar Emara Rect content_bounds = surface.GetFrame(); 182429cc50e1SOmar Emara content_bounds.Inset(1, 1); 182529cc50e1SOmar Emara Rect fields_bounds, new_button_bounds; 182629cc50e1SOmar Emara content_bounds.HorizontalSplit(content_bounds.size.height - 1, 182729cc50e1SOmar Emara fields_bounds, new_button_bounds); 182879e950a2SOmar Emara Surface fields_surface = surface.SubSurface(fields_bounds); 182979e950a2SOmar Emara Surface new_button_surface = surface.SubSurface(new_button_bounds); 183029cc50e1SOmar Emara 183129cc50e1SOmar Emara DrawFields(fields_surface, is_selected); 183229cc50e1SOmar Emara DrawNewButton(new_button_surface, is_selected); 183329cc50e1SOmar Emara } 183429cc50e1SOmar Emara 183529cc50e1SOmar Emara void AddNewField() { 183629cc50e1SOmar Emara m_fields.push_back(m_default_field); 183729cc50e1SOmar Emara m_selection_index = GetNumberOfFields() - 1; 183829cc50e1SOmar Emara m_selection_type = SelectionType::Field; 183929cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 184029cc50e1SOmar Emara field.FieldDelegateSelectFirstElement(); 184129cc50e1SOmar Emara } 184229cc50e1SOmar Emara 184329cc50e1SOmar Emara void RemoveField() { 184429cc50e1SOmar Emara m_fields.erase(m_fields.begin() + m_selection_index); 184529cc50e1SOmar Emara if (m_selection_index != 0) 184629cc50e1SOmar Emara m_selection_index--; 184729cc50e1SOmar Emara 184829cc50e1SOmar Emara if (GetNumberOfFields() > 0) { 184929cc50e1SOmar Emara m_selection_type = SelectionType::Field; 185029cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 185129cc50e1SOmar Emara field.FieldDelegateSelectFirstElement(); 185229cc50e1SOmar Emara } else 185329cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 185429cc50e1SOmar Emara } 185529cc50e1SOmar Emara 18560321dbc8SOmar Emara HandleCharResult SelectNext(int key) { 185729cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) 185829cc50e1SOmar Emara return eKeyNotHandled; 185929cc50e1SOmar Emara 186029cc50e1SOmar Emara if (m_selection_type == SelectionType::RemoveButton) { 186129cc50e1SOmar Emara if (m_selection_index == GetNumberOfFields() - 1) { 186229cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 186329cc50e1SOmar Emara return eKeyHandled; 186429cc50e1SOmar Emara } 186529cc50e1SOmar Emara m_selection_index++; 186629cc50e1SOmar Emara m_selection_type = SelectionType::Field; 186729cc50e1SOmar Emara FieldDelegate &next_field = m_fields[m_selection_index]; 186829cc50e1SOmar Emara next_field.FieldDelegateSelectFirstElement(); 186929cc50e1SOmar Emara return eKeyHandled; 187029cc50e1SOmar Emara } 187129cc50e1SOmar Emara 187229cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 187329cc50e1SOmar Emara if (!field.FieldDelegateOnLastOrOnlyElement()) { 187429cc50e1SOmar Emara return field.FieldDelegateHandleChar(key); 187529cc50e1SOmar Emara } 187629cc50e1SOmar Emara 187729cc50e1SOmar Emara field.FieldDelegateExitCallback(); 187829cc50e1SOmar Emara 187929cc50e1SOmar Emara m_selection_type = SelectionType::RemoveButton; 188029cc50e1SOmar Emara return eKeyHandled; 188129cc50e1SOmar Emara } 188229cc50e1SOmar Emara 188329cc50e1SOmar Emara HandleCharResult SelectPrevious(int key) { 188429cc50e1SOmar Emara if (FieldDelegateOnFirstOrOnlyElement()) 188529cc50e1SOmar Emara return eKeyNotHandled; 188629cc50e1SOmar Emara 188729cc50e1SOmar Emara if (m_selection_type == SelectionType::RemoveButton) { 188829cc50e1SOmar Emara m_selection_type = SelectionType::Field; 188929cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 189029cc50e1SOmar Emara field.FieldDelegateSelectLastElement(); 189129cc50e1SOmar Emara return eKeyHandled; 189229cc50e1SOmar Emara } 189329cc50e1SOmar Emara 189429cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) { 189529cc50e1SOmar Emara m_selection_type = SelectionType::RemoveButton; 189629cc50e1SOmar Emara m_selection_index = GetNumberOfFields() - 1; 189729cc50e1SOmar Emara return eKeyHandled; 189829cc50e1SOmar Emara } 189929cc50e1SOmar Emara 190029cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 190129cc50e1SOmar Emara if (!field.FieldDelegateOnFirstOrOnlyElement()) { 190229cc50e1SOmar Emara return field.FieldDelegateHandleChar(key); 190329cc50e1SOmar Emara } 190429cc50e1SOmar Emara 190529cc50e1SOmar Emara field.FieldDelegateExitCallback(); 190629cc50e1SOmar Emara 190729cc50e1SOmar Emara m_selection_type = SelectionType::RemoveButton; 190829cc50e1SOmar Emara m_selection_index--; 190929cc50e1SOmar Emara return eKeyHandled; 191029cc50e1SOmar Emara } 191129cc50e1SOmar Emara 191228a76049SOmar Emara // If the last element of the field is selected and it didn't handle the key. 191328a76049SOmar Emara // Select the next field or new button if the selected field is the last one. 191428a76049SOmar Emara HandleCharResult SelectNextInList(int key) { 191528a76049SOmar Emara assert(m_selection_type == SelectionType::Field); 191628a76049SOmar Emara 191728a76049SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 191828a76049SOmar Emara if (field.FieldDelegateHandleChar(key) == eKeyHandled) 191928a76049SOmar Emara return eKeyHandled; 192028a76049SOmar Emara 192128a76049SOmar Emara if (!field.FieldDelegateOnLastOrOnlyElement()) 192228a76049SOmar Emara return eKeyNotHandled; 192328a76049SOmar Emara 192428a76049SOmar Emara field.FieldDelegateExitCallback(); 192528a76049SOmar Emara 192628a76049SOmar Emara if (m_selection_index == GetNumberOfFields() - 1) { 192728a76049SOmar Emara m_selection_type = SelectionType::NewButton; 192828a76049SOmar Emara return eKeyHandled; 192928a76049SOmar Emara } 193028a76049SOmar Emara 193128a76049SOmar Emara m_selection_index++; 193228a76049SOmar Emara FieldDelegate &next_field = m_fields[m_selection_index]; 193328a76049SOmar Emara next_field.FieldDelegateSelectFirstElement(); 193428a76049SOmar Emara return eKeyHandled; 193528a76049SOmar Emara } 193628a76049SOmar Emara 193729cc50e1SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 193829cc50e1SOmar Emara switch (key) { 193929cc50e1SOmar Emara case '\r': 194029cc50e1SOmar Emara case '\n': 194129cc50e1SOmar Emara case KEY_ENTER: 194229cc50e1SOmar Emara switch (m_selection_type) { 194329cc50e1SOmar Emara case SelectionType::NewButton: 194429cc50e1SOmar Emara AddNewField(); 194529cc50e1SOmar Emara return eKeyHandled; 194629cc50e1SOmar Emara case SelectionType::RemoveButton: 194729cc50e1SOmar Emara RemoveField(); 194829cc50e1SOmar Emara return eKeyHandled; 194928a76049SOmar Emara case SelectionType::Field: 195028a76049SOmar Emara return SelectNextInList(key); 195129cc50e1SOmar Emara } 195229cc50e1SOmar Emara break; 195329cc50e1SOmar Emara case '\t': 195428a76049SOmar Emara return SelectNext(key); 195529cc50e1SOmar Emara case KEY_SHIFT_TAB: 195628a76049SOmar Emara return SelectPrevious(key); 195729cc50e1SOmar Emara default: 195829cc50e1SOmar Emara break; 195929cc50e1SOmar Emara } 196029cc50e1SOmar Emara 196129cc50e1SOmar Emara // If the key wasn't handled and one of the fields is selected, pass the key 196229cc50e1SOmar Emara // to that field. 196329cc50e1SOmar Emara if (m_selection_type == SelectionType::Field) { 196429cc50e1SOmar Emara return m_fields[m_selection_index].FieldDelegateHandleChar(key); 196529cc50e1SOmar Emara } 196629cc50e1SOmar Emara 196729cc50e1SOmar Emara return eKeyNotHandled; 196829cc50e1SOmar Emara } 196929cc50e1SOmar Emara 197029cc50e1SOmar Emara bool FieldDelegateOnLastOrOnlyElement() override { 197129cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton) { 197229cc50e1SOmar Emara return true; 197329cc50e1SOmar Emara } 197429cc50e1SOmar Emara return false; 197529cc50e1SOmar Emara } 197629cc50e1SOmar Emara 197729cc50e1SOmar Emara bool FieldDelegateOnFirstOrOnlyElement() override { 197829cc50e1SOmar Emara if (m_selection_type == SelectionType::NewButton && 197929cc50e1SOmar Emara GetNumberOfFields() == 0) 198029cc50e1SOmar Emara return true; 198129cc50e1SOmar Emara 198229cc50e1SOmar Emara if (m_selection_type == SelectionType::Field && m_selection_index == 0) { 198329cc50e1SOmar Emara FieldDelegate &field = m_fields[m_selection_index]; 198429cc50e1SOmar Emara return field.FieldDelegateOnFirstOrOnlyElement(); 198529cc50e1SOmar Emara } 198629cc50e1SOmar Emara 198729cc50e1SOmar Emara return false; 198829cc50e1SOmar Emara } 198929cc50e1SOmar Emara 199029cc50e1SOmar Emara void FieldDelegateSelectFirstElement() override { 199129cc50e1SOmar Emara if (GetNumberOfFields() == 0) { 199229cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 199329cc50e1SOmar Emara return; 199429cc50e1SOmar Emara } 199529cc50e1SOmar Emara 199629cc50e1SOmar Emara m_selection_type = SelectionType::Field; 199729cc50e1SOmar Emara m_selection_index = 0; 199829cc50e1SOmar Emara } 199929cc50e1SOmar Emara 200029cc50e1SOmar Emara void FieldDelegateSelectLastElement() override { 200129cc50e1SOmar Emara m_selection_type = SelectionType::NewButton; 200229cc50e1SOmar Emara return; 200329cc50e1SOmar Emara } 200429cc50e1SOmar Emara 200529cc50e1SOmar Emara int GetNumberOfFields() { return m_fields.size(); } 200629cc50e1SOmar Emara 200729cc50e1SOmar Emara // Returns the form delegate at the current index. 200829cc50e1SOmar Emara T &GetField(int index) { return m_fields[index]; } 200929cc50e1SOmar Emara 201029cc50e1SOmar Emara protected: 201129cc50e1SOmar Emara std::string m_label; 201229cc50e1SOmar Emara // The default field delegate instance from which new field delegates will be 201329cc50e1SOmar Emara // created though a copy. 201429cc50e1SOmar Emara T m_default_field; 201529cc50e1SOmar Emara std::vector<T> m_fields; 201629cc50e1SOmar Emara int m_selection_index; 201729cc50e1SOmar Emara // See SelectionType class enum. 201829cc50e1SOmar Emara SelectionType m_selection_type; 201929cc50e1SOmar Emara }; 202029cc50e1SOmar Emara 202182507f17SOmar Emara class ArgumentsFieldDelegate : public ListFieldDelegate<TextFieldDelegate> { 202282507f17SOmar Emara public: 202382507f17SOmar Emara ArgumentsFieldDelegate() 202482507f17SOmar Emara : ListFieldDelegate("Arguments", 202582507f17SOmar Emara TextFieldDelegate("Argument", "", false)) {} 202682507f17SOmar Emara 202782507f17SOmar Emara Args GetArguments() { 202882507f17SOmar Emara Args arguments; 202982507f17SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 203082507f17SOmar Emara arguments.AppendArgument(GetField(i).GetText()); 203182507f17SOmar Emara } 203282507f17SOmar Emara return arguments; 203382507f17SOmar Emara } 203482507f17SOmar Emara 203582507f17SOmar Emara void AddArguments(const Args &arguments) { 203682507f17SOmar Emara for (size_t i = 0; i < arguments.GetArgumentCount(); i++) { 203782507f17SOmar Emara AddNewField(); 203882507f17SOmar Emara TextFieldDelegate &field = GetField(GetNumberOfFields() - 1); 203982507f17SOmar Emara field.SetText(arguments.GetArgumentAtIndex(i)); 204082507f17SOmar Emara } 204182507f17SOmar Emara } 204282507f17SOmar Emara }; 204382507f17SOmar Emara 204462bd3315SOmar Emara template <class KeyFieldDelegateType, class ValueFieldDelegateType> 204562bd3315SOmar Emara class MappingFieldDelegate : public FieldDelegate { 204662bd3315SOmar Emara public: 204762bd3315SOmar Emara MappingFieldDelegate(KeyFieldDelegateType key_field, 204862bd3315SOmar Emara ValueFieldDelegateType value_field) 204962bd3315SOmar Emara : m_key_field(key_field), m_value_field(value_field), 205062bd3315SOmar Emara m_selection_type(SelectionType::Key) {} 205162bd3315SOmar Emara 205262bd3315SOmar Emara // Signify which element is selected. The key field or its value field. 205362bd3315SOmar Emara enum class SelectionType { Key, Value }; 205462bd3315SOmar Emara 205562bd3315SOmar Emara // A mapping field is drawn as two text fields with a right arrow in between. 205662bd3315SOmar Emara // The first field stores the key of the mapping and the second stores the 205762bd3315SOmar Emara // value if the mapping. 205862bd3315SOmar Emara // 205962bd3315SOmar Emara // __[Key]_____________ __[Value]___________ 206062bd3315SOmar Emara // | | > | | 206162bd3315SOmar Emara // |__________________| |__________________| 206262bd3315SOmar Emara // - Error message if it exists. 206362bd3315SOmar Emara 206462bd3315SOmar Emara // The mapping field has a height that is equal to the maximum height between 206562bd3315SOmar Emara // the key and value fields. 206662bd3315SOmar Emara int FieldDelegateGetHeight() override { 206762bd3315SOmar Emara return std::max(m_key_field.FieldDelegateGetHeight(), 206862bd3315SOmar Emara m_value_field.FieldDelegateGetHeight()); 206962bd3315SOmar Emara } 207062bd3315SOmar Emara 207179e950a2SOmar Emara void DrawArrow(Surface &surface) { 207262bd3315SOmar Emara surface.MoveCursor(0, 1); 207362bd3315SOmar Emara surface.PutChar(ACS_RARROW); 207462bd3315SOmar Emara } 207562bd3315SOmar Emara 207679e950a2SOmar Emara void FieldDelegateDraw(Surface &surface, bool is_selected) override { 207762bd3315SOmar Emara Rect bounds = surface.GetFrame(); 207862bd3315SOmar Emara Rect key_field_bounds, arrow_and_value_field_bounds; 207962bd3315SOmar Emara bounds.VerticalSplit(bounds.size.width / 2, key_field_bounds, 208062bd3315SOmar Emara arrow_and_value_field_bounds); 208162bd3315SOmar Emara Rect arrow_bounds, value_field_bounds; 208262bd3315SOmar Emara arrow_and_value_field_bounds.VerticalSplit(1, arrow_bounds, 208362bd3315SOmar Emara value_field_bounds); 208462bd3315SOmar Emara 208579e950a2SOmar Emara Surface key_field_surface = surface.SubSurface(key_field_bounds); 208679e950a2SOmar Emara Surface arrow_surface = surface.SubSurface(arrow_bounds); 208779e950a2SOmar Emara Surface value_field_surface = surface.SubSurface(value_field_bounds); 208862bd3315SOmar Emara 208962bd3315SOmar Emara bool key_is_selected = 209062bd3315SOmar Emara m_selection_type == SelectionType::Key && is_selected; 209162bd3315SOmar Emara m_key_field.FieldDelegateDraw(key_field_surface, key_is_selected); 209262bd3315SOmar Emara DrawArrow(arrow_surface); 209362bd3315SOmar Emara bool value_is_selected = 209462bd3315SOmar Emara m_selection_type == SelectionType::Value && is_selected; 209562bd3315SOmar Emara m_value_field.FieldDelegateDraw(value_field_surface, value_is_selected); 209662bd3315SOmar Emara } 209762bd3315SOmar Emara 209862bd3315SOmar Emara HandleCharResult SelectNext(int key) { 209962bd3315SOmar Emara if (FieldDelegateOnLastOrOnlyElement()) 210062bd3315SOmar Emara return eKeyNotHandled; 210162bd3315SOmar Emara 210262bd3315SOmar Emara if (!m_key_field.FieldDelegateOnLastOrOnlyElement()) { 210362bd3315SOmar Emara return m_key_field.FieldDelegateHandleChar(key); 210462bd3315SOmar Emara } 210562bd3315SOmar Emara 210662bd3315SOmar Emara m_key_field.FieldDelegateExitCallback(); 210762bd3315SOmar Emara m_selection_type = SelectionType::Value; 210862bd3315SOmar Emara m_value_field.FieldDelegateSelectFirstElement(); 210962bd3315SOmar Emara return eKeyHandled; 211062bd3315SOmar Emara } 211162bd3315SOmar Emara 211262bd3315SOmar Emara HandleCharResult SelectPrevious(int key) { 211362bd3315SOmar Emara if (FieldDelegateOnFirstOrOnlyElement()) 211462bd3315SOmar Emara return eKeyNotHandled; 211562bd3315SOmar Emara 211662bd3315SOmar Emara if (!m_value_field.FieldDelegateOnFirstOrOnlyElement()) { 211762bd3315SOmar Emara return m_value_field.FieldDelegateHandleChar(key); 211862bd3315SOmar Emara } 211962bd3315SOmar Emara 212062bd3315SOmar Emara m_value_field.FieldDelegateExitCallback(); 212162bd3315SOmar Emara m_selection_type = SelectionType::Key; 212262bd3315SOmar Emara m_key_field.FieldDelegateSelectLastElement(); 212362bd3315SOmar Emara return eKeyHandled; 212462bd3315SOmar Emara } 212562bd3315SOmar Emara 212628a76049SOmar Emara // If the value field is selected, pass the key to it. If the key field is 212728a76049SOmar Emara // selected, its last element is selected, and it didn't handle the key, then 212828a76049SOmar Emara // select its corresponding value field. 212928a76049SOmar Emara HandleCharResult SelectNextField(int key) { 213028a76049SOmar Emara if (m_selection_type == SelectionType::Value) { 213128a76049SOmar Emara return m_value_field.FieldDelegateHandleChar(key); 213228a76049SOmar Emara } 213328a76049SOmar Emara 213428a76049SOmar Emara if (m_key_field.FieldDelegateHandleChar(key) == eKeyHandled) 213528a76049SOmar Emara return eKeyHandled; 213628a76049SOmar Emara 213728a76049SOmar Emara if (!m_key_field.FieldDelegateOnLastOrOnlyElement()) 213828a76049SOmar Emara return eKeyNotHandled; 213928a76049SOmar Emara 214028a76049SOmar Emara m_key_field.FieldDelegateExitCallback(); 214128a76049SOmar Emara m_selection_type = SelectionType::Value; 214228a76049SOmar Emara m_value_field.FieldDelegateSelectFirstElement(); 214328a76049SOmar Emara return eKeyHandled; 214428a76049SOmar Emara } 214528a76049SOmar Emara 214662bd3315SOmar Emara HandleCharResult FieldDelegateHandleChar(int key) override { 214762bd3315SOmar Emara switch (key) { 214828a76049SOmar Emara case KEY_RETURN: 214928a76049SOmar Emara return SelectNextField(key); 215062bd3315SOmar Emara case '\t': 215128a76049SOmar Emara return SelectNext(key); 215262bd3315SOmar Emara case KEY_SHIFT_TAB: 215328a76049SOmar Emara return SelectPrevious(key); 215462bd3315SOmar Emara default: 215562bd3315SOmar Emara break; 215662bd3315SOmar Emara } 215762bd3315SOmar Emara 215862bd3315SOmar Emara // If the key wasn't handled, pass the key to the selected field. 215962bd3315SOmar Emara if (m_selection_type == SelectionType::Key) 216062bd3315SOmar Emara return m_key_field.FieldDelegateHandleChar(key); 216162bd3315SOmar Emara else 216262bd3315SOmar Emara return m_value_field.FieldDelegateHandleChar(key); 216362bd3315SOmar Emara 216462bd3315SOmar Emara return eKeyNotHandled; 216562bd3315SOmar Emara } 216662bd3315SOmar Emara 216762bd3315SOmar Emara bool FieldDelegateOnFirstOrOnlyElement() override { 216862bd3315SOmar Emara return m_selection_type == SelectionType::Key; 216962bd3315SOmar Emara } 217062bd3315SOmar Emara 217162bd3315SOmar Emara bool FieldDelegateOnLastOrOnlyElement() override { 217262bd3315SOmar Emara return m_selection_type == SelectionType::Value; 217362bd3315SOmar Emara } 217462bd3315SOmar Emara 217562bd3315SOmar Emara void FieldDelegateSelectFirstElement() override { 217662bd3315SOmar Emara m_selection_type = SelectionType::Key; 217762bd3315SOmar Emara } 217862bd3315SOmar Emara 217962bd3315SOmar Emara void FieldDelegateSelectLastElement() override { 218062bd3315SOmar Emara m_selection_type = SelectionType::Value; 218162bd3315SOmar Emara } 218262bd3315SOmar Emara 218362bd3315SOmar Emara bool FieldDelegateHasError() override { 218462bd3315SOmar Emara return m_key_field.FieldDelegateHasError() || 218562bd3315SOmar Emara m_value_field.FieldDelegateHasError(); 218662bd3315SOmar Emara } 218762bd3315SOmar Emara 218862bd3315SOmar Emara KeyFieldDelegateType &GetKeyField() { return m_key_field; } 218962bd3315SOmar Emara 219062bd3315SOmar Emara ValueFieldDelegateType &GetValueField() { return m_value_field; } 219162bd3315SOmar Emara 219262bd3315SOmar Emara protected: 219362bd3315SOmar Emara KeyFieldDelegateType m_key_field; 219462bd3315SOmar Emara ValueFieldDelegateType m_value_field; 219562bd3315SOmar Emara // See SelectionType class enum. 219662bd3315SOmar Emara SelectionType m_selection_type; 219762bd3315SOmar Emara }; 219862bd3315SOmar Emara 219962bd3315SOmar Emara class EnvironmentVariableNameFieldDelegate : public TextFieldDelegate { 220062bd3315SOmar Emara public: 220162bd3315SOmar Emara EnvironmentVariableNameFieldDelegate(const char *content) 220262bd3315SOmar Emara : TextFieldDelegate("Name", content, true) {} 220362bd3315SOmar Emara 220462bd3315SOmar Emara // Environment variable names can't contain an equal sign. 220562bd3315SOmar Emara bool IsAcceptableChar(int key) override { 220662bd3315SOmar Emara return TextFieldDelegate::IsAcceptableChar(key) && key != '='; 220762bd3315SOmar Emara } 220862bd3315SOmar Emara 220962bd3315SOmar Emara const std::string &GetName() { return m_content; } 221062bd3315SOmar Emara }; 221162bd3315SOmar Emara 221262bd3315SOmar Emara class EnvironmentVariableFieldDelegate 221362bd3315SOmar Emara : public MappingFieldDelegate<EnvironmentVariableNameFieldDelegate, 221462bd3315SOmar Emara TextFieldDelegate> { 221562bd3315SOmar Emara public: 221662bd3315SOmar Emara EnvironmentVariableFieldDelegate() 221762bd3315SOmar Emara : MappingFieldDelegate( 221862bd3315SOmar Emara EnvironmentVariableNameFieldDelegate(""), 221962bd3315SOmar Emara TextFieldDelegate("Value", "", /*required=*/false)) {} 222062bd3315SOmar Emara 222162bd3315SOmar Emara const std::string &GetName() { return GetKeyField().GetName(); } 222262bd3315SOmar Emara 222362bd3315SOmar Emara const std::string &GetValue() { return GetValueField().GetText(); } 222482507f17SOmar Emara 222582507f17SOmar Emara void SetName(const char *name) { return GetKeyField().SetText(name); } 222682507f17SOmar Emara 222782507f17SOmar Emara void SetValue(const char *value) { return GetValueField().SetText(value); } 222862bd3315SOmar Emara }; 222962bd3315SOmar Emara 223062bd3315SOmar Emara class EnvironmentVariableListFieldDelegate 223162bd3315SOmar Emara : public ListFieldDelegate<EnvironmentVariableFieldDelegate> { 223262bd3315SOmar Emara public: 223382507f17SOmar Emara EnvironmentVariableListFieldDelegate(const char *label) 223482507f17SOmar Emara : ListFieldDelegate(label, EnvironmentVariableFieldDelegate()) {} 223582507f17SOmar Emara 223682507f17SOmar Emara Environment GetEnvironment() { 223782507f17SOmar Emara Environment environment; 223882507f17SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 223982507f17SOmar Emara environment.insert( 224082507f17SOmar Emara std::make_pair(GetField(i).GetName(), GetField(i).GetValue())); 224182507f17SOmar Emara } 224282507f17SOmar Emara return environment; 224382507f17SOmar Emara } 224482507f17SOmar Emara 224582507f17SOmar Emara void AddEnvironmentVariables(const Environment &environment) { 224682507f17SOmar Emara for (auto &variable : environment) { 224782507f17SOmar Emara AddNewField(); 224882507f17SOmar Emara EnvironmentVariableFieldDelegate &field = 224982507f17SOmar Emara GetField(GetNumberOfFields() - 1); 225082507f17SOmar Emara field.SetName(variable.getKey().str().c_str()); 225182507f17SOmar Emara field.SetValue(variable.getValue().c_str()); 225282507f17SOmar Emara } 225382507f17SOmar Emara } 225462bd3315SOmar Emara }; 225562bd3315SOmar Emara 225629cc50e1SOmar Emara class FormAction { 225729cc50e1SOmar Emara public: 225829cc50e1SOmar Emara FormAction(const char *label, std::function<void(Window &)> action) 225929cc50e1SOmar Emara : m_action(action) { 226029cc50e1SOmar Emara if (label) 226129cc50e1SOmar Emara m_label = label; 226229cc50e1SOmar Emara } 226329cc50e1SOmar Emara 226429cc50e1SOmar Emara // Draw a centered [Label]. 226579e950a2SOmar Emara void Draw(Surface &surface, bool is_selected) { 226629cc50e1SOmar Emara int x = (surface.GetWidth() - m_label.length()) / 2; 226729cc50e1SOmar Emara surface.MoveCursor(x, 0); 226829cc50e1SOmar Emara if (is_selected) 226929cc50e1SOmar Emara surface.AttributeOn(A_REVERSE); 227029cc50e1SOmar Emara surface.PutChar('['); 227129cc50e1SOmar Emara surface.PutCString(m_label.c_str()); 227229cc50e1SOmar Emara surface.PutChar(']'); 227329cc50e1SOmar Emara if (is_selected) 227429cc50e1SOmar Emara surface.AttributeOff(A_REVERSE); 227529cc50e1SOmar Emara } 227629cc50e1SOmar Emara 227729cc50e1SOmar Emara void Execute(Window &window) { m_action(window); } 227829cc50e1SOmar Emara 227929cc50e1SOmar Emara const std::string &GetLabel() { return m_label; } 228029cc50e1SOmar Emara 228129cc50e1SOmar Emara protected: 228229cc50e1SOmar Emara std::string m_label; 228329cc50e1SOmar Emara std::function<void(Window &)> m_action; 228429cc50e1SOmar Emara }; 228529cc50e1SOmar Emara 228629cc50e1SOmar Emara class FormDelegate { 228729cc50e1SOmar Emara public: 228829cc50e1SOmar Emara FormDelegate() {} 228929cc50e1SOmar Emara 229029cc50e1SOmar Emara virtual ~FormDelegate() = default; 229129cc50e1SOmar Emara 22920321dbc8SOmar Emara virtual std::string GetName() = 0; 22930321dbc8SOmar Emara 22940321dbc8SOmar Emara virtual void UpdateFieldsVisibility() { return; } 22950321dbc8SOmar Emara 22960321dbc8SOmar Emara FieldDelegate *GetField(uint32_t field_index) { 22970321dbc8SOmar Emara if (field_index < m_fields.size()) 22980321dbc8SOmar Emara return m_fields[field_index].get(); 22990321dbc8SOmar Emara return nullptr; 23000321dbc8SOmar Emara } 230129cc50e1SOmar Emara 230229cc50e1SOmar Emara FormAction &GetAction(int action_index) { return m_actions[action_index]; } 230329cc50e1SOmar Emara 230429cc50e1SOmar Emara int GetNumberOfFields() { return m_fields.size(); } 230529cc50e1SOmar Emara 230629cc50e1SOmar Emara int GetNumberOfActions() { return m_actions.size(); } 230729cc50e1SOmar Emara 230829cc50e1SOmar Emara bool HasError() { return !m_error.empty(); } 230929cc50e1SOmar Emara 231029cc50e1SOmar Emara void ClearError() { m_error.clear(); } 231129cc50e1SOmar Emara 231229cc50e1SOmar Emara const std::string &GetError() { return m_error; } 231329cc50e1SOmar Emara 231429cc50e1SOmar Emara void SetError(const char *error) { m_error = error; } 231529cc50e1SOmar Emara 231680ac12b7SOmar Emara // If all fields are valid, true is returned. Otherwise, an error message is 231780ac12b7SOmar Emara // set and false is returned. This method is usually called at the start of an 231880ac12b7SOmar Emara // action that requires valid fields. 231980ac12b7SOmar Emara bool CheckFieldsValidity() { 232080ac12b7SOmar Emara for (int i = 0; i < GetNumberOfFields(); i++) { 2321945cde8bSOmar Emara GetField(i)->FieldDelegateExitCallback(); 232280ac12b7SOmar Emara if (GetField(i)->FieldDelegateHasError()) { 232380ac12b7SOmar Emara SetError("Some fields are invalid!"); 232480ac12b7SOmar Emara return false; 232580ac12b7SOmar Emara } 232680ac12b7SOmar Emara } 232780ac12b7SOmar Emara return true; 232880ac12b7SOmar Emara } 232980ac12b7SOmar Emara 233029cc50e1SOmar Emara // Factory methods to create and add fields of specific types. 233129cc50e1SOmar Emara 23329ef7de7cSOmar Emara TextFieldDelegate *AddTextField(const char *label, const char *content, 23339ef7de7cSOmar Emara bool required) { 23349ef7de7cSOmar Emara TextFieldDelegate *delegate = 23359ef7de7cSOmar Emara new TextFieldDelegate(label, content, required); 23360321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 233729cc50e1SOmar Emara return delegate; 233829cc50e1SOmar Emara } 233929cc50e1SOmar Emara 234029cc50e1SOmar Emara FileFieldDelegate *AddFileField(const char *label, const char *content, 23419ef7de7cSOmar Emara bool need_to_exist, bool required) { 234229cc50e1SOmar Emara FileFieldDelegate *delegate = 23439ef7de7cSOmar Emara new FileFieldDelegate(label, content, need_to_exist, required); 23440321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 234529cc50e1SOmar Emara return delegate; 234629cc50e1SOmar Emara } 234729cc50e1SOmar Emara 234829cc50e1SOmar Emara DirectoryFieldDelegate *AddDirectoryField(const char *label, 234929cc50e1SOmar Emara const char *content, 23509ef7de7cSOmar Emara bool need_to_exist, bool required) { 235129cc50e1SOmar Emara DirectoryFieldDelegate *delegate = 23529ef7de7cSOmar Emara new DirectoryFieldDelegate(label, content, need_to_exist, required); 23530321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 235429cc50e1SOmar Emara return delegate; 235529cc50e1SOmar Emara } 235629cc50e1SOmar Emara 2357ed5b4dbdSOmar Emara ArchFieldDelegate *AddArchField(const char *label, const char *content, 2358ed5b4dbdSOmar Emara bool required) { 2359ed5b4dbdSOmar Emara ArchFieldDelegate *delegate = 2360ed5b4dbdSOmar Emara new ArchFieldDelegate(label, content, required); 2361ed5b4dbdSOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 2362ed5b4dbdSOmar Emara return delegate; 2363ed5b4dbdSOmar Emara } 2364ed5b4dbdSOmar Emara 23659ef7de7cSOmar Emara IntegerFieldDelegate *AddIntegerField(const char *label, int content, 23669ef7de7cSOmar Emara bool required) { 23679ef7de7cSOmar Emara IntegerFieldDelegate *delegate = 23689ef7de7cSOmar Emara new IntegerFieldDelegate(label, content, required); 23690321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 237029cc50e1SOmar Emara return delegate; 237129cc50e1SOmar Emara } 237229cc50e1SOmar Emara 237329cc50e1SOmar Emara BooleanFieldDelegate *AddBooleanField(const char *label, bool content) { 237429cc50e1SOmar Emara BooleanFieldDelegate *delegate = new BooleanFieldDelegate(label, content); 23750321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 237629cc50e1SOmar Emara return delegate; 237729cc50e1SOmar Emara } 237829cc50e1SOmar Emara 237982507f17SOmar Emara LazyBooleanFieldDelegate *AddLazyBooleanField(const char *label, 238082507f17SOmar Emara const char *calculate_label) { 238182507f17SOmar Emara LazyBooleanFieldDelegate *delegate = 238282507f17SOmar Emara new LazyBooleanFieldDelegate(label, calculate_label); 238382507f17SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 238482507f17SOmar Emara return delegate; 238582507f17SOmar Emara } 238682507f17SOmar Emara 238729cc50e1SOmar Emara ChoicesFieldDelegate *AddChoicesField(const char *label, int height, 238829cc50e1SOmar Emara std::vector<std::string> choices) { 238929cc50e1SOmar Emara ChoicesFieldDelegate *delegate = 239029cc50e1SOmar Emara new ChoicesFieldDelegate(label, height, choices); 23910321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 239229cc50e1SOmar Emara return delegate; 239329cc50e1SOmar Emara } 239429cc50e1SOmar Emara 2395e160b398SOmar Emara PlatformPluginFieldDelegate *AddPlatformPluginField(Debugger &debugger) { 2396e160b398SOmar Emara PlatformPluginFieldDelegate *delegate = 2397e160b398SOmar Emara new PlatformPluginFieldDelegate(debugger); 2398e160b398SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 2399e160b398SOmar Emara return delegate; 2400e160b398SOmar Emara } 2401e160b398SOmar Emara 2402c93dc259SOmar Emara ProcessPluginFieldDelegate *AddProcessPluginField() { 2403c93dc259SOmar Emara ProcessPluginFieldDelegate *delegate = new ProcessPluginFieldDelegate(); 2404c93dc259SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 2405c93dc259SOmar Emara return delegate; 2406c93dc259SOmar Emara } 2407c93dc259SOmar Emara 240829cc50e1SOmar Emara template <class T> 240929cc50e1SOmar Emara ListFieldDelegate<T> *AddListField(const char *label, T default_field) { 241029cc50e1SOmar Emara ListFieldDelegate<T> *delegate = 241129cc50e1SOmar Emara new ListFieldDelegate<T>(label, default_field); 24120321dbc8SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 241329cc50e1SOmar Emara return delegate; 241429cc50e1SOmar Emara } 241529cc50e1SOmar Emara 241682507f17SOmar Emara ArgumentsFieldDelegate *AddArgumentsField() { 241782507f17SOmar Emara ArgumentsFieldDelegate *delegate = new ArgumentsFieldDelegate(); 241882507f17SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 241982507f17SOmar Emara return delegate; 242082507f17SOmar Emara } 242182507f17SOmar Emara 242262bd3315SOmar Emara template <class K, class V> 242362bd3315SOmar Emara MappingFieldDelegate<K, V> *AddMappingField(K key_field, V value_field) { 242462bd3315SOmar Emara MappingFieldDelegate<K, V> *delegate = 242562bd3315SOmar Emara new MappingFieldDelegate<K, V>(key_field, value_field); 242662bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 242762bd3315SOmar Emara return delegate; 242862bd3315SOmar Emara } 242962bd3315SOmar Emara 243062bd3315SOmar Emara EnvironmentVariableNameFieldDelegate * 243162bd3315SOmar Emara AddEnvironmentVariableNameField(const char *content) { 243262bd3315SOmar Emara EnvironmentVariableNameFieldDelegate *delegate = 243362bd3315SOmar Emara new EnvironmentVariableNameFieldDelegate(content); 243462bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 243562bd3315SOmar Emara return delegate; 243662bd3315SOmar Emara } 243762bd3315SOmar Emara 243862bd3315SOmar Emara EnvironmentVariableFieldDelegate *AddEnvironmentVariableField() { 243962bd3315SOmar Emara EnvironmentVariableFieldDelegate *delegate = 244062bd3315SOmar Emara new EnvironmentVariableFieldDelegate(); 244162bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 244262bd3315SOmar Emara return delegate; 244362bd3315SOmar Emara } 244462bd3315SOmar Emara 244582507f17SOmar Emara EnvironmentVariableListFieldDelegate * 244682507f17SOmar Emara AddEnvironmentVariableListField(const char *label) { 244762bd3315SOmar Emara EnvironmentVariableListFieldDelegate *delegate = 244882507f17SOmar Emara new EnvironmentVariableListFieldDelegate(label); 244962bd3315SOmar Emara m_fields.push_back(FieldDelegateUP(delegate)); 245062bd3315SOmar Emara return delegate; 245162bd3315SOmar Emara } 245262bd3315SOmar Emara 245329cc50e1SOmar Emara // Factory methods for adding actions. 245429cc50e1SOmar Emara 245529cc50e1SOmar Emara void AddAction(const char *label, std::function<void(Window &)> action) { 245629cc50e1SOmar Emara m_actions.push_back(FormAction(label, action)); 245729cc50e1SOmar Emara } 245829cc50e1SOmar Emara 245929cc50e1SOmar Emara protected: 24600321dbc8SOmar Emara std::vector<FieldDelegateUP> m_fields; 246129cc50e1SOmar Emara std::vector<FormAction> m_actions; 246229cc50e1SOmar Emara // Optional error message. If empty, form is considered to have no error. 246329cc50e1SOmar Emara std::string m_error; 246429cc50e1SOmar Emara }; 246529cc50e1SOmar Emara 246629cc50e1SOmar Emara typedef std::shared_ptr<FormDelegate> FormDelegateSP; 246729cc50e1SOmar Emara 246829cc50e1SOmar Emara class FormWindowDelegate : public WindowDelegate { 246929cc50e1SOmar Emara public: 247029cc50e1SOmar Emara FormWindowDelegate(FormDelegateSP &delegate_sp) 247129cc50e1SOmar Emara : m_delegate_sp(delegate_sp), m_selection_index(0), 24720321dbc8SOmar Emara m_first_visible_line(0) { 24730321dbc8SOmar Emara assert(m_delegate_sp->GetNumberOfActions() > 0); 24740321dbc8SOmar Emara if (m_delegate_sp->GetNumberOfFields() > 0) 24750321dbc8SOmar Emara m_selection_type = SelectionType::Field; 24760321dbc8SOmar Emara else 24770321dbc8SOmar Emara m_selection_type = SelectionType::Action; 24780321dbc8SOmar Emara } 247929cc50e1SOmar Emara 248029cc50e1SOmar Emara // Signify which element is selected. If a field or an action is selected, 248129cc50e1SOmar Emara // then m_selection_index signifies the particular field or action that is 248229cc50e1SOmar Emara // selected. 248329cc50e1SOmar Emara enum class SelectionType { Field, Action }; 248429cc50e1SOmar Emara 248529cc50e1SOmar Emara // A form window is padded by one character from all sides. First, if an error 248629cc50e1SOmar Emara // message exists, it is drawn followed by a separator. Then one or more 248729cc50e1SOmar Emara // fields are drawn. Finally, all available actions are drawn on a single 248829cc50e1SOmar Emara // line. 248929cc50e1SOmar Emara // 249029cc50e1SOmar Emara // ___<Form Name>_________________________________________________ 249129cc50e1SOmar Emara // | | 249229cc50e1SOmar Emara // | - Error message if it exists. | 249329cc50e1SOmar Emara // |-------------------------------------------------------------| 249429cc50e1SOmar Emara // | Form elements here. | 249529cc50e1SOmar Emara // | Form actions here. | 249629cc50e1SOmar Emara // | | 249729cc50e1SOmar Emara // |______________________________________[Press Esc to cancel]__| 249829cc50e1SOmar Emara // 249929cc50e1SOmar Emara 250029cc50e1SOmar Emara // One line for the error and another for the horizontal line. 250129cc50e1SOmar Emara int GetErrorHeight() { 250229cc50e1SOmar Emara if (m_delegate_sp->HasError()) 250329cc50e1SOmar Emara return 2; 250429cc50e1SOmar Emara return 0; 250529cc50e1SOmar Emara } 250629cc50e1SOmar Emara 250729cc50e1SOmar Emara // Actions span a single line. 250829cc50e1SOmar Emara int GetActionsHeight() { 250929cc50e1SOmar Emara if (m_delegate_sp->GetNumberOfActions() > 0) 251029cc50e1SOmar Emara return 1; 251129cc50e1SOmar Emara return 0; 251229cc50e1SOmar Emara } 251329cc50e1SOmar Emara 251429cc50e1SOmar Emara // Get the total number of needed lines to draw the contents. 251529cc50e1SOmar Emara int GetContentHeight() { 251629cc50e1SOmar Emara int height = 0; 251729cc50e1SOmar Emara height += GetErrorHeight(); 251829cc50e1SOmar Emara for (int i = 0; i < m_delegate_sp->GetNumberOfFields(); i++) { 25190321dbc8SOmar Emara if (!m_delegate_sp->GetField(i)->FieldDelegateIsVisible()) 25200321dbc8SOmar Emara continue; 252129cc50e1SOmar Emara height += m_delegate_sp->GetField(i)->FieldDelegateGetHeight(); 252229cc50e1SOmar Emara } 252329cc50e1SOmar Emara height += GetActionsHeight(); 252429cc50e1SOmar Emara return height; 252529cc50e1SOmar Emara } 252629cc50e1SOmar Emara 252729cc50e1SOmar Emara ScrollContext GetScrollContext() { 252829cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) 252929cc50e1SOmar Emara return ScrollContext(GetContentHeight() - 1); 253029cc50e1SOmar Emara 25310321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 253229cc50e1SOmar Emara ScrollContext context = field->FieldDelegateGetScrollContext(); 253329cc50e1SOmar Emara 253429cc50e1SOmar Emara int offset = GetErrorHeight(); 253529cc50e1SOmar Emara for (int i = 0; i < m_selection_index; i++) { 25360321dbc8SOmar Emara if (!m_delegate_sp->GetField(i)->FieldDelegateIsVisible()) 25370321dbc8SOmar Emara continue; 253829cc50e1SOmar Emara offset += m_delegate_sp->GetField(i)->FieldDelegateGetHeight(); 253929cc50e1SOmar Emara } 254029cc50e1SOmar Emara context.Offset(offset); 254129cc50e1SOmar Emara 254229cc50e1SOmar Emara // If the context is touching the error, include the error in the context as 254329cc50e1SOmar Emara // well. 254429cc50e1SOmar Emara if (context.start == GetErrorHeight()) 254529cc50e1SOmar Emara context.start = 0; 254629cc50e1SOmar Emara 254729cc50e1SOmar Emara return context; 254829cc50e1SOmar Emara } 254929cc50e1SOmar Emara 255079e950a2SOmar Emara void UpdateScrolling(Surface &surface) { 255129cc50e1SOmar Emara ScrollContext context = GetScrollContext(); 255229cc50e1SOmar Emara int content_height = GetContentHeight(); 255329cc50e1SOmar Emara int surface_height = surface.GetHeight(); 255429cc50e1SOmar Emara int visible_height = std::min(content_height, surface_height); 255529cc50e1SOmar Emara int last_visible_line = m_first_visible_line + visible_height - 1; 255629cc50e1SOmar Emara 255729cc50e1SOmar Emara // If the last visible line is bigger than the content, then it is invalid 255829cc50e1SOmar Emara // and needs to be set to the last line in the content. This can happen when 255929cc50e1SOmar Emara // a field has shrunk in height. 256029cc50e1SOmar Emara if (last_visible_line > content_height - 1) { 256129cc50e1SOmar Emara m_first_visible_line = content_height - visible_height; 256229cc50e1SOmar Emara } 256329cc50e1SOmar Emara 256429cc50e1SOmar Emara if (context.start < m_first_visible_line) { 256529cc50e1SOmar Emara m_first_visible_line = context.start; 256629cc50e1SOmar Emara return; 256729cc50e1SOmar Emara } 256829cc50e1SOmar Emara 256929cc50e1SOmar Emara if (context.end > last_visible_line) { 257029cc50e1SOmar Emara m_first_visible_line = context.end - visible_height + 1; 257129cc50e1SOmar Emara } 257229cc50e1SOmar Emara } 257329cc50e1SOmar Emara 257479e950a2SOmar Emara void DrawError(Surface &surface) { 257529cc50e1SOmar Emara if (!m_delegate_sp->HasError()) 257629cc50e1SOmar Emara return; 257729cc50e1SOmar Emara surface.MoveCursor(0, 0); 257829cc50e1SOmar Emara surface.AttributeOn(COLOR_PAIR(RedOnBlack)); 257929cc50e1SOmar Emara surface.PutChar(ACS_DIAMOND); 258029cc50e1SOmar Emara surface.PutChar(' '); 258129cc50e1SOmar Emara surface.PutCStringTruncated(1, m_delegate_sp->GetError().c_str()); 258229cc50e1SOmar Emara surface.AttributeOff(COLOR_PAIR(RedOnBlack)); 258329cc50e1SOmar Emara 258429cc50e1SOmar Emara surface.MoveCursor(0, 1); 258529cc50e1SOmar Emara surface.HorizontalLine(surface.GetWidth()); 258629cc50e1SOmar Emara } 258729cc50e1SOmar Emara 258879e950a2SOmar Emara void DrawFields(Surface &surface) { 258929cc50e1SOmar Emara int line = 0; 259029cc50e1SOmar Emara int width = surface.GetWidth(); 259129cc50e1SOmar Emara bool a_field_is_selected = m_selection_type == SelectionType::Field; 259229cc50e1SOmar Emara for (int i = 0; i < m_delegate_sp->GetNumberOfFields(); i++) { 25930321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(i); 25940321dbc8SOmar Emara if (!field->FieldDelegateIsVisible()) 25950321dbc8SOmar Emara continue; 259629cc50e1SOmar Emara bool is_field_selected = a_field_is_selected && m_selection_index == i; 259729cc50e1SOmar Emara int height = field->FieldDelegateGetHeight(); 259829cc50e1SOmar Emara Rect bounds = Rect(Point(0, line), Size(width, height)); 259979e950a2SOmar Emara Surface field_surface = surface.SubSurface(bounds); 260029cc50e1SOmar Emara field->FieldDelegateDraw(field_surface, is_field_selected); 260129cc50e1SOmar Emara line += height; 260229cc50e1SOmar Emara } 260329cc50e1SOmar Emara } 260429cc50e1SOmar Emara 260579e950a2SOmar Emara void DrawActions(Surface &surface) { 260629cc50e1SOmar Emara int number_of_actions = m_delegate_sp->GetNumberOfActions(); 260729cc50e1SOmar Emara int width = surface.GetWidth() / number_of_actions; 260829cc50e1SOmar Emara bool an_action_is_selected = m_selection_type == SelectionType::Action; 260929cc50e1SOmar Emara int x = 0; 261029cc50e1SOmar Emara for (int i = 0; i < number_of_actions; i++) { 261129cc50e1SOmar Emara bool is_action_selected = an_action_is_selected && m_selection_index == i; 261229cc50e1SOmar Emara FormAction &action = m_delegate_sp->GetAction(i); 261329cc50e1SOmar Emara Rect bounds = Rect(Point(x, 0), Size(width, 1)); 261479e950a2SOmar Emara Surface action_surface = surface.SubSurface(bounds); 261529cc50e1SOmar Emara action.Draw(action_surface, is_action_selected); 261629cc50e1SOmar Emara x += width; 261729cc50e1SOmar Emara } 261829cc50e1SOmar Emara } 261929cc50e1SOmar Emara 262079e950a2SOmar Emara void DrawElements(Surface &surface) { 262129cc50e1SOmar Emara Rect frame = surface.GetFrame(); 262229cc50e1SOmar Emara Rect fields_bounds, actions_bounds; 262329cc50e1SOmar Emara frame.HorizontalSplit(surface.GetHeight() - GetActionsHeight(), 262429cc50e1SOmar Emara fields_bounds, actions_bounds); 262579e950a2SOmar Emara Surface fields_surface = surface.SubSurface(fields_bounds); 262679e950a2SOmar Emara Surface actions_surface = surface.SubSurface(actions_bounds); 262729cc50e1SOmar Emara 262829cc50e1SOmar Emara DrawFields(fields_surface); 262929cc50e1SOmar Emara DrawActions(actions_surface); 263029cc50e1SOmar Emara } 263129cc50e1SOmar Emara 263229cc50e1SOmar Emara // Contents are first drawn on a pad. Then a subset of that pad is copied to 263329cc50e1SOmar Emara // the derived window starting at the first visible line. This essentially 263429cc50e1SOmar Emara // provides scrolling functionality. 263579e950a2SOmar Emara void DrawContent(Surface &surface) { 263629cc50e1SOmar Emara UpdateScrolling(surface); 263729cc50e1SOmar Emara 263829cc50e1SOmar Emara int width = surface.GetWidth(); 263929cc50e1SOmar Emara int height = GetContentHeight(); 264029cc50e1SOmar Emara Pad pad = Pad(Size(width, height)); 264129cc50e1SOmar Emara 264229cc50e1SOmar Emara Rect frame = pad.GetFrame(); 264329cc50e1SOmar Emara Rect error_bounds, elements_bounds; 264429cc50e1SOmar Emara frame.HorizontalSplit(GetErrorHeight(), error_bounds, elements_bounds); 264579e950a2SOmar Emara Surface error_surface = pad.SubSurface(error_bounds); 264679e950a2SOmar Emara Surface elements_surface = pad.SubSurface(elements_bounds); 264729cc50e1SOmar Emara 264829cc50e1SOmar Emara DrawError(error_surface); 264929cc50e1SOmar Emara DrawElements(elements_surface); 265029cc50e1SOmar Emara 265129cc50e1SOmar Emara int copy_height = std::min(surface.GetHeight(), pad.GetHeight()); 265229cc50e1SOmar Emara pad.CopyToSurface(surface, Point(0, m_first_visible_line), Point(), 265329cc50e1SOmar Emara Size(width, copy_height)); 265429cc50e1SOmar Emara } 265529cc50e1SOmar Emara 2656945cde8bSOmar Emara void DrawSubmitHint(Surface &surface, bool is_active) { 2657945cde8bSOmar Emara surface.MoveCursor(2, surface.GetHeight() - 1); 2658945cde8bSOmar Emara if (is_active) 2659945cde8bSOmar Emara surface.AttributeOn(A_BOLD | COLOR_PAIR(BlackOnWhite)); 2660945cde8bSOmar Emara surface.Printf("[Press Alt+Enter to %s]", 2661945cde8bSOmar Emara m_delegate_sp->GetAction(0).GetLabel().c_str()); 2662945cde8bSOmar Emara if (is_active) 2663945cde8bSOmar Emara surface.AttributeOff(A_BOLD | COLOR_PAIR(BlackOnWhite)); 2664945cde8bSOmar Emara } 2665945cde8bSOmar Emara 266629cc50e1SOmar Emara bool WindowDelegateDraw(Window &window, bool force) override { 26670321dbc8SOmar Emara m_delegate_sp->UpdateFieldsVisibility(); 266829cc50e1SOmar Emara 266929cc50e1SOmar Emara window.Erase(); 267029cc50e1SOmar Emara 26710321dbc8SOmar Emara window.DrawTitleBox(m_delegate_sp->GetName().c_str(), 2672945cde8bSOmar Emara "Press Esc to Cancel"); 2673945cde8bSOmar Emara DrawSubmitHint(window, window.IsActive()); 267429cc50e1SOmar Emara 267529cc50e1SOmar Emara Rect content_bounds = window.GetFrame(); 267629cc50e1SOmar Emara content_bounds.Inset(2, 2); 267779e950a2SOmar Emara Surface content_surface = window.SubSurface(content_bounds); 267829cc50e1SOmar Emara 267929cc50e1SOmar Emara DrawContent(content_surface); 268029cc50e1SOmar Emara return true; 268129cc50e1SOmar Emara } 268229cc50e1SOmar Emara 26830321dbc8SOmar Emara void SkipNextHiddenFields() { 26840321dbc8SOmar Emara while (true) { 26850321dbc8SOmar Emara if (m_delegate_sp->GetField(m_selection_index)->FieldDelegateIsVisible()) 26860321dbc8SOmar Emara return; 26870321dbc8SOmar Emara 26880321dbc8SOmar Emara if (m_selection_index == m_delegate_sp->GetNumberOfFields() - 1) { 26890321dbc8SOmar Emara m_selection_type = SelectionType::Action; 26900321dbc8SOmar Emara m_selection_index = 0; 26910321dbc8SOmar Emara return; 26920321dbc8SOmar Emara } 26930321dbc8SOmar Emara 26940321dbc8SOmar Emara m_selection_index++; 26950321dbc8SOmar Emara } 26960321dbc8SOmar Emara } 26970321dbc8SOmar Emara 26980321dbc8SOmar Emara HandleCharResult SelectNext(int key) { 269929cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) { 270029cc50e1SOmar Emara if (m_selection_index < m_delegate_sp->GetNumberOfActions() - 1) { 270129cc50e1SOmar Emara m_selection_index++; 270229cc50e1SOmar Emara return eKeyHandled; 270329cc50e1SOmar Emara } 270429cc50e1SOmar Emara 270529cc50e1SOmar Emara m_selection_index = 0; 270629cc50e1SOmar Emara m_selection_type = SelectionType::Field; 27070321dbc8SOmar Emara SkipNextHiddenFields(); 27080321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27090321dbc8SOmar Emara FieldDelegate *next_field = m_delegate_sp->GetField(m_selection_index); 271029cc50e1SOmar Emara next_field->FieldDelegateSelectFirstElement(); 27110321dbc8SOmar Emara } 271229cc50e1SOmar Emara return eKeyHandled; 271329cc50e1SOmar Emara } 271429cc50e1SOmar Emara 27150321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 271629cc50e1SOmar Emara if (!field->FieldDelegateOnLastOrOnlyElement()) { 271729cc50e1SOmar Emara return field->FieldDelegateHandleChar(key); 271829cc50e1SOmar Emara } 271929cc50e1SOmar Emara 272029cc50e1SOmar Emara field->FieldDelegateExitCallback(); 272129cc50e1SOmar Emara 272229cc50e1SOmar Emara if (m_selection_index == m_delegate_sp->GetNumberOfFields() - 1) { 272329cc50e1SOmar Emara m_selection_type = SelectionType::Action; 272429cc50e1SOmar Emara m_selection_index = 0; 272529cc50e1SOmar Emara return eKeyHandled; 272629cc50e1SOmar Emara } 272729cc50e1SOmar Emara 272829cc50e1SOmar Emara m_selection_index++; 27290321dbc8SOmar Emara SkipNextHiddenFields(); 273029cc50e1SOmar Emara 27310321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27320321dbc8SOmar Emara FieldDelegate *next_field = m_delegate_sp->GetField(m_selection_index); 273329cc50e1SOmar Emara next_field->FieldDelegateSelectFirstElement(); 27340321dbc8SOmar Emara } 273529cc50e1SOmar Emara 273629cc50e1SOmar Emara return eKeyHandled; 273729cc50e1SOmar Emara } 273829cc50e1SOmar Emara 27390321dbc8SOmar Emara void SkipPreviousHiddenFields() { 27400321dbc8SOmar Emara while (true) { 27410321dbc8SOmar Emara if (m_delegate_sp->GetField(m_selection_index)->FieldDelegateIsVisible()) 27420321dbc8SOmar Emara return; 27430321dbc8SOmar Emara 27440321dbc8SOmar Emara if (m_selection_index == 0) { 27450321dbc8SOmar Emara m_selection_type = SelectionType::Action; 27460321dbc8SOmar Emara m_selection_index = 0; 27470321dbc8SOmar Emara return; 27480321dbc8SOmar Emara } 27490321dbc8SOmar Emara 27500321dbc8SOmar Emara m_selection_index--; 27510321dbc8SOmar Emara } 27520321dbc8SOmar Emara } 27530321dbc8SOmar Emara 27540321dbc8SOmar Emara HandleCharResult SelectPrevious(int key) { 275529cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) { 275629cc50e1SOmar Emara if (m_selection_index > 0) { 275729cc50e1SOmar Emara m_selection_index--; 275829cc50e1SOmar Emara return eKeyHandled; 275929cc50e1SOmar Emara } 276029cc50e1SOmar Emara m_selection_index = m_delegate_sp->GetNumberOfFields() - 1; 276129cc50e1SOmar Emara m_selection_type = SelectionType::Field; 27620321dbc8SOmar Emara SkipPreviousHiddenFields(); 27630321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27640321dbc8SOmar Emara FieldDelegate *previous_field = 276529cc50e1SOmar Emara m_delegate_sp->GetField(m_selection_index); 276629cc50e1SOmar Emara previous_field->FieldDelegateSelectLastElement(); 27670321dbc8SOmar Emara } 276829cc50e1SOmar Emara return eKeyHandled; 276929cc50e1SOmar Emara } 277029cc50e1SOmar Emara 27710321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 277229cc50e1SOmar Emara if (!field->FieldDelegateOnFirstOrOnlyElement()) { 277329cc50e1SOmar Emara return field->FieldDelegateHandleChar(key); 277429cc50e1SOmar Emara } 277529cc50e1SOmar Emara 277629cc50e1SOmar Emara field->FieldDelegateExitCallback(); 277729cc50e1SOmar Emara 277829cc50e1SOmar Emara if (m_selection_index == 0) { 277929cc50e1SOmar Emara m_selection_type = SelectionType::Action; 278029cc50e1SOmar Emara m_selection_index = m_delegate_sp->GetNumberOfActions() - 1; 278129cc50e1SOmar Emara return eKeyHandled; 278229cc50e1SOmar Emara } 278329cc50e1SOmar Emara 278429cc50e1SOmar Emara m_selection_index--; 27850321dbc8SOmar Emara SkipPreviousHiddenFields(); 278629cc50e1SOmar Emara 27870321dbc8SOmar Emara if (m_selection_type == SelectionType::Field) { 27880321dbc8SOmar Emara FieldDelegate *previous_field = 278929cc50e1SOmar Emara m_delegate_sp->GetField(m_selection_index); 279029cc50e1SOmar Emara previous_field->FieldDelegateSelectLastElement(); 27910321dbc8SOmar Emara } 279229cc50e1SOmar Emara 279329cc50e1SOmar Emara return eKeyHandled; 279429cc50e1SOmar Emara } 279529cc50e1SOmar Emara 2796945cde8bSOmar Emara void ExecuteAction(Window &window, int index) { 2797945cde8bSOmar Emara FormAction &action = m_delegate_sp->GetAction(index); 279829cc50e1SOmar Emara action.Execute(window); 27990321dbc8SOmar Emara if (m_delegate_sp->HasError()) { 280029cc50e1SOmar Emara m_first_visible_line = 0; 280129cc50e1SOmar Emara m_selection_index = 0; 280229cc50e1SOmar Emara m_selection_type = SelectionType::Field; 280329cc50e1SOmar Emara } 28040321dbc8SOmar Emara } 280529cc50e1SOmar Emara 2806292f0133SOmar Emara // Always return eKeyHandled to absorb all events since forms are always 2807292f0133SOmar Emara // added as pop-ups that should take full control until canceled or submitted. 280829cc50e1SOmar Emara HandleCharResult WindowDelegateHandleChar(Window &window, int key) override { 280929cc50e1SOmar Emara switch (key) { 281029cc50e1SOmar Emara case '\r': 281129cc50e1SOmar Emara case '\n': 281229cc50e1SOmar Emara case KEY_ENTER: 281329cc50e1SOmar Emara if (m_selection_type == SelectionType::Action) { 2814945cde8bSOmar Emara ExecuteAction(window, m_selection_index); 281529cc50e1SOmar Emara return eKeyHandled; 281629cc50e1SOmar Emara } 281729cc50e1SOmar Emara break; 2818945cde8bSOmar Emara case KEY_ALT_ENTER: 2819945cde8bSOmar Emara ExecuteAction(window, 0); 2820945cde8bSOmar Emara return eKeyHandled; 282129cc50e1SOmar Emara case '\t': 2822292f0133SOmar Emara SelectNext(key); 2823292f0133SOmar Emara return eKeyHandled; 282429cc50e1SOmar Emara case KEY_SHIFT_TAB: 2825292f0133SOmar Emara SelectPrevious(key); 2826292f0133SOmar Emara return eKeyHandled; 282729cc50e1SOmar Emara case KEY_ESCAPE: 282829cc50e1SOmar Emara window.GetParent()->RemoveSubWindow(&window); 282929cc50e1SOmar Emara return eKeyHandled; 283029cc50e1SOmar Emara default: 283129cc50e1SOmar Emara break; 283229cc50e1SOmar Emara } 283329cc50e1SOmar Emara 283429cc50e1SOmar Emara // If the key wasn't handled and one of the fields is selected, pass the key 283529cc50e1SOmar Emara // to that field. 283629cc50e1SOmar Emara if (m_selection_type == SelectionType::Field) { 28370321dbc8SOmar Emara FieldDelegate *field = m_delegate_sp->GetField(m_selection_index); 2838292f0133SOmar Emara if (field->FieldDelegateHandleChar(key) == eKeyHandled) 2839292f0133SOmar Emara return eKeyHandled; 284029cc50e1SOmar Emara } 284129cc50e1SOmar Emara 2842292f0133SOmar Emara // If the key wasn't handled by the possibly selected field, handle some 2843292f0133SOmar Emara // extra keys for navigation. 2844292f0133SOmar Emara switch (key) { 2845292f0133SOmar Emara case KEY_DOWN: 2846292f0133SOmar Emara SelectNext(key); 2847292f0133SOmar Emara return eKeyHandled; 2848292f0133SOmar Emara case KEY_UP: 2849292f0133SOmar Emara SelectPrevious(key); 2850292f0133SOmar Emara return eKeyHandled; 2851292f0133SOmar Emara default: 2852292f0133SOmar Emara break; 2853292f0133SOmar Emara } 2854292f0133SOmar Emara 2855292f0133SOmar Emara return eKeyHandled; 285629cc50e1SOmar Emara } 285729cc50e1SOmar Emara 285829cc50e1SOmar Emara protected: 285929cc50e1SOmar Emara FormDelegateSP m_delegate_sp; 286029cc50e1SOmar Emara // The index of the currently selected SelectionType. 286129cc50e1SOmar Emara int m_selection_index; 286229cc50e1SOmar Emara // See SelectionType class enum. 286329cc50e1SOmar Emara SelectionType m_selection_type; 286429cc50e1SOmar Emara // The first visible line from the pad. 286529cc50e1SOmar Emara int m_first_visible_line; 286629cc50e1SOmar Emara }; 286729cc50e1SOmar Emara 28680321dbc8SOmar Emara /////////////////////////// 28690321dbc8SOmar Emara // Form Delegate Instances 28700321dbc8SOmar Emara /////////////////////////// 28710321dbc8SOmar Emara 28720321dbc8SOmar Emara class DetachOrKillProcessFormDelegate : public FormDelegate { 28730321dbc8SOmar Emara public: 28740321dbc8SOmar Emara DetachOrKillProcessFormDelegate(Process *process) : m_process(process) { 28750321dbc8SOmar Emara SetError("There is a running process, either detach or kill it."); 28760321dbc8SOmar Emara 28770321dbc8SOmar Emara m_keep_stopped_field = 28780321dbc8SOmar Emara AddBooleanField("Keep process stopped when detaching.", false); 28790321dbc8SOmar Emara 28800321dbc8SOmar Emara AddAction("Detach", [this](Window &window) { Detach(window); }); 28810321dbc8SOmar Emara AddAction("Kill", [this](Window &window) { Kill(window); }); 28820321dbc8SOmar Emara } 28830321dbc8SOmar Emara 28840321dbc8SOmar Emara std::string GetName() override { return "Detach/Kill Process"; } 28850321dbc8SOmar Emara 28860321dbc8SOmar Emara void Kill(Window &window) { 28870321dbc8SOmar Emara Status destroy_status(m_process->Destroy(false)); 28880321dbc8SOmar Emara if (destroy_status.Fail()) { 28890321dbc8SOmar Emara SetError("Failed to kill process."); 28900321dbc8SOmar Emara return; 28910321dbc8SOmar Emara } 28920321dbc8SOmar Emara window.GetParent()->RemoveSubWindow(&window); 28930321dbc8SOmar Emara } 28940321dbc8SOmar Emara 28950321dbc8SOmar Emara void Detach(Window &window) { 28960321dbc8SOmar Emara Status detach_status(m_process->Detach(m_keep_stopped_field->GetBoolean())); 28970321dbc8SOmar Emara if (detach_status.Fail()) { 28980321dbc8SOmar Emara SetError("Failed to detach from process."); 28990321dbc8SOmar Emara return; 29000321dbc8SOmar Emara } 29010321dbc8SOmar Emara window.GetParent()->RemoveSubWindow(&window); 29020321dbc8SOmar Emara } 29030321dbc8SOmar Emara 29040321dbc8SOmar Emara protected: 29050321dbc8SOmar Emara Process *m_process; 29060321dbc8SOmar Emara BooleanFieldDelegate *m_keep_stopped_field; 29070321dbc8SOmar Emara }; 29080321dbc8SOmar Emara 29090321dbc8SOmar Emara class ProcessAttachFormDelegate : public FormDelegate { 29100321dbc8SOmar Emara public: 29110321dbc8SOmar Emara ProcessAttachFormDelegate(Debugger &debugger, WindowSP main_window_sp) 29120321dbc8SOmar Emara : m_debugger(debugger), m_main_window_sp(main_window_sp) { 29130321dbc8SOmar Emara std::vector<std::string> types; 29140321dbc8SOmar Emara types.push_back(std::string("Name")); 29150321dbc8SOmar Emara types.push_back(std::string("PID")); 29160321dbc8SOmar Emara m_type_field = AddChoicesField("Attach By", 2, types); 29179ef7de7cSOmar Emara m_pid_field = AddIntegerField("PID", 0, true); 29180321dbc8SOmar Emara m_name_field = 29199ef7de7cSOmar Emara AddTextField("Process Name", GetDefaultProcessName().c_str(), true); 29200321dbc8SOmar Emara m_continue_field = AddBooleanField("Continue once attached.", false); 29210321dbc8SOmar Emara m_wait_for_field = AddBooleanField("Wait for process to launch.", false); 29220321dbc8SOmar Emara m_include_existing_field = 29230321dbc8SOmar Emara AddBooleanField("Include existing processes.", false); 29240321dbc8SOmar Emara m_show_advanced_field = AddBooleanField("Show advanced settings.", false); 2925c93dc259SOmar Emara m_plugin_field = AddProcessPluginField(); 29260321dbc8SOmar Emara 29270321dbc8SOmar Emara AddAction("Attach", [this](Window &window) { Attach(window); }); 29280321dbc8SOmar Emara } 29290321dbc8SOmar Emara 29300321dbc8SOmar Emara std::string GetName() override { return "Attach Process"; } 29310321dbc8SOmar Emara 29320321dbc8SOmar Emara void UpdateFieldsVisibility() override { 29330321dbc8SOmar Emara if (m_type_field->GetChoiceContent() == "Name") { 29340321dbc8SOmar Emara m_pid_field->FieldDelegateHide(); 29350321dbc8SOmar Emara m_name_field->FieldDelegateShow(); 29360321dbc8SOmar Emara m_wait_for_field->FieldDelegateShow(); 29370321dbc8SOmar Emara if (m_wait_for_field->GetBoolean()) 29380321dbc8SOmar Emara m_include_existing_field->FieldDelegateShow(); 29390321dbc8SOmar Emara else 29400321dbc8SOmar Emara m_include_existing_field->FieldDelegateHide(); 29410321dbc8SOmar Emara } else { 29420321dbc8SOmar Emara m_pid_field->FieldDelegateShow(); 29430321dbc8SOmar Emara m_name_field->FieldDelegateHide(); 29440321dbc8SOmar Emara m_wait_for_field->FieldDelegateHide(); 29450321dbc8SOmar Emara m_include_existing_field->FieldDelegateHide(); 29460321dbc8SOmar Emara } 29470321dbc8SOmar Emara if (m_show_advanced_field->GetBoolean()) 29480321dbc8SOmar Emara m_plugin_field->FieldDelegateShow(); 29490321dbc8SOmar Emara else 29500321dbc8SOmar Emara m_plugin_field->FieldDelegateHide(); 29510321dbc8SOmar Emara } 29520321dbc8SOmar Emara 29530321dbc8SOmar Emara // Get the basename of the target's main executable if available, empty string 29540321dbc8SOmar Emara // otherwise. 29550321dbc8SOmar Emara std::string GetDefaultProcessName() { 29560321dbc8SOmar Emara Target *target = m_debugger.GetSelectedTarget().get(); 29570321dbc8SOmar Emara if (target == nullptr) 29580321dbc8SOmar Emara return ""; 29590321dbc8SOmar Emara 29600321dbc8SOmar Emara ModuleSP module_sp = target->GetExecutableModule(); 29610321dbc8SOmar Emara if (!module_sp->IsExecutable()) 29620321dbc8SOmar Emara return ""; 29630321dbc8SOmar Emara 29640321dbc8SOmar Emara return module_sp->GetFileSpec().GetFilename().AsCString(); 29650321dbc8SOmar Emara } 29660321dbc8SOmar Emara 29670321dbc8SOmar Emara bool StopRunningProcess() { 29680321dbc8SOmar Emara ExecutionContext exe_ctx = 29690321dbc8SOmar Emara m_debugger.GetCommandInterpreter().GetExecutionContext(); 29700321dbc8SOmar Emara 29710321dbc8SOmar Emara if (!exe_ctx.HasProcessScope()) 29720321dbc8SOmar Emara return false; 29730321dbc8SOmar Emara 29740321dbc8SOmar Emara Process *process = exe_ctx.GetProcessPtr(); 29750321dbc8SOmar Emara if (!(process && process->IsAlive())) 29760321dbc8SOmar Emara return false; 29770321dbc8SOmar Emara 29780321dbc8SOmar Emara FormDelegateSP form_delegate_sp = 29790321dbc8SOmar Emara FormDelegateSP(new DetachOrKillProcessFormDelegate(process)); 29800321dbc8SOmar Emara Rect bounds = m_main_window_sp->GetCenteredRect(85, 8); 29810321dbc8SOmar Emara WindowSP form_window_sp = m_main_window_sp->CreateSubWindow( 29820321dbc8SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 29830321dbc8SOmar Emara WindowDelegateSP window_delegate_sp = 29840321dbc8SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 29850321dbc8SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 29860321dbc8SOmar Emara 29870321dbc8SOmar Emara return true; 29880321dbc8SOmar Emara } 29890321dbc8SOmar Emara 29900321dbc8SOmar Emara Target *GetTarget() { 29910321dbc8SOmar Emara Target *target = m_debugger.GetSelectedTarget().get(); 29920321dbc8SOmar Emara 29930321dbc8SOmar Emara if (target != nullptr) 29940321dbc8SOmar Emara return target; 29950321dbc8SOmar Emara 29960321dbc8SOmar Emara TargetSP new_target_sp; 29970321dbc8SOmar Emara m_debugger.GetTargetList().CreateTarget( 29980321dbc8SOmar Emara m_debugger, "", "", eLoadDependentsNo, nullptr, new_target_sp); 29990321dbc8SOmar Emara 30000321dbc8SOmar Emara target = new_target_sp.get(); 30010321dbc8SOmar Emara 30020321dbc8SOmar Emara if (target == nullptr) 30030321dbc8SOmar Emara SetError("Failed to create target."); 30040321dbc8SOmar Emara 30050321dbc8SOmar Emara m_debugger.GetTargetList().SetSelectedTarget(new_target_sp); 30060321dbc8SOmar Emara 30070321dbc8SOmar Emara return target; 30080321dbc8SOmar Emara } 30090321dbc8SOmar Emara 30100321dbc8SOmar Emara ProcessAttachInfo GetAttachInfo() { 30110321dbc8SOmar Emara ProcessAttachInfo attach_info; 30120321dbc8SOmar Emara attach_info.SetContinueOnceAttached(m_continue_field->GetBoolean()); 30130321dbc8SOmar Emara if (m_type_field->GetChoiceContent() == "Name") { 30140321dbc8SOmar Emara attach_info.GetExecutableFile().SetFile(m_name_field->GetText(), 30150321dbc8SOmar Emara FileSpec::Style::native); 30160321dbc8SOmar Emara attach_info.SetWaitForLaunch(m_wait_for_field->GetBoolean()); 30170321dbc8SOmar Emara if (m_wait_for_field->GetBoolean()) 30180321dbc8SOmar Emara attach_info.SetIgnoreExisting(!m_include_existing_field->GetBoolean()); 30190321dbc8SOmar Emara } else { 30200321dbc8SOmar Emara attach_info.SetProcessID(m_pid_field->GetInteger()); 30210321dbc8SOmar Emara } 3022c93dc259SOmar Emara attach_info.SetProcessPluginName(m_plugin_field->GetPluginName()); 30230321dbc8SOmar Emara 30240321dbc8SOmar Emara return attach_info; 30250321dbc8SOmar Emara } 30260321dbc8SOmar Emara 30270321dbc8SOmar Emara void Attach(Window &window) { 30280321dbc8SOmar Emara ClearError(); 30290321dbc8SOmar Emara 303080ac12b7SOmar Emara bool all_fields_are_valid = CheckFieldsValidity(); 303180ac12b7SOmar Emara if (!all_fields_are_valid) 303280ac12b7SOmar Emara return; 303380ac12b7SOmar Emara 30340321dbc8SOmar Emara bool process_is_running = StopRunningProcess(); 30350321dbc8SOmar Emara if (process_is_running) 30360321dbc8SOmar Emara return; 30370321dbc8SOmar Emara 30380321dbc8SOmar Emara Target *target = GetTarget(); 30390321dbc8SOmar Emara if (HasError()) 30400321dbc8SOmar Emara return; 30410321dbc8SOmar Emara 30420321dbc8SOmar Emara StreamString stream; 30430321dbc8SOmar Emara ProcessAttachInfo attach_info = GetAttachInfo(); 30440321dbc8SOmar Emara Status status = target->Attach(attach_info, &stream); 30450321dbc8SOmar Emara 30460321dbc8SOmar Emara if (status.Fail()) { 30470321dbc8SOmar Emara SetError(status.AsCString()); 30480321dbc8SOmar Emara return; 30490321dbc8SOmar Emara } 30500321dbc8SOmar Emara 30510321dbc8SOmar Emara ProcessSP process_sp(target->GetProcessSP()); 30520321dbc8SOmar Emara if (!process_sp) { 30530321dbc8SOmar Emara SetError("Attached sucessfully but target has no process."); 30540321dbc8SOmar Emara return; 30550321dbc8SOmar Emara } 30560321dbc8SOmar Emara 30570321dbc8SOmar Emara if (attach_info.GetContinueOnceAttached()) 30580321dbc8SOmar Emara process_sp->Resume(); 30590321dbc8SOmar Emara 30600321dbc8SOmar Emara window.GetParent()->RemoveSubWindow(&window); 30610321dbc8SOmar Emara } 30620321dbc8SOmar Emara 30630321dbc8SOmar Emara protected: 30640321dbc8SOmar Emara Debugger &m_debugger; 30650321dbc8SOmar Emara WindowSP m_main_window_sp; 30660321dbc8SOmar Emara 30670321dbc8SOmar Emara ChoicesFieldDelegate *m_type_field; 30680321dbc8SOmar Emara IntegerFieldDelegate *m_pid_field; 30690321dbc8SOmar Emara TextFieldDelegate *m_name_field; 30700321dbc8SOmar Emara BooleanFieldDelegate *m_continue_field; 30710321dbc8SOmar Emara BooleanFieldDelegate *m_wait_for_field; 30720321dbc8SOmar Emara BooleanFieldDelegate *m_include_existing_field; 30730321dbc8SOmar Emara BooleanFieldDelegate *m_show_advanced_field; 3074c93dc259SOmar Emara ProcessPluginFieldDelegate *m_plugin_field; 30750321dbc8SOmar Emara }; 30760321dbc8SOmar Emara 307718c25cd3SOmar Emara class TargetCreateFormDelegate : public FormDelegate { 307818c25cd3SOmar Emara public: 307918c25cd3SOmar Emara TargetCreateFormDelegate(Debugger &debugger) : m_debugger(debugger) { 308018c25cd3SOmar Emara m_executable_field = AddFileField("Executable", "", /*need_to_exist=*/true, 308118c25cd3SOmar Emara /*required=*/true); 308218c25cd3SOmar Emara m_core_file_field = AddFileField("Core File", "", /*need_to_exist=*/true, 308318c25cd3SOmar Emara /*required=*/false); 308418c25cd3SOmar Emara m_symbol_file_field = AddFileField( 308518c25cd3SOmar Emara "Symbol File", "", /*need_to_exist=*/true, /*required=*/false); 308618c25cd3SOmar Emara m_show_advanced_field = AddBooleanField("Show advanced settings.", false); 308718c25cd3SOmar Emara m_remote_file_field = AddFileField( 308818c25cd3SOmar Emara "Remote File", "", /*need_to_exist=*/false, /*required=*/false); 308918c25cd3SOmar Emara m_arch_field = AddArchField("Architecture", "", /*required=*/false); 309018c25cd3SOmar Emara m_platform_field = AddPlatformPluginField(debugger); 309118c25cd3SOmar Emara m_load_dependent_files_field = 309218c25cd3SOmar Emara AddChoicesField("Load Dependents", 3, GetLoadDependentFilesChoices()); 309318c25cd3SOmar Emara 309418c25cd3SOmar Emara AddAction("Create", [this](Window &window) { CreateTarget(window); }); 309518c25cd3SOmar Emara } 309618c25cd3SOmar Emara 309718c25cd3SOmar Emara std::string GetName() override { return "Create Target"; } 309818c25cd3SOmar Emara 309918c25cd3SOmar Emara void UpdateFieldsVisibility() override { 310018c25cd3SOmar Emara if (m_show_advanced_field->GetBoolean()) { 310118c25cd3SOmar Emara m_remote_file_field->FieldDelegateShow(); 310218c25cd3SOmar Emara m_arch_field->FieldDelegateShow(); 310318c25cd3SOmar Emara m_platform_field->FieldDelegateShow(); 310418c25cd3SOmar Emara m_load_dependent_files_field->FieldDelegateShow(); 310518c25cd3SOmar Emara } else { 310618c25cd3SOmar Emara m_remote_file_field->FieldDelegateHide(); 310718c25cd3SOmar Emara m_arch_field->FieldDelegateHide(); 310818c25cd3SOmar Emara m_platform_field->FieldDelegateHide(); 310918c25cd3SOmar Emara m_load_dependent_files_field->FieldDelegateHide(); 311018c25cd3SOmar Emara } 311118c25cd3SOmar Emara } 311218c25cd3SOmar Emara 311318c25cd3SOmar Emara static constexpr const char *kLoadDependentFilesNo = "No"; 311418c25cd3SOmar Emara static constexpr const char *kLoadDependentFilesYes = "Yes"; 311518c25cd3SOmar Emara static constexpr const char *kLoadDependentFilesExecOnly = "Executable only"; 311618c25cd3SOmar Emara 311718c25cd3SOmar Emara std::vector<std::string> GetLoadDependentFilesChoices() { 311818c25cd3SOmar Emara std::vector<std::string> load_depentents_options; 311918c25cd3SOmar Emara load_depentents_options.push_back(kLoadDependentFilesExecOnly); 312018c25cd3SOmar Emara load_depentents_options.push_back(kLoadDependentFilesYes); 312118c25cd3SOmar Emara load_depentents_options.push_back(kLoadDependentFilesNo); 312218c25cd3SOmar Emara return load_depentents_options; 312318c25cd3SOmar Emara } 312418c25cd3SOmar Emara 312518c25cd3SOmar Emara LoadDependentFiles GetLoadDependentFiles() { 312618c25cd3SOmar Emara std::string choice = m_load_dependent_files_field->GetChoiceContent(); 312718c25cd3SOmar Emara if (choice == kLoadDependentFilesNo) 312818c25cd3SOmar Emara return eLoadDependentsNo; 312918c25cd3SOmar Emara if (choice == kLoadDependentFilesYes) 313018c25cd3SOmar Emara return eLoadDependentsYes; 313118c25cd3SOmar Emara return eLoadDependentsDefault; 313218c25cd3SOmar Emara } 313318c25cd3SOmar Emara 313418c25cd3SOmar Emara OptionGroupPlatform GetPlatformOptions() { 313518c25cd3SOmar Emara OptionGroupPlatform platform_options(false); 313618c25cd3SOmar Emara platform_options.SetPlatformName(m_platform_field->GetPluginName().c_str()); 313718c25cd3SOmar Emara return platform_options; 313818c25cd3SOmar Emara } 313918c25cd3SOmar Emara 314018c25cd3SOmar Emara TargetSP GetTarget() { 314118c25cd3SOmar Emara OptionGroupPlatform platform_options = GetPlatformOptions(); 314218c25cd3SOmar Emara TargetSP target_sp; 314318c25cd3SOmar Emara Status status = m_debugger.GetTargetList().CreateTarget( 314418c25cd3SOmar Emara m_debugger, m_executable_field->GetPath(), 314518c25cd3SOmar Emara m_arch_field->GetArchString(), GetLoadDependentFiles(), 314618c25cd3SOmar Emara &platform_options, target_sp); 314718c25cd3SOmar Emara 314818c25cd3SOmar Emara if (status.Fail()) { 314918c25cd3SOmar Emara SetError(status.AsCString()); 315018c25cd3SOmar Emara return nullptr; 315118c25cd3SOmar Emara } 315218c25cd3SOmar Emara 315318c25cd3SOmar Emara m_debugger.GetTargetList().SetSelectedTarget(target_sp); 315418c25cd3SOmar Emara 315518c25cd3SOmar Emara return target_sp; 315618c25cd3SOmar Emara } 315718c25cd3SOmar Emara 315818c25cd3SOmar Emara void SetSymbolFile(TargetSP target_sp) { 315918c25cd3SOmar Emara if (!m_symbol_file_field->IsSpecified()) 316018c25cd3SOmar Emara return; 316118c25cd3SOmar Emara 316218c25cd3SOmar Emara ModuleSP module_sp(target_sp->GetExecutableModule()); 316318c25cd3SOmar Emara if (!module_sp) 316418c25cd3SOmar Emara return; 316518c25cd3SOmar Emara 316618c25cd3SOmar Emara module_sp->SetSymbolFileFileSpec( 316718c25cd3SOmar Emara m_symbol_file_field->GetResolvedFileSpec()); 316818c25cd3SOmar Emara } 316918c25cd3SOmar Emara 317018c25cd3SOmar Emara void SetCoreFile(TargetSP target_sp) { 317118c25cd3SOmar Emara if (!m_core_file_field->IsSpecified()) 317218c25cd3SOmar Emara return; 317318c25cd3SOmar Emara 317418c25cd3SOmar Emara FileSpec core_file_spec = m_core_file_field->GetResolvedFileSpec(); 317518c25cd3SOmar Emara 317618c25cd3SOmar Emara FileSpec core_file_directory_spec; 317718c25cd3SOmar Emara core_file_directory_spec.GetDirectory() = core_file_spec.GetDirectory(); 317818c25cd3SOmar Emara target_sp->AppendExecutableSearchPaths(core_file_directory_spec); 317918c25cd3SOmar Emara 318018c25cd3SOmar Emara ProcessSP process_sp(target_sp->CreateProcess( 318118c25cd3SOmar Emara m_debugger.GetListener(), llvm::StringRef(), &core_file_spec, false)); 318218c25cd3SOmar Emara 318318c25cd3SOmar Emara if (!process_sp) { 318418c25cd3SOmar Emara SetError("Unable to find process plug-in for core file!"); 318518c25cd3SOmar Emara return; 318618c25cd3SOmar Emara } 318718c25cd3SOmar Emara 318818c25cd3SOmar Emara Status status = process_sp->LoadCore(); 318918c25cd3SOmar Emara if (status.Fail()) { 319018c25cd3SOmar Emara SetError("Can't find plug-in for core file!"); 319118c25cd3SOmar Emara return; 319218c25cd3SOmar Emara } 319318c25cd3SOmar Emara } 319418c25cd3SOmar Emara 319518c25cd3SOmar Emara void SetRemoteFile(TargetSP target_sp) { 319618c25cd3SOmar Emara if (!m_remote_file_field->IsSpecified()) 319718c25cd3SOmar Emara return; 319818c25cd3SOmar Emara 319918c25cd3SOmar Emara ModuleSP module_sp(target_sp->GetExecutableModule()); 320018c25cd3SOmar Emara if (!module_sp) 320118c25cd3SOmar Emara return; 320218c25cd3SOmar Emara 320318c25cd3SOmar Emara FileSpec remote_file_spec = m_remote_file_field->GetFileSpec(); 320418c25cd3SOmar Emara module_sp->SetPlatformFileSpec(remote_file_spec); 320518c25cd3SOmar Emara } 320618c25cd3SOmar Emara 320718c25cd3SOmar Emara void RemoveTarget(TargetSP target_sp) { 320818c25cd3SOmar Emara m_debugger.GetTargetList().DeleteTarget(target_sp); 320918c25cd3SOmar Emara } 321018c25cd3SOmar Emara 321118c25cd3SOmar Emara void CreateTarget(Window &window) { 321218c25cd3SOmar Emara ClearError(); 321318c25cd3SOmar Emara 321418c25cd3SOmar Emara bool all_fields_are_valid = CheckFieldsValidity(); 321518c25cd3SOmar Emara if (!all_fields_are_valid) 321618c25cd3SOmar Emara return; 321718c25cd3SOmar Emara 321818c25cd3SOmar Emara TargetSP target_sp = GetTarget(); 321918c25cd3SOmar Emara if (HasError()) 322018c25cd3SOmar Emara return; 322118c25cd3SOmar Emara 322218c25cd3SOmar Emara SetSymbolFile(target_sp); 322318c25cd3SOmar Emara if (HasError()) { 322418c25cd3SOmar Emara RemoveTarget(target_sp); 322518c25cd3SOmar Emara return; 322618c25cd3SOmar Emara } 322718c25cd3SOmar Emara 322818c25cd3SOmar Emara SetCoreFile(target_sp); 322918c25cd3SOmar Emara if (HasError()) { 323018c25cd3SOmar Emara RemoveTarget(target_sp); 323118c25cd3SOmar Emara return; 323218c25cd3SOmar Emara } 323318c25cd3SOmar Emara 323418c25cd3SOmar Emara SetRemoteFile(target_sp); 323518c25cd3SOmar Emara if (HasError()) { 323618c25cd3SOmar Emara RemoveTarget(target_sp); 323718c25cd3SOmar Emara return; 323818c25cd3SOmar Emara } 323918c25cd3SOmar Emara 324018c25cd3SOmar Emara window.GetParent()->RemoveSubWindow(&window); 324118c25cd3SOmar Emara } 324218c25cd3SOmar Emara 324318c25cd3SOmar Emara protected: 324418c25cd3SOmar Emara Debugger &m_debugger; 324518c25cd3SOmar Emara 324618c25cd3SOmar Emara FileFieldDelegate *m_executable_field; 324718c25cd3SOmar Emara FileFieldDelegate *m_core_file_field; 324818c25cd3SOmar Emara FileFieldDelegate *m_symbol_file_field; 324918c25cd3SOmar Emara BooleanFieldDelegate *m_show_advanced_field; 325018c25cd3SOmar Emara FileFieldDelegate *m_remote_file_field; 325118c25cd3SOmar Emara ArchFieldDelegate *m_arch_field; 325218c25cd3SOmar Emara PlatformPluginFieldDelegate *m_platform_field; 325318c25cd3SOmar Emara ChoicesFieldDelegate *m_load_dependent_files_field; 325418c25cd3SOmar Emara }; 325518c25cd3SOmar Emara 325682507f17SOmar Emara class ProcessLaunchFormDelegate : public FormDelegate { 325782507f17SOmar Emara public: 325882507f17SOmar Emara ProcessLaunchFormDelegate(Debugger &debugger, WindowSP main_window_sp) 325982507f17SOmar Emara : m_debugger(debugger), m_main_window_sp(main_window_sp) { 326082507f17SOmar Emara 326182507f17SOmar Emara m_arguments_field = AddArgumentsField(); 326282507f17SOmar Emara SetArgumentsFieldDefaultValue(); 326382507f17SOmar Emara m_target_environment_field = 326482507f17SOmar Emara AddEnvironmentVariableListField("Target Environment Variables"); 326582507f17SOmar Emara SetTargetEnvironmentFieldDefaultValue(); 326682507f17SOmar Emara m_working_directory_field = AddDirectoryField( 326782507f17SOmar Emara "Working Directory", GetDefaultWorkingDirectory().c_str(), true, false); 326882507f17SOmar Emara 326982507f17SOmar Emara m_show_advanced_field = AddBooleanField("Show advanced settings.", false); 327082507f17SOmar Emara 327182507f17SOmar Emara m_stop_at_entry_field = AddBooleanField("Stop at entry point.", false); 327282507f17SOmar Emara m_detach_on_error_field = 327382507f17SOmar Emara AddBooleanField("Detach on error.", GetDefaultDetachOnError()); 327482507f17SOmar Emara m_disable_aslr_field = 327582507f17SOmar Emara AddBooleanField("Disable ASLR", GetDefaultDisableASLR()); 327682507f17SOmar Emara m_plugin_field = AddProcessPluginField(); 327782507f17SOmar Emara m_arch_field = AddArchField("Architecture", "", false); 327882507f17SOmar Emara m_shell_field = AddFileField("Shell", "", true, false); 327982507f17SOmar Emara m_expand_shell_arguments_field = 328082507f17SOmar Emara AddBooleanField("Expand shell arguments.", false); 328182507f17SOmar Emara 328282507f17SOmar Emara m_disable_standard_io_field = 328382507f17SOmar Emara AddBooleanField("Disable Standard IO", GetDefaultDisableStandardIO()); 328482507f17SOmar Emara m_standard_output_field = 328582507f17SOmar Emara AddFileField("Standard Output File", "", /*need_to_exist=*/false, 328682507f17SOmar Emara /*required=*/false); 328782507f17SOmar Emara m_standard_error_field = 328882507f17SOmar Emara AddFileField("Standard Error File", "", /*need_to_exist=*/false, 328982507f17SOmar Emara /*required=*/false); 329082507f17SOmar Emara m_standard_input_field = 329182507f17SOmar Emara AddFileField("Standard Input File", "", /*need_to_exist=*/false, 329282507f17SOmar Emara /*required=*/false); 329382507f17SOmar Emara 329482507f17SOmar Emara m_show_inherited_environment_field = 329582507f17SOmar Emara AddBooleanField("Show inherited environment variables.", false); 329682507f17SOmar Emara m_inherited_environment_field = 329782507f17SOmar Emara AddEnvironmentVariableListField("Inherited Environment Variables"); 329882507f17SOmar Emara SetInheritedEnvironmentFieldDefaultValue(); 329982507f17SOmar Emara 330082507f17SOmar Emara AddAction("Launch", [this](Window &window) { Launch(window); }); 330182507f17SOmar Emara } 330282507f17SOmar Emara 330382507f17SOmar Emara std::string GetName() override { return "Launch Process"; } 330482507f17SOmar Emara 330582507f17SOmar Emara void UpdateFieldsVisibility() override { 330682507f17SOmar Emara if (m_show_advanced_field->GetBoolean()) { 330782507f17SOmar Emara m_stop_at_entry_field->FieldDelegateShow(); 330882507f17SOmar Emara m_detach_on_error_field->FieldDelegateShow(); 330982507f17SOmar Emara m_disable_aslr_field->FieldDelegateShow(); 331082507f17SOmar Emara m_plugin_field->FieldDelegateShow(); 331182507f17SOmar Emara m_arch_field->FieldDelegateShow(); 331282507f17SOmar Emara m_shell_field->FieldDelegateShow(); 331382507f17SOmar Emara m_expand_shell_arguments_field->FieldDelegateShow(); 331482507f17SOmar Emara m_disable_standard_io_field->FieldDelegateShow(); 331582507f17SOmar Emara if (m_disable_standard_io_field->GetBoolean()) { 331682507f17SOmar Emara m_standard_input_field->FieldDelegateHide(); 331782507f17SOmar Emara m_standard_output_field->FieldDelegateHide(); 331882507f17SOmar Emara m_standard_error_field->FieldDelegateHide(); 331982507f17SOmar Emara } else { 332082507f17SOmar Emara m_standard_input_field->FieldDelegateShow(); 332182507f17SOmar Emara m_standard_output_field->FieldDelegateShow(); 332282507f17SOmar Emara m_standard_error_field->FieldDelegateShow(); 332382507f17SOmar Emara } 332482507f17SOmar Emara m_show_inherited_environment_field->FieldDelegateShow(); 332582507f17SOmar Emara if (m_show_inherited_environment_field->GetBoolean()) 332682507f17SOmar Emara m_inherited_environment_field->FieldDelegateShow(); 332782507f17SOmar Emara else 332882507f17SOmar Emara m_inherited_environment_field->FieldDelegateHide(); 332982507f17SOmar Emara } else { 333082507f17SOmar Emara m_stop_at_entry_field->FieldDelegateHide(); 333182507f17SOmar Emara m_detach_on_error_field->FieldDelegateHide(); 333282507f17SOmar Emara m_disable_aslr_field->FieldDelegateHide(); 333382507f17SOmar Emara m_plugin_field->FieldDelegateHide(); 333482507f17SOmar Emara m_arch_field->FieldDelegateHide(); 333582507f17SOmar Emara m_shell_field->FieldDelegateHide(); 333682507f17SOmar Emara m_expand_shell_arguments_field->FieldDelegateHide(); 333782507f17SOmar Emara m_disable_standard_io_field->FieldDelegateHide(); 333882507f17SOmar Emara m_standard_input_field->FieldDelegateHide(); 333982507f17SOmar Emara m_standard_output_field->FieldDelegateHide(); 334082507f17SOmar Emara m_standard_error_field->FieldDelegateHide(); 334182507f17SOmar Emara m_show_inherited_environment_field->FieldDelegateHide(); 334282507f17SOmar Emara m_inherited_environment_field->FieldDelegateHide(); 334382507f17SOmar Emara } 334482507f17SOmar Emara } 334582507f17SOmar Emara 334682507f17SOmar Emara // Methods for setting the default value of the fields. 334782507f17SOmar Emara 334882507f17SOmar Emara void SetArgumentsFieldDefaultValue() { 334982507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 335082507f17SOmar Emara if (target == nullptr) 335182507f17SOmar Emara return; 335282507f17SOmar Emara 335382507f17SOmar Emara const Args &target_arguments = 335482507f17SOmar Emara target->GetProcessLaunchInfo().GetArguments(); 335582507f17SOmar Emara m_arguments_field->AddArguments(target_arguments); 335682507f17SOmar Emara } 335782507f17SOmar Emara 335882507f17SOmar Emara void SetTargetEnvironmentFieldDefaultValue() { 335982507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 336082507f17SOmar Emara if (target == nullptr) 336182507f17SOmar Emara return; 336282507f17SOmar Emara 336382507f17SOmar Emara const Environment &target_environment = target->GetTargetEnvironment(); 336482507f17SOmar Emara m_target_environment_field->AddEnvironmentVariables(target_environment); 336582507f17SOmar Emara } 336682507f17SOmar Emara 336782507f17SOmar Emara void SetInheritedEnvironmentFieldDefaultValue() { 336882507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 336982507f17SOmar Emara if (target == nullptr) 337082507f17SOmar Emara return; 337182507f17SOmar Emara 337282507f17SOmar Emara const Environment &inherited_environment = 337382507f17SOmar Emara target->GetInheritedEnvironment(); 337482507f17SOmar Emara m_inherited_environment_field->AddEnvironmentVariables( 337582507f17SOmar Emara inherited_environment); 337682507f17SOmar Emara } 337782507f17SOmar Emara 337882507f17SOmar Emara std::string GetDefaultWorkingDirectory() { 337982507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 338082507f17SOmar Emara if (target == nullptr) 338182507f17SOmar Emara return ""; 338282507f17SOmar Emara 338382507f17SOmar Emara PlatformSP platform = target->GetPlatform(); 338482507f17SOmar Emara return platform->GetWorkingDirectory().GetPath(); 338582507f17SOmar Emara } 338682507f17SOmar Emara 338782507f17SOmar Emara bool GetDefaultDisableASLR() { 338882507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 338982507f17SOmar Emara if (target == nullptr) 339082507f17SOmar Emara return false; 339182507f17SOmar Emara 339282507f17SOmar Emara return target->GetDisableASLR(); 339382507f17SOmar Emara } 339482507f17SOmar Emara 339582507f17SOmar Emara bool GetDefaultDisableStandardIO() { 339682507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 339782507f17SOmar Emara if (target == nullptr) 339882507f17SOmar Emara return true; 339982507f17SOmar Emara 340082507f17SOmar Emara return target->GetDisableSTDIO(); 340182507f17SOmar Emara } 340282507f17SOmar Emara 340382507f17SOmar Emara bool GetDefaultDetachOnError() { 340482507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 340582507f17SOmar Emara if (target == nullptr) 340682507f17SOmar Emara return true; 340782507f17SOmar Emara 340882507f17SOmar Emara return target->GetDetachOnError(); 340982507f17SOmar Emara } 341082507f17SOmar Emara 341182507f17SOmar Emara // Methods for getting the necessary information and setting them to the 341282507f17SOmar Emara // ProcessLaunchInfo. 341382507f17SOmar Emara 341482507f17SOmar Emara void GetExecutableSettings(ProcessLaunchInfo &launch_info) { 341582507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 341682507f17SOmar Emara ModuleSP executable_module = target->GetExecutableModule(); 341782507f17SOmar Emara llvm::StringRef target_settings_argv0 = target->GetArg0(); 341882507f17SOmar Emara 341982507f17SOmar Emara if (!target_settings_argv0.empty()) { 342082507f17SOmar Emara launch_info.GetArguments().AppendArgument(target_settings_argv0); 342182507f17SOmar Emara launch_info.SetExecutableFile(executable_module->GetPlatformFileSpec(), 342282507f17SOmar Emara false); 342382507f17SOmar Emara return; 342482507f17SOmar Emara } 342582507f17SOmar Emara 342682507f17SOmar Emara launch_info.SetExecutableFile(executable_module->GetPlatformFileSpec(), 342782507f17SOmar Emara true); 342882507f17SOmar Emara } 342982507f17SOmar Emara 343082507f17SOmar Emara void GetArguments(ProcessLaunchInfo &launch_info) { 343182507f17SOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 343282507f17SOmar Emara Args arguments = m_arguments_field->GetArguments(); 343382507f17SOmar Emara launch_info.GetArguments().AppendArguments(arguments); 343482507f17SOmar Emara } 343582507f17SOmar Emara 343682507f17SOmar Emara void GetEnvironment(ProcessLaunchInfo &launch_info) { 343782507f17SOmar Emara Environment target_environment = 343882507f17SOmar Emara m_target_environment_field->GetEnvironment(); 343982507f17SOmar Emara Environment inherited_environment = 344082507f17SOmar Emara m_inherited_environment_field->GetEnvironment(); 344182507f17SOmar Emara launch_info.GetEnvironment().insert(target_environment.begin(), 344282507f17SOmar Emara target_environment.end()); 344382507f17SOmar Emara launch_info.GetEnvironment().insert(inherited_environment.begin(), 344482507f17SOmar Emara inherited_environment.end()); 344582507f17SOmar Emara } 344682507f17SOmar Emara 344782507f17SOmar Emara void GetWorkingDirectory(ProcessLaunchInfo &launch_info) { 344882507f17SOmar Emara if (m_working_directory_field->IsSpecified()) 344982507f17SOmar Emara launch_info.SetWorkingDirectory( 345082507f17SOmar Emara m_working_directory_field->GetResolvedFileSpec()); 345182507f17SOmar Emara } 345282507f17SOmar Emara 345382507f17SOmar Emara void GetStopAtEntry(ProcessLaunchInfo &launch_info) { 345482507f17SOmar Emara if (m_stop_at_entry_field->GetBoolean()) 345582507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagStopAtEntry); 345682507f17SOmar Emara else 345782507f17SOmar Emara launch_info.GetFlags().Clear(eLaunchFlagStopAtEntry); 345882507f17SOmar Emara } 345982507f17SOmar Emara 346082507f17SOmar Emara void GetDetachOnError(ProcessLaunchInfo &launch_info) { 346182507f17SOmar Emara if (m_detach_on_error_field->GetBoolean()) 346282507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagDetachOnError); 346382507f17SOmar Emara else 346482507f17SOmar Emara launch_info.GetFlags().Clear(eLaunchFlagDetachOnError); 346582507f17SOmar Emara } 346682507f17SOmar Emara 346782507f17SOmar Emara void GetDisableASLR(ProcessLaunchInfo &launch_info) { 346882507f17SOmar Emara if (m_disable_aslr_field->GetBoolean()) 346982507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagDisableASLR); 347082507f17SOmar Emara else 347182507f17SOmar Emara launch_info.GetFlags().Clear(eLaunchFlagDisableASLR); 347282507f17SOmar Emara } 347382507f17SOmar Emara 347482507f17SOmar Emara void GetPlugin(ProcessLaunchInfo &launch_info) { 347582507f17SOmar Emara launch_info.SetProcessPluginName(m_plugin_field->GetPluginName()); 347682507f17SOmar Emara } 347782507f17SOmar Emara 347882507f17SOmar Emara void GetArch(ProcessLaunchInfo &launch_info) { 347982507f17SOmar Emara if (!m_arch_field->IsSpecified()) 348082507f17SOmar Emara return; 348182507f17SOmar Emara 348282507f17SOmar Emara TargetSP target_sp = m_debugger.GetSelectedTarget(); 348382507f17SOmar Emara PlatformSP platform_sp = 348482507f17SOmar Emara target_sp ? target_sp->GetPlatform() : PlatformSP(); 348582507f17SOmar Emara launch_info.GetArchitecture() = Platform::GetAugmentedArchSpec( 348682507f17SOmar Emara platform_sp.get(), m_arch_field->GetArchString()); 348782507f17SOmar Emara } 348882507f17SOmar Emara 348982507f17SOmar Emara void GetShell(ProcessLaunchInfo &launch_info) { 349082507f17SOmar Emara if (!m_shell_field->IsSpecified()) 349182507f17SOmar Emara return; 349282507f17SOmar Emara 349382507f17SOmar Emara launch_info.SetShell(m_shell_field->GetResolvedFileSpec()); 349482507f17SOmar Emara launch_info.SetShellExpandArguments( 349582507f17SOmar Emara m_expand_shell_arguments_field->GetBoolean()); 349682507f17SOmar Emara } 349782507f17SOmar Emara 349882507f17SOmar Emara void GetStandardIO(ProcessLaunchInfo &launch_info) { 349982507f17SOmar Emara if (m_disable_standard_io_field->GetBoolean()) { 350082507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagDisableSTDIO); 350182507f17SOmar Emara return; 350282507f17SOmar Emara } 350382507f17SOmar Emara 350482507f17SOmar Emara FileAction action; 350582507f17SOmar Emara if (m_standard_input_field->IsSpecified()) { 350682507f17SOmar Emara action.Open(STDIN_FILENO, m_standard_input_field->GetFileSpec(), true, 350782507f17SOmar Emara false); 350882507f17SOmar Emara launch_info.AppendFileAction(action); 350982507f17SOmar Emara } 351082507f17SOmar Emara if (m_standard_output_field->IsSpecified()) { 351182507f17SOmar Emara action.Open(STDOUT_FILENO, m_standard_output_field->GetFileSpec(), false, 351282507f17SOmar Emara true); 351382507f17SOmar Emara launch_info.AppendFileAction(action); 351482507f17SOmar Emara } 351582507f17SOmar Emara if (m_standard_error_field->IsSpecified()) { 351682507f17SOmar Emara action.Open(STDERR_FILENO, m_standard_error_field->GetFileSpec(), false, 351782507f17SOmar Emara true); 351882507f17SOmar Emara launch_info.AppendFileAction(action); 351982507f17SOmar Emara } 352082507f17SOmar Emara } 352182507f17SOmar Emara 352282507f17SOmar Emara void GetInheritTCC(ProcessLaunchInfo &launch_info) { 352382507f17SOmar Emara if (m_debugger.GetSelectedTarget()->GetInheritTCC()) 352482507f17SOmar Emara launch_info.GetFlags().Set(eLaunchFlagInheritTCCFromParent); 352582507f17SOmar Emara } 352682507f17SOmar Emara 352782507f17SOmar Emara ProcessLaunchInfo GetLaunchInfo() { 352882507f17SOmar Emara ProcessLaunchInfo launch_info; 352982507f17SOmar Emara 353082507f17SOmar Emara GetExecutableSettings(launch_info); 353182507f17SOmar Emara GetArguments(launch_info); 353282507f17SOmar Emara GetEnvironment(launch_info); 353382507f17SOmar Emara GetWorkingDirectory(launch_info); 353482507f17SOmar Emara GetStopAtEntry(launch_info); 353582507f17SOmar Emara GetDetachOnError(launch_info); 353682507f17SOmar Emara GetDisableASLR(launch_info); 353782507f17SOmar Emara GetPlugin(launch_info); 353882507f17SOmar Emara GetArch(launch_info); 353982507f17SOmar Emara GetShell(launch_info); 354082507f17SOmar Emara GetStandardIO(launch_info); 354182507f17SOmar Emara GetInheritTCC(launch_info); 354282507f17SOmar Emara 354382507f17SOmar Emara return launch_info; 354482507f17SOmar Emara } 354582507f17SOmar Emara 354682507f17SOmar Emara bool StopRunningProcess() { 354782507f17SOmar Emara ExecutionContext exe_ctx = 354882507f17SOmar Emara m_debugger.GetCommandInterpreter().GetExecutionContext(); 354982507f17SOmar Emara 355082507f17SOmar Emara if (!exe_ctx.HasProcessScope()) 355182507f17SOmar Emara return false; 355282507f17SOmar Emara 355382507f17SOmar Emara Process *process = exe_ctx.GetProcessPtr(); 355482507f17SOmar Emara if (!(process && process->IsAlive())) 355582507f17SOmar Emara return false; 355682507f17SOmar Emara 355782507f17SOmar Emara FormDelegateSP form_delegate_sp = 355882507f17SOmar Emara FormDelegateSP(new DetachOrKillProcessFormDelegate(process)); 355982507f17SOmar Emara Rect bounds = m_main_window_sp->GetCenteredRect(85, 8); 356082507f17SOmar Emara WindowSP form_window_sp = m_main_window_sp->CreateSubWindow( 356182507f17SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 356282507f17SOmar Emara WindowDelegateSP window_delegate_sp = 356382507f17SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 356482507f17SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 356582507f17SOmar Emara 356682507f17SOmar Emara return true; 356782507f17SOmar Emara } 356882507f17SOmar Emara 356982507f17SOmar Emara Target *GetTarget() { 357082507f17SOmar Emara Target *target = m_debugger.GetSelectedTarget().get(); 357182507f17SOmar Emara 357282507f17SOmar Emara if (target == nullptr) { 357382507f17SOmar Emara SetError("No target exists!"); 357482507f17SOmar Emara return nullptr; 357582507f17SOmar Emara } 357682507f17SOmar Emara 357782507f17SOmar Emara ModuleSP exe_module_sp = target->GetExecutableModule(); 357882507f17SOmar Emara 357982507f17SOmar Emara if (exe_module_sp == nullptr) { 358082507f17SOmar Emara SetError("No executable in target!"); 358182507f17SOmar Emara return nullptr; 358282507f17SOmar Emara } 358382507f17SOmar Emara 358482507f17SOmar Emara return target; 358582507f17SOmar Emara } 358682507f17SOmar Emara 358782507f17SOmar Emara void Launch(Window &window) { 358882507f17SOmar Emara ClearError(); 358982507f17SOmar Emara 359082507f17SOmar Emara bool all_fields_are_valid = CheckFieldsValidity(); 359182507f17SOmar Emara if (!all_fields_are_valid) 359282507f17SOmar Emara return; 359382507f17SOmar Emara 359482507f17SOmar Emara bool process_is_running = StopRunningProcess(); 359582507f17SOmar Emara if (process_is_running) 359682507f17SOmar Emara return; 359782507f17SOmar Emara 359882507f17SOmar Emara Target *target = GetTarget(); 359982507f17SOmar Emara if (HasError()) 360082507f17SOmar Emara return; 360182507f17SOmar Emara 360282507f17SOmar Emara StreamString stream; 360382507f17SOmar Emara ProcessLaunchInfo launch_info = GetLaunchInfo(); 360482507f17SOmar Emara Status status = target->Launch(launch_info, &stream); 360582507f17SOmar Emara 360682507f17SOmar Emara if (status.Fail()) { 360782507f17SOmar Emara SetError(status.AsCString()); 360882507f17SOmar Emara return; 360982507f17SOmar Emara } 361082507f17SOmar Emara 361182507f17SOmar Emara ProcessSP process_sp(target->GetProcessSP()); 361282507f17SOmar Emara if (!process_sp) { 361382507f17SOmar Emara SetError("Launched successfully but target has no process!"); 361482507f17SOmar Emara return; 361582507f17SOmar Emara } 361682507f17SOmar Emara 361782507f17SOmar Emara window.GetParent()->RemoveSubWindow(&window); 361882507f17SOmar Emara } 361982507f17SOmar Emara 362082507f17SOmar Emara protected: 362182507f17SOmar Emara Debugger &m_debugger; 362282507f17SOmar Emara WindowSP m_main_window_sp; 362382507f17SOmar Emara 362482507f17SOmar Emara ArgumentsFieldDelegate *m_arguments_field; 362582507f17SOmar Emara EnvironmentVariableListFieldDelegate *m_target_environment_field; 362682507f17SOmar Emara DirectoryFieldDelegate *m_working_directory_field; 362782507f17SOmar Emara 362882507f17SOmar Emara BooleanFieldDelegate *m_show_advanced_field; 362982507f17SOmar Emara 363082507f17SOmar Emara BooleanFieldDelegate *m_stop_at_entry_field; 363182507f17SOmar Emara BooleanFieldDelegate *m_detach_on_error_field; 363282507f17SOmar Emara BooleanFieldDelegate *m_disable_aslr_field; 363382507f17SOmar Emara ProcessPluginFieldDelegate *m_plugin_field; 363482507f17SOmar Emara ArchFieldDelegate *m_arch_field; 363582507f17SOmar Emara FileFieldDelegate *m_shell_field; 363682507f17SOmar Emara BooleanFieldDelegate *m_expand_shell_arguments_field; 363782507f17SOmar Emara BooleanFieldDelegate *m_disable_standard_io_field; 363882507f17SOmar Emara FileFieldDelegate *m_standard_input_field; 363982507f17SOmar Emara FileFieldDelegate *m_standard_output_field; 364082507f17SOmar Emara FileFieldDelegate *m_standard_error_field; 364182507f17SOmar Emara 364282507f17SOmar Emara BooleanFieldDelegate *m_show_inherited_environment_field; 364382507f17SOmar Emara EnvironmentVariableListFieldDelegate *m_inherited_environment_field; 364482507f17SOmar Emara }; 364582507f17SOmar Emara 36463c11e572SOmar Emara //////////// 36473c11e572SOmar Emara // Searchers 36483c11e572SOmar Emara //////////// 36493c11e572SOmar Emara 36503c11e572SOmar Emara class SearcherDelegate { 36513c11e572SOmar Emara public: 36523c11e572SOmar Emara SearcherDelegate() {} 36533c11e572SOmar Emara 36543c11e572SOmar Emara virtual ~SearcherDelegate() = default; 36553c11e572SOmar Emara 36563c11e572SOmar Emara virtual int GetNumberOfMatches() = 0; 36573c11e572SOmar Emara 36583c11e572SOmar Emara // Get the string that will be displayed for the match at the input index. 36593c11e572SOmar Emara virtual const std::string &GetMatchTextAtIndex(int index) = 0; 36603c11e572SOmar Emara 36613c11e572SOmar Emara // Update the matches of the search. This is executed every time the text 36623c11e572SOmar Emara // field handles an event. 36633c11e572SOmar Emara virtual void UpdateMatches(const std::string &text) = 0; 36643c11e572SOmar Emara 36653c11e572SOmar Emara // Execute the user callback given the index of some match. This is executed 36663c11e572SOmar Emara // once the user selects a match. 36673c11e572SOmar Emara virtual void ExecuteCallback(int match_index) = 0; 36683c11e572SOmar Emara }; 36693c11e572SOmar Emara 36703c11e572SOmar Emara typedef std::shared_ptr<SearcherDelegate> SearcherDelegateSP; 36713c11e572SOmar Emara 36723c11e572SOmar Emara class SearcherWindowDelegate : public WindowDelegate { 36733c11e572SOmar Emara public: 36743c11e572SOmar Emara SearcherWindowDelegate(SearcherDelegateSP &delegate_sp) 36753c11e572SOmar Emara : m_delegate_sp(delegate_sp), m_text_field("Search", "", false), 36763c11e572SOmar Emara m_selected_match(0), m_first_visible_match(0) { 36773c11e572SOmar Emara ; 36783c11e572SOmar Emara } 36793c11e572SOmar Emara 36803c11e572SOmar Emara // A completion window is padded by one character from all sides. A text field 36813c11e572SOmar Emara // is first drawn for inputting the searcher request, then a list of matches 36823c11e572SOmar Emara // are displayed in a scrollable list. 36833c11e572SOmar Emara // 36843c11e572SOmar Emara // ___<Searcher Window Name>____________________________ 36853c11e572SOmar Emara // | | 36863c11e572SOmar Emara // | __[Search]_______________________________________ | 36873c11e572SOmar Emara // | | | | 36883c11e572SOmar Emara // | |_______________________________________________| | 36893c11e572SOmar Emara // | - Match 1. | 36903c11e572SOmar Emara // | - Match 2. | 36913c11e572SOmar Emara // | - ... | 36923c11e572SOmar Emara // | | 36933c11e572SOmar Emara // |____________________________[Press Esc to Cancel]__| 36943c11e572SOmar Emara // 36953c11e572SOmar Emara 36963c11e572SOmar Emara // Get the index of the last visible match. Assuming at least one match 36973c11e572SOmar Emara // exists. 36983c11e572SOmar Emara int GetLastVisibleMatch(int height) { 36993c11e572SOmar Emara int index = m_first_visible_match + height; 37003c11e572SOmar Emara return std::min(index, m_delegate_sp->GetNumberOfMatches()) - 1; 37013c11e572SOmar Emara } 37023c11e572SOmar Emara 37033c11e572SOmar Emara int GetNumberOfVisibleMatches(int height) { 37043c11e572SOmar Emara return GetLastVisibleMatch(height) - m_first_visible_match + 1; 37053c11e572SOmar Emara } 37063c11e572SOmar Emara 37073c11e572SOmar Emara void UpdateScrolling(Surface &surface) { 37083c11e572SOmar Emara if (m_selected_match < m_first_visible_match) { 37093c11e572SOmar Emara m_first_visible_match = m_selected_match; 37103c11e572SOmar Emara return; 37113c11e572SOmar Emara } 37123c11e572SOmar Emara 37133c11e572SOmar Emara int height = surface.GetHeight(); 37143c11e572SOmar Emara int last_visible_match = GetLastVisibleMatch(height); 37153c11e572SOmar Emara if (m_selected_match > last_visible_match) { 37163c11e572SOmar Emara m_first_visible_match = m_selected_match - height + 1; 37173c11e572SOmar Emara } 37183c11e572SOmar Emara } 37193c11e572SOmar Emara 37203c11e572SOmar Emara void DrawMatches(Surface &surface) { 37213c11e572SOmar Emara if (m_delegate_sp->GetNumberOfMatches() == 0) 37223c11e572SOmar Emara return; 37233c11e572SOmar Emara 37243c11e572SOmar Emara UpdateScrolling(surface); 37253c11e572SOmar Emara 37263c11e572SOmar Emara int count = GetNumberOfVisibleMatches(surface.GetHeight()); 37273c11e572SOmar Emara for (int i = 0; i < count; i++) { 37283c11e572SOmar Emara surface.MoveCursor(1, i); 37293c11e572SOmar Emara int current_match = m_first_visible_match + i; 37303c11e572SOmar Emara if (current_match == m_selected_match) 37313c11e572SOmar Emara surface.AttributeOn(A_REVERSE); 37323c11e572SOmar Emara surface.PutCString( 37333c11e572SOmar Emara m_delegate_sp->GetMatchTextAtIndex(current_match).c_str()); 37343c11e572SOmar Emara if (current_match == m_selected_match) 37353c11e572SOmar Emara surface.AttributeOff(A_REVERSE); 37363c11e572SOmar Emara } 37373c11e572SOmar Emara } 37383c11e572SOmar Emara 37393c11e572SOmar Emara void DrawContent(Surface &surface) { 37403c11e572SOmar Emara Rect content_bounds = surface.GetFrame(); 37413c11e572SOmar Emara Rect text_field_bounds, matchs_bounds; 37423c11e572SOmar Emara content_bounds.HorizontalSplit(m_text_field.FieldDelegateGetHeight(), 37433c11e572SOmar Emara text_field_bounds, matchs_bounds); 37443c11e572SOmar Emara Surface text_field_surface = surface.SubSurface(text_field_bounds); 37453c11e572SOmar Emara Surface matches_surface = surface.SubSurface(matchs_bounds); 37463c11e572SOmar Emara 37473c11e572SOmar Emara m_text_field.FieldDelegateDraw(text_field_surface, true); 37483c11e572SOmar Emara DrawMatches(matches_surface); 37493c11e572SOmar Emara } 37503c11e572SOmar Emara 37513c11e572SOmar Emara bool WindowDelegateDraw(Window &window, bool force) override { 37523c11e572SOmar Emara window.Erase(); 37533c11e572SOmar Emara 37543c11e572SOmar Emara window.DrawTitleBox(window.GetName(), "Press Esc to Cancel"); 37553c11e572SOmar Emara 37563c11e572SOmar Emara Rect content_bounds = window.GetFrame(); 37573c11e572SOmar Emara content_bounds.Inset(2, 2); 37583c11e572SOmar Emara Surface content_surface = window.SubSurface(content_bounds); 37593c11e572SOmar Emara 37603c11e572SOmar Emara DrawContent(content_surface); 37613c11e572SOmar Emara return true; 37623c11e572SOmar Emara } 37633c11e572SOmar Emara 37643c11e572SOmar Emara void SelectNext() { 37653c11e572SOmar Emara if (m_selected_match != m_delegate_sp->GetNumberOfMatches() - 1) 37663c11e572SOmar Emara m_selected_match++; 37673c11e572SOmar Emara return; 37683c11e572SOmar Emara } 37693c11e572SOmar Emara 37703c11e572SOmar Emara void SelectPrevious() { 37713c11e572SOmar Emara if (m_selected_match != 0) 37723c11e572SOmar Emara m_selected_match--; 37733c11e572SOmar Emara return; 37743c11e572SOmar Emara } 37753c11e572SOmar Emara 37763c11e572SOmar Emara void ExecuteCallback(Window &window) { 37773c11e572SOmar Emara m_delegate_sp->ExecuteCallback(m_selected_match); 37783c11e572SOmar Emara window.GetParent()->RemoveSubWindow(&window); 37793c11e572SOmar Emara } 37803c11e572SOmar Emara 37813c11e572SOmar Emara void UpdateMatches() { 37823c11e572SOmar Emara m_delegate_sp->UpdateMatches(m_text_field.GetText()); 37833c11e572SOmar Emara m_selected_match = 0; 37843c11e572SOmar Emara } 37853c11e572SOmar Emara 37863c11e572SOmar Emara HandleCharResult WindowDelegateHandleChar(Window &window, int key) override { 37873c11e572SOmar Emara switch (key) { 37883c11e572SOmar Emara case '\r': 37893c11e572SOmar Emara case '\n': 37903c11e572SOmar Emara case KEY_ENTER: 37913c11e572SOmar Emara ExecuteCallback(window); 37923c11e572SOmar Emara return eKeyHandled; 37933c11e572SOmar Emara case '\t': 37943c11e572SOmar Emara case KEY_DOWN: 37953c11e572SOmar Emara SelectNext(); 37963c11e572SOmar Emara return eKeyHandled; 37973c11e572SOmar Emara case KEY_SHIFT_TAB: 37983c11e572SOmar Emara case KEY_UP: 37993c11e572SOmar Emara SelectPrevious(); 38003c11e572SOmar Emara return eKeyHandled; 38013c11e572SOmar Emara case KEY_ESCAPE: 38023c11e572SOmar Emara window.GetParent()->RemoveSubWindow(&window); 38033c11e572SOmar Emara return eKeyHandled; 38043c11e572SOmar Emara default: 38053c11e572SOmar Emara break; 38063c11e572SOmar Emara } 38073c11e572SOmar Emara 38083c11e572SOmar Emara if (m_text_field.FieldDelegateHandleChar(key) == eKeyHandled) 38093c11e572SOmar Emara UpdateMatches(); 38103c11e572SOmar Emara 38113c11e572SOmar Emara return eKeyHandled; 38123c11e572SOmar Emara } 38133c11e572SOmar Emara 38143c11e572SOmar Emara protected: 38153c11e572SOmar Emara SearcherDelegateSP m_delegate_sp; 38163c11e572SOmar Emara TextFieldDelegate m_text_field; 38173c11e572SOmar Emara // The index of the currently selected match. 38183c11e572SOmar Emara int m_selected_match; 38193c11e572SOmar Emara // The index of the first visible match. 38203c11e572SOmar Emara int m_first_visible_match; 38213c11e572SOmar Emara }; 38223c11e572SOmar Emara 38233c11e572SOmar Emara ////////////////////////////// 38243c11e572SOmar Emara // Searcher Delegate Instances 38253c11e572SOmar Emara ////////////////////////////// 38263c11e572SOmar Emara 38273c11e572SOmar Emara // This is a searcher delegate wrapper around CommandCompletions common 38283c11e572SOmar Emara // callbacks. The callbacks are only given the match string. The completion_mask 38293c11e572SOmar Emara // can be a combination of CommonCompletionTypes. 38303c11e572SOmar Emara class CommonCompletionSearcherDelegate : public SearcherDelegate { 38313c11e572SOmar Emara public: 38323c11e572SOmar Emara typedef std::function<void(const std::string &)> CallbackType; 38333c11e572SOmar Emara 38343c11e572SOmar Emara CommonCompletionSearcherDelegate(Debugger &debugger, uint32_t completion_mask, 38353c11e572SOmar Emara CallbackType callback) 38363c11e572SOmar Emara : m_debugger(debugger), m_completion_mask(completion_mask), 38373c11e572SOmar Emara m_callback(callback) {} 38383c11e572SOmar Emara 38393c11e572SOmar Emara int GetNumberOfMatches() override { return m_matches.GetSize(); } 38403c11e572SOmar Emara 38413c11e572SOmar Emara const std::string &GetMatchTextAtIndex(int index) override { 38423c11e572SOmar Emara return m_matches[index]; 38433c11e572SOmar Emara } 38443c11e572SOmar Emara 38453c11e572SOmar Emara void UpdateMatches(const std::string &text) override { 38463c11e572SOmar Emara CompletionResult result; 38473c11e572SOmar Emara CompletionRequest request(text.c_str(), text.size(), result); 38483c11e572SOmar Emara CommandCompletions::InvokeCommonCompletionCallbacks( 38493c11e572SOmar Emara m_debugger.GetCommandInterpreter(), m_completion_mask, request, 38503c11e572SOmar Emara nullptr); 38513c11e572SOmar Emara result.GetMatches(m_matches); 38523c11e572SOmar Emara } 38533c11e572SOmar Emara 38543c11e572SOmar Emara void ExecuteCallback(int match_index) override { 38553c11e572SOmar Emara m_callback(m_matches[match_index]); 38563c11e572SOmar Emara } 38573c11e572SOmar Emara 38583c11e572SOmar Emara protected: 38593c11e572SOmar Emara Debugger &m_debugger; 38603c11e572SOmar Emara // A compound mask from CommonCompletionTypes. 38613c11e572SOmar Emara uint32_t m_completion_mask; 38623c11e572SOmar Emara // A callback to execute once the user selects a match. The match is passed to 38633c11e572SOmar Emara // the callback as a string. 38643c11e572SOmar Emara CallbackType m_callback; 38653c11e572SOmar Emara StringList m_matches; 38663c11e572SOmar Emara }; 38673c11e572SOmar Emara 38683c11e572SOmar Emara //////// 38693c11e572SOmar Emara // Menus 38703c11e572SOmar Emara //////// 38713c11e572SOmar Emara 38727caa17caSRaphael Isemann class MenuDelegate { 38737caa17caSRaphael Isemann public: 38747caa17caSRaphael Isemann virtual ~MenuDelegate() = default; 38757caa17caSRaphael Isemann 38767caa17caSRaphael Isemann virtual MenuActionResult MenuDelegateAction(Menu &menu) = 0; 38777caa17caSRaphael Isemann }; 38787caa17caSRaphael Isemann 38797caa17caSRaphael Isemann class Menu : public WindowDelegate { 38807caa17caSRaphael Isemann public: 38817caa17caSRaphael Isemann enum class Type { Invalid, Bar, Item, Separator }; 38827caa17caSRaphael Isemann 38837caa17caSRaphael Isemann // Menubar or separator constructor 38847caa17caSRaphael Isemann Menu(Type type); 38857caa17caSRaphael Isemann 38867caa17caSRaphael Isemann // Menuitem constructor 38877caa17caSRaphael Isemann Menu(const char *name, const char *key_name, int key_value, 38887caa17caSRaphael Isemann uint64_t identifier); 38897caa17caSRaphael Isemann 38907caa17caSRaphael Isemann ~Menu() override = default; 38917caa17caSRaphael Isemann 38927caa17caSRaphael Isemann const MenuDelegateSP &GetDelegate() const { return m_delegate_sp; } 38937caa17caSRaphael Isemann 38947caa17caSRaphael Isemann void SetDelegate(const MenuDelegateSP &delegate_sp) { 38957caa17caSRaphael Isemann m_delegate_sp = delegate_sp; 38967caa17caSRaphael Isemann } 38977caa17caSRaphael Isemann 38987caa17caSRaphael Isemann void RecalculateNameLengths(); 38997caa17caSRaphael Isemann 39007caa17caSRaphael Isemann void AddSubmenu(const MenuSP &menu_sp); 39017caa17caSRaphael Isemann 39027caa17caSRaphael Isemann int DrawAndRunMenu(Window &window); 39037caa17caSRaphael Isemann 39047caa17caSRaphael Isemann void DrawMenuTitle(Window &window, bool highlight); 39057caa17caSRaphael Isemann 39067caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override; 39077caa17caSRaphael Isemann 39087caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int key) override; 39097caa17caSRaphael Isemann 39107caa17caSRaphael Isemann MenuActionResult ActionPrivate(Menu &menu) { 39117caa17caSRaphael Isemann MenuActionResult result = MenuActionResult::NotHandled; 39127caa17caSRaphael Isemann if (m_delegate_sp) { 39137caa17caSRaphael Isemann result = m_delegate_sp->MenuDelegateAction(menu); 39147caa17caSRaphael Isemann if (result != MenuActionResult::NotHandled) 39157caa17caSRaphael Isemann return result; 39167caa17caSRaphael Isemann } else if (m_parent) { 39177caa17caSRaphael Isemann result = m_parent->ActionPrivate(menu); 39187caa17caSRaphael Isemann if (result != MenuActionResult::NotHandled) 39197caa17caSRaphael Isemann return result; 39207caa17caSRaphael Isemann } 39217caa17caSRaphael Isemann return m_canned_result; 39227caa17caSRaphael Isemann } 39237caa17caSRaphael Isemann 39247caa17caSRaphael Isemann MenuActionResult Action() { 39257caa17caSRaphael Isemann // Call the recursive action so it can try to handle it with the menu 39267caa17caSRaphael Isemann // delegate, and if not, try our parent menu 39277caa17caSRaphael Isemann return ActionPrivate(*this); 39287caa17caSRaphael Isemann } 39297caa17caSRaphael Isemann 39307caa17caSRaphael Isemann void SetCannedResult(MenuActionResult result) { m_canned_result = result; } 39317caa17caSRaphael Isemann 39327caa17caSRaphael Isemann Menus &GetSubmenus() { return m_submenus; } 39337caa17caSRaphael Isemann 39347caa17caSRaphael Isemann const Menus &GetSubmenus() const { return m_submenus; } 39357caa17caSRaphael Isemann 39367caa17caSRaphael Isemann int GetSelectedSubmenuIndex() const { return m_selected; } 39377caa17caSRaphael Isemann 39387caa17caSRaphael Isemann void SetSelectedSubmenuIndex(int idx) { m_selected = idx; } 39397caa17caSRaphael Isemann 39407caa17caSRaphael Isemann Type GetType() const { return m_type; } 39417caa17caSRaphael Isemann 39427caa17caSRaphael Isemann int GetStartingColumn() const { return m_start_col; } 39437caa17caSRaphael Isemann 39447caa17caSRaphael Isemann void SetStartingColumn(int col) { m_start_col = col; } 39457caa17caSRaphael Isemann 39467caa17caSRaphael Isemann int GetKeyValue() const { return m_key_value; } 39477caa17caSRaphael Isemann 39487caa17caSRaphael Isemann std::string &GetName() { return m_name; } 39497caa17caSRaphael Isemann 39507caa17caSRaphael Isemann int GetDrawWidth() const { 39517caa17caSRaphael Isemann return m_max_submenu_name_length + m_max_submenu_key_name_length + 8; 39527caa17caSRaphael Isemann } 39537caa17caSRaphael Isemann 39547caa17caSRaphael Isemann uint64_t GetIdentifier() const { return m_identifier; } 39557caa17caSRaphael Isemann 39567caa17caSRaphael Isemann void SetIdentifier(uint64_t identifier) { m_identifier = identifier; } 39577caa17caSRaphael Isemann 39587caa17caSRaphael Isemann protected: 39597caa17caSRaphael Isemann std::string m_name; 39607caa17caSRaphael Isemann std::string m_key_name; 39617caa17caSRaphael Isemann uint64_t m_identifier; 39627caa17caSRaphael Isemann Type m_type; 39637caa17caSRaphael Isemann int m_key_value; 39647caa17caSRaphael Isemann int m_start_col; 39657caa17caSRaphael Isemann int m_max_submenu_name_length; 39667caa17caSRaphael Isemann int m_max_submenu_key_name_length; 39677caa17caSRaphael Isemann int m_selected; 39687caa17caSRaphael Isemann Menu *m_parent; 39697caa17caSRaphael Isemann Menus m_submenus; 39707caa17caSRaphael Isemann WindowSP m_menu_window_sp; 39717caa17caSRaphael Isemann MenuActionResult m_canned_result; 39727caa17caSRaphael Isemann MenuDelegateSP m_delegate_sp; 39737caa17caSRaphael Isemann }; 39747caa17caSRaphael Isemann 39757caa17caSRaphael Isemann // Menubar or separator constructor 39767caa17caSRaphael Isemann Menu::Menu(Type type) 39777caa17caSRaphael Isemann : m_name(), m_key_name(), m_identifier(0), m_type(type), m_key_value(0), 39787caa17caSRaphael Isemann 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 39837caa17caSRaphael Isemann // Menuitem constructor 39847caa17caSRaphael Isemann Menu::Menu(const char *name, const char *key_name, int key_value, 39857caa17caSRaphael Isemann uint64_t identifier) 39867caa17caSRaphael Isemann : m_name(), m_key_name(), m_identifier(identifier), m_type(Type::Invalid), 39877caa17caSRaphael Isemann m_key_value(key_value), m_start_col(0), m_max_submenu_name_length(0), 39887caa17caSRaphael Isemann m_max_submenu_key_name_length(0), m_selected(0), m_parent(nullptr), 39897caa17caSRaphael Isemann m_submenus(), m_canned_result(MenuActionResult::NotHandled), 39907caa17caSRaphael Isemann m_delegate_sp() { 39917caa17caSRaphael Isemann if (name && name[0]) { 39927caa17caSRaphael Isemann m_name = name; 39937caa17caSRaphael Isemann m_type = Type::Item; 39947caa17caSRaphael Isemann if (key_name && key_name[0]) 39957caa17caSRaphael Isemann m_key_name = key_name; 39967caa17caSRaphael Isemann } else { 39977caa17caSRaphael Isemann m_type = Type::Separator; 39987caa17caSRaphael Isemann } 39997caa17caSRaphael Isemann } 40007caa17caSRaphael Isemann 40017caa17caSRaphael Isemann void Menu::RecalculateNameLengths() { 40027caa17caSRaphael Isemann m_max_submenu_name_length = 0; 40037caa17caSRaphael Isemann m_max_submenu_key_name_length = 0; 40047caa17caSRaphael Isemann Menus &submenus = GetSubmenus(); 40057caa17caSRaphael Isemann const size_t num_submenus = submenus.size(); 40067caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 40077caa17caSRaphael Isemann Menu *submenu = submenus[i].get(); 40087caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_name_length) < submenu->m_name.size()) 40097caa17caSRaphael Isemann m_max_submenu_name_length = submenu->m_name.size(); 40107caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_key_name_length) < 40117caa17caSRaphael Isemann submenu->m_key_name.size()) 40127caa17caSRaphael Isemann m_max_submenu_key_name_length = submenu->m_key_name.size(); 40137caa17caSRaphael Isemann } 40147caa17caSRaphael Isemann } 40157caa17caSRaphael Isemann 40167caa17caSRaphael Isemann void Menu::AddSubmenu(const MenuSP &menu_sp) { 40177caa17caSRaphael Isemann menu_sp->m_parent = this; 40187caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_name_length) < menu_sp->m_name.size()) 40197caa17caSRaphael Isemann m_max_submenu_name_length = menu_sp->m_name.size(); 40207caa17caSRaphael Isemann if (static_cast<size_t>(m_max_submenu_key_name_length) < 40217caa17caSRaphael Isemann menu_sp->m_key_name.size()) 40227caa17caSRaphael Isemann m_max_submenu_key_name_length = menu_sp->m_key_name.size(); 40237caa17caSRaphael Isemann m_submenus.push_back(menu_sp); 40247caa17caSRaphael Isemann } 40257caa17caSRaphael Isemann 40267caa17caSRaphael Isemann void Menu::DrawMenuTitle(Window &window, bool highlight) { 40277caa17caSRaphael Isemann if (m_type == Type::Separator) { 40287caa17caSRaphael Isemann window.MoveCursor(0, window.GetCursorY()); 40297caa17caSRaphael Isemann window.PutChar(ACS_LTEE); 40307caa17caSRaphael Isemann int width = window.GetWidth(); 40317caa17caSRaphael Isemann if (width > 2) { 40327caa17caSRaphael Isemann width -= 2; 40337caa17caSRaphael Isemann for (int i = 0; i < width; ++i) 40347caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 40357caa17caSRaphael Isemann } 40367caa17caSRaphael Isemann window.PutChar(ACS_RTEE); 40377caa17caSRaphael Isemann } else { 40387caa17caSRaphael Isemann const int shortcut_key = m_key_value; 40397caa17caSRaphael Isemann bool underlined_shortcut = false; 4040daa1c6d9SLuboš Luňák const attr_t highlight_attr = A_REVERSE; 40417caa17caSRaphael Isemann if (highlight) 4042daa1c6d9SLuboš Luňák window.AttributeOn(highlight_attr); 4043f5eaa2afSRaphael Isemann if (llvm::isPrint(shortcut_key)) { 40447caa17caSRaphael Isemann size_t lower_pos = m_name.find(tolower(shortcut_key)); 40457caa17caSRaphael Isemann size_t upper_pos = m_name.find(toupper(shortcut_key)); 40467caa17caSRaphael Isemann const char *name = m_name.c_str(); 40477caa17caSRaphael Isemann size_t pos = std::min<size_t>(lower_pos, upper_pos); 40487caa17caSRaphael Isemann if (pos != std::string::npos) { 40497caa17caSRaphael Isemann underlined_shortcut = true; 40507caa17caSRaphael Isemann if (pos > 0) { 40517caa17caSRaphael Isemann window.PutCString(name, pos); 40527caa17caSRaphael Isemann name += pos; 40537caa17caSRaphael Isemann } 40547caa17caSRaphael Isemann const attr_t shortcut_attr = A_UNDERLINE | A_BOLD; 40557caa17caSRaphael Isemann window.AttributeOn(shortcut_attr); 40567caa17caSRaphael Isemann window.PutChar(name[0]); 40577caa17caSRaphael Isemann window.AttributeOff(shortcut_attr); 40587caa17caSRaphael Isemann name++; 40597caa17caSRaphael Isemann if (name[0]) 40607caa17caSRaphael Isemann window.PutCString(name); 40617caa17caSRaphael Isemann } 40627caa17caSRaphael Isemann } 40637caa17caSRaphael Isemann 40647caa17caSRaphael Isemann if (!underlined_shortcut) { 40657caa17caSRaphael Isemann window.PutCString(m_name.c_str()); 40667caa17caSRaphael Isemann } 40677caa17caSRaphael Isemann 40687caa17caSRaphael Isemann if (highlight) 4069daa1c6d9SLuboš Luňák window.AttributeOff(highlight_attr); 40707caa17caSRaphael Isemann 40717caa17caSRaphael Isemann if (m_key_name.empty()) { 4072f5eaa2afSRaphael Isemann if (!underlined_shortcut && llvm::isPrint(m_key_value)) { 40734a8e4b5cSLuboš Luňák window.AttributeOn(COLOR_PAIR(MagentaOnWhite)); 40747caa17caSRaphael Isemann window.Printf(" (%c)", m_key_value); 40754a8e4b5cSLuboš Luňák window.AttributeOff(COLOR_PAIR(MagentaOnWhite)); 40767caa17caSRaphael Isemann } 40777caa17caSRaphael Isemann } else { 40784a8e4b5cSLuboš Luňák window.AttributeOn(COLOR_PAIR(MagentaOnWhite)); 40797caa17caSRaphael Isemann window.Printf(" (%s)", m_key_name.c_str()); 40804a8e4b5cSLuboš Luňák window.AttributeOff(COLOR_PAIR(MagentaOnWhite)); 40817caa17caSRaphael Isemann } 40827caa17caSRaphael Isemann } 40837caa17caSRaphael Isemann } 40847caa17caSRaphael Isemann 40857caa17caSRaphael Isemann bool Menu::WindowDelegateDraw(Window &window, bool force) { 40867caa17caSRaphael Isemann Menus &submenus = GetSubmenus(); 40877caa17caSRaphael Isemann const size_t num_submenus = submenus.size(); 40887caa17caSRaphael Isemann const int selected_idx = GetSelectedSubmenuIndex(); 40897caa17caSRaphael Isemann Menu::Type menu_type = GetType(); 40907caa17caSRaphael Isemann switch (menu_type) { 40917caa17caSRaphael Isemann case Menu::Type::Bar: { 40924a8e4b5cSLuboš Luňák window.SetBackground(BlackOnWhite); 40937caa17caSRaphael Isemann window.MoveCursor(0, 0); 40947caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 40957caa17caSRaphael Isemann Menu *menu = submenus[i].get(); 40967caa17caSRaphael Isemann if (i > 0) 40977caa17caSRaphael Isemann window.PutChar(' '); 40987caa17caSRaphael Isemann menu->SetStartingColumn(window.GetCursorX()); 40997caa17caSRaphael Isemann window.PutCString("| "); 41007caa17caSRaphael Isemann menu->DrawMenuTitle(window, false); 41017caa17caSRaphael Isemann } 41027caa17caSRaphael Isemann window.PutCString(" |"); 41037caa17caSRaphael Isemann } break; 41047caa17caSRaphael Isemann 41057caa17caSRaphael Isemann case Menu::Type::Item: { 41067caa17caSRaphael Isemann int y = 1; 41077caa17caSRaphael Isemann int x = 3; 41087caa17caSRaphael Isemann // Draw the menu 41097caa17caSRaphael Isemann int cursor_x = 0; 41107caa17caSRaphael Isemann int cursor_y = 0; 41117caa17caSRaphael Isemann window.Erase(); 41124a8e4b5cSLuboš Luňák window.SetBackground(BlackOnWhite); 41137caa17caSRaphael Isemann window.Box(); 41147caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 41157caa17caSRaphael Isemann const bool is_selected = (i == static_cast<size_t>(selected_idx)); 41167caa17caSRaphael Isemann window.MoveCursor(x, y + i); 41177caa17caSRaphael Isemann if (is_selected) { 41187caa17caSRaphael Isemann // Remember where we want the cursor to be 41197caa17caSRaphael Isemann cursor_x = x - 1; 41207caa17caSRaphael Isemann cursor_y = y + i; 41217caa17caSRaphael Isemann } 41227caa17caSRaphael Isemann submenus[i]->DrawMenuTitle(window, is_selected); 41237caa17caSRaphael Isemann } 41247caa17caSRaphael Isemann window.MoveCursor(cursor_x, cursor_y); 41257caa17caSRaphael Isemann } break; 41267caa17caSRaphael Isemann 41277caa17caSRaphael Isemann default: 41287caa17caSRaphael Isemann case Menu::Type::Separator: 41297caa17caSRaphael Isemann break; 41307caa17caSRaphael Isemann } 41317caa17caSRaphael Isemann return true; // Drawing handled... 41327caa17caSRaphael Isemann } 41337caa17caSRaphael Isemann 41347caa17caSRaphael Isemann HandleCharResult Menu::WindowDelegateHandleChar(Window &window, int key) { 41357caa17caSRaphael Isemann HandleCharResult result = eKeyNotHandled; 41367caa17caSRaphael Isemann 41377caa17caSRaphael Isemann Menus &submenus = GetSubmenus(); 41387caa17caSRaphael Isemann const size_t num_submenus = submenus.size(); 41397caa17caSRaphael Isemann const int selected_idx = GetSelectedSubmenuIndex(); 41407caa17caSRaphael Isemann Menu::Type menu_type = GetType(); 41417caa17caSRaphael Isemann if (menu_type == Menu::Type::Bar) { 41427caa17caSRaphael Isemann MenuSP run_menu_sp; 41437caa17caSRaphael Isemann switch (key) { 41447caa17caSRaphael Isemann case KEY_DOWN: 41457caa17caSRaphael Isemann case KEY_UP: 41467caa17caSRaphael Isemann // Show last menu or first menu 41477caa17caSRaphael Isemann if (selected_idx < static_cast<int>(num_submenus)) 41487caa17caSRaphael Isemann run_menu_sp = submenus[selected_idx]; 41497caa17caSRaphael Isemann else if (!submenus.empty()) 41507caa17caSRaphael Isemann run_menu_sp = submenus.front(); 41517caa17caSRaphael Isemann result = eKeyHandled; 41527caa17caSRaphael Isemann break; 41537caa17caSRaphael Isemann 41547caa17caSRaphael Isemann case KEY_RIGHT: 41557caa17caSRaphael Isemann ++m_selected; 41567caa17caSRaphael Isemann if (m_selected >= static_cast<int>(num_submenus)) 41577caa17caSRaphael Isemann m_selected = 0; 41587caa17caSRaphael Isemann if (m_selected < static_cast<int>(num_submenus)) 41597caa17caSRaphael Isemann run_menu_sp = submenus[m_selected]; 41607caa17caSRaphael Isemann else if (!submenus.empty()) 41617caa17caSRaphael Isemann run_menu_sp = submenus.front(); 41627caa17caSRaphael Isemann result = eKeyHandled; 41637caa17caSRaphael Isemann break; 41647caa17caSRaphael Isemann 41657caa17caSRaphael Isemann case KEY_LEFT: 41667caa17caSRaphael Isemann --m_selected; 41677caa17caSRaphael Isemann if (m_selected < 0) 41687caa17caSRaphael Isemann m_selected = num_submenus - 1; 41697caa17caSRaphael Isemann if (m_selected < static_cast<int>(num_submenus)) 41707caa17caSRaphael Isemann run_menu_sp = submenus[m_selected]; 41717caa17caSRaphael Isemann else if (!submenus.empty()) 41727caa17caSRaphael Isemann run_menu_sp = submenus.front(); 41737caa17caSRaphael Isemann result = eKeyHandled; 41747caa17caSRaphael Isemann break; 41757caa17caSRaphael Isemann 41767caa17caSRaphael Isemann default: 41777caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 41787caa17caSRaphael Isemann if (submenus[i]->GetKeyValue() == key) { 41797caa17caSRaphael Isemann SetSelectedSubmenuIndex(i); 41807caa17caSRaphael Isemann run_menu_sp = submenus[i]; 41817caa17caSRaphael Isemann result = eKeyHandled; 41827caa17caSRaphael Isemann break; 41837caa17caSRaphael Isemann } 41847caa17caSRaphael Isemann } 41857caa17caSRaphael Isemann break; 41867caa17caSRaphael Isemann } 41877caa17caSRaphael Isemann 41887caa17caSRaphael Isemann if (run_menu_sp) { 41897caa17caSRaphael Isemann // Run the action on this menu in case we need to populate the menu with 41907caa17caSRaphael Isemann // dynamic content and also in case check marks, and any other menu 41917caa17caSRaphael Isemann // decorations need to be calculated 41927caa17caSRaphael Isemann if (run_menu_sp->Action() == MenuActionResult::Quit) 41937caa17caSRaphael Isemann return eQuitApplication; 41947caa17caSRaphael Isemann 41957caa17caSRaphael Isemann Rect menu_bounds; 41967caa17caSRaphael Isemann menu_bounds.origin.x = run_menu_sp->GetStartingColumn(); 41977caa17caSRaphael Isemann menu_bounds.origin.y = 1; 41987caa17caSRaphael Isemann menu_bounds.size.width = run_menu_sp->GetDrawWidth(); 41997caa17caSRaphael Isemann menu_bounds.size.height = run_menu_sp->GetSubmenus().size() + 2; 42007caa17caSRaphael Isemann if (m_menu_window_sp) 42017caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(m_menu_window_sp.get()); 42027caa17caSRaphael Isemann 42037caa17caSRaphael Isemann m_menu_window_sp = window.GetParent()->CreateSubWindow( 42047caa17caSRaphael Isemann run_menu_sp->GetName().c_str(), menu_bounds, true); 42057caa17caSRaphael Isemann m_menu_window_sp->SetDelegate(run_menu_sp); 42067caa17caSRaphael Isemann } 42077caa17caSRaphael Isemann } else if (menu_type == Menu::Type::Item) { 42087caa17caSRaphael Isemann switch (key) { 42097caa17caSRaphael Isemann case KEY_DOWN: 42107caa17caSRaphael Isemann if (m_submenus.size() > 1) { 42117caa17caSRaphael Isemann const int start_select = m_selected; 42127caa17caSRaphael Isemann while (++m_selected != start_select) { 42137caa17caSRaphael Isemann if (static_cast<size_t>(m_selected) >= num_submenus) 42147caa17caSRaphael Isemann m_selected = 0; 42157caa17caSRaphael Isemann if (m_submenus[m_selected]->GetType() == Type::Separator) 42167caa17caSRaphael Isemann continue; 42177caa17caSRaphael Isemann else 42187caa17caSRaphael Isemann break; 42197caa17caSRaphael Isemann } 42207caa17caSRaphael Isemann return eKeyHandled; 42217caa17caSRaphael Isemann } 42227caa17caSRaphael Isemann break; 42237caa17caSRaphael Isemann 42247caa17caSRaphael Isemann case KEY_UP: 42257caa17caSRaphael Isemann if (m_submenus.size() > 1) { 42267caa17caSRaphael Isemann const int start_select = m_selected; 42277caa17caSRaphael Isemann while (--m_selected != start_select) { 42287caa17caSRaphael Isemann if (m_selected < static_cast<int>(0)) 42297caa17caSRaphael Isemann m_selected = num_submenus - 1; 42307caa17caSRaphael Isemann if (m_submenus[m_selected]->GetType() == Type::Separator) 42317caa17caSRaphael Isemann continue; 42327caa17caSRaphael Isemann else 42337caa17caSRaphael Isemann break; 42347caa17caSRaphael Isemann } 42357caa17caSRaphael Isemann return eKeyHandled; 42367caa17caSRaphael Isemann } 42377caa17caSRaphael Isemann break; 42387caa17caSRaphael Isemann 42397caa17caSRaphael Isemann case KEY_RETURN: 42407caa17caSRaphael Isemann if (static_cast<size_t>(selected_idx) < num_submenus) { 42417caa17caSRaphael Isemann if (submenus[selected_idx]->Action() == MenuActionResult::Quit) 42427caa17caSRaphael Isemann return eQuitApplication; 42437caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 42447caa17caSRaphael Isemann return eKeyHandled; 42457caa17caSRaphael Isemann } 42467caa17caSRaphael Isemann break; 42477caa17caSRaphael Isemann 42487caa17caSRaphael Isemann case KEY_ESCAPE: // Beware: pressing escape key has 1 to 2 second delay in 42497caa17caSRaphael Isemann // case other chars are entered for escaped sequences 42507caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 42517caa17caSRaphael Isemann return eKeyHandled; 42527caa17caSRaphael Isemann 42537caa17caSRaphael Isemann default: 42547caa17caSRaphael Isemann for (size_t i = 0; i < num_submenus; ++i) { 42557caa17caSRaphael Isemann Menu *menu = submenus[i].get(); 42567caa17caSRaphael Isemann if (menu->GetKeyValue() == key) { 42577caa17caSRaphael Isemann SetSelectedSubmenuIndex(i); 42587caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 42597caa17caSRaphael Isemann if (menu->Action() == MenuActionResult::Quit) 42607caa17caSRaphael Isemann return eQuitApplication; 42617caa17caSRaphael Isemann return eKeyHandled; 42627caa17caSRaphael Isemann } 42637caa17caSRaphael Isemann } 42647caa17caSRaphael Isemann break; 42657caa17caSRaphael Isemann } 42667caa17caSRaphael Isemann } else if (menu_type == Menu::Type::Separator) { 42677caa17caSRaphael Isemann } 42687caa17caSRaphael Isemann return result; 42697caa17caSRaphael Isemann } 42707caa17caSRaphael Isemann 42717caa17caSRaphael Isemann class Application { 42727caa17caSRaphael Isemann public: 42737caa17caSRaphael Isemann Application(FILE *in, FILE *out) 42747caa17caSRaphael Isemann : m_window_sp(), m_screen(nullptr), m_in(in), m_out(out) {} 42757caa17caSRaphael Isemann 42767caa17caSRaphael Isemann ~Application() { 42777caa17caSRaphael Isemann m_window_delegates.clear(); 42787caa17caSRaphael Isemann m_window_sp.reset(); 42797caa17caSRaphael Isemann if (m_screen) { 42807caa17caSRaphael Isemann ::delscreen(m_screen); 42817caa17caSRaphael Isemann m_screen = nullptr; 42827caa17caSRaphael Isemann } 42837caa17caSRaphael Isemann } 42847caa17caSRaphael Isemann 42857caa17caSRaphael Isemann void Initialize() { 42867caa17caSRaphael Isemann m_screen = ::newterm(nullptr, m_out, m_in); 42877caa17caSRaphael Isemann ::start_color(); 42887caa17caSRaphael Isemann ::curs_set(0); 42897caa17caSRaphael Isemann ::noecho(); 42907caa17caSRaphael Isemann ::keypad(stdscr, TRUE); 42917caa17caSRaphael Isemann } 42927caa17caSRaphael Isemann 42937caa17caSRaphael Isemann void Terminate() { ::endwin(); } 42947caa17caSRaphael Isemann 42957caa17caSRaphael Isemann void Run(Debugger &debugger) { 42967caa17caSRaphael Isemann bool done = false; 42977caa17caSRaphael Isemann int delay_in_tenths_of_a_second = 1; 42987caa17caSRaphael Isemann 429918c25cd3SOmar Emara // Alas the threading model in curses is a bit lame so we need to resort 430018c25cd3SOmar Emara // to polling every 0.5 seconds. We could poll for stdin ourselves and 430118c25cd3SOmar Emara // then pass the keys down but then we need to translate all of the escape 43027caa17caSRaphael Isemann // sequences ourselves. So we resort to polling for input because we need 43037caa17caSRaphael Isemann // to receive async process events while in this loop. 43047caa17caSRaphael Isemann 430518c25cd3SOmar Emara halfdelay(delay_in_tenths_of_a_second); // Poll using some number of 430618c25cd3SOmar Emara // tenths of seconds seconds when 430718c25cd3SOmar Emara // calling Window::GetChar() 43087caa17caSRaphael Isemann 43097caa17caSRaphael Isemann ListenerSP listener_sp( 43107caa17caSRaphael Isemann Listener::MakeListener("lldb.IOHandler.curses.Application")); 43117caa17caSRaphael Isemann ConstString broadcaster_class_process(Process::GetStaticBroadcasterClass()); 43127caa17caSRaphael Isemann debugger.EnableForwardEvents(listener_sp); 43137caa17caSRaphael Isemann 43142f1b24b7SLuboš Luňák m_update_screen = true; 43157caa17caSRaphael Isemann #if defined(__APPLE__) 43167caa17caSRaphael Isemann std::deque<int> escape_chars; 43177caa17caSRaphael Isemann #endif 43187caa17caSRaphael Isemann 43197caa17caSRaphael Isemann while (!done) { 43202f1b24b7SLuboš Luňák if (m_update_screen) { 43217caa17caSRaphael Isemann m_window_sp->Draw(false); 43227caa17caSRaphael Isemann // All windows should be calling Window::DeferredRefresh() instead of 43237caa17caSRaphael Isemann // Window::Refresh() so we can do a single update and avoid any screen 43247caa17caSRaphael Isemann // blinking 43257caa17caSRaphael Isemann update_panels(); 43267caa17caSRaphael Isemann 43277caa17caSRaphael Isemann // Cursor hiding isn't working on MacOSX, so hide it in the top left 43287caa17caSRaphael Isemann // corner 43297caa17caSRaphael Isemann m_window_sp->MoveCursor(0, 0); 43307caa17caSRaphael Isemann 43317caa17caSRaphael Isemann doupdate(); 43322f1b24b7SLuboš Luňák m_update_screen = false; 43337caa17caSRaphael Isemann } 43347caa17caSRaphael Isemann 43357caa17caSRaphael Isemann #if defined(__APPLE__) 43367caa17caSRaphael Isemann // Terminal.app doesn't map its function keys correctly, F1-F4 default 43377caa17caSRaphael Isemann // to: \033OP, \033OQ, \033OR, \033OS, so lets take care of this here if 43387caa17caSRaphael Isemann // possible 43397caa17caSRaphael Isemann int ch; 43407caa17caSRaphael Isemann if (escape_chars.empty()) 43417caa17caSRaphael Isemann ch = m_window_sp->GetChar(); 43427caa17caSRaphael Isemann else { 43437caa17caSRaphael Isemann ch = escape_chars.front(); 43447caa17caSRaphael Isemann escape_chars.pop_front(); 43457caa17caSRaphael Isemann } 43467caa17caSRaphael Isemann if (ch == KEY_ESCAPE) { 43477caa17caSRaphael Isemann int ch2 = m_window_sp->GetChar(); 43487caa17caSRaphael Isemann if (ch2 == 'O') { 43497caa17caSRaphael Isemann int ch3 = m_window_sp->GetChar(); 43507caa17caSRaphael Isemann switch (ch3) { 43517caa17caSRaphael Isemann case 'P': 43527caa17caSRaphael Isemann ch = KEY_F(1); 43537caa17caSRaphael Isemann break; 43547caa17caSRaphael Isemann case 'Q': 43557caa17caSRaphael Isemann ch = KEY_F(2); 43567caa17caSRaphael Isemann break; 43577caa17caSRaphael Isemann case 'R': 43587caa17caSRaphael Isemann ch = KEY_F(3); 43597caa17caSRaphael Isemann break; 43607caa17caSRaphael Isemann case 'S': 43617caa17caSRaphael Isemann ch = KEY_F(4); 43627caa17caSRaphael Isemann break; 43637caa17caSRaphael Isemann default: 43647caa17caSRaphael Isemann escape_chars.push_back(ch2); 43657caa17caSRaphael Isemann if (ch3 != -1) 43667caa17caSRaphael Isemann escape_chars.push_back(ch3); 43677caa17caSRaphael Isemann break; 43687caa17caSRaphael Isemann } 43697caa17caSRaphael Isemann } else if (ch2 != -1) 43707caa17caSRaphael Isemann escape_chars.push_back(ch2); 43717caa17caSRaphael Isemann } 43727caa17caSRaphael Isemann #else 43737caa17caSRaphael Isemann int ch = m_window_sp->GetChar(); 43747caa17caSRaphael Isemann 43757caa17caSRaphael Isemann #endif 43767caa17caSRaphael Isemann if (ch == -1) { 43777caa17caSRaphael Isemann if (feof(m_in) || ferror(m_in)) { 43787caa17caSRaphael Isemann done = true; 43797caa17caSRaphael Isemann } else { 43807caa17caSRaphael Isemann // Just a timeout from using halfdelay(), check for events 43817caa17caSRaphael Isemann EventSP event_sp; 43827caa17caSRaphael Isemann while (listener_sp->PeekAtNextEvent()) { 43837caa17caSRaphael Isemann listener_sp->GetEvent(event_sp, std::chrono::seconds(0)); 43847caa17caSRaphael Isemann 43857caa17caSRaphael Isemann if (event_sp) { 43867caa17caSRaphael Isemann Broadcaster *broadcaster = event_sp->GetBroadcaster(); 43877caa17caSRaphael Isemann if (broadcaster) { 43887caa17caSRaphael Isemann // uint32_t event_type = event_sp->GetType(); 43897caa17caSRaphael Isemann ConstString broadcaster_class( 43907caa17caSRaphael Isemann broadcaster->GetBroadcasterClass()); 43917caa17caSRaphael Isemann if (broadcaster_class == broadcaster_class_process) { 43922f1b24b7SLuboš Luňák m_update_screen = true; 43937caa17caSRaphael Isemann continue; // Don't get any key, just update our view 43947caa17caSRaphael Isemann } 43957caa17caSRaphael Isemann } 43967caa17caSRaphael Isemann } 43977caa17caSRaphael Isemann } 43987caa17caSRaphael Isemann } 43997caa17caSRaphael Isemann } else { 44007caa17caSRaphael Isemann HandleCharResult key_result = m_window_sp->HandleChar(ch); 44017caa17caSRaphael Isemann switch (key_result) { 44027caa17caSRaphael Isemann case eKeyHandled: 44032f1b24b7SLuboš Luňák m_update_screen = true; 44047caa17caSRaphael Isemann break; 44057caa17caSRaphael Isemann case eKeyNotHandled: 44068739445eSLuboš Luňák if (ch == 12) { // Ctrl+L, force full redraw 44078739445eSLuboš Luňák redrawwin(m_window_sp->get()); 44082f1b24b7SLuboš Luňák m_update_screen = true; 44098739445eSLuboš Luňák } 44107caa17caSRaphael Isemann break; 44117caa17caSRaphael Isemann case eQuitApplication: 44127caa17caSRaphael Isemann done = true; 44137caa17caSRaphael Isemann break; 44147caa17caSRaphael Isemann } 44157caa17caSRaphael Isemann } 44167caa17caSRaphael Isemann } 44177caa17caSRaphael Isemann 44187caa17caSRaphael Isemann debugger.CancelForwardEvents(listener_sp); 44197caa17caSRaphael Isemann } 44207caa17caSRaphael Isemann 44217caa17caSRaphael Isemann WindowSP &GetMainWindow() { 44227caa17caSRaphael Isemann if (!m_window_sp) 44237caa17caSRaphael Isemann m_window_sp = std::make_shared<Window>("main", stdscr, false); 44247caa17caSRaphael Isemann return m_window_sp; 44257caa17caSRaphael Isemann } 44267caa17caSRaphael Isemann 44272f1b24b7SLuboš Luňák void TerminalSizeChanged() { 44282f1b24b7SLuboš Luňák ::endwin(); 44292f1b24b7SLuboš Luňák ::refresh(); 44302f1b24b7SLuboš Luňák Rect content_bounds = m_window_sp->GetFrame(); 44312f1b24b7SLuboš Luňák m_window_sp->SetBounds(content_bounds); 44322f1b24b7SLuboš Luňák if (WindowSP menubar_window_sp = m_window_sp->FindSubWindow("Menubar")) 44332f1b24b7SLuboš Luňák menubar_window_sp->SetBounds(content_bounds.MakeMenuBar()); 44342f1b24b7SLuboš Luňák if (WindowSP status_window_sp = m_window_sp->FindSubWindow("Status")) 44352f1b24b7SLuboš Luňák status_window_sp->SetBounds(content_bounds.MakeStatusBar()); 44362f1b24b7SLuboš Luňák 44372f1b24b7SLuboš Luňák WindowSP source_window_sp = m_window_sp->FindSubWindow("Source"); 44382f1b24b7SLuboš Luňák WindowSP variables_window_sp = m_window_sp->FindSubWindow("Variables"); 44392f1b24b7SLuboš Luňák WindowSP registers_window_sp = m_window_sp->FindSubWindow("Registers"); 44402f1b24b7SLuboš Luňák WindowSP threads_window_sp = m_window_sp->FindSubWindow("Threads"); 44412f1b24b7SLuboš Luňák 44422f1b24b7SLuboš Luňák Rect threads_bounds; 44432f1b24b7SLuboš Luňák Rect source_variables_bounds; 44442f1b24b7SLuboš Luňák content_bounds.VerticalSplitPercentage(0.80, source_variables_bounds, 44452f1b24b7SLuboš Luňák threads_bounds); 44462f1b24b7SLuboš Luňák if (threads_window_sp) 44472f1b24b7SLuboš Luňák threads_window_sp->SetBounds(threads_bounds); 44482f1b24b7SLuboš Luňák else 44492f1b24b7SLuboš Luňák source_variables_bounds = content_bounds; 44502f1b24b7SLuboš Luňák 44512f1b24b7SLuboš Luňák Rect source_bounds; 44522f1b24b7SLuboš Luňák Rect variables_registers_bounds; 44532f1b24b7SLuboš Luňák source_variables_bounds.HorizontalSplitPercentage( 44542f1b24b7SLuboš Luňák 0.70, source_bounds, variables_registers_bounds); 44552f1b24b7SLuboš Luňák if (variables_window_sp || registers_window_sp) { 44562f1b24b7SLuboš Luňák if (variables_window_sp && registers_window_sp) { 44572f1b24b7SLuboš Luňák Rect variables_bounds; 44582f1b24b7SLuboš Luňák Rect registers_bounds; 44592f1b24b7SLuboš Luňák variables_registers_bounds.VerticalSplitPercentage( 44602f1b24b7SLuboš Luňák 0.50, variables_bounds, registers_bounds); 44612f1b24b7SLuboš Luňák variables_window_sp->SetBounds(variables_bounds); 44622f1b24b7SLuboš Luňák registers_window_sp->SetBounds(registers_bounds); 44632f1b24b7SLuboš Luňák } else if (variables_window_sp) { 44642f1b24b7SLuboš Luňák variables_window_sp->SetBounds(variables_registers_bounds); 44652f1b24b7SLuboš Luňák } else { 44662f1b24b7SLuboš Luňák registers_window_sp->SetBounds(variables_registers_bounds); 44672f1b24b7SLuboš Luňák } 44682f1b24b7SLuboš Luňák } else { 44692f1b24b7SLuboš Luňák source_bounds = source_variables_bounds; 44702f1b24b7SLuboš Luňák } 44712f1b24b7SLuboš Luňák 44722f1b24b7SLuboš Luňák source_window_sp->SetBounds(source_bounds); 44732f1b24b7SLuboš Luňák 44742f1b24b7SLuboš Luňák touchwin(stdscr); 44752f1b24b7SLuboš Luňák redrawwin(m_window_sp->get()); 44762f1b24b7SLuboš Luňák m_update_screen = true; 44772f1b24b7SLuboš Luňák } 44782f1b24b7SLuboš Luňák 44797caa17caSRaphael Isemann protected: 44807caa17caSRaphael Isemann WindowSP m_window_sp; 44817caa17caSRaphael Isemann WindowDelegates m_window_delegates; 44827caa17caSRaphael Isemann SCREEN *m_screen; 44837caa17caSRaphael Isemann FILE *m_in; 44847caa17caSRaphael Isemann FILE *m_out; 44852f1b24b7SLuboš Luňák bool m_update_screen = false; 44867caa17caSRaphael Isemann }; 44877caa17caSRaphael Isemann 44887caa17caSRaphael Isemann } // namespace curses 44897caa17caSRaphael Isemann 44907caa17caSRaphael Isemann using namespace curses; 44917caa17caSRaphael Isemann 44927caa17caSRaphael Isemann struct Row { 44934631afdeSRaphael Isemann ValueObjectUpdater value; 44947caa17caSRaphael Isemann Row *parent; 44957caa17caSRaphael Isemann // The process stop ID when the children were calculated. 4496f7e04b71SJordan Rupprecht uint32_t children_stop_id = 0; 4497f7e04b71SJordan Rupprecht int row_idx = 0; 4498f7e04b71SJordan Rupprecht int x = 1; 4499f7e04b71SJordan Rupprecht int y = 1; 45007caa17caSRaphael Isemann bool might_have_children; 4501f7e04b71SJordan Rupprecht bool expanded = false; 4502f7e04b71SJordan Rupprecht bool calculated_children = false; 45037caa17caSRaphael Isemann std::vector<Row> children; 45047caa17caSRaphael Isemann 45057caa17caSRaphael Isemann Row(const ValueObjectSP &v, Row *p) 45064631afdeSRaphael Isemann : value(v), parent(p), 4507f7e04b71SJordan Rupprecht might_have_children(v ? v->MightHaveChildren() : false) {} 45087caa17caSRaphael Isemann 45097caa17caSRaphael Isemann size_t GetDepth() const { 45107caa17caSRaphael Isemann if (parent) 45117caa17caSRaphael Isemann return 1 + parent->GetDepth(); 45127caa17caSRaphael Isemann return 0; 45137caa17caSRaphael Isemann } 45147caa17caSRaphael Isemann 45157caa17caSRaphael Isemann void Expand() { expanded = true; } 45167caa17caSRaphael Isemann 45177caa17caSRaphael Isemann std::vector<Row> &GetChildren() { 45187caa17caSRaphael Isemann ProcessSP process_sp = value.GetProcessSP(); 45197caa17caSRaphael Isemann auto stop_id = process_sp->GetStopID(); 45207caa17caSRaphael Isemann if (process_sp && stop_id != children_stop_id) { 45217caa17caSRaphael Isemann children_stop_id = stop_id; 45227caa17caSRaphael Isemann calculated_children = false; 45237caa17caSRaphael Isemann } 45247caa17caSRaphael Isemann if (!calculated_children) { 45257caa17caSRaphael Isemann children.clear(); 45267caa17caSRaphael Isemann calculated_children = true; 45277caa17caSRaphael Isemann ValueObjectSP valobj = value.GetSP(); 45287caa17caSRaphael Isemann if (valobj) { 45297caa17caSRaphael Isemann const size_t num_children = valobj->GetNumChildren(); 45307caa17caSRaphael Isemann for (size_t i = 0; i < num_children; ++i) { 45317caa17caSRaphael Isemann children.push_back(Row(valobj->GetChildAtIndex(i, true), this)); 45327caa17caSRaphael Isemann } 45337caa17caSRaphael Isemann } 45347caa17caSRaphael Isemann } 45357caa17caSRaphael Isemann return children; 45367caa17caSRaphael Isemann } 45377caa17caSRaphael Isemann 45387caa17caSRaphael Isemann void Unexpand() { 45397caa17caSRaphael Isemann expanded = false; 45407caa17caSRaphael Isemann calculated_children = false; 45417caa17caSRaphael Isemann children.clear(); 45427caa17caSRaphael Isemann } 45437caa17caSRaphael Isemann 45447caa17caSRaphael Isemann void DrawTree(Window &window) { 45457caa17caSRaphael Isemann if (parent) 45467caa17caSRaphael Isemann parent->DrawTreeForChild(window, this, 0); 45477caa17caSRaphael Isemann 45487caa17caSRaphael Isemann if (might_have_children) { 45497caa17caSRaphael Isemann // It we can get UTF8 characters to work we should try to use the 45507caa17caSRaphael Isemann // "symbol" UTF8 string below 45517caa17caSRaphael Isemann // const char *symbol = ""; 45527caa17caSRaphael Isemann // if (row.expanded) 45537caa17caSRaphael Isemann // symbol = "\xe2\x96\xbd "; 45547caa17caSRaphael Isemann // else 45557caa17caSRaphael Isemann // symbol = "\xe2\x96\xb7 "; 45567caa17caSRaphael Isemann // window.PutCString (symbol); 45577caa17caSRaphael Isemann 45587caa17caSRaphael Isemann // The ACS_DARROW and ACS_RARROW don't look very nice they are just a 'v' 45597caa17caSRaphael Isemann // or '>' character... 45607caa17caSRaphael Isemann // if (expanded) 45617caa17caSRaphael Isemann // window.PutChar (ACS_DARROW); 45627caa17caSRaphael Isemann // else 45637caa17caSRaphael Isemann // window.PutChar (ACS_RARROW); 45647caa17caSRaphael Isemann // Since we can't find any good looking right arrow/down arrow symbols, 45657caa17caSRaphael Isemann // just use a diamond... 45667caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 45677caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 45687caa17caSRaphael Isemann } 45697caa17caSRaphael Isemann } 45707caa17caSRaphael Isemann 45717caa17caSRaphael Isemann void DrawTreeForChild(Window &window, Row *child, uint32_t reverse_depth) { 45727caa17caSRaphael Isemann if (parent) 45737caa17caSRaphael Isemann parent->DrawTreeForChild(window, this, reverse_depth + 1); 45747caa17caSRaphael Isemann 45757caa17caSRaphael Isemann if (&GetChildren().back() == child) { 45767caa17caSRaphael Isemann // Last child 45777caa17caSRaphael Isemann if (reverse_depth == 0) { 45787caa17caSRaphael Isemann window.PutChar(ACS_LLCORNER); 45797caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 45807caa17caSRaphael Isemann } else { 45817caa17caSRaphael Isemann window.PutChar(' '); 45827caa17caSRaphael Isemann window.PutChar(' '); 45837caa17caSRaphael Isemann } 45847caa17caSRaphael Isemann } else { 45857caa17caSRaphael Isemann if (reverse_depth == 0) { 45867caa17caSRaphael Isemann window.PutChar(ACS_LTEE); 45877caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 45887caa17caSRaphael Isemann } else { 45897caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 45907caa17caSRaphael Isemann window.PutChar(' '); 45917caa17caSRaphael Isemann } 45927caa17caSRaphael Isemann } 45937caa17caSRaphael Isemann } 45947caa17caSRaphael Isemann }; 45957caa17caSRaphael Isemann 45967caa17caSRaphael Isemann struct DisplayOptions { 45977caa17caSRaphael Isemann bool show_types; 45987caa17caSRaphael Isemann }; 45997caa17caSRaphael Isemann 46007caa17caSRaphael Isemann class TreeItem; 46017caa17caSRaphael Isemann 46027caa17caSRaphael Isemann class TreeDelegate { 46037caa17caSRaphael Isemann public: 46047caa17caSRaphael Isemann TreeDelegate() = default; 46057caa17caSRaphael Isemann virtual ~TreeDelegate() = default; 46067caa17caSRaphael Isemann 46077caa17caSRaphael Isemann virtual void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) = 0; 46087caa17caSRaphael Isemann virtual void TreeDelegateGenerateChildren(TreeItem &item) = 0; 4609a94fbb25SMuhammad Omair Javaid virtual void TreeDelegateUpdateSelection(TreeItem &root, int &selection_index, 4610a94fbb25SMuhammad Omair Javaid TreeItem *&selected_item) { 4611a94fbb25SMuhammad Omair Javaid return; 4612a94fbb25SMuhammad Omair Javaid } 4613b26e1efcSOmar Emara // This is invoked when a tree item is selected. If true is returned, the 4614b26e1efcSOmar Emara // views are updated. 4615b26e1efcSOmar Emara virtual bool TreeDelegateItemSelected(TreeItem &item) = 0; 4616a94fbb25SMuhammad Omair Javaid virtual bool TreeDelegateExpandRootByDefault() { return false; } 4617b26e1efcSOmar Emara // This is mostly useful for root tree delegates. If false is returned, 4618b26e1efcSOmar Emara // drawing will be skipped completely. This is needed, for instance, in 4619b26e1efcSOmar Emara // skipping drawing of the threads tree if there is no running process. 4620b26e1efcSOmar Emara virtual bool TreeDelegateShouldDraw() { return true; } 46217caa17caSRaphael Isemann }; 46227caa17caSRaphael Isemann 46237caa17caSRaphael Isemann typedef std::shared_ptr<TreeDelegate> TreeDelegateSP; 46247caa17caSRaphael Isemann 46257caa17caSRaphael Isemann class TreeItem { 46267caa17caSRaphael Isemann public: 46277caa17caSRaphael Isemann TreeItem(TreeItem *parent, TreeDelegate &delegate, bool might_have_children) 46287caa17caSRaphael Isemann : m_parent(parent), m_delegate(delegate), m_user_data(nullptr), 46297caa17caSRaphael Isemann m_identifier(0), m_row_idx(-1), m_children(), 4630a94fbb25SMuhammad Omair Javaid m_might_have_children(might_have_children), m_is_expanded(false) { 4631a94fbb25SMuhammad Omair Javaid if (m_parent == nullptr) 4632a94fbb25SMuhammad Omair Javaid m_is_expanded = m_delegate.TreeDelegateExpandRootByDefault(); 4633a94fbb25SMuhammad Omair Javaid } 46347caa17caSRaphael Isemann 46357caa17caSRaphael Isemann TreeItem &operator=(const TreeItem &rhs) { 46367caa17caSRaphael Isemann if (this != &rhs) { 46377caa17caSRaphael Isemann m_parent = rhs.m_parent; 46387caa17caSRaphael Isemann m_delegate = rhs.m_delegate; 46397caa17caSRaphael Isemann m_user_data = rhs.m_user_data; 46407caa17caSRaphael Isemann m_identifier = rhs.m_identifier; 46417caa17caSRaphael Isemann m_row_idx = rhs.m_row_idx; 46427caa17caSRaphael Isemann m_children = rhs.m_children; 46437caa17caSRaphael Isemann m_might_have_children = rhs.m_might_have_children; 46447caa17caSRaphael Isemann m_is_expanded = rhs.m_is_expanded; 46457caa17caSRaphael Isemann } 46467caa17caSRaphael Isemann return *this; 46477caa17caSRaphael Isemann } 46487caa17caSRaphael Isemann 46495312139fSEric Christopher TreeItem(const TreeItem &) = default; 46505312139fSEric Christopher 46517caa17caSRaphael Isemann size_t GetDepth() const { 46527caa17caSRaphael Isemann if (m_parent) 46537caa17caSRaphael Isemann return 1 + m_parent->GetDepth(); 46547caa17caSRaphael Isemann return 0; 46557caa17caSRaphael Isemann } 46567caa17caSRaphael Isemann 46577caa17caSRaphael Isemann int GetRowIndex() const { return m_row_idx; } 46587caa17caSRaphael Isemann 46597caa17caSRaphael Isemann void ClearChildren() { m_children.clear(); } 46607caa17caSRaphael Isemann 46617caa17caSRaphael Isemann void Resize(size_t n, const TreeItem &t) { m_children.resize(n, t); } 46627caa17caSRaphael Isemann 46637caa17caSRaphael Isemann TreeItem &operator[](size_t i) { return m_children[i]; } 46647caa17caSRaphael Isemann 46657caa17caSRaphael Isemann void SetRowIndex(int row_idx) { m_row_idx = row_idx; } 46667caa17caSRaphael Isemann 46677caa17caSRaphael Isemann size_t GetNumChildren() { 46687caa17caSRaphael Isemann m_delegate.TreeDelegateGenerateChildren(*this); 46697caa17caSRaphael Isemann return m_children.size(); 46707caa17caSRaphael Isemann } 46717caa17caSRaphael Isemann 46727caa17caSRaphael Isemann void ItemWasSelected() { m_delegate.TreeDelegateItemSelected(*this); } 46737caa17caSRaphael Isemann 46747caa17caSRaphael Isemann void CalculateRowIndexes(int &row_idx) { 46757caa17caSRaphael Isemann SetRowIndex(row_idx); 46767caa17caSRaphael Isemann ++row_idx; 46777caa17caSRaphael Isemann 46787caa17caSRaphael Isemann const bool expanded = IsExpanded(); 46797caa17caSRaphael Isemann 46807caa17caSRaphael Isemann // The root item must calculate its children, or we must calculate the 46817caa17caSRaphael Isemann // number of children if the item is expanded 46827caa17caSRaphael Isemann if (m_parent == nullptr || expanded) 46837caa17caSRaphael Isemann GetNumChildren(); 46847caa17caSRaphael Isemann 46857caa17caSRaphael Isemann for (auto &item : m_children) { 46867caa17caSRaphael Isemann if (expanded) 46877caa17caSRaphael Isemann item.CalculateRowIndexes(row_idx); 46887caa17caSRaphael Isemann else 46897caa17caSRaphael Isemann item.SetRowIndex(-1); 46907caa17caSRaphael Isemann } 46917caa17caSRaphael Isemann } 46927caa17caSRaphael Isemann 46937caa17caSRaphael Isemann TreeItem *GetParent() { return m_parent; } 46947caa17caSRaphael Isemann 46957caa17caSRaphael Isemann bool IsExpanded() const { return m_is_expanded; } 46967caa17caSRaphael Isemann 46977caa17caSRaphael Isemann void Expand() { m_is_expanded = true; } 46987caa17caSRaphael Isemann 46997caa17caSRaphael Isemann void Unexpand() { m_is_expanded = false; } 47007caa17caSRaphael Isemann 47017caa17caSRaphael Isemann bool Draw(Window &window, const int first_visible_row, 47027caa17caSRaphael Isemann const uint32_t selected_row_idx, int &row_idx, int &num_rows_left) { 47037caa17caSRaphael Isemann if (num_rows_left <= 0) 47047caa17caSRaphael Isemann return false; 47057caa17caSRaphael Isemann 47067caa17caSRaphael Isemann if (m_row_idx >= first_visible_row) { 47077caa17caSRaphael Isemann window.MoveCursor(2, row_idx + 1); 47087caa17caSRaphael Isemann 47097caa17caSRaphael Isemann if (m_parent) 47107caa17caSRaphael Isemann m_parent->DrawTreeForChild(window, this, 0); 47117caa17caSRaphael Isemann 47127caa17caSRaphael Isemann if (m_might_have_children) { 47137caa17caSRaphael Isemann // It we can get UTF8 characters to work we should try to use the 47147caa17caSRaphael Isemann // "symbol" UTF8 string below 47157caa17caSRaphael Isemann // const char *symbol = ""; 47167caa17caSRaphael Isemann // if (row.expanded) 47177caa17caSRaphael Isemann // symbol = "\xe2\x96\xbd "; 47187caa17caSRaphael Isemann // else 47197caa17caSRaphael Isemann // symbol = "\xe2\x96\xb7 "; 47207caa17caSRaphael Isemann // window.PutCString (symbol); 47217caa17caSRaphael Isemann 47227caa17caSRaphael Isemann // The ACS_DARROW and ACS_RARROW don't look very nice they are just a 47237caa17caSRaphael Isemann // 'v' or '>' character... 47247caa17caSRaphael Isemann // if (expanded) 47257caa17caSRaphael Isemann // window.PutChar (ACS_DARROW); 47267caa17caSRaphael Isemann // else 47277caa17caSRaphael Isemann // window.PutChar (ACS_RARROW); 47287caa17caSRaphael Isemann // Since we can't find any good looking right arrow/down arrow symbols, 47297caa17caSRaphael Isemann // just use a diamond... 47307caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 47317caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 47327caa17caSRaphael Isemann } 47337caa17caSRaphael Isemann bool highlight = (selected_row_idx == static_cast<size_t>(m_row_idx)) && 47347caa17caSRaphael Isemann window.IsActive(); 47357caa17caSRaphael Isemann 47367caa17caSRaphael Isemann if (highlight) 47377caa17caSRaphael Isemann window.AttributeOn(A_REVERSE); 47387caa17caSRaphael Isemann 47397caa17caSRaphael Isemann m_delegate.TreeDelegateDrawTreeItem(*this, window); 47407caa17caSRaphael Isemann 47417caa17caSRaphael Isemann if (highlight) 47427caa17caSRaphael Isemann window.AttributeOff(A_REVERSE); 47437caa17caSRaphael Isemann ++row_idx; 47447caa17caSRaphael Isemann --num_rows_left; 47457caa17caSRaphael Isemann } 47467caa17caSRaphael Isemann 47477caa17caSRaphael Isemann if (num_rows_left <= 0) 47487caa17caSRaphael Isemann return false; // We are done drawing... 47497caa17caSRaphael Isemann 47507caa17caSRaphael Isemann if (IsExpanded()) { 47517caa17caSRaphael Isemann for (auto &item : m_children) { 47527caa17caSRaphael Isemann // If we displayed all the rows and item.Draw() returns false we are 47537caa17caSRaphael Isemann // done drawing and can exit this for loop 47547caa17caSRaphael Isemann if (!item.Draw(window, first_visible_row, selected_row_idx, row_idx, 47557caa17caSRaphael Isemann num_rows_left)) 47567caa17caSRaphael Isemann break; 47577caa17caSRaphael Isemann } 47587caa17caSRaphael Isemann } 47597caa17caSRaphael Isemann return num_rows_left >= 0; // Return true if not done drawing yet 47607caa17caSRaphael Isemann } 47617caa17caSRaphael Isemann 47627caa17caSRaphael Isemann void DrawTreeForChild(Window &window, TreeItem *child, 47637caa17caSRaphael Isemann uint32_t reverse_depth) { 47647caa17caSRaphael Isemann if (m_parent) 47657caa17caSRaphael Isemann m_parent->DrawTreeForChild(window, this, reverse_depth + 1); 47667caa17caSRaphael Isemann 47677caa17caSRaphael Isemann if (&m_children.back() == child) { 47687caa17caSRaphael Isemann // Last child 47697caa17caSRaphael Isemann if (reverse_depth == 0) { 47707caa17caSRaphael Isemann window.PutChar(ACS_LLCORNER); 47717caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 47727caa17caSRaphael Isemann } else { 47737caa17caSRaphael Isemann window.PutChar(' '); 47747caa17caSRaphael Isemann window.PutChar(' '); 47757caa17caSRaphael Isemann } 47767caa17caSRaphael Isemann } else { 47777caa17caSRaphael Isemann if (reverse_depth == 0) { 47787caa17caSRaphael Isemann window.PutChar(ACS_LTEE); 47797caa17caSRaphael Isemann window.PutChar(ACS_HLINE); 47807caa17caSRaphael Isemann } else { 47817caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 47827caa17caSRaphael Isemann window.PutChar(' '); 47837caa17caSRaphael Isemann } 47847caa17caSRaphael Isemann } 47857caa17caSRaphael Isemann } 47867caa17caSRaphael Isemann 47877caa17caSRaphael Isemann TreeItem *GetItemForRowIndex(uint32_t row_idx) { 47887caa17caSRaphael Isemann if (static_cast<uint32_t>(m_row_idx) == row_idx) 47897caa17caSRaphael Isemann return this; 47907caa17caSRaphael Isemann if (m_children.empty()) 47917caa17caSRaphael Isemann return nullptr; 47927caa17caSRaphael Isemann if (IsExpanded()) { 47937caa17caSRaphael Isemann for (auto &item : m_children) { 47947caa17caSRaphael Isemann TreeItem *selected_item_ptr = item.GetItemForRowIndex(row_idx); 47957caa17caSRaphael Isemann if (selected_item_ptr) 47967caa17caSRaphael Isemann return selected_item_ptr; 47977caa17caSRaphael Isemann } 47987caa17caSRaphael Isemann } 47997caa17caSRaphael Isemann return nullptr; 48007caa17caSRaphael Isemann } 48017caa17caSRaphael Isemann 48027caa17caSRaphael Isemann void *GetUserData() const { return m_user_data; } 48037caa17caSRaphael Isemann 48047caa17caSRaphael Isemann void SetUserData(void *user_data) { m_user_data = user_data; } 48057caa17caSRaphael Isemann 48067caa17caSRaphael Isemann uint64_t GetIdentifier() const { return m_identifier; } 48077caa17caSRaphael Isemann 48087caa17caSRaphael Isemann void SetIdentifier(uint64_t identifier) { m_identifier = identifier; } 48097caa17caSRaphael Isemann 4810b26e1efcSOmar Emara const std::string &GetText() const { return m_text; } 4811b26e1efcSOmar Emara 4812b26e1efcSOmar Emara void SetText(const char *text) { 4813b26e1efcSOmar Emara if (text == nullptr) { 4814b26e1efcSOmar Emara m_text.clear(); 4815b26e1efcSOmar Emara return; 4816b26e1efcSOmar Emara } 4817b26e1efcSOmar Emara m_text = text; 4818b26e1efcSOmar Emara } 4819b26e1efcSOmar Emara 48207caa17caSRaphael Isemann void SetMightHaveChildren(bool b) { m_might_have_children = b; } 48217caa17caSRaphael Isemann 48227caa17caSRaphael Isemann protected: 48237caa17caSRaphael Isemann TreeItem *m_parent; 48247caa17caSRaphael Isemann TreeDelegate &m_delegate; 48257caa17caSRaphael Isemann void *m_user_data; 48267caa17caSRaphael Isemann uint64_t m_identifier; 4827b26e1efcSOmar Emara std::string m_text; 48287caa17caSRaphael Isemann int m_row_idx; // Zero based visible row index, -1 if not visible or for the 48297caa17caSRaphael Isemann // root item 48307caa17caSRaphael Isemann std::vector<TreeItem> m_children; 48317caa17caSRaphael Isemann bool m_might_have_children; 48327caa17caSRaphael Isemann bool m_is_expanded; 48337caa17caSRaphael Isemann }; 48347caa17caSRaphael Isemann 48357caa17caSRaphael Isemann class TreeWindowDelegate : public WindowDelegate { 48367caa17caSRaphael Isemann public: 48377caa17caSRaphael Isemann TreeWindowDelegate(Debugger &debugger, const TreeDelegateSP &delegate_sp) 48387caa17caSRaphael Isemann : m_debugger(debugger), m_delegate_sp(delegate_sp), 48397caa17caSRaphael Isemann m_root(nullptr, *delegate_sp, true), m_selected_item(nullptr), 48407caa17caSRaphael Isemann m_num_rows(0), m_selected_row_idx(0), m_first_visible_row(0), 48417caa17caSRaphael Isemann m_min_x(0), m_min_y(0), m_max_x(0), m_max_y(0) {} 48427caa17caSRaphael Isemann 48437caa17caSRaphael Isemann int NumVisibleRows() const { return m_max_y - m_min_y; } 48447caa17caSRaphael Isemann 48457caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 48467caa17caSRaphael Isemann m_min_x = 2; 48477caa17caSRaphael Isemann m_min_y = 1; 48487caa17caSRaphael Isemann m_max_x = window.GetWidth() - 1; 48497caa17caSRaphael Isemann m_max_y = window.GetHeight() - 1; 48507caa17caSRaphael Isemann 48517caa17caSRaphael Isemann window.Erase(); 48527caa17caSRaphael Isemann window.DrawTitleBox(window.GetName()); 48537caa17caSRaphael Isemann 4854b26e1efcSOmar Emara if (!m_delegate_sp->TreeDelegateShouldDraw()) { 4855b26e1efcSOmar Emara m_selected_item = nullptr; 4856b26e1efcSOmar Emara return true; 4857b26e1efcSOmar Emara } 4858b26e1efcSOmar Emara 48597caa17caSRaphael Isemann const int num_visible_rows = NumVisibleRows(); 48607caa17caSRaphael Isemann m_num_rows = 0; 48617caa17caSRaphael Isemann m_root.CalculateRowIndexes(m_num_rows); 4862a94fbb25SMuhammad Omair Javaid m_delegate_sp->TreeDelegateUpdateSelection(m_root, m_selected_row_idx, 4863a94fbb25SMuhammad Omair Javaid m_selected_item); 48647caa17caSRaphael Isemann 48657caa17caSRaphael Isemann // If we unexpanded while having something selected our total number of 48667caa17caSRaphael Isemann // rows is less than the num visible rows, then make sure we show all the 48677caa17caSRaphael Isemann // rows by setting the first visible row accordingly. 48687caa17caSRaphael Isemann if (m_first_visible_row > 0 && m_num_rows < num_visible_rows) 48697caa17caSRaphael Isemann m_first_visible_row = 0; 48707caa17caSRaphael Isemann 48717caa17caSRaphael Isemann // Make sure the selected row is always visible 48727caa17caSRaphael Isemann if (m_selected_row_idx < m_first_visible_row) 48737caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx; 48747caa17caSRaphael Isemann else if (m_first_visible_row + num_visible_rows <= m_selected_row_idx) 48757caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx - num_visible_rows + 1; 48767caa17caSRaphael Isemann 48777caa17caSRaphael Isemann int row_idx = 0; 48787caa17caSRaphael Isemann int num_rows_left = num_visible_rows; 48797caa17caSRaphael Isemann m_root.Draw(window, m_first_visible_row, m_selected_row_idx, row_idx, 48807caa17caSRaphael Isemann num_rows_left); 48817caa17caSRaphael Isemann // Get the selected row 48827caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 48837caa17caSRaphael Isemann 48847caa17caSRaphael Isemann return true; // Drawing handled 48857caa17caSRaphael Isemann } 48867caa17caSRaphael Isemann 48877caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 48887caa17caSRaphael Isemann return "Thread window keyboard shortcuts:"; 48897caa17caSRaphael Isemann } 48907caa17caSRaphael Isemann 48917caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 48927caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 48937caa17caSRaphael Isemann {KEY_UP, "Select previous item"}, 48947caa17caSRaphael Isemann {KEY_DOWN, "Select next item"}, 48957caa17caSRaphael Isemann {KEY_RIGHT, "Expand the selected item"}, 48967caa17caSRaphael Isemann {KEY_LEFT, 48977caa17caSRaphael Isemann "Unexpand the selected item or select parent if not expanded"}, 48987caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 48997caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 49007caa17caSRaphael Isemann {'h', "Show help dialog"}, 49017caa17caSRaphael Isemann {' ', "Toggle item expansion"}, 49027caa17caSRaphael Isemann {',', "Page up"}, 49037caa17caSRaphael Isemann {'.', "Page down"}, 49047caa17caSRaphael Isemann {'\0', nullptr}}; 49057caa17caSRaphael Isemann return g_source_view_key_help; 49067caa17caSRaphael Isemann } 49077caa17caSRaphael Isemann 49087caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int c) override { 49097caa17caSRaphael Isemann switch (c) { 49107caa17caSRaphael Isemann case ',': 49117caa17caSRaphael Isemann case KEY_PPAGE: 49127caa17caSRaphael Isemann // Page up key 49137caa17caSRaphael Isemann if (m_first_visible_row > 0) { 49147caa17caSRaphael Isemann if (m_first_visible_row > m_max_y) 49157caa17caSRaphael Isemann m_first_visible_row -= m_max_y; 49167caa17caSRaphael Isemann else 49177caa17caSRaphael Isemann m_first_visible_row = 0; 49187caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 49197caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49207caa17caSRaphael Isemann if (m_selected_item) 49217caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49227caa17caSRaphael Isemann } 49237caa17caSRaphael Isemann return eKeyHandled; 49247caa17caSRaphael Isemann 49257caa17caSRaphael Isemann case '.': 49267caa17caSRaphael Isemann case KEY_NPAGE: 49277caa17caSRaphael Isemann // Page down key 49287caa17caSRaphael Isemann if (m_num_rows > m_max_y) { 49297caa17caSRaphael Isemann if (m_first_visible_row + m_max_y < m_num_rows) { 49307caa17caSRaphael Isemann m_first_visible_row += m_max_y; 49317caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 49327caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49337caa17caSRaphael Isemann if (m_selected_item) 49347caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49357caa17caSRaphael Isemann } 49367caa17caSRaphael Isemann } 49377caa17caSRaphael Isemann return eKeyHandled; 49387caa17caSRaphael Isemann 49397caa17caSRaphael Isemann case KEY_UP: 49407caa17caSRaphael Isemann if (m_selected_row_idx > 0) { 49417caa17caSRaphael Isemann --m_selected_row_idx; 49427caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49437caa17caSRaphael Isemann if (m_selected_item) 49447caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49457caa17caSRaphael Isemann } 49467caa17caSRaphael Isemann return eKeyHandled; 49477caa17caSRaphael Isemann 49487caa17caSRaphael Isemann case KEY_DOWN: 49497caa17caSRaphael Isemann if (m_selected_row_idx + 1 < m_num_rows) { 49507caa17caSRaphael Isemann ++m_selected_row_idx; 49517caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49527caa17caSRaphael Isemann if (m_selected_item) 49537caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49547caa17caSRaphael Isemann } 49557caa17caSRaphael Isemann return eKeyHandled; 49567caa17caSRaphael Isemann 49577caa17caSRaphael Isemann case KEY_RIGHT: 49587caa17caSRaphael Isemann if (m_selected_item) { 49597caa17caSRaphael Isemann if (!m_selected_item->IsExpanded()) 49607caa17caSRaphael Isemann m_selected_item->Expand(); 49617caa17caSRaphael Isemann } 49627caa17caSRaphael Isemann return eKeyHandled; 49637caa17caSRaphael Isemann 49647caa17caSRaphael Isemann case KEY_LEFT: 49657caa17caSRaphael Isemann if (m_selected_item) { 49667caa17caSRaphael Isemann if (m_selected_item->IsExpanded()) 49677caa17caSRaphael Isemann m_selected_item->Unexpand(); 49687caa17caSRaphael Isemann else if (m_selected_item->GetParent()) { 49697caa17caSRaphael Isemann m_selected_row_idx = m_selected_item->GetParent()->GetRowIndex(); 49707caa17caSRaphael Isemann m_selected_item = m_root.GetItemForRowIndex(m_selected_row_idx); 49717caa17caSRaphael Isemann if (m_selected_item) 49727caa17caSRaphael Isemann m_selected_item->ItemWasSelected(); 49737caa17caSRaphael Isemann } 49747caa17caSRaphael Isemann } 49757caa17caSRaphael Isemann return eKeyHandled; 49767caa17caSRaphael Isemann 49777caa17caSRaphael Isemann case ' ': 49787caa17caSRaphael Isemann // Toggle expansion state when SPACE is pressed 49797caa17caSRaphael Isemann if (m_selected_item) { 49807caa17caSRaphael Isemann if (m_selected_item->IsExpanded()) 49817caa17caSRaphael Isemann m_selected_item->Unexpand(); 49827caa17caSRaphael Isemann else 49837caa17caSRaphael Isemann m_selected_item->Expand(); 49847caa17caSRaphael Isemann } 49857caa17caSRaphael Isemann return eKeyHandled; 49867caa17caSRaphael Isemann 49877caa17caSRaphael Isemann case 'h': 49887caa17caSRaphael Isemann window.CreateHelpSubwindow(); 49897caa17caSRaphael Isemann return eKeyHandled; 49907caa17caSRaphael Isemann 49917caa17caSRaphael Isemann default: 49927caa17caSRaphael Isemann break; 49937caa17caSRaphael Isemann } 49947caa17caSRaphael Isemann return eKeyNotHandled; 49957caa17caSRaphael Isemann } 49967caa17caSRaphael Isemann 49977caa17caSRaphael Isemann protected: 49987caa17caSRaphael Isemann Debugger &m_debugger; 49997caa17caSRaphael Isemann TreeDelegateSP m_delegate_sp; 50007caa17caSRaphael Isemann TreeItem m_root; 50017caa17caSRaphael Isemann TreeItem *m_selected_item; 50027caa17caSRaphael Isemann int m_num_rows; 50037caa17caSRaphael Isemann int m_selected_row_idx; 50047caa17caSRaphael Isemann int m_first_visible_row; 50057caa17caSRaphael Isemann int m_min_x; 50067caa17caSRaphael Isemann int m_min_y; 50077caa17caSRaphael Isemann int m_max_x; 50087caa17caSRaphael Isemann int m_max_y; 50097caa17caSRaphael Isemann }; 50107caa17caSRaphael Isemann 5011b26e1efcSOmar Emara // A tree delegate that just draws the text member of the tree item, it doesn't 5012b26e1efcSOmar Emara // have any children or actions. 5013b26e1efcSOmar Emara class TextTreeDelegate : public TreeDelegate { 5014b26e1efcSOmar Emara public: 5015b26e1efcSOmar Emara TextTreeDelegate() : TreeDelegate() {} 5016b26e1efcSOmar Emara 5017b26e1efcSOmar Emara ~TextTreeDelegate() override = default; 5018b26e1efcSOmar Emara 5019b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5020b26e1efcSOmar Emara window.PutCStringTruncated(1, item.GetText().c_str()); 5021b26e1efcSOmar Emara } 5022b26e1efcSOmar Emara 5023b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override {} 5024b26e1efcSOmar Emara 5025b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5026b26e1efcSOmar Emara }; 5027b26e1efcSOmar Emara 50287caa17caSRaphael Isemann class FrameTreeDelegate : public TreeDelegate { 50297caa17caSRaphael Isemann public: 50307caa17caSRaphael Isemann FrameTreeDelegate() : TreeDelegate() { 50317caa17caSRaphael Isemann FormatEntity::Parse( 50327caa17caSRaphael Isemann "frame #${frame.index}: {${function.name}${function.pc-offset}}}", 50337caa17caSRaphael Isemann m_format); 50347caa17caSRaphael Isemann } 50357caa17caSRaphael Isemann 50367caa17caSRaphael Isemann ~FrameTreeDelegate() override = default; 50377caa17caSRaphael Isemann 50387caa17caSRaphael Isemann void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 50397caa17caSRaphael Isemann Thread *thread = (Thread *)item.GetUserData(); 50407caa17caSRaphael Isemann if (thread) { 50417caa17caSRaphael Isemann const uint64_t frame_idx = item.GetIdentifier(); 50427caa17caSRaphael Isemann StackFrameSP frame_sp = thread->GetStackFrameAtIndex(frame_idx); 50437caa17caSRaphael Isemann if (frame_sp) { 50447caa17caSRaphael Isemann StreamString strm; 50457caa17caSRaphael Isemann const SymbolContext &sc = 50467caa17caSRaphael Isemann frame_sp->GetSymbolContext(eSymbolContextEverything); 50477caa17caSRaphael Isemann ExecutionContext exe_ctx(frame_sp); 50487caa17caSRaphael Isemann if (FormatEntity::Format(m_format, strm, &sc, &exe_ctx, nullptr, 50497caa17caSRaphael Isemann nullptr, false, false)) { 50507caa17caSRaphael Isemann int right_pad = 1; 5051fc0e8fb7SLuboš Luňák window.PutCStringTruncated(right_pad, strm.GetString().str().c_str()); 50527caa17caSRaphael Isemann } 50537caa17caSRaphael Isemann } 50547caa17caSRaphael Isemann } 50557caa17caSRaphael Isemann } 50567caa17caSRaphael Isemann 50577caa17caSRaphael Isemann void TreeDelegateGenerateChildren(TreeItem &item) override { 50587caa17caSRaphael Isemann // No children for frames yet... 50597caa17caSRaphael Isemann } 50607caa17caSRaphael Isemann 50617caa17caSRaphael Isemann bool TreeDelegateItemSelected(TreeItem &item) override { 50627caa17caSRaphael Isemann Thread *thread = (Thread *)item.GetUserData(); 50637caa17caSRaphael Isemann if (thread) { 50647caa17caSRaphael Isemann thread->GetProcess()->GetThreadList().SetSelectedThreadByID( 50657caa17caSRaphael Isemann thread->GetID()); 50667caa17caSRaphael Isemann const uint64_t frame_idx = item.GetIdentifier(); 50677caa17caSRaphael Isemann thread->SetSelectedFrameByIndex(frame_idx); 50687caa17caSRaphael Isemann return true; 50697caa17caSRaphael Isemann } 50707caa17caSRaphael Isemann return false; 50717caa17caSRaphael Isemann } 50727caa17caSRaphael Isemann 50737caa17caSRaphael Isemann protected: 50747caa17caSRaphael Isemann FormatEntity::Entry m_format; 50757caa17caSRaphael Isemann }; 50767caa17caSRaphael Isemann 50777caa17caSRaphael Isemann class ThreadTreeDelegate : public TreeDelegate { 50787caa17caSRaphael Isemann public: 50797caa17caSRaphael Isemann ThreadTreeDelegate(Debugger &debugger) 50807caa17caSRaphael Isemann : TreeDelegate(), m_debugger(debugger), m_tid(LLDB_INVALID_THREAD_ID), 50817caa17caSRaphael Isemann m_stop_id(UINT32_MAX) { 50827caa17caSRaphael Isemann FormatEntity::Parse("thread #${thread.index}: tid = ${thread.id}{, stop " 50837caa17caSRaphael Isemann "reason = ${thread.stop-reason}}", 50847caa17caSRaphael Isemann m_format); 50857caa17caSRaphael Isemann } 50867caa17caSRaphael Isemann 50877caa17caSRaphael Isemann ~ThreadTreeDelegate() override = default; 50887caa17caSRaphael Isemann 50897caa17caSRaphael Isemann ProcessSP GetProcess() { 50907caa17caSRaphael Isemann return m_debugger.GetCommandInterpreter() 50917caa17caSRaphael Isemann .GetExecutionContext() 50927caa17caSRaphael Isemann .GetProcessSP(); 50937caa17caSRaphael Isemann } 50947caa17caSRaphael Isemann 50957caa17caSRaphael Isemann ThreadSP GetThread(const TreeItem &item) { 50967caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 50977caa17caSRaphael Isemann if (process_sp) 50987caa17caSRaphael Isemann return process_sp->GetThreadList().FindThreadByID(item.GetIdentifier()); 50997caa17caSRaphael Isemann return ThreadSP(); 51007caa17caSRaphael Isemann } 51017caa17caSRaphael Isemann 51027caa17caSRaphael Isemann void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 51037caa17caSRaphael Isemann ThreadSP thread_sp = GetThread(item); 51047caa17caSRaphael Isemann if (thread_sp) { 51057caa17caSRaphael Isemann StreamString strm; 51067caa17caSRaphael Isemann ExecutionContext exe_ctx(thread_sp); 51077caa17caSRaphael Isemann if (FormatEntity::Format(m_format, strm, nullptr, &exe_ctx, nullptr, 51087caa17caSRaphael Isemann nullptr, false, false)) { 51097caa17caSRaphael Isemann int right_pad = 1; 5110fc0e8fb7SLuboš Luňák window.PutCStringTruncated(right_pad, strm.GetString().str().c_str()); 51117caa17caSRaphael Isemann } 51127caa17caSRaphael Isemann } 51137caa17caSRaphael Isemann } 51147caa17caSRaphael Isemann 51157caa17caSRaphael Isemann void TreeDelegateGenerateChildren(TreeItem &item) override { 51167caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 51177caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 51187caa17caSRaphael Isemann StateType state = process_sp->GetState(); 51197caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 51207caa17caSRaphael Isemann ThreadSP thread_sp = GetThread(item); 51217caa17caSRaphael Isemann if (thread_sp) { 51227caa17caSRaphael Isemann if (m_stop_id == process_sp->GetStopID() && 51237caa17caSRaphael Isemann thread_sp->GetID() == m_tid) 51247caa17caSRaphael Isemann return; // Children are already up to date 51257caa17caSRaphael Isemann if (!m_frame_delegate_sp) { 51267caa17caSRaphael Isemann // Always expand the thread item the first time we show it 51277caa17caSRaphael Isemann m_frame_delegate_sp = std::make_shared<FrameTreeDelegate>(); 51287caa17caSRaphael Isemann } 51297caa17caSRaphael Isemann 51307caa17caSRaphael Isemann m_stop_id = process_sp->GetStopID(); 51317caa17caSRaphael Isemann m_tid = thread_sp->GetID(); 51327caa17caSRaphael Isemann 51337caa17caSRaphael Isemann TreeItem t(&item, *m_frame_delegate_sp, false); 51347caa17caSRaphael Isemann size_t num_frames = thread_sp->GetStackFrameCount(); 51357caa17caSRaphael Isemann item.Resize(num_frames, t); 51367caa17caSRaphael Isemann for (size_t i = 0; i < num_frames; ++i) { 51377caa17caSRaphael Isemann item[i].SetUserData(thread_sp.get()); 51387caa17caSRaphael Isemann item[i].SetIdentifier(i); 51397caa17caSRaphael Isemann } 51407caa17caSRaphael Isemann } 51417caa17caSRaphael Isemann return; 51427caa17caSRaphael Isemann } 51437caa17caSRaphael Isemann } 51447caa17caSRaphael Isemann item.ClearChildren(); 51457caa17caSRaphael Isemann } 51467caa17caSRaphael Isemann 51477caa17caSRaphael Isemann bool TreeDelegateItemSelected(TreeItem &item) override { 51487caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 51497caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 51507caa17caSRaphael Isemann StateType state = process_sp->GetState(); 51517caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 51527caa17caSRaphael Isemann ThreadSP thread_sp = GetThread(item); 51537caa17caSRaphael Isemann if (thread_sp) { 51547caa17caSRaphael Isemann ThreadList &thread_list = thread_sp->GetProcess()->GetThreadList(); 51557caa17caSRaphael Isemann std::lock_guard<std::recursive_mutex> guard(thread_list.GetMutex()); 51567caa17caSRaphael Isemann ThreadSP selected_thread_sp = thread_list.GetSelectedThread(); 51577caa17caSRaphael Isemann if (selected_thread_sp->GetID() != thread_sp->GetID()) { 51587caa17caSRaphael Isemann thread_list.SetSelectedThreadByID(thread_sp->GetID()); 51597caa17caSRaphael Isemann return true; 51607caa17caSRaphael Isemann } 51617caa17caSRaphael Isemann } 51627caa17caSRaphael Isemann } 51637caa17caSRaphael Isemann } 51647caa17caSRaphael Isemann return false; 51657caa17caSRaphael Isemann } 51667caa17caSRaphael Isemann 51677caa17caSRaphael Isemann protected: 51687caa17caSRaphael Isemann Debugger &m_debugger; 51697caa17caSRaphael Isemann std::shared_ptr<FrameTreeDelegate> m_frame_delegate_sp; 51707caa17caSRaphael Isemann lldb::user_id_t m_tid; 51717caa17caSRaphael Isemann uint32_t m_stop_id; 51727caa17caSRaphael Isemann FormatEntity::Entry m_format; 51737caa17caSRaphael Isemann }; 51747caa17caSRaphael Isemann 51757caa17caSRaphael Isemann class ThreadsTreeDelegate : public TreeDelegate { 51767caa17caSRaphael Isemann public: 51777caa17caSRaphael Isemann ThreadsTreeDelegate(Debugger &debugger) 51787caa17caSRaphael Isemann : TreeDelegate(), m_thread_delegate_sp(), m_debugger(debugger), 5179a94fbb25SMuhammad Omair Javaid m_stop_id(UINT32_MAX), m_update_selection(false) { 51807caa17caSRaphael Isemann FormatEntity::Parse("process ${process.id}{, name = ${process.name}}", 51817caa17caSRaphael Isemann m_format); 51827caa17caSRaphael Isemann } 51837caa17caSRaphael Isemann 51847caa17caSRaphael Isemann ~ThreadsTreeDelegate() override = default; 51857caa17caSRaphael Isemann 51867caa17caSRaphael Isemann ProcessSP GetProcess() { 51877caa17caSRaphael Isemann return m_debugger.GetCommandInterpreter() 51887caa17caSRaphael Isemann .GetExecutionContext() 51897caa17caSRaphael Isemann .GetProcessSP(); 51907caa17caSRaphael Isemann } 51917caa17caSRaphael Isemann 5192b26e1efcSOmar Emara bool TreeDelegateShouldDraw() override { 5193b26e1efcSOmar Emara ProcessSP process = GetProcess(); 5194b26e1efcSOmar Emara if (!process) 5195b26e1efcSOmar Emara return false; 5196b26e1efcSOmar Emara 5197b26e1efcSOmar Emara if (StateIsRunningState(process->GetState())) 5198b26e1efcSOmar Emara return false; 5199b26e1efcSOmar Emara 5200b26e1efcSOmar Emara return true; 5201b26e1efcSOmar Emara } 5202b26e1efcSOmar Emara 52037caa17caSRaphael Isemann void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 52047caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 52057caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 52067caa17caSRaphael Isemann StreamString strm; 52077caa17caSRaphael Isemann ExecutionContext exe_ctx(process_sp); 52087caa17caSRaphael Isemann if (FormatEntity::Format(m_format, strm, nullptr, &exe_ctx, nullptr, 52097caa17caSRaphael Isemann nullptr, false, false)) { 52107caa17caSRaphael Isemann int right_pad = 1; 5211fc0e8fb7SLuboš Luňák window.PutCStringTruncated(right_pad, strm.GetString().str().c_str()); 52127caa17caSRaphael Isemann } 52137caa17caSRaphael Isemann } 52147caa17caSRaphael Isemann } 52157caa17caSRaphael Isemann 52167caa17caSRaphael Isemann void TreeDelegateGenerateChildren(TreeItem &item) override { 52177caa17caSRaphael Isemann ProcessSP process_sp = GetProcess(); 5218a94fbb25SMuhammad Omair Javaid m_update_selection = false; 52197caa17caSRaphael Isemann if (process_sp && process_sp->IsAlive()) { 52207caa17caSRaphael Isemann StateType state = process_sp->GetState(); 52217caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 52227caa17caSRaphael Isemann const uint32_t stop_id = process_sp->GetStopID(); 52237caa17caSRaphael Isemann if (m_stop_id == stop_id) 52247caa17caSRaphael Isemann return; // Children are already up to date 52257caa17caSRaphael Isemann 52267caa17caSRaphael Isemann m_stop_id = stop_id; 5227a94fbb25SMuhammad Omair Javaid m_update_selection = true; 52287caa17caSRaphael Isemann 52297caa17caSRaphael Isemann if (!m_thread_delegate_sp) { 52307caa17caSRaphael Isemann // Always expand the thread item the first time we show it 52317caa17caSRaphael Isemann // item.Expand(); 52327caa17caSRaphael Isemann m_thread_delegate_sp = 52337caa17caSRaphael Isemann std::make_shared<ThreadTreeDelegate>(m_debugger); 52347caa17caSRaphael Isemann } 52357caa17caSRaphael Isemann 52367caa17caSRaphael Isemann TreeItem t(&item, *m_thread_delegate_sp, false); 52377caa17caSRaphael Isemann ThreadList &threads = process_sp->GetThreadList(); 52387caa17caSRaphael Isemann std::lock_guard<std::recursive_mutex> guard(threads.GetMutex()); 5239a94fbb25SMuhammad Omair Javaid ThreadSP selected_thread = threads.GetSelectedThread(); 52407caa17caSRaphael Isemann size_t num_threads = threads.GetSize(); 52417caa17caSRaphael Isemann item.Resize(num_threads, t); 52427caa17caSRaphael Isemann for (size_t i = 0; i < num_threads; ++i) { 5243a94fbb25SMuhammad Omair Javaid ThreadSP thread = threads.GetThreadAtIndex(i); 5244a94fbb25SMuhammad Omair Javaid item[i].SetIdentifier(thread->GetID()); 52457caa17caSRaphael Isemann item[i].SetMightHaveChildren(true); 5246a94fbb25SMuhammad Omair Javaid if (selected_thread->GetID() == thread->GetID()) 5247a94fbb25SMuhammad Omair Javaid item[i].Expand(); 52487caa17caSRaphael Isemann } 52497caa17caSRaphael Isemann return; 52507caa17caSRaphael Isemann } 52517caa17caSRaphael Isemann } 52527caa17caSRaphael Isemann item.ClearChildren(); 52537caa17caSRaphael Isemann } 52547caa17caSRaphael Isemann 5255a94fbb25SMuhammad Omair Javaid void TreeDelegateUpdateSelection(TreeItem &root, int &selection_index, 5256a94fbb25SMuhammad Omair Javaid TreeItem *&selected_item) override { 5257a94fbb25SMuhammad Omair Javaid if (!m_update_selection) 5258a94fbb25SMuhammad Omair Javaid return; 5259a94fbb25SMuhammad Omair Javaid 5260a94fbb25SMuhammad Omair Javaid ProcessSP process_sp = GetProcess(); 5261a94fbb25SMuhammad Omair Javaid if (!(process_sp && process_sp->IsAlive())) 5262a94fbb25SMuhammad Omair Javaid return; 5263a94fbb25SMuhammad Omair Javaid 5264a94fbb25SMuhammad Omair Javaid StateType state = process_sp->GetState(); 5265a94fbb25SMuhammad Omair Javaid if (!StateIsStoppedState(state, true)) 5266a94fbb25SMuhammad Omair Javaid return; 5267a94fbb25SMuhammad Omair Javaid 5268a94fbb25SMuhammad Omair Javaid ThreadList &threads = process_sp->GetThreadList(); 5269a94fbb25SMuhammad Omair Javaid std::lock_guard<std::recursive_mutex> guard(threads.GetMutex()); 5270a94fbb25SMuhammad Omair Javaid ThreadSP selected_thread = threads.GetSelectedThread(); 5271a94fbb25SMuhammad Omair Javaid size_t num_threads = threads.GetSize(); 5272a94fbb25SMuhammad Omair Javaid for (size_t i = 0; i < num_threads; ++i) { 5273a94fbb25SMuhammad Omair Javaid ThreadSP thread = threads.GetThreadAtIndex(i); 5274a94fbb25SMuhammad Omair Javaid if (selected_thread->GetID() == thread->GetID()) { 5275a94fbb25SMuhammad Omair Javaid selected_item = &root[i][thread->GetSelectedFrameIndex()]; 5276a94fbb25SMuhammad Omair Javaid selection_index = selected_item->GetRowIndex(); 5277a94fbb25SMuhammad Omair Javaid return; 5278a94fbb25SMuhammad Omair Javaid } 5279a94fbb25SMuhammad Omair Javaid } 5280a94fbb25SMuhammad Omair Javaid } 5281a94fbb25SMuhammad Omair Javaid 52827caa17caSRaphael Isemann bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 52837caa17caSRaphael Isemann 5284a94fbb25SMuhammad Omair Javaid bool TreeDelegateExpandRootByDefault() override { return true; } 5285a94fbb25SMuhammad Omair Javaid 52867caa17caSRaphael Isemann protected: 52877caa17caSRaphael Isemann std::shared_ptr<ThreadTreeDelegate> m_thread_delegate_sp; 52887caa17caSRaphael Isemann Debugger &m_debugger; 52897caa17caSRaphael Isemann uint32_t m_stop_id; 5290a94fbb25SMuhammad Omair Javaid bool m_update_selection; 52917caa17caSRaphael Isemann FormatEntity::Entry m_format; 52927caa17caSRaphael Isemann }; 52937caa17caSRaphael Isemann 5294b26e1efcSOmar Emara class BreakpointLocationTreeDelegate : public TreeDelegate { 5295b26e1efcSOmar Emara public: 5296b26e1efcSOmar Emara BreakpointLocationTreeDelegate(Debugger &debugger) 5297b26e1efcSOmar Emara : TreeDelegate(), m_debugger(debugger) {} 5298b26e1efcSOmar Emara 5299b26e1efcSOmar Emara ~BreakpointLocationTreeDelegate() override = default; 5300b26e1efcSOmar Emara 5301b26e1efcSOmar Emara Process *GetProcess() { 5302b26e1efcSOmar Emara ExecutionContext exe_ctx( 5303b26e1efcSOmar Emara m_debugger.GetCommandInterpreter().GetExecutionContext()); 5304b26e1efcSOmar Emara return exe_ctx.GetProcessPtr(); 5305b26e1efcSOmar Emara } 5306b26e1efcSOmar Emara 5307b26e1efcSOmar Emara BreakpointLocationSP GetBreakpointLocation(const TreeItem &item) { 5308b26e1efcSOmar Emara Breakpoint *breakpoint = (Breakpoint *)item.GetUserData(); 5309b26e1efcSOmar Emara return breakpoint->GetLocationAtIndex(item.GetIdentifier()); 5310b26e1efcSOmar Emara } 5311b26e1efcSOmar Emara 5312b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5313b26e1efcSOmar Emara BreakpointLocationSP breakpoint_location = GetBreakpointLocation(item); 5314b26e1efcSOmar Emara Process *process = GetProcess(); 5315b26e1efcSOmar Emara StreamString stream; 5316b26e1efcSOmar Emara stream.Printf("%i.%i: ", breakpoint_location->GetBreakpoint().GetID(), 5317b26e1efcSOmar Emara breakpoint_location->GetID()); 5318b26e1efcSOmar Emara Address address = breakpoint_location->GetAddress(); 5319b26e1efcSOmar Emara address.Dump(&stream, process, Address::DumpStyleResolvedDescription, 5320b26e1efcSOmar Emara Address::DumpStyleInvalid); 5321b26e1efcSOmar Emara window.PutCStringTruncated(1, stream.GetString().str().c_str()); 5322b26e1efcSOmar Emara } 5323b26e1efcSOmar Emara 5324b26e1efcSOmar Emara StringList ComputeDetailsList(BreakpointLocationSP breakpoint_location) { 5325b26e1efcSOmar Emara StringList details; 5326b26e1efcSOmar Emara 5327b26e1efcSOmar Emara Address address = breakpoint_location->GetAddress(); 5328b26e1efcSOmar Emara SymbolContext symbol_context; 5329b26e1efcSOmar Emara address.CalculateSymbolContext(&symbol_context); 5330b26e1efcSOmar Emara 5331b26e1efcSOmar Emara if (symbol_context.module_sp) { 5332b26e1efcSOmar Emara StreamString module_stream; 5333b26e1efcSOmar Emara module_stream.PutCString("module = "); 5334b26e1efcSOmar Emara symbol_context.module_sp->GetFileSpec().Dump( 5335b26e1efcSOmar Emara module_stream.AsRawOstream()); 5336b26e1efcSOmar Emara details.AppendString(module_stream.GetString()); 5337b26e1efcSOmar Emara } 5338b26e1efcSOmar Emara 5339b26e1efcSOmar Emara if (symbol_context.comp_unit != nullptr) { 5340b26e1efcSOmar Emara StreamString compile_unit_stream; 5341b26e1efcSOmar Emara compile_unit_stream.PutCString("compile unit = "); 5342b26e1efcSOmar Emara symbol_context.comp_unit->GetPrimaryFile().GetFilename().Dump( 5343b26e1efcSOmar Emara &compile_unit_stream); 5344b26e1efcSOmar Emara details.AppendString(compile_unit_stream.GetString()); 5345b26e1efcSOmar Emara 5346b26e1efcSOmar Emara if (symbol_context.function != nullptr) { 5347b26e1efcSOmar Emara StreamString function_stream; 5348b26e1efcSOmar Emara function_stream.PutCString("function = "); 5349b26e1efcSOmar Emara function_stream.PutCString( 5350b26e1efcSOmar Emara symbol_context.function->GetName().AsCString("<unknown>")); 5351b26e1efcSOmar Emara details.AppendString(function_stream.GetString()); 5352b26e1efcSOmar Emara } 5353b26e1efcSOmar Emara 5354b26e1efcSOmar Emara if (symbol_context.line_entry.line > 0) { 5355b26e1efcSOmar Emara StreamString location_stream; 5356b26e1efcSOmar Emara location_stream.PutCString("location = "); 5357b26e1efcSOmar Emara symbol_context.line_entry.DumpStopContext(&location_stream, true); 5358b26e1efcSOmar Emara details.AppendString(location_stream.GetString()); 5359b26e1efcSOmar Emara } 5360b26e1efcSOmar Emara 5361b26e1efcSOmar Emara } else { 5362b26e1efcSOmar Emara if (symbol_context.symbol) { 5363b26e1efcSOmar Emara StreamString symbol_stream; 5364b26e1efcSOmar Emara if (breakpoint_location->IsReExported()) 5365b26e1efcSOmar Emara symbol_stream.PutCString("re-exported target = "); 5366b26e1efcSOmar Emara else 5367b26e1efcSOmar Emara symbol_stream.PutCString("symbol = "); 5368b26e1efcSOmar Emara symbol_stream.PutCString( 5369b26e1efcSOmar Emara symbol_context.symbol->GetName().AsCString("<unknown>")); 5370b26e1efcSOmar Emara details.AppendString(symbol_stream.GetString()); 5371b26e1efcSOmar Emara } 5372b26e1efcSOmar Emara } 5373b26e1efcSOmar Emara 5374b26e1efcSOmar Emara Process *process = GetProcess(); 5375b26e1efcSOmar Emara 5376b26e1efcSOmar Emara StreamString address_stream; 5377b26e1efcSOmar Emara address.Dump(&address_stream, process, Address::DumpStyleLoadAddress, 5378b26e1efcSOmar Emara Address::DumpStyleModuleWithFileAddress); 5379b26e1efcSOmar Emara details.AppendString(address_stream.GetString()); 5380b26e1efcSOmar Emara 5381b26e1efcSOmar Emara BreakpointSiteSP breakpoint_site = breakpoint_location->GetBreakpointSite(); 5382b26e1efcSOmar Emara if (breakpoint_location->IsIndirect() && breakpoint_site) { 5383b26e1efcSOmar Emara Address resolved_address; 5384b26e1efcSOmar Emara resolved_address.SetLoadAddress(breakpoint_site->GetLoadAddress(), 5385b26e1efcSOmar Emara &breakpoint_location->GetTarget()); 5386b26e1efcSOmar Emara Symbol *resolved_symbol = resolved_address.CalculateSymbolContextSymbol(); 5387b26e1efcSOmar Emara if (resolved_symbol) { 5388b26e1efcSOmar Emara StreamString indirect_target_stream; 5389b26e1efcSOmar Emara indirect_target_stream.PutCString("indirect target = "); 5390b26e1efcSOmar Emara indirect_target_stream.PutCString( 5391b26e1efcSOmar Emara resolved_symbol->GetName().GetCString()); 5392b26e1efcSOmar Emara details.AppendString(indirect_target_stream.GetString()); 5393b26e1efcSOmar Emara } 5394b26e1efcSOmar Emara } 5395b26e1efcSOmar Emara 5396b26e1efcSOmar Emara bool is_resolved = breakpoint_location->IsResolved(); 5397b26e1efcSOmar Emara StreamString resolved_stream; 5398b26e1efcSOmar Emara resolved_stream.Printf("resolved = %s", is_resolved ? "true" : "false"); 5399b26e1efcSOmar Emara details.AppendString(resolved_stream.GetString()); 5400b26e1efcSOmar Emara 5401b26e1efcSOmar Emara bool is_hardware = is_resolved && breakpoint_site->IsHardware(); 5402b26e1efcSOmar Emara StreamString hardware_stream; 5403b26e1efcSOmar Emara hardware_stream.Printf("hardware = %s", is_hardware ? "true" : "false"); 5404b26e1efcSOmar Emara details.AppendString(hardware_stream.GetString()); 5405b26e1efcSOmar Emara 5406b26e1efcSOmar Emara StreamString hit_count_stream; 5407b26e1efcSOmar Emara hit_count_stream.Printf("hit count = %-4u", 5408b26e1efcSOmar Emara breakpoint_location->GetHitCount()); 5409b26e1efcSOmar Emara details.AppendString(hit_count_stream.GetString()); 5410b26e1efcSOmar Emara 5411b26e1efcSOmar Emara return details; 5412b26e1efcSOmar Emara } 5413b26e1efcSOmar Emara 5414b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override { 5415b26e1efcSOmar Emara BreakpointLocationSP breakpoint_location = GetBreakpointLocation(item); 5416b26e1efcSOmar Emara StringList details = ComputeDetailsList(breakpoint_location); 5417b26e1efcSOmar Emara 5418b26e1efcSOmar Emara if (!m_string_delegate_sp) 5419b26e1efcSOmar Emara m_string_delegate_sp = std::make_shared<TextTreeDelegate>(); 5420b26e1efcSOmar Emara TreeItem details_tree_item(&item, *m_string_delegate_sp, false); 5421b26e1efcSOmar Emara 5422b26e1efcSOmar Emara item.Resize(details.GetSize(), details_tree_item); 5423b26e1efcSOmar Emara for (size_t i = 0; i < details.GetSize(); i++) { 5424b26e1efcSOmar Emara item[i].SetText(details.GetStringAtIndex(i)); 5425b26e1efcSOmar Emara } 5426b26e1efcSOmar Emara } 5427b26e1efcSOmar Emara 5428b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5429b26e1efcSOmar Emara 5430b26e1efcSOmar Emara protected: 5431b26e1efcSOmar Emara Debugger &m_debugger; 5432b26e1efcSOmar Emara std::shared_ptr<TextTreeDelegate> m_string_delegate_sp; 5433b26e1efcSOmar Emara }; 5434b26e1efcSOmar Emara 5435b26e1efcSOmar Emara class BreakpointTreeDelegate : public TreeDelegate { 5436b26e1efcSOmar Emara public: 5437b26e1efcSOmar Emara BreakpointTreeDelegate(Debugger &debugger) 5438b26e1efcSOmar Emara : TreeDelegate(), m_debugger(debugger), 5439b26e1efcSOmar Emara m_breakpoint_location_delegate_sp() {} 5440b26e1efcSOmar Emara 5441b26e1efcSOmar Emara ~BreakpointTreeDelegate() override = default; 5442b26e1efcSOmar Emara 5443b26e1efcSOmar Emara BreakpointSP GetBreakpoint(const TreeItem &item) { 5444b26e1efcSOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 5445b26e1efcSOmar Emara BreakpointList &breakpoints = target->GetBreakpointList(false); 5446b26e1efcSOmar Emara return breakpoints.GetBreakpointAtIndex(item.GetIdentifier()); 5447b26e1efcSOmar Emara } 5448b26e1efcSOmar Emara 5449b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5450b26e1efcSOmar Emara BreakpointSP breakpoint = GetBreakpoint(item); 5451b26e1efcSOmar Emara StreamString stream; 5452b26e1efcSOmar Emara stream.Format("{0}: ", breakpoint->GetID()); 5453b26e1efcSOmar Emara breakpoint->GetResolverDescription(&stream); 5454b26e1efcSOmar Emara breakpoint->GetFilterDescription(&stream); 5455b26e1efcSOmar Emara window.PutCStringTruncated(1, stream.GetString().str().c_str()); 5456b26e1efcSOmar Emara } 5457b26e1efcSOmar Emara 5458b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override { 5459b26e1efcSOmar Emara BreakpointSP breakpoint = GetBreakpoint(item); 5460b26e1efcSOmar Emara 5461b26e1efcSOmar Emara if (!m_breakpoint_location_delegate_sp) 5462b26e1efcSOmar Emara m_breakpoint_location_delegate_sp = 5463b26e1efcSOmar Emara std::make_shared<BreakpointLocationTreeDelegate>(m_debugger); 5464b26e1efcSOmar Emara TreeItem breakpoint_location_tree_item( 5465b26e1efcSOmar Emara &item, *m_breakpoint_location_delegate_sp, true); 5466b26e1efcSOmar Emara 5467b26e1efcSOmar Emara item.Resize(breakpoint->GetNumLocations(), breakpoint_location_tree_item); 5468b26e1efcSOmar Emara for (size_t i = 0; i < breakpoint->GetNumLocations(); i++) { 5469b26e1efcSOmar Emara item[i].SetIdentifier(i); 5470b26e1efcSOmar Emara item[i].SetUserData(breakpoint.get()); 5471b26e1efcSOmar Emara } 5472b26e1efcSOmar Emara } 5473b26e1efcSOmar Emara 5474b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5475b26e1efcSOmar Emara 5476b26e1efcSOmar Emara protected: 5477b26e1efcSOmar Emara Debugger &m_debugger; 5478b26e1efcSOmar Emara std::shared_ptr<BreakpointLocationTreeDelegate> 5479b26e1efcSOmar Emara m_breakpoint_location_delegate_sp; 5480b26e1efcSOmar Emara }; 5481b26e1efcSOmar Emara 5482b26e1efcSOmar Emara class BreakpointsTreeDelegate : public TreeDelegate { 5483b26e1efcSOmar Emara public: 5484b26e1efcSOmar Emara BreakpointsTreeDelegate(Debugger &debugger) 5485b26e1efcSOmar Emara : TreeDelegate(), m_debugger(debugger), m_breakpoint_delegate_sp() {} 5486b26e1efcSOmar Emara 5487b26e1efcSOmar Emara ~BreakpointsTreeDelegate() override = default; 5488b26e1efcSOmar Emara 5489b26e1efcSOmar Emara bool TreeDelegateShouldDraw() override { 5490b26e1efcSOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 5491b26e1efcSOmar Emara if (!target) 5492b26e1efcSOmar Emara return false; 5493b26e1efcSOmar Emara 5494b26e1efcSOmar Emara return true; 5495b26e1efcSOmar Emara } 5496b26e1efcSOmar Emara 5497b26e1efcSOmar Emara void TreeDelegateDrawTreeItem(TreeItem &item, Window &window) override { 5498b26e1efcSOmar Emara window.PutCString("Breakpoints"); 5499b26e1efcSOmar Emara } 5500b26e1efcSOmar Emara 5501b26e1efcSOmar Emara void TreeDelegateGenerateChildren(TreeItem &item) override { 5502b26e1efcSOmar Emara TargetSP target = m_debugger.GetSelectedTarget(); 5503b26e1efcSOmar Emara 5504b26e1efcSOmar Emara BreakpointList &breakpoints = target->GetBreakpointList(false); 5505b26e1efcSOmar Emara std::unique_lock<std::recursive_mutex> lock; 5506b26e1efcSOmar Emara breakpoints.GetListMutex(lock); 5507b26e1efcSOmar Emara 5508b26e1efcSOmar Emara if (!m_breakpoint_delegate_sp) 5509b26e1efcSOmar Emara m_breakpoint_delegate_sp = 5510b26e1efcSOmar Emara std::make_shared<BreakpointTreeDelegate>(m_debugger); 5511b26e1efcSOmar Emara TreeItem breakpoint_tree_item(&item, *m_breakpoint_delegate_sp, true); 5512b26e1efcSOmar Emara 5513b26e1efcSOmar Emara item.Resize(breakpoints.GetSize(), breakpoint_tree_item); 5514b26e1efcSOmar Emara for (size_t i = 0; i < breakpoints.GetSize(); i++) { 5515b26e1efcSOmar Emara item[i].SetIdentifier(i); 5516b26e1efcSOmar Emara } 5517b26e1efcSOmar Emara } 5518b26e1efcSOmar Emara 5519b26e1efcSOmar Emara bool TreeDelegateItemSelected(TreeItem &item) override { return false; } 5520b26e1efcSOmar Emara 5521b26e1efcSOmar Emara bool TreeDelegateExpandRootByDefault() override { return true; } 5522b26e1efcSOmar Emara 5523b26e1efcSOmar Emara protected: 5524b26e1efcSOmar Emara Debugger &m_debugger; 5525b26e1efcSOmar Emara std::shared_ptr<BreakpointTreeDelegate> m_breakpoint_delegate_sp; 5526b26e1efcSOmar Emara }; 5527b26e1efcSOmar Emara 55287caa17caSRaphael Isemann class ValueObjectListDelegate : public WindowDelegate { 55297caa17caSRaphael Isemann public: 55309494c510SJonas Devlieghere ValueObjectListDelegate() : m_rows() {} 55317caa17caSRaphael Isemann 55327caa17caSRaphael Isemann ValueObjectListDelegate(ValueObjectList &valobj_list) 55337caa17caSRaphael Isemann : m_rows(), m_selected_row(nullptr), m_selected_row_idx(0), 55347caa17caSRaphael Isemann m_first_visible_row(0), m_num_rows(0), m_max_x(0), m_max_y(0) { 55357caa17caSRaphael Isemann SetValues(valobj_list); 55367caa17caSRaphael Isemann } 55377caa17caSRaphael Isemann 55387caa17caSRaphael Isemann ~ValueObjectListDelegate() override = default; 55397caa17caSRaphael Isemann 55407caa17caSRaphael Isemann void SetValues(ValueObjectList &valobj_list) { 55417caa17caSRaphael Isemann m_selected_row = nullptr; 55427caa17caSRaphael Isemann m_selected_row_idx = 0; 55437caa17caSRaphael Isemann m_first_visible_row = 0; 55447caa17caSRaphael Isemann m_num_rows = 0; 55457caa17caSRaphael Isemann m_rows.clear(); 55467caa17caSRaphael Isemann for (auto &valobj_sp : valobj_list.GetObjects()) 55477caa17caSRaphael Isemann m_rows.push_back(Row(valobj_sp, nullptr)); 55487caa17caSRaphael Isemann } 55497caa17caSRaphael Isemann 55507caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 55517caa17caSRaphael Isemann m_num_rows = 0; 55527caa17caSRaphael Isemann m_min_x = 2; 55537caa17caSRaphael Isemann m_min_y = 1; 55547caa17caSRaphael Isemann m_max_x = window.GetWidth() - 1; 55557caa17caSRaphael Isemann m_max_y = window.GetHeight() - 1; 55567caa17caSRaphael Isemann 55577caa17caSRaphael Isemann window.Erase(); 55587caa17caSRaphael Isemann window.DrawTitleBox(window.GetName()); 55597caa17caSRaphael Isemann 55607caa17caSRaphael Isemann const int num_visible_rows = NumVisibleRows(); 55617caa17caSRaphael Isemann const int num_rows = CalculateTotalNumberRows(m_rows); 55627caa17caSRaphael Isemann 55637caa17caSRaphael Isemann // If we unexpanded while having something selected our total number of 55647caa17caSRaphael Isemann // rows is less than the num visible rows, then make sure we show all the 55657caa17caSRaphael Isemann // rows by setting the first visible row accordingly. 55667caa17caSRaphael Isemann if (m_first_visible_row > 0 && num_rows < num_visible_rows) 55677caa17caSRaphael Isemann m_first_visible_row = 0; 55687caa17caSRaphael Isemann 55697caa17caSRaphael Isemann // Make sure the selected row is always visible 55707caa17caSRaphael Isemann if (m_selected_row_idx < m_first_visible_row) 55717caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx; 55727caa17caSRaphael Isemann else if (m_first_visible_row + num_visible_rows <= m_selected_row_idx) 55737caa17caSRaphael Isemann m_first_visible_row = m_selected_row_idx - num_visible_rows + 1; 55747caa17caSRaphael Isemann 55757caa17caSRaphael Isemann DisplayRows(window, m_rows, g_options); 55767caa17caSRaphael Isemann 55777caa17caSRaphael Isemann // Get the selected row 55787caa17caSRaphael Isemann m_selected_row = GetRowForRowIndex(m_selected_row_idx); 55797caa17caSRaphael Isemann // Keep the cursor on the selected row so the highlight and the cursor are 55807caa17caSRaphael Isemann // always on the same line 55817caa17caSRaphael Isemann if (m_selected_row) 55827caa17caSRaphael Isemann window.MoveCursor(m_selected_row->x, m_selected_row->y); 55837caa17caSRaphael Isemann 55847caa17caSRaphael Isemann return true; // Drawing handled 55857caa17caSRaphael Isemann } 55867caa17caSRaphael Isemann 55877caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 55887caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 55897caa17caSRaphael Isemann {KEY_UP, "Select previous item"}, 55907caa17caSRaphael Isemann {KEY_DOWN, "Select next item"}, 55917caa17caSRaphael Isemann {KEY_RIGHT, "Expand selected item"}, 55927caa17caSRaphael Isemann {KEY_LEFT, "Unexpand selected item or select parent if not expanded"}, 55937caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 55947caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 55957caa17caSRaphael Isemann {'A', "Format as annotated address"}, 55967caa17caSRaphael Isemann {'b', "Format as binary"}, 55977caa17caSRaphael Isemann {'B', "Format as hex bytes with ASCII"}, 55987caa17caSRaphael Isemann {'c', "Format as character"}, 55997caa17caSRaphael Isemann {'d', "Format as a signed integer"}, 56007caa17caSRaphael Isemann {'D', "Format selected value using the default format for the type"}, 56017caa17caSRaphael Isemann {'f', "Format as float"}, 56027caa17caSRaphael Isemann {'h', "Show help dialog"}, 56037caa17caSRaphael Isemann {'i', "Format as instructions"}, 56047caa17caSRaphael Isemann {'o', "Format as octal"}, 56057caa17caSRaphael Isemann {'p', "Format as pointer"}, 56067caa17caSRaphael Isemann {'s', "Format as C string"}, 56077caa17caSRaphael Isemann {'t', "Toggle showing/hiding type names"}, 56087caa17caSRaphael Isemann {'u', "Format as an unsigned integer"}, 56097caa17caSRaphael Isemann {'x', "Format as hex"}, 56107caa17caSRaphael Isemann {'X', "Format as uppercase hex"}, 56117caa17caSRaphael Isemann {' ', "Toggle item expansion"}, 56127caa17caSRaphael Isemann {',', "Page up"}, 56137caa17caSRaphael Isemann {'.', "Page down"}, 56147caa17caSRaphael Isemann {'\0', nullptr}}; 56157caa17caSRaphael Isemann return g_source_view_key_help; 56167caa17caSRaphael Isemann } 56177caa17caSRaphael Isemann 56187caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int c) override { 56197caa17caSRaphael Isemann switch (c) { 56207caa17caSRaphael Isemann case 'x': 56217caa17caSRaphael Isemann case 'X': 56227caa17caSRaphael Isemann case 'o': 56237caa17caSRaphael Isemann case 's': 56247caa17caSRaphael Isemann case 'u': 56257caa17caSRaphael Isemann case 'd': 56267caa17caSRaphael Isemann case 'D': 56277caa17caSRaphael Isemann case 'i': 56287caa17caSRaphael Isemann case 'A': 56297caa17caSRaphael Isemann case 'p': 56307caa17caSRaphael Isemann case 'c': 56317caa17caSRaphael Isemann case 'b': 56327caa17caSRaphael Isemann case 'B': 56337caa17caSRaphael Isemann case 'f': 56347caa17caSRaphael Isemann // Change the format for the currently selected item 56357caa17caSRaphael Isemann if (m_selected_row) { 56367caa17caSRaphael Isemann auto valobj_sp = m_selected_row->value.GetSP(); 56377caa17caSRaphael Isemann if (valobj_sp) 56387caa17caSRaphael Isemann valobj_sp->SetFormat(FormatForChar(c)); 56397caa17caSRaphael Isemann } 56407caa17caSRaphael Isemann return eKeyHandled; 56417caa17caSRaphael Isemann 56427caa17caSRaphael Isemann case 't': 56437caa17caSRaphael Isemann // Toggle showing type names 56447caa17caSRaphael Isemann g_options.show_types = !g_options.show_types; 56457caa17caSRaphael Isemann return eKeyHandled; 56467caa17caSRaphael Isemann 56477caa17caSRaphael Isemann case ',': 56487caa17caSRaphael Isemann case KEY_PPAGE: 56497caa17caSRaphael Isemann // Page up key 56507caa17caSRaphael Isemann if (m_first_visible_row > 0) { 56517caa17caSRaphael Isemann if (static_cast<int>(m_first_visible_row) > m_max_y) 56527caa17caSRaphael Isemann m_first_visible_row -= m_max_y; 56537caa17caSRaphael Isemann else 56547caa17caSRaphael Isemann m_first_visible_row = 0; 56557caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 56567caa17caSRaphael Isemann } 56577caa17caSRaphael Isemann return eKeyHandled; 56587caa17caSRaphael Isemann 56597caa17caSRaphael Isemann case '.': 56607caa17caSRaphael Isemann case KEY_NPAGE: 56617caa17caSRaphael Isemann // Page down key 56627caa17caSRaphael Isemann if (m_num_rows > static_cast<size_t>(m_max_y)) { 56637caa17caSRaphael Isemann if (m_first_visible_row + m_max_y < m_num_rows) { 56647caa17caSRaphael Isemann m_first_visible_row += m_max_y; 56657caa17caSRaphael Isemann m_selected_row_idx = m_first_visible_row; 56667caa17caSRaphael Isemann } 56677caa17caSRaphael Isemann } 56687caa17caSRaphael Isemann return eKeyHandled; 56697caa17caSRaphael Isemann 56707caa17caSRaphael Isemann case KEY_UP: 56717caa17caSRaphael Isemann if (m_selected_row_idx > 0) 56727caa17caSRaphael Isemann --m_selected_row_idx; 56737caa17caSRaphael Isemann return eKeyHandled; 56747caa17caSRaphael Isemann 56757caa17caSRaphael Isemann case KEY_DOWN: 56767caa17caSRaphael Isemann if (m_selected_row_idx + 1 < m_num_rows) 56777caa17caSRaphael Isemann ++m_selected_row_idx; 56787caa17caSRaphael Isemann return eKeyHandled; 56797caa17caSRaphael Isemann 56807caa17caSRaphael Isemann case KEY_RIGHT: 56817caa17caSRaphael Isemann if (m_selected_row) { 56827caa17caSRaphael Isemann if (!m_selected_row->expanded) 56837caa17caSRaphael Isemann m_selected_row->Expand(); 56847caa17caSRaphael Isemann } 56857caa17caSRaphael Isemann return eKeyHandled; 56867caa17caSRaphael Isemann 56877caa17caSRaphael Isemann case KEY_LEFT: 56887caa17caSRaphael Isemann if (m_selected_row) { 56897caa17caSRaphael Isemann if (m_selected_row->expanded) 56907caa17caSRaphael Isemann m_selected_row->Unexpand(); 56917caa17caSRaphael Isemann else if (m_selected_row->parent) 56927caa17caSRaphael Isemann m_selected_row_idx = m_selected_row->parent->row_idx; 56937caa17caSRaphael Isemann } 56947caa17caSRaphael Isemann return eKeyHandled; 56957caa17caSRaphael Isemann 56967caa17caSRaphael Isemann case ' ': 56977caa17caSRaphael Isemann // Toggle expansion state when SPACE is pressed 56987caa17caSRaphael Isemann if (m_selected_row) { 56997caa17caSRaphael Isemann if (m_selected_row->expanded) 57007caa17caSRaphael Isemann m_selected_row->Unexpand(); 57017caa17caSRaphael Isemann else 57027caa17caSRaphael Isemann m_selected_row->Expand(); 57037caa17caSRaphael Isemann } 57047caa17caSRaphael Isemann return eKeyHandled; 57057caa17caSRaphael Isemann 57067caa17caSRaphael Isemann case 'h': 57077caa17caSRaphael Isemann window.CreateHelpSubwindow(); 57087caa17caSRaphael Isemann return eKeyHandled; 57097caa17caSRaphael Isemann 57107caa17caSRaphael Isemann default: 57117caa17caSRaphael Isemann break; 57127caa17caSRaphael Isemann } 57137caa17caSRaphael Isemann return eKeyNotHandled; 57147caa17caSRaphael Isemann } 57157caa17caSRaphael Isemann 57167caa17caSRaphael Isemann protected: 57177caa17caSRaphael Isemann std::vector<Row> m_rows; 57189494c510SJonas Devlieghere Row *m_selected_row = nullptr; 57199494c510SJonas Devlieghere uint32_t m_selected_row_idx = 0; 57209494c510SJonas Devlieghere uint32_t m_first_visible_row = 0; 57219494c510SJonas Devlieghere uint32_t m_num_rows = 0; 57227caa17caSRaphael Isemann int m_min_x; 57237caa17caSRaphael Isemann int m_min_y; 57249494c510SJonas Devlieghere int m_max_x = 0; 57259494c510SJonas Devlieghere int m_max_y = 0; 57267caa17caSRaphael Isemann 57277caa17caSRaphael Isemann static Format FormatForChar(int c) { 57287caa17caSRaphael Isemann switch (c) { 57297caa17caSRaphael Isemann case 'x': 57307caa17caSRaphael Isemann return eFormatHex; 57317caa17caSRaphael Isemann case 'X': 57327caa17caSRaphael Isemann return eFormatHexUppercase; 57337caa17caSRaphael Isemann case 'o': 57347caa17caSRaphael Isemann return eFormatOctal; 57357caa17caSRaphael Isemann case 's': 57367caa17caSRaphael Isemann return eFormatCString; 57377caa17caSRaphael Isemann case 'u': 57387caa17caSRaphael Isemann return eFormatUnsigned; 57397caa17caSRaphael Isemann case 'd': 57407caa17caSRaphael Isemann return eFormatDecimal; 57417caa17caSRaphael Isemann case 'D': 57427caa17caSRaphael Isemann return eFormatDefault; 57437caa17caSRaphael Isemann case 'i': 57447caa17caSRaphael Isemann return eFormatInstruction; 57457caa17caSRaphael Isemann case 'A': 57467caa17caSRaphael Isemann return eFormatAddressInfo; 57477caa17caSRaphael Isemann case 'p': 57487caa17caSRaphael Isemann return eFormatPointer; 57497caa17caSRaphael Isemann case 'c': 57507caa17caSRaphael Isemann return eFormatChar; 57517caa17caSRaphael Isemann case 'b': 57527caa17caSRaphael Isemann return eFormatBinary; 57537caa17caSRaphael Isemann case 'B': 57547caa17caSRaphael Isemann return eFormatBytesWithASCII; 57557caa17caSRaphael Isemann case 'f': 57567caa17caSRaphael Isemann return eFormatFloat; 57577caa17caSRaphael Isemann } 57587caa17caSRaphael Isemann return eFormatDefault; 57597caa17caSRaphael Isemann } 57607caa17caSRaphael Isemann 57617caa17caSRaphael Isemann bool DisplayRowObject(Window &window, Row &row, DisplayOptions &options, 57627caa17caSRaphael Isemann bool highlight, bool last_child) { 57637caa17caSRaphael Isemann ValueObject *valobj = row.value.GetSP().get(); 57647caa17caSRaphael Isemann 57657caa17caSRaphael Isemann if (valobj == nullptr) 57667caa17caSRaphael Isemann return false; 57677caa17caSRaphael Isemann 57687caa17caSRaphael Isemann const char *type_name = 57697caa17caSRaphael Isemann options.show_types ? valobj->GetTypeName().GetCString() : nullptr; 57707caa17caSRaphael Isemann const char *name = valobj->GetName().GetCString(); 57717caa17caSRaphael Isemann const char *value = valobj->GetValueAsCString(); 57727caa17caSRaphael Isemann const char *summary = valobj->GetSummaryAsCString(); 57737caa17caSRaphael Isemann 57747caa17caSRaphael Isemann window.MoveCursor(row.x, row.y); 57757caa17caSRaphael Isemann 57767caa17caSRaphael Isemann row.DrawTree(window); 57777caa17caSRaphael Isemann 57787caa17caSRaphael Isemann if (highlight) 57797caa17caSRaphael Isemann window.AttributeOn(A_REVERSE); 57807caa17caSRaphael Isemann 57817caa17caSRaphael Isemann if (type_name && type_name[0]) 5782fc0e8fb7SLuboš Luňák window.PrintfTruncated(1, "(%s) ", type_name); 57837caa17caSRaphael Isemann 57847caa17caSRaphael Isemann if (name && name[0]) 5785fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, name); 57867caa17caSRaphael Isemann 57877caa17caSRaphael Isemann attr_t changd_attr = 0; 57887caa17caSRaphael Isemann if (valobj->GetValueDidChange()) 57894a8e4b5cSLuboš Luňák changd_attr = COLOR_PAIR(RedOnBlack) | A_BOLD; 57907caa17caSRaphael Isemann 57917caa17caSRaphael Isemann if (value && value[0]) { 5792fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, " = "); 57937caa17caSRaphael Isemann if (changd_attr) 57947caa17caSRaphael Isemann window.AttributeOn(changd_attr); 5795fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, value); 57967caa17caSRaphael Isemann if (changd_attr) 57977caa17caSRaphael Isemann window.AttributeOff(changd_attr); 57987caa17caSRaphael Isemann } 57997caa17caSRaphael Isemann 58007caa17caSRaphael Isemann if (summary && summary[0]) { 5801fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, " "); 58027caa17caSRaphael Isemann if (changd_attr) 58037caa17caSRaphael Isemann window.AttributeOn(changd_attr); 5804fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, summary); 58057caa17caSRaphael Isemann if (changd_attr) 58067caa17caSRaphael Isemann window.AttributeOff(changd_attr); 58077caa17caSRaphael Isemann } 58087caa17caSRaphael Isemann 58097caa17caSRaphael Isemann if (highlight) 58107caa17caSRaphael Isemann window.AttributeOff(A_REVERSE); 58117caa17caSRaphael Isemann 58127caa17caSRaphael Isemann return true; 58137caa17caSRaphael Isemann } 58147caa17caSRaphael Isemann 58157caa17caSRaphael Isemann void DisplayRows(Window &window, std::vector<Row> &rows, 58167caa17caSRaphael Isemann DisplayOptions &options) { 58177caa17caSRaphael Isemann // > 0x25B7 58187caa17caSRaphael Isemann // \/ 0x25BD 58197caa17caSRaphael Isemann 58207caa17caSRaphael Isemann bool window_is_active = window.IsActive(); 58217caa17caSRaphael Isemann for (auto &row : rows) { 58227caa17caSRaphael Isemann const bool last_child = row.parent && &rows[rows.size() - 1] == &row; 58237caa17caSRaphael Isemann // Save the row index in each Row structure 58247caa17caSRaphael Isemann row.row_idx = m_num_rows; 58257caa17caSRaphael Isemann if ((m_num_rows >= m_first_visible_row) && 58267caa17caSRaphael Isemann ((m_num_rows - m_first_visible_row) < 58277caa17caSRaphael Isemann static_cast<size_t>(NumVisibleRows()))) { 58287caa17caSRaphael Isemann row.x = m_min_x; 58297caa17caSRaphael Isemann row.y = m_num_rows - m_first_visible_row + 1; 58307caa17caSRaphael Isemann if (DisplayRowObject(window, row, options, 58317caa17caSRaphael Isemann window_is_active && 58327caa17caSRaphael Isemann m_num_rows == m_selected_row_idx, 58337caa17caSRaphael Isemann last_child)) { 58347caa17caSRaphael Isemann ++m_num_rows; 58357caa17caSRaphael Isemann } else { 58367caa17caSRaphael Isemann row.x = 0; 58377caa17caSRaphael Isemann row.y = 0; 58387caa17caSRaphael Isemann } 58397caa17caSRaphael Isemann } else { 58407caa17caSRaphael Isemann row.x = 0; 58417caa17caSRaphael Isemann row.y = 0; 58427caa17caSRaphael Isemann ++m_num_rows; 58437caa17caSRaphael Isemann } 58447caa17caSRaphael Isemann 58457caa17caSRaphael Isemann auto &children = row.GetChildren(); 58467caa17caSRaphael Isemann if (row.expanded && !children.empty()) { 58477caa17caSRaphael Isemann DisplayRows(window, children, options); 58487caa17caSRaphael Isemann } 58497caa17caSRaphael Isemann } 58507caa17caSRaphael Isemann } 58517caa17caSRaphael Isemann 58527caa17caSRaphael Isemann int CalculateTotalNumberRows(std::vector<Row> &rows) { 58537caa17caSRaphael Isemann int row_count = 0; 58547caa17caSRaphael Isemann for (auto &row : rows) { 58557caa17caSRaphael Isemann ++row_count; 58567caa17caSRaphael Isemann if (row.expanded) 58577caa17caSRaphael Isemann row_count += CalculateTotalNumberRows(row.GetChildren()); 58587caa17caSRaphael Isemann } 58597caa17caSRaphael Isemann return row_count; 58607caa17caSRaphael Isemann } 58617caa17caSRaphael Isemann 58627caa17caSRaphael Isemann static Row *GetRowForRowIndexImpl(std::vector<Row> &rows, size_t &row_index) { 58637caa17caSRaphael Isemann for (auto &row : rows) { 58647caa17caSRaphael Isemann if (row_index == 0) 58657caa17caSRaphael Isemann return &row; 58667caa17caSRaphael Isemann else { 58677caa17caSRaphael Isemann --row_index; 58687caa17caSRaphael Isemann auto &children = row.GetChildren(); 58697caa17caSRaphael Isemann if (row.expanded && !children.empty()) { 58707caa17caSRaphael Isemann Row *result = GetRowForRowIndexImpl(children, row_index); 58717caa17caSRaphael Isemann if (result) 58727caa17caSRaphael Isemann return result; 58737caa17caSRaphael Isemann } 58747caa17caSRaphael Isemann } 58757caa17caSRaphael Isemann } 58767caa17caSRaphael Isemann return nullptr; 58777caa17caSRaphael Isemann } 58787caa17caSRaphael Isemann 58797caa17caSRaphael Isemann Row *GetRowForRowIndex(size_t row_index) { 58807caa17caSRaphael Isemann return GetRowForRowIndexImpl(m_rows, row_index); 58817caa17caSRaphael Isemann } 58827caa17caSRaphael Isemann 58837caa17caSRaphael Isemann int NumVisibleRows() const { return m_max_y - m_min_y; } 58847caa17caSRaphael Isemann 58857caa17caSRaphael Isemann static DisplayOptions g_options; 58867caa17caSRaphael Isemann }; 58877caa17caSRaphael Isemann 58887caa17caSRaphael Isemann class FrameVariablesWindowDelegate : public ValueObjectListDelegate { 58897caa17caSRaphael Isemann public: 58907caa17caSRaphael Isemann FrameVariablesWindowDelegate(Debugger &debugger) 58917caa17caSRaphael Isemann : ValueObjectListDelegate(), m_debugger(debugger), 58927caa17caSRaphael Isemann m_frame_block(nullptr) {} 58937caa17caSRaphael Isemann 58947caa17caSRaphael Isemann ~FrameVariablesWindowDelegate() override = default; 58957caa17caSRaphael Isemann 58967caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 58977caa17caSRaphael Isemann return "Frame variable window keyboard shortcuts:"; 58987caa17caSRaphael Isemann } 58997caa17caSRaphael Isemann 59007caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 59017caa17caSRaphael Isemann ExecutionContext exe_ctx( 59027caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext()); 59037caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 59047caa17caSRaphael Isemann Block *frame_block = nullptr; 59057caa17caSRaphael Isemann StackFrame *frame = nullptr; 59067caa17caSRaphael Isemann 59077caa17caSRaphael Isemann if (process) { 59087caa17caSRaphael Isemann StateType state = process->GetState(); 59097caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 59107caa17caSRaphael Isemann frame = exe_ctx.GetFramePtr(); 59117caa17caSRaphael Isemann if (frame) 59127caa17caSRaphael Isemann frame_block = frame->GetFrameBlock(); 59137caa17caSRaphael Isemann } else if (StateIsRunningState(state)) { 59147caa17caSRaphael Isemann return true; // Don't do any updating when we are running 59157caa17caSRaphael Isemann } 59167caa17caSRaphael Isemann } 59177caa17caSRaphael Isemann 59187caa17caSRaphael Isemann ValueObjectList local_values; 59197caa17caSRaphael Isemann if (frame_block) { 59207caa17caSRaphael Isemann // Only update the variables if they have changed 59217caa17caSRaphael Isemann if (m_frame_block != frame_block) { 59227caa17caSRaphael Isemann m_frame_block = frame_block; 59237caa17caSRaphael Isemann 59247caa17caSRaphael Isemann VariableList *locals = frame->GetVariableList(true); 59257caa17caSRaphael Isemann if (locals) { 59267caa17caSRaphael Isemann const DynamicValueType use_dynamic = eDynamicDontRunTarget; 59277caa17caSRaphael Isemann for (const VariableSP &local_sp : *locals) { 59287caa17caSRaphael Isemann ValueObjectSP value_sp = 59297caa17caSRaphael Isemann frame->GetValueObjectForFrameVariable(local_sp, use_dynamic); 59307caa17caSRaphael Isemann if (value_sp) { 59317caa17caSRaphael Isemann ValueObjectSP synthetic_value_sp = value_sp->GetSyntheticValue(); 59327caa17caSRaphael Isemann if (synthetic_value_sp) 59337caa17caSRaphael Isemann local_values.Append(synthetic_value_sp); 59347caa17caSRaphael Isemann else 59357caa17caSRaphael Isemann local_values.Append(value_sp); 59367caa17caSRaphael Isemann } 59377caa17caSRaphael Isemann } 59387caa17caSRaphael Isemann // Update the values 59397caa17caSRaphael Isemann SetValues(local_values); 59407caa17caSRaphael Isemann } 59417caa17caSRaphael Isemann } 59427caa17caSRaphael Isemann } else { 59437caa17caSRaphael Isemann m_frame_block = nullptr; 59447caa17caSRaphael Isemann // Update the values with an empty list if there is no frame 59457caa17caSRaphael Isemann SetValues(local_values); 59467caa17caSRaphael Isemann } 59477caa17caSRaphael Isemann 59487caa17caSRaphael Isemann return ValueObjectListDelegate::WindowDelegateDraw(window, force); 59497caa17caSRaphael Isemann } 59507caa17caSRaphael Isemann 59517caa17caSRaphael Isemann protected: 59527caa17caSRaphael Isemann Debugger &m_debugger; 59537caa17caSRaphael Isemann Block *m_frame_block; 59547caa17caSRaphael Isemann }; 59557caa17caSRaphael Isemann 59567caa17caSRaphael Isemann class RegistersWindowDelegate : public ValueObjectListDelegate { 59577caa17caSRaphael Isemann public: 59587caa17caSRaphael Isemann RegistersWindowDelegate(Debugger &debugger) 59597caa17caSRaphael Isemann : ValueObjectListDelegate(), m_debugger(debugger) {} 59607caa17caSRaphael Isemann 59617caa17caSRaphael Isemann ~RegistersWindowDelegate() override = default; 59627caa17caSRaphael Isemann 59637caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 59647caa17caSRaphael Isemann return "Register window keyboard shortcuts:"; 59657caa17caSRaphael Isemann } 59667caa17caSRaphael Isemann 59677caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 59687caa17caSRaphael Isemann ExecutionContext exe_ctx( 59697caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext()); 59707caa17caSRaphael Isemann StackFrame *frame = exe_ctx.GetFramePtr(); 59717caa17caSRaphael Isemann 59727caa17caSRaphael Isemann ValueObjectList value_list; 59737caa17caSRaphael Isemann if (frame) { 59747caa17caSRaphael Isemann if (frame->GetStackID() != m_stack_id) { 59757caa17caSRaphael Isemann m_stack_id = frame->GetStackID(); 59767caa17caSRaphael Isemann RegisterContextSP reg_ctx(frame->GetRegisterContext()); 59777caa17caSRaphael Isemann if (reg_ctx) { 59787caa17caSRaphael Isemann const uint32_t num_sets = reg_ctx->GetRegisterSetCount(); 59797caa17caSRaphael Isemann for (uint32_t set_idx = 0; set_idx < num_sets; ++set_idx) { 59807caa17caSRaphael Isemann value_list.Append( 59817caa17caSRaphael Isemann ValueObjectRegisterSet::Create(frame, reg_ctx, set_idx)); 59827caa17caSRaphael Isemann } 59837caa17caSRaphael Isemann } 59847caa17caSRaphael Isemann SetValues(value_list); 59857caa17caSRaphael Isemann } 59867caa17caSRaphael Isemann } else { 59877caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 59887caa17caSRaphael Isemann if (process && process->IsAlive()) 59897caa17caSRaphael Isemann return true; // Don't do any updating if we are running 59907caa17caSRaphael Isemann else { 59917caa17caSRaphael Isemann // Update the values with an empty list if there is no process or the 59927caa17caSRaphael Isemann // process isn't alive anymore 59937caa17caSRaphael Isemann SetValues(value_list); 59947caa17caSRaphael Isemann } 59957caa17caSRaphael Isemann } 59967caa17caSRaphael Isemann return ValueObjectListDelegate::WindowDelegateDraw(window, force); 59977caa17caSRaphael Isemann } 59987caa17caSRaphael Isemann 59997caa17caSRaphael Isemann protected: 60007caa17caSRaphael Isemann Debugger &m_debugger; 60017caa17caSRaphael Isemann StackID m_stack_id; 60027caa17caSRaphael Isemann }; 60037caa17caSRaphael Isemann 60047caa17caSRaphael Isemann static const char *CursesKeyToCString(int ch) { 60057caa17caSRaphael Isemann static char g_desc[32]; 60067caa17caSRaphael Isemann if (ch >= KEY_F0 && ch < KEY_F0 + 64) { 60077caa17caSRaphael Isemann snprintf(g_desc, sizeof(g_desc), "F%u", ch - KEY_F0); 60087caa17caSRaphael Isemann return g_desc; 60097caa17caSRaphael Isemann } 60107caa17caSRaphael Isemann switch (ch) { 60117caa17caSRaphael Isemann case KEY_DOWN: 60127caa17caSRaphael Isemann return "down"; 60137caa17caSRaphael Isemann case KEY_UP: 60147caa17caSRaphael Isemann return "up"; 60157caa17caSRaphael Isemann case KEY_LEFT: 60167caa17caSRaphael Isemann return "left"; 60177caa17caSRaphael Isemann case KEY_RIGHT: 60187caa17caSRaphael Isemann return "right"; 60197caa17caSRaphael Isemann case KEY_HOME: 60207caa17caSRaphael Isemann return "home"; 60217caa17caSRaphael Isemann case KEY_BACKSPACE: 60227caa17caSRaphael Isemann return "backspace"; 60237caa17caSRaphael Isemann case KEY_DL: 60247caa17caSRaphael Isemann return "delete-line"; 60257caa17caSRaphael Isemann case KEY_IL: 60267caa17caSRaphael Isemann return "insert-line"; 60277caa17caSRaphael Isemann case KEY_DC: 60287caa17caSRaphael Isemann return "delete-char"; 60297caa17caSRaphael Isemann case KEY_IC: 60307caa17caSRaphael Isemann return "insert-char"; 60317caa17caSRaphael Isemann case KEY_CLEAR: 60327caa17caSRaphael Isemann return "clear"; 60337caa17caSRaphael Isemann case KEY_EOS: 60347caa17caSRaphael Isemann return "clear-to-eos"; 60357caa17caSRaphael Isemann case KEY_EOL: 60367caa17caSRaphael Isemann return "clear-to-eol"; 60377caa17caSRaphael Isemann case KEY_SF: 60387caa17caSRaphael Isemann return "scroll-forward"; 60397caa17caSRaphael Isemann case KEY_SR: 60407caa17caSRaphael Isemann return "scroll-backward"; 60417caa17caSRaphael Isemann case KEY_NPAGE: 60427caa17caSRaphael Isemann return "page-down"; 60437caa17caSRaphael Isemann case KEY_PPAGE: 60447caa17caSRaphael Isemann return "page-up"; 60457caa17caSRaphael Isemann case KEY_STAB: 60467caa17caSRaphael Isemann return "set-tab"; 60477caa17caSRaphael Isemann case KEY_CTAB: 60487caa17caSRaphael Isemann return "clear-tab"; 60497caa17caSRaphael Isemann case KEY_CATAB: 60507caa17caSRaphael Isemann return "clear-all-tabs"; 60517caa17caSRaphael Isemann case KEY_ENTER: 60527caa17caSRaphael Isemann return "enter"; 60537caa17caSRaphael Isemann case KEY_PRINT: 60547caa17caSRaphael Isemann return "print"; 60557caa17caSRaphael Isemann case KEY_LL: 60567caa17caSRaphael Isemann return "lower-left key"; 60577caa17caSRaphael Isemann case KEY_A1: 60587caa17caSRaphael Isemann return "upper left of keypad"; 60597caa17caSRaphael Isemann case KEY_A3: 60607caa17caSRaphael Isemann return "upper right of keypad"; 60617caa17caSRaphael Isemann case KEY_B2: 60627caa17caSRaphael Isemann return "center of keypad"; 60637caa17caSRaphael Isemann case KEY_C1: 60647caa17caSRaphael Isemann return "lower left of keypad"; 60657caa17caSRaphael Isemann case KEY_C3: 60667caa17caSRaphael Isemann return "lower right of keypad"; 60677caa17caSRaphael Isemann case KEY_BTAB: 60687caa17caSRaphael Isemann return "back-tab key"; 60697caa17caSRaphael Isemann case KEY_BEG: 60707caa17caSRaphael Isemann return "begin key"; 60717caa17caSRaphael Isemann case KEY_CANCEL: 60727caa17caSRaphael Isemann return "cancel key"; 60737caa17caSRaphael Isemann case KEY_CLOSE: 60747caa17caSRaphael Isemann return "close key"; 60757caa17caSRaphael Isemann case KEY_COMMAND: 60767caa17caSRaphael Isemann return "command key"; 60777caa17caSRaphael Isemann case KEY_COPY: 60787caa17caSRaphael Isemann return "copy key"; 60797caa17caSRaphael Isemann case KEY_CREATE: 60807caa17caSRaphael Isemann return "create key"; 60817caa17caSRaphael Isemann case KEY_END: 60827caa17caSRaphael Isemann return "end key"; 60837caa17caSRaphael Isemann case KEY_EXIT: 60847caa17caSRaphael Isemann return "exit key"; 60857caa17caSRaphael Isemann case KEY_FIND: 60867caa17caSRaphael Isemann return "find key"; 60877caa17caSRaphael Isemann case KEY_HELP: 60887caa17caSRaphael Isemann return "help key"; 60897caa17caSRaphael Isemann case KEY_MARK: 60907caa17caSRaphael Isemann return "mark key"; 60917caa17caSRaphael Isemann case KEY_MESSAGE: 60927caa17caSRaphael Isemann return "message key"; 60937caa17caSRaphael Isemann case KEY_MOVE: 60947caa17caSRaphael Isemann return "move key"; 60957caa17caSRaphael Isemann case KEY_NEXT: 60967caa17caSRaphael Isemann return "next key"; 60977caa17caSRaphael Isemann case KEY_OPEN: 60987caa17caSRaphael Isemann return "open key"; 60997caa17caSRaphael Isemann case KEY_OPTIONS: 61007caa17caSRaphael Isemann return "options key"; 61017caa17caSRaphael Isemann case KEY_PREVIOUS: 61027caa17caSRaphael Isemann return "previous key"; 61037caa17caSRaphael Isemann case KEY_REDO: 61047caa17caSRaphael Isemann return "redo key"; 61057caa17caSRaphael Isemann case KEY_REFERENCE: 61067caa17caSRaphael Isemann return "reference key"; 61077caa17caSRaphael Isemann case KEY_REFRESH: 61087caa17caSRaphael Isemann return "refresh key"; 61097caa17caSRaphael Isemann case KEY_REPLACE: 61107caa17caSRaphael Isemann return "replace key"; 61117caa17caSRaphael Isemann case KEY_RESTART: 61127caa17caSRaphael Isemann return "restart key"; 61137caa17caSRaphael Isemann case KEY_RESUME: 61147caa17caSRaphael Isemann return "resume key"; 61157caa17caSRaphael Isemann case KEY_SAVE: 61167caa17caSRaphael Isemann return "save key"; 61177caa17caSRaphael Isemann case KEY_SBEG: 61187caa17caSRaphael Isemann return "shifted begin key"; 61197caa17caSRaphael Isemann case KEY_SCANCEL: 61207caa17caSRaphael Isemann return "shifted cancel key"; 61217caa17caSRaphael Isemann case KEY_SCOMMAND: 61227caa17caSRaphael Isemann return "shifted command key"; 61237caa17caSRaphael Isemann case KEY_SCOPY: 61247caa17caSRaphael Isemann return "shifted copy key"; 61257caa17caSRaphael Isemann case KEY_SCREATE: 61267caa17caSRaphael Isemann return "shifted create key"; 61277caa17caSRaphael Isemann case KEY_SDC: 61287caa17caSRaphael Isemann return "shifted delete-character key"; 61297caa17caSRaphael Isemann case KEY_SDL: 61307caa17caSRaphael Isemann return "shifted delete-line key"; 61317caa17caSRaphael Isemann case KEY_SELECT: 61327caa17caSRaphael Isemann return "select key"; 61337caa17caSRaphael Isemann case KEY_SEND: 61347caa17caSRaphael Isemann return "shifted end key"; 61357caa17caSRaphael Isemann case KEY_SEOL: 61367caa17caSRaphael Isemann return "shifted clear-to-end-of-line key"; 61377caa17caSRaphael Isemann case KEY_SEXIT: 61387caa17caSRaphael Isemann return "shifted exit key"; 61397caa17caSRaphael Isemann case KEY_SFIND: 61407caa17caSRaphael Isemann return "shifted find key"; 61417caa17caSRaphael Isemann case KEY_SHELP: 61427caa17caSRaphael Isemann return "shifted help key"; 61437caa17caSRaphael Isemann case KEY_SHOME: 61447caa17caSRaphael Isemann return "shifted home key"; 61457caa17caSRaphael Isemann case KEY_SIC: 61467caa17caSRaphael Isemann return "shifted insert-character key"; 61477caa17caSRaphael Isemann case KEY_SLEFT: 61487caa17caSRaphael Isemann return "shifted left-arrow key"; 61497caa17caSRaphael Isemann case KEY_SMESSAGE: 61507caa17caSRaphael Isemann return "shifted message key"; 61517caa17caSRaphael Isemann case KEY_SMOVE: 61527caa17caSRaphael Isemann return "shifted move key"; 61537caa17caSRaphael Isemann case KEY_SNEXT: 61547caa17caSRaphael Isemann return "shifted next key"; 61557caa17caSRaphael Isemann case KEY_SOPTIONS: 61567caa17caSRaphael Isemann return "shifted options key"; 61577caa17caSRaphael Isemann case KEY_SPREVIOUS: 61587caa17caSRaphael Isemann return "shifted previous key"; 61597caa17caSRaphael Isemann case KEY_SPRINT: 61607caa17caSRaphael Isemann return "shifted print key"; 61617caa17caSRaphael Isemann case KEY_SREDO: 61627caa17caSRaphael Isemann return "shifted redo key"; 61637caa17caSRaphael Isemann case KEY_SREPLACE: 61647caa17caSRaphael Isemann return "shifted replace key"; 61657caa17caSRaphael Isemann case KEY_SRIGHT: 61667caa17caSRaphael Isemann return "shifted right-arrow key"; 61677caa17caSRaphael Isemann case KEY_SRSUME: 61687caa17caSRaphael Isemann return "shifted resume key"; 61697caa17caSRaphael Isemann case KEY_SSAVE: 61707caa17caSRaphael Isemann return "shifted save key"; 61717caa17caSRaphael Isemann case KEY_SSUSPEND: 61727caa17caSRaphael Isemann return "shifted suspend key"; 61737caa17caSRaphael Isemann case KEY_SUNDO: 61747caa17caSRaphael Isemann return "shifted undo key"; 61757caa17caSRaphael Isemann case KEY_SUSPEND: 61767caa17caSRaphael Isemann return "suspend key"; 61777caa17caSRaphael Isemann case KEY_UNDO: 61787caa17caSRaphael Isemann return "undo key"; 61797caa17caSRaphael Isemann case KEY_MOUSE: 61807caa17caSRaphael Isemann return "Mouse event has occurred"; 61817caa17caSRaphael Isemann case KEY_RESIZE: 61827caa17caSRaphael Isemann return "Terminal resize event"; 61837caa17caSRaphael Isemann #ifdef KEY_EVENT 61847caa17caSRaphael Isemann case KEY_EVENT: 61857caa17caSRaphael Isemann return "We were interrupted by an event"; 61867caa17caSRaphael Isemann #endif 61877caa17caSRaphael Isemann case KEY_RETURN: 61887caa17caSRaphael Isemann return "return"; 61897caa17caSRaphael Isemann case ' ': 61907caa17caSRaphael Isemann return "space"; 61917caa17caSRaphael Isemann case '\t': 61927caa17caSRaphael Isemann return "tab"; 61937caa17caSRaphael Isemann case KEY_ESCAPE: 61947caa17caSRaphael Isemann return "escape"; 61957caa17caSRaphael Isemann default: 6196f5eaa2afSRaphael Isemann if (llvm::isPrint(ch)) 61977caa17caSRaphael Isemann snprintf(g_desc, sizeof(g_desc), "%c", ch); 61987caa17caSRaphael Isemann else 61997caa17caSRaphael Isemann snprintf(g_desc, sizeof(g_desc), "\\x%2.2x", ch); 62007caa17caSRaphael Isemann return g_desc; 62017caa17caSRaphael Isemann } 62027caa17caSRaphael Isemann return nullptr; 62037caa17caSRaphael Isemann } 62047caa17caSRaphael Isemann 62057caa17caSRaphael Isemann HelpDialogDelegate::HelpDialogDelegate(const char *text, 62067caa17caSRaphael Isemann KeyHelp *key_help_array) 62077caa17caSRaphael Isemann : m_text(), m_first_visible_line(0) { 62087caa17caSRaphael Isemann if (text && text[0]) { 62097caa17caSRaphael Isemann m_text.SplitIntoLines(text); 62107caa17caSRaphael Isemann m_text.AppendString(""); 62117caa17caSRaphael Isemann } 62127caa17caSRaphael Isemann if (key_help_array) { 62137caa17caSRaphael Isemann for (KeyHelp *key = key_help_array; key->ch; ++key) { 62147caa17caSRaphael Isemann StreamString key_description; 62157caa17caSRaphael Isemann key_description.Printf("%10s - %s", CursesKeyToCString(key->ch), 62167caa17caSRaphael Isemann key->description); 62177caa17caSRaphael Isemann m_text.AppendString(key_description.GetString()); 62187caa17caSRaphael Isemann } 62197caa17caSRaphael Isemann } 62207caa17caSRaphael Isemann } 62217caa17caSRaphael Isemann 62227caa17caSRaphael Isemann HelpDialogDelegate::~HelpDialogDelegate() = default; 62237caa17caSRaphael Isemann 62247caa17caSRaphael Isemann bool HelpDialogDelegate::WindowDelegateDraw(Window &window, bool force) { 62257caa17caSRaphael Isemann window.Erase(); 62267caa17caSRaphael Isemann const int window_height = window.GetHeight(); 62277caa17caSRaphael Isemann int x = 2; 62287caa17caSRaphael Isemann int y = 1; 62297caa17caSRaphael Isemann const int min_y = y; 62307caa17caSRaphael Isemann const int max_y = window_height - 1 - y; 62317caa17caSRaphael Isemann const size_t num_visible_lines = max_y - min_y + 1; 62327caa17caSRaphael Isemann const size_t num_lines = m_text.GetSize(); 62337caa17caSRaphael Isemann const char *bottom_message; 62347caa17caSRaphael Isemann if (num_lines <= num_visible_lines) 62357caa17caSRaphael Isemann bottom_message = "Press any key to exit"; 62367caa17caSRaphael Isemann else 62377caa17caSRaphael Isemann bottom_message = "Use arrows to scroll, any other key to exit"; 62387caa17caSRaphael Isemann window.DrawTitleBox(window.GetName(), bottom_message); 62397caa17caSRaphael Isemann while (y <= max_y) { 62407caa17caSRaphael Isemann window.MoveCursor(x, y); 62417caa17caSRaphael Isemann window.PutCStringTruncated( 6242fc0e8fb7SLuboš Luňák 1, m_text.GetStringAtIndex(m_first_visible_line + y - min_y)); 62437caa17caSRaphael Isemann ++y; 62447caa17caSRaphael Isemann } 62457caa17caSRaphael Isemann return true; 62467caa17caSRaphael Isemann } 62477caa17caSRaphael Isemann 62487caa17caSRaphael Isemann HandleCharResult HelpDialogDelegate::WindowDelegateHandleChar(Window &window, 62497caa17caSRaphael Isemann int key) { 62507caa17caSRaphael Isemann bool done = false; 62517caa17caSRaphael Isemann const size_t num_lines = m_text.GetSize(); 62527caa17caSRaphael Isemann const size_t num_visible_lines = window.GetHeight() - 2; 62537caa17caSRaphael Isemann 62547caa17caSRaphael Isemann if (num_lines <= num_visible_lines) { 62557caa17caSRaphael Isemann done = true; 62567caa17caSRaphael Isemann // If we have all lines visible and don't need scrolling, then any key 62577caa17caSRaphael Isemann // press will cause us to exit 62587caa17caSRaphael Isemann } else { 62597caa17caSRaphael Isemann switch (key) { 62607caa17caSRaphael Isemann case KEY_UP: 62617caa17caSRaphael Isemann if (m_first_visible_line > 0) 62627caa17caSRaphael Isemann --m_first_visible_line; 62637caa17caSRaphael Isemann break; 62647caa17caSRaphael Isemann 62657caa17caSRaphael Isemann case KEY_DOWN: 62667caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < num_lines) 62677caa17caSRaphael Isemann ++m_first_visible_line; 62687caa17caSRaphael Isemann break; 62697caa17caSRaphael Isemann 62707caa17caSRaphael Isemann case KEY_PPAGE: 62717caa17caSRaphael Isemann case ',': 62727caa17caSRaphael Isemann if (m_first_visible_line > 0) { 62737caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) >= num_visible_lines) 62747caa17caSRaphael Isemann m_first_visible_line -= num_visible_lines; 62757caa17caSRaphael Isemann else 62767caa17caSRaphael Isemann m_first_visible_line = 0; 62777caa17caSRaphael Isemann } 62787caa17caSRaphael Isemann break; 62797caa17caSRaphael Isemann 62807caa17caSRaphael Isemann case KEY_NPAGE: 62817caa17caSRaphael Isemann case '.': 62827caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < num_lines) { 62837caa17caSRaphael Isemann m_first_visible_line += num_visible_lines; 62847caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) > num_lines) 62857caa17caSRaphael Isemann m_first_visible_line = num_lines - num_visible_lines; 62867caa17caSRaphael Isemann } 62877caa17caSRaphael Isemann break; 62887caa17caSRaphael Isemann 62897caa17caSRaphael Isemann default: 62907caa17caSRaphael Isemann done = true; 62917caa17caSRaphael Isemann break; 62927caa17caSRaphael Isemann } 62937caa17caSRaphael Isemann } 62947caa17caSRaphael Isemann if (done) 62957caa17caSRaphael Isemann window.GetParent()->RemoveSubWindow(&window); 62967caa17caSRaphael Isemann return eKeyHandled; 62977caa17caSRaphael Isemann } 62987caa17caSRaphael Isemann 62997caa17caSRaphael Isemann class ApplicationDelegate : public WindowDelegate, public MenuDelegate { 63007caa17caSRaphael Isemann public: 63017caa17caSRaphael Isemann enum { 63027caa17caSRaphael Isemann eMenuID_LLDB = 1, 63037caa17caSRaphael Isemann eMenuID_LLDBAbout, 63047caa17caSRaphael Isemann eMenuID_LLDBExit, 63057caa17caSRaphael Isemann 63067caa17caSRaphael Isemann eMenuID_Target, 63077caa17caSRaphael Isemann eMenuID_TargetCreate, 63087caa17caSRaphael Isemann eMenuID_TargetDelete, 63097caa17caSRaphael Isemann 63107caa17caSRaphael Isemann eMenuID_Process, 63117caa17caSRaphael Isemann eMenuID_ProcessAttach, 631247d2c7cdSLuboš Luňák eMenuID_ProcessDetachResume, 631347d2c7cdSLuboš Luňák eMenuID_ProcessDetachSuspended, 63147caa17caSRaphael Isemann eMenuID_ProcessLaunch, 63157caa17caSRaphael Isemann eMenuID_ProcessContinue, 63167caa17caSRaphael Isemann eMenuID_ProcessHalt, 63177caa17caSRaphael Isemann eMenuID_ProcessKill, 63187caa17caSRaphael Isemann 63197caa17caSRaphael Isemann eMenuID_Thread, 63207caa17caSRaphael Isemann eMenuID_ThreadStepIn, 63217caa17caSRaphael Isemann eMenuID_ThreadStepOver, 63227caa17caSRaphael Isemann eMenuID_ThreadStepOut, 63237caa17caSRaphael Isemann 63247caa17caSRaphael Isemann eMenuID_View, 63257caa17caSRaphael Isemann eMenuID_ViewBacktrace, 63267caa17caSRaphael Isemann eMenuID_ViewRegisters, 63277caa17caSRaphael Isemann eMenuID_ViewSource, 63287caa17caSRaphael Isemann eMenuID_ViewVariables, 6329b26e1efcSOmar Emara eMenuID_ViewBreakpoints, 63307caa17caSRaphael Isemann 63317caa17caSRaphael Isemann eMenuID_Help, 63327caa17caSRaphael Isemann eMenuID_HelpGUIHelp 63337caa17caSRaphael Isemann }; 63347caa17caSRaphael Isemann 63357caa17caSRaphael Isemann ApplicationDelegate(Application &app, Debugger &debugger) 63367caa17caSRaphael Isemann : WindowDelegate(), MenuDelegate(), m_app(app), m_debugger(debugger) {} 63377caa17caSRaphael Isemann 63387caa17caSRaphael Isemann ~ApplicationDelegate() override = default; 63397caa17caSRaphael Isemann 63407caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 63417caa17caSRaphael Isemann return false; // Drawing not handled, let standard window drawing happen 63427caa17caSRaphael Isemann } 63437caa17caSRaphael Isemann 63447caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int key) override { 63457caa17caSRaphael Isemann switch (key) { 63467caa17caSRaphael Isemann case '\t': 63477caa17caSRaphael Isemann window.SelectNextWindowAsActive(); 63487caa17caSRaphael Isemann return eKeyHandled; 63497caa17caSRaphael Isemann 635029cc50e1SOmar Emara case KEY_SHIFT_TAB: 63517a63dc53SLuboš Luňák window.SelectPreviousWindowAsActive(); 63527a63dc53SLuboš Luňák return eKeyHandled; 63537a63dc53SLuboš Luňák 63547caa17caSRaphael Isemann case 'h': 63557caa17caSRaphael Isemann window.CreateHelpSubwindow(); 63567caa17caSRaphael Isemann return eKeyHandled; 63577caa17caSRaphael Isemann 63587caa17caSRaphael Isemann case KEY_ESCAPE: 63597caa17caSRaphael Isemann return eQuitApplication; 63607caa17caSRaphael Isemann 63617caa17caSRaphael Isemann default: 63627caa17caSRaphael Isemann break; 63637caa17caSRaphael Isemann } 63647caa17caSRaphael Isemann return eKeyNotHandled; 63657caa17caSRaphael Isemann } 63667caa17caSRaphael Isemann 63677caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 63687caa17caSRaphael Isemann return "Welcome to the LLDB curses GUI.\n\n" 63697caa17caSRaphael Isemann "Press the TAB key to change the selected view.\n" 63707caa17caSRaphael Isemann "Each view has its own keyboard shortcuts, press 'h' to open a " 63717caa17caSRaphael Isemann "dialog to display them.\n\n" 63727caa17caSRaphael Isemann "Common key bindings for all views:"; 63737caa17caSRaphael Isemann } 63747caa17caSRaphael Isemann 63757caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 63767caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 63777caa17caSRaphael Isemann {'\t', "Select next view"}, 63787a63dc53SLuboš Luňák {KEY_BTAB, "Select previous view"}, 63797caa17caSRaphael Isemann {'h', "Show help dialog with view specific key bindings"}, 63807caa17caSRaphael Isemann {',', "Page up"}, 63817caa17caSRaphael Isemann {'.', "Page down"}, 63827caa17caSRaphael Isemann {KEY_UP, "Select previous"}, 63837caa17caSRaphael Isemann {KEY_DOWN, "Select next"}, 63847caa17caSRaphael Isemann {KEY_LEFT, "Unexpand or select parent"}, 63857caa17caSRaphael Isemann {KEY_RIGHT, "Expand"}, 63867caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 63877caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 63887caa17caSRaphael Isemann {'\0', nullptr}}; 63897caa17caSRaphael Isemann return g_source_view_key_help; 63907caa17caSRaphael Isemann } 63917caa17caSRaphael Isemann 63927caa17caSRaphael Isemann MenuActionResult MenuDelegateAction(Menu &menu) override { 63937caa17caSRaphael Isemann switch (menu.GetIdentifier()) { 639418c25cd3SOmar Emara case eMenuID_TargetCreate: { 639518c25cd3SOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 639618c25cd3SOmar Emara FormDelegateSP form_delegate_sp = 639718c25cd3SOmar Emara FormDelegateSP(new TargetCreateFormDelegate(m_debugger)); 639818c25cd3SOmar Emara Rect bounds = main_window_sp->GetCenteredRect(80, 19); 639918c25cd3SOmar Emara WindowSP form_window_sp = main_window_sp->CreateSubWindow( 640018c25cd3SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 640118c25cd3SOmar Emara WindowDelegateSP window_delegate_sp = 640218c25cd3SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 640318c25cd3SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 640418c25cd3SOmar Emara return MenuActionResult::Handled; 640518c25cd3SOmar Emara } 64067caa17caSRaphael Isemann case eMenuID_ThreadStepIn: { 64077caa17caSRaphael Isemann ExecutionContext exe_ctx = 64087caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64097caa17caSRaphael Isemann if (exe_ctx.HasThreadScope()) { 64107caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64117caa17caSRaphael Isemann if (process && process->IsAlive() && 64127caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 64137caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepIn(true); 64147caa17caSRaphael Isemann } 64157caa17caSRaphael Isemann } 64167caa17caSRaphael Isemann return MenuActionResult::Handled; 64177caa17caSRaphael Isemann 64187caa17caSRaphael Isemann case eMenuID_ThreadStepOut: { 64197caa17caSRaphael Isemann ExecutionContext exe_ctx = 64207caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64217caa17caSRaphael Isemann if (exe_ctx.HasThreadScope()) { 64227caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64237caa17caSRaphael Isemann if (process && process->IsAlive() && 64247caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 64257caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOut(); 64267caa17caSRaphael Isemann } 64277caa17caSRaphael Isemann } 64287caa17caSRaphael Isemann return MenuActionResult::Handled; 64297caa17caSRaphael Isemann 64307caa17caSRaphael Isemann case eMenuID_ThreadStepOver: { 64317caa17caSRaphael Isemann ExecutionContext exe_ctx = 64327caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64337caa17caSRaphael Isemann if (exe_ctx.HasThreadScope()) { 64347caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64357caa17caSRaphael Isemann if (process && process->IsAlive() && 64367caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 64377caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOver(true); 64387caa17caSRaphael Isemann } 64397caa17caSRaphael Isemann } 64407caa17caSRaphael Isemann return MenuActionResult::Handled; 64417caa17caSRaphael Isemann 64420321dbc8SOmar Emara case eMenuID_ProcessAttach: { 64430321dbc8SOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 64440321dbc8SOmar Emara FormDelegateSP form_delegate_sp = FormDelegateSP( 64450321dbc8SOmar Emara new ProcessAttachFormDelegate(m_debugger, main_window_sp)); 64460321dbc8SOmar Emara Rect bounds = main_window_sp->GetCenteredRect(80, 22); 64470321dbc8SOmar Emara WindowSP form_window_sp = main_window_sp->CreateSubWindow( 64480321dbc8SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 64490321dbc8SOmar Emara WindowDelegateSP window_delegate_sp = 64500321dbc8SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 64510321dbc8SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 64520321dbc8SOmar Emara return MenuActionResult::Handled; 64530321dbc8SOmar Emara } 645482507f17SOmar Emara case eMenuID_ProcessLaunch: { 645582507f17SOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 645682507f17SOmar Emara FormDelegateSP form_delegate_sp = FormDelegateSP( 645782507f17SOmar Emara new ProcessLaunchFormDelegate(m_debugger, main_window_sp)); 645882507f17SOmar Emara Rect bounds = main_window_sp->GetCenteredRect(80, 22); 645982507f17SOmar Emara WindowSP form_window_sp = main_window_sp->CreateSubWindow( 646082507f17SOmar Emara form_delegate_sp->GetName().c_str(), bounds, true); 646182507f17SOmar Emara WindowDelegateSP window_delegate_sp = 646282507f17SOmar Emara WindowDelegateSP(new FormWindowDelegate(form_delegate_sp)); 646382507f17SOmar Emara form_window_sp->SetDelegate(window_delegate_sp); 646482507f17SOmar Emara return MenuActionResult::Handled; 646582507f17SOmar Emara } 64660321dbc8SOmar Emara 64677caa17caSRaphael Isemann case eMenuID_ProcessContinue: { 64687caa17caSRaphael Isemann ExecutionContext exe_ctx = 64697caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64707caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 64717caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64727caa17caSRaphael Isemann if (process && process->IsAlive() && 64737caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) 64747caa17caSRaphael Isemann process->Resume(); 64757caa17caSRaphael Isemann } 64767caa17caSRaphael Isemann } 64777caa17caSRaphael Isemann return MenuActionResult::Handled; 64787caa17caSRaphael Isemann 64797caa17caSRaphael Isemann case eMenuID_ProcessKill: { 64807caa17caSRaphael Isemann ExecutionContext exe_ctx = 64817caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64827caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 64837caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64847caa17caSRaphael Isemann if (process && process->IsAlive()) 64857caa17caSRaphael Isemann process->Destroy(false); 64867caa17caSRaphael Isemann } 64877caa17caSRaphael Isemann } 64887caa17caSRaphael Isemann return MenuActionResult::Handled; 64897caa17caSRaphael Isemann 64907caa17caSRaphael Isemann case eMenuID_ProcessHalt: { 64917caa17caSRaphael Isemann ExecutionContext exe_ctx = 64927caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 64937caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 64947caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 64957caa17caSRaphael Isemann if (process && process->IsAlive()) 64967caa17caSRaphael Isemann process->Halt(); 64977caa17caSRaphael Isemann } 64987caa17caSRaphael Isemann } 64997caa17caSRaphael Isemann return MenuActionResult::Handled; 65007caa17caSRaphael Isemann 650147d2c7cdSLuboš Luňák case eMenuID_ProcessDetachResume: 650247d2c7cdSLuboš Luňák case eMenuID_ProcessDetachSuspended: { 65037caa17caSRaphael Isemann ExecutionContext exe_ctx = 65047caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 65057caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) { 65067caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 65077caa17caSRaphael Isemann if (process && process->IsAlive()) 650847d2c7cdSLuboš Luňák process->Detach(menu.GetIdentifier() == 650947d2c7cdSLuboš Luňák eMenuID_ProcessDetachSuspended); 65107caa17caSRaphael Isemann } 65117caa17caSRaphael Isemann } 65127caa17caSRaphael Isemann return MenuActionResult::Handled; 65137caa17caSRaphael Isemann 65147caa17caSRaphael Isemann case eMenuID_Process: { 65157caa17caSRaphael Isemann // Populate the menu with all of the threads if the process is stopped 65167caa17caSRaphael Isemann // when the Process menu gets selected and is about to display its 65177caa17caSRaphael Isemann // submenu. 65187caa17caSRaphael Isemann Menus &submenus = menu.GetSubmenus(); 65197caa17caSRaphael Isemann ExecutionContext exe_ctx = 65207caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 65217caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 65227caa17caSRaphael Isemann if (process && process->IsAlive() && 65237caa17caSRaphael Isemann StateIsStoppedState(process->GetState(), true)) { 65247caa17caSRaphael Isemann if (submenus.size() == 7) 65257caa17caSRaphael Isemann menu.AddSubmenu(MenuSP(new Menu(Menu::Type::Separator))); 65267caa17caSRaphael Isemann else if (submenus.size() > 8) 65277caa17caSRaphael Isemann submenus.erase(submenus.begin() + 8, submenus.end()); 65287caa17caSRaphael Isemann 65297caa17caSRaphael Isemann ThreadList &threads = process->GetThreadList(); 65307caa17caSRaphael Isemann std::lock_guard<std::recursive_mutex> guard(threads.GetMutex()); 65317caa17caSRaphael Isemann size_t num_threads = threads.GetSize(); 65327caa17caSRaphael Isemann for (size_t i = 0; i < num_threads; ++i) { 65337caa17caSRaphael Isemann ThreadSP thread_sp = threads.GetThreadAtIndex(i); 65347caa17caSRaphael Isemann char menu_char = '\0'; 65357caa17caSRaphael Isemann if (i < 9) 65367caa17caSRaphael Isemann menu_char = '1' + i; 65377caa17caSRaphael Isemann StreamString thread_menu_title; 65387caa17caSRaphael Isemann thread_menu_title.Printf("Thread %u", thread_sp->GetIndexID()); 65397caa17caSRaphael Isemann const char *thread_name = thread_sp->GetName(); 65407caa17caSRaphael Isemann if (thread_name && thread_name[0]) 65417caa17caSRaphael Isemann thread_menu_title.Printf(" %s", thread_name); 65427caa17caSRaphael Isemann else { 65437caa17caSRaphael Isemann const char *queue_name = thread_sp->GetQueueName(); 65447caa17caSRaphael Isemann if (queue_name && queue_name[0]) 65457caa17caSRaphael Isemann thread_menu_title.Printf(" %s", queue_name); 65467caa17caSRaphael Isemann } 65477caa17caSRaphael Isemann menu.AddSubmenu( 65487caa17caSRaphael Isemann MenuSP(new Menu(thread_menu_title.GetString().str().c_str(), 65497caa17caSRaphael Isemann nullptr, menu_char, thread_sp->GetID()))); 65507caa17caSRaphael Isemann } 65517caa17caSRaphael Isemann } else if (submenus.size() > 7) { 65527caa17caSRaphael Isemann // Remove the separator and any other thread submenu items that were 65537caa17caSRaphael Isemann // previously added 65547caa17caSRaphael Isemann submenus.erase(submenus.begin() + 7, submenus.end()); 65557caa17caSRaphael Isemann } 6556b26e1efcSOmar Emara // Since we are adding and removing items we need to recalculate the 6557b26e1efcSOmar Emara // name lengths 65587caa17caSRaphael Isemann menu.RecalculateNameLengths(); 65597caa17caSRaphael Isemann } 65607caa17caSRaphael Isemann return MenuActionResult::Handled; 65617caa17caSRaphael Isemann 65627caa17caSRaphael Isemann case eMenuID_ViewVariables: { 65637caa17caSRaphael Isemann WindowSP main_window_sp = m_app.GetMainWindow(); 65647caa17caSRaphael Isemann WindowSP source_window_sp = main_window_sp->FindSubWindow("Source"); 65657caa17caSRaphael Isemann WindowSP variables_window_sp = main_window_sp->FindSubWindow("Variables"); 65667caa17caSRaphael Isemann WindowSP registers_window_sp = main_window_sp->FindSubWindow("Registers"); 65677caa17caSRaphael Isemann const Rect source_bounds = source_window_sp->GetBounds(); 65687caa17caSRaphael Isemann 65697caa17caSRaphael Isemann if (variables_window_sp) { 65707caa17caSRaphael Isemann const Rect variables_bounds = variables_window_sp->GetBounds(); 65717caa17caSRaphael Isemann 65727caa17caSRaphael Isemann main_window_sp->RemoveSubWindow(variables_window_sp.get()); 65737caa17caSRaphael Isemann 65747caa17caSRaphael Isemann if (registers_window_sp) { 65757caa17caSRaphael Isemann // We have a registers window, so give all the area back to the 65767caa17caSRaphael Isemann // registers window 65777caa17caSRaphael Isemann Rect registers_bounds = variables_bounds; 65787caa17caSRaphael Isemann registers_bounds.size.width = source_bounds.size.width; 65797caa17caSRaphael Isemann registers_window_sp->SetBounds(registers_bounds); 65807caa17caSRaphael Isemann } else { 65817caa17caSRaphael Isemann // We have no registers window showing so give the bottom area back 65827caa17caSRaphael Isemann // to the source view 65837caa17caSRaphael Isemann source_window_sp->Resize(source_bounds.size.width, 65847caa17caSRaphael Isemann source_bounds.size.height + 65857caa17caSRaphael Isemann variables_bounds.size.height); 65867caa17caSRaphael Isemann } 65877caa17caSRaphael Isemann } else { 65887caa17caSRaphael Isemann Rect new_variables_rect; 65897caa17caSRaphael Isemann if (registers_window_sp) { 65907caa17caSRaphael Isemann // We have a registers window so split the area of the registers 65917caa17caSRaphael Isemann // window into two columns where the left hand side will be the 65927caa17caSRaphael Isemann // variables and the right hand side will be the registers 65937caa17caSRaphael Isemann const Rect variables_bounds = registers_window_sp->GetBounds(); 65947caa17caSRaphael Isemann Rect new_registers_rect; 65957caa17caSRaphael Isemann variables_bounds.VerticalSplitPercentage(0.50, new_variables_rect, 65967caa17caSRaphael Isemann new_registers_rect); 65977caa17caSRaphael Isemann registers_window_sp->SetBounds(new_registers_rect); 65987caa17caSRaphael Isemann } else { 65992f1b24b7SLuboš Luňák // No registers window, grab the bottom part of the source window 66007caa17caSRaphael Isemann Rect new_source_rect; 66017caa17caSRaphael Isemann source_bounds.HorizontalSplitPercentage(0.70, new_source_rect, 66027caa17caSRaphael Isemann new_variables_rect); 66037caa17caSRaphael Isemann source_window_sp->SetBounds(new_source_rect); 66047caa17caSRaphael Isemann } 66057caa17caSRaphael Isemann WindowSP new_window_sp = main_window_sp->CreateSubWindow( 66067caa17caSRaphael Isemann "Variables", new_variables_rect, false); 66077caa17caSRaphael Isemann new_window_sp->SetDelegate( 66087caa17caSRaphael Isemann WindowDelegateSP(new FrameVariablesWindowDelegate(m_debugger))); 66097caa17caSRaphael Isemann } 66107caa17caSRaphael Isemann touchwin(stdscr); 66117caa17caSRaphael Isemann } 66127caa17caSRaphael Isemann return MenuActionResult::Handled; 66137caa17caSRaphael Isemann 66147caa17caSRaphael Isemann case eMenuID_ViewRegisters: { 66157caa17caSRaphael Isemann WindowSP main_window_sp = m_app.GetMainWindow(); 66167caa17caSRaphael Isemann WindowSP source_window_sp = main_window_sp->FindSubWindow("Source"); 66177caa17caSRaphael Isemann WindowSP variables_window_sp = main_window_sp->FindSubWindow("Variables"); 66187caa17caSRaphael Isemann WindowSP registers_window_sp = main_window_sp->FindSubWindow("Registers"); 66197caa17caSRaphael Isemann const Rect source_bounds = source_window_sp->GetBounds(); 66207caa17caSRaphael Isemann 66217caa17caSRaphael Isemann if (registers_window_sp) { 66227caa17caSRaphael Isemann if (variables_window_sp) { 66237caa17caSRaphael Isemann const Rect variables_bounds = variables_window_sp->GetBounds(); 66247caa17caSRaphael Isemann 66257caa17caSRaphael Isemann // We have a variables window, so give all the area back to the 66267caa17caSRaphael Isemann // variables window 66277caa17caSRaphael Isemann variables_window_sp->Resize(variables_bounds.size.width + 66287caa17caSRaphael Isemann registers_window_sp->GetWidth(), 66297caa17caSRaphael Isemann variables_bounds.size.height); 66307caa17caSRaphael Isemann } else { 66317caa17caSRaphael Isemann // We have no variables window showing so give the bottom area back 66327caa17caSRaphael Isemann // to the source view 66337caa17caSRaphael Isemann source_window_sp->Resize(source_bounds.size.width, 66347caa17caSRaphael Isemann source_bounds.size.height + 66357caa17caSRaphael Isemann registers_window_sp->GetHeight()); 66367caa17caSRaphael Isemann } 66377caa17caSRaphael Isemann main_window_sp->RemoveSubWindow(registers_window_sp.get()); 66387caa17caSRaphael Isemann } else { 66397caa17caSRaphael Isemann Rect new_regs_rect; 66407caa17caSRaphael Isemann if (variables_window_sp) { 66417caa17caSRaphael Isemann // We have a variables window, split it into two columns where the 66427caa17caSRaphael Isemann // left hand side will be the variables and the right hand side will 66437caa17caSRaphael Isemann // be the registers 66447caa17caSRaphael Isemann const Rect variables_bounds = variables_window_sp->GetBounds(); 66457caa17caSRaphael Isemann Rect new_vars_rect; 66467caa17caSRaphael Isemann variables_bounds.VerticalSplitPercentage(0.50, new_vars_rect, 66477caa17caSRaphael Isemann new_regs_rect); 66487caa17caSRaphael Isemann variables_window_sp->SetBounds(new_vars_rect); 66497caa17caSRaphael Isemann } else { 66502f1b24b7SLuboš Luňák // No variables window, grab the bottom part of the source window 66517caa17caSRaphael Isemann Rect new_source_rect; 66527caa17caSRaphael Isemann source_bounds.HorizontalSplitPercentage(0.70, new_source_rect, 66537caa17caSRaphael Isemann new_regs_rect); 66547caa17caSRaphael Isemann source_window_sp->SetBounds(new_source_rect); 66557caa17caSRaphael Isemann } 66567caa17caSRaphael Isemann WindowSP new_window_sp = 66577caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Registers", new_regs_rect, false); 66587caa17caSRaphael Isemann new_window_sp->SetDelegate( 66597caa17caSRaphael Isemann WindowDelegateSP(new RegistersWindowDelegate(m_debugger))); 66607caa17caSRaphael Isemann } 66617caa17caSRaphael Isemann touchwin(stdscr); 66627caa17caSRaphael Isemann } 66637caa17caSRaphael Isemann return MenuActionResult::Handled; 66647caa17caSRaphael Isemann 6665b26e1efcSOmar Emara case eMenuID_ViewBreakpoints: { 6666b26e1efcSOmar Emara WindowSP main_window_sp = m_app.GetMainWindow(); 6667b26e1efcSOmar Emara WindowSP threads_window_sp = main_window_sp->FindSubWindow("Threads"); 6668b26e1efcSOmar Emara WindowSP breakpoints_window_sp = 6669b26e1efcSOmar Emara main_window_sp->FindSubWindow("Breakpoints"); 6670b26e1efcSOmar Emara const Rect threads_bounds = threads_window_sp->GetBounds(); 6671b26e1efcSOmar Emara 6672b26e1efcSOmar Emara // If a breakpoints window already exists, remove it and give the area 6673b26e1efcSOmar Emara // it used to occupy to the threads window. If it doesn't exist, split 6674b26e1efcSOmar Emara // the threads window horizontally into two windows where the top window 6675b26e1efcSOmar Emara // is the threads window and the bottom window is a newly added 6676b26e1efcSOmar Emara // breakpoints window. 6677b26e1efcSOmar Emara if (breakpoints_window_sp) { 6678b26e1efcSOmar Emara threads_window_sp->Resize(threads_bounds.size.width, 6679b26e1efcSOmar Emara threads_bounds.size.height + 6680b26e1efcSOmar Emara breakpoints_window_sp->GetHeight()); 6681b26e1efcSOmar Emara main_window_sp->RemoveSubWindow(breakpoints_window_sp.get()); 6682b26e1efcSOmar Emara } else { 6683b26e1efcSOmar Emara Rect new_threads_bounds, breakpoints_bounds; 6684b26e1efcSOmar Emara threads_bounds.HorizontalSplitPercentage(0.70, new_threads_bounds, 6685b26e1efcSOmar Emara breakpoints_bounds); 6686b26e1efcSOmar Emara threads_window_sp->SetBounds(new_threads_bounds); 6687b26e1efcSOmar Emara breakpoints_window_sp = main_window_sp->CreateSubWindow( 6688b26e1efcSOmar Emara "Breakpoints", breakpoints_bounds, false); 6689b26e1efcSOmar Emara TreeDelegateSP breakpoints_delegate_sp( 6690b26e1efcSOmar Emara new BreakpointsTreeDelegate(m_debugger)); 6691b26e1efcSOmar Emara breakpoints_window_sp->SetDelegate(WindowDelegateSP( 6692b26e1efcSOmar Emara new TreeWindowDelegate(m_debugger, breakpoints_delegate_sp))); 6693b26e1efcSOmar Emara } 6694b26e1efcSOmar Emara touchwin(stdscr); 6695b26e1efcSOmar Emara return MenuActionResult::Handled; 6696b26e1efcSOmar Emara } 6697b26e1efcSOmar Emara 66987caa17caSRaphael Isemann case eMenuID_HelpGUIHelp: 66997caa17caSRaphael Isemann m_app.GetMainWindow()->CreateHelpSubwindow(); 67007caa17caSRaphael Isemann return MenuActionResult::Handled; 67017caa17caSRaphael Isemann 67027caa17caSRaphael Isemann default: 67037caa17caSRaphael Isemann break; 67047caa17caSRaphael Isemann } 67057caa17caSRaphael Isemann 67067caa17caSRaphael Isemann return MenuActionResult::NotHandled; 67077caa17caSRaphael Isemann } 67087caa17caSRaphael Isemann 67097caa17caSRaphael Isemann protected: 67107caa17caSRaphael Isemann Application &m_app; 67117caa17caSRaphael Isemann Debugger &m_debugger; 67127caa17caSRaphael Isemann }; 67137caa17caSRaphael Isemann 67147caa17caSRaphael Isemann class StatusBarWindowDelegate : public WindowDelegate { 67157caa17caSRaphael Isemann public: 67167caa17caSRaphael Isemann StatusBarWindowDelegate(Debugger &debugger) : m_debugger(debugger) { 67177caa17caSRaphael Isemann FormatEntity::Parse("Thread: ${thread.id%tid}", m_format); 67187caa17caSRaphael Isemann } 67197caa17caSRaphael Isemann 67207caa17caSRaphael Isemann ~StatusBarWindowDelegate() override = default; 67217caa17caSRaphael Isemann 67227caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 67237caa17caSRaphael Isemann ExecutionContext exe_ctx = 67247caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 67257caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 67267caa17caSRaphael Isemann Thread *thread = exe_ctx.GetThreadPtr(); 67277caa17caSRaphael Isemann StackFrame *frame = exe_ctx.GetFramePtr(); 67287caa17caSRaphael Isemann window.Erase(); 67294a8e4b5cSLuboš Luňák window.SetBackground(BlackOnWhite); 67307caa17caSRaphael Isemann window.MoveCursor(0, 0); 67317caa17caSRaphael Isemann if (process) { 67327caa17caSRaphael Isemann const StateType state = process->GetState(); 67337caa17caSRaphael Isemann window.Printf("Process: %5" PRIu64 " %10s", process->GetID(), 67347caa17caSRaphael Isemann StateAsCString(state)); 67357caa17caSRaphael Isemann 67367caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 67377caa17caSRaphael Isemann StreamString strm; 67387caa17caSRaphael Isemann if (thread && FormatEntity::Format(m_format, strm, nullptr, &exe_ctx, 67397caa17caSRaphael Isemann nullptr, nullptr, false, false)) { 67407caa17caSRaphael Isemann window.MoveCursor(40, 0); 6741fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, strm.GetString().str().c_str()); 67427caa17caSRaphael Isemann } 67437caa17caSRaphael Isemann 67447caa17caSRaphael Isemann window.MoveCursor(60, 0); 67457caa17caSRaphael Isemann if (frame) 67467caa17caSRaphael Isemann window.Printf("Frame: %3u PC = 0x%16.16" PRIx64, 67477caa17caSRaphael Isemann frame->GetFrameIndex(), 67487caa17caSRaphael Isemann frame->GetFrameCodeAddress().GetOpcodeLoadAddress( 67497caa17caSRaphael Isemann exe_ctx.GetTargetPtr())); 67507caa17caSRaphael Isemann } else if (state == eStateExited) { 67517caa17caSRaphael Isemann const char *exit_desc = process->GetExitDescription(); 67527caa17caSRaphael Isemann const int exit_status = process->GetExitStatus(); 67537caa17caSRaphael Isemann if (exit_desc && exit_desc[0]) 67547caa17caSRaphael Isemann window.Printf(" with status = %i (%s)", exit_status, exit_desc); 67557caa17caSRaphael Isemann else 67567caa17caSRaphael Isemann window.Printf(" with status = %i", exit_status); 67577caa17caSRaphael Isemann } 67587caa17caSRaphael Isemann } 67597caa17caSRaphael Isemann return true; 67607caa17caSRaphael Isemann } 67617caa17caSRaphael Isemann 67627caa17caSRaphael Isemann protected: 67637caa17caSRaphael Isemann Debugger &m_debugger; 67647caa17caSRaphael Isemann FormatEntity::Entry m_format; 67657caa17caSRaphael Isemann }; 67667caa17caSRaphael Isemann 67677caa17caSRaphael Isemann class SourceFileWindowDelegate : public WindowDelegate { 67687caa17caSRaphael Isemann public: 67697caa17caSRaphael Isemann SourceFileWindowDelegate(Debugger &debugger) 67707caa17caSRaphael Isemann : WindowDelegate(), m_debugger(debugger), m_sc(), m_file_sp(), 67717caa17caSRaphael Isemann m_disassembly_scope(nullptr), m_disassembly_sp(), m_disassembly_range(), 6772b4825a6dSJordan Rupprecht m_title(), m_tid(LLDB_INVALID_THREAD_ID), m_line_width(4), 6773b4825a6dSJordan Rupprecht m_selected_line(0), m_pc_line(0), m_stop_id(0), m_frame_idx(UINT32_MAX), 6774b4825a6dSJordan Rupprecht m_first_visible_line(0), m_first_visible_column(0), m_min_x(0), 6775b4825a6dSJordan Rupprecht m_min_y(0), m_max_x(0), m_max_y(0) {} 67767caa17caSRaphael Isemann 67777caa17caSRaphael Isemann ~SourceFileWindowDelegate() override = default; 67787caa17caSRaphael Isemann 67797caa17caSRaphael Isemann void Update(const SymbolContext &sc) { m_sc = sc; } 67807caa17caSRaphael Isemann 67817caa17caSRaphael Isemann uint32_t NumVisibleLines() const { return m_max_y - m_min_y; } 67827caa17caSRaphael Isemann 67837caa17caSRaphael Isemann const char *WindowDelegateGetHelpText() override { 67847caa17caSRaphael Isemann return "Source/Disassembly window keyboard shortcuts:"; 67857caa17caSRaphael Isemann } 67867caa17caSRaphael Isemann 67877caa17caSRaphael Isemann KeyHelp *WindowDelegateGetKeyHelp() override { 67887caa17caSRaphael Isemann static curses::KeyHelp g_source_view_key_help[] = { 67897caa17caSRaphael Isemann {KEY_RETURN, "Run to selected line with one shot breakpoint"}, 67907caa17caSRaphael Isemann {KEY_UP, "Select previous source line"}, 67917caa17caSRaphael Isemann {KEY_DOWN, "Select next source line"}, 6792dcd4589aSLuboš Luňák {KEY_LEFT, "Scroll to the left"}, 6793dcd4589aSLuboš Luňák {KEY_RIGHT, "Scroll to the right"}, 67947caa17caSRaphael Isemann {KEY_PPAGE, "Page up"}, 67957caa17caSRaphael Isemann {KEY_NPAGE, "Page down"}, 67967caa17caSRaphael Isemann {'b', "Set breakpoint on selected source/disassembly line"}, 67977caa17caSRaphael Isemann {'c', "Continue process"}, 67987caa17caSRaphael Isemann {'D', "Detach with process suspended"}, 67997caa17caSRaphael Isemann {'h', "Show help dialog"}, 68007caa17caSRaphael Isemann {'n', "Step over (source line)"}, 68017caa17caSRaphael Isemann {'N', "Step over (single instruction)"}, 6802336c7029SLuboš Luňák {'f', "Step out (finish)"}, 68037caa17caSRaphael Isemann {'s', "Step in (source line)"}, 68047caa17caSRaphael Isemann {'S', "Step in (single instruction)"}, 680513978643SLuboš Luňák {'u', "Frame up"}, 680613978643SLuboš Luňák {'d', "Frame down"}, 68077caa17caSRaphael Isemann {',', "Page up"}, 68087caa17caSRaphael Isemann {'.', "Page down"}, 68097caa17caSRaphael Isemann {'\0', nullptr}}; 68107caa17caSRaphael Isemann return g_source_view_key_help; 68117caa17caSRaphael Isemann } 68127caa17caSRaphael Isemann 68137caa17caSRaphael Isemann bool WindowDelegateDraw(Window &window, bool force) override { 68147caa17caSRaphael Isemann ExecutionContext exe_ctx = 68157caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 68167caa17caSRaphael Isemann Process *process = exe_ctx.GetProcessPtr(); 68177caa17caSRaphael Isemann Thread *thread = nullptr; 68187caa17caSRaphael Isemann 68197caa17caSRaphael Isemann bool update_location = false; 68207caa17caSRaphael Isemann if (process) { 68217caa17caSRaphael Isemann StateType state = process->GetState(); 68227caa17caSRaphael Isemann if (StateIsStoppedState(state, true)) { 68237caa17caSRaphael Isemann // We are stopped, so it is ok to 68247caa17caSRaphael Isemann update_location = true; 68257caa17caSRaphael Isemann } 68267caa17caSRaphael Isemann } 68277caa17caSRaphael Isemann 68287caa17caSRaphael Isemann m_min_x = 1; 68297caa17caSRaphael Isemann m_min_y = 2; 68307caa17caSRaphael Isemann m_max_x = window.GetMaxX() - 1; 68317caa17caSRaphael Isemann m_max_y = window.GetMaxY() - 1; 68327caa17caSRaphael Isemann 68337caa17caSRaphael Isemann const uint32_t num_visible_lines = NumVisibleLines(); 68347caa17caSRaphael Isemann StackFrameSP frame_sp; 68357caa17caSRaphael Isemann bool set_selected_line_to_pc = false; 68367caa17caSRaphael Isemann 68377caa17caSRaphael Isemann if (update_location) { 68387caa17caSRaphael Isemann const bool process_alive = process ? process->IsAlive() : false; 68397caa17caSRaphael Isemann bool thread_changed = false; 68407caa17caSRaphael Isemann if (process_alive) { 68417caa17caSRaphael Isemann thread = exe_ctx.GetThreadPtr(); 68427caa17caSRaphael Isemann if (thread) { 68437caa17caSRaphael Isemann frame_sp = thread->GetSelectedFrame(); 68447caa17caSRaphael Isemann auto tid = thread->GetID(); 68457caa17caSRaphael Isemann thread_changed = tid != m_tid; 68467caa17caSRaphael Isemann m_tid = tid; 68477caa17caSRaphael Isemann } else { 68487caa17caSRaphael Isemann if (m_tid != LLDB_INVALID_THREAD_ID) { 68497caa17caSRaphael Isemann thread_changed = true; 68507caa17caSRaphael Isemann m_tid = LLDB_INVALID_THREAD_ID; 68517caa17caSRaphael Isemann } 68527caa17caSRaphael Isemann } 68537caa17caSRaphael Isemann } 68547caa17caSRaphael Isemann const uint32_t stop_id = process ? process->GetStopID() : 0; 68557caa17caSRaphael Isemann const bool stop_id_changed = stop_id != m_stop_id; 68567caa17caSRaphael Isemann bool frame_changed = false; 68577caa17caSRaphael Isemann m_stop_id = stop_id; 68587caa17caSRaphael Isemann m_title.Clear(); 68597caa17caSRaphael Isemann if (frame_sp) { 68607caa17caSRaphael Isemann m_sc = frame_sp->GetSymbolContext(eSymbolContextEverything); 68617caa17caSRaphael Isemann if (m_sc.module_sp) { 68627caa17caSRaphael Isemann m_title.Printf( 68637caa17caSRaphael Isemann "%s", m_sc.module_sp->GetFileSpec().GetFilename().GetCString()); 68647caa17caSRaphael Isemann ConstString func_name = m_sc.GetFunctionName(); 68657caa17caSRaphael Isemann if (func_name) 68667caa17caSRaphael Isemann m_title.Printf("`%s", func_name.GetCString()); 68677caa17caSRaphael Isemann } 68687caa17caSRaphael Isemann const uint32_t frame_idx = frame_sp->GetFrameIndex(); 68697caa17caSRaphael Isemann frame_changed = frame_idx != m_frame_idx; 68707caa17caSRaphael Isemann m_frame_idx = frame_idx; 68717caa17caSRaphael Isemann } else { 68727caa17caSRaphael Isemann m_sc.Clear(true); 68737caa17caSRaphael Isemann frame_changed = m_frame_idx != UINT32_MAX; 68747caa17caSRaphael Isemann m_frame_idx = UINT32_MAX; 68757caa17caSRaphael Isemann } 68767caa17caSRaphael Isemann 68777caa17caSRaphael Isemann const bool context_changed = 68787caa17caSRaphael Isemann thread_changed || frame_changed || stop_id_changed; 68797caa17caSRaphael Isemann 68807caa17caSRaphael Isemann if (process_alive) { 68817caa17caSRaphael Isemann if (m_sc.line_entry.IsValid()) { 68827caa17caSRaphael Isemann m_pc_line = m_sc.line_entry.line; 68837caa17caSRaphael Isemann if (m_pc_line != UINT32_MAX) 68847caa17caSRaphael Isemann --m_pc_line; // Convert to zero based line number... 68857caa17caSRaphael Isemann // Update the selected line if the stop ID changed... 68867caa17caSRaphael Isemann if (context_changed) 68877caa17caSRaphael Isemann m_selected_line = m_pc_line; 68887caa17caSRaphael Isemann 6889532290e6SPavel Labath if (m_file_sp && m_file_sp->GetFileSpec() == m_sc.line_entry.file) { 6890b26e1efcSOmar Emara // Same file, nothing to do, we should either have the lines or 6891b26e1efcSOmar Emara // not (source file missing) 68927caa17caSRaphael Isemann if (m_selected_line >= static_cast<size_t>(m_first_visible_line)) { 68937caa17caSRaphael Isemann if (m_selected_line >= m_first_visible_line + num_visible_lines) 68947caa17caSRaphael Isemann m_first_visible_line = m_selected_line - 10; 68957caa17caSRaphael Isemann } else { 68967caa17caSRaphael Isemann if (m_selected_line > 10) 68977caa17caSRaphael Isemann m_first_visible_line = m_selected_line - 10; 68987caa17caSRaphael Isemann else 68997caa17caSRaphael Isemann m_first_visible_line = 0; 69007caa17caSRaphael Isemann } 69017caa17caSRaphael Isemann } else { 69027caa17caSRaphael Isemann // File changed, set selected line to the line with the PC 69037caa17caSRaphael Isemann m_selected_line = m_pc_line; 69047caa17caSRaphael Isemann m_file_sp = 69057caa17caSRaphael Isemann m_debugger.GetSourceManager().GetFile(m_sc.line_entry.file); 69067caa17caSRaphael Isemann if (m_file_sp) { 69077caa17caSRaphael Isemann const size_t num_lines = m_file_sp->GetNumLines(); 69087caa17caSRaphael Isemann m_line_width = 1; 69097caa17caSRaphael Isemann for (size_t n = num_lines; n >= 10; n = n / 10) 69107caa17caSRaphael Isemann ++m_line_width; 69117caa17caSRaphael Isemann 69127caa17caSRaphael Isemann if (num_lines < num_visible_lines || 69137caa17caSRaphael Isemann m_selected_line < num_visible_lines) 69147caa17caSRaphael Isemann m_first_visible_line = 0; 69157caa17caSRaphael Isemann else 69167caa17caSRaphael Isemann m_first_visible_line = m_selected_line - 10; 69177caa17caSRaphael Isemann } 69187caa17caSRaphael Isemann } 69197caa17caSRaphael Isemann } else { 69207caa17caSRaphael Isemann m_file_sp.reset(); 69217caa17caSRaphael Isemann } 69227caa17caSRaphael Isemann 69237caa17caSRaphael Isemann if (!m_file_sp || m_file_sp->GetNumLines() == 0) { 69247caa17caSRaphael Isemann // Show disassembly 69257caa17caSRaphael Isemann bool prefer_file_cache = false; 69267caa17caSRaphael Isemann if (m_sc.function) { 69277caa17caSRaphael Isemann if (m_disassembly_scope != m_sc.function) { 69287caa17caSRaphael Isemann m_disassembly_scope = m_sc.function; 69297caa17caSRaphael Isemann m_disassembly_sp = m_sc.function->GetInstructions( 6930e9fe788dSJason Molenda exe_ctx, nullptr, !prefer_file_cache); 69317caa17caSRaphael Isemann if (m_disassembly_sp) { 69327caa17caSRaphael Isemann set_selected_line_to_pc = true; 69337caa17caSRaphael Isemann m_disassembly_range = m_sc.function->GetAddressRange(); 69347caa17caSRaphael Isemann } else { 69357caa17caSRaphael Isemann m_disassembly_range.Clear(); 69367caa17caSRaphael Isemann } 69377caa17caSRaphael Isemann } else { 69387caa17caSRaphael Isemann set_selected_line_to_pc = context_changed; 69397caa17caSRaphael Isemann } 69407caa17caSRaphael Isemann } else if (m_sc.symbol) { 69417caa17caSRaphael Isemann if (m_disassembly_scope != m_sc.symbol) { 69427caa17caSRaphael Isemann m_disassembly_scope = m_sc.symbol; 69437caa17caSRaphael Isemann m_disassembly_sp = m_sc.symbol->GetInstructions( 69447caa17caSRaphael Isemann exe_ctx, nullptr, prefer_file_cache); 69457caa17caSRaphael Isemann if (m_disassembly_sp) { 69467caa17caSRaphael Isemann set_selected_line_to_pc = true; 69477caa17caSRaphael Isemann m_disassembly_range.GetBaseAddress() = 69487caa17caSRaphael Isemann m_sc.symbol->GetAddress(); 69497caa17caSRaphael Isemann m_disassembly_range.SetByteSize(m_sc.symbol->GetByteSize()); 69507caa17caSRaphael Isemann } else { 69517caa17caSRaphael Isemann m_disassembly_range.Clear(); 69527caa17caSRaphael Isemann } 69537caa17caSRaphael Isemann } else { 69547caa17caSRaphael Isemann set_selected_line_to_pc = context_changed; 69557caa17caSRaphael Isemann } 69567caa17caSRaphael Isemann } 69577caa17caSRaphael Isemann } 69587caa17caSRaphael Isemann } else { 69597caa17caSRaphael Isemann m_pc_line = UINT32_MAX; 69607caa17caSRaphael Isemann } 69617caa17caSRaphael Isemann } 69627caa17caSRaphael Isemann 69637caa17caSRaphael Isemann const int window_width = window.GetWidth(); 69647caa17caSRaphael Isemann window.Erase(); 69657caa17caSRaphael Isemann window.DrawTitleBox("Sources"); 69667caa17caSRaphael Isemann if (!m_title.GetString().empty()) { 69677caa17caSRaphael Isemann window.AttributeOn(A_REVERSE); 69687caa17caSRaphael Isemann window.MoveCursor(1, 1); 69697caa17caSRaphael Isemann window.PutChar(' '); 6970fc0e8fb7SLuboš Luňák window.PutCStringTruncated(1, m_title.GetString().str().c_str()); 69717caa17caSRaphael Isemann int x = window.GetCursorX(); 69727caa17caSRaphael Isemann if (x < window_width - 1) { 69737caa17caSRaphael Isemann window.Printf("%*s", window_width - x - 1, ""); 69747caa17caSRaphael Isemann } 69757caa17caSRaphael Isemann window.AttributeOff(A_REVERSE); 69767caa17caSRaphael Isemann } 69777caa17caSRaphael Isemann 69787caa17caSRaphael Isemann Target *target = exe_ctx.GetTargetPtr(); 69797caa17caSRaphael Isemann const size_t num_source_lines = GetNumSourceLines(); 69807caa17caSRaphael Isemann if (num_source_lines > 0) { 69817caa17caSRaphael Isemann // Display source 69827caa17caSRaphael Isemann BreakpointLines bp_lines; 69837caa17caSRaphael Isemann if (target) { 69847caa17caSRaphael Isemann BreakpointList &bp_list = target->GetBreakpointList(); 69857caa17caSRaphael Isemann const size_t num_bps = bp_list.GetSize(); 69867caa17caSRaphael Isemann for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 69877caa17caSRaphael Isemann BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 69887caa17caSRaphael Isemann const size_t num_bps_locs = bp_sp->GetNumLocations(); 69897caa17caSRaphael Isemann for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; ++bp_loc_idx) { 69907caa17caSRaphael Isemann BreakpointLocationSP bp_loc_sp = 69917caa17caSRaphael Isemann bp_sp->GetLocationAtIndex(bp_loc_idx); 69927caa17caSRaphael Isemann LineEntry bp_loc_line_entry; 69937caa17caSRaphael Isemann if (bp_loc_sp->GetAddress().CalculateSymbolContextLineEntry( 69947caa17caSRaphael Isemann bp_loc_line_entry)) { 69957caa17caSRaphael Isemann if (m_file_sp->GetFileSpec() == bp_loc_line_entry.file) { 69967caa17caSRaphael Isemann bp_lines.insert(bp_loc_line_entry.line); 69977caa17caSRaphael Isemann } 69987caa17caSRaphael Isemann } 69997caa17caSRaphael Isemann } 70007caa17caSRaphael Isemann } 70017caa17caSRaphael Isemann } 70027caa17caSRaphael Isemann 70037caa17caSRaphael Isemann const attr_t selected_highlight_attr = A_REVERSE; 70044a8e4b5cSLuboš Luňák const attr_t pc_highlight_attr = COLOR_PAIR(BlackOnBlue); 70057caa17caSRaphael Isemann 70067caa17caSRaphael Isemann for (size_t i = 0; i < num_visible_lines; ++i) { 70077caa17caSRaphael Isemann const uint32_t curr_line = m_first_visible_line + i; 70087caa17caSRaphael Isemann if (curr_line < num_source_lines) { 70097caa17caSRaphael Isemann const int line_y = m_min_y + i; 70107caa17caSRaphael Isemann window.MoveCursor(1, line_y); 70117caa17caSRaphael Isemann const bool is_pc_line = curr_line == m_pc_line; 70127caa17caSRaphael Isemann const bool line_is_selected = m_selected_line == curr_line; 7013b26e1efcSOmar Emara // Highlight the line as the PC line first, then if the selected 7014b26e1efcSOmar Emara // line isn't the same as the PC line, highlight it differently 70157caa17caSRaphael Isemann attr_t highlight_attr = 0; 70167caa17caSRaphael Isemann attr_t bp_attr = 0; 70177caa17caSRaphael Isemann if (is_pc_line) 70187caa17caSRaphael Isemann highlight_attr = pc_highlight_attr; 70197caa17caSRaphael Isemann else if (line_is_selected) 70207caa17caSRaphael Isemann highlight_attr = selected_highlight_attr; 70217caa17caSRaphael Isemann 70227caa17caSRaphael Isemann if (bp_lines.find(curr_line + 1) != bp_lines.end()) 70234a8e4b5cSLuboš Luňák bp_attr = COLOR_PAIR(BlackOnWhite); 70247caa17caSRaphael Isemann 70257caa17caSRaphael Isemann if (bp_attr) 70267caa17caSRaphael Isemann window.AttributeOn(bp_attr); 70277caa17caSRaphael Isemann 70287caa17caSRaphael Isemann window.Printf(" %*u ", m_line_width, curr_line + 1); 70297caa17caSRaphael Isemann 70307caa17caSRaphael Isemann if (bp_attr) 70317caa17caSRaphael Isemann window.AttributeOff(bp_attr); 70327caa17caSRaphael Isemann 70337caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 70347caa17caSRaphael Isemann // Mark the line with the PC with a diamond 70357caa17caSRaphael Isemann if (is_pc_line) 70367caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 70377caa17caSRaphael Isemann else 70387caa17caSRaphael Isemann window.PutChar(' '); 70397caa17caSRaphael Isemann 70407caa17caSRaphael Isemann if (highlight_attr) 70417caa17caSRaphael Isemann window.AttributeOn(highlight_attr); 704214406ca0SLuboš Luňák 704314406ca0SLuboš Luňák StreamString lineStream; 704414406ca0SLuboš Luňák m_file_sp->DisplaySourceLines(curr_line + 1, {}, 0, 0, &lineStream); 704514406ca0SLuboš Luňák StringRef line = lineStream.GetString(); 704614406ca0SLuboš Luňák if (line.endswith("\n")) 704714406ca0SLuboš Luňák line = line.drop_back(); 7048dcd4589aSLuboš Luňák bool wasWritten = window.OutputColoredStringTruncated( 7049dcd4589aSLuboš Luňák 1, line, m_first_visible_column, line_is_selected); 7050dcd4589aSLuboš Luňák if (line_is_selected && !wasWritten) { 7051dcd4589aSLuboš Luňák // Draw an empty space to show the selected line if empty, 7052dcd4589aSLuboš Luňák // or draw '<' if nothing is visible because of scrolling too much 7053dcd4589aSLuboš Luňák // to the right. 7054dcd4589aSLuboš Luňák window.PutCStringTruncated( 7055dcd4589aSLuboš Luňák 1, line.empty() && m_first_visible_column == 0 ? " " : "<"); 7056dcd4589aSLuboš Luňák } 70577caa17caSRaphael Isemann 70587caa17caSRaphael Isemann if (is_pc_line && frame_sp && 70597caa17caSRaphael Isemann frame_sp->GetConcreteFrameIndex() == 0) { 70607caa17caSRaphael Isemann StopInfoSP stop_info_sp; 70617caa17caSRaphael Isemann if (thread) 70627caa17caSRaphael Isemann stop_info_sp = thread->GetStopInfo(); 70637caa17caSRaphael Isemann if (stop_info_sp) { 70647caa17caSRaphael Isemann const char *stop_description = stop_info_sp->GetDescription(); 70657caa17caSRaphael Isemann if (stop_description && stop_description[0]) { 70667caa17caSRaphael Isemann size_t stop_description_len = strlen(stop_description); 70677caa17caSRaphael Isemann int desc_x = window_width - stop_description_len - 16; 7068fc0e8fb7SLuboš Luňák if (desc_x - window.GetCursorX() > 0) 70697caa17caSRaphael Isemann window.Printf("%*s", desc_x - window.GetCursorX(), ""); 707014406ca0SLuboš Luňák window.MoveCursor(window_width - stop_description_len - 16, 7071fc0e8fb7SLuboš Luňák line_y); 70724a8e4b5cSLuboš Luňák const attr_t stop_reason_attr = COLOR_PAIR(WhiteOnBlue); 707314406ca0SLuboš Luňák window.AttributeOn(stop_reason_attr); 7074fc0e8fb7SLuboš Luňák window.PrintfTruncated(1, " <<< Thread %u: %s ", 7075fc0e8fb7SLuboš Luňák thread->GetIndexID(), stop_description); 707614406ca0SLuboš Luňák window.AttributeOff(stop_reason_attr); 70777caa17caSRaphael Isemann } 70787caa17caSRaphael Isemann } else { 70797caa17caSRaphael Isemann window.Printf("%*s", window_width - window.GetCursorX() - 1, ""); 70807caa17caSRaphael Isemann } 70817caa17caSRaphael Isemann } 70827caa17caSRaphael Isemann if (highlight_attr) 70837caa17caSRaphael Isemann window.AttributeOff(highlight_attr); 70847caa17caSRaphael Isemann } else { 70857caa17caSRaphael Isemann break; 70867caa17caSRaphael Isemann } 70877caa17caSRaphael Isemann } 70887caa17caSRaphael Isemann } else { 70897caa17caSRaphael Isemann size_t num_disassembly_lines = GetNumDisassemblyLines(); 70907caa17caSRaphael Isemann if (num_disassembly_lines > 0) { 70917caa17caSRaphael Isemann // Display disassembly 70927caa17caSRaphael Isemann BreakpointAddrs bp_file_addrs; 70937caa17caSRaphael Isemann Target *target = exe_ctx.GetTargetPtr(); 70947caa17caSRaphael Isemann if (target) { 70957caa17caSRaphael Isemann BreakpointList &bp_list = target->GetBreakpointList(); 70967caa17caSRaphael Isemann const size_t num_bps = bp_list.GetSize(); 70977caa17caSRaphael Isemann for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 70987caa17caSRaphael Isemann BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 70997caa17caSRaphael Isemann const size_t num_bps_locs = bp_sp->GetNumLocations(); 71007caa17caSRaphael Isemann for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; 71017caa17caSRaphael Isemann ++bp_loc_idx) { 71027caa17caSRaphael Isemann BreakpointLocationSP bp_loc_sp = 71037caa17caSRaphael Isemann bp_sp->GetLocationAtIndex(bp_loc_idx); 71047caa17caSRaphael Isemann LineEntry bp_loc_line_entry; 71057caa17caSRaphael Isemann const lldb::addr_t file_addr = 71067caa17caSRaphael Isemann bp_loc_sp->GetAddress().GetFileAddress(); 71077caa17caSRaphael Isemann if (file_addr != LLDB_INVALID_ADDRESS) { 71087caa17caSRaphael Isemann if (m_disassembly_range.ContainsFileAddress(file_addr)) 71097caa17caSRaphael Isemann bp_file_addrs.insert(file_addr); 71107caa17caSRaphael Isemann } 71117caa17caSRaphael Isemann } 71127caa17caSRaphael Isemann } 71137caa17caSRaphael Isemann } 71147caa17caSRaphael Isemann 71157caa17caSRaphael Isemann const attr_t selected_highlight_attr = A_REVERSE; 71164a8e4b5cSLuboš Luňák const attr_t pc_highlight_attr = COLOR_PAIR(WhiteOnBlue); 71177caa17caSRaphael Isemann 71187caa17caSRaphael Isemann StreamString strm; 71197caa17caSRaphael Isemann 71207caa17caSRaphael Isemann InstructionList &insts = m_disassembly_sp->GetInstructionList(); 71217caa17caSRaphael Isemann Address pc_address; 71227caa17caSRaphael Isemann 71237caa17caSRaphael Isemann if (frame_sp) 71247caa17caSRaphael Isemann pc_address = frame_sp->GetFrameCodeAddress(); 71257caa17caSRaphael Isemann const uint32_t pc_idx = 71267caa17caSRaphael Isemann pc_address.IsValid() 71277caa17caSRaphael Isemann ? insts.GetIndexOfInstructionAtAddress(pc_address) 71287caa17caSRaphael Isemann : UINT32_MAX; 71297caa17caSRaphael Isemann if (set_selected_line_to_pc) { 71307caa17caSRaphael Isemann m_selected_line = pc_idx; 71317caa17caSRaphael Isemann } 71327caa17caSRaphael Isemann 71337caa17caSRaphael Isemann const uint32_t non_visible_pc_offset = (num_visible_lines / 5); 71347caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) >= num_disassembly_lines) 71357caa17caSRaphael Isemann m_first_visible_line = 0; 71367caa17caSRaphael Isemann 71377caa17caSRaphael Isemann if (pc_idx < num_disassembly_lines) { 71387caa17caSRaphael Isemann if (pc_idx < static_cast<uint32_t>(m_first_visible_line) || 71397caa17caSRaphael Isemann pc_idx >= m_first_visible_line + num_visible_lines) 71407caa17caSRaphael Isemann m_first_visible_line = pc_idx - non_visible_pc_offset; 71417caa17caSRaphael Isemann } 71427caa17caSRaphael Isemann 71437caa17caSRaphael Isemann for (size_t i = 0; i < num_visible_lines; ++i) { 71447caa17caSRaphael Isemann const uint32_t inst_idx = m_first_visible_line + i; 71457caa17caSRaphael Isemann Instruction *inst = insts.GetInstructionAtIndex(inst_idx).get(); 71467caa17caSRaphael Isemann if (!inst) 71477caa17caSRaphael Isemann break; 71487caa17caSRaphael Isemann 71497caa17caSRaphael Isemann const int line_y = m_min_y + i; 71507caa17caSRaphael Isemann window.MoveCursor(1, line_y); 71517caa17caSRaphael Isemann const bool is_pc_line = frame_sp && inst_idx == pc_idx; 71527caa17caSRaphael Isemann const bool line_is_selected = m_selected_line == inst_idx; 7153b26e1efcSOmar Emara // Highlight the line as the PC line first, then if the selected 7154b26e1efcSOmar Emara // line isn't the same as the PC line, highlight it differently 71557caa17caSRaphael Isemann attr_t highlight_attr = 0; 71567caa17caSRaphael Isemann attr_t bp_attr = 0; 71577caa17caSRaphael Isemann if (is_pc_line) 71587caa17caSRaphael Isemann highlight_attr = pc_highlight_attr; 71597caa17caSRaphael Isemann else if (line_is_selected) 71607caa17caSRaphael Isemann highlight_attr = selected_highlight_attr; 71617caa17caSRaphael Isemann 71627caa17caSRaphael Isemann if (bp_file_addrs.find(inst->GetAddress().GetFileAddress()) != 71637caa17caSRaphael Isemann bp_file_addrs.end()) 71644a8e4b5cSLuboš Luňák bp_attr = COLOR_PAIR(BlackOnWhite); 71657caa17caSRaphael Isemann 71667caa17caSRaphael Isemann if (bp_attr) 71677caa17caSRaphael Isemann window.AttributeOn(bp_attr); 71687caa17caSRaphael Isemann 71697caa17caSRaphael Isemann window.Printf(" 0x%16.16llx ", 71707caa17caSRaphael Isemann static_cast<unsigned long long>( 71717caa17caSRaphael Isemann inst->GetAddress().GetLoadAddress(target))); 71727caa17caSRaphael Isemann 71737caa17caSRaphael Isemann if (bp_attr) 71747caa17caSRaphael Isemann window.AttributeOff(bp_attr); 71757caa17caSRaphael Isemann 71767caa17caSRaphael Isemann window.PutChar(ACS_VLINE); 71777caa17caSRaphael Isemann // Mark the line with the PC with a diamond 71787caa17caSRaphael Isemann if (is_pc_line) 71797caa17caSRaphael Isemann window.PutChar(ACS_DIAMOND); 71807caa17caSRaphael Isemann else 71817caa17caSRaphael Isemann window.PutChar(' '); 71827caa17caSRaphael Isemann 71837caa17caSRaphael Isemann if (highlight_attr) 71847caa17caSRaphael Isemann window.AttributeOn(highlight_attr); 71857caa17caSRaphael Isemann 71867caa17caSRaphael Isemann const char *mnemonic = inst->GetMnemonic(&exe_ctx); 71877caa17caSRaphael Isemann const char *operands = inst->GetOperands(&exe_ctx); 71887caa17caSRaphael Isemann const char *comment = inst->GetComment(&exe_ctx); 71897caa17caSRaphael Isemann 71907caa17caSRaphael Isemann if (mnemonic != nullptr && mnemonic[0] == '\0') 71917caa17caSRaphael Isemann mnemonic = nullptr; 71927caa17caSRaphael Isemann if (operands != nullptr && operands[0] == '\0') 71937caa17caSRaphael Isemann operands = nullptr; 71947caa17caSRaphael Isemann if (comment != nullptr && comment[0] == '\0') 71957caa17caSRaphael Isemann comment = nullptr; 71967caa17caSRaphael Isemann 71977caa17caSRaphael Isemann strm.Clear(); 71987caa17caSRaphael Isemann 71997caa17caSRaphael Isemann if (mnemonic != nullptr && operands != nullptr && comment != nullptr) 72007caa17caSRaphael Isemann strm.Printf("%-8s %-25s ; %s", mnemonic, operands, comment); 72017caa17caSRaphael Isemann else if (mnemonic != nullptr && operands != nullptr) 72027caa17caSRaphael Isemann strm.Printf("%-8s %s", mnemonic, operands); 72037caa17caSRaphael Isemann else if (mnemonic != nullptr) 72047caa17caSRaphael Isemann strm.Printf("%s", mnemonic); 72057caa17caSRaphael Isemann 72067caa17caSRaphael Isemann int right_pad = 1; 7207dcd4589aSLuboš Luňák window.PutCStringTruncated( 7208dcd4589aSLuboš Luňák right_pad, 7209dcd4589aSLuboš Luňák strm.GetString().substr(m_first_visible_column).data()); 72107caa17caSRaphael Isemann 72117caa17caSRaphael Isemann if (is_pc_line && frame_sp && 72127caa17caSRaphael Isemann frame_sp->GetConcreteFrameIndex() == 0) { 72137caa17caSRaphael Isemann StopInfoSP stop_info_sp; 72147caa17caSRaphael Isemann if (thread) 72157caa17caSRaphael Isemann stop_info_sp = thread->GetStopInfo(); 72167caa17caSRaphael Isemann if (stop_info_sp) { 72177caa17caSRaphael Isemann const char *stop_description = stop_info_sp->GetDescription(); 72187caa17caSRaphael Isemann if (stop_description && stop_description[0]) { 72197caa17caSRaphael Isemann size_t stop_description_len = strlen(stop_description); 72207caa17caSRaphael Isemann int desc_x = window_width - stop_description_len - 16; 7221fc0e8fb7SLuboš Luňák if (desc_x - window.GetCursorX() > 0) 72227caa17caSRaphael Isemann window.Printf("%*s", desc_x - window.GetCursorX(), ""); 7223fc0e8fb7SLuboš Luňák window.MoveCursor(window_width - stop_description_len - 15, 7224fc0e8fb7SLuboš Luňák line_y); 7225fc0e8fb7SLuboš Luňák window.PrintfTruncated(1, "<<< Thread %u: %s ", 7226fc0e8fb7SLuboš Luňák thread->GetIndexID(), stop_description); 72277caa17caSRaphael Isemann } 72287caa17caSRaphael Isemann } else { 72297caa17caSRaphael Isemann window.Printf("%*s", window_width - window.GetCursorX() - 1, ""); 72307caa17caSRaphael Isemann } 72317caa17caSRaphael Isemann } 72327caa17caSRaphael Isemann if (highlight_attr) 72337caa17caSRaphael Isemann window.AttributeOff(highlight_attr); 72347caa17caSRaphael Isemann } 72357caa17caSRaphael Isemann } 72367caa17caSRaphael Isemann } 72377caa17caSRaphael Isemann return true; // Drawing handled 72387caa17caSRaphael Isemann } 72397caa17caSRaphael Isemann 72407caa17caSRaphael Isemann size_t GetNumLines() { 72417caa17caSRaphael Isemann size_t num_lines = GetNumSourceLines(); 72427caa17caSRaphael Isemann if (num_lines == 0) 72437caa17caSRaphael Isemann num_lines = GetNumDisassemblyLines(); 72447caa17caSRaphael Isemann return num_lines; 72457caa17caSRaphael Isemann } 72467caa17caSRaphael Isemann 72477caa17caSRaphael Isemann size_t GetNumSourceLines() const { 72487caa17caSRaphael Isemann if (m_file_sp) 72497caa17caSRaphael Isemann return m_file_sp->GetNumLines(); 72507caa17caSRaphael Isemann return 0; 72517caa17caSRaphael Isemann } 72527caa17caSRaphael Isemann 72537caa17caSRaphael Isemann size_t GetNumDisassemblyLines() const { 72547caa17caSRaphael Isemann if (m_disassembly_sp) 72557caa17caSRaphael Isemann return m_disassembly_sp->GetInstructionList().GetSize(); 72567caa17caSRaphael Isemann return 0; 72577caa17caSRaphael Isemann } 72587caa17caSRaphael Isemann 72597caa17caSRaphael Isemann HandleCharResult WindowDelegateHandleChar(Window &window, int c) override { 72607caa17caSRaphael Isemann const uint32_t num_visible_lines = NumVisibleLines(); 72617caa17caSRaphael Isemann const size_t num_lines = GetNumLines(); 72627caa17caSRaphael Isemann 72637caa17caSRaphael Isemann switch (c) { 72647caa17caSRaphael Isemann case ',': 72657caa17caSRaphael Isemann case KEY_PPAGE: 72667caa17caSRaphael Isemann // Page up key 72677caa17caSRaphael Isemann if (static_cast<uint32_t>(m_first_visible_line) > num_visible_lines) 72687caa17caSRaphael Isemann m_first_visible_line -= num_visible_lines; 72697caa17caSRaphael Isemann else 72707caa17caSRaphael Isemann m_first_visible_line = 0; 72717caa17caSRaphael Isemann m_selected_line = m_first_visible_line; 72727caa17caSRaphael Isemann return eKeyHandled; 72737caa17caSRaphael Isemann 72747caa17caSRaphael Isemann case '.': 72757caa17caSRaphael Isemann case KEY_NPAGE: 72767caa17caSRaphael Isemann // Page down key 72777caa17caSRaphael Isemann { 72787caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < num_lines) 72797caa17caSRaphael Isemann m_first_visible_line += num_visible_lines; 72807caa17caSRaphael Isemann else if (num_lines < num_visible_lines) 72817caa17caSRaphael Isemann m_first_visible_line = 0; 72827caa17caSRaphael Isemann else 72837caa17caSRaphael Isemann m_first_visible_line = num_lines - num_visible_lines; 72847caa17caSRaphael Isemann m_selected_line = m_first_visible_line; 72857caa17caSRaphael Isemann } 72867caa17caSRaphael Isemann return eKeyHandled; 72877caa17caSRaphael Isemann 72887caa17caSRaphael Isemann case KEY_UP: 72897caa17caSRaphael Isemann if (m_selected_line > 0) { 72907caa17caSRaphael Isemann m_selected_line--; 72917caa17caSRaphael Isemann if (static_cast<size_t>(m_first_visible_line) > m_selected_line) 72927caa17caSRaphael Isemann m_first_visible_line = m_selected_line; 72937caa17caSRaphael Isemann } 72947caa17caSRaphael Isemann return eKeyHandled; 72957caa17caSRaphael Isemann 72967caa17caSRaphael Isemann case KEY_DOWN: 72977caa17caSRaphael Isemann if (m_selected_line + 1 < num_lines) { 72987caa17caSRaphael Isemann m_selected_line++; 72997caa17caSRaphael Isemann if (m_first_visible_line + num_visible_lines < m_selected_line) 73007caa17caSRaphael Isemann m_first_visible_line++; 73017caa17caSRaphael Isemann } 73027caa17caSRaphael Isemann return eKeyHandled; 73037caa17caSRaphael Isemann 7304dcd4589aSLuboš Luňák case KEY_LEFT: 7305dcd4589aSLuboš Luňák if (m_first_visible_column > 0) 7306dcd4589aSLuboš Luňák --m_first_visible_column; 7307dcd4589aSLuboš Luňák return eKeyHandled; 7308dcd4589aSLuboš Luňák 7309dcd4589aSLuboš Luňák case KEY_RIGHT: 7310dcd4589aSLuboš Luňák ++m_first_visible_column; 7311dcd4589aSLuboš Luňák return eKeyHandled; 7312dcd4589aSLuboš Luňák 73137caa17caSRaphael Isemann case '\r': 73147caa17caSRaphael Isemann case '\n': 73157caa17caSRaphael Isemann case KEY_ENTER: 73167caa17caSRaphael Isemann // Set a breakpoint and run to the line using a one shot breakpoint 73177caa17caSRaphael Isemann if (GetNumSourceLines() > 0) { 73187caa17caSRaphael Isemann ExecutionContext exe_ctx = 73197caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73207caa17caSRaphael Isemann if (exe_ctx.HasProcessScope() && exe_ctx.GetProcessRef().IsAlive()) { 73217caa17caSRaphael Isemann BreakpointSP bp_sp = exe_ctx.GetTargetRef().CreateBreakpoint( 73227caa17caSRaphael Isemann nullptr, // Don't limit the breakpoint to certain modules 73237caa17caSRaphael Isemann m_file_sp->GetFileSpec(), // Source file 73247caa17caSRaphael Isemann m_selected_line + 73257caa17caSRaphael Isemann 1, // Source line number (m_selected_line is zero based) 73267caa17caSRaphael Isemann 0, // Unspecified column. 73277caa17caSRaphael Isemann 0, // No offset 73287caa17caSRaphael Isemann eLazyBoolCalculate, // Check inlines using global setting 73297caa17caSRaphael Isemann eLazyBoolCalculate, // Skip prologue using global setting, 73307caa17caSRaphael Isemann false, // internal 73317caa17caSRaphael Isemann false, // request_hardware 73327caa17caSRaphael Isemann eLazyBoolCalculate); // move_to_nearest_code 73337caa17caSRaphael Isemann // Make breakpoint one shot 7334cfb96d84SJim Ingham bp_sp->GetOptions().SetOneShot(true); 73357caa17caSRaphael Isemann exe_ctx.GetProcessRef().Resume(); 73367caa17caSRaphael Isemann } 73377caa17caSRaphael Isemann } else if (m_selected_line < GetNumDisassemblyLines()) { 73387caa17caSRaphael Isemann const Instruction *inst = m_disassembly_sp->GetInstructionList() 73397caa17caSRaphael Isemann .GetInstructionAtIndex(m_selected_line) 73407caa17caSRaphael Isemann .get(); 73417caa17caSRaphael Isemann ExecutionContext exe_ctx = 73427caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73437caa17caSRaphael Isemann if (exe_ctx.HasTargetScope()) { 73447caa17caSRaphael Isemann Address addr = inst->GetAddress(); 73457caa17caSRaphael Isemann BreakpointSP bp_sp = exe_ctx.GetTargetRef().CreateBreakpoint( 73467caa17caSRaphael Isemann addr, // lldb_private::Address 73477caa17caSRaphael Isemann false, // internal 73487caa17caSRaphael Isemann false); // request_hardware 73497caa17caSRaphael Isemann // Make breakpoint one shot 7350cfb96d84SJim Ingham bp_sp->GetOptions().SetOneShot(true); 73517caa17caSRaphael Isemann exe_ctx.GetProcessRef().Resume(); 73527caa17caSRaphael Isemann } 73537caa17caSRaphael Isemann } 73547caa17caSRaphael Isemann return eKeyHandled; 73557caa17caSRaphael Isemann 73567caa17caSRaphael Isemann case 'b': // 'b' == toggle breakpoint on currently selected line 7357d6868d9cSLuboš Luňák ToggleBreakpointOnSelectedLine(); 73587caa17caSRaphael Isemann return eKeyHandled; 73597caa17caSRaphael Isemann 73607caa17caSRaphael Isemann case 'D': // 'D' == detach and keep stopped 73617caa17caSRaphael Isemann { 73627caa17caSRaphael Isemann ExecutionContext exe_ctx = 73637caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73647caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) 736547d2c7cdSLuboš Luňák exe_ctx.GetProcessRef().Detach(true); 73667caa17caSRaphael Isemann } 73677caa17caSRaphael Isemann return eKeyHandled; 73687caa17caSRaphael Isemann 73697caa17caSRaphael Isemann case 'c': 73707caa17caSRaphael Isemann // 'c' == continue 73717caa17caSRaphael Isemann { 73727caa17caSRaphael Isemann ExecutionContext exe_ctx = 73737caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73747caa17caSRaphael Isemann if (exe_ctx.HasProcessScope()) 73757caa17caSRaphael Isemann exe_ctx.GetProcessRef().Resume(); 73767caa17caSRaphael Isemann } 73777caa17caSRaphael Isemann return eKeyHandled; 73787caa17caSRaphael Isemann 7379336c7029SLuboš Luňák case 'f': 7380336c7029SLuboš Luňák // 'f' == step out (finish) 73817caa17caSRaphael Isemann { 73827caa17caSRaphael Isemann ExecutionContext exe_ctx = 73837caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73847caa17caSRaphael Isemann if (exe_ctx.HasThreadScope() && 73857caa17caSRaphael Isemann StateIsStoppedState(exe_ctx.GetProcessRef().GetState(), true)) { 73867caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOut(); 73877caa17caSRaphael Isemann } 73887caa17caSRaphael Isemann } 73897caa17caSRaphael Isemann return eKeyHandled; 73907caa17caSRaphael Isemann 73917caa17caSRaphael Isemann case 'n': // 'n' == step over 73927caa17caSRaphael Isemann case 'N': // 'N' == step over instruction 73937caa17caSRaphael Isemann { 73947caa17caSRaphael Isemann ExecutionContext exe_ctx = 73957caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 73967caa17caSRaphael Isemann if (exe_ctx.HasThreadScope() && 73977caa17caSRaphael Isemann StateIsStoppedState(exe_ctx.GetProcessRef().GetState(), true)) { 73987caa17caSRaphael Isemann bool source_step = (c == 'n'); 73997caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepOver(source_step); 74007caa17caSRaphael Isemann } 74017caa17caSRaphael Isemann } 74027caa17caSRaphael Isemann return eKeyHandled; 74037caa17caSRaphael Isemann 74047caa17caSRaphael Isemann case 's': // 's' == step into 74057caa17caSRaphael Isemann case 'S': // 'S' == step into instruction 74067caa17caSRaphael Isemann { 74077caa17caSRaphael Isemann ExecutionContext exe_ctx = 74087caa17caSRaphael Isemann m_debugger.GetCommandInterpreter().GetExecutionContext(); 74097caa17caSRaphael Isemann if (exe_ctx.HasThreadScope() && 74107caa17caSRaphael Isemann StateIsStoppedState(exe_ctx.GetProcessRef().GetState(), true)) { 74117caa17caSRaphael Isemann bool source_step = (c == 's'); 74127caa17caSRaphael Isemann exe_ctx.GetThreadRef().StepIn(source_step); 74137caa17caSRaphael Isemann } 74147caa17caSRaphael Isemann } 74157caa17caSRaphael Isemann return eKeyHandled; 74167caa17caSRaphael Isemann 741713978643SLuboš Luňák case 'u': // 'u' == frame up 741813978643SLuboš Luňák case 'd': // 'd' == frame down 741913978643SLuboš Luňák { 742013978643SLuboš Luňák ExecutionContext exe_ctx = 742113978643SLuboš Luňák m_debugger.GetCommandInterpreter().GetExecutionContext(); 742213978643SLuboš Luňák if (exe_ctx.HasThreadScope()) { 742313978643SLuboš Luňák Thread *thread = exe_ctx.GetThreadPtr(); 742413978643SLuboš Luňák uint32_t frame_idx = thread->GetSelectedFrameIndex(); 742513978643SLuboš Luňák if (frame_idx == UINT32_MAX) 742613978643SLuboš Luňák frame_idx = 0; 742713978643SLuboš Luňák if (c == 'u' && frame_idx + 1 < thread->GetStackFrameCount()) 742813978643SLuboš Luňák ++frame_idx; 742913978643SLuboš Luňák else if (c == 'd' && frame_idx > 0) 743013978643SLuboš Luňák --frame_idx; 743113978643SLuboš Luňák if (thread->SetSelectedFrameByIndex(frame_idx, true)) 743213978643SLuboš Luňák exe_ctx.SetFrameSP(thread->GetSelectedFrame()); 743313978643SLuboš Luňák } 743413978643SLuboš Luňák } 743513978643SLuboš Luňák return eKeyHandled; 743613978643SLuboš Luňák 74377caa17caSRaphael Isemann case 'h': 74387caa17caSRaphael Isemann window.CreateHelpSubwindow(); 74397caa17caSRaphael Isemann return eKeyHandled; 74407caa17caSRaphael Isemann 74417caa17caSRaphael Isemann default: 74427caa17caSRaphael Isemann break; 74437caa17caSRaphael Isemann } 74447caa17caSRaphael Isemann return eKeyNotHandled; 74457caa17caSRaphael Isemann } 74467caa17caSRaphael Isemann 7447d6868d9cSLuboš Luňák void ToggleBreakpointOnSelectedLine() { 7448d6868d9cSLuboš Luňák ExecutionContext exe_ctx = 7449d6868d9cSLuboš Luňák m_debugger.GetCommandInterpreter().GetExecutionContext(); 7450d6868d9cSLuboš Luňák if (!exe_ctx.HasTargetScope()) 7451d6868d9cSLuboš Luňák return; 7452d6868d9cSLuboš Luňák if (GetNumSourceLines() > 0) { 7453d6868d9cSLuboš Luňák // Source file breakpoint. 7454d6868d9cSLuboš Luňák BreakpointList &bp_list = exe_ctx.GetTargetRef().GetBreakpointList(); 7455d6868d9cSLuboš Luňák const size_t num_bps = bp_list.GetSize(); 7456d6868d9cSLuboš Luňák for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 7457d6868d9cSLuboš Luňák BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 7458d6868d9cSLuboš Luňák const size_t num_bps_locs = bp_sp->GetNumLocations(); 7459d6868d9cSLuboš Luňák for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; ++bp_loc_idx) { 7460d6868d9cSLuboš Luňák BreakpointLocationSP bp_loc_sp = 7461d6868d9cSLuboš Luňák bp_sp->GetLocationAtIndex(bp_loc_idx); 7462d6868d9cSLuboš Luňák LineEntry bp_loc_line_entry; 7463d6868d9cSLuboš Luňák if (bp_loc_sp->GetAddress().CalculateSymbolContextLineEntry( 7464d6868d9cSLuboš Luňák bp_loc_line_entry)) { 7465d6868d9cSLuboš Luňák if (m_file_sp->GetFileSpec() == bp_loc_line_entry.file && 7466d6868d9cSLuboš Luňák m_selected_line + 1 == bp_loc_line_entry.line) { 7467d6868d9cSLuboš Luňák bool removed = 7468d6868d9cSLuboš Luňák exe_ctx.GetTargetRef().RemoveBreakpointByID(bp_sp->GetID()); 7469d6868d9cSLuboš Luňák assert(removed); 7470d6868d9cSLuboš Luňák UNUSED_IF_ASSERT_DISABLED(removed); 7471d6868d9cSLuboš Luňák return; // Existing breakpoint removed. 7472d6868d9cSLuboš Luňák } 7473d6868d9cSLuboš Luňák } 7474d6868d9cSLuboš Luňák } 7475d6868d9cSLuboš Luňák } 7476d6868d9cSLuboš Luňák // No breakpoint found on the location, add it. 7477d6868d9cSLuboš Luňák BreakpointSP bp_sp = exe_ctx.GetTargetRef().CreateBreakpoint( 7478d6868d9cSLuboš Luňák nullptr, // Don't limit the breakpoint to certain modules 7479d6868d9cSLuboš Luňák m_file_sp->GetFileSpec(), // Source file 7480d6868d9cSLuboš Luňák m_selected_line + 7481d6868d9cSLuboš Luňák 1, // Source line number (m_selected_line is zero based) 7482d6868d9cSLuboš Luňák 0, // No column specified. 7483d6868d9cSLuboš Luňák 0, // No offset 7484d6868d9cSLuboš Luňák eLazyBoolCalculate, // Check inlines using global setting 7485d6868d9cSLuboš Luňák eLazyBoolCalculate, // Skip prologue using global setting, 7486d6868d9cSLuboš Luňák false, // internal 7487d6868d9cSLuboš Luňák false, // request_hardware 7488d6868d9cSLuboš Luňák eLazyBoolCalculate); // move_to_nearest_code 7489d6868d9cSLuboš Luňák } else { 7490d6868d9cSLuboš Luňák // Disassembly breakpoint. 7491d6868d9cSLuboš Luňák assert(GetNumDisassemblyLines() > 0); 7492d6868d9cSLuboš Luňák assert(m_selected_line < GetNumDisassemblyLines()); 7493d6868d9cSLuboš Luňák const Instruction *inst = m_disassembly_sp->GetInstructionList() 7494d6868d9cSLuboš Luňák .GetInstructionAtIndex(m_selected_line) 7495d6868d9cSLuboš Luňák .get(); 7496d6868d9cSLuboš Luňák Address addr = inst->GetAddress(); 7497d6868d9cSLuboš Luňák // Try to find it. 7498d6868d9cSLuboš Luňák BreakpointList &bp_list = exe_ctx.GetTargetRef().GetBreakpointList(); 7499d6868d9cSLuboš Luňák const size_t num_bps = bp_list.GetSize(); 7500d6868d9cSLuboš Luňák for (size_t bp_idx = 0; bp_idx < num_bps; ++bp_idx) { 7501d6868d9cSLuboš Luňák BreakpointSP bp_sp = bp_list.GetBreakpointAtIndex(bp_idx); 7502d6868d9cSLuboš Luňák const size_t num_bps_locs = bp_sp->GetNumLocations(); 7503d6868d9cSLuboš Luňák for (size_t bp_loc_idx = 0; bp_loc_idx < num_bps_locs; ++bp_loc_idx) { 7504d6868d9cSLuboš Luňák BreakpointLocationSP bp_loc_sp = 7505d6868d9cSLuboš Luňák bp_sp->GetLocationAtIndex(bp_loc_idx); 7506d6868d9cSLuboš Luňák LineEntry bp_loc_line_entry; 7507d6868d9cSLuboš Luňák const lldb::addr_t file_addr = 7508d6868d9cSLuboš Luňák bp_loc_sp->GetAddress().GetFileAddress(); 7509d6868d9cSLuboš Luňák if (file_addr == addr.GetFileAddress()) { 7510d6868d9cSLuboš Luňák bool removed = 7511d6868d9cSLuboš Luňák exe_ctx.GetTargetRef().RemoveBreakpointByID(bp_sp->GetID()); 7512d6868d9cSLuboš Luňák assert(removed); 7513d6868d9cSLuboš Luňák UNUSED_IF_ASSERT_DISABLED(removed); 7514d6868d9cSLuboš Luňák return; // Existing breakpoint removed. 7515d6868d9cSLuboš Luňák } 7516d6868d9cSLuboš Luňák } 7517d6868d9cSLuboš Luňák } 7518d6868d9cSLuboš Luňák // No breakpoint found on the address, add it. 7519d6868d9cSLuboš Luňák BreakpointSP bp_sp = 7520d6868d9cSLuboš Luňák exe_ctx.GetTargetRef().CreateBreakpoint(addr, // lldb_private::Address 7521d6868d9cSLuboš Luňák false, // internal 7522d6868d9cSLuboš Luňák false); // request_hardware 7523d6868d9cSLuboš Luňák } 7524d6868d9cSLuboš Luňák } 7525d6868d9cSLuboš Luňák 75267caa17caSRaphael Isemann protected: 75277caa17caSRaphael Isemann typedef std::set<uint32_t> BreakpointLines; 75287caa17caSRaphael Isemann typedef std::set<lldb::addr_t> BreakpointAddrs; 75297caa17caSRaphael Isemann 75307caa17caSRaphael Isemann Debugger &m_debugger; 75317caa17caSRaphael Isemann SymbolContext m_sc; 75327caa17caSRaphael Isemann SourceManager::FileSP m_file_sp; 75337caa17caSRaphael Isemann SymbolContextScope *m_disassembly_scope; 75347caa17caSRaphael Isemann lldb::DisassemblerSP m_disassembly_sp; 75357caa17caSRaphael Isemann AddressRange m_disassembly_range; 75367caa17caSRaphael Isemann StreamString m_title; 75377caa17caSRaphael Isemann lldb::user_id_t m_tid; 75387caa17caSRaphael Isemann int m_line_width; 75397caa17caSRaphael Isemann uint32_t m_selected_line; // The selected line 75407caa17caSRaphael Isemann uint32_t m_pc_line; // The line with the PC 75417caa17caSRaphael Isemann uint32_t m_stop_id; 75427caa17caSRaphael Isemann uint32_t m_frame_idx; 75437caa17caSRaphael Isemann int m_first_visible_line; 7544dcd4589aSLuboš Luňák int m_first_visible_column; 75457caa17caSRaphael Isemann int m_min_x; 75467caa17caSRaphael Isemann int m_min_y; 75477caa17caSRaphael Isemann int m_max_x; 75487caa17caSRaphael Isemann int m_max_y; 75497caa17caSRaphael Isemann }; 75507caa17caSRaphael Isemann 75517caa17caSRaphael Isemann DisplayOptions ValueObjectListDelegate::g_options = {true}; 75527caa17caSRaphael Isemann 75537caa17caSRaphael Isemann IOHandlerCursesGUI::IOHandlerCursesGUI(Debugger &debugger) 75547caa17caSRaphael Isemann : IOHandler(debugger, IOHandler::Type::Curses) {} 75557caa17caSRaphael Isemann 75567caa17caSRaphael Isemann void IOHandlerCursesGUI::Activate() { 75577caa17caSRaphael Isemann IOHandler::Activate(); 75587caa17caSRaphael Isemann if (!m_app_ap) { 755906412daeSJonas Devlieghere m_app_ap = std::make_unique<Application>(GetInputFILE(), GetOutputFILE()); 75607caa17caSRaphael Isemann 75617caa17caSRaphael Isemann // This is both a window and a menu delegate 75627caa17caSRaphael Isemann std::shared_ptr<ApplicationDelegate> app_delegate_sp( 75637caa17caSRaphael Isemann new ApplicationDelegate(*m_app_ap, m_debugger)); 75647caa17caSRaphael Isemann 75657caa17caSRaphael Isemann MenuDelegateSP app_menu_delegate_sp = 75667caa17caSRaphael Isemann std::static_pointer_cast<MenuDelegate>(app_delegate_sp); 75677caa17caSRaphael Isemann MenuSP lldb_menu_sp( 75687caa17caSRaphael Isemann new Menu("LLDB", "F1", KEY_F(1), ApplicationDelegate::eMenuID_LLDB)); 75697caa17caSRaphael Isemann MenuSP exit_menuitem_sp( 75707caa17caSRaphael Isemann new Menu("Exit", nullptr, 'x', ApplicationDelegate::eMenuID_LLDBExit)); 75717caa17caSRaphael Isemann exit_menuitem_sp->SetCannedResult(MenuActionResult::Quit); 75727caa17caSRaphael Isemann lldb_menu_sp->AddSubmenu(MenuSP(new Menu( 75737caa17caSRaphael Isemann "About LLDB", nullptr, 'a', ApplicationDelegate::eMenuID_LLDBAbout))); 75747caa17caSRaphael Isemann lldb_menu_sp->AddSubmenu(MenuSP(new Menu(Menu::Type::Separator))); 75757caa17caSRaphael Isemann lldb_menu_sp->AddSubmenu(exit_menuitem_sp); 75767caa17caSRaphael Isemann 75777caa17caSRaphael Isemann MenuSP target_menu_sp(new Menu("Target", "F2", KEY_F(2), 75787caa17caSRaphael Isemann ApplicationDelegate::eMenuID_Target)); 75797caa17caSRaphael Isemann target_menu_sp->AddSubmenu(MenuSP(new Menu( 75807caa17caSRaphael Isemann "Create", nullptr, 'c', ApplicationDelegate::eMenuID_TargetCreate))); 75817caa17caSRaphael Isemann target_menu_sp->AddSubmenu(MenuSP(new Menu( 75827caa17caSRaphael Isemann "Delete", nullptr, 'd', ApplicationDelegate::eMenuID_TargetDelete))); 75837caa17caSRaphael Isemann 75847caa17caSRaphael Isemann MenuSP process_menu_sp(new Menu("Process", "F3", KEY_F(3), 75857caa17caSRaphael Isemann ApplicationDelegate::eMenuID_Process)); 75867caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 75877caa17caSRaphael Isemann "Attach", nullptr, 'a', ApplicationDelegate::eMenuID_ProcessAttach))); 758847d2c7cdSLuboš Luňák process_menu_sp->AddSubmenu( 758947d2c7cdSLuboš Luňák MenuSP(new Menu("Detach and resume", nullptr, 'd', 759047d2c7cdSLuboš Luňák ApplicationDelegate::eMenuID_ProcessDetachResume))); 759147d2c7cdSLuboš Luňák process_menu_sp->AddSubmenu( 759247d2c7cdSLuboš Luňák MenuSP(new Menu("Detach suspended", nullptr, 's', 759347d2c7cdSLuboš Luňák ApplicationDelegate::eMenuID_ProcessDetachSuspended))); 75947caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 75957caa17caSRaphael Isemann "Launch", nullptr, 'l', ApplicationDelegate::eMenuID_ProcessLaunch))); 75967caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu(Menu::Type::Separator))); 75977caa17caSRaphael Isemann process_menu_sp->AddSubmenu( 75987caa17caSRaphael Isemann MenuSP(new Menu("Continue", nullptr, 'c', 75997caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ProcessContinue))); 76007caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 76017caa17caSRaphael Isemann "Halt", nullptr, 'h', ApplicationDelegate::eMenuID_ProcessHalt))); 76027caa17caSRaphael Isemann process_menu_sp->AddSubmenu(MenuSP(new Menu( 76037caa17caSRaphael Isemann "Kill", nullptr, 'k', ApplicationDelegate::eMenuID_ProcessKill))); 76047caa17caSRaphael Isemann 76057caa17caSRaphael Isemann MenuSP thread_menu_sp(new Menu("Thread", "F4", KEY_F(4), 76067caa17caSRaphael Isemann ApplicationDelegate::eMenuID_Thread)); 76077caa17caSRaphael Isemann thread_menu_sp->AddSubmenu(MenuSP(new Menu( 76087caa17caSRaphael Isemann "Step In", nullptr, 'i', ApplicationDelegate::eMenuID_ThreadStepIn))); 76097caa17caSRaphael Isemann thread_menu_sp->AddSubmenu( 76107caa17caSRaphael Isemann MenuSP(new Menu("Step Over", nullptr, 'v', 76117caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ThreadStepOver))); 76127caa17caSRaphael Isemann thread_menu_sp->AddSubmenu(MenuSP(new Menu( 76137caa17caSRaphael Isemann "Step Out", nullptr, 'o', ApplicationDelegate::eMenuID_ThreadStepOut))); 76147caa17caSRaphael Isemann 76157caa17caSRaphael Isemann MenuSP view_menu_sp( 76167caa17caSRaphael Isemann new Menu("View", "F5", KEY_F(5), ApplicationDelegate::eMenuID_View)); 76177caa17caSRaphael Isemann view_menu_sp->AddSubmenu( 7618b26e1efcSOmar Emara MenuSP(new Menu("Backtrace", nullptr, 't', 76197caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ViewBacktrace))); 76207caa17caSRaphael Isemann view_menu_sp->AddSubmenu( 76217caa17caSRaphael Isemann MenuSP(new Menu("Registers", nullptr, 'r', 76227caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ViewRegisters))); 76237caa17caSRaphael Isemann view_menu_sp->AddSubmenu(MenuSP(new Menu( 76247caa17caSRaphael Isemann "Source", nullptr, 's', ApplicationDelegate::eMenuID_ViewSource))); 76257caa17caSRaphael Isemann view_menu_sp->AddSubmenu( 76267caa17caSRaphael Isemann MenuSP(new Menu("Variables", nullptr, 'v', 76277caa17caSRaphael Isemann ApplicationDelegate::eMenuID_ViewVariables))); 7628b26e1efcSOmar Emara view_menu_sp->AddSubmenu( 7629b26e1efcSOmar Emara MenuSP(new Menu("Breakpoints", nullptr, 'b', 7630b26e1efcSOmar Emara ApplicationDelegate::eMenuID_ViewBreakpoints))); 76317caa17caSRaphael Isemann 76327caa17caSRaphael Isemann MenuSP help_menu_sp( 76337caa17caSRaphael Isemann new Menu("Help", "F6", KEY_F(6), ApplicationDelegate::eMenuID_Help)); 76347caa17caSRaphael Isemann help_menu_sp->AddSubmenu(MenuSP(new Menu( 76357caa17caSRaphael Isemann "GUI Help", nullptr, 'g', ApplicationDelegate::eMenuID_HelpGUIHelp))); 76367caa17caSRaphael Isemann 76377caa17caSRaphael Isemann m_app_ap->Initialize(); 76387caa17caSRaphael Isemann WindowSP &main_window_sp = m_app_ap->GetMainWindow(); 76397caa17caSRaphael Isemann 76407caa17caSRaphael Isemann MenuSP menubar_sp(new Menu(Menu::Type::Bar)); 76417caa17caSRaphael Isemann menubar_sp->AddSubmenu(lldb_menu_sp); 76427caa17caSRaphael Isemann menubar_sp->AddSubmenu(target_menu_sp); 76437caa17caSRaphael Isemann menubar_sp->AddSubmenu(process_menu_sp); 76447caa17caSRaphael Isemann menubar_sp->AddSubmenu(thread_menu_sp); 76457caa17caSRaphael Isemann menubar_sp->AddSubmenu(view_menu_sp); 76467caa17caSRaphael Isemann menubar_sp->AddSubmenu(help_menu_sp); 76477caa17caSRaphael Isemann menubar_sp->SetDelegate(app_menu_delegate_sp); 76487caa17caSRaphael Isemann 76497caa17caSRaphael Isemann Rect content_bounds = main_window_sp->GetFrame(); 76507caa17caSRaphael Isemann Rect menubar_bounds = content_bounds.MakeMenuBar(); 76517caa17caSRaphael Isemann Rect status_bounds = content_bounds.MakeStatusBar(); 76527caa17caSRaphael Isemann Rect source_bounds; 76537caa17caSRaphael Isemann Rect variables_bounds; 76547caa17caSRaphael Isemann Rect threads_bounds; 76557caa17caSRaphael Isemann Rect source_variables_bounds; 76567caa17caSRaphael Isemann content_bounds.VerticalSplitPercentage(0.80, source_variables_bounds, 76577caa17caSRaphael Isemann threads_bounds); 76587caa17caSRaphael Isemann source_variables_bounds.HorizontalSplitPercentage(0.70, source_bounds, 76597caa17caSRaphael Isemann variables_bounds); 76607caa17caSRaphael Isemann 76617caa17caSRaphael Isemann WindowSP menubar_window_sp = 76627caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Menubar", menubar_bounds, false); 76637caa17caSRaphael Isemann // Let the menubar get keys if the active window doesn't handle the keys 76647caa17caSRaphael Isemann // that are typed so it can respond to menubar key presses. 76657caa17caSRaphael Isemann menubar_window_sp->SetCanBeActive( 76667caa17caSRaphael Isemann false); // Don't let the menubar become the active window 76677caa17caSRaphael Isemann menubar_window_sp->SetDelegate(menubar_sp); 76687caa17caSRaphael Isemann 76697caa17caSRaphael Isemann WindowSP source_window_sp( 76707caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Source", source_bounds, true)); 76717caa17caSRaphael Isemann WindowSP variables_window_sp( 76727caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Variables", variables_bounds, false)); 76737caa17caSRaphael Isemann WindowSP threads_window_sp( 76747caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Threads", threads_bounds, false)); 76757caa17caSRaphael Isemann WindowSP status_window_sp( 76767caa17caSRaphael Isemann main_window_sp->CreateSubWindow("Status", status_bounds, false)); 76777caa17caSRaphael Isemann status_window_sp->SetCanBeActive( 76787caa17caSRaphael Isemann false); // Don't let the status bar become the active window 76797caa17caSRaphael Isemann main_window_sp->SetDelegate( 76807caa17caSRaphael Isemann std::static_pointer_cast<WindowDelegate>(app_delegate_sp)); 76817caa17caSRaphael Isemann source_window_sp->SetDelegate( 76827caa17caSRaphael Isemann WindowDelegateSP(new SourceFileWindowDelegate(m_debugger))); 76837caa17caSRaphael Isemann variables_window_sp->SetDelegate( 76847caa17caSRaphael Isemann WindowDelegateSP(new FrameVariablesWindowDelegate(m_debugger))); 76857caa17caSRaphael Isemann TreeDelegateSP thread_delegate_sp(new ThreadsTreeDelegate(m_debugger)); 76867caa17caSRaphael Isemann threads_window_sp->SetDelegate(WindowDelegateSP( 76877caa17caSRaphael Isemann new TreeWindowDelegate(m_debugger, thread_delegate_sp))); 76887caa17caSRaphael Isemann status_window_sp->SetDelegate( 76897caa17caSRaphael Isemann WindowDelegateSP(new StatusBarWindowDelegate(m_debugger))); 76907caa17caSRaphael Isemann 7691b26e1efcSOmar Emara // Show the main help window once the first time the curses GUI is 7692b26e1efcSOmar Emara // launched 76937caa17caSRaphael Isemann static bool g_showed_help = false; 76947caa17caSRaphael Isemann if (!g_showed_help) { 76957caa17caSRaphael Isemann g_showed_help = true; 76967caa17caSRaphael Isemann main_window_sp->CreateHelpSubwindow(); 76977caa17caSRaphael Isemann } 76987caa17caSRaphael Isemann 769914406ca0SLuboš Luňák // All colors with black background. 770014406ca0SLuboš Luňák init_pair(1, COLOR_BLACK, COLOR_BLACK); 770114406ca0SLuboš Luňák init_pair(2, COLOR_RED, COLOR_BLACK); 770214406ca0SLuboš Luňák init_pair(3, COLOR_GREEN, COLOR_BLACK); 770314406ca0SLuboš Luňák init_pair(4, COLOR_YELLOW, COLOR_BLACK); 770414406ca0SLuboš Luňák init_pair(5, COLOR_BLUE, COLOR_BLACK); 770514406ca0SLuboš Luňák init_pair(6, COLOR_MAGENTA, COLOR_BLACK); 770614406ca0SLuboš Luňák init_pair(7, COLOR_CYAN, COLOR_BLACK); 770714406ca0SLuboš Luňák init_pair(8, COLOR_WHITE, COLOR_BLACK); 770814406ca0SLuboš Luňák // All colors with blue background. 770914406ca0SLuboš Luňák init_pair(9, COLOR_BLACK, COLOR_BLUE); 771014406ca0SLuboš Luňák init_pair(10, COLOR_RED, COLOR_BLUE); 771114406ca0SLuboš Luňák init_pair(11, COLOR_GREEN, COLOR_BLUE); 771214406ca0SLuboš Luňák init_pair(12, COLOR_YELLOW, COLOR_BLUE); 771314406ca0SLuboš Luňák init_pair(13, COLOR_BLUE, COLOR_BLUE); 771414406ca0SLuboš Luňák init_pair(14, COLOR_MAGENTA, COLOR_BLUE); 771514406ca0SLuboš Luňák init_pair(15, COLOR_CYAN, COLOR_BLUE); 771614406ca0SLuboš Luňák init_pair(16, COLOR_WHITE, COLOR_BLUE); 77174a8e4b5cSLuboš Luňák // These must match the order in the color indexes enum. 77184a8e4b5cSLuboš Luňák init_pair(17, COLOR_BLACK, COLOR_WHITE); 77194a8e4b5cSLuboš Luňák init_pair(18, COLOR_MAGENTA, COLOR_WHITE); 77204a8e4b5cSLuboš Luňák static_assert(LastColorPairIndex == 18, "Color indexes do not match."); 772129cc50e1SOmar Emara 772229cc50e1SOmar Emara define_key("\033[Z", KEY_SHIFT_TAB); 7723945cde8bSOmar Emara define_key("\033\015", KEY_ALT_ENTER); 77247caa17caSRaphael Isemann } 77257caa17caSRaphael Isemann } 77267caa17caSRaphael Isemann 77277caa17caSRaphael Isemann void IOHandlerCursesGUI::Deactivate() { m_app_ap->Terminate(); } 77287caa17caSRaphael Isemann 77297caa17caSRaphael Isemann void IOHandlerCursesGUI::Run() { 77307caa17caSRaphael Isemann m_app_ap->Run(m_debugger); 77317caa17caSRaphael Isemann SetIsDone(true); 77327caa17caSRaphael Isemann } 77337caa17caSRaphael Isemann 77347caa17caSRaphael Isemann IOHandlerCursesGUI::~IOHandlerCursesGUI() = default; 77357caa17caSRaphael Isemann 77367caa17caSRaphael Isemann void IOHandlerCursesGUI::Cancel() {} 77377caa17caSRaphael Isemann 77387caa17caSRaphael Isemann bool IOHandlerCursesGUI::Interrupt() { return false; } 77397caa17caSRaphael Isemann 77407caa17caSRaphael Isemann void IOHandlerCursesGUI::GotEOF() {} 77417caa17caSRaphael Isemann 77422f1b24b7SLuboš Luňák void IOHandlerCursesGUI::TerminalSizeChanged() { 77432f1b24b7SLuboš Luňák m_app_ap->TerminalSizeChanged(); 77442f1b24b7SLuboš Luňák } 77452f1b24b7SLuboš Luňák 7746a4304f96SJonas Devlieghere #endif // LLDB_ENABLE_CURSES 7747