Implement the Instant extended API startMargin, endMargin, and rtl properties and the onmarginchang…

chrome/browser/instant/instant_controller.cc

 // 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.
 
 #include "chrome/browser/instant/instant_controller.h"
 
 #include "base/command_line.h"
 #include "base/i18n/case_conversion.h"
 #include "base/metrics/histogram.h"
 #include "base/string_util.h"
@@ skipping 24 matching lines @@
 #include "net/base/escape.h"
 #include "unicode/normalizer2.h"
 #include "unicode/unistr.h"
 
 #if defined(TOOLKIT_VIEWS)
 #include "ui/views/widget/widget.h"
 #endif
 
 namespace {
 
 // An artificial delay (in milliseconds) we introduce before telling the Instant

[samarth, 2012/11/16 22:08:26]

I suspect this was necessary because the height of the popup is fairly volatile.
I hope we don't need this for the omnibox bounds, but something to keep in mind.

[melevin, 2012/11/16 22:34:43]

We'll have to test once the JavaScript is wired.

 // page about the new omnibox bounds, in cases where the bounds shrink. This is
 // to avoid the page jumping up/down very fast in response to bounds changes.
 const int kUpdateBoundsDelayMS = 1000;
 
 // The maximum number of times we'll load a non-Instant-supporting search engine
 // before we give up and blacklist it for the rest of the browsing session.
 const int kMaxInstantSupportFailures = 10;
 
 // If an Instant page has not been used in these many milliseconds, it is
 // reloaded so that the page does not become stale.
@@ skipping 196 matching lines @@
   browser_->SetInstantSuggestion(last_suggestion_);
 
   // Though we may have handled a URL match above, we return false here, so that
   // omnibox prerendering can kick in. TODO(sreeram): Remove this (and always
   // return true) once we are able to commit URLs as well.
   return last_match_was_search_;
 }
 
 // TODO(tonyg): This method only fires when the omnibox bounds change. It also
 // needs to fire when the preview bounds change (e.g.: open/close info bar).
