Remove FrameViewBase as base class of PluginView.

third_party/WebKit/Source/core/layout/LayoutPart.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 2000 Simon Hausmann <hausmann@kde.org>
  *           (C) 2000 Stefan Schimanski (1Stein@gmx.de)
  * Copyright (C) 2004, 2005, 2006, 2009 Apple Inc. All rights reserved.
  * Copyright (C) Research In Motion Limited 2011. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, write to
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  *
  */
 
 #include "core/layout/LayoutPart.h"
 
 #include "core/dom/AXObjectCache.h"
+#include "core/frame/FrameOrPlugin.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/LocalFrame.h"
 #include "core/html/HTMLFrameElementBase.h"
 #include "core/html/HTMLPlugInElement.h"
 #include "core/layout/HitTestResult.h"
 #include "core/layout/LayoutAnalyzer.h"
 #include "core/layout/LayoutView.h"
 #include "core/layout/api/LayoutAPIShim.h"
 #include "core/layout/api/LayoutViewItem.h"
 #include "core/paint/PartPainter.h"
@@ skipping 45 matching lines @@
   // we don't access it in the future.
   ClearNode();
   Deref();
 }
 
 LayoutPart::~LayoutPart() {
   DCHECK_LE(ref_count_, 0);
 }
 
 FrameViewBase* LayoutPart::GetFrameViewBase() const {
-  // Plugin FrameViewBases are stored in their DOM node.
+  // FrameViews are stored in HTMLFrameOwnerElement node.
   Element* element = ToElement(GetNode());
 
   if (element && element->IsFrameOwnerElement())
     return ToHTMLFrameOwnerElement(element)->OwnedWidget();
 
   return nullptr;
 }
 
 PluginView* LayoutPart::Plugin() const {
   // Plugins are stored in their DOM node.
   return GetNode() && IsHTMLPlugInElement(GetNode())
              ? ToHTMLPlugInElement(GetNode())->Plugin()
              : nullptr;
 }
 
