Menu.cs 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352
  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 ();
  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, (ctx) => SelectOrRun (ctx.KeyBinding?.Context));
  400. AddCommand (Command.HotKey, (ctx) => _host?.SelectItem (ctx.KeyBinding?.Context as MenuItem));//_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. KeyBinding keyBinding = new ([Command.ToggleExpandCollapse], KeyBindingScope.HotKey, menuItem);
  434. KeyBindings.Add ((KeyCode)menuItem.HotKey.Value, keyBinding);
  435. KeyBindings.Add ((KeyCode)menuItem.HotKey.Value | KeyCode.AltMask, keyBinding);
  436. if (menuItem.Shortcut != KeyCode.Null)
  437. {
  438. keyBinding = new ([Command.Select], KeyBindingScope.HotKey, menuItem);
  439. KeyBindings.Add (menuItem.Shortcut, keyBinding);
  440. }
  441. MenuBarItem subMenu = menuBarItem.SubMenu (menuItem);
  442. AddKeyBindings (subMenu);
  443. }
  444. }
  445. private int _menuBarItemToActivate = -1;
  446. private MenuItem _menuItemToSelect;
  447. /// <summary>Called when a key bound to Command.Select is pressed. This means a hot key was pressed.</summary>
  448. /// <returns></returns>
  449. private bool SelectOrRun ([CanBeNull] object context)
  450. {
  451. if (!IsInitialized || !Visible)
  452. {
  453. return true;
  454. }
  455. if (context is MenuItem menuItem)
  456. {
  457. _menuItemToSelect = menuItem;
  458. }
  459. if (_menuBarItemToActivate != -1)
  460. {
  461. _host.Activate (1, _menuBarItemToActivate);
  462. }
  463. else if (_menuItemToSelect is { })
  464. {
  465. var m = _menuItemToSelect as MenuBarItem;
  466. if (m?.Children?.Length > 0)
  467. {
  468. MenuItem item = _barItems.Children [_currentChild];
  469. if (item is null)
  470. {
  471. return true;
  472. }
  473. bool disabled = item is null || !item.IsEnabled ();
  474. if (!disabled && (_host.UseSubMenusSingleFrame || !CheckSubMenu ()))
  475. {
  476. SetNeedsDisplay ();
  477. SetParentSetNeedsDisplay ();
  478. return true;
  479. }
  480. if (!disabled)
  481. {
  482. _host.OnMenuOpened ();
  483. }
  484. }
  485. else
  486. {
  487. _host.SelectItem (_menuItemToSelect);
  488. }
  489. }
  490. else if (_host.IsMenuOpen)
  491. {
  492. _host.CloseAllMenus ();
  493. }
  494. else
  495. {
  496. _host.OpenMenu ();
  497. }
  498. //_openedByHotKey = true;
  499. return true;
  500. }
  501. /// <inheritdoc/>
  502. public override bool? OnInvokingKeyBindings (Key keyEvent)
  503. {
  504. // This is a bit of a hack. We want to handle the key bindings for menu bar but
  505. // InvokeKeyBindings doesn't pass any context so we can't tell which item it is for.
  506. // So before we call the base class we set SelectedItem appropriately.
  507. KeyCode key = keyEvent.KeyCode;
  508. //if (KeyBindings.TryGet (key, out _))
  509. //{
  510. // _menuBarItemToActivate = -1;
  511. // _menuItemToSelect = null;
  512. // MenuItem [] children = _barItems.Children;
  513. // if (children is null)
  514. // {
  515. // return base.OnInvokingKeyBindings (keyEvent);
  516. // }
  517. // // Search for shortcuts first. If there's a shortcut, we don't want to activate the menu item.
  518. // foreach (MenuItem c in children)
  519. // {
  520. // if (key == c?.Shortcut)
  521. // {
  522. // _menuBarItemToActivate = -1;
  523. // _menuItemToSelect = c;
  524. // //keyEvent.Scope = KeyBindingScope.HotKey;
  525. // return base.OnInvokingKeyBindings (keyEvent);
  526. // }
  527. // MenuBarItem subMenu = _barItems.SubMenu (c);
  528. // if (FindShortcutInChildMenu (key, subMenu))
  529. // {
  530. // //keyEvent.Scope = KeyBindingScope.HotKey;
  531. // return base.OnInvokingKeyBindings (keyEvent);
  532. // }
  533. // }
  534. // // Search for hot keys next.
  535. // for (var c = 0; c < children.Length; c++)
  536. // {
  537. // int hotKeyValue = children [c]?.HotKey.Value ?? default (int);
  538. // var hotKey = (KeyCode)hotKeyValue;
  539. // if (hotKey == KeyCode.Null)
  540. // {
  541. // continue;
  542. // }
  543. // bool matches = key == hotKey || key == (hotKey | KeyCode.AltMask);
  544. // if (!_host.IsMenuOpen)
  545. // {
  546. // // If the menu is open, only match if Alt is not pressed.
  547. // matches = key == hotKey;
  548. // }
  549. // if (matches)
  550. // {
  551. // _menuItemToSelect = children [c];
  552. // _currentChild = c;
  553. // return base.OnInvokingKeyBindings (keyEvent);
  554. // }
  555. // }
  556. //}
  557. bool? handled = base.OnInvokingKeyBindings (keyEvent);
  558. if (handled is { } && (bool)handled)
  559. {
  560. return true;
  561. }
  562. // This supports the case where the menu bar is a context menu
  563. return _host.OnInvokingKeyBindings (keyEvent);
  564. }
  565. private bool FindShortcutInChildMenu (KeyCode key, MenuBarItem menuBarItem)
  566. {
  567. if (menuBarItem?.Children is null)
  568. {
  569. return false;
  570. }
  571. foreach (MenuItem menuItem in menuBarItem.Children)
  572. {
  573. if (key == menuItem?.Shortcut)
  574. {
  575. _menuBarItemToActivate = -1;
  576. _menuItemToSelect = menuItem;
  577. return true;
  578. }
  579. MenuBarItem subMenu = menuBarItem.SubMenu (menuItem);
  580. FindShortcutInChildMenu (key, subMenu);
  581. }
  582. return false;
  583. }
  584. private void Current_TerminalResized (object sender, SizeChangedEventArgs e)
  585. {
  586. if (_host.IsMenuOpen)
  587. {
  588. _host.CloseAllMenus ();
  589. }
  590. }
  591. /// <inheritdoc/>
  592. public override void OnVisibleChanged ()
  593. {
  594. base.OnVisibleChanged ();
  595. if (Visible)
  596. {
  597. Application.MouseEvent += Application_RootMouseEvent;
  598. }
  599. else
  600. {
  601. Application.MouseEvent -= Application_RootMouseEvent;
  602. }
  603. }
  604. private void Application_RootMouseEvent (object sender, MouseEvent a)
  605. {
  606. if (a.View is { } and (MenuBar or not Menu))
  607. {
  608. return;
  609. }
  610. if (!Visible)
  611. {
  612. throw new InvalidOperationException ("This shouldn't running on a invisible menu!");
  613. }
  614. View view = a.View ?? this;
  615. Point boundsPoint = view.ScreenToViewport (new (a.Position.X, a.Position.Y));
  616. var me = new MouseEvent
  617. {
  618. Position = boundsPoint,
  619. Flags = a.Flags,
  620. ScreenPosition = a.Position,
  621. View = view
  622. };
  623. if (view.NewMouseEvent (me) == true || a.Flags == MouseFlags.Button1Pressed || a.Flags == MouseFlags.Button1Released)
  624. {
  625. a.Handled = true;
  626. }
  627. }
  628. internal Attribute DetermineColorSchemeFor (MenuItem item, int index)
  629. {
  630. if (item is null)
  631. {
  632. return GetNormalColor ();
  633. }
  634. if (index == _currentChild)
  635. {
  636. return GetFocusColor ();
  637. }
  638. return !item.IsEnabled () ? ColorScheme.Disabled : GetNormalColor ();
  639. }
  640. public override void OnDrawContent (Rectangle viewport)
  641. {
  642. if (_barItems.Children is null)
  643. {
  644. return;
  645. }
  646. Rectangle savedClip = Driver.Clip;
  647. Driver.Clip = new (0, 0, Driver.Cols, Driver.Rows);
  648. Driver.SetAttribute (GetNormalColor ());
  649. OnDrawAdornments ();
  650. OnRenderLineCanvas ();
  651. for (int i = Viewport.Y; i < _barItems.Children.Length; i++)
  652. {
  653. if (i < 0)
  654. {
  655. continue;
  656. }
  657. if (ViewportToScreen (Viewport).Y + i >= Driver.Rows)
  658. {
  659. break;
  660. }
  661. MenuItem item = _barItems.Children [i];
  662. Driver.SetAttribute (
  663. item is null ? GetNormalColor () :
  664. i == _currentChild ? GetFocusColor () : GetNormalColor ()
  665. );
  666. if (item is null && BorderStyle != LineStyle.None)
  667. {
  668. Point s = ViewportToScreen (new Point (-1, i));
  669. Driver.Move (s.X, s.Y);
  670. Driver.AddRune (Glyphs.LeftTee);
  671. }
  672. else if (Frame.X < Driver.Cols)
  673. {
  674. Move (0, i);
  675. }
  676. Driver.SetAttribute (DetermineColorSchemeFor (item, i));
  677. for (int p = Viewport.X; p < Frame.Width - 2; p++)
  678. {
  679. // This - 2 is for the border
  680. if (p < 0)
  681. {
  682. continue;
  683. }
  684. if (ViewportToScreen (Viewport).X + p >= Driver.Cols)
  685. {
  686. break;
  687. }
  688. if (item is null)
  689. {
  690. Driver.AddRune (Glyphs.HLine);
  691. }
  692. else if (i == 0 && p == 0 && _host.UseSubMenusSingleFrame && item.Parent.Parent is { })
  693. {
  694. Driver.AddRune (Glyphs.LeftArrow);
  695. }
  696. // This `- 3` is left border + right border + one row in from right
  697. else if (p == Frame.Width - 3 && _barItems.SubMenu (_barItems.Children [i]) is { })
  698. {
  699. Driver.AddRune (Glyphs.RightArrow);
  700. }
  701. else
  702. {
  703. Driver.AddRune ((Rune)' ');
  704. }
  705. }
  706. if (item is null)
  707. {
  708. if (BorderStyle != LineStyle.None && SuperView?.Frame.Right - Frame.X > Frame.Width)
  709. {
  710. Point s = ViewportToScreen (new Point (Frame.Width - 2, i));
  711. Driver.Move (s.X, s.Y);
  712. Driver.AddRune (Glyphs.RightTee);
  713. }
  714. continue;
  715. }
  716. string textToDraw = null;
  717. Rune nullCheckedChar = Glyphs.NullChecked;
  718. Rune checkChar = Glyphs.Selected;
  719. Rune uncheckedChar = Glyphs.UnSelected;
  720. if (item.CheckType.HasFlag (MenuItemCheckStyle.Checked))
  721. {
  722. checkChar = Glyphs.Checked;
  723. uncheckedChar = Glyphs.UnChecked;
  724. }
  725. // Support Checked even though CheckType wasn't set
  726. if (item.CheckType == MenuItemCheckStyle.Checked && item.Checked is null)
  727. {
  728. textToDraw = $"{nullCheckedChar} {item.Title}";
  729. }
  730. else if (item.Checked == true)
  731. {
  732. textToDraw = $"{checkChar} {item.Title}";
  733. }
  734. else if (item.CheckType.HasFlag (MenuItemCheckStyle.Checked) || item.CheckType.HasFlag (MenuItemCheckStyle.Radio))
  735. {
  736. textToDraw = $"{uncheckedChar} {item.Title}";
  737. }
  738. else
  739. {
  740. textToDraw = item.Title;
  741. }
  742. Point screen = ViewportToScreen (new Point (0, i));
  743. if (screen.X < Driver.Cols)
  744. {
  745. Driver.Move (screen.X + 1, screen.Y);
  746. if (!item.IsEnabled ())
  747. {
  748. DrawHotString (textToDraw, ColorScheme.Disabled, ColorScheme.Disabled);
  749. }
  750. else if (i == 0 && _host.UseSubMenusSingleFrame && item.Parent.Parent is { })
  751. {
  752. var tf = new TextFormatter
  753. {
  754. AutoSize = true,
  755. Alignment = Alignment.Center, HotKeySpecifier = MenuBar.HotKeySpecifier, Text = textToDraw
  756. };
  757. // The -3 is left/right border + one space (not sure what for)
  758. tf.Draw (
  759. ViewportToScreen (new Rectangle (1, i, Frame.Width - 3, 1)),
  760. i == _currentChild ? GetFocusColor () : GetNormalColor (),
  761. i == _currentChild ? ColorScheme.HotFocus : ColorScheme.HotNormal,
  762. SuperView?.ViewportToScreen (SuperView.Viewport) ?? Rectangle.Empty
  763. );
  764. }
  765. else
  766. {
  767. DrawHotString (
  768. textToDraw,
  769. i == _currentChild ? ColorScheme.HotFocus : ColorScheme.HotNormal,
  770. i == _currentChild ? GetFocusColor () : GetNormalColor ()
  771. );
  772. }
  773. // The help string
  774. int l = item.ShortcutTag.GetColumns () == 0
  775. ? item.Help.GetColumns ()
  776. : item.Help.GetColumns () + item.ShortcutTag.GetColumns () + 2;
  777. int col = Frame.Width - l - 3;
  778. screen = ViewportToScreen (new Point (col, i));
  779. if (screen.X < Driver.Cols)
  780. {
  781. Driver.Move (screen.X, screen.Y);
  782. Driver.AddStr (item.Help);
  783. // The shortcut tag string
  784. if (!string.IsNullOrEmpty (item.ShortcutTag))
  785. {
  786. Driver.Move (screen.X + l - item.ShortcutTag.GetColumns (), screen.Y);
  787. Driver.AddStr (item.ShortcutTag);
  788. }
  789. }
  790. }
  791. }
  792. Driver.Clip = savedClip;
  793. // PositionCursor ();
  794. }
  795. private void Current_DrawContentComplete (object sender, DrawEventArgs e)
  796. {
  797. if (Visible)
  798. {
  799. OnDrawContent (Viewport);
  800. }
  801. }
  802. public override Point? PositionCursor ()
  803. {
  804. if (_host?.IsMenuOpen != false)
  805. {
  806. if (_barItems.IsTopLevel)
  807. {
  808. return _host?.PositionCursor ();
  809. }
  810. Move (2, 1 + _currentChild);
  811. return null; // Don't show the cursor
  812. }
  813. return _host?.PositionCursor ();
  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.Position.Y < 0)
  997. {
  998. return me.Handled = true;
  999. }
  1000. if (me.Position.Y >= _barItems.Children.Length)
  1001. {
  1002. return me.Handled = true;
  1003. }
  1004. MenuItem item = _barItems.Children [me.Position.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.Position.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.Position.Y < 0 || me.Position.Y >= _barItems.Children.Length)
  1028. {
  1029. return me.Handled = true;
  1030. }
  1031. MenuItem item = _barItems.Children [me.Position.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.Position.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. protected override void Dispose (bool disposing)
  1110. {
  1111. if (Application.Current is { })
  1112. {
  1113. Application.Current.DrawContentComplete -= Current_DrawContentComplete;
  1114. Application.Current.SizeChanging -= Current_TerminalResized;
  1115. }
  1116. Application.MouseEvent -= Application_RootMouseEvent;
  1117. base.Dispose (disposing);
  1118. }
  1119. }