Rename Node::inShadowIncludingDocument() to Node::isConnected()

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

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  * Copyright (C) 2004-2011, 2014 Apple Inc. All rights reserved.
  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
  *
  * 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
@@ skipping 458 matching lines @@
     }
 
     TreeScope& containingTreeScope() const
     {
         DCHECK(isInTreeScope());
         return *m_treeScope;
     }
 
     bool inActiveDocument() const;
 
-    // Returns true if this node is associated with a shadow-including document and is in its associated document's
-    // node tree, false otherwise.
-    bool inShadowIncludingDocument() const
+    // Returns true if this node is connected to a document, false otherwise.
+    // If you are looking for inDocument() or inShadowIncludingDocument(), they were removed. Use isConnected() instead.

[tkent, 2016/07/14 08:21:09]

I don't think this line is necessary.

Also, I want a brief explanation of what is 'connected' here. Even Blink
developers aren't familiar with it yet.

[hayato, 2016/07/14 08:47:12]

Done.

Since the definition of "connected" is "An element is connected if its
shadow-including root is a document.", I have added a link to the definition in
DOM Standard.

+    bool isConnected() const
     {
-        return getFlag(InDocumentFlag);
+        return getFlag(IsConnectedFlag);
     }
     bool isInShadowTree() const { return getFlag(IsInShadowTreeFlag); }
-    bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(InDocumentFlag | IsInShadowTreeFlag)); }
+    bool isInTreeScope() const { return getFlag(static_cast<NodeFlags>(IsConnectedFlag | IsInShadowTreeFlag)); }
 
     ElementShadow* parentElementShadow() const;
     bool isInV1ShadowTree() const;
     bool isInV0ShadowTree() const;
     bool isChildOfV1ShadowHost() const;
     bool isChildOfV0ShadowHost() const;
     ShadowRoot* v1ShadowRootOfParent() const;
 
     bool isDocumentTypeNode() const { return getNodeType() == DOCUMENT_TYPE_NODE; }
     virtual bool childTypeAllowed(NodeType) const { return false; }
@@ skipping 67 matching lines @@
 
     // -----------------------------------------------------------------------------
     // Notification of document structure changes (see ContainerNode.h for more notification methods)
     //
     // At first, WebKit notifies the node that it has been inserted into the document. This is called during document parsing, and also
     // when a node is added through the DOM methods insertBefore(), appendChild() or replaceChild(). The call happens _after_ the node has been added to the tree.
     // This is similar to the DOMNodeInsertedIntoDocument DOM event, but does not require the overhead of event
     // dispatching.
     //
     // WebKit notifies this callback regardless if the subtree of the node is a document tree or a floating subtree.
-    // Implementation can determine the type of subtree by seeing insertionPoint->inShadowIncludingDocument().
+    // Implementation can determine the type of subtree by seeing insertionPoint->isConnected().
     // For a performance reason, notifications are delivered only to ContainerNode subclasses if the insertionPoint is out of document.
     //
     // There are another callback named didNotifySubtreeInsertionsToDocument(), which is called after all the descendant is notified,
     // if this node was inserted into the document tree. Only a few subclasses actually need this. To utilize this, the node should
     // return InsertionShouldCallDidNotifySubtreeInsertions from insertedInto().
     //
     enum InsertionNotificationRequest {
         InsertionDone,
         InsertionShouldCallDidNotifySubtreeInsertions
     };
@@ skipping 118 matching lines @@
 
         // Changes based on if the element should be treated like a link,
         // ex. When setting the href attribute on an <a>.
         IsLinkFlag = 1 << 8,
 
         // Changes based on :hover, :active and :focus state.
         IsUserActionElementFlag = 1 << 9,
 
         // Tree state flags. These change when the element is added/removed
         // from a DOM tree.
-        InDocumentFlag = 1 << 10,
+        IsConnectedFlag = 1 << 10,
         IsInShadowTreeFlag = 1 << 11,
 
         // Set by the parser when the children are done parsing.
         IsFinishedParsingChildrenFlag = 1 << 12,
 
         // Flags related to recalcStyle.
         SVGFilterNeedsLayerUpdateFlag = 1 << 13,
         HasCustomStyleCallbacksFlag = 1 << 14,
         ChildNeedsStyleInvalidationFlag = 1 << 15,
         NeedsStyleInvalidationFlag = 1 << 16,
@@ skipping 26 matching lines @@
 protected:
     enum ConstructionType {
         CreateOther = DefaultNodeFlags,
         CreateText = DefaultNodeFlags | IsTextFlag,
         CreateContainer = DefaultNodeFlags | ChildNeedsStyleRecalcFlag | IsContainerFlag,
         CreateElement = CreateContainer | IsElementFlag,
         CreateShadowRoot = CreateContainer | IsDocumentFragmentFlag | IsInShadowTreeFlag,
         CreateDocumentFragment = CreateContainer | IsDocumentFragmentFlag,
         CreateHTMLElement = CreateElement | IsHTMLFlag,
         CreateSVGElement = CreateElement | IsSVGFlag,
-        CreateDocument = CreateContainer | InDocumentFlag,
+        CreateDocument = CreateContainer | IsConnectedFlag,
         CreateInsertionPoint = CreateHTMLElement | IsInsertionPointFlag,
         CreateEditingText = CreateText | HasNameOrIsEditingTextFlag,
     };
 
     Node(TreeScope*, ConstructionType);
 
     virtual void didMoveToNewDocument(Document& oldDocument);
 
     void addedEventListener(const AtomicString& eventType, RegisteredEventListener&) override;
     void removedEventListener(const AtomicString& eventType, const RegisteredEventListener&) override;
@@ skipping 151 matching lines @@
 } // namespace blink
 
 #ifndef NDEBUG
 // Outside the WebCore namespace for ease of invocation from gdb.
 void showNode(const blink::Node*);
 void showTree(const blink::Node*);
 void showNodePath(const blink::Node*);
 #endif
 
 #endif // Node_h