Touch Bar add documentation, support enabled states, and system icons

Enabled states now work. E.g. a mapped Touch Bar button using "vmenu
TouchBar.DoStuff <nop>" will not show up in normal mode.

Also support specifying default Apple template icons. E.g. "an
icon=NSTouchBarListViewTemplate TouchBar.ShowList <Nop>"

Remove default TouchBar buttons as there were too many of them and most
of them are unlikely to be heavily used as there are direct Vim command
equivalent. Instead just add a single fullscreen toggle button. This can
be changed later.

Author: ychin

runtime/doc/gui_mac.txt

@@ -12,14 +12,15 @@ The MacVim Graphical User Interface			*macvim* *gui-macvim*
  4. Special colors		|macvim-colors|
  5. Menus			|macvim-menus|
  6. Toolbar			|macvim-toolbar|
- 7. Dialogs			|macvim-dialogs|
- 8. System services		|macvim-services|
- 9. mvim:// URL handler		|macvim-url-handler|
-10. Keyboard shortcuts		|macvim-shortcuts|
-11. Trackpad gestures		|macvim-gestures|
-12. International		|macvim-international|
-13. Known bugs/missing features	|macvim-todo|
-14. Hints			|macvim-hints|
+ 7. Touch Bar			|macvim-touchbar|
+ 8. Dialogs			|macvim-dialogs|
+ 9. System services		|macvim-services|
+10. mvim:// URL handler		|macvim-url-handler|
+11. Keyboard shortcuts		|macvim-shortcuts|
+12. Trackpad gestures		|macvim-gestures|
+13. International		|macvim-international|
+14. Known bugs/missing features	|macvim-todo|
+15. Hints			|macvim-hints|
 
 Other relevant documentation:
 |gui.txt|	For generic items of the GUI.
@@ -467,19 +468,47 @@ empty space which will shink or expand so that the items to the right of it
 are right-aligned.  A space (flexspace) will be created for any toolbar item
 whose name begins with "-space" ("-flexspace") and ends with "-"
 
-Toolbar icons should be tiff, png or icns, of dimension 32x32 or 24x24 pixels.
-The larger size is used when 'tbis' is "medium" or "large", otherwise the
-smaller size is used (which is the default).  If the icon file only contains
-one dimension then Mac OS X will scale the icon to the appropriate dimension
-if necessary.  To avoid this, use a file format which supports multiple
-resolutions (such as icns) and provide both 32x32 and 24x24 versions of the
-icon.
+Toolbar icons should be tiff, png, icns, or heic, of dimension 32x32 or 24x24
+pixels.  The larger size is used when 'tbis' is "medium" or "large", otherwise
+the smaller size is used (which is the default).  If the icon file only
+contains one dimension then Mac OS X will scale the icon to the appropriate
+dimension if necessary.  To avoid this, use a file format which supports
+multiple resolutions (such as icns) and provide both 32x32 and 24x24 versions
+of the icon.
 
 Note: Only a subset of the builtin toolbar items presently have icons.  If no
 icon can be found a warning triangle is displayed instead.
 
 ==============================================================================
-7. Dialogs						*macvim-dialogs*
+7. Touch Bar						*macvim-touchbar*
+
+Touch Bar in MacVim works similar to the toolbar (see |macvim-toolbar|).  The
+difference is that you use the special menu "TouchBar" instead of "ToolBar": >
+	:an TouchBar.Hello          :echo "Hello"<CR>
+
+The separators work similar to how toolbars work: >
+	:an TouchBar.-Sep-          <Nop>
+	:an TouchBar.-space1-       <Nop>
+	:an TouchBar.-flexspace2-   <Nop>
+
+The first example is a Vim separator (see |menu-separator|) and injects a
+space between two buttons. The second creates a smaller space than a normal
+separator and are specified by names that begin with "-space" and ends with
+"-". The third creates a flexible empty space which will shrink or expand so
+that items after it will be right-aligned, and is specified by names that
+begin with "-flexspace" and ends with "-".
+
+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. You can also use default template icons provided by Apple by using
+their template names. An example: >
+	:an icon=NSTouchBarListViewTemplate TouchBar.ShowList <Nop>
+
+This feature only works on Mac devices that come with Touch Bars. On the ones
+that don't, nothing will show up.
+
+==============================================================================
+8. Dialogs						*macvim-dialogs*
 
 Dialogs can be controlled with the keyboard in two ways.  By default each
 button in a dialog is bound to a key.  The button that is highlighted by blue
