Properly destroy popups when their parent views are told to destroy....

chrome/browser/renderer_host/render_widget_host_view_mac.mm

 // Copyright (c) 2006-2008 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.
 
 #include "chrome/browser/renderer_host/render_widget_host_view_mac.h"
 
 #include "base/histogram.h"
 #include "base/sys_string_conversions.h"
 #include "chrome/browser/browser_trial.h"
 #import "chrome/browser/cocoa/rwhvm_editcommand_helper.h"
 #include "chrome/browser/renderer_host/backing_store.h"
 #include "chrome/browser/renderer_host/render_process_host.h"
 #include "chrome/browser/renderer_host/render_widget_host.h"
 #include "chrome/common/native_web_keyboard_event.h"
 #include "skia/ext/platform_canvas.h"
 #include "webkit/api/public/mac/WebInputEventFactory.h"
 #include "webkit/api/public/WebInputEvent.h"
 #include "webkit/glue/webmenurunner_mac.h"
 
 using WebKit::WebInputEventFactory;
 using WebKit::WebMouseEvent;
 using WebKit::WebMouseWheelEvent;
 
 @interface RenderWidgetHostViewCocoa (Private)
 - (id)initWithRenderWidgetHostViewMac:(RenderWidgetHostViewMac*)r;
+- (void)cancelChildPopups;
 @end
 
 namespace {
 
 // Maximum number of characters we allow in a tooltip.
 const size_t kMaxTooltipLength = 1024;
 
 }
 
 // RenderWidgetHostView --------------------------------------------------------
@@ skipping 207 matching lines @@
   [cocoa_view_ setNeedsDisplay:YES];
 }
 
 void RenderWidgetHostViewMac::RenderViewGone() {
   // TODO(darin): keep this around, and draw sad-tab into it.
   UpdateCursorIfOverSelf();
   Destroy();
 }
 
 void RenderWidgetHostViewMac::Destroy() {
+  // On Windows, popups are implemented with a popup window style, so that when
+  // an event comes in that would "cancel" it, it receives the OnCancelMode
+  // message and can kill itself. Alas, on the Mac, views cannot capture events
+  // outside of themselves. On Windows, if Destroy is being called on a view,
+  // then the event causing the destroy had also cancelled any popups by the
+  // time Destroy() was called. On the Mac we have to destroy all the popups
+  // ourselves.
+
+  // Depth-first destroy all popups. Use ShutdownHost() to enforce deepest-first
+  // ordering.
+  for (RenderWidgetHostViewCocoa* subview in [cocoa_view_ subviews]) {
+    [subview renderWidgetHostViewMac]->ShutdownHost();
+  }
+
   // We've been told to destroy.
   [cocoa_view_ retain];
   [cocoa_view_ removeFromSuperview];
   [cocoa_view_ autorelease];
 
   // We get this call just before |render_widget_host_| deletes
   // itself.  But we are owned by |cocoa_view_|, which may be retained
   // by some other code.  Examples are TabContentsViewMac's
   // |latent_focus_view_| and TabWindowController's
   // |cachedContentView_|.
@@ skipping 153 matching lines @@
 
 - (void)setCanBeKeyView:(BOOL)can {
   canBeKeyView_ = can;
 }
 
 - (void)setCloseOnDeactivate:(BOOL)b {
   closeOnDeactivate_ = b;
 }
 
 - (void)mouseEvent:(NSEvent *)theEvent {
+  // Don't cancel child popups; killing them on a mouse click would prevent the
+  // user from positioning the insertion point in the text field spawning the
+  // popup. A click outside the text field would cause the text field to drop
+  // the focus, and then EditorClientImpl::textFieldDidEndEditing() would cancel
+  // the popup anyway, so we're OK.
+
   const WebMouseEvent& event =
       WebInputEventFactory::mouseEvent(theEvent, self);
   if (renderWidgetHostView_->render_widget_host_)
     renderWidgetHostView_->render_widget_host_->ForwardMouseEvent(event);
 }
 
 - (void)keyEvent:(NSEvent *)theEvent {
   // TODO(avi): Possibly kill self? See RenderWidgetHostViewWin::OnKeyEvent and
   // http://b/issue?id=1192881 .
 
+  // Don't cancel child popups; the key events are probably what's triggering
+  // the popup in the first place.
+
   NativeWebKeyboardEvent event(theEvent);
   if (renderWidgetHostView_->render_widget_host_)
     renderWidgetHostView_->render_widget_host_->ForwardKeyboardEvent(event);
 }
 
 - (void)scrollWheel:(NSEvent *)theEvent {
-  // On Windows, popups are implemented with a popup window style, so that when
-  // an event comes in that would "cancel" it, it receives the OnCancelMode
-  // message and can kill itself. Alas, on the Mac, views cannot capture events
-  // outside of themselves.  While a click outside a popup kills it, that's just
-  // a defocusing of the text field in WebCore and our editor client kills the
-  // popup. But a scroll wheel event outside a popup must kill it.
-  //
-  // Thus this lovely case of filicide. If this view can be the key view, it is
-  // not a popup. Therefore, if it has any children, they are popups that need
-  // to be canceled.
-  if (canBeKeyView_) {
-    for (NSView* subview in [self subviews]) {
-      ((RenderWidgetHostViewCocoa*)subview)->renderWidgetHostView_->KillSelf();
-    }
-  }
+  [self cancelChildPopups];
 
   const WebMouseWheelEvent& event =
       WebInputEventFactory::mouseWheelEvent(theEvent, self);
   if (renderWidgetHostView_->render_widget_host_)
     renderWidgetHostView_->render_widget_host_->ForwardWheelEvent(event);
 }
 
+// See the comment in RenderWidgetHostViewMac::Destroy() about cancellation
+// events. On the Mac we must kill popups on outside events, thus this lovely
+// case of filicide caused by events on parent views.
+- (void)cancelChildPopups {
+  // If this view can be the key view, it is not a popup. Therefore, if it has
+  // any children, they are popups that need to be canceled.
+  if (canBeKeyView_) {
+    for (RenderWidgetHostViewCocoa* subview in [self subviews]) {
+      subview->renderWidgetHostView_->KillSelf();
+    }
+  }
+}
+
 - (void)setFrame:(NSRect)frameRect {
   [super setFrame:frameRect];
   if (renderWidgetHostView_->render_widget_host_)
     renderWidgetHostView_->render_widget_host_->WasResized();
 }
 
 - (void)drawRect:(NSRect)dirtyRect {
   if (!renderWidgetHostView_->render_widget_host_) {
     // TODO(shess): Consider using something more noticable?
     [[NSColor whiteColor] set];
@@ skipping 317 matching lines @@
 // NSView calls this to get the text when displaying the tooltip.
 - (NSString *)view:(NSView *)view
   stringForToolTip:(NSToolTipTag)tag
              point:(NSPoint)point
           userData:(void *)data {
   return [[toolTip_ copy] autorelease];
 }
 
 @end