Clean up the page state saving mechanism.

content/renderer/render_view_impl.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
 #define CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
 
 #include <deque>
 #include <map>
 #include <set>
@@ skipping 188 matching lines @@
   int history_list_offset() const { return history_list_offset_; }
 
   const WebPreferences& webkit_preferences() const {
     return webkit_preferences_;
   }
 
   const RendererPreferences& renderer_preferences() const {
     return renderer_preferences_;
   }
 
-  void set_send_content_state_immediately(bool value) {
-    send_content_state_immediately_ = value;
+  void set_page_state_sent_immediately(bool value) {
+    page_state_sent_immediately_ = value;
   }
 
   MouseLockDispatcher* mouse_lock_dispatcher() {
     return mouse_lock_dispatcher_;
   }
 
   HistoryController* history_controller() {
     return history_controller_.get();
   }
 
@@ skipping 82 matching lines @@
   // supported PPAPI plug-ins.
   bool HasIMETextFocus();
 
   // Callback for use with GetWindowSnapshot.
   typedef base::Callback<void(
       const gfx::Size&, const std::vector<unsigned char>&)>
       WindowSnapshotCallback;
 
   void GetWindowSnapshot(const WindowSnapshotCallback& callback);
 
-  // Dispatches the current navigation state to the browser. Called on a
-  // periodic timer so we don't send too many messages.
-  void SyncNavigationState();
+  // Forces the current page state to be flushed to the browser.
+  void ForcePageStateFlushForTesting();
 
   // Returns the length of the session history of this RenderView. Note that
   // this only coincides with the actual length of the session history if this
   // RenderView is the currently active RenderView of a WebContents.
   unsigned GetLocalSessionHistoryLengthForTesting() const;
 
   // Invokes OnSetFocus and marks the widget as active depending on the value
   // of |enable|. This is used for layout tests that need to control the focus
   // synchronously from the renderer.
   void SetFocusAndActivateForTesting(bool enable);
@@ skipping 132 matching lines @@
   gfx::Size GetSize() const override;
   WebPreferences& GetWebkitPreferences() override;
   void SetWebkitPreferences(const WebPreferences& preferences) override;
   blink::WebView* GetWebView() override;
   blink::WebElement GetFocusedElement() const override;
   bool IsEditableNode(const blink::WebNode& node) const override;
   bool NodeContainsPoint(const blink::WebNode& node,
                          const gfx::Point& point) const override;
   bool ShouldDisplayScrollbars(int width, int height) const override;
   int GetEnabledBindings() const override;
-  bool GetContentStateImmediately() const override;
+  bool GetPageStateSentImmediately() const override;
   blink::WebPageVisibilityState GetVisibilityState() const override;
   void DidStartLoading() override;
   void DidStopLoading() override;
   void Repaint(const gfx::Size& size) override;
   void SetEditCommandForNextKeyEvent(const std::string& name,
                                      const std::string& value) override;
   void ClearEditCommands() override;
   SSLStatus GetSSLStatusOfFrame(blink::WebFrame* frame) const override;
   const std::string& GetAcceptLanguages() const override;
 #if defined(OS_ANDROID)
@@ skipping 142 matching lines @@
 
   static bool IsReload(FrameMsg_Navigate_Type::Value navigation_type);
 
   static Referrer GetReferrerFromRequest(
       blink::WebFrame* frame,
       const blink::WebURLRequest& request);
 
   static WindowOpenDisposition NavigationPolicyToDisposition(
       blink::WebNavigationPolicy policy);
 
-  void UpdateSessionHistory(blink::WebFrame* frame);
-  void SendUpdateState(HistoryEntry* entry);
-
   // Sends a message and runs a nested message loop.
   bool SendAndRunNestedMessageLoop(IPC::SyncMessage* message);
 
   // IPC message handlers ------------------------------------------------------
   //
   // The documentation for these functions should be in
   // content/common/*_messages.h for the message that the function is handling.
   void OnExecuteEditCommand(const std::string& name, const std::string& value);
   void OnMoveCaret(const gfx::Point& point);
   void OnScrollFocusedEditableNodeIntoRect(const gfx::Rect& rect);
@@ skipping 129 matching lines @@
 #endif
 
   // Sends a reply to the current find operation handling if it was a
   // synchronous find request.
   void SendFindReply(int request_id,
                      int match_count,
                      int ordinal,
                      const blink::WebRect& selection_rect,
                      bool final_status_update);
 
-  // Starts nav_state_sync_timer_ if it isn't already running.
-  void StartNavStateSyncTimerIfNecessary();
+  // Marks the page state as being changed and in need of being sent to the
+  // browser. (It will be send on a delay, but that doesn't concern callers.)

[Charlie Reis, 2014/10/31 21:38:49]

nit: send -> sent

[Avi (use Gerrit), 2014/10/31 22:11:12]

Done.

+  void MarkPageStateAsDirty();
+
+  // If there is a pending page state update that hasn't yet been sent to the
+  // browser, send it to the browser.
+  void FlushPageState();
 
 #if defined(OS_POSIX) && !defined(OS_MACOSX)
   void UpdateFontRenderingFromRendererPrefs();
 #else
   void UpdateFontRenderingFromRendererPrefs() {}
 #endif
 
   // Update the target url and tell the browser that the target URL has changed.
   // If |url| is empty, show |fallback_url|.
   void UpdateTargetURL(const GURL& url, const GURL& fallback_url);
@@ skipping 36 matching lines @@
   // it in the same order in the .cc file as it was in the header.
   // ---------------------------------------------------------------------------
 
   // Settings ------------------------------------------------------------------
 
   WebPreferences webkit_preferences_;
   RendererPreferences renderer_preferences_;
 
   HostZoomLevels host_zoom_levels_;
 
-  // Whether content state (such as form state, scroll position and page
-  // contents) should be sent to the browser immediately. This is normally
-  // false, but set to true by some tests.
-  bool send_content_state_immediately_;
-
   // Bitwise-ORed set of extra bindings that have been enabled.  See
   // BindingsPolicy for details.
   int enabled_bindings_;
 
   // If true, we send IPC messages when |preferred_size_| changes.
   bool send_preferred_size_changes_;
 
   // If non-empty, and |send_preferred_size_changes_| is true, disable drawing
   // scroll bars on windows smaller than this size.  Used for windows that the
   // browser resizes to the size of the content, such as browser action popups.
@@ skipping 24 matching lines @@
   // PageGroupLoadDeferrer on the stack that interferes with swapping out.
   bool suppress_dialogs_until_swap_out_;
 
   // Holds state pertaining to a navigation that we initiated.  This is held by
   // the WebDataSource::ExtraData attribute.  We use pending_navigation_state_
   // as a temporary holder for the state until the WebDataSource corresponding
   // to the new navigation is created.  See DidCreateDataSource.
   // TODO(nasko): Move to RenderFrame, as this is per-frame state.
   scoped_ptr<FrameMsg_Navigate_Params> pending_navigation_params_;
 
-  // Timer used to delay the updating of nav state (see SyncNavigationState).
-  base::OneShotTimer<RenderViewImpl> nav_state_sync_timer_;
+  // Whether the page state (such as form state, scroll position and page
+  // contents) should be sent to the browser immediately. This is normally
+  // false, but is set to true by some tests.
+  bool page_state_sent_immediately_;
+
+  // Whether the page state is dirty (meaning that the browser does not have an
+  // up-to-date copy).
+  bool page_state_dirty_;
+
+  // Timer used to delay the sending of the page state (see
+  // MarkPageStateAsDirty).
+  base::OneShotTimer<RenderViewImpl> page_state_timer_;
 
   // Page IDs ------------------------------------------------------------------
   // See documentation in RenderView.
   int32 page_id_;
 
   // Indicates the ID of the last page that we sent a FrameNavigate to the
   // browser for. This is used to determine if the most recent transition
   // generated a history entry (less than page_id_), or not (equal to or
   // greater than). Note that this will be greater than page_id_ if the user
   // goes back.
@@ skipping 203 matching lines @@
   // use the Observer interface to filter IPC messages and receive frame change
   // notifications.
   // ---------------------------------------------------------------------------
 
   DISALLOW_COPY_AND_ASSIGN(RenderViewImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_RENDER_VIEW_IMPL_H_