Allow storing null navigations in CRWWKNavigationStates.

ios/web/web_state/ui/crw_wk_navigation_states.mm

 // Copyright 2016 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.
 
 #import "ios/web/web_state/ui/crw_wk_navigation_states.h"
 
 #include "base/logging.h"
 #include "ios/web/web_state/navigation_context_impl.h"
 
 #if !defined(__has_feature) || !__has_feature(objc_arc)
@@ skipping 65 matching lines @@
 
 - (web::NavigationContextImpl*)context {
   return _context.get();
 }
 
 @end
 
 @interface CRWWKNavigationStates () {
   NSMapTable* _records;
   NSUInteger _lastStateIndex;
+  WKNavigation* _nullNavigation;
 }
+
+// Returns key to use for storing navigation in records table.
+- (id)keyForNavigation:(WKNavigation*)navigation;
+
+// Returns last added navigation and record.
+- (void)getLastAddedNavigation:(WKNavigation**)outNavigation
+                        record:(CRWWKNavigationsStateRecord**)outRecord;
+
 @end
 
 @implementation CRWWKNavigationStates
 
 - (instancetype)init {
   if ((self = [super init])) {
     _records = [NSMapTable weakToStrongObjectsMapTable];
+    _nullNavigation = static_cast<WKNavigation*>([NSNull null]);

[kkhorimoto, 2017/04/25 14:00:11]

Is reinterpret_cast more appropriate here? 

[Eugene But (OOO till 7-30), 2017/04/26 05:51:33]

This translates one Obc-C pointer type to another, so static_cast should be
fine.

   }
   return self;
 }
 
 - (NSString*)description {
   return [NSString stringWithFormat:@"records: %@, lastAddedNavigation: %@",
                                     _records, self.lastAddedNavigation];
 }
 
 - (void)setState:(web::WKNavigationState)state
     forNavigation:(WKNavigation*)navigation {
-  if (!navigation) {
-    // WKWebView may call WKNavigationDelegate callbacks with nil.
-    return;
-  }
-
-  CRWWKNavigationsStateRecord* record = [_records objectForKey:navigation];
+  id key = [self keyForNavigation:navigation];
+  CRWWKNavigationsStateRecord* record = [_records objectForKey:key];
   if (!record) {
     DCHECK(state == web::WKNavigationState::REQUESTED ||
            state == web::WKNavigationState::STARTED ||
            state == web::WKNavigationState::COMMITTED);
     record =
         [[CRWWKNavigationsStateRecord alloc] initWithState:state
                                                      index:++_lastStateIndex];
   } else {
     DCHECK(
         record.state < state ||
         (record.state == state && state == web::WKNavigationState::REDIRECTED));
     record.state = state;
   }
-  [_records setObject:record forKey:navigation];
+  [_records setObject:record forKey:key];
 }
 
 - (void)removeNavigation:(WKNavigation*)navigation {
-  if (!navigation) {
-    // WKWebView may call WKNavigationDelegate callbacks with nil.
-    return;
-  }
-
-  DCHECK([_records objectForKey:navigation]);
-  [_records removeObjectForKey:navigation];
+  id key = [self keyForNavigation:navigation];
+  DCHECK([_records objectForKey:key]);
+  [_records removeObjectForKey:key];
 }
 
 - (void)setContext:(std::unique_ptr<web::NavigationContextImpl>)context
      forNavigation:(WKNavigation*)navigation {
-  if (!navigation) {
-    // WKWebView may call WKNavigationDelegate callbacks with nil.
-    return;
-  }
-  CRWWKNavigationsStateRecord* record = [_records objectForKey:navigation];
+  id key = [self keyForNavigation:navigation];
+  CRWWKNavigationsStateRecord* record = [_records objectForKey:key];
   if (!record) {
     record =
         [[CRWWKNavigationsStateRecord alloc] initWithContext:std::move(context)
                                                        index:++_lastStateIndex];
   } else {
     [record setContext:std::move(context)];
   }
-  [_records setObject:record forKey:navigation];
+  [_records setObject:record forKey:key];
 }
 
 - (web::NavigationContextImpl*)contextForNavigation:(WKNavigation*)navigation {
-  if (!navigation) {
-    // WKWebView may call WKNavigationDelegate callbacks with nil.
-    return nullptr;
-  }
-  CRWWKNavigationsStateRecord* record = [_records objectForKey:navigation];
+  id key = [self keyForNavigation:navigation];
+  CRWWKNavigationsStateRecord* record = [_records objectForKey:key];
   return record.context;
 }
 
 - (WKNavigation*)lastAddedNavigation {
   WKNavigation* result = nil;
+  CRWWKNavigationsStateRecord* unused = nil;
+  [self getLastAddedNavigation:&result record:&unused];
+  return result;
+}
+
+- (web::WKNavigationState)lastAddedNavigationState {
+  CRWWKNavigationsStateRecord* result = nil;
+  WKNavigation* unused = nil;
+  [self getLastAddedNavigation:&unused record:&result];
+  return result.state;
+}
+
+- (id)keyForNavigation:(WKNavigation*)navigation {
+  return navigation ? navigation : _nullNavigation;
+}
+
+- (void)getLastAddedNavigation:(WKNavigation**)outNavigation
+                        record:(CRWWKNavigationsStateRecord**)outRecord {
   NSUInteger lastAddedIndex = 0;  // record indices start with 1.
   for (WKNavigation* navigation in _records) {
     CRWWKNavigationsStateRecord* record = [_records objectForKey:navigation];
     if (lastAddedIndex < record.index) {
-      result = navigation;
+      *outNavigation = navigation;
+      *outRecord = record;
       lastAddedIndex = record.index;
     }
   }
-  return result;
-}
 
-- (web::WKNavigationState)lastAddedNavigationState {
-  CRWWKNavigationsStateRecord* lastAddedRecord = nil;
-  WKNavigation* lastAddedNavigation = [self lastAddedNavigation];
-  if (lastAddedNavigation)
-    lastAddedRecord = [_records objectForKey:lastAddedNavigation];
-
-  return lastAddedRecord.state;
+  if (*outNavigation == _nullNavigation) {
+    // |_nullNavigation| is a key for storing null navigations.
+    *outNavigation = nil;
+  }
 }
 
 @end