[iOS] Refactoring web CRWSessionController user agent code.

ios/web/navigation/navigation_manager_impl.h

 // Copyright 2013 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 IOS_WEB_NAVIGATION_NAVIGATION_MANAGER_IMPL_H_
 #define IOS_WEB_NAVIGATION_NAVIGATION_MANAGER_IMPL_H_
 
 #include <stddef.h>
 
 #include <memory>
@@ skipping 64 matching lines @@
   void OnNavigationItemCommitted();
 
   // Temporary accessors and content/ class pass-throughs.
   // TODO(stuartmorgan): Re-evaluate this list once the refactorings have
   // settled down.
   CRWSessionController* GetSessionController();
   void LoadURL(const GURL& url,
                const Referrer& referrer,
                ui::PageTransition type);
 
+  // Add a new item with the given url, referrer, and navigation type, making it
+  // the current item. If pending item is the same as the current item, this
+  // does nothing. |referrer| may be nil if there isn't one. The item starts
+  // out as pending, and will be lost unless |-commitPendingItem| is called.
+  void AddUserInitiatedPendingItem(const GURL& url,
+                                   const web::Referrer& referrer,
+                                   ui::PageTransition type);
+  void AddRendererInitiatedPendingItem(const GURL& url,
+                                       const web::Referrer& referrer,
+                                       ui::PageTransition type);
+
   // Convenience accessors to get the underlying NavigationItems from the
   // SessionEntries returned from |session_controller_|'s -lastUserEntry and
   // -previousEntry methods.
   // TODO(crbug.com/546365): Remove these methods.
   NavigationItem* GetLastUserItem() const;
   NavigationItem* GetPreviousItem() const;
 
   // Temporary method. Returns a vector of NavigationItems corresponding to
   // the SessionEntries of the uderlying CRWSessionController.
   // TODO(crbug.com/546365): Remove this method.
@@ skipping 17 matching lines @@
   int GetPendingItemIndex() const override;
   int GetLastCommittedItemIndex() const override;
   bool RemoveItemAtIndex(int index) override;
   bool CanGoBack() const override;
   bool CanGoForward() const override;
   bool CanGoToOffset(int offset) const override;
   void GoBack() override;
   void GoForward() override;
   void GoToIndex(int index) override;
   void Reload(bool check_for_reposts) override;
+  // Removes this method once crbug.com/692303 is fixed.

[kkhorimoto, 2017/02/15 23:02:06]

This comment isn't really necessary since it's already in navigation_manager.h

[liaoyuke, 2017/02/16 01:49:05]

Done.

+  void OverrideDesktopUserAgentForNextPendingItem() override;
 
   // Returns the current list of transient url rewriters, passing ownership to
   // the caller.
   // TODO(crbug.com/546197): remove once NavigationItem creation occurs in this
   // class.
   std::unique_ptr<std::vector<BrowserURLRewriter::URLRewriter>>
   GetTransientURLRewriters();
 
   // Called to reset the transient url rewriter list.
   void RemoveTransientURLRewriters();
@@ skipping 11 matching lines @@
 
  private:
   // The SessionStorageBuilder functions require access to private variables of
   // NavigationManagerImpl.
   friend SessionStorageBuilder;
 
   // Returns true if the PageTransition for the underlying navigation item at
   // |index| has ui::PAGE_TRANSITION_IS_REDIRECT_MASK.
   bool IsRedirectItemAtIndex(int index) const;
 
+  // Add a new item with the given url, referrer, and navigation type, making it
+  // the current item. If pending item is the same as the current item, this
+  // does nothing. |referrer| may be nil if there isn't one. The item starts
+  // out as pending, and will be lost unless |-commitPendingItem| is called.
+  void AddPendingItem(const GURL& url,

[kkhorimoto, 2017/02/15 23:02:06]

Why not just expose this in the public interface instead of creating two
functions above?

[liaoyuke, 2017/02/16 01:49:05]

I feel like having a boolean value as a function parameter is error prone in
C++. In Objective C, by calling the function, you would easily know that the
name of the parameter is rendererInitiated, but in C++, you just pass in the
parameter, and someone may easily mistaken the parameter name as userInitiated.

What do you think?

+                      const web::Referrer& referrer,
+                      ui::PageTransition type,
+                      bool rendererInitiated);

[kkhorimoto, 2017/02/15 23:02:06]

s/rendererInitiated/renderer_initiated

[liaoyuke, 2017/02/16 01:49:05]

Done.

+
+  // If true, override navigation item's useDesktopUserAgent flag and always
+  // create the pending entry using the desktop user agent.
+  // Removes this method once crbug.com/692303 is fixed.
+  bool override_desktop_user_agent_for_next_pending_item_;
+
   // The primary delegate for this manager.
   NavigationManagerDelegate* delegate_;
 
   // The BrowserState that is associated with this instance.
   BrowserState* browser_state_;
 
   // CRWSessionController that backs this instance.
   // TODO(stuartmorgan): Fold CRWSessionController into this class.
   base::scoped_nsobject<CRWSessionController> session_controller_;
 
   // Weak pointer to the facade delegate.
   NavigationManagerFacadeDelegate* facade_delegate_;
 
   // List of transient url rewriters added by |AddTransientURLRewriter()|.
   std::unique_ptr<std::vector<BrowserURLRewriter::URLRewriter>>
       transient_url_rewriters_;
 
   DISALLOW_COPY_AND_ASSIGN(NavigationManagerImpl);
 };
 
 }  // namespace web
 
 #endif  // IOS_WEB_NAVIGATION_NAVIGATION_MANAGER_IMPL_H_