]> code.delx.au - gnu-emacs/blobdiff - lispref/nonascii.texi
*** empty log message ***
[gnu-emacs] / lispref / nonascii.texi
index 0cd2e286a7e22a84b81e977410cea0d20fc254d2..0e67bcb0c4e66b923d07ac336148ec80850bfa60 100644 (file)
@@ -60,10 +60,10 @@ character are always in the range 160 through 255 (octal 0240 through
 0377); these values are @dfn{trailing codes}.
 
   Some sequences of bytes are not valid in multibyte text: for example,
-a single isolated byte in the range 128 through 159 is not allowed.
-But character codes 128 through 159 can appear in multibyte text,
-represented as two-byte sequences.  None of the character codes 128
-through 255 normally appear in ordinary multibyte text, but they do
+a single isolated byte in the range 128 through 159 is not allowed.  But
+character codes 128 through 159 can appear in multibyte text,
+represented as two-byte sequences.  All the character codes 128 through
+255 are possible (though slightly abnormal) in multibyte text; they
 appear in multibyte buffers and strings when you do explicit encoding
 and decoding (@pxref{Explicit Encoding}).
 
@@ -135,15 +135,15 @@ acceptable because the buffer's representation is a choice made by the
 user that cannot be overridden automatically.
 
   Converting unibyte text to multibyte text leaves @sc{ascii} characters
