[MacViews] Implemented text context menu

ui/base/cocoa/text_services_context_menu.cc

+// Copyright 2016 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.
+SpeechChannel speechChannel;

[tapted, 2016/12/21 11:20:26]

speechChannel -> g_speech_channel

[spqchan, 2016/12/21 22:00:13]

Done. Quick question, why the g_?

[tapted, 2016/12/21 22:13:16]

This is to make it clear that we're declaring/referencing a global variable.
(i.e. even though it has internal linkage and isn't "global" in that sense, the
g_ makes it clear when referencing it that there is only one object). It's
commonly used (see e.g. `git grep '[^ ].* g_.*=.*;' -- '*.cc'`. There's no style
guideline for naming global variables, but this doesn't break any rules either
:)

[spqchan, 2017/01/13 20:13:19]

Gotcha, thanks!

+
+// 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::TextDirection::UNKNOWN_DIRECTION;
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR:
+      return base::i18n::TextDirection::LEFT_TO_RIGHT;
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL:
+      return base::i18n::TextDirection::RIGHT_TO_LEFT;
+    default:
+      NOTREACHED();
+      return base::i18n::TextDirection::UNKNOWN_DIRECTION;
+  }
+}
+
+}  // namespace
+
+namespace ui {
+
+//////////////////////////////////////////////////////////////////

[tapted, 2016/12/21 11:20:26]

nit: I wouldn't worry about this style of comments - it's used for really big
classes, but here it's fine to omit. same below

[spqchan, 2016/12/21 22:00:13]

Done.

+// TextServicesContextMenu, public:
+
+TextServicesContextMenu::TextServicesContextMenu(Delegate* delegate)
+    : speech_submenu_model_(this),
+      bidi_submenu_model_(this),
+      delegate_(delegate) {
+  DCHECK(delegate);
+
+  // Add items to the speech submenu.

[tapted, 2016/12/21 11:20:26]

nit: submenu -> submenu model. Same below. Or I think we could also just omit
this comments.

[spqchan, 2016/12/21 22:00:13]

Done.

+  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);
+
+  // Add items to the BiDi submenu.
+  bidi_submenu_model_.AddCheckItem(

[tapted, 2016/12/21 11:20:26]

AddCheckItemWithStringId ?

[spqchan, 2016/12/21 22:00:13]

Done.

+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT,
+      l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT));
+  bidi_submenu_model_.AddCheckItem(
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR,
+      l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR));
+  bidi_submenu_model_.AddCheckItem(
+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL,
+      l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL));
+}
+
+void TextServicesContextMenu::SpeakText(const base::string16& text) {
+  if (IsSpeaking())
+    StopSpeaking();
+
+  NewSpeechChannel(nullptr, &speechChannel);
+  SpeakCFString(speechChannel, SysUTF16ToCFStringRef(text), nullptr);
+}
+
+void TextServicesContextMenu::StopSpeaking() {
+  StopSpeechAt(speechChannel, kImmediate);
+  DisposeSpeechChannel(speechChannel);
+}
+
+bool TextServicesContextMenu::IsSpeaking() {
+  return SpeechBusy();
+}
+
+void TextServicesContextMenu::AppendToContextMenu(SimpleMenuModel* model) {
+  base::string16 printable_selection_text = delegate_->GetSelectedText();
+  if (printable_selection_text.empty())

[tapted, 2016/12/21 11:20:26]

Hmmm - it looks like we can still speak when there is no selection, but only
when selecting from the Edit menu. But does this mean we need
OnSpeakRequested()? i.e. instead of

delegate_->OnSpeakRequested();

can we just do

SpeakText(delegate_->GetSelectedText())

[spqchan, 2016/12/21 22:00:13]

We still need OnSpeakRequested() because if nothing is selected, then the host
view will send an async request to retrieve all of the text.

[tapted, 2016/12/21 22:13:15]

But the logic here will not add the menu item if nothing is selected, so
OnSpeakRequested() _can't_ be called if nothing is selected :)

The async request only comes into play when selecting Edit->Speech->Start
Speaking. So we still need a public `SpeakText` so that -[RWHVC startSpeaking:]
can call it. However, the right-click context menu shouldn't need it.

[spqchan, 2017/01/13 20:13:19]

Doh, I see what you mean. Removed it :)

+    return;
+
+  model->AddSeparator(NORMAL_SEPARATOR);
+
+  model->AddSubMenu(IDS_SPEECH_MAC, l10n_util::GetStringUTF16(IDS_SPEECH_MAC),

[tapted, 2016/12/21 11:20:26]

AddSubMenuWithStringId ?

[spqchan, 2016/12/21 22:00:13]

Done.

+                    &speech_submenu_model_);
+}
+
+void TextServicesContextMenu::AppendEditableItems(SimpleMenuModel* model) {
+  model->AddSubMenu(

[tapted, 2016/12/21 11:20:26]

AddSubMenuWithStringId ?

[spqchan, 2016/12/21 22:00:13]

Done.

+      IDS_CONTENT_CONTEXT_WRITING_DIRECTION_MENU,
+      l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_WRITING_DIRECTION_MENU),
+      &bidi_submenu_model_);
+}
+
+bool TextServicesContextMenu::IsTextServicesCommandId(int command_id) const {
+  switch (command_id) {
+    case IDS_SPEECH_START_SPEAKING_MAC:
+    case IDS_SPEECH_STOP_SPEAKING_MAC:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_DEFAULT:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_LTR:
+    case IDS_CONTENT_CONTEXT_WRITING_DIRECTION_RTL:
+      return true;
+  }
+
+  return false;
+}
+
+//////////////////////////////////////////////////////////////////
+// TextServicesContextMenu::SimpleMenuModel::Delegate:
+
+void TextServicesContextMenu::ExecuteCommand(int command_id, int event_flags) {
+  switch (command_id) {
+    case IDS_SPEECH_START_SPEAKING_MAC:
+      delegate_->OnSpeakRequested();
+      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();
+  }
+}
+
+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_SPEECH_START_SPEAKING_MAC:
+    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_STOP_SPEAKING_MAC:
+      return IsSpeaking();
+  }
+
+  NOTREACHED();
+  return false;
+}
+
+}  // namespace ui