Touch Bar add submenu/title/emoji picker support

[ychin]

Touch Bar add submenu/title/emoji picker support

Can now specify submenus. E.g. TouchBar.Debugger.Run. When trying to create a submenu it will first create a popover item and then only create the NSButton at the leaf.

• Unfortunatley macOS currently can't do multiple levels of submenus (the API will allow it, but it doesn't really work), presumably for usability concerns. Limit it to only one level of nesting for now.

Add ability to set a title on a Touch Bar button, using tmenu. This allows us to override the displayed button name, and when an icon is specified the override name will still be shown alongside the icon.

Add emoji picker support, and add it to the list of default Touch Bar menus. Only enable it in modes where the user is typing (insert, command, terminal, etc).

Fixed up the internal implementation of Touch Bar management so it's easier to add metadata to it now.

Also, add documentation.

TODO:

• Using tmenu after amenu doesn't really work (unless it's specified in vimrc and loaded on initialization). This is because MacVim hasn't implemented gui_mch_menu_set_tip. Should fix it by adding support for it. For now, the user can just call tmenu before amenu.
  • Edit: Done in Fix tmenu in MacVim and submenu handling in Touch Bar #1086.
• Disabling menus currently just hides the menu. Since the user can already do aunmenu to hide, should change the disable behavior to show the button but disabled instead, similar to how toolbars and normal menus work.
  • Edit: This is probably not going to be done, because doing it would mean menus designated for insert mode (imenu) would show up in normal mode, which is a waste of space. Vim doesn't let the GUI know whether a menu item is disabled via the amenu disable command or not.

[ychin]

Just some examples of what it looks like.

Here's some example configs in a vimrc:

an                                          TouchBar.-flexspace1- <Nop>
amenu icon=NSTouchBarSkipToStartTemplate    TouchBar.GoFirst :cfirst<CR>
tmenu TouchBar.GoFirst First
amenu icon=NSTouchBarGoBackTemplate         TouchBar.GoPrev :cprev<CR>
amenu icon=NSTouchBarGoForwardTemplate      TouchBar.GoNext :cnext<CR>
amenu icon=NSTouchBarSkipToEndTemplate      TouchBar.GoLast :clast<CR>
tmenu TouchBar.GoLast Last
amenu TouchBar.Debug›.▶️Run <Nop>
amenu TouchBar.Debug›.🛑Stop <Nop>

It looks like this in Normal mode (note that GoFirst and GoLast have both icons and text):

Tapping into Debug› will expose the submenus:

When in Insert mode, the character emoji picker shows up:

And you can use it to select emoji to enter:

If you tap the search button on the Touch Bar emoji picker, it will bring up an interactive emoji picker that you can search and enter the emoji you want:

[DesantBucie]

Any way to add custom icons?

[ychin]

Yup. @DesantBucie, see :help macvim-touchbar-icon:

You can specify icons for Touch Bar buttons the same way for toolbar icons. Touch Bar icons should ideally be 36x36 pixels, and no larger than 44x44 pixels.

Also, see :help macvim-toolbar:

Toolbar icons should be tiff, png, icns, or heic, of dimension 32x32 or 24x24 pixels.

What the above means is you just use the builtin Vim functionality to do something like:

 anoremenu icon=/my/path/to/icon.png TouchBar.DoSomething :echo 'Hello!'<CR>

Currently you can't specify an image as a "template image" (see https://developer.apple.com/design/human-interface-guidelines/macos/touch-bar/touch-bar-icons-and-images/). If you want that feature, feel free to file another issue on it.

[DesantBucie]

Thank you very much.