author Harry Twyford <htwyford@mozilla.com>

Tue, 19 Jun 2018 16:25:42 -0400

changeset 810983 c180ab622df5a9963e4002fba6571dda99e5319c

parent 810379 6e8e861540e6d8c85c73ab7b2afa1f027fb3750c

push id 114177

push user bmo:htwyford@mozilla.com

push date Tue, 26 Jun 2018 21:35:24 +0000

reviewers spohl, mstange

bugs 1313429

milestone 63.0a1

modules/libpref/init/all.js file | annotate | diff | comparison | revisions

toolkit/components/telemetry/Scalars.yaml file | annotate | diff | comparison | revisions

toolkit/locales/en-US/chrome/global/touchbar.properties file | annotate | diff | comparison | revisions

toolkit/locales/jar.mn file | annotate | diff | comparison | revisions

widget/cocoa/cursors/back@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/forward@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/fullscreen@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/home@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/readermode@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/refresh@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/search@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/share@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/sidebar@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/star@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/cursors/tabnew@2x.png file | annotate | diff | comparison | revisions

widget/cocoa/moz.build file | annotate | diff | comparison | revisions

widget/cocoa/nsCocoaWindow.h file | annotate | diff | comparison | revisions

widget/cocoa/nsCocoaWindow.mm file | annotate | diff | comparison | revisions

widget/cocoa/nsTouchBar.h file | annotate | diff | comparison | revisions

