Merge from mainline.
[bpt/emacs.git] / src / character.c
1 /* Basic character support.
2
3 Copyright (C) 2001-2011 Free Software Foundation, Inc.
4 Copyright (C) 1995, 1997, 1998, 2001 Electrotechnical Laboratory, JAPAN.
5 Licensed to the Free Software Foundation.
6 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
7 National Institute of Advanced Industrial Science and Technology (AIST)
8 Registration Number H13PRO009
9
10 This file is part of GNU Emacs.
11
12 GNU Emacs is free software: you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation, either version 3 of the License, or
15 (at your option) any later version.
16
17 GNU Emacs is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
21
22 You should have received a copy of the GNU General Public License
23 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24
25 /* At first, see the document in `character.h' to understand the code
26 in this file. */
27
28 #ifdef emacs
29 #include <config.h>
30 #endif
31
32 #include <stdio.h>
33
34 #ifdef emacs
35
36 #include <sys/types.h>
37 #include <setjmp.h>
38 #include <intprops.h>
39 #include "lisp.h"
40 #include "character.h"
41 #include "buffer.h"
42 #include "charset.h"
43 #include "composite.h"
44 #include "disptab.h"
45
46 #else /* not emacs */
47
48 #include "mulelib.h"
49
50 #endif /* emacs */
51
52 Lisp_Object Qcharacterp;
53
54 static Lisp_Object Qauto_fill_chars;
55
56 /* Char-table of information about which character to unify to which
57 Unicode character. Mainly used by the macro MAYBE_UNIFY_CHAR. */
58 Lisp_Object Vchar_unify_table;
59
60 /* Variable used locally in the macro FETCH_MULTIBYTE_CHAR. */
61 unsigned char *_fetch_multibyte_char_p;
62
63 static Lisp_Object Qchar_script_table;
64
65 \f
66
67 /* If character code C has modifier masks, reflect them to the
68 character code if possible. Return the resulting code. */
69
70 int
71 char_resolve_modifier_mask (int c)
72 {
73 /* A non-ASCII character can't reflect modifier bits to the code. */
74 if (! ASCII_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
75 return c;
76
77 /* For Meta, Shift, and Control modifiers, we need special care. */
78 if (c & CHAR_SHIFT)
79 {
80 /* Shift modifier is valid only with [A-Za-z]. */
81 if ((c & 0377) >= 'A' && (c & 0377) <= 'Z')
82 c &= ~CHAR_SHIFT;
83 else if ((c & 0377) >= 'a' && (c & 0377) <= 'z')
84 c = (c & ~CHAR_SHIFT) - ('a' - 'A');
85 /* Shift modifier for control characters and SPC is ignored. */
86 else if ((c & ~CHAR_MODIFIER_MASK) <= 0x20)
87 c &= ~CHAR_SHIFT;
88 }
89 if (c & CHAR_CTL)
90 {
91 /* Simulate the code in lread.c. */
92 /* Allow `\C- ' and `\C-?'. */
93 if ((c & 0377) == ' ')
94 c &= ~0177 & ~ CHAR_CTL;
95 else if ((c & 0377) == '?')
96 c = 0177 | (c & ~0177 & ~CHAR_CTL);
97 /* ASCII control chars are made from letters (both cases),
98 as well as the non-letters within 0100...0137. */
99 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
100 c &= (037 | (~0177 & ~CHAR_CTL));
101 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
102 c &= (037 | (~0177 & ~CHAR_CTL));
103 }
104 #if 0 /* This is outside the scope of this function. (bug#4751) */
105 if (c & CHAR_META)
106 {
107 /* Move the meta bit to the right place for a string. */
108 c = (c & ~CHAR_META) | 0x80;
109 }
110 #endif
111
112 return c;
113 }
114
115
116 /* Store multibyte form of character C at P. If C has modifier bits,
117 handle them appropriately. */
118
119 int
120 char_string (unsigned int c, unsigned char *p)
121 {
122 int bytes;
123
124 if (c & CHAR_MODIFIER_MASK)
125 {
126 c = (unsigned) char_resolve_modifier_mask ((int) c);
127 /* If C still has any modifier bits, just ignore it. */
128 c &= ~CHAR_MODIFIER_MASK;
129 }
130
131 MAYBE_UNIFY_CHAR (c);
132
133 if (c <= MAX_3_BYTE_CHAR)
134 {
135 bytes = CHAR_STRING (c, p);
136 }
137 else if (c <= MAX_4_BYTE_CHAR)
138 {
139 p[0] = (0xF0 | (c >> 18));
140 p[1] = (0x80 | ((c >> 12) & 0x3F));
141 p[2] = (0x80 | ((c >> 6) & 0x3F));
142 p[3] = (0x80 | (c & 0x3F));
143 bytes = 4;
144 }
145 else if (c <= MAX_5_BYTE_CHAR)
146 {
147 p[0] = 0xF8;
148 p[1] = (0x80 | ((c >> 18) & 0x0F));
149 p[2] = (0x80 | ((c >> 12) & 0x3F));
150 p[3] = (0x80 | ((c >> 6) & 0x3F));
151 p[4] = (0x80 | (c & 0x3F));
152 bytes = 5;
153 }
154 else if (c <= MAX_CHAR)
155 {
156 c = CHAR_TO_BYTE8 (c);
157 bytes = BYTE8_STRING (c, p);
158 }
159 else
160 error ("Invalid character: %x", c);
161
162 return bytes;
163 }
164
165
166 /* Return a character whose multibyte form is at P. If LEN is not
167 NULL, it must be a pointer to integer. In that case, set *LEN to
168 the byte length of the multibyte form. If ADVANCED is not NULL, it
169 must be a pointer to unsigned char. In that case, set *ADVANCED to
170 the ending address (i.e., the starting address of the next
171 character) of the multibyte form. */
172
173 int
174 string_char (const unsigned char *p, const unsigned char **advanced, int *len)
175 {
176 int c;
177 const unsigned char *saved_p = p;
178
179 if (*p < 0x80 || ! (*p & 0x20) || ! (*p & 0x10))
180 {
181 c = STRING_CHAR_ADVANCE (p);
182 }
183 else if (! (*p & 0x08))
184 {
185 c = ((((p)[0] & 0xF) << 18)
186 | (((p)[1] & 0x3F) << 12)
187 | (((p)[2] & 0x3F) << 6)
188 | ((p)[3] & 0x3F));
189 p += 4;
190 }
191 else
192 {
193 c = ((((p)[1] & 0x3F) << 18)
194 | (((p)[2] & 0x3F) << 12)
195 | (((p)[3] & 0x3F) << 6)
196 | ((p)[4] & 0x3F));
197 p += 5;
198 }
199
200 MAYBE_UNIFY_CHAR (c);
201
202 if (len)
203 *len = p - saved_p;
204 if (advanced)
205 *advanced = p;
206 return c;
207 }
208
209
210 /* Translate character C by translation table TABLE. If no translation is
211 found in TABLE, return the untranslated character. If TABLE is a list,
212 elements are char tables. In that case, recursively translate C by all the
213 tables in the list. */
214
215 int
216 translate_char (Lisp_Object table, int c)
217 {
218 if (CHAR_TABLE_P (table))
219 {
220 Lisp_Object ch;
221
222 ch = CHAR_TABLE_REF (table, c);
223 if (CHARACTERP (ch))
224 c = XINT (ch);
225 }
226 else
227 {
228 for (; CONSP (table); table = XCDR (table))
229 c = translate_char (XCAR (table), c);
230 }
231 return c;
232 }
233
234 /* Convert ASCII or 8-bit character C to unibyte. If C is none of
235 them, return (C & 0xFF). */
236
237 int
238 multibyte_char_to_unibyte (int c)
239 {
240 if (c < 0x80)
241 return c;
242 if (CHAR_BYTE8_P (c))
243 return CHAR_TO_BYTE8 (c);
244 return (c & 0xFF);
245 }
246
247 /* Like multibyte_char_to_unibyte, but return -1 if C is not supported
248 by charset_unibyte. */
249
250 int
251 multibyte_char_to_unibyte_safe (int c)
252 {
253 if (c < 0x80)
254 return c;
255 if (CHAR_BYTE8_P (c))
256 return CHAR_TO_BYTE8 (c);
257 return -1;
258 }
259
260 DEFUN ("characterp", Fcharacterp, Scharacterp, 1, 2, 0,
261 doc: /* Return non-nil if OBJECT is a character. */)
262 (Lisp_Object object, Lisp_Object ignore)
263 {
264 return (CHARACTERP (object) ? Qt : Qnil);
265 }
266
267 DEFUN ("max-char", Fmax_char, Smax_char, 0, 0, 0,
268 doc: /* Return the character of the maximum code. */)
269 (void)
270 {
271 return make_number (MAX_CHAR);
272 }
273
274 DEFUN ("unibyte-char-to-multibyte", Funibyte_char_to_multibyte,
275 Sunibyte_char_to_multibyte, 1, 1, 0,
276 doc: /* Convert the byte CH to multibyte character. */)
277 (Lisp_Object ch)
278 {
279 int c;
280
281 CHECK_CHARACTER (ch);
282 c = XFASTINT (ch);
283 if (c >= 0x100)
284 error ("Not a unibyte character: %d", c);
285 MAKE_CHAR_MULTIBYTE (c);
286 return make_number (c);
287 }
288
289 DEFUN ("multibyte-char-to-unibyte", Fmultibyte_char_to_unibyte,
290 Smultibyte_char_to_unibyte, 1, 1, 0,
291 doc: /* Convert the multibyte character CH to a byte.
292 If the multibyte character does not represent a byte, return -1. */)
293 (Lisp_Object ch)
294 {
295 int cm;
296
297 CHECK_CHARACTER (ch);
298 cm = XFASTINT (ch);
299 if (cm < 256)
300 /* Can't distinguish a byte read from a unibyte buffer from
301 a latin1 char, so let's let it slide. */
302 return ch;
303 else
304 {
305 int cu = CHAR_TO_BYTE_SAFE (cm);
306 return make_number (cu);
307 }
308 }
309
310 DEFUN ("char-width", Fchar_width, Schar_width, 1, 1, 0,
311 doc: /* Return width of CHAR when displayed in the current buffer.
312 The width is measured by how many columns it occupies on the screen.
313 Tab is taken to occupy `tab-width' columns.
314 usage: (char-width CHAR) */)
315 (Lisp_Object ch)
316 {
317 Lisp_Object disp;
318 int c, width;
319 struct Lisp_Char_Table *dp = buffer_display_table ();
320
321 CHECK_CHARACTER (ch);
322 c = XINT (ch);
323
324 /* Get the way the display table would display it. */
325 disp = dp ? DISP_CHAR_VECTOR (dp, c) : Qnil;
326
327 if (VECTORP (disp))
328 width = ASIZE (disp);
329 else
330 width = CHAR_WIDTH (c);
331
332 return make_number (width);
333 }
334
335 /* Return width of string STR of length LEN when displayed in the
336 current buffer. The width is measured by how many columns it
337 occupies on the screen. If PRECISION > 0, return the width of
338 longest substring that doesn't exceed PRECISION, and set number of
339 characters and bytes of the substring in *NCHARS and *NBYTES
340 respectively. */
341
342 EMACS_INT
343 c_string_width (const unsigned char *str, EMACS_INT len, int precision,
344 EMACS_INT *nchars, EMACS_INT *nbytes)
345 {
346 EMACS_INT i = 0, i_byte = 0;
347 EMACS_INT width = 0;
348 struct Lisp_Char_Table *dp = buffer_display_table ();
349
350 while (i_byte < len)
351 {
352 int bytes, thiswidth;
353 Lisp_Object val;
354 int c = STRING_CHAR_AND_LENGTH (str + i_byte, bytes);
355
356 if (dp)
357 {
358 val = DISP_CHAR_VECTOR (dp, c);
359 if (VECTORP (val))
360 thiswidth = ASIZE (val);
361 else
362 thiswidth = CHAR_WIDTH (c);
363 }
364 else
365 {
366 thiswidth = CHAR_WIDTH (c);
367 }
368
369 if (precision > 0
370 && (width + thiswidth > precision))
371 {
372 *nchars = i;
373 *nbytes = i_byte;
374 return width;
375 }
376 i++;
377 i_byte += bytes;
378 width += thiswidth;
379 }
380
381 if (precision > 0)
382 {
383 *nchars = i;
384 *nbytes = i_byte;
385 }
386
387 return width;
388 }
389
390 /* Return width of string STR of length LEN when displayed in the
391 current buffer. The width is measured by how many columns it
392 occupies on the screen. */
393
394 EMACS_INT
395 strwidth (const char *str, EMACS_INT len)
396 {
397 return c_string_width ((const unsigned char *) str, len, -1, NULL, NULL);
398 }
399
400 /* Return width of Lisp string STRING when displayed in the current
401 buffer. The width is measured by how many columns it occupies on
402 the screen while paying attention to compositions. If PRECISION >
403 0, return the width of longest substring that doesn't exceed
404 PRECISION, and set number of characters and bytes of the substring
405 in *NCHARS and *NBYTES respectively. */
406
407 EMACS_INT
408 lisp_string_width (Lisp_Object string, EMACS_INT precision,
409 EMACS_INT *nchars, EMACS_INT *nbytes)
410 {
411 EMACS_INT len = SCHARS (string);
412 /* This set multibyte to 0 even if STRING is multibyte when it
413 contains only ascii and eight-bit-graphic, but that's
414 intentional. */
415 int multibyte = len < SBYTES (string);
416 unsigned char *str = SDATA (string);
417 EMACS_INT i = 0, i_byte = 0;
418 EMACS_INT width = 0;
419 struct Lisp_Char_Table *dp = buffer_display_table ();
420
421 while (i < len)
422 {
423 EMACS_INT chars, bytes, thiswidth;
424 Lisp_Object val;
425 int cmp_id;
426 EMACS_INT ignore, end;
427
428 if (find_composition (i, -1, &ignore, &end, &val, string)
429 && ((cmp_id = get_composition_id (i, i_byte, end - i, val, string))
430 >= 0))
431 {
432 thiswidth = composition_table[cmp_id]->width;
433 chars = end - i;
434 bytes = string_char_to_byte (string, end) - i_byte;
435 }
436 else
437 {
438 int c;
439
440 if (multibyte)
441 {
442 int cbytes;
443 c = STRING_CHAR_AND_LENGTH (str + i_byte, cbytes);
444 bytes = cbytes;
445 }
446 else
447 c = str[i_byte], bytes = 1;
448 chars = 1;
449 if (dp)
450 {
451 val = DISP_CHAR_VECTOR (dp, c);
452 if (VECTORP (val))
453 thiswidth = ASIZE (val);
454 else
455 thiswidth = CHAR_WIDTH (c);
456 }
457 else
458 {
459 thiswidth = CHAR_WIDTH (c);
460 }
461 }
462
463 if (precision <= 0)
464 {
465 #ifdef emacs
466 if (INT_ADD_OVERFLOW (width, thiswidth))
467 string_overflow ();
468 #endif
469 }
470 else if (precision - width < thiswidth)
471 {
472 *nchars = i;
473 *nbytes = i_byte;
474 return width;
475 }
476 i += chars;
477 i_byte += bytes;
478 width += thiswidth;
479 }
480
481 if (precision > 0)
482 {
483 *nchars = i;
484 *nbytes = i_byte;
485 }
486
487 return width;
488 }
489
490 DEFUN ("string-width", Fstring_width, Sstring_width, 1, 1, 0,
491 doc: /* Return width of STRING when displayed in the current buffer.
492 Width is measured by how many columns it occupies on the screen.
493 When calculating width of a multibyte character in STRING,
494 only the base leading-code is considered; the validity of
495 the following bytes is not checked. Tabs in STRING are always
496 taken to occupy `tab-width' columns.
497 usage: (string-width STRING) */)
498 (Lisp_Object str)
499 {
500 Lisp_Object val;
501
502 CHECK_STRING (str);
503 XSETFASTINT (val, lisp_string_width (str, -1, NULL, NULL));
504 return val;
505 }
506
507 /* Return the number of characters in the NBYTES bytes at PTR.
508 This works by looking at the contents and checking for multibyte
509 sequences while assuming that there's no invalid sequence.
510 However, if the current buffer has enable-multibyte-characters =
511 nil, we treat each byte as a character. */
512
513 EMACS_INT
514 chars_in_text (const unsigned char *ptr, EMACS_INT nbytes)
515 {
516 /* current_buffer is null at early stages of Emacs initialization. */
517 if (current_buffer == 0
518 || NILP (BVAR (current_buffer, enable_multibyte_characters)))
519 return nbytes;
520
521 return multibyte_chars_in_text (ptr, nbytes);
522 }
523
524 /* Return the number of characters in the NBYTES bytes at PTR.
525 This works by looking at the contents and checking for multibyte
526 sequences while assuming that there's no invalid sequence. It
527 ignores enable-multibyte-characters. */
528
529 EMACS_INT
530 multibyte_chars_in_text (const unsigned char *ptr, EMACS_INT nbytes)
531 {
532 const unsigned char *endp = ptr + nbytes;
533 EMACS_INT chars = 0;
534
535 while (ptr < endp)
536 {
537 EMACS_INT len = MULTIBYTE_LENGTH (ptr, endp);
538
539 if (len == 0)
540 abort ();
541 ptr += len;
542 chars++;
543 }
544
545 return chars;
546 }
547
548 /* Parse unibyte text at STR of LEN bytes as a multibyte text, count
549 characters and bytes in it, and store them in *NCHARS and *NBYTES
550 respectively. On counting bytes, pay attention to that 8-bit
551 characters not constructing a valid multibyte sequence are
552 represented by 2-byte in a multibyte text. */
553
554 void
555 parse_str_as_multibyte (const unsigned char *str, EMACS_INT len,
556 EMACS_INT *nchars, EMACS_INT *nbytes)
557 {
558 const unsigned char *endp = str + len;
559 EMACS_INT n, chars = 0, bytes = 0;
560
561 if (len >= MAX_MULTIBYTE_LENGTH)
562 {
563 const unsigned char *adjusted_endp = endp - MAX_MULTIBYTE_LENGTH;
564 while (str < adjusted_endp)
565 {
566 if (! CHAR_BYTE8_HEAD_P (*str)
567 && (n = MULTIBYTE_LENGTH_NO_CHECK (str)) > 0)
568 str += n, bytes += n;
569 else
570 str++, bytes += 2;
571 chars++;
572 }
573 }
574 while (str < endp)
575 {
576 if (! CHAR_BYTE8_HEAD_P (*str)
577 && (n = MULTIBYTE_LENGTH (str, endp)) > 0)
578 str += n, bytes += n;
579 else
580 str++, bytes += 2;
581 chars++;
582 }
583
584 *nchars = chars;
585 *nbytes = bytes;
586 return;
587 }
588
589 /* Arrange unibyte text at STR of NBYTES bytes as a multibyte text.
590 It actually converts only such 8-bit characters that don't contruct
591 a multibyte sequence to multibyte forms of Latin-1 characters. If
592 NCHARS is nonzero, set *NCHARS to the number of characters in the
593 text. It is assured that we can use LEN bytes at STR as a work
594 area and that is enough. Return the number of bytes of the
595 resulting text. */
596
597 EMACS_INT
598 str_as_multibyte (unsigned char *str, EMACS_INT len, EMACS_INT nbytes,
599 EMACS_INT *nchars)
600 {
601 unsigned char *p = str, *endp = str + nbytes;
602 unsigned char *to;
603 EMACS_INT chars = 0;
604 int n;
605
606 if (nbytes >= MAX_MULTIBYTE_LENGTH)
607 {
608 unsigned char *adjusted_endp = endp - MAX_MULTIBYTE_LENGTH;
609 while (p < adjusted_endp
610 && ! CHAR_BYTE8_HEAD_P (*p)
611 && (n = MULTIBYTE_LENGTH_NO_CHECK (p)) > 0)
612 p += n, chars++;
613 }
614 while (p < endp
615 && ! CHAR_BYTE8_HEAD_P (*p)
616 && (n = MULTIBYTE_LENGTH (p, endp)) > 0)
617 p += n, chars++;
618 if (nchars)
619 *nchars = chars;
620 if (p == endp)
621 return nbytes;
622
623 to = p;
624 nbytes = endp - p;
625 endp = str + len;
626 memmove (endp - nbytes, p, nbytes);
627 p = endp - nbytes;
628
629 if (nbytes >= MAX_MULTIBYTE_LENGTH)
630 {
631 unsigned char *adjusted_endp = endp - MAX_MULTIBYTE_LENGTH;
632 while (p < adjusted_endp)
633 {
634 if (! CHAR_BYTE8_HEAD_P (*p)
635 && (n = MULTIBYTE_LENGTH_NO_CHECK (p)) > 0)
636 {
637 while (n--)
638 *to++ = *p++;
639 }
640 else
641 {
642 int c = *p++;
643 c = BYTE8_TO_CHAR (c);
644 to += CHAR_STRING (c, to);
645 }
646 }
647 chars++;
648 }
649 while (p < endp)
650 {
651 if (! CHAR_BYTE8_HEAD_P (*p)
652 && (n = MULTIBYTE_LENGTH (p, endp)) > 0)
653 {
654 while (n--)
655 *to++ = *p++;
656 }
657 else
658 {
659 int c = *p++;
660 c = BYTE8_TO_CHAR (c);
661 to += CHAR_STRING (c, to);
662 }
663 chars++;
664 }
665 if (nchars)
666 *nchars = chars;
667 return (to - str);
668 }
669
670 /* Parse unibyte string at STR of LEN bytes, and return the number of
671 bytes it may ocupy when converted to multibyte string by
672 `str_to_multibyte'. */
673
674 EMACS_INT
675 parse_str_to_multibyte (const unsigned char *str, EMACS_INT len)
676 {
677 const unsigned char *endp = str + len;
678 EMACS_INT bytes;
679
680 for (bytes = 0; str < endp; str++)
681 bytes += (*str < 0x80) ? 1 : 2;
682 return bytes;
683 }
684
685
686 /* Convert unibyte text at STR of BYTES bytes to a multibyte text
687 that contains the same single-byte characters. It actually
688 converts all 8-bit characters to multibyte forms. It is assured
689 that we can use LEN bytes at STR as a work area and that is
690 enough. */
691
692 EMACS_INT
693 str_to_multibyte (unsigned char *str, EMACS_INT len, EMACS_INT bytes)
694 {
695 unsigned char *p = str, *endp = str + bytes;
696 unsigned char *to;
697
698 while (p < endp && *p < 0x80) p++;
699 if (p == endp)
700 return bytes;
701 to = p;
702 bytes = endp - p;
703 endp = str + len;
704 memmove (endp - bytes, p, bytes);
705 p = endp - bytes;
706 while (p < endp)
707 {
708 int c = *p++;
709
710 if (c >= 0x80)
711 c = BYTE8_TO_CHAR (c);
712 to += CHAR_STRING (c, to);
713 }
714 return (to - str);
715 }
716
717 /* Arrange multibyte text at STR of LEN bytes as a unibyte text. It
718 actually converts characters in the range 0x80..0xFF to
719 unibyte. */
720
721 EMACS_INT
722 str_as_unibyte (unsigned char *str, EMACS_INT bytes)
723 {
724 const unsigned char *p = str, *endp = str + bytes;
725 unsigned char *to;
726 int c, len;
727
728 while (p < endp)
729 {
730 c = *p;
731 len = BYTES_BY_CHAR_HEAD (c);
732 if (CHAR_BYTE8_HEAD_P (c))
733 break;
734 p += len;
735 }
736 to = str + (p - str);
737 while (p < endp)
738 {
739 c = *p;
740 len = BYTES_BY_CHAR_HEAD (c);
741 if (CHAR_BYTE8_HEAD_P (c))
742 {
743 c = STRING_CHAR_ADVANCE (p);
744 *to++ = CHAR_TO_BYTE8 (c);
745 }
746 else
747 {
748 while (len--) *to++ = *p++;
749 }
750 }
751 return (to - str);
752 }
753
754 /* Convert eight-bit chars in SRC (in multibyte form) to the
755 corresponding byte and store in DST. CHARS is the number of
756 characters in SRC. The value is the number of bytes stored in DST.
757 Usually, the value is the same as CHARS, but is less than it if SRC
758 contains a non-ASCII, non-eight-bit character. If ACCEPT_LATIN_1
759 is nonzero, a Latin-1 character is accepted and converted to a byte
760 of that character code.
761 Note: Currently the arg ACCEPT_LATIN_1 is not used. */
762
763 EMACS_INT
764 str_to_unibyte (const unsigned char *src, unsigned char *dst, EMACS_INT chars, int accept_latin_1)
765 {
766 EMACS_INT i;
767
768 for (i = 0; i < chars; i++)
769 {
770 int c = STRING_CHAR_ADVANCE (src);
771
772 if (CHAR_BYTE8_P (c))
773 c = CHAR_TO_BYTE8 (c);
774 else if (! ASCII_CHAR_P (c)
775 && (! accept_latin_1 || c >= 0x100))
776 return i;
777 *dst++ = c;
778 }
779 return i;
780 }
781
782
783 static EMACS_INT
784 string_count_byte8 (Lisp_Object string)
785 {
786 int multibyte = STRING_MULTIBYTE (string);
787 EMACS_INT nbytes = SBYTES (string);
788 unsigned char *p = SDATA (string);
789 unsigned char *pend = p + nbytes;
790 EMACS_INT count = 0;
791 int c, len;
792
793 if (multibyte)
794 while (p < pend)
795 {
796 c = *p;
797 len = BYTES_BY_CHAR_HEAD (c);
798
799 if (CHAR_BYTE8_HEAD_P (c))
800 count++;
801 p += len;
802 }
803 else
804 while (p < pend)
805 {
806 if (*p++ >= 0x80)
807 count++;
808 }
809 return count;
810 }
811
812
813 Lisp_Object
814 string_escape_byte8 (Lisp_Object string)
815 {
816 EMACS_INT nchars = SCHARS (string);
817 EMACS_INT nbytes = SBYTES (string);
818 int multibyte = STRING_MULTIBYTE (string);
819 EMACS_INT byte8_count;
820 const unsigned char *src, *src_end;
821 unsigned char *dst;
822 Lisp_Object val;
823 int c, len;
824
825 if (multibyte && nchars == nbytes)
826 return string;
827
828 byte8_count = string_count_byte8 (string);
829
830 if (byte8_count == 0)
831 return string;
832
833 if (multibyte)
834 {
835 if ((MOST_POSITIVE_FIXNUM - nchars) / 3 < byte8_count
836 || (MOST_POSITIVE_FIXNUM - nbytes) / 2 < byte8_count)
837 string_overflow ();
838
839 /* Convert 2-byte sequence of byte8 chars to 4-byte octal. */
840 val = make_uninit_multibyte_string (nchars + byte8_count * 3,
841 nbytes + byte8_count * 2);
842 }
843 else
844 {
845 if ((MOST_POSITIVE_FIXNUM - nchars) / 3 < byte8_count)
846 string_overflow ();
847
848 /* Convert 1-byte sequence of byte8 chars to 4-byte octal. */
849 val = make_uninit_string (nbytes + byte8_count * 3);
850 }
851
852 src = SDATA (string);
853 src_end = src + nbytes;
854 dst = SDATA (val);
855 if (multibyte)
856 while (src < src_end)
857 {
858 c = *src;
859 len = BYTES_BY_CHAR_HEAD (c);
860
861 if (CHAR_BYTE8_HEAD_P (c))
862 {
863 c = STRING_CHAR_ADVANCE (src);
864 c = CHAR_TO_BYTE8 (c);
865 sprintf ((char *) dst, "\\%03o", c);
866 dst += 4;
867 }
868 else
869 while (len--) *dst++ = *src++;
870 }
871 else
872 while (src < src_end)
873 {
874 c = *src++;
875 if (c >= 0x80)
876 {
877 sprintf ((char *) dst, "\\%03o", c);
878 dst += 4;
879 }
880 else
881 *dst++ = c;
882 }
883 return val;
884 }
885
886 \f
887 DEFUN ("string", Fstring, Sstring, 0, MANY, 0,
888 doc: /*
889 Concatenate all the argument characters and make the result a string.
890 usage: (string &rest CHARACTERS) */)
891 (size_t n, Lisp_Object *args)
892 {
893 size_t i;
894 int c;
895 unsigned char *buf, *p;
896 Lisp_Object str;
897 USE_SAFE_ALLOCA;
898
899 SAFE_ALLOCA (buf, unsigned char *, MAX_MULTIBYTE_LENGTH * n);
900 p = buf;
901
902 for (i = 0; i < n; i++)
903 {
904 CHECK_CHARACTER (args[i]);
905 c = XINT (args[i]);
906 p += CHAR_STRING (c, p);
907 }
908
909 str = make_string_from_bytes ((char *) buf, n, p - buf);
910 SAFE_FREE ();
911 return str;
912 }
913
914 DEFUN ("unibyte-string", Funibyte_string, Sunibyte_string, 0, MANY, 0,
915 doc: /* Concatenate all the argument bytes and make the result a unibyte string.
916 usage: (unibyte-string &rest BYTES) */)
917 (size_t n, Lisp_Object *args)
918 {
919 size_t i;
920 int c;
921 unsigned char *buf, *p;
922 Lisp_Object str;
923 USE_SAFE_ALLOCA;
924
925 SAFE_ALLOCA (buf, unsigned char *, n);
926 p = buf;
927
928 for (i = 0; i < n; i++)
929 {
930 CHECK_NATNUM (args[i]);
931 c = XFASTINT (args[i]);
932 if (c >= 256)
933 args_out_of_range_3 (args[i], make_number (0), make_number (255));
934 *p++ = c;
935 }
936
937 str = make_string_from_bytes ((char *) buf, n, p - buf);
938 SAFE_FREE ();
939 return str;
940 }
941
942 DEFUN ("char-resolve-modifiers", Fchar_resolve_modifiers,
943 Schar_resolve_modifiers, 1, 1, 0,
944 doc: /* Resolve modifiers in the character CHAR.
945 The value is a character with modifiers resolved into the character
946 code. Unresolved modifiers are kept in the value.
947 usage: (char-resolve-modifiers CHAR) */)
948 (Lisp_Object character)
949 {
950 int c;
951
952 CHECK_NUMBER (character);
953 c = XINT (character);
954 return make_number (char_resolve_modifier_mask (c));
955 }
956
957 DEFUN ("get-byte", Fget_byte, Sget_byte, 0, 2, 0,
958 doc: /* Return a byte value of a character at point.
959 Optional 1st arg POSITION, if non-nil, is a position of a character to get
960 a byte value.
961 Optional 2nd arg STRING, if non-nil, is a string of which first
962 character is a target to get a byte value. In this case, POSITION, if
963 non-nil, is an index of a target character in the string.
964
965 If the current buffer (or STRING) is multibyte, and the target
966 character is not ASCII nor 8-bit character, an error is signalled. */)
967 (Lisp_Object position, Lisp_Object string)
968 {
969 int c;
970 EMACS_INT pos;
971 unsigned char *p;
972
973 if (NILP (string))
974 {
975 if (NILP (position))
976 {
977 p = PT_ADDR;
978 }
979 else
980 {
981 CHECK_NUMBER_COERCE_MARKER (position);
982 if (XINT (position) < BEGV || XINT (position) >= ZV)
983 args_out_of_range_3 (position, make_number (BEGV), make_number (ZV));
984 pos = XFASTINT (position);
985 p = CHAR_POS_ADDR (pos);
986 }
987 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
988 return make_number (*p);
989 }
990 else
991 {
992 CHECK_STRING (string);
993 if (NILP (position))
994 {
995 p = SDATA (string);
996 }
997 else
998 {
999 CHECK_NATNUM (position);
1000 if (XINT (position) >= SCHARS (string))
1001 args_out_of_range (string, position);
1002 pos = XFASTINT (position);
1003 p = SDATA (string) + string_char_to_byte (string, pos);
1004 }
1005 if (! STRING_MULTIBYTE (string))
1006 return make_number (*p);
1007 }
1008 c = STRING_CHAR (p);
1009 if (CHAR_BYTE8_P (c))
1010 c = CHAR_TO_BYTE8 (c);
1011 else if (! ASCII_CHAR_P (c))
1012 error ("Not an ASCII nor an 8-bit character: %d", c);
1013 return make_number (c);
1014 }
1015
1016
1017 void
1018 init_character_once (void)
1019 {
1020 }
1021
1022 #ifdef emacs
1023
1024 void
1025 syms_of_character (void)
1026 {
1027 DEFSYM (Qcharacterp, "characterp");
1028 DEFSYM (Qauto_fill_chars, "auto-fill-chars");
1029
1030 staticpro (&Vchar_unify_table);
1031 Vchar_unify_table = Qnil;
1032
1033 defsubr (&Smax_char);
1034 defsubr (&Scharacterp);
1035 defsubr (&Sunibyte_char_to_multibyte);
1036 defsubr (&Smultibyte_char_to_unibyte);
1037 defsubr (&Schar_width);
1038 defsubr (&Sstring_width);
1039 defsubr (&Sstring);
1040 defsubr (&Sunibyte_string);
1041 defsubr (&Schar_resolve_modifiers);
1042 defsubr (&Sget_byte);
1043
1044 DEFVAR_LISP ("translation-table-vector", Vtranslation_table_vector,
1045 doc: /*
1046 Vector recording all translation tables ever defined.
1047 Each element is a pair (SYMBOL . TABLE) relating the table to the
1048 symbol naming it. The ID of a translation table is an index into this vector. */);
1049 Vtranslation_table_vector = Fmake_vector (make_number (16), Qnil);
1050
1051 DEFVAR_LISP ("auto-fill-chars", Vauto_fill_chars,
1052 doc: /*
1053 A char-table for characters which invoke auto-filling.
1054 Such characters have value t in this table. */);
1055 Vauto_fill_chars = Fmake_char_table (Qauto_fill_chars, Qnil);
1056 CHAR_TABLE_SET (Vauto_fill_chars, ' ', Qt);
1057 CHAR_TABLE_SET (Vauto_fill_chars, '\n', Qt);
1058
1059 DEFVAR_LISP ("char-width-table", Vchar_width_table,
1060 doc: /*
1061 A char-table for width (columns) of each character. */);
1062 Vchar_width_table = Fmake_char_table (Qnil, make_number (1));
1063 char_table_set_range (Vchar_width_table, 0x80, 0x9F, make_number (4));
1064 char_table_set_range (Vchar_width_table, MAX_5_BYTE_CHAR + 1, MAX_CHAR,
1065 make_number (4));
1066
1067 DEFVAR_LISP ("printable-chars", Vprintable_chars,
1068 doc: /* A char-table for each printable character. */);
1069 Vprintable_chars = Fmake_char_table (Qnil, Qnil);
1070 Fset_char_table_range (Vprintable_chars,
1071 Fcons (make_number (32), make_number (126)), Qt);
1072 Fset_char_table_range (Vprintable_chars,
1073 Fcons (make_number (160),
1074 make_number (MAX_5_BYTE_CHAR)), Qt);
1075
1076 DEFVAR_LISP ("char-script-table", Vchar_script_table,
1077 doc: /* Char table of script symbols.
1078 It has one extra slot whose value is a list of script symbols. */);
1079
1080 /* Intern this now in case it isn't already done.
1081 Setting this variable twice is harmless.
1082 But don't staticpro it here--that is done in alloc.c. */
1083 Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
1084 DEFSYM (Qchar_script_table, "char-script-table");
1085 Fput (Qchar_script_table, Qchar_table_extra_slots, make_number (1));
1086 Vchar_script_table = Fmake_char_table (Qchar_script_table, Qnil);
1087
1088 DEFVAR_LISP ("script-representative-chars", Vscript_representative_chars,
1089 doc: /* Alist of scripts vs the representative characters.
1090 Each element is a cons (SCRIPT . CHARS).
1091 SCRIPT is a symbol representing a script or a subgroup of a script.
1092 CHARS is a list or a vector of characters.
1093 If it is a list, all characters in the list are necessary for supporting SCRIPT.
1094 If it is a vector, one of the characters in the vector is necessary.
1095 This variable is used to find a font for a specific script. */);
1096 Vscript_representative_chars = Qnil;
1097
1098 DEFVAR_LISP ("unicode-category-table", Vunicode_category_table,
1099 doc: /* Char table of Unicode's "General Category".
1100 All Unicode characters have one of the following values (symbol):
1101 Lu, Ll, Lt, Lm, Lo, Mn, Mc, Me, Nd, Nl, No, Pc, Pd, Ps, Pe, Pi, Pf, Po,
1102 Sm, Sc, Sk, So, Zs, Zl, Zp, Cc, Cf, Cs, Co, Cn
1103 See The Unicode Standard for the meaning of those values. */);
1104 /* The correct char-table is setup in characters.el. */
1105 Vunicode_category_table = Qnil;
1106 }
1107
1108 #endif /* emacs */