gnus-util.el (gnus-macroexpand-all): Allow optional argument `environment'.
[emacs.git] / src / character.c
blob1c8fae88176abc7fd4386ecfc5f067cdd37e5861
1 /* Basic character support.
2 Copyright (C) 1995, 1997, 1998, 2001 Electrotechnical Laboratory, JAPAN.
3 Licensed to the Free Software Foundation.
4 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
6 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
7 National Institute of Advanced Industrial Science and Technology (AIST)
8 Registration Number H13PRO009
10 This file is part of GNU Emacs.
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.
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.
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/>. */
25 /* At first, see the document in `character.h' to understand the code
26 in this file. */
28 #ifdef emacs
29 #include <config.h>
30 #endif
32 #include <stdio.h>
34 #ifdef emacs
36 #include <sys/types.h>
37 #include <setjmp.h>
38 #include "lisp.h"
39 #include "character.h"
40 #include "buffer.h"
41 #include "charset.h"
42 #include "composite.h"
43 #include "disptab.h"
45 #else /* not emacs */
47 #include "mulelib.h"
49 #endif /* emacs */
51 Lisp_Object Qcharacterp;
53 /* Vector of translation table ever defined.
54 ID of a translation table is used to index this vector. */
55 Lisp_Object Vtranslation_table_vector;
57 /* A char-table for characters which may invoke auto-filling. */
58 Lisp_Object Vauto_fill_chars;
60 Lisp_Object Qauto_fill_chars;
62 /* Char-table of information about which character to unify to which
63 Unicode character. Mainly used by the macro MAYBE_UNIFY_CHAR. */
64 Lisp_Object Vchar_unify_table;
66 /* A char-table. An element is non-nil iff the corresponding
67 character has a printable glyph. */
68 Lisp_Object Vprintable_chars;
70 /* A char-table. An elemnent is a column-width of the corresponding
71 character. */
72 Lisp_Object Vchar_width_table;
74 /* A char-table. An element is a symbol indicating the direction
75 property of corresponding character. */
76 Lisp_Object Vchar_direction_table;
78 /* Variable used locally in the macro FETCH_MULTIBYTE_CHAR. */
79 unsigned char *_fetch_multibyte_char_p;
81 /* Char table of scripts. */
82 Lisp_Object Vchar_script_table;
84 /* Alist of scripts vs representative characters. */
85 Lisp_Object Vscript_representative_chars;
87 static Lisp_Object Qchar_script_table;
89 Lisp_Object Vunicode_category_table;
92 /* If character code C has modifier masks, reflect them to the
93 character code if possible. Return the resulting code. */
95 int
96 char_resolve_modifier_mask (int c)
98 /* A non-ASCII character can't reflect modifier bits to the code. */
99 if (! ASCII_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
100 return c;
102 /* For Meta, Shift, and Control modifiers, we need special care. */
103 if (c & CHAR_SHIFT)
105 /* Shift modifier is valid only with [A-Za-z]. */
106 if ((c & 0377) >= 'A' && (c & 0377) <= 'Z')
107 c &= ~CHAR_SHIFT;
108 else if ((c & 0377) >= 'a' && (c & 0377) <= 'z')
109 c = (c & ~CHAR_SHIFT) - ('a' - 'A');
110 /* Shift modifier for control characters and SPC is ignored. */
111 else if ((c & ~CHAR_MODIFIER_MASK) <= 0x20)
112 c &= ~CHAR_SHIFT;
114 if (c & CHAR_CTL)
116 /* Simulate the code in lread.c. */
117 /* Allow `\C- ' and `\C-?'. */
118 if ((c & 0377) == ' ')
119 c &= ~0177 & ~ CHAR_CTL;
120 else if ((c & 0377) == '?')
121 c = 0177 | (c & ~0177 & ~CHAR_CTL);
122 /* ASCII control chars are made from letters (both cases),
123 as well as the non-letters within 0100...0137. */
124 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
125 c &= (037 | (~0177 & ~CHAR_CTL));
126 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
127 c &= (037 | (~0177 & ~CHAR_CTL));
129 #if 0 /* This is outside the scope of this function. (bug#4751) */
130 if (c & CHAR_META)
132 /* Move the meta bit to the right place for a string. */
133 c = (c & ~CHAR_META) | 0x80;
135 #endif
137 return c;
141 /* Store multibyte form of character C at P. If C has modifier bits,
142 handle them appropriately. */
145 char_string (unsigned int c, unsigned char *p)
147 int bytes;
149 if (c & CHAR_MODIFIER_MASK)
151 c = (unsigned) char_resolve_modifier_mask ((int) c);
152 /* If C still has any modifier bits, just ignore it. */
153 c &= ~CHAR_MODIFIER_MASK;
156 MAYBE_UNIFY_CHAR (c);
158 if (c <= MAX_3_BYTE_CHAR)
160 bytes = CHAR_STRING (c, p);
162 else if (c <= MAX_4_BYTE_CHAR)
164 p[0] = (0xF0 | (c >> 18));
165 p[1] = (0x80 | ((c >> 12) & 0x3F));
166 p[2] = (0x80 | ((c >> 6) & 0x3F));
167 p[3] = (0x80 | (c & 0x3F));
168 bytes = 4;
170 else if (c <= MAX_5_BYTE_CHAR)
172 p[0] = 0xF8;
173 p[1] = (0x80 | ((c >> 18) & 0x0F));
174 p[2] = (0x80 | ((c >> 12) & 0x3F));
175 p[3] = (0x80 | ((c >> 6) & 0x3F));
176 p[4] = (0x80 | (c & 0x3F));
177 bytes = 5;
179 else if (c <= MAX_CHAR)
181 c = CHAR_TO_BYTE8 (c);
182 bytes = BYTE8_STRING (c, p);
184 else
185 error ("Invalid character: %d", c);
187 return bytes;
191 /* Return a character whose multibyte form is at P. Set LEN is not
192 NULL, it must be a pointer to integer. In that case, set *LEN to
193 the byte length of the multibyte form. If ADVANCED is not NULL, is
194 must be a pointer to unsigned char. In that case, set *ADVANCED to
195 the ending address (i.e. the starting address of the next
196 character) of the multibyte form. */
199 string_char (const unsigned char *p, const unsigned char **advanced, int *len)
201 int c;
202 const unsigned char *saved_p = p;
204 if (*p < 0x80 || ! (*p & 0x20) || ! (*p & 0x10))
206 c = STRING_CHAR_ADVANCE (p);
208 else if (! (*p & 0x08))
210 c = ((((p)[0] & 0xF) << 18)
211 | (((p)[1] & 0x3F) << 12)
212 | (((p)[2] & 0x3F) << 6)
213 | ((p)[3] & 0x3F));
214 p += 4;
216 else
218 c = ((((p)[1] & 0x3F) << 18)
219 | (((p)[2] & 0x3F) << 12)
220 | (((p)[3] & 0x3F) << 6)
221 | ((p)[4] & 0x3F));
222 p += 5;
225 MAYBE_UNIFY_CHAR (c);
227 if (len)
228 *len = p - saved_p;
229 if (advanced)
230 *advanced = p;
231 return c;
235 /* Translate character C by translation table TABLE. If C is
236 negative, translate a character specified by CHARSET and CODE. If
237 no translation is found in TABLE, return the untranslated
238 character. If TABLE is a list, elements are char tables. In this
239 case, translace C by all tables. */
242 translate_char (Lisp_Object table, int c)
244 if (CHAR_TABLE_P (table))
246 Lisp_Object ch;
248 ch = CHAR_TABLE_REF (table, c);
249 if (CHARACTERP (ch))
250 c = XINT (ch);
252 else
254 for (; CONSP (table); table = XCDR (table))
255 c = translate_char (XCAR (table), c);
257 return c;
260 /* Convert ASCII or 8-bit character C to unibyte. If C is none of
261 them, return (C & 0xFF).
263 The argument REV_TBL is now ignored. It will be removed in the
264 future. */
267 multibyte_char_to_unibyte (int c, Lisp_Object rev_tbl)
269 if (c < 0x80)
270 return c;
271 if (CHAR_BYTE8_P (c))
272 return CHAR_TO_BYTE8 (c);
273 return (c & 0xFF);
276 /* Like multibyte_char_to_unibyte, but return -1 if C is not supported
277 by charset_unibyte. */
280 multibyte_char_to_unibyte_safe (int c)
282 if (c < 0x80)
283 return c;
284 if (CHAR_BYTE8_P (c))
285 return CHAR_TO_BYTE8 (c);
286 return -1;
289 DEFUN ("characterp", Fcharacterp, Scharacterp, 1, 2, 0,
290 doc: /* Return non-nil if OBJECT is a character. */)
291 (Lisp_Object object, Lisp_Object ignore)
293 return (CHARACTERP (object) ? Qt : Qnil);
296 DEFUN ("max-char", Fmax_char, Smax_char, 0, 0, 0,
297 doc: /* Return the character of the maximum code. */)
298 (void)
300 return make_number (MAX_CHAR);
303 DEFUN ("unibyte-char-to-multibyte", Funibyte_char_to_multibyte,
304 Sunibyte_char_to_multibyte, 1, 1, 0,
305 doc: /* Convert the byte CH to multibyte character. */)
306 (Lisp_Object ch)
308 int c;
310 CHECK_CHARACTER (ch);
311 c = XFASTINT (ch);
312 if (c >= 0x100)
313 error ("Not a unibyte character: %d", c);
314 MAKE_CHAR_MULTIBYTE (c);
315 return make_number (c);
318 DEFUN ("multibyte-char-to-unibyte", Fmultibyte_char_to_unibyte,
319 Smultibyte_char_to_unibyte, 1, 1, 0,
320 doc: /* Convert the multibyte character CH to a byte.
321 If the multibyte character does not represent a byte, return -1. */)
322 (Lisp_Object ch)
324 int cm;
326 CHECK_CHARACTER (ch);
327 cm = XFASTINT (ch);
328 if (cm < 256)
329 /* Can't distinguish a byte read from a unibyte buffer from
330 a latin1 char, so let's let it slide. */
331 return ch;
332 else
334 int cu = CHAR_TO_BYTE_SAFE (cm);
335 return make_number (cu);
339 DEFUN ("char-width", Fchar_width, Schar_width, 1, 1, 0,
340 doc: /* Return width of CHAR when displayed in the current buffer.
341 The width is measured by how many columns it occupies on the screen.
342 Tab is taken to occupy `tab-width' columns.
343 usage: (char-width CHAR) */)
344 (Lisp_Object ch)
346 Lisp_Object disp;
347 int c, width;
348 struct Lisp_Char_Table *dp = buffer_display_table ();
350 CHECK_CHARACTER (ch);
351 c = XINT (ch);
353 /* Get the way the display table would display it. */
354 disp = dp ? DISP_CHAR_VECTOR (dp, c) : Qnil;
356 if (VECTORP (disp))
357 width = ASIZE (disp);
358 else
359 width = CHAR_WIDTH (c);
361 return make_number (width);
364 /* Return width of string STR of length LEN when displayed in the
365 current buffer. The width is measured by how many columns it
366 occupies on the screen. If PRECISION > 0, return the width of
367 longest substring that doesn't exceed PRECISION, and set number of
368 characters and bytes of the substring in *NCHARS and *NBYTES
369 respectively. */
371 EMACS_INT
372 c_string_width (const unsigned char *str, EMACS_INT len, int precision,
373 EMACS_INT *nchars, EMACS_INT *nbytes)
375 EMACS_INT i = 0, i_byte = 0;
376 EMACS_INT width = 0;
377 struct Lisp_Char_Table *dp = buffer_display_table ();
379 while (i_byte < len)
381 int bytes, thiswidth;
382 Lisp_Object val;
383 int c = STRING_CHAR_AND_LENGTH (str + i_byte, bytes);
385 if (dp)
387 val = DISP_CHAR_VECTOR (dp, c);
388 if (VECTORP (val))
389 thiswidth = XVECTOR (val)->size;
390 else
391 thiswidth = CHAR_WIDTH (c);
393 else
395 thiswidth = CHAR_WIDTH (c);
398 if (precision > 0
399 && (width + thiswidth > precision))
401 *nchars = i;
402 *nbytes = i_byte;
403 return width;
405 i++;
406 i_byte += bytes;
407 width += thiswidth;
410 if (precision > 0)
412 *nchars = i;
413 *nbytes = i_byte;
416 return width;
419 /* Return width of string STR of length LEN when displayed in the
420 current buffer. The width is measured by how many columns it
421 occupies on the screen. */
423 EMACS_INT
424 strwidth (const unsigned char *str, EMACS_INT len)
426 return c_string_width (str, len, -1, NULL, NULL);
429 /* Return width of Lisp string STRING when displayed in the current
430 buffer. The width is measured by how many columns it occupies on
431 the screen while paying attention to compositions. If PRECISION >
432 0, return the width of longest substring that doesn't exceed
433 PRECISION, and set number of characters and bytes of the substring
434 in *NCHARS and *NBYTES respectively. */
436 EMACS_INT
437 lisp_string_width (Lisp_Object string, int precision,
438 EMACS_INT *nchars, EMACS_INT *nbytes)
440 EMACS_INT len = SCHARS (string);
441 /* This set multibyte to 0 even if STRING is multibyte when it
442 contains only ascii and eight-bit-graphic, but that's
443 intentional. */
444 int multibyte = len < SBYTES (string);
445 unsigned char *str = SDATA (string);
446 EMACS_INT i = 0, i_byte = 0;
447 EMACS_INT width = 0;
448 struct Lisp_Char_Table *dp = buffer_display_table ();
450 while (i < len)
452 int chars, bytes, thiswidth;
453 Lisp_Object val;
454 int cmp_id;
455 EMACS_INT ignore, end;
457 if (find_composition (i, -1, &ignore, &end, &val, string)
458 && ((cmp_id = get_composition_id (i, i_byte, end - i, val, string))
459 >= 0))
461 thiswidth = composition_table[cmp_id]->width;
462 chars = end - i;
463 bytes = string_char_to_byte (string, end) - i_byte;
465 else
467 int c;
469 if (multibyte)
470 c = STRING_CHAR_AND_LENGTH (str + i_byte, bytes);
471 else
472 c = str[i_byte], bytes = 1;
473 chars = 1;
474 if (dp)
476 val = DISP_CHAR_VECTOR (dp, c);
477 if (VECTORP (val))
478 thiswidth = XVECTOR (val)->size;
479 else
480 thiswidth = CHAR_WIDTH (c);
482 else
484 thiswidth = CHAR_WIDTH (c);
488 if (precision > 0
489 && (width + thiswidth > precision))
491 *nchars = i;
492 *nbytes = i_byte;
493 return width;
495 i += chars;
496 i_byte += bytes;
497 width += thiswidth;
500 if (precision > 0)
502 *nchars = i;
503 *nbytes = i_byte;
506 return width;
509 DEFUN ("string-width", Fstring_width, Sstring_width, 1, 1, 0,
510 doc: /* Return width of STRING when displayed in the current buffer.
511 Width is measured by how many columns it occupies on the screen.
512 When calculating width of a multibyte character in STRING,
513 only the base leading-code is considered; the validity of
514 the following bytes is not checked. Tabs in STRING are always
515 taken to occupy `tab-width' columns.
516 usage: (string-width STRING) */)
517 (Lisp_Object str)
519 Lisp_Object val;
521 CHECK_STRING (str);
522 XSETFASTINT (val, lisp_string_width (str, -1, NULL, NULL));
523 return val;
526 DEFUN ("char-direction", Fchar_direction, Schar_direction, 1, 1, 0,
527 doc: /* Return the direction of CHAR.
528 The returned value is 0 for left-to-right and 1 for right-to-left.
529 usage: (char-direction CHAR) */)
530 (Lisp_Object ch)
532 int c;
534 CHECK_CHARACTER (ch);
535 c = XINT (ch);
536 return CHAR_TABLE_REF (Vchar_direction_table, c);
539 /* Return the number of characters in the NBYTES bytes at PTR.
540 This works by looking at the contents and checking for multibyte
541 sequences while assuming that there's no invalid sequence.
542 However, if the current buffer has enable-multibyte-characters =
543 nil, we treat each byte as a character. */
545 EMACS_INT
546 chars_in_text (const unsigned char *ptr, EMACS_INT nbytes)
548 /* current_buffer is null at early stages of Emacs initialization. */
549 if (current_buffer == 0
550 || NILP (current_buffer->enable_multibyte_characters))
551 return nbytes;
553 return multibyte_chars_in_text (ptr, nbytes);
556 /* Return the number of characters in the NBYTES bytes at PTR.
557 This works by looking at the contents and checking for multibyte
558 sequences while assuming that there's no invalid sequence. It
559 ignores enable-multibyte-characters. */
561 EMACS_INT
562 multibyte_chars_in_text (const unsigned char *ptr, EMACS_INT nbytes)
564 const unsigned char *endp = ptr + nbytes;
565 EMACS_INT chars = 0;
567 while (ptr < endp)
569 EMACS_INT len = MULTIBYTE_LENGTH (ptr, endp);
571 if (len == 0)
572 abort ();
573 ptr += len;
574 chars++;
577 return chars;
580 /* Parse unibyte text at STR of LEN bytes as a multibyte text, count
581 characters and bytes in it, and store them in *NCHARS and *NBYTES
582 respectively. On counting bytes, pay attention to that 8-bit
583 characters not constructing a valid multibyte sequence are
584 represented by 2-byte in a multibyte text. */
586 void
587 parse_str_as_multibyte (const unsigned char *str, EMACS_INT len,
588 EMACS_INT *nchars, EMACS_INT *nbytes)
590 const unsigned char *endp = str + len;
591 EMACS_INT n, chars = 0, bytes = 0;
593 if (len >= MAX_MULTIBYTE_LENGTH)
595 const unsigned char *adjusted_endp = endp - MAX_MULTIBYTE_LENGTH;
596 while (str < adjusted_endp)
598 if (! CHAR_BYTE8_HEAD_P (*str)
599 && (n = MULTIBYTE_LENGTH_NO_CHECK (str)) > 0)
600 str += n, bytes += n;
601 else
602 str++, bytes += 2;
603 chars++;
606 while (str < endp)
608 if (! CHAR_BYTE8_HEAD_P (*str)
609 && (n = MULTIBYTE_LENGTH (str, endp)) > 0)
610 str += n, bytes += n;
611 else
612 str++, bytes += 2;
613 chars++;
616 *nchars = chars;
617 *nbytes = bytes;
618 return;
621 /* Arrange unibyte text at STR of NBYTES bytes as a multibyte text.
622 It actually converts only such 8-bit characters that don't contruct
623 a multibyte sequence to multibyte forms of Latin-1 characters. If
624 NCHARS is nonzero, set *NCHARS to the number of characters in the
625 text. It is assured that we can use LEN bytes at STR as a work
626 area and that is enough. Return the number of bytes of the
627 resulting text. */
629 EMACS_INT
630 str_as_multibyte (unsigned char *str, EMACS_INT len, EMACS_INT nbytes,
631 EMACS_INT *nchars)
633 unsigned char *p = str, *endp = str + nbytes;
634 unsigned char *to;
635 EMACS_INT chars = 0;
636 int n;
638 if (nbytes >= MAX_MULTIBYTE_LENGTH)
640 unsigned char *adjusted_endp = endp - MAX_MULTIBYTE_LENGTH;
641 while (p < adjusted_endp
642 && ! CHAR_BYTE8_HEAD_P (*p)
643 && (n = MULTIBYTE_LENGTH_NO_CHECK (p)) > 0)
644 p += n, chars++;
646 while (p < endp
647 && ! CHAR_BYTE8_HEAD_P (*p)
648 && (n = MULTIBYTE_LENGTH (p, endp)) > 0)
649 p += n, chars++;
650 if (nchars)
651 *nchars = chars;
652 if (p == endp)
653 return nbytes;
655 to = p;
656 nbytes = endp - p;
657 endp = str + len;
658 memmove (endp - nbytes, p, nbytes);
659 p = endp - nbytes;
661 if (nbytes >= MAX_MULTIBYTE_LENGTH)
663 unsigned char *adjusted_endp = endp - MAX_MULTIBYTE_LENGTH;
664 while (p < adjusted_endp)
666 if (! CHAR_BYTE8_HEAD_P (*p)
667 && (n = MULTIBYTE_LENGTH_NO_CHECK (p)) > 0)
669 while (n--)
670 *to++ = *p++;
672 else
674 int c = *p++;
675 c = BYTE8_TO_CHAR (c);
676 to += CHAR_STRING (c, to);
679 chars++;
681 while (p < endp)
683 if (! CHAR_BYTE8_HEAD_P (*p)
684 && (n = MULTIBYTE_LENGTH (p, endp)) > 0)
686 while (n--)
687 *to++ = *p++;
689 else
691 int c = *p++;
692 c = BYTE8_TO_CHAR (c);
693 to += CHAR_STRING (c, to);
695 chars++;
697 if (nchars)
698 *nchars = chars;
699 return (to - str);
702 /* Parse unibyte string at STR of LEN bytes, and return the number of
703 bytes it may ocupy when converted to multibyte string by
704 `str_to_multibyte'. */
706 EMACS_INT
707 parse_str_to_multibyte (const unsigned char *str, EMACS_INT len)
709 const unsigned char *endp = str + len;
710 EMACS_INT bytes;
712 for (bytes = 0; str < endp; str++)
713 bytes += (*str < 0x80) ? 1 : 2;
714 return bytes;
718 /* Convert unibyte text at STR of NBYTES bytes to a multibyte text
719 that contains the same single-byte characters. It actually
720 converts all 8-bit characters to multibyte forms. It is assured
721 that we can use LEN bytes at STR as a work area and that is
722 enough. */
724 EMACS_INT
725 str_to_multibyte (unsigned char *str, EMACS_INT len, EMACS_INT bytes)
727 unsigned char *p = str, *endp = str + bytes;
728 unsigned char *to;
730 while (p < endp && *p < 0x80) p++;
731 if (p == endp)
732 return bytes;
733 to = p;
734 bytes = endp - p;
735 endp = str + len;
736 memmove (endp - bytes, p, bytes);
737 p = endp - bytes;
738 while (p < endp)
740 int c = *p++;
742 if (c >= 0x80)
743 c = BYTE8_TO_CHAR (c);
744 to += CHAR_STRING (c, to);
746 return (to - str);
749 /* Arrange multibyte text at STR of LEN bytes as a unibyte text. It
750 actually converts characters in the range 0x80..0xFF to
751 unibyte. */
753 EMACS_INT
754 str_as_unibyte (unsigned char *str, EMACS_INT bytes)
756 const unsigned char *p = str, *endp = str + bytes;
757 unsigned char *to;
758 int c, len;
760 while (p < endp)
762 c = *p;
763 len = BYTES_BY_CHAR_HEAD (c);
764 if (CHAR_BYTE8_HEAD_P (c))
765 break;
766 p += len;
768 to = str + (p - str);
769 while (p < endp)
771 c = *p;
772 len = BYTES_BY_CHAR_HEAD (c);
773 if (CHAR_BYTE8_HEAD_P (c))
775 c = STRING_CHAR_ADVANCE (p);
776 *to++ = CHAR_TO_BYTE8 (c);
778 else
780 while (len--) *to++ = *p++;
783 return (to - str);
786 /* Convert eight-bit chars in SRC (in multibyte form) to the
787 corresponding byte and store in DST. CHARS is the number of
788 characters in SRC. The value is the number of bytes stored in DST.
789 Usually, the value is the same as CHARS, but is less than it if SRC
790 contains a non-ASCII, non-eight-bit characater. If ACCEPT_LATIN_1
791 is nonzero, a Latin-1 character is accepted and converted to a byte
792 of that character code.
793 Note: Currently the arg ACCEPT_LATIN_1 is not used. */
795 EMACS_INT
796 str_to_unibyte (const unsigned char *src, unsigned char *dst, EMACS_INT chars, int accept_latin_1)
798 EMACS_INT i;
800 for (i = 0; i < chars; i++)
802 int c = STRING_CHAR_ADVANCE (src);
804 if (CHAR_BYTE8_P (c))
805 c = CHAR_TO_BYTE8 (c);
806 else if (! ASCII_CHAR_P (c)
807 && (! accept_latin_1 || c >= 0x100))
808 return i;
809 *dst++ = c;
811 return i;
815 EMACS_INT
816 string_count_byte8 (Lisp_Object string)
818 int multibyte = STRING_MULTIBYTE (string);
819 EMACS_INT nbytes = SBYTES (string);
820 unsigned char *p = SDATA (string);
821 unsigned char *pend = p + nbytes;
822 EMACS_INT count = 0;
823 int c, len;
825 if (multibyte)
826 while (p < pend)
828 c = *p;
829 len = BYTES_BY_CHAR_HEAD (c);
831 if (CHAR_BYTE8_HEAD_P (c))
832 count++;
833 p += len;
835 else
836 while (p < pend)
838 if (*p++ >= 0x80)
839 count++;
841 return count;
845 Lisp_Object
846 string_escape_byte8 (Lisp_Object string)
848 EMACS_INT nchars = SCHARS (string);
849 EMACS_INT nbytes = SBYTES (string);
850 int multibyte = STRING_MULTIBYTE (string);
851 EMACS_INT byte8_count;
852 const unsigned char *src, *src_end;
853 unsigned char *dst;
854 Lisp_Object val;
855 int c, len;
857 if (multibyte && nchars == nbytes)
858 return string;
860 byte8_count = string_count_byte8 (string);
862 if (byte8_count == 0)
863 return string;
865 if (multibyte)
867 if ((MOST_POSITIVE_FIXNUM - nchars) / 3 < byte8_count
868 || (MOST_POSITIVE_FIXNUM - nbytes) / 2 < byte8_count)
869 error ("Maximum string size exceeded");
871 /* Convert 2-byte sequence of byte8 chars to 4-byte octal. */
872 val = make_uninit_multibyte_string (nchars + byte8_count * 3,
873 nbytes + byte8_count * 2);
875 else
877 if ((MOST_POSITIVE_FIXNUM - nchars) / 3 < byte8_count)
878 error ("Maximum string size exceeded");
879 /* Convert 1-byte sequence of byte8 chars to 4-byte octal. */
880 val = make_uninit_string (nbytes + byte8_count * 3);
883 src = SDATA (string);
884 src_end = src + nbytes;
885 dst = SDATA (val);
886 if (multibyte)
887 while (src < src_end)
889 c = *src;
890 len = BYTES_BY_CHAR_HEAD (c);
892 if (CHAR_BYTE8_HEAD_P (c))
894 c = STRING_CHAR_ADVANCE (src);
895 c = CHAR_TO_BYTE8 (c);
896 sprintf ((char *) dst, "\\%03o", c);
897 dst += 4;
899 else
900 while (len--) *dst++ = *src++;
902 else
903 while (src < src_end)
905 c = *src++;
906 if (c >= 0x80)
908 sprintf ((char *) dst, "\\%03o", c);
909 dst += 4;
911 else
912 *dst++ = c;
914 return val;
918 DEFUN ("string", Fstring, Sstring, 0, MANY, 0,
919 doc: /*
920 Concatenate all the argument characters and make the result a string.
921 usage: (string &rest CHARACTERS) */)
922 (int n, Lisp_Object *args)
924 int i, c;
925 unsigned char *buf, *p;
926 Lisp_Object str;
927 USE_SAFE_ALLOCA;
929 SAFE_ALLOCA (buf, unsigned char *, MAX_MULTIBYTE_LENGTH * n);
930 p = buf;
932 for (i = 0; i < n; i++)
934 CHECK_CHARACTER (args[i]);
935 c = XINT (args[i]);
936 p += CHAR_STRING (c, p);
939 str = make_string_from_bytes ((char *) buf, n, p - buf);
940 SAFE_FREE ();
941 return str;
944 DEFUN ("unibyte-string", Funibyte_string, Sunibyte_string, 0, MANY, 0,
945 doc: /* Concatenate all the argument bytes and make the result a unibyte string.
946 usage: (unibyte-string &rest BYTES) */)
947 (int n, Lisp_Object *args)
949 int i, c;
950 unsigned char *buf, *p;
951 Lisp_Object str;
952 USE_SAFE_ALLOCA;
954 SAFE_ALLOCA (buf, unsigned char *, n);
955 p = buf;
957 for (i = 0; i < n; i++)
959 CHECK_NATNUM (args[i]);
960 c = XFASTINT (args[i]);
961 if (c >= 256)
962 args_out_of_range_3 (args[i], make_number (0), make_number (255));
963 *p++ = c;
966 str = make_string_from_bytes ((char *) buf, n, p - buf);
967 SAFE_FREE ();
968 return str;
971 DEFUN ("char-resolve-modifiers", Fchar_resolve_modifiers,
972 Schar_resolve_modifiers, 1, 1, 0,
973 doc: /* Resolve modifiers in the character CHAR.
974 The value is a character with modifiers resolved into the character
975 code. Unresolved modifiers are kept in the value.
976 usage: (char-resolve-modifiers CHAR) */)
977 (Lisp_Object character)
979 int c;
981 CHECK_NUMBER (character);
982 c = XINT (character);
983 return make_number (char_resolve_modifier_mask (c));
986 DEFUN ("get-byte", Fget_byte, Sget_byte, 0, 2, 0,
987 doc: /* Return a byte value of a character at point.
988 Optional 1st arg POSITION, if non-nil, is a position of a character to get
989 a byte value.
990 Optional 2nd arg STRING, if non-nil, is a string of which first
991 character is a target to get a byte value. In this case, POSITION, if
992 non-nil, is an index of a target character in the string.
994 If the current buffer (or STRING) is multibyte, and the target
995 character is not ASCII nor 8-bit character, an error is signalled. */)
996 (Lisp_Object position, Lisp_Object string)
998 int c;
999 EMACS_INT pos;
1000 unsigned char *p;
1002 if (NILP (string))
1004 if (NILP (position))
1006 p = PT_ADDR;
1008 else
1010 CHECK_NUMBER_COERCE_MARKER (position);
1011 if (XINT (position) < BEGV || XINT (position) >= ZV)
1012 args_out_of_range_3 (position, make_number (BEGV), make_number (ZV));
1013 pos = XFASTINT (position);
1014 p = CHAR_POS_ADDR (pos);
1016 if (NILP (current_buffer->enable_multibyte_characters))
1017 return make_number (*p);
1019 else
1021 CHECK_STRING (string);
1022 if (NILP (position))
1024 p = SDATA (string);
1026 else
1028 CHECK_NATNUM (position);
1029 if (XINT (position) >= SCHARS (string))
1030 args_out_of_range (string, position);
1031 pos = XFASTINT (position);
1032 p = SDATA (string) + string_char_to_byte (string, pos);
1034 if (! STRING_MULTIBYTE (string))
1035 return make_number (*p);
1037 c = STRING_CHAR (p);
1038 if (CHAR_BYTE8_P (c))
1039 c = CHAR_TO_BYTE8 (c);
1040 else if (! ASCII_CHAR_P (c))
1041 error ("Not an ASCII nor an 8-bit character: %d", c);
1042 return make_number (c);
1046 void
1047 init_character_once (void)
1051 #ifdef emacs
1053 void
1054 syms_of_character (void)
1056 DEFSYM (Qcharacterp, "characterp");
1057 DEFSYM (Qauto_fill_chars, "auto-fill-chars");
1059 staticpro (&Vchar_unify_table);
1060 Vchar_unify_table = Qnil;
1062 defsubr (&Smax_char);
1063 defsubr (&Scharacterp);
1064 defsubr (&Sunibyte_char_to_multibyte);
1065 defsubr (&Smultibyte_char_to_unibyte);
1066 defsubr (&Schar_width);
1067 defsubr (&Sstring_width);
1068 defsubr (&Schar_direction);
1069 defsubr (&Sstring);
1070 defsubr (&Sunibyte_string);
1071 defsubr (&Schar_resolve_modifiers);
1072 defsubr (&Sget_byte);
1074 DEFVAR_LISP ("translation-table-vector", &Vtranslation_table_vector,
1075 doc: /*
1076 Vector recording all translation tables ever defined.
1077 Each element is a pair (SYMBOL . TABLE) relating the table to the
1078 symbol naming it. The ID of a translation table is an index into this vector. */);
1079 Vtranslation_table_vector = Fmake_vector (make_number (16), Qnil);
1081 DEFVAR_LISP ("auto-fill-chars", &Vauto_fill_chars,
1082 doc: /*
1083 A char-table for characters which invoke auto-filling.
1084 Such characters have value t in this table. */);
1085 Vauto_fill_chars = Fmake_char_table (Qauto_fill_chars, Qnil);
1086 CHAR_TABLE_SET (Vauto_fill_chars, ' ', Qt);
1087 CHAR_TABLE_SET (Vauto_fill_chars, '\n', Qt);
1089 DEFVAR_LISP ("char-width-table", &Vchar_width_table,
1090 doc: /*
1091 A char-table for width (columns) of each character. */);
1092 Vchar_width_table = Fmake_char_table (Qnil, make_number (1));
1093 char_table_set_range (Vchar_width_table, 0x80, 0x9F, make_number (4));
1094 char_table_set_range (Vchar_width_table, MAX_5_BYTE_CHAR + 1, MAX_CHAR,
1095 make_number (4));
1097 DEFVAR_LISP ("char-direction-table", &Vchar_direction_table,
1098 doc: /* A char-table for direction of each character. */);
1099 Vchar_direction_table = Fmake_char_table (Qnil, make_number (1));
1101 DEFVAR_LISP ("printable-chars", &Vprintable_chars,
1102 doc: /* A char-table for each printable character. */);
1103 Vprintable_chars = Fmake_char_table (Qnil, Qnil);
1104 Fset_char_table_range (Vprintable_chars,
1105 Fcons (make_number (32), make_number (126)), Qt);
1106 Fset_char_table_range (Vprintable_chars,
1107 Fcons (make_number (160),
1108 make_number (MAX_5_BYTE_CHAR)), Qt);
1110 DEFVAR_LISP ("char-script-table", &Vchar_script_table,
1111 doc: /* Char table of script symbols.
1112 It has one extra slot whose value is a list of script symbols. */);
1114 /* Intern this now in case it isn't already done.
1115 Setting this variable twice is harmless.
1116 But don't staticpro it here--that is done in alloc.c. */
1117 Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
1118 DEFSYM (Qchar_script_table, "char-script-table");
1119 Fput (Qchar_script_table, Qchar_table_extra_slots, make_number (1));
1120 Vchar_script_table = Fmake_char_table (Qchar_script_table, Qnil);
1122 DEFVAR_LISP ("script-representative-chars", &Vscript_representative_chars,
1123 doc: /* Alist of scripts vs the representative characters.
1124 Each element is a cons (SCRIPT . CHARS).
1125 SCRIPT is a symbol representing a script or a subgroup of a script.
1126 CHARS is a list or a vector of characters.
1127 If it is a list, all characters in the list are necessary for supporting SCRIPT.
1128 If it is a vector, one of the characters in the vector is necessary.
1129 This variable is used to find a font for a specific script. */);
1130 Vscript_representative_chars = Qnil;
1132 DEFVAR_LISP ("unicode-category-table", &Vunicode_category_table,
1133 doc: /* Char table of Unicode's "General Category".
1134 All Unicode characters have one of the following values (symbol):
1135 Lu, Ll, Lt, Lm, Lo, Mn, Mc, Me, Nd, Nl, No, Pc, Pd, Ps, Pe, Pi, Pf, Po,
1136 Sm, Sc, Sk, So, Zs, Zl, Zp, Cc, Cf, Cs, Co, Cn
1137 See The Unicode Standard for the meaning of those values. */);
1138 /* The correct char-table is setup in characters.el. */
1139 Vunicode_category_table = Qnil;
1142 #endif /* emacs */
1144 /* arch-tag: b6665960-3c3d-4184-85cd-af4318197999
1145 (do not change this comment) */