Implementation of the UI part of the autofill

webkit/glue/webview_impl.cc

 /*
 * Copyright 2007 Google Inc. All Rights Reserved.
 *
 * Portions Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
 *
 * ***** BEGIN LICENSE BLOCK *****
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
@@ skipping 17 matching lines @@
 *
 * ***** END LICENSE BLOCK *****
 *
 */
 
 #include "config.h"
 #include "build/build_config.h"
 
 #include "base/compiler_specific.h"
 MSVC_PUSH_WARNING_LEVEL(0);
+#include "CSSStyleSelector.h"
 #if defined(OS_WIN)
 #include "Cursor.h"
 #endif
 #include "Document.h"
 #include "DocumentLoader.h"
 #include "DragController.h"
 #include "DragData.h"
 #include "Editor.h"
 #include "EventHandler.h"
 #include "FocusController.h"
 #include "FontDescription.h"
 #include "FrameLoader.h"
 #include "FrameTree.h"
 #include "FrameView.h"
 #include "GraphicsContext.h"
+#include "HTMLNames.h"
+#include "HTMLInputElement.h"
 #include "HitTestResult.h"
 #include "Image.h"
 #include "InspectorController.h"
 #include "IntRect.h"
 #include "KeyboardEvent.h"
 #include "MIMETypeRegistry.h"
 #include "Page.h"
 #include "PlatformKeyboardEvent.h"
 #include "PlatformMouseEvent.h"
 #include "PlatformWheelEvent.h"
 #include "PluginInfoStore.h"
+#include "PopupMenuClient.h"
 #if defined(OS_WIN)
 #include "RenderThemeWin.h"
 #endif
+#include "RenderView.h"
 #include "ResourceHandle.h"
 #include "SelectionController.h"
 #include "Settings.h"
 #include "TypingCommand.h"
 #include "event_conversion.h"
 MSVC_POP_WARNING();
 #undef LOG
 
 #include "base/gfx/rect.h"
 #include "base/logging.h"
@@ skipping 10 matching lines @@
 #include "webkit/glue/inspector_client_impl.h"
 #include "webkit/glue/searchable_form_data.h"
 #include "webkit/glue/webdropdata.h"
 #include "webkit/glue/webhistoryitem_impl.h"
 #include "webkit/glue/webinputevent.h"
 #include "webkit/glue/webkit_glue.h"
 #include "webkit/glue/webpreferences.h"
 #include "webkit/glue/webview_delegate.h"
 #include "webkit/glue/webview_impl.h"
 #include "webkit/glue/webwidget_impl.h"
+#include "webkit/port/platform/chromium/PopupMenuChromium.h"
 #include "webkit/port/platform/graphics/PlatformContextSkia.h"
 
 // Get rid of WTF's pow define so we can use std::pow.
 #undef pow
 #include <cmath> // for std::pow
 
 using namespace WebCore;
 
 // Change the text zoom level by kTextSizeMultiplierRatio each time the user
 // zooms text in or out (ie., change by 20%).  The min and max values limit
 // text zoom to half and 3x the original text size.  These three values match
 // those in Apple's port in WebKit/WebKit/WebView/WebView.mm
 static const double kTextSizeMultiplierRatio = 1.2;
 static const double kMinTextSizeMultiplier = 0.5;
 static const double kMaxTextSizeMultiplier = 3.0;
 
 // The webcore drag operation type when something is trying to be dropped on
 // the webview.  These values are taken from Apple's windows port.
 static const WebCore::DragOperation kDropTargetOperation =
     static_cast<WebCore::DragOperation>(DragOperationCopy | DragOperationLink);
 
