Add FINAL decorators to the InlineBox class hierarchy.

<http://webkit.org/b/115177>

Reviewed by Antti Koivisto.

From Blink r148628 by <cevans@chromium.org>:

FINAL is a macro in wtf/Compiler.h that does the correct thing if the compiler does not support "final")
The approach used is as simple as possible whilst being thorough.
So, leaf classes have FINAL applied to the whole class whereas intermediary classes have FINAL applied to relevant methods.

FINAL allows a compiler to devirtualize call sites and turn them into direct calls. As you might expect, this is perf positive:
(clang on Linux):
- line_layout.html goes from 120 runs/s -> 123 runs/2, +2.5%
- html5-full-render.html goes from 3176ms -> 3162ms, +0.4%

I have confidence that the former result is statistically significant (as the numbers are very very stable) but not the latter.

* rendering/EllipsisBox.h:
* rendering/InlineFlowBox.h:
* rendering/InlineTextBox.h:
* rendering/RootInlineBox.h:
* rendering/TrailingFloatsRootInlineBox.h:
* rendering/svg/SVGInlineFlowBox.h:
* rendering/svg/SVGInlineTextBox.h:
* rendering/svg/SVGRootInlineBox.h:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@149110 268f45cc-cd09-0410-ab3c-d52691b4dbfc

diff --git a/Source/WebCore/ChangeLog b/Source/WebCore/ChangeLog
index bfcb7a8..b967b65 100644 (file)
--- a/Source/WebCore/ChangeLog
+++ b/Source/WebCore/ChangeLog
@@ -1,5 +1,34 @@
 2013-04-25  Andreas Kling  <akling@apple.com>
 
 2013-04-25  Andreas Kling  <akling@apple.com>
 

+        Add FINAL decorators to the InlineBox class hierarchy.
+        <http://webkit.org/b/115177>
+
+        Reviewed by Antti Koivisto.
+
+        From Blink r148628 by <cevans@chromium.org>:
+
+        FINAL is a macro in wtf/Compiler.h that does the correct thing if the compiler does not support "final")
+        The approach used is as simple as possible whilst being thorough.
+        So, leaf classes have FINAL applied to the whole class whereas intermediary classes have FINAL applied to relevant methods.
+
+        FINAL allows a compiler to devirtualize call sites and turn them into direct calls. As you might expect, this is perf positive:
+        (clang on Linux):
+        - line_layout.html goes from 120 runs/s -> 123 runs/2, +2.5%
+        - html5-full-render.html goes from 3176ms -> 3162ms, +0.4%
+
+        I have confidence that the former result is statistically significant (as the numbers are very very stable) but not the latter.
+
+        * rendering/EllipsisBox.h:
+        * rendering/InlineFlowBox.h:
+        * rendering/InlineTextBox.h:
+        * rendering/RootInlineBox.h:
+        * rendering/TrailingFloatsRootInlineBox.h:
+        * rendering/svg/SVGInlineFlowBox.h:
+        * rendering/svg/SVGInlineTextBox.h:
+        * rendering/svg/SVGRootInlineBox.h:
+
+2013-04-25  Andreas Kling  <akling@apple.com>
+

         CSS parser: Add error recovery while parsing @-webkit-keyframes key values.
         <http://webkit.org/b/115175>
 
         CSS parser: Add error recovery while parsing @-webkit-keyframes key values.
         <http://webkit.org/b/115175>
 

