| blob | 96023265b039e85e10c99e6cdb45869f8831667e |
1 ;;; fill.el --- fill commands for Emacs
3 ;; Copyright (C) 1985-1986, 1992, 1994-1997, 1999, 2001-2017 Free
4 ;; Software Foundation, Inc.
6 ;; Maintainer: emacs-devel@gnu.org
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 <https://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 "Non-nil means that use a space to separate words of different kind.
54 This will be done with a word in the end of a line and a word in the
55 beginning of the next line when concatenating them for filling those
56 lines. Whether to use a space is up to how the words are categorized."
62 "Mode-specific function to fill a paragraph, or nil if there is none.
63 If the function returns nil, then `fill-paragraph' does its normal work.
65 Note: This only affects `fill-paragraph' and not `fill-region'
66 nor `auto-fill-mode', so it is often better to use some other hook,
74 Kinsoku processing is designed to prevent certain characters from being
75 placed at the beginning or end of a line by filling.
76 See the documentation of `kinsoku' for more information."
81 "Set the fill prefix to the current line up to point.
82 Filling expects lines to start with the fill prefix and
83 reinserts the fill prefix in each resulting line."
97 "Non-nil means determine a paragraph's fill prefix from its text."
102 ;; Added `!' for doxygen comments starting with `//!' or `/*!'.
103 ;; Added `%' for TeX comments.
104 ;; RMS: deleted the code to match `1.' and `(1)'.
105 ;; Update mail-mode's paragraph-separate if you change this.
107 "Regexp to match text at start of line that constitutes indentation.
108 If Adaptive Fill mode is enabled, a prefix matching this pattern
109 on the first and second lines of a paragraph is used as the
110 standard indentation for the whole paragraph.
112 If the paragraph has just one line, the indentation is taken from that
113 line, but in that case `adaptive-fill-first-line-regexp' also plays
114 a role."
119 "Regexp specifying whether to set fill prefix from a one-line paragraph.
120 When a paragraph has just one line, then after `adaptive-fill-regexp'
121 finds the prefix at the beginning of the line, if it doesn't
122 match this regexp, it is replaced with whitespace.
124 By default, this regexp matches sequences of just spaces and tabs.
126 However, we never use a prefix from a one-line paragraph
127 if it would act as a paragraph-starter on the second line."
132 "Function to call to choose a fill prefix for a paragraph, or nil.
133 A nil value means the function has not determined the fill prefix."
141 "Return the fill-column to use for this line.
142 The fill-column to use for a buffer is stored in the variable `fill-column',
143 but can be locally modified by the `right-margin' text property, which is
144 subtracted from `fill-column'.
146 The fill column to use for a line is the first column at which the column
147 number equals or exceeds the local fill-column - right-margin difference."
153 margin fill-col change col)
154 ;; Look separately at each region of line with a different
155 ;; right-margin.
164 here-col col))
168 "Remove extra spaces between words in region.
169 Leave one space between words, two at end of sentences or after colons
170 \(depending on values of `sentence-end-double-space', `colon-double-space',
171 and `sentence-end-without-period').
172 Remove indentation from each line."
174 ;; Ideally, we'd want to scan the text from the end, so that changes to
175 ;; text don't affect the boundary, but the regexp we match against does
176 ;; not match as eagerly when matching backward, so we instead use
177 ;; a marker.
182 ;; Nuke tabs; they get screwed up in a fill.
183 ;; This is quick, but loses when a tab follows the end of a sentence.
184 ;; Actually, it is difficult to tell that from "Mr.\tSmith".
185 ;; Blame the typist.
191 ;; `sentence-end' matched and did not match all spaces.
192 ;; I.e. it only matched the number of spaces it needs: drop the rest.
194 ;; `sentence-end' matched but with nothing left. Either that means
195 ;; nothing should be removed, or it means it's the "old-style"
196 ;; sentence-end which matches all it can. Keep only 2 spaces.
197 ;; We probably don't even need to check `sentence-end-double-space'.
206 ;; Determine number of spaces to leave:
220 "Return the longest common prefix of strings S1 and S2, or nil if none."
223 s1
234 ;; Death to insanely long prefixes.
235 nil
236 str)))
239 "Compute a fill prefix from the text between FROM and TO.
240 This uses the variables `adaptive-fill-regexp' and `adaptive-fill-function'
241 and `adaptive-fill-first-line-regexp'. `paragraph-start' also plays a role;
242 we reject a prefix based on a one-line paragraph if that prefix would
243 act as a paragraph-separator."
249 ;; Move to the second line unless there is just one.
252 ;; Non-nil if we are on the second line.
253 second-line-prefix)
255 ;; We don't need to consider `paragraph-start' here since it
256 ;; will be explicitly checked later on.
257 ;; Also setting first-line-prefix to nil prevents
258 ;; second-line-prefix from being used.
259 ;; ((looking-at paragraph-start) nil)
268 ;; If we get a fill prefix from the second line,
269 ;; make sure it or something compatible is on the first line too.
272 ;; If the non-whitespace chars match the first line,
273 ;; just use it (this subsumes the 2 checks used previously).
274 ;; Used when first line is `/* ...' and second-line is
275 ;; ` * ...'.
281 ;; (assert (string-match "\\`[ \t]*\\'" tmp))
284 second-line-prefix
286 ;; Use the longest common substring of both prefixes,
287 ;; if there is one.
289 second-line-prefix)))))
290 ;; If we get a fill prefix from a one-line paragraph,
291 ;; maybe change it to whitespace,
292 ;; and check that it isn't a paragraph starter.
295 ;; If first-line-prefix comes from the first line,
296 ;; see if it seems reasonable to use for all lines.
297 ;; If not, replace it with whitespace.
300 first-line-prefix))
303 first-line-prefix)))
304 first-line-prefix
306 ;; But either way, reject it if it indicates the start
307 ;; of a paragraph when text follows it.
310 result)))))))
313 "Don't break a line after the first or before the last word of a sentence."
314 ;; Actually, allow breaking before the last word of a sentence, so long as
315 ;; it's not the last word of the paragraph.
325 "Return nil if French style allows breaking the line at point.
326 This is used in `fill-nobreak-predicate' to prevent breaking lines just
327 after an opening paren or just before a closing paren or a punctuation
328 mark such as `?' or `:'. It is common in French writing to put a space
329 at such places, which would normally allow breaking the line at those
330 places."
337 ;; Don't cut right after a single-letter word.
342 "Return non-nil if a one-letter word is before point.
343 This function is suitable for adding to the hook `fill-nobreak-predicate',
344 to prevent the breaking of a line just after a one-letter word,
345 which is an error according to some typographical conventions."
352 "List of predicates for recognizing places not to break a line.
353 The predicates are called with no arguments, with point at the place to
354 be tested. If it returns t, fill commands do not break the line there."
358 fill-single-char-nobreak-p))
361 "Non-nil means that fill commands do not break lines in invisible text."
366 "Return nil if breaking the line at point is allowed.
367 Can be customized with the variables `fill-nobreak-predicate'
368 and `fill-nobreak-invisible'."
373 ;; Don't break after a period followed by just one space.
374 ;; Move back to the previous place to break.
375 ;; The reason is that if a period ends up at the end of a
376 ;; line, further fills will assume it ends a sentence.
377 ;; If we now know it does not end a sentence, avoid putting
378 ;; it at the end of the line.
384 ;; Another approach to the same problem.
389 ;; Don't split a line if the rest would look like a new paragraph.
393 ;; If this break point is at the end of the line,
394 ;; which can occur for auto-fill, don't consider the newline
395 ;; which follows as a reason to return t.
407 ;; Register `kinsoku' for scripts HAN, KANA, BOPOMOFO, and CJK-MISC.
408 ;; Also tell that they don't use space between words.
415 key t)))
416 char-script-table)
417 ;; Do the same thing also for full width characters and half
418 ;; width kana variants.
425 "Move point to a proper line breaking position of the current line.
426 Don't move back past the buffer position LIMIT.
428 This function is called when we are going to break the current line
429 after or before a non-ASCII character. If the charset of the
430 character has the property `fill-find-break-point-function', this
431 function calls the property value as a function with one arg LIMIT.
432 If the charset has no such property, do nothing."
440 "Delete the fill prefix from every line except the first.
441 The first line may not even have a fill prefix.
442 Point is moved to just past the fill prefix on the first line."
451 ;; Why signal an error here? The problem needs to be caught elsewhere.
452 ;; (if (>= (+ (current-left-margin) (length prefix))
453 ;; (current-fill-column))
454 ;; (error "fill-prefix too long for specified width"))
465 ;; The `fill-space' property carries the string with which a newline
466 ;; should be replaced when unbreaking a line (in fill-delete-newlines).
467 ;; It is added to newline characters by fill-newline when the default
468 ;; behavior of fill-delete-newlines is not what we want.
473 ;; Make sure sentences ending at end of line get an extra space.
474 ;; loses on split abbrevs ("Mr.\nSmith")
478 ;; Try to add the : inside the `sentence-end' regexp.
481 ;; Can't find the right spot to insert the colon.
488 sentence-end-without-space-list)
493 ;; Delete unnecessary newlines surrounded by words. The
494 ;; character category `|' means that we can break a line at the
495 ;; character. And, char-table
496 ;; `fill-nospace-between-words-table' tells how to concatenate
497 ;; words. If a character has non-nil value in the table, never
498 ;; put spaces between words, thus delete a newline between them.
499 ;; Otherwise, delete a newline only when a character preceding a
500 ;; newline has non-nil value in that table.
517 ;; Then change all newlines to spaces.
520 nil
522 ;; Remove trailing whitespace.
523 ;; Maybe canonically-space-region should do that.
528 "Move to the position where the line should be broken.
529 The break position will be always after LINEBEG and generally before point."
530 ;; If the fill column is before linebeg, move to linebeg.
532 ;; Move back to the point where we can break the line
533 ;; at. We break the line between word or after/before
534 ;; the character which has character category `|'. We
535 ;; search space, \c| followed by a character, or \c|
536 ;; following a character. If not found, place
537 ;; the point at linebeg.
540 ;; In case of space, we place the point at next to
541 ;; the point where the break occurs actually,
542 ;; because we don't want to change the following
543 ;; logic of original Emacs. In case of \c|, the
544 ;; point is at the place where the break occurs.
548 ;; Move back over the single space between the words.
551 ;; If the left margin and fill prefix by themselves
552 ;; pass the fill-column. or if they are zero
553 ;; but we have no room for even one word,
554 ;; keep at least one word or a character which has
555 ;; category `|' anyway.
557 ;; Ok, skip at least one word or one \c| character.
558 ;; Meanwhile, don't stop at a period followed by one space.
563 ;; Find a breakable point while ignoring the
564 ;; following spaces.
577 ;; If we are going to break the line after or
578 ;; before a non-ascii character, we may have to
579 ;; run a special function for the charset of the
580 ;; character to find the correct break point.
583 ;; Make sure we take SOMETHING after the fill prefix if any.
586 ;; Like text-properties-at but don't include `composition' property.
589 prop-list)
595 prop-list))
598 ;; Replace whitespace here with one newline, then
599 ;; indent to left margin.
602 ;; Give newline the properties of the space(s) it replaces
608 ;; When refilling later on, this newline would normally not be replaced
609 ;; by a space, so we need to mark it specially to re-install the space
610 ;; when we unfill.
612 ;; If we don't want breaks in invisible text, don't insert
613 ;; an invisible newline.
621 ;; Insert the fill prefix after indentation.
623 ;; Markers that were after the whitespace are now at point: insert
624 ;; before them so they don't get stuck before the prefix.
628 "Indent current line to the column given by `current-left-margin'."
634 nosqueeze squeeze-after)
635 "Fill the region as one paragraph.
636 It removes any paragraph breaks in the region and extra newlines at the end,
637 indents and fills lines between the margins given by the
638 `current-left-margin' and `current-fill-column' functions.
639 \(In most cases, the variable `fill-column' controls the width.)
640 It leaves point at the beginning of the line following the paragraph.
642 Normally performs justification according to the `current-justification'
643 function, but with a prefix arg, does full justification instead.
645 From a program, optional third arg JUSTIFY can specify any type of
646 justification. Fourth arg NOSQUEEZE non-nil means not to make spaces
647 between words canonical before filling. Fifth arg SQUEEZE-AFTER, if non-nil,
648 means don't canonicalize spaces before that position.
650 Return the `fill-prefix' used for filling.
652 If `sentence-end-double-space' is non-nil, then period followed by one
653 space does not end a sentence, so don't break a line there."
661 ;; Make sure "to" is the endpoint.
664 ;; Ignore blank lines at beginning of region.
671 ;; We used to round up to whole line, but that prevents us from
672 ;; correctly handling filling of mixed code-and-comment where we do want
673 ;; to fill the comment but not the code. So only use (point) if it's
674 ;; further than `from', which means that `from' is followed by some
675 ;; number of empty lines.
678 ;; Delete all but one soft newline at end of region.
679 ;; And leave TO before that one.
689 ;; ;; If there was no newline, and there is text in the paragraph, then
690 ;; ;; create a newline.
691 ;; (if (and (not oneleft) (> to from-plus-indent))
692 ;; (newline))
696 nil ;; There is no paragraph, only whitespace: exit now.
700 ;; Don't let Adaptive Fill mode alter the fill prefix permanently.
702 ;; Figure out how this paragraph is indented, if desired.
706 ;; Ignore a white-space only fill-prefix
707 ;; if we indent-according-to-mode.
726 ;; Make sure first line is indented (at least) to left margin...
730 ;; Delete the fill-prefix from every line.
734 ;; FROM, and point, are now before the text to fill,
735 ;; but after any fill prefix on the first line.
739 ;; This is the actual filling loop.
746 ;; Find the position where we'll break the line.
747 ;; Use an immediately following space, if any.
748 ;; However, note that `move-to-column' may overshoot
749 ;; if there are wide characters (Bug#3234).
753 ;; Check again to see if we got to the end of
754 ;; the paragraph.
757 ;; Found a place to cut.
761 ;; Justify the line just ended, if desired.
767 ;; Justify this last line, if desired.
769 ;; Leave point after final newline.
772 ;; Return the fill-prefix we used
773 fill-prefix)))
776 "If point is inside the string PREFIX at the beginning of line, move past it."
785 "Fill a paragraph in the minibuffer, ignoring the prompt."
791 "Function to move over paragraphs used by the filling code.
792 It is called with a single argument specifying the number of paragraphs to move.
793 Just like `forward-paragraph', it should return the number of paragraphs
800 "Fill paragraph at or after point.
802 If JUSTIFY is non-nil (interactively, with prefix argument), justify as well.
803 If `sentence-end-double-space' is non-nil, then period followed by one
804 space does not end a sentence, so don't break a line there.
805 The variable `fill-column' controls the width for filling.
807 If `fill-paragraph-function' is non-nil, we call it (passing our
808 argument to it), and if it returns non-nil, we simply return its value.
810 If `fill-paragraph-function' is nil, return the `fill-prefix' used for filling.
812 The REGION argument is non-nil if called interactively; in that
813 case, if Transient Mark mode is enabled and the mark is active,
814 call `fill-region' to fill each of the paragraphs in the active
815 region, instead of just filling the current paragraph."
823 ;; 1. Fill the region if it is active when called interactively.
827 ;; 2. Try fill-paragraph-function.
833 ;; In the minibuffer, don't count
834 ;; the width of the prompt.
836 ;; If fill-paragraph-function is set, it probably
837 ;; takes care of comments and stuff. If not, it
838 ;; will have to set fill-paragraph-handle-comment
839 ;; back to t explicitly or return nil.
843 ;; 3. Try our syntax-aware filling code.
845 ;; Our code only handles \n-terminated comments right now.
849 ;; 4. If it all fails, default to the good ol' text paragraph filling.
852 ;; Fill prefix used for filling the paragraph.
853 fill-pfx)
854 ;; Try to prevent code sections and comment sections from being
855 ;; filled together.
861 ;; To make sure the return value of forward-paragraph is
862 ;; meaningful, we have to start from the beginning of
863 ;; line, otherwise skipping past the last few chars of a
864 ;; paragraph-separator would count as a paragraph (and
865 ;; not skipping any chars at EOB would not count as a
866 ;; paragraph even if it is).
869 ;; There's no paragraph at or after point: give up.
876 ;; Can't use fill-region-as-paragraph, since this
877 ;; paragraph may still contain hard newlines. See
878 ;; fill-region.
881 fill-pfx))
882 ;; If we didn't change anything in the buffer (and the buffer
883 ;; was previously unmodified), then flip the modification status
884 ;; back to "unchanged".
894 "Fill current comment.
895 If we're not in a comment, just return nil so that the caller
896 can take care of filling. JUSTIFY is used as in `fill-paragraph'."
899 comin comstart)
900 ;; Figure out what kind of comment we are looking at.
909 ;; Make sure the comment-start mark we found is accepted by
910 ;; comment-start-skip. If not, all bets are off, and
911 ;; we'd better not mess with it.
915 ;; Return nil, so the normal filling will take place.
916 nil
918 ;; Narrow to include only the comment, and then fill the region.
923 ;; A regexp more specialized than comment-start-skip, that only
924 ;; matches the current commark rather than any valid commark.
925 ;;
926 ;; The specialized regexp only works for "normal" comment
927 ;; syntax, not for Texinfo's "@c" (which can't be immediately
928 ;; followed by word-chars) or Fortran's "C" (which needs to be
929 ;; at bol), so check that comment-start-skip indeed allows the
930 ;; commark to appear in the middle of the line and followed by
931 ;; word chars. The choice of "\0" and "a" is mostly arbitrary.
934 ;; Make sure we only match comments that
935 ;; use the exact same comment marker.
950 beg end)
955 ;; Find the first line we should include in the region to fill.
961 ;; We may have gone too far. Go forward again.
970 ;; Find the beginning of the first line past the region to fill.
975 ;; Obey paragraph starters and boundaries within comments.
977 ;; Use the default values since they correspond to
978 ;; the values to use for plain text.
986 ;; We used to rely on fill-prefix to break paragraph at
987 ;; comment-starter changes, but it did not work for the
988 ;; first line (mixed comment&code).
989 ;; We now use comment-re instead to "manually" make sure
990 ;; we treat comment-marker changes as paragraph boundaries.
991 ;; (paragraph-ignore-fill-prefix nil)
992 ;; (fill-prefix comment-fill-prefix)
996 ;; If this comment starts on a line with code,
997 ;; include that line in the filling.
1003 ;; Find the fill-prefix to use.
1012 ;; Don't fill with narrowing.
1016 ;; Don't canonicalize spaces within the code just before
1017 ;; the comment.
1021 nil
1023 ;; Make sure we don't return nil.
1024 t))))))
1027 "Fill each of the paragraphs in the region.
1028 A prefix arg means justify as well.
1029 The `fill-column' variable controls the width.
1031 Noninteractively, the third argument JUSTIFY specifies which
1032 kind of justification to do: `full', `left', `right', `center',
1033 or `none' (equivalent to nil). A value of t means handle each
1034 paragraph as specified by its text properties.
1036 The fourth arg NOSQUEEZE non-nil means to leave whitespace other
1037 than line breaks untouched, and fifth arg TO-EOP non-nil means
1038 to keep filling to the end of the paragraph (or next hard newline,
1039 if variable `use-hard-newlines' is on).
1041 Return the fill-prefix used for filling the last paragraph.
1043 If `sentence-end-double-space' is non-nil, then period followed by one
1044 space does not end a sentence, so don't break a line there."
1052 max beg fill-pfx)
1062 end)
1063 ;; If using hard newlines, break at every one for filling
1064 ;; purposes rather than using paragraph breaks.
1085 fill-pfx))
1087 \f
1089 "Method of justifying text not otherwise specified.
1090 Possible values are `left', `right', `full', `center', or `none'.
1091 The requested kind of justification is done whenever lines are filled.
1092 The `justification' text-property can locally override this variable."
1103 "How should we justify this line?
1104 This returns the value of the text-property `justification',
1105 or the variable `default-justification' if there is no text-property.
1108 ;; Make sure we're looking at paragraph body.
1113 default-justification)))
1115 nil
1116 j)))
1119 "Set the region's justification style to STYLE.
1120 This commands prompts for the kind of justification to use.
1121 If the mark is not active, this command operates on the current paragraph.
1122 If the mark is active, it operates on the region. However, if the
1123 beginning and end of the region are not at paragraph breaks, they are
1124 moved to the beginning and end \(respectively) of the paragraphs they
1125 are in.
1127 If variable `use-hard-newlines' is true, all hard newlines are
1128 taken to be paragraph breaks.
1130 When calling from a program, operates just on region between BEGIN and END,
1131 unless optional fourth arg WHOLE-PAR is non-nil. In that case bounds are
1132 extended to include entire paragraphs as in the interactive command."
1136 "Set justification to: "
1139 nil t)))
1142 t))
1148 paragraph-ignore-fill-prefix)))
1164 "Disable automatic filling for paragraphs in the region.
1165 If the mark is not active, this applies to the current paragraph."
1171 "Make paragraphs in the region left-justified.
1172 This means they are flush at the left margin and ragged on the right.
1173 This is usually the default, but see the variable `default-justification'.
1174 If the mark is not active, this applies to the current paragraph."
1180 "Make paragraphs in the region right-justified.
1181 This means they are flush at the right margin and ragged on the left.
1182 If the mark is not active, this applies to the current paragraph."
1188 "Make paragraphs in the region fully justified.
1189 This makes lines flush on both margins by inserting spaces between words.
1190 If the mark is not active, this applies to the current paragraph."
1196 "Make paragraphs in the region centered.
1197 If the mark is not active, this applies to the current paragraph."
1202 ;; A line has up to six parts:
1203 ;;
1204 ;; >>> hello.
1205 ;; [Indent-1][FP][ Indent-2 ][text][trailing whitespace][newline]
1206 ;;
1207 ;; "Indent-1" is the left-margin indentation; normally it ends at column
1208 ;; given by the `current-left-margin' function.
1209 ;; "FP" is the fill-prefix. It can be any string, including whitespace.
1210 ;; "Indent-2" is added to justify a line if the `current-justification' is
1211 ;; `center' or `right'. In `left' and `full' justification regions, any
1212 ;; whitespace there is part of the line's text, and should not be changed.
1213 ;; Trailing whitespace is not counted as part of the line length when
1214 ;; center- or right-justifying.
1215 ;;
1216 ;; All parts of the line are optional, although the final newline can
1217 ;; only be missing on the last line of the buffer.
1220 "Do some kind of justification on this line.
1221 Normally does full justification: adds spaces to the line to make it end at
1222 the column given by `current-fill-column'.
1223 Optional first argument HOW specifies alternate type of justification:
1224 it can be `left', `right', `full', `center', or `none'.
1225 If HOW is t, will justify however the `current-justification' function says to.
1226 If HOW is nil or missing, full justification is done by default.
1227 Second arg EOP non-nil means that this is the last line of the paragraph, so
1228 it will not be stretched by full justification.
1229 Third arg NOSQUEEZE non-nil means to leave interior whitespace unchanged,
1230 otherwise it is made canonical."
1239 fp-end ; point at end of fill prefix
1240 beg ; point at beginning of line's text
1241 end ; point at end of line's text
1242 indent ; column of `beg'
1243 endcol ; column of `end'
1244 ncols ; new indent point or offset
1246 ; in line (not space characters)
1248 count)
1250 ;; Check if this is the last line of the paragraph.
1255 ;; Quick exit if it appears to be properly justified already
1256 ;; or there is no text.
1260 nil
1264 ;; Skip over fill-prefix.
1277 ;; This is beginning of the line's text.
1283 ;; HOW can't be null or left--we would have exited already
1287 ;; Need to remove some indentation
1294 ;; Need to add some
1297 ;; If point was at beginning of text, keep it there.
1302 ;; Figure out how much indentation is needed
1308 ;; Have too much indentation - remove some
1315 ;; Have too little - add some
1318 ;; If point was at beginning of text, keep it there.
1323 ;; Insert extra spaces between words to justify line
1329 ;; count word spaces in line
1334 ;; Ncols is number of additional space chars needed
1337 count nspaces)
1343 curr-fracspace
1348 nil)
1351 "Remove justification whitespace from current line.
1352 If the line is centered or right-justified, this function removes any
1353 indentation past the left margin. If the line is full-justified, it removes
1354 extra spaces between words. It does nothing in other justification modes."
1364 ;; Position ourselves after any fill-prefix.
1376 "Remove justification whitespace from region.
1377 For centered or right-justified regions, this function removes any indentation
1378 past the left margin from each line. For full-justified lines, it removes
1379 extra spaces between words. It does nothing in other justification modes.
1380 Arguments BEGIN and END are optional; default is the whole buffer."
1389 \f
1391 "Fill paragraphs within the region, allowing varying indentation within each.
1393 only at paragraph-separator lines, then fills each paragraph
1394 using as the fill prefix the smallest indentation of any line
1395 in the paragraph.
1397 When calling from a program, pass range to fill as first two arguments.
1399 Optional third and fourth arguments JUSTIFYP and CITATION-REGEXP:
1400 JUSTIFYP to justify paragraphs (prefix arg).
1401 When filling a mail message, pass a regexp for CITATION-REGEXP
1402 which will match the prefix of a line which is a citation marker
1403 plus whitespace, but no other kind of prefix.
1404 Also, if CITATION-REGEXP is non-nil, don't fill header lines."
1413 "Fill paragraphs of uniform indentation within the region.
1415 treating every change in indentation level or prefix as a paragraph boundary,
1416 then fills each paragraph using its indentation level as the fill prefix.
1418 There is one special case where a change in indentation does not start
1419 a new paragraph. This is for text of this form:
1421 foo> This line with extra indentation starts
1422 foo> a paragraph that continues on more lines.
1424 These lines are filled together.
1426 When calling from a program, pass the range to fill
1427 as the first two arguments.
1429 Optional third and fourth arguments JUSTIFY and CITATION-REGEXP:
1430 JUSTIFY to justify paragraphs (prefix arg).
1431 When filling a mail message, pass a regexp for CITATION-REGEXP
1432 which will match the prefix of a line which is a citation marker
1433 plus whitespace, but no other kind of prefix.
1434 Also, if CITATION-REGEXP is non-nil, don't fill header lines."
1452 ;; Loop over paragraphs.
1454 ;; Skip over all paragraph-separating lines
1455 ;; so as to not include them in any paragraph.
1464 fill-prefix fill-prefix-regexp)
1465 ;; Find end of paragraph, and compute the smallest fill-prefix
1466 ;; that fits all the lines in this paragraph.
1468 ;; Update the fill-prefix on the first line
1469 ;; and whenever the prefix good so far is too long.
1474 citation-regexp)
1478 ;; If forward-line went past a newline,
1479 ;; move further to the left margin.
1481 ;; Now stop the loop if end of paragraph.
1484 ;; If this line is a separator line, with or
1485 ;; without prefix, end the paragraph.
1493 paragraph-separate))))))
1494 ;; If this line has more or less indent
1495 ;; than the fill prefix wants, end the paragraph.
1497 ;; If fill prefix is shorter than a new
1498 ;; fill prefix computed here, end paragraph.
1501 citation-regexp)))
1511 citation-regexp
1513 ;; Fill this paragraph, but don't add a newline at the end.
1522 ;; Accept any prefix rather than just the ones matched by
1523 ;; adaptive-fill-first-line-regexp.
1530 ;; See if the citation part of JUST-ONE-LINE-PREFIX
1531 ;; is the same as that of TWO-LINES-PREFIX,
1532 ;; except perhaps with longer whitespace.
1536 just-one-line-prefix citation-regexp))
1539 two-lines-prefix citation-regexp))
1543 two-lines-citation-part))))
1547 adjusted-two-lines-citation-part)
1549 one-line-citation-part)
1552 two-lines-prefix
1553 just-one-line-prefix))))
1560 string))
1562 ;;; fill.el ends here