@@ -498,7 +527,7 @@ select the current button.  The current button is indicated with a blue
 outline.
 
 ==============================================================================
-8. System services					*macvim-services*
+9. System services					*macvim-services*
 
 MacVim supports two system services.  These can be accessed from the MacVim
 submenu in the Services menu or by right-clicking a selection.  For services
@@ -516,7 +545,7 @@ The services respect the "Open files from applications" setting in the general
 preferences.
 
 ==============================================================================
-9. mvim:// URL handler				*mvim://* *macvim-url-handler*
+10. mvim:// URL handler				*mvim://* *macvim-url-handler*
 
 MacVim supports a custom URL handler for "mvim://" URLs. The handler is
 supposed to be compatible to TextMate's URL scheme as documented at >
@@ -537,7 +566,7 @@ will open the file /etc/profile on line 20 when clicked in a web browser.
 Note that url has to be a file:// url pointing to an existing local file.
 
 ==============================================================================
-10. Keyboard shortcuts					*macvim-shortcuts*
+11. Keyboard shortcuts					*macvim-shortcuts*
 
 Most keyboard shortcuts in MacVim are bound to menu items and can be
 discovered by looking through the menus (see |macvim-menus| on how to create
@@ -617,7 +646,7 @@ sometimes be slightly involved.  Here are all the things you need to consider:
 - A few command key mappings are set up by MacVim, see |cmd-movement|.
 
 ==============================================================================
-11. Trackpad gestures					*macvim-gestures*
+12. Trackpad gestures					*macvim-gestures*
 
 MacVim supports trackpad swipe gestures.  By default this can be used to
 navigate back/forward in the help (try it!).
@@ -648,7 +677,7 @@ As another example, here is how to switch buffers by swiping left/right: >
 See the section on |key-mapping| for more help on how to map keys.
 
 ==============================================================================
-12. International					*macvim-international*
+13. International					*macvim-international*
 
 When editing non-English text it may be convenient to keep separate keyboard
 layouts for normal and insert mode.  This is supported via the 'imd' option on
@@ -669,7 +698,7 @@ wrong layout when going back to normal mode, then select the layout you want
 to use in normal mode and type ":set imd" followed by ":set noimd".
 
 ==============================================================================
-13. Known bugs/missing features				*macvim-todo*
+14. Known bugs/missing features				*macvim-todo*
 
 This list is by no means exhaustive, it only enumerates some of the more
 prominent bugs/missing features.
@@ -693,7 +722,7 @@ This is also the best place for making feature requests as well as for asking
 general questions about MacVim.
 
 ==============================================================================
-14. Hints						*macvim-hints*
+15. Hints						*macvim-hints*
 
 In this section some general (not necessarily MacVim specific) hints are
 given.

runtime/doc/tags

@@ -7428,6 +7428,7 @@ macvim-start	gui_mac.txt	/*macvim-start*
 macvim-tablabel	gui_mac.txt	/*macvim-tablabel*
 macvim-todo	gui_mac.txt	/*macvim-todo*
 macvim-toolbar	gui_mac.txt	/*macvim-toolbar*
+macvim-touchbar	gui_mac.txt	/*macvim-touchbar*
 macvim-url-handler	gui_mac.txt	/*macvim-url-handler*
 macvim-user-defaults	gui_mac.txt	/*macvim-user-defaults*
 macvim-window-title	gui_mac.txt	/*macvim-window-title*

runtime/menu.vim

@@ -1288,20 +1288,26 @@ if has("gui_macvim")
 endif
 
 if has("touchbar")
-  an TouchBar.Open			:browse confirm e<CR>
-  an <silent> TouchBar.Save		:if expand("%") == ""<Bar>browse confirm w<Bar>else<Bar>confirm w<Bar>endif<CR>
-  an TouchBar.SaveAll		:browse confirm wa<CR>
-
-  an TouchBar.-sep1-		<Nop>
-  an TouchBar.Undo			u
-  an TouchBar.Redo			<C-R>
-
-  an TouchBar.-sep2-		<Nop>
-  vnoremenu TouchBar.Cut		"+x
-  vnoremenu TouchBar.Copy		"+y
-  cnoremenu TouchBar.Copy		<C-Y>
-  nnoremenu TouchBar.Paste		"+gP
-  cnoremenu	TouchBar.Paste		<C-R>+
+  " Set up default Touch Bar buttons.
+  " 1. Smart fullscreen icon that toggles between going full screen or not.
+  an icon=NSTouchBarEnterFullScreenTemplate 1.10 TouchBar.EnterFullScreen :set fullscreen<CR>
+
+  let s:touchbar_fullscreen=0
+  func! s:SetupFullScreenTouchBar()
+    if &fullscreen && s:touchbar_fullscreen == 0
+      aun TouchBar.EnterFullScreen
+      an icon=NSTouchBarExitFullScreenTemplate 1.10 TouchBar.ExitFullScreen :set nofullscreen<CR>
+      let s:touchbar_fullscreen = 1
+    elseif !&fullscreen && s:touchbar_fullscreen == 1
+      aun TouchBar.ExitFullScreen
+      an icon=NSTouchBarEnterFullScreenTemplate 1.10 TouchBar.EnterFullScreen :set fullscreen<CR>
+      let s:touchbar_fullscreen = 0
+    endif
+  endfunc
+  aug FullScreenTouchBar
+    au!
+    au VimResized * call <SID>SetupFullScreenTouchBar()
+  aug END
 endif
 
 " vim: set sw=2 :

src/MacVim/MMVimController.h

@@ -32,6 +32,7 @@
     NSTouchBar          *touchbar;
     NSMutableDictionary *touchbarItemDict;
     NSMutableArray      *touchbarItemOrder;
+    NSMutableSet        *touchbarDisabledItems;
 #endif
 
     int                 pid;

src/MacVim/MMVimController.m

@@ -136,6 +136,7 @@ - (id)initWithBackend:(id)backend pid:(int)processIdentifier
     toolbarItemDict = [[NSMutableDictionary alloc] init];
     touchbarItemDict = [[NSMutableDictionary alloc] init];
     touchbarItemOrder = [[NSMutableArray alloc] init];
+    touchbarDisabledItems = [[NSMutableSet alloc] init];
 #endif
     pid = processIdentifier;
     creationDate = [[NSDate alloc] init];
@@ -188,6 +189,7 @@ - (void)dealloc
 #if MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_12
     [touchbarItemDict release];  touchbarItemDict = nil;
     [touchbarItemOrder release];  touchbarItemOrder = nil;
+    [touchbarDisabledItems release]; touchbarDisabledItems = nil;
     [touchbar release];  touchbar = nil;
 #endif
     [popupMenuItems release];  popupMenuItems = nil;
@@ -505,7 +507,28 @@ - (NSTouchBar *)makeTouchBar
 {
     touchbar = [[NSTouchBar alloc] init];
     touchbar.delegate = self;
-    touchbar.defaultItemIdentifiers = [NSArray arrayWithArray: touchbarItemOrder];
+    
+    NSMutableArray *filteredTouchbarItemOrder = [NSMutableArray array];
+    for (NSString *label in touchbarItemOrder) {
+        if (![touchbarDisabledItems containsObject:label]) {
+            if ([touchbarItemDict objectForKey:label] == nil) {
+                // The label begins and ends with '-'; decided which kind of separator
+                // item it is by looking at the prefix.
+                if ([label hasPrefix:@"-space"]) {
+                    label = NSTouchBarItemIdentifierFixedSpaceSmall;
+                } else if ([label hasPrefix:@"-flexspace"]) {
+                    label = NSTouchBarItemIdentifierFlexibleSpace;
+                } else {
+                    label = NSTouchBarItemIdentifierFixedSpaceLarge;
+                }
+            }
+
+            [filteredTouchbarItemOrder addObject:label];
+        }
+    }
+    [filteredTouchbarItemOrder addObject:NSTouchBarItemIdentifierOtherItemsProxy];
+
+    touchbar.defaultItemIdentifiers = filteredTouchbarItemOrder;
     return touchbar;
 }
 
@@ -1173,7 +1196,7 @@ - (void)addMenuItemWithDescriptor:(NSArray *)desc
     }
 #if MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_12
     if ([rootName isEqual:MMTouchbarMenuName]) {
-        if (toolbar && [desc count] == 2)
+        if ([desc count] == 2)
             [self addTouchbarItemWithLabel:title icon:icon atIndex:idx];
         return;
     }
@@ -1245,6 +1268,7 @@ - (void)removeMenuItemWithDescriptor:(NSArray *)desc
         if ([desc count] == 2) {
             [touchbarItemOrder removeObject:title];
             [touchbarItemDict removeObjectForKey:title];
+            [touchbarDisabledItems removeObject:title];
             [windowController setTouchBar:nil];
         }
         return;
@@ -1286,6 +1310,14 @@ - (void)enableMenuItemWithDescriptor:(NSArray *)desc state:(BOOL)on
     }
 #if MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_12
     if ([rootName isEqual:MMTouchbarMenuName]) {
+        if ([desc count] == 2) {
+            NSString *title = [desc lastObject];
+            if (on)
+                [touchbarDisabledItems removeObject:title];
+            else
+                [touchbarDisabledItems addObject:title];
+            [windowController setTouchBar:nil];
+        }
         return;
     }
 #endif
@@ -1376,15 +1408,7 @@ - (void)addTouchbarItemWithLabel:(NSString *)label
         label = NSTouchBarItemIdentifierFixedSpaceLarge;
     } else if ([label length] >= 2 && [label hasPrefix:@"-"]
                                    && [label hasSuffix:@"-"]) {
-        // The label begins and ends with '-'; decided which kind of separator
-        // item it is by looking at the prefix.
-        if ([label hasPrefix:@"-space"]) {
-            label = NSTouchBarItemIdentifierFixedSpaceSmall;
-        } else if ([label hasPrefix:@"-flexspace"]) {
-            label = NSTouchBarItemIdentifierFlexibleSpace;
-        } else {
-            label = NSTouchBarItemIdentifierFixedSpaceLarge;
-        }
+        // These will be converted to fixed/flexible space identifiers later, when "makeTouchBar" is called.
     } else {
         NSButton* button = [NSButton buttonWithTitle:label target:windowController action:@selector(vimTouchbarItemAction:)];
         NSCustomTouchBarItem *item =

src/MacVim/gui_macvim.m

@@ -799,6 +799,13 @@
         // then a warning icon will be displayed).
         if (!icon)
             icon = lookup_toolbar_item(menu->iconidx);
+
+        // Last step is to see if this is a standard Apple template icon. The
+        // touch bar templates are of the form "NSTouchBar*Template".
+        if (!icon)
+            if (menu->iconfile && STRNCMP(menu->iconfile, "NSTouchBar", 10) == 0) {
+                icon = menu->iconfile;
+            }
     }
 
     [[MMBackend sharedInstance] queueMessage:AddMenuItemMsgID properties: