annotate lisp/international/utf-7.el @ 67159:4de8eb0fda27

*** empty log message ***
author Richard M. Stallman <rms@gnu.org>
date Sun, 27 Nov 2005 19:29:09 +0000
parents 7d9558ca0c3b
children 43cc94d955c2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
1 ;;; utf-7.el --- utf-7 coding system
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
2
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 2003 Free Software Foundation, Inc.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
4
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
5 ;; Author: Dave Love <fx@gnu.org>
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
6 ;; Keywords: i18n, mail
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
7
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
8 ;; This file is free software; you can redistribute it and/or modify
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
9 ;; it under the terms of the GNU General Public License as published by
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
10 ;; the Free Software Foundation; either version 2, or (at your option)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
11 ;; any later version.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
12
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
13 ;; This file is distributed in the hope that it will be useful,
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
16 ;; GNU General Public License for more details.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
17
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
18 ;; You should have received a copy of the GNU General Public License
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
19 ;; along with GNU Emacs; see the file COPYING. If not, write to
64085
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
20 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
21 ;; Boston, MA 02110-1301, USA.
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
22
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
23 ;;; Commentary:
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
24
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
25 ;; Defines a coding system for UTF-7, defined in RFC 2152. Non-ASCII
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
26 ;; segments are encoded as base64-encoded big endian UTF-16. Also
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
27 ;; defines a variation required for IMAP (RFC 2060).
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
28
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
29 ;; The encoding and decoding was originally taken from Jon K Hellan's
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
30 ;; implementation in Gnus, but has been substantially re-done.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
31
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
32 ;; This probably needs more attention. In particular, it's not
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
33 ;; completely consistent with iconv's behaviour. It's arguable
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
34 ;; whether the IMAP version should be a coding system since it's
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
35 ;; apparently only used for IMAP mailbox names, so it's commented out.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
36
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
37 ;;; Code:
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
38
66391
7d9558ca0c3b (utf-7): Add autoload cookie.
Kenichi Handa <handa@m17n.org>
parents: 64085
diff changeset
39 ;;;###autoload(autoload-coding-system 'utf-7 '(require 'utf-7))
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
40 (make-coding-system
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
41 'utf-7 0 ?U
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
42 "UTF-7 encoding of Unicode (RFC 2152)"
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
43 nil
51630
90215b7be64d Adjusted for the name change: xxx-utf-16-{le,be} -> xxx-utf-16{le,be}.
Kenichi Handa <handa@m17n.org>
parents: 50897
diff changeset
44 `((safe-chars . ,(coding-system-get 'utf-16be 'safe-chars))
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
45 (mime-charset . utf-7)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
46 (pre-write-conversion . utf-7-pre-write-conversion)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
47 (post-read-conversion . utf-7-post-read-conversion)))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
48
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
49 ;; (make-coding-system
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
50 ;; 'utf-7-imap 0 ?u
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
51 ;; "UTF-7 encoding of Unicode, IMAP version (RFC 2060)"
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
52 ;; nil
51630
90215b7be64d Adjusted for the name change: xxx-utf-16-{le,be} -> xxx-utf-16{le,be}.
Kenichi Handa <handa@m17n.org>
parents: 50897
diff changeset
53 ;; `((safe-chars . ,(coding-system-get 'utf-16be 'safe-chars))
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
54 ;; (pre-write-conversion . utf-7-imap-pre-write-conversion)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
55 ;; (post-read-conversion . utf-7-imap-post-read-conversion)))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
56
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
57 (defun utf-7-decode (len imap)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
58 "Decode LEN bytes of UTF-7 at point.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
59 IMAP non-nil means use the IMAP version."
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
60 (save-excursion
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
61 (save-restriction
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
62 (narrow-to-region (point) (+ (point) len))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
63 (let ((not-esc (if imap "^&" "^+"))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
64 (skip-chars (if imap "A-Za-z0-9+," "A-Za-z0-9+/")))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
65 (while (not (eobp))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
66 (skip-chars-forward not-esc)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
67 (unless (eobp)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
68 (forward-char)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
69 (let ((p (point))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
70 (run-length (skip-chars-forward skip-chars)))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
71 (if (eq ?- (char-after))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
72 (delete-char 1))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
73 (unless (= run-length 0) ; encoded lone esc-char
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
74 (let ((pl (mod (- run-length) 4)))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
75 (insert-char ?= pl)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
76 (if imap
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
77 (subst-char-in-region p (point) ?, ?/))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
78 (base64-decode-region p (point)))
51630
90215b7be64d Adjusted for the name change: xxx-utf-16-{le,be} -> xxx-utf-16{le,be}.
Kenichi Handa <handa@m17n.org>
parents: 50897
diff changeset
79 (decode-coding-region p (point) 'utf-16be)
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
80 (save-excursion
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
81 (goto-char p)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
82 (delete-backward-char 1)))))))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
83 (- (point-max) (point-min)))))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
84
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
85 (defun utf-7-post-read-conversion (len)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
86 (utf-7-decode len nil))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
87
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
88 ;; (defun utf-7-imap-post-read-conversion (len)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
89 ;; (utf-7-decode len t))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
90
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
91 (defun utf-7-encode (from to imap)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
92 "Encode bytes between FROM and TO to UTF-7.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
93 ESC and SKIP-CHARS are adjusted for the normal and IMAP versions."
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
94 (let* ((old-buf (current-buffer))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
95 (esc (if imap ?& ?+))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
96 ;; These are characters which can be encoded asis.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
97 (skip-chars (if imap
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
98 "\t\n\r\x20-\x25\x27-\x7e" ; rfc2060
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
99 ;; This includes the rfc2152 optional set.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
100 ;; Perhaps it shouldn't (like iconv).
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
101 "\t\n\r -*,-[]-}"))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
102 (not-skip-chars (format "^%s%c" skip-chars esc)))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
103 (set-buffer (generate-new-buffer " *temp*"))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
104 (if (stringp from)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
105 (insert from)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
106 (insert-buffer-substring old-buf from to))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
107 (goto-char (point-min))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
108 (while (not (eobp))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
109 (skip-chars-forward skip-chars)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
110 (if (eq ?+ (char-after))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
111 (progn (forward-char)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
112 (insert ?-))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
113 (unless (eobp)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
114 (insert esc)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
115 (let ((p (point)))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
116 (skip-chars-forward not-skip-chars)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
117 (save-restriction
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
118 ;; encode-coding-region doesn't preserve point
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
119 (narrow-to-region p (point))
51630
90215b7be64d Adjusted for the name change: xxx-utf-16-{le,be} -> xxx-utf-16{le,be}.
Kenichi Handa <handa@m17n.org>
parents: 50897
diff changeset
120 (encode-coding-region p (point-max) 'utf-16be)
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
121 (base64-encode-region p (point-max))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
122 (if imap
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
123 (subst-char-in-region p (point-max) ?/ ?,))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
124 (goto-char p)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
125 ;; As I read the RFC, this isn't correct, but it's
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
126 ;; consistent with iconv, at least regarding `='.
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
127 (skip-chars-forward "^= \t\n")
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
128 (delete-region (point) (point-max))))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
129 (unless (eobp)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
130 (insert ?-)))))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
131 nil))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
132
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
133 (defun utf-7-pre-write-conversion (from to)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
134 (utf-7-encode from to nil))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
135
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
136 ;; (defun utf-7-imap-pre-write-conversion (from to)
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
137 ;; (utf-7-encode from to t))
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
138
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
139 (provide 'utf-7)
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51630
diff changeset
140
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51630
diff changeset
141 ;;; arch-tag: 975ee403-90a4-4286-97d2-4ed1323f4ef9
50897
289523dd4fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
142 ;;; utf-7.el ends here