Migrate accessibility from RenderView to RenderFrame.

content/browser/frame_host/render_frame_host_impl.h

 // Copyright 2013 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 CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_IMPL_H_
 #define CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_IMPL_H_
 
 #include <map>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "base/memory/weak_ptr.h"
 #include "base/strings/string16.h"
 #include "base/time/time.h"
+#include "content/browser/accessibility/browser_accessibility_manager.h"
+#include "content/common/accessibility_mode_enums.h"
 #include "content/common/content_export.h"
 #include "content/common/mojo/service_registry_impl.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/common/javascript_message_type.h"
 #include "content/public/common/page_transition_types.h"
 #include "third_party/WebKit/public/web/WebTextDirection.h"
+#include "ui/accessibility/ax_node_data.h"
 
 class GURL;
+struct AccessibilityHostMsg_EventParams;
+struct AccessibilityHostMsg_LocationChangeParams;
 struct FrameHostMsg_DidFailProvisionalLoadWithError_Params;
 struct FrameHostMsg_OpenURL_Params;
 struct FrameMsg_Navigate_Params;
 
 namespace base {
 class FilePath;
 class ListValue;
 }
 
 namespace content {
 
 class CrossProcessFrameConnector;
 class CrossSiteTransferringRequest;
 class FrameTree;
 class FrameTreeNode;
 class RenderFrameHostDelegate;
 class RenderFrameProxyHost;
 class RenderProcessHost;
 class RenderViewHostImpl;
 class RenderWidgetHostImpl;
 struct ContextMenuParams;
 struct GlobalRequestID;
 struct Referrer;
 struct ShowDesktopNotificationHostMsgParams;
 
-class CONTENT_EXPORT RenderFrameHostImpl : public RenderFrameHost {
+class CONTENT_EXPORT RenderFrameHostImpl
+    : public RenderFrameHost,
+      public BrowserAccessibilityDelegate {
  public:
   static RenderFrameHostImpl* FromID(int process_id, int routing_id);
 
   virtual ~RenderFrameHostImpl();
 
   // RenderFrameHost
   virtual int GetRoutingID() OVERRIDE;
   virtual SiteInstance* GetSiteInstance() OVERRIDE;
   virtual RenderProcessHost* GetProcess() OVERRIDE;
   virtual RenderFrameHost* GetParent() OVERRIDE;
   virtual const std::string& GetFrameName() OVERRIDE;
   virtual bool IsCrossProcessSubframe() OVERRIDE;
   virtual GURL GetLastCommittedURL() OVERRIDE;
   virtual gfx::NativeView GetNativeView() OVERRIDE;
   virtual void ExecuteJavaScript(
       const base::string16& javascript) OVERRIDE;
   virtual void ExecuteJavaScript(
       const base::string16& javascript,
       const JavaScriptResultCallback& callback) OVERRIDE;
   virtual RenderViewHost* GetRenderViewHost() OVERRIDE;
   virtual ServiceRegistry* GetServiceRegistry() OVERRIDE;
 
   // IPC::Sender
   virtual bool Send(IPC::Message* msg) OVERRIDE;
 
   // IPC::Listener
   virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
 
+  // BrowserAccessibilityDelegate
+  virtual void AccessibilitySetFocus(int acc_obj_id) OVERRIDE;
+  virtual void AccessibilityDoDefaultAction(int acc_obj_id) OVERRIDE;
+  virtual void AccessibilityShowMenu(const gfx::Point& point) OVERRIDE;
+  virtual void AccessibilityScrollToMakeVisible(
+      int acc_obj_id, gfx::Rect subfocus) OVERRIDE;

[ncarter (slow), 2014/07/15 01:23:28]

Probably worth passing the gfx::Rect as a const ref.

[dmazzoni, 2014/07/15 07:55:04]

Done.

+  virtual void AccessibilityScrollToPoint(
+      int acc_obj_id, gfx::Point point) OVERRIDE;
+  virtual void AccessibilitySetTextSelection(
+      int acc_obj_id, int start_offset, int end_offset) OVERRIDE;
+  virtual bool AccessibilityViewHasFocus() const OVERRIDE;
+  virtual gfx::Rect AccessibilityGetViewBounds() const OVERRIDE;
+  virtual gfx::Point AccessibilityOriginInScreen(const gfx::Rect& bounds)
+      const OVERRIDE;
+  virtual void AccessibilityHitTest(const gfx::Point& point) OVERRIDE;
+  virtual void AccessibilityFatalError() OVERRIDE;
+
   void Init();
   int routing_id() const { return routing_id_; }
   void OnCreateChildFrame(int new_routing_id,
                           const std::string& frame_name);
 
   RenderViewHostImpl* render_view_host() { return render_view_host_; }
   RenderFrameHostDelegate* delegate() { return delegate_; }
   FrameTreeNode* frame_tree_node() { return frame_tree_node_; }
   // TODO(nasko): The RenderWidgetHost will be owned by RenderFrameHost in
   // the future, so update this accessor to return the right pointer.
@@ skipping 83 matching lines @@
                               bool dialog_was_suppressed);
 
   // Called when an HTML5 notification is closed.
   void NotificationClosed(int notification_id);
 
   // Sets whether there is an outstanding transition request. This is called at
   // the start of a provisional load for the main frame, and cleared when we
   // hear the response or commit.
   void SetHasPendingTransitionRequest(bool has_pending_request);
 
+  // Gets the accessibility mode.
+  AccessibilityMode accessibility_mode() const {
+    return accessibility_mode_;

[David Tseng, 2014/07/14 19:08:02]

Does each frame get its own accessibility mode? If so (as it seems like it is
here), then the comment in the delegate seems incorrect.

Automation can be adapted to ensure the mode gets set on a per tab (all
subframes would have to be set when encountered).

Do we foresee some time in the future where this would be useful? If not, then I
think we should just keep one accessibility mode on the top level frame?

[dmazzoni, 2014/07/15 07:55:04]

This change already made the WebContents have the only authoritative mode. You
made me realize that there's no reason to cache it here. I replaced the few
places where we used accessibility_mode() or accessibility_mode_ with
delegate_->GetAccessibilityMode().

+  }
+
+  // Send a message to the renderer process to change the accessibility mode.
+  void SetAccessibilityMode(AccessibilityMode AccessibilityMode);
+
+  // Turn on accessibility testing. The given callback will be run
+  // every time an accessibility notification is received from the
+  // renderer process, and the accessibility tree it sent can be
+  // retrieved using GetAXTreeForTesting().

[David Tseng, 2014/07/14 19:08:02]

Why not just pass the ax tree as a param of the callback and get rid of the
other test method?

[dmazzoni, 2014/07/15 07:55:04]

Often the callback is used by the accessibility waiter, and the ax tree is
retrieved directly by the test.

None of this is changing in this changelist, it's just moving.

+  void SetAccessibilityCallbackForTesting(
+      const base::Callback<void(ui::AXEvent, int)>& callback);
+
+  // Returns a snapshot of the accessibility tree received from the
+  // renderer as of the last time an accessibility notification was
+  // received.
+  const ui::AXTree* GetAXTreeForTesting();

[David Tseng, 2014/07/14 19:08:02]

Not really needed; see above.

+
+  // Access the BrowserAccessibilityManager if it already exists.
+  BrowserAccessibilityManager* browser_accessibility_manager() const {

[David Tseng, 2014/07/14 19:08:02]

How do you feel about naming this RenderFrameHostAccessibilityManager (or some
variation of that)?

[dmazzoni, 2014/07/15 07:55:04]

I was thinking FrameAccessibility or FrameHostAccessibility.

Not in this change, but definitely up for that.

+    return browser_accessibility_manager_.get();
+  }
+
+  // If accessibility is enabled, get the BrowserAccessibilityManager for
+  // this frame, or create one if it doesn't exist yet, otherwise return
+  // NULL.
+  BrowserAccessibilityManager* GetOrCreateBrowserAccessibilityManager();
+
+#if defined(OS_WIN)
+  void SetParentNativeViewAccessible(
+      gfx::NativeViewAccessible accessible_parent);
+  gfx::NativeViewAccessible GetParentNativeViewAccessible() const;
+#endif
+
  protected:
   friend class RenderFrameHostFactory;
 
   // TODO(nasko): Remove dependency on RenderViewHost here. RenderProcessHost
   // should be the abstraction needed here, but we need RenderViewHost to pass
   // into WebContentsObserver::FrameDetached for now.
   RenderFrameHostImpl(RenderViewHostImpl* render_view_host,
                       RenderFrameHostDelegate* delegate,
                       FrameTree* frame_tree,
                       FrameTreeNode* frame_tree_node,
@@ skipping 48 matching lines @@
   void OnCancelDesktopNotification(int notification_id);
   void OnTextSurroundingSelectionResponse(const base::string16& content,
                                           size_t start_offset,
                                           size_t end_offset);
   void OnDidAccessInitialDocument();
   void OnDidDisownOpener();
   void OnUpdateTitle(int32 page_id,
                      const base::string16& title,
                      blink::WebTextDirection title_direction);
   void OnUpdateEncoding(const std::string& encoding);
+  void OnAccessibilityEvents(
+      const std::vector<AccessibilityHostMsg_EventParams>& params);
+  void OnAccessibilityLocationChanges(
+      const std::vector<AccessibilityHostMsg_LocationChangeParams>& params);
 
   // Returns whether the given URL is allowed to commit in the current process.
   // This is a more conservative check than RenderProcessHost::FilterURL, since
   // it will be used to kill processes that commit unauthorized URLs.
   bool CanCommitURL(const GURL& url);
 
   void DesktopNotificationPermissionRequestDone(int callback_context);
 
   // For now, RenderFrameHosts indirectly keep RenderViewHosts alive via a
   // refcount that calls Shutdown when it reaches zero.  This allows each
@@ skipping 41 matching lines @@
   int routing_id_;
   bool is_swapped_out_;
 
   // When the last BeforeUnload message was sent.
   base::TimeTicks send_before_unload_start_time_;
 
   ServiceRegistryImpl service_registry_;
 
   base::WeakPtrFactory<RenderFrameHostImpl> weak_ptr_factory_;
 
+  AccessibilityMode accessibility_mode_;
+  base::Callback<void(ui::AXEvent, int)> accessibility_testing_callback_;
+  // The most recently received accessibility tree - for testing only.

[David Tseng, 2014/07/14 19:08:02]

Are we ok with test only members?

[ncarter (slow), 2014/07/15 01:23:28]

I also would rather we not have test-only members, but in this patch the
test-only member is just moving from one spot to another, so I don't consider it
at issue.

[dmazzoni, 2014/07/15 07:55:04]

Yeah, I'm happy to work on ways to do this without test-only members other than
maybe the callback, in a future change.

+  scoped_ptr<ui::AXTree> ax_tree_for_testing_;
+  scoped_ptr<BrowserAccessibilityManager> browser_accessibility_manager_;

[David Tseng, 2014/07/14 19:08:02]

Seems like test members should go last?

[dmazzoni, 2014/07/15 07:55:04]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(RenderFrameHostImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_IMPL_H_