[Autofill] Add Mac implementation for the in-browser process popup view.

chrome/browser/ui/cocoa/autofill/autofill_popup_view_cocoa.mm

+// Copyright (c) 2012 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/autofill/autofill_popup_view_cocoa.h"
+
+#include "base/i18n/rtl.h"
+#include "base/logging.h"
+#include "base/sys_string_conversions.h"
+#include "chrome/browser/ui/autofill/autofill_popup_controller.h"
+#include "chrome/browser/ui/cocoa/autofill/autofill_popup_view_mac.h"
+#include "grit/ui_resources.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebAutofillClient.h"
+#include "ui/base/resource/resource_bundle.h"
+#include "ui/gfx/image/image.h"
+#include "ui/gfx/point.h"
+#include "ui/gfx/rect.h"
+
+#pragma mark -
+#pragma mark Private methods
+
+@interface AutofillPopupViewCocoa ()
+
+// Draws a thin separator in the popup UI.
+- (void)drawSeparatorWithBounds:(NSRect)bounds;
+
+// Draws an Autofill suggestion in the given |bounds|, labeled with the given
+// |name| and |subtext| hint.  If the suggestion |isSelected|, then it is drawn
+// with a highlight.  Some suggestions -- such as for credit cards -- might also
+// include an |icon| -- e.g. for the card type.  Finally, if |canDelete| is
+// true, a delete icon is also drawn.
+- (void)drawSuggestionWithName:(NSString*)name
+                       subtext:(NSString*)subtext
+                          icon:(NSImage*)icon
+                        bounds:(NSRect)bounds
+                      selected:(BOOL)isSelected
+                     canDelete:(BOOL)canDelete;
+
+// Returns the icon for the row with the given |index|, or |nil| if there is
+// none.
+- (NSImage*)iconAtIndex:(size_t)index;
+
+// Flips the given |point|'s y coordinate to match Chrome's screen coordinate
+// system.
+- (gfx::Point)flipNSPointToPoint:(NSPoint)point;
+
+@end
+
+@implementation AutofillPopupViewCocoa
+
+#pragma mark -
+#pragma mark Initialisers
+
+- (id)initWithFrame:(NSRect)frame {
+  NOTREACHED();
+  return [self initWithController:NULL frame:frame];
+}
+
+- (id)initWithController:(AutofillPopupController*)controller
+                   frame:(NSRect)frame {
+  self = [super initWithFrame:frame];
+  if (self)
+    controller_ = controller;
+
+  return self;
+}
+
+#pragma mark -
+#pragma mark NSView implementation:
+
+// A slight optimization for drawing:
+// https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CocoaViewsGuide/Optimizing/Optimizing.html
+- (BOOL)isOpaque {
+  return YES;
+}
+
+- (void)drawRect:(NSRect)dirtyRect {
+  // If the view is in the process of being destroyed, don't bother drawing.
+  if (!controller_)
+    return;
+
+  // TODO(isherman): Is there a better way to leave room for the border?
+  // TODO(isherman): Drawing the border as part of the content view means that
+  // the rest of the content has to be careful not to overlap the border.
+  // Should the border be part of the window instead?  If not, should the rest
+  // of the view be a subview?  Or should I just draw the window content
+  // carefully?
+  NSRect borderRect = NSInsetRect([self bounds], 0.5, 0.5);
+  NSBezierPath* border = [NSBezierPath bezierPathWithRect:borderRect];
+
+  [[NSColor whiteColor] set];
+  [border fill];
+
+  // TODO(isherman): This color does not match the other platforms, but it
+  // matches what the existing UI on Mac has as the color.  The other platforms
+  // have a strange color: the RGB values are almost, but not quite, identical
+  // to each other.
+  // TODO(isherman): Maybe use a system color for this?
+  [[NSColor colorWithCalibratedRed:127/255.0
+                             green:157/255.0
+                              blue:185/255.0
+                             alpha:1.0] set];
+  [border stroke];
+
+  for (size_t i = 0; i < controller_->names().size(); ++i) {
+    // Skip rows outside of the dirty rect.
+    NSRect rowBounds = [self flipRectToNSRect:controller_->GetRowBounds(i)];
+    if (!NSIntersectsRect(rowBounds, dirtyRect))
+      continue;
+
+    if (controller_->identifiers()[i] ==
+            WebKit::WebAutofillClient::MenuItemIDSeparator) {
+      [self drawSeparatorWithBounds:rowBounds];
+    } else {
+      NSString* name = SysUTF16ToNSString(controller_->names()[i]);
+      NSString* subtext = SysUTF16ToNSString(controller_->subtexts()[i]);
+      BOOL isSelected = static_cast<int>(i) == controller_->selected_line();
+      [self drawSuggestionWithName:name
+                           subtext:subtext
+                              icon:[self iconAtIndex:i]
+                            bounds:rowBounds
+                          selected:isSelected
+                         canDelete:controller_->CanDelete(i)];
+    }
+  }
+}
+
+#pragma mark -
+#pragma mark BaseView implementation:
+
+- (void)mouseEvent:(NSEvent *)theEvent {
+  // If the view is in the process of being destroyed, abort.
+  if (!controller_)
+    return;
+
+  NSEventType event_type = [theEvent type];

[Scott Hess - ex-Googler, 2013/01/09 21:36:17]

It seems kind of roundabout to override -mouseUp:, -mouseExited: -mouseMoved:
and -mouseDragged: to call -mouseEvent: and then dispatch manually to specific
controller_ functions.  Does it look that bad to have them coded up
individually, perhaps with -mouseDragged: just calling -mouseMoved:?

If that is too much, move event_type down to where it's used, and convert to
eventType because of Objective-C.

[Ilya Sherman, 2013/01/10 02:21:21]

Done.  I was mostly just following the BaseView class design, on the assumption
that there was some reason for funneling mouse events that way.

[Scott Hess - ex-Googler, 2013/01/10 22:02:57]

I think BaseView might do that for purposes of subclasses which need to funnel
all events somewhere else for dispatch.  Though I might be wrong.  Regardless, I
think leaving them broken out makes it somewhat clearer which bits of per-event
magic belong together, which might prevent future developers from making
ill-advised changes.

[It's also possible you shouldn't be a BaseView subclass in the first place. 
Maybe Avi would know.]

+  NSPoint location = [self convertPoint:[theEvent locationInWindow]
+                               fromView:nil];
+
+  // Convert to Chrome's screen coordinates.

[Scott Hess - ex-Googler, 2013/01/09 21:36:17]

I don't understand what "screen coordinates" means in this case?  AFAICT what
you're calculating is the mouse location relative to the upper-left of the
popup.

Also, screenLocation not screen_location.

[Ilya Sherman, 2013/01/10 02:21:21]

Moot.

+  gfx::Point screen_location = [self flipNSPointToPoint:location];
+
+  if (event_type == NSLeftMouseUp && NSPointInRect(location, [self bounds]))
+    controller_->MouseClicked(screen_location.x(), screen_location.y());
+  else if (event_type == NSMouseExited)
+    controller_->MouseExitedPopup();
+  else if (event_type == NSMouseMoved || event_type == NSLeftMouseDragged)
+    controller_->MouseHovered(screen_location.x(), screen_location.y());
+}
+
+#pragma mark -
+#pragma mark Public API:
+
+- (void)controllerDestroyed {

[Scott Hess - ex-Googler, 2013/01/09 21:36:17]

This is where I meant to drop a comment.  When this is called, it indicated that
controller_ cannot be safely accessed.  Just so someone doesn't do something
like one-last-update or whatever.

[Ilya Sherman, 2013/01/10 02:21:21]

Done.

+  controller_ = NULL;
+}
+
+#pragma mark -
+#pragma mark Private API:
+
+- (void)drawSeparatorWithBounds:(NSRect)bounds {
+  [[NSColor colorWithCalibratedWhite:220/255.0 alpha:1] set];
+  [NSBezierPath fillRect:bounds];
+}
+
+- (void)drawSuggestionWithName:(NSString*)name
+                       subtext:(NSString*)subtext
+                          icon:(NSImage*)icon
+                        bounds:(NSRect)bounds
+                      selected:(BOOL)isSelected
+                     canDelete:(BOOL)canDelete {
+  // If this row is selected, highlight it.
+  if (isSelected) {
+    // TODO(isherman): The highlight color should match the system highlight
+    // color.  Maybe use controlHighlightColor or selectedTextBackgroundColor
+    // for this?
+    [[NSColor colorWithCalibratedWhite:(0xCD / 255.0) alpha:1] set];
+    [NSBezierPath fillRect:bounds];
+  }
+
+  BOOL isRTL = base::i18n::IsRTL();
+
+  // TODO(isherman): Set font, colors, and any other appropriate attributes.
+  NSSize nameSize = [name sizeWithAttributes:nil];
+  CGFloat x = bounds.origin.x +
+      (isRTL ?
+       bounds.size.width - AutofillPopupView::kEndPadding - nameSize.width:
+       AutofillPopupView::kEndPadding);
+  CGFloat y = bounds.origin.y + (bounds.size.height - nameSize.height) / 2;
+
+  [name drawAtPoint:NSMakePoint(x, y) withAttributes:nil];
+
+  ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
+
+  // The x-coordinate will be updated as each element is drawn.
+  x = bounds.origin.x +
+      (isRTL ?
+       AutofillPopupView::kEndPadding :
+       bounds.size.width - AutofillPopupView::kEndPadding);
+
+  // Draw the delete icon, if one is needed.
+  if (canDelete) {
+    // TODO(csharp): Create a custom resource for the delete icon.
+    // http://crbug.com/131801
+    NSImage* deleteIcon;
+    if (isSelected && controller_->delete_icon_hovered())
+      deleteIcon = rb.GetImageNamed(IDR_CLOSE_BAR_H).ToNSImage();

[Robert Sesek, 2013/01/09 22:17:30]

drive-by: use GetNativeImageNamed to avoid an Skia conversion

[Ilya Sherman, 2013/01/10 02:21:21]

Thanks, done.

+    else
+      deleteIcon = rb.GetImageNamed(IDR_CLOSE_BAR).ToNSImage();
+
+    NSSize iconSize = [deleteIcon size];
+    x += isRTL ? 0 : -iconSize.width;
+    y = bounds.origin.y + (bounds.size.height - iconSize.height) / 2;
+    [deleteIcon drawAtPoint:NSMakePoint(x, y)
+                   fromRect:NSZeroRect
+                  operation:NSCompositeSourceOver
+                   fraction:1.0];
+
+    x += isRTL ?
+        iconSize.width + AutofillPopupView::kIconPadding :
+        -AutofillPopupView::kIconPadding;
+  }
+
+  // Draw the Autofill icon, if one exists.
+  if (icon) {
+    NSSize iconSize = [icon size];
+    x += isRTL ? 0 : -iconSize.width;
+    y = bounds.origin.y + (bounds.size.height - iconSize.height) / 2;
+    [icon drawAtPoint:NSMakePoint(x, y)
+             fromRect:NSZeroRect
+            operation:NSCompositeSourceOver
+             fraction:1.0];
+
+    x += isRTL ?
+        iconSize.width + AutofillPopupView::kIconPadding :
+        -AutofillPopupView::kIconPadding;
+  }
+
+  // Draw the subtext.
+  NSSize subtextSize = [subtext sizeWithAttributes:nil];
+  x += isRTL ? 0 : -subtextSize.width;
+  y = bounds.origin.y + (bounds.size.height - subtextSize.height) / 2;
+
+  [subtext drawAtPoint:NSMakePoint(x, y) withAttributes:nil];
+}
+
+- (NSImage*)iconAtIndex:(size_t)index {
+  if (controller_->icons()[index].empty())
+    return nil;
+
+  int iconId = controller_->GetIconResourceID(controller_->icons()[index]);
+  DCHECK_NE(-1, iconId);
+  return
+      ui::ResourceBundle::GetSharedInstance().GetImageNamed(iconId).ToNSImage();
+}
+
+- (gfx::Point)flipNSPointToPoint:(NSPoint)point {
+  NSRect rect;
+  rect.origin = point;
+  rect.size = NSZeroSize;

[Scott Hess - ex-Googler, 2013/01/09 21:36:17]

NSRect rect = {point, NSZeroSize}; should work.
Or NSMakeRect(point.x, point.y, 0, 0) is pretty readible, too.

[Ilya Sherman, 2013/01/10 02:21:21]

Moot.

+  return [self flipNSRectToRect:rect].origin();
+}
+
+@end