Changeset 125832 in webkit

Timestamp:

Aug 16, 2012 5:29:35 PM (12 years ago)

Author:

abarth@webkit.org

Message:

Rename DOMWindow::clear to something more descriptive
​https://bugs.webkit.org/show_bug.cgi?id=93993

Reviewed by Eric Seidel.

As requested by Eric Seidel. In WebKit, we typically use "clear" to
mean zeroing out a pointer (e.g., OwnPtr::clear). For DOMWindow, it's
more like we're resetting the DOMWindow to a known state (i.e., its
initial state), modulo a wrinkle w.r.t. the PageCache. The new name
attempts to clarify the situation.

• dom/Document.cpp:

(WebCore::Document::~Document):

• loader/FrameLoader.cpp:

(WebCore::FrameLoader::clear):

• page/DOMWindow.cpp:

(WebCore::DOMWindow::~DOMWindow):
(WebCore::DOMWindow::frameDestroyed):
(WebCore::DOMWindow::resetUnlessSuspendedForPageCache):
(WebCore::DOMWindow::resetDOMWindowProperties):

• page/DOMWindow.h:

(DOMWindow):

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• dom/Document.cpp (modified) (1 diff)
• loader/FrameLoader.cpp (modified) (1 diff)
• page/DOMWindow.cpp (modified) (4 diffs)
• page/DOMWindow.h (modified) (2 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-08-16  Adam Barth  <abarth@webkit.org>
+
+        Rename DOMWindow::clear to something more descriptive
+        https://bugs.webkit.org/show_bug.cgi?id=93993
+
+        Reviewed by Eric Seidel.
+
+        As requested by Eric Seidel. In WebKit, we typically use "clear" to
+        mean zeroing out a pointer (e.g., OwnPtr::clear). For DOMWindow, it's
+        more like we're resetting the DOMWindow to a known state (i.e., its
+        initial state), modulo a wrinkle w.r.t. the PageCache. The new name
+        attempts to clarify the situation.
+
+        * dom/Document.cpp:
+        (WebCore::Document::~Document):
+        * loader/FrameLoader.cpp:
+        (WebCore::FrameLoader::clear):
+        * page/DOMWindow.cpp:
+        (WebCore::DOMWindow::~DOMWindow):
+        (WebCore::DOMWindow::frameDestroyed):
+        (WebCore::DOMWindow::resetUnlessSuspendedForPageCache):
+        (WebCore::DOMWindow::resetDOMWindowProperties):
+        * page/DOMWindow.h:
+        (DOMWindow):
+
 2012-08-16  Sheriff Bot  <webkit.review.bot@gmail.com>
 

trunk/Source/WebCore/dom/Document.cpp

@@ -613 +613 @@
     ASSERT(!m_guardRefCount);
 
-    // FIXME: Should we clear m_domWindow when we detach from the Frame?
+    // FIXME: Should we reset m_domWindow when we detach from the Frame?
     if (m_domWindow)
-        m_domWindow->clear();
+        m_domWindow->resetUnlessSuspendedForPageCache();
 
     m_scriptRunner.clear();

trunk/Source/WebCore/loader/FrameLoader.cpp

@@ -562 +562 @@
     if (clearWindowProperties) {
         InspectorInstrumentation::frameWindowDiscarded(m_frame, m_frame->document()->domWindow());
-        m_frame->document()->domWindow()->clear();
+        m_frame->document()->domWindow()->resetUnlessSuspendedForPageCache();
         m_frame->script()->clearWindowShell(newDocument->domWindow(), m_frame->document()->inPageCache());
     }

trunk/Source/WebCore/page/DOMWindow.cpp

@@ -438 +438 @@
         willDestroyDocumentInFrame();
 
-    // As the ASSERTs above indicate, this clear should only be necesary if this DOMWindow is suspended for the page cache.
+    // As the ASSERTs above indicate, this reset should only be necessary if this DOMWindow is suspended for the page cache.
     // But we don't want to risk any of these objects hanging around after we've been destroyed.
-    clearDOMWindowProperties();
+    resetDOMWindowProperties();
 
     removeAllUnloadEventListeners(this);
@@ -475 +475 @@
     willDestroyDocumentInFrame();
     FrameDestructionObserver::frameDestroyed();
-    clearDOMWindowProperties();
+    resetDOMWindowProperties();
 }
 
@@ -523 +523 @@
 }
 
-void DOMWindow::clear()
-{
-    // The main frame will always try to clear its DOMWindow when a new load is committed, even if that
-    // DOMWindow is suspended in the page cache.
-    // In those cases we need to make sure we don't actually clear it.
+void DOMWindow::resetUnlessSuspendedForPageCache()
+{
     if (m_suspendedForPageCache)
         return;
-    
     willDestroyDocumentInFrame();
-    clearDOMWindowProperties();
+    resetDOMWindowProperties();
 }
 
@@ -568 +564 @@
 }
 
-void DOMWindow::clearDOMWindowProperties()
+void DOMWindow::resetDOMWindowProperties()
 {
     m_properties.clear();

trunk/Source/WebCore/page/DOMWindow.h

@@ -110 +110 @@
         void unregisterProperty(DOMWindowProperty*);
 
-        void clear();
+        void resetUnlessSuspendedForPageCache();
         void suspendForPageCache();
         void resumeFromPageCache();
@@ -423 +423 @@
         bool isInsecureScriptAccess(DOMWindow* activeWindow, const String& urlString);
 
-        void clearDOMWindowProperties();
+        void resetDOMWindowProperties();
         void disconnectDOMWindowProperties();
         void reconnectDOMWindowProperties();