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