widget/cocoa/nsTouchBar.mm file | annotate | diff | comparison | revisions
--- a/modules/libpref/init/all.js
+++ b/modules/libpref/init/all.js
@@ -272,16 +272,21 @@ pref("ui.click_hold_context_menus", fals
 // Pop up context menu on mouseup instead of mousedown, if that's the OS default.
 // Note: ignored on Windows (context menus always use mouseup)
 pref("ui.context_menus.after_mouseup", false);
 // Duration of timeout of incremental search in menus (ms).  0 means infinite.
 pref("ui.menu.incremental_search.timeout", 1000);
 // If true, all popups won't hide automatically on blur
 pref("ui.popup.disable_autohide", false);
 
+#if defined(XP_MACOSX)
+// 0-2 define different Touch Bar layouts
+pref("ui.touchbar.layout", 0);
+#endif
+
 pref("browser.display.use_document_fonts",  1);  // 0 = never, 1 = quick, 2 = always
 // 0 = default: always, except in high contrast mode
 // 1 = always
 // 2 = never
 pref("browser.display.document_color_use", 0);
 pref("browser.display.use_system_colors",   false);
 pref("browser.display.foreground_color",    "#000000");
 pref("browser.display.background_color",    "#FFFFFF");
--- a/toolkit/components/telemetry/Scalars.yaml
+++ b/toolkit/components/telemetry/Scalars.yaml
@@ -1742,16 +1742,45 @@ memoryreporter:
     expires: "66"
     kind: uint
     notification_emails:
       - memshrink-telemetry-alerts@mozilla.com
     release_channel_collection: opt-out
     record_in_processes:
       - 'content'
 
+# The following section contains Macbook Pro Touch Bar scalars
+touchbar:
+  enabled:
+    bug_numbers:
+      - 1313429
+    description: >
+      If the user has an enabled Touch Bar.
+    expires: "65"
+    kind: boolean
+    notification_emails:
+      - htwyford@mozilla.com
+    release_channel_collection: opt-out
+    record_in_processes:
+      - 'main'
+
+  button_pressed:
+    bug_numbers:
+      - 1313429
+    description: >
+      Which buttons are pressed on the Macbook Pro Touch Bar.
+    keyed: true
+    expires: "65"
+    kind: uint
+    notification_emails:
+      - htwyford@mozilla.com
+    release_channel_collection: opt-out
+    record_in_processes:
+      - 'main'
+
 # The following section is for probes testing the Telemetry system. They will not be
 # submitted in pings and are only used for testing.
 telemetry.test:
   unsigned_int_kind:
     bug_numbers:
       - 1276190
     description: >
       This is a test uint type with a really long description, maybe spanning even multiple
new file mode 100644
--- /dev/null
+++ b/toolkit/locales/en-US/chrome/global/touchbar.properties
@@ -0,0 +1,17 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+back = Back
+forward = Forward
+reload = Reload
+fullScreen = Fullscreen
+readerView = Reader View
+find = Find
+newTab = New Tab
+home = Home
+addBookmark = Add Bookmark
+openBookmarksSidebar = Open Bookmarks Sidebar
+tabList = Tab List
+openLocation = Search or enter address
--- a/toolkit/locales/jar.mn
+++ b/toolkit/locales/jar.mn
@@ -37,16 +37,17 @@
   locale/@AB_CD@/global/datetimebox.dtd                 (%chrome/global/datetimebox.dtd)
   locale/@AB_CD@/global/dialogOverlay.dtd               (%chrome/global/dialogOverlay.dtd)
 #ifndef MOZ_FENNEC
   locale/@AB_CD@/global/editMenuOverlay.dtd             (%chrome/global/editMenuOverlay.dtd)
 #endif
   locale/@AB_CD@/global/extensions.properties           (%chrome/global/extensions.properties)
   locale/@AB_CD@/global/fallbackMenubar.properties      (%chrome/global/fallbackMenubar.properties)
   locale/@AB_CD@/global/filepicker.properties           (%chrome/global/filepicker.properties)
+  locale/@AB_CD@/global/touchbar.properties             (%chrome/global/touchbar.properties)
 #ifndef MOZ_FENNEC
   locale/@AB_CD@/global/findbar.dtd                     (%chrome/global/findbar.dtd)
   locale/@AB_CD@/global/findbar.properties              (%chrome/global/findbar.properties)
 #endif
   locale/@AB_CD@/global/globalKeys.dtd                  (%chrome/global/globalKeys.dtd)
   locale/@AB_CD@/global/intl.css                        (%chrome/global/intl.css)
   locale/@AB_CD@/global/intl.properties                 (%chrome/global/intl.properties)
   locale/@AB_CD@/global/keys.properties                 (%chrome/global/keys.properties)
--- a/widget/cocoa/moz.build
+++ b/widget/cocoa/moz.build
@@ -49,16 +49,17 @@ UNIFIED_SOURCES += [
     'nsMenuX.mm',
     'nsPrintDialogX.mm',
     'nsPrintSettingsServiceX.mm',
     'nsPrintSettingsX.mm',
     'nsSound.mm',
     'nsStandaloneNativeMenu.mm',
     'nsSystemStatusBarCocoa.mm',
     'nsToolkit.mm',
+    'nsTouchBar.mm',
     'nsWidgetFactory.mm',
     'nsWindowMap.mm',
     'OSXNotificationCenter.mm',
     'RectTextureImage.mm',
     'ScreenHelperCocoa.mm',
     'SwipeTracker.mm',
     'TextInputHandler.mm',
     'VibrancyManager.mm',
@@ -100,40 +101,51 @@ if CONFIG['MOZ_ENABLE_SKIA_PDF']:
         '/gfx/skia/skia/include/core',
     ]
 
 RESOURCE_FILES.cursors += [
     'cursors/arrowN.png',
     'cursors/arrowN@2x.png',
     'cursors/arrowS.png',
     'cursors/arrowS@2x.png',
+    'cursors/back@2x.png',
     'cursors/cell.png',
     'cursors/cell@2x.png',
     'cursors/colResize.png',
     'cursors/colResize@2x.png',
+    'cursors/forward@2x.png',
+    'cursors/fullscreen@2x.png',
     'cursors/help.png',
     'cursors/help@2x.png',
+    'cursors/home@2x.png',
     'cursors/move.png',
     'cursors/move@2x.png',
+    'cursors/readermode@2x.png',
+    'cursors/refresh@2x.png',
     'cursors/rowResize.png',
     'cursors/rowResize@2x.png',
+    'cursors/search@2x.png',
+    'cursors/share@2x.png',
+    'cursors/sidebar@2x.png',
     'cursors/sizeNE.png',
     'cursors/sizeNE@2x.png',
     'cursors/sizeNESW.png',
     'cursors/sizeNESW@2x.png',
     'cursors/sizeNS.png',
     'cursors/sizeNS@2x.png',
     'cursors/sizeNW.png',
     'cursors/sizeNW@2x.png',
     'cursors/sizeNWSE.png',
     'cursors/sizeNWSE@2x.png',
     'cursors/sizeSE.png',
     'cursors/sizeSE@2x.png',
     'cursors/sizeSW.png',
     'cursors/sizeSW@2x.png',
+    'cursors/star@2x.png',
+    'cursors/tabnew@2x.png',
     'cursors/vtIBeam.png',
     'cursors/vtIBeam@2x.png',
     'cursors/zoomIn.png',
     'cursors/zoomIn@2x.png',
     'cursors/zoomOut.png',
     'cursors/zoomOut@2x.png',
 ]
 
--- a/widget/cocoa/nsCocoaWindow.h
+++ b/widget/cocoa/nsCocoaWindow.h
@@ -80,16 +80,18 @@ typedef struct _nsCocoaWindowList {
 
 - (void)disableSetNeedsDisplay;
 - (void)enableSetNeedsDisplay;
 
 - (NSRect)getAndResetNativeDirtyRect;
 
 - (void)setUseMenuStyle:(BOOL)aValue;
 
+- (NSTouchBar *)makeTouchBar;
+
 @end
 
 @interface NSWindow (Undocumented)
 
 // If a window has been explicitly removed from the "window cache" (to
 // deactivate it), it's sometimes necessary to "reset" it to reactivate it
 // (and put it back in the "window cache").  One way to do this, which Apple
 // often uses, is to set the "window number" to '-1' and then back to its
--- a/widget/cocoa/nsCocoaWindow.mm
+++ b/widget/cocoa/nsCocoaWindow.mm
@@ -30,16 +30,17 @@
 #include "nsNativeThemeColors.h"
 #include "nsNativeThemeCocoa.h"
 #include "nsChildView.h"
 #include "nsCocoaFeatures.h"
 #include "nsIScreenManager.h"
 #include "nsIWidgetListener.h"
 #include "nsIPresShell.h"
 #include "VibrancyManager.h"
+#include "nsTouchBar.h"
 
 #include "gfxPlatform.h"
 #include "gfxPrefs.h"
 #include "qcms.h"
 
 #include "mozilla/AutoRestore.h"
 #include "mozilla/BasicEvents.h"
 #include "mozilla/Preferences.h"
@@ -3159,16 +3160,21 @@ GetMenuMaskImage()
     // Turn off rounded corner masking.
     NSView* wrapper = [[NSView alloc] initWithFrame:NSZeroRect];
     [self swapOutChildViewWrapper:wrapper];
     [wrapper release];
   }
   mUseMenuStyle = aValue;
 }
 
