Fix window shadows.

ui/base/cocoa/underlay_opengl_hosting_window.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 "ui/base/cocoa/underlay_opengl_hosting_window.h"
 
+#import <objc/runtime.h>
+
 #include "base/logging.h"
+#include "base/mac/mac_util.h"
+#include "base/mac/scoped_nsautorelease_pool.h"
+#include "base/memory/scoped_nsobject.h"
+
+@interface NSWindow (UndocumentedAPI)
+// Normally, punching a hole in a window by painting a subview with a
+// transparent color causes the shadow for that area to also not be present.
+// That feature is "content has shadow", which means that shadows are effective
+// even in the content area of the window. If, however, "content has shadow" is
+// turned off, then the transparent area of the content casts a shadow. The one
+// tricky part is that even if "content has shadow" is turned off, "the content"
+// is defined as being the scanline from the leftmost opaque part to the
+// rightmost opaque part.  Therefore, to force the entire window to have a
+// shadow, make sure that for the entire content region, there is an opaque area
+// on the right and left edge of the window.
+- (void)_setContentHasShadow:(BOOL)shadow;
+@end
+
+@interface OpaqueView : NSView
+@end
+
+@implementation OpaqueView
+- (void)drawRect:(NSRect)r {
+  [[NSColor blackColor] set];
+  NSRectFill(r);
+}
+@end
+
+namespace {
+
+NSComparisonResult OpaqueViewsOnTop(id view1, id view2, void* context) {
+  BOOL view1IsOpaqueView = [view1 isKindOfClass:[OpaqueView class]];

[Mark Mentovai, 2012/04/10 19:08:30]

Style nit: use_c_plus_plus_naming outside of @interface/@implementation blocks.

[Avi (use Gerrit), 2012/04/10 19:42:50]

Done.

+  BOOL view2IsOpaqueView = [view2 isKindOfClass:[OpaqueView class]];
+  if (view1IsOpaqueView && view2IsOpaqueView)
+    return NSOrderedSame;
+  if (view1IsOpaqueView)
+    return NSOrderedDescending;
+  if (view2IsOpaqueView)
+    return NSOrderedAscending;
+  return NSOrderedSame;
+}
+
+void RootDidAddSubview(id self, SEL _cmd, NSView* subview) {
+  // Make sure the opaques are on top.
+  [self sortSubviewsUsingFunction:OpaqueViewsOnTop context:NULL];
+}
+
+}  // namespace
 
 @implementation UnderlayOpenGLHostingWindow
 
