Simplifying renderer focus management

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 362 matching lines @@
 
   page_->backForwardList()->setClient(&back_forward_list_client_impl_);
 
   // The group name identifies a namespace of pages.  I'm not sure how it's
   // intended to be used, but keeping all pages in the same group works for us.
   page_->setGroupName("default");
 }
 
 WebViewImpl::~WebViewImpl() {
   DCHECK(page_ == NULL);
-  ReleaseFocusReferences();
   for (std::set<ImageResourceFetcher*>::iterator i = image_fetchers_.begin();
        i != image_fetchers_.end(); ++i) {
     delete *i;
   }
 }
 
 RenderTheme* WebViewImpl::theme() const {
   return page_.get() ? page_->theme() : RenderTheme::defaultTheme().get();
 }
 
@@ skipping 697 matching lines @@
 
 void WebViewImpl::StopLoading() {
   main_frame()->StopLoading();
 }
 
 void WebViewImpl::SetBackForwardListSize(int size) {
   page_->backForwardList()->setCapacity(size);
 }
 
 void WebViewImpl::ClearFocusedNode() {
-  // Get the last focused frame or the mainframe.
-  RefPtr<Frame> frame = last_focused_frame_;
-  if (!frame.get() && page_.get())
-    frame = page_->mainFrame();
+  if (!page_.get())
+    return;
+
+  RefPtr<Frame> frame = page_->mainFrame();
   if (!frame.get())
     return;
 
   RefPtr<Document> document = frame->document();
   if (!document.get())
     return;
 
   RefPtr<Node> old_focused_node = document->focusedNode();
 
   // Clear the focused node.
   document->setFocusedNode(NULL);
 
   if (!old_focused_node.get())
     return;
 
   // If a text field has focus, we need to make sure the selection controller
   // knows to remove selection from it. Otherwise, the text field is still
   // processing keyboard events even though focus has been moved to the page and
   // keystrokes get eaten as a result.
   if (old_focused_node->hasTagName(HTMLNames::textareaTag) ||
       (old_focused_node->hasTagName(HTMLNames::inputTag) &&
        static_cast<HTMLInputElement*>(old_focused_node.get())->isTextField())) {
     // Clear the selection.
     SelectionController* selection = frame->selection();
     selection->clear();
   }
 }
 
 void WebViewImpl::SetFocus(bool enable) {
+  page_->focusController()->setFocused(enable);
   if (enable) {
-    // 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 (page_.get() && page_->mainFrame()) {
-      Frame* frame = page_->mainFrame();
-      if (!frame->selection()->isFocusedAndActive()) {
-        // No one has focus yet, try to restore focus.
-        RestoreFocus();
-        page_->focusController()->setActive(true);
-      }
-      Frame* focused_frame = page_->focusController()->focusedOrMainFrame();
-      frame->selection()->setFocused(frame == focused_frame);
-    }
+    // Note that we don't call setActive() when disabled as this cause extra
+    // focus/blur events to be dispatched.
+    page_->focusController()->setActive(true);
     ime_accept_events_ = true;
   } else {
     HideAutoCompletePopup();
 
-    // 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 (!page_.get())
       return;
 
     Frame* frame = page_->mainFrame();
     if (!frame)
       return;
 
-    RefPtr<Frame> focused = page_->focusController()->focusedFrame();
-    if (focused.get()) {
-      // Update the focus refs, this way we can give focus back appropriately.
-      // It's entirely possible to have a focused document, but not a focused
-      // node.
-      RefPtr<Document> document = focused->document();
-      last_focused_frame_ = focused;
-      if (document.get()) {
-        RefPtr<Node> focused_node = document->focusedNode();
-        if (focused_node.get()) {
-          // To workaround bug #792423, we do not blur the focused node.  This
-          // should be reenabled when we merge a WebKit that has the fix for
-          // http://bugs.webkit.org/show_bug.cgi?id=16928.
-          // last_focused_node_ = focused_node;
-          // document->setFocusedNode(NULL);
-        }
-      }
-      page_->focusController()->setFocusedFrame(0);
-
+    RefPtr<Frame> focused_frame = page_->focusController()->focusedFrame();
+    if (focused_frame.get()) {
       // Finish an ongoing composition to delete the composition node.
-      Editor* editor = focused->editor();
+      Editor* editor = focused_frame->editor();
       if (editor && editor->hasComposition())
         editor->confirmComposition();
       ime_accept_events_ = false;
     }
-    // Make sure the main frame doesn't think it has focus.
-    if (frame != focused.get())
-      frame->selection()->setFocused(false);
-  }
-}
-
-// TODO(jcampan): http://b/issue?id=1157486 this is needed to work-around
-// issues caused by the fix for bug #792423 and should be removed when that
-// bug is fixed.
-void WebViewImpl::StoreFocusForFrame(WebFrame* frame) {
-  DCHECK(frame);
-
-  // We only want to store focus info if we are the focused frame and if we have
-  // not stored it already.
-  WebCore::Frame* webcore_frame = static_cast<WebFrameImpl*>(frame)->frame();
-  if (last_focused_frame_.get() != webcore_frame || last_focused_node_.get())
-    return;
-
-  // Clear out who last had focus. If someone has focus, the refs will be
-  // updated below.
-  ReleaseFocusReferences();
-
-  last_focused_frame_ = webcore_frame;
-  RefPtr<Document> document = last_focused_frame_->document();
-  if (document.get()) {
-    RefPtr<Node> focused_node = document->focusedNode();
-    if (focused_node.get()) {
-      last_focused_node_ = focused_node;
-      document->setFocusedNode(NULL);
-    }
   }
 }
 
 bool WebViewImpl::ImeSetComposition(int string_type,
                                     int cursor_position,
                                     int target_start,
                                     int target_end,
                                     const std::wstring& ime_string) {
   Frame* focused = GetFocusedWebCoreFrame();
   if (!focused || !ime_accept_events_) {
@@ skipping 133 matching lines @@
     case WEB_TEXT_DIRECTION_RTL:
       editor->setBaseWritingDirection(WebCore::RightToLeftWritingDirection);
       break;
 
     default:
       NOTIMPLEMENTED();
       break;
   }
 }
 
