Enhance chrome://omnibox Presentation

chrome/browser/autocomplete/autocomplete_match.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_MATCH_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_MATCH_H_
 #pragma once
 
+#include <map>
 #include <string>
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "content/public/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 
 class AutocompleteProvider;
 class Profile;
 class TemplateURL;
 
+namespace base {
+class Time;
+}  // namespace base
+
 // AutocompleteMatch ----------------------------------------------------------
 
 // A single result line with classified spans.  The autocomplete popup displays
 // the 'contents' and the 'description' (the description is optional) in the
 // autocomplete dropdown, and fills in 'fill_into_edit' into the textbox when
 // that line is selected.  fill_into_edit may be the same as 'description' for
 // things like URLs, but may be different for searches or other providers.  For
 // example, a search result may say "Search for asdf" as the description, but
 // "asdf" should appear in the box.
 struct AutocompleteMatch {
@@ skipping 152 matching lines @@
   // invoke its keyword), this returns the empty string.  The result is that
   // this function returns a non-empty string in the same cases as when the UI
   // should show up as being "in keyword mode".
   string16 GetSubstitutingExplicitlyInvokedKeyword(Profile* profile) const;
 
   // Returns the TemplateURL associated with this match.  This may be NULL if
   // the match has no keyword OR if the keyword no longer corresponds to a valid
   // TemplateURL.  See comments on |keyword| below.
   TemplateURL* GetTemplateURL(Profile* profile) const;
 
+  // Adds logging information to the logging dictionary |info_log|.

[Mark P, 2012/07/10 14:51:34]

Please don't call this type of information (displayed on chrome://omnibox)
logged information.  It's not logged.

This comment requires changes in multiple places in multiple files.

[mrossetti, 2012/07/10 17:57:08]

Excellent suggestion! I want with forms of the word 'diagnostic'. What do you
think?

+  void LogInfo(const std::string& title, const std::string& value);

[Mark P, 2012/07/10 14:51:34]

Title feels to me a bit odd.  Consider something else like name or property or
feature or variable_name or ...

Once you rename this, please change the css/html/js appropriately.

[mrossetti, 2012/07/10 17:57:08]

In this case, I went with 'property'.

+  void LogInfo(const std::string& title, int value);
+  void LogInfo(const std::string& title, const base::Time& value);
+
   // The provider of this match, used to remember which provider the user had
   // selected when the input changes. This may be NULL, in which case there is
   // no provider (or memory of the user's selection).
   AutocompleteProvider* provider;
 
   // The relevance of this match. See table in autocomplete.h for scores
   // returned by various providers. This is used to rank matches among all
   // responding providers, so different providers must be carefully tuned to
   // supply matches with appropriate relevance.
   //
@@ skipping 74 matching lines @@
 
   // Optional search terms args.  If present,
   // AutocompleteController::UpdateAssistedQueryStats() will incorporate this
   // data with additional data it calculates and pass the completed struct to
   // TemplateURLRef::ReplaceSearchTerms() to reset the match's |destination_url|
   // after the complete set of matches in the AutocompleteResult has been chosen
   // and sorted.  Most providers will leave this as NULL, which will cause the
   // AutocompleteController to do no additional transformations.
   scoped_ptr<TemplateURLRef::SearchTermsArgs> search_terms_args;
 
+  // Logging information dictionary into which each provider can optionally
+  // include a title as key and associated data.
+  std::map<std::string, std::string> info_log;
+
 #ifndef NDEBUG
   // Does a data integrity check on this match.
   void Validate() const;
 
   // Checks one text/classifications pair for valid values.
   void ValidateClassifications(
       const string16& text,
       const ACMatchClassifications& classifications) const;
 #endif
 };
 
 typedef AutocompleteMatch::ACMatchClassification ACMatchClassification;
 typedef std::vector<ACMatchClassification> ACMatchClassifications;
 typedef std::vector<AutocompleteMatch> ACMatches;
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_MATCH_H_