| blob | d0e90c99516806bcccc7accc88151471b668f17d |
1 ;;; fill.el --- fill commands for Emacs -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1997, 1999, 2001-2012
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)'.
96 ;; Update mail-mode's paragraph-separate if you change this.
98 "Regexp to match text at start of line that constitutes indentation.
99 If Adaptive Fill mode is enabled, a prefix matching this pattern
100 on the first and second lines of a paragraph is used as the
101 standard indentation for the whole paragraph.
103 If the paragraph has just one line, the indentation is taken from that
104 line, but in that case `adaptive-fill-first-line-regexp' also plays
105 a role."
110 "Regexp specifying whether to set fill prefix from a one-line paragraph.
111 When a paragraph has just one line, then after `adaptive-fill-regexp'
112 finds the prefix at the beginning of the line, if it doesn't
113 match this regexp, it is replaced with whitespace.
115 By default, this regexp matches sequences of just spaces and tabs.
117 However, we never use a prefix from a one-line paragraph
118 if it would act as a paragraph-starter on the second line."
123 "Function to call to choose a fill prefix for a paragraph, or nil.
124 A nil value means the function has not determined the fill prefix."
132 "Return the fill-column to use for this line.
133 The fill-column to use for a buffer is stored in the variable `fill-column',
134 but can be locally modified by the `right-margin' text property, which is
135 subtracted from `fill-column'.
137 The fill column to use for a line is the first column at which the column
138 number equals or exceeds the local fill-column - right-margin difference."
144 margin fill-col change col)
145 ;; Look separately at each region of line with a different
146 ;; right-margin.
155 here-col col))
159 "Remove extra spaces between words in region.
160 Leave one space between words, two at end of sentences or after colons
161 \(depending on values of `sentence-end-double-space', `colon-double-space',
162 and `sentence-end-without-period').
163 Remove indentation from each line."
165 ;; Ideally, we'd want to scan the text from the end, so that changes to
166 ;; text don't affect the boundary, but the regexp we match against does
167 ;; not match as eagerly when matching backward, so we instead use
168 ;; a marker.
173 ;; Nuke tabs; they get screwed up in a fill.
174 ;; This is quick, but loses when a tab follows the end of a sentence.
175 ;; Actually, it is difficult to tell that from "Mr.\tSmith".
176 ;; Blame the typist.
182 ;; `sentence-end' matched and did not match all spaces.
183 ;; I.e. it only matched the number of spaces it needs: drop the rest.
185 ;; `sentence-end' matched but with nothing left. Either that means
186 ;; nothing should be removed, or it means it's the "old-style"
187 ;; sentence-end which matches all it can. Keep only 2 spaces.
188 ;; We probably don't even need to check `sentence-end-double-space'.
197 ;; Determine number of spaces to leave:
211 "Return the longest common prefix of strings S1 and S2, or nil if none."
214 s1
225 ;; Death to insanely long prefixes.
226 nil
227 str)))
230 "Compute a fill prefix from the text between FROM and TO.
231 This uses the variables `adaptive-fill-regexp' and `adaptive-fill-function'
232 and `adaptive-fill-first-line-regexp'. `paragraph-start' also plays a role;
233 we reject a prefix based on a one-line paragraph if that prefix would
234 act as a paragraph-separator."
240 ;; Move to the second line unless there is just one.
243 ;; Non-nil if we are on the second line.
244 second-line-prefix)
246 ;; We don't need to consider `paragraph-start' here since it
247 ;; will be explicitly checked later on.
248 ;; Also setting first-line-prefix to nil prevents
249 ;; second-line-prefix from being used.
250 ;; ((looking-at paragraph-start) nil)
259 ;; If we get a fill prefix from the second line,
260 ;; make sure it or something compatible is on the first line too.
263 ;; If the non-whitespace chars match the first line,
264 ;; just use it (this subsumes the 2 checks used previously).
265 ;; Used when first line is `/* ...' and second-line is
266 ;; ` * ...'.
272 ;; (assert (string-match "\\`[ \t]*\\'" tmp))
275 second-line-prefix
277 ;; Use the longest common substring of both prefixes,
278 ;; if there is one.
280 second-line-prefix)))))
281 ;; If we get a fill prefix from a one-line paragraph,
282 ;; maybe change it to whitespace,
283 ;; and check that it isn't a paragraph starter.
286 ;; If first-line-prefix comes from the first line,
287 ;; see if it seems reasonable to use for all lines.
288 ;; If not, replace it with whitespace.
291 first-line-prefix))
294 first-line-prefix)))
295 first-line-prefix
297 ;; But either way, reject it if it indicates the start
298 ;; of a paragraph when text follows it.
301 result)))))))
304 "Don't break a line after the first or before the last word of a sentence."
305 ;; Actually, allow breaking before the last word of a sentence, so long as
306 ;; it's not the last word of the paragraph.
316 "Return nil if French style allows breaking the line at point.
317 This is used in `fill-nobreak-predicate' to prevent breaking lines just
318 after an opening paren or just before a closing paren or a punctuation
319 mark such as `?' or `:'. It is common in French writing to put a space
320 at such places, which would normally allow breaking the line at those
321 places."
328 ;; Don't cut right after a single-letter word.
333 "List of predicates for recognizing places not to break a line.
334 The predicates are called with no arguments, with point at the place to
335 be tested. If it returns t, fill commands do not break the line there."
341 "Non-nil means that fill commands do not break lines in invisible text."
346 "Return nil if breaking the line at point is allowed.
347 Can be customized with the variables `fill-nobreak-predicate'
348 and `fill-nobreak-invisible'."
353 ;; Don't break after a period followed by just one space.
354 ;; Move back to the previous place to break.
355 ;; The reason is that if a period ends up at the end of a
356 ;; line, further fills will assume it ends a sentence.
357 ;; If we now know it does not end a sentence, avoid putting
358 ;; it at the end of the line.
364 ;; Another approach to the same problem.
369 ;; Don't split a line if the rest would look like a new paragraph.
373 ;; If this break point is at the end of the line,
374 ;; which can occur for auto-fill, don't consider the newline
375 ;; which follows as a reason to return t.
387 ;; Register `kinsoku' for scripts HAN, KANA, BOPOMOFO, and CJK-MISC.
388 ;; Also tell that they don't use space between words.
395 key t)))
396 char-script-table)
397 ;; Do the same thing also for full width characters and half
398 ;; width kana variants.
405 "Move point to a proper line breaking position of the current line.
406 Don't move back past the buffer position LIMIT.
408 This function is called when we are going to break the current line
409 after or before a non-ASCII character. If the charset of the
410 character has the property `fill-find-break-point-function', this
411 function calls the property value as a function with one arg LIMIT.
412 If the charset has no such property, do nothing."
420 "Delete the fill prefix from every line except the first.
421 The first line may not even have a fill prefix.
422 Point is moved to just past the fill prefix on the first line."
431 ;; Why signal an error here? The problem needs to be caught elsewhere.
432 ;; (if (>= (+ (current-left-margin) (length prefix))
433 ;; (current-fill-column))
434 ;; (error "fill-prefix too long for specified width"))
445 ;; The `fill-space' property carries the string with which a newline
446 ;; should be replaced when unbreaking a line (in fill-delete-newlines).
447 ;; It is added to newline characters by fill-newline when the default
448 ;; behavior of fill-delete-newlines is not what we want.
453 ;; Make sure sentences ending at end of line get an extra space.
454 ;; loses on split abbrevs ("Mr.\nSmith")
458 ;; Try to add the : inside the `sentence-end' regexp.
461 ;; Can't find the right spot to insert the colon.
468 sentence-end-without-space-list)
473 ;; Delete unnecessary newlines surrounded by words. The
474 ;; character category `|' means that we can break a line at the
475 ;; character. And, char-table
476 ;; `fill-nospace-between-words-table' tells how to concatenate
477 ;; words. If a character has non-nil value in the table, never
478 ;; put spaces between words, thus delete a newline between them.
479 ;; Otherwise, delete a newline only when a character preceding a
480 ;; newline has non-nil value in that table.
494 ;; Then change all newlines to spaces.
497 nil
499 ;; Remove trailing whitespace.
500 ;; Maybe canonically-space-region should do that.
505 "Move to the position where the line should be broken.
506 The break position will be always after LINEBEG and generally before point."
507 ;; If the fill column is before linebeg, move to linebeg.
509 ;; Move back to the point where we can break the line
510 ;; at. We break the line between word or after/before
511 ;; the character which has character category `|'. We
512 ;; search space, \c| followed by a character, or \c|
513 ;; following a character. If not found, place
514 ;; the point at linebeg.
517 ;; In case of space, we place the point at next to
518 ;; the point where the break occurs actually,
519 ;; because we don't want to change the following
520 ;; logic of original Emacs. In case of \c|, the
521 ;; point is at the place where the break occurs.
525 ;; Move back over the single space between the words.
528 ;; If the left margin and fill prefix by themselves
529 ;; pass the fill-column. or if they are zero
530 ;; but we have no room for even one word,
531 ;; keep at least one word or a character which has
532 ;; category `|' anyway.
534 ;; Ok, skip at least one word or one \c| character.
535 ;; Meanwhile, don't stop at a period followed by one space.
540 ;; Find a breakable point while ignoring the
541 ;; following spaces.
554 ;; If we are going to break the line after or
555 ;; before a non-ascii character, we may have to
556 ;; run a special function for the charset of the
557 ;; character to find the correct break point.
560 ;; Make sure we take SOMETHING after the fill prefix if any.
563 ;; Like text-properties-at but don't include `composition' property.
566 prop-list)
572 prop-list))
575 ;; Replace whitespace here with one newline, then
576 ;; indent to left margin.
579 ;; Give newline the properties of the space(s) it replaces
585 ;; When refilling later on, this newline would normally not be replaced
586 ;; by a space, so we need to mark it specially to re-install the space
587 ;; when we unfill.
589 ;; If we don't want breaks in invisible text, don't insert
590 ;; an invisible newline.
598 ;; Insert the fill prefix after indentation.
600 ;; Markers that were after the whitespace are now at point: insert
601 ;; before them so they don't get stuck before the prefix.
605 "Indent current line to the column given by `current-left-margin'."
611 nosqueeze squeeze-after)
612 "Fill the region as one paragraph.
613 It removes any paragraph breaks in the region and extra newlines at the end,
614 indents and fills lines between the margins given by the
615 `current-left-margin' and `current-fill-column' functions.
616 \(In most cases, the variable `fill-column' controls the width.)
617 It leaves point at the beginning of the line following the paragraph.
619 Normally performs justification according to the `current-justification'
620 function, but with a prefix arg, does full justification instead.
622 From a program, optional third arg JUSTIFY can specify any type of
623 justification. Fourth arg NOSQUEEZE non-nil means not to make spaces
624 between words canonical before filling. Fifth arg SQUEEZE-AFTER, if non-nil,
625 means don't canonicalize spaces before that position.
627 Return the `fill-prefix' used for filling.
629 If `sentence-end-double-space' is non-nil, then period followed by one
630 space does not end a sentence, so don't break a line there."
638 ;; Make sure "to" is the endpoint.
641 ;; Ignore blank lines at beginning of region.
648 ;; We used to round up to whole line, but that prevents us from
649 ;; correctly handling filling of mixed code-and-comment where we do want
650 ;; to fill the comment but not the code. So only use (point) if it's
651 ;; further than `from', which means that `from' is followed by some
652 ;; number of empty lines.
655 ;; Delete all but one soft newline at end of region.
656 ;; And leave TO before that one.
666 ;; ;; If there was no newline, and there is text in the paragraph, then
667 ;; ;; create a newline.
668 ;; (if (and (not oneleft) (> to from-plus-indent))
669 ;; (newline))
673 nil ;; There is no paragraph, only whitespace: exit now.
677 ;; Don't let Adaptive Fill mode alter the fill prefix permanently.
679 ;; Figure out how this paragraph is indented, if desired.
683 ;; Ignore a white-space only fill-prefix
684 ;; if we indent-according-to-mode.
703 ;; Make sure first line is indented (at least) to left margin...
707 ;; Delete the fill-prefix from every line.
711 ;; FROM, and point, are now before the text to fill,
712 ;; but after any fill prefix on the first line.
716 ;; This is the actual filling loop.
723 ;; Find the position where we'll break the line.
726 ;; Check again to see if we got to the end of
727 ;; the paragraph.
730 ;; Found a place to cut.
734 ;; Justify the line just ended, if desired.
740 ;; Justify this last line, if desired.
742 ;; Leave point after final newline.
745 ;; Return the fill-prefix we used
746 fill-prefix)))
749 "If point is inside the string PREFIX at the beginning of line, move past it."
758 "Fill a paragraph in the minibuffer, ignoring the prompt."
764 "Function to move over paragraphs used by the filling code.
765 It is called with a single argument specifying the number of paragraphs to move.
766 Just like `forward-paragraph', it should return the number of paragraphs
773 "Fill paragraph at or after point.
775 If JUSTIFY is non-nil (interactively, with prefix argument), justify as well.
776 If `sentence-end-double-space' is non-nil, then period followed by one
777 space does not end a sentence, so don't break a line there.
778 The variable `fill-column' controls the width for filling.
780 If `fill-paragraph-function' is non-nil, we call it (passing our
781 argument to it), and if it returns non-nil, we simply return its value.
783 If `fill-paragraph-function' is nil, return the `fill-prefix' used for filling.
785 The REGION argument is non-nil if called interactively; in that
786 case, if Transient Mark mode is enabled and the mark is active,
787 call `fill-region' to fill each of the paragraphs in the active
788 region, instead of just filling the current paragraph."
793 ;; 1. Fill the region if it is active when called interactively.
797 ;; 2. Try fill-paragraph-function.
803 ;; In the minibuffer, don't count the width
804 ;; of the prompt.
806 ;; If fill-paragraph-function is set, it probably takes care
807 ;; of comments and stuff. If not, it will have to set
808 ;; fill-paragraph-handle-comment back to t explicitly or
809 ;; return nil.
813 ;; 3. Try our syntax-aware filling code.
815 ;; Our code only handles \n-terminated comments right now.
819 ;; 4. If it all fails, default to the good ol' text paragraph filling.
822 ;; Fill prefix used for filling the paragraph.
823 fill-pfx)
824 ;; Try to prevent code sections and comment sections from being
825 ;; filled together.
831 ;; To make sure the return value of forward-paragraph is meaningful,
832 ;; we have to start from the beginning of line, otherwise skipping
833 ;; past the last few chars of a paragraph-separator would count as
834 ;; a paragraph (and not skipping any chars at EOB would not count
835 ;; as a paragraph even if it is).
838 ;; There's no paragraph at or after point: give up.
845 ;; Can't use fill-region-as-paragraph, since this
846 ;; paragraph may still contain hard newlines. See
847 ;; fill-region.
850 fill-pfx)))
857 "Fill current comment.
858 If we're not in a comment, just return nil so that the caller
859 can take care of filling. JUSTIFY is used as in `fill-paragraph'."
862 comin comstart)
863 ;; Figure out what kind of comment we are looking at.
872 ;; Make sure the comment-start mark we found is accepted by
873 ;; comment-start-skip. If not, all bets are off, and
874 ;; we'd better not mess with it.
878 ;; Return nil, so the normal filling will take place.
879 nil
881 ;; Narrow to include only the comment, and then fill the region.
886 ;; A regexp more specialized than comment-start-skip, that only
887 ;; matches the current commark rather than any valid commark.
888 ;;
889 ;; The specialized regexp only works for "normal" comment
890 ;; syntax, not for Texinfo's "@c" (which can't be immediately
891 ;; followed by word-chars) or Fortran's "C" (which needs to be
892 ;; at bol), so check that comment-start-skip indeed allows the
893 ;; commark to appear in the middle of the line and followed by
894 ;; word chars. The choice of "\0" and "a" is mostly arbitrary.
897 ;; Make sure we only match comments that
898 ;; use the exact same comment marker.
913 beg end)
918 ;; Find the first line we should include in the region to fill.
924 ;; We may have gone too far. Go forward again.
933 ;; Find the beginning of the first line past the region to fill.
938 ;; Obey paragraph starters and boundaries within comments.
940 ;; Use the default values since they correspond to
941 ;; the values to use for plain text.
949 ;; We used to rely on fill-prefix to break paragraph at
950 ;; comment-starter changes, but it did not work for the
951 ;; first line (mixed comment&code).
952 ;; We now use comment-re instead to "manually" make sure
953 ;; we treat comment-marker changes as paragraph boundaries.
954 ;; (paragraph-ignore-fill-prefix nil)
955 ;; (fill-prefix comment-fill-prefix)
959 ;; If this comment starts on a line with code,
960 ;; include that line in the filling.
966 ;; Find the fill-prefix to use.
975 ;; Don't fill with narrowing.
979 ;; Don't canonicalize spaces within the code just before
980 ;; the comment.
984 nil
986 ;; Make sure we don't return nil.
987 t))))))
990 "Fill each of the paragraphs in the region.
991 A prefix arg means justify as well.
992 The `fill-column' variable controls the width.
994 Noninteractively, the third argument JUSTIFY specifies which
995 kind of justification to do: `full', `left', `right', `center',
996 or `none' (equivalent to nil). A value of t means handle each
997 paragraph as specified by its text properties.
999 The fourth arg NOSQUEEZE non-nil means to leave whitespace other
1000 than line breaks untouched, and fifth arg TO-EOP non-nil means
1001 to keep filling to the end of the paragraph (or next hard newline,
1002 if variable `use-hard-newlines' is on).
1004 Return the fill-prefix used for filling the last paragraph.
1006 If `sentence-end-double-space' is non-nil, then period followed by one
1007 space does not end a sentence, so don't break a line there."
1015 max beg fill-pfx)
1025 end)
1026 ;; If using hard newlines, break at every one for filling
1027 ;; purposes rather than using paragraph breaks.
1048 fill-pfx))
1050 \f
1052 "Method of justifying text not otherwise specified.
1053 Possible values are `left', `right', `full', `center', or `none'.
1054 The requested kind of justification is done whenever lines are filled.
1055 The `justification' text-property can locally override this variable."
1066 "How should we justify this line?
1067 This returns the value of the text-property `justification',
1068 or the variable `default-justification' if there is no text-property.
1071 ;; Make sure we're looking at paragraph body.
1076 default-justification)))
1078 nil
1079 j)))
1082 "Set the region's justification style to STYLE.
1083 This commands prompts for the kind of justification to use.
1084 If the mark is not active, this command operates on the current paragraph.
1085 If the mark is active, it operates on the region. However, if the
1086 beginning and end of the region are not at paragraph breaks, they are
1087 moved to the beginning and end \(respectively) of the paragraphs they
1088 are in.
1090 If variable `use-hard-newlines' is true, all hard newlines are
1091 taken to be paragraph breaks.
1093 When calling from a program, operates just on region between BEGIN and END,
1094 unless optional fourth arg WHOLE-PAR is non-nil. In that case bounds are
1095 extended to include entire paragraphs as in the interactive command."
1099 "Set justification to: "
1102 nil t)))
1105 t))
1111 paragraph-ignore-fill-prefix)))
1127 "Disable automatic filling for paragraphs in the region.
1128 If the mark is not active, this applies to the current paragraph."
1134 "Make paragraphs in the region left-justified.
1135 This means they are flush at the left margin and ragged on the right.
1136 This is usually the default, but see the variable `default-justification'.
1137 If the mark is not active, this applies to the current paragraph."
1143 "Make paragraphs in the region right-justified.
1144 This means they are flush at the right margin and ragged on the left.
1145 If the mark is not active, this applies to the current paragraph."
1151 "Make paragraphs in the region fully justified.
1152 This makes lines flush on both margins by inserting spaces between words.
1153 If the mark is not active, this applies to the current paragraph."
1159 "Make paragraphs in the region centered.
1160 If the mark is not active, this applies to the current paragraph."
1165 ;; A line has up to six parts:
1166 ;;
1167 ;; >>> hello.
1168 ;; [Indent-1][FP][ Indent-2 ][text][trailing whitespace][newline]
1169 ;;
1170 ;; "Indent-1" is the left-margin indentation; normally it ends at column
1171 ;; given by the `current-left-margin' function.
1172 ;; "FP" is the fill-prefix. It can be any string, including whitespace.
1173 ;; "Indent-2" is added to justify a line if the `current-justification' is
1174 ;; `center' or `right'. In `left' and `full' justification regions, any
1175 ;; whitespace there is part of the line's text, and should not be changed.
1176 ;; Trailing whitespace is not counted as part of the line length when
1177 ;; center- or right-justifying.
1178 ;;
1179 ;; All parts of the line are optional, although the final newline can
1180 ;; only be missing on the last line of the buffer.
1183 "Do some kind of justification on this line.
1184 Normally does full justification: adds spaces to the line to make it end at
1185 the column given by `current-fill-column'.
1186 Optional first argument HOW specifies alternate type of justification:
1187 it can be `left', `right', `full', `center', or `none'.
1188 If HOW is t, will justify however the `current-justification' function says to.
1189 If HOW is nil or missing, full justification is done by default.
1190 Second arg EOP non-nil means that this is the last line of the paragraph, so
1191 it will not be stretched by full justification.
1192 Third arg NOSQUEEZE non-nil means to leave interior whitespace unchanged,
1193 otherwise it is made canonical."
1202 fp-end ; point at end of fill prefix
1203 beg ; point at beginning of line's text
1204 end ; point at end of line's text
1205 indent ; column of `beg'
1206 endcol ; column of `end'
1207 ncols ; new indent point or offset
1209 ; in line (not space characters)
1211 count)
1213 ;; Check if this is the last line of the paragraph.
1218 ;; Quick exit if it appears to be properly justified already
1219 ;; or there is no text.
1223 nil
1227 ;; Skip over fill-prefix.
1240 ;; This is beginning of the line's text.
1246 ;; HOW can't be null or left--we would have exited already
1250 ;; Need to remove some indentation
1257 ;; Need to add some
1260 ;; If point was at beginning of text, keep it there.
1265 ;; Figure out how much indentation is needed
1271 ;; Have too much indentation - remove some
1278 ;; Have too little - add some
1281 ;; If point was at beginning of text, keep it there.
1286 ;; Insert extra spaces between words to justify line
1292 ;; count word spaces in line
1297 ;; Ncols is number of additional space chars needed
1300 count nspaces)
1306 curr-fracspace
1311 nil)
1314 "Remove justification whitespace from current line.
1315 If the line is centered or right-justified, this function removes any
1316 indentation past the left margin. If the line is full-justified, it removes
1317 extra spaces between words. It does nothing in other justification modes."
1327 ;; Position ourselves after any fill-prefix.
1339 "Remove justification whitespace from region.
1340 For centered or right-justified regions, this function removes any indentation
1341 past the left margin from each line. For full-justified lines, it removes
1342 extra spaces between words. It does nothing in other justification modes.
1343 Arguments BEGIN and END are optional; default is the whole buffer."
1352 \f
1354 "Fill paragraphs within the region, allowing varying indentation within each.
1356 only at paragraph-separator lines, then fills each paragraph
1357 using as the fill prefix the smallest indentation of any line
1358 in the paragraph.
1360 When calling from a program, pass range to fill as first two arguments.
1362 Optional third and fourth arguments JUSTIFYP and CITATION-REGEXP:
1363 JUSTIFYP to justify paragraphs (prefix arg).
1364 When filling a mail message, pass a regexp for CITATION-REGEXP
1365 which will match the prefix of a line which is a citation marker
1366 plus whitespace, but no other kind of prefix.
1367 Also, if CITATION-REGEXP is non-nil, don't fill header lines."
1376 "Fill paragraphs of uniform indentation within the region.
1378 treating every change in indentation level or prefix as a paragraph boundary,
1379 then fills each paragraph using its indentation level as the fill prefix.
1381 There is one special case where a change in indentation does not start
1382 a new paragraph. This is for text of this form:
1384 foo> This line with extra indentation starts
1385 foo> a paragraph that continues on more lines.
1387 These lines are filled together.
1389 When calling from a program, pass the range to fill
1390 as the first two arguments.
1392 Optional third and fourth arguments JUSTIFY and CITATION-REGEXP:
1393 JUSTIFY to justify paragraphs (prefix arg).
1394 When filling a mail message, pass a regexp for CITATION-REGEXP
1395 which will match the prefix of a line which is a citation marker
1396 plus whitespace, but no other kind of prefix.
1397 Also, if CITATION-REGEXP is non-nil, don't fill header lines."
1415 ;; Loop over paragraphs.
1417 ;; Skip over all paragraph-separating lines
1418 ;; so as to not include them in any paragraph.
1427 fill-prefix fill-prefix-regexp)
1428 ;; Find end of paragraph, and compute the smallest fill-prefix
1429 ;; that fits all the lines in this paragraph.
1431 ;; Update the fill-prefix on the first line
1432 ;; and whenever the prefix good so far is too long.
1437 citation-regexp)
1441 ;; If forward-line went past a newline,
1442 ;; move further to the left margin.
1444 ;; Now stop the loop if end of paragraph.
1447 ;; If this line is a separator line, with or
1448 ;; without prefix, end the paragraph.
1456 paragraph-separate))))))
1457 ;; If this line has more or less indent
1458 ;; than the fill prefix wants, end the paragraph.
1460 ;; If fill prefix is shorter than a new
1461 ;; fill prefix computed here, end paragraph.
1464 citation-regexp)))
1474 citation-regexp
1476 ;; Fill this paragraph, but don't add a newline at the end.
1485 ;; Accept any prefix rather than just the ones matched by
1486 ;; adaptive-fill-first-line-regexp.
1493 ;; See if the citation part of JUST-ONE-LINE-PREFIX
1494 ;; is the same as that of TWO-LINES-PREFIX,
1495 ;; except perhaps with longer whitespace.
1499 just-one-line-prefix citation-regexp))
1502 two-lines-prefix citation-regexp))
1506 two-lines-citation-part))))
1510 adjusted-two-lines-citation-part)
1512 one-line-citation-part)
1515 two-lines-prefix
1516 just-one-line-prefix))))
1523 string))
1525 ;;; fill.el ends here