[iOS] Refactoring web CRWSessionController user agent code.

ios/web/navigation/navigation_item_impl.h

 // Copyright 2014 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_ITEM_IMPL_H_
 #define IOS_WEB_NAVIGATION_NAVIGATION_ITEM_IMPL_H_
 
 #import <Foundation/Foundation.h>
 
 #include <memory>
 
 #import "base/mac/scoped_nsobject.h"
 #include "base/strings/string16.h"
 #include "ios/web/navigation/navigation_item_facade_delegate.h"
 #include "ios/web/public/favicon_status.h"
 #import "ios/web/public/navigation_item.h"
 #include "ios/web/public/referrer.h"
 #include "ios/web/public/ssl_status.h"
 #include "url/gurl.h"
 
 namespace web {
 
 class NavigationItemFacadeDelegate;
 class NavigationItemStorageBuilder;
+enum class NavigationInitiationType;
 
 // Implementation of NavigationItem.
 class NavigationItemImpl : public web::NavigationItem {
  public:
   // Creates a default NavigationItemImpl.
   NavigationItemImpl();
   ~NavigationItemImpl() override;
 
   // Since NavigationItemImpls own their facade delegates, there is no implicit
   // copy constructor (scoped_ptrs can't be copied), so one is defined here.
@@ skipping 52 matching lines @@
   // TODO(crbug.com/659816): This state is only tracked because of flaky early
   // page script injection.  Once the root cause of this flake is found, this
   // can be removed.
   void SetHasStateBeenReplaced(bool replace_state);
   bool HasStateBeenReplaced() const;
 
   // Whether this navigation is the result of a hash change.
   void SetIsCreatedFromHashChange(bool hash_change);
   bool IsCreatedFromHashChange() const;
 
+  // The initiation type of this pending navigation. Resets to user-initiated
+  // after commit.
+  void SetNavigationInitiationType(
+      web::NavigationInitiationType navigation_initiation_type);
+  web::NavigationInitiationType NavigationInitiationType() const;
+
   // Whether or not to bypass showing the repost form confirmation when loading
   // a POST request. Set to YES for browser-generated POST requests.
   void SetShouldSkipRepostFormConfirmation(bool skip);
   bool ShouldSkipRepostFormConfirmation() const;
 
   // Data submitted with a POST request, persisted for resubmits.
   void SetPostData(NSData* post_data);
   NSData* GetPostData() const;
 
   // Removes the header for |key| from |http_request_headers_|.
   void RemoveHttpRequestHeaderForKey(NSString* key);
 
   // Removes all http headers from |http_request_headers_|.
   void ResetHttpRequestHeaders();
 
   // Once a navigation item is committed, we should no longer track
   // non-persisted state, as documented on the members below.
   void ResetForCommit();
 
-  // Whether this (pending) navigation is renderer-initiated.  Resets to false
-  // for all types of navigations after commit.
-  void set_is_renderer_initiated(bool is_renderer_initiated) {
-    is_renderer_initiated_ = is_renderer_initiated;
-  }
-  bool is_renderer_initiated() const { return is_renderer_initiated_; }
-
  private:
   // The NavigationManItemStorageBuilder functions require access to
   // private variables of NavigationItemImpl.
   friend NavigationItemStorageBuilder;
 
   int unique_id_;
   GURL original_request_url_;
   GURL url_;
   Referrer referrer_;
   GURL virtual_url_;
   base::string16 title_;
   PageDisplayState page_display_state_;
   ui::PageTransition transition_type_;
   FaviconStatus favicon_;
   SSLStatus ssl_;
   base::Time timestamp_;
   bool is_overriding_user_agent_;
   base::scoped_nsobject<NSMutableDictionary> http_request_headers_;
 
   base::scoped_nsobject<NSString> serialized_state_object_;
   bool is_created_from_push_state_;
   bool has_state_been_replaced_;
   bool is_created_from_hash_change_;
   bool should_skip_repost_form_confirmation_;
   base::scoped_nsobject<NSData> post_data_;
 
-  // Whether the item, while loading, was created for a renderer-initiated
-  // navigation.  This dictates whether the URL should be displayed before the
-  // navigation commits.  It is cleared in |ResetForCommit| and not persisted.
-  bool is_renderer_initiated_;
+  // The navigation initiation type of the item.  This decides whether the URL
+  // should be displayed before the navigation commits.  It is cleared in
+  // |ResetForCommit| and not persisted.
+  web::NavigationInitiationType navigation_initiation_type_;
 
   // Whether the navigation contains unsafe resources.
   bool is_unsafe_;
 
   // This is a cached version of the result of GetTitleForDisplay. When the URL,
   // virtual URL, or title is set, this should be cleared to force a refresh.
   mutable base::string16 cached_display_title_;
 
   // Weak pointer to the facade delegate.
   std::unique_ptr<NavigationItemFacadeDelegate> facade_delegate_;
 
   // Copy and assignment is explicitly allowed for this class.
 };
 
 }  // namespace web
 
 #endif  // IOS_WEB_NAVIGATION_NAVIGATION_ITEM_IMPL_H_