+- (NSTouchBar *) makeTouchBar
+{
+    return [[TouchBar alloc] init];
+}
+
 - (void)setBeingShown:(BOOL)aValue
 {
   mBeingShown = aValue;
 }
 
 - (BOOL)isBeingShown
 {
   return mBeingShown;
new file mode 100644
--- /dev/null
+++ b/widget/cocoa/nsTouchBar.h
@@ -0,0 +1,58 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef nsTouchBar_h_
+#define nsTouchBar_h_
+
+#import <Cocoa/Cocoa.h>
+
+#include "mozilla/RefPtr.h"
+#include "nsIDocument.h"
+
+/*
+* Our TouchBar is its own delegate. This is adequate for our purposes, since the current
+* implementation only defines Touch Bar buttons for the main Firefox window. If modals and
+* other windows were to have custom Touch Bar views, each window would have to be a
+* NSTouchBarDelegate so they could define their own custom sets of buttons.
+* NSTouchBarDelegate implements `makeTouchBar:` (in lieu of `init:`) and `makeItemForIdentifier`.
+*/
+@interface TouchBar : NSTouchBar<NSTouchBarDelegate>
+
+- (id)init;
+
+// Create new NSTouchBarItem. Reads the passed identifier and creates the
+// appropriate item type (eg. NSCustomTouchBarItem).
+- (NSTouchBarItem*)touchBar:(NSTouchBar*)touchBar
+      makeItemForIdentifier:(NSTouchBarItemIdentifier)identifier;
+
+// Updates NSCustomTouchBarItem, adding a title and image.
+- (void)updateButton:(NSCustomTouchBarItem*)item
+           withTitle:(NSString*)title
+           withImage:(NSImage*)image;
+
+// Initializes buttons from a default set.
+// Could be depreciated in the future if an API is introduced.
+- (void)updateButtonFromDefaults:(NSCustomTouchBarItem*)item
+                      withAction:(NSString*)action;
+
+// Redirects button actions to the appropriate handler and handles telemetry.
+- (void)touchbarAction:(id)sender;
+
+/*
+* Static helper functions
+*/
+// Acquires the active nsIDocument.
++ (RefPtr<nsIDocument>)getXULDocument;
+
++ (void)dispatchSystemFunction:(nsAutoString)action
+                    toDocument:(RefPtr<nsIDocument>)doc;
+
+// Retrieves icons from widget/cocoa/cursors
++ (NSImage*)cursorWithImageNamed:(NSString*)imageName;
+
++ (NSString*)getLocalizedTouchbarName:(NSString*)lookupKey;
+
+@end  // TouchBar
+
+#endif // nsTouchBar_h_
new file mode 100644
--- /dev/null
+++ b/widget/cocoa/nsTouchBar.mm
@@ -0,0 +1,308 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=2 sw=2 et tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsTouchBar.h"
+
+#include "nsMenuUtilsX.h"
+#include "nsDirectoryServiceDefs.h"
+#include "nsIWindowMediator.h"
+#include "nsIDocument.h"
+#include "mozilla/MacStringHelpers.h"
+#include "mozilla/Telemetry.h"
+#include "mozilla/Preferences.h"
+
+#define TOUCHBAR_LAYOUT_PREF      "ui.touchbar.layout"
+
+@implementation TouchBar
+
+static NSTouchBarItemIdentifier CustomButtonIdentifier = @"com.mozilla.firefox.touchbar.button";
+
+static NSTouchBarItemIdentifier NewWindowIdentifier = @"cmd_newNavigator";
+static NSTouchBarItemIdentifier NewTabIdentifier = @"cmd_newNavigatorTabNoEvent";
+static NSTouchBarItemIdentifier CloseWindowIdentifier = @"cmd_closeWindow";
+static NSTouchBarItemIdentifier FindIdentifier = @"cmd_find";
+static NSTouchBarItemIdentifier ViewBookmarksSidebarIdentifier = @"viewBookmarksSidebar";
+
+static NSTouchBarItemIdentifier FullscreenIdentifier = @"View:FullScreen";
+static NSTouchBarItemIdentifier ReaderViewIdentifier = @"View:ReaderView";
+
+static NSTouchBarItemIdentifier AddBookmarkAsIdentifier = @"Browser:AddBookmarkAs";
+static NSTouchBarItemIdentifier HomeIdentifier = @"Browser:Home";
+static NSTouchBarItemIdentifier BackIdentifier = @"Browser:Back";
+static NSTouchBarItemIdentifier ForwardIdentifier = @"Browser:Forward";
+static NSTouchBarItemIdentifier ReloadIdentifier = @"Browser:Reload";
+static NSTouchBarItemIdentifier OpenLocationIdentifier = @"Browser:OpenLocation";
+
+// Used to tie action strings to buttons
+static char actionStringAssociationKey;
+
+#pragma mark - NSTouchBarDelegate
+
+- (id)init
+{
+  if ((self = [super init])) {
+    Telemetry::ScalarSet(Telemetry::ScalarID::TOUCHBAR_ENABLED, true);
+    self.delegate = self;
+
+    // Assemble button identifiers by appending actions to input type
+    NSTouchBarItemIdentifier BackButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:BackIdentifier];
+    NSTouchBarItemIdentifier ForwardButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:ForwardIdentifier];
+    NSTouchBarItemIdentifier ReloadButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:ReloadIdentifier];
+    NSTouchBarItemIdentifier HomeButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:HomeIdentifier];
+    NSTouchBarItemIdentifier FullscreenButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:FullscreenIdentifier];
+    NSTouchBarItemIdentifier FindButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:FindIdentifier];
+    NSTouchBarItemIdentifier NewTabButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:NewTabIdentifier];
+    NSTouchBarItemIdentifier ViewBookmarksSidebarButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:ViewBookmarksSidebarIdentifier];
+    NSTouchBarItemIdentifier AddBookmarkAsButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:AddBookmarkAsIdentifier];
+    NSTouchBarItemIdentifier ReaderViewButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:ReaderViewIdentifier];
+    NSTouchBarItemIdentifier OpenLocationButtonIdentifier =
+      [CustomButtonIdentifier stringByAppendingPathExtension:OpenLocationIdentifier];
+
+    int layoutPref = [TouchBar getLayoutPref];
+
+    switch (layoutPref) {
+      case 2:
+        self.defaultItemIdentifiers = @[BackButtonIdentifier, ForwardButtonIdentifier,
+          ViewBookmarksSidebarButtonIdentifier, ReaderViewButtonIdentifier, FindButtonIdentifier,
+          AddBookmarkAsButtonIdentifier, FullscreenButtonIdentifier, NewTabButtonIdentifier,
+          NSTouchBarItemIdentifierOtherItemsProxy];
+        break;
+      case 1:
+        self.defaultItemIdentifiers = @[BackButtonIdentifier, ReloadButtonIdentifier,
+          HomeButtonIdentifier, OpenLocationButtonIdentifier, FullscreenButtonIdentifier,
+          NewTabButtonIdentifier, NSTouchBarItemIdentifierOtherItemsProxy];
+        break;
+      default:    // case 0
+        self.defaultItemIdentifiers = @[BackButtonIdentifier, ForwardButtonIdentifier,
+          ReloadButtonIdentifier, OpenLocationButtonIdentifier, HomeButtonIdentifier,
+          NewTabButtonIdentifier, NSTouchBarItemIdentifierOtherItemsProxy];
+        break;
+    }
+  }
+
+  return self;
+}
+
+- (NSTouchBarItem*)touchBar:(NSTouchBar*)touchBar
+     makeItemForIdentifier:(NSTouchBarItemIdentifier)identifier
+{
+  if ([identifier hasPrefix:CustomButtonIdentifier]) {
+    NSCustomTouchBarItem* item = [[NSCustomTouchBarItem alloc] initWithIdentifier:identifier];
+    NSButton* theButton = [NSButton buttonWithTitle:@""
+                target:self
+                action:@selector(touchbarAction:)];
+    NSString* actionString = [identifier substringFromIndex:CustomButtonIdentifier.length + 1];
+    objc_setAssociatedObject(theButton, &actionStringAssociationKey, actionString, OBJC_ASSOCIATION_RETAIN);
+    item.view = theButton;
+    [self updateButtonFromDefaults:(NSCustomTouchBarItem*)item withAction:(NSString*)actionString];
+    return item;
+  }
+
+  return nil;
+}
+
+- (void)updateButton:(NSCustomTouchBarItem*)item
+           withTitle:(NSString*)title
+           withImage:(NSImage*)image
+{
+  if (!item)
+    return;
+  NSButton* button = item.view;
+  button.title = title;
+  item.customizationLabel = title;
+  if (image) {
+    button.image = image;
+    [button setImagePosition:NSImageOnly];
+  }
+}
+
+- (void)updateButtonFromDefaults:(NSCustomTouchBarItem*)item
+                      withAction:(NSString*)action
+{
+  // if/elseif instead of switch/case since it's all string comparison
+  if ([action isEqualToString:BackIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"back"]
+             withImage:[TouchBar cursorWithImageNamed:@"back@2x"]];
+  }
+  else if ([action isEqualToString:ForwardIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"forward"]
+             withImage:[TouchBar cursorWithImageNamed:@"forward@2x"]];
+  }
+  else if ([action isEqualToString:ReloadIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"reload"]
+             withImage:[TouchBar cursorWithImageNamed:@"refresh@2x"]];
+  }
+  else if ([action isEqualToString:FullscreenIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"fullScreen"]
+             withImage:[TouchBar cursorWithImageNamed:@"fullscreen@2x"]];
+  }
+  // Not yet receptive to whether or not the page can be opened in Reader View
+  else if ([action isEqualToString:ReaderViewIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"readerView"]
+             withImage:[TouchBar cursorWithImageNamed:@"readermode@2x"]];
+  }
+  else if ([action isEqualToString:FindIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"find"]
+             withImage:[TouchBar cursorWithImageNamed:@"search@2x"]];
+  }
+  else if ([action isEqualToString:NewTabIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"newTab"]
+             withImage:[TouchBar cursorWithImageNamed:@"tabnew@2x"]];
+  }
+  else if ([action isEqualToString:HomeIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"home"]
+             withImage:[TouchBar cursorWithImageNamed:@"home@2x"]];
+  }
+  // Not yet receptive to whether or not the page is already bookmarked
+  else if ([action isEqualToString:AddBookmarkAsIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"addBookmark"]
+             withImage:[TouchBar cursorWithImageNamed:@"star@2x"]];
+  }
+  else if ([action isEqualToString:ViewBookmarksSidebarIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"openBookmarksSidebar"]
+             withImage:[TouchBar cursorWithImageNamed:@"sidebar@2x"]];
+  }
+  // Special handling for the wider Open Location button
+  else if ([action isEqualToString:OpenLocationIdentifier]) {
+    [self updateButton:(NSCustomTouchBarItem*)item
+             withTitle:[TouchBar getLocalizedTouchbarName:@"openLocation"]
+             withImage:[TouchBar cursorWithImageNamed:@"search@2x"]];
+    NSButton* button = item.view;
+    [button setImagePosition:NSImageLeft];
+    button.imageHugsTitle = YES;
+    [button.widthAnchor
+      constraintGreaterThanOrEqualToConstant:252]
+      .active = YES;
+    [button setContentHuggingPriority:1.0
+                       forOrientation:NSLayoutConstraintOrientationHorizontal];
+  }
+}
+
+- (void)touchbarAction:(id)sender
+{
+  NSTouchBarItemIdentifier actionIdentifier = objc_getAssociatedObject(sender, &actionStringAssociationKey);
+  if (!actionIdentifier) {
+    return;
+  }
+
+  nsAutoString action;
+  mozilla::CopyCocoaStringToXPCOMString(actionIdentifier, action);
+
+  Telemetry::ScalarAdd(Telemetry::ScalarID::TOUCHBAR_BUTTON_PRESSED, action, 1);
+  [TouchBar dispatchSystemFunction:action toDocument:[TouchBar getXULDocument]];
+  return;
+}
+
+#pragma mark - TouchBar Utilities
+
++ (RefPtr<nsIDocument>)getXULDocument
+{
+    nsCOMPtr<nsIWindowMediator> wm = do_GetService(NS_WINDOWMEDIATOR_CID);
+
+    if (!wm)
+      return nil;
+
+    nsCOMPtr<mozIDOMWindowProxy> recent;
+    nsresult rv = wm->GetMostRecentWindow(nullptr, getter_AddRefs(recent));
+
+    NS_ENSURE_SUCCESS(rv, nil);
+
+    RefPtr<nsIDocument> doc = nsPIDOMWindowOuter::From(recent)->GetDoc();
+
+    return doc;
+}
+
++ (void)dispatchSystemFunction:(nsAutoString)action
+                    toDocument:(RefPtr<nsIDocument>)doc
+{
+  if (doc == nil)
+    return;
+
+  dom::Element* aDomElement = doc->GetElementById(action);
+  nsMenuUtilsX::DispatchCommandTo(aDomElement);
+}
+
++ (NSImage*)cursorWithImageNamed:(NSString*)imageName
+{
+  nsCOMPtr<nsIFile> resDir;
+  nsAutoCString resPath;
+  NSString* pathToImage;
+
+  nsresult rv = NS_GetSpecialDirectory(NS_GRE_DIR, getter_AddRefs(resDir));
+  resDir->AppendNative(NS_LITERAL_CSTRING("res"));
+  resDir->AppendNative(NS_LITERAL_CSTRING("cursors"));
+
+  rv = resDir->GetNativePath(resPath);
+  NS_ENSURE_SUCCESS(rv, nil);
+
+  pathToImage = [NSString stringWithUTF8String:(const char*)resPath.get()];
+  pathToImage = [pathToImage stringByAppendingPathComponent:imageName];
+  pathToImage = [pathToImage stringByAppendingPathExtension:@"png"];
+  NSImage* image = [[NSImage alloc] initWithContentsOfFile:pathToImage];
+  // A nil image will fail gracefully to a labelled button
+
+  return image;
+}
+
++ (NSString*)getLocalizedTouchbarName:(NSString*)lookupKey
+{
+  NSString* localizedName = [[NSString alloc] initWithString:lookupKey];
+
+  nsCOMPtr<nsIStringBundleService> sbs = do_GetService(NS_STRINGBUNDLE_CONTRACTID);
+  nsCOMPtr<nsIStringBundle> bundle;
+  nsresult rv = sbs->CreateBundle("chrome://global/locale/touchbar.properties", getter_AddRefs(bundle));
+  if (NS_SUCCEEDED(rv)) {
+    nsAutoString localLabel;
+      rv = bundle->GetStringFromName([lookupKey UTF8String], localLabel);
+      if (NS_SUCCEEDED(rv)) {
+      localizedName = [NSString stringWithCharacters:reinterpret_cast<const unichar*>(localLabel.get())
+                      length:localLabel.Length()];
+      }
+  }
+
+  return localizedName;
+}
+
++ (int)getLayoutPref
+{
+    nsresult rv;
+    int layoutPref = 0;
+    nsCOMPtr<nsIPrefService> prefService = do_GetService(NS_PREFSERVICE_CONTRACTID, &rv);
+    if (!NS_FAILED(rv) && prefService) {
+      nsCOMPtr<nsIPrefBranch> mPrefBranch;
+      rv = prefService->GetBranch(nullptr, getter_AddRefs(mPrefBranch));
+      if (!NS_FAILED(rv)) {
+        rv = mPrefBranch->GetIntPrefWithDefault(TOUCHBAR_LAYOUT_PREF, 0, 0, &layoutPref);
+        if (NS_FAILED(rv) || layoutPref < 0 || layoutPref > 3) {
+          layoutPref = 0;
+        }
+      }
+    }
+
+  return layoutPref;
+}
+
+@end
author	Harry Twyford <htwyford@mozilla.com>
	Tue, 19 Jun 2018 16:25:42 -0400
changeset 810983	c180ab622df5a9963e4002fba6571dda99e5319c
parent 810379	6e8e861540e6d8c85c73ab7b2afa1f027fb3750c
push id	114177
push user	bmo:htwyford@mozilla.com
push date	Tue, 26 Jun 2018 21:35:24 +0000
reviewers	spohl, mstange
bugs	1313429
milestone	63.0a1
modules/libpref/init/all.js		file \| annotate \| diff \| comparison \| revisions
toolkit/components/telemetry/Scalars.yaml		file \| annotate \| diff \| comparison \| revisions
toolkit/locales/en-US/chrome/global/touchbar.properties		file \| annotate \| diff \| comparison \| revisions
toolkit/locales/jar.mn		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/back@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/forward@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/fullscreen@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/home@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/readermode@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/refresh@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/search@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/share@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/sidebar@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/star@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/cursors/tabnew@2x.png		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/moz.build		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/nsCocoaWindow.h		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/nsCocoaWindow.mm		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/nsTouchBar.h		file \| annotate \| diff \| comparison \| revisions
widget/cocoa/nsTouchBar.mm		file \| annotate \| diff \| comparison \| revisions