Implement a Hit Test Cache.

Source/core/layout/HitTestResult.h

 /*
  * Copyright (C) 2006 Apple Computer, Inc.
  * Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies)
  *
  * 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,
@@ skipping 16 matching lines @@
 #include "core/layout/HitTestRequest.h"
 #include "platform/geometry/FloatQuad.h"
 #include "platform/geometry/FloatRect.h"
 #include "platform/geometry/LayoutRect.h"
 #include "platform/heap/Handle.h"
 #include "platform/text/TextDirection.h"
 #include "wtf/Forward.h"
 #include "wtf/ListHashSet.h"
 #include "wtf/OwnPtr.h"
 #include "wtf/RefPtr.h"
+#include "wtf/VectorTraits.h"
 
 namespace blink {
 
 class Element;
 class LocalFrame;
 class HTMLAreaElement;
 class HTMLMediaElement;
 class Image;
 class KURL;
 class Node;
 class LayoutObject;
 class PositionWithAffinity;
 class Scrollbar;
 
 class CORE_EXPORT HitTestResult {
-    DISALLOW_ALLOCATION();
+    ALLOW_ONLY_INLINE_ALLOCATION();
+
 public:
     typedef WillBeHeapListHashSet<RefPtrWillBeMember<Node>> NodeSet;
 
     HitTestResult();
     HitTestResult(const HitTestRequest&, const LayoutPoint&);
     // Pass positive padding values to perform a rect-based hit test.
     HitTestResult(const HitTestRequest&, const LayoutPoint& centerPoint, unsigned topPadding, unsigned rightPadding, unsigned bottomPadding, unsigned leftPadding);
     HitTestResult(const HitTestRequest&, const HitTestLocation&);
     HitTestResult(const HitTestResult&);
     ~HitTestResult();
     HitTestResult& operator=(const HitTestResult&);
     DECLARE_TRACE();
 
+    bool equalForCacheability(const HitTestResult&) const;
+    void cacheValues(const HitTestResult&);
+
+    // Populate this object based on another HitTestResult; similar to assignment operator
+    // but don't assign any of the request parameters. ie. Thie method avoids setting
+    // |m_hitTestLocation|, |m_hitTestRequest|.
+    void populateFromCachedResult(const HitTestResult&);
+
     // For point-based hit tests, these accessors provide information about the node
     // under the point. For rect-based hit tests they are meaningless (reflect the
     // last candidate node observed in the rect).
     // FIXME: Make these less error-prone for rect-based hit tests (center point or fail).
     Node* innerNode() const { return m_innerNode.get(); }
     Node* innerPossiblyPseudoNode() const { return m_innerPossiblyPseudoNode.get(); }
     Element* innerElement() const;
 
     // If innerNode is an image map or image map area, return the associated image node.
     Node* innerNodeOrImageMapImage() const;
@@ skipping 41 matching lines @@
     KURL absoluteImageURL() const;
     KURL absoluteMediaURL() const;
     KURL absoluteLinkURL() const;
     String textContent() const;
     bool isLiveLink() const;
     bool isMisspelled() const;
     bool isContentEditable() const;
 
     bool isOverLink() const;
 
+    bool isCacheable() const { return m_cacheable; }
+    void setCacheable(bool cacheable) { m_cacheable = cacheable; }
+
     // Return true if the test is a list-based test and we should continue testing.
     bool addNodeToListBasedTestResult(Node*, const HitTestLocation& pointInContainer, const LayoutRect& = LayoutRect());
     bool addNodeToListBasedTestResult(Node*, const HitTestLocation& pointInContainer, const FloatRect&);
     void append(const HitTestResult&);
 
     // If m_listBasedTestResult is 0 then set it to a new NodeSet. Return *m_listBasedTestResult. Lazy allocation makes
     // sense because the NodeSet is seldom necessary, and it's somewhat expensive to allocate and initialize. This method does
     // the same thing as mutableListBasedTestResult(), but here the return value is const.
     const NodeSet& listBasedTestResult() const;
 
     // Collapse the rect-based test result into a single target at the specified location.
     void resolveRectBasedTest(Node* resolvedInnerNode, const LayoutPoint& resolvedPointInMainFrame);
 
 private:
     NodeSet& mutableListBasedTestResult(); // See above.
     HTMLMediaElement* mediaElement() const;
 
     HitTestLocation m_hitTestLocation;
     HitTestRequest m_hitTestRequest;
+    bool m_cacheable;
 
     RefPtrWillBeMember<Node> m_innerNode;
     RefPtrWillBeMember<Node> m_innerPossiblyPseudoNode;
     // FIXME: Nothing changes this to a value different from m_hitTestLocation!
     LayoutPoint m_pointInInnerNodeFrame; // The hit-tested point in innerNode frame coordinates.
     LayoutPoint m_localPoint; // A point in the local coordinate space of m_innerNode's layoutObject. Allows us to efficiently
         // determine where inside the layoutObject we hit on subsequent operations.
     RefPtrWillBeMember<Element> m_innerURLElement;
     RefPtrWillBeMember<Scrollbar> m_scrollbar;
     bool m_isOverWidget; // Returns true if we are over a widget (and not in the border/padding area of a LayoutPart for example).
 
     mutable OwnPtrWillBeMember<NodeSet> m_listBasedTestResult;
 };
 
 } // namespace blink
 
+#if ENABLE(OILPAN)
+// TODO(sof): the trait override/specialization is needed by HitTestCache's
+// HeapVector<> to handle unused slots. It is not correct for HitTestResult
+// in the wider sense of what canInitializeWithMemset provides, so fix this
+// by introducing a trait that encompasses "unused slot" handling and use it
+// here instead.
+//
+// Until that time, make this trait specialization conditional on OILPAN to
+// limit exposure.
+WTF_ALLOW_INIT_WITH_MEM_FUNCTIONS(blink::HitTestResult);
+#endif
+
 #endif // HitTestResult_h