gecko/widget/windows/nsTextStore.cpp

1673 lines
54 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 <olectl.h>
#include "nscore.h"
#include "nsTextStore.h"
#include "nsWindow.h"
#include "prlog.h"
#include "nsPrintfCString.h"
#include "mozilla/Preferences.h"
using namespace mozilla;
using namespace mozilla::widget;
/******************************************************************/
/* nsTextStore */
/******************************************************************/
ITfThreadMgr* nsTextStore::sTsfThreadMgr = NULL;
ITfDisplayAttributeMgr* nsTextStore::sDisplayAttrMgr = NULL;
ITfCategoryMgr* nsTextStore::sCategoryMgr = NULL;
DWORD nsTextStore::sTsfClientId = 0;
nsTextStore* nsTextStore::sTsfTextStore = NULL;
UINT nsTextStore::sFlushTIPInputMessage = 0;
#ifdef PR_LOGGING
PRLogModuleInfo* sTextStoreLog = nullptr;
#endif
nsTextStore::nsTextStore()
{
mRefCnt = 1;
mEditCookie = 0;
mSinkMask = 0;
mWindow = nullptr;
mLock = 0;
mLockQueued = 0;
mTextChange.acpStart = PR_INT32_MAX;
mTextChange.acpOldEnd = mTextChange.acpNewEnd = 0;
mLastDispatchedTextEvent = nullptr;
}
nsTextStore::~nsTextStore()
{
if (mCompositionTimer) {
mCompositionTimer->Cancel();
mCompositionTimer = nullptr;
}
SaveTextEvent(nullptr);
}
bool
nsTextStore::Create(nsWindow* aWindow,
IMEState::Enabled aIMEEnabled)
{
if (!mDocumentMgr) {
// Create document manager
HRESULT hr = sTsfThreadMgr->CreateDocumentMgr(
getter_AddRefs(mDocumentMgr));
NS_ENSURE_TRUE(SUCCEEDED(hr), false);
mWindow = aWindow;
// Create context and add it to document manager
hr = mDocumentMgr->CreateContext(sTsfClientId, 0,
static_cast<ITextStoreACP*>(this),
getter_AddRefs(mContext), &mEditCookie);
if (SUCCEEDED(hr)) {
SetInputContextInternal(aIMEEnabled);
hr = mDocumentMgr->Push(mContext);
}
if (SUCCEEDED(hr)) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: Created, window=%08x\n", aWindow));
return true;
}
mContext = NULL;
mDocumentMgr = NULL;
}
return false;
}
bool
nsTextStore::Destroy(void)
{
if (mWindow) {
// When blurred, Tablet Input Panel posts "blur" messages
// and try to insert text when the message is retrieved later.
// But by that time the text store is already destroyed,
// so try to get the message early
MSG msg;
if (::PeekMessageW(&msg, mWindow->GetWindowHandle(),
sFlushTIPInputMessage, sFlushTIPInputMessage,
PM_REMOVE)) {
::DispatchMessageW(&msg);
}
}
mContext = NULL;
if (mDocumentMgr) {
mDocumentMgr->Pop(TF_POPF_ALL);
mDocumentMgr = NULL;
}
mSink = NULL;
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: Destroyed, window=%08x\n", mWindow));
mWindow = NULL;
return true;
}
STDMETHODIMP
nsTextStore::QueryInterface(REFIID riid,
void** ppv)
{
*ppv=NULL;
if ( (IID_IUnknown == riid) || (IID_ITextStoreACP == riid) ) {
*ppv = static_cast<ITextStoreACP*>(this);
} else if (IID_ITfContextOwnerCompositionSink == riid) {
*ppv = static_cast<ITfContextOwnerCompositionSink*>(this);
}
if (*ppv) {
AddRef();
return S_OK;
}
return E_NOINTERFACE;
}
STDMETHODIMP_(ULONG) nsTextStore::AddRef()
{
return ++mRefCnt;
}
STDMETHODIMP_(ULONG) nsTextStore::Release()
{
--mRefCnt;
if (0 != mRefCnt)
return mRefCnt;
delete this;
return 0;
}
STDMETHODIMP
nsTextStore::AdviseSink(REFIID riid,
IUnknown *punk,
DWORD dwMask)
{
NS_ENSURE_TRUE(punk && IID_ITextStoreACPSink == riid, E_INVALIDARG);
if (!mSink) {
// Install sink
punk->QueryInterface(IID_ITextStoreACPSink, getter_AddRefs(mSink));
NS_ENSURE_TRUE(mSink, E_UNEXPECTED);
} else {
// If sink is already installed we check to see if they are the same
// Get IUnknown from both sides for comparison
nsRefPtr<IUnknown> comparison1, comparison2;
punk->QueryInterface(IID_IUnknown, getter_AddRefs(comparison1));
mSink->QueryInterface(IID_IUnknown, getter_AddRefs(comparison2));
if (comparison1 != comparison2)
return CONNECT_E_ADVISELIMIT;
}
// Update mask either for a new sink or an existing sink
mSinkMask = dwMask;
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: Sink installed, punk=%08x\n", punk));
return S_OK;
}
STDMETHODIMP
nsTextStore::UnadviseSink(IUnknown *punk)
{
NS_ENSURE_TRUE(punk, E_INVALIDARG);
NS_ENSURE_TRUE(mSink, CONNECT_E_NOCONNECTION);
// Get IUnknown from both sides for comparison
nsRefPtr<IUnknown> comparison1, comparison2;
punk->QueryInterface(IID_IUnknown, getter_AddRefs(comparison1));
mSink->QueryInterface(IID_IUnknown, getter_AddRefs(comparison2));
// Unadvise only if sinks are the same
NS_ENSURE_TRUE(comparison1 == comparison2, CONNECT_E_NOCONNECTION);
mSink = NULL;
mSinkMask = 0;
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: Sink removed, punk=%08x\n", punk));
return S_OK;
}
STDMETHODIMP
nsTextStore::RequestLock(DWORD dwLockFlags,
HRESULT *phrSession)
{
NS_ENSURE_TRUE(mSink, E_FAIL);
NS_ENSURE_TRUE(phrSession, E_INVALIDARG);
if (mLock) {
// only time when reentrant lock is allowed is when caller holds a
// read-only lock and is requesting an async write lock
if (TS_LF_READ == (mLock & TS_LF_READWRITE) &&
TS_LF_READWRITE == (dwLockFlags & TS_LF_READWRITE) &&
!(dwLockFlags & TS_LF_SYNC)) {
*phrSession = TS_S_ASYNC;
mLockQueued = dwLockFlags & (~TS_LF_SYNC);
} else {
// no more locks allowed
*phrSession = TS_E_SYNCHRONOUS;
return E_FAIL;
}
} else {
// put on lock
mLock = dwLockFlags & (~TS_LF_SYNC);
*phrSession = mSink->OnLockGranted(mLock);
while (mLockQueued) {
mLock = mLockQueued;
mLockQueued = 0;
mSink->OnLockGranted(mLock);
}
mLock = 0;
}
return S_OK;
}
STDMETHODIMP
nsTextStore::GetStatus(TS_STATUS *pdcs)
{
NS_ENSURE_TRUE(pdcs, E_INVALIDARG);
pdcs->dwDynamicFlags = 0;
// we use a "flat" text model for TSF support so no hidden text
pdcs->dwStaticFlags = TS_SS_NOHIDDENTEXT;
return S_OK;
}
STDMETHODIMP
nsTextStore::QueryInsert(LONG acpTestStart,
LONG acpTestEnd,
ULONG cch,
LONG *pacpResultStart,
LONG *pacpResultEnd)
{
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: QueryInsert, start=%ld end=%ld cch=%lu\n",
acpTestStart, acpTestEnd, cch));
// We don't test to see if these positions are
// after the end of document for performance reasons
NS_ENSURE_TRUE(0 <= acpTestStart && acpTestStart <= acpTestEnd &&
pacpResultStart && pacpResultEnd, E_INVALIDARG);
// XXX need to adjust to cluster boundary
// Assume we are given good offsets for now
*pacpResultStart = acpTestStart;
*pacpResultEnd = acpTestStart + cch;
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: QueryInsert SUCCEEDED\n"));
return S_OK;
}
STDMETHODIMP
nsTextStore::GetSelection(ULONG ulIndex,
ULONG ulCount,
TS_SELECTION_ACP *pSelection,
ULONG *pcFetched)
{
NS_ENSURE_TRUE(TS_LF_READ == (mLock & TS_LF_READ), TS_E_NOLOCK);
NS_ENSURE_TRUE(ulCount && pSelection && pcFetched, E_INVALIDARG);
*pcFetched = 0;
NS_ENSURE_TRUE((ULONG)TS_DEFAULT_SELECTION == ulIndex || 0 == ulIndex,
TS_E_NOSELECTION);
if (mCompositionView) {
// Emulate selection during compositions
*pSelection = mCompositionSelection;
} else {
// Construct and initialize an event to get selection info
nsQueryContentEvent event(true, NS_QUERY_SELECTED_TEXT, mWindow);
mWindow->InitEvent(event);
mWindow->DispatchWindowEvent(&event);
NS_ENSURE_TRUE(event.mSucceeded, E_FAIL);
// Usually the selection anchor (beginning) position corresponds to the
// TSF start and the selection focus (ending) position corresponds to
// the TSF end, but if selection is reversed the focus now corresponds
// to the TSF start and the anchor now corresponds to the TSF end
pSelection->acpStart = event.mReply.mOffset;
pSelection->acpEnd = pSelection->acpStart + event.mReply.mString.Length();
pSelection->style.ase = event.mReply.mString.Length() &&
event.mReply.mReversed ? TS_AE_START : TS_AE_END;
// No support for interim character
pSelection->style.fInterimChar = 0;
}
*pcFetched = 1;
return S_OK;
}
static HRESULT
GetRangeExtent(ITfRange* aRange, LONG* aStart, LONG* aLength)
{
nsRefPtr<ITfRangeACP> rangeACP;
aRange->QueryInterface(IID_ITfRangeACP, getter_AddRefs(rangeACP));
NS_ENSURE_TRUE(rangeACP, E_FAIL);
return rangeACP->GetExtent(aStart, aLength);
}
static uint32_t
GetGeckoSelectionValue(TF_DISPLAYATTRIBUTE &aDisplayAttr)
{
uint32_t result;
switch (aDisplayAttr.bAttr) {
case TF_ATTR_TARGET_CONVERTED:
result = NS_TEXTRANGE_SELECTEDCONVERTEDTEXT;
break;
case TF_ATTR_CONVERTED:
result = NS_TEXTRANGE_CONVERTEDTEXT;
break;
case TF_ATTR_TARGET_NOTCONVERTED:
result = NS_TEXTRANGE_SELECTEDRAWTEXT;
break;
default:
result = NS_TEXTRANGE_RAWINPUT;
break;
}
return result;
}
#ifdef PR_LOGGING
static void
GetLogTextFor(const TF_DA_COLOR &aColor, nsACString &aText)
{
aText = "type: ";
switch (aColor.type) {
case TF_CT_NONE:
aText += "TF_CT_NONE";
break;
case TF_CT_SYSCOLOR: {
nsPrintfCString tmp("TF_CT_SYSCOLOR, nIndex:0x%08X",
int32_t(aColor.nIndex));
aText += tmp;
break;
}
case TF_CT_COLORREF: {
nsPrintfCString tmp("TF_CT_COLORREF, cr:0x%08X", int32_t(aColor.cr));
aText += tmp;
break;
}
default: {
nsPrintfCString tmp("Unknown(%08X)", int32_t(aColor.type));
aText += tmp;
break;
}
}
}
static void
GetLogTextFor(TF_DA_LINESTYLE aLineStyle, nsACString &aText)
{
switch (aLineStyle) {
case TF_LS_NONE:
aText = "TF_LS_NONE";
break;
case TF_LS_SOLID:
aText = "TF_LS_SOLID";
break;
case TF_LS_DOT:
aText = "TF_LS_DOT";
break;
case TF_LS_DASH:
aText = "TF_LS_DASH";
break;
case TF_LS_SQUIGGLE:
aText = "TF_LS_SQUIGGLE";
break;
default: {
nsPrintfCString tmp("Unknown(%08X)", int32_t(aLineStyle));
aText = tmp;
break;
}
}
}
static void
GetLogTextFor(TF_DA_ATTR_INFO aAttr, nsACString &aText)
{
switch (aAttr) {
case TF_ATTR_INPUT:
aText = "TF_ATTR_INPUT";
break;
case TF_ATTR_TARGET_CONVERTED:
aText = "TF_ATTR_TARGET_CONVERTED";
break;
case TF_ATTR_CONVERTED:
aText = "TF_ATTR_CONVERTED";
break;
case TF_ATTR_TARGET_NOTCONVERTED:
aText = "TF_ATTR_TARGET_NOTCONVERTED";
break;
case TF_ATTR_INPUT_ERROR:
aText = "TF_ATTR_INPUT_ERROR";
break;
case TF_ATTR_FIXEDCONVERTED:
aText = "TF_ATTR_FIXEDCONVERTED";
break;
case TF_ATTR_OTHER:
aText = "TF_ATTR_OTHER";
break;
default: {
nsPrintfCString tmp("Unknown(%08X)", int32_t(aAttr));
aText = tmp;
break;
}
}
}
static nsCString
GetLogTextFor(const TF_DISPLAYATTRIBUTE &aDispAttr)
{
nsAutoCString str, tmp;
str = "crText:{ ";
GetLogTextFor(aDispAttr.crText, tmp);
str += tmp;
str += " }, crBk:{ ";
GetLogTextFor(aDispAttr.crBk, tmp);
str += tmp;
str += " }, lsStyle: ";
GetLogTextFor(aDispAttr.lsStyle, tmp);
str += tmp;
str += ", fBoldLine: ";
str += aDispAttr.fBoldLine ? "TRUE" : "FALSE";
str += ", crLine:{ ";
GetLogTextFor(aDispAttr.crLine, tmp);
str += tmp;
str += " }, bAttr: ";
GetLogTextFor(aDispAttr.bAttr, tmp);
str += tmp;
return str;
}
#endif // PR_LOGGING
HRESULT
nsTextStore::GetDisplayAttribute(ITfProperty* aAttrProperty,
ITfRange* aRange,
TF_DISPLAYATTRIBUTE* aResult)
{
NS_ENSURE_TRUE(aAttrProperty, E_FAIL);
NS_ENSURE_TRUE(aRange, E_FAIL);
NS_ENSURE_TRUE(aResult, E_FAIL);
HRESULT hr;
#ifdef PR_LOGGING
LONG start = 0, length = 0;
hr = GetRangeExtent(aRange, &start, &length);
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: GetDisplayAttribute range=%ld-%ld\n",
start - mCompositionStart, start - mCompositionStart + length));
#endif
VARIANT propValue;
::VariantInit(&propValue);
hr = aAttrProperty->GetValue(TfEditCookie(mEditCookie), aRange, &propValue);
if (FAILED(hr)) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
(" ITfProperty::GetValue Failed\n"));
return hr;
}
if (VT_I4 != propValue.vt) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
(" ITfProperty::GetValue returns non-VT_I4 value\n"));
::VariantClear(&propValue);
return E_FAIL;
}
NS_ENSURE_TRUE(sCategoryMgr, E_FAIL);
GUID guid;
hr = sCategoryMgr->GetGUID(DWORD(propValue.lVal), &guid);
::VariantClear(&propValue);
if (FAILED(hr)) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
(" ITfCategoryMgr::GetGUID Failed\n"));
return hr;
}
NS_ENSURE_TRUE(sDisplayAttrMgr, E_FAIL);
nsRefPtr<ITfDisplayAttributeInfo> info;
hr = sDisplayAttrMgr->GetDisplayAttributeInfo(guid, getter_AddRefs(info),
NULL);
if (FAILED(hr) || !info) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
(" ITfDisplayAttributeMgr::GetDisplayAttributeInfo Failed\n"));
return hr;
}
hr = info->GetAttributeInfo(aResult);
if (FAILED(hr)) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
(" ITfDisplayAttributeInfo::GetAttributeInfo Failed\n"));
return hr;
}
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: GetDisplayAttribute Result={ %s }\n",
GetLogTextFor(*aResult).get()));
return S_OK;
}
HRESULT
nsTextStore::SaveTextEvent(const nsTextEvent* aEvent)
{
if (mLastDispatchedTextEvent) {
if (mLastDispatchedTextEvent->rangeArray)
delete [] mLastDispatchedTextEvent->rangeArray;
delete mLastDispatchedTextEvent;
mLastDispatchedTextEvent = nullptr;
}
if (!aEvent)
return S_OK;
mLastDispatchedTextEvent = new nsTextEvent(true, NS_TEXT_TEXT, nullptr);
if (!mLastDispatchedTextEvent)
return E_OUTOFMEMORY;
mLastDispatchedTextEvent->rangeCount = aEvent->rangeCount;
mLastDispatchedTextEvent->theText = aEvent->theText;
mLastDispatchedTextEvent->rangeArray = nullptr;
if (aEvent->rangeCount == 0)
return S_OK;
NS_ENSURE_TRUE(aEvent->rangeArray, E_FAIL);
mLastDispatchedTextEvent->rangeArray = new nsTextRange[aEvent->rangeCount];
if (!mLastDispatchedTextEvent->rangeArray) {
delete mLastDispatchedTextEvent;
mLastDispatchedTextEvent = nullptr;
return E_OUTOFMEMORY;
}
memcpy(mLastDispatchedTextEvent->rangeArray, aEvent->rangeArray,
sizeof(nsTextRange) * aEvent->rangeCount);
return S_OK;
}
static bool
IsSameTextEvent(const nsTextEvent* aEvent1, const nsTextEvent* aEvent2)
{
NS_PRECONDITION(aEvent1 || aEvent2, "both events are null");
NS_PRECONDITION(aEvent2 && (aEvent1 != aEvent2),
"both events are same instance");
return (aEvent1 && aEvent2 &&
aEvent1->rangeCount == aEvent2->rangeCount &&
aEvent1->theText == aEvent2->theText &&
(aEvent1->rangeCount == 0 ||
((aEvent1->rangeArray && aEvent2->rangeArray) &&
!memcmp(aEvent1->rangeArray, aEvent2->rangeArray,
sizeof(nsTextRange) * aEvent1->rangeCount))));
}
HRESULT
nsTextStore::UpdateCompositionExtent(ITfRange* aRangeNew)
{
NS_ENSURE_TRUE(mCompositionView, E_FAIL);
HRESULT hr;
nsRefPtr<ITfCompositionView> pComposition(mCompositionView);
nsRefPtr<ITfRange> composingRange(aRangeNew);
if (!composingRange) {
hr = pComposition->GetRange(getter_AddRefs(composingRange));
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
}
// Get starting offset of the composition
LONG compStart = 0, compLength = 0;
hr = GetRangeExtent(composingRange, &compStart, &compLength);
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
if (mCompositionStart != compStart ||
mCompositionString.Length() != (ULONG)compLength) {
// If the queried composition length is different from the length
// of our composition string, OnUpdateComposition is being called
// because a part of the original composition was committed.
// Reflect that by committing existing composition and starting
// a new one. OnEndComposition followed by OnStartComposition
// will accomplish this automagically.
OnEndComposition(pComposition);
OnStartCompositionInternal(pComposition, composingRange, true);
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: UpdateCompositionExtent, (reset) range=%ld-%ld\n",
compStart, compStart + compLength));
} else {
mCompositionLength = compLength;
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: UpdateCompositionExtent, range=%ld-%ld\n",
compStart, compStart + compLength));
}
return S_OK;
}
static bool
GetColor(const TF_DA_COLOR &aTSFColor, nscolor &aResult)
{
switch (aTSFColor.type) {
case TF_CT_SYSCOLOR: {
DWORD sysColor = ::GetSysColor(aTSFColor.nIndex);
aResult = NS_RGB(GetRValue(sysColor), GetGValue(sysColor),
GetBValue(sysColor));
return true;
}
case TF_CT_COLORREF:
aResult = NS_RGB(GetRValue(aTSFColor.cr), GetGValue(aTSFColor.cr),
GetBValue(aTSFColor.cr));
return true;
case TF_CT_NONE:
default:
return false;
}
}
static bool
GetLineStyle(TF_DA_LINESTYLE aTSFLineStyle, uint8_t &aTextRangeLineStyle)
{
switch (aTSFLineStyle) {
case TF_LS_NONE:
aTextRangeLineStyle = nsTextRangeStyle::LINESTYLE_NONE;
return true;
case TF_LS_SOLID:
aTextRangeLineStyle = nsTextRangeStyle::LINESTYLE_SOLID;
return true;
case TF_LS_DOT:
aTextRangeLineStyle = nsTextRangeStyle::LINESTYLE_DOTTED;
return true;
case TF_LS_DASH:
aTextRangeLineStyle = nsTextRangeStyle::LINESTYLE_DASHED;
return true;
case TF_LS_SQUIGGLE:
aTextRangeLineStyle = nsTextRangeStyle::LINESTYLE_WAVY;
return true;
default:
return false;
}
}
HRESULT
nsTextStore::SendTextEventForCompositionString()
{
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SendTextEventForCompositionString\n"));
NS_ENSURE_TRUE(mCompositionView, E_FAIL);
// Getting display attributes is *really* complicated!
// We first get the context and the property objects to query for
// attributes, but since a big range can have a variety of values for
// the attribute, we have to find out all the ranges that have distinct
// attribute values. Then we query for what the value represents through
// the display attribute manager and translate that to nsTextRange to be
// sent in NS_TEXT_TEXT
nsRefPtr<ITfProperty> attrPropetry;
HRESULT hr = mContext->GetProperty(GUID_PROP_ATTRIBUTE,
getter_AddRefs(attrPropetry));
NS_ENSURE_TRUE(SUCCEEDED(hr) && attrPropetry, hr);
// Use NS_TEXT_TEXT to set composition string
nsTextEvent event(true, NS_TEXT_TEXT, mWindow);
mWindow->InitEvent(event);
nsRefPtr<ITfRange> composingRange;
hr = mCompositionView->GetRange(getter_AddRefs(composingRange));
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
nsRefPtr<IEnumTfRanges> enumRanges;
hr = attrPropetry->EnumRanges(TfEditCookie(mEditCookie),
getter_AddRefs(enumRanges), composingRange);
NS_ENSURE_TRUE(SUCCEEDED(hr) && enumRanges, hr);
nsAutoTArray<nsTextRange, 4> textRanges;
nsTextRange newRange;
// No matter if we have display attribute info or not,
// we always pass in at least one range to NS_TEXT_TEXT
newRange.mStartOffset = 0;
newRange.mEndOffset = mCompositionString.Length();
newRange.mRangeType = NS_TEXTRANGE_RAWINPUT;
textRanges.AppendElement(newRange);
nsRefPtr<ITfRange> range;
while (S_OK == enumRanges->Next(1, getter_AddRefs(range), NULL) && range) {
LONG start = 0, length = 0;
if (FAILED(GetRangeExtent(range, &start, &length)))
continue;
nsTextRange newRange;
newRange.mStartOffset = uint32_t(start - mCompositionStart);
// The end of the last range in the array is
// always kept at the end of composition
newRange.mEndOffset = mCompositionString.Length();
TF_DISPLAYATTRIBUTE attr;
hr = GetDisplayAttribute(attrPropetry, range, &attr);
if (FAILED(hr)) {
newRange.mRangeType = NS_TEXTRANGE_RAWINPUT;
} else {
newRange.mRangeType = GetGeckoSelectionValue(attr);
if (GetColor(attr.crText, newRange.mRangeStyle.mForegroundColor)) {
newRange.mRangeStyle.mDefinedStyles |=
nsTextRangeStyle::DEFINED_FOREGROUND_COLOR;
}
if (GetColor(attr.crBk, newRange.mRangeStyle.mBackgroundColor)) {
newRange.mRangeStyle.mDefinedStyles |=
nsTextRangeStyle::DEFINED_BACKGROUND_COLOR;
}
if (GetColor(attr.crLine, newRange.mRangeStyle.mUnderlineColor)) {
newRange.mRangeStyle.mDefinedStyles |=
nsTextRangeStyle::DEFINED_UNDERLINE_COLOR;
}
if (GetLineStyle(attr.lsStyle, newRange.mRangeStyle.mLineStyle)) {
newRange.mRangeStyle.mDefinedStyles |=
nsTextRangeStyle::DEFINED_LINESTYLE;
newRange.mRangeStyle.mIsBoldLine = attr.fBoldLine != 0;
}
}
nsTextRange& lastRange = textRanges[textRanges.Length() - 1];
if (lastRange.mStartOffset == newRange.mStartOffset) {
// Replace range if last range is the same as this one
// So that ranges don't overlap and confuse the editor
lastRange = newRange;
} else {
lastRange.mEndOffset = newRange.mStartOffset;
textRanges.AppendElement(newRange);
}
}
// We need to hack for Korean Input System which is Korean standard TIP.
// It sets no change style to IME selection (the selection is always only
// one). So, the composition string looks like normal (or committed) string.
// At this time, mCompositionSelection range is same as the composition
// string range. Other applications set a wide caret which covers the
// composition string, however, Gecko doesn't support the wide caret drawing
// now (Gecko doesn't support XOR drawing), unfortunately. For now, we should
// change the range style to undefined.
if (mCompositionSelection.acpStart != mCompositionSelection.acpEnd &&
textRanges.Length() == 1) {
nsTextRange& range = textRanges[0];
LONG start = NS_MIN(mCompositionSelection.acpStart,
mCompositionSelection.acpEnd);
LONG end = NS_MAX(mCompositionSelection.acpStart,
mCompositionSelection.acpEnd);
if ((LONG)range.mStartOffset == start - mCompositionStart &&
(LONG)range.mEndOffset == end - mCompositionStart &&
range.mRangeStyle.IsNoChangeStyle()) {
range.mRangeStyle.Clear();
// The looks of selected type is better than others.
range.mRangeType = NS_TEXTRANGE_SELECTEDRAWTEXT;
}
}
// The caret position has to be collapsed.
LONG caretPosition = NS_MAX(mCompositionSelection.acpStart,
mCompositionSelection.acpEnd);
caretPosition -= mCompositionStart;
nsTextRange caretRange;
caretRange.mStartOffset = caretRange.mEndOffset = uint32_t(caretPosition);
caretRange.mRangeType = NS_TEXTRANGE_CARETPOSITION;
textRanges.AppendElement(caretRange);
event.theText = mCompositionString;
event.rangeArray = textRanges.Elements();
event.rangeCount = textRanges.Length();
// If we are already send same text event, we should not resend it. Because
// it can be a cause of flickering.
if (IsSameTextEvent(mLastDispatchedTextEvent, &event)) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SendTextEventForCompositionString does not dispatch\n"));
return S_OK;
}
if (mCompositionString != mLastDispatchedCompositionString) {
nsCompositionEvent compositionUpdate(true, NS_COMPOSITION_UPDATE,
mWindow);
mWindow->InitEvent(compositionUpdate);
compositionUpdate.data = mCompositionString;
mLastDispatchedCompositionString = mCompositionString;
mWindow->DispatchWindowEvent(&compositionUpdate);
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SendTextEventForCompositionString compositionupdate "
"DISPATCHED\n"));
}
if (mWindow && !mWindow->Destroyed()) {
mWindow->DispatchWindowEvent(&event);
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SendTextEventForCompositionString text event DISPATCHED\n"));
}
return SaveTextEvent(&event);
}
HRESULT
nsTextStore::SetSelectionInternal(const TS_SELECTION_ACP* pSelection,
bool aDispatchTextEvent)
{
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SetSelection, sel=%ld-%ld\n",
pSelection->acpStart, pSelection->acpEnd));
if (mCompositionView) {
if (aDispatchTextEvent) {
HRESULT hr = UpdateCompositionExtent(nullptr);
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
}
// Emulate selection during compositions
NS_ENSURE_TRUE(pSelection->acpStart >= mCompositionStart &&
pSelection->acpEnd <= mCompositionStart +
LONG(mCompositionString.Length()), TS_E_INVALIDPOS);
mCompositionSelection = *pSelection;
if (aDispatchTextEvent) {
HRESULT hr = SendTextEventForCompositionString();
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
}
} else {
nsSelectionEvent event(true, NS_SELECTION_SET, mWindow);
event.mOffset = pSelection->acpStart;
event.mLength = uint32_t(pSelection->acpEnd - pSelection->acpStart);
event.mReversed = pSelection->style.ase == TS_AE_START;
mWindow->InitEvent(event);
mWindow->DispatchWindowEvent(&event);
NS_ENSURE_TRUE(event.mSucceeded, E_FAIL);
}
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SetSelection SUCCEEDED\n"));
return S_OK;
}
STDMETHODIMP
nsTextStore::SetSelection(ULONG ulCount,
const TS_SELECTION_ACP *pSelection)
{
NS_ENSURE_TRUE(TS_LF_READWRITE == (mLock & TS_LF_READWRITE), TS_E_NOLOCK);
NS_ENSURE_TRUE(1 == ulCount && pSelection, E_INVALIDARG);
return SetSelectionInternal(pSelection, true);
}
STDMETHODIMP
nsTextStore::GetText(LONG acpStart,
LONG acpEnd,
WCHAR *pchPlain,
ULONG cchPlainReq,
ULONG *pcchPlainOut,
TS_RUNINFO *prgRunInfo,
ULONG ulRunInfoReq,
ULONG *pulRunInfoOut,
LONG *pacpNext)
{
NS_ENSURE_TRUE(TS_LF_READ == (mLock & TS_LF_READ), TS_E_NOLOCK);
NS_ENSURE_TRUE(pcchPlainOut && (pchPlain || prgRunInfo) &&
(!cchPlainReq == !pchPlain) &&
(!ulRunInfoReq == !prgRunInfo), E_INVALIDARG);
NS_ENSURE_TRUE(0 <= acpStart && -1 <= acpEnd &&
(-1 == acpEnd || acpStart <= acpEnd), TS_E_INVALIDPOS);
// Making sure to NULL-terminate string just to be on the safe side
*pcchPlainOut = 0;
if (pchPlain && cchPlainReq) *pchPlain = 0;
if (pulRunInfoOut) *pulRunInfoOut = 0;
if (pacpNext) *pacpNext = acpStart;
if (prgRunInfo && ulRunInfoReq) {
prgRunInfo->uCount = 0;
prgRunInfo->type = TS_RT_PLAIN;
}
uint32_t length = -1 == acpEnd ? PR_UINT32_MAX : uint32_t(acpEnd - acpStart);
if (cchPlainReq && cchPlainReq - 1 < length) {
length = cchPlainReq - 1;
}
if (length) {
LONG compNewStart = 0, compOldEnd = 0, compNewEnd = 0;
if (mCompositionView) {
// Sometimes GetText gets called between InsertTextAtSelection and
// OnUpdateComposition. In this case the returned text would
// be out of sync because we haven't sent NS_TEXT_TEXT in
// OnUpdateComposition yet. Manually resync here.
compOldEnd = NS_MIN(LONG(length) + acpStart,
mCompositionLength + mCompositionStart);
compNewEnd = NS_MIN(LONG(length) + acpStart,
LONG(mCompositionString.Length()) + mCompositionStart);
compNewStart = NS_MAX(acpStart, mCompositionStart);
// Check if the range is affected
if (compOldEnd > compNewStart || compNewEnd > compNewStart) {
NS_ASSERTION(compOldEnd >= mCompositionStart &&
compNewEnd >= mCompositionStart, "Range end is less than start\n");
length = uint32_t(LONG(length) + compOldEnd - compNewEnd);
}
}
// Send NS_QUERY_TEXT_CONTENT to get text content
nsQueryContentEvent event(true, NS_QUERY_TEXT_CONTENT, mWindow);
mWindow->InitEvent(event);
event.InitForQueryTextContent(uint32_t(acpStart), length);
mWindow->DispatchWindowEvent(&event);
NS_ENSURE_TRUE(event.mSucceeded, E_FAIL);
if (compOldEnd > compNewStart || compNewEnd > compNewStart) {
// Resync composition string
const PRUnichar* compStrStart = mCompositionString.BeginReading() +
NS_MAX<LONG>(compNewStart - mCompositionStart, 0);
event.mReply.mString.Replace(compNewStart - acpStart,
compOldEnd - mCompositionStart, compStrStart,
compNewEnd - mCompositionStart);
length = uint32_t(LONG(length) - compOldEnd + compNewEnd);
}
NS_ENSURE_TRUE(-1 == acpEnd || event.mReply.mString.Length() == length,
TS_E_INVALIDPOS);
length = NS_MIN(length, event.mReply.mString.Length());
if (pchPlain && cchPlainReq) {
memcpy(pchPlain, event.mReply.mString.BeginReading(),
length * sizeof(*pchPlain));
pchPlain[length] = 0;
*pcchPlainOut = length;
}
if (prgRunInfo && ulRunInfoReq) {
prgRunInfo->uCount = length;
prgRunInfo->type = TS_RT_PLAIN;
if (pulRunInfoOut) *pulRunInfoOut = 1;
}
if (pacpNext) *pacpNext = acpStart + length;
}
return S_OK;
}
STDMETHODIMP
nsTextStore::SetText(DWORD dwFlags,
LONG acpStart,
LONG acpEnd,
const WCHAR *pchText,
ULONG cch,
TS_TEXTCHANGE *pChange)
{
// Per SDK documentation, and since we don't have better
// ways to do this, this method acts as a helper to
// call SetSelection followed by InsertTextAtSelection
NS_ENSURE_TRUE(TS_LF_READWRITE == (mLock & TS_LF_READWRITE), TS_E_NOLOCK);
TS_SELECTION_ACP selection;
selection.acpStart = acpStart;
selection.acpEnd = acpEnd;
selection.style.ase = TS_AE_END;
selection.style.fInterimChar = 0;
// Set selection to desired range
NS_ENSURE_TRUE(SUCCEEDED(SetSelectionInternal(&selection)), E_FAIL);
// Replace just selected text
return InsertTextAtSelection(TS_IAS_NOQUERY, pchText, cch,
NULL, NULL, pChange);
}
STDMETHODIMP
nsTextStore::GetFormattedText(LONG acpStart,
LONG acpEnd,
IDataObject **ppDataObject)
{
// no support for formatted text
return E_NOTIMPL;
}
STDMETHODIMP
nsTextStore::GetEmbedded(LONG acpPos,
REFGUID rguidService,
REFIID riid,
IUnknown **ppunk)
{
// embedded objects are not supported
return E_NOTIMPL;
}
STDMETHODIMP
nsTextStore::QueryInsertEmbedded(const GUID *pguidService,
const FORMATETC *pFormatEtc,
BOOL *pfInsertable)
{
// embedded objects are not supported
*pfInsertable = FALSE;
return S_OK;
}
STDMETHODIMP
nsTextStore::InsertEmbedded(DWORD dwFlags,
LONG acpStart,
LONG acpEnd,
IDataObject *pDataObject,
TS_TEXTCHANGE *pChange)
{
// embedded objects are not supported
return E_NOTIMPL;
}
STDMETHODIMP
nsTextStore::RequestSupportedAttrs(DWORD dwFlags,
ULONG cFilterAttrs,
const TS_ATTRID *paFilterAttrs)
{
// no attributes defined
return S_OK;
}
STDMETHODIMP
nsTextStore::RequestAttrsAtPosition(LONG acpPos,
ULONG cFilterAttrs,
const TS_ATTRID *paFilterAttrs,
DWORD dwFlags)
{
// no per character attributes defined
return S_OK;
}
STDMETHODIMP
nsTextStore::RequestAttrsTransitioningAtPosition(LONG acpPos,
ULONG cFilterAttrs,
const TS_ATTRID *paFilterAttr,
DWORD dwFlags)
{
// no per character attributes defined
return S_OK;
}
STDMETHODIMP
nsTextStore::FindNextAttrTransition(LONG acpStart,
LONG acpHalt,
ULONG cFilterAttrs,
const TS_ATTRID *paFilterAttrs,
DWORD dwFlags,
LONG *pacpNext,
BOOL *pfFound,
LONG *plFoundOffset)
{
NS_ENSURE_TRUE(pacpNext && pfFound && plFoundOffset, E_INVALIDARG);
// no per character attributes defined
*pacpNext = *plFoundOffset = acpHalt;
*pfFound = FALSE;
return S_OK;
}
STDMETHODIMP
nsTextStore::RetrieveRequestedAttrs(ULONG ulCount,
TS_ATTRVAL *paAttrVals,
ULONG *pcFetched)
{
NS_ENSURE_TRUE(pcFetched && ulCount && paAttrVals, E_INVALIDARG);
// no attributes defined
*pcFetched = 0;
return S_OK;
}
STDMETHODIMP
nsTextStore::GetEndACP(LONG *pacp)
{
NS_ENSURE_TRUE(TS_LF_READ == (mLock & TS_LF_READ), TS_E_NOLOCK);
NS_ENSURE_TRUE(pacp, E_INVALIDARG);
// Flattened text is retrieved and its length returned
nsQueryContentEvent event(true, NS_QUERY_TEXT_CONTENT, mWindow);
mWindow->InitEvent(event);
// Return entire text
event.InitForQueryTextContent(0, PR_INT32_MAX);
mWindow->DispatchWindowEvent(&event);
NS_ENSURE_TRUE(event.mSucceeded, E_FAIL);
*pacp = LONG(event.mReply.mString.Length());
return S_OK;
}
#define TEXTSTORE_DEFAULT_VIEW (1)
STDMETHODIMP
nsTextStore::GetActiveView(TsViewCookie *pvcView)
{
NS_ENSURE_TRUE(pvcView, E_INVALIDARG);
*pvcView = TEXTSTORE_DEFAULT_VIEW;
return S_OK;
}
STDMETHODIMP
nsTextStore::GetACPFromPoint(TsViewCookie vcView,
const POINT *pt,
DWORD dwFlags,
LONG *pacp)
{
NS_ENSURE_TRUE(TS_LF_READ == (mLock & TS_LF_READ), TS_E_NOLOCK);
NS_ENSURE_TRUE(TEXTSTORE_DEFAULT_VIEW == vcView, E_INVALIDARG);
// not supported for now
return E_NOTIMPL;
}
STDMETHODIMP
nsTextStore::GetTextExt(TsViewCookie vcView,
LONG acpStart,
LONG acpEnd,
RECT *prc,
BOOL *pfClipped)
{
NS_ENSURE_TRUE(TS_LF_READ == (mLock & TS_LF_READ), TS_E_NOLOCK);
NS_ENSURE_TRUE(TEXTSTORE_DEFAULT_VIEW == vcView && prc && pfClipped,
E_INVALIDARG);
NS_ENSURE_TRUE(acpStart >= 0 && acpEnd >= acpStart, TS_E_INVALIDPOS);
// use NS_QUERY_TEXT_RECT to get rect in system, screen coordinates
nsQueryContentEvent event(true, NS_QUERY_TEXT_RECT, mWindow);
mWindow->InitEvent(event);
event.InitForQueryTextRect(acpStart, acpEnd - acpStart);
mWindow->DispatchWindowEvent(&event);
NS_ENSURE_TRUE(event.mSucceeded, TS_E_INVALIDPOS);
// IMEs don't like empty rects, fix here
if (event.mReply.mRect.width <= 0)
event.mReply.mRect.width = 1;
if (event.mReply.mRect.height <= 0)
event.mReply.mRect.height = 1;
// convert to unclipped screen rect
nsWindow* refWindow = static_cast<nsWindow*>(
event.mReply.mFocusedWidget ? event.mReply.mFocusedWidget : mWindow);
// Result rect is in top level widget coordinates
refWindow = refWindow->GetTopLevelWindow(false);
NS_ENSURE_TRUE(refWindow, E_FAIL);
event.mReply.mRect.MoveBy(refWindow->WidgetToScreenOffset());
// get bounding screen rect to test for clipping
HRESULT hr = GetScreenExt(vcView, prc);
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
// clip text rect to bounding rect
RECT textRect;
::SetRect(&textRect, event.mReply.mRect.x, event.mReply.mRect.y,
event.mReply.mRect.XMost(), event.mReply.mRect.YMost());
if (!::IntersectRect(prc, prc, &textRect))
// Text is not visible
::SetRectEmpty(prc);
// not equal if text rect was clipped
*pfClipped = !::EqualRect(prc, &textRect);
return S_OK;
}
STDMETHODIMP
nsTextStore::GetScreenExt(TsViewCookie vcView,
RECT *prc)
{
NS_ENSURE_TRUE(TEXTSTORE_DEFAULT_VIEW == vcView && prc, E_INVALIDARG);
// use NS_QUERY_EDITOR_RECT to get rect in system, screen coordinates
nsQueryContentEvent event(true, NS_QUERY_EDITOR_RECT, mWindow);
mWindow->InitEvent(event);
mWindow->DispatchWindowEvent(&event);
NS_ENSURE_TRUE(event.mSucceeded, E_FAIL);
nsWindow* refWindow = static_cast<nsWindow*>(
event.mReply.mFocusedWidget ? event.mReply.mFocusedWidget : mWindow);
// Result rect is in top level widget coordinates
refWindow = refWindow->GetTopLevelWindow(false);
NS_ENSURE_TRUE(refWindow, E_FAIL);
nsIntRect boundRect;
nsresult rv = refWindow->GetClientBounds(boundRect);
NS_ENSURE_SUCCESS(rv, E_FAIL);
boundRect.MoveTo(0, 0);
// Clip frame rect to window rect
boundRect.IntersectRect(event.mReply.mRect, boundRect);
if (!boundRect.IsEmpty()) {
boundRect.MoveBy(refWindow->WidgetToScreenOffset());
::SetRect(prc, boundRect.x, boundRect.y,
boundRect.XMost(), boundRect.YMost());
} else {
::SetRectEmpty(prc);
}
return S_OK;
}
STDMETHODIMP
nsTextStore::GetWnd(TsViewCookie vcView,
HWND *phwnd)
{
NS_ENSURE_TRUE(TEXTSTORE_DEFAULT_VIEW == vcView && phwnd, E_INVALIDARG);
*phwnd = mWindow->GetWindowHandle();
return S_OK;
}
STDMETHODIMP
nsTextStore::InsertTextAtSelection(DWORD dwFlags,
const WCHAR *pchText,
ULONG cch,
LONG *pacpStart,
LONG *pacpEnd,
TS_TEXTCHANGE *pChange)
{
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: InsertTextAtSelection, cch=%lu\n", cch));
NS_ENSURE_TRUE(TS_LF_READWRITE == (mLock & TS_LF_READWRITE), TS_E_NOLOCK);
NS_ENSURE_TRUE(!cch || pchText, E_INVALIDARG);
// Get selection first
TS_SELECTION_ACP sel;
ULONG selFetched;
NS_ENSURE_TRUE(SUCCEEDED(GetSelection(
TS_DEFAULT_SELECTION, 1, &sel, &selFetched)) && selFetched, E_FAIL);
if (TS_IAS_QUERYONLY == dwFlags) {
NS_ENSURE_TRUE(pacpStart && pacpEnd, E_INVALIDARG);
// Simulate text insertion
*pacpStart = sel.acpStart;
*pacpEnd = sel.acpEnd;
if (pChange) {
pChange->acpStart = sel.acpStart;
pChange->acpOldEnd = sel.acpEnd;
pChange->acpNewEnd = sel.acpStart + cch;
}
} else {
NS_ENSURE_TRUE(pChange, E_INVALIDARG);
NS_ENSURE_TRUE(TS_IAS_NOQUERY == dwFlags || (pacpStart && pacpEnd),
E_INVALIDARG);
if (mCompositionView) {
// Emulate text insertion during compositions, because during a
// composition, editor expects the whole composition string to
// be sent in NS_TEXT_TEXT, not just the inserted part.
// The actual NS_TEXT_TEXT will be sent in SetSelection or
// OnUpdateComposition.
mCompositionString.Replace(uint32_t(sel.acpStart - mCompositionStart),
sel.acpEnd - sel.acpStart, pchText, cch);
mCompositionSelection.acpStart += cch;
mCompositionSelection.acpEnd = mCompositionSelection.acpStart;
mCompositionSelection.style.ase = TS_AE_END;
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: InsertTextAtSelection, replaced=%lu-%lu\n",
sel.acpStart - mCompositionStart,
sel.acpEnd - mCompositionStart));
} else {
// Use a temporary composition to contain the text
nsCompositionEvent compEvent(true, NS_COMPOSITION_START, mWindow);
mWindow->InitEvent(compEvent);
mWindow->DispatchWindowEvent(&compEvent);
if (mWindow && !mWindow->Destroyed()) {
compEvent.message = NS_COMPOSITION_UPDATE;
compEvent.data.Assign(pchText, cch);
mWindow->DispatchWindowEvent(&compEvent);
if (mWindow && !mWindow->Destroyed()) {
nsTextEvent event(true, NS_TEXT_TEXT, mWindow);
mWindow->InitEvent(event);
event.theText.Assign(pchText, cch);
event.theText.ReplaceSubstring(NS_LITERAL_STRING("\r\n"),
NS_LITERAL_STRING("\n"));
mWindow->DispatchWindowEvent(&event);
if (mWindow && !mWindow->Destroyed()) {
compEvent.message = NS_COMPOSITION_END;
mWindow->DispatchWindowEvent(&compEvent);
}
}
}
}
pChange->acpStart = sel.acpStart;
pChange->acpOldEnd = sel.acpEnd;
// Get new selection
NS_ENSURE_TRUE(SUCCEEDED(GetSelection(
TS_DEFAULT_SELECTION, 1, &sel, &selFetched)) && selFetched, E_FAIL);
pChange->acpNewEnd = sel.acpEnd;
if (TS_IAS_NOQUERY != dwFlags) {
*pacpStart = pChange->acpStart;
*pacpEnd = pChange->acpNewEnd;
}
}
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: InsertTextAtSelection SUCCEEDED\n"));
return S_OK;
}
STDMETHODIMP
nsTextStore::InsertEmbeddedAtSelection(DWORD dwFlags,
IDataObject *pDataObject,
LONG *pacpStart,
LONG *pacpEnd,
TS_TEXTCHANGE *pChange)
{
// embedded objects are not supported
return E_NOTIMPL;
}
HRESULT
nsTextStore::OnStartCompositionInternal(ITfCompositionView* pComposition,
ITfRange* aRange,
bool aPreserveSelection)
{
mCompositionView = pComposition;
HRESULT hr = GetRangeExtent(aRange, &mCompositionStart, &mCompositionLength);
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: OnStartComposition, range=%ld-%ld\n", mCompositionStart,
mCompositionStart + mCompositionLength));
// Select composition range so the new composition replaces the range
nsSelectionEvent selEvent(true, NS_SELECTION_SET, mWindow);
mWindow->InitEvent(selEvent);
selEvent.mOffset = uint32_t(mCompositionStart);
selEvent.mLength = uint32_t(mCompositionLength);
selEvent.mReversed = false;
mWindow->DispatchWindowEvent(&selEvent);
NS_ENSURE_TRUE(selEvent.mSucceeded, E_FAIL);
// Set up composition
nsQueryContentEvent queryEvent(true, NS_QUERY_SELECTED_TEXT, mWindow);
mWindow->InitEvent(queryEvent);
mWindow->DispatchWindowEvent(&queryEvent);
NS_ENSURE_TRUE(queryEvent.mSucceeded, E_FAIL);
mCompositionString = queryEvent.mReply.mString;
if (!aPreserveSelection) {
mCompositionSelection.acpStart = mCompositionStart;
mCompositionSelection.acpEnd = mCompositionStart + mCompositionLength;
mCompositionSelection.style.ase = TS_AE_END;
mCompositionSelection.style.fInterimChar = FALSE;
}
nsCompositionEvent event(true, NS_COMPOSITION_START, mWindow);
mWindow->InitEvent(event);
mWindow->DispatchWindowEvent(&event);
return S_OK;
}
static uint32_t
GetLayoutChangeIntervalTime()
{
static int32_t sTime = -1;
if (sTime > 0)
return uint32_t(sTime);
sTime = NS_MAX(10,
Preferences::GetInt("intl.tsf.on_layout_change_interval", 100));
return uint32_t(sTime);
}
STDMETHODIMP
nsTextStore::OnStartComposition(ITfCompositionView* pComposition,
BOOL* pfOk)
{
*pfOk = FALSE;
// Only one composition at a time
if (mCompositionView)
return S_OK;
nsRefPtr<ITfRange> range;
HRESULT hr = pComposition->GetRange(getter_AddRefs(range));
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
hr = OnStartCompositionInternal(pComposition, range, false);
if (FAILED(hr))
return hr;
NS_ASSERTION(!mCompositionTimer, "The timer is alive!");
mCompositionTimer = do_CreateInstance(NS_TIMER_CONTRACTID);
if (mCompositionTimer) {
mCompositionTimer->InitWithFuncCallback(CompositionTimerCallbackFunc, this,
GetLayoutChangeIntervalTime(),
nsITimer::TYPE_REPEATING_SLACK);
}
*pfOk = TRUE;
return S_OK;
}
STDMETHODIMP
nsTextStore::OnUpdateComposition(ITfCompositionView* pComposition,
ITfRange* pRangeNew)
{
NS_ENSURE_TRUE(mCompositionView &&
mCompositionView == pComposition &&
mDocumentMgr && mContext, E_UNEXPECTED);
if (!pRangeNew) // pRangeNew is null when the update is not complete
return S_OK;
HRESULT hr = UpdateCompositionExtent(pRangeNew);
NS_ENSURE_TRUE(SUCCEEDED(hr), hr);
return SendTextEventForCompositionString();
}
STDMETHODIMP
nsTextStore::OnEndComposition(ITfCompositionView* pComposition)
{
NS_ENSURE_TRUE(mCompositionView &&
mCompositionView == pComposition, E_UNEXPECTED);
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: OnEndComposition\n"));
// Clear the saved text event
SaveTextEvent(nullptr);
if (mCompositionTimer) {
mCompositionTimer->Cancel();
mCompositionTimer = nullptr;
}
if (mCompositionString != mLastDispatchedCompositionString) {
nsCompositionEvent compositionUpdate(true, NS_COMPOSITION_UPDATE,
mWindow);
mWindow->InitEvent(compositionUpdate);
compositionUpdate.data = mCompositionString;
mLastDispatchedCompositionString = mCompositionString;
mWindow->DispatchWindowEvent(&compositionUpdate);
if (!mWindow || mWindow->Destroyed()) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: CompositionUpdate caused aborting compositionend\n"));
return S_OK;
}
}
// Use NS_TEXT_TEXT to commit composition string
nsTextEvent textEvent(true, NS_TEXT_TEXT, mWindow);
mWindow->InitEvent(textEvent);
textEvent.theText = mCompositionString;
textEvent.theText.ReplaceSubstring(NS_LITERAL_STRING("\r\n"),
NS_LITERAL_STRING("\n"));
mWindow->DispatchWindowEvent(&textEvent);
if (!mWindow || mWindow->Destroyed()) {
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: Text event caused aborting compositionend\n"));
return S_OK;
}
nsCompositionEvent event(true, NS_COMPOSITION_END, mWindow);
event.data = mLastDispatchedCompositionString;
mWindow->InitEvent(event);
mWindow->DispatchWindowEvent(&event);
mCompositionView = NULL;
mCompositionString.Truncate(0);
mLastDispatchedCompositionString.Truncate();
// Maintain selection
SetSelectionInternal(&mCompositionSelection);
return S_OK;
}
nsresult
nsTextStore::OnFocusChange(bool aFocus,
nsWindow* aWindow,
IMEState::Enabled aIMEEnabled)
{
// no change notifications if TSF is disabled
if (!sTsfThreadMgr || !sTsfTextStore)
return NS_ERROR_NOT_AVAILABLE;
if (aFocus) {
bool bRet = sTsfTextStore->Create(aWindow, aIMEEnabled);
NS_ENSURE_TRUE(bRet, NS_ERROR_FAILURE);
NS_ENSURE_TRUE(sTsfTextStore->mDocumentMgr, NS_ERROR_FAILURE);
HRESULT hr = sTsfThreadMgr->SetFocus(sTsfTextStore->mDocumentMgr);
NS_ENSURE_TRUE(SUCCEEDED(hr), NS_ERROR_FAILURE);
} else {
sTsfTextStore->Destroy();
}
return NS_OK;
}
nsresult
nsTextStore::OnTextChangeInternal(uint32_t aStart,
uint32_t aOldEnd,
uint32_t aNewEnd)
{
if (!mLock && mSink && 0 != (mSinkMask & TS_AS_TEXT_CHANGE)) {
mTextChange.acpStart = NS_MIN(mTextChange.acpStart, LONG(aStart));
mTextChange.acpOldEnd = NS_MAX(mTextChange.acpOldEnd, LONG(aOldEnd));
mTextChange.acpNewEnd = NS_MAX(mTextChange.acpNewEnd, LONG(aNewEnd));
::PostMessageW(mWindow->GetWindowHandle(),
WM_USER_TSF_TEXTCHANGE, 0, 0);
}
return NS_OK;
}
void
nsTextStore::OnTextChangeMsgInternal(void)
{
if (!mLock && mSink && 0 != (mSinkMask & TS_AS_TEXT_CHANGE) &&
PR_INT32_MAX > mTextChange.acpStart) {
mSink->OnTextChange(0, &mTextChange);
mTextChange.acpStart = PR_INT32_MAX;
mTextChange.acpOldEnd = mTextChange.acpNewEnd = 0;
}
}
nsresult
nsTextStore::OnSelectionChangeInternal(void)
{
if (!mLock && mSink && 0 != (mSinkMask & TS_AS_SEL_CHANGE)) {
mSink->OnSelectionChange();
}
return NS_OK;
}
nsresult
nsTextStore::OnCompositionTimer()
{
NS_ENSURE_TRUE(mContext, NS_ERROR_FAILURE);
NS_ENSURE_TRUE(mSink, NS_ERROR_FAILURE);
// XXXmnakano We always call OnLayoutChange for now, but this might use CPU
// power when the focused editor has very long text. Ideally, we should call
// this only when the composition string screen position is changed by window
// moving, resizing. And also reflowing and scrolling the contents.
HRESULT hr = mSink->OnLayoutChange(TS_LC_CHANGE, TEXTSTORE_DEFAULT_VIEW);
NS_ENSURE_TRUE(SUCCEEDED(hr), NS_ERROR_FAILURE);
return NS_OK;
}
void
nsTextStore::CommitCompositionInternal(bool aDiscard)
{
if (mCompositionView && aDiscard) {
mCompositionString.Truncate(0);
if (mSink && !mLock) {
TS_TEXTCHANGE textChange;
textChange.acpStart = mCompositionStart;
textChange.acpOldEnd = mCompositionStart + mCompositionLength;
textChange.acpNewEnd = mCompositionStart;
mSink->OnTextChange(0, &textChange);
}
}
// Terminate two contexts, the base context (mContext) and the top
// if the top context is not the same as the base context
nsRefPtr<ITfContext> context = mContext;
do {
if (context) {
nsRefPtr<ITfContextOwnerCompositionServices> services;
context->QueryInterface(IID_ITfContextOwnerCompositionServices,
getter_AddRefs(services));
if (services)
services->TerminateComposition(NULL);
}
if (context != mContext)
break;
if (mDocumentMgr)
mDocumentMgr->GetTop(getter_AddRefs(context));
} while (context != mContext);
}
static
bool
GetCompartment(IUnknown* pUnk,
const GUID& aID,
ITfCompartment** aCompartment)
{
if (!pUnk) return false;
nsRefPtr<ITfCompartmentMgr> compMgr;
pUnk->QueryInterface(IID_ITfCompartmentMgr, getter_AddRefs(compMgr));
if (!compMgr) return false;
return SUCCEEDED(compMgr->GetCompartment(aID, aCompartment)) &&
(*aCompartment) != NULL;
}
void
nsTextStore::SetIMEOpenState(bool aState)
{
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SetIMEOpenState, state=%lu\n", aState));
nsRefPtr<ITfCompartment> comp;
if (!GetCompartment(sTsfThreadMgr,
GUID_COMPARTMENT_KEYBOARD_OPENCLOSE,
getter_AddRefs(comp)))
return;
VARIANT variant;
variant.vt = VT_I4;
variant.lVal = aState;
comp->SetValue(sTsfClientId, &variant);
}
bool
nsTextStore::GetIMEOpenState(void)
{
nsRefPtr<ITfCompartment> comp;
if (!GetCompartment(sTsfThreadMgr,
GUID_COMPARTMENT_KEYBOARD_OPENCLOSE,
getter_AddRefs(comp)))
return false;
VARIANT variant;
::VariantInit(&variant);
if (SUCCEEDED(comp->GetValue(&variant)) && variant.vt == VT_I4)
return variant.lVal != 0;
::VariantClear(&variant); // clear up in case variant.vt != VT_I4
return false;
}
void
nsTextStore::SetInputContextInternal(IMEState::Enabled aState)
{
PR_LOG(sTextStoreLog, PR_LOG_ALWAYS,
("TSF: SetInputContext, state=%ld\n", static_cast<int32_t>(aState)));
VARIANT variant;
variant.vt = VT_I4;
variant.lVal = (aState != IMEState::ENABLED);
// Set two contexts, the base context (mContext) and the top
// if the top context is not the same as the base context
nsRefPtr<ITfContext> context = mContext;
nsRefPtr<ITfCompartment> comp;
do {
if (GetCompartment(context, GUID_COMPARTMENT_KEYBOARD_DISABLED,
getter_AddRefs(comp)))
comp->SetValue(sTsfClientId, &variant);
if (context != mContext)
break;
if (mDocumentMgr)
mDocumentMgr->GetTop(getter_AddRefs(context));
} while (context != mContext);
}
void
nsTextStore::Initialize(void)
{
#ifdef PR_LOGGING
if (!sTextStoreLog)
sTextStoreLog = PR_NewLogModule("nsTextStoreWidgets");
#endif
if (!sTsfThreadMgr) {
bool enableTsf =
Preferences::GetBool("intl.enable_tsf_support", false);
if (enableTsf) {
if (SUCCEEDED(CoCreateInstance(CLSID_TF_ThreadMgr, NULL,
CLSCTX_INPROC_SERVER, IID_ITfThreadMgr,
reinterpret_cast<void**>(&sTsfThreadMgr)))) {
if (FAILED(sTsfThreadMgr->Activate(&sTsfClientId))) {
NS_RELEASE(sTsfThreadMgr);
NS_WARNING("failed to activate TSF\n");
}
} else
// TSF not installed?
NS_WARNING("failed to create TSF manager\n");
}
}
if (sTsfThreadMgr && !sTsfTextStore) {
sTsfTextStore = new nsTextStore();
if (!sTsfTextStore)
NS_ERROR("failed to create text store");
}
if (sTsfThreadMgr && !sDisplayAttrMgr) {
HRESULT hr =
::CoCreateInstance(CLSID_TF_DisplayAttributeMgr, NULL,
CLSCTX_INPROC_SERVER, IID_ITfDisplayAttributeMgr,
reinterpret_cast<void**>(&sDisplayAttrMgr));
if (FAILED(hr) || !sDisplayAttrMgr)
NS_ERROR("failed to create display attribute manager");
}
if (sTsfThreadMgr && !sCategoryMgr) {
HRESULT hr =
::CoCreateInstance(CLSID_TF_CategoryMgr, NULL,
CLSCTX_INPROC_SERVER, IID_ITfCategoryMgr,
reinterpret_cast<void**>(&sCategoryMgr));
if (FAILED(hr) || !sCategoryMgr)
NS_ERROR("failed to create category manager");
}
if (sTsfThreadMgr && !sFlushTIPInputMessage) {
sFlushTIPInputMessage = ::RegisterWindowMessageW(
NS_LITERAL_STRING("Flush TIP Input Message").get());
}
}
void
nsTextStore::Terminate(void)
{
NS_IF_RELEASE(sDisplayAttrMgr);
NS_IF_RELEASE(sCategoryMgr);
NS_IF_RELEASE(sTsfTextStore);
if (sTsfThreadMgr) {
sTsfThreadMgr->Deactivate();
NS_RELEASE(sTsfThreadMgr);
}
}