Omnibox: Create Bundled Field Trial; Convert SearchHistory trial to it

chrome/browser/omnibox/omnibox_field_trial.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_OMNIBOX_OMNIBOX_FIELD_TRIAL_H_
 #define CHROME_BROWSER_OMNIBOX_OMNIBOX_FIELD_TRIAL_H_
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
+#include "base/gtest_prod_util.h"
+#include "chrome/browser/autocomplete/autocomplete_input.h"
 
 // This class manages the Omnibox field trials.
 class OmniboxFieldTrial {
  public:
   // Creates the static field trial groups.
   // *** MUST NOT BE CALLED MORE THAN ONCE. ***
   static void ActivateStaticTrials();
 
   // Activates all dynamic field trials.  The main difference between
   // the autocomplete dynamic and static field trials is that the former
@@ skipping 72 matching lines @@
   // if the field trial is not active, etc., returns false.
   // CalculateScore()'s return value is a product of this maximum
   // relevance score and some attenuating factors that are all between
   // 0 and 1.  (Note that Shortcuts results may have their scores
   // reduced later if the assigned score is higher than allowed for
   // non-inlineable results.  Shortcuts results are not allowed to be
   // inlined.)
   static bool ShortcutsScoringMaxRelevance(int* max_relevance);
 
   // ---------------------------------------------------------
-  // For the SearchHistory field trial.
+  // For the SearchHistory experiment that's part of the bundled omnibox
+  // field trial.
 
-  // Returns true if the user is in the experiment group that scores
-  // search history query suggestions less aggressively so that they don't
-  // inline.
-  static bool SearchHistoryPreventInlining();
+  // Returns true if the user is in the experiment group that, given the
+  // provided |current_page_classification| context, scores search history
+  // query suggestions less aggressively so that they don't inline.
+  static bool SearchHistoryPreventInlining(
+      AutocompleteInput::PageClassification current_page_classification);
 
-  // Returns true if the user is in the experiment group that disables
-  // all query suggestions from search history.
-  static bool SearchHistoryDisable();
+  // Returns true if the user is in the experiment group that, given the
+  // provided |current_page_classification| context, disables all query
+  // suggestions from search history.
+  static bool SearchHistoryDisable(
+      AutocompleteInput::PageClassification current_page_classification);
 
  private:
+  FRIEND_TEST_ALL_PREFIXES(OmniboxFieldTrialTest, GetValueForRuleInContext);
+
+  // The bundled omnibox experiment comes with a set of parameters
+  // (key-value pairs).  Each key indicates a certain rule that applies in
+  // a certain context.  The value indicates what the consequences of
+  // applying the rule are.  For example, the value of a SearchHistory rule
+  // in the context of a search results page might indicate that we should
+  // prevent search history matches from inlining.
+  //
+  // This function returns the value associated with the |rule| that applies
+  // in the current context (which currently only consists of
+  // |page_classification| but will soon contain other features, some not
+  // passed in as parameters, such as whether Instant Extended is enabled).
+  // If no such rule exists in the current context, looks for that rule in
+  // the global context and return its value if found.  If the rule remains
+  // unfound in the global context, returns the empty string.  For more
+  // details, see the implementation.  How to interpret the value is left
+  // to the caller; this is rule-dependent.
+  static std::string GetValueForRuleInContext(
+      const std::string& rule,
+      AutocompleteInput::PageClassification page_classification);
+
   DISALLOW_IMPLICIT_CONSTRUCTORS(OmniboxFieldTrial);
 };
 
 #endif  // CHROME_BROWSER_OMNIBOX_OMNIBOX_FIELD_TRIAL_H_