+// AutocompletePopupMenuClient
+class AutocompletePopupMenuClient
+    : public RefCounted<AutocompletePopupMenuClient>,
+      public WebCore::PopupMenuClient {
+ public:
+  AutocompletePopupMenuClient(WebViewImpl* webview,
+                              WebCore::HTMLInputElement* text_field,
+                              const std::vector<std::wstring>& suggestions,
+                              int default_suggestion_index)
+      : text_field_(text_field),
+        selected_index_(default_suggestion_index),
+        webview_(webview) {
+    for (std::vector<std::wstring>::const_iterator iter = suggestions.begin();
+         iter != suggestions.end(); ++iter) {
+      suggestions_.push_back(webkit_glue::StdWStringToString(*iter));
+    }
+  }
+  virtual ~AutocompletePopupMenuClient() {
+  }
+
+  virtual void valueChanged(unsigned listIndex, bool fireEvents = true) {
+    text_field_->setValue(suggestions_[listIndex]);
+  }  
+
+  virtual WebCore::String itemText(unsigned list_index) const {
+    return suggestions_[list_index];
+  }
+  
+  virtual bool itemIsEnabled(unsigned listIndex) const {
+    return true;
+  }
+
+  virtual PopupMenuStyle itemStyle(unsigned listIndex) const {
+    return menuStyle();
+  }
+
+  virtual PopupMenuStyle menuStyle() const {
+    RenderStyle* style = text_field_->renderStyle() ?
+                            text_field_->renderStyle() :
+                            text_field_->computedStyle();
+    return PopupMenuStyle(style->color(), Color::white, style->font(),
+                          style->visibility() == VISIBLE);
+  }
+
+  virtual int clientInsetLeft() const {
+    return 0;
+  }
+  virtual int clientInsetRight() const {
+    return 0;
+  }
+  virtual int clientPaddingLeft() const {
+#if defined(OS_WIN)
+    return theme()->popupInternalPaddingLeft(text_field_->computedStyle());
+#else
+    NOTIMPLEMENTED();
+    return 0;
+#endif
+  }
+  virtual int clientPaddingRight() const {
+#if defined(OS_WIN)
+    return theme()->popupInternalPaddingRight(text_field_->computedStyle());
+#else
+    NOTIMPLEMENTED();
+    return 0;
+#endif
+  }
+  virtual int listSize() const {
+    return suggestions_.size();
+  }
+  virtual int selectedIndex() const {
+    return selected_index_;
+  }
+  virtual void hidePopup() {
+    webview_->HideAutoCompletePopup();
+  }
+  virtual bool itemIsSeparator(unsigned listIndex) const {
+    return false;
+  }
+  virtual bool itemIsLabel(unsigned listIndex) const {
+    return false;
+  }
+  virtual bool itemIsSelected(unsigned listIndex) const {
+    return false;
+  }
+  virtual bool shouldPopOver() const {
+    return false;
+  }
+  virtual bool valueShouldChangeOnHotTrack() const {
+    return false;
+  }
+
+  virtual FontSelector* fontSelector() const {
+    return text_field_->document()->styleSelector()->fontSelector();
+  }
+
+  virtual void setTextFromItem(unsigned listIndex) {
+    text_field_->setValue(suggestions_[listIndex]);
+  }
+
+  virtual HostWindow* hostWindow() const {
+    return text_field_->document()->view()->hostWindow();
+  }
+
+  virtual PassRefPtr<Scrollbar> createScrollbar(
+      ScrollbarClient* client,
+      ScrollbarOrientation orientation,
+      ScrollbarControlSize size) {
+    RefPtr<Scrollbar> widget = Scrollbar::createNativeScrollbar(client, 
+                                                                orientation,
+                                                                size);
+    return widget.release();
+  }
+
+ private:
+  RefPtr<WebCore::HTMLInputElement> text_field_;
+  std::vector<WebCore::String> suggestions_;
+  int selected_index_;
+  WebViewImpl* webview_;
+};
+
 // WebView ----------------------------------------------------------------
 
 /*static*/
 WebView* WebView::Create(WebViewDelegate* delegate,
                          const WebPreferences& prefs) {
   WebViewImpl* instance = new WebViewImpl();
   instance->AddRef();
   instance->SetPreferences(prefs);
   instance->main_frame_->InitMainFrame(instance);
   // Set the delegate after initializing the main frame, to avoid trying to
@@ skipping 157 matching lines @@
          (event.type == WebInputEvent::KEY_UP));
 
   // Please refer to the comments explaining the suppress_next_keypress_event_
   // member.
   // The suppress_next_keypress_event_ is set if the KeyDown is handled by
   // Webkit. A keyDown event is typically associated with a keyPress(char)
   // event and a keyUp event. We reset this flag here as this is a new keyDown
   // event.
   suppress_next_keypress_event_ = false;
 
