Menu.cs 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353
  1. namespace Terminal.Gui;
  2. /// <summary>Specifies how a <see cref="MenuItem"/> shows selection state.</summary>
  3. [Flags]
  4. public enum MenuItemCheckStyle
  5. {
  6. /// <summary>The menu item will be shown normally, with no check indicator. The default.</summary>
  7. NoCheck = 0b_0000_0000,
  8. /// <summary>The menu item will indicate checked/un-checked state (see <see cref="Checked"/>).</summary>
  9. Checked = 0b_0000_0001,
  10. /// <summary>The menu item is part of a menu radio group (see <see cref="Checked"/>) and will indicate selected state.</summary>
  11. Radio = 0b_0000_0010
  12. }
  13. /// <summary>
  14. /// A <see cref="MenuItem"/> has title, an associated help text, and an action to execute on activation. MenuItems
  15. /// can also have a checked indicator (see <see cref="Checked"/>).
  16. /// </summary>
  17. public class MenuItem
  18. {
  19. private readonly ShortcutHelper _shortcutHelper;
  20. private bool _allowNullChecked;
  21. private MenuItemCheckStyle _checkType;
  22. private string _title;
  23. // TODO: Update to use Key instead of KeyCode
  24. /// <summary>Initializes a new instance of <see cref="MenuItem"/></summary>
  25. public MenuItem (KeyCode shortcut = KeyCode.Null) : this ("", "", null, null, null, shortcut) { }
  26. // TODO: Update to use Key instead of KeyCode
  27. /// <summary>Initializes a new instance of <see cref="MenuItem"/>.</summary>
  28. /// <param name="title">Title for the menu item.</param>
  29. /// <param name="help">Help text to display.</param>
  30. /// <param name="action">Action to invoke when the menu item is activated.</param>
  31. /// <param name="canExecute">Function to determine if the action can currently be executed.</param>
  32. /// <param name="parent">The <see cref="Parent"/> of this menu item.</param>
  33. /// <param name="shortcut">The <see cref="Shortcut"/> keystroke combination.</param>
  34. public MenuItem (
  35. string title,
  36. string help,
  37. Action action,
  38. Func<bool> canExecute = null,
  39. MenuItem parent = null,
  40. KeyCode shortcut = KeyCode.Null
  41. )
  42. {
  43. Title = title ?? "";
  44. Help = help ?? "";
  45. Action = action;
  46. CanExecute = canExecute;
  47. Parent = parent;
  48. _shortcutHelper = new ShortcutHelper ();
  49. if (shortcut != KeyCode.Null)
  50. {
  51. Shortcut = shortcut;
  52. }
  53. }
  54. /// <summary>Gets or sets the action to be invoked when the menu item is triggered.</summary>
  55. /// <value>Method to invoke.</value>
  56. public Action Action { get; set; }
  57. /// <summary>
  58. /// Used only if <see cref="CheckType"/> is of <see cref="MenuItemCheckStyle.Checked"/> type. If
  59. /// <see langword="true"/> allows <see cref="Checked"/> to be null, true or false. If <see langword="false"/> only
  60. /// allows <see cref="Checked"/> to be true or false.
  61. /// </summary>
  62. public bool AllowNullChecked
  63. {
  64. get => _allowNullChecked;
  65. set
  66. {
  67. _allowNullChecked = value;
  68. Checked ??= false;
  69. }
  70. }
  71. /// <summary>
  72. /// Gets or sets the action to be invoked to determine if the menu can be triggered. If <see cref="CanExecute"/>
  73. /// returns <see langword="true"/> the menu item will be enabled. Otherwise, it will be disabled.
  74. /// </summary>
  75. /// <value>Function to determine if the action is can be executed or not.</value>
  76. public Func<bool> CanExecute { get; set; }
  77. /// <summary>
  78. /// Sets or gets whether the <see cref="MenuItem"/> shows a check indicator or not. See
  79. /// <see cref="MenuItemCheckStyle"/>.
  80. /// </summary>
  81. public bool? Checked { set; get; }
  82. /// <summary>
  83. /// Sets or gets the <see cref="MenuItemCheckStyle"/> of a menu item where <see cref="Checked"/> is set to
  84. /// <see langword="true"/>.
  85. /// </summary>
  86. public MenuItemCheckStyle CheckType
  87. {
  88. get => _checkType;
  89. set
  90. {
  91. _checkType = value;
  92. if (_checkType == MenuItemCheckStyle.Checked && !_allowNullChecked && Checked is null)
  93. {
  94. Checked = false;
  95. }
  96. }
  97. }
  98. /// <summary>Gets or sets arbitrary data for the menu item.</summary>
  99. /// <remarks>This property is not used internally.</remarks>
  100. public object Data { get; set; }
  101. /// <summary>Gets or sets the help text for the menu item. The help text is drawn to the right of the <see cref="Title"/>.</summary>
  102. /// <value>The help text.</value>
  103. public string Help { get; set; }
  104. /// <summary>Gets the parent for this <see cref="MenuItem"/>.</summary>
  105. /// <value>The parent.</value>
  106. public MenuItem Parent { get; set; }
  107. /// <summary>Gets or sets the title of the menu item .</summary>
  108. /// <value>The title.</value>
  109. public string Title
  110. {
  111. get => _title;
  112. set
  113. {
  114. if (_title == value)
  115. {
  116. return;
  117. }
  118. _title = value;
  119. GetHotKey ();
  120. }
  121. }
  122. /// <summary>Gets if this <see cref="MenuItem"/> is from a sub-menu.</summary>
  123. internal bool IsFromSubMenu => Parent != null;
  124. internal int TitleLength => GetMenuBarItemLength (Title);
  125. //
  126. // ┌─────────────────────────────┐
  127. // │ Quit Quit UI Catalog Ctrl+Q │
  128. // └─────────────────────────────┘
  129. // ┌─────────────────┐
  130. // │ ◌ TopLevel Alt+T │
  131. // └─────────────────┘
  132. // TODO: Replace the `2` literals with named constants
  133. internal int Width => 1
  134. + // space before Title
  135. TitleLength
  136. + 2
  137. + // space after Title - BUGBUG: This should be 1
  138. (Checked == true || CheckType.HasFlag (MenuItemCheckStyle.Checked) || CheckType.HasFlag (MenuItemCheckStyle.Radio)
  139. ? 2
  140. : 0)
  141. + // check glyph + space
  142. (Help.GetColumns () > 0 ? 2 + Help.GetColumns () : 0)
  143. + // Two spaces before Help
  144. (ShortcutTag.GetColumns () > 0
  145. ? 2 + ShortcutTag.GetColumns ()
  146. : 0); // Pad two spaces before shortcut tag (which are also aligned right)
  147. /// <summary>Merely a debugging aid to see the interaction with main.</summary>
  148. public bool GetMenuBarItem () { return IsFromSubMenu; }
  149. /// <summary>Merely a debugging aid to see the interaction with main.</summary>
  150. public MenuItem GetMenuItem () { return this; }
  151. /// <summary>
  152. /// Returns <see langword="true"/> if the menu item is enabled. This method is a wrapper around
  153. /// <see cref="CanExecute"/>.
  154. /// </summary>
  155. public bool IsEnabled () { return CanExecute?.Invoke () ?? true; }
  156. /// <summary>
  157. /// Toggle the <see cref="Checked"/> between three states if <see cref="AllowNullChecked"/> is
  158. /// <see langword="true"/> or between two states if <see cref="AllowNullChecked"/> is <see langword="false"/>.
  159. /// </summary>
  160. public void ToggleChecked ()
  161. {
  162. if (_checkType != MenuItemCheckStyle.Checked)
  163. {
  164. throw new InvalidOperationException ("This isn't a Checked MenuItemCheckStyle!");
  165. }
  166. bool? previousChecked = Checked;
  167. if (AllowNullChecked)
  168. {
  169. Checked = previousChecked switch
  170. {
  171. null => true,
  172. true => false,
  173. false => null
  174. };
  175. }
  176. else
  177. {
  178. Checked = !Checked;
  179. }
  180. }
  181. private static int GetMenuBarItemLength (string title)
  182. {
  183. return title.EnumerateRunes ()
  184. .Where (ch => ch != MenuBar.HotKeySpecifier)
  185. .Sum (ch => Math.Max (ch.GetColumns (), 1));
  186. }
  187. #region Keyboard Handling
  188. // TODO: Update to use Key instead of Rune
  189. /// <summary>
  190. /// The HotKey is used to activate a <see cref="MenuItem"/> with the keyboard. HotKeys are defined by prefixing the
  191. /// <see cref="Title"/> of a MenuItem with an underscore ('_').
  192. /// <para>
  193. /// Pressing Alt-Hotkey for a <see cref="MenuBarItem"/> (menu items on the menu bar) works even if the menu is
  194. /// not active). Once a menu has focus and is active, pressing just the HotKey will activate the MenuItem.
  195. /// </para>
  196. /// <para>
  197. /// For example for a MenuBar with a "_File" MenuBarItem that contains a "_New" MenuItem, Alt-F will open the
  198. /// File menu. Pressing the N key will then activate the New MenuItem.
  199. /// </para>
  200. /// <para>See also <see cref="Shortcut"/> which enable global key-bindings to menu items.</para>
  201. /// </summary>
  202. public Rune HotKey { get; set; }
  203. private void GetHotKey ()
  204. {
  205. var nextIsHot = false;
  206. foreach (char x in _title)
  207. {
  208. if (x == MenuBar.HotKeySpecifier.Value)
  209. {
  210. nextIsHot = true;
  211. }
  212. else
  213. {
  214. if (nextIsHot)
  215. {
  216. HotKey = (Rune)char.ToUpper (x);
  217. break;
  218. }
  219. nextIsHot = false;
  220. HotKey = default (Rune);
  221. }
  222. }
  223. }
  224. // TODO: Update to use Key instead of KeyCode
  225. /// <summary>
  226. /// Shortcut defines a key binding to the MenuItem that will invoke the MenuItem's action globally for the
  227. /// <see cref="View"/> that is the parent of the <see cref="MenuBar"/> or <see cref="ContextMenu"/> this
  228. /// <see cref="MenuItem"/>.
  229. /// <para>
  230. /// The <see cref="KeyCode"/> will be drawn on the MenuItem to the right of the <see cref="Title"/> and
  231. /// <see cref="Help"/> text. See <see cref="ShortcutTag"/>.
  232. /// </para>
  233. /// </summary>
  234. public KeyCode Shortcut
  235. {
  236. get => _shortcutHelper.Shortcut;
  237. set
  238. {
  239. if (_shortcutHelper.Shortcut != value && (ShortcutHelper.PostShortcutValidation (value) || value == KeyCode.Null))
  240. {
  241. _shortcutHelper.Shortcut = value;
  242. }
  243. }
  244. }
  245. /// <summary>Gets the text describing the keystroke combination defined by <see cref="Shortcut"/>.</summary>
  246. public string ShortcutTag => _shortcutHelper.Shortcut == KeyCode.Null
  247. ? string.Empty
  248. : Key.ToString (_shortcutHelper.Shortcut, MenuBar.ShortcutDelimiter);
  249. #endregion Keyboard Handling
  250. }
  251. /// <summary>
  252. /// An internal class used to represent a menu pop-up menu. Created and managed by <see cref="MenuBar"/> and
  253. /// <see cref="ContextMenu"/>.
  254. /// </summary>
  255. internal sealed class Menu : View
  256. {
  257. private readonly MenuBarItem _barItems;
  258. private readonly MenuBar _host;
  259. internal int _currentChild;
  260. internal View _previousSubFocused;
  261. internal static Rectangle MakeFrame (int x, int y, MenuItem [] items, Menu parent = null)
  262. {
  263. if (items is null || items.Length == 0)
  264. {
  265. return Rectangle.Empty;
  266. }
  267. int minX = x;
  268. int minY = y;
  269. const int borderOffset = 2; // This 2 is for the space around
  270. int maxW = (items.Max (z => z?.Width) ?? 0) + borderOffset;
  271. int maxH = items.Length + borderOffset;
  272. if (parent is { } && x + maxW > Driver.Cols)
  273. {
  274. minX = Math.Max (parent.Frame.Right - parent.Frame.Width - maxW, 0);
  275. }
  276. if (y + maxH > Driver.Rows)
  277. {
  278. minY = Math.Max (Driver.Rows - maxH, 0);
  279. }
  280. return new (minX, minY, maxW, maxH);
  281. }
  282. internal required MenuBar Host
  283. {
  284. get => _host;
  285. init
  286. {
  287. ArgumentNullException.ThrowIfNull (value);
  288. _host = value;
  289. }
  290. }
  291. internal required MenuBarItem BarItems
  292. {
  293. get => _barItems;
  294. init
  295. {
  296. ArgumentNullException.ThrowIfNull (value);
  297. _barItems = value;
  298. // Debugging aid so ToString() is helpful
  299. Text = _barItems.Title;
  300. }
  301. }
  302. internal Menu Parent { get; init; }
  303. public override void BeginInit ()
  304. {
  305. base.BeginInit ();
  306. Frame = MakeFrame (Frame.X, Frame.Y, _barItems?.Children, Parent);
  307. if (_barItems is { IsTopLevel: true })
  308. {
  309. // This is a standalone MenuItem on a MenuBar
  310. ColorScheme = _host.ColorScheme;
  311. CanFocus = true;
  312. }
  313. else
  314. {
  315. _currentChild = -1;
  316. for (var i = 0; i < _barItems!.Children?.Length; i++)
  317. {
  318. if (_barItems.Children [i]?.IsEnabled () == true)
  319. {
  320. _currentChild = i;
  321. break;
  322. }
  323. }
  324. ColorScheme = _host.ColorScheme;
  325. CanFocus = true;
  326. WantMousePositionReports = _host.WantMousePositionReports;
  327. }
  328. BorderStyle = _host.MenusBorderStyle;
  329. AddCommand (
  330. Command.Right,
  331. () =>
  332. {
  333. _host.NextMenu (
  334. !_barItems.IsTopLevel
  335. || (_barItems.Children != null
  336. && _barItems!.Children.Length > 0
  337. && _currentChild > -1
  338. && _currentChild < _barItems.Children.Length
  339. && _barItems.Children [_currentChild].IsFromSubMenu),
  340. _barItems!.Children != null
  341. && _barItems.Children.Length > 0
  342. && _currentChild > -1
  343. && _host.UseSubMenusSingleFrame
  344. && _barItems.SubMenu (
  345. _barItems.Children [_currentChild]
  346. )
  347. != null
  348. );
  349. return true;
  350. }
  351. );
  352. AddKeyBindings (_barItems);
  353. #if SUPPORT_ALT_TO_ACTIVATE_MENU
  354. Initialized += (s, e) =>
  355. {
  356. if (SuperView is { })
  357. {
  358. SuperView.KeyUp += SuperView_KeyUp;
  359. }
  360. };
  361. #endif
  362. }
  363. public Menu ()
  364. {
  365. if (Application.Current is { })
  366. {
  367. Application.Current.DrawContentComplete += Current_DrawContentComplete;
  368. Application.Current.SizeChanging += Current_TerminalResized;
  369. }
  370. Application.MouseEvent += Application_RootMouseEvent;
  371. // Things this view knows how to do
  372. AddCommand (Command.LineUp, () => MoveUp ());
  373. AddCommand (Command.LineDown, () => MoveDown ());
  374. AddCommand (
  375. Command.Left,
  376. () =>
  377. {
  378. _host.PreviousMenu (true);
  379. return true;
  380. }
  381. );
  382. AddCommand (
  383. Command.Cancel,
  384. () =>
  385. {
  386. CloseAllMenus ();
  387. return true;
  388. }
  389. );
  390. AddCommand (
  391. Command.Accept,
  392. () =>
  393. {
  394. RunSelected ();
  395. return true;
  396. }
  397. );
  398. AddCommand (Command.Select, () => _host?.SelectItem (_menuItemToSelect));
  399. AddCommand (Command.ToggleExpandCollapse, () => SelectOrRun ());
  400. AddCommand (Command.HotKey, () => _host?.SelectItem (_menuItemToSelect));
  401. // Default key bindings for this view
  402. KeyBindings.Add (Key.CursorUp, Command.LineUp);
  403. KeyBindings.Add (Key.CursorDown, Command.LineDown);
  404. KeyBindings.Add (Key.CursorLeft, Command.Left);
  405. KeyBindings.Add (Key.CursorRight, Command.Right);
  406. KeyBindings.Add (Key.Esc, Command.Cancel);
  407. KeyBindings.Add (Key.Enter, Command.Accept);
  408. KeyBindings.Add (Key.F9, KeyBindingScope.HotKey, Command.ToggleExpandCollapse);
  409. KeyBindings.Add (
  410. KeyCode.CtrlMask | KeyCode.Space,
  411. KeyBindingScope.HotKey,
  412. Command.ToggleExpandCollapse
  413. );
  414. }
  415. #if SUPPORT_ALT_TO_ACTIVATE_MENU
  416. void SuperView_KeyUp (object sender, KeyEventArgs e)
  417. {
  418. if (SuperView is null || SuperView.CanFocus == false || SuperView.Visible == false)
  419. {
  420. return;
  421. }
  422. _host.AltKeyUpHandler (e);
  423. }
  424. #endif
  425. private void AddKeyBindings (MenuBarItem menuBarItem)
  426. {
  427. if (menuBarItem is null || menuBarItem.Children is null)
  428. {
  429. return;
  430. }
  431. foreach (MenuItem menuItem in menuBarItem.Children.Where (m => m is { }))
  432. {
  433. KeyBindings.Add ((KeyCode)menuItem.HotKey.Value, Command.ToggleExpandCollapse);
  434. KeyBindings.Add (
  435. (KeyCode)menuItem.HotKey.Value | KeyCode.AltMask,
  436. Command.ToggleExpandCollapse
  437. );
  438. if (menuItem.Shortcut != KeyCode.Null)
  439. {
  440. KeyBindings.Add (menuItem.Shortcut, KeyBindingScope.HotKey, Command.Select);
  441. }
  442. MenuBarItem subMenu = menuBarItem.SubMenu (menuItem);
  443. AddKeyBindings (subMenu);
  444. }
  445. }
  446. private int _menuBarItemToActivate = -1;
  447. private MenuItem _menuItemToSelect;
  448. /// <summary>Called when a key bound to Command.Select is pressed. This means a hot key was pressed.</summary>
  449. /// <returns></returns>
  450. private bool SelectOrRun ()
  451. {
  452. if (!IsInitialized || !Visible)
  453. {
  454. return true;
  455. }
  456. if (_menuBarItemToActivate != -1)
  457. {
  458. _host.Activate (1, _menuBarItemToActivate);
  459. }
  460. else if (_menuItemToSelect is { })
  461. {
  462. var m = _menuItemToSelect as MenuBarItem;
  463. if (m?.Children?.Length > 0)
  464. {
  465. MenuItem item = _barItems.Children [_currentChild];
  466. if (item is null)
  467. {
  468. return true;
  469. }
  470. bool disabled = item is null || !item.IsEnabled ();
  471. if (!disabled && (_host.UseSubMenusSingleFrame || !CheckSubMenu ()))
  472. {
  473. SetNeedsDisplay ();
  474. SetParentSetNeedsDisplay ();
  475. return true;
  476. }
  477. if (!disabled)
  478. {
  479. _host.OnMenuOpened ();
  480. }
  481. }
  482. else
  483. {
  484. _host.SelectItem (_menuItemToSelect);
  485. }
  486. }
  487. else if (_host.IsMenuOpen)
  488. {
  489. _host.CloseAllMenus ();
  490. }
  491. else
  492. {
  493. _host.OpenMenu ();
  494. }
  495. //_openedByHotKey = true;
  496. return true;
  497. }
  498. /// <inheritdoc/>
  499. public override bool? OnInvokingKeyBindings (Key keyEvent)
  500. {
  501. // This is a bit of a hack. We want to handle the key bindings for menu bar but
  502. // InvokeKeyBindings doesn't pass any context so we can't tell which item it is for.
  503. // So before we call the base class we set SelectedItem appropriately.
  504. KeyCode key = keyEvent.KeyCode;
  505. if (KeyBindings.TryGet (key, out _))
  506. {
  507. _menuBarItemToActivate = -1;
  508. _menuItemToSelect = null;
  509. MenuItem [] children = _barItems.Children;
  510. if (children is null)
  511. {
  512. return base.OnInvokingKeyBindings (keyEvent);
  513. }
  514. // Search for shortcuts first. If there's a shortcut, we don't want to activate the menu item.
  515. foreach (MenuItem c in children)
  516. {
  517. if (key == c?.Shortcut)
  518. {
  519. _menuBarItemToActivate = -1;
  520. _menuItemToSelect = c;
  521. //keyEvent.Scope = KeyBindingScope.HotKey;
  522. return base.OnInvokingKeyBindings (keyEvent);
  523. }
  524. MenuBarItem subMenu = _barItems.SubMenu (c);
  525. if (FindShortcutInChildMenu (key, subMenu))
  526. {
  527. //keyEvent.Scope = KeyBindingScope.HotKey;
  528. return base.OnInvokingKeyBindings (keyEvent);
  529. }
  530. }
  531. // Search for hot keys next.
  532. for (var c = 0; c < children.Length; c++)
  533. {
  534. int hotKeyValue = children [c]?.HotKey.Value ?? default (int);
  535. var hotKey = (KeyCode)hotKeyValue;
  536. if (hotKey == KeyCode.Null)
  537. {
  538. continue;
  539. }
  540. bool matches = key == hotKey || key == (hotKey | KeyCode.AltMask);
  541. if (!_host.IsMenuOpen)
  542. {
  543. // If the menu is open, only match if Alt is not pressed.
  544. matches = key == hotKey;
  545. }
  546. if (matches)
  547. {
  548. _menuItemToSelect = children [c];
  549. _currentChild = c;
  550. return base.OnInvokingKeyBindings (keyEvent);
  551. }
  552. }
  553. }
  554. bool? handled = base.OnInvokingKeyBindings (keyEvent);
  555. if (handled is { } && (bool)handled)
  556. {
  557. return true;
  558. }
  559. // This supports the case where the menu bar is a context menu
  560. return _host.OnInvokingKeyBindings (keyEvent);
  561. }
  562. private bool FindShortcutInChildMenu (KeyCode key, MenuBarItem menuBarItem)
  563. {
  564. if (menuBarItem?.Children is null)
  565. {
  566. return false;
  567. }
  568. foreach (MenuItem menuItem in menuBarItem.Children)
  569. {
  570. if (key == menuItem?.Shortcut)
  571. {
  572. _menuBarItemToActivate = -1;
  573. _menuItemToSelect = menuItem;
  574. return true;
  575. }
  576. MenuBarItem subMenu = menuBarItem.SubMenu (menuItem);
  577. FindShortcutInChildMenu (key, subMenu);
  578. }
  579. return false;
  580. }
  581. private void Current_TerminalResized (object sender, SizeChangedEventArgs e)
  582. {
  583. if (_host.IsMenuOpen)
  584. {
  585. _host.CloseAllMenus ();
  586. }
  587. }
  588. /// <inheritdoc/>
  589. public override void OnVisibleChanged ()
  590. {
  591. base.OnVisibleChanged ();
  592. if (Visible)
  593. {
  594. Application.MouseEvent += Application_RootMouseEvent;
  595. }
  596. else
  597. {
  598. Application.MouseEvent -= Application_RootMouseEvent;
  599. }
  600. }
  601. private void Application_RootMouseEvent (object sender, MouseEvent a)
  602. {
  603. if (a.View is { } and (MenuBar or not Menu))
  604. {
  605. return;
  606. }
  607. if (!Visible)
  608. {
  609. throw new InvalidOperationException ("This shouldn't running on a invisible menu!");
  610. }
  611. View view = a.View ?? this;
  612. Point boundsPoint = view.ScreenToBounds (a.X, a.Y);
  613. var me = new MouseEvent
  614. {
  615. X = boundsPoint.X,
  616. Y = boundsPoint.Y,
  617. Flags = a.Flags,
  618. ScreenPosition = new (a.X, a.Y),
  619. View = view
  620. };
  621. if (view.NewMouseEvent (me) == true || a.Flags == MouseFlags.Button1Pressed || a.Flags == MouseFlags.Button1Released)
  622. {
  623. a.Handled = true;
  624. }
  625. }
  626. internal Attribute DetermineColorSchemeFor (MenuItem item, int index)
  627. {
  628. if (item is null)
  629. {
  630. return GetNormalColor ();
  631. }
  632. if (index == _currentChild)
  633. {
  634. return ColorScheme.Focus;
  635. }
  636. return !item.IsEnabled () ? ColorScheme.Disabled : GetNormalColor ();
  637. }
  638. public override void OnDrawContent (Rectangle contentArea)
  639. {
  640. if (_barItems.Children is null)
  641. {
  642. return;
  643. }
  644. Rectangle savedClip = Driver.Clip;
  645. Driver.Clip = new (0, 0, Driver.Cols, Driver.Rows);
  646. Driver.SetAttribute (GetNormalColor ());
  647. OnDrawAdornments ();
  648. OnRenderLineCanvas ();
  649. for (int i = Bounds.Y; i < _barItems.Children.Length; i++)
  650. {
  651. if (i < 0)
  652. {
  653. continue;
  654. }
  655. if (BoundsToScreen (Bounds).Y + i >= Driver.Rows)
  656. {
  657. break;
  658. }
  659. MenuItem item = _barItems.Children [i];
  660. Driver.SetAttribute (
  661. item is null ? GetNormalColor () :
  662. i == _currentChild ? ColorScheme.Focus : GetNormalColor ()
  663. );
  664. if (item is null && BorderStyle != LineStyle.None)
  665. {
  666. Move (-1, i);
  667. Driver.AddRune (Glyphs.LeftTee);
  668. }
  669. else if (Frame.X < Driver.Cols)
  670. {
  671. Move (0, i);
  672. }
  673. Driver.SetAttribute (DetermineColorSchemeFor (item, i));
  674. for (int p = Bounds.X; p < Frame.Width - 2; p++)
  675. {
  676. // This - 2 is for the border
  677. if (p < 0)
  678. {
  679. continue;
  680. }
  681. if (BoundsToScreen (Bounds).X + p >= Driver.Cols)
  682. {
  683. break;
  684. }
  685. if (item is null)
  686. {
  687. Driver.AddRune (Glyphs.HLine);
  688. }
  689. else if (i == 0 && p == 0 && _host.UseSubMenusSingleFrame && item.Parent.Parent is { })
  690. {
  691. Driver.AddRune (Glyphs.LeftArrow);
  692. }
  693. // This `- 3` is left border + right border + one row in from right
  694. else if (p == Frame.Width - 3 && _barItems.SubMenu (_barItems.Children [i]) is { })
  695. {
  696. Driver.AddRune (Glyphs.RightArrow);
  697. }
  698. else
  699. {
  700. Driver.AddRune ((Rune)' ');
  701. }
  702. }
  703. if (item is null)
  704. {
  705. if (BorderStyle != LineStyle.None && SuperView?.Frame.Right - Frame.X > Frame.Width)
  706. {
  707. Move (Frame.Width - 2, i);
  708. Driver.AddRune (Glyphs.RightTee);
  709. }
  710. continue;
  711. }
  712. string textToDraw = null;
  713. Rune nullCheckedChar = Glyphs.NullChecked;
  714. Rune checkChar = Glyphs.Selected;
  715. Rune uncheckedChar = Glyphs.UnSelected;
  716. if (item.CheckType.HasFlag (MenuItemCheckStyle.Checked))
  717. {
  718. checkChar = Glyphs.Checked;
  719. uncheckedChar = Glyphs.UnChecked;
  720. }
  721. // Support Checked even though CheckType wasn't set
  722. if (item.CheckType == MenuItemCheckStyle.Checked && item.Checked is null)
  723. {
  724. textToDraw = $"{nullCheckedChar} {item.Title}";
  725. }
  726. else if (item.Checked == true)
  727. {
  728. textToDraw = $"{checkChar} {item.Title}";
  729. }
  730. else if (item.CheckType.HasFlag (MenuItemCheckStyle.Checked) || item.CheckType.HasFlag (MenuItemCheckStyle.Radio))
  731. {
  732. textToDraw = $"{uncheckedChar} {item.Title}";
  733. }
  734. else
  735. {
  736. textToDraw = item.Title;
  737. }
  738. Rectangle screen = BoundsToScreen (new (new (0 , i), Size.Empty));
  739. if (screen.X < Driver.Cols)
  740. {
  741. Driver.Move (screen.X + 1, screen.Y);
  742. if (!item.IsEnabled ())
  743. {
  744. DrawHotString (textToDraw, ColorScheme.Disabled, ColorScheme.Disabled);
  745. }
  746. else if (i == 0 && _host.UseSubMenusSingleFrame && item.Parent.Parent is { })
  747. {
  748. var tf = new TextFormatter
  749. {
  750. Alignment = TextAlignment.Centered, HotKeySpecifier = MenuBar.HotKeySpecifier, Text = textToDraw
  751. };
  752. // The -3 is left/right border + one space (not sure what for)
  753. tf.Draw (
  754. BoundsToScreen (new (1, i, Frame.Width - 3, 1)),
  755. i == _currentChild ? ColorScheme.Focus : GetNormalColor (),
  756. i == _currentChild ? ColorScheme.HotFocus : ColorScheme.HotNormal,
  757. SuperView?.BoundsToScreen (SuperView.Bounds) ?? Rectangle.Empty
  758. );
  759. }
  760. else
  761. {
  762. DrawHotString (
  763. textToDraw,
  764. i == _currentChild ? ColorScheme.HotFocus : ColorScheme.HotNormal,
  765. i == _currentChild ? ColorScheme.Focus : GetNormalColor ()
  766. );
  767. }
  768. // The help string
  769. int l = item.ShortcutTag.GetColumns () == 0
  770. ? item.Help.GetColumns ()
  771. : item.Help.GetColumns () + item.ShortcutTag.GetColumns () + 2;
  772. int col = Frame.Width - l - 3;
  773. screen = BoundsToScreen (new (new (col, i), Size.Empty));
  774. if (screen.X < Driver.Cols)
  775. {
  776. Driver.Move (screen.X, screen.Y);
  777. Driver.AddStr (item.Help);
  778. // The shortcut tag string
  779. if (!string.IsNullOrEmpty (item.ShortcutTag))
  780. {
  781. Driver.Move (screen.X + l - item.ShortcutTag.GetColumns (), screen.Y);
  782. Driver.AddStr (item.ShortcutTag);
  783. }
  784. }
  785. }
  786. }
  787. Driver.Clip = savedClip;
  788. PositionCursor ();
  789. }
  790. private void Current_DrawContentComplete (object sender, DrawEventArgs e)
  791. {
  792. if (Visible)
  793. {
  794. OnDrawContent (Bounds);
  795. }
  796. }
  797. public override void PositionCursor ()
  798. {
  799. if (_host?.IsMenuOpen != false)
  800. {
  801. if (_barItems.IsTopLevel)
  802. {
  803. _host?.PositionCursor ();
  804. }
  805. else
  806. {
  807. Move (2, 1 + _currentChild);
  808. }
  809. }
  810. else
  811. {
  812. _host?.PositionCursor ();
  813. }
  814. }
  815. public void Run (Action action)
  816. {
  817. if (action is null || _host is null)
  818. {
  819. return;
  820. }
  821. Application.UngrabMouse ();
  822. _host.CloseAllMenus ();
  823. Application.Refresh ();
  824. _host.Run (action);
  825. }
  826. public override bool OnLeave (View view) { return _host.OnLeave (view); }
  827. private void RunSelected ()
  828. {
  829. if (_barItems.IsTopLevel)
  830. {
  831. Run (_barItems.Action);
  832. }
  833. else
  834. {
  835. switch (_currentChild)
  836. {
  837. case > -1 when _barItems.Children [_currentChild].Action != null:
  838. Run (_barItems.Children [_currentChild].Action);
  839. break;
  840. case 0 when _host.UseSubMenusSingleFrame && _barItems.Children [_currentChild].Parent.Parent != null:
  841. _host.PreviousMenu (_barItems.Children [_currentChild].Parent.IsFromSubMenu, true);
  842. break;
  843. case > -1 when _barItems.SubMenu (_barItems.Children [_currentChild]) != null:
  844. CheckSubMenu ();
  845. break;
  846. }
  847. }
  848. }
  849. private void CloseAllMenus ()
  850. {
  851. Application.UngrabMouse ();
  852. _host.CloseAllMenus ();
  853. }
  854. private bool MoveDown ()
  855. {
  856. if (_barItems.IsTopLevel)
  857. {
  858. return true;
  859. }
  860. bool disabled;
  861. do
  862. {
  863. _currentChild++;
  864. if (_currentChild >= _barItems.Children.Length)
  865. {
  866. _currentChild = 0;
  867. }
  868. if (this != _host.openCurrentMenu && _barItems.Children [_currentChild]?.IsFromSubMenu == true && _host._selectedSub > -1)
  869. {
  870. _host.PreviousMenu (true);
  871. _host.SelectEnabledItem (_barItems.Children, _currentChild, out _currentChild);
  872. _host.openCurrentMenu = this;
  873. }
  874. MenuItem item = _barItems.Children [_currentChild];
  875. if (item?.IsEnabled () != true)
  876. {
  877. disabled = true;
  878. }
  879. else
  880. {
  881. disabled = false;
  882. }
  883. if (!_host.UseSubMenusSingleFrame
  884. && _host.UseKeysUpDownAsKeysLeftRight
  885. && _barItems.SubMenu (_barItems.Children [_currentChild]) != null
  886. && !disabled
  887. && _host.IsMenuOpen)
  888. {
  889. if (!CheckSubMenu ())
  890. {
  891. return false;
  892. }
  893. break;
  894. }
  895. if (!_host.IsMenuOpen)
  896. {
  897. _host.OpenMenu (_host._selected);
  898. }
  899. }
  900. while (_barItems.Children [_currentChild] is null || disabled);
  901. SetNeedsDisplay ();
  902. SetParentSetNeedsDisplay ();
  903. if (!_host.UseSubMenusSingleFrame)
  904. {
  905. _host.OnMenuOpened ();
  906. }
  907. return true;
  908. }
  909. private bool MoveUp ()
  910. {
  911. if (_barItems.IsTopLevel || _currentChild == -1)
  912. {
  913. return true;
  914. }
  915. bool disabled;
  916. do
  917. {
  918. _currentChild--;
  919. if (_host.UseKeysUpDownAsKeysLeftRight && !_host.UseSubMenusSingleFrame)
  920. {
  921. if ((_currentChild == -1 || this != _host.openCurrentMenu)
  922. && _barItems.Children [_currentChild + 1].IsFromSubMenu
  923. && _host._selectedSub > -1)
  924. {
  925. _currentChild++;
  926. _host.PreviousMenu (true);
  927. if (_currentChild > 0)
  928. {
  929. _currentChild--;
  930. _host.openCurrentMenu = this;
  931. }
  932. break;
  933. }
  934. }
  935. if (_currentChild < 0)
  936. {
  937. _currentChild = _barItems.Children.Length - 1;
  938. }
  939. if (!_host.SelectEnabledItem (_barItems.Children, _currentChild, out _currentChild, false))
  940. {
  941. _currentChild = 0;
  942. if (!_host.SelectEnabledItem (_barItems.Children, _currentChild, out _currentChild) && !_host.CloseMenu (false))
  943. {
  944. return false;
  945. }
  946. break;
  947. }
  948. MenuItem item = _barItems.Children [_currentChild];
  949. disabled = item?.IsEnabled () != true;
  950. if (_host.UseSubMenusSingleFrame
  951. || !_host.UseKeysUpDownAsKeysLeftRight
  952. || _barItems.SubMenu (_barItems.Children [_currentChild]) == null
  953. || disabled
  954. || !_host.IsMenuOpen)
  955. {
  956. continue;
  957. }
  958. if (!CheckSubMenu ())
  959. {
  960. return false;
  961. }
  962. break;
  963. }
  964. while (_barItems.Children [_currentChild] is null || disabled);
  965. SetNeedsDisplay ();
  966. SetParentSetNeedsDisplay ();
  967. if (!_host.UseSubMenusSingleFrame)
  968. {
  969. _host.OnMenuOpened ();
  970. }
  971. return true;
  972. }
  973. private void SetParentSetNeedsDisplay ()
  974. {
  975. if (_host._openSubMenu is { })
  976. {
  977. foreach (Menu menu in _host._openSubMenu)
  978. {
  979. menu.SetNeedsDisplay ();
  980. }
  981. }
  982. _host?._openMenu?.SetNeedsDisplay ();
  983. _host?.SetNeedsDisplay ();
  984. }
  985. protected internal override bool OnMouseEvent (MouseEvent me)
  986. {
  987. if (!_host._handled && !_host.HandleGrabView (me, this))
  988. {
  989. return false;
  990. }
  991. _host._handled = false;
  992. bool disabled;
  993. if (me.Flags == MouseFlags.Button1Clicked)
  994. {
  995. disabled = false;
  996. if (me.Y < 0)
  997. {
  998. return me.Handled = true;
  999. }
  1000. if (me.Y >= _barItems.Children.Length)
  1001. {
  1002. return me.Handled = true;
  1003. }
  1004. MenuItem item = _barItems.Children [me.Y];
  1005. if (item is null || !item.IsEnabled ())
  1006. {
  1007. disabled = true;
  1008. }
  1009. if (disabled)
  1010. {
  1011. return me.Handled = true;
  1012. }
  1013. _currentChild = me.Y;
  1014. RunSelected ();
  1015. return me.Handled = true;
  1016. }
  1017. if (me.Flags != MouseFlags.Button1Pressed
  1018. && me.Flags != MouseFlags.Button1DoubleClicked
  1019. && me.Flags != MouseFlags.Button1TripleClicked
  1020. && me.Flags != MouseFlags.ReportMousePosition
  1021. && !me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition))
  1022. {
  1023. return false;
  1024. }
  1025. {
  1026. disabled = false;
  1027. if (me.Y < 0 || me.Y >= _barItems.Children.Length)
  1028. {
  1029. return me.Handled = true;
  1030. }
  1031. MenuItem item = _barItems.Children [me.Y];
  1032. if (item is null)
  1033. {
  1034. return me.Handled = true;
  1035. }
  1036. if (item?.IsEnabled () != true)
  1037. {
  1038. disabled = true;
  1039. }
  1040. if (!disabled)
  1041. {
  1042. _currentChild = me.Y;
  1043. }
  1044. if (_host.UseSubMenusSingleFrame || !CheckSubMenu ())
  1045. {
  1046. SetNeedsDisplay ();
  1047. SetParentSetNeedsDisplay ();
  1048. return me.Handled = true;
  1049. }
  1050. _host.OnMenuOpened ();
  1051. return me.Handled = true;
  1052. }
  1053. }
  1054. internal bool CheckSubMenu ()
  1055. {
  1056. if (_currentChild == -1 || _barItems.Children [_currentChild] is null)
  1057. {
  1058. return true;
  1059. }
  1060. MenuBarItem subMenu = _barItems.SubMenu (_barItems.Children [_currentChild]);
  1061. if (subMenu is { })
  1062. {
  1063. int pos = -1;
  1064. if (_host._openSubMenu is { })
  1065. {
  1066. pos = _host._openSubMenu.FindIndex (o => o?._barItems == subMenu);
  1067. }
  1068. if (pos == -1
  1069. && this != _host.openCurrentMenu
  1070. && subMenu.Children != _host.openCurrentMenu._barItems.Children
  1071. && !_host.CloseMenu (false, true))
  1072. {
  1073. return false;
  1074. }
  1075. _host.Activate (_host._selected, pos, subMenu);
  1076. }
  1077. else if (_host._openSubMenu?.Count == 0 || _host._openSubMenu?.Last ()._barItems.IsSubMenuOf (_barItems.Children [_currentChild]) == false)
  1078. {
  1079. return _host.CloseMenu (false, true);
  1080. }
  1081. else
  1082. {
  1083. SetNeedsDisplay ();
  1084. SetParentSetNeedsDisplay ();
  1085. }
  1086. return true;
  1087. }
  1088. private int GetSubMenuIndex (MenuBarItem subMenu)
  1089. {
  1090. int pos = -1;
  1091. if (Subviews.Count == 0)
  1092. {
  1093. return pos;
  1094. }
  1095. Menu v = null;
  1096. foreach (View menu in Subviews)
  1097. {
  1098. if (((Menu)menu)._barItems == subMenu)
  1099. {
  1100. v = (Menu)menu;
  1101. }
  1102. }
  1103. if (v is { })
  1104. {
  1105. pos = Subviews.IndexOf (v);
  1106. }
  1107. return pos;
  1108. }
  1109. /// <inheritdoc/>
  1110. public override bool OnEnter (View view)
  1111. {
  1112. Application.Driver.SetCursorVisibility (CursorVisibility.Invisible);
  1113. return base.OnEnter (view);
  1114. }
  1115. protected override void Dispose (bool disposing)
  1116. {
  1117. if (Application.Current is { })
  1118. {
  1119. Application.Current.DrawContentComplete -= Current_DrawContentComplete;
  1120. Application.Current.SizeChanging -= Current_TerminalResized;
  1121. }
  1122. Application.MouseEvent -= Application_RootMouseEvent;
  1123. base.Dispose (disposing);
  1124. }
  1125. }