MMTabline: expose scroll button settings and fix misc scroll issues

Allows the user to set whether to show the tabs scroll buttons or not in
the preference pane as this is likely going to be a relatively popular
configuration.

Also, add new `macaction`'s for scrolling to selected tab and scrolling
backward/forward so the user doesn't have to use the mouse to scroll.

Fix misc issues with scrolling to a tab. The existing implementation
was animating both the bounds size and position which would cause issues
if the user resizes the window while still scrolling. Make sure the
animation only touches the position.

Also, the scrolling logic were using the physical locations of the
scroll bounds to determine scroll condition, which doesn't account for
the fact that it could be in the middle of animation. This led to rapid
clicking of the scroll buttons having some clicks being ignored.
Instead, fix it to always use the animated destination.

Author: ychin

runtime/doc/gui_mac.txt

@@ -573,8 +573,11 @@ _cycleWindows:			Select next window (similar to <D-`>)
 _cycleWindowsBackwards:		Select previous window (similar to <D-S-`>)
 _removeWindowFromStageManagerSet  Remove window from a Stage Manager Set. Same
 				as the "Remove Window from Set" menu item.
-joinAllStageManagerSets		Window will float among all Stage Manager sets
-unjoinAllStageManagerSets	Window will only show up in its own set
+joinAllStageManagerSets:	Window will float among all Stage Manager sets
+unjoinAllStageManagerSets:	Window will only show up in its own set
+scrollToCurrentTab:		Scroll to the selected tab in the GUI tab bar
+scrollBackwardOneTab:		Scroll backward by one tab in the tab bar
+scrollForwardOneTab:		Scroll forward by one tab in the tab bar
 
 ==============================================================================
 7. Toolbar						*macvim-toolbar*

src/MacVim/Actions.plist

@@ -8,6 +8,12 @@
 	<string></string>
 	<key>addNewTab:</key>
 	<string></string>
+	<key>scrollToCurrentTab:</key>
+	<string></string>
+	<key>scrollBackwardOneTab:</key>
+	<string></string>
+	<key>scrollForwardOneTab:</key>
+	<string></string>
 	<key>arrangeInFront:</key>
 	<string></string>
 	<key>clearRecentDocuments:</key>

src/MacVim/Base.lproj/Preferences.xib

@@ -280,11 +280,11 @@
             <point key="canvasLocation" x="137.5" y="-17"/>
         </customView>
         <customView id="hr4-G4-3ZG" userLabel="Appearance">
-            <rect key="frame" x="0.0" y="0.0" width="483" height="379"/>
+            <rect key="frame" x="0.0" y="0.0" width="483" height="405"/>
             <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
             <subviews>
                 <customView id="fw0-VK-Nbz" userLabel="Dark mode selection">
-                    <rect key="frame" x="19" y="201" width="433" height="156"/>
+                    <rect key="frame" x="19" y="227" width="433" height="156"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <subviews>
                         <textField focusRingType="none" verticalHuggingPriority="750" horizontalCompressionResistancePriority="250" id="T40-Os-PUf" userLabel="Dark mode selection">
@@ -345,7 +345,7 @@
                     </subviews>
                 </customView>
                 <customView id="7af-iK-4r7" userLabel="Titlebar appearance">
-                    <rect key="frame" x="19" y="118" width="433" height="75"/>
+                    <rect key="frame" x="19" y="144" width="433" height="75"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <subviews>
                         <textField focusRingType="none" verticalHuggingPriority="750" horizontalCompressionResistancePriority="250" id="9Rk-gT-kVC" userLabel="Titlebar appearance">
@@ -407,6 +407,33 @@
                         </button>
                     </subviews>
                 </customView>
+                <customView id="C3B-cu-RC2" userLabel="Tabs">
+                    <rect key="frame" x="20" y="118" width="432" height="18"/>
+                    <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
+                    <subviews>
+                        <button id="rCZ-9B-5RL">
+                            <rect key="frame" x="189" y="-1" width="244" height="18"/>
+                            <autoresizingMask key="autoresizingMask" flexibleMinY="YES"/>
+                            <buttonCell key="cell" type="check" title="Show scroll buttons" bezelStyle="regularSquare" imagePosition="left" alignment="left" inset="2" id="Yqp-j5-BpX">
+                                <behavior key="behavior" changeContents="YES" doesNotDimImage="YES" lightByContents="YES"/>
+                                <font key="font" metaFont="system"/>
+                            </buttonCell>
+                            <connections>
+                                <action selector="tabsPropertiesChanged:" target="-1" id="5xm-T0-e3B"/>
+                                <binding destination="58" name="value" keyPath="values.MMShowTabScrollButtons" id="KHi-zu-Jz2"/>
+                            </connections>
+                        </button>
+                        <textField focusRingType="none" verticalHuggingPriority="750" horizontalCompressionResistancePriority="250" id="qMc-Md-UwA" userLabel="Tabs">
+                            <rect key="frame" x="-2" y="0.0" width="187" height="17"/>
+                            <autoresizingMask key="autoresizingMask" flexibleMinY="YES"/>
+                            <textFieldCell key="cell" sendsActionOnEndEditing="YES" alignment="right" title="Tabs:" id="iUO-3c-iff" userLabel="Tabs:">
+                                <font key="font" metaFont="system"/>
+                                <color key="textColor" name="controlTextColor" catalog="System" colorSpace="catalog"/>
+                                <color key="backgroundColor" name="controlColor" catalog="System" colorSpace="catalog"/>
+                            </textFieldCell>
+                        </textField>
+                    </subviews>
+                </customView>
                 <customView id="BpJ-rH-ona" userLabel="Full Screen">
                     <rect key="frame" x="19" y="72" width="433" height="38"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
