[Mac] First pass at multiple selection in the tabstrip.

chrome/browser/ui/cocoa/tabs/tab_strip_controller.mm

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "chrome/browser/ui/cocoa/tabs/tab_strip_controller.h"
 
 #import <QuartzCore/QuartzCore.h>
 
 #include <limits>
 #include <string>
 
 #include "app/mac/nsimage_cache.h"
 #include "base/command_line.h"
 #include "base/mac/mac_util.h"
 #include "base/sys_string_conversions.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/autocomplete/autocomplete.h"
 #include "chrome/browser/autocomplete/autocomplete_classifier.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
 #include "chrome/browser/extensions/extension_tab_helper.h"
 #include "chrome/browser/metrics/user_metrics.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/debugger/devtools_window.h"
 #include "chrome/browser/net/url_fixer_upper.h"
 #include "chrome/browser/sidebar/sidebar_container.h"
 #include "chrome/browser/sidebar/sidebar_manager.h"
 #include "chrome/browser/tabs/tab_strip_model.h"
+#include "chrome/browser/tabs/tab_strip_selection_model.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_navigator.h"
 #include "chrome/browser/ui/find_bar/find_tab_helper.h"
 #import "chrome/browser/ui/cocoa/browser_window_controller.h"
 #import "chrome/browser/ui/cocoa/constrained_window_mac.h"
 #import "chrome/browser/ui/cocoa/new_tab_button.h"
 #import "chrome/browser/ui/cocoa/profile_menu_button.h"
 #import "chrome/browser/ui/cocoa/tab_contents/favicon_util.h"
 #import "chrome/browser/ui/cocoa/tabs/tab_controller.h"
 #import "chrome/browser/ui/cocoa/tabs/tab_strip_model_observer_bridge.h"
 #import "chrome/browser/ui/cocoa/tabs/tab_strip_view.h"
 #import "chrome/browser/ui/cocoa/tabs/tab_view.h"
 #import "chrome/browser/ui/cocoa/tabs/throbber_view.h"
 #import "chrome/browser/ui/cocoa/tracking_area.h"
 #include "chrome/browser/ui/find_bar/find_bar.h"
 #include "chrome/browser/ui/find_bar/find_bar_controller.h"
 #include "chrome/browser/ui/title_prefix_matcher.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
+#include "chrome/browser/ui/tabs/tab_menu_model.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "content/browser/tab_contents/navigation_controller.h"
 #include "content/browser/tab_contents/navigation_entry.h"
 #include "content/browser/tab_contents/tab_contents.h"
 #include "content/browser/tab_contents/tab_contents_view.h"
 #include "content/common/notification_service.h"
 #include "grit/app_resources.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
@@ skipping 405 matching lines @@
     const TabContentsWrapper* selection =
         tabStripModel_->GetSelectedTabContents();
     for (int i = 0; i < existingTabCount; ++i) {
       TabContentsWrapper* currentContents = tabStripModel_->GetTabContentsAt(i);
       [self insertTabWithContents:currentContents
                           atIndex:i
                      inForeground:NO];
       if (selection == currentContents) {
         // Must manually force a selection since the model won't send
         // selection messages in this scenario.
-        [self selectTabWithContents:currentContents
-                   previousContents:NULL
-                            atIndex:i
-                        userGesture:NO];
+        [self activateTabWithContents:currentContents
+                     previousContents:NULL
+                              atIndex:i
+                          userGesture:NO];
       }
     }
     // Don't lay out the tabs until after the controller has been fully
     // constructed. The |verticalLayout_| flag has not been initialized by
     // subclasses at this point, which would cause layout to potentially use
     // the wrong mode.
     if (existingTabCount) {
       [self performSelectorOnMainThread:@selector(layoutTabs)
                              withObject:nil
                           waitUntilDone:NO];
@@ skipping 58 matching lines @@
     // ensureContentsVisible (see below) sets content size and autoresizing
     // properties.
     [newView setFrame:[oldView frame]];
     [switchView_ replaceSubview:oldView with:newView];
   } else {
     [newView setFrame:[switchView_ bounds]];
     [switchView_ addSubview:newView];
   }
 
   // New content is in place, delegate should adjust itself accordingly.
