Mercurial > hg > xemacs-beta

comparison src/chartab.c @ 4469:c661944aa259

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fill out docstrings for #'translate-region, #'make-char-table. 2008-05-25 Aidan Kehoe <kehoea@parhasard.net> * chartab.c (Fmake_char_table): Document the default return values for the various char table types. * editfns.c (Ftranslate_region): Document why `generic' char tables are preferable to `char' char tables for this function.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 25 May 2008 22:54:33 +0200
parents 1b6a5c6e012d
children 1d11ecca9cd0
comparison
equal deleted inserted replaced
4468:a78d697ccd2c 4469:c661944aa259
564 564
565 Each char table type is used for a different purpose and allows different 565 Each char table type is used for a different purpose and allows different
566 sorts of values. The different char table types are 566 sorts of values. The different char table types are
567 567
568 `category' 568 `category'
569 Used for category tables, which specify the regexp categories 569 Used for category tables, which specify the regexp categories that a
570 that a character is in. The valid values are nil or a 570 character is in. The valid values are nil or a bit vector of 95
571 bit vector of 95 elements. Higher-level Lisp functions are 571 elements, and values default to nil. Higher-level Lisp functions
572 provided for working with category tables. Currently categories 572 are provided for working with category tables. Currently categories
573 and category tables only exist when Mule support is present. 573 and category tables only exist when Mule support is present.
574 `char' 574 `char'
575 A generalized char table, for mapping from one character to 575 A generalized char table, for mapping from one character to another.
576 another. Used for case tables, syntax matching tables, 576 Used for case tables, syntax matching tables,
577 `keyboard-translate-table', etc. The valid values are characters. 577 `keyboard-translate-table', etc. The valid values are characters,
578 and the default result given by `get-char-table' if a value hasn't
579 been set for a given character or for a range that includes it, is
580 ?\x00.
578 `generic' 581 `generic'
579 An even more generalized char table, for mapping from a 582 An even more generalized char table, for mapping from a character to
580 character to anything. 583 anything. The default result given by `get-char-table' is nil.
581 `display' 584 `display'
582 Used for display tables, which specify how a particular character 585 Used for display tables, which specify how a particular character is
583 is to appear when displayed. #### Not yet implemented. 586 to appear when displayed. #### Not yet implemented; currently, the
587 display table code uses generic char tables, and it's not clear that
588 implementing this char table type would be useful.
584 `syntax' 589 `syntax'
585 Used for syntax tables, which specify the syntax of a particular 590 Used for syntax tables, which specify the syntax of a particular
586 character. Higher-level Lisp functions are provided for 591 character. Higher-level Lisp functions are provided for
587 working with syntax tables. The valid values are integers. 592 working with syntax tables. The valid values are integers, and the
593 default result given by `get-char-table' is the syntax code for
594 `inherit'.
588 */ 595 */
589 (type)) 596 (type))
590 { 597 {
591 Lisp_Char_Table *ct; 598 Lisp_Char_Table *ct;
592 Lisp_Object obj; 599 Lisp_Object obj;