[MacViews] Implemented text context menu

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>
 #include <stdint.h>
@@ skipping 55 matching lines @@
 #include "gpu/ipc/common/gpu_messages.h"
 #include "skia/ext/platform_canvas.h"
 #include "skia/ext/skia_utils_mac.h"
 #include "third_party/WebKit/public/platform/WebScreenInfo.h"
 #include "third_party/WebKit/public/web/WebInputEvent.h"
 #import "ui/base/clipboard/clipboard_util_mac.h"
 #include "ui/base/cocoa/animation_utils.h"
 #import "ui/base/cocoa/appkit_utils.h"
 #include "ui/base/cocoa/cocoa_base_utils.h"
 #import "ui/base/cocoa/fullscreen_window_manager.h"
+#include "ui/base/cocoa/text_context_menu.h"
 #import "ui/base/cocoa/underlay_opengl_hosting_window.h"
 #include "ui/base/layout.h"
 #include "ui/compositor/compositor.h"
 #include "ui/compositor/layer.h"
 #include "ui/display/display.h"
 #include "ui/display/screen.h"
 #include "ui/events/event_utils.h"
 #include "ui/events/keycodes/keyboard_codes.h"
 #include "ui/gfx/color_profile.h"
 #include "ui/gfx/geometry/dip_util.h"
@@ skipping 45 matching lines @@
   content::WebContents* guest =
       guest_manager->GetFullPageGuest(web_contents);
   if (!guest)
     return render_widget_host_view;
   return static_cast<RenderWidgetHostViewMac*>(
       guest->GetRenderWidgetHostView());
 }
 
 }  // namespace
 
 // These are not documented, so use only after checking -respondsToSelector:.

[tapted, 2016/07/22 03:06:42]

Can these all be deleted? (if callers remain in RWHVM they should call
text_context_menu instead)

[spqchan, 2016/12/12 19:32:27]

Done.

 @interface NSApplication (UndocumentedSpeechMethods)
 - (void)speakString:(NSString*)string;
 - (void)stopSpeaking:(id)sender;
 - (BOOL)isSpeaking;
 @end
 
 // Private methods:
 @interface RenderWidgetHostViewCocoa ()
 @property(nonatomic, assign) NSRange selectedRange;
 @property(nonatomic, assign) NSRange markedRange;
@@ skipping 714 matching lines @@
     vsync_interval_ = base::TimeDelta();
     return;
   }
 
   if (browser_compositor_) {
     browser_compositor_->compositor()->vsync_manager()->UpdateVSyncParameters(
         vsync_timebase_, vsync_interval_);
   }
 }
 
-void RenderWidgetHostViewMac::SpeakText(const std::string& text) {
-  [NSApp speakString:base::SysUTF8ToNSString(text)];
-}
-
 void RenderWidgetHostViewMac::UpdateBackingStoreProperties() {
   if (!render_widget_host_)
     return;
   render_widget_host_->NotifyScreenInfoChanged();
 }
 
 RenderWidgetHost* RenderWidgetHostViewMac::GetRenderWidgetHost() const {
   return render_widget_host_;
 }
 
@@ skipping 269 matching lines @@
     // set it again every single time the mouse moves.
     base::string16 display_text = tooltip_text_;
     if (tooltip_text_.length() > kMaxTooltipLength)
       display_text = tooltip_text_.substr(0, kMaxTooltipLength);
 
     NSString* tooltip_nsstring = base::SysUTF16ToNSString(display_text);
     [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:)])
     return;
 
   if (selected_text_.empty() && render_widget_host_) {
     // If there's no selection, speak all text. Send an asynchronous IPC
     // request for fetching all the text for a webcontent.
     // ViewMsg_GetRenderedTextCompleted is sent back to IPC Message receiver.
     render_widget_host_->Send(new ViewMsg_GetRenderedText(
         render_widget_host_->GetRoutingID()));
     return;
   }
 
-  SpeakText(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_];
+  TextContextMenu::SpeakText(base::ASCIIToUTF16(selected_text_));

[tapted, 2016/07/22 03:06:42]

ASCII -> UTF8

(but also ... the selected_text_ member should really be a base::string16 so
that it's not first converted _from_ UTF16 in
RenderWidgetHostViewMac::SelectionChanged - but that should be a separate CL)

[spqchan, 2016/12/12 19:32:27]

