Remove unnecessary include paths in Makefile
[MacVim.git] / src / mbyte.c
blob6156e8f9e7c40ecd51c0cc2eaa96f38b6a2e7569
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
4 * Multibyte extensions partly by Sung-Hoon Baek
6 * Do ":help uganda" in Vim to read copying and usage conditions.
7 * Do ":help credits" in Vim to see a list of people who contributed.
8 * See README.txt for an overview of the Vim source code.
9 */
11 * mbyte.c: Code specifically for handling multi-byte characters.
13 * The encoding used in the core is set with 'encoding'. When 'encoding' is
14 * changed, the following four variables are set (for speed).
15 * Currently these types of character encodings are supported:
17 * "enc_dbcs" When non-zero it tells the type of double byte character
18 * encoding (Chinese, Korean, Japanese, etc.).
19 * The cell width on the display is equal to the number of
20 * bytes. (exception: DBCS_JPNU with first byte 0x8e)
21 * Recognizing the first or second byte is difficult, it
22 * requires checking a byte sequence from the start.
23 * "enc_utf8" When TRUE use Unicode characters in UTF-8 encoding.
24 * The cell width on the display needs to be determined from
25 * the character value.
26 * Recognizing bytes is easy: 0xxx.xxxx is a single-byte
27 * char, 10xx.xxxx is a trailing byte, 11xx.xxxx is a leading
28 * byte of a multi-byte character.
29 * To make things complicated, up to two composing characters
30 * are allowed. These are drawn on top of the first char.
31 * For most editing the sequence of bytes with composing
32 * characters included is considered to be one character.
33 * "enc_unicode" When 2 use 16-bit Unicode characters (or UTF-16).
34 * When 4 use 32-but Unicode characters.
35 * Internally characters are stored in UTF-8 encoding to
36 * avoid NUL bytes. Conversion happens when doing I/O.
37 * "enc_utf8" will also be TRUE.
39 * "has_mbyte" is set when "enc_dbcs" or "enc_utf8" is non-zero.
41 * If none of these is TRUE, 8-bit bytes are used for a character. The
42 * encoding isn't currently specified (TODO).
44 * 'encoding' specifies the encoding used in the core. This is in registers,
45 * text manipulation, buffers, etc. Conversion has to be done when characters
46 * in another encoding are received or send:
48 * clipboard
49 * ^
50 * | (2)
51 * V
52 * +---------------+
53 * (1) | | (3)
54 * keyboard ----->| core |-----> display
55 * | |
56 * +---------------+
57 * ^
58 * | (4)
59 * V
60 * file
62 * (1) Typed characters arrive in the current locale. Conversion is to be
63 * done when 'encoding' is different from 'termencoding'.
64 * (2) Text will be made available with the encoding specified with
65 * 'encoding'. If this is not sufficient, system-specific conversion
66 * might be required.
67 * (3) For the GUI the correct font must be selected, no conversion done.
68 * Otherwise, conversion is to be done when 'encoding' differs from
69 * 'termencoding'. (Different in the GTK+ 2 port -- 'termencoding'
70 * is always used for both input and output and must always be set to
71 * "utf-8". gui_mch_init() does this automatically.)
72 * (4) The encoding of the file is specified with 'fileencoding'. Conversion
73 * is to be done when it's different from 'encoding'.
75 * The viminfo file is a special case: Only text is converted, not file names.
76 * Vim scripts may contain an ":encoding" command. This has an effect for
77 * some commands, like ":menutrans"
80 #include "vim.h"
82 #ifdef WIN32UNIX
83 # ifndef WIN32_LEAN_AND_MEAN
84 # define WIN32_LEAN_AND_MEAN
85 # endif
86 # include <windows.h>
87 # ifdef WIN32
88 # undef WIN32 /* Some windows.h define WIN32, we don't want that here. */
89 # endif
90 #endif
92 #if (defined(WIN3264) || defined(WIN32UNIX)) && !defined(__MINGW32__)
93 # include <winnls.h>
94 #endif
96 #ifdef FEAT_GUI_X11
97 # include <X11/Intrinsic.h>
98 #endif
99 #ifdef X_LOCALE
100 #include <X11/Xlocale.h>
101 #endif
103 #if defined(FEAT_GUI_GTK) && defined(FEAT_XIM) && defined(HAVE_GTK2)
104 # include <gdk/gdkkeysyms.h>
105 # ifdef WIN3264
106 # include <gdk/gdkwin32.h>
107 # else
108 # include <gdk/gdkx.h>
109 # endif
110 #endif
112 #ifdef HAVE_WCHAR_H
113 # include <wchar.h>
114 #endif
116 #if 0
117 /* This has been disabled, because several people reported problems with the
118 * wcwidth() and iswprint() library functions, esp. for Hebrew. */
119 # ifdef __STDC_ISO_10646__
120 # define USE_WCHAR_FUNCTIONS
121 # endif
122 #endif
124 #if defined(FEAT_MBYTE) || defined(PROTO)
126 static int enc_canon_search __ARGS((char_u *name));
127 static int dbcs_char2len __ARGS((int c));
128 static int dbcs_char2bytes __ARGS((int c, char_u *buf));
129 static int dbcs_ptr2len __ARGS((char_u *p));
130 static int dbcs_ptr2len_len __ARGS((char_u *p, int size));
131 static int utf_ptr2cells_len __ARGS((char_u *p, int size));
132 static int dbcs_char2cells __ARGS((int c));
133 static int dbcs_ptr2cells_len __ARGS((char_u *p, int size));
134 static int dbcs_ptr2char __ARGS((char_u *p));
136 /* Lookup table to quickly get the length in bytes of a UTF-8 character from
137 * the first byte of a UTF-8 string. Bytes which are illegal when used as the
138 * first byte have a one, because these will be used separately. */
139 static char utf8len_tab[256] =
141 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
142 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
143 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
144 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
145 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /*bogus*/
146 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /*bogus*/
147 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
148 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,4,4,4,4,4,4,4,4,5,5,5,5,6,6,1,1,
152 * XIM often causes trouble. Define XIM_DEBUG to get a log of XIM callbacks
153 * in the "xim.log" file.
155 /* #define XIM_DEBUG */
156 #ifdef XIM_DEBUG
157 static void
158 xim_log(char *s, ...)
160 va_list arglist;
161 static FILE *fd = NULL;
163 if (fd == (FILE *)-1)
164 return;
165 if (fd == NULL)
167 fd = mch_fopen("xim.log", "w");
168 if (fd == NULL)
170 EMSG("Cannot open xim.log");
171 fd = (FILE *)-1;
172 return;
176 va_start(arglist, s);
177 vfprintf(fd, s, arglist);
178 va_end(arglist);
180 #endif
182 #endif
184 #if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT) || defined(PROTO)
186 * Canonical encoding names and their properties.
187 * "iso-8859-n" is handled by enc_canonize() directly.
189 static struct
190 { char *name; int prop; int codepage;}
191 enc_canon_table[] =
193 #define IDX_LATIN_1 0
194 {"latin1", ENC_8BIT + ENC_LATIN1, 1252},
195 #define IDX_ISO_2 1
196 {"iso-8859-2", ENC_8BIT, 0},
197 #define IDX_ISO_3 2
198 {"iso-8859-3", ENC_8BIT, 0},
199 #define IDX_ISO_4 3
200 {"iso-8859-4", ENC_8BIT, 0},
201 #define IDX_ISO_5 4
202 {"iso-8859-5", ENC_8BIT, 0},
203 #define IDX_ISO_6 5
204 {"iso-8859-6", ENC_8BIT, 0},
205 #define IDX_ISO_7 6
206 {"iso-8859-7", ENC_8BIT, 0},
207 #define IDX_ISO_8 7
208 {"iso-8859-8", ENC_8BIT, 0},
209 #define IDX_ISO_9 8
210 {"iso-8859-9", ENC_8BIT, 0},
211 #define IDX_ISO_10 9
212 {"iso-8859-10", ENC_8BIT, 0},
213 #define IDX_ISO_11 10
214 {"iso-8859-11", ENC_8BIT, 0},
215 #define IDX_ISO_13 11
216 {"iso-8859-13", ENC_8BIT, 0},
217 #define IDX_ISO_14 12
218 {"iso-8859-14", ENC_8BIT, 0},
219 #define IDX_ISO_15 13
220 {"iso-8859-15", ENC_8BIT + ENC_LATIN9, 0},
221 #define IDX_KOI8_R 14
222 {"koi8-r", ENC_8BIT, 0},
223 #define IDX_KOI8_U 15
224 {"koi8-u", ENC_8BIT, 0},
225 #define IDX_UTF8 16
226 {"utf-8", ENC_UNICODE, 0},
227 #define IDX_UCS2 17
228 {"ucs-2", ENC_UNICODE + ENC_ENDIAN_B + ENC_2BYTE, 0},
229 #define IDX_UCS2LE 18
230 {"ucs-2le", ENC_UNICODE + ENC_ENDIAN_L + ENC_2BYTE, 0},
231 #define IDX_UTF16 19
232 {"utf-16", ENC_UNICODE + ENC_ENDIAN_B + ENC_2WORD, 0},
233 #define IDX_UTF16LE 20
234 {"utf-16le", ENC_UNICODE + ENC_ENDIAN_L + ENC_2WORD, 0},
235 #define IDX_UCS4 21
236 {"ucs-4", ENC_UNICODE + ENC_ENDIAN_B + ENC_4BYTE, 0},
237 #define IDX_UCS4LE 22
238 {"ucs-4le", ENC_UNICODE + ENC_ENDIAN_L + ENC_4BYTE, 0},
240 /* For debugging DBCS encoding on Unix. */
241 #define IDX_DEBUG 23
242 {"debug", ENC_DBCS, DBCS_DEBUG},
243 #define IDX_EUC_JP 24
244 {"euc-jp", ENC_DBCS, DBCS_JPNU},
245 #define IDX_SJIS 25
246 {"sjis", ENC_DBCS, DBCS_JPN},
247 #define IDX_EUC_KR 26
248 {"euc-kr", ENC_DBCS, DBCS_KORU},
249 #define IDX_EUC_CN 27
250 {"euc-cn", ENC_DBCS, DBCS_CHSU},
251 #define IDX_EUC_TW 28
252 {"euc-tw", ENC_DBCS, DBCS_CHTU},
253 #define IDX_BIG5 29
254 {"big5", ENC_DBCS, DBCS_CHT},
256 /* MS-DOS and MS-Windows codepages are included here, so that they can be
257 * used on Unix too. Most of them are similar to ISO-8859 encodings, but
258 * not exactly the same. */
259 #define IDX_CP437 30
260 {"cp437", ENC_8BIT, 437}, /* like iso-8859-1 */
261 #define IDX_CP737 31
262 {"cp737", ENC_8BIT, 737}, /* like iso-8859-7 */
263 #define IDX_CP775 32
264 {"cp775", ENC_8BIT, 775}, /* Baltic */
265 #define IDX_CP850 33
266 {"cp850", ENC_8BIT, 850}, /* like iso-8859-4 */
267 #define IDX_CP852 34
268 {"cp852", ENC_8BIT, 852}, /* like iso-8859-1 */
269 #define IDX_CP855 35
270 {"cp855", ENC_8BIT, 855}, /* like iso-8859-2 */
271 #define IDX_CP857 36
272 {"cp857", ENC_8BIT, 857}, /* like iso-8859-5 */
273 #define IDX_CP860 37
274 {"cp860", ENC_8BIT, 860}, /* like iso-8859-9 */
275 #define IDX_CP861 38
276 {"cp861", ENC_8BIT, 861}, /* like iso-8859-1 */
277 #define IDX_CP862 39
278 {"cp862", ENC_8BIT, 862}, /* like iso-8859-1 */
279 #define IDX_CP863 40
280 {"cp863", ENC_8BIT, 863}, /* like iso-8859-8 */
281 #define IDX_CP865 41
282 {"cp865", ENC_8BIT, 865}, /* like iso-8859-1 */
283 #define IDX_CP866 42
284 {"cp866", ENC_8BIT, 866}, /* like iso-8859-5 */
285 #define IDX_CP869 43
286 {"cp869", ENC_8BIT, 869}, /* like iso-8859-7 */
287 #define IDX_CP874 44
288 {"cp874", ENC_8BIT, 874}, /* Thai */
289 #define IDX_CP932 45
290 {"cp932", ENC_DBCS, DBCS_JPN},
291 #define IDX_CP936 46
292 {"cp936", ENC_DBCS, DBCS_CHS},
293 #define IDX_CP949 47
294 {"cp949", ENC_DBCS, DBCS_KOR},
295 #define IDX_CP950 48
296 {"cp950", ENC_DBCS, DBCS_CHT},
297 #define IDX_CP1250 49
298 {"cp1250", ENC_8BIT, 1250}, /* Czech, Polish, etc. */
299 #define IDX_CP1251 50
300 {"cp1251", ENC_8BIT, 1251}, /* Cyrillic */
301 /* cp1252 is considered to be equal to latin1 */
302 #define IDX_CP1253 51
303 {"cp1253", ENC_8BIT, 1253}, /* Greek */
304 #define IDX_CP1254 52
305 {"cp1254", ENC_8BIT, 1254}, /* Turkish */
306 #define IDX_CP1255 53
307 {"cp1255", ENC_8BIT, 1255}, /* Hebrew */
308 #define IDX_CP1256 54
309 {"cp1256", ENC_8BIT, 1256}, /* Arabic */
310 #define IDX_CP1257 55
311 {"cp1257", ENC_8BIT, 1257}, /* Baltic */
312 #define IDX_CP1258 56
313 {"cp1258", ENC_8BIT, 1258}, /* Vietnamese */
315 #define IDX_MACROMAN 57
316 {"macroman", ENC_8BIT + ENC_MACROMAN, 0}, /* Mac OS */
317 #define IDX_DECMCS 58
318 {"dec-mcs", ENC_8BIT, 0}, /* DEC MCS */
319 #define IDX_HPROMAN8 59
320 {"hp-roman8", ENC_8BIT, 0}, /* HP Roman8 */
321 #define IDX_COUNT 60
325 * Aliases for encoding names.
327 static struct
328 { char *name; int canon;}
329 enc_alias_table[] =
331 {"ansi", IDX_LATIN_1},
332 {"iso-8859-1", IDX_LATIN_1},
333 {"latin2", IDX_ISO_2},
334 {"latin3", IDX_ISO_3},
335 {"latin4", IDX_ISO_4},
336 {"cyrillic", IDX_ISO_5},
337 {"arabic", IDX_ISO_6},
338 {"greek", IDX_ISO_7},
339 #ifdef WIN3264
340 {"hebrew", IDX_CP1255},
341 #else
342 {"hebrew", IDX_ISO_8},
343 #endif
344 {"latin5", IDX_ISO_9},
345 {"turkish", IDX_ISO_9}, /* ? */
346 {"latin6", IDX_ISO_10},
347 {"nordic", IDX_ISO_10}, /* ? */
348 {"thai", IDX_ISO_11}, /* ? */
349 {"latin7", IDX_ISO_13},
350 {"latin8", IDX_ISO_14},
351 {"latin9", IDX_ISO_15},
352 {"utf8", IDX_UTF8},
353 {"unicode", IDX_UCS2},
354 {"ucs2", IDX_UCS2},
355 {"ucs2be", IDX_UCS2},
356 {"ucs-2be", IDX_UCS2},
357 {"ucs2le", IDX_UCS2LE},
358 {"utf16", IDX_UTF16},
359 {"utf16be", IDX_UTF16},
360 {"utf-16be", IDX_UTF16},
361 {"utf16le", IDX_UTF16LE},
362 {"ucs4", IDX_UCS4},
363 {"ucs4be", IDX_UCS4},
364 {"ucs-4be", IDX_UCS4},
365 {"ucs4le", IDX_UCS4LE},
366 {"utf32", IDX_UCS4},
367 {"utf-32", IDX_UCS4},
368 {"utf32be", IDX_UCS4},
369 {"utf-32be", IDX_UCS4},
370 {"utf32le", IDX_UCS4LE},
371 {"utf-32le", IDX_UCS4LE},
372 {"932", IDX_CP932},
373 {"949", IDX_CP949},
374 {"936", IDX_CP936},
375 {"gbk", IDX_CP936},
376 {"950", IDX_CP950},
377 {"eucjp", IDX_EUC_JP},
378 {"unix-jis", IDX_EUC_JP},
379 {"ujis", IDX_EUC_JP},
380 {"shift-jis", IDX_SJIS},
381 {"euckr", IDX_EUC_KR},
382 {"5601", IDX_EUC_KR}, /* Sun: KS C 5601 */
383 {"euccn", IDX_EUC_CN},
384 {"gb2312", IDX_EUC_CN},
385 {"euctw", IDX_EUC_TW},
386 #if defined(WIN3264) || defined(WIN32UNIX) || defined(MACOS)
387 {"japan", IDX_CP932},
388 {"korea", IDX_CP949},
389 {"prc", IDX_CP936},
390 {"chinese", IDX_CP936},
391 {"taiwan", IDX_CP950},
392 {"big5", IDX_CP950},
393 #else
394 {"japan", IDX_EUC_JP},
395 {"korea", IDX_EUC_KR},
396 {"prc", IDX_EUC_CN},
397 {"chinese", IDX_EUC_CN},
398 {"taiwan", IDX_EUC_TW},
399 {"cp950", IDX_BIG5},
400 {"950", IDX_BIG5},
401 #endif
402 {"mac", IDX_MACROMAN},
403 {"mac-roman", IDX_MACROMAN},
404 {NULL, 0}
407 #ifndef CP_UTF8
408 # define CP_UTF8 65001 /* magic number from winnls.h */
409 #endif
412 * Find encoding "name" in the list of canonical encoding names.
413 * Returns -1 if not found.
415 static int
416 enc_canon_search(name)
417 char_u *name;
419 int i;
421 for (i = 0; i < IDX_COUNT; ++i)
422 if (STRCMP(name, enc_canon_table[i].name) == 0)
423 return i;
424 return -1;
427 #endif
429 #if defined(FEAT_MBYTE) || defined(PROTO)
432 * Find canonical encoding "name" in the list and return its properties.
433 * Returns 0 if not found.
436 enc_canon_props(name)
437 char_u *name;
439 int i;
441 i = enc_canon_search(name);
442 if (i >= 0)
443 return enc_canon_table[i].prop;
444 #ifdef WIN3264
445 if (name[0] == 'c' && name[1] == 'p' && VIM_ISDIGIT(name[2]))
447 CPINFO cpinfo;
449 /* Get info on this codepage to find out what it is. */
450 if (GetCPInfo(atoi(name + 2), &cpinfo) != 0)
452 if (cpinfo.MaxCharSize == 1) /* some single-byte encoding */
453 return ENC_8BIT;
454 if (cpinfo.MaxCharSize == 2
455 && (cpinfo.LeadByte[0] != 0 || cpinfo.LeadByte[1] != 0))
456 /* must be a DBCS encoding */
457 return ENC_DBCS;
459 return 0;
461 #endif
462 if (STRNCMP(name, "2byte-", 6) == 0)
463 return ENC_DBCS;
464 if (STRNCMP(name, "8bit-", 5) == 0 || STRNCMP(name, "iso-8859-", 9) == 0)
465 return ENC_8BIT;
466 return 0;
470 * Set up for using multi-byte characters.
471 * Called in three cases:
472 * - by main() to initialize (p_enc == NULL)
473 * - by set_init_1() after 'encoding' was set to its default.
474 * - by do_set() when 'encoding' has been set.
475 * p_enc must have been passed through enc_canonize() already.
476 * Sets the "enc_unicode", "enc_utf8", "enc_dbcs" and "has_mbyte" flags.
477 * Fills mb_bytelen_tab[] and returns NULL when there are no problems.
478 * When there is something wrong: Returns an error message and doesn't change
479 * anything.
481 char_u *
482 mb_init()
484 int i;
485 int idx;
486 int n;
487 int enc_dbcs_new = 0;
488 #if defined(USE_ICONV) && !defined(WIN3264) && !defined(WIN32UNIX) \
489 && !defined(MACOS)
490 # define LEN_FROM_CONV
491 vimconv_T vimconv;
492 char_u *p;
493 #endif
495 if (p_enc == NULL)
497 /* Just starting up: set the whole table to one's. */
498 for (i = 0; i < 256; ++i)
499 mb_bytelen_tab[i] = 1;
500 input_conv.vc_type = CONV_NONE;
501 input_conv.vc_factor = 1;
502 output_conv.vc_type = CONV_NONE;
503 return NULL;
506 #ifdef WIN3264
507 if (p_enc[0] == 'c' && p_enc[1] == 'p' && VIM_ISDIGIT(p_enc[2]))
509 CPINFO cpinfo;
511 /* Get info on this codepage to find out what it is. */
512 if (GetCPInfo(atoi(p_enc + 2), &cpinfo) != 0)
514 if (cpinfo.MaxCharSize == 1)
516 /* some single-byte encoding */
517 enc_unicode = 0;
518 enc_utf8 = FALSE;
520 else if (cpinfo.MaxCharSize == 2
521 && (cpinfo.LeadByte[0] != 0 || cpinfo.LeadByte[1] != 0))
523 /* must be a DBCS encoding, check below */
524 enc_dbcs_new = atoi(p_enc + 2);
526 else
527 goto codepage_invalid;
529 else if (GetLastError() == ERROR_INVALID_PARAMETER)
531 codepage_invalid:
532 return (char_u *)N_("E543: Not a valid codepage");
535 #endif
536 else if (STRNCMP(p_enc, "8bit-", 5) == 0
537 || STRNCMP(p_enc, "iso-8859-", 9) == 0)
539 /* Accept any "8bit-" or "iso-8859-" name. */
540 enc_unicode = 0;
541 enc_utf8 = FALSE;
543 else if (STRNCMP(p_enc, "2byte-", 6) == 0)
545 #ifdef WIN3264
546 /* Windows: accept only valid codepage numbers, check below. */
547 if (p_enc[6] != 'c' || p_enc[7] != 'p'
548 || (enc_dbcs_new = atoi(p_enc + 8)) == 0)
549 return e_invarg;
550 #else
551 /* Unix: accept any "2byte-" name, assume current locale. */
552 enc_dbcs_new = DBCS_2BYTE;
553 #endif
555 else if ((idx = enc_canon_search(p_enc)) >= 0)
557 i = enc_canon_table[idx].prop;
558 if (i & ENC_UNICODE)
560 /* Unicode */
561 enc_utf8 = TRUE;
562 if (i & (ENC_2BYTE | ENC_2WORD))
563 enc_unicode = 2;
564 else if (i & ENC_4BYTE)
565 enc_unicode = 4;
566 else
567 enc_unicode = 0;
569 else if (i & ENC_DBCS)
571 /* 2byte, handle below */
572 enc_dbcs_new = enc_canon_table[idx].codepage;
574 else
576 /* Must be 8-bit. */
577 enc_unicode = 0;
578 enc_utf8 = FALSE;
581 else /* Don't know what encoding this is, reject it. */
582 return e_invarg;
584 if (enc_dbcs_new != 0)
586 #ifdef WIN3264
587 /* Check if the DBCS code page is OK. */
588 if (!IsValidCodePage(enc_dbcs_new))
589 goto codepage_invalid;
590 #endif
591 enc_unicode = 0;
592 enc_utf8 = FALSE;
594 enc_dbcs = enc_dbcs_new;
595 has_mbyte = (enc_dbcs != 0 || enc_utf8);
597 #ifdef WIN3264
598 enc_codepage = encname2codepage(p_enc);
599 enc_latin9 = (STRCMP(p_enc, "iso-8859-15") == 0);
600 #endif
602 /* Detect an encoding that uses latin1 characters. */
603 enc_latin1like = (enc_utf8 || STRCMP(p_enc, "latin1") == 0
604 || STRCMP(p_enc, "iso-8859-15") == 0);
607 * Set the function pointers.
609 if (enc_utf8)
611 mb_ptr2len = utfc_ptr2len;
612 mb_ptr2len_len = utfc_ptr2len_len;
613 mb_char2len = utf_char2len;
614 mb_char2bytes = utf_char2bytes;
615 mb_ptr2cells = utf_ptr2cells;
616 mb_ptr2cells_len = utf_ptr2cells_len;
617 mb_char2cells = utf_char2cells;
618 mb_off2cells = utf_off2cells;
619 mb_ptr2char = utf_ptr2char;
620 mb_head_off = utf_head_off;
622 else if (enc_dbcs != 0)
624 mb_ptr2len = dbcs_ptr2len;
625 mb_ptr2len_len = dbcs_ptr2len_len;
626 mb_char2len = dbcs_char2len;
627 mb_char2bytes = dbcs_char2bytes;
628 mb_ptr2cells = dbcs_ptr2cells;
629 mb_ptr2cells_len = dbcs_ptr2cells_len;
630 mb_char2cells = dbcs_char2cells;
631 mb_off2cells = dbcs_off2cells;
632 mb_ptr2char = dbcs_ptr2char;
633 mb_head_off = dbcs_head_off;
635 else
637 mb_ptr2len = latin_ptr2len;
638 mb_ptr2len_len = latin_ptr2len_len;
639 mb_char2len = latin_char2len;
640 mb_char2bytes = latin_char2bytes;
641 mb_ptr2cells = latin_ptr2cells;
642 mb_ptr2cells_len = latin_ptr2cells_len;
643 mb_char2cells = latin_char2cells;
644 mb_off2cells = latin_off2cells;
645 mb_ptr2char = latin_ptr2char;
646 mb_head_off = latin_head_off;
650 * Fill the mb_bytelen_tab[] for MB_BYTE2LEN().
652 #ifdef LEN_FROM_CONV
653 /* When 'encoding' is different from the current locale mblen() won't
654 * work. Use conversion to "utf-8" instead. */
655 vimconv.vc_type = CONV_NONE;
656 if (enc_dbcs)
658 p = enc_locale();
659 if (p == NULL || STRCMP(p, p_enc) != 0)
661 convert_setup(&vimconv, p_enc, (char_u *)"utf-8");
662 vimconv.vc_fail = TRUE;
664 vim_free(p);
666 #endif
668 for (i = 0; i < 256; ++i)
670 /* Our own function to reliably check the length of UTF-8 characters,
671 * independent of mblen(). */
672 if (enc_utf8)
673 n = utf8len_tab[i];
674 else if (enc_dbcs == 0)
675 n = 1;
676 else
678 #if defined(WIN3264) || defined(WIN32UNIX)
679 /* enc_dbcs is set by setting 'fileencoding'. It becomes a Windows
680 * CodePage identifier, which we can pass directly in to Windows
681 * API */
682 n = IsDBCSLeadByteEx(enc_dbcs, (BYTE)i) ? 2 : 1;
683 #else
684 # if defined(MACOS) || defined(__amigaos4__)
686 * if mblen() is not available, character which MSB is turned on
687 * are treated as leading byte character. (note : This assumption
688 * is not always true.)
690 n = (i & 0x80) ? 2 : 1;
691 # else
692 char buf[MB_MAXBYTES];
693 # ifdef X_LOCALE
694 # ifndef mblen
695 # define mblen _Xmblen
696 # endif
697 # endif
698 if (i == NUL) /* just in case mblen() can't handle "" */
699 n = 1;
700 else
702 buf[0] = i;
703 buf[1] = 0;
704 #ifdef LEN_FROM_CONV
705 if (vimconv.vc_type != CONV_NONE)
708 * string_convert() should fail when converting the first
709 * byte of a double-byte character.
711 p = string_convert(&vimconv, (char_u *)buf, NULL);
712 if (p != NULL)
714 vim_free(p);
715 n = 1;
717 else
718 n = 2;
720 else
721 #endif
724 * mblen() should return -1 for invalid (means the leading
725 * multibyte) character. However there are some platforms
726 * where mblen() returns 0 for invalid character.
727 * Therefore, following condition includes 0.
729 ignored = mblen(NULL, 0); /* First reset the state. */
730 if (mblen(buf, (size_t)1) <= 0)
731 n = 2;
732 else
733 n = 1;
736 # endif
737 #endif
740 mb_bytelen_tab[i] = n;
743 #ifdef LEN_FROM_CONV
744 convert_setup(&vimconv, NULL, NULL);
745 #endif
747 /* The cell width depends on the type of multi-byte characters. */
748 (void)init_chartab();
750 /* When enc_utf8 is set or reset, (de)allocate ScreenLinesUC[] */
751 screenalloc(FALSE);
753 /* When using Unicode, set default for 'fileencodings'. */
754 if (enc_utf8 && !option_was_set((char_u *)"fencs"))
755 set_string_option_direct((char_u *)"fencs", -1,
756 (char_u *)"ucs-bom,utf-8,default,latin1", OPT_FREE, 0);
758 #if defined(HAVE_BIND_TEXTDOMAIN_CODESET) && defined(FEAT_GETTEXT)
759 /* GNU gettext 0.10.37 supports this feature: set the codeset used for
760 * translated messages independently from the current locale. */
761 (void)bind_textdomain_codeset(VIMPACKAGE,
762 enc_utf8 ? "utf-8" : (char *)p_enc);
763 #endif
765 #ifdef WIN32
766 /* When changing 'encoding' while starting up, then convert the command
767 * line arguments from the active codepage to 'encoding'. */
768 if (starting != 0)
769 fix_arg_enc();
770 #endif
772 #ifdef FEAT_AUTOCMD
773 /* Fire an autocommand to let people do custom font setup. This must be
774 * after Vim has been setup for the new encoding. */
775 apply_autocmds(EVENT_ENCODINGCHANGED, NULL, (char_u *)"", FALSE, curbuf);
776 #endif
778 #ifdef FEAT_SPELL
779 /* Need to reload spell dictionaries */
780 spell_reload();
781 #endif
783 return NULL;
787 * Return the size of the BOM for the current buffer:
788 * 0 - no BOM
789 * 2 - UCS-2 or UTF-16 BOM
790 * 4 - UCS-4 BOM
791 * 3 - UTF-8 BOM
794 bomb_size()
796 int n = 0;
798 if (curbuf->b_p_bomb && !curbuf->b_p_bin)
800 if (*curbuf->b_p_fenc == NUL)
802 if (enc_utf8)
804 if (enc_unicode != 0)
805 n = enc_unicode;
806 else
807 n = 3;
810 else if (STRCMP(curbuf->b_p_fenc, "utf-8") == 0)
811 n = 3;
812 else if (STRNCMP(curbuf->b_p_fenc, "ucs-2", 5) == 0
813 || STRNCMP(curbuf->b_p_fenc, "utf-16", 6) == 0)
814 n = 2;
815 else if (STRNCMP(curbuf->b_p_fenc, "ucs-4", 5) == 0)
816 n = 4;
818 return n;
822 * Get class of pointer:
823 * 0 for blank or NUL
824 * 1 for punctuation
825 * 2 for an (ASCII) word character
826 * >2 for other word characters
829 mb_get_class(p)
830 char_u *p;
832 if (MB_BYTE2LEN(p[0]) == 1)
834 if (p[0] == NUL || vim_iswhite(p[0]))
835 return 0;
836 if (vim_iswordc(p[0]))
837 return 2;
838 return 1;
840 if (enc_dbcs != 0 && p[0] != NUL && p[1] != NUL)
841 return dbcs_class(p[0], p[1]);
842 if (enc_utf8)
843 return utf_class(utf_ptr2char(p));
844 return 0;
848 * Get class of a double-byte character. This always returns 3 or bigger.
849 * TODO: Should return 1 for punctuation.
852 dbcs_class(lead, trail)
853 unsigned lead;
854 unsigned trail;
856 switch (enc_dbcs)
858 /* please add classfy routine for your language in here */
860 case DBCS_JPNU: /* ? */
861 case DBCS_JPN:
863 /* JIS code classification */
864 unsigned char lb = lead;
865 unsigned char tb = trail;
867 /* convert process code to JIS */
868 # if defined(WIN3264) || defined(WIN32UNIX) || defined(MACOS)
869 /* process code is SJIS */
870 if (lb <= 0x9f)
871 lb = (lb - 0x81) * 2 + 0x21;
872 else
873 lb = (lb - 0xc1) * 2 + 0x21;
874 if (tb <= 0x7e)
875 tb -= 0x1f;
876 else if (tb <= 0x9e)
877 tb -= 0x20;
878 else
880 tb -= 0x7e;
881 lb += 1;
883 # else
885 * XXX: Code page identification can not use with all
886 * system! So, some other encoding information
887 * will be needed.
888 * In japanese: SJIS,EUC,UNICODE,(JIS)
889 * Note that JIS-code system don't use as
890 * process code in most system because it uses
891 * escape sequences(JIS is context depend encoding).
893 /* assume process code is JAPANESE-EUC */
894 lb &= 0x7f;
895 tb &= 0x7f;
896 # endif
897 /* exceptions */
898 switch (lb << 8 | tb)
900 case 0x2121: /* ZENKAKU space */
901 return 0;
902 case 0x2122: /* KU-TEN (Japanese comma) */
903 case 0x2123: /* TOU-TEN (Japanese period) */
904 case 0x2124: /* ZENKAKU comma */
905 case 0x2125: /* ZENKAKU period */
906 return 1;
907 case 0x213c: /* prolongedsound handled as KATAKANA */
908 return 13;
910 /* sieved by KU code */
911 switch (lb)
913 case 0x21:
914 case 0x22:
915 /* special symbols */
916 return 10;
917 case 0x23:
918 /* alpha-numeric */
919 return 11;
920 case 0x24:
921 /* hiragana */
922 return 12;
923 case 0x25:
924 /* katakana */
925 return 13;
926 case 0x26:
927 /* greek */
928 return 14;
929 case 0x27:
930 /* russian */
931 return 15;
932 case 0x28:
933 /* lines */
934 return 16;
935 default:
936 /* kanji */
937 return 17;
941 case DBCS_KORU: /* ? */
942 case DBCS_KOR:
944 /* KS code classification */
945 unsigned char c1 = lead;
946 unsigned char c2 = trail;
949 * 20 : Hangul
950 * 21 : Hanja
951 * 22 : Symbols
952 * 23 : Alpha-numeric/Roman Letter (Full width)
953 * 24 : Hangul Letter(Alphabet)
954 * 25 : Roman Numeral/Greek Letter
955 * 26 : Box Drawings
956 * 27 : Unit Symbols
957 * 28 : Circled/Parenthesized Letter
958 * 29 : Hirigana/Katakana
959 * 30 : Cyrillic Letter
962 if (c1 >= 0xB0 && c1 <= 0xC8)
963 /* Hangul */
964 return 20;
965 #if defined(WIN3264) || defined(WIN32UNIX)
966 else if (c1 <= 0xA0 || c2 <= 0xA0)
967 /* Extended Hangul Region : MS UHC(Unified Hangul Code) */
968 /* c1: 0x81-0xA0 with c2: 0x41-0x5A, 0x61-0x7A, 0x81-0xFE
969 * c1: 0xA1-0xC6 with c2: 0x41-0x5A, 0x61-0x7A, 0x81-0xA0
971 return 20;
972 #endif
974 else if (c1 >= 0xCA && c1 <= 0xFD)
975 /* Hanja */
976 return 21;
977 else switch (c1)
979 case 0xA1:
980 case 0xA2:
981 /* Symbols */
982 return 22;
983 case 0xA3:
984 /* Alpha-numeric */
985 return 23;
986 case 0xA4:
987 /* Hangul Letter(Alphabet) */
988 return 24;
989 case 0xA5:
990 /* Roman Numeral/Greek Letter */
991 return 25;
992 case 0xA6:
993 /* Box Drawings */
994 return 26;
995 case 0xA7:
996 /* Unit Symbols */
997 return 27;
998 case 0xA8:
999 case 0xA9:
1000 if (c2 <= 0xAF)
1001 return 25; /* Roman Letter */
1002 else if (c2 >= 0xF6)
1003 return 22; /* Symbols */
1004 else
1005 /* Circled/Parenthesized Letter */
1006 return 28;
1007 case 0xAA:
1008 case 0xAB:
1009 /* Hirigana/Katakana */
1010 return 29;
1011 case 0xAC:
1012 /* Cyrillic Letter */
1013 return 30;
1016 default:
1017 break;
1019 return 3;
1023 * mb_char2len() function pointer.
1024 * Return length in bytes of character "c".
1025 * Returns 1 for a single-byte character.
1028 latin_char2len(c)
1029 int c UNUSED;
1031 return 1;
1034 static int
1035 dbcs_char2len(c)
1036 int c;
1038 if (c >= 0x100)
1039 return 2;
1040 return 1;
1044 * mb_char2bytes() function pointer.
1045 * Convert a character to its bytes.
1046 * Returns the length in bytes.
1049 latin_char2bytes(c, buf)
1050 int c;
1051 char_u *buf;
1053 buf[0] = c;
1054 return 1;
1057 static int
1058 dbcs_char2bytes(c, buf)
1059 int c;
1060 char_u *buf;
1062 if (c >= 0x100)
1064 buf[0] = (unsigned)c >> 8;
1065 buf[1] = c;
1066 /* Never use a NUL byte, it causes lots of trouble. It's an invalid
1067 * character anyway. */
1068 if (buf[1] == NUL)
1069 buf[1] = '\n';
1070 return 2;
1072 buf[0] = c;
1073 return 1;
1077 * mb_ptr2len() function pointer.
1078 * Get byte length of character at "*p" but stop at a NUL.
1079 * For UTF-8 this includes following composing characters.
1080 * Returns 0 when *p is NUL.
1083 latin_ptr2len(p)
1084 char_u *p;
1086 return MB_BYTE2LEN(*p);
1089 static int
1090 dbcs_ptr2len(p)
1091 char_u *p;
1093 int len;
1095 /* Check if second byte is not missing. */
1096 len = MB_BYTE2LEN(*p);
1097 if (len == 2 && p[1] == NUL)
1098 len = 1;
1099 return len;
1103 * mb_ptr2len_len() function pointer.
1104 * Like mb_ptr2len(), but limit to read "size" bytes.
1105 * Returns 0 for an empty string.
1106 * Returns 1 for an illegal char or an incomplete byte sequence.
1109 latin_ptr2len_len(p, size)
1110 char_u *p;
1111 int size;
1113 if (size < 1 || *p == NUL)
1114 return 0;
1115 return 1;
1118 static int
1119 dbcs_ptr2len_len(p, size)
1120 char_u *p;
1121 int size;
1123 int len;
1125 if (size < 1 || *p == NUL)
1126 return 0;
1127 if (size == 1)
1128 return 1;
1129 /* Check that second byte is not missing. */
1130 len = MB_BYTE2LEN(*p);
1131 if (len == 2 && p[1] == NUL)
1132 len = 1;
1133 return len;
1136 struct interval
1138 unsigned short first;
1139 unsigned short last;
1141 static int intable __ARGS((struct interval *table, size_t size, int c));
1144 * Return TRUE if "c" is in "table[size / sizeof(struct interval)]".
1146 static int
1147 intable(table, size, c)
1148 struct interval *table;
1149 size_t size;
1150 int c;
1152 int mid, bot, top;
1154 /* first quick check for Latin1 etc. characters */
1155 if (c < table[0].first)
1156 return FALSE;
1158 /* binary search in table */
1159 bot = 0;
1160 top = (int)(size / sizeof(struct interval) - 1);
1161 while (top >= bot)
1163 mid = (bot + top) / 2;
1164 if (table[mid].last < c)
1165 bot = mid + 1;
1166 else if (table[mid].first > c)
1167 top = mid - 1;
1168 else
1169 return TRUE;
1171 return FALSE;
1175 * For UTF-8 character "c" return 2 for a double-width character, 1 for others.
1176 * Returns 4 or 6 for an unprintable character.
1177 * Is only correct for characters >= 0x80.
1178 * When p_ambw is "double", return 2 for a character with East Asian Width
1179 * class 'A'(mbiguous).
1182 utf_char2cells(c)
1183 int c;
1185 /* sorted list of non-overlapping intervals of East Asian Ambiguous
1186 * characters, generated with:
1187 * "uniset +WIDTH-A -cat=Me -cat=Mn -cat=Cf c" */
1188 static struct interval ambiguous[] = {
1189 {0x00A1, 0x00A1}, {0x00A4, 0x00A4}, {0x00A7, 0x00A8},
1190 {0x00AA, 0x00AA}, {0x00AE, 0x00AE}, {0x00B0, 0x00B4},
1191 {0x00B6, 0x00BA}, {0x00BC, 0x00BF}, {0x00C6, 0x00C6},
1192 {0x00D0, 0x00D0}, {0x00D7, 0x00D8}, {0x00DE, 0x00E1},
1193 {0x00E6, 0x00E6}, {0x00E8, 0x00EA}, {0x00EC, 0x00ED},
1194 {0x00F0, 0x00F0}, {0x00F2, 0x00F3}, {0x00F7, 0x00FA},
1195 {0x00FC, 0x00FC}, {0x00FE, 0x00FE}, {0x0101, 0x0101},
1196 {0x0111, 0x0111}, {0x0113, 0x0113}, {0x011B, 0x011B},
1197 {0x0126, 0x0127}, {0x012B, 0x012B}, {0x0131, 0x0133},
1198 {0x0138, 0x0138}, {0x013F, 0x0142}, {0x0144, 0x0144},
1199 {0x0148, 0x014B}, {0x014D, 0x014D}, {0x0152, 0x0153},
1200 {0x0166, 0x0167}, {0x016B, 0x016B}, {0x01CE, 0x01CE},
1201 {0x01D0, 0x01D0}, {0x01D2, 0x01D2}, {0x01D4, 0x01D4},
1202 {0x01D6, 0x01D6}, {0x01D8, 0x01D8}, {0x01DA, 0x01DA},
1203 {0x01DC, 0x01DC}, {0x0251, 0x0251}, {0x0261, 0x0261},
1204 {0x02C4, 0x02C4}, {0x02C7, 0x02C7}, {0x02C9, 0x02CB},
1205 {0x02CD, 0x02CD}, {0x02D0, 0x02D0}, {0x02D8, 0x02DB},
1206 {0x02DD, 0x02DD}, {0x02DF, 0x02DF}, {0x0391, 0x03A1},
1207 {0x03A3, 0x03A9}, {0x03B1, 0x03C1}, {0x03C3, 0x03C9},
1208 {0x0401, 0x0401}, {0x0410, 0x044F}, {0x0451, 0x0451},
1209 {0x2010, 0x2010}, {0x2013, 0x2016}, {0x2018, 0x2019},
1210 {0x201C, 0x201D}, {0x2020, 0x2022}, {0x2024, 0x2027},
1211 {0x2030, 0x2030}, {0x2032, 0x2033}, {0x2035, 0x2035},
1212 {0x203B, 0x203B}, {0x203E, 0x203E}, {0x2074, 0x2074},
1213 {0x207F, 0x207F}, {0x2081, 0x2084}, {0x20AC, 0x20AC},
1214 {0x2103, 0x2103}, {0x2105, 0x2105}, {0x2109, 0x2109},
1215 {0x2113, 0x2113}, {0x2116, 0x2116}, {0x2121, 0x2122},
1216 {0x2126, 0x2126}, {0x212B, 0x212B}, {0x2153, 0x2154},
1217 {0x215B, 0x215E}, {0x2160, 0x216B}, {0x2170, 0x2179},
1218 {0x2190, 0x2199}, {0x21B8, 0x21B9}, {0x21D2, 0x21D2},
1219 {0x21D4, 0x21D4}, {0x21E7, 0x21E7}, {0x2200, 0x2200},
1220 {0x2202, 0x2203}, {0x2207, 0x2208}, {0x220B, 0x220B},
1221 {0x220F, 0x220F}, {0x2211, 0x2211}, {0x2215, 0x2215},
1222 {0x221A, 0x221A}, {0x221D, 0x2220}, {0x2223, 0x2223},
1223 {0x2225, 0x2225}, {0x2227, 0x222C}, {0x222E, 0x222E},
1224 {0x2234, 0x2237}, {0x223C, 0x223D}, {0x2248, 0x2248},
1225 {0x224C, 0x224C}, {0x2252, 0x2252}, {0x2260, 0x2261},
1226 {0x2264, 0x2267}, {0x226A, 0x226B}, {0x226E, 0x226F},
1227 {0x2282, 0x2283}, {0x2286, 0x2287}, {0x2295, 0x2295},
1228 {0x2299, 0x2299}, {0x22A5, 0x22A5}, {0x22BF, 0x22BF},
1229 {0x2312, 0x2312}, {0x2460, 0x24E9}, {0x24EB, 0x254B},
1230 {0x2550, 0x2573}, {0x2580, 0x258F}, {0x2592, 0x2595},
1231 {0x25A0, 0x25A1}, {0x25A3, 0x25A9}, {0x25B2, 0x25B3},
1232 {0x25B6, 0x25B7}, {0x25BC, 0x25BD}, {0x25C0, 0x25C1},
1233 {0x25C6, 0x25C8}, {0x25CB, 0x25CB}, {0x25CE, 0x25D1},
1234 {0x25E2, 0x25E5}, {0x25EF, 0x25EF}, {0x2605, 0x2606},
1235 {0x2609, 0x2609}, {0x260E, 0x260F}, {0x2614, 0x2615},
1236 {0x261C, 0x261C}, {0x261E, 0x261E}, {0x2640, 0x2640},
1237 {0x2642, 0x2642}, {0x2660, 0x2661}, {0x2663, 0x2665},
1238 {0x2667, 0x266A}, {0x266C, 0x266D}, {0x266F, 0x266F},
1239 {0x273D, 0x273D}, {0x2776, 0x277F}, {0xE000, 0xF8FF},
1240 {0xFFFD, 0xFFFD}, /* {0xF0000, 0xFFFFD}, {0x100000, 0x10FFFD} */
1243 if (c >= 0x100)
1245 #ifdef USE_WCHAR_FUNCTIONS
1247 * Assume the library function wcwidth() works better than our own
1248 * stuff. It should return 1 for ambiguous width chars!
1250 int n = wcwidth(c);
1252 if (n < 0)
1253 return 6; /* unprintable, displays <xxxx> */
1254 if (n > 1)
1255 return n;
1256 #else
1257 if (!utf_printable(c))
1258 return 6; /* unprintable, displays <xxxx> */
1259 if (c >= 0x1100
1260 && (c <= 0x115f /* Hangul Jamo */
1261 || c == 0x2329
1262 || c == 0x232a
1263 || (c >= 0x2e80 && c <= 0xa4cf
1264 && c != 0x303f) /* CJK ... Yi */
1265 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
1266 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility
1267 Ideographs */
1268 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
1269 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
1270 || (c >= 0xffe0 && c <= 0xffe6)
1271 || (c >= 0x20000 && c <= 0x2fffd)
1272 || (c >= 0x30000 && c <= 0x3fffd)))
1273 return 2;
1274 #endif
1277 /* Characters below 0x100 are influenced by 'isprint' option */
1278 else if (c >= 0x80 && !vim_isprintc(c))
1279 return 4; /* unprintable, displays <xx> */
1281 if (c >= 0x80 && *p_ambw == 'd' && intable(ambiguous, sizeof(ambiguous), c))
1282 return 2;
1284 return 1;
1288 * mb_ptr2cells() function pointer.
1289 * Return the number of display cells character at "*p" occupies.
1290 * This doesn't take care of unprintable characters, use ptr2cells() for that.
1293 latin_ptr2cells(p)
1294 char_u *p UNUSED;
1296 return 1;
1300 utf_ptr2cells(p)
1301 char_u *p;
1303 int c;
1305 /* Need to convert to a wide character. */
1306 if (*p >= 0x80)
1308 c = utf_ptr2char(p);
1309 /* An illegal byte is displayed as <xx>. */
1310 if (utf_ptr2len(p) == 1 || c == NUL)
1311 return 4;
1312 /* If the char is ASCII it must be an overlong sequence. */
1313 if (c < 0x80)
1314 return char2cells(c);
1315 return utf_char2cells(c);
1317 return 1;
1321 dbcs_ptr2cells(p)
1322 char_u *p;
1324 /* Number of cells is equal to number of bytes, except for euc-jp when
1325 * the first byte is 0x8e. */
1326 if (enc_dbcs == DBCS_JPNU && *p == 0x8e)
1327 return 1;
1328 return MB_BYTE2LEN(*p);
1332 * mb_ptr2cells_len() function pointer.
1333 * Like mb_ptr2cells(), but limit string length to "size".
1334 * For an empty string or truncated character returns 1.
1337 latin_ptr2cells_len(p, size)
1338 char_u *p UNUSED;
1339 int size UNUSED;
1341 return 1;
1344 static int
1345 utf_ptr2cells_len(p, size)
1346 char_u *p;
1347 int size;
1349 int c;
1351 /* Need to convert to a wide character. */
1352 if (size > 0 && *p >= 0x80)
1354 if (utf_ptr2len_len(p, size) < utf8len_tab[*p])
1355 return 1;
1356 c = utf_ptr2char(p);
1357 /* An illegal byte is displayed as <xx>. */
1358 if (utf_ptr2len(p) == 1 || c == NUL)
1359 return 4;
1360 /* If the char is ASCII it must be an overlong sequence. */
1361 if (c < 0x80)
1362 return char2cells(c);
1363 return utf_char2cells(c);
1365 return 1;
1368 static int
1369 dbcs_ptr2cells_len(p, size)
1370 char_u *p;
1371 int size;
1373 /* Number of cells is equal to number of bytes, except for euc-jp when
1374 * the first byte is 0x8e. */
1375 if (size <= 1 || (enc_dbcs == DBCS_JPNU && *p == 0x8e))
1376 return 1;
1377 return MB_BYTE2LEN(*p);
1381 * mb_char2cells() function pointer.
1382 * Return the number of display cells character "c" occupies.
1383 * Only takes care of multi-byte chars, not "^C" and such.
1386 latin_char2cells(c)
1387 int c UNUSED;
1389 return 1;
1392 static int
1393 dbcs_char2cells(c)
1394 int c;
1396 /* Number of cells is equal to number of bytes, except for euc-jp when
1397 * the first byte is 0x8e. */
1398 if (enc_dbcs == DBCS_JPNU && ((unsigned)c >> 8) == 0x8e)
1399 return 1;
1400 /* use the first byte */
1401 return MB_BYTE2LEN((unsigned)c >> 8);
1405 * mb_off2cells() function pointer.
1406 * Return number of display cells for char at ScreenLines[off].
1407 * We make sure that the offset used is less than "max_off".
1410 latin_off2cells(off, max_off)
1411 unsigned off UNUSED;
1412 unsigned max_off UNUSED;
1414 return 1;
1418 dbcs_off2cells(off, max_off)
1419 unsigned off;
1420 unsigned max_off;
1422 /* never check beyond end of the line */
1423 if (off >= max_off)
1424 return 1;
1426 /* Number of cells is equal to number of bytes, except for euc-jp when
1427 * the first byte is 0x8e. */
1428 if (enc_dbcs == DBCS_JPNU && ScreenLines[off] == 0x8e)
1429 return 1;
1430 return MB_BYTE2LEN(ScreenLines[off]);
1434 utf_off2cells(off, max_off)
1435 unsigned off;
1436 unsigned max_off;
1438 return (off + 1 < max_off && ScreenLines[off + 1] == 0) ? 2 : 1;
1442 * mb_ptr2char() function pointer.
1443 * Convert a byte sequence into a character.
1446 latin_ptr2char(p)
1447 char_u *p;
1449 return *p;
1452 static int
1453 dbcs_ptr2char(p)
1454 char_u *p;
1456 if (MB_BYTE2LEN(*p) > 1 && p[1] != NUL)
1457 return (p[0] << 8) + p[1];
1458 return *p;
1462 * Convert a UTF-8 byte sequence to a wide character.
1463 * If the sequence is illegal or truncated by a NUL the first byte is
1464 * returned.
1465 * Does not include composing characters, of course.
1468 utf_ptr2char(p)
1469 char_u *p;
1471 int len;
1473 if (p[0] < 0x80) /* be quick for ASCII */
1474 return p[0];
1476 len = utf8len_tab[p[0]];
1477 if (len > 1 && (p[1] & 0xc0) == 0x80)
1479 if (len == 2)
1480 return ((p[0] & 0x1f) << 6) + (p[1] & 0x3f);
1481 if ((p[2] & 0xc0) == 0x80)
1483 if (len == 3)
1484 return ((p[0] & 0x0f) << 12) + ((p[1] & 0x3f) << 6)
1485 + (p[2] & 0x3f);
1486 if ((p[3] & 0xc0) == 0x80)
1488 if (len == 4)
1489 return ((p[0] & 0x07) << 18) + ((p[1] & 0x3f) << 12)
1490 + ((p[2] & 0x3f) << 6) + (p[3] & 0x3f);
1491 if ((p[4] & 0xc0) == 0x80)
1493 if (len == 5)
1494 return ((p[0] & 0x03) << 24) + ((p[1] & 0x3f) << 18)
1495 + ((p[2] & 0x3f) << 12) + ((p[3] & 0x3f) << 6)
1496 + (p[4] & 0x3f);
1497 if ((p[5] & 0xc0) == 0x80 && len == 6)
1498 return ((p[0] & 0x01) << 30) + ((p[1] & 0x3f) << 24)
1499 + ((p[2] & 0x3f) << 18) + ((p[3] & 0x3f) << 12)
1500 + ((p[4] & 0x3f) << 6) + (p[5] & 0x3f);
1505 /* Illegal value, just return the first byte */
1506 return p[0];
1510 * Get character at **pp and advance *pp to the next character.
1511 * Note: composing characters are skipped!
1514 mb_ptr2char_adv(pp)
1515 char_u **pp;
1517 int c;
1519 c = (*mb_ptr2char)(*pp);
1520 *pp += (*mb_ptr2len)(*pp);
1521 return c;
1525 * Get character at **pp and advance *pp to the next character.
1526 * Note: composing characters are returned as separate characters.
1529 mb_cptr2char_adv(pp)
1530 char_u **pp;
1532 int c;
1534 c = (*mb_ptr2char)(*pp);
1535 if (enc_utf8)
1536 *pp += utf_ptr2len(*pp);
1537 else
1538 *pp += (*mb_ptr2len)(*pp);
1539 return c;
1542 #if defined(FEAT_ARABIC) || defined(PROTO)
1544 * Check whether we are dealing with Arabic combining characters.
1545 * Note: these are NOT really composing characters!
1548 arabic_combine(one, two)
1549 int one; /* first character */
1550 int two; /* character just after "one" */
1552 if (one == a_LAM)
1553 return arabic_maycombine(two);
1554 return FALSE;
1558 * Check whether we are dealing with a character that could be regarded as an
1559 * Arabic combining character, need to check the character before this.
1562 arabic_maycombine(two)
1563 int two;
1565 if (p_arshape && !p_tbidi)
1566 return (two == a_ALEF_MADDA
1567 || two == a_ALEF_HAMZA_ABOVE
1568 || two == a_ALEF_HAMZA_BELOW
1569 || two == a_ALEF);
1570 return FALSE;
1574 * Check if the character pointed to by "p2" is a composing character when it
1575 * comes after "p1". For Arabic sometimes "ab" is replaced with "c", which
1576 * behaves like a composing character.
1579 utf_composinglike(p1, p2)
1580 char_u *p1;
1581 char_u *p2;
1583 int c2;
1585 c2 = utf_ptr2char(p2);
1586 if (utf_iscomposing(c2))
1587 return TRUE;
1588 if (!arabic_maycombine(c2))
1589 return FALSE;
1590 return arabic_combine(utf_ptr2char(p1), c2);
1592 #endif
1595 * Convert a UTF-8 byte string to a wide character. Also get up to MAX_MCO
1596 * composing characters.
1599 utfc_ptr2char(p, pcc)
1600 char_u *p;
1601 int *pcc; /* return: composing chars, last one is 0 */
1603 int len;
1604 int c;
1605 int cc;
1606 int i = 0;
1608 c = utf_ptr2char(p);
1609 len = utf_ptr2len(p);
1611 /* Only accept a composing char when the first char isn't illegal. */
1612 if ((len > 1 || *p < 0x80)
1613 && p[len] >= 0x80
1614 && UTF_COMPOSINGLIKE(p, p + len))
1616 cc = utf_ptr2char(p + len);
1617 for (;;)
1619 pcc[i++] = cc;
1620 if (i == MAX_MCO)
1621 break;
1622 len += utf_ptr2len(p + len);
1623 if (p[len] < 0x80 || !utf_iscomposing(cc = utf_ptr2char(p + len)))
1624 break;
1628 if (i < MAX_MCO) /* last composing char must be 0 */
1629 pcc[i] = 0;
1631 return c;
1635 * Convert a UTF-8 byte string to a wide character. Also get up to MAX_MCO
1636 * composing characters. Use no more than p[maxlen].
1639 utfc_ptr2char_len(p, pcc, maxlen)
1640 char_u *p;
1641 int *pcc; /* return: composing chars, last one is 0 */
1642 int maxlen;
1644 int len;
1645 int c;
1646 int cc;
1647 int i = 0;
1649 c = utf_ptr2char(p);
1650 len = utf_ptr2len_len(p, maxlen);
1651 /* Only accept a composing char when the first char isn't illegal. */
1652 if ((len > 1 || *p < 0x80)
1653 && len < maxlen
1654 && p[len] >= 0x80
1655 && UTF_COMPOSINGLIKE(p, p + len))
1657 cc = utf_ptr2char(p + len);
1658 for (;;)
1660 pcc[i++] = cc;
1661 if (i == MAX_MCO)
1662 break;
1663 len += utf_ptr2len_len(p + len, maxlen - len);
1664 if (len >= maxlen
1665 || p[len] < 0x80
1666 || !utf_iscomposing(cc = utf_ptr2char(p + len)))
1667 break;
1671 if (i < MAX_MCO) /* last composing char must be 0 */
1672 pcc[i] = 0;
1674 return c;
1678 * Convert the character at screen position "off" to a sequence of bytes.
1679 * Includes the composing characters.
1680 * "buf" must at least have the length MB_MAXBYTES.
1681 * Returns the produced number of bytes.
1684 utfc_char2bytes(off, buf)
1685 int off;
1686 char_u *buf;
1688 int len;
1689 int i;
1691 len = utf_char2bytes(ScreenLinesUC[off], buf);
1692 for (i = 0; i < Screen_mco; ++i)
1694 if (ScreenLinesC[i][off] == 0)
1695 break;
1696 len += utf_char2bytes(ScreenLinesC[i][off], buf + len);
1698 return len;
1702 * Get the length of a UTF-8 byte sequence, not including any following
1703 * composing characters.
1704 * Returns 0 for "".
1705 * Returns 1 for an illegal byte sequence.
1708 utf_ptr2len(p)
1709 char_u *p;
1711 int len;
1712 int i;
1714 if (*p == NUL)
1715 return 0;
1716 len = utf8len_tab[*p];
1717 for (i = 1; i < len; ++i)
1718 if ((p[i] & 0xc0) != 0x80)
1719 return 1;
1720 return len;
1724 * Return length of UTF-8 character, obtained from the first byte.
1725 * "b" must be between 0 and 255!
1728 utf_byte2len(b)
1729 int b;
1731 return utf8len_tab[b];
1735 * Get the length of UTF-8 byte sequence "p[size]". Does not include any
1736 * following composing characters.
1737 * Returns 1 for "".
1738 * Returns 1 for an illegal byte sequence (also in incomplete byte seq.).
1739 * Returns number > "size" for an incomplete byte sequence.
1742 utf_ptr2len_len(p, size)
1743 char_u *p;
1744 int size;
1746 int len;
1747 int i;
1748 int m;
1750 if (*p == NUL)
1751 return 1;
1752 m = len = utf8len_tab[*p];
1753 if (len > size)
1754 m = size; /* incomplete byte sequence. */
1755 for (i = 1; i < m; ++i)
1756 if ((p[i] & 0xc0) != 0x80)
1757 return 1;
1758 return len;
1762 * Return the number of bytes the UTF-8 encoding of the character at "p" takes.
1763 * This includes following composing characters.
1766 utfc_ptr2len(p)
1767 char_u *p;
1769 int len;
1770 int b0 = *p;
1771 #ifdef FEAT_ARABIC
1772 int prevlen;
1773 #endif
1775 if (b0 == NUL)
1776 return 0;
1777 if (b0 < 0x80 && p[1] < 0x80) /* be quick for ASCII */
1778 return 1;
1780 /* Skip over first UTF-8 char, stopping at a NUL byte. */
1781 len = utf_ptr2len(p);
1783 /* Check for illegal byte. */
1784 if (len == 1 && b0 >= 0x80)
1785 return 1;
1788 * Check for composing characters. We can handle only the first two, but
1789 * skip all of them (otherwise the cursor would get stuck).
1791 #ifdef FEAT_ARABIC
1792 prevlen = 0;
1793 #endif
1794 for (;;)
1796 if (p[len] < 0x80 || !UTF_COMPOSINGLIKE(p + prevlen, p + len))
1797 return len;
1799 /* Skip over composing char */
1800 #ifdef FEAT_ARABIC
1801 prevlen = len;
1802 #endif
1803 len += utf_ptr2len(p + len);
1808 * Return the number of bytes the UTF-8 encoding of the character at "p[size]"
1809 * takes. This includes following composing characters.
1810 * Returns 0 for an empty string.
1811 * Returns 1 for an illegal char or an incomplete byte sequence.
1814 utfc_ptr2len_len(p, size)
1815 char_u *p;
1816 int size;
1818 int len;
1819 #ifdef FEAT_ARABIC
1820 int prevlen;
1821 #endif
1823 if (size < 1 || *p == NUL)
1824 return 0;
1825 if (p[0] < 0x80 && (size == 1 || p[1] < 0x80)) /* be quick for ASCII */
1826 return 1;
1828 /* Skip over first UTF-8 char, stopping at a NUL byte. */
1829 len = utf_ptr2len_len(p, size);
1831 /* Check for illegal byte and incomplete byte sequence. */
1832 if ((len == 1 && p[0] >= 0x80) || len > size)
1833 return 1;
1836 * Check for composing characters. We can handle only the first two, but
1837 * skip all of them (otherwise the cursor would get stuck).
1839 #ifdef FEAT_ARABIC
1840 prevlen = 0;
1841 #endif
1842 while (len < size)
1844 int len_next_char;
1846 if (p[len] < 0x80)
1847 break;
1850 * Next character length should not go beyond size to ensure that
1851 * UTF_COMPOSINGLIKE(...) does not read beyond size.
1853 len_next_char = utf_ptr2len_len(p + len, size - len);
1854 if (len_next_char > size - len)
1855 break;
1857 if (!UTF_COMPOSINGLIKE(p + prevlen, p + len))
1858 break;
1860 /* Skip over composing char */
1861 #ifdef FEAT_ARABIC
1862 prevlen = len;
1863 #endif
1864 len += len_next_char;
1866 return len;
1870 * Return the number of bytes the UTF-8 encoding of character "c" takes.
1871 * This does not include composing characters.
1874 utf_char2len(c)
1875 int c;
1877 if (c < 0x80)
1878 return 1;
1879 if (c < 0x800)
1880 return 2;
1881 if (c < 0x10000)
1882 return 3;
1883 if (c < 0x200000)
1884 return 4;
1885 if (c < 0x4000000)
1886 return 5;
1887 return 6;
1891 * Convert Unicode character "c" to UTF-8 string in "buf[]".
1892 * Returns the number of bytes.
1893 * This does not include composing characters.
1896 utf_char2bytes(c, buf)
1897 int c;
1898 char_u *buf;
1900 if (c < 0x80) /* 7 bits */
1902 buf[0] = c;
1903 return 1;
1905 if (c < 0x800) /* 11 bits */
1907 buf[0] = 0xc0 + ((unsigned)c >> 6);
1908 buf[1] = 0x80 + (c & 0x3f);
1909 return 2;
1911 if (c < 0x10000) /* 16 bits */
1913 buf[0] = 0xe0 + ((unsigned)c >> 12);
1914 buf[1] = 0x80 + (((unsigned)c >> 6) & 0x3f);
1915 buf[2] = 0x80 + (c & 0x3f);
1916 return 3;
1918 if (c < 0x200000) /* 21 bits */
1920 buf[0] = 0xf0 + ((unsigned)c >> 18);
1921 buf[1] = 0x80 + (((unsigned)c >> 12) & 0x3f);
1922 buf[2] = 0x80 + (((unsigned)c >> 6) & 0x3f);
1923 buf[3] = 0x80 + (c & 0x3f);
1924 return 4;
1926 if (c < 0x4000000) /* 26 bits */
1928 buf[0] = 0xf8 + ((unsigned)c >> 24);
1929 buf[1] = 0x80 + (((unsigned)c >> 18) & 0x3f);
1930 buf[2] = 0x80 + (((unsigned)c >> 12) & 0x3f);
1931 buf[3] = 0x80 + (((unsigned)c >> 6) & 0x3f);
1932 buf[4] = 0x80 + (c & 0x3f);
1933 return 5;
1935 /* 31 bits */
1936 buf[0] = 0xfc + ((unsigned)c >> 30);
1937 buf[1] = 0x80 + (((unsigned)c >> 24) & 0x3f);
1938 buf[2] = 0x80 + (((unsigned)c >> 18) & 0x3f);
1939 buf[3] = 0x80 + (((unsigned)c >> 12) & 0x3f);
1940 buf[4] = 0x80 + (((unsigned)c >> 6) & 0x3f);
1941 buf[5] = 0x80 + (c & 0x3f);
1942 return 6;
1946 * Return TRUE if "c" is a composing UTF-8 character. This means it will be
1947 * drawn on top of the preceding character.
1948 * Based on code from Markus Kuhn.
1951 utf_iscomposing(c)
1952 int c;
1954 /* sorted list of non-overlapping intervals */
1955 static struct interval combining[] =
1957 {0x0300, 0x034f}, {0x0360, 0x036f}, {0x0483, 0x0486}, {0x0488, 0x0489},
1958 {0x0591, 0x05a1}, {0x05a3, 0x05b9}, {0x05bb, 0x05bd}, {0x05bf, 0x05bf},
1959 {0x05c1, 0x05c2}, {0x05c4, 0x05c4}, {0x0610, 0x0615}, {0x064b, 0x0658},
1960 {0x0670, 0x0670}, {0x06d6, 0x06dc}, {0x06de, 0x06e4}, {0x06e7, 0x06e8},
1961 {0x06ea, 0x06ed}, {0x0711, 0x0711}, {0x0730, 0x074a}, {0x07a6, 0x07b0},
1962 {0x0901, 0x0903}, {0x093c, 0x093c}, {0x093e, 0x094d}, {0x0951, 0x0954},
1963 {0x0962, 0x0963}, {0x0981, 0x0983}, {0x09bc, 0x09bc}, {0x09be, 0x09c4},
1964 {0x09c7, 0x09c8}, {0x09cb, 0x09cd}, {0x09d7, 0x09d7}, {0x09e2, 0x09e3},
1965 {0x0a01, 0x0a03}, {0x0a3c, 0x0a3c}, {0x0a3e, 0x0a42}, {0x0a47, 0x0a48},
1966 {0x0a4b, 0x0a4d}, {0x0a70, 0x0a71}, {0x0a81, 0x0a83}, {0x0abc, 0x0abc},
1967 {0x0abe, 0x0ac5}, {0x0ac7, 0x0ac9}, {0x0acb, 0x0acd}, {0x0ae2, 0x0ae3},
1968 {0x0b01, 0x0b03}, {0x0b3c, 0x0b3c}, {0x0b3e, 0x0b43}, {0x0b47, 0x0b48},
1969 {0x0b4b, 0x0b4d}, {0x0b56, 0x0b57}, {0x0b82, 0x0b82}, {0x0bbe, 0x0bc2},
1970 {0x0bc6, 0x0bc8}, {0x0bca, 0x0bcd}, {0x0bd7, 0x0bd7}, {0x0c01, 0x0c03},
1971 {0x0c3e, 0x0c44}, {0x0c46, 0x0c48}, {0x0c4a, 0x0c4d}, {0x0c55, 0x0c56},
1972 {0x0c82, 0x0c83}, {0x0cbc, 0x0cbc}, {0x0cbe, 0x0cc4}, {0x0cc6, 0x0cc8},
1973 {0x0cca, 0x0ccd}, {0x0cd5, 0x0cd6}, {0x0d02, 0x0d03}, {0x0d3e, 0x0d43},
1974 {0x0d46, 0x0d48}, {0x0d4a, 0x0d4d}, {0x0d57, 0x0d57}, {0x0d82, 0x0d83},
1975 {0x0dca, 0x0dca}, {0x0dcf, 0x0dd4}, {0x0dd6, 0x0dd6}, {0x0dd8, 0x0ddf},
1976 {0x0df2, 0x0df3}, {0x0e31, 0x0e31}, {0x0e34, 0x0e3a}, {0x0e47, 0x0e4e},
1977 {0x0eb1, 0x0eb1}, {0x0eb4, 0x0eb9}, {0x0ebb, 0x0ebc}, {0x0ec8, 0x0ecd},
1978 {0x0f18, 0x0f19}, {0x0f35, 0x0f35}, {0x0f37, 0x0f37}, {0x0f39, 0x0f39},
1979 {0x0f3e, 0x0f3f}, {0x0f71, 0x0f84}, {0x0f86, 0x0f87}, {0x0f90, 0x0f97},
1980 {0x0f99, 0x0fbc}, {0x0fc6, 0x0fc6}, {0x102c, 0x1032}, {0x1036, 0x1039},
1981 {0x1056, 0x1059}, {0x1712, 0x1714}, {0x1732, 0x1734}, {0x1752, 0x1753},
1982 {0x1772, 0x1773}, {0x17b6, 0x17d3}, {0x17dd, 0x17dd}, {0x180b, 0x180d},
1983 {0x18a9, 0x18a9}, {0x1920, 0x192b}, {0x1930, 0x193b}, {0x20d0, 0x20ea},
1984 {0x302a, 0x302f}, {0x3099, 0x309a}, {0xfb1e, 0xfb1e}, {0xfe00, 0xfe0f},
1985 {0xfe20, 0xfe23},
1988 return intable(combining, sizeof(combining), c);
1992 * Return TRUE for characters that can be displayed in a normal way.
1993 * Only for characters of 0x100 and above!
1996 utf_printable(c)
1997 int c;
1999 #ifdef USE_WCHAR_FUNCTIONS
2001 * Assume the iswprint() library function works better than our own stuff.
2003 return iswprint(c);
2004 #else
2005 /* Sorted list of non-overlapping intervals.
2006 * 0xd800-0xdfff is reserved for UTF-16, actually illegal. */
2007 static struct interval nonprint[] =
2009 {0x070f, 0x070f}, {0x180b, 0x180e}, {0x200b, 0x200f}, {0x202a, 0x202e},
2010 {0x206a, 0x206f}, {0xd800, 0xdfff}, {0xfeff, 0xfeff}, {0xfff9, 0xfffb},
2011 {0xfffe, 0xffff}
2014 return !intable(nonprint, sizeof(nonprint), c);
2015 #endif
2019 * Get class of a Unicode character.
2020 * 0: white space
2021 * 1: punctuation
2022 * 2 or bigger: some class of word character.
2025 utf_class(c)
2026 int c;
2028 /* sorted list of non-overlapping intervals */
2029 static struct clinterval
2031 unsigned short first;
2032 unsigned short last;
2033 unsigned short class;
2034 } classes[] =
2036 {0x037e, 0x037e, 1}, /* Greek question mark */
2037 {0x0387, 0x0387, 1}, /* Greek ano teleia */
2038 {0x055a, 0x055f, 1}, /* Armenian punctuation */
2039 {0x0589, 0x0589, 1}, /* Armenian full stop */
2040 {0x05be, 0x05be, 1},
2041 {0x05c0, 0x05c0, 1},
2042 {0x05c3, 0x05c3, 1},
2043 {0x05f3, 0x05f4, 1},
2044 {0x060c, 0x060c, 1},
2045 {0x061b, 0x061b, 1},
2046 {0x061f, 0x061f, 1},
2047 {0x066a, 0x066d, 1},
2048 {0x06d4, 0x06d4, 1},
2049 {0x0700, 0x070d, 1}, /* Syriac punctuation */
2050 {0x0964, 0x0965, 1},
2051 {0x0970, 0x0970, 1},
2052 {0x0df4, 0x0df4, 1},
2053 {0x0e4f, 0x0e4f, 1},
2054 {0x0e5a, 0x0e5b, 1},
2055 {0x0f04, 0x0f12, 1},
2056 {0x0f3a, 0x0f3d, 1},
2057 {0x0f85, 0x0f85, 1},
2058 {0x104a, 0x104f, 1}, /* Myanmar punctuation */
2059 {0x10fb, 0x10fb, 1}, /* Georgian punctuation */
2060 {0x1361, 0x1368, 1}, /* Ethiopic punctuation */
2061 {0x166d, 0x166e, 1}, /* Canadian Syl. punctuation */
2062 {0x1680, 0x1680, 0},
2063 {0x169b, 0x169c, 1},
2064 {0x16eb, 0x16ed, 1},
2065 {0x1735, 0x1736, 1},
2066 {0x17d4, 0x17dc, 1}, /* Khmer punctuation */
2067 {0x1800, 0x180a, 1}, /* Mongolian punctuation */
2068 {0x2000, 0x200b, 0}, /* spaces */
2069 {0x200c, 0x2027, 1}, /* punctuation and symbols */
2070 {0x2028, 0x2029, 0},
2071 {0x202a, 0x202e, 1}, /* punctuation and symbols */
2072 {0x202f, 0x202f, 0},
2073 {0x2030, 0x205e, 1}, /* punctuation and symbols */
2074 {0x205f, 0x205f, 0},
2075 {0x2060, 0x27ff, 1}, /* punctuation and symbols */
2076 {0x2070, 0x207f, 0x2070}, /* superscript */
2077 {0x2080, 0x2094, 0x2080}, /* subscript */
2078 {0x20a0, 0x27ff, 1}, /* all kinds of symbols */
2079 {0x2800, 0x28ff, 0x2800}, /* braille */
2080 {0x2900, 0x2998, 1}, /* arrows, brackets, etc. */
2081 {0x29d8, 0x29db, 1},
2082 {0x29fc, 0x29fd, 1},
2083 {0x3000, 0x3000, 0}, /* ideographic space */
2084 {0x3001, 0x3020, 1}, /* ideographic punctuation */
2085 {0x3030, 0x3030, 1},
2086 {0x303d, 0x303d, 1},
2087 {0x3040, 0x309f, 0x3040}, /* Hiragana */
2088 {0x30a0, 0x30ff, 0x30a0}, /* Katakana */
2089 {0x3300, 0x9fff, 0x4e00}, /* CJK Ideographs */
2090 {0xac00, 0xd7a3, 0xac00}, /* Hangul Syllables */
2091 {0xf900, 0xfaff, 0x4e00}, /* CJK Ideographs */
2092 {0xfd3e, 0xfd3f, 1},
2093 {0xfe30, 0xfe6b, 1}, /* punctuation forms */
2094 {0xff00, 0xff0f, 1}, /* half/fullwidth ASCII */
2095 {0xff1a, 0xff20, 1}, /* half/fullwidth ASCII */
2096 {0xff3b, 0xff40, 1}, /* half/fullwidth ASCII */
2097 {0xff5b, 0xff65, 1}, /* half/fullwidth ASCII */
2099 int bot = 0;
2100 int top = sizeof(classes) / sizeof(struct clinterval) - 1;
2101 int mid;
2103 /* First quick check for Latin1 characters, use 'iskeyword'. */
2104 if (c < 0x100)
2106 if (c == ' ' || c == '\t' || c == NUL || c == 0xa0)
2107 return 0; /* blank */
2108 if (vim_iswordc(c))
2109 return 2; /* word character */
2110 return 1; /* punctuation */
2113 /* binary search in table */
2114 while (top >= bot)
2116 mid = (bot + top) / 2;
2117 if (classes[mid].last < c)
2118 bot = mid + 1;
2119 else if (classes[mid].first > c)
2120 top = mid - 1;
2121 else
2122 return (int)classes[mid].class;
2125 /* most other characters are "word" characters */
2126 return 2;
2130 * Code for Unicode case-dependent operations. Based on notes in
2131 * http://www.unicode.org/Public/UNIDATA/CaseFolding.txt
2132 * This code uses simple case folding, not full case folding.
2136 * The following table is built by foldExtract.pl < CaseFolding.txt .
2137 * It must be in numeric order, because we use binary search on it.
2138 * An entry such as {0x41,0x5a,1,32} means that UCS-4 characters in the range
2139 * from 0x41 to 0x5a inclusive, stepping by 1, are folded by adding 32.
2142 typedef struct
2144 int rangeStart;
2145 int rangeEnd;
2146 int step;
2147 int offset;
2148 } convertStruct;
2150 static convertStruct foldCase[] =
2152 {0x41,0x5a,1,32}, {0xc0,0xd6,1,32}, {0xd8,0xde,1,32},
2153 {0x100,0x12e,2,1}, {0x130,0x130,-1,-199}, {0x132,0x136,2,1},
2154 {0x139,0x147,2,1}, {0x14a,0x176,2,1}, {0x178,0x178,-1,-121},
2155 {0x179,0x17d,2,1}, {0x181,0x181,-1,210}, {0x182,0x184,2,1},
2156 {0x186,0x186,-1,206}, {0x187,0x187,-1,1}, {0x189,0x18a,1,205},
2157 {0x18b,0x18b,-1,1}, {0x18e,0x18e,-1,79}, {0x18f,0x18f,-1,202},
2158 {0x190,0x190,-1,203}, {0x191,0x191,-1,1}, {0x193,0x193,-1,205},
2159 {0x194,0x194,-1,207}, {0x196,0x196,-1,211}, {0x197,0x197,-1,209},
2160 {0x198,0x198,-1,1}, {0x19c,0x19c,-1,211}, {0x19d,0x19d,-1,213},
2161 {0x19f,0x19f,-1,214}, {0x1a0,0x1a4,2,1}, {0x1a6,0x1a6,-1,218},
2162 {0x1a7,0x1a7,-1,1}, {0x1a9,0x1a9,-1,218}, {0x1ac,0x1ac,-1,1},
2163 {0x1ae,0x1ae,-1,218}, {0x1af,0x1af,-1,1}, {0x1b1,0x1b2,1,217},
2164 {0x1b3,0x1b5,2,1}, {0x1b7,0x1b7,-1,219}, {0x1b8,0x1bc,4,1},
2165 {0x1c4,0x1c4,-1,2}, {0x1c5,0x1c5,-1,1}, {0x1c7,0x1c7,-1,2},
2166 {0x1c8,0x1c8,-1,1}, {0x1ca,0x1ca,-1,2}, {0x1cb,0x1db,2,1},
2167 {0x1de,0x1ee,2,1}, {0x1f1,0x1f1,-1,2}, {0x1f2,0x1f4,2,1},
2168 {0x1f6,0x1f6,-1,-97}, {0x1f7,0x1f7,-1,-56}, {0x1f8,0x21e,2,1},
2169 {0x220,0x220,-1,-130}, {0x222,0x232,2,1}, {0x386,0x386,-1,38},
2170 {0x388,0x38a,1,37}, {0x38c,0x38c,-1,64}, {0x38e,0x38f,1,63},
2171 {0x391,0x3a1,1,32}, {0x3a3,0x3ab,1,32}, {0x3d8,0x3ee,2,1},
2172 {0x3f4,0x3f4,-1,-60}, {0x3f7,0x3f7,-1,1}, {0x3f9,0x3f9,-1,-7},
2173 {0x3fa,0x3fa,-1,1}, {0x400,0x40f,1,80}, {0x410,0x42f,1,32},
2174 {0x460,0x480,2,1}, {0x48a,0x4be,2,1}, {0x4c1,0x4cd,2,1},
2175 {0x4d0,0x4f4,2,1}, {0x4f8,0x500,8,1}, {0x502,0x50e,2,1},
2176 {0x531,0x556,1,48}, {0x1e00,0x1e94,2,1}, {0x1ea0,0x1ef8,2,1},
2177 {0x1f08,0x1f0f,1,-8}, {0x1f18,0x1f1d,1,-8}, {0x1f28,0x1f2f,1,-8},
2178 {0x1f38,0x1f3f,1,-8}, {0x1f48,0x1f4d,1,-8}, {0x1f59,0x1f5f,2,-8},
2179 {0x1f68,0x1f6f,1,-8}, {0x1f88,0x1f8f,1,-8}, {0x1f98,0x1f9f,1,-8},
2180 {0x1fa8,0x1faf,1,-8}, {0x1fb8,0x1fb9,1,-8}, {0x1fba,0x1fbb,1,-74},
2181 {0x1fbc,0x1fbc,-1,-9}, {0x1fc8,0x1fcb,1,-86}, {0x1fcc,0x1fcc,-1,-9},
2182 {0x1fd8,0x1fd9,1,-8}, {0x1fda,0x1fdb,1,-100}, {0x1fe8,0x1fe9,1,-8},
2183 {0x1fea,0x1feb,1,-112}, {0x1fec,0x1fec,-1,-7}, {0x1ff8,0x1ff9,1,-128},
2184 {0x1ffa,0x1ffb,1,-126}, {0x1ffc,0x1ffc,-1,-9}, {0x2126,0x2126,-1,-7517},
2185 {0x212a,0x212a,-1,-8383}, {0x212b,0x212b,-1,-8262},
2186 {0x2160,0x216f,1,16}, {0x24b6,0x24cf,1,26}, {0xff21,0xff3a,1,32},
2187 {0x10400,0x10427,1,40}
2190 static int utf_convert(int a, convertStruct table[], int tableSize);
2193 * Generic conversion function for case operations.
2194 * Return the converted equivalent of "a", which is a UCS-4 character. Use
2195 * the given conversion "table". Uses binary search on "table".
2197 static int
2198 utf_convert(a, table, tableSize)
2199 int a;
2200 convertStruct table[];
2201 int tableSize;
2203 int start, mid, end; /* indices into table */
2205 start = 0;
2206 end = tableSize / sizeof(convertStruct);
2207 while (start < end)
2209 /* need to search further */
2210 mid = (end + start) /2;
2211 if (table[mid].rangeEnd < a)
2212 start = mid + 1;
2213 else
2214 end = mid;
2216 if (table[start].rangeStart <= a && a <= table[start].rangeEnd
2217 && (a - table[start].rangeStart) % table[start].step == 0)
2218 return (a + table[start].offset);
2219 else
2220 return a;
2224 * Return the folded-case equivalent of "a", which is a UCS-4 character. Uses
2225 * simple case folding.
2228 utf_fold(a)
2229 int a;
2231 return utf_convert(a, foldCase, sizeof(foldCase));
2235 * The following tables are built by upperLowerExtract.pl < UnicodeData.txt .
2236 * They must be in numeric order, because we use binary search on them.
2237 * An entry such as {0x41,0x5a,1,32} means that UCS-4 characters in the range
2238 * from 0x41 to 0x5a inclusive, stepping by 1, are switched to lower (for
2239 * example) by adding 32.
2241 static convertStruct toLower[] =
2243 {0x41,0x5a,1,32}, {0xc0,0xd6,1,32}, {0xd8,0xde,1,32},
2244 {0x100,0x12e,2,1}, {0x130,0x130,-1,-199}, {0x132,0x136,2,1},
2245 {0x139,0x147,2,1}, {0x14a,0x176,2,1}, {0x178,0x178,-1,-121},
2246 {0x179,0x17d,2,1}, {0x181,0x181,-1,210}, {0x182,0x184,2,1},
2247 {0x186,0x186,-1,206}, {0x187,0x187,-1,1}, {0x189,0x18a,1,205},
2248 {0x18b,0x18b,-1,1}, {0x18e,0x18e,-1,79}, {0x18f,0x18f,-1,202},
2249 {0x190,0x190,-1,203}, {0x191,0x191,-1,1}, {0x193,0x193,-1,205},
2250 {0x194,0x194,-1,207}, {0x196,0x196,-1,211}, {0x197,0x197,-1,209},
2251 {0x198,0x198,-1,1}, {0x19c,0x19c,-1,211}, {0x19d,0x19d,-1,213},
2252 {0x19f,0x19f,-1,214}, {0x1a0,0x1a4,2,1}, {0x1a6,0x1a6,-1,218},
2253 {0x1a7,0x1a7,-1,1}, {0x1a9,0x1a9,-1,218}, {0x1ac,0x1ac,-1,1},
2254 {0x1ae,0x1ae,-1,218}, {0x1af,0x1af,-1,1}, {0x1b1,0x1b2,1,217},
2255 {0x1b3,0x1b5,2,1}, {0x1b7,0x1b7,-1,219}, {0x1b8,0x1bc,4,1},
2256 {0x1c4,0x1ca,3,2}, {0x1cd,0x1db,2,1}, {0x1de,0x1ee,2,1},
2257 {0x1f1,0x1f1,-1,2}, {0x1f4,0x1f4,-1,1}, {0x1f6,0x1f6,-1,-97},
2258 {0x1f7,0x1f7,-1,-56}, {0x1f8,0x21e,2,1}, {0x220,0x220,-1,-130},
2259 {0x222,0x232,2,1}, {0x386,0x386,-1,38}, {0x388,0x38a,1,37},
2260 {0x38c,0x38c,-1,64}, {0x38e,0x38f,1,63}, {0x391,0x3a1,1,32},
2261 {0x3a3,0x3ab,1,32}, {0x3d8,0x3ee,2,1}, {0x3f4,0x3f4,-1,-60},
2262 {0x3f7,0x3f7,-1,1}, {0x3f9,0x3f9,-1,-7}, {0x3fa,0x3fa,-1,1},
2263 {0x400,0x40f,1,80}, {0x410,0x42f,1,32}, {0x460,0x480,2,1},
2264 {0x48a,0x4be,2,1}, {0x4c1,0x4cd,2,1}, {0x4d0,0x4f4,2,1},
2265 {0x4f8,0x500,8,1}, {0x502,0x50e,2,1}, {0x531,0x556,1,48},
2266 {0x1e00,0x1e94,2,1}, {0x1ea0,0x1ef8,2,1}, {0x1f08,0x1f0f,1,-8},
2267 {0x1f18,0x1f1d,1,-8}, {0x1f28,0x1f2f,1,-8}, {0x1f38,0x1f3f,1,-8},
2268 {0x1f48,0x1f4d,1,-8}, {0x1f59,0x1f5f,2,-8}, {0x1f68,0x1f6f,1,-8},
2269 {0x1fb8,0x1fb9,1,-8}, {0x1fba,0x1fbb,1,-74}, {0x1fc8,0x1fcb,1,-86},
2270 {0x1fd8,0x1fd9,1,-8}, {0x1fda,0x1fdb,1,-100}, {0x1fe8,0x1fe9,1,-8},
2271 {0x1fea,0x1feb,1,-112}, {0x1fec,0x1fec,-1,-7}, {0x1ff8,0x1ff9,1,-128},
2272 {0x1ffa,0x1ffb,1,-126}, {0x2126,0x2126,-1,-7517}, {0x212a,0x212a,-1,-8383},
2273 {0x212b,0x212b,-1,-8262}, {0xff21,0xff3a,1,32}, {0x10400,0x10427,1,40}
2276 static convertStruct toUpper[] =
2278 {0x61,0x7a,1,-32}, {0xb5,0xb5,-1,743}, {0xe0,0xf6,1,-32},
2279 {0xf8,0xfe,1,-32}, {0xff,0xff,-1,121}, {0x101,0x12f,2,-1},
2280 {0x131,0x131,-1,-232}, {0x133,0x137,2,-1}, {0x13a,0x148,2,-1},
2281 {0x14b,0x177,2,-1}, {0x17a,0x17e,2,-1}, {0x17f,0x17f,-1,-300},
2282 {0x183,0x185,2,-1}, {0x188,0x18c,4,-1}, {0x192,0x192,-1,-1},
2283 {0x195,0x195,-1,97}, {0x199,0x199,-1,-1}, {0x19e,0x19e,-1,130},
2284 {0x1a1,0x1a5,2,-1}, {0x1a8,0x1ad,5,-1}, {0x1b0,0x1b4,4,-1},
2285 {0x1b6,0x1b9,3,-1}, {0x1bd,0x1bd,-1,-1}, {0x1bf,0x1bf,-1,56},
2286 {0x1c5,0x1c6,1,-1}, {0x1c8,0x1c9,1,-1}, {0x1cb,0x1cc,1,-1},
2287 {0x1ce,0x1dc,2,-1}, {0x1dd,0x1dd,-1,-79}, {0x1df,0x1ef,2,-1},
2288 {0x1f2,0x1f3,1,-1}, {0x1f5,0x1f9,4,-1}, {0x1fb,0x21f,2,-1},
2289 {0x223,0x233,2,-1}, {0x253,0x253,-1,-210}, {0x254,0x254,-1,-206},
2290 {0x256,0x257,1,-205}, {0x259,0x259,-1,-202}, {0x25b,0x25b,-1,-203},
2291 {0x260,0x260,-1,-205}, {0x263,0x263,-1,-207}, {0x268,0x268,-1,-209},
2292 {0x269,0x26f,6,-211}, {0x272,0x272,-1,-213}, {0x275,0x275,-1,-214},
2293 {0x280,0x283,3,-218}, {0x288,0x288,-1,-218}, {0x28a,0x28b,1,-217},
2294 {0x292,0x292,-1,-219}, {0x3ac,0x3ac,-1,-38}, {0x3ad,0x3af,1,-37},
2295 {0x3b1,0x3c1,1,-32}, {0x3c2,0x3c2,-1,-31}, {0x3c3,0x3cb,1,-32},
2296 {0x3cc,0x3cc,-1,-64}, {0x3cd,0x3ce,1,-63}, {0x3d0,0x3d0,-1,-62},
2297 {0x3d1,0x3d1,-1,-57}, {0x3d5,0x3d5,-1,-47}, {0x3d6,0x3d6,-1,-54},
2298 {0x3d9,0x3ef,2,-1}, {0x3f0,0x3f0,-1,-86}, {0x3f1,0x3f1,-1,-80},
2299 {0x3f2,0x3f2,-1,7}, {0x3f5,0x3f5,-1,-96}, {0x3f8,0x3fb,3,-1},
2300 {0x430,0x44f,1,-32}, {0x450,0x45f,1,-80}, {0x461,0x481,2,-1},
2301 {0x48b,0x4bf,2,-1}, {0x4c2,0x4ce,2,-1}, {0x4d1,0x4f5,2,-1},
2302 {0x4f9,0x501,8,-1}, {0x503,0x50f,2,-1}, {0x561,0x586,1,-48},
2303 {0x1e01,0x1e95,2,-1}, {0x1e9b,0x1e9b,-1,-59}, {0x1ea1,0x1ef9,2,-1},
2304 {0x1f00,0x1f07,1,8}, {0x1f10,0x1f15,1,8}, {0x1f20,0x1f27,1,8},
2305 {0x1f30,0x1f37,1,8}, {0x1f40,0x1f45,1,8}, {0x1f51,0x1f57,2,8},
2306 {0x1f60,0x1f67,1,8}, {0x1f70,0x1f71,1,74}, {0x1f72,0x1f75,1,86},
2307 {0x1f76,0x1f77,1,100}, {0x1f78,0x1f79,1,128}, {0x1f7a,0x1f7b,1,112},
2308 {0x1f7c,0x1f7d,1,126}, {0x1f80,0x1f87,1,8}, {0x1f90,0x1f97,1,8},
2309 {0x1fa0,0x1fa7,1,8}, {0x1fb0,0x1fb1,1,8}, {0x1fb3,0x1fb3,-1,9},
2310 {0x1fbe,0x1fbe,-1,-7205}, {0x1fc3,0x1fc3,-1,9}, {0x1fd0,0x1fd1,1,8},
2311 {0x1fe0,0x1fe1,1,8}, {0x1fe5,0x1fe5,-1,7}, {0x1ff3,0x1ff3,-1,9},
2312 {0xff41,0xff5a,1,-32}, {0x10428,0x1044f,1,-40}
2316 * Return the upper-case equivalent of "a", which is a UCS-4 character. Use
2317 * simple case folding.
2320 utf_toupper(a)
2321 int a;
2323 /* If 'casemap' contains "keepascii" use ASCII style toupper(). */
2324 if (a < 128 && (cmp_flags & CMP_KEEPASCII))
2325 return TOUPPER_ASC(a);
2327 #if defined(HAVE_TOWUPPER) && defined(__STDC_ISO_10646__)
2328 /* If towupper() is available and handles Unicode, use it. */
2329 if (!(cmp_flags & CMP_INTERNAL))
2330 return towupper(a);
2331 #endif
2333 /* For characters below 128 use locale sensitive toupper(). */
2334 if (a < 128)
2335 return TOUPPER_LOC(a);
2337 /* For any other characters use the above mapping table. */
2338 return utf_convert(a, toUpper, sizeof(toUpper));
2342 utf_islower(a)
2343 int a;
2345 return (utf_toupper(a) != a);
2349 * Return the lower-case equivalent of "a", which is a UCS-4 character. Use
2350 * simple case folding.
2353 utf_tolower(a)
2354 int a;
2356 /* If 'casemap' contains "keepascii" use ASCII style tolower(). */
2357 if (a < 128 && (cmp_flags & CMP_KEEPASCII))
2358 return TOLOWER_ASC(a);
2360 #if defined(HAVE_TOWLOWER) && defined(__STDC_ISO_10646__)
2361 /* If towlower() is available and handles Unicode, use it. */
2362 if (!(cmp_flags & CMP_INTERNAL))
2363 return towlower(a);
2364 #endif
2366 /* For characters below 128 use locale sensitive tolower(). */
2367 if (a < 128)
2368 return TOLOWER_LOC(a);
2370 /* For any other characters use the above mapping table. */
2371 return utf_convert(a, toLower, sizeof(toLower));
2375 utf_isupper(a)
2376 int a;
2378 return (utf_tolower(a) != a);
2382 * Version of strnicmp() that handles multi-byte characters.
2383 * Needed for Big5, Sjift-JIS and UTF-8 encoding. Other DBCS encodings can
2384 * probably use strnicmp(), because there are no ASCII characters in the
2385 * second byte.
2386 * Returns zero if s1 and s2 are equal (ignoring case), the difference between
2387 * two characters otherwise.
2390 mb_strnicmp(s1, s2, nn)
2391 char_u *s1, *s2;
2392 size_t nn;
2394 int i, j, l;
2395 int cdiff;
2396 int incomplete = FALSE;
2397 int n = (int)nn;
2399 for (i = 0; i < n; i += l)
2401 if (s1[i] == NUL && s2[i] == NUL) /* both strings end */
2402 return 0;
2403 if (enc_utf8)
2405 l = utf_byte2len(s1[i]);
2406 if (l > n - i)
2408 l = n - i; /* incomplete character */
2409 incomplete = TRUE;
2411 /* Check directly first, it's faster. */
2412 for (j = 0; j < l; ++j)
2414 if (s1[i + j] != s2[i + j])
2415 break;
2416 if (s1[i + j] == 0)
2417 /* Both stings have the same bytes but are incomplete or
2418 * have illegal bytes, accept them as equal. */
2419 l = j;
2421 if (j < l)
2423 /* If one of the two characters is incomplete return -1. */
2424 if (incomplete || i + utf_byte2len(s2[i]) > n)
2425 return -1;
2426 cdiff = utf_fold(utf_ptr2char(s1 + i))
2427 - utf_fold(utf_ptr2char(s2 + i));
2428 if (cdiff != 0)
2429 return cdiff;
2432 else
2434 l = (*mb_ptr2len)(s1 + i);
2435 if (l <= 1)
2437 /* Single byte: first check normally, then with ignore case. */
2438 if (s1[i] != s2[i])
2440 cdiff = MB_TOLOWER(s1[i]) - MB_TOLOWER(s2[i]);
2441 if (cdiff != 0)
2442 return cdiff;
2445 else
2447 /* For non-Unicode multi-byte don't ignore case. */
2448 if (l > n - i)
2449 l = n - i;
2450 cdiff = STRNCMP(s1 + i, s2 + i, l);
2451 if (cdiff != 0)
2452 return cdiff;
2456 return 0;
2460 * "g8": show bytes of the UTF-8 char under the cursor. Doesn't matter what
2461 * 'encoding' has been set to.
2463 void
2464 show_utf8()
2466 int len;
2467 int rlen = 0;
2468 char_u *line;
2469 int clen;
2470 int i;
2472 /* Get the byte length of the char under the cursor, including composing
2473 * characters. */
2474 line = ml_get_cursor();
2475 len = utfc_ptr2len(line);
2476 if (len == 0)
2478 MSG("NUL");
2479 return;
2482 clen = 0;
2483 for (i = 0; i < len; ++i)
2485 if (clen == 0)
2487 /* start of (composing) character, get its length */
2488 if (i > 0)
2490 STRCPY(IObuff + rlen, "+ ");
2491 rlen += 2;
2493 clen = utf_ptr2len(line + i);
2495 sprintf((char *)IObuff + rlen, "%02x ", line[i]);
2496 --clen;
2497 rlen += (int)STRLEN(IObuff + rlen);
2498 if (rlen > IOSIZE - 20)
2499 break;
2502 msg(IObuff);
2506 * mb_head_off() function pointer.
2507 * Return offset from "p" to the first byte of the character it points into.
2508 * Returns 0 when already at the first byte of a character.
2511 latin_head_off(base, p)
2512 char_u *base UNUSED;
2513 char_u *p UNUSED;
2515 return 0;
2519 dbcs_head_off(base, p)
2520 char_u *base;
2521 char_u *p;
2523 char_u *q;
2525 /* It can't be a trailing byte when not using DBCS, at the start of the
2526 * string or the previous byte can't start a double-byte. */
2527 if (p <= base || MB_BYTE2LEN(p[-1]) == 1)
2528 return 0;
2530 /* This is slow: need to start at the base and go forward until the
2531 * byte we are looking for. Return 1 when we went past it, 0 otherwise. */
2532 q = base;
2533 while (q < p)
2534 q += dbcs_ptr2len(q);
2535 return (q == p) ? 0 : 1;
2539 * Special version of dbcs_head_off() that works for ScreenLines[], where
2540 * single-width DBCS_JPNU characters are stored separately.
2543 dbcs_screen_head_off(base, p)
2544 char_u *base;
2545 char_u *p;
2547 char_u *q;
2549 /* It can't be a trailing byte when not using DBCS, at the start of the
2550 * string or the previous byte can't start a double-byte.
2551 * For euc-jp an 0x8e byte in the previous cell always means we have a
2552 * lead byte in the current cell. */
2553 if (p <= base
2554 || (enc_dbcs == DBCS_JPNU && p[-1] == 0x8e)
2555 || MB_BYTE2LEN(p[-1]) == 1)
2556 return 0;
2558 /* This is slow: need to start at the base and go forward until the
2559 * byte we are looking for. Return 1 when we went past it, 0 otherwise.
2560 * For DBCS_JPNU look out for 0x8e, which means the second byte is not
2561 * stored as the next byte. */
2562 q = base;
2563 while (q < p)
2565 if (enc_dbcs == DBCS_JPNU && *q == 0x8e)
2566 ++q;
2567 else
2568 q += dbcs_ptr2len(q);
2570 return (q == p) ? 0 : 1;
2574 utf_head_off(base, p)
2575 char_u *base;
2576 char_u *p;
2578 char_u *q;
2579 char_u *s;
2580 int c;
2581 #ifdef FEAT_ARABIC
2582 char_u *j;
2583 #endif
2585 if (*p < 0x80) /* be quick for ASCII */
2586 return 0;
2588 /* Skip backwards over trailing bytes: 10xx.xxxx
2589 * Skip backwards again if on a composing char. */
2590 for (q = p; ; --q)
2592 /* Move s to the last byte of this char. */
2593 for (s = q; (s[1] & 0xc0) == 0x80; ++s)
2595 /* Move q to the first byte of this char. */
2596 while (q > base && (*q & 0xc0) == 0x80)
2597 --q;
2598 /* Check for illegal sequence. Do allow an illegal byte after where we
2599 * started. */
2600 if (utf8len_tab[*q] != (int)(s - q + 1)
2601 && utf8len_tab[*q] != (int)(p - q + 1))
2602 return 0;
2604 if (q <= base)
2605 break;
2607 c = utf_ptr2char(q);
2608 if (utf_iscomposing(c))
2609 continue;
2611 #ifdef FEAT_ARABIC
2612 if (arabic_maycombine(c))
2614 /* Advance to get a sneak-peak at the next char */
2615 j = q;
2616 --j;
2617 /* Move j to the first byte of this char. */
2618 while (j > base && (*j & 0xc0) == 0x80)
2619 --j;
2620 if (arabic_combine(utf_ptr2char(j), c))
2621 continue;
2623 #endif
2624 break;
2627 return (int)(p - q);
2631 * Copy a character from "*fp" to "*tp" and advance the pointers.
2633 void
2634 mb_copy_char(fp, tp)
2635 char_u **fp;
2636 char_u **tp;
2638 int l = (*mb_ptr2len)(*fp);
2640 mch_memmove(*tp, *fp, (size_t)l);
2641 *tp += l;
2642 *fp += l;
2646 * Return the offset from "p" to the first byte of a character. When "p" is
2647 * at the start of a character 0 is returned, otherwise the offset to the next
2648 * character. Can start anywhere in a stream of bytes.
2651 mb_off_next(base, p)
2652 char_u *base;
2653 char_u *p;
2655 int i;
2656 int j;
2658 if (enc_utf8)
2660 if (*p < 0x80) /* be quick for ASCII */
2661 return 0;
2663 /* Find the next character that isn't 10xx.xxxx */
2664 for (i = 0; (p[i] & 0xc0) == 0x80; ++i)
2666 if (i > 0)
2668 /* Check for illegal sequence. */
2669 for (j = 0; p - j > base; ++j)
2670 if ((p[-j] & 0xc0) != 0x80)
2671 break;
2672 if (utf8len_tab[p[-j]] != i + j)
2673 return 0;
2675 return i;
2678 /* Only need to check if we're on a trail byte, it doesn't matter if we
2679 * want the offset to the next or current character. */
2680 return (*mb_head_off)(base, p);
2684 * Return the offset from "p" to the last byte of the character it points
2685 * into. Can start anywhere in a stream of bytes.
2688 mb_tail_off(base, p)
2689 char_u *base;
2690 char_u *p;
2692 int i;
2693 int j;
2695 if (*p == NUL)
2696 return 0;
2698 if (enc_utf8)
2700 /* Find the last character that is 10xx.xxxx */
2701 for (i = 0; (p[i + 1] & 0xc0) == 0x80; ++i)
2703 /* Check for illegal sequence. */
2704 for (j = 0; p - j > base; ++j)
2705 if ((p[-j] & 0xc0) != 0x80)
2706 break;
2707 if (utf8len_tab[p[-j]] != i + j + 1)
2708 return 0;
2709 return i;
2712 /* It can't be the first byte if a double-byte when not using DBCS, at the
2713 * end of the string or the byte can't start a double-byte. */
2714 if (enc_dbcs == 0 || p[1] == NUL || MB_BYTE2LEN(*p) == 1)
2715 return 0;
2717 /* Return 1 when on the lead byte, 0 when on the tail byte. */
2718 return 1 - dbcs_head_off(base, p);
2722 * Find the next illegal byte sequence.
2724 void
2725 utf_find_illegal()
2727 pos_T pos = curwin->w_cursor;
2728 char_u *p;
2729 int len;
2730 vimconv_T vimconv;
2731 char_u *tofree = NULL;
2733 vimconv.vc_type = CONV_NONE;
2734 if (enc_utf8 && (enc_canon_props(curbuf->b_p_fenc) & ENC_8BIT))
2736 /* 'encoding' is "utf-8" but we are editing a 8-bit encoded file,
2737 * possibly a utf-8 file with illegal bytes. Setup for conversion
2738 * from utf-8 to 'fileencoding'. */
2739 convert_setup(&vimconv, p_enc, curbuf->b_p_fenc);
2742 #ifdef FEAT_VIRTUALEDIT
2743 curwin->w_cursor.coladd = 0;
2744 #endif
2745 for (;;)
2747 p = ml_get_cursor();
2748 if (vimconv.vc_type != CONV_NONE)
2750 vim_free(tofree);
2751 tofree = string_convert(&vimconv, p, NULL);
2752 if (tofree == NULL)
2753 break;
2754 p = tofree;
2757 while (*p != NUL)
2759 /* Illegal means that there are not enough trail bytes (checked by
2760 * utf_ptr2len()) or too many of them (overlong sequence). */
2761 len = utf_ptr2len(p);
2762 if (*p >= 0x80 && (len == 1
2763 || utf_char2len(utf_ptr2char(p)) != len))
2765 if (vimconv.vc_type == CONV_NONE)
2766 curwin->w_cursor.col += (colnr_T)(p - ml_get_cursor());
2767 else
2769 int l;
2771 len = (int)(p - tofree);
2772 for (p = ml_get_cursor(); *p != NUL && len-- > 0; p += l)
2774 l = utf_ptr2len(p);
2775 curwin->w_cursor.col += l;
2778 goto theend;
2780 p += len;
2782 if (curwin->w_cursor.lnum == curbuf->b_ml.ml_line_count)
2783 break;
2784 ++curwin->w_cursor.lnum;
2785 curwin->w_cursor.col = 0;
2788 /* didn't find it: don't move and beep */
2789 curwin->w_cursor = pos;
2790 beep_flush();
2792 theend:
2793 vim_free(tofree);
2794 convert_setup(&vimconv, NULL, NULL);
2797 #if defined(HAVE_GTK2) || defined(PROTO)
2799 * Return TRUE if string "s" is a valid utf-8 string.
2800 * When "end" is NULL stop at the first NUL.
2801 * When "end" is positive stop there.
2804 utf_valid_string(s, end)
2805 char_u *s;
2806 char_u *end;
2808 int l;
2809 char_u *p = s;
2811 while (end == NULL ? *p != NUL : p < end)
2813 if ((*p & 0xc0) == 0x80)
2814 return FALSE; /* invalid lead byte */
2815 l = utf8len_tab[*p];
2816 if (end != NULL && p + l > end)
2817 return FALSE; /* incomplete byte sequence */
2818 ++p;
2819 while (--l > 0)
2820 if ((*p++ & 0xc0) != 0x80)
2821 return FALSE; /* invalid trail byte */
2823 return TRUE;
2825 #endif
2827 #if defined(FEAT_GUI) || defined(PROTO)
2829 * Special version of mb_tail_off() for use in ScreenLines[].
2832 dbcs_screen_tail_off(base, p)
2833 char_u *base;
2834 char_u *p;
2836 /* It can't be the first byte if a double-byte when not using DBCS, at the
2837 * end of the string or the byte can't start a double-byte.
2838 * For euc-jp an 0x8e byte always means we have a lead byte in the current
2839 * cell. */
2840 if (*p == NUL || p[1] == NUL
2841 || (enc_dbcs == DBCS_JPNU && *p == 0x8e)
2842 || MB_BYTE2LEN(*p) == 1)
2843 return 0;
2845 /* Return 1 when on the lead byte, 0 when on the tail byte. */
2846 return 1 - dbcs_screen_head_off(base, p);
2848 #endif
2851 * If the cursor moves on an trail byte, set the cursor on the lead byte.
2852 * Thus it moves left if necessary.
2853 * Return TRUE when the cursor was adjusted.
2855 void
2856 mb_adjust_cursor()
2858 mb_adjustpos(&curwin->w_cursor);
2862 * Adjust position "*lp" to point to the first byte of a multi-byte character.
2863 * If it points to a tail byte it's moved backwards to the head byte.
2865 void
2866 mb_adjustpos(lp)
2867 pos_T *lp;
2869 char_u *p;
2871 if (lp->col > 0
2872 #ifdef FEAT_VIRTUALEDIT
2873 || lp->coladd > 1
2874 #endif
2877 p = ml_get(lp->lnum);
2878 lp->col -= (*mb_head_off)(p, p + lp->col);
2879 #ifdef FEAT_VIRTUALEDIT
2880 /* Reset "coladd" when the cursor would be on the right half of a
2881 * double-wide character. */
2882 if (lp->coladd == 1
2883 && p[lp->col] != TAB
2884 && vim_isprintc((*mb_ptr2char)(p + lp->col))
2885 && ptr2cells(p + lp->col) > 1)
2886 lp->coladd = 0;
2887 #endif
2892 * Return a pointer to the character before "*p", if there is one.
2894 char_u *
2895 mb_prevptr(line, p)
2896 char_u *line; /* start of the string */
2897 char_u *p;
2899 if (p > line)
2900 mb_ptr_back(line, p);
2901 return p;
2905 * Return the character length of "str". Each multi-byte character (with
2906 * following composing characters) counts as one.
2909 mb_charlen(str)
2910 char_u *str;
2912 char_u *p = str;
2913 int count;
2915 if (p == NULL)
2916 return 0;
2918 for (count = 0; *p != NUL; count++)
2919 p += (*mb_ptr2len)(p);
2921 return count;
2924 #if defined(FEAT_SPELL) || defined(PROTO)
2926 * Like mb_charlen() but for a string with specified length.
2929 mb_charlen_len(str, len)
2930 char_u *str;
2931 int len;
2933 char_u *p = str;
2934 int count;
2936 for (count = 0; *p != NUL && p < str + len; count++)
2937 p += (*mb_ptr2len)(p);
2939 return count;
2941 #endif
2944 * Try to un-escape a multi-byte character.
2945 * Used for the "to" and "from" part of a mapping.
2946 * Return the un-escaped string if it is a multi-byte character, and advance
2947 * "pp" to just after the bytes that formed it.
2948 * Return NULL if no multi-byte char was found.
2950 char_u *
2951 mb_unescape(pp)
2952 char_u **pp;
2954 static char_u buf[MB_MAXBYTES + 1];
2955 int n, m = 0;
2956 char_u *str = *pp;
2958 /* Must translate K_SPECIAL KS_SPECIAL KE_FILLER to K_SPECIAL and CSI
2959 * KS_EXTRA KE_CSI to CSI. */
2960 for (n = 0; str[n] != NUL && m <= MB_MAXBYTES; ++n)
2962 if (str[n] == K_SPECIAL
2963 && str[n + 1] == KS_SPECIAL
2964 && str[n + 2] == KE_FILLER)
2966 buf[m++] = K_SPECIAL;
2967 n += 2;
2969 else if ((str[n] == K_SPECIAL
2970 # ifdef FEAT_GUI
2971 || str[n] == CSI
2972 # endif
2974 && str[n + 1] == KS_EXTRA
2975 && str[n + 2] == (int)KE_CSI)
2977 buf[m++] = CSI;
2978 n += 2;
2980 else if (str[n] == K_SPECIAL
2981 # ifdef FEAT_GUI
2982 || str[n] == CSI
2983 # endif
2985 break; /* a special key can't be a multibyte char */
2986 else
2987 buf[m++] = str[n];
2988 buf[m] = NUL;
2990 /* Return a multi-byte character if it's found. An illegal sequence
2991 * will result in a 1 here. */
2992 if ((*mb_ptr2len)(buf) > 1)
2994 *pp = str + n + 1;
2995 return buf;
2998 return NULL;
3002 * Return TRUE if the character at "row"/"col" on the screen is the left side
3003 * of a double-width character.
3004 * Caller must make sure "row" and "col" are not invalid!
3007 mb_lefthalve(row, col)
3008 int row;
3009 int col;
3011 #ifdef FEAT_HANGULIN
3012 if (composing_hangul)
3013 return TRUE;
3014 #endif
3015 return (*mb_off2cells)(LineOffset[row] + col,
3016 LineOffset[row] + screen_Columns) > 1;
3020 * Correct a position on the screen, if it's the right half of a double-wide
3021 * char move it to the left half. Returns the corrected column.
3024 mb_fix_col(col, row)
3025 int col;
3026 int row;
3028 col = check_col(col);
3029 row = check_row(row);
3030 if (has_mbyte && ScreenLines != NULL && col > 0
3031 && ((enc_dbcs
3032 && ScreenLines[LineOffset[row] + col] != NUL
3033 && dbcs_screen_head_off(ScreenLines + LineOffset[row],
3034 ScreenLines + LineOffset[row] + col))
3035 || (enc_utf8 && ScreenLines[LineOffset[row] + col] == 0)))
3036 return col - 1;
3037 return col;
3039 #endif
3041 #if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT) || defined(PROTO)
3042 static int enc_alias_search __ARGS((char_u *name));
3045 * Skip the Vim specific head of a 'encoding' name.
3047 char_u *
3048 enc_skip(p)
3049 char_u *p;
3051 if (STRNCMP(p, "2byte-", 6) == 0)
3052 return p + 6;
3053 if (STRNCMP(p, "8bit-", 5) == 0)
3054 return p + 5;
3055 return p;
3059 * Find the canonical name for encoding "enc".
3060 * When the name isn't recognized, returns "enc" itself, but with all lower
3061 * case characters and '_' replaced with '-'.
3062 * Returns an allocated string. NULL for out-of-memory.
3064 char_u *
3065 enc_canonize(enc)
3066 char_u *enc;
3068 char_u *r;
3069 char_u *p, *s;
3070 int i;
3072 # ifdef FEAT_MBYTE
3073 if (STRCMP(enc, "default") == 0)
3075 /* Use the default encoding as it's found by set_init_1(). */
3076 r = get_encoding_default();
3077 if (r == NULL)
3078 r = (char_u *)"latin1";
3079 return vim_strsave(r);
3081 # endif
3083 /* copy "enc" to allocated memory, with room for two '-' */
3084 r = alloc((unsigned)(STRLEN(enc) + 3));
3085 if (r != NULL)
3087 /* Make it all lower case and replace '_' with '-'. */
3088 p = r;
3089 for (s = enc; *s != NUL; ++s)
3091 if (*s == '_')
3092 *p++ = '-';
3093 else
3094 *p++ = TOLOWER_ASC(*s);
3096 *p = NUL;
3098 /* Skip "2byte-" and "8bit-". */
3099 p = enc_skip(r);
3101 /* Change "microsoft-cp" to "cp". Used in some spell files. */
3102 if (STRNCMP(p, "microsoft-cp", 12) == 0)
3103 STRMOVE(p, p + 10);
3105 /* "iso8859" -> "iso-8859" */
3106 if (STRNCMP(p, "iso8859", 7) == 0)
3108 STRMOVE(p + 4, p + 3);
3109 p[3] = '-';
3112 /* "iso-8859n" -> "iso-8859-n" */
3113 if (STRNCMP(p, "iso-8859", 8) == 0 && p[8] != '-')
3115 STRMOVE(p + 9, p + 8);
3116 p[8] = '-';
3119 /* "latin-N" -> "latinN" */
3120 if (STRNCMP(p, "latin-", 6) == 0)
3121 STRMOVE(p + 5, p + 6);
3123 if (enc_canon_search(p) >= 0)
3125 /* canonical name can be used unmodified */
3126 if (p != r)
3127 STRMOVE(r, p);
3129 else if ((i = enc_alias_search(p)) >= 0)
3131 /* alias recognized, get canonical name */
3132 vim_free(r);
3133 r = vim_strsave((char_u *)enc_canon_table[i].name);
3136 return r;
3140 * Search for an encoding alias of "name".
3141 * Returns -1 when not found.
3143 static int
3144 enc_alias_search(name)
3145 char_u *name;
3147 int i;
3149 for (i = 0; enc_alias_table[i].name != NULL; ++i)
3150 if (STRCMP(name, enc_alias_table[i].name) == 0)
3151 return enc_alias_table[i].canon;
3152 return -1;
3154 #endif
3156 #if defined(FEAT_MBYTE) || defined(PROTO)
3158 #ifdef HAVE_LANGINFO_H
3159 # include <langinfo.h>
3160 #endif
3163 * Get the canonicalized encoding of the current locale.
3164 * Returns an allocated string when successful, NULL when not.
3166 char_u *
3167 enc_locale()
3169 #ifndef WIN3264
3170 char *s;
3171 char *p;
3172 int i;
3173 #endif
3174 char buf[50];
3175 #ifdef WIN3264
3176 long acp = GetACP();
3178 if (acp == 1200)
3179 STRCPY(buf, "ucs-2le");
3180 else if (acp == 1252) /* cp1252 is used as latin1 */
3181 STRCPY(buf, "latin1");
3182 else
3183 sprintf(buf, "cp%ld", acp);
3184 #else
3185 # ifdef HAVE_NL_LANGINFO_CODESET
3186 if ((s = nl_langinfo(CODESET)) == NULL || *s == NUL)
3187 # endif
3188 # if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
3189 if ((s = setlocale(LC_CTYPE, NULL)) == NULL || *s == NUL)
3190 # endif
3191 if ((s = getenv("LC_ALL")) == NULL || *s == NUL)
3192 if ((s = getenv("LC_CTYPE")) == NULL || *s == NUL)
3193 s = getenv("LANG");
3195 if (s == NULL || *s == NUL)
3196 return FAIL;
3198 /* The most generic locale format is:
3199 * language[_territory][.codeset][@modifier][+special][,[sponsor][_revision]]
3200 * If there is a '.' remove the part before it.
3201 * if there is something after the codeset, remove it.
3202 * Make the name lowercase and replace '_' with '-'.
3203 * Exception: "ja_JP.EUC" == "euc-jp", "zh_CN.EUC" = "euc-cn",
3204 * "ko_KR.EUC" == "euc-kr"
3206 if ((p = (char *)vim_strchr((char_u *)s, '.')) != NULL)
3208 if (p > s + 2 && STRNICMP(p + 1, "EUC", 3) == 0
3209 && !isalnum((int)p[4]) && p[4] != '-' && p[-3] == '_')
3211 /* copy "XY.EUC" to "euc-XY" to buf[10] */
3212 STRCPY(buf + 10, "euc-");
3213 buf[14] = p[-2];
3214 buf[15] = p[-1];
3215 buf[16] = 0;
3216 s = buf + 10;
3218 else
3219 s = p + 1;
3221 for (i = 0; s[i] != NUL && i < (int)sizeof(buf) - 1; ++i)
3223 if (s[i] == '_' || s[i] == '-')
3224 buf[i] = '-';
3225 else if (isalnum((int)s[i]))
3226 buf[i] = TOLOWER_ASC(s[i]);
3227 else
3228 break;
3230 buf[i] = NUL;
3231 #endif
3233 return enc_canonize((char_u *)buf);
3236 #if defined(WIN3264) || defined(PROTO)
3238 * Convert an encoding name to an MS-Windows codepage.
3239 * Returns zero if no codepage can be figured out.
3242 encname2codepage(name)
3243 char_u *name;
3245 int cp;
3246 char_u *p = name;
3247 int idx;
3249 if (STRNCMP(p, "8bit-", 5) == 0)
3250 p += 5;
3251 else if (STRNCMP(p_enc, "2byte-", 6) == 0)
3252 p += 6;
3254 if (p[0] == 'c' && p[1] == 'p')
3255 cp = atoi(p + 2);
3256 else if ((idx = enc_canon_search(p)) >= 0)
3257 cp = enc_canon_table[idx].codepage;
3258 else
3259 return 0;
3260 if (IsValidCodePage(cp))
3261 return cp;
3262 return 0;
3264 #endif
3266 # if defined(USE_ICONV) || defined(PROTO)
3268 static char_u *iconv_string __ARGS((vimconv_T *vcp, char_u *str, int slen, int *unconvlenp, int *resultlenp));
3271 * Call iconv_open() with a check if iconv() works properly (there are broken
3272 * versions).
3273 * Returns (void *)-1 if failed.
3274 * (should return iconv_t, but that causes problems with prototypes).
3276 void *
3277 my_iconv_open(to, from)
3278 char_u *to;
3279 char_u *from;
3281 iconv_t fd;
3282 #define ICONV_TESTLEN 400
3283 char_u tobuf[ICONV_TESTLEN];
3284 char *p;
3285 size_t tolen;
3286 static int iconv_ok = -1;
3288 if (iconv_ok == FALSE)
3289 return (void *)-1; /* detected a broken iconv() previously */
3291 #ifdef DYNAMIC_ICONV
3292 /* Check if the iconv.dll can be found. */
3293 if (!iconv_enabled(TRUE))
3294 return (void *)-1;
3295 #endif
3297 fd = iconv_open((char *)enc_skip(to), (char *)enc_skip(from));
3299 if (fd != (iconv_t)-1 && iconv_ok == -1)
3302 * Do a dummy iconv() call to check if it actually works. There is a
3303 * version of iconv() on Linux that is broken. We can't ignore it,
3304 * because it's wide-spread. The symptoms are that after outputting
3305 * the initial shift state the "to" pointer is NULL and conversion
3306 * stops for no apparent reason after about 8160 characters.
3308 p = (char *)tobuf;
3309 tolen = ICONV_TESTLEN;
3310 (void)iconv(fd, NULL, NULL, &p, &tolen);
3311 if (p == NULL)
3313 iconv_ok = FALSE;
3314 iconv_close(fd);
3315 fd = (iconv_t)-1;
3317 else
3318 iconv_ok = TRUE;
3321 return (void *)fd;
3325 * Convert the string "str[slen]" with iconv().
3326 * If "unconvlenp" is not NULL handle the string ending in an incomplete
3327 * sequence and set "*unconvlenp" to the length of it.
3328 * Returns the converted string in allocated memory. NULL for an error.
3329 * If resultlenp is not NULL, sets it to the result length in bytes.
3331 static char_u *
3332 iconv_string(vcp, str, slen, unconvlenp, resultlenp)
3333 vimconv_T *vcp;
3334 char_u *str;
3335 int slen;
3336 int *unconvlenp;
3337 int *resultlenp;
3339 const char *from;
3340 size_t fromlen;
3341 char *to;
3342 size_t tolen;
3343 size_t len = 0;
3344 size_t done = 0;
3345 char_u *result = NULL;
3346 char_u *p;
3347 int l;
3349 from = (char *)str;
3350 fromlen = slen;
3351 for (;;)
3353 if (len == 0 || ICONV_ERRNO == ICONV_E2BIG)
3355 /* Allocate enough room for most conversions. When re-allocating
3356 * increase the buffer size. */
3357 len = len + fromlen * 2 + 40;
3358 p = alloc((unsigned)len);
3359 if (p != NULL && done > 0)
3360 mch_memmove(p, result, done);
3361 vim_free(result);
3362 result = p;
3363 if (result == NULL) /* out of memory */
3364 break;
3367 to = (char *)result + done;
3368 tolen = len - done - 2;
3369 /* Avoid a warning for systems with a wrong iconv() prototype by
3370 * casting the second argument to void *. */
3371 if (iconv(vcp->vc_fd, (void *)&from, &fromlen, &to, &tolen)
3372 != (size_t)-1)
3374 /* Finished, append a NUL. */
3375 *to = NUL;
3376 break;
3379 /* Check both ICONV_EINVAL and EINVAL, because the dynamically loaded
3380 * iconv library may use one of them. */
3381 if (!vcp->vc_fail && unconvlenp != NULL
3382 && (ICONV_ERRNO == ICONV_EINVAL || ICONV_ERRNO == EINVAL))
3384 /* Handle an incomplete sequence at the end. */
3385 *to = NUL;
3386 *unconvlenp = (int)fromlen;
3387 break;
3390 /* Check both ICONV_EILSEQ and EILSEQ, because the dynamically loaded
3391 * iconv library may use one of them. */
3392 else if (!vcp->vc_fail
3393 && (ICONV_ERRNO == ICONV_EILSEQ || ICONV_ERRNO == EILSEQ
3394 || ICONV_ERRNO == ICONV_EINVAL || ICONV_ERRNO == EINVAL))
3396 /* Can't convert: insert a '?' and skip a character. This assumes
3397 * conversion from 'encoding' to something else. In other
3398 * situations we don't know what to skip anyway. */
3399 *to++ = '?';
3400 if ((*mb_ptr2cells)((char_u *)from) > 1)
3401 *to++ = '?';
3402 if (enc_utf8)
3403 l = utfc_ptr2len_len((char_u *)from, (int)fromlen);
3404 else
3406 l = (*mb_ptr2len)((char_u *)from);
3407 if (l > (int)fromlen)
3408 l = (int)fromlen;
3410 from += l;
3411 fromlen -= l;
3413 else if (ICONV_ERRNO != ICONV_E2BIG)
3415 /* conversion failed */
3416 vim_free(result);
3417 result = NULL;
3418 break;
3420 /* Not enough room or skipping illegal sequence. */
3421 done = to - (char *)result;
3424 if (resultlenp != NULL)
3425 *resultlenp = (int)(to - (char *)result);
3426 return result;
3429 # if defined(DYNAMIC_ICONV) || defined(PROTO)
3431 * Dynamically load the "iconv.dll" on Win32.
3434 #ifndef DYNAMIC_ICONV /* just generating prototypes */
3435 # define HINSTANCE int
3436 #endif
3437 static HINSTANCE hIconvDLL = 0;
3438 static HINSTANCE hMsvcrtDLL = 0;
3440 # ifndef DYNAMIC_ICONV_DLL
3441 # define DYNAMIC_ICONV_DLL "iconv.dll"
3442 # define DYNAMIC_ICONV_DLL_ALT "libiconv.dll"
3443 # endif
3444 # ifndef DYNAMIC_MSVCRT_DLL
3445 # define DYNAMIC_MSVCRT_DLL "msvcrt.dll"
3446 # endif
3449 * Try opening the iconv.dll and return TRUE if iconv() can be used.
3452 iconv_enabled(verbose)
3453 int verbose;
3455 if (hIconvDLL != 0 && hMsvcrtDLL != 0)
3456 return TRUE;
3457 hIconvDLL = LoadLibrary(DYNAMIC_ICONV_DLL);
3458 if (hIconvDLL == 0) /* sometimes it's called libiconv.dll */
3459 hIconvDLL = LoadLibrary(DYNAMIC_ICONV_DLL_ALT);
3460 if (hIconvDLL != 0)
3461 hMsvcrtDLL = LoadLibrary(DYNAMIC_MSVCRT_DLL);
3462 if (hIconvDLL == 0 || hMsvcrtDLL == 0)
3464 /* Only give the message when 'verbose' is set, otherwise it might be
3465 * done whenever a conversion is attempted. */
3466 if (verbose && p_verbose > 0)
3468 verbose_enter();
3469 EMSG2(_(e_loadlib),
3470 hIconvDLL == 0 ? DYNAMIC_ICONV_DLL : DYNAMIC_MSVCRT_DLL);
3471 verbose_leave();
3473 iconv_end();
3474 return FALSE;
3477 iconv = (void *)GetProcAddress(hIconvDLL, "libiconv");
3478 iconv_open = (void *)GetProcAddress(hIconvDLL, "libiconv_open");
3479 iconv_close = (void *)GetProcAddress(hIconvDLL, "libiconv_close");
3480 iconvctl = (void *)GetProcAddress(hIconvDLL, "libiconvctl");
3481 iconv_errno = (void *)GetProcAddress(hMsvcrtDLL, "_errno");
3482 if (iconv == NULL || iconv_open == NULL || iconv_close == NULL
3483 || iconvctl == NULL || iconv_errno == NULL)
3485 iconv_end();
3486 if (verbose && p_verbose > 0)
3488 verbose_enter();
3489 EMSG2(_(e_loadfunc), "for libiconv");
3490 verbose_leave();
3492 return FALSE;
3494 return TRUE;
3497 void
3498 iconv_end()
3500 /* Don't use iconv() when inputting or outputting characters. */
3501 if (input_conv.vc_type == CONV_ICONV)
3502 convert_setup(&input_conv, NULL, NULL);
3503 if (output_conv.vc_type == CONV_ICONV)
3504 convert_setup(&output_conv, NULL, NULL);
3506 if (hIconvDLL != 0)
3507 FreeLibrary(hIconvDLL);
3508 if (hMsvcrtDLL != 0)
3509 FreeLibrary(hMsvcrtDLL);
3510 hIconvDLL = 0;
3511 hMsvcrtDLL = 0;
3513 # endif /* DYNAMIC_ICONV */
3514 # endif /* USE_ICONV */
3516 #endif /* FEAT_MBYTE */
3518 #if defined(FEAT_XIM) || defined(PROTO)
3520 # ifdef FEAT_GUI_MACVIM
3521 typedef int GtkIMContext;
3522 typedef int * gpointer;
3523 typedef char gchar;
3524 # define g_return_if_fail(x) if (!(x)) return;
3525 # endif
3527 # if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_MACVIM)
3528 static int xim_has_preediting INIT(= FALSE); /* IM current status */
3531 * Set preedit_start_col to the current cursor position.
3533 static void
3534 init_preedit_start_col(void)
3536 if (State & CMDLINE)
3537 preedit_start_col = cmdline_getvcol_cursor();
3538 else if (curwin != NULL)
3539 getvcol(curwin, &curwin->w_cursor, &preedit_start_col, NULL, NULL);
3540 /* Prevent that preediting marks the buffer as changed. */
3541 xim_changed_while_preediting = curbuf->b_changed;
3543 # endif
3545 # if (defined(HAVE_GTK2) || defined(FEAT_GUI_MACVIM)) && !defined(PROTO)
3547 static int im_is_active = FALSE; /* IM is enabled for current mode */
3548 static int preedit_is_active = FALSE;
3549 static int im_preedit_cursor = 0; /* cursor offset in characters */
3550 static int im_preedit_trailing = 0; /* number of characters after cursor */
3552 static unsigned long im_commit_handler_id = 0;
3553 # ifndef FEAT_GUI_MACVIM
3554 static unsigned int im_activatekey_keyval = GDK_VoidSymbol;
3555 static unsigned int im_activatekey_state = 0;
3556 # endif
3558 # ifndef FEAT_GUI_MACVIM
3559 void
3560 im_set_active(int active)
3562 int was_active;
3564 was_active = !!im_is_active;
3565 im_is_active = (active && !p_imdisable);
3567 if (im_is_active != was_active)
3568 xim_reset();
3570 # endif
3572 void
3573 xim_set_focus(int focus)
3575 # ifndef FEAT_GUI_MACVIM
3576 if (xic != NULL)
3578 if (focus)
3579 gtk_im_context_focus_in(xic);
3580 else
3581 gtk_im_context_focus_out(xic);
3583 # endif
3586 # ifndef FEAT_GUI_MACVIM
3587 void
3588 im_set_position(int row, int col)
3590 if (xic != NULL)
3592 GdkRectangle area;
3594 area.x = FILL_X(col);
3595 area.y = FILL_Y(row);
3596 area.width = gui.char_width * (mb_lefthalve(row, col) ? 2 : 1);
3597 area.height = gui.char_height;
3599 gtk_im_context_set_cursor_location(xic, &area);
3602 # endif
3604 # if 0 || defined(PROTO) /* apparently only used in gui_x11.c */
3605 void
3606 xim_set_preedit(void)
3608 im_set_position(gui.row, gui.col);
3610 # endif
3612 static void
3613 im_add_to_input(char_u *str, int len)
3615 /* Convert from 'termencoding' (always "utf-8") to 'encoding' */
3616 if (input_conv.vc_type != CONV_NONE)
3618 str = string_convert(&input_conv, str, &len);
3619 g_return_if_fail(str != NULL);
3622 add_to_input_buf_csi(str, len);
3624 if (input_conv.vc_type != CONV_NONE)
3625 vim_free(str);
3627 # ifndef FEAT_GUI_MACVIM
3628 if (p_mh) /* blank out the pointer if necessary */
3629 gui_mch_mousehide(TRUE);
3630 # endif
3633 static void
3634 im_delete_preedit(void)
3636 char_u bskey[] = {CSI, 'k', 'b'};
3637 char_u delkey[] = {CSI, 'k', 'D'};
3639 if (State & NORMAL)
3641 im_preedit_cursor = 0;
3642 return;
3644 for (; im_preedit_cursor > 0; --im_preedit_cursor)
3645 add_to_input_buf(bskey, (int)sizeof(bskey));
3647 for (; im_preedit_trailing > 0; --im_preedit_trailing)
3648 add_to_input_buf(delkey, (int)sizeof(delkey));
3652 * Move the cursor left by "num_move_back" characters.
3653 * Note that ins_left() checks im_is_preediting() to avoid breaking undo for
3654 * these K_LEFT keys.
3656 static void
3657 im_correct_cursor(int num_move_back)
3659 char_u backkey[] = {CSI, 'k', 'l'};
3661 if (State & NORMAL)
3662 return;
3663 # ifdef FEAT_RIGHTLEFT
3664 if ((State & CMDLINE) == 0 && curwin != NULL && curwin->w_p_rl)
3665 backkey[2] = 'r';
3666 # endif
3667 for (; num_move_back > 0; --num_move_back)
3668 add_to_input_buf(backkey, (int)sizeof(backkey));
3671 # ifndef FEAT_GUI_MACVIM
3672 static int xim_expected_char = NUL;
3673 static int xim_ignored_char = FALSE;
3674 # endif
3677 * Update the mode and cursor while in an IM callback.
3679 static void
3680 im_show_info(void)
3682 int old_vgetc_busy;
3684 old_vgetc_busy = vgetc_busy;
3685 vgetc_busy = TRUE;
3686 showmode();
3687 vgetc_busy = old_vgetc_busy;
3688 setcursor();
3689 out_flush();
3692 # ifndef FEAT_GUI_MACVIM
3694 * Callback invoked when the user finished preediting.
3695 * Put the final string into the input buffer.
3697 static void
3698 im_commit_cb(GtkIMContext *context UNUSED,
3699 const gchar *str,
3700 gpointer data UNUSED)
3702 int slen = (int)STRLEN(str);
3703 int add_to_input = TRUE;
3704 int clen;
3705 int len = slen;
3706 int commit_with_preedit = TRUE;
3707 char_u *im_str, *p;
3709 #ifdef XIM_DEBUG
3710 xim_log("im_commit_cb(): %s\n", str);
3711 #endif
3713 /* The imhangul module doesn't reset the preedit string before
3714 * committing. Call im_delete_preedit() to work around that. */
3715 im_delete_preedit();
3717 /* Indicate that preediting has finished. */
3718 if (preedit_start_col == MAXCOL)
3720 init_preedit_start_col();
3721 commit_with_preedit = FALSE;
3724 /* The thing which setting "preedit_start_col" to MAXCOL means that
3725 * "preedit_start_col" will be set forcely when calling
3726 * preedit_changed_cb() next time.
3727 * "preedit_start_col" should not reset with MAXCOL on this part. Vim
3728 * is simulating the preediting by using add_to_input_str(). when
3729 * preedit begin immediately before committed, the typebuf is not
3730 * flushed to screen, then it can't get correct "preedit_start_col".
3731 * Thus, it should calculate the cells by adding cells of the committed
3732 * string. */
3733 if (input_conv.vc_type != CONV_NONE)
3735 im_str = string_convert(&input_conv, (char_u *)str, &len);
3736 g_return_if_fail(im_str != NULL);
3738 else
3739 im_str = (char_u *)str;
3740 clen = 0;
3741 for (p = im_str; p < im_str + len; p += (*mb_ptr2len)(p))
3742 clen += (*mb_ptr2cells)(p);
3743 if (input_conv.vc_type != CONV_NONE)
3744 vim_free(im_str);
3745 preedit_start_col += clen;
3747 /* Is this a single character that matches a keypad key that's just
3748 * been pressed? If so, we don't want it to be entered as such - let
3749 * us carry on processing the raw keycode so that it may be used in
3750 * mappings as <kSomething>. */
3751 if (xim_expected_char != NUL)
3753 /* We're currently processing a keypad or other special key */
3754 if (slen == 1 && str[0] == xim_expected_char)
3756 /* It's a match - don't do it here */
3757 xim_ignored_char = TRUE;
3758 add_to_input = FALSE;
3760 else
3762 /* Not a match */
3763 xim_ignored_char = FALSE;
3767 if (add_to_input)
3768 im_add_to_input((char_u *)str, slen);
3770 /* Inserting chars while "im_is_active" is set does not cause a change of
3771 * buffer. When the chars are committed the buffer must be marked as
3772 * changed. */
3773 if (!commit_with_preedit)
3774 preedit_start_col = MAXCOL;
3776 /* This flag is used in changed() at next call. */
3777 xim_changed_while_preediting = TRUE;
3779 if (gtk_main_level() > 0)
3780 gtk_main_quit();
3782 # endif
3785 * Callback invoked after start to the preedit.
3787 # ifndef FEAT_GUI_MACVIM
3788 static void
3789 im_preedit_start_cb(GtkIMContext *context UNUSED, gpointer data UNUSED)
3790 # else
3791 void
3792 im_preedit_start_macvim()
3793 # endif
3795 #ifdef XIM_DEBUG
3796 xim_log("im_preedit_start_cb()\n");
3797 #endif
3799 im_is_active = TRUE;
3800 preedit_is_active = TRUE;
3801 gui_update_cursor(TRUE, FALSE);
3802 im_show_info();
3806 * Callback invoked after end to the preedit.
3808 # ifndef FEAT_GUI_MACVIM
3809 static void
3810 im_preedit_end_cb(GtkIMContext *context UNUSED, gpointer data UNUSED)
3811 # else
3812 void
3813 im_preedit_end_macvim()
3814 # endif
3816 #ifdef XIM_DEBUG
3817 xim_log("im_preedit_end_cb()\n");
3818 #endif
3819 im_delete_preedit();
3821 /* Indicate that preediting has finished */
3822 preedit_start_col = MAXCOL;
3823 xim_has_preediting = FALSE;
3825 #if 0
3826 /* Removal of this line suggested by Takuhiro Nishioka. Fixes that IM was
3827 * switched off unintentionally. We now use preedit_is_active (added by
3828 * SungHyun Nam). */
3829 im_is_active = FALSE;
3830 #endif
3831 preedit_is_active = FALSE;
3832 gui_update_cursor(TRUE, FALSE);
3833 im_show_info();
3837 * Callback invoked after changes to the preedit string. If the preedit
3838 * string was empty before, remember the preedit start column so we know
3839 * where to apply feedback attributes. Delete the previous preedit string
3840 * if there was one, save the new preedit cursor offset, and put the new
3841 * string into the input buffer.
3843 * TODO: The pragmatic "put into input buffer" approach used here has
3844 * several fundamental problems:
3846 * - The characters in the preedit string are subject to remapping.
3847 * That's broken, only the finally committed string should be remapped.
3849 * - There is a race condition involved: The retrieved value for the
3850 * current cursor position will be wrong if any unprocessed characters
3851 * are still queued in the input buffer.
3853 * - Due to the lack of synchronization between the file buffer in memory
3854 * and any typed characters, it's practically impossible to implement the
3855 * "retrieve_surrounding" and "delete_surrounding" signals reliably. IM
3856 * modules for languages such as Thai are likely to rely on this feature
3857 * for proper operation.
3859 * Conclusions: I think support for preediting needs to be moved to the
3860 * core parts of Vim. Ideally, until it has been committed, the preediting
3861 * string should only be displayed and not affect the buffer content at all.
3862 * The question how to deal with the synchronization issue still remains.
3863 * Circumventing the input buffer is probably not desirable. Anyway, I think
3864 * implementing "retrieve_surrounding" is the only hard problem.
3866 * One way to solve all of this in a clean manner would be to queue all key
3867 * press/release events "as is" in the input buffer, and apply the IM filtering
3868 * at the receiving end of the queue. This, however, would have a rather large
3869 * impact on the code base. If there is an easy way to force processing of all
3870 * remaining input from within the "retrieve_surrounding" signal handler, this
3871 * might not be necessary. Gotta ask on vim-dev for opinions.
3873 # ifndef FEAT_GUI_MACVIM
3874 static void
3875 im_preedit_changed_cb(GtkIMContext *context, gpointer data UNUSED)
3876 # else
3877 void
3878 im_preedit_changed_macvim(char *preedit_string, int cursor_index)
3879 # endif
3881 # ifndef FEAT_GUI_MACVIM
3882 char *preedit_string = NULL;
3883 int cursor_index = 0;
3884 # endif
3885 int num_move_back = 0;
3886 char_u *str;
3887 char_u *p;
3888 int i;
3890 # ifndef FEAT_GUI_MACVIM
3891 gtk_im_context_get_preedit_string(context,
3892 &preedit_string, NULL,
3893 &cursor_index);
3894 # endif
3896 #ifdef XIM_DEBUG
3897 xim_log("im_preedit_changed_cb(): %s\n", preedit_string);
3898 #endif
3900 g_return_if_fail(preedit_string != NULL); /* just in case */
3902 /* If preedit_start_col is MAXCOL set it to the current cursor position. */
3903 if (preedit_start_col == MAXCOL && preedit_string[0] != '\0')
3905 xim_has_preediting = TRUE;
3907 /* Urgh, this breaks if the input buffer isn't empty now */
3908 init_preedit_start_col();
3910 else if (cursor_index == 0 && preedit_string[0] == '\0')
3912 xim_has_preediting = FALSE;
3914 /* If at the start position (after typing backspace)
3915 * preedit_start_col must be reset. */
3916 preedit_start_col = MAXCOL;
3919 im_delete_preedit();
3922 * Compute the end of the preediting area: "preedit_end_col".
3923 * According to the documentation of gtk_im_context_get_preedit_string(),
3924 * the cursor_pos output argument returns the offset in bytes. This is
3925 * unfortunately not true -- real life shows the offset is in characters,
3926 * and the GTK+ source code agrees with me. Will file a bug later.
3928 if (preedit_start_col != MAXCOL)
3929 preedit_end_col = preedit_start_col;
3930 str = (char_u *)preedit_string;
3931 for (p = str, i = 0; *p != NUL; p += utf_byte2len(*p), ++i)
3933 int is_composing;
3935 is_composing = ((*p & 0x80) != 0 && utf_iscomposing(utf_ptr2char(p)));
3937 * These offsets are used as counters when generating <BS> and <Del>
3938 * to delete the preedit string. So don't count composing characters
3939 * unless 'delcombine' is enabled.
3941 if (!is_composing || p_deco)
3943 if (i < cursor_index)
3944 ++im_preedit_cursor;
3945 else
3946 ++im_preedit_trailing;
3948 if (!is_composing && i >= cursor_index)
3950 /* This is essentially the same as im_preedit_trailing, except
3951 * composing characters are not counted even if p_deco is set. */
3952 ++num_move_back;
3954 if (preedit_start_col != MAXCOL)
3955 preedit_end_col += utf_ptr2cells(p);
3958 if (p > str)
3960 im_add_to_input(str, (int)(p - str));
3961 im_correct_cursor(num_move_back);
3964 # ifndef FEAT_GUI_MACVIM
3965 g_free(preedit_string);
3967 if (gtk_main_level() > 0)
3968 gtk_main_quit();
3969 # endif
3972 # ifndef FEAT_GUI_MACVIM
3974 * Translate the Pango attributes at iter to Vim highlighting attributes.
3975 * Ignore attributes not supported by Vim highlighting. This shouldn't have
3976 * too much impact -- right now we handle even more attributes than necessary
3977 * for the IM modules I tested with.
3979 static int
3980 translate_pango_attributes(PangoAttrIterator *iter)
3982 PangoAttribute *attr;
3983 int char_attr = HL_NORMAL;
3985 attr = pango_attr_iterator_get(iter, PANGO_ATTR_UNDERLINE);
3986 if (attr != NULL && ((PangoAttrInt *)attr)->value
3987 != (int)PANGO_UNDERLINE_NONE)
3988 char_attr |= HL_UNDERLINE;
3990 attr = pango_attr_iterator_get(iter, PANGO_ATTR_WEIGHT);
3991 if (attr != NULL && ((PangoAttrInt *)attr)->value >= (int)PANGO_WEIGHT_BOLD)
3992 char_attr |= HL_BOLD;
3994 attr = pango_attr_iterator_get(iter, PANGO_ATTR_STYLE);
3995 if (attr != NULL && ((PangoAttrInt *)attr)->value
3996 != (int)PANGO_STYLE_NORMAL)
3997 char_attr |= HL_ITALIC;
3999 attr = pango_attr_iterator_get(iter, PANGO_ATTR_BACKGROUND);
4000 if (attr != NULL)
4002 const PangoColor *color = &((PangoAttrColor *)attr)->color;
4004 /* Assume inverse if black background is requested */
4005 if ((color->red | color->green | color->blue) == 0)
4006 char_attr |= HL_INVERSE;
4009 return char_attr;
4011 # endif
4014 * Retrieve the highlighting attributes at column col in the preedit string.
4015 * Return -1 if not in preediting mode or if col is out of range.
4018 im_get_feedback_attr(int col)
4020 # ifndef FEAT_GUI_MACVIM
4021 char *preedit_string = NULL;
4022 PangoAttrList *attr_list = NULL;
4023 int char_attr = -1;
4025 if (xic == NULL)
4026 return char_attr;
4028 gtk_im_context_get_preedit_string(xic, &preedit_string, &attr_list, NULL);
4030 if (preedit_string != NULL && attr_list != NULL)
4032 int idx;
4034 /* Get the byte index as used by PangoAttrIterator */
4035 for (idx = 0; col > 0 && preedit_string[idx] != '\0'; --col)
4036 idx += utfc_ptr2len((char_u *)preedit_string + idx);
4038 if (preedit_string[idx] != '\0')
4040 PangoAttrIterator *iter;
4041 int start, end;
4043 char_attr = HL_NORMAL;
4044 iter = pango_attr_list_get_iterator(attr_list);
4046 /* Extract all relevant attributes from the list. */
4049 pango_attr_iterator_range(iter, &start, &end);
4051 if (idx >= start && idx < end)
4052 char_attr |= translate_pango_attributes(iter);
4054 while (pango_attr_iterator_next(iter));
4056 pango_attr_iterator_destroy(iter);
4060 if (attr_list != NULL)
4061 pango_attr_list_unref(attr_list);
4062 g_free(preedit_string);
4064 return char_attr;
4065 # else
4066 return HL_UNDERLINE;
4067 # endif
4070 void
4071 xim_init(void)
4073 #ifdef XIM_DEBUG
4074 xim_log("xim_init()\n");
4075 #endif
4077 # ifndef FEAT_GUI_MACVIM
4078 g_return_if_fail(gui.drawarea != NULL);
4079 g_return_if_fail(gui.drawarea->window != NULL);
4081 xic = gtk_im_multicontext_new();
4082 g_object_ref(xic);
4084 im_commit_handler_id = g_signal_connect(G_OBJECT(xic), "commit",
4085 G_CALLBACK(&im_commit_cb), NULL);
4086 g_signal_connect(G_OBJECT(xic), "preedit_changed",
4087 G_CALLBACK(&im_preedit_changed_cb), NULL);
4088 g_signal_connect(G_OBJECT(xic), "preedit_start",
4089 G_CALLBACK(&im_preedit_start_cb), NULL);
4090 g_signal_connect(G_OBJECT(xic), "preedit_end",
4091 G_CALLBACK(&im_preedit_end_cb), NULL);
4093 gtk_im_context_set_client_window(xic, gui.drawarea->window);
4094 # endif
4097 void
4098 im_shutdown(void)
4100 #ifdef XIM_DEBUG
4101 xim_log("im_shutdown()\n");
4102 #endif
4104 # ifndef FEAT_GUI_MACVIM
4105 if (xic != NULL)
4107 gtk_im_context_focus_out(xic);
4108 g_object_unref(xic);
4109 xic = NULL;
4111 # endif
4112 im_is_active = FALSE;
4113 im_commit_handler_id = 0;
4114 preedit_start_col = MAXCOL;
4115 xim_has_preediting = FALSE;
4118 # ifndef FEAT_GUI_MACVIM
4120 * Convert the string argument to keyval and state for GdkEventKey.
4121 * If str is valid return TRUE, otherwise FALSE.
4123 * See 'imactivatekey' for documentation of the format.
4125 static int
4126 im_string_to_keyval(const char *str, unsigned int *keyval, unsigned int *state)
4128 const char *mods_end;
4129 unsigned tmp_keyval;
4130 unsigned tmp_state = 0;
4132 mods_end = strrchr(str, '-');
4133 mods_end = (mods_end != NULL) ? mods_end + 1 : str;
4135 /* Parse modifier keys */
4136 while (str < mods_end)
4137 switch (*str++)
4139 case '-': break;
4140 case 'S': case 's': tmp_state |= (unsigned)GDK_SHIFT_MASK; break;
4141 case 'L': case 'l': tmp_state |= (unsigned)GDK_LOCK_MASK; break;
4142 case 'C': case 'c': tmp_state |= (unsigned)GDK_CONTROL_MASK;break;
4143 case '1': tmp_state |= (unsigned)GDK_MOD1_MASK; break;
4144 case '2': tmp_state |= (unsigned)GDK_MOD2_MASK; break;
4145 case '3': tmp_state |= (unsigned)GDK_MOD3_MASK; break;
4146 case '4': tmp_state |= (unsigned)GDK_MOD4_MASK; break;
4147 case '5': tmp_state |= (unsigned)GDK_MOD5_MASK; break;
4148 default:
4149 return FALSE;
4152 tmp_keyval = gdk_keyval_from_name(str);
4154 if (tmp_keyval == 0 || tmp_keyval == GDK_VoidSymbol)
4155 return FALSE;
4157 if (keyval != NULL)
4158 *keyval = tmp_keyval;
4159 if (state != NULL)
4160 *state = tmp_state;
4162 return TRUE;
4166 * Return TRUE if p_imak is valid, otherwise FALSE. As a special case, an
4167 * empty string is also regarded as valid.
4169 * Note: The numerical key value of p_imak is cached if it was valid; thus
4170 * boldly assuming im_xim_isvalid_imactivate() will always be called whenever
4171 * 'imak' changes. This is currently the case but not obvious -- should
4172 * probably rename the function for clarity.
4175 im_xim_isvalid_imactivate(void)
4177 if (p_imak[0] == NUL)
4179 im_activatekey_keyval = GDK_VoidSymbol;
4180 im_activatekey_state = 0;
4181 return TRUE;
4184 return im_string_to_keyval((const char *)p_imak,
4185 &im_activatekey_keyval,
4186 &im_activatekey_state);
4189 static void
4190 im_synthesize_keypress(unsigned int keyval, unsigned int state)
4192 GdkEventKey *event;
4194 # ifdef HAVE_GTK_MULTIHEAD
4195 event = (GdkEventKey *)gdk_event_new(GDK_KEY_PRESS);
4196 g_object_ref(gui.drawarea->window); /* unreffed by gdk_event_free() */
4197 # else
4198 event = (GdkEventKey *)g_malloc0((gulong)sizeof(GdkEvent));
4199 event->type = GDK_KEY_PRESS;
4200 # endif
4201 event->window = gui.drawarea->window;
4202 event->send_event = TRUE;
4203 event->time = GDK_CURRENT_TIME;
4204 event->state = state;
4205 event->keyval = keyval;
4206 event->hardware_keycode = /* needed for XIM */
4207 XKeysymToKeycode(GDK_WINDOW_XDISPLAY(event->window), (KeySym)keyval);
4208 event->length = 0;
4209 event->string = NULL;
4211 gtk_im_context_filter_keypress(xic, event);
4213 /* For consistency, also send the corresponding release event. */
4214 event->type = GDK_KEY_RELEASE;
4215 event->send_event = FALSE;
4216 gtk_im_context_filter_keypress(xic, event);
4218 # ifdef HAVE_GTK_MULTIHEAD
4219 gdk_event_free((GdkEvent *)event);
4220 # else
4221 g_free(event);
4222 # endif
4224 # endif // FEAT_GUI_MACVIM
4226 void
4227 xim_reset(void)
4229 # ifndef FEAT_GUI_MACVIM
4230 if (xic != NULL)
4233 * The third-party imhangul module (and maybe others too) ignores
4234 * gtk_im_context_reset() or at least doesn't reset the active state.
4235 * Thus sending imactivatekey would turn it off if it was on before,
4236 * which is clearly not what we want. Fortunately we can work around
4237 * that for imhangul by sending GDK_Escape, but I don't know if it
4238 * works with all IM modules that support an activation key :/
4240 * An alternative approach would be to destroy the IM context and
4241 * recreate it. But that means loading/unloading the IM module on
4242 * every mode switch, which causes a quite noticable delay even on
4243 * my rather fast box...
4245 * Moreover, there are some XIM which cannot respond to
4246 * im_synthesize_keypress(). we hope that they reset by
4247 * xim_shutdown().
4249 if (im_activatekey_keyval != GDK_VoidSymbol && im_is_active)
4250 im_synthesize_keypress(GDK_Escape, 0U);
4252 gtk_im_context_reset(xic);
4255 * HACK for Ami: This sequence of function calls makes Ami handle
4256 * the IM reset graciously, without breaking loads of other stuff.
4257 * It seems to force English mode as well, which is exactly what we
4258 * want because it makes the Ami status display work reliably.
4260 gtk_im_context_set_use_preedit(xic, FALSE);
4262 if (p_imdisable)
4263 im_shutdown();
4264 else
4266 gtk_im_context_set_use_preedit(xic, TRUE);
4267 xim_set_focus(gui.in_focus);
4269 if (im_activatekey_keyval != GDK_VoidSymbol)
4271 if (im_is_active)
4273 g_signal_handler_block(xic, im_commit_handler_id);
4274 im_synthesize_keypress(im_activatekey_keyval,
4275 im_activatekey_state);
4276 g_signal_handler_unblock(xic, im_commit_handler_id);
4279 else
4281 im_shutdown();
4282 xim_init();
4283 xim_set_focus(gui.in_focus);
4287 # endif
4289 preedit_start_col = MAXCOL;
4290 xim_has_preediting = FALSE;
4293 # ifndef FEAT_GUI_MACVIM
4295 xim_queue_key_press_event(GdkEventKey *event, int down)
4297 if (down)
4300 * Workaround GTK2 XIM 'feature' that always converts keypad keys to
4301 * chars., even when not part of an IM sequence (ref. feature of
4302 * gdk/gdkkeyuni.c).
4303 * Flag any keypad keys that might represent a single char.
4304 * If this (on its own - i.e., not part of an IM sequence) is
4305 * committed while we're processing one of these keys, we can ignore
4306 * that commit and go ahead & process it ourselves. That way we can
4307 * still distinguish keypad keys for use in mappings.
4308 * Also add GDK_space to make <S-Space> work.
4310 switch (event->keyval)
4312 case GDK_KP_Add: xim_expected_char = '+'; break;
4313 case GDK_KP_Subtract: xim_expected_char = '-'; break;
4314 case GDK_KP_Divide: xim_expected_char = '/'; break;
4315 case GDK_KP_Multiply: xim_expected_char = '*'; break;
4316 case GDK_KP_Decimal: xim_expected_char = '.'; break;
4317 case GDK_KP_Equal: xim_expected_char = '='; break;
4318 case GDK_KP_0: xim_expected_char = '0'; break;
4319 case GDK_KP_1: xim_expected_char = '1'; break;
4320 case GDK_KP_2: xim_expected_char = '2'; break;
4321 case GDK_KP_3: xim_expected_char = '3'; break;
4322 case GDK_KP_4: xim_expected_char = '4'; break;
4323 case GDK_KP_5: xim_expected_char = '5'; break;
4324 case GDK_KP_6: xim_expected_char = '6'; break;
4325 case GDK_KP_7: xim_expected_char = '7'; break;
4326 case GDK_KP_8: xim_expected_char = '8'; break;
4327 case GDK_KP_9: xim_expected_char = '9'; break;
4328 case GDK_space: xim_expected_char = ' '; break;
4329 default: xim_expected_char = NUL;
4331 xim_ignored_char = FALSE;
4335 * When typing fFtT, XIM may be activated. Thus it must pass
4336 * gtk_im_context_filter_keypress() in Normal mode.
4337 * And while doing :sh too.
4339 if (xic != NULL && !p_imdisable
4340 && (State & (INSERT | CMDLINE | NORMAL | EXTERNCMD)) != 0)
4343 * Filter 'imactivatekey' and map it to CTRL-^. This way, Vim is
4344 * always aware of the current status of IM, and can even emulate
4345 * the activation key for modules that don't support one.
4347 if (event->keyval == im_activatekey_keyval
4348 && (event->state & im_activatekey_state) == im_activatekey_state)
4350 unsigned int state_mask;
4352 /* Require the state of the 3 most used modifiers to match exactly.
4353 * Otherwise e.g. <S-C-space> would be unusable for other purposes
4354 * if the IM activate key is <S-space>. */
4355 state_mask = im_activatekey_state;
4356 state_mask |= ((int)GDK_SHIFT_MASK | (int)GDK_CONTROL_MASK
4357 | (int)GDK_MOD1_MASK);
4359 if ((event->state & state_mask) != im_activatekey_state)
4360 return FALSE;
4362 /* Don't send it a second time on GDK_KEY_RELEASE. */
4363 if (event->type != GDK_KEY_PRESS)
4364 return TRUE;
4366 if (map_to_exists_mode((char_u *)"", LANGMAP, FALSE))
4368 im_set_active(FALSE);
4370 /* ":lmap" mappings exists, toggle use of mappings. */
4371 State ^= LANGMAP;
4372 if (State & LANGMAP)
4374 curbuf->b_p_iminsert = B_IMODE_NONE;
4375 State &= ~LANGMAP;
4377 else
4379 curbuf->b_p_iminsert = B_IMODE_LMAP;
4380 State |= LANGMAP;
4382 return TRUE;
4385 return gtk_im_context_filter_keypress(xic, event);
4388 /* Don't filter events through the IM context if IM isn't active
4389 * right now. Unlike with GTK+ 1.2 we cannot rely on the IM module
4390 * not doing anything before the activation key was sent. */
4391 if (im_activatekey_keyval == GDK_VoidSymbol || im_is_active)
4393 int imresult = gtk_im_context_filter_keypress(xic, event);
4395 /* Some XIM send following sequence:
4396 * 1. preedited string.
4397 * 2. committed string.
4398 * 3. line changed key.
4399 * 4. preedited string.
4400 * 5. remove preedited string.
4401 * if 3, Vim can't move back the above line for 5.
4402 * thus, this part should not parse the key. */
4403 if (!imresult && preedit_start_col != MAXCOL
4404 && event->keyval == GDK_Return)
4406 im_synthesize_keypress(GDK_Return, 0U);
4407 return FALSE;
4410 /* If XIM tried to commit a keypad key as a single char.,
4411 * ignore it so we can use the keypad key 'raw', for mappings. */
4412 if (xim_expected_char != NUL && xim_ignored_char)
4413 /* We had a keypad key, and XIM tried to thieve it */
4414 return FALSE;
4416 /* Normal processing */
4417 return imresult;
4421 return FALSE;
4423 # endif
4425 # ifndef FEAT_GUI_MACVIM
4427 im_get_status(void)
4429 return im_is_active;
4431 # endif
4433 # else /* !HAVE_GTK2 */
4435 static int xim_is_active = FALSE; /* XIM should be active in the current
4436 mode */
4437 static int xim_has_focus = FALSE; /* XIM is really being used for Vim */
4438 #ifdef FEAT_GUI_X11
4439 static XIMStyle input_style;
4440 static int status_area_enabled = TRUE;
4441 #endif
4443 #ifdef FEAT_GUI_GTK
4444 # ifdef WIN3264
4445 # include <gdk/gdkwin32.h>
4446 # else
4447 # include <gdk/gdkx.h>
4448 # endif
4449 #else
4450 # ifdef PROTO
4451 /* Define a few things to be able to generate prototypes while not configured
4452 * for GTK. */
4453 # define GSList int
4454 # define gboolean int
4455 typedef int GdkEvent;
4456 typedef int GdkEventKey;
4457 # define GdkIC int
4458 # endif
4459 #endif
4461 #if defined(FEAT_GUI_GTK) || defined(PROTO)
4462 static int preedit_buf_len = 0;
4463 static int xim_can_preediting INIT(= FALSE); /* XIM in showmode() */
4464 static int xim_input_style;
4465 #ifndef FEAT_GUI_GTK
4466 # define gboolean int
4467 #endif
4468 static gboolean use_status_area = 0;
4470 static int im_xim_str2keycode __ARGS((unsigned int *code, unsigned int *state));
4471 static void im_xim_send_event_imactivate __ARGS((void));
4474 * Convert string to keycode and state for XKeyEvent.
4475 * When string is valid return OK, when invalid return FAIL.
4477 * See 'imactivatekey' documentation for the format.
4479 static int
4480 im_xim_str2keycode(code, state)
4481 unsigned int *code;
4482 unsigned int *state;
4484 int retval = OK;
4485 int len;
4486 unsigned keycode = 0, keystate = 0;
4487 Window window;
4488 Display *display;
4489 char_u *flag_end;
4490 char_u *str;
4492 if (*p_imak != NUL)
4494 len = STRLEN(p_imak);
4495 for (flag_end = p_imak + len - 1;
4496 flag_end > p_imak && *flag_end != '-'; --flag_end)
4499 /* Parse modifier keys */
4500 for (str = p_imak; str < flag_end; ++str)
4502 switch (*str)
4504 case 's': case 'S':
4505 keystate |= ShiftMask;
4506 break;
4507 case 'l': case 'L':
4508 keystate |= LockMask;
4509 break;
4510 case 'c': case 'C':
4511 keystate |= ControlMask;
4512 break;
4513 case '1':
4514 keystate |= Mod1Mask;
4515 break;
4516 case '2':
4517 keystate |= Mod2Mask;
4518 break;
4519 case '3':
4520 keystate |= Mod3Mask;
4521 break;
4522 case '4':
4523 keystate |= Mod4Mask;
4524 break;
4525 case '5':
4526 keystate |= Mod5Mask;
4527 break;
4528 case '-':
4529 break;
4530 default:
4531 retval = FAIL;
4534 if (*str == '-')
4535 ++str;
4537 /* Get keycode from string. */
4538 gui_get_x11_windis(&window, &display);
4539 if (display)
4540 keycode = XKeysymToKeycode(display, XStringToKeysym((char *)str));
4541 if (keycode == 0)
4542 retval = FAIL;
4544 if (code != NULL)
4545 *code = keycode;
4546 if (state != NULL)
4547 *state = keystate;
4549 return retval;
4552 static void
4553 im_xim_send_event_imactivate()
4555 /* Force turn on preedit state by symulate keypress event.
4556 * Keycode and state is specified by 'imactivatekey'.
4558 XKeyEvent ev;
4560 gui_get_x11_windis(&ev.window, &ev.display);
4561 ev.root = RootWindow(ev.display, DefaultScreen(ev.display));
4562 ev.subwindow = None;
4563 ev.time = CurrentTime;
4564 ev.x = 1;
4565 ev.y = 1;
4566 ev.x_root = 1;
4567 ev.y_root = 1;
4568 ev.same_screen = 1;
4569 ev.type = KeyPress;
4570 if (im_xim_str2keycode(&ev.keycode, &ev.state) == OK)
4571 XSendEvent(ev.display, ev.window, 1, KeyPressMask, (XEvent*)&ev);
4575 * Return TRUE if 'imactivatekey' has a valid value.
4578 im_xim_isvalid_imactivate()
4580 return im_xim_str2keycode(NULL, NULL) == OK;
4582 #endif /* FEAT_GUI_GTK */
4585 * Switch using XIM on/off. This is used by the code that changes "State".
4587 void
4588 im_set_active(active)
4589 int active;
4591 if (xic == NULL)
4592 return;
4594 /* If 'imdisable' is set, XIM is never active. */
4595 if (p_imdisable)
4596 active = FALSE;
4597 #if !defined (FEAT_GUI_GTK)
4598 else if (input_style & XIMPreeditPosition)
4599 /* There is a problem in switching XIM off when preediting is used,
4600 * and it is not clear how this can be solved. For now, keep XIM on
4601 * all the time, like it was done in Vim 5.8. */
4602 active = TRUE;
4603 #endif
4605 /* Remember the active state, it is needed when Vim gets keyboard focus. */
4606 xim_is_active = active;
4608 #ifdef FEAT_GUI_GTK
4609 /* When 'imactivatekey' has valid key-string, try to control XIM preedit
4610 * state. When 'imactivatekey' has no or invalid string, try old XIM
4611 * focus control.
4613 if (*p_imak != NUL)
4615 /* BASIC STRATEGY:
4616 * Destroy old Input Context (XIC), and create new one. New XIC
4617 * would have a state of preedit that is off. When argument:active
4618 * is false, that's all. Else argument:active is true, send a key
4619 * event specified by 'imactivatekey' to activate XIM preedit state.
4622 xim_is_active = TRUE; /* Disable old XIM focus control */
4623 /* If we can monitor preedit state with preedit callback functions,
4624 * try least creation of new XIC.
4626 if (xim_input_style & (int)GDK_IM_PREEDIT_CALLBACKS)
4628 if (xim_can_preediting && !active)
4630 /* Force turn off preedit state. With some IM
4631 * implementations, we cannot turn off preedit state by
4632 * symulate keypress event. It is why using such a method
4633 * that destroy old IC (input context), and create new one.
4634 * When create new IC, its preedit state is usually off.
4636 xim_reset();
4637 xim_set_focus(FALSE);
4638 gdk_ic_destroy(xic);
4639 xim_init();
4640 xim_can_preediting = FALSE;
4642 else if (!xim_can_preediting && active)
4643 im_xim_send_event_imactivate();
4645 else
4647 /* First, force destroy old IC, and create new one. It
4648 * symulates "turning off preedit state".
4650 xim_set_focus(FALSE);
4651 gdk_ic_destroy(xic);
4652 xim_init();
4653 xim_can_preediting = FALSE;
4655 /* 2nd, when requested to activate IM, symulate this by sending
4656 * the event.
4658 if (active)
4660 im_xim_send_event_imactivate();
4661 xim_can_preediting = TRUE;
4665 else
4667 # ifndef XIMPreeditUnKnown
4668 /* X11R5 doesn't have these, it looks safe enough to define here. */
4669 typedef unsigned long XIMPreeditState;
4670 # define XIMPreeditUnKnown 0L
4671 # define XIMPreeditEnable 1L
4672 # define XIMPreeditDisable (1L<<1)
4673 # define XNPreeditState "preeditState"
4674 # endif
4675 XIMPreeditState preedit_state = XIMPreeditUnKnown;
4676 XVaNestedList preedit_attr;
4677 XIC pxic;
4679 preedit_attr = XVaCreateNestedList(0,
4680 XNPreeditState, &preedit_state,
4681 NULL);
4682 pxic = ((GdkICPrivate *)xic)->xic;
4684 if (!XGetICValues(pxic, XNPreeditAttributes, preedit_attr, NULL))
4686 XFree(preedit_attr);
4687 preedit_attr = XVaCreateNestedList(0,
4688 XNPreeditState,
4689 active ? XIMPreeditEnable : XIMPreeditDisable,
4690 NULL);
4691 XSetICValues(pxic, XNPreeditAttributes, preedit_attr, NULL);
4692 xim_can_preediting = active;
4693 xim_is_active = active;
4695 XFree(preedit_attr);
4697 if (xim_input_style & XIMPreeditCallbacks)
4699 preedit_buf_len = 0;
4700 init_preedit_start_col();
4702 #else
4703 # if 0
4704 /* When had tested kinput2 + canna + Athena GUI version with
4705 * 'imactivatekey' is "s-space", im_xim_send_event_imactivate() did not
4706 * work correctly. It just inserted one space. I don't know why we
4707 * couldn't switch state of XIM preediting. This is reason why these
4708 * codes are commented out.
4710 /* First, force destroy old IC, and create new one. It symulates
4711 * "turning off preedit state".
4713 xim_set_focus(FALSE);
4714 XDestroyIC(xic);
4715 xic = NULL;
4716 xim_init();
4718 /* 2nd, when requested to activate IM, symulate this by sending the
4719 * event.
4721 if (active)
4722 im_xim_send_event_imactivate();
4723 # endif
4724 #endif
4725 xim_set_preedit();
4729 * Adjust using XIM for gaining or losing keyboard focus. Also called when
4730 * "xim_is_active" changes.
4732 void
4733 xim_set_focus(focus)
4734 int focus;
4736 if (xic == NULL)
4737 return;
4740 * XIM only gets focus when the Vim window has keyboard focus and XIM has
4741 * been set active for the current mode.
4743 if (focus && xim_is_active)
4745 if (!xim_has_focus)
4747 xim_has_focus = TRUE;
4748 #ifdef FEAT_GUI_GTK
4749 gdk_im_begin(xic, gui.drawarea->window);
4750 #else
4751 XSetICFocus(xic);
4752 #endif
4755 else
4757 if (xim_has_focus)
4759 xim_has_focus = FALSE;
4760 #ifdef FEAT_GUI_GTK
4761 gdk_im_end();
4762 #else
4763 XUnsetICFocus(xic);
4764 #endif
4769 void
4770 im_set_position(row, col)
4771 int row UNUSED;
4772 int col UNUSED;
4774 xim_set_preedit();
4778 * Set the XIM to the current cursor position.
4780 void
4781 xim_set_preedit()
4783 if (xic == NULL)
4784 return;
4786 xim_set_focus(TRUE);
4788 #ifdef FEAT_GUI_GTK
4789 if (gdk_im_ready())
4791 int attrmask;
4792 GdkICAttr *attr;
4794 if (!xic_attr)
4795 return;
4797 attr = xic_attr;
4798 attrmask = 0;
4800 # ifdef FEAT_XFONTSET
4801 if ((xim_input_style & (int)GDK_IM_PREEDIT_POSITION)
4802 && gui.fontset != NOFONTSET
4803 && gui.fontset->type == GDK_FONT_FONTSET)
4805 if (!xim_has_focus)
4807 if (attr->spot_location.y >= 0)
4809 attr->spot_location.x = 0;
4810 attr->spot_location.y = -100;
4811 attrmask |= (int)GDK_IC_SPOT_LOCATION;
4814 else
4816 gint width, height;
4818 if (attr->spot_location.x != TEXT_X(gui.col)
4819 || attr->spot_location.y != TEXT_Y(gui.row))
4821 attr->spot_location.x = TEXT_X(gui.col);
4822 attr->spot_location.y = TEXT_Y(gui.row);
4823 attrmask |= (int)GDK_IC_SPOT_LOCATION;
4826 gdk_window_get_size(gui.drawarea->window, &width, &height);
4827 width -= 2 * gui.border_offset;
4828 height -= 2 * gui.border_offset;
4829 if (xim_input_style & (int)GDK_IM_STATUS_AREA)
4830 height -= gui.char_height;
4831 if (attr->preedit_area.width != width
4832 || attr->preedit_area.height != height)
4834 attr->preedit_area.x = gui.border_offset;
4835 attr->preedit_area.y = gui.border_offset;
4836 attr->preedit_area.width = width;
4837 attr->preedit_area.height = height;
4838 attrmask |= (int)GDK_IC_PREEDIT_AREA;
4841 if (attr->preedit_fontset != gui.current_font)
4843 attr->preedit_fontset = gui.current_font;
4844 attrmask |= (int)GDK_IC_PREEDIT_FONTSET;
4848 # endif /* FEAT_XFONTSET */
4850 if (xim_fg_color == INVALCOLOR)
4852 xim_fg_color = gui.def_norm_pixel;
4853 xim_bg_color = gui.def_back_pixel;
4855 if (attr->preedit_foreground.pixel != xim_fg_color)
4857 attr->preedit_foreground.pixel = xim_fg_color;
4858 attrmask |= (int)GDK_IC_PREEDIT_FOREGROUND;
4860 if (attr->preedit_background.pixel != xim_bg_color)
4862 attr->preedit_background.pixel = xim_bg_color;
4863 attrmask |= (int)GDK_IC_PREEDIT_BACKGROUND;
4866 if (attrmask != 0)
4867 gdk_ic_set_attr(xic, attr, (GdkICAttributesType)attrmask);
4869 #else /* FEAT_GUI_GTK */
4871 XVaNestedList attr_list;
4872 XRectangle spot_area;
4873 XPoint over_spot;
4874 int line_space;
4876 if (!xim_has_focus)
4878 /* hide XIM cursor */
4879 over_spot.x = 0;
4880 over_spot.y = -100; /* arbitrary invisible position */
4881 attr_list = (XVaNestedList) XVaCreateNestedList(0,
4882 XNSpotLocation,
4883 &over_spot,
4884 NULL);
4885 XSetICValues(xic, XNPreeditAttributes, attr_list, NULL);
4886 XFree(attr_list);
4887 return;
4890 if (input_style & XIMPreeditPosition)
4892 if (xim_fg_color == INVALCOLOR)
4894 xim_fg_color = gui.def_norm_pixel;
4895 xim_bg_color = gui.def_back_pixel;
4897 over_spot.x = TEXT_X(gui.col);
4898 over_spot.y = TEXT_Y(gui.row);
4899 spot_area.x = 0;
4900 spot_area.y = 0;
4901 spot_area.height = gui.char_height * Rows;
4902 spot_area.width = gui.char_width * Columns;
4903 line_space = gui.char_height;
4904 attr_list = (XVaNestedList) XVaCreateNestedList(0,
4905 XNSpotLocation, &over_spot,
4906 XNForeground, (Pixel) xim_fg_color,
4907 XNBackground, (Pixel) xim_bg_color,
4908 XNArea, &spot_area,
4909 XNLineSpace, line_space,
4910 NULL);
4911 if (XSetICValues(xic, XNPreeditAttributes, attr_list, NULL))
4912 EMSG(_("E284: Cannot set IC values"));
4913 XFree(attr_list);
4916 #endif /* FEAT_GUI_GTK */
4920 * Set up the status area.
4922 * This should use a separate Widget, but that seems not possible, because
4923 * preedit_area and status_area should be set to the same window as for the
4924 * text input. Unfortunately this means the status area pollutes the text
4925 * window...
4927 void
4928 xim_set_status_area()
4930 if (xic == NULL)
4931 return;
4933 #ifdef FEAT_GUI_GTK
4934 # if defined(FEAT_XFONTSET)
4935 if (use_status_area)
4937 GdkICAttr *attr;
4938 int style;
4939 gint width, height;
4940 GtkWidget *widget;
4941 int attrmask;
4943 if (!xic_attr)
4944 return;
4946 attr = xic_attr;
4947 attrmask = 0;
4948 style = (int)gdk_ic_get_style(xic);
4949 if ((style & (int)GDK_IM_STATUS_MASK) == (int)GDK_IM_STATUS_AREA)
4951 if (gui.fontset != NOFONTSET
4952 && gui.fontset->type == GDK_FONT_FONTSET)
4954 widget = gui.mainwin;
4955 gdk_window_get_size(widget->window, &width, &height);
4957 attrmask |= (int)GDK_IC_STATUS_AREA;
4958 attr->status_area.x = 0;
4959 attr->status_area.y = height - gui.char_height - 1;
4960 attr->status_area.width = width;
4961 attr->status_area.height = gui.char_height;
4964 if (attrmask != 0)
4965 gdk_ic_set_attr(xic, attr, (GdkICAttributesType)attrmask);
4967 # endif
4968 #else
4970 XVaNestedList preedit_list = 0, status_list = 0, list = 0;
4971 XRectangle pre_area, status_area;
4973 if (input_style & XIMStatusArea)
4975 if (input_style & XIMPreeditArea)
4977 XRectangle *needed_rect;
4979 /* to get status_area width */
4980 status_list = XVaCreateNestedList(0, XNAreaNeeded,
4981 &needed_rect, NULL);
4982 XGetICValues(xic, XNStatusAttributes, status_list, NULL);
4983 XFree(status_list);
4985 status_area.width = needed_rect->width;
4987 else
4988 status_area.width = gui.char_width * Columns;
4990 status_area.x = 0;
4991 status_area.y = gui.char_height * Rows + gui.border_offset;
4992 if (gui.which_scrollbars[SBAR_BOTTOM])
4993 status_area.y += gui.scrollbar_height;
4994 #ifdef FEAT_MENU
4995 if (gui.menu_is_active)
4996 status_area.y += gui.menu_height;
4997 #endif
4998 status_area.height = gui.char_height;
4999 status_list = XVaCreateNestedList(0, XNArea, &status_area, NULL);
5001 else
5003 status_area.x = 0;
5004 status_area.y = gui.char_height * Rows + gui.border_offset;
5005 if (gui.which_scrollbars[SBAR_BOTTOM])
5006 status_area.y += gui.scrollbar_height;
5007 #ifdef FEAT_MENU
5008 if (gui.menu_is_active)
5009 status_area.y += gui.menu_height;
5010 #endif
5011 status_area.width = 0;
5012 status_area.height = gui.char_height;
5015 if (input_style & XIMPreeditArea) /* off-the-spot */
5017 pre_area.x = status_area.x + status_area.width;
5018 pre_area.y = gui.char_height * Rows + gui.border_offset;
5019 pre_area.width = gui.char_width * Columns - pre_area.x;
5020 if (gui.which_scrollbars[SBAR_BOTTOM])
5021 pre_area.y += gui.scrollbar_height;
5022 #ifdef FEAT_MENU
5023 if (gui.menu_is_active)
5024 pre_area.y += gui.menu_height;
5025 #endif
5026 pre_area.height = gui.char_height;
5027 preedit_list = XVaCreateNestedList(0, XNArea, &pre_area, NULL);
5029 else if (input_style & XIMPreeditPosition) /* over-the-spot */
5031 pre_area.x = 0;
5032 pre_area.y = 0;
5033 pre_area.height = gui.char_height * Rows;
5034 pre_area.width = gui.char_width * Columns;
5035 preedit_list = XVaCreateNestedList(0, XNArea, &pre_area, NULL);
5038 if (preedit_list && status_list)
5039 list = XVaCreateNestedList(0, XNPreeditAttributes, preedit_list,
5040 XNStatusAttributes, status_list, NULL);
5041 else if (preedit_list)
5042 list = XVaCreateNestedList(0, XNPreeditAttributes, preedit_list,
5043 NULL);
5044 else if (status_list)
5045 list = XVaCreateNestedList(0, XNStatusAttributes, status_list,
5046 NULL);
5047 else
5048 list = NULL;
5050 if (list)
5052 XSetICValues(xic, XNVaNestedList, list, NULL);
5053 XFree(list);
5055 if (status_list)
5056 XFree(status_list);
5057 if (preedit_list)
5058 XFree(preedit_list);
5060 #endif
5063 #if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
5064 static char e_xim[] = N_("E285: Failed to create input context");
5065 #endif
5067 #if defined(FEAT_GUI_X11) || defined(PROTO)
5068 # if defined(XtSpecificationRelease) && XtSpecificationRelease >= 6 && !defined(sun)
5069 # define USE_X11R6_XIM
5070 # endif
5072 static int xim_real_init __ARGS((Window x11_window, Display *x11_display));
5075 #ifdef USE_X11R6_XIM
5076 static void xim_instantiate_cb __ARGS((Display *display, XPointer client_data, XPointer call_data));
5077 static void xim_destroy_cb __ARGS((XIM im, XPointer client_data, XPointer call_data));
5079 static void
5080 xim_instantiate_cb(display, client_data, call_data)
5081 Display *display;
5082 XPointer client_data UNUSED;
5083 XPointer call_data UNUSED;
5085 Window x11_window;
5086 Display *x11_display;
5088 #ifdef XIM_DEBUG
5089 xim_log("xim_instantiate_cb()\n");
5090 #endif
5092 gui_get_x11_windis(&x11_window, &x11_display);
5093 if (display != x11_display)
5094 return;
5096 xim_real_init(x11_window, x11_display);
5097 gui_set_shellsize(FALSE, FALSE, RESIZE_BOTH);
5098 if (xic != NULL)
5099 XUnregisterIMInstantiateCallback(x11_display, NULL, NULL, NULL,
5100 xim_instantiate_cb, NULL);
5103 static void
5104 xim_destroy_cb(im, client_data, call_data)
5105 XIM im UNUSED;
5106 XPointer client_data UNUSED;
5107 XPointer call_data UNUSED;
5109 Window x11_window;
5110 Display *x11_display;
5112 #ifdef XIM_DEBUG
5113 xim_log("xim_destroy_cb()\n");
5114 #endif
5115 gui_get_x11_windis(&x11_window, &x11_display);
5117 xic = NULL;
5118 status_area_enabled = FALSE;
5120 gui_set_shellsize(FALSE, FALSE, RESIZE_BOTH);
5122 XRegisterIMInstantiateCallback(x11_display, NULL, NULL, NULL,
5123 xim_instantiate_cb, NULL);
5125 #endif
5127 void
5128 xim_init()
5130 Window x11_window;
5131 Display *x11_display;
5133 #ifdef XIM_DEBUG
5134 xim_log("xim_init()\n");
5135 #endif
5137 gui_get_x11_windis(&x11_window, &x11_display);
5139 xic = NULL;
5141 if (xim_real_init(x11_window, x11_display))
5142 return;
5144 gui_set_shellsize(FALSE, FALSE, RESIZE_BOTH);
5146 #ifdef USE_X11R6_XIM
5147 XRegisterIMInstantiateCallback(x11_display, NULL, NULL, NULL,
5148 xim_instantiate_cb, NULL);
5149 #endif
5152 static int
5153 xim_real_init(x11_window, x11_display)
5154 Window x11_window;
5155 Display *x11_display;
5157 int i;
5158 char *p,
5160 *ns,
5161 *end,
5162 tmp[1024];
5163 #define IMLEN_MAX 40
5164 char buf[IMLEN_MAX + 7];
5165 XIM xim = NULL;
5166 XIMStyles *xim_styles;
5167 XIMStyle this_input_style = 0;
5168 Boolean found;
5169 XPoint over_spot;
5170 XVaNestedList preedit_list, status_list;
5172 input_style = 0;
5173 status_area_enabled = FALSE;
5175 if (xic != NULL)
5176 return FALSE;
5178 if (gui.rsrc_input_method != NULL && *gui.rsrc_input_method != NUL)
5180 strcpy(tmp, gui.rsrc_input_method);
5181 for (ns = s = tmp; ns != NULL && *s != NUL;)
5183 s = (char *)skipwhite((char_u *)s);
5184 if (*s == NUL)
5185 break;
5186 if ((ns = end = strchr(s, ',')) == NULL)
5187 end = s + strlen(s);
5188 while (isspace(((char_u *)end)[-1]))
5189 end--;
5190 *end = NUL;
5192 if (strlen(s) <= IMLEN_MAX)
5194 strcpy(buf, "@im=");
5195 strcat(buf, s);
5196 if ((p = XSetLocaleModifiers(buf)) != NULL && *p != NUL
5197 && (xim = XOpenIM(x11_display, NULL, NULL, NULL))
5198 != NULL)
5199 break;
5202 s = ns + 1;
5206 if (xim == NULL && (p = XSetLocaleModifiers("")) != NULL && *p != NUL)
5207 xim = XOpenIM(x11_display, NULL, NULL, NULL);
5209 /* This is supposed to be useful to obtain characters through
5210 * XmbLookupString() without really using a XIM. */
5211 if (xim == NULL && (p = XSetLocaleModifiers("@im=none")) != NULL
5212 && *p != NUL)
5213 xim = XOpenIM(x11_display, NULL, NULL, NULL);
5215 if (xim == NULL)
5217 /* Only give this message when verbose is set, because too many people
5218 * got this message when they didn't want to use a XIM. */
5219 if (p_verbose > 0)
5221 verbose_enter();
5222 EMSG(_("E286: Failed to open input method"));
5223 verbose_leave();
5225 return FALSE;
5228 #ifdef USE_X11R6_XIM
5230 XIMCallback destroy_cb;
5232 destroy_cb.callback = xim_destroy_cb;
5233 destroy_cb.client_data = NULL;
5234 if (XSetIMValues(xim, XNDestroyCallback, &destroy_cb, NULL))
5235 EMSG(_("E287: Warning: Could not set destroy callback to IM"));
5237 #endif
5239 if (XGetIMValues(xim, XNQueryInputStyle, &xim_styles, NULL) || !xim_styles)
5241 EMSG(_("E288: input method doesn't support any style"));
5242 XCloseIM(xim);
5243 return FALSE;
5246 found = False;
5247 strcpy(tmp, gui.rsrc_preedit_type_name);
5248 for (s = tmp; s && !found; )
5250 while (*s && isspace((unsigned char)*s))
5251 s++;
5252 if (!*s)
5253 break;
5254 if ((ns = end = strchr(s, ',')) != 0)
5255 ns++;
5256 else
5257 end = s + strlen(s);
5258 while (isspace((unsigned char)*end))
5259 end--;
5260 *end = '\0';
5262 if (!strcmp(s, "OverTheSpot"))
5263 this_input_style = (XIMPreeditPosition | XIMStatusArea);
5264 else if (!strcmp(s, "OffTheSpot"))
5265 this_input_style = (XIMPreeditArea | XIMStatusArea);
5266 else if (!strcmp(s, "Root"))
5267 this_input_style = (XIMPreeditNothing | XIMStatusNothing);
5269 for (i = 0; (unsigned short)i < xim_styles->count_styles; i++)
5271 if (this_input_style == xim_styles->supported_styles[i])
5273 found = True;
5274 break;
5277 if (!found)
5278 for (i = 0; (unsigned short)i < xim_styles->count_styles; i++)
5280 if ((xim_styles->supported_styles[i] & this_input_style)
5281 == (this_input_style & ~XIMStatusArea))
5283 this_input_style &= ~XIMStatusArea;
5284 found = True;
5285 break;
5289 s = ns;
5291 XFree(xim_styles);
5293 if (!found)
5295 /* Only give this message when verbose is set, because too many people
5296 * got this message when they didn't want to use a XIM. */
5297 if (p_verbose > 0)
5299 verbose_enter();
5300 EMSG(_("E289: input method doesn't support my preedit type"));
5301 verbose_leave();
5303 XCloseIM(xim);
5304 return FALSE;
5307 over_spot.x = TEXT_X(gui.col);
5308 over_spot.y = TEXT_Y(gui.row);
5309 input_style = this_input_style;
5311 /* A crash was reported when trying to pass gui.norm_font as XNFontSet,
5312 * thus that has been removed. Hopefully the default works... */
5313 #ifdef FEAT_XFONTSET
5314 if (gui.fontset != NOFONTSET)
5316 preedit_list = XVaCreateNestedList(0,
5317 XNSpotLocation, &over_spot,
5318 XNForeground, (Pixel)gui.def_norm_pixel,
5319 XNBackground, (Pixel)gui.def_back_pixel,
5320 XNFontSet, (XFontSet)gui.fontset,
5321 NULL);
5322 status_list = XVaCreateNestedList(0,
5323 XNForeground, (Pixel)gui.def_norm_pixel,
5324 XNBackground, (Pixel)gui.def_back_pixel,
5325 XNFontSet, (XFontSet)gui.fontset,
5326 NULL);
5328 else
5329 #endif
5331 preedit_list = XVaCreateNestedList(0,
5332 XNSpotLocation, &over_spot,
5333 XNForeground, (Pixel)gui.def_norm_pixel,
5334 XNBackground, (Pixel)gui.def_back_pixel,
5335 NULL);
5336 status_list = XVaCreateNestedList(0,
5337 XNForeground, (Pixel)gui.def_norm_pixel,
5338 XNBackground, (Pixel)gui.def_back_pixel,
5339 NULL);
5342 xic = XCreateIC(xim,
5343 XNInputStyle, input_style,
5344 XNClientWindow, x11_window,
5345 XNFocusWindow, gui.wid,
5346 XNPreeditAttributes, preedit_list,
5347 XNStatusAttributes, status_list,
5348 NULL);
5349 XFree(status_list);
5350 XFree(preedit_list);
5351 if (xic != NULL)
5353 if (input_style & XIMStatusArea)
5355 xim_set_status_area();
5356 status_area_enabled = TRUE;
5358 else
5359 gui_set_shellsize(FALSE, FALSE, RESIZE_BOTH);
5361 else
5363 EMSG(_(e_xim));
5364 XCloseIM(xim);
5365 return FALSE;
5368 return TRUE;
5371 #endif /* FEAT_GUI_X11 */
5373 #if defined(FEAT_GUI_GTK) || defined(PROTO)
5375 # ifdef FEAT_XFONTSET
5376 static char e_overthespot[] = N_("E290: over-the-spot style requires fontset");
5377 # endif
5379 # ifdef PROTO
5380 typedef int GdkIC;
5381 # endif
5383 void
5384 xim_decide_input_style()
5386 /* GDK_IM_STATUS_CALLBACKS was disabled, enabled it to allow Japanese
5387 * OverTheSpot. */
5388 int supported_style = (int)GDK_IM_PREEDIT_NONE |
5389 (int)GDK_IM_PREEDIT_NOTHING |
5390 (int)GDK_IM_PREEDIT_POSITION |
5391 (int)GDK_IM_PREEDIT_CALLBACKS |
5392 (int)GDK_IM_STATUS_CALLBACKS |
5393 (int)GDK_IM_STATUS_AREA |
5394 (int)GDK_IM_STATUS_NONE |
5395 (int)GDK_IM_STATUS_NOTHING;
5397 #ifdef XIM_DEBUG
5398 xim_log("xim_decide_input_style()\n");
5399 #endif
5401 if (!gdk_im_ready())
5402 xim_input_style = 0;
5403 else
5405 if (gtk_major_version > 1
5406 || (gtk_major_version == 1
5407 && (gtk_minor_version > 2
5408 || (gtk_minor_version == 2 && gtk_micro_version >= 3))))
5409 use_status_area = TRUE;
5410 else
5412 EMSG(_("E291: Your GTK+ is older than 1.2.3. Status area disabled"));
5413 use_status_area = FALSE;
5415 #ifdef FEAT_XFONTSET
5416 if (gui.fontset == NOFONTSET || gui.fontset->type != GDK_FONT_FONTSET)
5417 #endif
5418 supported_style &= ~((int)GDK_IM_PREEDIT_POSITION
5419 | (int)GDK_IM_STATUS_AREA);
5420 if (!use_status_area)
5421 supported_style &= ~(int)GDK_IM_STATUS_AREA;
5422 xim_input_style = (int)gdk_im_decide_style((GdkIMStyle)supported_style);
5426 static void
5427 preedit_start_cbproc(XIC thexic UNUSED,
5428 XPointer client_data UNUSED,
5429 XPointer call_data UNUSED)
5431 #ifdef XIM_DEBUG
5432 xim_log("xim_decide_input_style()\n");
5433 #endif
5435 draw_feedback = NULL;
5436 xim_can_preediting = TRUE;
5437 xim_has_preediting = TRUE;
5438 gui_update_cursor(TRUE, FALSE);
5439 if (showmode() > 0)
5441 setcursor();
5442 out_flush();
5446 static void
5447 xim_back_delete(int n)
5449 char_u str[3];
5451 str[0] = CSI;
5452 str[1] = 'k';
5453 str[2] = 'b';
5454 while (n-- > 0)
5455 add_to_input_buf(str, 3);
5458 static GSList *key_press_event_queue = NULL;
5459 static gboolean processing_queued_event = FALSE;
5461 static void
5462 preedit_draw_cbproc(XIC thexic UNUSED,
5463 XPointer client_data UNUSED,
5464 XPointer call_data)
5466 XIMPreeditDrawCallbackStruct *draw_data;
5467 XIMText *text;
5468 char *src;
5469 GSList *event_queue;
5471 #ifdef XIM_DEBUG
5472 xim_log("preedit_draw_cbproc()\n");
5473 #endif
5475 draw_data = (XIMPreeditDrawCallbackStruct *) call_data;
5476 text = (XIMText *) draw_data->text;
5478 if ((text == NULL && draw_data->chg_length == preedit_buf_len)
5479 || preedit_buf_len == 0)
5481 init_preedit_start_col();
5482 vim_free(draw_feedback);
5483 draw_feedback = NULL;
5485 if (draw_data->chg_length > 0)
5487 int bs_cnt;
5489 if (draw_data->chg_length > preedit_buf_len)
5490 bs_cnt = preedit_buf_len;
5491 else
5492 bs_cnt = draw_data->chg_length;
5493 xim_back_delete(bs_cnt);
5494 preedit_buf_len -= bs_cnt;
5496 if (text != NULL)
5498 int len;
5499 #ifdef FEAT_MBYTE
5500 char_u *buf = NULL;
5501 unsigned int nfeedback = 0;
5502 #endif
5503 char_u *ptr;
5505 src = text->string.multi_byte;
5506 if (src != NULL && !text->encoding_is_wchar)
5508 len = strlen(src);
5509 ptr = (char_u *)src;
5510 /* Avoid the enter for decision */
5511 if (*ptr == '\n')
5512 return;
5514 #ifdef FEAT_MBYTE
5515 if (input_conv.vc_type != CONV_NONE
5516 && (buf = string_convert(&input_conv,
5517 (char_u *)src, &len)) != NULL)
5519 /* Converted from 'termencoding' to 'encoding'. */
5520 add_to_input_buf_csi(buf, len);
5521 ptr = buf;
5523 else
5524 #endif
5525 add_to_input_buf_csi((char_u *)src, len);
5526 /* Add count of character to preedit_buf_len */
5527 while (*ptr != NUL)
5529 #ifdef FEAT_MBYTE
5530 if (draw_data->text->feedback != NULL)
5532 if (draw_feedback == NULL)
5533 draw_feedback = (char *)alloc(draw_data->chg_first
5534 + text->length);
5535 else
5536 draw_feedback = vim_realloc(draw_feedback,
5537 draw_data->chg_first + text->length);
5538 if (draw_feedback != NULL)
5540 draw_feedback[nfeedback + draw_data->chg_first]
5541 = draw_data->text->feedback[nfeedback];
5542 nfeedback++;
5545 if (has_mbyte)
5546 ptr += (*mb_ptr2len)(ptr);
5547 else
5548 #endif
5549 ptr++;
5550 preedit_buf_len++;
5552 #ifdef FEAT_MBYTE
5553 vim_free(buf);
5554 #endif
5555 preedit_end_col = MAXCOL;
5558 if (text != NULL || draw_data->chg_length > 0)
5560 event_queue = key_press_event_queue;
5561 processing_queued_event = TRUE;
5562 while (event_queue != NULL && processing_queued_event)
5564 GdkEvent *ev = event_queue->data;
5566 gboolean *ret;
5567 gtk_signal_emit_by_name((GtkObject*)gui.mainwin, "key_press_event",
5568 ev, &ret);
5569 gdk_event_free(ev);
5570 event_queue = event_queue->next;
5572 processing_queued_event = FALSE;
5573 if (key_press_event_queue)
5575 g_slist_free(key_press_event_queue);
5576 key_press_event_queue = NULL;
5579 if (gtk_main_level() > 0)
5580 gtk_main_quit();
5584 * Retrieve the highlighting attributes at column col in the preedit string.
5585 * Return -1 if not in preediting mode or if col is out of range.
5588 im_get_feedback_attr(int col)
5590 if (draw_feedback != NULL && col < preedit_buf_len)
5592 if (draw_feedback[col] & XIMReverse)
5593 return HL_INVERSE;
5594 else if (draw_feedback[col] & XIMUnderline)
5595 return HL_UNDERLINE;
5596 else
5597 return hl_attr(HLF_V);
5600 return -1;
5603 static void
5604 preedit_caret_cbproc(XIC thexic UNUSED,
5605 XPointer client_data UNUSED,
5606 XPointer call_data UNUSED)
5608 #ifdef XIM_DEBUG
5609 xim_log("preedit_caret_cbproc()\n");
5610 #endif
5613 static void
5614 preedit_done_cbproc(XIC thexic UNUSED,
5615 XPointer client_data UNUSED,
5616 XPointer call_data UNUSED)
5618 #ifdef XIM_DEBUG
5619 xim_log("preedit_done_cbproc()\n");
5620 #endif
5622 vim_free(draw_feedback);
5623 draw_feedback = NULL;
5624 xim_can_preediting = FALSE;
5625 xim_has_preediting = FALSE;
5626 gui_update_cursor(TRUE, FALSE);
5627 if (showmode() > 0)
5629 setcursor();
5630 out_flush();
5634 void
5635 xim_reset(void)
5637 char *text;
5639 #ifdef XIM_DEBUG
5640 xim_log("xim_reset()\n");
5641 #endif
5643 if (xic != NULL)
5645 text = XmbResetIC(((GdkICPrivate *)xic)->xic);
5646 if (text != NULL && !(xim_input_style & (int)GDK_IM_PREEDIT_CALLBACKS))
5647 add_to_input_buf_csi((char_u *)text, strlen(text));
5648 else
5649 preedit_buf_len = 0;
5650 if (text != NULL)
5651 XFree(text);
5656 xim_queue_key_press_event(GdkEventKey *event, int down UNUSED)
5658 #ifdef XIM_DEBUG
5659 xim_log("xim_queue_key_press_event()\n");
5660 #endif
5662 if (preedit_buf_len <= 0)
5663 return FALSE;
5664 if (processing_queued_event)
5665 processing_queued_event = FALSE;
5667 key_press_event_queue = g_slist_append(key_press_event_queue,
5668 gdk_event_copy((GdkEvent *)event));
5669 return TRUE;
5672 static void
5673 preedit_callback_setup(GdkIC *ic UNUSED)
5675 XIC xxic;
5676 XVaNestedList preedit_attr;
5677 XIMCallback preedit_start_cb;
5678 XIMCallback preedit_draw_cb;
5679 XIMCallback preedit_caret_cb;
5680 XIMCallback preedit_done_cb;
5682 xxic = ((GdkICPrivate*)xic)->xic;
5683 preedit_start_cb.callback = (XIMProc)preedit_start_cbproc;
5684 preedit_draw_cb.callback = (XIMProc)preedit_draw_cbproc;
5685 preedit_caret_cb.callback = (XIMProc)preedit_caret_cbproc;
5686 preedit_done_cb.callback = (XIMProc)preedit_done_cbproc;
5687 preedit_attr
5688 = XVaCreateNestedList(0,
5689 XNPreeditStartCallback, &preedit_start_cb,
5690 XNPreeditDrawCallback, &preedit_draw_cb,
5691 XNPreeditCaretCallback, &preedit_caret_cb,
5692 XNPreeditDoneCallback, &preedit_done_cb,
5693 NULL);
5694 XSetICValues(xxic, XNPreeditAttributes, preedit_attr, NULL);
5695 XFree(preedit_attr);
5698 static void
5699 reset_state_setup(GdkIC *ic UNUSED)
5701 #ifdef USE_X11R6_XIM
5702 /* don't change the input context when we call reset */
5703 XSetICValues(((GdkICPrivate *)ic)->xic, XNResetState, XIMPreserveState,
5704 NULL);
5705 #endif
5708 void
5709 xim_init(void)
5711 #ifdef XIM_DEBUG
5712 xim_log("xim_init()\n");
5713 #endif
5715 xic = NULL;
5716 xic_attr = NULL;
5718 if (!gdk_im_ready())
5720 if (p_verbose > 0)
5722 verbose_enter();
5723 EMSG(_("E292: Input Method Server is not running"));
5724 verbose_leave();
5726 return;
5728 if ((xic_attr = gdk_ic_attr_new()) != NULL)
5730 #ifdef FEAT_XFONTSET
5731 gint width, height;
5732 #endif
5733 int mask;
5734 GdkColormap *colormap;
5735 GdkICAttr *attr = xic_attr;
5736 int attrmask = (int)GDK_IC_ALL_REQ;
5737 GtkWidget *widget = gui.drawarea;
5739 attr->style = (GdkIMStyle)xim_input_style;
5740 attr->client_window = gui.mainwin->window;
5742 if ((colormap = gtk_widget_get_colormap(widget)) !=
5743 gtk_widget_get_default_colormap())
5745 attrmask |= (int)GDK_IC_PREEDIT_COLORMAP;
5746 attr->preedit_colormap = colormap;
5748 attrmask |= (int)GDK_IC_PREEDIT_FOREGROUND;
5749 attrmask |= (int)GDK_IC_PREEDIT_BACKGROUND;
5750 attr->preedit_foreground = widget->style->fg[GTK_STATE_NORMAL];
5751 attr->preedit_background = widget->style->base[GTK_STATE_NORMAL];
5753 #ifdef FEAT_XFONTSET
5754 if ((xim_input_style & (int)GDK_IM_PREEDIT_MASK)
5755 == (int)GDK_IM_PREEDIT_POSITION)
5757 if (gui.fontset == NOFONTSET
5758 || gui.fontset->type != GDK_FONT_FONTSET)
5760 EMSG(_(e_overthespot));
5762 else
5764 gdk_window_get_size(widget->window, &width, &height);
5766 attrmask |= (int)GDK_IC_PREEDIT_POSITION_REQ;
5767 attr->spot_location.x = TEXT_X(0);
5768 attr->spot_location.y = TEXT_Y(0);
5769 attr->preedit_area.x = gui.border_offset;
5770 attr->preedit_area.y = gui.border_offset;
5771 attr->preedit_area.width = width - 2*gui.border_offset;
5772 attr->preedit_area.height = height - 2*gui.border_offset;
5773 attr->preedit_fontset = gui.fontset;
5777 if ((xim_input_style & (int)GDK_IM_STATUS_MASK)
5778 == (int)GDK_IM_STATUS_AREA)
5780 if (gui.fontset == NOFONTSET
5781 || gui.fontset->type != GDK_FONT_FONTSET)
5783 EMSG(_(e_overthespot));
5785 else
5787 gdk_window_get_size(gui.mainwin->window, &width, &height);
5788 attrmask |= (int)GDK_IC_STATUS_AREA_REQ;
5789 attr->status_area.x = 0;
5790 attr->status_area.y = height - gui.char_height - 1;
5791 attr->status_area.width = width;
5792 attr->status_area.height = gui.char_height;
5793 attr->status_fontset = gui.fontset;
5796 else if ((xim_input_style & (int)GDK_IM_STATUS_MASK)
5797 == (int)GDK_IM_STATUS_CALLBACKS)
5799 /* FIXME */
5801 #endif
5803 xic = gdk_ic_new(attr, (GdkICAttributesType)attrmask);
5805 if (xic == NULL)
5806 EMSG(_(e_xim));
5807 else
5809 mask = (int)gdk_window_get_events(widget->window);
5810 mask |= (int)gdk_ic_get_events(xic);
5811 gdk_window_set_events(widget->window, (GdkEventMask)mask);
5812 if (xim_input_style & (int)GDK_IM_PREEDIT_CALLBACKS)
5813 preedit_callback_setup(xic);
5814 reset_state_setup(xic);
5819 void
5820 im_shutdown(void)
5822 #ifdef XIM_DEBUG
5823 xim_log("im_shutdown()\n");
5824 #endif
5826 if (xic != NULL)
5828 gdk_im_end();
5829 gdk_ic_destroy(xic);
5830 xic = NULL;
5832 xim_is_active = FALSE;
5833 xim_can_preediting = FALSE;
5834 preedit_start_col = MAXCOL;
5835 xim_has_preediting = FALSE;
5838 #endif /* FEAT_GUI_GTK */
5841 xim_get_status_area_height()
5843 #ifdef FEAT_GUI_GTK
5844 if (xim_input_style & (int)GDK_IM_STATUS_AREA)
5845 return gui.char_height;
5846 #else
5847 if (status_area_enabled)
5848 return gui.char_height;
5849 #endif
5850 return 0;
5854 * Get IM status. When IM is on, return TRUE. Else return FALSE.
5855 * FIXME: This doesn't work correctly: Having focus doesn't always mean XIM is
5856 * active, when not having focus XIM may still be active (e.g., when using a
5857 * tear-off menu item).
5860 im_get_status()
5862 # ifdef FEAT_GUI_GTK
5863 if (xim_input_style & (int)GDK_IM_PREEDIT_CALLBACKS)
5864 return xim_can_preediting;
5865 # endif
5866 return xim_has_focus;
5869 # endif /* !HAVE_GTK2 */
5871 # if (defined(HAVE_GTK2) || defined(FEAT_GUI_MACVIM)) || defined(PROTO)
5873 preedit_get_status(void)
5875 return preedit_is_active;
5877 # endif
5879 # if (defined(FEAT_GUI_GTK) || defined(FEAT_GUI_MACVIM)) || defined(PROTO)
5881 im_is_preediting()
5883 return xim_has_preediting;
5885 # endif
5886 #endif /* FEAT_XIM */
5888 #if defined(FEAT_MBYTE) || defined(PROTO)
5891 * Setup "vcp" for conversion from "from" to "to".
5892 * The names must have been made canonical with enc_canonize().
5893 * vcp->vc_type must have been initialized to CONV_NONE.
5894 * Note: cannot be used for conversion from/to ucs-2 and ucs-4 (will use utf-8
5895 * instead).
5896 * Afterwards invoke with "from" and "to" equal to NULL to cleanup.
5897 * Return FAIL when conversion is not supported, OK otherwise.
5900 convert_setup(vcp, from, to)
5901 vimconv_T *vcp;
5902 char_u *from;
5903 char_u *to;
5905 return convert_setup_ext(vcp, from, TRUE, to, TRUE);
5909 * As convert_setup(), but only when from_unicode_is_utf8 is TRUE will all
5910 * "from" unicode charsets be considered utf-8. Same for "to".
5913 convert_setup_ext(vcp, from, from_unicode_is_utf8, to, to_unicode_is_utf8)
5914 vimconv_T *vcp;
5915 char_u *from;
5916 int from_unicode_is_utf8;
5917 char_u *to;
5918 int to_unicode_is_utf8;
5920 int from_prop;
5921 int to_prop;
5922 int from_is_utf8;
5923 int to_is_utf8;
5925 /* Reset to no conversion. */
5926 # ifdef USE_ICONV
5927 if (vcp->vc_type == CONV_ICONV && vcp->vc_fd != (iconv_t)-1)
5928 iconv_close(vcp->vc_fd);
5929 # endif
5930 vcp->vc_type = CONV_NONE;
5931 vcp->vc_factor = 1;
5932 vcp->vc_fail = FALSE;
5934 /* No conversion when one of the names is empty or they are equal. */
5935 if (from == NULL || *from == NUL || to == NULL || *to == NUL
5936 || STRCMP(from, to) == 0)
5937 return OK;
5939 from_prop = enc_canon_props(from);
5940 to_prop = enc_canon_props(to);
5941 if (from_unicode_is_utf8)
5942 from_is_utf8 = from_prop & ENC_UNICODE;
5943 else
5944 from_is_utf8 = from_prop == ENC_UNICODE;
5945 if (to_unicode_is_utf8)
5946 to_is_utf8 = to_prop & ENC_UNICODE;
5947 else
5948 to_is_utf8 = to_prop == ENC_UNICODE;
5950 if ((from_prop & ENC_LATIN1) && to_is_utf8)
5952 /* Internal latin1 -> utf-8 conversion. */
5953 vcp->vc_type = CONV_TO_UTF8;
5954 vcp->vc_factor = 2; /* up to twice as long */
5956 else if ((from_prop & ENC_LATIN9) && to_is_utf8)
5958 /* Internal latin9 -> utf-8 conversion. */
5959 vcp->vc_type = CONV_9_TO_UTF8;
5960 vcp->vc_factor = 3; /* up to three as long (euro sign) */
5962 else if (from_is_utf8 && (to_prop & ENC_LATIN1))
5964 /* Internal utf-8 -> latin1 conversion. */
5965 vcp->vc_type = CONV_TO_LATIN1;
5967 else if (from_is_utf8 && (to_prop & ENC_LATIN9))
5969 /* Internal utf-8 -> latin9 conversion. */
5970 vcp->vc_type = CONV_TO_LATIN9;
5972 #ifdef WIN3264
5973 /* Win32-specific codepage <-> codepage conversion without iconv. */
5974 else if ((from_is_utf8 || encname2codepage(from) > 0)
5975 && (to_is_utf8 || encname2codepage(to) > 0))
5977 vcp->vc_type = CONV_CODEPAGE;
5978 vcp->vc_factor = 2; /* up to twice as long */
5979 vcp->vc_cpfrom = from_is_utf8 ? 0 : encname2codepage(from);
5980 vcp->vc_cpto = to_is_utf8 ? 0 : encname2codepage(to);
5982 #endif
5983 #ifdef MACOS_X
5984 else if ((from_prop & ENC_MACROMAN) && (to_prop & ENC_LATIN1))
5986 vcp->vc_type = CONV_MAC_LATIN1;
5988 else if ((from_prop & ENC_MACROMAN) && to_is_utf8)
5990 vcp->vc_type = CONV_MAC_UTF8;
5991 vcp->vc_factor = 2; /* up to twice as long */
5993 else if ((from_prop & ENC_LATIN1) && (to_prop & ENC_MACROMAN))
5995 vcp->vc_type = CONV_LATIN1_MAC;
5997 else if (from_is_utf8 && (to_prop & ENC_MACROMAN))
5999 vcp->vc_type = CONV_UTF8_MAC;
6001 #endif
6002 # ifdef USE_ICONV
6003 else
6005 /* Use iconv() for conversion. */
6006 vcp->vc_fd = (iconv_t)my_iconv_open(
6007 to_is_utf8 ? (char_u *)"utf-8" : to,
6008 from_is_utf8 ? (char_u *)"utf-8" : from);
6009 if (vcp->vc_fd != (iconv_t)-1)
6011 vcp->vc_type = CONV_ICONV;
6012 vcp->vc_factor = 4; /* could be longer too... */
6015 # endif
6016 if (vcp->vc_type == CONV_NONE)
6017 return FAIL;
6019 return OK;
6022 #if defined(FEAT_GUI) || defined(AMIGA) || defined(WIN3264) \
6023 || defined(MSDOS) || defined(PROTO)
6025 * Do conversion on typed input characters in-place.
6026 * The input and output are not NUL terminated!
6027 * Returns the length after conversion.
6030 convert_input(ptr, len, maxlen)
6031 char_u *ptr;
6032 int len;
6033 int maxlen;
6035 return convert_input_safe(ptr, len, maxlen, NULL, NULL);
6037 #endif
6040 * Like convert_input(), but when there is an incomplete byte sequence at the
6041 * end return that as an allocated string in "restp" and set "*restlenp" to
6042 * the length. If "restp" is NULL it is not used.
6045 convert_input_safe(ptr, len, maxlen, restp, restlenp)
6046 char_u *ptr;
6047 int len;
6048 int maxlen;
6049 char_u **restp;
6050 int *restlenp;
6052 char_u *d;
6053 int dlen = len;
6054 int unconvertlen = 0;
6056 d = string_convert_ext(&input_conv, ptr, &dlen,
6057 restp == NULL ? NULL : &unconvertlen);
6058 if (d != NULL)
6060 if (dlen <= maxlen)
6062 if (unconvertlen > 0)
6064 /* Move the unconverted characters to allocated memory. */
6065 *restp = alloc(unconvertlen);
6066 if (*restp != NULL)
6067 mch_memmove(*restp, ptr + len - unconvertlen, unconvertlen);
6068 *restlenp = unconvertlen;
6070 mch_memmove(ptr, d, dlen);
6072 else
6073 /* result is too long, keep the unconverted text (the caller must
6074 * have done something wrong!) */
6075 dlen = len;
6076 vim_free(d);
6078 return dlen;
6082 * Convert text "ptr[*lenp]" according to "vcp".
6083 * Returns the result in allocated memory and sets "*lenp".
6084 * When "lenp" is NULL, use NUL terminated strings.
6085 * Illegal chars are often changed to "?", unless vcp->vc_fail is set.
6086 * When something goes wrong, NULL is returned and "*lenp" is unchanged.
6088 char_u *
6089 string_convert(vcp, ptr, lenp)
6090 vimconv_T *vcp;
6091 char_u *ptr;
6092 int *lenp;
6094 return string_convert_ext(vcp, ptr, lenp, NULL);
6098 * Like string_convert(), but when "unconvlenp" is not NULL and there are is
6099 * an incomplete sequence at the end it is not converted and "*unconvlenp" is
6100 * set to the number of remaining bytes.
6102 char_u *
6103 string_convert_ext(vcp, ptr, lenp, unconvlenp)
6104 vimconv_T *vcp;
6105 char_u *ptr;
6106 int *lenp;
6107 int *unconvlenp;
6109 char_u *retval = NULL;
6110 char_u *d;
6111 int len;
6112 int i;
6113 int l;
6114 int c;
6116 if (lenp == NULL)
6117 len = (int)STRLEN(ptr);
6118 else
6119 len = *lenp;
6120 if (len == 0)
6121 return vim_strsave((char_u *)"");
6123 switch (vcp->vc_type)
6125 case CONV_TO_UTF8: /* latin1 to utf-8 conversion */
6126 retval = alloc(len * 2 + 1);
6127 if (retval == NULL)
6128 break;
6129 d = retval;
6130 for (i = 0; i < len; ++i)
6132 c = ptr[i];
6133 if (c < 0x80)
6134 *d++ = c;
6135 else
6137 *d++ = 0xc0 + ((unsigned)c >> 6);
6138 *d++ = 0x80 + (c & 0x3f);
6141 *d = NUL;
6142 if (lenp != NULL)
6143 *lenp = (int)(d - retval);
6144 break;
6146 case CONV_9_TO_UTF8: /* latin9 to utf-8 conversion */
6147 retval = alloc(len * 3 + 1);
6148 if (retval == NULL)
6149 break;
6150 d = retval;
6151 for (i = 0; i < len; ++i)
6153 c = ptr[i];
6154 switch (c)
6156 case 0xa4: c = 0x20ac; break; /* euro */
6157 case 0xa6: c = 0x0160; break; /* S hat */
6158 case 0xa8: c = 0x0161; break; /* S -hat */
6159 case 0xb4: c = 0x017d; break; /* Z hat */
6160 case 0xb8: c = 0x017e; break; /* Z -hat */
6161 case 0xbc: c = 0x0152; break; /* OE */
6162 case 0xbd: c = 0x0153; break; /* oe */
6163 case 0xbe: c = 0x0178; break; /* Y */
6165 d += utf_char2bytes(c, d);
6167 *d = NUL;
6168 if (lenp != NULL)
6169 *lenp = (int)(d - retval);
6170 break;
6172 case CONV_TO_LATIN1: /* utf-8 to latin1 conversion */
6173 case CONV_TO_LATIN9: /* utf-8 to latin9 conversion */
6174 retval = alloc(len + 1);
6175 if (retval == NULL)
6176 break;
6177 d = retval;
6178 for (i = 0; i < len; ++i)
6180 l = utf_ptr2len(ptr + i);
6181 if (l == 0)
6182 *d++ = NUL;
6183 else if (l == 1)
6185 if (unconvlenp != NULL && utf8len_tab[ptr[i]] > len - i)
6187 /* Incomplete sequence at the end. */
6188 *unconvlenp = len - i;
6189 break;
6191 *d++ = ptr[i];
6193 else
6195 c = utf_ptr2char(ptr + i);
6196 if (vcp->vc_type == CONV_TO_LATIN9)
6197 switch (c)
6199 case 0x20ac: c = 0xa4; break; /* euro */
6200 case 0x0160: c = 0xa6; break; /* S hat */
6201 case 0x0161: c = 0xa8; break; /* S -hat */
6202 case 0x017d: c = 0xb4; break; /* Z hat */
6203 case 0x017e: c = 0xb8; break; /* Z -hat */
6204 case 0x0152: c = 0xbc; break; /* OE */
6205 case 0x0153: c = 0xbd; break; /* oe */
6206 case 0x0178: c = 0xbe; break; /* Y */
6207 case 0xa4:
6208 case 0xa6:
6209 case 0xa8:
6210 case 0xb4:
6211 case 0xb8:
6212 case 0xbc:
6213 case 0xbd:
6214 case 0xbe: c = 0x100; break; /* not in latin9 */
6216 if (!utf_iscomposing(c)) /* skip composing chars */
6218 if (c < 0x100)
6219 *d++ = c;
6220 else if (vcp->vc_fail)
6222 vim_free(retval);
6223 return NULL;
6225 else
6227 *d++ = 0xbf;
6228 if (utf_char2cells(c) > 1)
6229 *d++ = '?';
6232 i += l - 1;
6235 *d = NUL;
6236 if (lenp != NULL)
6237 *lenp = (int)(d - retval);
6238 break;
6240 # ifdef MACOS_CONVERT
6241 case CONV_MAC_LATIN1:
6242 retval = mac_string_convert(ptr, len, lenp, vcp->vc_fail,
6243 'm', 'l', unconvlenp);
6244 break;
6246 case CONV_LATIN1_MAC:
6247 retval = mac_string_convert(ptr, len, lenp, vcp->vc_fail,
6248 'l', 'm', unconvlenp);
6249 break;
6251 case CONV_MAC_UTF8:
6252 retval = mac_string_convert(ptr, len, lenp, vcp->vc_fail,
6253 'm', 'u', unconvlenp);
6254 break;
6256 case CONV_UTF8_MAC:
6257 retval = mac_string_convert(ptr, len, lenp, vcp->vc_fail,
6258 'u', 'm', unconvlenp);
6259 break;
6260 # endif
6262 # ifdef USE_ICONV
6263 case CONV_ICONV: /* conversion with output_conv.vc_fd */
6264 retval = iconv_string(vcp, ptr, len, unconvlenp, lenp);
6265 break;
6266 # endif
6267 # ifdef WIN3264
6268 case CONV_CODEPAGE: /* codepage -> codepage */
6270 int retlen;
6271 int tmp_len;
6272 short_u *tmp;
6274 /* 1. codepage/UTF-8 -> ucs-2. */
6275 if (vcp->vc_cpfrom == 0)
6276 tmp_len = utf8_to_utf16(ptr, len, NULL, NULL);
6277 else
6278 tmp_len = MultiByteToWideChar(vcp->vc_cpfrom, 0,
6279 ptr, len, 0, 0);
6280 tmp = (short_u *)alloc(sizeof(short_u) * tmp_len);
6281 if (tmp == NULL)
6282 break;
6283 if (vcp->vc_cpfrom == 0)
6284 utf8_to_utf16(ptr, len, tmp, unconvlenp);
6285 else
6286 MultiByteToWideChar(vcp->vc_cpfrom, 0, ptr, len, tmp, tmp_len);
6288 /* 2. ucs-2 -> codepage/UTF-8. */
6289 if (vcp->vc_cpto == 0)
6290 retlen = utf16_to_utf8(tmp, tmp_len, NULL);
6291 else
6292 retlen = WideCharToMultiByte(vcp->vc_cpto, 0,
6293 tmp, tmp_len, 0, 0, 0, 0);
6294 retval = alloc(retlen + 1);
6295 if (retval != NULL)
6297 if (vcp->vc_cpto == 0)
6298 utf16_to_utf8(tmp, tmp_len, retval);
6299 else
6300 WideCharToMultiByte(vcp->vc_cpto, 0,
6301 tmp, tmp_len, retval, retlen, 0, 0);
6302 retval[retlen] = NUL;
6303 if (lenp != NULL)
6304 *lenp = retlen;
6306 vim_free(tmp);
6307 break;
6309 # endif
6312 return retval;
6314 #endif