2 * The IME for interfacing with XIM
4 * Copyright 2008 CodeWeavers, Aric Stewart
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 * The normal flow for IMM/IME Processing is as follows.
24 * 1) The Keyboard Driver generates key messages which are first passed to
25 * the IMM and then to IME via ImeProcessKey. If the IME returns 0 then
26 * it does not want the key and the keyboard driver then generates the
27 * WM_KEYUP/WM_KEYDOWN messages. However if the IME is going to process the
28 * key it returns non-zero.
29 * 2) If the IME is going to process the key then the IMM calls ImeToAsciiEx to
30 * process the key. the IME modifies the HIMC structure to reflect the
31 * current state and generates any messages it needs the IMM to process.
32 * 3) IMM checks the messages and send them to the application in question. From
33 * here the IMM level deals with if the application is IME aware or not.
35 * This flow does not work well for the X11 driver and XIM.
36 * (It works fine for Mac)
37 * As such we will have to reroute step 1. Instead the x11drv driver will
38 * generate an XIM events and call directly into this IME implementation.
39 * As such we will have to use the alternative ImmGenerateMessage path to be
40 * generate the messages that we want the IMM layer to send to the application.
51 #include "wine/debug.h"
57 WINE_DEFAULT_DEBUG_CHANNEL(imm);
59 #define FROM_X11 ((HIMC)0xcafe1337)
61 typedef struct _IMEPRIVATE {
66 } IMEPRIVATE, *LPIMEPRIVATE;
68 typedef struct _tagTRANSMSG {
72 } TRANSMSG, *LPTRANSMSG;
74 static const WCHAR UI_CLASS_NAME[] = {'W','i','n','e','X','1','1','I','M','E',0};
76 static HIMC *hSelectedFrom = NULL;
77 static INT hSelectedCount = 0;
80 static UINT WM_MSIME_SERVICE;
81 static UINT WM_MSIME_RECONVERTOPTIONS;
82 static UINT WM_MSIME_MOUSE;
83 static UINT WM_MSIME_RECONVERTREQUEST;
84 static UINT WM_MSIME_RECONVERT;
85 static UINT WM_MSIME_QUERYPOSITION;
86 static UINT WM_MSIME_DOCUMENTFEED;
88 static LRESULT WINAPI IME_WindowProc(HWND hwnd, UINT uMsg, WPARAM wParam,
91 static HIMC RealIMC(HIMC hIMC)
96 HWND wnd = GetFocus();
97 HIMC winHimc = ImmGetContext(wnd);
98 for (i = 0; i < hSelectedCount; i++)
99 if (winHimc == hSelectedFrom[i])
107 static LPINPUTCONTEXT LockRealIMC(HIMC hIMC)
109 HIMC real_imc = RealIMC(hIMC);
111 return ImmLockIMC(real_imc);
116 static BOOL UnlockRealIMC(HIMC hIMC)
118 HIMC real_imc = RealIMC(hIMC);
120 return ImmUnlockIMC(real_imc);
125 static void IME_RegisterClasses(void)
133 ZeroMemory(&wndClass, sizeof(WNDCLASSW));
134 wndClass.style = CS_GLOBALCLASS | CS_IME | CS_HREDRAW | CS_VREDRAW;
135 wndClass.lpfnWndProc = IME_WindowProc;
136 wndClass.cbClsExtra = 0;
137 wndClass.cbWndExtra = 2 * sizeof(LONG_PTR);
138 wndClass.hInstance = x11drv_module;
139 wndClass.hCursor = LoadCursorW(NULL, (LPWSTR)IDC_ARROW);
140 wndClass.hIcon = LoadIconW(NULL, (LPWSTR)IDI_APPLICATION);
141 wndClass.hbrBackground = (HBRUSH)(COLOR_WINDOW +1);
142 wndClass.lpszMenuName = 0;
143 wndClass.lpszClassName = UI_CLASS_NAME;
145 RegisterClassW(&wndClass);
147 WM_MSIME_SERVICE = RegisterWindowMessageA("MSIMEService");
148 WM_MSIME_RECONVERTOPTIONS = RegisterWindowMessageA("MSIMEReconvertOptions");
149 WM_MSIME_MOUSE = RegisterWindowMessageA("MSIMEMouseOperation");
150 WM_MSIME_RECONVERTREQUEST = RegisterWindowMessageA("MSIMEReconvertRequest");
151 WM_MSIME_RECONVERT = RegisterWindowMessageA("MSIMEReconvert");
152 WM_MSIME_QUERYPOSITION = RegisterWindowMessageA("MSIMEQueryPosition");
153 WM_MSIME_DOCUMENTFEED = RegisterWindowMessageA("MSIMEDocumentFeed");
156 static HIMCC ImeCreateBlankCompStr(void)
159 LPCOMPOSITIONSTRING ptr;
160 rc = ImmCreateIMCC(sizeof(COMPOSITIONSTRING));
161 ptr = ImmLockIMCC(rc);
162 memset(ptr,0,sizeof(COMPOSITIONSTRING));
163 ptr->dwSize = sizeof(COMPOSITIONSTRING);
168 static int updateField(DWORD origLen, DWORD origOffset, DWORD currentOffset,
169 LPBYTE target, LPBYTE source, DWORD* lenParam,
170 DWORD* offsetParam, BOOL wchars )
172 if (origLen > 0 && origOffset > 0)
174 int truelen = origLen;
176 truelen *= sizeof(WCHAR);
178 memcpy(&target[currentOffset], &source[origOffset], truelen);
181 *offsetParam = currentOffset;
182 currentOffset += truelen;
184 return currentOffset;
187 static HIMCC updateCompStr(HIMCC old, LPCWSTR compstr, DWORD len)
189 /* we need to make sure the CompStr, CompClaus and CompAttr fields are all
193 LPBYTE newdata = NULL;
194 LPBYTE olddata = NULL;
195 LPCOMPOSITIONSTRING new_one;
196 LPCOMPOSITIONSTRING lpcs = NULL;
197 INT current_offset = 0;
199 TRACE("%s, %i\n",debugstr_wn(compstr,len),len);
201 if (old == NULL && compstr == NULL && len == 0)
204 if (compstr == NULL && len != 0)
206 ERR("compstr is NULL however we have a len! Please report\n");
212 olddata = ImmLockIMCC(old);
213 lpcs = (LPCOMPOSITIONSTRING)olddata;
216 needed_size = sizeof(COMPOSITIONSTRING) + len * sizeof(WCHAR) +
217 len + sizeof(DWORD) * 2;
221 needed_size += lpcs->dwCompReadAttrLen;
222 needed_size += lpcs->dwCompReadClauseLen;
223 needed_size += lpcs->dwCompReadStrLen * sizeof(DWORD);
224 needed_size += lpcs->dwResultReadClauseLen;
225 needed_size += lpcs->dwResultReadStrLen * sizeof(DWORD);
226 needed_size += lpcs->dwResultClauseLen;
227 needed_size += lpcs->dwResultStrLen * sizeof(DWORD);
228 needed_size += lpcs->dwPrivateSize;
230 rc = ImmCreateIMCC(needed_size);
231 newdata = ImmLockIMCC(rc);
232 new_one = (LPCOMPOSITIONSTRING)newdata;
234 new_one->dwSize = needed_size;
235 current_offset = sizeof(COMPOSITIONSTRING);
238 current_offset = updateField(lpcs->dwCompReadAttrLen,
239 lpcs->dwCompReadAttrOffset,
240 current_offset, newdata, olddata,
241 &new_one->dwCompReadAttrLen,
242 &new_one->dwCompReadAttrOffset, FALSE);
244 current_offset = updateField(lpcs->dwCompReadClauseLen,
245 lpcs->dwCompReadClauseOffset,
246 current_offset, newdata, olddata,
247 &new_one->dwCompReadClauseLen,
248 &new_one->dwCompReadClauseOffset, FALSE);
250 current_offset = updateField(lpcs->dwCompReadStrLen,
251 lpcs->dwCompReadStrOffset,
252 current_offset, newdata, olddata,
253 &new_one->dwCompReadStrLen,
254 &new_one->dwCompReadStrOffset, TRUE);
256 /* new CompAttr, CompClause, CompStr, dwCursorPos */
257 new_one->dwDeltaStart = 0;
259 current_offset = updateField(lpcs->dwResultReadClauseLen,
260 lpcs->dwResultReadClauseOffset,
261 current_offset, newdata, olddata,
262 &new_one->dwResultReadClauseLen,
263 &new_one->dwResultReadClauseOffset, FALSE);
265 current_offset = updateField(lpcs->dwResultReadStrLen,
266 lpcs->dwResultReadStrOffset,
267 current_offset, newdata, olddata,
268 &new_one->dwResultReadStrLen,
269 &new_one->dwResultReadStrOffset, TRUE);
271 current_offset = updateField(lpcs->dwResultClauseLen,
272 lpcs->dwResultClauseOffset,
273 current_offset, newdata, olddata,
274 &new_one->dwResultClauseLen,
275 &new_one->dwResultClauseOffset, FALSE);
277 current_offset = updateField(lpcs->dwResultStrLen,
278 lpcs->dwResultStrOffset,
279 current_offset, newdata, olddata,
280 &new_one->dwResultStrLen,
281 &new_one->dwResultStrOffset, TRUE);
283 current_offset = updateField(lpcs->dwPrivateSize,
284 lpcs->dwPrivateOffset,
285 current_offset, newdata, olddata,
286 &new_one->dwPrivateSize,
287 &new_one->dwPrivateOffset, FALSE);
292 new_one->dwCompAttrLen = len;
295 new_one->dwCompAttrOffset = current_offset;
296 memset(&newdata[current_offset],ATTR_INPUT,len);
297 current_offset += len;
303 new_one->dwCompClauseLen = sizeof(DWORD) * 2;
304 new_one->dwCompClauseOffset = current_offset;
305 *(DWORD*)(&newdata[current_offset]) = 0;
306 current_offset += sizeof(DWORD);
307 *(DWORD*)(&newdata[current_offset]) = len;
308 current_offset += sizeof(DWORD);
312 new_one->dwCompStrLen = len;
315 new_one->dwCompStrOffset = current_offset;
316 memcpy(&newdata[current_offset],compstr,len*sizeof(WCHAR));
320 new_one->dwCursorPos = len;
329 static HIMCC updateResultStr(HIMCC old, LPWSTR resultstr, DWORD len)
331 /* we need to make sure the ResultStr and ResultClause fields are all
335 LPBYTE newdata = NULL;
336 LPBYTE olddata = NULL;
337 LPCOMPOSITIONSTRING new_one;
338 LPCOMPOSITIONSTRING lpcs = NULL;
339 INT current_offset = 0;
341 TRACE("%s, %i\n",debugstr_wn(resultstr,len),len);
343 if (old == NULL && resultstr == NULL && len == 0)
346 if (resultstr == NULL && len != 0)
348 ERR("resultstr is NULL however we have a len! Please report\n");
354 olddata = ImmLockIMCC(old);
355 lpcs = (LPCOMPOSITIONSTRING)olddata;
358 needed_size = sizeof(COMPOSITIONSTRING) + len * sizeof(WCHAR) +
363 needed_size += lpcs->dwCompReadAttrLen;
364 needed_size += lpcs->dwCompReadClauseLen;
365 needed_size += lpcs->dwCompReadStrLen * sizeof(DWORD);
366 needed_size += lpcs->dwCompAttrLen;
367 needed_size += lpcs->dwCompClauseLen;
368 needed_size += lpcs->dwCompStrLen * sizeof(DWORD);
369 needed_size += lpcs->dwResultReadClauseLen;
370 needed_size += lpcs->dwResultReadStrLen * sizeof(DWORD);
371 needed_size += lpcs->dwPrivateSize;
373 rc = ImmCreateIMCC(needed_size);
374 newdata = ImmLockIMCC(rc);
375 new_one = (LPCOMPOSITIONSTRING)newdata;
377 new_one->dwSize = needed_size;
378 current_offset = sizeof(COMPOSITIONSTRING);
381 current_offset = updateField(lpcs->dwCompReadAttrLen,
382 lpcs->dwCompReadAttrOffset,
383 current_offset, newdata, olddata,
384 &new_one->dwCompReadAttrLen,
385 &new_one->dwCompReadAttrOffset, FALSE);
387 current_offset = updateField(lpcs->dwCompReadClauseLen,
388 lpcs->dwCompReadClauseOffset,
389 current_offset, newdata, olddata,
390 &new_one->dwCompReadClauseLen,
391 &new_one->dwCompReadClauseOffset, FALSE);
393 current_offset = updateField(lpcs->dwCompReadStrLen,
394 lpcs->dwCompReadStrOffset,
395 current_offset, newdata, olddata,
396 &new_one->dwCompReadStrLen,
397 &new_one->dwCompReadStrOffset, TRUE);
399 current_offset = updateField(lpcs->dwCompAttrLen,
400 lpcs->dwCompAttrOffset,
401 current_offset, newdata, olddata,
402 &new_one->dwCompAttrLen,
403 &new_one->dwCompAttrOffset, FALSE);
405 current_offset = updateField(lpcs->dwCompClauseLen,
406 lpcs->dwCompClauseOffset,
407 current_offset, newdata, olddata,
408 &new_one->dwCompClauseLen,
409 &new_one->dwCompClauseOffset, FALSE);
411 current_offset = updateField(lpcs->dwCompStrLen,
412 lpcs->dwCompStrOffset,
413 current_offset, newdata, olddata,
414 &new_one->dwCompStrLen,
415 &new_one->dwCompStrOffset, TRUE);
417 new_one->dwCursorPos = lpcs->dwCursorPos;
418 new_one->dwDeltaStart = 0;
420 current_offset = updateField(lpcs->dwResultReadClauseLen,
421 lpcs->dwResultReadClauseOffset,
422 current_offset, newdata, olddata,
423 &new_one->dwResultReadClauseLen,
424 &new_one->dwResultReadClauseOffset, FALSE);
426 current_offset = updateField(lpcs->dwResultReadStrLen,
427 lpcs->dwResultReadStrOffset,
428 current_offset, newdata, olddata,
429 &new_one->dwResultReadStrLen,
430 &new_one->dwResultReadStrOffset, TRUE);
432 /* new ResultClause , ResultStr */
434 current_offset = updateField(lpcs->dwPrivateSize,
435 lpcs->dwPrivateOffset,
436 current_offset, newdata, olddata,
437 &new_one->dwPrivateSize,
438 &new_one->dwPrivateOffset, FALSE);
445 new_one->dwResultClauseLen = sizeof(DWORD) * 2;
446 new_one->dwResultClauseOffset = current_offset;
447 *(DWORD*)(&newdata[current_offset]) = 0;
448 current_offset += sizeof(DWORD);
449 *(DWORD*)(&newdata[current_offset]) = len;
450 current_offset += sizeof(DWORD);
454 new_one->dwResultStrLen = len;
457 new_one->dwResultStrOffset = current_offset;
458 memcpy(&newdata[current_offset],resultstr,len*sizeof(WCHAR));
467 static void GenerateIMEMessage(HIMC hIMC, UINT msg, WPARAM wParam,
470 LPINPUTCONTEXT lpIMC;
471 LPTRANSMSG lpTransMsg;
473 lpIMC = LockRealIMC(hIMC);
477 lpIMC->hMsgBuf = ImmReSizeIMCC(lpIMC->hMsgBuf, (lpIMC->dwNumMsgBuf + 1) *
482 lpTransMsg = ImmLockIMCC(lpIMC->hMsgBuf);
486 lpTransMsg += lpIMC->dwNumMsgBuf;
487 lpTransMsg->message = msg;
488 lpTransMsg->wParam = wParam;
489 lpTransMsg->lParam = lParam;
491 ImmUnlockIMCC(lpIMC->hMsgBuf);
492 lpIMC->dwNumMsgBuf++;
494 ImmGenerateMessage(RealIMC(hIMC));
498 static void GenerateIMECHARMessages(HIMC hIMC, LPWSTR String, DWORD length)
500 LPINPUTCONTEXT lpIMC;
501 LPTRANSMSG lpTransMsg;
507 lpIMC = LockRealIMC(hIMC);
511 lpIMC->hMsgBuf = ImmReSizeIMCC(lpIMC->hMsgBuf,
512 (lpIMC->dwNumMsgBuf + length) *
517 lpTransMsg = ImmLockIMCC(lpIMC->hMsgBuf);
521 lpTransMsg += lpIMC->dwNumMsgBuf;
522 for (i = 0; i < length; i++)
524 lpTransMsg->message = WM_IME_CHAR;
525 lpTransMsg->wParam = String[i];
526 lpTransMsg->lParam = 1;
530 ImmUnlockIMCC(lpIMC->hMsgBuf);
531 lpIMC->dwNumMsgBuf+=length;
533 ImmGenerateMessage(RealIMC(hIMC));
537 static BOOL IME_RemoveFromSelected(HIMC hIMC)
540 for (i = 0; i < hSelectedCount; i++)
541 if (hSelectedFrom[i] == hIMC)
543 if (i < hSelectedCount - 1)
544 memmove(&hSelectedFrom[i], &hSelectedFrom[i+1], (hSelectedCount - i - 1)*sizeof(HIMC));
551 static void IME_AddToSelected(HIMC hIMC)
555 hSelectedFrom = HeapReAlloc(GetProcessHeap(), 0, hSelectedFrom, hSelectedCount*sizeof(HIMC));
557 hSelectedFrom = HeapAlloc(GetProcessHeap(), 0, sizeof(HIMC));
558 hSelectedFrom[hSelectedCount-1] = hIMC;
561 BOOL WINAPI ImeInquire(LPIMEINFO lpIMEInfo, LPWSTR lpszUIClass,
565 IME_RegisterClasses();
566 lpIMEInfo->dwPrivateDataSize = sizeof (IMEPRIVATE);
567 lpIMEInfo->fdwProperty = IME_PROP_UNICODE | IME_PROP_AT_CARET;
568 lpIMEInfo->fdwConversionCaps = IME_CMODE_NATIVE;
569 lpIMEInfo->fdwSentenceCaps = IME_SMODE_AUTOMATIC;
570 lpIMEInfo->fdwUICaps = UI_CAP_2700;
571 /* Tell App we cannot accept ImeSetCompositionString calls */
572 lpIMEInfo->fdwSCSCaps = 0;
573 lpIMEInfo->fdwSelectCaps = SELECT_CAP_CONVERSION;
575 lstrcpyW(lpszUIClass,UI_CLASS_NAME);
580 BOOL WINAPI ImeConfigure(HKL hKL,HWND hWnd, DWORD dwMode, LPVOID lpData)
582 FIXME("(%p, %p, %d, %p): stub\n", hKL, hWnd, dwMode, lpData);
583 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
587 DWORD WINAPI ImeConversionList(HIMC hIMC, LPCWSTR lpSource,
588 LPCANDIDATELIST lpCandList, DWORD dwBufLen, UINT uFlag)
591 FIXME("(%p, %s, %p, %d, %d): stub\n", hIMC, debugstr_w(lpSource),
592 lpCandList, dwBufLen, uFlag);
593 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
597 BOOL WINAPI ImeDestroy(UINT uForce)
600 HeapFree(GetProcessHeap(),0,hSelectedFrom);
601 hSelectedFrom = NULL;
606 LRESULT WINAPI ImeEscape(HIMC hIMC, UINT uSubFunc, LPVOID lpData)
608 FIXME("(%p, %d, %p): stub\n", hIMC, uSubFunc, lpData);
609 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
613 BOOL WINAPI ImeProcessKey(HIMC hIMC, UINT vKey, LPARAM lKeyData,
614 CONST LPBYTE lpbKeyState)
616 /* See the comment at the head of this file */
617 TRACE("We do no processing via this route\n");
621 BOOL WINAPI ImeSelect(HIMC hIMC, BOOL fSelect)
623 LPINPUTCONTEXT lpIMC;
624 TRACE("%p %s\n",hIMC,(fSelect)?"TRUE":"FALSE");
626 if (hIMC == FROM_X11)
628 ERR("ImeSelect should never be called from X11\n");
637 return IME_RemoveFromSelected(hIMC);
639 IME_AddToSelected(hIMC);
641 /* Initialize our structures */
642 lpIMC = LockRealIMC(hIMC);
645 LPIMEPRIVATE myPrivate;
646 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
647 myPrivate->bInComposition = FALSE;
648 myPrivate->bInternalState = FALSE;
649 myPrivate->textfont = NULL;
650 myPrivate->hwndDefault = NULL;
651 ImmUnlockIMCC(lpIMC->hPrivate);
658 BOOL WINAPI ImeSetActiveContext(HIMC hIMC,BOOL fFlag)
660 FIXME("(%p, %x): stub\n", hIMC, fFlag);
664 UINT WINAPI ImeToAsciiEx (UINT uVKey, UINT uScanCode,
665 CONST LPBYTE lpbKeyState, LPDWORD lpdwTransKey,
666 UINT fuState, HIMC hIMC)
668 /* See the comment at the head of this file */
669 TRACE("We do no processing via this route\n");
673 BOOL WINAPI NotifyIME(HIMC hIMC, DWORD dwAction, DWORD dwIndex, DWORD dwValue)
676 LPINPUTCONTEXT lpIMC;
678 TRACE("%p %i %i %i\n",hIMC,dwAction,dwIndex,dwValue);
680 lpIMC = LockRealIMC(hIMC);
686 case NI_OPENCANDIDATE: FIXME("NI_OPENCANDIDATE\n"); break;
687 case NI_CLOSECANDIDATE: FIXME("NI_CLOSECANDIDATE\n"); break;
688 case NI_SELECTCANDIDATESTR: FIXME("NI_SELECTCANDIDATESTR\n"); break;
689 case NI_CHANGECANDIDATELIST: FIXME("NI_CHANGECANDIDATELIST\n"); break;
690 case NI_SETCANDIDATE_PAGESTART: FIXME("NI_SETCANDIDATE_PAGESTART\n"); break;
691 case NI_SETCANDIDATE_PAGESIZE: FIXME("NI_SETCANDIDATE_PAGESIZE\n"); break;
692 case NI_CONTEXTUPDATED:
695 case IMC_SETCOMPOSITIONWINDOW: FIXME("IMC_SETCOMPOSITIONWINDOW\n"); break;
696 case IMC_SETCONVERSIONMODE: FIXME("IMC_SETCONVERSIONMODE\n"); break;
697 case IMC_SETSENTENCEMODE: FIXME("IMC_SETSENTENCEMODE\n"); break;
698 case IMC_SETCANDIDATEPOS: FIXME("IMC_SETCANDIDATEPOS\n"); break;
699 case IMC_SETCOMPOSITIONFONT:
701 LPIMEPRIVATE myPrivate;
702 TRACE("IMC_SETCOMPOSITIONFONT\n");
704 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
705 if (myPrivate->textfont)
707 DeleteObject(myPrivate->textfont);
708 myPrivate->textfont = NULL;
710 myPrivate->textfont = CreateFontIndirectW(&lpIMC->lfFont.W);
711 ImmUnlockIMCC(lpIMC->hPrivate);
714 case IMC_SETOPENSTATUS:
715 TRACE("IMC_SETOPENSTATUS\n");
718 X11DRV_SetPreeditState(lpIMC->hWnd, lpIMC->fOpen);
721 LPIMEPRIVATE myPrivate;
723 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
724 if (myPrivate->bInComposition)
726 X11DRV_ForceXIMReset(lpIMC->hWnd);
727 GenerateIMEMessage(hIMC, WM_IME_ENDCOMPOSITION, 0, 0);
728 myPrivate->bInComposition = FALSE;
730 ImmUnlockIMCC(lpIMC->hPrivate);
734 default: FIXME("Unknown\n"); break;
737 case NI_COMPOSITIONSTR:
745 LPCOMPOSITIONSTRING cs = NULL;
747 LPIMEPRIVATE myPrivate;
749 TRACE("CPS_COMPLETE\n");
751 /* clear existing result */
752 newCompStr = updateResultStr(lpIMC->hCompStr, NULL, 0);
754 ImmDestroyIMCC(lpIMC->hCompStr);
755 lpIMC->hCompStr = newCompStr;
759 cdata = ImmLockIMCC(lpIMC->hCompStr);
760 cs = (LPCOMPOSITIONSTRING)cdata;
761 cplen = cs->dwCompStrLen;
762 cpstr = (LPWSTR)&(cdata[cs->dwCompStrOffset]);
763 ImmUnlockIMCC(lpIMC->hCompStr);
767 WCHAR param = cpstr[0];
769 newCompStr = updateResultStr(lpIMC->hCompStr, cpstr, cplen);
770 ImmDestroyIMCC(lpIMC->hCompStr);
771 lpIMC->hCompStr = newCompStr;
772 newCompStr = updateCompStr(lpIMC->hCompStr, NULL, 0);
773 ImmDestroyIMCC(lpIMC->hCompStr);
774 lpIMC->hCompStr = newCompStr;
776 GenerateIMEMessage(hIMC, WM_IME_COMPOSITION, 0,
779 GenerateIMEMessage(hIMC, WM_IME_COMPOSITION, param,
780 GCS_RESULTSTR|GCS_RESULTCLAUSE);
783 GenerateIMEMessage(hIMC,WM_IME_ENDCOMPOSITION, 0, 0);
785 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
786 myPrivate->bInComposition = FALSE;
787 ImmUnlockIMCC(lpIMC->hPrivate);
792 case CPS_CONVERT: FIXME("CPS_CONVERT\n"); break;
793 case CPS_REVERT: FIXME("CPS_REVERT\n"); break;
796 LPIMEPRIVATE myPrivate;
798 TRACE("CPS_CANCEL\n");
800 X11DRV_ForceXIMReset(lpIMC->hWnd);
803 ImmDestroyIMCC(lpIMC->hCompStr);
804 lpIMC->hCompStr = ImeCreateBlankCompStr();
806 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
807 if (myPrivate->bInComposition)
809 GenerateIMEMessage(hIMC, WM_IME_ENDCOMPOSITION, 0, 0);
810 myPrivate->bInComposition = FALSE;
812 ImmUnlockIMCC(lpIMC->hPrivate);
816 default: FIXME("Unknown\n"); break;
819 default: FIXME("Unknown Message\n"); break;
826 BOOL WINAPI ImeRegisterWord(LPCWSTR lpszReading, DWORD dwStyle,
827 LPCWSTR lpszRegister)
829 FIXME("(%s, %d, %s): stub\n", debugstr_w(lpszReading), dwStyle,
830 debugstr_w(lpszRegister));
831 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
835 BOOL WINAPI ImeUnregisterWord(LPCWSTR lpszReading, DWORD dwStyle,
836 LPCWSTR lpszUnregister)
838 FIXME("(%s, %d, %s): stub\n", debugstr_w(lpszReading), dwStyle,
839 debugstr_w(lpszUnregister));
840 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
844 UINT WINAPI ImeGetRegisterWordStyle(UINT nItem, LPSTYLEBUFW lpStyleBuf)
846 FIXME("(%d, %p): stub\n", nItem, lpStyleBuf);
847 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
851 UINT WINAPI ImeEnumRegisterWord(REGISTERWORDENUMPROCW lpfnEnumProc,
852 LPCWSTR lpszReading, DWORD dwStyle,
853 LPCWSTR lpszRegister, LPVOID lpData)
855 FIXME("(%p, %s, %d, %s, %p): stub\n", lpfnEnumProc,
856 debugstr_w(lpszReading), dwStyle, debugstr_w(lpszRegister),
858 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
862 BOOL WINAPI ImeSetCompositionString(HIMC hIMC, DWORD dwIndex, LPCVOID lpComp,
863 DWORD dwCompLen, LPCVOID lpRead,
866 LPINPUTCONTEXT lpIMC;
869 LPIMEPRIVATE myPrivate;
871 TRACE("(%p, %d, %p, %d, %p, %d):\n",
872 hIMC, dwIndex, lpComp, dwCompLen, lpRead, dwReadLen);
875 if (hIMC != FROM_X11)
876 FIXME("PROBLEM: This only sets the wine level string\n");
880 * this sets the composition string in the imm32.dll level
881 * of the composition buffer. we cannot manipulate the xim level
882 * buffer, which means that once the xim level buffer changes again
883 * any call to this function from the application will be lost
886 if (lpRead && dwReadLen)
887 FIXME("Reading string unimplemented\n");
889 lpIMC = LockRealIMC(hIMC);
894 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
896 if (dwIndex == SCS_SETSTR)
900 if (!myPrivate->bInComposition)
902 GenerateIMEMessage(hIMC, WM_IME_STARTCOMPOSITION, 0, 0);
903 myPrivate->bInComposition = TRUE;
908 if (dwCompLen && lpComp)
910 newCompStr = updateCompStr(lpIMC->hCompStr, (LPCWSTR)lpComp, dwCompLen / sizeof(WCHAR));
911 ImmDestroyIMCC(lpIMC->hCompStr);
912 lpIMC->hCompStr = newCompStr;
914 wParam = ((const WCHAR*)lpComp)[0];
915 flags |= GCS_COMPCLAUSE | GCS_COMPATTR | GCS_DELTASTART;
919 newCompStr = updateCompStr(lpIMC->hCompStr, NULL, 0);
920 ImmDestroyIMCC(lpIMC->hCompStr);
921 lpIMC->hCompStr = newCompStr;
925 GenerateIMEMessage(hIMC, WM_IME_COMPOSITION, wParam, flags);
926 ImmUnlockIMCC(lpIMC->hPrivate);
932 DWORD WINAPI ImeGetImeMenuItems(HIMC hIMC, DWORD dwFlags, DWORD dwType,
933 LPIMEMENUITEMINFOW lpImeParentMenu, LPIMEMENUITEMINFOW lpImeMenu,
936 FIXME("(%p, %x %x %p %p %x): stub\n", hIMC, dwFlags, dwType,
937 lpImeParentMenu, lpImeMenu, dwSize);
938 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
942 /* Interfaces to XIM and other parts of winex11drv */
944 void IME_SetOpenStatus(BOOL fOpen)
948 imc = RealIMC(FROM_X11);
949 ImmSetOpenStatus(imc, fOpen);
952 void IME_SetCompositionStatus(BOOL fOpen)
955 LPINPUTCONTEXT lpIMC;
956 LPIMEPRIVATE myPrivate;
958 imc = RealIMC(FROM_X11);
959 lpIMC = ImmLockIMC(imc);
963 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
965 if (fOpen && !myPrivate->bInComposition)
967 GenerateIMEMessage(imc, WM_IME_STARTCOMPOSITION, 0, 0);
969 else if (!fOpen && myPrivate->bInComposition)
971 ShowWindow(myPrivate->hwndDefault, SW_HIDE);
972 ImmDestroyIMCC(lpIMC->hCompStr);
973 lpIMC->hCompStr = ImeCreateBlankCompStr();
974 GenerateIMEMessage(imc, WM_IME_ENDCOMPOSITION, 0, 0);
976 myPrivate->bInComposition = fOpen;
978 ImmUnlockIMCC(lpIMC->hPrivate);
982 INT IME_GetCursorPos(void)
984 LPINPUTCONTEXT lpIMC;
986 LPCOMPOSITIONSTRING compstr;
991 lpIMC = LockRealIMC(FROM_X11);
994 compstr = ImmLockIMCC(lpIMC->hCompStr);
995 rc = compstr->dwCursorPos;
996 ImmUnlockIMCC(lpIMC->hCompStr);
998 UnlockRealIMC(FROM_X11);
1002 void IME_SetCursorPos(DWORD pos)
1004 LPINPUTCONTEXT lpIMC;
1005 LPCOMPOSITIONSTRING compstr;
1010 lpIMC = LockRealIMC(FROM_X11);
1014 compstr = ImmLockIMCC(lpIMC->hCompStr);
1017 UnlockRealIMC(FROM_X11);
1021 compstr->dwCursorPos = pos;
1022 ImmUnlockIMCC(lpIMC->hCompStr);
1023 UnlockRealIMC(FROM_X11);
1024 GenerateIMEMessage(FROM_X11, WM_IME_COMPOSITION, pos, GCS_CURSORPOS);
1028 void IME_UpdateAssociation(HWND focus)
1030 ImmGetContext(focus);
1032 if (!focus || !hSelectedFrom)
1035 ImmAssociateContext(focus,RealIMC(FROM_X11));
1039 BOOL IME_SetCompositionString(DWORD dwIndex, LPCVOID lpComp, DWORD dwCompLen,
1040 LPCVOID lpRead, DWORD dwReadLen)
1042 return ImeSetCompositionString(FROM_X11, dwIndex, lpComp, dwCompLen,
1046 void IME_SetResultString(LPWSTR lpResult, DWORD dwResultLen)
1049 LPINPUTCONTEXT lpIMC;
1051 LPIMEPRIVATE myPrivate;
1053 imc = RealIMC(FROM_X11);
1054 lpIMC = ImmLockIMC(imc);
1058 newCompStr = updateResultStr(lpIMC->hCompStr, lpResult, dwResultLen);
1059 ImmDestroyIMCC(lpIMC->hCompStr);
1060 lpIMC->hCompStr = newCompStr;
1062 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
1063 if (!myPrivate->bInComposition)
1064 GenerateIMEMessage(imc, WM_IME_STARTCOMPOSITION, 0, 0);
1065 GenerateIMEMessage(imc, WM_IME_COMPOSITION, 0, GCS_RESULTSTR);
1066 if (!myPrivate->bInComposition)
1067 GenerateIMEMessage(imc, WM_IME_ENDCOMPOSITION, 0, 0);
1068 ImmUnlockIMCC(lpIMC->hPrivate);
1074 * Internal functions to help with IME window management
1076 static void PaintDefaultIMEWnd(HIMC hIMC, HWND hwnd)
1081 LPCOMPOSITIONSTRING compstr;
1082 LPBYTE compdata = NULL;
1084 MONITORINFO mon_info;
1086 LPINPUTCONTEXT lpIMC;
1088 lpIMC = LockRealIMC(hIMC);
1092 hdc = BeginPaint(hwnd,&ps);
1094 GetClientRect(hwnd,&rect);
1095 FillRect(hdc, &rect, (HBRUSH)(COLOR_WINDOW + 1));
1097 compdata = ImmLockIMCC(lpIMC->hCompStr);
1098 compstr = (LPCOMPOSITIONSTRING)compdata;
1100 if (compstr->dwCompStrLen && compstr->dwCompStrOffset)
1104 HFONT oldfont = NULL;
1106 LPIMEPRIVATE myPrivate;
1108 CompString = (LPWSTR)(compdata + compstr->dwCompStrOffset);
1109 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
1111 if (myPrivate->textfont)
1112 oldfont = SelectObject(hdc,myPrivate->textfont);
1114 ImmUnlockIMCC(lpIMC->hPrivate);
1116 GetTextExtentPoint32W(hdc, CompString, compstr->dwCompStrLen, &size);
1122 * How this works based on tests on windows:
1123 * CFS_POINT: then we start our window at the point and grow it as large
1124 * as it needs to be for the string.
1125 * CFS_RECT: we still use the ptCurrentPos as a starting point and our
1126 * window is only as large as we need for the string, but we do not
1127 * grow such that our window exceeds the given rect. Wrapping if
1128 * needed and possible. If our ptCurrentPos is outside of our rect
1129 * then no window is displayed.
1130 * CFS_FORCE_POSITION: appears to behave just like CFS_POINT
1131 * maybe because the default MSIME does not do any IME adjusting.
1133 if (lpIMC->cfCompForm.dwStyle != CFS_DEFAULT)
1135 POINT cpt = lpIMC->cfCompForm.ptCurrentPos;
1136 ClientToScreen(lpIMC->hWnd,&cpt);
1139 rect.right = rect.left + pt.x;
1140 rect.bottom = rect.top + pt.y;
1141 monitor = MonitorFromPoint(cpt, MONITOR_DEFAULTTOPRIMARY);
1143 else /* CFS_DEFAULT */
1145 /* Windows places the default IME window in the bottom left */
1146 HWND target = lpIMC->hWnd;
1147 if (!target) target = GetFocus();
1149 GetWindowRect(target,&rect);
1150 rect.top = rect.bottom;
1151 rect.right = rect.left + pt.x + 20;
1152 rect.bottom = rect.top + pt.y + 20;
1154 monitor = MonitorFromWindow(target, MONITOR_DEFAULTTOPRIMARY);
1157 if (lpIMC->cfCompForm.dwStyle == CFS_RECT)
1160 client =lpIMC->cfCompForm.rcArea;
1161 MapWindowPoints( lpIMC->hWnd, 0, (POINT *)&client, 2 );
1162 IntersectRect(&rect,&rect,&client);
1163 /* TODO: Wrap the input if needed */
1166 if (lpIMC->cfCompForm.dwStyle == CFS_DEFAULT)
1168 /* make sure we are on the desktop */
1169 mon_info.cbSize = sizeof(mon_info);
1170 GetMonitorInfoW(monitor, &mon_info);
1172 if (rect.bottom > mon_info.rcWork.bottom)
1174 int shift = rect.bottom - mon_info.rcWork.bottom;
1176 rect.bottom -= shift;
1180 rect.right -= rect.left;
1183 if (rect.right > mon_info.rcWork.right)
1185 int shift = rect.right - mon_info.rcWork.right;
1187 rect.right -= shift;
1191 SetWindowPos(hwnd, HWND_TOPMOST, rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, SWP_NOACTIVATE);
1193 TextOutW(hdc, offX,offY, CompString, compstr->dwCompStrLen);
1196 SelectObject(hdc,oldfont);
1199 ImmUnlockIMCC(lpIMC->hCompStr);
1202 UnlockRealIMC(hIMC);
1205 static void UpdateDefaultIMEWindow(HIMC hIMC, HWND hwnd)
1207 LPCOMPOSITIONSTRING compstr;
1208 LPINPUTCONTEXT lpIMC;
1210 lpIMC = LockRealIMC(hIMC);
1214 if (lpIMC->hCompStr)
1215 compstr = ImmLockIMCC(lpIMC->hCompStr);
1219 if (compstr == NULL || compstr->dwCompStrLen == 0)
1220 ShowWindow(hwnd,SW_HIDE);
1223 ShowWindow(hwnd,SW_SHOWNOACTIVATE);
1224 RedrawWindow(hwnd, NULL, NULL, RDW_ERASENOW | RDW_INVALIDATE);
1227 if (compstr != NULL)
1228 ImmUnlockIMCC(lpIMC->hCompStr);
1230 lpIMC->hWnd = GetFocus();
1231 UnlockRealIMC(hIMC);
1234 static void DefaultIMEComposition(HIMC hIMC, HWND hwnd, LPARAM lParam)
1236 TRACE("IME message WM_IME_COMPOSITION 0x%lx\n", lParam);
1237 if (lParam & GCS_RESULTSTR)
1239 LPCOMPOSITIONSTRING compstr;
1243 LPINPUTCONTEXT lpIMC;
1245 lpIMC = LockRealIMC(hIMC);
1249 TRACE("Posting result as IME_CHAR\n");
1250 compdata = ImmLockIMCC(lpIMC->hCompStr);
1251 compstr = (LPCOMPOSITIONSTRING)compdata;
1252 ResultStr = (LPWSTR)(compdata + compstr->dwResultStrOffset);
1253 GenerateIMECHARMessages(hIMC, ResultStr, compstr->dwResultStrLen);
1254 ImmUnlockIMCC(lpIMC->hCompStr);
1256 /* clear the buffer */
1257 newCompStr = updateResultStr(lpIMC->hCompStr, NULL, 0);
1258 ImmDestroyIMCC(lpIMC->hCompStr);
1259 lpIMC->hCompStr = newCompStr;
1260 UnlockRealIMC(hIMC);
1263 UpdateDefaultIMEWindow(hIMC, hwnd);
1266 static void DefaultIMEStartComposition(HIMC hIMC, HWND hwnd )
1268 TRACE("IME message WM_IME_STARTCOMPOSITION\n");
1269 UpdateDefaultIMEWindow(hIMC, hwnd);
1272 static LRESULT ImeHandleNotify(HIMC hIMC, HWND hwnd, UINT msg, WPARAM wParam,
1277 case IMN_OPENSTATUSWINDOW:
1278 FIXME("WM_IME_NOTIFY:IMN_OPENSTATUSWINDOW\n");
1280 case IMN_CLOSESTATUSWINDOW:
1281 FIXME("WM_IME_NOTIFY:IMN_CLOSESTATUSWINDOW\n");
1283 case IMN_OPENCANDIDATE:
1284 FIXME("WM_IME_NOTIFY:IMN_OPENCANDIDATE\n");
1286 case IMN_CHANGECANDIDATE:
1287 FIXME("WM_IME_NOTIFY:IMN_CHANGECANDIDATE\n");
1289 case IMN_CLOSECANDIDATE:
1290 FIXME("WM_IME_NOTIFY:IMN_CLOSECANDIDATE\n");
1292 case IMN_SETCONVERSIONMODE:
1293 FIXME("WM_IME_NOTIFY:IMN_SETCONVERSIONMODE\n");
1295 case IMN_SETSENTENCEMODE:
1296 FIXME("WM_IME_NOTIFY:IMN_SETSENTENCEMODE\n");
1298 case IMN_SETOPENSTATUS:
1299 TRACE("WM_IME_NOTIFY:IMN_SETOPENSTATUS\n");
1301 case IMN_SETCANDIDATEPOS:
1302 FIXME("WM_IME_NOTIFY:IMN_SETCANDIDATEPOS\n");
1304 case IMN_SETCOMPOSITIONFONT:
1305 FIXME("WM_IME_NOTIFY:IMN_SETCOMPOSITIONFONT\n");
1307 case IMN_SETCOMPOSITIONWINDOW:
1308 FIXME("WM_IME_NOTIFY:IMN_SETCOMPOSITIONWINDOW\n");
1311 FIXME("WM_IME_NOTIFY:IMN_GUIDELINE\n");
1313 case IMN_SETSTATUSWINDOWPOS:
1314 FIXME("WM_IME_NOTIFY:IMN_SETSTATUSWINDOWPOS\n");
1317 FIXME("WM_IME_NOTIFY:<Unknown 0x%lx>\n",wParam);
1323 static LRESULT WINAPI IME_WindowProc(HWND hwnd, UINT msg, WPARAM wParam,
1329 TRACE("Incoming Message 0x%x (0x%08lx, 0x%08lx)\n", msg, wParam, lParam);
1332 * Each UI window contains the current Input Context.
1333 * This Input Context can be obtained by calling GetWindowLong
1334 * with IMMGWL_IMC when the UI window receives a WM_IME_xxx message.
1335 * The UI window can refer to this Input Context and handles the
1339 hIMC = (HIMC)GetWindowLongPtrW(hwnd,IMMGWL_IMC);
1341 hIMC = RealIMC(FROM_X11);
1343 /* if we have no hIMC there are many messages we cannot process */
1347 case WM_IME_STARTCOMPOSITION:
1348 case WM_IME_ENDCOMPOSITION:
1349 case WM_IME_COMPOSITION:
1351 case WM_IME_CONTROL:
1352 case WM_IME_COMPOSITIONFULL:
1365 LPIMEPRIVATE myPrivate;
1366 LPINPUTCONTEXT lpIMC;
1368 SetWindowTextA(hwnd,"Wine Ime Active");
1370 lpIMC = LockRealIMC(hIMC);
1373 myPrivate = ImmLockIMCC(lpIMC->hPrivate);
1374 myPrivate->hwndDefault = hwnd;
1375 ImmUnlockIMCC(lpIMC->hPrivate);
1377 UnlockRealIMC(hIMC);
1382 PaintDefaultIMEWnd(hIMC, hwnd);
1390 SetFocus((HWND)wParam);
1392 FIXME("Received focus, should never have focus\n");
1394 case WM_IME_COMPOSITION:
1395 DefaultIMEComposition(hIMC, hwnd, lParam);
1397 case WM_IME_STARTCOMPOSITION:
1398 DefaultIMEStartComposition(hIMC, hwnd);
1400 case WM_IME_ENDCOMPOSITION:
1401 TRACE("IME message %s, 0x%lx, 0x%lx\n",
1402 "WM_IME_ENDCOMPOSITION", wParam, lParam);
1403 ShowWindow(hwnd,SW_HIDE);
1406 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_IME_SELECT", wParam, lParam);
1408 case WM_IME_CONTROL:
1409 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_IME_CONTROL", wParam, lParam);
1413 rc = ImeHandleNotify(hIMC,hwnd,msg,wParam,lParam);
1416 TRACE("Non-standard message 0x%x\n",msg);
1418 /* check the MSIME messages */
1419 if (msg == WM_MSIME_SERVICE)
1421 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_MSIME_SERVICE", wParam, lParam);
1424 else if (msg == WM_MSIME_RECONVERTOPTIONS)
1426 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_MSIME_RECONVERTOPTIONS", wParam, lParam);
1428 else if (msg == WM_MSIME_MOUSE)
1430 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_MSIME_MOUSE", wParam, lParam);
1432 else if (msg == WM_MSIME_RECONVERTREQUEST)
1434 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_MSIME_RECONVERTREQUEST", wParam, lParam);
1436 else if (msg == WM_MSIME_RECONVERT)
1438 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_MSIME_RECONVERT", wParam, lParam);
1440 else if (msg == WM_MSIME_QUERYPOSITION)
1442 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_MSIME_QUERYPOSITION", wParam, lParam);
1444 else if (msg == WM_MSIME_DOCUMENTFEED)
1446 TRACE("IME message %s, 0x%lx, 0x%lx\n","WM_MSIME_DOCUMENTFEED", wParam, lParam);
1448 /* DefWndProc if not an IME message */
1449 if (!rc && !((msg >= WM_IME_STARTCOMPOSITION && msg <= WM_IME_KEYLAST) ||
1450 (msg >= WM_IME_SETCONTEXT && msg <= WM_IME_KEYUP)))
1451 rc = DefWindowProcW(hwnd,msg,wParam,lParam);