flow-fill.el 7.77 KB
Newer Older
1
;;; flow-fill.el --- interpret RFC2646 "flowed" text
Gerd Moellmann's avatar
Gerd Moellmann committed
2

3
;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
5 6 7 8 9 10 11 12

;; Author: Simon Josefsson <jas@pdc.kth.se>
;; Keywords: mail

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
13
;; the Free Software Foundation; either version 3, or (at your option)
Gerd Moellmann's avatar
Gerd Moellmann committed
14 15 16 17 18 19 20 21 22
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Gerd Moellmann's avatar
Gerd Moellmann committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38

;;; Commentary:

;; This implement decoding of RFC2646 formatted text, including the
;; quoted-depth wins rules.

;; Theory of operation: search for lines ending with SPC, save quote
;; length of line, remove SPC and concatenate line with the following
;; line if quote length of following line matches current line.

;; When no further concatenations are possible, we've found a
;; paragraph and we let `fill-region' fill the long line into several
;; lines with the quote prefix as `fill-prefix'.

39
;; Todo: implement basic `fill-region' (Emacs and XEmacs
Dave Love's avatar
Dave Love committed
40
;;       implementations differ..)
Gerd Moellmann's avatar
Gerd Moellmann committed
41

42
;;; History:
Gerd Moellmann's avatar
Gerd Moellmann committed
43 44 45 46

;; 2000-02-17  posted on ding mailing list
;; 2000-02-19  use `point-at-{b,e}ol' in XEmacs
;; 2000-03-11  no compile warnings for point-at-bol stuff
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
47
;; 2000-03-26  committed to gnus cvs
Dave Love's avatar
Dave Love committed
48 49
;; 2000-10-23  don't flow "-- " lines, make "quote-depth wins" rule
;;             work when first line is at level 0.
50 51
;; 2002-01-12  probably incomplete encoding support
;; 2003-12-08  started working on test harness.
Gerd Moellmann's avatar
Gerd Moellmann committed
52 53 54

;;; Code:

Dave Love's avatar
Dave Love committed
55 56
(eval-when-compile (require 'cl))

57 58 59
(defcustom fill-flowed-display-column 'fill-column
  "Column beyond which format=flowed lines are wrapped, when displayed.
This can be a Lisp expression or an integer."
60
  :version "22.1"
61
  :group 'mime-display
62 63 64 65 66 67 68 69 70
  :type '(choice (const :tag "Standard `fill-column'" fill-column)
		 (const :tag "Fit Window" (- (window-width) 5))
		 (sexp)
		 (integer)))

(defcustom fill-flowed-encode-column 66
  "Column beyond which format=flowed lines are wrapped, in outgoing messages.
This can be a Lisp expression or an integer.
RFC 2646 suggests 66 characters for readability."
71
  :version "22.1"
72
  :group 'mime-display
73 74 75 76 77
  :type '(choice (const :tag "Standard fill-column" fill-column)
		 (const :tag "RFC 2646 default (66)" 66)
		 (sexp)
		 (integer)))