@@ -508,7 +535,7 @@
                     </subviews>
                 </customView>
             </subviews>
-            <point key="canvasLocation" x="137.5" y="444.5"/>
+            <point key="canvasLocation" x="137.5" y="457.5"/>
         </customView>
         <customView id="Bnq-Nx-GJH" userLabel="Input">
             <rect key="frame" x="0.0" y="0.0" width="483" height="110"/>
@@ -595,7 +622,7 @@
                     </subviews>
                 </customView>
             </subviews>
-            <point key="canvasLocation" x="137.5" y="705"/>
+            <point key="canvasLocation" x="138" y="775"/>
         </customView>
         <customView id="620" userLabel="Advanced">
             <rect key="frame" x="0.0" y="0.0" width="483" height="367"/>

src/MacVim/MMAppController.h

@@ -84,6 +84,7 @@
 - (BOOL)openFiles:(NSArray *)filenames withArguments:(NSDictionary *)args;
 
 - (void)refreshAllAppearances;
+- (void)refreshAllTabProperties;
 - (void)refreshAllFonts;
 - (void)refreshAllResizeConstraints;
 - (void)refreshAllTextViews;

src/MacVim/MMAppController.m

@@ -1229,19 +1229,22 @@ - (BOOL)openFiles:(NSArray *)filenames withArguments:(NSDictionary *)args
 
 - (void)refreshAllAppearances
 {
-    const NSUInteger count = [vimControllers count];
-    for (unsigned i = 0; i < count; ++i) {
-        MMVimController *vc = [vimControllers objectAtIndex:i];
+    for (MMVimController *vc in vimControllers) {
         [vc.windowController refreshApperanceMode];
     }
 }
 
+- (void)refreshAllTabProperties
+{
+    for (MMVimController *vc in vimControllers) {
+        [vc.windowController.vimView refreshTabProperties];
+    }
+}
+
 /// Refresh all Vim text views' fonts.
 - (void)refreshAllFonts
 {
-    const NSUInteger count = [vimControllers count];
-    for (unsigned i = 0; i < count; ++i) {
-        MMVimController *vc = [vimControllers objectAtIndex:i];
+    for (MMVimController *vc in vimControllers) {
         [vc.windowController refreshFonts];
     }
 }
@@ -1250,9 +1253,7 @@ - (void)refreshAllFonts
 /// and resize the windows to match the constraints.
 - (void)refreshAllResizeConstraints
 {
-    const NSUInteger count = [vimControllers count];
-    for (unsigned i = 0; i < count; ++i) {
-        MMVimController *vc = [vimControllers objectAtIndex:i];
+    for (MMVimController *vc in vimControllers) {
         [vc.windowController updateResizeConstraints:YES];
     }
 }
@@ -1261,9 +1262,7 @@ - (void)refreshAllResizeConstraints
 /// cmdline alignment properties to make sure they are pinned properly.
 - (void)refreshAllTextViews
 {
-    const NSUInteger count = [vimControllers count];
-    for (unsigned i = 0; i < count; ++i) {
-        MMVimController *vc = [vimControllers objectAtIndex:i];
+    for (MMVimController *vc in vimControllers) {
         [vc.windowController.vimView.textView updateCmdlineRow];
         vc.windowController.vimView.textView.needsDisplay = YES;
     }

src/MacVim/MMPreferenceController.h

@@ -39,5 +39,6 @@
 
 // Appearance pane
 - (IBAction)fontPropertiesChanged:(id)sender;
+- (IBAction)tabsPropertiesChanged:(id)sender;
 
 @end

src/MacVim/MMPreferenceController.m

@@ -167,6 +167,11 @@ - (IBAction)fontPropertiesChanged:(id)sender
     [[MMAppController sharedInstance] refreshAllFonts];
 }
 
+- (IBAction)tabsPropertiesChanged:(id)sender
+{
+    [[MMAppController sharedInstance] refreshAllTabProperties];
+}
+
 - (IBAction)smoothResizeChanged:(id)sender
 {
     [[MMAppController sharedInstance] refreshAllResizeConstraints];

src/MacVim/MMTabline/MMTabline.h

@@ -53,6 +53,8 @@
 - (void)selectTabAtIndex:(NSInteger)index;
 - (MMTab *)tabAtIndex:(NSInteger)index;
 - (void)scrollTabToVisibleAtIndex:(NSInteger)index;
+- (void)scrollLeftOneTab;
+- (void)scrollRightOneTab;
 - (void)setTablineSelBackground:(NSColor *)back foreground:(NSColor *)fore;
 
 @end

src/MacVim/MMTabline/MMTabline.m

@@ -8,9 +8,10 @@
     CGFloat remainder;
 } TabWidth;
 
-const CGFloat OptimumTabWidth = 200;
+const CGFloat OptimumTabWidth = 220;
 const CGFloat MinimumTabWidth = 100;
 const CGFloat TabOverlap      = 6;
+const CGFloat ScrollOneTabAllowance = 0.25; // If we are showing 75+% of the tab, consider it to be fully shown when deciding whether to scroll to next tab.
 
 static MMHoverButton* MakeHoverButton(MMTabline *tabline, NSString *imageName, NSString *tooltip, SEL action, BOOL continuous) {
     MMHoverButton *button = [MMHoverButton new];
@@ -759,7 +760,7 @@ - (void)updateTabScrollButtonsEnabledState
 - (void)scrollTabToVisibleAtIndex:(NSInteger)index
 {
     if (_tabs.count == 0) return;
-    if (index < 0 || index >= _tabs.count) return;
+    index = index < 0 ? 0 : (index >= _tabs.count ? _tabs.count - 1 : index);
 
     // Get the amount of time elapsed between the previous invocation
     // of this method and now. Use this elapsed time to set the animation
@@ -780,8 +781,8 @@ - (void)scrollTabToVisibleAtIndex:(NSInteger)index
     NSTimeInterval elapsedTime = 0.1;
 #endif
 
-    NSRect tabFrame = _tabs[index].frame;
-    NSRect clipBounds = _scrollView.contentView.bounds;
+    NSRect tabFrame = _tabs[index].animator.frame;
+    NSRect clipBounds =_scrollView.contentView.animator.bounds;
     // One side or the other of the selected tab is clipped.
     if (!NSContainsRect(clipBounds, tabFrame)) {
         if (NSMinX(tabFrame) > NSMinX(clipBounds)) {
@@ -793,18 +794,19 @@ - (void)scrollTabToVisibleAtIndex:(NSInteger)index
         }
         [NSAnimationContext beginGrouping];
         [NSAnimationContext.currentContext setDuration:elapsedTime < 0.2 ? 0.05 : 0.2];
-        _scrollView.contentView.animator.bounds = clipBounds;
+        [_scrollView.contentView.animator setBoundsOrigin:clipBounds.origin];
         [NSAnimationContext endGrouping];
     }
 }
 
 - (void)scrollLeftOneTab
 {
-    NSRect clipBounds = _scrollView.contentView.bounds;
+    NSRect clipBounds = _scrollView.contentView.animator.bounds;
     for (NSInteger i = _tabs.count - 1; i >= 0; i--) {
         NSRect tabFrame = _tabs[i].frame;
         if (!NSContainsRect(clipBounds, tabFrame)) {
-            if (NSMinX(tabFrame) < NSMinX(clipBounds)) {
+            CGFloat allowance = i == 0 ? 0 : NSWidth(tabFrame) * ScrollOneTabAllowance;
+            if (NSMinX(tabFrame) + allowance < NSMinX(clipBounds)) {
                 [self scrollTabToVisibleAtIndex:i];
                 break;
             }
@@ -814,11 +816,12 @@ - (void)scrollLeftOneTab
 
 - (void)scrollRightOneTab
 {
-    NSRect clipBounds = _scrollView.contentView.bounds;
+    NSRect clipBounds = _scrollView.contentView.animator.bounds;
     for (NSInteger i = 0; i < _tabs.count; i++) {
         NSRect tabFrame = _tabs[i].frame;
         if (!NSContainsRect(clipBounds, tabFrame)) {
-            if (NSMaxX(tabFrame) > NSMaxX(clipBounds)) {
+            CGFloat allowance = i == _tabs.count - 1 ? 0 : NSWidth(tabFrame) * ScrollOneTabAllowance;
+            if (NSMaxX(tabFrame) - allowance > NSMaxX(clipBounds)) {
                 [self scrollTabToVisibleAtIndex:i];
                 break;
             }

src/MacVim/MMVimView.h

@@ -44,7 +44,12 @@
 
 - (MMTabline *)tabline;
 - (IBAction)addNewTab:(id)sender;
+- (IBAction)scrollToCurrentTab:(id)sender;
+- (IBAction)scrollBackwardOneTab:(id)sender;
+- (IBAction)scrollForwardOneTab:(id)sender;
+- (void)showTabline:(BOOL)on;
 - (void)updateTabsWithData:(NSData *)data;
+- (void)refreshTabProperties;
 
 - (void)createScrollbarWithIdentifier:(int32_t)ident type:(int)type;
 - (BOOL)destroyScrollbarWithIdentifier:(int32_t)ident;