+  // Give autocomplete a chance to consume the key events it is interested in.
+  if (autocomplete_popup_ &&
+      autocomplete_popup_->isInterestedInEventForKey(event.key_code)) {
+    if (autocomplete_popup_->handleKeyEvent(MakePlatformKeyboardEvent(event)))
+      return true;
+    return false;
+  }
+
+  // A new key being pressed should hide the popup.
+  if (event.type == WebInputEvent::KEY_DOWN)
+    HideAutoCompletePopup();
+
   Frame* frame = GetFocusedWebCoreFrame();
   if (!frame)
     return false;
 
   EventHandler* handler = frame->eventHandler();
   if (!handler)
     return KeyEventDefault(event);
 
 #if defined(OS_WIN)
   // TODO(pinkerton): figure out these keycodes on non-windows
@@ skipping 402 matching lines @@
 // TODO(eseidel): g_current_input_event should be removed once
 // ChromeClient:show() can get the current-event information from WebCore.
 /* static */
 const WebInputEvent* WebViewImpl::g_current_input_event = NULL;
 
 bool WebViewImpl::HandleInputEvent(const WebInputEvent* input_event) {
   // If we've started a drag and drop operation, ignore input events until
   // we're done.
   if (doing_drag_and_drop_)
     return true;
-
   // TODO(eseidel): Remove g_current_input_event.
   // This only exists to allow ChromeClient::show() to know which mouse button
   // triggered a window.open event.
   // Safari must perform a similar hack, ours is in our WebKit glue layer
   // theirs is in the application.  This should go when WebCore can be fixed
   // to pass more event information to ChromeClient::show()
   g_current_input_event = input_event;
 
   bool handled = true;
 
@@ skipping 47 matching lines @@
 void WebViewImpl::StopLoading() {
   main_frame_->StopLoading();
 }
 
 void WebViewImpl::SetBackForwardListSize(int size) {
   page_->backForwardList()->setCapacity(size);
 }
 
 void WebViewImpl::SetFocus(bool enable) {
   if (enable) {
+    // Hide the popup menu if any.
+    // TODO(jcampan): bug #3844: we should do that when we lose focus.  The
+    // reason we are not doing it is because when clicking on the autofill
+    // popup, the page first loses focus before the mouse click is sent to the
+    // popup.  So if we close when the focus is lost, the mouse click does not
+    // do anything.
+    HideAutoCompletePopup();
+
     // Getting the focused frame will have the side-effect of setting the main
     // frame as the focused frame if it is not already focused.  Otherwise, if
     // there is already a focused frame, then this does nothing.
     GetFocusedFrame();
     if (main_frame_ && main_frame_->frame()) {
       Frame* frame = main_frame_->frame();
       if (!frame->selection()->isFocusedAndActive()) {
         // No one has focus yet, try to restore focus.
         RestoreFocus();
         frame->page()->focusController()->setActive(true);
       }
       Frame* focused_frame =
           frame->page()->focusController()->focusedOrMainFrame();
       frame->selection()->setFocused(frame == focused_frame);
     }
     ime_accept_events_ = true;
   } else {
     // Clear out who last had focus. If someone has focus, the refs will be
     // updated below.
     ReleaseFocusReferences();
 
-    // Clear focus on the currently focused frame if any.
-
     if (!main_frame_)
       return;
 
     Frame* frame = main_frame_->frame();
     if (!frame)
       return;
 
     RefPtr<Frame> focused = frame->page()->focusController()->focusedFrame();
     if (focused.get()) {
       // Update the focus refs, this way we can give focus back appropriately.
@@ skipping 195 matching lines @@
     WebKeyboardEvent keyboard_event;
     keyboard_event.type = WebInputEvent::KEY_DOWN;
     if (reverse)
       keyboard_event.modifiers = WebInputEvent::SHIFT_KEY;
     // VK_TAB which is only defined on Windows.
     keyboard_event.key_code = 0x09;
     MakePlatformKeyboardEvent platform_event(keyboard_event);
     // We have to set the key type explicitly to avoid an assert in the
     // KeyboardEvent constructor.
     platform_event.SetKeyType(PlatformKeyboardEvent::RawKeyDown);
-    RefPtr<KeyboardEvent> webkit_event = KeyboardEvent::create(platform_event, NULL);
+    RefPtr<KeyboardEvent> webkit_event = KeyboardEvent::create(platform_event,
+                                                               NULL);
     page()->focusController()->setInitialFocus(
         reverse ? WebCore::FocusDirectionBackward :
                   WebCore::FocusDirectionForward,
         webkit_event.get());
   }
 }
 
 bool WebViewImpl::FocusedFrameNeedsSpellchecking() {
   const WebCore::Frame* frame = GetFocusedWebCoreFrame();
   if (!frame)
@@ skipping 292 matching lines @@
       if (focused_node.get() &&
           focused_node->nodeType() == Node::ELEMENT_NODE) {
         return SearchableFormData::Create(
           static_cast<Element*>(focused_node.get()));
       }
     }
   }
   return NULL;
 }
 
