Changeset 41977 in webkit

Timestamp:

Mar 25, 2009 10:30:01 AM (15 years ago)

Author:

kdecker@apple.com

Message:

Reviewed by Kevin Decker.

<rdar://problem/6453738> call SetWindow when user creates a new tab

CoreGraphics plug-ins now receive an NPP_SetWindow call when moving to a background tab.
Flash is excluded from this change in behavior, as it has historical WebKit-specific code
that isn't compatible with this change.

• Plugins/WebNetscapePluginView.h:

Added an _isFlash ivar.

• Plugins/WebNetscapePluginView.mm: (-[WebNetscapePluginView _createPlugin]):

Set the new _isFlash ivar based on the bundle identifier.

(-[WebNetscapePluginView saveAndSetNewPortStateForUpdate:]):

When using the CG drawing model and in a non-drawable state, set the portState
to NULL and return early.

(-[WebNetscapePluginView updateAndSetWindow]):

When using the CG drawing model, call -setWindowIfNecessary even if the portState is NULL.
Flash is an exception to this, due to its historical behavior.

(-[WebNetscapePluginView setWindowIfNecessary]):

Removed an assertion that was no longer true. The [NSView focus] view
is no longer guaranteed to be 'self' at this point.
Also modified the debug logging for CG plug-ins to include the size of the
window's clipRect, which was useful in verifying the correct behavior of this patch.

Location:

trunk/WebKit/mac

Files:

• ChangeLog (modified) (1 diff)
• Plugins/WebNetscapePluginView.h (modified) (1 diff)
• Plugins/WebNetscapePluginView.mm (modified) (7 diffs)

trunk/WebKit/mac/ChangeLog

@@ +1 @@
+2009-03-25  Mike Thole  <mthole@apple.com>
+
+        Reviewed by Kevin Decker.
+        
+        <rdar://problem/6453738> call SetWindow when user creates a new tab
+        
+        CoreGraphics plug-ins now receive an NPP_SetWindow call when moving to a background tab.
+        Flash is excluded from this change in behavior, as it has historical WebKit-specific code
+        that isn't compatible with this change.
+
+        * Plugins/WebNetscapePluginView.h:
+            Added an _isFlash ivar.
+        * Plugins/WebNetscapePluginView.mm:
+        (-[WebNetscapePluginView _createPlugin]):
+            Set the new _isFlash ivar based on the bundle identifier.
+        (-[WebNetscapePluginView saveAndSetNewPortStateForUpdate:]):
+            When using the CG drawing model and in a non-drawable state,  set the portState
+            to NULL and return early.
+        (-[WebNetscapePluginView updateAndSetWindow]):
+            When using the CG drawing model, call -setWindowIfNecessary even if the portState is NULL.
+            Flash is an exception to this, due to its historical behavior.
+        (-[WebNetscapePluginView setWindowIfNecessary]):
+            Removed an assertion that was no longer true.  The [NSView focus] view
+            is no longer guaranteed to be 'self' at this point.
+            Also modified the debug logging for CG plug-ins to include the size of the 
+            window's clipRect, which was useful in verifying the correct behavior of this patch.
+
 2009-03-24  Dan Bernstein  <mitz@apple.com>
 

trunk/WebKit/mac/Plugins/WebNetscapePluginView.h

@@ -100 +100 @@
     RetainPtr<NSMutableDictionary> _pendingFrameLoads;
     
+    BOOL _isFlash;
     BOOL _isSilverlight;
 }

trunk/WebKit/mac/Plugins/WebNetscapePluginView.mm

@@ -495 +495 @@
 
         case NPDrawingModelCoreGraphics: {            
+            if (![self canDraw]) {
+                portState = NULL;
+                break;
+            }
+            
             ASSERT([NSView focusView] == self);
 
@@ -893 +898 @@
     // A plug-in can only update if it's (1) already been started (2) isn't stopped
     // and (3) is able to draw on-screen. To meet condition (3) the plug-in must not
-    // be hidden and be attached to a window. QuickDraw plug-ins are an important
-    // excpetion to rule (3) because they manually must be told when to stop writing
+    // be hidden and be attached to a window. There are two exceptions to this rule:
+    //
+    // Exception 1: QuickDraw plug-ins must be manually told when to stop writing
     // bits to the window backing store, thus to do so requires a new call to
     // NPP_SetWindow() with an empty NPWindow struct.
+    //
+    // Exception 2: CoreGraphics plug-ins expect to have their drawable area updated
+    // when they are moved to a background tab, via a NPP_SetWindow call. This is
+    // accomplished by allowing -saveAndSetNewPortStateForUpdate to "clip-out" the window's
+    // clipRect. Flash is curently an exception to this. See 6453738.
+    //
+    
     if (!_isStarted)
         return;
@@ -906 +919 @@
     if (drawingModel == NPDrawingModelQuickDraw)
         [self tellQuickTimeToChill];
-    else if (drawingModel == NPDrawingModelCoreGraphics && ![self canDraw])
-        return;
-    
+    else if (drawingModel == NPDrawingModelCoreGraphics && ![self canDraw] && _isFlash) {
+        // The Flash plug-in does not expect an NPP_SetWindow call from WebKit in this case.
+        // See Exception 2 above.
+        return;
+    }
 #endif // NP_NO_QUICKDRAW
     
@@ -919 +934 @@
         if (portState != (PortState)1)
             free(portState);
-    }   
+    } else if (drawingModel == NPDrawingModelCoreGraphics)
+        [self setWindowIfNecessary];        
+
     if (didLockFocus)
         [self unlockFocus];
@@ -937 +954 @@
         ASSERT(!inSetWindow);
         
-        inSetWindow = YES;
-        
-        // A CoreGraphics plugin's window may only be set while the plugin is being updated
-        ASSERT((drawingModel != NPDrawingModelCoreGraphics) || [NSView focusView] == self);
-        
+        inSetWindow = YES;        
         [self willCallPlugInFunction];
         {
@@ -960 +973 @@
             
             case NPDrawingModelCoreGraphics:
-                LOG(Plugins, "NPP_SetWindow (CoreGraphics): %d, window=%p, context=%p, window.x:%d window.y:%d window.width:%d window.height:%d",
-                npErr, nPort.cgPort.window, nPort.cgPort.context, (int)window.x, (int)window.y, (int)window.width, (int)window.height);
+                LOG(Plugins, "NPP_SetWindow (CoreGraphics): %d, window=%p, context=%p, window.x:%d window.y:%d window.width:%d window.height:%d window.clipRect size:%dx%d",
+                npErr, nPort.cgPort.window, nPort.cgPort.context, (int)window.x, (int)window.y, (int)window.width, (int)window.height, 
+                    window.clipRect.right - window.clipRect.left, window.clipRect.bottom - window.clipRect.top);
             break;
 
@@ -2060 +2074 @@
     PluginMainThreadScheduler::scheduler().registerPlugin(plugin);
     
+    _isFlash = [[[_pluginPackage.get() bundle] bundleIdentifier] isEqualToString:@"com.macromedia.Flash Player.plugin"];
     _isSilverlight = [[[_pluginPackage.get() bundle] bundleIdentifier] isEqualToString:@"com.microsoft.SilverlightPlugin"];