-void WebViewImpl::RestoreFocus() {
-  if (last_focused_frame_.get()) {
-    if (last_focused_frame_->page()) {
-      // last_focused_frame_ can be detached from the frame tree, thus,
-      // its page can be null.
-      last_focused_frame_->page()->focusController()->setFocusedFrame(
-        last_focused_frame_.get());
-    }
-    if (last_focused_node_.get()) {
-      // last_focused_node_ may be null, make sure it's valid before trying to
-      // focus it.
-      static_cast<Element*>(last_focused_node_.get())->focus();
-    }
-    // And clear out the refs.
-    ReleaseFocusReferences();
-  }
-}
-
 void WebViewImpl::SetInitialFocus(bool reverse) {
   if (page_.get()) {
-    // So RestoreFocus does not focus anything when it is called.
-    ReleaseFocusReferences();
-
     // Since we don't have a keyboard event, we'll create one.
     WebKeyboardEvent keyboard_event;
     keyboard_event.type = WebInputEvent::RawKeyDown;
     if (reverse)
       keyboard_event.modifiers = WebInputEvent::ShiftKey;
     // VK_TAB which is only defined on Windows.
     keyboard_event.windowsKeyCode = 0x09;
     MakePlatformKeyboardEvent platform_event(keyboard_event);
     RefPtr<KeyboardEvent> webkit_event =
         KeyboardEvent::create(platform_event, NULL);
     page()->focusController()->setInitialFocus(
         reverse ? WebCore::FocusDirectionBackward :
                   WebCore::FocusDirectionForward,
         webkit_event.get());
   }
 }
 
-// Releases references used to restore focus.
-void WebViewImpl::ReleaseFocusReferences() {
-  if (last_focused_frame_.get()) {
-    last_focused_frame_.release();
-    last_focused_node_.release();
-  }
-}
-
 bool WebViewImpl::DownloadImage(int id, const GURL& image_url, int image_size) {
   if (!page_.get())
     return false;
   image_fetchers_.insert(
       new ImageResourceFetcher(this, id, image_url, image_size));
   return true;
 }
 
 void WebViewImpl::SetPreferences(const WebPreferences& preferences) {
   if (!page_.get())
@@ skipping 510 matching lines @@
 
   return document->focusedNode();
 }
 
 HitTestResult WebViewImpl::HitTestResultForWindowPos(const IntPoint& pos) {
   IntPoint doc_point(
       page_->mainFrame()->view()->windowToContents(pos));
   return page_->mainFrame()->eventHandler()->
       hitTestResultAtPoint(doc_point, false);
 }