[MacViews] Implemented text context menu

ui/base/cocoa/text_services_context_menu.cc

+// Copyright 2017 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 "ui/base/cocoa/text_services_context_menu.h"
+
+#include <utility>
+
+#include <ApplicationServices/ApplicationServices.h>
+#include <CoreAudio/CoreAudio.h>
+
+#include "base/strings/sys_string_conversions.h"
+#include "base/strings/utf_string_conversions.h"
+#include "ui/base/l10n/l10n_util.h"
+#include "ui/strings/grit/ui_strings.h"
+
+namespace {
+
+// The speech channel used for speaking.

[Alexei Svitkine (slow), 2017/02/01 19:12:37]

Can you expand comment to mention why it makes sense for this to be a global?

[spqchan, 2017/02/02 20:35:06]

Done.

+SpeechChannel g_speech_channel;
+
+// Returns the TextDirection associated associated with the given
+// BiDi |command_id|.
+base::i18n::TextDirection GetTextDirectionFromCommandId(int command_id) {
+  switch (command_id) {
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT:
+      return base::i18n::UNKNOWN_DIRECTION;
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR:
+      return base::i18n::LEFT_TO_RIGHT;
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL:
+      return base::i18n::RIGHT_TO_LEFT;
+    default:
+      NOTREACHED();
+      return base::i18n::UNKNOWN_DIRECTION;
+  }
+}
+
+}  // namespace
+
+namespace ui {
+
+TextServicesContextMenu::TextServicesContextMenu(Delegate* delegate)
+    : speech_submenu_model_(this),
+      bidi_submenu_model_(this),
+      delegate_(delegate) {
+  DCHECK(delegate);
+
+  speech_submenu_model_.AddItemWithStringId(IDS_SPEECH_START_SPEAKING_MAC,
+                                            IDS_SPEECH_START_SPEAKING_MAC);
+  speech_submenu_model_.AddItemWithStringId(IDS_SPEECH_STOP_SPEAKING_MAC,
+                                            IDS_SPEECH_STOP_SPEAKING_MAC);
+
+  bidi_submenu_model_.AddCheckItemWithStringId(
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT,
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT);
+  bidi_submenu_model_.AddCheckItemWithStringId(
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR,
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR);
+  bidi_submenu_model_.AddCheckItemWithStringId(
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL,
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL);
+}
+
+void TextServicesContextMenu::SpeakText(const base::string16& text) {
+  if (IsSpeaking())
+    StopSpeaking();
+
+  NewSpeechChannel(nullptr, &g_speech_channel);

[Alexei Svitkine (slow), 2017/02/01 19:12:37]

What happens if g_speech_channel already exists?

Should the OSErr return value of this be checked?

Can there be test coverage of this code? I know it might be weird to have unit
tests speaking stuff... but I think having tests the exercise the APIs we're
using is preferred to the side effect of some stuff being spoken...

[spqchan, 2017/02/02 20:35:06]

Whoops, that's a good point. I added a check for it. Currently it just created a
new one but we can just reuse the old one
I added a check for the OSErr return value too.

I added a TODO for a test suite. I'm not sure if I'll be able to write unit
tests for the speech stuff but I can give it a try.

[Alexei Svitkine (slow), 2017/02/02 20:50:24]

I would prefer it's done in this CL so that it's not forgotten.

I think it can be pretty basic to start with - e.g. exercising the functions to
make sure they don't crash.

For the context menu stuff, seems tests should be pretty easy too - check if
entries were added to the model, etc.

[spqchan, 2017/02/03 23:32:10]

Done.

+  SpeakCFString(g_speech_channel, SysUTF16ToCFStringRef(text), nullptr);
+}
+
+void TextServicesContextMenu::StopSpeaking() {
+  StopSpeechAt(g_speech_channel, kImmediate);
+  DisposeSpeechChannel(g_speech_channel);
+}
+
+bool TextServicesContextMenu::IsSpeaking() {
+  return SpeechBusy();
+}
+
+void TextServicesContextMenu::AppendToContextMenu(SimpleMenuModel* model) {
+  model->AddSeparator(NORMAL_SEPARATOR);
+  model->AddSubMenuWithStringId(IDS_SPEECH_MAC, IDS_SPEECH_MAC,
+                                &speech_submenu_model_);
+}
+
+void TextServicesContextMenu::AppendEditableItems(SimpleMenuModel* model) {
+  model->AddSubMenuWithStringId(IDS_CONTENT_CONTEXT_WRITING_DIRECTION_MENU,
+                                IDS_CONTENT_CONTEXT_WRITING_DIRECTION_MENU,
+                                &bidi_submenu_model_);
+}
+
+bool TextServicesContextMenu::IsCommandIdChecked(int command_id) const {
+  switch (command_id) {
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL:
+      return delegate_->IsTextDirectionChecked(
+          GetTextDirectionFromCommandId(command_id));
+    case IDS_SPEECH_START_SPEAKING_MAC:
+    case IDS_SPEECH_STOP_SPEAKING_MAC:
+      return false;
+  }
+
+  NOTREACHED();
+  return false;
+}
+
+bool TextServicesContextMenu::IsCommandIdEnabled(int command_id) const {
+  switch (command_id) {
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL:
+      return delegate_->IsTextDirectionEnabled(
+          GetTextDirectionFromCommandId(command_id));
+    case IDS_SPEECH_START_SPEAKING_MAC:
+      return true;
+    case IDS_SPEECH_STOP_SPEAKING_MAC:
+      return IsSpeaking();
+  }
+
+  NOTREACHED();
+  return false;
+}
+
+void TextServicesContextMenu::ExecuteCommand(int command_id, int event_flags) {
+  switch (command_id) {
+    case IDS_SPEECH_START_SPEAKING_MAC:
+      SpeakText(delegate_->GetSelectedText());
+      break;
+    case IDS_SPEECH_STOP_SPEAKING_MAC:
+      StopSpeaking();
+      break;
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL:
+      delegate_->UpdateTextDirection(GetTextDirectionFromCommandId(command_id));
+      break;
+    default:
+      NOTREACHED();
+  }
+}
+
+}  // namespace ui