diff --git a/Source/WebCore/rendering/EllipsisBox.h b/Source/WebCore/rendering/EllipsisBox.h
index f1fb0d1..7c60b18 100644 (file)
--- a/Source/WebCore/rendering/EllipsisBox.h
+++ b/Source/WebCore/rendering/EllipsisBox.h
@@ -27,7 +27,7 @@ namespace WebCore {
 class HitTestRequest;
 class HitTestResult;
 
 class HitTestRequest;
 class HitTestResult;
 

-class EllipsisBox : public InlineBox {
+class EllipsisBox FINAL : public InlineBox {

 public:
     EllipsisBox(RenderObject* obj, const AtomicString& ellipsisStr, InlineFlowBox* parent,
                 int width, int height, int y, bool firstLine, bool isVertical, InlineBox* markupBox)
 public:
     EllipsisBox(RenderObject* obj, const AtomicString& ellipsisStr, InlineFlowBox* parent,
                 int width, int height, int y, bool firstLine, bool isVertical, InlineBox* markupBox)

diff --git a/Source/WebCore/rendering/InlineFlowBox.h b/Source/WebCore/rendering/InlineFlowBox.h
index 828562d..b645227 100644 (file)
--- a/Source/WebCore/rendering/InlineFlowBox.h
+++ b/Source/WebCore/rendering/InlineFlowBox.h
@@ -80,7 +80,7 @@ public:
     InlineBox* firstChild() const { checkConsistency(); return m_firstChild; }
     InlineBox* lastChild() const { checkConsistency(); return m_lastChild; }
 
     InlineBox* firstChild() const { checkConsistency(); return m_firstChild; }
     InlineBox* lastChild() const { checkConsistency(); return m_lastChild; }
 

-    virtual bool isLeaf() const { return false; }
+    virtual bool isLeaf() const FINAL { return false; }

     
     InlineBox* firstLeafChild() const;
     InlineBox* lastLeafChild() const;
     
     InlineBox* firstLeafChild() const;
     InlineBox* lastLeafChild() const;


@@ -88,7 +88,7 @@ public:
     typedef void (*CustomInlineBoxRangeReverse)(void* userData, Vector<InlineBox*>::iterator first, Vector<InlineBox*>::iterator last);
     void collectLeafBoxesInLogicalOrder(Vector<InlineBox*>&, CustomInlineBoxRangeReverse customReverseImplementation = 0, void* userData = 0) const;
 
     typedef void (*CustomInlineBoxRangeReverse)(void* userData, Vector<InlineBox*>::iterator first, Vector<InlineBox*>::iterator last);
     void collectLeafBoxesInLogicalOrder(Vector<InlineBox*>&, CustomInlineBoxRangeReverse customReverseImplementation = 0, void* userData = 0) const;
 

-    virtual void setConstructed()
+    virtual void setConstructed() FINAL

     {
         InlineBox::setConstructed();
         for (InlineBox* child = firstChild(); child; child = child->nextOnLine())
     {
         InlineBox::setConstructed();
         for (InlineBox* child = firstChild(); child; child = child->nextOnLine())


@@ -96,9 +96,9 @@ public:
     }
 
     void addToLine(InlineBox* child);
     }
 
     void addToLine(InlineBox* child);

-    virtual void deleteLine(RenderArena*);
-    virtual void extractLine();
-    virtual void attachLine();
+    virtual void deleteLine(RenderArena*) FINAL;
+    virtual void extractLine() FINAL;
+    virtual void attachLine() FINAL;

     virtual void adjustPosition(float dx, float dy);
 
     virtual void extractLineBoxFromRenderObject();
     virtual void adjustPosition(float dx, float dy);
 
     virtual void extractLineBoxFromRenderObject();


@@ -109,8 +109,8 @@ public:
 
     IntRect roundedFrameRect() const;
     
 
     IntRect roundedFrameRect() const;
     

-    virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
-    virtual void paintMask(PaintInfo&, const LayoutPoint&);
+    virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) FINAL;
+    virtual void paintMask(PaintInfo&, const LayoutPoint&) FINAL;

     void paintFillLayers(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
     void paintFillLayer(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
     void paintBoxShadow(const PaintInfo&, RenderStyle*, ShadowStyle, const LayoutRect&);
     void paintFillLayers(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
     void paintFillLayer(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
     void paintBoxShadow(const PaintInfo&, RenderStyle*, ShadowStyle, const LayoutRect&);


@@ -201,7 +201,7 @@ public:
 
     virtual RenderObject::SelectionState selectionState();
 
 
     virtual RenderObject::SelectionState selectionState();
 

-    virtual bool canAccommodateEllipsis(bool ltr, int blockEdge, int ellipsisWidth) const OVERRIDE;
+    virtual bool canAccommodateEllipsis(bool ltr, int blockEdge, int ellipsisWidth) const OVERRIDE FINAL;

     virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool&) OVERRIDE;
 
     bool hasTextChildren() const { return m_hasTextChildren; }
     virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool&) OVERRIDE;
 
     bool hasTextChildren() const { return m_hasTextChildren; }


@@ -309,7 +309,7 @@ private:
 protected:
     OwnPtr<RenderOverflow> m_overflow;
 
 protected:
     OwnPtr<RenderOverflow> m_overflow;
 

-    virtual bool isInlineFlowBox() const { return true; }
+    virtual bool isInlineFlowBox() const FINAL { return true; }

 
     InlineBox* m_firstChild;
     InlineBox* m_lastChild;
 
     InlineBox* m_firstChild;
     InlineBox* m_lastChild;

diff --git a/Source/WebCore/rendering/InlineTextBox.h b/Source/WebCore/rendering/InlineTextBox.h
index 74b1f7e..3f1d639 100644 (file)
--- a/Source/WebCore/rendering/InlineTextBox.h
+++ b/Source/WebCore/rendering/InlineTextBox.h
@@ -57,7 +57,7 @@ public:
     {
     }
 
     {
     }
 

-    virtual void destroy(RenderArena*);
+    virtual void destroy(RenderArena*) FINAL;

 
     InlineTextBox* prevTextBox() const { return m_prevTextBox; }
     InlineTextBox* nextTextBox() const { return m_nextTextBox; }
 
     InlineTextBox* prevTextBox() const { return m_prevTextBox; }
     InlineTextBox* nextTextBox() const { return m_nextTextBox; }


@@ -76,7 +76,7 @@ public:
 
     unsigned short truncation() { return m_truncation; }
 
 
     unsigned short truncation() { return m_truncation; }
 

-    virtual void markDirty(bool dirty = true) OVERRIDE;
+    virtual void markDirty(bool dirty = true) OVERRIDE FINAL;

 
     using InlineBox::hasHyphen;
     using InlineBox::setHasHyphen;
 
     using InlineBox::hasHyphen;
     using InlineBox::setHasHyphen;


@@ -85,8 +85,8 @@ public:
 
     static inline bool compareByStart(const InlineTextBox* first, const InlineTextBox* second) { return first->start() < second->start(); }
 
 
     static inline bool compareByStart(const InlineTextBox* first, const InlineTextBox* second) { return first->start() < second->start(); }
 

-    virtual int baselinePosition(FontBaseline) const;
-    virtual LayoutUnit lineHeight() const;
+    virtual int baselinePosition(FontBaseline) const FINAL;
+    virtual LayoutUnit lineHeight() const FINAL;

 
     bool getEmphasisMarkPosition(RenderStyle*, TextEmphasisPosition&) const;
 
 
     bool getEmphasisMarkPosition(RenderStyle*, TextEmphasisPosition&) const;
 


@@ -125,19 +125,19 @@ public:
     RenderText* textRenderer() const;
 
 private:
     RenderText* textRenderer() const;
 
 private:

-    virtual void deleteLine(RenderArena*);
-    virtual void extractLine();
-    virtual void attachLine();
+    virtual void deleteLine(RenderArena*) FINAL;
+    virtual void extractLine() FINAL;
+    virtual void attachLine() FINAL;

 
 public:
 
 public:

-    virtual RenderObject::SelectionState selectionState();
+    virtual RenderObject::SelectionState selectionState() FINAL;

 
 private:
 
 private:

-    virtual void clearTruncation() { m_truncation = cNoTruncation; }
-    virtual float placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) OVERRIDE;
+    virtual void clearTruncation() FINAL { m_truncation = cNoTruncation; }
+    virtual float placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) OVERRIDE FINAL;

 
 public:
 
 public:

-    virtual bool isLineBreak() const;
+    virtual bool isLineBreak() const FINAL;

 
     void setExpansion(int newExpansion)
     {
 
     void setExpansion(int newExpansion)
     {


@@ -147,11 +147,11 @@ public:
     }
 
 private:
     }
 
 private:

-    virtual bool isInlineTextBox() const { return true; }    
+    virtual bool isInlineTextBox() const FINAL { return true; }

 
 public:
 
 public:

-    virtual int caretMinOffset() const;
-    virtual int caretMaxOffset() const;
+    virtual int caretMinOffset() const FINAL;
+    virtual int caretMaxOffset() const FINAL;

 
 private:
     float textPos() const; // returns the x position relative to the left start of the text line.
 
 private:
     float textPos() const; // returns the x position relative to the left start of the text line.

diff --git a/Source/WebCore/rendering/RootInlineBox.h b/Source/WebCore/rendering/RootInlineBox.h
index f867745..08bc513 100644 (file)
--- a/Source/WebCore/rendering/RootInlineBox.h
+++ b/Source/WebCore/rendering/RootInlineBox.h
@@ -38,16 +38,16 @@ class RootInlineBox : public InlineFlowBox {
 public:
     explicit RootInlineBox(RenderBlock*);
 
 public:
     explicit RootInlineBox(RenderBlock*);
 

-    virtual void destroy(RenderArena*);
+    virtual void destroy(RenderArena*) FINAL;

 
 

-    virtual bool isRootInlineBox() const { return true; }
+    virtual bool isRootInlineBox() const FINAL { return true; }

 
     void detachEllipsisBox(RenderArena*);
 
     RootInlineBox* nextRootBox() const { return static_cast<RootInlineBox*>(m_nextLineBox); }
     RootInlineBox* prevRootBox() const { return static_cast<RootInlineBox*>(m_prevLineBox); }
 
 
     void detachEllipsisBox(RenderArena*);
 
     RootInlineBox* nextRootBox() const { return static_cast<RootInlineBox*>(m_nextLineBox); }
     RootInlineBox* prevRootBox() const { return static_cast<RootInlineBox*>(m_prevLineBox); }
 

-    virtual void adjustPosition(float dx, float dy);
+    virtual void adjustPosition(float dx, float dy) FINAL;

 
     LayoutUnit lineTop() const { return m_lineTop; }
     LayoutUnit lineBottom() const { return m_lineBottom; }
 
     LayoutUnit lineTop() const { return m_lineTop; }
     LayoutUnit lineBottom() const { return m_lineBottom; }


@@ -85,7 +85,7 @@ public:
         m_lineBottomWithLeading = bottomWithLeading;
     }
 
         m_lineBottomWithLeading = bottomWithLeading;
     }
 

-    virtual RenderLineBoxList* rendererLineBoxes() const;
+    virtual RenderLineBoxList* rendererLineBoxes() const FINAL;

 
     RenderObject* lineBreakObj() const { return m_lineBreakObj; }
     BidiStatus lineBreakBidiStatus() const;
 
     RenderObject* lineBreakObj() const { return m_lineBreakObj; }
     BidiStatus lineBreakBidiStatus() const;


@@ -103,19 +103,19 @@ public:
     // Return the truncatedWidth, the width of the truncated text + ellipsis.
     float placeEllipsis(const AtomicString& ellipsisStr, bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, InlineBox* markupBox = 0);
     // Return the position of the EllipsisBox or -1.
     // Return the truncatedWidth, the width of the truncated text + ellipsis.
     float placeEllipsis(const AtomicString& ellipsisStr, bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, InlineBox* markupBox = 0);
     // Return the position of the EllipsisBox or -1.

-    virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) OVERRIDE;
+    virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) OVERRIDE FINAL;

 
     using InlineBox::hasEllipsisBox;
     EllipsisBox* ellipsisBox() const;
 
     void paintEllipsisBox(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) const;
 
 
     using InlineBox::hasEllipsisBox;
     EllipsisBox* ellipsisBox() const;
 
     void paintEllipsisBox(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) const;
 