-- (void)underlaySurfaceAdded {
-  DCHECK_GE(underlaySurfaceCount_, 0);
-  ++underlaySurfaceCount_;
++ (void)load {
+  base::mac::ScopedNSAutoreleasePool pool;
 
-  // We're having the OpenGL surface render under the window, so the window
-  // needs to be not opaque.
-  if (underlaySurfaceCount_ == 1)
-    [self setOpaque:NO];
+  // On 10.8+ the background for textured windows are no longer drawn by
+  // NSGrayFrame, and NSThemeFrame is used instead <http://crbug.com/114745>.
+  Class borderViewClass = NSClassFromString(
+      base::mac::IsOSMountainLionOrLater() ? @"NSThemeFrame" : @"NSGrayFrame");
+  DCHECK(borderViewClass);
+  if (!borderViewClass) return;
+
+  // Install callback for added views.
+  Method m = class_getInstanceMethod([NSView class], @selector(didAddSubview:));

[Mark Mentovai, 2012/04/10 19:08:30]

You can use borderViewClass here instead of [NSView class]. But…

+  DCHECK(m);
+  if (m) {
+    BOOL didAdd = class_addMethod(borderViewClass,
+                                  @selector(didAddSubview:),
+                                  reinterpret_cast<IMP>(&RootDidAddSubview),
+                                  method_getTypeEncoding(m));

[Mark Mentovai, 2012/04/10 19:08:30]

If this is all you’re using m for, it seems like you don’t even really need it.
You can build up the encoding with

  @encode(void), @encode(id), @encode(SEL), @encode(NSView*)

but this also sucks because @encode isn’t treated as a string literal during
preprocessing so you can’t use the preprocessor’s string paste.

[Avi (use Gerrit), 2012/04/10 19:42:50]

I'm having trouble; how do you paste together the strings generated by @encode
into the one big string wanted by class_addMethod? I'm completely happy cheating
and grabbing a ready-to-go type encoding string.

[Mark Mentovai, 2012/04/10 19:48:29]

Avi wrote:
You’d have to build it at runtime with snprintf.

[Avi (use Gerrit), 2012/04/10 20:11:23]

Well, sure, but I'm not sure I see the advantage to grabbing it off the class
we're overriding.

[Mark Mentovai, 2012/04/10 20:19:11]

Avi wrote:
That’s why I said it sucks too.

+    DCHECK(didAdd);
+  }
 }
 
-- (void)underlaySurfaceRemoved {
-  --underlaySurfaceCount_;
-  DCHECK_GE(underlaySurfaceCount_, 0);
+- (id)initWithContentRect:(NSRect)contentRect
+                styleMask:(NSUInteger)windowStyle
+                  backing:(NSBackingStoreType)bufferingType
+                    defer:(BOOL)deferCreation {
+  if ((self = [super initWithContentRect:contentRect
+                               styleMask:windowStyle
+                                 backing:bufferingType
+                                   defer:deferCreation])) {
+    // The invisible opaque area technique only works > 10.5. Fortunately, hole
+    // punching is used only when IOSurfaces are used to transport, and that's
+    // also only on > 10.5.
+    if (base::mac::IsOSSnowLeopardOrLater()) {
+      [self setOpaque:NO];
+      [self _setContentHasShadow:NO];
 
-  if (underlaySurfaceCount_ == 0)
-    [self setOpaque:YES];
+      NSView* rootView = [[self contentView] superview];
+      NSRect rootBounds = [rootView bounds];
+
+      const CGFloat kEdgeInset = 16;
+
+      scoped_nsobject<NSView> leftOpaque(
+          [[OpaqueView alloc] initWithFrame:
+              NSMakeRect(NSMinX(rootBounds), NSMinY(rootBounds) + kEdgeInset,
+                         1, NSHeight(rootBounds) - 2 * kEdgeInset)]);
+      [rootView addSubview:leftOpaque];

[Mark Mentovai, 2012/04/10 19:08:30]

Can you wait to add it ’til after the resize mask and alpha are set up? 114 too.

[Avi (use Gerrit), 2012/04/10 19:42:50]

Done.

+      [leftOpaque setAutoresizingMask:NSViewMaxXMargin|NSViewHeightSizable];

[Mark Mentovai, 2012/04/10 19:08:30]

Tiny bit more readable with space around the “or” operator, and also on line
115.

[Avi (use Gerrit), 2012/04/10 19:42:50]

Done.

+      [leftOpaque setAlphaValue:0.002f];

[Mark Mentovai, 2012/04/10 19:08:30]

Want a const CGFloat to store this so you can be sure you’re using the same
value for rightOpaque?

I’d say “get rid of the f” because CGFloat isn’t always gonna be a float.

[Avi (use Gerrit), 2012/04/10 19:42:50]

Done.

+
+      scoped_nsobject<NSView> rightOpaque([[OpaqueView alloc] initWithFrame:
+          NSMakeRect(NSMaxX(rootBounds) - 1, NSMinY(rootBounds) + kEdgeInset,
+                     1, NSHeight(rootBounds) - 2 * kEdgeInset)]);

[Mark Mentovai, 2012/04/10 19:08:30]

Similarly, you can also keep consts for y and h.

[Avi (use Gerrit), 2012/04/10 19:42:50]

It's weird to have some of the values from the root bounds be consts and not
others.

[Mark Mentovai, 2012/04/10 19:48:29]

Avi wrote:
They’re all consts in that you can declare rootBounds const too…

+      [rootView addSubview:rightOpaque];
+      [rightOpaque setAutoresizingMask:NSViewMinXMargin|NSViewHeightSizable];
+      [rightOpaque setAlphaValue:0.002f];
+    }
+  }
+
+  return self;
 }
 
 @end