home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / emacs-19.28-src.tgz / tar.out / fsf / emacs / lisp / fill.el < prev    next >
Lisp/Scheme  |  1996-09-28  |  15KB  |  399 lines
  1. ;;; fill.el --- fill commands for Emacs
  2.  
  3. ;; Copyright (C) 1985, 1986, 1992, 1994 Free Software Foundation, Inc.
  4.  
  5. ;; Keywords: wp
  6.  
  7. ;; This file is part of GNU Emacs.
  8.  
  9. ;; GNU Emacs is free software; you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation; either version 2, or (at your option)
  12. ;; any later version.
  13.  
  14. ;; GNU Emacs is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17. ;; GNU General Public License for more details.
  18.  
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  21. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  22.  
  23. ;;; Commentary:
  24.  
  25. ;; All the commands for filling text.  These are documented in the Emacs
  26. ;; manual.
  27.  
  28. ;;; Code:
  29.  
  30. (defconst fill-individual-varying-indent nil
  31.   "*Controls criterion for a new paragraph in `fill-individual-paragraphs'.
  32. Non-nil means changing indent doesn't end a paragraph.
  33. That mode can handle paragraphs with extra indentation on the first line,
  34. but it requires separator lines between paragraphs.
  35. A value of nil means that any change in indentation starts a new paragraph.")
  36.  
  37. (defconst sentence-end-double-space t
  38.   "*Non-nil means a single space does not end a sentence.")
  39.  
  40. (defun set-fill-prefix ()
  41.   "Set the fill prefix to the current line up to point.
  42. Filling expects lines to start with the fill prefix and
  43. reinserts the fill prefix in each resulting line."
  44.   (interactive)
  45.   (setq fill-prefix (buffer-substring
  46.              (save-excursion (beginning-of-line) (point))
  47.              (point)))
  48.   (if (equal fill-prefix "")
  49.       (setq fill-prefix nil))
  50.   (if fill-prefix
  51.       (message "fill-prefix: \"%s\"" fill-prefix)
  52.     (message "fill-prefix cancelled")))
  53.  
  54. (defconst adaptive-fill-mode t
  55.   "*Non-nil means determine a paragraph's fill prefix from its text.")
  56.  
  57. (defconst adaptive-fill-regexp "[ \t]*\\([>*] +\\)?"
  58.   "*Regexp to match text at start of line that constitutes indentation.
  59. If Adaptive Fill mode is enabled, whatever text matches this pattern
  60. on the second line of a paragraph is used as the standard indentation
  61. for the paragraph.")
  62.  
  63. (defun fill-region-as-paragraph (from to &optional justify-flag)
  64.   "Fill region as one paragraph: break lines to fit `fill-column'.
  65. Prefix arg means justify too.
  66. If `sentence-end-double-space' is non-nil, then period followed by one
  67. space does not end a sentence, so don't break a line there.
  68. From program, pass args FROM, TO and JUSTIFY-FLAG."
  69.   (interactive "r\nP")
  70.   ;; Arrange for undoing the fill to restore point.
  71.   (if (and buffer-undo-list (not (eq buffer-undo-list t)))
  72.       (setq buffer-undo-list (cons (point) buffer-undo-list)))
  73.   ;; Don't let Adaptive Fill mode alter the fill prefix permanently.
  74.   (let ((fill-prefix fill-prefix))
  75.     ;; Figure out how this paragraph is indented, if desired.
  76.     (if (and adaptive-fill-mode
  77.          (or (null fill-prefix) (string= fill-prefix "")))
  78.     (save-excursion
  79.       (goto-char (min from to))
  80.       (if (eolp) (forward-line 1))
  81.       (forward-line 1)
  82.       (if (< (point) (max from to))
  83.           (let ((start (point)))
  84.         (re-search-forward adaptive-fill-regexp)
  85.         (setq fill-prefix (buffer-substring start (point))))
  86.         (goto-char (min from to))
  87.         (if (eolp) (forward-line 1))
  88.         ;; If paragraph has only one line, don't assume in general
  89.         ;; that additional lines would have the same starting
  90.         ;; decoration.  Assume no indentation.
  91.         ;; But if left-margin is nonzero, we can assume ordinary
  92.         ;; lines do have indentation.
  93.         (if (> left-margin 0)
  94.         (progn
  95.           (re-search-forward adaptive-fill-regexp)
  96.           (setq fill-prefix (make-string (current-column) ?\ ))))
  97.         )))
  98.  
  99.     (save-restriction
  100.       (narrow-to-region from to)
  101.       (goto-char (point-min))
  102.       (skip-chars-forward "\n")
  103.       (narrow-to-region (point) (point-max))
  104.       (setq from (point))
  105.       (goto-char (point-max))
  106.       (let ((fpre (and fill-prefix (not (equal fill-prefix ""))
  107.                (regexp-quote fill-prefix))))
  108.     ;; Delete the fill prefix from every line except the first.
  109.     ;; The first line may not even have a fill prefix.
  110.     (and fpre
  111.          (progn
  112.            (if (>= (length fill-prefix) fill-column)
  113.            (error "fill-prefix too long for specified width"))
  114.            (goto-char (point-min))
  115.            (forward-line 1)
  116.            (while (not (eobp))
  117.          (if (looking-at fpre)
  118.              (delete-region (point) (match-end 0)))
  119.          (forward-line 1))
  120.            (goto-char (point-min))
  121.            (and (looking-at fpre) (forward-char (length fill-prefix)))
  122.            (setq from (point)))))
  123.       ;; from is now before the text to fill,
  124.       ;; but after any fill prefix on the first line.
  125.  
  126.       ;; Make sure sentences ending at end of line get an extra space.
  127.       ;; loses on split abbrevs ("Mr.\nSmith")
  128.       (goto-char from)
  129.       (while (re-search-forward "[.?!][])}\"']*$" nil t)
  130.     (insert ? ))
  131.  
  132.       ;; Then change all newlines to spaces.
  133.       (subst-char-in-region from (point-max) ?\n ?\ )
  134.  
  135.       ;; Flush excess spaces, except in the paragraph indentation.
  136.       (goto-char from)
  137.       (skip-chars-forward " \t")
  138.       ;; Nuke tabs while we're at it; they get screwed up in a fill.
  139.       ;; This is quick, but loses when a tab follows the end of a sentence.
  140.       ;; Actually, it is difficult to tell that from "Mr.\tSmith".
  141.       ;; Blame the typist.
  142.       (subst-char-in-region (point) (point-max) ?\t ?\ )
  143.       (while (re-search-forward "   *" nil t)
  144.     (delete-region
  145.      (+ (match-beginning 0)
  146.         (if (and sentence-end-double-space
  147.              (save-excursion
  148.                (skip-chars-backward " ]})\"'")
  149.                (memq (preceding-char) '(?. ?? ?!))))
  150.         2 1))
  151.      (match-end 0)))
  152.       (goto-char (point-max))
  153.       (delete-horizontal-space)
  154.       (insert "  ")
  155.       (goto-char (point-min))
  156.  
  157.       ;; This is the actual filling loop.
  158.       (let ((prefixcol 0) linebeg)
  159.     (while (not (eobp))
  160.       (setq linebeg (point))
  161.       (move-to-column (1+ fill-column))
  162.       (if (eobp)
  163.           nil
  164.         ;; Move back to start of word.
  165.         (skip-chars-backward "^ \n" linebeg)
  166.         ;; Don't break after a period followed by just one space.
  167.         ;; Move back to the previous place to break.
  168.         ;; The reason is that if a period ends up at the end of a line,
  169.         ;; further fills will assume it ends a sentence.
  170.         ;; If we now know it does not end a sentence,
  171.         ;; avoid putting it at the end of the line.
  172.         (if sentence-end-double-space
  173.         (while (and (> (point) (+ linebeg 2))
  174.                 (eq (preceding-char) ?\ )
  175.                 (not (eq (following-char) ?\ ))
  176.                 (eq (char-after (- (point) 2)) ?\.))
  177.           (forward-char -2)
  178.           (skip-chars-backward "^ \n" linebeg)))
  179.         (if (if (zerop prefixcol)
  180.             (save-excursion
  181.               (skip-chars-backward " " linebeg)
  182.               (bolp))
  183.           (>= prefixcol (current-column)))
  184.         ;; Keep at least one word even if fill prefix exceeds margin.
  185.         ;; This handles all but the first line of the paragraph.
  186.         ;; Meanwhile, don't stop at a period followed by one space.
  187.         (let ((first t))
  188.           (move-to-column prefixcol)
  189.           (while (and (not (eobp))
  190.                   (or first
  191.                   (and (not (bobp))
  192.                        sentence-end-double-space
  193.                        (save-excursion (forward-char -1)
  194.                                (and (looking-at "\\. ")
  195.                                 (not (looking-at "\\.  ")))))))
  196.             (skip-chars-forward " ")
  197.             (skip-chars-forward "^ \n")
  198.             (setq first nil)))
  199.           ;; Normally, move back over the single space between the words.
  200.           (forward-char -1))
  201.         (if (and fill-prefix (zerop prefixcol)
  202.              (< (- (point) (point-min)) (length fill-prefix))
  203.              (string= (buffer-substring (point-min) (point))
  204.                   (substring fill-prefix 0 (- (point) (point-min)))))
  205.         ;; Keep at least one word even if fill prefix exceeds margin.
  206.         ;; This handles the first line of the paragraph.
  207.         ;; Don't stop at a period followed by just one space.
  208.         (let ((first t))
  209.           (while (and (not (eobp))
  210.                   (or first
  211.                   (and (not (bobp))
  212.                        sentence-end-double-space
  213.                        (save-excursion (forward-char -1)
  214.                                (and (looking-at "\\. ")
  215.                                 (not (looking-at "\\.  ")))))))
  216.             (skip-chars-forward " ")
  217.             (skip-chars-forward "^ \n")
  218.             (setq first nil)))))
  219.       ;; Replace all whitespace here with one newline.
  220.       ;; Insert before deleting, so we don't forget which side of
  221.       ;; the whitespace point or markers used to be on.
  222.       (skip-chars-backward " ")
  223.       (insert ?\n)
  224.       (delete-horizontal-space)
  225.       ;; Insert the fill prefix at start of each line.
  226.       ;; Set prefixcol so whitespace in the prefix won't get lost.
  227.       (and (not (eobp)) fill-prefix (not (equal fill-prefix ""))
  228.            (progn
  229.          (insert fill-prefix)
  230.          (setq prefixcol (current-column))))
  231.       ;; Justify the line just ended, if desired.
  232.       (and justify-flag (not (eobp))
  233.            (progn
  234.          (forward-line -1)
  235.          (justify-current-line)
  236.          (forward-line 1))))))))
  237.  
  238. (defun fill-paragraph (arg)
  239.   "Fill paragraph at or after point.  Prefix arg means justify as well.
  240. If `sentence-end-double-space' is non-nil, then period followed by one
  241. space does not end a sentence, so don't break a line there."
  242.   (interactive "P")
  243.   (let ((before (point)))
  244.     (save-excursion
  245.       (forward-paragraph)
  246.       (or (bolp) (newline 1))
  247.       (let ((end (point))
  248.         (beg (progn (backward-paragraph) (point))))
  249.     (goto-char before)
  250.     (fill-region-as-paragraph beg end arg)))))
  251.  
  252. (defun fill-region (from to &optional justify-flag)
  253.   "Fill each of the paragraphs in the region.
  254. Prefix arg (non-nil third arg, if called from program) means justify as well.
  255. If `sentence-end-double-space' is non-nil, then period followed by one
  256. space does not end a sentence, so don't break a line there."
  257.   (interactive "r\nP")
  258.   (save-restriction
  259.    (narrow-to-region from to)
  260.    (goto-char (point-min))
  261.    (while (not (eobp))
  262.      (let ((initial (point))
  263.        (end (progn
  264.          (forward-paragraph 1) (point))))
  265.        (forward-paragraph -1)
  266.        (if (>= (point) initial)
  267.        (fill-region-as-paragraph (point) end justify-flag)
  268.      (goto-char end))))))
  269.  
  270. (defun justify-current-line ()
  271.   "Add spaces to line point is in, so it ends at `fill-column'."
  272.   (interactive)
  273.   (save-excursion
  274.    (save-restriction
  275.     (let (ncols beg indent end)
  276.       (beginning-of-line)
  277.       (forward-char (length fill-prefix))
  278.       (skip-chars-forward " \t")
  279.       (setq indent (current-column))
  280.       (setq beg (point))
  281.       (end-of-line)
  282.       (narrow-to-region beg (point))
  283.       (setq end (point))
  284.       (skip-chars-backward " \t")
  285.       (delete-char (- end (point)))
  286.       (goto-char beg)
  287.       (while (re-search-forward "   *" nil t)
  288.     (delete-region
  289.      (+ (match-beginning 0)
  290.         (if (save-excursion
  291.          (skip-chars-backward " ])\"'")
  292.          (memq (preceding-char) '(?. ?? ?!)))
  293.         2 1))
  294.      (match-end 0)))
  295.       (goto-char beg)
  296.       (while (re-search-forward "[.?!][])\"']*\n" nil t)
  297.     (forward-char -1)
  298.     (insert-and-inherit ? ))
  299.       (goto-char (point-max))
  300.       ;; Note that the buffer bounds start after the indentation,
  301.       ;; so the columns counted by INDENT don't appear in (current-column).
  302.       (setq ncols (- fill-column (current-column) indent))
  303.       (if (search-backward " " nil t)
  304.       (while (> ncols 0)
  305.         (let ((nmove (+ 3 (random 3))))
  306.           (while (> nmove 0)
  307.         (or (search-backward " " nil t)
  308.             (progn
  309.              (goto-char (point-max))
  310.              (search-backward " ")))
  311.         (skip-chars-backward " ")
  312.         (setq nmove (1- nmove))))
  313.         (insert-and-inherit " ")
  314.         (skip-chars-backward " ")
  315.         (setq ncols (1- ncols)))))))
  316.   nil)
  317.  
  318.  
  319. (defun fill-nonuniform-paragraphs (min max &optional justifyp mailp)
  320.   "Fill paragraphs within the region, allowing varying indentation within each.
  321. This command divides the region into \"paragraphs\",
  322. only at paragraph-separator lines, then fills each paragraph
  323. using as the fill prefix the smallest indentation of any line
  324. in the paragraph.
  325.  
  326. When calling from a program, pass range to fill as first two arguments.
  327.  
  328. Optional third and fourth arguments JUSTIFY-FLAG and MAIL-FLAG:
  329. JUSTIFY-FLAG to justify paragraphs (prefix arg),
  330. MAIL-FLAG for a mail message, i. e. don't fill header lines."
  331.   (interactive "r\nP")
  332.   (let ((fill-individual-varying-indent t))
  333.     (fill-individual-paragraphs min max justifyp mailp)))
  334.  
  335. (defun fill-individual-paragraphs (min max &optional justifyp mailp)
  336.   "Fill paragraphs of uniform indentation within the region.
  337. This command divides the region into \"paragraphs\", 
  338. treating every change in indentation level as a paragraph boundary,
  339. then fills each paragraph using its indentation level as the fill prefix.
  340.  
  341. When calling from a program, pass range to fill as first two arguments.
  342.  
  343. Optional third and fourth arguments JUSTIFY-FLAG and MAIL-FLAG:
  344. JUSTIFY-FLAG to justify paragraphs (prefix arg),
  345. MAIL-FLAG for a mail message, i. e. don't fill header lines."
  346.   (interactive "r\nP")
  347.   (save-restriction
  348.     (save-excursion
  349.       (goto-char min)
  350.       (beginning-of-line)
  351.       (if mailp 
  352.       (while (or (looking-at "[ \t]*[^ \t\n]*:") (looking-at "[ \t]*$"))
  353.         (if (looking-at "[ \t]*[^ \t\n]*:")
  354.         (search-forward "\n\n" nil 'move)
  355.           (forward-line 1))))
  356.       (narrow-to-region (point) max)
  357.       ;; Loop over paragraphs.
  358.       (while (progn (skip-chars-forward " \t\n") (not (eobp)))
  359.     (beginning-of-line)
  360.     (let ((start (point))
  361.           fill-prefix fill-prefix-regexp)
  362.       ;; Find end of paragraph, and compute the smallest fill-prefix
  363.       ;; that fits all the lines in this paragraph.
  364.       (while (progn
  365.            ;; Update the fill-prefix on the first line
  366.            ;; and whenever the prefix good so far is too long.
  367.            (if (not (and fill-prefix
  368.                  (looking-at fill-prefix-regexp)))
  369.                (setq fill-prefix
  370.                  (buffer-substring (point)
  371.                            (save-excursion (skip-chars-forward " \t") (point)))
  372.                  fill-prefix-regexp
  373.                  (regexp-quote fill-prefix)))
  374.            (forward-line 1)
  375.            ;; Now stop the loop if end of paragraph.
  376.            (and (not (eobp))
  377.             (if fill-individual-varying-indent
  378.                 ;; If this line is a separator line, with or
  379.                 ;; without prefix, end the paragraph.
  380.                 (and 
  381.             (not (looking-at paragraph-separate))
  382.             (save-excursion
  383.               (not (and (looking-at fill-prefix-regexp)
  384.                     (progn (forward-char (length fill-prefix))
  385.                         (looking-at paragraph-separate))))))
  386.               ;; If this line has more or less indent
  387.               ;; than the fill prefix wants, end the paragraph.
  388.               (and (looking-at fill-prefix-regexp)
  389.                    (save-excursion
  390.                  (not (progn (forward-char (length fill-prefix))
  391.                          (or (looking-at paragraph-separate)
  392.                          (looking-at paragraph-start))))))))))
  393.       ;; Fill this paragraph, but don't add a newline at the end.
  394.       (let ((had-newline (bolp)))
  395.         (fill-region-as-paragraph start (point) justifyp)
  396.         (or had-newline (delete-char -1))))))))
  397.  
  398. ;;; fill.el ends here
  399.