Gerd Moellmann's avatar
Gerd Moellmann committed
78 79 80 81 82
(eval-and-compile
  (defalias 'fill-flowed-point-at-bol
	(if (fboundp 'point-at-bol)
	    'point-at-bol
	  'line-beginning-position))
Dave Love's avatar
Dave Love committed
83 84

   (defalias 'fill-flowed-point-at-eol
Gerd Moellmann's avatar
Gerd Moellmann committed
85 86 87 88
	(if (fboundp 'point-at-eol)
	    'point-at-eol
	  'line-end-position)))

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
;;;###autoload
(defun fill-flowed-encode (&optional buffer)
  (with-current-buffer (or buffer (current-buffer))
    ;; No point in doing this unless hard newlines is used.
    (when use-hard-newlines
      (let ((start (point-min)) end)
	;; Go through each paragraph, filling it and adding SPC
	;; as the last character on each line.
	(while (setq end (text-property-any start (point-max) 'hard 't))
	  (let ((fill-column (eval fill-flowed-encode-column)))
	    (fill-region start end t 'nosqueeze 'to-eop))
	  (goto-char start)
	  ;; `fill-region' probably distorted end.
	  (setq end (text-property-any start (point-max) 'hard 't))
	  (while (and (< (point) end)
		      (re-search-forward "$" (1- end) t))
	    (insert " ")
	    (setq end (1+ end))
	    (forward-char))
	  (goto-char (setq start (1+ end)))))
      t)))

;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
112 113 114 115
(defun fill-flowed (&optional buffer)
  (save-excursion
    (set-buffer (or (current-buffer) buffer))
    (goto-char (point-min))
116
    ;; Remove space stuffing.
117
    (while (re-search-forward "^\\( \\|>+ $\\)" nil t)
118 119 120
      (delete-char -1)
      (forward-line 1))
    (goto-char (point-min))
Gerd Moellmann's avatar
Gerd Moellmann committed
121 122 123
    (while (re-search-forward " $" nil t)
      (when (save-excursion
	      (beginning-of-line)
124
	      (looking-at "^\\(>*\\)\\( ?\\)"))
125 126
	(let ((quote (match-string 1))
	      sig)
Gerd Moellmann's avatar
Gerd Moellmann committed
127 128 129 130 131 132 133 134
	  (if (string= quote "")
	      (setq quote nil))
	  (when (and quote (string= (match-string 2) ""))
	    (save-excursion
	      ;; insert SP after quote for pleasant reading of quoted lines
	      (beginning-of-line)
	      (when (> (skip-chars-forward ">") 0)
		(insert " "))))
135
	  ;; XXX slightly buggy handling of "-- "
Gerd Moellmann's avatar
Gerd Moellmann committed
136
	  (while (and (save-excursion
Dave Love's avatar
Dave Love committed
137 138
			(ignore-errors (backward-char 3))
			(setq sig (looking-at "-- "))
Gerd Moellmann's avatar
Gerd Moellmann committed
139 140 141 142
			(looking-at "[^-][^-] "))
		      (save-excursion
			(unless (eobp)
			  (forward-char 1)
143 144
			  (looking-at (format "^\\(%s\\)\\([^>\n\r]\\)"
					      (or quote " ?"))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
145 146 147 148 149
	    (save-excursion
	      (replace-match (if (string= (match-string 2) " ")
				 "" "\\2")))
	    (backward-delete-char -1)
	    (end-of-line))
Dave Love's avatar
Dave Love committed
150
	  (unless sig
151 152 153
	    (condition-case nil
		(let ((fill-prefix (when quote (concat quote " ")))
		      (fill-column (eval fill-flowed-display-column))
154 155
		      filladapt-mode
		      adaptive-fill-mode)
156 157 158 159 160 161 162 163 164 165 166 167 168 169
		  (fill-region (fill-flowed-point-at-bol)
			       (min (1+ (fill-flowed-point-at-eol))
				    (point-max))
			       'left 'nosqueeze))
	      (error
	       (forward-line 1)
	       nil))))))))

;; Test vectors.

(eval-when-compile
  (defvar show-trailing-whitespace))

(defvar fill-flowed-encode-tests
170
  `(
171 172
    ;; The syntax of each list element is:
    ;; (INPUT . EXPECTED-OUTPUT)
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    (,(concat
       "> Thou villainous ill-breeding spongy dizzy-eyed \n"
       "> reeky elf-skinned pigeon-egg! \n"
       ">> Thou artless swag-bellied milk-livered \n"
       ">> dismal-dreaming idle-headed scut!\n"
       ">>> Thou errant folly-fallen spleeny reeling-ripe \n"
       ">>> unmuzzled ratsbane!\n"
       ">>>> Henceforth, the coding style is to be strictly \n"
       ">>>> enforced, including the use of only upper case.\n"
       ">>>>> I've noticed a lack of adherence to the coding \n"
       ">>>>> styles, of late.\n"
       ">>>>>> Any complaints?")
     .
     ,(concat
       "> Thou villainous ill-breeding spongy dizzy-eyed reeky elf-skinned\n"
       "> pigeon-egg! \n"
       ">> Thou artless swag-bellied milk-livered dismal-dreaming idle-headed\n"
       ">> scut!\n"
       ">>> Thou errant folly-fallen spleeny reeling-ripe unmuzzled ratsbane!\n"
       ">>>> Henceforth, the coding style is to be strictly enforced,\n"
       ">>>> including the use of only upper case.\n"
       ">>>>> I've noticed a lack of adherence to the coding styles, of late.\n"
       ">>>>>> Any complaints?\n"
       ))
    ;; (,(concat
    ;;    "\n"
    ;;    "> foo\n"
    ;;    "> \n"
    ;;    "> \n"
    ;;    "> bar\n")
    ;;  .
    ;;  ,(concat
    ;;    "\n"
    ;;    "> foo bar\n"))
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    ))

(defun fill-flowed-test ()
  (interactive "")
  (switch-to-buffer (get-buffer-create "*Format=Flowed test output*"))
  (erase-buffer)
  (setq show-trailing-whitespace t)
  (dolist (test fill-flowed-encode-tests)
    (let (start output)
      (insert "***** BEGIN TEST INPUT *****\n")
      (insert (car test))
      (insert "***** END TEST INPUT *****\n\n")
      (insert "***** BEGIN TEST OUTPUT *****\n")
      (setq start (point))
      (insert (car test))
      (save-restriction
	(narrow-to-region start (point))
	(fill-flowed))
      (setq output (buffer-substring start (point-max)))
      (insert "***** END TEST OUTPUT *****\n")
      (unless (string= output (cdr test))
	(insert "\n***** BEGIN TEST EXPECTED OUTPUT *****\n")
	(insert (cdr test))
	(insert "***** END TEST EXPECTED OUTPUT *****\n"))
      (insert "\n\n")))
  (goto-char (point-max)))
Gerd Moellmann's avatar
Gerd Moellmann committed
233 234 235

(provide 'flow-fill)

Miles Bader's avatar
Miles Bader committed
236
;;; arch-tag: addc0040-bc53-4f17-b4bc-1eb44eed6f0b
Gerd Moellmann's avatar
Gerd Moellmann committed
237
;;; flow-fill.el ends here