-unchanged, and likewise 128 through 159.  It converts the non-@sc{ascii}
-codes 160 through 255 by adding the value @code{nonascii-insert-offset}
-to each character code.  By setting this variable, you specify which
-character set the unibyte characters correspond to (@pxref{Character
-Sets}).  For example, if @code{nonascii-insert-offset} is 2048, which is
-@code{(- (make-char 'latin-iso8859-1) 128)}, then the unibyte
-non-@sc{ascii} characters correspond to Latin 1.  If it is 2688, which
-is @code{(- (make-char 'greek-iso8859-7) 128)}, then they correspond to
-Greek letters.
+unchanged, and likewise character codes 128 through 159.  It converts
+the non-@sc{ascii} codes 160 through 255 by adding the value
+@code{nonascii-insert-offset} to each character code.  By setting this
+variable, you specify which character set the unibyte characters
+correspond to (@pxref{Character Sets}).  For example, if
+@code{nonascii-insert-offset} is 2048, which is @code{(- (make-char
+'latin-iso8859-1) 128)}, then the unibyte non-@sc{ascii} characters
+correspond to Latin 1.  If it is 2688, which is @code{(- (make-char
+'greek-iso8859-7) 128)}, then they correspond to Greek letters.
 
   Converting multibyte text to unibyte is simpler: it discards all but
 the low 8 bits of each character code.  If @code{nonascii-insert-offset}
@@ -156,7 +156,7 @@ text.
 This variable specifies the amount to add to a non-@sc{ascii} character
 when converting unibyte text to multibyte.  It also applies when
 @code{self-insert-command} inserts a character in the unibyte
-non-@sc{ascii} range, 128 through 255.  However, the function
+non-@sc{ascii} range, 128 through 255.  However, the functions
 @code{insert} and @code{insert-char} do not perform this conversion.
 
 The right value to use to select character set @var{cs} is @code{(-
@@ -177,12 +177,16 @@ If this is non-@code{nil}, it overrides @code{nonascii-insert-offset}.
 This function converts the text of @var{string} to unibyte
 representation, if it isn't already, and returns the result.  If
 @var{string} is a unibyte string, it is returned unchanged.
+Multibyte character codes are converted to unibyte
+by using just the low 8 bits.
 @end defun
 
 @defun string-make-multibyte string
 This function converts the text of @var{string} to multibyte
 representation, if it isn't already, and returns the result.  If
 @var{string} is a multibyte string, it is returned unchanged.
+The function @code{unibyte-char-to-multibyte} is used to convert
+each unibyte character to a multibyte character.
 @end defun
 
 @node Selecting a Representation
@@ -221,7 +225,10 @@ treating each byte as a character.  This means that the value may have
 more characters than @var{string} has.
 
 If @var{string} is already a unibyte string, then the value is
-@var{string} itself.
+@var{string} itself.  Otherwise it is a newly created string, with no
+text properties.  If @var{string} is multibyte, any characters it
+contains of charset @var{eight-bit-control} or @var{eight-bit-graphic}
+are converted to the corresponding single byte.
 @end defun
 
 @defun string-as-multibyte string
@@ -230,7 +237,11 @@ treating each multibyte sequence as one character.  This means that the
 value may have fewer characters than @var{string} has.
 
 If @var{string} is already a multibyte string, then the value is
-@var{string} itself.
+@var{string} itself.  Otherwise it is a newly created string, with no
+text properties.  If @var{string} is unibyte and contains any individual
+8-bit bytes (i.e.@: not part of a multibyte form), they are converted to
+the corresponding multibyte character of charset @var{eight-bit-control}
+or @var{eight-bit-graphic}.
 @end defun
 
 @node Character Codes
@@ -242,10 +253,10 @@ codes.  The valid character codes for unibyte representation range from
 0 to 255---the values that can fit in one byte.  The valid character
 codes for multibyte representation range from 0 to 524287, but not all
 values in that range are valid.  The values 128 through 255 are not
-really proper in multibyte text, but they can occur if you do explicit
+entirely proper in multibyte text, but they can occur if you do explicit
 encoding and decoding (@pxref{Explicit Encoding}).  Some other character
 codes cannot occur at all in multibyte text.  Only the @sc{ascii} codes
-0 through 127 are truly legitimate in both representations.
+0 through 127 are completely legitimate in both representations.
 
 @defun char-valid-p charcode &optional genericp
 This returns @code{t} if @var{charcode} is valid for either one of the two
@@ -262,7 +273,7 @@ text representations.
 
 If the optional argument @var{genericp} is non-nil, this function
 returns @code{t} if @var{charcode} is a generic character
-(@pxref{Generic Character}).
+(@pxref{Splitting Characters}).
 @end defun
 
 @node Character Sets
@@ -371,12 +382,12 @@ values is the character set's dimension.
 @end example
 @end defun
 
-@defun make-char charset &rest byte-values
-This function returns the character in character set @var{charset}
-identified by @var{byte-values}.  This is roughly the inverse of
-@code{split-char}.  Normally, you should specify either one or two
-@var{byte-values}, according to the dimension of @var{charset}.  For
-example,
+@defun make-char charset &optional code1 code2
+This function returns the character in character set @var{charset} whose
+position codes are @var{code1} and @var{code2}.  This is roughly the
+inverse of @code{split-char}.  Normally, you should specify either one
+or both of @var{code1} and @var{code2} according to the dimension of
+@var{charset}.  For example,
 
 @example
 (make-char 'latin-iso8859-1 72)
@@ -405,7 +416,10 @@ For example:
 @end example
 
 The character sets @sc{ascii}, @sc{eight-bit-control}, and
-@sc{eight-bit-graphic} don't have corresponding generic characters.
+@sc{eight-bit-graphic} don't have corresponding generic characters.  If
+@var{charset} is one of them and you don't supply @var{code1},
+@code{make-char} returns the character code corresponding to the
+smallest code in @var{charset}.
 
 @node Scanning Charsets
 @section Scanning for Character Sets
@@ -446,10 +460,14 @@ apply to all other coding systems.
 
 @defun make-translation-table &rest translations
 This function returns a translation table based on the argument
-@var{translations}.  Each element of
-@var{translations} should be a list of the form @code{(@var{from}
-. @var{to})}; this says to translate the character @var{from} into
-@var{to}.
+@var{translations}.  Each element of @var{translations} should be a
+list of elements of the form @code{(@var{from} . @var{to})}; this says
+to translate the character @var{from} into @var{to}.
+
+The arguments and the forms in each argument are processed in order,
+and if a previous form already translates @var{to} to some other
+character, say @var{to-alt}, @var{from} is also translated to
+@var{to-alt}.
 
 You can also map one whole character set into another character set with
 the same dimension.  To do this, you specify a generic character (which
@@ -721,22 +739,39 @@ systems used for I/O to a subprocess.
 @node User-Chosen Coding Systems
 @subsection User-Chosen Coding Systems
 
-@defun select-safe-coding-system from to &optional preferred-coding-system
-This function selects a coding system for encoding the text between
-@var{from} and @var{to}, asking the user to choose if necessary.
-
-The optional argument @var{preferred-coding-system} specifies a coding
-system to try first.  If that one can handle the text in the specified
-region, then it is used.  If this argument is omitted, the current
-buffer's value of @code{buffer-file-coding-system} is tried first.
-
-If the region contains some multibyte characters that the preferred
-coding system cannot encode, this function asks the user to choose from
-a list of coding systems which can encode the text, and returns the
-user's choice.
-
-One other kludgy feature: if @var{from} is a string, the string is the
-target text, and @var{to} is ignored.
+@defun select-safe-coding-system from to &optional default-coding-system accept-default-p
+This function selects a coding system for encoding specified text,
+asking the user to choose if necessary.  Normally the specified text
+is the text in the current buffer between @var{from} and @var{to},
+defaulting to the whole buffer if they are @code{nil}.  If @var{from}
+is a string, the string is the specified text, and @var{to} is ignored.
+
+If @var{default-coding-system} is non-@code{nil}, that is the first
+coding system to try; if that can handle the text,
+@code{select-safe-coding-system} returns that coding system.  It can
+also be a list of coding systems; then the function tries each of them
+one by one.  After trying all of them, it next tries the user's most
+preferred coding system (@pxref{Recognize Coding,
+prefer-coding-system, the description of @code{prefer-coding-system},
+emacs, GNU Emacs Manual}), and after that the current buffer's value
+of @code{buffer-file-coding-system} (if it is not @code{undecided}).
+
+If one of those coding systems can safely encode all the specified
+text, @code{select-safe-coding-system} chooses it and returns it.
+Otherwise, it asks the user to choose from a list of coding systems
+which can encode all the text, and returns the user's choice.
+
+The optional argument @var{accept-default-p}, if non-@code{nil},
+should be a function to determine whether the coding system selected
+without user interaction is acceptable.  If this function returns
+@code{nil}, the silently selected coding system is rejected, and the
+user is asked to select a coding system from a list of possible
+candidates.
+
+@vindex select-safe-coding-system-accept-default-p
+If the variable @code{select-safe-coding-system-accept-default-p} is
+non-@code{nil}, its value overrides the value of
+@var{accept-default-p}.
 @end defun
 
   Here are two functions you can use to let the user specify a coding
@@ -770,6 +805,18 @@ don't change these variables; instead, override them using
 @code{coding-system-for-read} and @code{coding-system-for-write}
 (@pxref{Specifying Coding Systems}).
 
+@defvar auto-coding-regexp-alist
+This variable is an alist of text patterns and corresponding coding
+systems. Each element has the form @code{(@var{regexp}
+. @var{coding-system})}; a file whose first few kilobytes match
+@var{regexp} is decoded with @var{coding-system} when its contents are
+read into a buffer.  The settings in this alist take priority over
+@code{coding:} tags in the files and the contents of
+@code{file-coding-system-alist} (see below).  The default value is set
+so that Emacs automatically recognizes mail files in Babyl format and
+reads them with no code conversions.
+@end defvar
+
 @defvar file-coding-system-alist
 This variable is an alist that specifies the coding systems to use for
 reading and writing particular files.  Each element has the form