Persist the Instant API to committed search result pages.

chrome/browser/instant/instant_controller.h

 // Copyright 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_INSTANT_INSTANT_CONTROLLER_H_
 #define CHROME_BROWSER_INSTANT_INSTANT_CONTROLLER_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string16.h"
 #include "base/time.h"
 #include "base/timer.h"
 #include "chrome/browser/instant/instant_commit_type.h"
 #include "chrome/browser/instant/instant_model.h"
 #include "chrome/common/instant_types.h"
 #include "chrome/common/search_types.h"
 #include "content/public/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 #include "ui/gfx/native_widget_types.h"
 #include "ui/gfx/rect.h"
 
 struct AutocompleteMatch;
 class AutocompleteProvider;
+class InstantClient;
 class InstantLoader;
 class TabContents;
 class TemplateURL;
 struct ThemeBackgroundInfo;
 
 namespace chrome {
 class BrowserInstantController;
 }
 
 // InstantController maintains a WebContents that is intended to give a preview
@@ skipping 47 matching lines @@
 
   // The omnibox has gained focus. Preload the default search engine, in
   // anticipation of the user typing a query.
   void OmniboxGotFocus();
 
   // The search mode in the active tab has changed. Pass the message down to
   // the loader which will notify the renderer.
   void SearchModeChanged(const chrome::search::Mode& old_mode,
                          const chrome::search::Mode& new_mode);
 
   // The user switched tabs. Hide the preview if needed.

[sky, 2012/11/27 01:07:51]

Update comment.

[sreeram, 2012/11/29 07:33:19]

Done.

   void ActiveTabChanged();
 
   // Sets whether Instant should show result previews.
   void SetInstantEnabled(bool instant_enabled);
 
   // The theme has changed.  Pass the message down to the loader which will
   // notify the renderer.
   void ThemeChanged(const ThemeBackgroundInfo& theme_info);
 
   // The theme area height has changed.  Pass the message down to the loader
   // which will notify the renderer.
   void ThemeAreaHeightChanged(int height);
 
   // Returns the transition type of the last AutocompleteMatch passed to Update.
   content::PageTransition last_transition_type() const {
     return last_transition_type_;
   }
 
   const InstantModel* model() const { return &model_; }
 
   // Invoked by InstantLoader when it has suggested text.

[Jered, 2012/11/27 19:21:57]

InstantLoader -> client

[sreeram, 2012/11/29 07:33:19]

Done.

-  void SetSuggestions(InstantLoader* loader,
+  void SetSuggestions(InstantClient* client,
                       const std::vector<InstantSuggestion>& suggestions);
 
   // Invoked by InstantLoader to commit the preview.
   void CommitInstantLoader(InstantLoader* loader);
 
   // Invoked by InstantLoader to request that the preview be shown.
   void ShowInstantPreview(InstantLoader* loader,
                           InstantShownReason reason,
                           int height,
                           InstantSizeUnits units);
 
   // Invoked by InstantLoader when it has determined whether or not the page

[Jered, 2012/11/27 19:21:57]

InstantLoader -> client

[sreeram, 2012/11/29 07:33:19]

Done.

   // supports the Instant API.
-  void InstantSupportDetermined(InstantLoader* loader, bool supports_instant);
+  void InstantSupportDetermined(InstantClient* client, bool supports_instant);
 
   // Invoked by InstantLoader when it has swapped a different TabContents into
   // the preview, usually because a prerendered page was navigated to.
   void SwappedTabContents(InstantLoader* loader);
 
   // Invoked by InstantLoader when the preview gains focus, usually due to the
   // user clicking on it.
   void InstantLoaderContentsFocused(InstantLoader* loader);
 
 #if defined(UNIT_TEST)
   // Accessors used only in tests.
   InstantLoader* loader() const { return loader_.get(); }
 #endif
 
  private:
   FRIEND_TEST_ALL_PREFIXES(InstantTest, InstantLoaderRefresh);
 
+  void ResetClient();
+
   // Creates a new loader if necessary, using the instant_url property of the
   // |template_url| (for example, if the Instant URL has changed since the last
   // time the loader was created). Returns false if the |template_url| doesn't
   // have a valid Instant URL; true otherwise.
   bool ResetLoader(const TemplateURL* template_url,
                    const TabContents* active_tab);
 
   // Ensures that the |loader_| uses the default Instant URL, recreating it if
   // necessary, and returns true. Returns false if the Instant URL could not be
   // determined or the active tab is NULL (browser is shutting down).
@@ skipping 19 matching lines @@
   // Send the omnibox dropdown bounds to the page.
   void SendBoundsToPage();
 
   // If |template_url| is a valid TemplateURL for use with Instant, fills in
   // |instant_url| and returns true; returns false otherwise.
   // Note: If the command-line switch kInstantURL is set, this method uses its
   // value for |instant_url| and returns true without examining |template_url|.
   bool GetInstantURL(const TemplateURL* template_url,
                      std::string* instant_url) const;
 
+  InstantClient* CurrentClient() const;
+
   chrome::BrowserInstantController* const browser_;
 
   // Whether the extended API and regular API are enabled. If both are false,
   // Instant is effectively disabled.
   const bool extended_enabled_;
   bool instant_enabled_;
 
   InstantModel model_;

[samarth, 2012/11/27 18:09:43]

Worth clarifying somewhere that model_ only reflects the model for loader_.

[sreeram, 2012/11/29 07:33:19]

Done.

 
+  scoped_ptr<InstantClient> client_;

[sky, 2012/11/27 01:07:51]

Since InstantLoader is also an InstantClient using the name client_ here is
mildly confusing.

[sreeram, 2012/11/29 07:33:19]

Done.

   scoped_ptr<InstantLoader> loader_;

[Jered, 2012/11/27 19:21:57]

It feels funny to me that InstantController owns client_. Instead, is there
somehow it could be tethered to the active tab? Then if the active tab has a
client, use it, otherwise use the loader. (The client flakes off from the loader
on commit.)

[sreeram, 2012/11/29 07:33:19]

Ack. As per previous comments, I've kept the ownership the same.

 
   // The most recent user_text passed to Update().
   string16 last_user_text_;
 
   // The most recent full_text passed to Update().
   string16 last_full_text_;
 
   // The most recent verbatim passed to Update().
   bool last_verbatim_;
 
@@ skipping 40 matching lines @@
 
   // The timestamp at which query editing began. This value is used when the
   // first set of suggestions is processed and cleared when the overlay is
   // hidden.
   base::Time first_interaction_time_;
 
   DISALLOW_COPY_AND_ASSIGN(InstantController);
 };
 
 #endif  // CHROME_BROWSER_INSTANT_INSTANT_CONTROLLER_H_