-    virtual void clearTruncation() OVERRIDE;
+    virtual void clearTruncation() OVERRIDE FINAL;

 
     bool isHyphenated() const;
 
 
     bool isHyphenated() const;
 

-    virtual int baselinePosition(FontBaseline baselineType) const;
-    virtual LayoutUnit lineHeight() const;
+    virtual int baselinePosition(FontBaseline baselineType) const FINAL;
+    virtual LayoutUnit lineHeight() const FINAL;

 
 #if PLATFORM(MAC)
     void addHighlightOverflow();
 
 #if PLATFORM(MAC)
     void addHighlightOverflow();


@@ -123,12 +123,12 @@ public:
 #endif
 
     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom);
 #endif
 
     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom);

-    virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
+    virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE FINAL;

 
     using InlineBox::hasSelectedChildren;
     using InlineBox::setHasSelectedChildren;
 
 
     using InlineBox::hasSelectedChildren;
     using InlineBox::setHasSelectedChildren;
 

-    virtual RenderObject::SelectionState selectionState();
+    virtual RenderObject::SelectionState selectionState() FINAL;

     InlineBox* firstSelectedBox();
     InlineBox* lastSelectedBox();
 
     InlineBox* firstSelectedBox();
     InlineBox* lastSelectedBox();
 


