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

chrome/browser/instant/instant_controller.cc

 // 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.
 
 #include "chrome/browser/instant/instant_controller.h"
 
 #include "base/command_line.h"
 #include "base/metrics/histogram.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
@@ skipping 135 matching lines @@
                                      bool extended_enabled)
     : browser_(browser),
       extended_enabled_(extended_enabled),
       instant_enabled_(false),
       model_(ALLOW_THIS_IN_INITIALIZER_LIST(this)),
       last_omnibox_text_has_inline_autocompletion_(false),
       last_verbatim_(false),
       last_transition_type_(content::PAGE_TRANSITION_LINK),
       last_match_was_search_(false),
       is_omnibox_focused_(false),
+      start_margin_(0),
+      end_margin_(0),
       allow_preview_to_show_search_suggestions_(false) {
 }
 
 InstantController::~InstantController() {
 }
 
 bool InstantController::Update(const AutocompleteMatch& match,
                                const string16& user_text,
                                const string16& full_text,
                                size_t selection_start,
@@ skipping 171 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) {
+void InstantController::SetPopupBounds(const gfx::Rect& bounds) {
   if (!extended_enabled_ && !instant_enabled_)
     return;
 
-  if (omnibox_bounds_ == 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();
+    SendPopupBoundsToPage();
   } else if (!update_bounds_timer_.IsRunning()) {
     update_bounds_timer_.Start(FROM_HERE,
         base::TimeDelta::FromMilliseconds(kUpdateBoundsDelayMS), this,
-        &InstantController::SendBoundsToPage);
+        &InstantController::SendPopupBoundsToPage);
   }
 }
 
+void InstantController::SetMarginSize(int start, int end) {
+  if (!extended_enabled_ || (start_margin_ == start && end_margin_ == end) ||
+      !GetPreviewContents())
+    return;

[sreeram, 2012/12/05 00:14:46]

The margin should be sent to committed tabs too. Instead of trying to wrangle
which should be used, I'd just send it to both:

if (!extended_enabled_ || (start_margin_ == ...))
  return;

start_margin_ = start;
end_margin_ = end;

if (loader_)
  loader_->SetMarginSize(...);
if (instant_tab_)
  instant_tab_->SetMarginSize(...);

[melevin, 2012/12/06 23:13:00]

Done.

+
+  start_margin_ = start;
+  end_margin_ = end;
+  loader_->SetMarginSize(start_margin_, end_margin_);
+}
+
 void InstantController::HandleAutocompleteResults(
     const std::vector<AutocompleteProvider*>& providers) {
   if (!extended_enabled_)
     return;
 
   if (!instant_tab_ && !loader_)
     return;
 
   DVLOG(1) << "AutocompleteResults:";
   std::vector<InstantAutocompleteResult> results;
@@ skipping 391 matching lines @@
 
   HideInternal();
   loader_.reset(new InstantLoader(this, instant_url));
   loader_->InitContents(active_tab);
 
   // Ensure the searchbox API has the correct initial state.
   if (extended_enabled_) {
     browser_->UpdateThemeInfoForPreview();
     loader_->SetDisplayInstantResults(instant_enabled_);
     loader_->SearchModeChanged(search_mode_);
+    loader_->SetMarginSize(start_margin_, end_margin_);
   }
 
   // Restart the stale loader timer.
   stale_loader_timer_.Start(FROM_HERE,
       base::TimeDelta::FromMilliseconds(kStaleLoaderTimeoutMS), this,
       &InstantController::OnStaleLoader);
 
   return true;
 }
 
@@ skipping 19 matching lines @@
     loader_.reset();
     CreateDefaultLoader();
   }
 }
 
 void InstantController::ResetInstantTab() {
   if (search_mode_.is_origin_search()) {
     content::WebContents* active_tab = browser_->GetActiveWebContents();
     if (!instant_tab_ || active_tab != instant_tab_->contents()) {
       instant_tab_.reset(new InstantTab(this, active_tab));
       instant_tab_->Init();

[sreeram, 2012/12/05 00:14:46]

Similar to ResetLoader(), you should do this here:
  instant_tab_->SetMarginSize(...);

[melevin, 2012/12/06 23:13:00]

Added this but I'm not sure what it's doing. Once the page is committed, the
start/end margin remain inaccessible. Do we want these values to be accessible
after commit?

[samarth, 2012/12/07 01:44:49]

Yes, why not?  Search pages can be committed and they should have access to the
current values for the margins.  In the future, the NTP will be committed too.

[melevin, 2012/12/08 00:04:09]

Oops, it wasn't working due to a copy-paste error. Fixed and working now.

     }
 
     // Hide the |loader_| since we are now using |instant_tab_| instead.
     HideLoader();
   } else {
     instant_tab_.reset();
   }
 }
 
 bool InstantController::ResetLoaderForMatch(const AutocompleteMatch& match) {
@@ skipping 90 matching lines @@
   //   already showing at 100% height.
   bool is_full_height = model_.height() == 100 &&
                         model_.height_units() == INSTANT_SIZE_PERCENT;
   if (!instant_enabled_ || reason == INSTANT_SHOWN_CUSTOM_NTP_CONTENT ||
       (search_mode_.is_origin_default() && !is_full_height))
     model_.SetPreviewState(search_mode_, height, units);
   else
     model_.SetPreviewState(search_mode_, 100, INSTANT_SIZE_PERCENT);
 }
 
-void InstantController::SendBoundsToPage() {
+void InstantController::SendPopupBoundsToPage() {
   if (last_omnibox_bounds_ == omnibox_bounds_ || !loader_ ||

[sreeram, 2012/12/05 00:14:46]

Shouldn't this be "last_popup_bounds_ == popup_bounds_"?

[melevin, 2012/12/06 23:13:00]

Done.

       loader_->is_pointer_down_from_activate())
     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,
                                       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 33 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;
 }