Done.

 }
 
 //
 // RenderWidgetHostViewCocoa uses the stored selection text,
 // which implements NSServicesRequests protocol.
 //
 void RenderWidgetHostViewMac::SelectionChanged(const base::string16& text,
                                                size_t offset,
                                                const gfx::Range& range) {
   if (range.is_empty() || text.empty()) {
@@ skipping 559 matching lines @@
     else
       DisablePasswordInput();
   } else {
     if (text_input_type_ == ui::TEXT_INPUT_TYPE_PASSWORD)
       DisablePasswordInput();
   }
 }
 
 void RenderWidgetHostViewMac::OnGetRenderedTextCompleted(
     const std::string& text) {
-  SpeakText(text);
+  TextContextMenu::SpeakText(base::ASCIIToUTF16(text));

[tapted, 2016/07/22 03:06:42]

ASCII -> UTF8

[spqchan, 2016/12/12 19:32:27]

Done.

 }
 
 void RenderWidgetHostViewMac::PauseForPendingResizeOrRepaintsAndDraw() {
   if (!render_widget_host_ || render_widget_host_->is_hidden())
     return;
 
   // Pausing for one view prevents others from receiving frames.
   // This may lead to large delays, causing overlaps. See crbug.com/352020.
   if (!allow_pause_for_resize_or_repaint_)
     return;
@@ skipping 999 matching lines @@
     if (known)
       return valid;
   }
 
   SEL action = [item action];
   BOOL is_render_view =
       RenderViewHost::From(renderWidgetHostView_->render_widget_host_) !=
       nullptr;
 
   if (action == @selector(stopSpeaking:))
-    return is_render_view && renderWidgetHostView_->IsSpeaking();
+    return is_render_view && TextContextMenu::IsSpeaking();
 
   if (action == @selector(startSpeaking:))
-    return is_render_view && renderWidgetHostView_->SupportsSpeech();
+    return is_render_view && TextContextMenu::SupportsSpeech();
 
   // For now, these actions are always enabled for render view,
   // this is sub-optimal.
   // TODO(suzhe): Plumb the "can*" methods up from WebCore.
   if (action == @selector(undo:) ||
       action == @selector(redo:) ||
       action == @selector(cut:) ||
       action == @selector(copy:) ||
       action == @selector(copyToFindPboard:) ||
       action == @selector(paste:) ||
@@ skipping 516 matching lines @@
   // one of the Select methods on RWH. Since selectAll: is called from the
   // menu handler, neither is true.
   // Explicitly call SelectAll() here to make sure the renderer returns
   // selection results.
   content::RenderWidgetHostDelegate* render_widget_host_delegate =
       renderWidgetHostView_->render_widget_host_->delegate();
   if (render_widget_host_delegate)
     render_widget_host_delegate->SelectAll();
 }
 
 - (void)startSpeaking:(id)sender {

[tapted, 2016/07/22 03:06:42]

BridgedContentView will need to implement these if we want it to respond to the
items in the mainMenu bar (as well as the context menu). They can be implemented
in terms of the textInputClient_ member on BridgedContentView (see later
comment)

It can probably be implemented something like

ViewsTextServicesMenuMac::SpeakTextInputClient(textInputClient_) -- see later
comments


(and SpeakTextInputClient could possibly even go on TextServicesContextMenu,
since I think it's allowed to depend on ui::TextInputClient [but not views])

[spqchan, 2016/12/12 19:32:27]

I'm a bit confused with what you mean about BridgedContentView since the speak
menu on the main menu is current working with MacViews. Can you elaborate?
Thanks!  

[tapted, 2016/12/12 22:32:44]

I think selecting 'Start Speaking' from the mainMenu will hunt through the
responder chain until it finds a class implementing `startSpeaking:`.
BridgedContentView doesn't implement it, so currently on MacViews (e.g. the
bookmark bubble) `Edit -> Speech -> StartSpeaking` will read out the web page
(since it skips over the views::Widget but then finds this implementation), but
on Cocoa it will read out the contents of the `Name:` textfield in the bookmarks
bubble.

   GetRenderWidgetHostViewToUse(renderWidgetHostView_.get())->SpeakSelection();
 }
 
 - (void)stopSpeaking:(id)sender {
-  GetRenderWidgetHostViewToUse(renderWidgetHostView_.get())->StopSpeaking();
+  TextContextMenu::StopSpeaking();
 }
 
 - (void)cancelComposition {
   if (!hasMarkedText_)
     return;
 
   // Cancel the ongoing composition. [NSInputManager markedTextAbandoned:]
   // doesn't call any NSTextInput functions, such as setMarkedText or
   // insertText. So, we need to send an IPC message to a renderer so it can
   // delete the composition node.
@@ skipping 93 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