The Tor Browser: dom/events/TextComposition.cpp@b8a032363ba2 (annotated)

dom/events/TextComposition.cpp@b8a032363ba2 (annotated)

dom/events/TextComposition.cpp

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* vim: set ts=2 sw=2 et tw=80: */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 #include "ContentEventHandler.h"
 #include "nsContentUtils.h"
 #include "nsIContent.h"
 #include "nsIEditor.h"
 #include "nsIPresShell.h"
 #include "nsPresContext.h"
 #include "mozilla/EventDispatcher.h"
 #include "mozilla/IMEStateManager.h"
 #include "mozilla/MiscEvents.h"
 #include "mozilla/TextComposition.h"
 #include "mozilla/TextEvents.h"
 using namespace mozilla::widget;
 namespace mozilla {
 /******************************************************************************
  * TextComposition
  ******************************************************************************/
 TextComposition::TextComposition(nsPresContext* aPresContext,
                                  nsINode* aNode,
                                  WidgetGUIEvent* aEvent)
   : mPresContext(aPresContext)
   , mNode(aNode)
   , mNativeContext(aEvent->widget->GetInputContext().mNativeIMEContext)
   , mCompositionStartOffset(0)
   , mCompositionTargetOffset(0)
   , mIsSynthesizedForTests(aEvent->mFlags.mIsSynthesizedForTests)
   , mIsComposing(false)
   , mIsEditorHandlingEvent(false)
 {
 }
 void
 TextComposition::Destroy()
 {
   mPresContext = nullptr;
   mNode = nullptr;
   // TODO: If the editor is still alive and this is held by it, we should tell
   //       this being destroyed for cleaning up the stuff.
 }
 bool
 TextComposition::MatchesNativeContext(nsIWidget* aWidget) const
 {
   return mNativeContext == aWidget->GetInputContext().mNativeIMEContext;
 }
 void
 TextComposition::DispatchEvent(WidgetGUIEvent* aEvent,
                                nsEventStatus* aStatus,
                                EventDispatchingCallback* aCallBack)
 {
   if (aEvent->message == NS_COMPOSITION_UPDATE) {
     mLastData = aEvent->AsCompositionEvent()->data;
   }
   EventDispatcher::Dispatch(mNode, mPresContext,
                             aEvent, nullptr, aStatus, aCallBack);
   if (!mPresContext) {
     return;
   }
   // Emulate editor behavior of text event handler if no editor handles
   // composition/text events.
   if (aEvent->message == NS_TEXT_TEXT && !HasEditor()) {
     EditorWillHandleTextEvent(aEvent->AsTextEvent());
     EditorDidHandleTextEvent();
   }
 #ifdef DEBUG
   else if (aEvent->message == NS_COMPOSITION_END) {
     MOZ_ASSERT(!mIsComposing, "Why is the editor still composing?");
     MOZ_ASSERT(!HasEditor(), "Why does the editor still keep to hold this?");
   }
 #endif // #ifdef DEBUG
   // Notify composition update to widget if possible
   NotityUpdateComposition(aEvent);
 }
 void
 TextComposition::NotityUpdateComposition(WidgetGUIEvent* aEvent)
 {
   nsEventStatus status;
   // When compositon start, notify the rect of first offset character.
   // When not compositon start, notify the rect of selected composition
   // string if text event.
   if (aEvent->message == NS_COMPOSITION_START) {
     nsCOMPtr<nsIWidget> widget = mPresContext->GetRootWidget();
     // Update composition start offset
     WidgetQueryContentEvent selectedTextEvent(true,
                                               NS_QUERY_SELECTED_TEXT,
                                               widget);
     widget->DispatchEvent(&selectedTextEvent, status);
     if (selectedTextEvent.mSucceeded) {
       mCompositionStartOffset = selectedTextEvent.mReply.mOffset;
     } else {
       // Unknown offset
       NS_WARNING("Cannot get start offset of IME composition");
       mCompositionStartOffset = 0;
     }
     mCompositionTargetOffset = mCompositionStartOffset;
   } else if (aEvent->eventStructType != NS_TEXT_EVENT) {
     return;
   } else {
     mCompositionTargetOffset =
       mCompositionStartOffset + aEvent->AsTextEvent()->TargetClauseOffset();
   }
   NotifyIME(NOTIFY_IME_OF_COMPOSITION_UPDATE);
 }
 void
 TextComposition::DispatchCompositionEventRunnable(uint32_t aEventMessage,
                                                   const nsAString& aData)
 {
   nsContentUtils::AddScriptRunner(
     new CompositionEventDispatcher(mPresContext, mNode,
                                    aEventMessage, aData));
 }
 void
 TextComposition::SynthesizeCommit(bool aDiscard)
 {
   nsRefPtr<TextComposition> kungFuDeathGrip(this);
   nsAutoString data(aDiscard ? EmptyString() : mLastData);
   if (mLastData != data) {
     DispatchCompositionEventRunnable(NS_COMPOSITION_UPDATE, data);
     DispatchCompositionEventRunnable(NS_TEXT_TEXT, data);
   }
   DispatchCompositionEventRunnable(NS_COMPOSITION_END, data);
 }
 nsresult
 TextComposition::NotifyIME(IMEMessage aMessage)
 {
   NS_ENSURE_TRUE(mPresContext, NS_ERROR_NOT_AVAILABLE);
   return IMEStateManager::NotifyIME(aMessage, mPresContext);
 }
 void
 TextComposition::EditorWillHandleTextEvent(const WidgetTextEvent* aTextEvent)
 {
   mIsComposing = aTextEvent->IsComposing();
   mRanges = aTextEvent->mRanges;
   mIsEditorHandlingEvent = true;
   MOZ_ASSERT(mLastData == aTextEvent->theText,
     "The text of a text event must be same as previous data attribute value "
     "of the latest compositionupdate event");
 }
 void
 TextComposition::EditorDidHandleTextEvent()
 {
   mString = mLastData;
   mIsEditorHandlingEvent = false;
 }
 void
 TextComposition::StartHandlingComposition(nsIEditor* aEditor)
 {
   MOZ_ASSERT(!HasEditor(), "There is a handling editor already");
   mEditorWeak = do_GetWeakReference(aEditor);
 }
 void
 TextComposition::EndHandlingComposition(nsIEditor* aEditor)
 {
 #ifdef DEBUG
   nsCOMPtr<nsIEditor> editor = GetEditor();
   MOZ_ASSERT(editor == aEditor, "Another editor handled the composition?");
 #endif // #ifdef DEBUG
   mEditorWeak = nullptr;
 }
 already_AddRefed<nsIEditor>
 TextComposition::GetEditor() const
 {
   nsCOMPtr<nsIEditor> editor = do_QueryReferent(mEditorWeak);
   return editor.forget();
 }
 bool
 TextComposition::HasEditor() const
 {
   nsCOMPtr<nsIEditor> editor = GetEditor();
   return !!editor;
 }
 /******************************************************************************
  * TextComposition::CompositionEventDispatcher
  ******************************************************************************/
 TextComposition::CompositionEventDispatcher::CompositionEventDispatcher(
                                                nsPresContext* aPresContext,
                                                nsINode* aEventTarget,
                                                uint32_t aEventMessage,
                                                const nsAString& aData) :
   mPresContext(aPresContext), mEventTarget(aEventTarget),
   mEventMessage(aEventMessage), mData(aData)
 {
   mWidget = mPresContext->GetRootWidget();
 }
 NS_IMETHODIMP
 TextComposition::CompositionEventDispatcher::Run()
 {
   if (!mPresContext->GetPresShell() ||
       mPresContext->GetPresShell()->IsDestroying()) {
     return NS_OK; // cannot dispatch any events anymore
   }
   nsEventStatus status = nsEventStatus_eIgnore;
   switch (mEventMessage) {
     case NS_COMPOSITION_START: {
       WidgetCompositionEvent compStart(true, NS_COMPOSITION_START, mWidget);
       WidgetQueryContentEvent selectedText(true, NS_QUERY_SELECTED_TEXT,
                                            mWidget);
       ContentEventHandler handler(mPresContext);
       handler.OnQuerySelectedText(&selectedText);
       NS_ASSERTION(selectedText.mSucceeded, "Failed to get selected text");
       compStart.data = selectedText.mReply.mString;
       IMEStateManager::DispatchCompositionEvent(mEventTarget, mPresContext,
                                                 &compStart, &status, nullptr);
       break;
     }
     case NS_COMPOSITION_UPDATE:
     case NS_COMPOSITION_END: {
       WidgetCompositionEvent compEvent(true, mEventMessage, mWidget);
       compEvent.data = mData;
       IMEStateManager::DispatchCompositionEvent(mEventTarget, mPresContext,
                                                 &compEvent, &status, nullptr);
       break;
     }
     case NS_TEXT_TEXT: {
       WidgetTextEvent textEvent(true, NS_TEXT_TEXT, mWidget);
       textEvent.theText = mData;
       IMEStateManager::DispatchCompositionEvent(mEventTarget, mPresContext,
                                                 &textEvent, &status, nullptr);
       break;
     }
     default:
       MOZ_CRASH("Unsupported event");
   }
   return NS_OK;
 }
 /******************************************************************************
  * TextCompositionArray
  ******************************************************************************/
 TextCompositionArray::index_type
 TextCompositionArray::IndexOf(nsIWidget* aWidget)
 {
   for (index_type i = Length(); i > 0; --i) {
     if (ElementAt(i - 1)->MatchesNativeContext(aWidget)) {
       return i - 1;
     }
   }
   return NoIndex;
 }
 TextCompositionArray::index_type
 TextCompositionArray::IndexOf(nsPresContext* aPresContext)
 {
   for (index_type i = Length(); i > 0; --i) {
     if (ElementAt(i - 1)->GetPresContext() == aPresContext) {
       return i - 1;
     }
   }
   return NoIndex;
 }
 TextCompositionArray::index_type
 TextCompositionArray::IndexOf(nsPresContext* aPresContext,
                               nsINode* aNode)
 {
   index_type index = IndexOf(aPresContext);
   if (index == NoIndex) {
     return NoIndex;
   }
   nsINode* node = ElementAt(index)->GetEventTargetNode();
   return node == aNode ? index : NoIndex;
 }
 TextComposition*
 TextCompositionArray::GetCompositionFor(nsIWidget* aWidget)
 {
   index_type i = IndexOf(aWidget);
   return i != NoIndex ? ElementAt(i) : nullptr;
 }
 TextComposition*
 TextCompositionArray::GetCompositionFor(nsPresContext* aPresContext,
                                            nsINode* aNode)
 {
   index_type i = IndexOf(aPresContext, aNode);
   return i != NoIndex ? ElementAt(i) : nullptr;
 }
 TextComposition*
 TextCompositionArray::GetCompositionInContent(nsPresContext* aPresContext,
                                               nsIContent* aContent)
 {
   // There should be only one composition per content object.
   for (index_type i = Length(); i > 0; --i) {
     nsINode* node = ElementAt(i - 1)->GetEventTargetNode();
     if (node && nsContentUtils::ContentIsDescendantOf(node, aContent)) {
       return ElementAt(i - 1);
     }
   }
   return nullptr;
 }
 } // namespace mozilla

The Tor Browser / annotate

dom/events/TextComposition.cpp@b8a032363ba2 (annotated)

dom/events/TextComposition.cpp