| blob | 11a77a2ab91f5b46e7b38b821bb01827849a55f6 |
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985,1987,1992-2001 Free Software Foundation, Inc.
5 ;; Authors: 2000- Martin Stjernholm
6 ;; 1998-1999 Barry A. Warsaw and Martin Stjernholm
7 ;; 1992-1997 Barry A. Warsaw
8 ;; 1987 Dave Detlefs and Stewart Clamen
9 ;; 1985 Richard M. Stallman
10 ;; Maintainer: bug-cc-mode@gnu.org
11 ;; Created: 22-Apr-1997 (split from cc-mode.el)
12 ;; Version: See cc-mode.el
13 ;; Keywords: c languages oop
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with this program; see the file COPYING. If not, write to
29 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
30 ;; Boston, MA 02111-1307, USA.
32 ;;; Commentary:
34 ;;; Code:
41 load-path)))
49 ;; Silence the compiler.
54 ; which looks at this.
56 \f
58 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
59 ;; arg is nil or zero, toggle the state. If arg is negative, turn
60 ;; the state off, and if arg is positive, turn the state on
66 ;; Auto-newline and hungry-delete
68 "Toggle auto-newline feature.
69 Optional numeric ARG, if supplied, turns on auto-newline when
70 positive, turns it off when negative, and just toggles it when zero or
71 left out.
73 When the auto-newline feature is enabled (as evidenced by the `/a' or
74 `/ah' on the modeline after the mode name) newlines are automatically
75 inserted after special characters such as brace, comma, semi-colon,
76 and colon."
83 "Toggle hungry-delete-key feature.
84 Optional numeric ARG, if supplied, turns on hungry-delete when
85 positive, turns it off when negative, and just toggles it when zero or
86 left out.
88 When the hungry-delete-key feature is enabled (as evidenced by the
89 `/h' or `/ah' on the modeline after the mode name) the delete key
90 gobbles all preceding whitespace in one fell swoop."
97 "Toggle auto-newline and hungry-delete-key features.
98 Optional numeric ARG, if supplied, turns on auto-newline and
99 hungry-delete when positive, turns them off when negative, and just
100 toggles them when zero or left out.
102 See `c-toggle-auto-state' and `c-toggle-hungry-state' for details."
109 \f
110 ;; Electric keys
113 "Deletes preceding character or whitespace.
116 consumed. If however a prefix argument is supplied, or
117 `c-hungry-delete-key' is nil, or point is inside a literal then the
118 function in the variable `c-backspace-function' is called.
123 arg
131 ))))
134 "Deletes following character or whitespace.
137 consumed. If however a prefix argument is supplied, or
138 `c-hungry-delete-key' is nil, or point is inside a literal then the
139 function in the variable `c-delete-function' is called."
142 arg
152 "Deletes preceding or following character or whitespace.
153 This function either deletes forward as `c-electric-delete-forward' or
154 backward as `c-electric-backspace', depending on the configuration:
156 If the function `delete-forward-p' is defined (XEmacs 21) and returns
157 non-nil, it deletes forward. Else, if the variable
158 `delete-key-deletes-forward' is defined (XEmacs 20) and is set to
159 non-nil, it deletes forward. Otherwise it deletes backward.
161 Note: This is the way in XEmacs 20 and later to choose the correct
162 action for the [delete] key, whichever key that means. In other
163 flavors this function isn't used, instead it's left to the user to
164 bind [delete] to either \\[c-electric-delete-forward] or \\[c-electric-backspace] as appropriate
165 \(the keymap `function-key-map' is useful for that). Emacs 21 handles
166 that automatically, though."
171 delete-key-deletes-forward))
176 "Electric pound (`#') insertion.
177 Inserts a `#' character specially depending on the variable
178 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if
179 point is inside a literal, nothing special happens."
185 ;; do nothing special
187 ;; place the pound character at the left edge
195 )))
198 "Insert a brace.
202 after braces based on the value of `c-hanging-braces-alist'.
204 Also, the line is re-indented unless a numeric ARG is supplied, there
205 are non-whitespace characters present on the line after the brace, the
206 brace is inserted inside a literal, or `c-syntactic-indentation' is
207 nil.
209 This function does various newline cleanups based on the value of
210 `c-cleanup-list'."
215 ;; if we're in a literal, or we're not at the end of the line, or
216 ;; a numeric arg is provided, or auto-newlining is turned off,
217 ;; then just insert the character.
219 arg
223 ;; This is the list of brace syntactic symbols that can
224 ;; hang. If any new ones are added to c-offsets-alist,
225 ;; they should be added here as well.
227 inline-open inline-close
228 brace-list-open brace-list-close
229 brace-list-intro brace-entry-open
230 block-open block-close
231 substatement-open statement-case-open
232 extern-lang-open extern-lang-close
233 namespace-open namespace-close
234 inexpr-class-open inexpr-class-close
235 ))
236 ;; we want to inhibit blinking the paren since this will
237 ;; be most disruptive. we'll blink it ourselves later on
239 blink-paren-function
241 delete-temp-newline
244 ;; shut this up too
247 ;; only insert a newline if there is
248 ;; non-whitespace behind us
257 ;; state cache doesn't change
260 c-auto-newline
262 syms
263 ;; Substitute inexpr-class and class-open
264 ;; or class-close with inexpr-class-open
265 ;; or inexpr-class-close.
272 syntax)
273 c-hanging-braces-alist)
275 ;; Do not try to insert newlines around a special (Pike-style)
276 ;; brace list.
284 ;; If syntax is a function symbol, then call it using the
285 ;; defined semantics.
291 ;; does a newline go before the open brace?
293 ;; we leave the newline we've put in there before,
294 ;; but we need to re-indent the line above
302 ;; we may need to update the cache. this should
303 ;; still be faster than recalculating the state
304 ;; in many cases
312 t))))
319 c-state-cache))
321 ;; if the buffer has changed due to the indentation, we
322 ;; need to recalculate syntax for the current line, but
323 ;; we won't need to update the state cache.
326 ;; must remove the newline we just stuck in (if we really did it)
329 ;; if there is whitespace before point, then preserve
330 ;; at least one space.
336 ;; since we're hanging the brace, we need to recalculate
337 ;; syntax. Update the state to accurately reflect the
338 ;; beginning of the line. We punt if we cross any open or
339 ;; closed parens because its just too hard to modify the
340 ;; known state. This limitation will be fixed in v5.
345 ;; gotta punt. this requires some horrible kludgery
349 syntax nil))))
350 )
351 ;; Now adjust the line's indentation. Don't update the state
352 ;; cache since c-guess-basic-syntax isn't called when
353 ;; c-syntactic-context is set.
360 c-state-cache)))
361 ;; Do all appropriate clean ups
364 mbeg mend tmp)
365 ;; clean up empty defun braces
370 syntax)
375 ;; make sure matching open brace isn't in a comment
378 ;; clean up brace-else-brace and brace-elseif-brace
403 nil t))
409 )
410 ;; does a newline go after the brace?
414 ;; update on c-state-cache
419 ;; blink the paren
421 old-blink-paren
425 ))))
428 "Insert a slash character.
430 Indent the line as a comment, if:
432 1. The slash is second of a `//' line oriented comment introducing
433 token and we are on a comment-only-line, or
435 2. The slash is part of a `*/' token that closes a block oriented
436 comment.
438 If a numeric ARG is supplied, point is inside a literal, or
439 `c-syntactic-indentation' is nil, indentation is inhibited."
449 ))
450 ;; shut this up
457 "Insert a star character.
458 If the star is the second character of a C style comment introducing
459 construct, and we are on a comment-only-line, indent line as comment.
460 If a numeric ARG is supplied, point is inside a literal, or
461 `c-syntactic-indentation' is nil, indentation is inhibited."
464 ;; if we are in a literal, or if arg is given do not re-indent the
465 ;; current line, unless this star introduces a comment-only line.
479 ))
482 "Insert a comma or semicolon.
485 the variable `c-hanging-semi&comma-criteria' for how newline insertion
486 is determined.
488 When semicolon is inserted, the line is re-indented unless a numeric
489 arg is supplied, point is inside a literal, or there are
490 non-whitespace characters on the line following the semicolon, or
491 `c-syntactic-indentation' is nil.
493 Based on the value of `c-cleanup-list', this function cleans up commas
494 following brace lists and semicolons following defuns."
499 ;; shut this up
502 arg
505 ;; do some special stuff with the character
507 ;; do all cleanups and newline insertions if c-auto-newline is
508 ;; turned on
512 ;; clean ups
524 ;; make sure matching open brace isn't in a comment
528 ;; re-indent line
531 ;; check to see if a newline should be added
533 answer add-newline-p)
536 ;; only nil value means continue checking
540 ;; only 'stop specifically says do not add a newline
542 ))
546 )))))
549 "Insert a colon.
553 after colons based on the value of `c-hanging-colons-alist'.
555 Also, the line is re-indented unless a numeric ARG is supplied, there
556 are non-whitespace characters present on the line after the colon, the
557 colon is inserted inside a literal, or `c-syntactic-indentation' is
558 nil.
560 This function cleans up double colon scope operators based on the
561 value of `c-cleanup-list'."
565 syntax newlines is-scope-op
566 ;; shut this up
569 arg
572 ;; insert the colon, then do any specified cleanups
589 ;; lets do some special stuff with the colon character
591 ;; some language elements can only be determined by
592 ;; checking the following line. Lets first look for ones
593 ;; that can be found when looking on the line with the
594 ;; colon
595 newlines
598 syntax c-hanging-colons-alist)
605 c-hanging-colons-alist))))
606 ;; indent the current line if it's done syntactically.
610 ;; does a newline go before the colon? Watch out for already
611 ;; non-hung colons. However, we don't unhang them because that
612 ;; would be a cleanup (and anti-social).
623 ;; does a newline go after the colon?
629 )))
632 "Insert a less-than, or greater-than character.
633 The line will be re-indented if the character inserted is the second
634 of a C++ style stream operator and the buffer is in C++ mode.
635 Exceptions are when a numeric argument is supplied, point is inside a
636 literal, or `c-syntactic-indentation' is nil, in which case the line
637 will not be re-indented."
643 ;; shut this up
650 "Insert a parenthesis.
652 Some newline cleanups are done if appropriate; see the variable
653 `c-cleanup-list'.
655 Also, the line is re-indented unless a numeric ARG is supplied, there
656 are non-whitespace characters present on the line after the
657 parenthesis, the parenthesis is inserted inside a literal, or
658 `c-syntactic-indentation' is nil."
665 ;; do some special stuff with the character
667 ;; be most disruptive. We'll blink it ourselves
668 ;; afterwards.
670 blink-paren-function)
676 ;; Do all appropriate clean ups
679 mbeg mend)
680 ;; clean up brace-elseif-brace
684 nil t)
693 ;; clean up brace-catch-brace
706 )))
733 "Reindent the current line if appropriate.
735 This function is used to reindent the line after a keyword which
739 The line is reindented if there is nothing but whitespace before the
740 keyword on the line, the keyword is not inserted inside a literal, and
741 `c-syntactic-indentation' is non-nil."
753 \f
754 ;; better movement routines for ThisStyleOfVariablesCommonInCPlusPlus
755 ;; originally contributed by Terry_Glanfield.Southern@rxuk.xerox.com
757 "Move forward to end of a nomenclature section or word.
758 With arg, to it arg times."
772 "Move backward to beginning of a nomenclature section or word.
773 With optional ARG, move that many times. If ARG is negative, move
774 forward."
780 "Insert a double colon scope operator at point.
786 "Move backward to the beginning of a defun.
787 With argument, do it that many times. Negative arg -N
788 means move forward to Nth following beginning of defun.
789 Returns t unless search stops due to beginning or end of buffer.
791 Unlike the built-in `beginning-of-defun' this tries to be smarter
792 about finding the char with open-parenthesis syntax that starts the
793 defun."
800 prevbod bod)
806 bod nil)))
817 "Move forward to next end of defun. With argument, do it that many times.
818 Negative argument -N means move back to Nth preceding end of defun.
819 Returns t unless search stops due to beginning or end of buffer.
821 An end of a defun occurs right after the close-parenthesis that matches
822 the open-parenthesis that starts a defun; see `beginning-of-defun'."
830 eol)
833 ;; skip down into the next defun-block
840 ;; Don't move to next line for one line defuns.
849 \f
851 "Go to the beginning of the innermost C statement.
852 With prefix arg, go back N - 1 statements. If already at the
853 beginning of a statement then go to the beginning of the closest
854 preceding one, moving into nested blocks if necessary (use
856 comment or multiline string, move by sentences instead of statements.
858 When called from a program, this function takes 3 optional args: the
859 repetition count, a buffer position limit which is the farthest back
860 to search for the syntactic context, and a flag saying whether to do
861 sentence motion in or near comments and multiline strings."
863 nil t))
865 here
872 ;; Find the comment next to point if we're not in one.
883 ;; skip-syntax-* doesn't count \n as whitespace..
893 nil))))
896 ;; Special case because eob might be in a literal.
901 ;; Only visit a string if it spans more than one line.
908 c-current-comment-prefix
928 ;; Move by sentence, but not past the limit of the
929 ;; literal, narrowed to the appropriate
930 ;; paragraph(s).
943 end)
946 ;; Check if we stopped due to a comment
947 ;; prefix and not a sentence end.
958 ;; The comment prefix may contain
959 ;; characters that is regarded as end
960 ;; of sentence.
969 sentence-end
971 t))
977 ;; In block comments, if there's only
978 ;; horizontal ws between the text and the
979 ;; comment ender, stop before it. Stop after
980 ;; the ender if there's either nothing or
981 ;; newlines between.
991 ;; Stop before instead of after the comment
992 ;; starter if nothing follows it.
997 range nil))))))
998 ;; See if we should escape the literal.
1010 ;; Below we do approximately the same as
1011 ;; c-beginning-of-statement-1 and c-end-of-statement-1, and
1012 ;; perhaps they should be changed, but that'd likely break a
1013 ;; lot in cc-engine.
1017 ;; Stop before `{' and after `;', `{', `}' and `};'
1018 ;; when not followed by `}' or `)', but on the other
1019 ;; side of the syntactic ws. Move by sexps and move
1020 ;; into parens. Also stop before `#' when it's at boi
1021 ;; on a line.
1024 last last-below-line)
1031 )
1044 ;; Record position of first comment.
1078 ;; Break at multiline string.
1082 )))
1085 ;; We jumped over a comment or string that
1086 ;; should be investigated.
1093 ;; Stop before `{', `}', and `#' when it's at boi on a
1094 ;; line, but on the other side of the syntactic ws, and
1095 ;; after `;', `}' and `};'. Only stop before `{' if at
1096 ;; top level or inside braces, though. Move by sexps
1097 ;; and move into parens. Also stop at eol of lines
1098 ;; with `#' at the boi.
1101 last)
1109 ;; Record position of first comment.
1150 ;; Break at multiline string.
1156 )))
1159 ;; We jumped over a comment that should be investigated.
1165 ))
1166 ;; If we haven't moved we're near a buffer limit.
1173 "Go to the end of the innermost C statement.
1174 With prefix arg, go forward N - 1 statements. Move forward to the end
1175 of the next statement if already at end, and move into nested blocks
1177 comment or multiline string, move by sentences instead of statements.
1179 When called from a program, this function takes 3 optional args: the
1180 repetition count, a buffer position limit which is the farthest back
1181 to search for the syntactic context, and a flag saying whether to do
1182 sentence motion in or near comments and multiline strings."
1184 nil t))
1188 \f
1189 ;; set up electric character functions to work with pending-del,
1190 ;; (a.k.a. delsel) mode. All symbols get the t value except
1191 ;; the functions which delete, which gets 'supersede.
1198 c-electric-brace
1199 c-electric-slash
1200 c-electric-star
1201 c-electric-semi&comma
1202 c-electric-lt-gt
1203 c-electric-colon
1204 c-electric-paren))
1212 \f
1213 ;; This is used by indent-for-comment to decide how much to indent a
1214 ;; comment in C code based on its context.
1219 placeholder)
1223 ;; CASE 1: A comment following a solitary close-brace should
1224 ;; have only one space.
1226 c-comment-start-regexp
1230 ;; CASE 2: 2 spaces after #endif
1234 ;; CASE 3: when c-indent-comments-syntactically-p is t,
1235 ;; calculate the offset according to c-offsets-alist.
1236 ;; E.g. identical to hitting TAB.
1243 ;; BOGOSITY ALERT: if we're looking at the eol, its
1244 ;; because indent-for-comment hasn't put the comment-start
1245 ;; in the buffer yet. this will screw up the syntactic
1246 ;; analysis so we kludge in the necessary info. Another
1247 ;; kludge is that if we're at the bol, then we really want
1248 ;; to ignore any anchoring as specified by
1249 ;; c-comment-only-line-offset since it doesn't apply here.
1256 c-comment-only-line-offset
1258 c-comment-only-line-offset))))
1260 ;; CASE 4: If previous line is a comment-only line, use its
1261 ;; indentation if it's greater than comment-column. Leave at
1262 ;; least one space between the comment and the last nonblank
1263 ;; character in any case.
1275 placeholder
1276 comment-column))
1277 ;; CASE 5: If comment-column is 0, and nothing but space
1278 ;; before the comment, align it at 0 rather than 1.
1284 ;; CASE 6: indent at comment column except leave at least one
1285 ;; space.
1287 comment-column))
1288 )))))
1290 \f
1291 ;; used by outline-minor-mode
1293 ;; This so that `current-column' DTRT in otherwise-hidden text.
1299 \f
1301 "Move back to the containing preprocessor conditional, leaving mark behind.
1302 A prefix argument acts as a repeat count. With a negative argument,
1303 move forward to the end of the containing preprocessor conditional.
1305 `#elif' is treated like `#else' followed by `#if', so the function
1306 stops at them when going backward, but not when going forward."
1312 "Move back to the containing preprocessor conditional, including `#else'.
1313 Just like `c-up-conditional', except it also stops at `#else'
1314 directives."
1320 "Move forward into the next preprocessor conditional, leaving mark behind.
1321 A prefix argument acts as a repeat count. With a negative argument,
1322 move backward into the previous preprocessor conditional.
1324 `#elif' is treated like `#else' followed by `#if', so the function
1325 stops at them when going forward, but not when going backward."
1331 "Move forward into the next preprocessor conditional, including `#else'.
1332 Just like `c-down-conditional', except it also stops at `#else'
1333 directives."
1339 "Move back across a preprocessor conditional, leaving mark behind.
1340 A prefix argument acts as a repeat count. With a negative argument,
1341 move forward across a preprocessor conditional."
1347 "Move forward across a preprocessor conditional, leaving mark behind.
1348 A prefix argument acts as a repeat count. With a negative argument,
1349 move backward across a preprocessor conditional.
1351 `#elif' is treated like `#else' followed by `#if', except that the
1352 nesting level isn't changed when tracking subconditionals.
1354 The optional argument TARGET-DEPTH specifies the wanted nesting depth
1355 after each scan. I.e. if TARGET-DEPTH is -1, the function will move
1356 out of the enclosing conditional. A non-integer non-nil TARGET-DEPTH
1357 counts as -1.
1359 If the optional argument WITH-ELSE is non-nil, `#else' directives are
1360 treated as conditional clause limits. Normally they are ignored."
1371 ;; subdepth is the depth in "uninteresting" subtrees,
1372 ;; i.e. those that takes us farther from the target
1373 ;; depth instead of closer.
1375 found)
1377 ;; Find the "next" significant line in the proper direction.
1379 ;; Rather than searching for a # sign that
1380 ;; comes at the beginning of a line aside from
1381 ;; whitespace, search first for a string
1382 ;; starting with # sign. Then verify what
1383 ;; precedes it. This is faster on account of
1384 ;; the fastmap feature of the regexp matcher.
1387 nil t))
1389 ;; Now verify it is really a preproc line.
1397 ;; When we're not in an "uninteresting"
1398 ;; subtree, we might want to act on "elif"
1399 ;; and "else" too.
1401 ;; Always move toward the target depth.
1406 ;; Ignore the change if it'd take us
1407 ;; into an "uninteresting" subtree.
1415 ;; If we are trying to move across, and we find an
1416 ;; end before we find a beginning, get an error.
1419 "No following conditional at this level"
1421 ;; When searching forward, start from next line so
1422 ;; that we don't find the same line again.
1424 ;; We found something if we've arrived at the
1425 ;; target depth.
1428 ;; else
1438 \f
1439 ;; commands to indent lines, regions, defuns, and expressions
1441 "Indent current line as C code, and/or insert some whitespace.
1443 If `c-tab-always-indent' is t, always just indent the current line.
1444 If nil, indent the current line only if point is at the left margin or
1445 in the line's indentation; otherwise insert some whitespace[*]. If
1446 other than nil or t, then some whitespace[*] is inserted only within
1447 literals (comments and strings) and inside preprocessor directives,
1448 but the line is always reindented.
1450 If `c-syntactic-indentation' is t, indentation is done according to
1451 the syntactic context. If it's nil, the line is just indented one
1452 step according to `c-basic-offset'. In this mode, a numeric argument
1453 indents a number of such steps, positive or negative, and an empty
1454 prefix argument is equivalent to -1.
1456 If `c-syntactic-indentation' is t, then a numeric argument, regardless
1457 of its value, means indent rigidly all the lines of the expression
1458 starting after point so that this line becomes properly indented. The
1459 relative indentation among the lines of the expression is preserved.
1461 [*] The amount and kind of whitespace inserted is controlled by the
1462 variable `c-insert-tab-function', which is called to do the actual
1463 insertion of whitespace. Normally the function in this variable
1464 just inserts a tab character, or the equivalent number of spaces,
1465 depending on the variable `indent-tabs-mode'."
1477 ))))
1479 ;; If c-syntactic-indentation and got arg, always indent this
1480 ;; line as C and shift remaining lines of expression the same
1481 ;; amount.
1485 beg end)
1490 shift-amt))
1502 ;; Else use c-tab-always-indent to determine behavior.
1504 ;; CASE 1: indent when at column zero or in lines indentation,
1505 ;; otherwise insert a tab
1512 ;; CASE 2: just indent the line
1515 ;; CASE 3: if in a literal, insert a tab, but always indent the
1516 ;; line
1521 )))))
1524 "Indent each line in the balanced expression following point syntactically.
1525 If optional SHUTUP-P is non-nil, no errors are signalled if no
1526 balanced expression is found."
1529 end)
1533 ;; try to be smarter about finding the range of
1534 ;; lines to indent. skip all following
1535 ;; whitespace, then try to find any
1536 ;; opening paren on the current line
1541 ;; find balanced expression end
1544 ;; sanity check
1560 "Indent the current top-level function def, struct or class declaration
1561 syntactically."
1567 ;; if we're sitting at b-o-b, it might be because there was no
1568 ;; least enclosing brace and we were sitting on the defun's open
1569 ;; brace.
1572 ;; if defun-prompt-regexp is non-nil, b-o-d might not leave us at
1573 ;; the open brace. I consider this an Emacs bug.
1575 defun-prompt-regexp
1578 ;; catch all errors in c-indent-exp so we can 1. give more
1579 ;; meaningful error message, and 2. restore point
1586 "Indent every line whose first char is between START and END inclusive.
1587 Be silent about syntactic errors if the optional argument QUIET is non-nil."
1590 ;; Advance to first nonblank line.
1596 ;; shut up any echo msgs on indiv lines
1604 ;; update progress
1606 ;; skip blank lines
1609 ;; indent the current line
1615 c-parsing-error))))
1618 "Put mark at end of current top-level defun, point at beginning."
1623 ;; Are we sitting at the top level, someplace between either the
1624 ;; beginning of buffer, or the nearest preceding defun? If so,
1625 ;; try first to figure out whether we're sitting on the
1626 ;; introduction to a top-level defun, in which case we want to
1627 ;; mark the entire defun we're sitting on.
1628 ;;
1629 ;; If we're sitting on anything else at the top-level, we want to
1630 ;; just mark the statement that we're on
1634 ;; Are we in the whitespace after the nearest preceding defun?
1649 ;; We must be in a defuns's introduction
1655 ;; Just mark the statement
1660 ;; We are inside some enclosing brace structure, so we first
1661 ;; need to find our way to the least enclosing brace. Then, in
1662 ;; both cases, we to mark the region from the beginning of the
1663 ;; current statement, until the end of the next following defun
1673 ;; Function version of the macro for use in places that aren't
1674 ;; compiled, e.g. in the menus.
1678 "When the region is active, indent it. Otherwise indent the current line."
1679 ;; Emacs has a variable called mark-active, XEmacs uses region-active-p
1685 \f
1686 ;; for progress reporting
1691 ;; Be silent
1693 ;; Start the progress update messages. If this Emacs doesn't have
1694 ;; a built-in timer, just be dumb about it.
1697 ;; If progress has already been initialized, do nothing. otherwise
1698 ;; initialize the counter with a vector of:
1699 ;; [start end lastsec context]
1706 context))
1708 ))
1711 ;; update progress
1713 nil
1718 ;; should we update? currently, update happens every 2 seconds,
1719 ;; what's the right value?
1725 )))
1728 ;; finished
1730 nil
1739 \f
1740 ;;; This page handles insertion and removal of backslashes for C macros.
1743 "Insert, align, or delete end-of-line backslashes on the lines in the region.
1744 With no argument, inserts backslashes and aligns existing backslashes.
1745 With an argument, deletes the backslashes.
1747 This function does not modify blank lines at the start of the region.
1748 If the region ends at the start of a line, it always deletes the
1749 backslash (if any) at the end of the previous line.
1751 You can put the region around an entire macro definition and use this
1752 command to conveniently insert and align the necessary backslashes."
1759 ;; Compute the smallest column number past the ends of all the lines.
1768 ;; Adjust upward to a tab column, if that doesn't push past the margin.
1773 ;; Don't modify blank lines at start of region.
1777 ;; Add or remove backslashes on all the lines.
1780 ;; Un-backslashify the last line
1781 ;; if the region ends right at the start of the next line.
1809 \f
1810 ;;; Line breaking and paragraph filling.
1816 ;; The filling code is based on a simple theory; leave the intricacies
1817 ;; of the text handling to the currently active mode for that
1818 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
1819 ;; possible to make them work correctly wrt the comment and string
1820 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
1821 ;; to it, there's quite a lot of special cases to handle which makes
1822 ;; the code anything but simple. The intention is that it will work
1823 ;; with any well-written text filling package that preserves a fill
1824 ;; prefix.
1825 ;;
1826 ;; We temporarily mask comment starters and enders as necessary for
1827 ;; the filling code to do its job on a seemingly normal text block.
1828 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
1829 ;; preserve it correctly (especially important when filling C++ style
1830 ;; line comments). By default, we set up and use adaptive-fill-mode,
1831 ;; which is standard in all supported Emacs flavors.
1834 ;; Determine the appropriate comment fill prefix for a block or line
1835 ;; comment. Return a cons of the prefix string and the column where
1836 ;; it ends. If fill-prefix is set, it'll override. Note that this
1837 ;; function also uses the value of point in some heuristics.
1840 c-current-comment-prefix
1843 prefix-regexp
1844 comment-start-skip))
1845 prefix-line comment-prefix res comment-text-end)
1849 ;; Ugly way of getting the column after the fill
1850 ;; prefix; it'd be nice with a current-column
1851 ;; that works on strings..
1863 ;; Set fallback for comment-prefix if none is found.
1868 ;; The current line is not the comment starter, so the
1869 ;; comment has more than one line, and it can therefore be
1870 ;; used to find the comment fill prefix.
1875 ;; The line after the comment starter is inside the
1876 ;; comment, so we can use it.
1878 ;; The comment is only one line. Take the comment prefix
1879 ;; from it and keep the indentation.
1887 ;; There is only whitespace before the comment
1888 ;; starter; take the prefix straight from this
1889 ;; line.
1893 ;; There is code before the comment starter, so we
1894 ;; have to temporarily insert and indent a new
1895 ;; line to get the right space/tab mix in the
1896 ;; indentation.
1900 tmp)
1913 )))))
1921 ;; The current line is not the comment starter and
1922 ;; contains more than just the ender, so it's good enough
1923 ;; to be used for the comment fill prefix.
1935 ;; The comment is either one line or the next line
1936 ;; contains just the comment ender. Also, if point is
1937 ;; on the comment opener line and the following line is
1938 ;; empty or doesn't match c-current-comment-prefix we
1939 ;; assume that this is in fact a not yet closed one line
1940 ;; comment, so we shouldn't look for the comment prefix
1941 ;; on the next line. In these cases we have no
1942 ;; information about a suitable comment prefix, so we
1943 ;; resort to c-block-comment-prefix.
1947 tmp-pre tmp-post)
1948 ;; The comment doesn't give any information
1949 ;; about the indentation column. We'll have to
1950 ;; temporarily insert a new comment line and
1951 ;; indent it to find the correct column.
1960 ;; If there's ws on the current
1961 ;; line, we'll use it instead of
1962 ;; what's ending comment-prefix.
1967 comment-prefix))
1974 ;; We insert an extra non-whitespace
1975 ;; character before the line break and
1976 ;; after comment-prefix in case it's
1977 ;; "" or ends with whitespace.
1990 ;; Otherwise the line after the comment starter is good
1991 ;; enough to find the prefix in.
1995 ;; prefix-line is the bol of a line on which we should try
1996 ;; to find the prefix.
2003 ;; The match is fine if there's text after it.
2009 ;; This match is better than nothing, so let's
2010 ;; remember it in case nothing better is found
2011 ;; on another line.
2015 t))))
2017 ;; Search for a line which has text after the prefix
2018 ;; so that we get the proper amount of whitespace
2019 ;; after it. We start with the current line, then
2020 ;; search backwards, then forwards.
2024 ;; The whitespace is sucked up by the
2025 ;; first [ \t]* glob if the prefix is empty.
2028 ;; If the current line doesn't have text but do
2029 ;; have whitespace after the prefix, we'll use it.
2034 ;; For line comments we can search up to and
2035 ;; including the first line.
2039 ;; For block comments we must stop before the
2040 ;; block starter.
2049 nil)
2051 ;; A good line wasn't found, but at least we have a
2052 ;; fallback that matches the comment prefix regexp.
2054 ;; There are ws after the prefix, so let's use it.
2058 ;; Check if there's any whitespace padding
2059 ;; on the comment start line that we can
2060 ;; use after the prefix.
2077 ;; Got to mess in the buffer once again to
2078 ;; ensure the column gets correct. :P
2089 ;; Last resort: Just add a single space after
2090 ;; the prefix.
2094 ;; The line doesn't match the comment prefix regexp.
2096 ;; We have a fallback for line comments that we must use.
2099 comment-prefix)
2102 ;; Assume we are dealing with a "free text" block
2103 ;; comment where the lines doesn't have any comment
2104 ;; prefix at all and we should just fill it as
2105 ;; normal text.
2107 ))
2111 If any of the current line is a comment or within a comment, fill the
2112 comment or the paragraph of it that point is in, preserving the
2113 comment indentation or line-starting decorations (see the
2114 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
2115 details).
2117 If point is inside multiline string literal, fill it. This currently
2118 does not respect escaped newlines, except for the special case when it
2119 is the very first thing in the string. The intended use for this rule
2120 is in situations like the following:
2123 A very long description of something that you want to fill to make
2126 If point is in any other situation, i.e. in normal code, do nothing.
2128 Optional prefix ARG means justify paragraph as well."
2131 ;; beg and end limits the region to be filled. end is a marker.
2132 beg end
2133 ;; tmp-pre and tmp-post mark strings that are temporarily
2134 ;; inserted at the start and end of the region. tmp-pre is a
2135 ;; cons of the positions of the prepended string. tmp-post is
2136 ;; a marker pointing to the single character of the appended
2137 ;; string.
2138 tmp-pre tmp-post
2139 ;; If hang-ender-stuck isn't nil, the comment ender is
2140 ;; hanging. In that case it's set to the number of spaces
2141 ;; that should be between the text and the ender.
2142 hang-ender-stuck
2144 ;; Restore point on undo. It's necessary since we do a lot of
2145 ;; hidden inserts and deletes below that should be as transparent
2146 ;; as possible.
2150 ;; Widen to catch comment limits correctly.
2173 ;; Fill to the comment or paragraph end, whichever
2174 ;; comes first.
2177 ;; The region to be filled includes the comment
2178 ;; starter, so we must check it.
2182 ;; Include the first line in the fill.
2184 ;; The first line contains code before the
2185 ;; comment. We must fake a line that doesn't.
2187 ))
2190 ;; The region to be filled includes the comment ender.
2195 c-current-comment-prefix
2198 ;; Leave the comment ender on its own line.
2200 ;; The comment ender should hang. Replace all cruft
2201 ;; between it and the last word with one or two 'x'
2202 ;; and include it in the fill. We'll change them back
2203 ;; spaces afterwards.
2209 spaces)
2217 c-current-comment-prefix
2220 ;; The comment ender is prefixed by nothing
2221 ;; but a comment line prefix. Remove it
2222 ;; along with surrounding ws.
2229 ;; Don't adjust point below if it's
2230 ;; before the string we replace.
2232 ;; Keep one or two spaces between the text and
2233 ;; the ender, depending on how many there are now.
2236 ;; Insert the filler first to keep marks right.
2245 ;; Point was in the middle of the string we
2246 ;; replaced above, so put it back in the same
2247 ;; relative position, counting from the end.
2249 )))
2251 ;; The region to be filled includes the comment starter.
2255 ;; Begin filling with the next line.
2257 ;; Fake the fill prefix in the first line.
2269 ;; Leave the start line if it's
2270 ;; nothing but an escaped newline.
2275 ;; Temporarily insert the fill prefix after the comment
2276 ;; starter so that the first line looks like any other
2277 ;; comment line in the narrowed region.
2280 c-current-comment-prefix
2283 ;; Oops, the prefix doesn't match the comment prefix
2284 ;; regexp. This could produce very confusing
2285 ;; results with adaptive fill packages together with
2286 ;; the insert prefix magic below, since the prefix
2287 ;; often doesn't appear at all. So let's warn about
2288 ;; it.
2290 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
2292 ;; Find the right spot on the line, break it, insert
2293 ;; the fill prefix and make sure we're back in the
2294 ;; same column by temporarily prefixing the first word
2295 ;; with a number of 'x'.
2299 c-current-comment-prefix
2300 comment-start-skip))
2315 ;; Avoid infinite recursion.
2317 fill-paragraph-function))
2320 ;; Kludge: If the function that adapts the fill prefix
2321 ;; doesn't produce the required comment starter for line
2322 ;; comments, then force it by setting fill-prefix.
2324 ;; Kludge the kludge: filladapt-mode doesn't
2325 ;; have this problem, but it doesn't override
2326 ;; fill-context-prefix currently (version
2327 ;; 2.12).
2329 filladapt-mode))
2335 lit-limits lit-type))))))
2338 ;; Preparations finally done! Now we can call the
2339 ;; real fill function.
2344 ;; Restore point if it was outside the region.
2348 )))
2356 ;; Preserve point even if it's in the middle of the string
2357 ;; we replace; save-excursion doesn't work in that case.
2367 ;; Always return t. This has the effect that if filling isn't done
2368 ;; above, it isn't done at all, and it's therefore effectively
2369 ;; disabled in normal code.
2370 t)
2373 ;; Do automatic filling if not inside a context where it should be
2374 ;; ignored.
2376 ;; The decision whether the line should be broken is actually
2377 ;; done in c-indent-new-comment-line, which do-auto-fill
2378 ;; calls to break lines. We just set this special variable
2379 ;; so that we'll know when we're called from there. It's
2380 ;; also used to detect whether fill-prefix is user set or
2381 ;; generated automatically by do-auto-fill.
2382 fill-prefix))
2386 "Break line at point and indent, continuing comment if within one.
2387 If inside a comment and `comment-multi-line' is non-nil, the
2388 indentation and line prefix are preserved (see the
2389 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
2390 details). If inside a single line comment and `comment-multi-line' is
2391 nil, a new comment of the same type is started on the next line and
2392 indented as appropriate for comments.
2394 If a fill prefix is specified, it overrides all the above."
2402 ;; Already know the literal type and limits when called from
2403 ;; c-context-line-break.
2407 ;; Called from do-auto-fill.
2413 ;; Come to think about it, "pound" is a bit
2414 ;; of a misnomer, so call it "cpp" instead
2415 ;; in user interaction.
2419 c-ignore-auto-fill)
2424 ;; The adaptive fill function has generated a prefix, but
2425 ;; we're on the first line in a block comment so it'll be
2426 ;; wrong. Ignore it to guess a better one below.
2430 ;; Kludge: If the function that adapted the fill prefix
2431 ;; doesn't produce the required comment starter for line
2432 ;; comments, then we ignore it.
2434 ))
2436 ;; A call from do-auto-fill which should be ignored.
2437 )
2439 ;; A fill-prefix overrides anything.
2453 ;; Inside a comment that should be continued.
2457 c-lit-type))
2464 ;; Skip forward past the fill prefix in case
2465 ;; we're standing in it.
2476 ;; The skip takes us out of the comment;
2477 ;; insert the fill prefix at bol instead
2478 ;; and keep the position.
2489 ;; Inside a comment that should be broken.
2492 col)
2506 ;; c-comment-indent may look at the current
2507 ;; indentation, so let's start out with the same
2508 ;; indentation as the previous one.
2513 ;; Somewhere else in the code.
2525 ;; advice for indent-new-comment-line for older Emacsen
2529 activate preactivate)
2530 "Call `c-indent-new-comment-line' if in CC Mode."
2533 ad-do-it
2538 "Do a line break suitable to the context.
2540 When point is outside a comment, insert a newline and indent according
2541 to the syntactic context.
2543 When point is inside a comment, continue it with the appropriate
2544 comment prefix (see the `c-comment-prefix-regexp' and
2545 `c-block-comment-prefix' variables for details). The end of a
2546 C++-style line comment doesn't count as inside the comment, though."
2560 ;; c-indent-line may look at the current indentation, so let's
2561 ;; start out with the same indentation as the previous line.
2571 \f
2574 ;;; cc-cmds.el ends here