@@ -151,9 +151,9 @@ public:
 
     Vector<RenderBox*>* floatsPtr() { ASSERT(!isDirty()); return m_floats.get(); }
 
 
     Vector<RenderBox*>* floatsPtr() { ASSERT(!isDirty()); return m_floats.get(); }
 

-    virtual void extractLineBoxFromRenderObject();
-    virtual void attachLineBoxToRenderObject();
-    virtual void removeLineBoxFromRenderObject();
+    virtual void extractLineBoxFromRenderObject() FINAL;
+    virtual void attachLineBoxToRenderObject() FINAL;
+    virtual void removeLineBoxFromRenderObject() FINAL;

     
     FontBaseline baselineType() const { return static_cast<FontBaseline>(m_baselineType); }
 
     
     FontBaseline baselineType() const { return static_cast<FontBaseline>(m_baselineType); }
 

diff --git a/Source/WebCore/rendering/TrailingFloatsRootInlineBox.h b/Source/WebCore/rendering/TrailingFloatsRootInlineBox.h
index 960ca8a..1f9150d 100644 (file)
--- a/Source/WebCore/rendering/TrailingFloatsRootInlineBox.h
+++ b/Source/WebCore/rendering/TrailingFloatsRootInlineBox.h
@@ -30,7 +30,7 @@
 
 namespace WebCore {
 
 
 namespace WebCore {
 

-class TrailingFloatsRootInlineBox : public RootInlineBox {
+class TrailingFloatsRootInlineBox FINAL : public RootInlineBox {

 public:
     TrailingFloatsRootInlineBox(RenderBlock* block)
         : RootInlineBox(block)
 public:
     TrailingFloatsRootInlineBox(RenderBlock* block)
         : RootInlineBox(block)

diff --git a/Source/WebCore/rendering/svg/SVGInlineFlowBox.h b/Source/WebCore/rendering/svg/SVGInlineFlowBox.h
index bc44c7e..3241b92 100644 (file)
--- a/Source/WebCore/rendering/svg/SVGInlineFlowBox.h
+++ b/Source/WebCore/rendering/svg/SVGInlineFlowBox.h
@@ -28,7 +28,7 @@ namespace WebCore {
 
 class RenderSVGInlineText;
 
 
 class RenderSVGInlineText;
 

-class SVGInlineFlowBox : public InlineFlowBox {
+class SVGInlineFlowBox FINAL : public InlineFlowBox {

 public:
     SVGInlineFlowBox(RenderObject* obj)
         : InlineFlowBox(obj)
 public:
     SVGInlineFlowBox(RenderObject* obj)
         : InlineFlowBox(obj)

diff --git a/Source/WebCore/rendering/svg/SVGInlineTextBox.h b/Source/WebCore/rendering/svg/SVGInlineTextBox.h
index ef399c7..2db18d1 100644 (file)
--- a/Source/WebCore/rendering/svg/SVGInlineTextBox.h
+++ b/Source/WebCore/rendering/svg/SVGInlineTextBox.h
@@ -31,7 +31,7 @@ namespace WebCore {
 class RenderSVGResource;
 class SVGRootInlineBox;
 
 class RenderSVGResource;
 class SVGRootInlineBox;
 

-class SVGInlineTextBox : public InlineTextBox {
+class SVGInlineTextBox FINAL : public InlineTextBox {

 public:
     SVGInlineTextBox(RenderObject*);
 
 public:
     SVGInlineTextBox(RenderObject*);
 


@@ -57,7 +57,7 @@ public:
     Vector<SVGTextFragment>& textFragments() { return m_textFragments; }
     const Vector<SVGTextFragment>& textFragments() const { return m_textFragments; }
 
     Vector<SVGTextFragment>& textFragments() { return m_textFragments; }
     const Vector<SVGTextFragment>& textFragments() const { return m_textFragments; }
 

-    void dirtyLineBoxes() OVERRIDE;
+    virtual void dirtyLineBoxes() OVERRIDE;

 
     bool startsNewTextChunk() const { return m_startsNewTextChunk; }
     void setStartsNewTextChunk(bool newTextChunk) { m_startsNewTextChunk = newTextChunk; }
 
     bool startsNewTextChunk() const { return m_startsNewTextChunk; }
     void setStartsNewTextChunk(bool newTextChunk) { m_startsNewTextChunk = newTextChunk; }

diff --git a/Source/WebCore/rendering/svg/SVGRootInlineBox.h b/Source/WebCore/rendering/svg/SVGRootInlineBox.h
index 7aec8d8..5bab4f7 100644 (file)
--- a/Source/WebCore/rendering/svg/SVGRootInlineBox.h
+++ b/Source/WebCore/rendering/svg/SVGRootInlineBox.h
@@ -32,7 +32,7 @@ namespace WebCore {
 
 class SVGInlineTextBox;
 
 
 class SVGInlineTextBox;
 

-class SVGRootInlineBox : public RootInlineBox {
+class SVGRootInlineBox FINAL : public RootInlineBox {

 public:
     SVGRootInlineBox(RenderBlock* block)
         : RootInlineBox(block)
 public:
     SVGRootInlineBox(RenderBlock* block)
         : RootInlineBox(block)