Defect 248426: Speak rendered text when no selection is made on Mac

content/browser/renderer_host/render_widget_host_view_mac.mm

 // 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 "content/browser/renderer_host/render_widget_host_view_mac.h"
 
 #import <objc/runtime.h>
 #include <OpenGL/gl.h>
 #include <QuartzCore/QuartzCore.h>
 
@@ skipping 148 matching lines @@
 - (void)processedWheelEvent:(const blink::WebMouseWheelEvent&)event
                    consumed:(BOOL)consumed;
 
 - (void)keyEvent:(NSEvent*)theEvent wasKeyEquivalent:(BOOL)equiv;
 - (void)windowDidChangeBackingProperties:(NSNotification*)notification;
 - (void)windowChangedGlobalFrame:(NSNotification*)notification;
 - (void)checkForPluginImeCancellation;
 - (void)updateScreenProperties;
 - (void)setResponderDelegate:
         (NSObject<RenderWidgetHostViewMacDelegate>*)delegate;
+- (void)speakText:(NSString*)text;
 @end
 
 // A window subclass that allows the fullscreen window to become main and gain
 // keyboard focus. This is only used for pepper flash. Normal fullscreen is
 // handled by the browser.
 @interface PepperFlashFullscreenWindow : UnderlayOpenGLHostingWindow
 @end
 
 @implementation PepperFlashFullscreenWindow
 
@@ skipping 548 matching lines @@
   DestroyCompositedIOSurfaceLayer(kRemoveLayerFromHierarchy);
   compositing_iosurface_ = NULL;
   compositing_iosurface_context_ = NULL;
 }
 
 bool RenderWidgetHostViewMac::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(RenderWidgetHostViewMac, message)
     IPC_MESSAGE_HANDLER(ViewHostMsg_PluginFocusChanged, OnPluginFocusChanged)
     IPC_MESSAGE_HANDLER(ViewHostMsg_StartPluginIme, OnStartPluginIme)
+    IPC_MESSAGE_HANDLER(ViewMsg_GetRenderedTextCompleted,
+        OnGetRenderedTextCompleted)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void RenderWidgetHostViewMac::InitAsChild(
     gfx::NativeView parent_view) {
 }
 
 void RenderWidgetHostViewMac::InitAsPopup(
@@ skipping 429 matching lines @@
     [cocoa_view_ setToolTipAtMousePoint:tooltip_nsstring];
   }
 }
 
 bool RenderWidgetHostViewMac::SupportsSpeech() const {
   return [NSApp respondsToSelector:@selector(speakString:)] &&
          [NSApp respondsToSelector:@selector(stopSpeaking:)];
 }
 
 void RenderWidgetHostViewMac::SpeakSelection() {
-  if ([NSApp respondsToSelector:@selector(speakString:)])
-    [NSApp speakString:base::SysUTF8ToNSString(selected_text_)];
+  if (![NSApp respondsToSelector:@selector(speakString:)])
+    return;
+
+  if (selected_text_.empty() && render_widget_host_) {
+    // If there's no selection, speak all text. Send an asynchronous IPC
+    // request for all the text in the webcontents.
+    // ViewMsg_GetRenderedTextCompleted is sent back to IPC Message receiver.
+    render_widget_host_->Send(new ViewMsg_GetRenderedText(
+        render_widget_host_->GetRoutingID()));
+    return;
+  }
+
+  [cocoa_view_ speakText:base::SysUTF8ToNSString(selected_text_)];
 }
 
 bool RenderWidgetHostViewMac::IsSpeaking() const {
   return [NSApp respondsToSelector:@selector(isSpeaking)] &&
          [NSApp isSpeaking];
 }
 
 void RenderWidgetHostViewMac::StopSpeaking() {
   if ([NSApp respondsToSelector:@selector(stopSpeaking:)])
     [NSApp stopSpeaking:cocoa_view_];
@@ skipping 955 matching lines @@
 
 void RenderWidgetHostViewMac::OnPluginFocusChanged(bool focused,
                                                    int plugin_id) {
   [cocoa_view_ pluginFocusChanged:(focused ? YES : NO) forPlugin:plugin_id];
 }
 
 void RenderWidgetHostViewMac::OnStartPluginIme() {
   [cocoa_view_ setPluginImeActive:YES];
 }
 
+void RenderWidgetHostViewMac::OnGetRenderedTextCompleted(
+    const std::string& text) {
+  [cocoa_view_ speakText:base::SysUTF8ToNSString(text)];
+}
+
 gfx::Rect RenderWidgetHostViewMac::GetScaledOpenGLPixelRect(
     const gfx::Rect& rect) {
   gfx::Rect src_gl_subrect = rect;
   src_gl_subrect.set_y(GetViewBounds().height() - rect.bottom());
 
   return gfx::ToEnclosingRect(gfx::ScaleRect(src_gl_subrect,
                                              ViewScaleFactor()));
 }
 
 void RenderWidgetHostViewMac::AddPendingLatencyInfo(
@@ skipping 847 matching lines @@
     // Note that we don't attempt to bracket these by GesturePinchBegin/End (or
     // GestureSrollBegin/End) as is done for touchscreen.  Keeping track of when
     // a pinch is active would take a little more work here, and we don't need
     // it for anything yet.
     const WebGestureEvent& webEvent =
         WebInputEventFactory::gestureEvent(event, self);
     renderWidgetHostView_->render_widget_host_->ForwardGestureEvent(webEvent);
   }
 }
 
+- (void)speakText:(NSString*) text {

[dcheng, 2014/08/12 20:55:27]

Nit: not really sure why this is currently it's own method. You could change
this to a normal C++ method and have it take a const std::string& so you don't
have to repeat the call to SysUTF8ToNSString() in both
OnGetRenderedTextComplete() and SpeakSelection().

Otherwise, just inline this into the two places it's called: [NSApp
speakText:...] is shorter than [cocoa_view_ speakText:...] anyway.

[sarka, 2014/08/12 21:03:16]

I think [NSApp speakString] is decided at runtime since its an undocumented
method and one of the reviewers suggested from an earlier patch that I make a
private method that can be used launch a TTS session hence [cocoa_view_
speakText:]. Let me know if that makes sense, else I would make suggested
changes.

+  [NSApp speakString:text];
+}
+
 - (void)viewWillMoveToWindow:(NSWindow*)newWindow {
   NSWindow* oldWindow = [self window];
 
   NSNotificationCenter* notificationCenter =
       [NSNotificationCenter defaultCenter];
 
   // Backing property notifications crash on 10.6 when building with the 10.7
   // SDK, see http://crbug.com/260595.
   static BOOL supportsBackingPropertiesNotification =
       SupportsBackingPropertiesChangedNotification();
@@ skipping 1023 matching lines @@
 
 // "-webkit-app-region: drag | no-drag" is implemented on Mac by excluding
 // regions that are not draggable. (See ControlRegionView in
 // native_app_window_cocoa.mm). This requires the render host view to be
 // draggable by default.
 - (BOOL)mouseDownCanMoveWindow {
   return YES;
 }
 
 @end