Mercurial > emacs
annotate lisp/gnus/qp.el @ 41059:70987a4f43c8
Fixed some doc strings to properly quote symbols.
author | Sam Steingold <sds@gnu.org> |
---|---|
date | Wed, 14 Nov 2001 20:22:13 +0000 |
parents | 282970d20daa |
children | 4f7c660e6029 2d97add2d48b |
rev | line source |
---|---|
31717 | 1 ;;; qp.el --- Quoted-Printable functions |
32103 | 2 |
35619
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
3 ;; Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc. |
31717 | 4 |
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org> | |
32103 | 6 ;; Keywords: mail, extensions |
7 | |
31717 | 8 ;; This file is part of GNU Emacs. |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
12 ;; the Free Software Foundation; either version 2, or (at your option) | |
13 ;; any later version. | |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
24 | |
25 ;;; Commentary: | |
26 | |
32103 | 27 ;; Functions for encoding and decoding quoted-printable text as |
28 ;; defined in RFC 2045. | |
29 | |
31717 | 30 ;;; Code: |
31 | |
32504 | 32 (require 'mm-util) |
33 (eval-when-compile (defvar mm-use-ultra-safe-encoding)) | |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
34 |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
35 (defun quoted-printable-decode-region (from to &optional coding-system) |
32103 | 36 "Decode quoted-printable in the region between FROM and TO, per RFC 2045. |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
37 If CODING-SYSTEM is non-nil, decode bytes into characters with that |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
38 coding-system." |
38103
282970d20daa
(quoted-printable-decode-region): If called interactively,
Eli Zaretskii <eliz@gnu.org>
parents:
35931
diff
changeset
|
39 (interactive |
282970d20daa
(quoted-printable-decode-region): If called interactively,
Eli Zaretskii <eliz@gnu.org>
parents:
35931
diff
changeset
|
40 ;; Let the user determine the coding system with "C-x RET c". |
282970d20daa
(quoted-printable-decode-region): If called interactively,
Eli Zaretskii <eliz@gnu.org>
parents:
35931
diff
changeset
|
41 (list (region-beginning) (region-end) coding-system-for-read)) |
32462
7a39fdec7aac
(quoted-printable-decode-region): Avoid invalid
Dave Love <fx@gnu.org>
parents:
32211
diff
changeset
|
42 (unless (mm-coding-system-p coding-system) ; e.g. `ascii' from Gnus |
7a39fdec7aac
(quoted-printable-decode-region): Avoid invalid
Dave Love <fx@gnu.org>
parents:
32211
diff
changeset
|
43 (setq coding-system nil)) |
31717 | 44 (save-excursion |
45 (save-restriction | |
32462
7a39fdec7aac
(quoted-printable-decode-region): Avoid invalid
Dave Love <fx@gnu.org>
parents:
32211
diff
changeset
|
46 ;; RFC 2045: ``An "=" followed by two hexadecimal digits, one |
7a39fdec7aac
(quoted-printable-decode-region): Avoid invalid
Dave Love <fx@gnu.org>
parents:
32211
diff
changeset
|
47 ;; or both of which are lowercase letters in "abcdef", is |
7a39fdec7aac
(quoted-printable-decode-region): Avoid invalid
Dave Love <fx@gnu.org>
parents:
32211
diff
changeset
|
48 ;; formally illegal. A robust implementation might choose to |
7a39fdec7aac
(quoted-printable-decode-region): Avoid invalid
Dave Love <fx@gnu.org>
parents:
32211
diff
changeset
|
49 ;; recognize them as the corresponding uppercase letters.'' |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
50 (let ((case-fold-search t)) |
31717 | 51 (narrow-to-region from to) |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
52 ;; Do this in case we're called from Gnus, say, in a buffer |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
53 ;; which already contains non-ASCII characters which would |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
54 ;; then get doubly-decoded below. |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
55 (if coding-system |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
56 (mm-encode-coding-region (point-min) (point-max) coding-system)) |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
57 (goto-char (point-min)) |
35619
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
58 (while (and (skip-chars-forward "^=") |
32103 | 59 (not (eobp))) |
60 (cond ((eq (char-after (1+ (point))) ?\n) | |
61 (delete-char 2)) | |
62 ((looking-at "=[0-9A-F][0-9A-F]") | |
63 (let ((byte (string-to-int (buffer-substring (1+ (point)) | |
64 (+ 3 (point))) | |
65 16))) | |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
66 (insert byte) |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
67 (delete-char 3) |
32103 | 68 (unless (eq byte ?=) |
69 (backward-char)))) | |
70 (t | |
34025
07dcbc7e702f
(quoted-printable-decode-region): Use error, not message
Dave Love <fx@gnu.org>
parents:
32504
diff
changeset
|
71 (error "Malformed quoted-printable text") |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
72 (forward-char))))) |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
73 (if coding-system |
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
74 (mm-decode-coding-region (point-min) (point-max) coding-system))))) |
31717 | 75 |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
76 (defun quoted-printable-decode-string (string &optional coding-system) |
32103 | 77 "Decode the quoted-printable encoded STRING and return the result. |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
78 If CODING-SYSTEM is non-nil, decode the region with coding-system." |
31717 | 79 (with-temp-buffer |
80 (insert string) | |
32211
5b42e5f7e809
(mm-decode-coding-region, mm-encode-coding-region):
Dave Love <fx@gnu.org>
parents:
32107
diff
changeset
|
81 (quoted-printable-decode-region (point-min) (point-max) coding-system) |
31717 | 82 (buffer-string))) |
83 | |
84 (defun quoted-printable-encode-region (from to &optional fold class) | |
32103 | 85 "Quoted-printable encode the region between FROM and TO per RFC 2045. |
31717 | 86 |
32103 | 87 If FOLD, fold long lines at 76 characters (as required by the RFC). |
35619
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
88 If CLASS is non-nil, translate the characters not matched by that |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
89 regexp class, which is in the form expected by `skip-chars-forward'. |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
90 You should probably avoid non-ASCII characters in this arg. |
31717 | 91 |
32103 | 92 If `mm-use-ultra-safe-encoding' is set, fold lines unconditionally and |
31717 | 93 encode lines starting with \"From\"." |
94 (interactive "r") | |
35619
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
95 ;; Fixme: what should this do in XEmacs/Mule? |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
96 (if (fboundp 'find-charset-region) ; else XEmacs, non-Mule |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
97 (if (delq 'unknown ; Emacs 20 unibyte |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
98 (delq 'eight-bit-graphic ; Emacs 21 |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
99 (delq 'eight-bit-control |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
100 (delq 'ascii (find-charset-region from to))))) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
101 (error "Multibyte character in QP encoding region"))) |
32103 | 102 (unless class |
34752
f04f551e94ce
* message.el (message-narrow-to-head-1): New function.
ShengHuo ZHU <zsh@cs.rochester.edu>
parents:
34025
diff
changeset
|
103 ;; Avoid using 8bit characters. = is \075. |
f04f551e94ce
* message.el (message-narrow-to-head-1): New function.
ShengHuo ZHU <zsh@cs.rochester.edu>
parents:
34025
diff
changeset
|
104 ;; Equivalent to "^\000-\007\013\015-\037\200-\377=" |
f04f551e94ce
* message.el (message-narrow-to-head-1): New function.
ShengHuo ZHU <zsh@cs.rochester.edu>
parents:
34025
diff
changeset
|
105 (setq class "\010-\012\014\040-\074\076-\177")) |
31717 | 106 (save-excursion |
107 (save-restriction | |
108 (narrow-to-region from to) | |
35619
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
109 ;; Encode all the non-ascii and control characters. |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
110 (goto-char (point-min)) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
111 (while (and (skip-chars-forward class) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
112 (not (eobp))) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
113 (insert |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
114 (prog1 |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
115 (format "=%02X" (char-after)) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
116 (delete-char 1)))) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
117 ;; Encode white space at the end of lines. |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
118 (goto-char (point-min)) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
119 (while (re-search-forward "[ \t]+$" nil t) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
120 (goto-char (match-beginning 0)) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
121 (while (not (eolp)) |
31717 | 122 (insert |
123 (prog1 | |
34752
f04f551e94ce
* message.el (message-narrow-to-head-1): New function.
ShengHuo ZHU <zsh@cs.rochester.edu>
parents:
34025
diff
changeset
|
124 (format "=%02X" (char-after)) |
35931
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
125 (delete-char 1))))) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
126 (let ((mm-use-ultra-safe-encoding |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
127 (and (boundp 'mm-use-ultra-safe-encoding) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
128 mm-use-ultra-safe-encoding))) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
129 (when (or fold mm-use-ultra-safe-encoding) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
130 (let ((tab-width 1)) ; HTAB is one character. |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
131 (goto-char (point-min)) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
132 (while (not (eobp)) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
133 ;; In ultra-safe mode, encode "From " at the beginning |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
134 ;; of a line. |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
135 (when mm-use-ultra-safe-encoding |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
136 (if (looking-at "From ") |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
137 (replace-match "From=20" nil t) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
138 (if (looking-at "-") |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
139 (replace-match "=2D" nil t)))) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
140 (end-of-line) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
141 ;; Fold long lines. |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
142 (while (> (current-column) 76) ; tab-width must be 1. |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
143 (beginning-of-line) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
144 (forward-char 75) ; 75 chars plus an "=" |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
145 (search-backward "=" (- (point) 2) t) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
146 (insert "=\n") |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
147 (end-of-line)) |
ccc41398da84
(quoted-printable-encode-region): Remove redundant code
Dave Love <fx@gnu.org>
parents:
35619
diff
changeset
|
148 (forward-line)))))))) |
31717 | 149 |
150 (defun quoted-printable-encode-string (string) | |
32103 | 151 "Encode the STRING as quoted-printable and return the result." |
35619
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
152 (let ((default-enable-multibyte-characters (mm-multibyte-string-p string))) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
153 (with-temp-buffer |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
154 (insert string) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
155 (quoted-printable-encode-region (point-min) (point-max)) |
a670d2680870
Remove un-logged bogus changes from 2000-12-20.
Dave Love <fx@gnu.org>
parents:
34752
diff
changeset
|
156 (buffer-string)))) |
31717 | 157 |
158 (provide 'qp) | |
159 | |
32103 | 160 ;;; qp.el ends here |