Add support for icons for TouchBar submenus (and maybe other customizations)

[jabrouwer82]

According to the code, :menu doesn't support setting an icon for touchbar submenus.

For example in the hypothetical nested menu TouchBar.Example.Thing, TouchBar.Example can only be plain a plain text (or emoji) button, but TouchBar.Example.Thing could have an icon declared in the :menu command that defined it.

The (semi) original touchbar implementation (#715) suggests using the macmenu command to support extra customization options.

[ychin]

Yes that's correct. Thinking more about it I think just fixing Vim's :menu variants to be able to set icon on TouchBar subfolders may be better and more consistent for users instead of having to learn a new thing.

[jabrouwer82]

But other options like color, priority, etc, would probably need to be something special, right?

[ychin]

I haven't quite decided on them, but yes, maybe. The macmenu command is always a little odd and I would like to keep things as consistent as possible. So if you define icons through the normal :menu commands for toolbar and non-subfolder Touch Bar items, then ideally that's the way we define icons for Touch Bar subfolders too, just to reduce the cognitive load. I haven't looked at the code yet though, so I don't have a sense how big a refactor from upstream that is. It's likely that it's a simple check that we just need to fix.

Some other special items like the emoji picker is specified by special menu item names, like amenu TouchBar.-characterpicker- <Nop> or -flexspace-. Those probably won't fly for color and priority though. I think priority is relatively low in usefulness because you can always choose to enable/disable menu items, but if we have a generic way to hook it up, why not.

[DesantBucie]

Maybe not entirely on topic but is it possible to update touchbar names dynamicaly during one session? Like when I i press button name1 it changes to name2?

[ychin]

Use :tmenu

[DesantBucie]

Yea I tried, but it does not seem to update in the same session. Anyway thanks :)

[ychin]

@DesantBucie that should not be the case. Do you have the exact sequence of commands you used?

[DesantBucie]

Well I tried something like this

let g:TabSpaces = 4

function! TabSpaces()

 if g:TabSpaces == 4
 set tabstop = 2 | set shiftwidth = 2
 let g:TabSpaces = 2
 
 else
 set tabstop = 4 | set shiftwidth = 4
 let g:TabSpaces = 4
 
 endif
endfunction

nmenu TouchBar.Settings.Tab :TabSpaces<CR>
if g:TabSpaces == 4
 tmenu TouchBar.Settings.Tab Set Tab 2
else
 tmenu TouchBar.Settings.Tab Set Tab 4
endif

[ychin]

@DesantBucie You need to debug your script more and make sure it works before even trying out the fancier Touch Bar label functionality. I don't think your script currently works at all.

1. You can't put spaces after "=" in set tabstop = 2(it should be throwing errors at you). You have to do set tabstop=2.
2. You are not invoking the tmenu command inside the function so it's not going to magically update the label for you after you call TabSpaces().
3. Your menu is calling :TabSpaces which assumes TabSpaces is a command, but it is a function instead. You need to be doing :call TabSpaces()<CR> instead.
4. Try to use nnoremenu instead of nmenu because it's more foolproof. If you don't mind it showing up in other modes (insert, command, etc), you could consider using anoremenu.

[DesantBucie]

I fixed 1,2,3, put both tmenus to function, got "default" one on vimrc and it works like magic. And no I wanted it to be available only on normal mode so it's fine. Thanks awfully for your time.

[destructobeam]

Sorry to just hop in here, this could possibly be a separate issue, but is related to icons. In the toolbar and Touch Bar would it be possible to add SF Symbols support? So you could do something like:

nnoremenu icon=cross.case.fill TouchBar.Fix :ALEFix <CR>

[ychin]

Yeah it's something on my mind. I will likely touch these after the next release. It will also make the toolbars look better and fit macOS 11 better.