-FrameViewBase* LayoutPart::PluginOrFrame() const {
-  FrameViewBase* result = GetFrameViewBase();
+FrameOrPlugin* LayoutPart::GetFrameOrPlugin() const {
+  FrameOrPlugin* result = nullptr;
+  FrameViewBase* frame_view_base = GetFrameViewBase();
+  if (frame_view_base && frame_view_base->IsFrameView()) {
+    result = ToFrameView(frame_view_base);
+  }
   if (!result)
     result = Plugin();
   return result;
 }
 
 PaintLayerType LayoutPart::LayerTypeRequired() const {
   PaintLayerType type = LayoutReplaced::LayerTypeRequired();
   if (type != kNoPaintLayer)
     return type;
   return kForcedPaintLayer;
@@ skipping 128 matching lines @@
 
 CompositingReasons LayoutPart::AdditionalCompositingReasons() const {
   if (RequiresAcceleratedCompositing())
     return kCompositingReasonIFrame;
   return kCompositingReasonNone;
 }
 
 void LayoutPart::StyleDidChange(StyleDifference diff,
                                 const ComputedStyle* old_style) {
   LayoutReplaced::StyleDidChange(diff, old_style);
-  FrameViewBase* frame_view_base = this->PluginOrFrame();
-  if (!frame_view_base)
+  FrameOrPlugin* frame_or_plugin = GetFrameOrPlugin();
+  if (!frame_or_plugin)
     return;
 
   // If the iframe has custom scrollbars, recalculate their style.
-  if (frame_view_base->IsFrameView())
-    ToFrameView(frame_view_base)->RecalculateCustomScrollbarStyle();
+  FrameViewBase* frame_view_base = GetFrameViewBase();
+  if (frame_view_base && frame_view_base->IsFrameView()) {

[dcheng, 2017/04/12 00:06:39]

Maybe it would be more natural to write this as a downcast from FrameOrPlugin
directly, rather than checking FrameViewBase?

[joelhockey, 2017/04/12 04:33:00]

My preferred solution is to make FrameView accessible directly from LayoutPart
on its own method.  I didn't want to mix up this CL with too many things though.
 I think I'll do it as a prequel CL right now.  Keep your eyes peeeled.

I don't like the explicit downcasts as a general pattern, so I don't want to
introduce it into the FrameOrPlugin class.

LayoutPart inherits indirectly from LayoutObject.  LayoutObject already has a
method GetFrameView which returns Document().Frame().View().  This is not the
same as the FrameViewBase which is stored on HTMLFrameOwnerElement.  So I need
to think of a good name for this method.  I will do my best and you will see it
in a CL coming soon.

+    FrameView* frame_view = ToFrameView(frame_view_base);
+    frame_view->RecalculateCustomScrollbarStyle();
+  }
 
   if (Style()->Visibility() != EVisibility::kVisible) {
-    frame_view_base->Hide();
+    frame_or_plugin->Hide();
   } else {
-    frame_view_base->Show();
+    frame_or_plugin->Show();
   }
 }
 
 void LayoutPart::GetLayout() {
   DCHECK(NeedsLayout());
   LayoutAnalyzer::Scope analyzer(*this);
   ClearNeedsLayout();
 }
 
 void LayoutPart::Paint(const PaintInfo& paint_info,
@@ skipping 21 matching lines @@
   // rect is snapped at the document boundary, and sub-pixel movement could
   // cause the sub-frame to layout due to the 1px snap difference. In order to
   // avoid that, the size of sub-frame is rounded in advance.
   LayoutRect size_rounded_rect = ContentBoxRect();
   size_rounded_rect.SetSize(
       LayoutSize(RoundedIntSize(size_rounded_rect.size())));
   return size_rounded_rect;
 }
 
 void LayoutPart::UpdateOnWidgetChange() {
-  FrameViewBase* frame_view_base = this->PluginOrFrame();
-  if (!frame_view_base)
+  FrameOrPlugin* frame_or_plugin = GetFrameOrPlugin();
+  if (!frame_or_plugin)
     return;
 
   if (!Style())
     return;
 
   if (!NeedsLayout())
-    UpdateGeometryInternal(*frame_view_base);
+    UpdateGeometryInternal(*frame_or_plugin);
 
   if (Style()->Visibility() != EVisibility::kVisible) {
-    frame_view_base->Hide();
+    frame_or_plugin->Hide();
   } else {
-    frame_view_base->Show();
+    frame_or_plugin->Show();
     // FIXME: Why do we issue a full paint invalidation in this case, but not
     // the other?
     SetShouldDoFullPaintInvalidation();
   }
 }
 
 void LayoutPart::UpdateGeometry() {
-  FrameViewBase* frame_view_base = this->PluginOrFrame();
-  if (!frame_view_base ||
+  FrameOrPlugin* frame_or_plugin = GetFrameOrPlugin();
+  if (!frame_or_plugin ||
       !GetNode())  // Check the node in case destroy() has been called.
     return;
 
   LayoutRect new_frame = ReplacedContentRect();
   DCHECK(new_frame.size() == RoundedIntSize(new_frame.size()));
   bool bounds_will_change =
-      LayoutSize(frame_view_base->FrameRect().size()) != new_frame.size();
+      LayoutSize(frame_or_plugin->FrameRect().size()) != new_frame.size();
 
-  FrameView* frame_view =
-      frame_view_base->IsFrameView() ? ToFrameView(frame_view_base) : nullptr;
+  FrameViewBase* frame_view_base = GetFrameViewBase();
+  FrameView* frame_view = nullptr;
+  if (frame_view_base && frame_view_base->IsFrameView()) {

[dcheng, 2017/04/12 00:06:39]

Ditto -- it seems a bit unusual to have this null check here.

[joelhockey, 2017/04/12 04:33:00]

I'll clean this up as a prequel CL.

+    frame_view = ToFrameView(frame_view_base);
+  }
 
   // If frame bounds are changing mark the view for layout. Also check the
   // frame's page to make sure that the frame isn't in the process of being
   // destroyed. If iframe scrollbars needs reconstruction from native to custom
   // scrollbar, then also we need to layout the frameview.
   if (frame_view && frame_view->GetFrame().GetPage() &&
       (bounds_will_change || frame_view->NeedsScrollbarReconstruction()))
     frame_view->SetNeedsLayout();
 
-  UpdateGeometryInternal(*frame_view_base);
+  UpdateGeometryInternal(*frame_or_plugin);
 
   // If view needs layout, either because bounds have changed or possibly
   // indicating content size is wrong, we have to do a layout to set the right
-  // FrameViewBase size.
+  // FrameView size.
   if (frame_view && frame_view->NeedsLayout() &&
       frame_view->GetFrame().GetPage())
     frame_view->Layout();
 
-  frame_view_base->GeometryMayHaveChanged();
+  if (PluginView* plugin = Plugin())
+    plugin->GeometryMayHaveChanged();
 }
 
-void LayoutPart::UpdateGeometryInternal(FrameViewBase& frame_view_base) {
+void LayoutPart::UpdateGeometryInternal(FrameOrPlugin& frame_or_plugin) {
   // Ignore transform here, as we only care about the sub-pixel accumulation.
   // TODO(trchen): What about multicol? Need a LayoutBox function to query
   // sub-pixel accumulation.
   LayoutPoint absolute_location(LocalToAbsolute(FloatPoint()));
   LayoutRect absolute_replaced_rect = ReplacedContentRect();
   absolute_replaced_rect.MoveBy(absolute_location);
 
   IntRect frame_rect(IntPoint(),
                      PixelSnappedIntRect(absolute_replaced_rect).size());
   // Normally the location of the frame rect is ignored by the painter, but
   // currently it is still used by a family of coordinate conversion function in
-  // FrameViewBase/FrameView. This is incorrect because coordinate conversion
+  // FrameView. This is incorrect because coordinate conversion
   // needs to take transform and into account. A few callers still use the
   // family of conversion function, including but not exhaustive:
   // FrameView::updateViewportIntersectionIfNeeded()
   // RemoteFrameView::frameRectsChanged().
   // WebPluginContainerImpl::reportGeometry()
   // TODO(trchen): Remove this hack once we fixed all callers.
   FloatRect absolute_bounding_box =
       LocalToAbsoluteQuad(FloatRect(ReplacedContentRect())).BoundingBox();
   frame_rect.SetLocation(RoundedIntPoint(absolute_bounding_box.Location()));
 
   // Why is the protector needed?
   RefPtr<LayoutPart> protector(this);
-  frame_view_base.SetFrameRect(frame_rect);
+  frame_or_plugin.SetFrameRect(frame_rect);
 }
 
 void LayoutPart::InvalidatePaintOfSubtreesIfNeeded(
     const PaintInvalidationState& paint_invalidation_state) {
   if (GetFrameViewBase() && GetFrameViewBase()->IsFrameView() &&
       !IsThrottledFrameView()) {
     FrameView* child_frame_view = ToFrameView(GetFrameViewBase());
     // |childFrameView| is in another document, which could be
     // missing its LayoutView. TODO(jchaffraix): Ideally we should
     // not need this code.
@@ skipping 11 matching lines @@
 }
 
 bool LayoutPart::IsThrottledFrameView() const {
   if (!GetFrameViewBase() || !GetFrameViewBase()->IsFrameView())
     return false;
   const FrameView* frame_view = ToFrameView(GetFrameViewBase());
   return frame_view->ShouldThrottleRendering();
 }
 
 }  // namespace blink