dlls/winex11.drv/xim.c

   1 /*
   2  * Functions for further XIM control
   3  *
   4  * Copyright 2003 CodeWeavers, Aric Stewart
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #include "config.h"
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <stdarg.h>
  25
  26 #include "windef.h"
  27 #include "winbase.h"
  28 #include "winuser.h"
  29 #include "wingdi.h"
  30 #include "winnls.h"
  31 #include "x11drv.h"
  32 #include "imm.h"
  33 #include "wine/debug.h"
  34
  35 WINE_DEFAULT_DEBUG_CHANNEL(xim);
  36
  37 #ifndef HAVE_XICCALLBACK_CALLBACK
  38 #define XICCallback XIMCallback
  39 #define XICProc XIMProc
  40 #endif
  41
  42 BOOL ximInComposeMode=FALSE;
  43
  44 /* moved here from imm32 for dll separation */
  45 static DWORD dwCompStringLength = 0;
  46 static LPBYTE CompositionString = NULL;
  47 static DWORD dwCompStringSize = 0;
  48
  49 #define STYLE_OFFTHESPOT (XIMPreeditArea | XIMStatusArea)
  50 #define STYLE_OVERTHESPOT (XIMPreeditPosition | XIMStatusNothing)
  51 #define STYLE_ROOT (XIMPreeditNothing | XIMStatusNothing)
  52 /* this uses all the callbacks to utilize full IME support */
  53 #define STYLE_CALLBACK (XIMPreeditCallbacks | XIMStatusNothing)
  54 /* in order to enable deadkey support */
  55 #define STYLE_NONE (XIMPreeditNothing | XIMStatusNothing)
  56
  57 static XIMStyle ximStyle = 0;
  58 static XIMStyle ximStyleRoot = 0;
  59 static XIMStyle ximStyleRequest = STYLE_CALLBACK;
  60
  61 static void X11DRV_ImmSetInternalString(DWORD dwOffset,
  62                                         DWORD selLength, LPWSTR lpComp, DWORD dwCompLen)
  63 {
  64     /* Composition strings are edited in chunks */
  65     unsigned int byte_length = dwCompLen * sizeof(WCHAR);
  66     unsigned int byte_offset = dwOffset * sizeof(WCHAR);
  67     unsigned int byte_selection = selLength * sizeof(WCHAR);
  68     int byte_expansion = byte_length - byte_selection;
  69     LPBYTE ptr_new;
  70
  71     TRACE("( %i, %i, %p, %d):\n", dwOffset, selLength, lpComp, dwCompLen );
  72
  73     if (byte_expansion + dwCompStringLength >= dwCompStringSize)
  74     {
  75         if (CompositionString)
  76             ptr_new = HeapReAlloc(GetProcessHeap(), 0, CompositionString,
  77                                   dwCompStringSize + byte_expansion);
  78         else
  79             ptr_new = HeapAlloc(GetProcessHeap(), 0,
  80                                 dwCompStringSize + byte_expansion);
  81
  82         if (ptr_new == NULL)
  83         {
  84             ERR("Couldn't expand composition string buffer\n");
  85             return;
  86         }
  87
  88         CompositionString = ptr_new;
  89         dwCompStringSize += byte_expansion;
  90     }
  91
  92     ptr_new = CompositionString + byte_offset;
  93     memmove(ptr_new + byte_length, ptr_new + byte_selection,
  94             dwCompStringLength - byte_offset - byte_selection);
  95     memcpy(ptr_new, lpComp, byte_length);
  96     dwCompStringLength += byte_expansion;
  97
  98     IME_SetCompositionString(SCS_SETSTR, CompositionString,
  99                              dwCompStringLength, NULL, 0);
 100 }
 101
 102 void X11DRV_XIMLookupChars( const char *str, DWORD count )
 103 {
 104     DWORD dwOutput;
 105     WCHAR *wcOutput;
 106     HWND focus;
 107
 108     TRACE("%p %u\n", str, count);
 109
 110     dwOutput = MultiByteToWideChar(CP_UNIXCP, 0, str, count, NULL, 0);
 111     wcOutput = HeapAlloc(GetProcessHeap(), 0, sizeof(WCHAR) * dwOutput);
 112     if (wcOutput == NULL)
 113         return;
 114     MultiByteToWideChar(CP_UNIXCP, 0, str, count, wcOutput, dwOutput);
 115
 116     if ((focus = GetFocus()))
 117         IME_UpdateAssociation(focus);
 118
 119     IME_SetResultString(wcOutput, dwOutput);
 120     HeapFree(GetProcessHeap(), 0, wcOutput);
 121 }
 122
 123 static BOOL XIMPreEditStateNotifyCallback(XIC xic, XPointer p, XPointer data)
 124 {
 125     const struct x11drv_win_data * const win_data = (struct x11drv_win_data *)p;
 126     const XIMPreeditState state = ((XIMPreeditStateNotifyCallbackStruct *)data)->state;
 127
 128     TRACE("xic = %p, win = %lx, state = %lu\n", xic, win_data->whole_window, state);
 129     switch (state)
 130     {
 131     case XIMPreeditEnable:
 132         IME_SetOpenStatus(TRUE);
 133         break;
 134     case XIMPreeditDisable:
 135         IME_SetOpenStatus(FALSE);
 136         break;
 137     default:
 138         break;
 139     }
 140     return TRUE;
 141 }
 142
 143 static int XIMPreEditStartCallback(XIC ic, XPointer client_data, XPointer call_data)
 144 {
 145     TRACE("PreEditStartCallback %p\n",ic);
 146     IME_SetCompositionStatus(TRUE);
 147     ximInComposeMode = TRUE;
 148     return -1;
 149 }
 150
 151 static void XIMPreEditDoneCallback(XIC ic, XPointer client_data, XPointer call_data)
 152 {
 153     TRACE("PreeditDoneCallback %p\n",ic);
 154     ximInComposeMode = FALSE;
 155     if (dwCompStringSize)
 156         HeapFree(GetProcessHeap(), 0, CompositionString);
 157     dwCompStringSize = 0;
 158     dwCompStringLength = 0;
 159     CompositionString = NULL;
 160     IME_SetCompositionStatus(FALSE);
 161 }
 162
 163 static void XIMPreEditDrawCallback(XIM ic, XPointer client_data,
 164                                    XIMPreeditDrawCallbackStruct *P_DR)
 165 {
 166     TRACE("PreEditDrawCallback %p\n",ic);
 167
 168     if (P_DR)
 169     {
 170         int sel = P_DR->chg_first;
 171         int len = P_DR->chg_length;
 172         if (P_DR->text)
 173         {
 174             if (! P_DR->text->encoding_is_wchar)
 175             {
 176                 DWORD dwOutput;
 177                 WCHAR *wcOutput;
 178
 179                 TRACE("multibyte\n");
 180                 dwOutput = MultiByteToWideChar(CP_UNIXCP, 0,
 181                            P_DR->text->string.multi_byte, -1,
 182                            NULL, 0);
 183                 wcOutput = HeapAlloc(GetProcessHeap(), 0, sizeof (WCHAR) * dwOutput);
 184                 if (wcOutput)
 185                 {
 186                     dwOutput = MultiByteToWideChar(CP_UNIXCP, 0,
 187                                P_DR->text->string.multi_byte, -1,
 188                                wcOutput, dwOutput);
 189
 190                     /* ignore null */
 191                     dwOutput --;
 192                     X11DRV_ImmSetInternalString (sel, len, wcOutput, dwOutput);
 193                     HeapFree(GetProcessHeap(), 0, wcOutput);
 194                 }
 195             }
 196             else
 197             {
 198                 FIXME("wchar PROBIBILY WRONG\n");
 199                 X11DRV_ImmSetInternalString (sel, len,
 200                                              (LPWSTR)P_DR->text->string.wide_char,
 201                                              P_DR->text->length);
 202             }
 203         }
 204         else
 205             X11DRV_ImmSetInternalString (sel, len, NULL, 0);
 206         IME_SetCursorPos(P_DR->caret);
 207     }
 208     TRACE("Finished\n");
 209 }
 210
 211 static void XIMPreEditCaretCallback(XIC ic, XPointer client_data,
 212                                     XIMPreeditCaretCallbackStruct *P_C)
 213 {
 214     TRACE("PreeditCaretCallback %p\n",ic);
 215
 216     if (P_C)
 217     {
 218         int pos = IME_GetCursorPos();
 219         TRACE("pos: %d\n", pos);
 220         switch(P_C->direction)
 221         {
 222             case XIMForwardChar:
 223             case XIMForwardWord:
 224                 pos++;
 225                 break;
 226             case XIMBackwardChar:
 227             case XIMBackwardWord:
 228                 pos--;
 229                 break;
 230             case XIMLineStart:
 231                 pos = 0;
 232                 break;
 233             case XIMAbsolutePosition:
 234                 pos = P_C->position;
 235                 break;
 236             case XIMDontChange:
 237                 P_C->position = pos;
 238                 return;
 239             case XIMCaretUp:
 240             case XIMCaretDown:
 241             case XIMPreviousLine:
 242             case XIMNextLine:
 243             case XIMLineEnd:
 244                 FIXME("Not implemented\n");
 245                 break;
 246         }
 247         IME_SetCursorPos(pos);
 248         P_C->position = pos;
 249     }
 250     TRACE("Finished\n");
 251 }
 252
 253 void X11DRV_ForceXIMReset(HWND hwnd)
 254 {
 255     XIC ic = X11DRV_get_ic(hwnd);
 256     if (ic)
 257     {
 258         char* leftover;
 259         TRACE("Forcing Reset %p\n",ic);
 260         leftover = XmbResetIC(ic);
 261         XFree(leftover);
 262     }
 263 }
 264
 265 void X11DRV_SetPreeditState(HWND hwnd, BOOL fOpen)
 266 {
 267     XIC ic;
 268     XIMPreeditState state;
 269     XVaNestedList attr;
 270
 271     ic = X11DRV_get_ic(hwnd);
 272     if (!ic)
 273         return;
 274
 275     if (fOpen)
 276         state = XIMPreeditEnable;
 277     else
 278         state = XIMPreeditDisable;
 279
 280     attr = XVaCreateNestedList(0, XNPreeditState, state, NULL);
 281     if (attr != NULL)
 282     {
 283         XSetICValues(ic, XNPreeditAttributes, attr, NULL);
 284         XFree(attr);
 285     }
 286 }
 287
 288
 289 /***********************************************************************
 290  *           X11DRV_InitXIM
 291  *
 292  * Process-wide XIM initialization.
 293  */
 294 BOOL X11DRV_InitXIM( const char *input_style )
 295 {
 296     if (!strcasecmp(input_style, "offthespot"))
 297         ximStyleRequest = STYLE_OFFTHESPOT;
 298     else if (!strcasecmp(input_style, "overthespot"))
 299         ximStyleRequest = STYLE_OVERTHESPOT;
 300     else if (!strcasecmp(input_style, "root"))
 301         ximStyleRequest = STYLE_ROOT;
 302
 303     if (!XSupportsLocale())
 304     {
 305         WARN("X does not support locale.\n");
 306         return FALSE;
 307     }
 308     if (XSetLocaleModifiers("") == NULL)
 309     {
 310         WARN("Could not set locale modifiers.\n");
 311         return FALSE;
 312     }
 313     return TRUE;
 314 }
 315
 316
 317 static void open_xim_callback( Display *display, XPointer ptr, XPointer data );
 318
 319 static void X11DRV_DestroyIM(XIM xim, XPointer p, XPointer data)
 320 {
 321     struct x11drv_thread_data *thread_data = x11drv_thread_data();
 322
 323     TRACE("xim = %p, p = %p\n", xim, p);
 324     thread_data->xim = NULL;
 325     ximStyle = 0;
 326     XRegisterIMInstantiateCallback( thread_data->display, NULL, NULL, NULL, open_xim_callback, NULL );
 327 }
 328
 329 /***********************************************************************
 330  *           X11DRV Ime creation
 331  *
 332  * Should always be called with the x11 lock held
 333  */
 334 static BOOL open_xim( Display *display )
 335 {
 336     struct x11drv_thread_data *thread_data = x11drv_thread_data();
 337     XIMStyle ximStyleCallback, ximStyleNone;
 338     XIMStyles *ximStyles = NULL;
 339     INT i;
 340     XIM xim;
 341     XIMCallback destroy;
 342
 343     xim = XOpenIM(display, NULL, NULL, NULL);
 344     if (xim == NULL)
 345     {
 346         WARN("Could not open input method.\n");
 347         return FALSE;
 348     }
 349
 350     destroy.client_data = NULL;
 351     destroy.callback = X11DRV_DestroyIM;
 352     if (XSetIMValues(xim, XNDestroyCallback, &destroy, NULL))
 353     {
 354         WARN("Could not set destroy callback.\n");
 355     }
 356
 357     TRACE("xim = %p\n", xim);
 358     TRACE("X display of IM = %p\n", XDisplayOfIM(xim));
 359     TRACE("Using %s locale of Input Method\n", XLocaleOfIM(xim));
 360
 361     XGetIMValues(xim, XNQueryInputStyle, &ximStyles, NULL);
 362     if (ximStyles == 0)
 363     {
 364         WARN("Could not find supported input style.\n");
 365         XCloseIM(xim);
 366         return FALSE;
 367     }
 368     else
 369     {
 370         TRACE("ximStyles->count_styles = %d\n", ximStyles->count_styles);
 371
 372         ximStyleRoot = 0;
 373         ximStyleNone = 0;
 374         ximStyleCallback = 0;
 375
 376         for (i = 0; i < ximStyles->count_styles; ++i)
 377         {
 378             int style = ximStyles->supported_styles[i];
 379             TRACE("ximStyles[%d] = %s%s%s%s%s\n", i,
 380                         (style&XIMPreeditArea)?"XIMPreeditArea ":"",
 381                         (style&XIMPreeditCallbacks)?"XIMPreeditCallbacks ":"",
 382                         (style&XIMPreeditPosition)?"XIMPreeditPosition ":"",
 383                         (style&XIMPreeditNothing)?"XIMPreeditNothing ":"",
 384                         (style&XIMPreeditNone)?"XIMPreeditNone ":"");
 385             if (!ximStyle && (ximStyles->supported_styles[i] ==
 386                                 ximStyleRequest))
 387             {
 388                 ximStyle = ximStyleRequest;
 389                 TRACE("Setting Style: ximStyle = ximStyleRequest\n");
 390             }
 391             else if (!ximStyleRoot &&(ximStyles->supported_styles[i] ==
 392                      STYLE_ROOT))
 393             {
 394                 ximStyleRoot = STYLE_ROOT;
 395                 TRACE("Setting Style: ximStyleRoot = STYLE_ROOT\n");
 396             }
 397             else if (!ximStyleCallback &&(ximStyles->supported_styles[i] ==
 398                      STYLE_CALLBACK))
 399             {
 400                 ximStyleCallback = STYLE_CALLBACK;
 401                 TRACE("Setting Style: ximStyleCallback = STYLE_CALLBACK\n");
 402             }
 403             else if (!ximStyleNone && (ximStyles->supported_styles[i] ==
 404                      STYLE_NONE))
 405             {
 406                 TRACE("Setting Style: ximStyleNone = STYLE_NONE\n");
 407                 ximStyleNone = STYLE_NONE;
 408             }
 409         }
 410         XFree(ximStyles);
 411
 412         if (ximStyle == 0)
 413             ximStyle = ximStyleRoot;
 414
 415         if (ximStyle == 0)
 416             ximStyle = ximStyleNone;
 417
 418         if (ximStyleCallback == 0)
 419         {
 420             TRACE("No callback style available\n");
 421             ximStyleCallback = ximStyle;
 422         }
 423
 424     }
 425
 426     thread_data->xim = xim;
 427
 428     if ((ximStyle & (XIMPreeditNothing | XIMPreeditNone)) == 0 ||
 429         (ximStyle & (XIMStatusNothing | XIMStatusNone)) == 0)
 430     {
 431         char **list;
 432         int count;
 433         thread_data->font_set = XCreateFontSet(display, "fixed",
 434                           &list, &count, NULL);
 435         TRACE("ximFontSet = %p\n", thread_data->font_set);
 436         TRACE("list = %p, count = %d\n", list, count);
 437         if (list != NULL)
 438         {
 439             int i;
 440             for (i = 0; i < count; ++i)
 441                 TRACE("list[%d] = %s\n", i, list[i]);
 442             XFreeStringList(list);
 443         }
 444     }
 445     else
 446         thread_data->font_set = NULL;
 447
 448     IME_UpdateAssociation(NULL);
 449     return TRUE;
 450 }
 451
 452 static void open_xim_callback( Display *display, XPointer ptr, XPointer data )
 453 {
 454     if (open_xim( display ))
 455         XUnregisterIMInstantiateCallback( display, NULL, NULL, NULL, open_xim_callback, NULL);
 456 }
 457
 458 void X11DRV_SetupXIM(void)
 459 {
 460     Display *display = thread_display();
 461
 462     if (!open_xim( display ))
 463         XRegisterIMInstantiateCallback( display, NULL, NULL, NULL, open_xim_callback, NULL );
 464 }
 465
 466 static BOOL X11DRV_DestroyIC(XIC xic, XPointer p, XPointer data)
 467 {
 468     struct x11drv_win_data *win_data = (struct x11drv_win_data *)p;
 469     TRACE("xic = %p, win = %lx\n", xic, win_data->whole_window);
 470     win_data->xic = NULL;
 471     return TRUE;
 472 }
 473
 474
 475 XIC X11DRV_CreateIC(XIM xim, struct x11drv_win_data *data)
 476 {
 477     XPoint spot = {0};
 478     XVaNestedList preedit = NULL;
 479     XVaNestedList status = NULL;
 480     XIC xic;
 481     XICCallback destroy = {(XPointer)data, X11DRV_DestroyIC};
 482     XICCallback P_StateNotifyCB, P_StartCB, P_DoneCB, P_DrawCB, P_CaretCB;
 483     LANGID langid = PRIMARYLANGID(LANGIDFROMLCID(GetThreadLocale()));
 484     Window win = data->whole_window;
 485     XFontSet fontSet = x11drv_thread_data()->font_set;
 486
 487     TRACE("xim = %p\n", xim);
 488
 489     /* use complex and slow XIC initialization method only for CJK */
 490     if (langid != LANG_CHINESE &&
 491         langid != LANG_JAPANESE &&
 492         langid != LANG_KOREAN)
 493     {
 494         xic = XCreateIC(xim,
 495                         XNInputStyle, XIMPreeditNothing | XIMStatusNothing,
 496                         XNClientWindow, win,
 497                         XNFocusWindow, win,
 498                         XNDestroyCallback, &destroy,
 499                         NULL);
 500         data->xic = xic;
 501         return xic;
 502     }
 503
 504     /* create callbacks */
 505     P_StateNotifyCB.client_data = (XPointer)data;
 506     P_StartCB.client_data = NULL;
 507     P_DoneCB.client_data = NULL;
 508     P_DrawCB.client_data = NULL;
 509     P_CaretCB.client_data = NULL;
 510     P_StateNotifyCB.callback = XIMPreEditStateNotifyCallback;
 511     P_StartCB.callback = XIMPreEditStartCallback;
 512     P_DoneCB.callback = (XICProc)XIMPreEditDoneCallback;
 513     P_DrawCB.callback = (XICProc)XIMPreEditDrawCallback;
 514     P_CaretCB.callback = (XICProc)XIMPreEditCaretCallback;
 515
 516     if ((ximStyle & (XIMPreeditNothing | XIMPreeditNone)) == 0)
 517     {
 518         preedit = XVaCreateNestedList(0,
 519                         XNFontSet, fontSet,
 520                         XNSpotLocation, &spot,
 521                         XNPreeditStateNotifyCallback, &P_StateNotifyCB,
 522                         XNPreeditStartCallback, &P_StartCB,
 523                         XNPreeditDoneCallback, &P_DoneCB,
 524                         XNPreeditDrawCallback, &P_DrawCB,
 525                         XNPreeditCaretCallback, &P_CaretCB,
 526                         NULL);
 527         TRACE("preedit = %p\n", preedit);
 528     }
 529     else
 530     {
 531         preedit = XVaCreateNestedList(0,
 532                         XNPreeditStateNotifyCallback, &P_StateNotifyCB,
 533                         XNPreeditStartCallback, &P_StartCB,
 534                         XNPreeditDoneCallback, &P_DoneCB,
 535                         XNPreeditDrawCallback, &P_DrawCB,
 536                         XNPreeditCaretCallback, &P_CaretCB,
 537                         NULL);
 538
 539         TRACE("preedit = %p\n", preedit);
 540     }
 541
 542     if ((ximStyle & (XIMStatusNothing | XIMStatusNone)) == 0)
 543     {
 544         status = XVaCreateNestedList(0,
 545             XNFontSet, fontSet,
 546             NULL);
 547         TRACE("status = %p\n", status);
 548      }
 549
 550     if (preedit != NULL && status != NULL)
 551     {
 552         xic = XCreateIC(xim,
 553               XNInputStyle, ximStyle,
 554               XNPreeditAttributes, preedit,
 555               XNStatusAttributes, status,
 556               XNClientWindow, win,
 557               XNFocusWindow, win,
 558               XNDestroyCallback, &destroy,
 559               NULL);
 560      }
 561     else if (preedit != NULL)
 562     {
 563         xic = XCreateIC(xim,
 564               XNInputStyle, ximStyle,
 565               XNPreeditAttributes, preedit,
 566               XNClientWindow, win,
 567               XNFocusWindow, win,
 568               XNDestroyCallback, &destroy,
 569               NULL);
 570     }
 571     else if (status != NULL)
 572     {
 573         xic = XCreateIC(xim,
 574               XNInputStyle, ximStyle,
 575               XNStatusAttributes, status,
 576               XNClientWindow, win,
 577               XNFocusWindow, win,
 578               XNDestroyCallback, &destroy,
 579               NULL);
 580     }
 581     else
 582     {
 583         xic = XCreateIC(xim,
 584               XNInputStyle, ximStyle,
 585               XNClientWindow, win,
 586               XNFocusWindow, win,
 587               XNDestroyCallback, &destroy,
 588               NULL);
 589     }
 590
 591     TRACE("xic = %p\n", xic);
 592     data->xic = xic;
 593
 594     if (preedit != NULL)
 595         XFree(preedit);
 596     if (status != NULL)
 597         XFree(status);
 598
 599     return xic;
 600 }