Mercurial > hg > xemacs-beta

comparison src/chartab.c @ 2714:2eed1f34d39d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2005-04-06 03:47:16 by stephent] improve docstrings <87y8bwbmaa.fsf@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Wed, 06 Apr 2005 03:47:22 +0000
parents 3d8143fc88e1
children 6fa9919a9a0b
comparison
equal deleted inserted replaced
2713:d438c2289647 2714:2eed1f34d39d
540 once per character). 540 once per character).
541 541
542 When Mule support exists, the types of ranges that can be assigned 542 When Mule support exists, the types of ranges that can be assigned
543 values are 543 values are
544 544
545 -- all characters 545 -- all characters (represented by t)
546 -- an entire charset 546 -- an entire charset
547 -- a single row in a two-octet charset 547 -- a single row in a two-octet charset (represented by a vector of two
548 elements: a two-octet charset and a row number; the row must be an
549 integer, not a character)
548 -- a single character 550 -- a single character
549 551
550 When Mule support is not present, the types of ranges that can be 552 When Mule support is not present, the types of ranges that can be
551 assigned values are 553 assigned values are
552 554
553 -- all characters 555 -- all characters (represented by t)
554 -- a single character 556 -- a single character
555 557
556 To create a char table, use `make-char-table'. 558 To create a char table, use `make-char-table'.
557 To modify a char table, use `put-char-table' or `remove-char-table'. 559 To modify a char table, use `put-char-table' or `remove-char-table'.
558 To retrieve the value for a particular character, use `get-char-table'. 560 To retrieve the value for a particular character, use `get-char-table'.
910 } 912 }
911 913
912 #endif /* ERROR_CHECK_TYPES */ 914 #endif /* ERROR_CHECK_TYPES */
913 915
914 DEFUN ("get-range-char-table", Fget_range_char_table, 2, 3, 0, /* 916 DEFUN ("get-range-char-table", Fget_range_char_table, 2, 3, 0, /*
915 Find value for a range in CHAR-TABLE. 917 Find value for RANGE in CHAR-TABLE.
916 If there is more than one value, return MULTI (defaults to nil). 918 If there is more than one value, return MULTI (defaults to nil).
919
920 Valid values for RANGE are single characters, charsets, a row in a
921 two-octet charset, and all characters. See `put-char-table'.
917 */ 922 */
918 (range, char_table, multi)) 923 (range, char_table, multi))
919 { 924 {
920 struct chartab_range rainj; 925 struct chartab_range rainj;
921 926
1126 RANGE specifies one or more characters to be affected and should be 1131 RANGE specifies one or more characters to be affected and should be
1127 one of the following: 1132 one of the following:
1128 1133
1129 -- t (all characters are affected) 1134 -- t (all characters are affected)
1130 -- A charset (only allowed when Mule support is present) 1135 -- A charset (only allowed when Mule support is present)
1131 -- A vector of two elements: a two-octet charset and a row number 1136 -- A vector of two elements: a two-octet charset and a row number; the row
1132 (only allowed when Mule support is present) 1137 must be an integer, not a character (only allowed when Mule support is
1138 present)
1133 -- A single character 1139 -- A single character
1134 1140
1135 VALUE must be a value appropriate for the type of CHAR-TABLE. 1141 VALUE must be a value appropriate for the type of CHAR-TABLE.
1136 See `make-char-table'. 1142 See `make-char-table'.
1137 */ 1143 */
1454 DEFUN ("map-char-table", Fmap_char_table, 2, 3, 0, /* 1460 DEFUN ("map-char-table", Fmap_char_table, 2, 3, 0, /*
1455 Map FUNCTION over entries in CHAR-TABLE, calling it with two args, 1461 Map FUNCTION over entries in CHAR-TABLE, calling it with two args,
1456 each key and value in the table. 1462 each key and value in the table.
1457 1463
1458 RANGE specifies a subrange to map over and is in the same format as 1464 RANGE specifies a subrange to map over and is in the same format as
1459 the RANGE argument to `put-range-table'. If omitted or t, it defaults to 1465 the RANGE argument to `put-char-table'. If omitted or t, it defaults to
1460 the entire table. 1466 the entire table. See also `char-table-p'.
1461 */ 1467 */
1462 (function, char_table, range)) 1468 (function, char_table, range))
1463 { 1469 {
1464 struct slow_map_char_table_arg slarg; 1470 struct slow_map_char_table_arg slarg;
1465 struct gcpro gcpro1, gcpro2; 1471 struct gcpro gcpro1, gcpro2;