Move persistent gesture state to Document, add DocumentUserGestureToken

third_party/WebKit/Source/core/dom/Document.h

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All
  * rights reserved.
  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
  * (http://www.torchmobile.com/)
  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
@@ skipping 1266 matching lines @@
   RootScrollerController* rootScrollerController() const {
     return m_rootScrollerController.get();
   }
 
   bool isInMainFrame() const;
 
   void onVisibilityMaybeChanged(bool visible);
 
   PropertyRegistry* propertyRegistry();
 
+  void setHasReceivedUserGesture() { m_hasReceivedUserGesture = true; }

[Rick Byers, 2016/10/17 17:02:46]

Nit: add a short comment describing why this is meaningful (eg. indicates the
user has done something to interact with this document in particular).

[Nate Chapin, 2016/10/18 23:26:33]

Done.

+  void clearHasReceivedUserGesture() { m_hasReceivedUserGesture = false; }

[Rick Byers, 2016/10/17 17:02:46]

I'm surprised you ever need to clear (I'm sure I'll see where it's being used
soon).  Maybe worth a comment explaining when it makes sense to invoke this?

[Nate Chapin, 2016/10/18 23:26:33]

Done.

+  bool hasReceivedUserGesture() const { return m_hasReceivedUserGesture; }
+
  protected:
   Document(const DocumentInit&, DocumentClassFlags = DefaultDocumentClass);
 
   void didUpdateSecurityOrigin() final;
 
   void clearXMLVersion() { m_xmlVersion = String(); }
 
   virtual Document* cloneDocumentWithoutChildren();
 
   bool importContainerNodeChildren(ContainerNode* oldContainerNode,
@@ skipping 225 matching lines @@
   String m_xmlVersion;
   unsigned m_xmlStandalone : 2;
   unsigned m_hasXMLDeclaration : 1;
 
   AtomicString m_contentLanguage;
 
   DocumentEncodingData m_encodingData;
 
   bool m_designMode;
   bool m_isRunningExecCommand;
+  bool m_hasReceivedUserGesture;
 
   HeapHashSet<WeakMember<const LiveNodeListBase>> m_listsInvalidatedAtDocument;
   // Oilpan keeps track of all registered NodeLists.
   // TODO(Oilpan): improve - only need to know if a NodeList
   // is currently alive or not for the different types.
   HeapHashSet<WeakMember<const LiveNodeListBase>>
       m_nodeLists[numNodeListInvalidationTypes];
 
   Member<SVGDocumentExtensions> m_svgExtensions;
 
@@ skipping 144 matching lines @@
 DEFINE_TYPE_CASTS(TreeScope, Document, document, true, true);
 
 }  // namespace blink
 
 #ifndef NDEBUG
 // Outside the WebCore namespace for ease of invocation from gdb.
 CORE_EXPORT void showLiveDocumentInstances();
 #endif
 
 #endif  // Document_h