comparison lisp/international/mule.el @ 35807:8e8e96ebe639

(make-coding-system): Add description about recognized properties in the docstring.
author Kenichi Handa <handa@m17n.org>
date Wed, 31 Jan 2001 23:51:49 +0000
parents fbb4712321dd
children 3507e0283ebb
comparison
equal deleted inserted replaced
35806:1d75f7b1955f 35807:8e8e96ebe639
708 708
709 If TYPE is 4 (private), FLAGS should be a cons of CCL programs, for 709 If TYPE is 4 (private), FLAGS should be a cons of CCL programs, for
710 decoding and encoding. CCL programs should be specified by their 710 decoding and encoding. CCL programs should be specified by their
711 symbols. 711 symbols.
712 712
713 PROPERTIES is an alist of properties vs the corresponding values. 713 PROPERTIES is an alist of properties vs the corresponding values. The
714 following properties are recognized:
715
716 o post-read-conversion
717
718 The value is a function to call after some text is inserted and
719 decoded by the coding system itself and before any functions in
720 `after-insert-functions' are called. The arguments to this
721 function is the same as those of a function in
722 `after-insert-functions', i.e. LENGTH of a text while putting point
723 at the head of the text to be decoded
724
725 o pre-write-conversion
726
727 The value is a function to call after all functions in
728 `write-region-annotate-functions' and `buffer-file-format' are
729 called, and before the text is encoded by the coding system itself.
730 The arguments to this function is the same as those of a function
731 in `write-region-annotate-functions', i.e. FROM and TO specifying
732 region of a text.
733
734 o translation-table-for-decode
735
736 The value is a translation table to be applied on decoding. See
737 the function `make-translation-table' for the format of translation
738 table.
739
740 o translation-table-for-encode
741
742 The value is a translation table to be applied on encoding.
743
744 o safe-chars
745
746 The value is a char table. If a character has non-nil value in it,
747 the character is safely supported by the coding system. This
748 overrides the specification of safe-charsets.
749
750 o safe-charsets
751
752 The value is a list of charsets safely supported by the coding
753 system. The value t means that all charsets Emacs handles are
754 supported. Even if some charset is not in this list, it doesn't
755 mean that the charset can't be encoded in the coding system,
756 instead, it just means that some other receiver of a text encoded
757 in the coding system won't be able to handle that charset.
758
759 o mime-charset
760
761 The value is a symbol of which name is `MIME-charset' parameter of
762 the coding system.
763
764 o valid-codes (meaningful only for a coding system based on CCL)
765
766 The value is a list to indicate valid byte ranges of the encoded
767 file. Each element of the list is an integer or a cons of integer.
768 In the former case, the integer value is a valid byte code. In the
769 latter case, the integers specifies the range of valid byte codes.
770
714 These properties are set in PLIST, a property list. This function 771 These properties are set in PLIST, a property list. This function
715 also sets properties `coding-category' and `alias-coding-systems' 772 also sets properties `coding-category' and `alias-coding-systems'
716 automatically. 773 automatically.
717 774
718 EOL-TYPE specifies the EOL type of the coding-system in one of the 775 EOL-TYPE specifies the EOL type of the coding-system in one of the