+void WebViewImpl::AutofillSuggestionsForNode(
+      int64 node_id,
+      const std::vector<std::wstring>& suggestions,
+      int default_suggestion_index) {
+  if (!main_frame_ || suggestions.empty())
+    return;
+
+  DCHECK(default_suggestion_index < static_cast<int>(suggestions.size()));
+
+  Frame* frame = main_frame_->frame();
+  if (!frame)
+    return;
+
+  if (RefPtr<Frame> focused =
+      frame->page()->focusController()->focusedFrame()) {
+    RefPtr<Document> document = focused->document();
+    if (!document.get())
+      return;
+
+    RefPtr<Node> focused_node = document->focusedNode();
+    // If the node for which we queried the autofill suggestions is not the
+    // focused node, then we have nothing to do.
+    // TODO(jcampan): also check the carret is at the end and that the text has
+    // not changed.
+    if (!focused_node.get() ||
+        reinterpret_cast<int64>(focused_node.get()) != node_id)
+      return;
+
+    if (!focused_node->hasTagName(WebCore::HTMLNames::inputTag)) {
+      NOTREACHED();
+      return;
+    }
+
+    WebCore::HTMLInputElement* input_elem =
+        static_cast<WebCore::HTMLInputElement*>(focused_node.get());
+    // Hide any current autocomplete popup.
+    HideAutoCompletePopup();
+
+    if (suggestions.size() > 0) {
+      autocomplete_popup_client_ =
+          adoptRef(new AutocompletePopupMenuClient(this, input_elem,
+                                                   suggestions,
+                                                   default_suggestion_index));
+      // Autocomplete popup does not get focused.  We need the page to still
+      // have focus so the user can keep typing when the popup is showing.
+      autocomplete_popup_ =
+          WebCore::PopupContainer::create(autocomplete_popup_client_.get(),
+                                          false);
+      autocomplete_popup_->show(focused_node->getRect(), frame->view(), 0);
+    }
+  }
+}
+
 void WebViewImpl::DidCommitLoad(bool* is_new_navigation) {
   if (is_new_navigation)
     *is_new_navigation = observed_new_navigation_;
 
 #ifndef NDEBUG
   DCHECK(!observed_new_navigation_ ||
     main_frame_->frame()->loader()->documentLoader() == new_navigation_loader_);
   new_navigation_loader_ = NULL;
 #endif
   observed_new_navigation_ = false;
@@ skipping 128 matching lines @@
 }
 
 void WebViewImpl::DeleteImageResourceFetcher(ImageResourceFetcher* fetcher) {
   DCHECK(image_fetchers_.find(fetcher) != image_fetchers_.end());
   image_fetchers_.erase(fetcher);
 
   // We're in the callback from the ImageResourceFetcher, best to delay
   // deletion.
   MessageLoop::current()->DeleteSoon(FROM_HERE, fetcher);
 }
+
+void WebViewImpl::HideAutoCompletePopup() {
+  if (autocomplete_popup_) {
+    autocomplete_popup_->hidePopup();
+    autocomplete_popup_.clear();
+    autocomplete_popup_client_.clear();
+  }
+}