Omnibox: Log Elapsed Time Since Last Time The Default Match Changed

chrome/browser/autocomplete/autocomplete_controller.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 CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/string16.h"
+#include "base/time.h"
 #include "base/timer.h"
 #include "chrome/browser/autocomplete/autocomplete_input.h"
 #include "chrome/browser/autocomplete/autocomplete_provider.h"
 #include "chrome/browser/autocomplete/autocomplete_provider_listener.h"
 #include "chrome/browser/autocomplete/autocomplete_result.h"
 
 class AutocompleteControllerDelegate;
 class KeywordProvider;
 class Profile;
 class SearchProvider;
@@ skipping 96 matching lines @@
   void ExpireCopiedEntries();
 
   SearchProvider* search_provider() const { return search_provider_; }
   KeywordProvider* keyword_provider() const { return keyword_provider_; }
 
   const AutocompleteInput& input() const { return input_; }
   const AutocompleteResult& result() const { return result_; }
   bool done() const { return done_; }
   const ACProviders* providers() const { return &providers_; }
 
+  const base::TimeTicks& last_time_default_match_changed() const {
+    return last_time_default_match_changed_;
+  }
+
   // AutocompleteProviderListener:
   virtual void OnProviderUpdate(bool updated_matches) OVERRIDE;
 
   // Called when an omnibox event log entry is generated.
   // Populates provider_info with diagnostic information about the status
   // of various providers.  In turn, calls
   // AutocompleteProvider::AddProviderInfo() so each provider can add
   // provider-specific information, information we want to log for a particular
   // provider but not others.
   void AddProvidersInfo(ProvidersInfo* provider_info) const;
 
  private:
   friend class AutocompleteProviderTest;
   FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest,
                            RedundantKeywordsIgnoredInResult);
   FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, UpdateAssistedQueryStats);
 
-  // Updates |result_| to reflect the current provider state.  Resets timers and
-  // fires notifications as necessary.  |is_synchronous_pass| is true only when
-  // Start() is calling this to get the synchronous result.
-  void UpdateResult(bool is_synchronous_pass);
+  // Updates |result_| to reflect the current provider state and fires
+  // notifications.  If |regenerate_result| then we clear the result
+  // so when we incorporate the current provider state we end up
+  // implicitly removing all expired matches.  (Normally we allow
+  // matches from the previous result set carry over.  These stale
+  // results may outrank legitimate matches from the current result
+  // set.  Sometimes we just want the current matches; the easier way
+  // to do this is to throw everything out and reconstruct the result
+  // set from the providers' current data.)
+  // If |force_notify_default_match_changed|, we tell NotifyChanged
+  // the default match has changed even if it hasn't.  This is
+  // necessary in some cases; for instance, if the user typed a new
+  // character, the edit model needs to repaint (highlighting changed)
+  // even if the default match didn't change.
+  void UpdateResult(bool regenerate_result,
+                    bool force_notify_default_match_changed);
 
   // Updates |result| to populate each match's |associated_keyword| if that
   // match can show a keyword hint.  |result| should be sorted by
   // relevance before this is called.
   void UpdateAssociatedKeywords(AutocompleteResult* result);
 
   // For each group of contiguous matches from the same TemplateURL, show the
   // provider name as a description on the first match in the group.
   void UpdateKeywordDescriptions(AutocompleteResult* result);
 
@@ skipping 22 matching lines @@
   SearchProvider* search_provider_;
 
   ZeroSuggestProvider* zero_suggest_provider_;
 
   // Input passed to Start.
   AutocompleteInput input_;
 
   // Data from the autocomplete query.
   AutocompleteResult result_;
 
+  // The most recent time the default match (inline match) changed.  This may
+  // be earlier than the most recent keystroke if the recent keystrokes didn't
+  // change the suggested match in the omnibox.  (For instance, if
+  // a user typed "mail.goog" and the match https://mail.google.com/ was
+  // the destination match ever since the user typed "ma" then this time
+  // corresponds to the first instance https://mail.google.com/

[Peter Kasting, 2012/11/20 06:49:19]

Nit: How about "then this is the time that URL first appeared as the default
match."

[Mark P, 2012/11/20 17:34:41]

Done.

+  // appeared as the default match.)  This also be more recent than the

[Peter Kasting, 2012/11/20 06:49:19]

Nit: This also -> This may also

[Mark P, 2012/11/20 17:34:41]

Done.

+  // last keystroke if there was an asynchronous provider that returned
+  // and changed the default match.  See UpdateResult() for details on
+  // when we consider a match to have changed.
+  base::TimeTicks last_time_default_match_changed_;
+
   // Timer used to remove any matches copied from the last result. When run
   // invokes |ExpireCopiedEntries|.
   base::OneShotTimer<AutocompleteController> expire_timer_;
 
   // True if a query is not currently running.
   bool done_;
 
   // Are we in Start()? This is used to avoid updating |result_| and sending
   // notifications until Start() has been invoked on all providers.
   bool in_start_;
 
   // Has StartZeroSuggest() been called but not Start()?
   bool in_zero_suggest_;
 
   Profile* profile_;
 
   DISALLOW_COPY_AND_ASSIGN(AutocompleteController);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_