1 ;;; flow-fill.el --- interprete RFC2646 "flowed" text
3 ;; Copyright (C) 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
5 ;; Author: Simon Josefsson <jas@pdc.kth.se>
8 ;; This file is part of GNU Emacs.
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)
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.
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.
27 ;; This implement decoding of RFC2646 formatted text, including the
28 ;; quoted-depth wins rules.
30 ;; Theory of operation: search for lines ending with SPC, save quote
31 ;; length of line, remove SPC and concatenate line with the following
32 ;; line if quote length of following line matches current line.
34 ;; When no further concatenations are possible, we've found a
35 ;; paragraph and we let `fill-region' fill the long line into several
36 ;; lines with the quote prefix as `fill-prefix'.
38 ;; Todo: implement basic `fill-region' (Emacs and XEmacs
39 ;; implementations differ..)
43 ;; 2000-02-17 posted on ding mailing list
44 ;; 2000-02-19 use `point-at-{b,e}ol' in XEmacs
45 ;; 2000-03-11 no compile warnings for point-at-bol stuff
46 ;; 2000-03-26 committed to gnus cvs
47 ;; 2000-10-23 don't flow "-- " lines, make "quote-depth wins" rule
48 ;; work when first line is at level 0.
49 ;; 2002-01-12 probably incomplete encoding support
50 ;; 2003-12-08 started working on test harness.
54 (eval-when-compile (require 'cl))
56 (defcustom fill-flowed-display-column 'fill-column
57 "Column beyond which format=flowed lines are wrapped, when displayed.
58 This can be a Lisp expression or an integer."
59 :type '(choice (const :tag "Standard `fill-column'" fill-column)
60 (const :tag "Fit Window" (- (window-width) 5))
64 (defcustom fill-flowed-encode-column 66
65 "Column beyond which format=flowed lines are wrapped, in outgoing messages.
66 This can be a Lisp expression or an integer.
67 RFC 2646 suggests 66 characters for readability."
68 :type '(choice (const :tag "Standard fill-column" fill-column)
69 (const :tag "RFC 2646 default (66)" 66)
74 (defalias 'fill-flowed-point-at-bol
75 (if (fboundp 'point-at-bol)
77 'line-beginning-position))
79 (defalias 'fill-flowed-point-at-eol
80 (if (fboundp 'point-at-eol)
85 (defun fill-flowed-encode (&optional buffer)
86 (with-current-buffer (or buffer (current-buffer))
87 ;; No point in doing this unless hard newlines is used.
88 (when use-hard-newlines
89 (let ((start (point-min)) end)
90 ;; Go through each paragraph, filling it and adding SPC
91 ;; as the last character on each line.
92 (while (setq end (text-property-any start (point-max) 'hard 't))
93 (let ((fill-column (eval fill-flowed-encode-column)))
94 (fill-region start end t 'nosqueeze 'to-eop))
96 ;; `fill-region' probably distorted end.
97 (setq end (text-property-any start (point-max) 'hard 't))
98 (while (and (< (point) end)
99 (re-search-forward "$" (1- end) t))
103 (goto-char (setq start (1+ end)))))
107 (defun fill-flowed (&optional buffer)
109 (set-buffer (or (current-buffer) buffer))
110 (goto-char (point-min))
111 (while (re-search-forward " $" nil t)
112 (when (save-excursion
114 (looking-at "^\\(>*\\)\\( ?\\)"))
115 (let ((quote (match-string 1))
117 (if (string= quote "")
119 (when (and quote (string= (match-string 2) ""))
121 ;; insert SP after quote for pleasant reading of quoted lines
123 (when (> (skip-chars-forward ">") 0)
125 ;; XXX slightly buggy handling of "-- "
126 (while (and (save-excursion
127 (ignore-errors (backward-char 3))
128 (setq sig (looking-at "-- "))
129 (looking-at "[^-][^-] "))
133 (looking-at (format "^\\(%s\\)\\([^>\n\r]\\)"
136 (replace-match (if (string= (match-string 2) " ")
138 (backward-delete-char -1)
142 (let ((fill-prefix (when quote (concat quote " ")))
143 (fill-column (eval fill-flowed-display-column))
145 (fill-region (fill-flowed-point-at-bol)
146 (min (1+ (fill-flowed-point-at-eol))
156 (defvar show-trailing-whitespace))
158 (defvar fill-flowed-encode-tests
160 ;; The syntax of each list element is:
161 ;; (INPUT . EXPECTED-OUTPUT)
162 ("> Thou villainous ill-breeding spongy dizzy-eyed
163 > reeky elf-skinned pigeon-egg!
164 >> Thou artless swag-bellied milk-livered
165 >> dismal-dreaming idle-headed scut!
166 >>> Thou errant folly-fallen spleeny reeling-ripe
167 >>> unmuzzled ratsbane!
168 >>>> Henceforth, the coding style is to be strictly
169 >>>> enforced, including the use of only upper case.
170 >>>>> I've noticed a lack of adherence to the coding
171 >>>>> styles, of late.
172 >>>>>> Any complaints?
173 " . "> Thou villainous ill-breeding spongy dizzy-eyed reeky elf-skinned
175 >> Thou artless swag-bellied milk-livered dismal-dreaming idle-headed
177 >>> Thou errant folly-fallen spleeny reeling-ripe unmuzzled ratsbane!
178 >>>> Henceforth, the coding style is to be strictly enforced,
179 >>>> including the use of only upper case.
180 >>>>> I've noticed a lack of adherence to the coding styles, of late.
181 >>>>>> Any complaints?
193 (defun fill-flowed-test ()
195 (switch-to-buffer (get-buffer-create "*Format=Flowed test output*"))
197 (setq show-trailing-whitespace t)
198 (dolist (test fill-flowed-encode-tests)
200 (insert "***** BEGIN TEST INPUT *****\n")
202 (insert "***** END TEST INPUT *****\n\n")
203 (insert "***** BEGIN TEST OUTPUT *****\n")
207 (narrow-to-region start (point))
209 (setq output (buffer-substring start (point-max)))
210 (insert "***** END TEST OUTPUT *****\n")
211 (unless (string= output (cdr test))
212 (insert "\n***** BEGIN TEST EXPECTED OUTPUT *****\n")
214 (insert "***** END TEST EXPECTED OUTPUT *****\n"))
216 (goto-char (point-max)))
220 ;;; flow-fill.el ends here