-  [delegate_ onSelectTabWithContents:[controller tabContents]];
+  [delegate_ onActivateTabWithContents:[controller tabContents]];
 
   // It also restores content autoresizing properties.
   [controller ensureContentsVisible];
 
   // Tell per-tab sheet manager about currently selected tab.
   if (sheetController_.get()) {
     [sheetController_ setActiveView:newView];
   }
 
   // Make sure the new tabs's sheets are visible (necessary when a background
@@ skipping 50 matching lines @@
   DCHECK_GE(number, 0);
   return number;
 }
 
 // Given an index into the tab model, returns the index into the tab controller
 // or tab contents controller array accounting for tabs that are currently
 // closing. For example, if there are two tabs in the process of closing before
 // |index|, this returns |index| + 2. If there are no closing tabs, this will
 // return |index|.
 - (NSInteger)indexFromModelIndex:(NSInteger)index {
-  DCHECK(index >= 0);
+  DCHECK_GE(index, 0);
   if (index < 0)
     return index;
 
   NSInteger i = 0;
   for (TabController* controller in tabArray_.get()) {
     if ([closingControllers_ containsObject:controller]) {
       DCHECK([(TabView*)[controller view] isClosing]);
       ++index;
     }
     if (i == index)  // No need to check anything after, it has no effect.
@@ skipping 54 matching lines @@
 
 - (NSUInteger)viewsCount {
   return [tabArray_ count];
 }
 
 // Called when the user clicks a tab. Tell the model the selection has changed,
 // which feeds back into us via a notification.
 - (void)selectTab:(id)sender {
   DCHECK([sender isKindOfClass:[NSView class]]);
   int index = [self modelIndexForTabView:sender];
-  if (tabStripModel_->ContainsIndex(index))
-    tabStripModel_->ActivateTabAt(index, true);
+  NSUInteger modifiers = [[NSApp currentEvent] modifierFlags];
+  if (tabStripModel_->ContainsIndex(index)) {
+    if (modifiers & NSCommandKeyMask && modifiers & NSShiftKeyMask) {
+      tabStripModel_->AddSelectionFromAnchorTo(index);
+    } else if (modifiers & NSShiftKeyMask) {
+      tabStripModel_->ExtendSelectionTo(index);
+    } else if (modifiers & NSCommandKeyMask) {
+      tabStripModel_->ToggleSelectionAt(index);
+    } else if (!tabStripModel_->IsTabSelected(index)) {
+      tabStripModel_->ActivateTabAt(index, true);
+    }
+  }
 }
 
 // Called when the user closes a tab. Asks the model to close the tab. |sender|
 // is the TabView that is potentially going away.
 - (void)closeTab:(id)sender {
   DCHECK([sender isKindOfClass:[TabView class]]);
   if ([hoveredTab_ isEqual:sender]) {
     hoveredTab_ = nil;
   }
 
@@ skipping 52 matching lines @@
 // Returns YES if the specificed command should be enabled for the given
 // controller.
 - (BOOL)isCommandEnabled:(TabStripModel::ContextMenuCommand)command
            forController:(TabController*)controller {
   int index = [self modelIndexForTabView:[controller view]];
   if (!tabStripModel_->ContainsIndex(index))
     return NO;
   return tabStripModel_->IsContextMenuCommandEnabled(index, command) ? YES : NO;
 }
 
+// Returns a context menu model for a given controller. Caller owns the result.
+- (ui::SimpleMenuModel*)contextMenuModelForController:(TabController*)controller
+    menuDelegate:(ui::SimpleMenuModel::Delegate*)delegate {
+  int index = [self modelIndexForTabView:[controller view]];
+  return new TabMenuModel(delegate, tabStripModel_, index);
+}
+
 - (void)insertPlaceholderForTab:(TabView*)tab
                           frame:(NSRect)frame
                   yStretchiness:(CGFloat)yStretchiness {
   placeholderTab_ = tab;
   placeholderFrame_ = frame;
   placeholderStretchiness_ = yStretchiness;
   [self layoutTabsWithAnimation:initialLayoutComplete_ regenerateSubviews:NO];
 }
 
 - (BOOL)isDragSessionActive {
@@ skipping 368 matching lines @@
   [self updateCommonTitlePrefix];
 
   // Send a broadcast that the number of tabs have changed.
   [[NSNotificationCenter defaultCenter]
       postNotificationName:kTabStripNumberOfTabsChanged
                     object:self];
 }
 
 // Called when a notification is received from the model to select a particular
 // tab. Swaps in the toolbar and content area associated with |newContents|.
-- (void)selectTabWithContents:(TabContentsWrapper*)newContents
-             previousContents:(TabContentsWrapper*)oldContents
-                      atIndex:(NSInteger)modelIndex
-                  userGesture:(bool)wasUserGesture {
+- (void)activateTabWithContents:(TabContentsWrapper*)newContents
+               previousContents:(TabContentsWrapper*)oldContents
+                        atIndex:(NSInteger)modelIndex
+                    userGesture:(bool)wasUserGesture {
   // Take closing tabs into account.
-  NSInteger index = [self indexFromModelIndex:modelIndex];
+  NSInteger activeIndex = [self indexFromModelIndex:modelIndex];
 
   if (oldContents && oldContents != newContents) {
     int oldModelIndex =
         browser_->GetIndexOfController(&(oldContents->controller()));
     if (oldModelIndex != -1) {  // When closing a tab, the old tab may be gone.
       NSInteger oldIndex = [self indexFromModelIndex:oldModelIndex];
       TabContentsController* oldController =
           [tabContentsArray_ objectAtIndex:oldIndex];
       [oldController willBecomeUnselectedTab];
       oldContents->view()->StoreFocus();
       oldContents->tab_contents()->WasHidden();
     }
   }
 
-  // De-select all other tabs and select the new tab.
+  // First get the vector of indices, which is allays sorted in ascending order.
+  TabStripSelectionModel::SelectedIndices selection(
+      tabStripModel_->selection_model().selected_indices());
+  // Iterate through all of the tabs, selecting each as necessary.
+  TabStripSelectionModel::SelectedIndices::iterator iter = selection.begin();
   int i = 0;
   for (TabController* current in tabArray_.get()) {
-    [current setSelected:(i == index) ? YES : NO];
+    BOOL selected = iter != selection.end() &&
+        [self indexFromModelIndex:*iter] == i;
+    [current setSelected:selected];
+    [current setActive:i == activeIndex];
+    if (selected)
+      ++iter;
     ++i;
   }
 
   // Tell the new tab contents it is about to become the selected tab. Here it
   // can do things like make sure the toolbar is up to date.
   TabContentsController* newController =
-      [tabContentsArray_ objectAtIndex:index];
+      [tabContentsArray_ objectAtIndex:activeIndex];
   [newController willBecomeSelectedTab];
 
   // Relayout for new tabs and to let the selected tab grow to be larger in
   // size than surrounding tabs if the user has many. This also raises the
   // selected tab to the top.
   [self layoutTabs];
 
   // Swap in the contents for the new tab.
   [self swapInTabAtIndex:modelIndex];
 
@@ skipping 240 matching lines @@
 // Called when a notification is received from the model that the given tab
 // has been updated. |loading| will be YES when we only want to update the
 // throbber state, not anything else about the (partially) loading tab.
 - (void)tabChangedWithContents:(TabContentsWrapper*)contents
                        atIndex:(NSInteger)modelIndex
                     changeType:(TabStripModelObserver::TabChangeType)change {
   // Take closing tabs into account.
   NSInteger index = [self indexFromModelIndex:modelIndex];
 
   if (modelIndex == tabStripModel_->active_index())
-    [delegate_ onSelectedTabChange:change];
+    [delegate_ onTabChanged:change withContents:contents->tab_contents()];
 
   if (change == TabStripModelObserver::TITLE_NOT_LOADING) {
     // TODO(sky): make this work.
     // We'll receive another notification of the change asynchronously.
     return;
   }
 
   TabController* tabController = [tabArray_ objectAtIndex:index];
 
   if (change != TabStripModelObserver::LOADING_ONLY)
@@ skipping 55 matching lines @@
   [tabController setUrl:contents->tab_contents()->GetURL()];
   [self updateFaviconForContents:contents->tab_contents() atIndex:modelIndex];
   // If the tab is being restored and it's pinned, the mini state is set after
   // the tab has already been rendered, so re-layout the tabstrip. In all other
   // cases, the state is set before the tab is rendered so this isn't needed.
   [self layoutTabs];
 
   [self updateCommonTitlePrefix];
 }
 
-- (void)setFrameOfSelectedTab:(NSRect)frame {
-  NSView* view = [self selectedTabView];
+- (void)setFrameOfActiveTab:(NSRect)frame {
+  NSView* view = [self activeTabView];
   NSValue* identifier = [NSValue valueWithPointer:view];
   [targetFrames_ setObject:[NSValue valueWithRect:frame]
                     forKey:identifier];
   [view setFrame:frame];
 }
 
-- (NSView*)selectedTabView {
-  int selectedIndex = tabStripModel_->active_index();
+- (NSView*)activeTabView {
+  int activeIndex = tabStripModel_->active_index();
   // Take closing tabs into account. They can't ever be selected.
-  selectedIndex = [self indexFromModelIndex:selectedIndex];
-  return [self viewAtIndex:selectedIndex];
+  activeIndex = [self indexFromModelIndex:activeIndex];
+  return [self viewAtIndex:activeIndex];
 }
 
 // Find the model index based on the x coordinate of the placeholder. If there
 // is no placeholder, this returns the end of the tab strip. Closing tabs are
 // not considered in computing the index.
 - (int)indexOfPlaceholder {
   double placeholderX = placeholderFrame_.origin.x;
   int index = 0;
   int location = 0;
   // Use |tabArray_| here instead of the tab strip count in order to get the
@@ skipping 204 matching lines @@
 // |-regenerateSubviewList| to actually add it).
 - (void)regenerateSubviewList {
   // Remove self as an observer from all the old tabs before a new set of
   // potentially different tabs is put in place.
   [self setTabTrackingAreasEnabled:NO];
 
   // Subviews to put in (in bottom-to-top order), beginning with the permanent
   // ones.
   NSMutableArray* subviews = [NSMutableArray arrayWithArray:permanentSubviews_];
 
-  NSView* selectedTabView = nil;
+  NSView* activeTabView = nil;
   // Go through tabs in reverse order, since |subviews| is bottom-to-top.
   for (TabController* tab in [tabArray_ reverseObjectEnumerator]) {
     NSView* tabView = [tab view];
-    if ([tab selected]) {
-      DCHECK(!selectedTabView);
-      selectedTabView = tabView;
+    if ([tab active]) {
+      DCHECK(!activeTabView);
+      activeTabView = tabView;
     } else {
       [subviews addObject:tabView];
     }
   }
-  if (selectedTabView) {
-    [subviews addObject:selectedTabView];
+  if (activeTabView) {
+    [subviews addObject:activeTabView];
   }
   [tabStripView_ setSubviews:subviews];
   [self setTabTrackingAreasEnabled:mouseInside_];
 }
 
 // Get the index and disposition for a potential URL(s) drop given a point (in
 // the |TabStripView|'s coordinates). It considers only the x-coordinate of the
 // given point. If it's in the "middle" of a tab, it drops on that tab. If it's
 // to the left, it inserts to the left, and similarly for the right.
 - (void)droppingURLsAt:(NSPoint)point
@@ skipping 314 matching lines @@
   }
 
   NSString* menuTitle =
       l10n_util::GetNSStringWithFixup(IDS_PROFILES_CREATE_NEW_PROFILE_OPTION);
   [menu addItemWithTitle:menuTitle
                   action:NULL
            keyEquivalent:@""];
 }
 
 @end