-void InstantController::SetOmniboxBounds(const gfx::Rect& bounds) {
-  if (omnibox_bounds_ == bounds)
+void InstantController::SetPopupBounds(const gfx::Rect& bounds) {
+  if (popup_bounds_ == bounds)
     return;
 
-  omnibox_bounds_ = bounds;
-  if (omnibox_bounds_.height() > last_omnibox_bounds_.height()) {
+  popup_bounds_ = bounds;
+  if (popup_bounds_.height() > last_popup_bounds_.height()) {
     update_bounds_timer_.Stop();
     SendBoundsToPage();
   } else if (!update_bounds_timer_.IsRunning()) {
     update_bounds_timer_.Start(FROM_HERE,
         base::TimeDelta::FromMilliseconds(kUpdateBoundsDelayMS), this,
         &InstantController::SendBoundsToPage);
   }
 }
 
+void InstantController::SetMarginSize(int start, int end) {
+  if ((start_margin_ == start && end_margin_ == end) ||
+      model_.preview_state() == InstantModel::NOT_READY ||
+      !GetPreviewContents() || loader_->IsPointerDownFromActivate())
+    return;
+
+  start_margin_ = start;
+  end_margin_ = end;
+  loader_->SetMarginSize(start_margin_, end_margin_);
+}
+
 void InstantController::HandleAutocompleteResults(
     const std::vector<AutocompleteProvider*>& providers) {
   if (mode_ != EXTENDED || !GetPreviewContents())
     return;
 
   std::vector<InstantAutocompleteResult> results;
   for (ACProviders::const_iterator provider = providers.begin();
        provider != providers.end(); ++provider) {
     for (ACMatches::const_iterator match = (*provider)->matches().begin();
          match != (*provider)->matches().end(); ++match) {
@@ skipping 35 matching lines @@
   // correctly after the commit is done.
   if (GetPreviewContents())
     model_.SetPreviewState(InstantModel::NOT_READY, 0, INSTANT_SIZE_PERCENT);
 
   if (GetPreviewContents() && !last_full_text_.empty()) {
     // Send a blank query to ask the preview to clear out old results.
     last_full_text_.clear();
     last_user_text_.clear();
     loader_->Update(last_full_text_, true);
   }
+
+  // Clear the margins so they are set when the preview is shown again.

[samarth, 2012/11/16 22:08:26]

Why is this necessary?

[melevin, 2012/11/16 22:34:43]

When the SearchBox object is created it does not have the bounds set. We need to
clear these here so that the margin-change event goes through and sets them.
Perhaps there is a better way but I could not find any other example of the
SearchBox pulling information from Instant on creation.

[samarth, 2012/11/19 21:42:44]

Take a look at ResetLoader. Whenever we load a new instant page, we send it any
state it expects to have already.

[melevin, 2012/11/20 22:32:20]

I only see the instant URL being communicated to the TabContents in ResetLoader.
It's not clear to me how the page margins would be communicated this way, I
don't think it's right to wire them through the TabContents object.

[samarth, 2012/11/20 22:47:37]

I meant something like
https://cs.corp.google.com/#chrome/src/chrome/browser/instant/instant_control...
where we make sure a fresh instant overlay has the correct context (we used to
also update the omnibox focus state here before that got ripped out completely).

+  start_margin_ = 0;
+  end_margin_ = 0;
 }
 
 bool InstantController::IsCurrent() const {
   return model_.preview_state() == InstantModel::QUERY_RESULTS &&
          GetPreviewContents() &&
          loader_->supports_instant() && last_match_was_search_;
 }
 
 void InstantController::CommitCurrentPreview(InstantCommitType type) {
   TabContents* preview = loader_->ReleasePreviewContents(type, last_full_text_);
@@ skipping 367 matching lines @@
   if (!stale_loader_timer_.IsRunning())
     OnStaleLoader();
 }
 
 void InstantController::DeleteLoader() {
   last_full_text_.clear();
   last_user_text_.clear();
   last_verbatim_ = false;
   last_suggestion_ = InstantSuggestion();
   last_match_was_search_ = false;
-  last_omnibox_bounds_ = gfx::Rect();
+  last_popup_bounds_ = gfx::Rect();
   url_for_history_ = GURL();
   if (GetPreviewContents())
     model_.SetPreviewState(InstantModel::NOT_READY, 0, INSTANT_SIZE_PERCENT);
 
   // Schedule the deletion for later, since we may have gotten here from a call
   // within a |loader_| method (i.e., it's still on the stack). If we deleted
   // the loader immediately, things would still be fine so long as the caller
   // doesn't access any instance members after we return, but why rely on that?
   MessageLoop::current()->DeleteSoon(FROM_HERE, loader_.release());
 }
 
 void InstantController::Show(InstantShownReason reason,
                              int height,
                              InstantSizeUnits units) {
   // Must be on NTP to show NTP content.
   if (reason == INSTANT_SHOWN_CUSTOM_NTP_CONTENT && !active_tab_is_ntp_)
     return;
 
   // Must have updated omnibox after most recent Hide() to show suggestions.
   if (reason == INSTANT_SHOWN_QUERY_SUGGESTIONS &&
       model_.preview_state() == InstantModel::NOT_READY)
     return;
 
   model_.SetPreviewState(GetNewPreviewState(reason), height, units);
 }
 
 void InstantController::SendBoundsToPage() {
-  if (last_omnibox_bounds_ == omnibox_bounds_ ||
+  if (last_popup_bounds_ == popup_bounds_ ||
       model_.preview_state() == InstantModel::NOT_READY ||
       !GetPreviewContents() || loader_->IsPointerDownFromActivate())
     return;
 
-  last_omnibox_bounds_ = omnibox_bounds_;
+  last_popup_bounds_ = popup_bounds_;
   gfx::Rect preview_bounds = browser_->GetInstantBounds();
-  gfx::Rect intersection = gfx::IntersectRects(omnibox_bounds_, preview_bounds);
+  gfx::Rect intersection = gfx::IntersectRects(popup_bounds_, preview_bounds);
 
   // Translate into window coordinates.
   if (!intersection.IsEmpty()) {
     intersection.Offset(-preview_bounds.origin().x(),
                         -preview_bounds.origin().y());
   }
 
   // In the current Chrome UI, these must always be true so they sanity check
   // the above operations. In a future UI, these may be removed or adjusted.
   // There is no point in sanity-checking |intersection.y()| because the omnibox
   // can be placed anywhere vertically relative to the preview (for example, in
   // Mac fullscreen mode, the omnibox is fully enclosed by the preview bounds).
   DCHECK_LE(0, intersection.x());
   DCHECK_LE(0, intersection.width());
   DCHECK_LE(0, intersection.height());
 
-  loader_->SetOmniboxBounds(intersection);
+  loader_->SetPopupBounds(intersection);
 }
 
 bool InstantController::GetInstantURL(const TemplateURL* template_url,
                                       const GURL& tab_url,
                                       std::string* instant_url) const {
   CommandLine* command_line = CommandLine::ForCurrentProcess();
   if (command_line->HasSwitch(switches::kInstantURL)) {
     *instant_url = command_line->GetSwitchValueASCII(switches::kInstantURL);
     return template_url != NULL;
   }
@@ skipping 34 matching lines @@
   }
 
   std::map<std::string, int>::const_iterator iter =
       blacklisted_urls_.find(*instant_url);
   if (iter != blacklisted_urls_.end() &&
       iter->second > kMaxInstantSupportFailures)
     return false;
 
   return true;
 }