| blob | 2b7e9a19baa39737011927944f3fd2f8585bf1e4 |
1 ;;; fill.el --- fill commands for Emacs -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1997, 1999, 2001-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: wp
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; All the commands for filling text. These are documented in the Emacs
28 ;; manual.
30 ;;; Code:
33 "Indenting and filling text."
38 "Controls criterion for a new paragraph in `fill-individual-paragraphs'.
39 Non-nil means changing indent doesn't end a paragraph.
40 That mode can handle paragraphs with extra indentation on the first line,
41 but it requires separator lines between paragraphs.
42 A value of nil means that any change in indentation starts a new paragraph."
47 "Non-nil means put two spaces after a colon when filling."
53 "Mode-specific function to fill a paragraph, or nil if there is none.
54 If the function returns nil, then `fill-paragraph' does its normal work.
56 Note: This only affects `fill-paragraph' and not `fill-region'
57 nor `auto-fill-mode', so it is often better to use some other hook,
65 Kinsoku processing is designed to prevent certain characters from being
66 placed at the beginning or end of a line by filling.
67 See the documentation of `kinsoku' for more information."
72 "Set the fill prefix to the current line up to point.
73 Filling expects lines to start with the fill prefix and
74 reinserts the fill prefix in each resulting line."
88 "Non-nil means determine a paragraph's fill prefix from its text."
93 ;; Added `!' for doxygen comments starting with `//!' or `/*!'.
94 ;; Added `%' for TeX comments.
95 ;; RMS: deleted the code to match `1.' and `(1)'.
97 "Regexp to match text at start of line that constitutes indentation.
98 If Adaptive Fill mode is enabled, a prefix matching this pattern
99 on the first and second lines of a paragraph is used as the
100 standard indentation for the whole paragraph.
102 If the paragraph has just one line, the indentation is taken from that
103 line, but in that case `adaptive-fill-first-line-regexp' also plays
104 a role."
109 "Regexp specifying whether to set fill prefix from a one-line paragraph.
110 When a paragraph has just one line, then after `adaptive-fill-regexp'
111 finds the prefix at the beginning of the line, if it doesn't
112 match this regexp, it is replaced with whitespace.
114 By default, this regexp matches sequences of just spaces and tabs.
116 However, we never use a prefix from a one-line paragraph
117 if it would act as a paragraph-starter on the second line."
122 "Function to call to choose a fill prefix for a paragraph, or nil.
123 A nil value means the function has not determined the fill prefix."
131 "Return the fill-column to use for this line.
132 The fill-column to use for a buffer is stored in the variable `fill-column',
133 but can be locally modified by the `right-margin' text property, which is
134 subtracted from `fill-column'.
136 The fill column to use for a line is the first column at which the column
137 number equals or exceeds the local fill-column - right-margin difference."
143 margin fill-col change col)
144 ;; Look separately at each region of line with a different
145 ;; right-margin.
154 here-col col))
158 "Remove extra spaces between words in region.
159 Leave one space between words, two at end of sentences or after colons
160 \(depending on values of `sentence-end-double-space', `colon-double-space',
161 and `sentence-end-without-period').
162 Remove indentation from each line."
164 ;; Ideally, we'd want to scan the text from the end, so that changes to
165 ;; text don't affect the boundary, but the regexp we match against does
166 ;; not match as eagerly when matching backward, so we instead use
167 ;; a marker.
172 ;; Nuke tabs; they get screwed up in a fill.
173 ;; This is quick, but loses when a tab follows the end of a sentence.
174 ;; Actually, it is difficult to tell that from "Mr.\tSmith".
175 ;; Blame the typist.
181 ;; `sentence-end' matched and did not match all spaces.
182 ;; I.e. it only matched the number of spaces it needs: drop the rest.
184 ;; `sentence-end' matched but with nothing left. Either that means
185 ;; nothing should be removed, or it means it's the "old-style"
186 ;; sentence-end which matches all it can. Keep only 2 spaces.
187 ;; We probably don't even need to check `sentence-end-double-space'.
196 ;; Determine number of spaces to leave:
210 "Return the longest common prefix of strings S1 and S2, or nil if none."
213 s1
224 ;; Death to insanely long prefixes.
225 nil
226 str)))
229 "Compute a fill prefix from the text between FROM and TO.
230 This uses the variables `adaptive-fill-regexp' and `adaptive-fill-function'
231 and `adaptive-fill-first-line-regexp'. `paragraph-start' also plays a role;
232 we reject a prefix based on a one-line paragraph if that prefix would
233 act as a paragraph-separator."
239 ;; Move to the second line unless there is just one.
242 ;; Non-nil if we are on the second line.
243 second-line-prefix)
245 ;; We don't need to consider `paragraph-start' here since it
246 ;; will be explicitly checked later on.
247 ;; Also setting first-line-prefix to nil prevents
248 ;; second-line-prefix from being used.
249 ;; ((looking-at paragraph-start) nil)
258 ;; If we get a fill prefix from the second line,
259 ;; make sure it or something compatible is on the first line too.
262 ;; If the non-whitespace chars match the first line,
263 ;; just use it (this subsumes the 2 checks used previously).
264 ;; Used when first line is `/* ...' and second-line is
265 ;; ` * ...'.
271 ;; (assert (string-match "\\`[ \t]*\\'" tmp))
274 second-line-prefix
276 ;; Use the longest common substring of both prefixes,
277 ;; if there is one.
279 second-line-prefix)))))
280 ;; If we get a fill prefix from a one-line paragraph,
281 ;; maybe change it to whitespace,
282 ;; and check that it isn't a paragraph starter.
285 ;; If first-line-prefix comes from the first line,
286 ;; see if it seems reasonable to use for all lines.
287 ;; If not, replace it with whitespace.
290 first-line-prefix))
293 first-line-prefix)))
294 first-line-prefix
296 ;; But either way, reject it if it indicates the start
297 ;; of a paragraph when text follows it.
300 result)))))))
303 "Don't break a line after the first or before the last word of a sentence."
304 ;; Actually, allow breaking before the last word of a sentence, so long as
305 ;; it's not the last word of the paragraph.
315 "Return nil if French style allows breaking the line at point.
316 This is used in `fill-nobreak-predicate' to prevent breaking lines just
317 after an opening paren or just before a closing paren or a punctuation
318 mark such as `?' or `:'. It is common in French writing to put a space
319 at such places, which would normally allow breaking the line at those
320 places."
327 ;; Don't cut right after a single-letter word.
332 "List of predicates for recognizing places not to break a line.
333 The predicates are called with no arguments, with point at the place to
334 be tested. If it returns t, fill commands do not break the line there."
340 "Non-nil means that fill commands do not break lines in invisible text."
345 "Return nil if breaking the line at point is allowed.
346 Can be customized with the variables `fill-nobreak-predicate'
347 and `fill-nobreak-invisible'."
352 ;; Don't break after a period followed by just one space.
353 ;; Move back to the previous place to break.
354 ;; The reason is that if a period ends up at the end of a
355 ;; line, further fills will assume it ends a sentence.
356 ;; If we now know it does not end a sentence, avoid putting
357 ;; it at the end of the line.
363 ;; Another approach to the same problem.
368 ;; Don't split a line if the rest would look like a new paragraph.
372 ;; If this break point is at the end of the line,
373 ;; which can occur for auto-fill, don't consider the newline
374 ;; which follows as a reason to return t.
386 ;; Register `kinsoku' for scripts HAN, KANA, BOPOMPFO, and CJK-MISS.
387 ;; Also tell that they don't use space between words.
394 key t)))
395 char-script-table)
396 ;; Do the same thing also for full width characters and half
397 ;; width kana variants.
404 "Move point to a proper line breaking position of the current line.
405 Don't move back past the buffer position LIMIT.
407 This function is called when we are going to break the current line
408 after or before a non-ASCII character. If the charset of the
409 character has the property `fill-find-break-point-function', this
410 function calls the property value as a function with one arg LIMIT.
411 If the charset has no such property, do nothing."
419 "Delete the fill prefix from every line except the first.
420 The first line may not even have a fill prefix.
421 Point is moved to just past the fill prefix on the first line."
430 ;; Why signal an error here? The problem needs to be caught elsewhere.
431 ;; (if (>= (+ (current-left-margin) (length prefix))
432 ;; (current-fill-column))
433 ;; (error "fill-prefix too long for specified width"))
444 ;; The `fill-space' property carries the string with which a newline
445 ;; should be replaced when unbreaking a line (in fill-delete-newlines).
446 ;; It is added to newline characters by fill-newline when the default
447 ;; behavior of fill-delete-newlines is not what we want.
452 ;; Make sure sentences ending at end of line get an extra space.
453 ;; loses on split abbrevs ("Mr.\nSmith")
457 ;; Try to add the : inside the `sentence-end' regexp.
460 ;; Can't find the right spot to insert the colon.
467 sentence-end-without-space-list)
472 ;; Delete unnecessay newlines surrounded by words. The
473 ;; character category `|' means that we can break a line at the
474 ;; character. And, char-table
475 ;; `fill-nospace-between-words-table' tells how to concatenate
476 ;; words. If a character has non-nil value in the table, never
477 ;; put spaces between words, thus delete a newline between them.
478 ;; Otherwise, delete a newline only when a character preceding a
479 ;; newline has non-nil value in that table.
493 ;; Then change all newlines to spaces.
496 nil
498 ;; Remove trailing whitespace.
499 ;; Maybe canonically-space-region should do that.
504 "Move to the position where the line should be broken.
505 The break position will be always after LINEBEG and generally before point."
506 ;; If the fill column is before linebeg, move to linebeg.
508 ;; Move back to the point where we can break the line
509 ;; at. We break the line between word or after/before
510 ;; the character which has character category `|'. We
511 ;; search space, \c| followed by a character, or \c|
512 ;; following a character. If not found, place
513 ;; the point at linebeg.
516 ;; In case of space, we place the point at next to
517 ;; the point where the break occurs actually,
518 ;; because we don't want to change the following
519 ;; logic of original Emacs. In case of \c|, the
520 ;; point is at the place where the break occurs.
524 ;; Move back over the single space between the words.
527 ;; If the left margin and fill prefix by themselves
528 ;; pass the fill-column. or if they are zero
529 ;; but we have no room for even one word,
530 ;; keep at least one word or a character which has
531 ;; category `|' anyway.
533 ;; Ok, skip at least one word or one \c| character.
534 ;; Meanwhile, don't stop at a period followed by one space.
539 ;; Find a breakable point while ignoring the
540 ;; following spaces.
553 ;; If we are going to break the line after or
554 ;; before a non-ascii character, we may have to
555 ;; run a special function for the charset of the
556 ;; character to find the correct break point.
559 ;; Make sure we take SOMETHING after the fill prefix if any.
562 ;; Like text-properties-at but don't include `composition' property.
565 prop-list)
571 prop-list))
574 ;; Replace whitespace here with one newline, then
575 ;; indent to left margin.
578 ;; Give newline the properties of the space(s) it replaces
584 ;; When refilling later on, this newline would normally not be replaced
585 ;; by a space, so we need to mark it specially to re-install the space
586 ;; when we unfill.
588 ;; If we don't want breaks in invisible text, don't insert
589 ;; an invisible newline.
597 ;; Insert the fill prefix after indentation.
599 ;; Markers that were after the whitespace are now at point: insert
600 ;; before them so they don't get stuck before the prefix.
604 "Indent current line to the column given by `current-left-margin'."
610 nosqueeze squeeze-after)
611 "Fill the region as one paragraph.
612 It removes any paragraph breaks in the region and extra newlines at the end,
613 indents and fills lines between the margins given by the
614 `current-left-margin' and `current-fill-column' functions.
615 \(In most cases, the variable `fill-column' controls the width.)
616 It leaves point at the beginning of the line following the paragraph.
618 Normally performs justification according to the `current-justification'
619 function, but with a prefix arg, does full justification instead.
621 From a program, optional third arg JUSTIFY can specify any type of
622 justification. Fourth arg NOSQUEEZE non-nil means not to make spaces
623 between words canonical before filling. Fifth arg SQUEEZE-AFTER, if non-nil,
624 means don't canonicalize spaces before that position.
626 Return the `fill-prefix' used for filling.
628 If `sentence-end-double-space' is non-nil, then period followed by one
629 space does not end a sentence, so don't break a line there."
637 ;; Make sure "to" is the endpoint.
640 ;; Ignore blank lines at beginning of region.
647 ;; We used to round up to whole line, but that prevents us from
648 ;; correctly handling filling of mixed code-and-comment where we do want
649 ;; to fill the comment but not the code. So only use (point) if it's
650 ;; further than `from', which means that `from' is followed by some
651 ;; number of empty lines.
654 ;; Delete all but one soft newline at end of region.
655 ;; And leave TO before that one.
665 ;; ;; If there was no newline, and there is text in the paragraph, then
666 ;; ;; create a newline.
667 ;; (if (and (not oneleft) (> to from-plus-indent))
668 ;; (newline))
672 nil ;; There is no paragraph, only whitespace: exit now.
676 ;; Don't let Adaptive Fill mode alter the fill prefix permanently.
678 ;; Figure out how this paragraph is indented, if desired.
682 ;; Ignore a white-space only fill-prefix
683 ;; if we indent-according-to-mode.
702 ;; Make sure first line is indented (at least) to left margin...
706 ;; Delete the fill-prefix from every line.
710 ;; FROM, and point, are now before the text to fill,
711 ;; but after any fill prefix on the first line.
715 ;; This is the actual filling loop.
722 ;; Find the position where we'll break the line.
725 ;; Check again to see if we got to the end of
726 ;; the paragraph.
729 ;; Found a place to cut.
733 ;; Justify the line just ended, if desired.
739 ;; Justify this last line, if desired.
741 ;; Leave point after final newline.
744 ;; Return the fill-prefix we used
745 fill-prefix)))
748 "If point is inside the string PREFIX at the beginning of line, move past it."
757 "Fill a paragraph in the minibuffer, ignoring the prompt."
763 "Function to move over paragraphs used by the filling code.
764 It is called with a single argument specifying the number of paragraphs to move.
765 Just like `forward-paragraph', it should return the number of paragraphs
772 "Fill paragraph at or after point.
774 If JUSTIFY is non-nil (interactively, with prefix argument), justify as well.
775 If `sentence-end-double-space' is non-nil, then period followed by one
776 space does not end a sentence, so don't break a line there.
777 The variable `fill-column' controls the width for filling.
779 If `fill-paragraph-function' is non-nil, we call it (passing our
780 argument to it), and if it returns non-nil, we simply return its value.
782 If `fill-paragraph-function' is nil, return the `fill-prefix' used for filling.
784 The REGION argument is non-nil if called interactively; in that
785 case, if Transient Mark mode is enabled and the mark is active,
786 call `fill-region' to fill each of the paragraphs in the active
787 region, instead of just filling the current paragraph."
792 ;; 1. Fill the region if it is active when called interactively.
796 ;; 2. Try fill-paragraph-function.
802 ;; In the minibuffer, don't count the width
803 ;; of the prompt.
805 ;; If fill-paragraph-function is set, it probably takes care
806 ;; of comments and stuff. If not, it will have to set
807 ;; fill-paragraph-handle-comment back to t explicitly or
808 ;; return nil.
812 ;; 3. Try our syntax-aware filling code.
814 ;; Our code only handles \n-terminated comments right now.
818 ;; 4. If it all fails, default to the good ol' text paragraph filling.
821 ;; Fill prefix used for filling the paragraph.
822 fill-pfx)
823 ;; Try to prevent code sections and comment sections from being
824 ;; filled together.
830 ;; To make sure the return value of forward-paragraph is meaningful,
831 ;; we have to start from the beginning of line, otherwise skipping
832 ;; past the last few chars of a paragraph-separator would count as
833 ;; a paragraph (and not skipping any chars at EOB would not count
834 ;; as a paragraph even if it is).
837 ;; There's no paragraph at or after point: give up.
844 ;; Can't use fill-region-as-paragraph, since this
845 ;; paragraph may still contain hard newlines. See
846 ;; fill-region.
849 fill-pfx)))
856 "Fill current comment.
857 If we're not in a comment, just return nil so that the caller
858 can take care of filling. JUSTIFY is used as in `fill-paragraph'."
861 comin comstart)
862 ;; Figure out what kind of comment we are looking at.
871 ;; Make sure the comment-start mark we found is accepted by
872 ;; comment-start-skip. If not, all bets are off, and
873 ;; we'd better not mess with it.
877 ;; Return nil, so the normal filling will take place.
878 nil
880 ;; Narrow to include only the comment, and then fill the region.
885 ;; A regexp more specialized than comment-start-skip, that only
886 ;; matches the current commark rather than any valid commark.
887 ;;
888 ;; The specialized regexp only works for "normal" comment
889 ;; syntax, not for Texinfo's "@c" (which can't be immediately
890 ;; followed by word-chars) or Fortran's "C" (which needs to be
891 ;; at bol), so check that comment-start-skip indeed allows the
892 ;; commark to appear in the middle of the line and followed by
893 ;; word chars. The choice of "\0" and "a" is mostly arbitrary.
896 ;; Make sure we only match comments that
897 ;; use the exact same comment marker.
912 beg end)
917 ;; Find the first line we should include in the region to fill.
923 ;; We may have gone too far. Go forward again.
932 ;; Find the beginning of the first line past the region to fill.
937 ;; Obey paragraph starters and boundaries within comments.
939 ;; Use the default values since they correspond to
940 ;; the values to use for plain text.
948 ;; We used to rely on fill-prefix to break paragraph at
949 ;; comment-starter changes, but it did not work for the
950 ;; first line (mixed comment&code).
951 ;; We now use comment-re instead to "manually" make sure
952 ;; we treat comment-marker changes as paragraph boundaries.
953 ;; (paragraph-ignore-fill-prefix nil)
954 ;; (fill-prefix comment-fill-prefix)
958 ;; If this comment starts on a line with code,
959 ;; include that line in the filling.
965 ;; Find the fill-prefix to use.
974 ;; Don't fill with narrowing.
978 ;; Don't canonicalize spaces within the code just before
979 ;; the comment.
983 nil
985 ;; Make sure we don't return nil.
986 t))))))
989 "Fill each of the paragraphs in the region.
990 A prefix arg means justify as well.
991 Ordinarily the variable `fill-column' controls the width.
993 Noninteractively, the third argument JUSTIFY specifies which
994 kind of justification to do: `full', `left', `right', `center',
995 or `none' (equivalent to nil). A value of t means handle each
996 paragraph as specified by its text properties.
998 The fourth arg NOSQUEEZE non-nil means to leave whitespace other
999 than line breaks untouched, and fifth arg TO-EOP non-nil means
1000 to keep filling to the end of the paragraph (or next hard newline,
1001 if variable `use-hard-newlines' is on).
1003 Return the fill-prefix used for filling the last paragraph.
1005 If `sentence-end-double-space' is non-nil, then period followed by one
1006 space does not end a sentence, so don't break a line there."
1023 end)
1024 ;; If using hard newlines, break at every one for filling
1025 ;; purposes rather than using paragraph breaks.
1044 fill-pfx))
1046 \f
1048 "Method of justifying text not otherwise specified.
1049 Possible values are `left', `right', `full', `center', or `none'.
1050 The requested kind of justification is done whenever lines are filled.
1051 The `justification' text-property can locally override this variable."
1061 "How should we justify this line?
1062 This returns the value of the text-property `justification',
1063 or the variable `default-justification' if there is no text-property.
1066 ;; Make sure we're looking at paragraph body.
1071 default-justification)))
1073 nil
1074 j)))
1077 "Set the region's justification style to STYLE.
1078 This commands prompts for the kind of justification to use.
1079 If the mark is not active, this command operates on the current paragraph.
1080 If the mark is active, it operates on the region. However, if the
1081 beginning and end of the region are not at paragraph breaks, they are
1082 moved to the beginning and end \(respectively) of the paragraphs they
1083 are in.
1085 If variable `use-hard-newlines' is true, all hard newlines are
1086 taken to be paragraph breaks.
1088 When calling from a program, operates just on region between BEGIN and END,
1089 unless optional fourth arg WHOLE-PAR is non-nil. In that case bounds are
1090 extended to include entire paragraphs as in the interactive command."
1094 "Set justification to: "
1097 nil t)))
1100 t))
1106 paragraph-ignore-fill-prefix)))
1122 "Disable automatic filling for paragraphs in the region.
1123 If the mark is not active, this applies to the current paragraph."
1129 "Make paragraphs in the region left-justified.
1130 This means they are flush at the left margin and ragged on the right.
1131 This is usually the default, but see the variable `default-justification'.
1132 If the mark is not active, this applies to the current paragraph."
1138 "Make paragraphs in the region right-justified.
1139 This means they are flush at the right margin and ragged on the left.
1140 If the mark is not active, this applies to the current paragraph."
1146 "Make paragraphs in the region fully justified.
1147 This makes lines flush on both margins by inserting spaces between words.
1148 If the mark is not active, this applies to the current paragraph."
1154 "Make paragraphs in the region centered.
1155 If the mark is not active, this applies to the current paragraph."
1160 ;; A line has up to six parts:
1161 ;;
1162 ;; >>> hello.
1163 ;; [Indent-1][FP][ Indent-2 ][text][trailing whitespace][newline]
1164 ;;
1165 ;; "Indent-1" is the left-margin indentation; normally it ends at column
1166 ;; given by the `current-left-margin' function.
1167 ;; "FP" is the fill-prefix. It can be any string, including whitespace.
1168 ;; "Indent-2" is added to justify a line if the `current-justification' is
1169 ;; `center' or `right'. In `left' and `full' justification regions, any
1170 ;; whitespace there is part of the line's text, and should not be changed.
1171 ;; Trailing whitespace is not counted as part of the line length when
1172 ;; center- or right-justifying.
1173 ;;
1174 ;; All parts of the line are optional, although the final newline can
1175 ;; only be missing on the last line of the buffer.
1178 "Do some kind of justification on this line.
1179 Normally does full justification: adds spaces to the line to make it end at
1180 the column given by `current-fill-column'.
1181 Optional first argument HOW specifies alternate type of justification:
1182 it can be `left', `right', `full', `center', or `none'.
1183 If HOW is t, will justify however the `current-justification' function says to.
1184 If HOW is nil or missing, full justification is done by default.
1185 Second arg EOP non-nil means that this is the last line of the paragraph, so
1186 it will not be stretched by full justification.
1187 Third arg NOSQUEEZE non-nil means to leave interior whitespace unchanged,
1188 otherwise it is made canonical."
1197 fp-end ; point at end of fill prefix
1198 beg ; point at beginning of line's text
1199 end ; point at end of line's text
1200 indent ; column of `beg'
1201 endcol ; column of `end'
1202 ncols ; new indent point or offset
1204 ; in line (not space characters)
1206 count)
1208 ;; Check if this is the last line of the paragraph.
1213 ;; Quick exit if it appears to be properly justified already
1214 ;; or there is no text.
1218 nil
1222 ;; Skip over fill-prefix.
1235 ;; This is beginning of the line's text.
1241 ;; HOW can't be null or left--we would have exited already
1245 ;; Need to remove some indentation
1252 ;; Need to add some
1255 ;; If point was at beginning of text, keep it there.
1260 ;; Figure out how much indentation is needed
1266 ;; Have too much indentation - remove some
1273 ;; Have too little - add some
1276 ;; If point was at beginning of text, keep it there.
1281 ;; Insert extra spaces between words to justify line
1287 ;; count word spaces in line
1292 ;; Ncols is number of additional space chars needed
1295 count nspaces)
1301 curr-fracspace
1306 nil)
1309 "Remove justification whitespace from current line.
1310 If the line is centered or right-justified, this function removes any
1311 indentation past the left margin. If the line is full-justified, it removes
1312 extra spaces between words. It does nothing in other justification modes."
1322 ;; Position ourselves after any fill-prefix.
1334 "Remove justification whitespace from region.
1335 For centered or right-justified regions, this function removes any indentation
1336 past the left margin from each line. For full-justified lines, it removes
1337 extra spaces between words. It does nothing in other justification modes.
1338 Arguments BEGIN and END are optional; default is the whole buffer."
1347 \f
1349 "Fill paragraphs within the region, allowing varying indentation within each.
1351 only at paragraph-separator lines, then fills each paragraph
1352 using as the fill prefix the smallest indentation of any line
1353 in the paragraph.
1355 When calling from a program, pass range to fill as first two arguments.
1357 Optional third and fourth arguments JUSTIFYP and CITATION-REGEXP:
1358 JUSTIFYP to justify paragraphs (prefix arg).
1359 When filling a mail message, pass a regexp for CITATION-REGEXP
1360 which will match the prefix of a line which is a citation marker
1361 plus whitespace, but no other kind of prefix.
1362 Also, if CITATION-REGEXP is non-nil, don't fill header lines."
1371 "Fill paragraphs of uniform indentation within the region.
1373 treating every change in indentation level or prefix as a paragraph boundary,
1374 then fills each paragraph using its indentation level as the fill prefix.
1376 There is one special case where a change in indentation does not start
1377 a new paragraph. This is for text of this form:
1379 foo> This line with extra indentation starts
1380 foo> a paragraph that continues on more lines.
1382 These lines are filled together.
1384 When calling from a program, pass the range to fill
1385 as the first two arguments.
1387 Optional third and fourth arguments JUSTIFY and CITATION-REGEXP:
1388 JUSTIFY to justify paragraphs (prefix arg).
1389 When filling a mail message, pass a regexp for CITATION-REGEXP
1390 which will match the prefix of a line which is a citation marker
1391 plus whitespace, but no other kind of prefix.
1392 Also, if CITATION-REGEXP is non-nil, don't fill header lines."
1410 ;; Loop over paragraphs.
1412 ;; Skip over all paragraph-separating lines
1413 ;; so as to not include them in any paragraph.
1422 fill-prefix fill-prefix-regexp)
1423 ;; Find end of paragraph, and compute the smallest fill-prefix
1424 ;; that fits all the lines in this paragraph.
1426 ;; Update the fill-prefix on the first line
1427 ;; and whenever the prefix good so far is too long.
1432 citation-regexp)
1436 ;; If forward-line went past a newline,
1437 ;; move further to the left margin.
1439 ;; Now stop the loop if end of paragraph.
1442 ;; If this line is a separator line, with or
1443 ;; without prefix, end the paragraph.
1451 paragraph-separate))))))
1452 ;; If this line has more or less indent
1453 ;; than the fill prefix wants, end the paragraph.
1455 ;; If fill prefix is shorter than a new
1456 ;; fill prefix computed here, end paragraph.
1459 citation-regexp)))
1469 citation-regexp
1471 ;; Fill this paragraph, but don't add a newline at the end.
1480 ;; Accept any prefix rather than just the ones matched by
1481 ;; adaptive-fill-first-line-regexp.
1488 ;; See if the citation part of JUST-ONE-LINE-PREFIX
1489 ;; is the same as that of TWO-LINES-PREFIX,
1490 ;; except perhaps with longer whitespace.
1494 just-one-line-prefix citation-regexp))
1497 two-lines-prefix citation-regexp))
1501 two-lines-citation-part))))
1505 adjusted-two-lines-citation-part)
1507 one-line-citation-part)
1510 two-lines-prefix
1511 just-one-line-prefix))))
1518 string))
1520 ;;; fill.el ends here