| blob | 4f205d62a4cd3f714ac4a06ca035ddde120640d7 |
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs
9 ;; 1987 Stewart Clamen
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
14 ;; Package: cc-mode
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 ;;; Commentary:
33 ;;; Code:
40 load-path)))
47 ;; Silence the compiler.
49 ; which looks at this.
50 \f
51 ;; Indentation / Display syntax functions
55 "Indent the current line according to the syntactic context,
56 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
57 syntactic information for the current line. Be silent about syntactic
58 errors if the optional argument QUIET is non-nil, even if
59 `c-report-syntactic-errors' is non-nil. Normally the position of
60 point is used to decide where the old indentation is on a lines that
61 is otherwise empty \(ignoring any line continuation backslash), but
62 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
63 indentation change \(in columns)."
69 bs-col
70 shift-amt)
75 ;; Don't use "\\s " - ^L doesn't count as WS
76 ;; here
80 ;; Delete all whitespace after point if there's only whitespace
81 ;; on the line, so that any code that does back-to-indentation
82 ;; or similar gets the current column in this case. If this
83 ;; removes a line continuation backslash it'll be restored
84 ;; at the end.
86 ;; Should try to keep the backslash alignment
87 ;; in this case.
99 c-syntactic-context))))
104 c-syntactic-context))
106 c-echo-syntactic-information-p
108 c-syntactic-context indent))
112 c-parsing-error)
113 c-parsing-error))
118 t
120 nil))))
129 ;; Realign the line continuation backslash.
131 shift-amt))
134 "Insert a newline and indent the new line.
135 This function fixes line continuation backslashes if inside a macro,
136 and takes care to set the indentation before calling
137 `indent-according-to-mode', so that lineup functions like
138 `c-lineup-dont-change' works better."
140 ;; TODO: Backslashes before eol in comments and literals aren't
141 ;; kept intact.
143 ;; Avoid calling c-backslash-region from c-indent-line if it's
144 ;; called during the newline call, which can happen due to
145 ;; c-electric-continued-statement, for example. We also don't
146 ;; want any backslash alignment from indent-according-to-mode.
148 has-backslash insert-backslash
149 start col)
159 has-backslash t)
166 ;; The backslash stayed on the previous line. Insert one
167 ;; before calling c-backslash-region, so that
168 ;; bs-col-after-end in it works better. Fixup the
169 ;; backslashes on the newly inserted line.
173 ;; The backslash moved to the new line, if there was any. Let
174 ;; c-backslash-region fix a backslash on the previous line,
175 ;; and the one that might be on the new line.
176 ;; c-auto-align-backslashes is intentionally ignored here;
177 ;; maybe the moved backslash should be left alone if it's set,
178 ;; but we fix both lines on the grounds that the old backslash
179 ;; has been moved anyway and is now in a different context.
182 ;; Reindent syntactically. The indentation done above is not
183 ;; wasted, since c-indent-line might look at the current
184 ;; indentation.
187 ;; We temporarily insert another line break, so that the
188 ;; lineup functions will see the line as empty. That makes
189 ;; e.g. c-lineup-cpp-define more intuitive since it then
190 ;; proceeds to the preceding line in this case.
201 ;; Must align the backslash again after reindentation. The
202 ;; c-backslash-region call above can't be optimized to ignore
203 ;; this line, since it then won't align correctly with the
204 ;; lines below if the first line in the macro is broken.
208 "Show syntactic information for current line.
209 With universal argument, inserts the analysis as a comment on that line."
213 ;; Use `c-syntactic-context' in the same way as
214 ;; `c-indent-line', to be consistent.
215 c-syntactic-context
228 ols))
232 ols)))
238 ))
242 "Insert a comment with the syntactic analysis on every line in the region."
252 \f
253 ;; Minor mode functions.
261 ;; subword might not be loaded.
264 "w"
266 ;; FIXME: Derived modes might want to use something else
267 ;; than a string for `mode-name'.
270 mode-name)))
271 ;; (setq c-submode-indicators
272 ;; (if (> (length fmt) 1)
273 ;; fmt))
277 bare-mode-name))
281 "Toggle syntactic indentation.
282 Optional numeric ARG, if supplied, turns on syntactic indentation when
283 positive, turns it off when negative, and just toggles it when zero or
284 left out.
286 When syntactic indentation is turned on (the default), the indentation
287 functions and the electric keys indent according to the syntactic
288 context keys, when applicable.
290 When it's turned off, the electric keys don't reindent, the indentation
291 functions indents every new line to the same level as the previous
293 specified by `c-basic-offset'. The indentation style has no effect in
294 this mode, nor any of the indentation associated variables,
295 e.g. `c-special-indent-hook'.
297 This command sets the variable `c-syntactic-indentation'."
304 "Toggle auto-newline feature.
305 Optional numeric ARG, if supplied, turns on auto-newline when
306 positive, turns it off when negative, and just toggles it when zero or
307 left out.
309 Turning on auto-newline automatically enables electric indentation.
312 mode line after the mode name) newlines are automatically inserted
313 after special characters such as brace, comma, semi-colon, and colon."
325 "Toggle hungry-delete-key feature.
326 Optional numeric ARG, if supplied, turns on hungry-delete when
327 positive, turns it off when negative, and just toggles it when zero or
328 left out.
331 the mode line after the mode name) the delete key gobbles all preceding
332 whitespace in one fell swoop."
339 "Toggle auto-newline and hungry-delete-key features.
340 Optional numeric ARG, if supplied, turns on auto-newline and
341 hungry-delete when positive, turns them off when negative, and just
342 toggles them when zero or left out.
344 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
352 "Toggle the electric indentation feature.
353 Optional numeric ARG, if supplied, turns on electric indentation when
354 positive, turns it off when negative, and just toggles it when zero or
355 left out."
363 \f
364 ;; Electric keys
367 "Delete the preceding character or whitespace.
369 line) then all preceding whitespace is consumed. If however a prefix
370 argument is supplied, or `c-hungry-delete-key' is nil, or point is
371 inside a literal then the function in the variable
372 `c-backspace-function' is called."
376 arg
382 "Delete the preceding character or all preceding whitespace
383 back to the previous non-whitespace character.
395 "Delete the following character or whitespace.
397 line) then all following whitespace is consumed. If however a prefix
398 argument is supplied, or `c-hungry-delete-key' is nil, or point is
399 inside a literal then the function in the variable `c-delete-function'
400 is called."
404 arg
410 "Delete the following character or all following whitespace
411 up to the next non-whitespace character.
420 ;; This function is only used in XEmacs.
422 "Deletes preceding or following character or whitespace.
423 This function either deletes forward as `c-electric-delete-forward' or
424 backward as `c-electric-backspace', depending on the configuration: If
425 the function `delete-forward-p' is defined and returns non-nil, it
426 deletes forward. Otherwise it deletes backward.
428 Note: This is the way in XEmacs to choose the correct action for the
429 \[delete] key, whichever key that means. Other flavors don't use this
430 function to control that."
437 ;; This function is only used in XEmacs.
439 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
440 The direction of deletion depends on the configuration: If the
441 function `delete-forward-p' is defined and returns non-nil, it deletes
442 forward using `c-hungry-delete-forward'. Otherwise it deletes
443 backward using `c-hungry-backspace'.
445 Note: This is the way in XEmacs to choose the correct action for the
446 \[delete] key, whichever key that means. Other flavors don't use this
447 function to control that."
456 If `c-electric-flag' is set, handle it specially according to the variable
457 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
458 inside a literal or a macro, nothing special happens."
472 ;; do nothing special
474 ;; place the pound character at the left edge
482 )))
485 ;; Return the syntactic context of the construct at point. (This is NOT
486 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
487 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
490 syntax)
492 ;; insert a newline to isolate the construct at point for syntactic
493 ;; analysis.
495 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
496 ;; the syntax. (There might already be an escaped NL there.)
512 ;; Turn on syntactic macro analysis to help with auto
513 ;; newlines only.
515 nil))
516 syntax))
519 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
520 ;; (not necessarily the same as the S.C. of the line it is on). Return
521 ;; NEWLINES, the list containing some combination of the symbols `before'
522 ;; and `after' saying where newlines should be inserted.
525 ;; This is the list of brace syntactic symbols that can hang.
526 ;; If any new ones are added to c-offsets-alist, they should be
527 ;; added here as well.
528 ;;
529 ;; The order of this list is important; if SYNTAX has several
530 ;; elements, the element that "wins" is the earliest in SYMS.
532 class-open class-close defun-open defun-close
533 inline-open inline-close
534 brace-list-open brace-list-close
535 brace-list-intro brace-entry-open
536 block-open block-close
537 substatement-open statement-case-open
538 extern-lang-open extern-lang-close
539 namespace-open namespace-close
540 module-open module-close
541 composition-open composition-close
542 inexpr-class-open inexpr-class-close
543 ;; `statement-cont' is here for the case with a brace
544 ;; list opener inside a statement. C.f. CASE B.2 in
545 ;; `c-guess-continued-construct'.
546 statement-cont))
547 ;; shut this up too
552 ;; Do not try to insert newlines around a special
553 ;; (Pike-style) brace list.
560 nil
561 ;; Seek the matching entry in c-hanging-braces-alist.
563 syms
564 ;; Substitute inexpr-class and class-open or
565 ;; class-close with inexpr-class-open or
566 ;; inexpr-class-close.
573 syntax)
574 c-hanging-braces-alist)
577 ;; If syntax is a function symbol, then call it using the
578 ;; defined semantics.
588 ;; Point is just after a newly inserted }. If the non-whitespace
589 ;; content of the braces is a single line of code, compact the whole
590 ;; construct to a single line, if this line isn't too long. The Right
591 ;; Thing is done with comments.
592 ;;
593 ;; Point will be left after the }, regardless of whether the clean-up is
594 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
598 mbeg1 mend1 mbeg4 mend4
599 eol-col cmnt-pos cmnt-col cmnt-gap)
604 ;; Avoid backtracking over a very large block. The one we
605 ;; deal with here can never be more than three lines.
636 ;; Necessary to put the closing brace before any line
637 ;; oriented comment to keep it syntactically significant.
638 ;; This isn't necessary for block comments, but the result
639 ;; looks nicer anyway.
655 ;; Can we trim space before comment to make the line fit?
661 t))))
665 "Insert a brace.
667 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
668 numeric ARG hasn't been supplied, the command performs several electric
669 actions:
672 the mode line) newlines are inserted before and after the brace as
673 directed by the settings in `c-hanging-braces-alist'.
675 \(b) Any auto-newlines are indented. The original line is also
676 reindented unless `c-syntactic-indentation' is nil.
678 \(c) If auto-newline is turned on, various newline cleanups based on the
679 settings of `c-cleanup-list' are done."
683 ;; We want to inhibit blinking the paren since this would be
684 ;; most disruptive. We'll blink it ourselves later on.
686 blink-paren-function case-fold-search)
692 ;; Insert the brace. Note that expand-abbrev might reindent
693 ;; the line here if there's a preceding "else" or something.
703 newlines
705 ; of the brace itself, of the line the brace ends up on.
717 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
721 ;; Only a plain newline for now - it's indented
722 ;; after the cleanups when the line has its final
723 ;; appearance.
728 ;; `syntax' is the syntactic context of the line which ends up
729 ;; with the brace on it.
732 ;; Do all appropriate clean ups
735 mbeg mend
736 )
738 ;; `}': clean up empty defun braces
743 syntax)
748 ;; make sure matching open brace isn't in a comment
754 ;; `}': compact to a one-liner defun?
763 ;; `{': clean up brace-else-brace and brace-elseif-brace
770 "else"
772 "{"
774 nil t))
786 ; (progn
787 ; (setq tmp (point))
791 "else"
793 "if"
797 ;(eq (match-end 0) tmp);
798 )
805 ;; Indent the line after the cleanups since it might
806 ;; very well indent differently due to them, e.g. if
807 ;; c-indent-one-line-block is used together with the
808 ;; one-liner-defun cleanup.
812 ;; does a newline go after the brace?
815 ))))
817 ;; blink the paren
820 old-blink-paren
827 "Insert a slash character.
829 If the slash is inserted immediately after the comment prefix in a c-style
830 comment, the comment might get closed by removing whitespace and possibly
833 Indent the line as a comment, if:
836 token and we are on a comment-only-line, or
839 comment.
841 If a numeric ARG is supplied, point is inside a literal, or
842 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
843 is inhibited."
846 indentp
847 ;; shut this up
850 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
851 ;; `c-syntactic-indentation' set.
858 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
869 c-syntactic-indentation
870 c-electric-flag
878 "Insert a star character.
879 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
880 the star is the second character of a C style comment starter on a
881 comment-only-line, indent the line as a comment. If a numeric ARG is
882 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
883 this indentation is inhibited."
887 ;; if we are in a literal, or if arg is given do not reindent the
888 ;; current line, unless this star introduces a comment-only line.
891 c-electric-flag
904 ))
907 "Insert a comma or semicolon.
909 If `c-electric-flag' is non-nil, point isn't inside a literal and a
910 numeric ARG hasn't been supplied, the command performs several electric
911 actions:
914 the mode line) a newline might be inserted. See the variable
915 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
917 \(b) Any auto-newlines are indented. The original line is also
918 reindented unless `c-syntactic-indentation' is nil.
920 \(c) If auto-newline is turned on, a comma following a brace list or a
921 semicolon following a defun might be cleaned up, depending on the
922 settings of `c-cleanup-list'."
926 ;; shut this up
936 ;; do all cleanups and newline insertions if c-auto-newline is on.
941 ;; clean ups: list-close-comma or defun-close-semi
954 ;; make sure matching open brace isn't in a comment
958 ;; reindent line
962 ;; check to see if a newline should be added
964 answer add-newline-p)
967 ;; only nil value means continue checking
971 ;; only 'stop specifically says do not add a newline
973 ))
976 )))))
979 "Insert a colon.
981 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
982 numeric ARG hasn't been supplied, the command performs several electric
983 actions:
986 the mode line) newlines are inserted before and after the colon based on
987 the settings in `c-hanging-colons-alist'.
989 \(b) Any auto-newlines are indented. The original line is also
990 reindented unless `c-syntactic-indentation' is nil.
992 \(c) If auto-newline is turned on, whitespace between two colons will be
994 `c-cleanup-list'."
999 newlines is-scope-op
1000 ;; shut this up
1003 ;; Any electric action?
1005 ;; Unless we're at EOL, only re-indentation happens.
1010 ;; scope-operator clean-up?
1028 ;; indent the current line if it's done syntactically.
1030 ;; Cannot use the same syntax analysis as we find below,
1031 ;; since that's made with c-syntactic-indentation-in-macros
1032 ;; always set to t.
1035 ;; Calculate where, if anywhere, we want newlines.
1039 ;; Turn on syntactic macro analysis to help with auto newlines
1040 ;; only.
1043 ;; Translate substatement-label to label for this operation.
1048 ;; some language elements can only be determined by checking
1049 ;; the following line. Let's first look for ones that can be
1050 ;; found when looking on the line with the colon
1054 syntax c-hanging-colons-alist)
1061 c-hanging-colons-alist)))))
1062 ;; does a newline go before the colon? Watch out for already
1063 ;; non-hung colons. However, we don't unhang them because that
1064 ;; would be a cleanup (and anti-social).
1074 ;; does a newline go after the colon?
1078 ))))
1082 If the current language uses angle bracket parens (e.g. template
1083 arguments in C++), try to find out if the inserted character is a
1084 paren and give it paren syntax if appropriate.
1086 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1087 line will be reindented if the inserted character is a paren or if it
1088 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1089 numeric argument is supplied, or the point is inside a literal."
1093 final-pos close-paren-inserted found-delim case-fold-search)
1098 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1099 ;;;; property on the new < or > and its mate (if any) when they are template
1100 ;;;; parens. This is now done in an after-change function.
1102 ;; Indent the line if appropriate.
1106 ;; If a <, basically see if it's got "template" before it .....
1114 ;; ..... or is a C++ << operator.
1122 ;; It's a >. Either a C++ >> operator. ......
1129 ;; ...., or search back for a < which isn't already marked as an
1130 ;; opening template delimiter.
1133 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1134 ;; our position.
1157 blink-paren-function)
1158 ;; Note: Most paren blink functions, such as the standard
1159 ;; `blink-matching-open', currently doesn't handle paren chars
1160 ;; marked with text properties very well. Maybe we should avoid
1161 ;; this call for the time being?
1165 "Insert a parenthesis.
1167 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1168 line is reindented unless a numeric ARG is supplied, or the parenthesis
1169 is inserted inside a literal.
1171 Whitespace between a function name and the parenthesis may get added or
1172 removed; see the variable `c-cleanup-list'.
1174 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1175 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1178 ;; shut this up
1180 case-fold-search)
1185 ;; be most disruptive. We'll blink it ourselves
1186 ;; afterwards.
1188 blink-paren-function)
1192 ;; If we're at EOL, check for new-line clean-ups.
1196 ;; clean up brace-elseif-brace
1203 "else"
1205 "if"
1207 "("
1209 nil t)
1214 ;; clean up brace-catch-brace
1221 "catch"
1223 "("
1225 nil t)
1230 ;; Check for clean-ups at function calls. These two DON'T need
1231 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1232 ;; Point is currently just after the inserted paren.
1236 ;; space-before-funcall clean-up?
1244 ;; Don't add a space into #define FOO()....
1253 ;; compact-empty-funcall clean-up?
1267 old-blink-paren
1271 "Reindent the current line if appropriate.
1273 This function is used to reindent the line after a keyword which
1277 The line is reindented if there is nothing but whitespace before the
1278 keyword on the line, the keyword is not inserted inside a literal, and
1279 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1284 c-syntactic-indentation
1291 ;; Have to temporarily insert a space so that
1292 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1293 ;; space with a nonspace to avoid messing up any whitespace
1294 ;; sensitive meddling that might be done, e.g. by
1295 ;; `c-backslash-region'.
1301 \f
1306 ;; "nomenclature" functions + c-scope-operator.
1308 "Compatibility alias for `c-forward-subword'."
1315 "Compatibility alias for `c-backward-subword'."
1322 "Insert a double colon scope operator at point.
1327 \f
1328 ;; Movement (etc.) by defuns.
1330 ;; Return non-nil if point is between the closing brace and the semicolon of
1331 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1332 ;; portion of a declaration like "struct foo {...} bar ;".
1333 ;;
1334 ;; Return the position of the main declaration. Otherwise, return nil.
1335 ;; Point is assumed to be at the top level and outside of any macro or
1336 ;; literal.
1337 ;;
1338 ;; If LIM is non-nil, it is the bound on a the backward search for the
1339 ;; beginning of the declaration.
1340 ;;
1341 ;; This function might do hidden buffer changes.
1346 bod)
1350 ;; Look for struct or union or ... If we find one, it might
1351 ;; be the return type of a function, or the like. Exclude
1352 ;; this case.
1355 c-opt-block-decls-with-vars-key
1357 eo-block t t t)
1362 bod)))))
1365 ;; Determine where we are with respect to functions (or other brace
1366 ;; constructs, included in the term "function" in the rest of this comment).
1367 ;; Point is assumed to be outside any macro or literal.
1368 ;; This is used by c-\(beginning\|end\)-of-defun.
1369 ;;
1370 ;; Return one of these symbols:
1371 ;; at-header : we're at the start of a function's header.
1372 ;; in-header : we're inside a function's header, this extending right
1373 ;; up to the brace. This bit includes any k&r declarations.
1374 ;; in-block : we're inside a function's brace block.
1375 ;; in-trailer : we're in the area between the "}" and ";" of something
1376 ;; like "struct foo {...} bar, baz;".
1377 ;; at-function-end : we're just after the closing brace (or semicolon) that
1378 ;; terminates the function.
1379 ;; outwith-function: we're not at or in any function. Being inside a
1380 ;; non-brace construct also counts as 'outwith-function'.
1381 ;;
1382 ;; This function might do hidden buffer changes.
1385 decl-result brace-decl-p
1402 ;; Find the start of the current declaration. NOTE: If we're in the
1403 ;; variables after a "struct/eval" type block, we don't get to the
1404 ;; real declaration here - we detect and correct for this later.
1406 ;;If we're in the parameters' parens, move back out of them.
1408 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1409 ;; at a declaration.
1417 ;; NOTE: If we're in a K&R region, this might be the start
1418 ;; of a parameter declaration, not the actual function.
1422 ;; Has the declaration we've gone back to got braces?
1428 ;; Might have stopped on the
1429 ;; ';' in a K&R argdecl. In
1430 ;; that case the declaration
1431 ;; should contain a block.
1440 'at-header
1446 'at-function-end
1449 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1450 decl-result))))))))
1453 ;; Skip to the opening brace of the Nth function before point. If
1454 ;; point is inside a function, this counts as the first. Point must be
1455 ;; outside any comment/string or macro.
1456 ;;
1457 ;; N must be strictly positive.
1458 ;; WHERE describes the position of point, one of the symbols `at-header',
1459 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1460 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1461 ;;
1462 ;; If we run out of functions, leave point at BOB. Return zero on success,
1463 ;; otherwise the number of {s still to go.
1464 ;;
1465 ;; This function may do hidden buffer changes
1467 ;; What we do to go back the first defun depends on where we start.
1483 ;; Each time round the loop, go back to a "{" at the outermost level.
1486 ; by a factor of ~6. Hmmm. 2006/4/5.
1491 n)
1494 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1495 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1496 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1497 ;; otherwise include the braces. If the closing brace is missing,
1498 ;; (point-max) is used instead.
1500 encl-decl)
1519 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1520 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1521 ;; braces NOT being included in the resulting region. On no account may the
1522 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1523 ;; PAREN-STATE is a list of buffer positions in the style of
1524 ;; (c-parse-state), one of which will be that of the desired opening brace,
1525 ;; if there is one.
1526 ;;
1527 ;; Return the position of the enclosing opening brace, or nil
1541 orig-point-max)))
1542 encl-decl)
1544 nil)))
1548 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1549 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1550 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1551 ;; buffer's original restriction.
1552 ;;
1553 ;; This is a very special purpose macro, which assumes the existence of
1554 ;; several variables. It is for use only in c-beginning-of-defun and
1555 ;; c-end-of-defun.
1559 lim)
1562 paren-state orig-point-min orig-point-max))
1566 "Move backward to the beginning of a defun.
1567 Every top level declaration that contains a brace paren block is
1568 considered to be a defun.
1570 With a positive argument, move backward that many defuns. A negative
1571 argument -N means move forward to the Nth following beginning. Return
1572 t unless search stops due to beginning or end of buffer.
1574 Unlike the built-in `beginning-of-defun' this tries to be smarter
1575 about finding the char with open-parenthesis syntax that starts the
1576 defun."
1590 ; structure with other users of c-state-cache.
1592 lim ; Position of { which has been widened to.
1593 where pos case-fold-search)
1598 paren-state orig-point-min orig-point-max)))
1600 ;; Move back out of any macro/comment/string we happen to be in.
1608 ;; Move forward to the closing brace of a function.
1615 ;; Move forward to the next opening brace....
1622 ;; ... and backward to the function header.
1624 t))
1626 ;; Move backward to the opening brace of a function, making successively
1627 ;; larger portions of the buffer visible as necessary.
1633 ;; Go backward to this function's header.
1637 ;; We're now there, modulo comments and whitespace.
1638 ;; Try to be line oriented; position point at the closest
1639 ;; preceding boi that isn't inside a comment, but if we hit
1640 ;; the previous declaration then we use the current point
1641 ;; instead.
1651 ;; Skip to the closing brace of the Nth function after point. If
1652 ;; point is inside a function, this counts as the first. Point must be
1653 ;; outside any comment/string or macro.
1654 ;;
1655 ;; N must be strictly positive.
1656 ;; WHERE describes the position of point, one of the symbols `at-header',
1657 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1658 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1659 ;;
1660 ;; If we run out of functions, leave point at EOB. Return zero on success,
1661 ;; otherwise the number of }s still to go.
1662 ;;
1663 ;; This function may do hidden buffer changes.
1666 ;; What we do to go forward over the first defun depends on where we
1667 ;; start. We go to the closing brace of that defun, even when we go
1668 ;; backwards to it (in a "struct foo {...} bar ;").
1684 ;; Each time round the loop, go forward to a "}" at the outermost level.
1686 ;(c-parse-state) ; This call speeds up the following one by a factor
1687 ; of ~6. Hmmm. 2006/4/5.
1692 n)
1695 "Move forward to the end of a top level declaration.
1696 With argument, do it that many times. Negative argument -N means move
1697 back to Nth preceding end. Returns t unless search stops due to
1698 beginning or end of buffer.
1700 An end of a defun occurs right after the close-parenthesis that matches
1701 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1714 ; structure with other users of c-state-cache.
1716 lim
1717 where pos case-fold-search)
1722 paren-state orig-point-min orig-point-max)))
1724 ;; Move back out of any macro/comment/string we happen to be in.
1732 ;; Move backwards to the } of a function
1744 ;; Move forward to the } of a function
1749 ;; Do we need to move forward from the brace to the semicolon?
1755 ;; We're there now, modulo comments and whitespace.
1756 ;; Try to be line oriented; position point after the next
1757 ;; newline that isn't inside a comment, but if we hit the
1758 ;; next declaration then we use the current point instead.
1772 "Return the name of the current defun, or NIL if there isn't one.
1774 with a brace block."
1778 where pos name-end case-fold-search)
1783 ;; Move back out of any macro/comment/string we happen to be in.
1790 ;; Move to the beginning of the current defun, if any, if we're not
1791 ;; already there.
1793 nil
1798 ;; Pick out the defun name, according to the type of defun.
1800 ;; struct, union, enum, or similar:
1812 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1813 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1829 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1830 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1833 ;; Objc selectors.
1845 ;; Normal function or initializer.
1857 ;; Return a cons of the beginning and end positions of the current
1858 ;; top level declaration or macro. If point is not inside any then
1859 ;; nil is returned, unless NEAR is non-nil in which case the closest
1860 ;; following one is chosen instead (if there is any). The end
1861 ;; position is at the next line, providing there is one before the
1862 ;; declaration.
1863 ;;
1864 ;; This function might do hidden buffer changes.
1872 ;; Note: Some code duplication in `c-beginning-of-defun' and
1873 ;; `c-end-of-defun'.
1877 lim pos end-pos)
1880 ;; If we moved to the outermost enclosing paren
1881 ;; then we can use c-safe-position to set the
1882 ;; limit. Can't do that otherwise since the
1883 ;; earlier paren pair on paren-state might very
1884 ;; well be part of the declaration we should go
1885 ;; to.
1887 t)
1888 ;; At top level. Make sure we aren't inside a literal.
1904 ;; We moved back over the previous defun. Skip to the next
1905 ;; one. Not using c-forward-syntactic-ws here since we
1906 ;; should not skip a macro. We can also be directly after
1907 ;; the block in a `c-opt-block-decls-with-vars-key'
1908 ;; declaration, but then we won't move significantly far
1909 ;; here.
1923 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1924 ;; declaration that doesn't end there. We're searching back and
1925 ;; forth over the block here, which can be expensive.
1937 nil
1941 nil
1943 ;; Try to be line oriented; position the limits at the
1944 ;; closest preceding boi, and after the next newline, that
1945 ;; isn't inside a comment, but if we hit a neighboring
1946 ;; declaration then we instead use the exact declaration
1947 ;; limit in that direction.
1953 pos
1969 pos))))))))
1977 "Put mark at end of the current top-level declaration or macro, point at beginning.
1978 If point is not inside any then the closest following one is
1979 chosen. Each successive call of this command extends the marked
1980 region by one function.
1982 A mark is left where the command started, unless the region is already active
1983 \(in Transient Mark mode).
1986 function does not require the declaration to contain a brace block."
1991 ;; We try to be line oriented, unless there are several
1992 ;; declarations on the same line.
2019 "Return the name of the current CPP macro, or NIL if we're not in one."
2028 \f
2029 ;; Movement by statements.
2031 ;; Point is within a comment. Is it also within a comment-prefix?
2032 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2033 ;;
2034 ;; This function might do hidden buffer changes.
2044 ;; Narrow to the "inside" of the comment (block) defined by range, as
2045 ;; follows:
2046 ;;
2047 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2048 ;; present) removed. A c++-style line comment retains its opening "//" but
2049 ;; has any final NL removed. If POINT is currently outwith these innards,
2050 ;; move it to the appropriate boundary.
2051 ;;
2052 ;; This narrowing simplifies the sentence movement functions, since it
2053 ;; eliminates awkward things at the boundaries of the comment (block).
2054 ;;
2055 ;; This function might do hidden buffer changes.
2073 ;; Move backwards to the "beginning of a sentence" within the comment
2074 ;; defined by RANGE, a cons of its starting and ending positions. If we
2075 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2076 ;; of the comment and return T.
2077 ;;
2078 ;; The BOS is either text which follows a regexp match of sentence-end,
2079 ;; or text which is a beginning of "paragraph".
2080 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2081 ;;
2082 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2083 ;; It is not a general function, but is intended only for calling from
2084 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2085 ;;
2086 ;; This function might do hidden buffer changes.
2092 last
2098 ;; First, find the previous paragraph start, if any.
2102 ; paragraph-\(start\|separate\)
2111 ;; Now seek successively earlier sentence ends between PAR-BEG and
2112 ;; HERE, until the "start of sentence" following it is earlier than
2113 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2131 nil
2133 t))))
2136 ;; Move forward to the "end of a sentence" within the comment defined by
2137 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2138 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2139 ;; return NIL. Otherwise, move point to just after the end of the comment
2140 ;; and return T.
2141 ;;
2142 ;; The EOS is just after the non-WS part of the next match of the regexp
2143 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2144 ;; no sentence-end match following point, any WS before the end of the
2145 ;; comment will count as EOS, providing we're not already in it.
2146 ;;
2147 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2148 ;; It is not a general function, but is intended only for calling from
2149 ;; c-move-over-sentence.
2150 ;;
2151 ;; This function might do hidden buffer changes.
2154 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2155 )
2161 ;; The cc-mode values of paragraph-\(start\|separate\), set
2162 ;; in c-setup-paragraph-variables, are used in the
2163 ;; following.
2172 last
2175 ;; Go forward one "comment-prefix which looks like sentence-end"
2176 ;; each time round the following:
2187 ;; Take special action if we're up against the end of a comment (of
2188 ;; either sort): Leave point just after the last non-ws text.
2195 nil
2197 t))))
2200 ;; Move backwards to the "beginning of a sentence" within the string defined
2201 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2202 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2203 ;; just before the start of the string and return T.
2204 ;;
2205 ;; The BOS is either the text which follows a regexp match of sentence-end
2206 ;; or text which is a beginning of "paragraph". For the purposes of
2207 ;; determining paragraph boundaries, escaped newlines are treated as
2208 ;; ordinary newlines.
2209 ;;
2210 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2211 ;; It is not a general function, but is intended only for calling from
2212 ;; c-move-over-sentence.
2213 ;;
2214 ;; This function might do hidden buffer changes.
2220 ;; Enhance paragraph-start and paragraph-separate also to recognize
2221 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2222 ;; these values should be customizable user options, or something.
2231 ; paragraph-\(start\|separate\)
2239 ;; Now see if we can find a sentence end after PAR-BEG.
2247 ; than here, in case point starts
2248 ; beyond the closing quote.
2253 nil
2255 t))))
2258 ;; Move forward to the "end of a sentence" within the string defined by
2259 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2260 ;; return NIL. Otherwise, move point to just after the end of the string
2261 ;; and return T.
2262 ;;
2263 ;; The EOS is just after the non-WS part of the next match of the regexp
2264 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2265 ;; no sentence-end match following point, any WS before the end of the
2266 ;; string will count as EOS, providing we're not already in it.
2267 ;;
2268 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2269 ;; It is not a general function, but is intended only for calling from
2270 ;; c-move-over-sentence.
2271 ;;
2272 ;; This function might do hidden buffer changes.
2275 last
2276 ;; Enhance paragraph-start and paragraph-separate to recognize
2277 ;; blank lines terminated by escaped EOLs.
2285 ;; The above values of paragraph-\(start\|separate\) are used
2286 ;; in the following.
2289 ;; (re-search-backward filler-here nil t) would find an empty
2290 ;; string. Therefore we simulate it by the following:
2299 ;; Try to go forward a sentence.
2304 ;; Did we move a sentence, or did we hit the end of the string?
2306 nil
2308 t))))
2311 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2312 ;; If a literal is the next thing (aside from whitespace) to be found before
2313 ;; point, return a cons of its start.end positions (enclosing the
2314 ;; delimiters). Otherwise return NIL.
2315 ;;
2316 ;; This function might do hidden buffer changes.
2320 pos)
2324 ;; to prevent `looking-at' seeing a " at point.
2328 ;; An EOL can act as an "open string" terminator in AWK.
2339 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2340 ;; If a literal is the next thing (aside from whitespace) following point,
2341 ;; return a cons of its start.end positions (enclosing the delimiters).
2342 ;; Otherwise return NIL.
2343 ;;
2344 ;; This function might do hidden buffer changes.
2357 ;; Does point immediately follow a statement "terminator"? A virtual
2358 ;; semicolon is regarded here as such. So is an opening brace ;-)
2359 ;;
2360 ;; This function might do hidden buffer changes.
2368 ;; The following (for macros) is not strict about exactly where we are
2369 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2370 ;; much. ACM 2004/3/29.
2382 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2383 ;; stopping before reaching BOB or a literal or the boundary of a
2384 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2385 ;; the position of the '#' beginning the current preprocessor directive, or
2386 ;; NIL if we're not in such.
2387 ;;
2388 ;; Return a cons (A.B), where
2389 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2390 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2391 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2392 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2393 ;;
2394 ;; The total collection of returned values is as follows:
2395 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2396 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2397 ;; a BOS - the caller must check this.
2398 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2399 ;; moved and reached the opening # of the macro.
2400 ;; (t . macro-boundary): Every other circumstance in which we're at a
2401 ;; macro-boundary. We might be at a BOS.
2402 ;;
2403 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2404 ;; code before encountering the literal/BOB or macro-boundary.
2405 ;;
2406 ;; Note that this function moves within either preprocessor commands
2407 ;; (macros) or normal code, but will not cross a boundary between the two,
2408 ;; or between two distinct preprocessor commands.
2409 ;;
2410 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2411 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2412 ;; move into parens. Also stop before `#' when it's at boi on a line.
2413 ;;
2414 ;; This function might do hidden buffer changes.
2418 ; semicolon precedes it.
2423 ;; Stop at the token after a comment.
2428 ;; If we've gone back over a LF, we might have moved into or out of
2429 ;; a preprocessor line.
2437 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2442 ;; Have we found a virtual semicolon? If so, stop, unless the next
2443 ;; statement is where we started from.
2450 ;; Hit the beginning of the buffer/region?
2456 ;; Move back a character.
2459 ;; Stop at "{" (unless it's a PIKE special brace list.)
2468 ;; Have we reached the start of a macro? This always counts as
2469 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2470 ;; here. FIXME!!! ACM 2004/3/29)
2474 ;; Stop at token just after "}" or ";".
2476 ;; If we've gone back over ;, {, or }, we're done.
2485 ;; Stop at the token after a string.
2490 ;; Nothing special: go back word characters.
2492 ))))))
2495 ;; Move forwards over code, stopping before reaching EOB or a literal
2496 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2497 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2498 ;; terminates the current preprocessor directive, or NIL if we're not in
2499 ;; such.
2500 ;;
2501 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2502 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2503 ;; seems unavoidable. Depending on the context this function is called
2504 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2505 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2506 ;; semicolons, or anything else.
2507 ;;
2508 ;; Return a cons (A.B), where
2509 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2510 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2511 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2512 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2513 ;;
2514 ;; Point is left either after the end-of-statement, or at the last non-ws
2515 ;; code before encountering the literal, or the # of the preprocessor
2516 ;; statement, or at EOB [or just after last non-WS stuff??].
2517 ;;
2518 ;; As a clarification of "after the end-of-statement", if a comment or
2519 ;; whitespace follows a completed AWK statement, that statement is treated
2520 ;; as ending just after the last non-ws character before the comment.
2521 ;;
2522 ;; Note that this function moves within either preprocessor commands
2523 ;; (macros) or normal code, but not both within the same invocation.
2524 ;;
2525 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2526 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2527 ;; stop before `{' if at top level or inside braces, though. Move by
2528 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2529 ;; the boi.
2530 ;;
2531 ;; This function might do hidden buffer changes.
2533 last)
2538 ;; If we've moved forward to a virtual semicolon, we're done.
2545 ;; Gone past the end of a macro?
2550 ;; About to hit a comment?
2555 ;; End of buffer?
2561 ;; If we encounter a '{', stop just after the previous token.
2567 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2568 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2569 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2570 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2576 ;; End of a PIKE special brace list? If so, step over it and continue.
2585 ;; Have we got a '}' after having moved? If so, stop after the
2586 ;; previous token.
2592 ;; Stop if we encounter a preprocessor line. Continue if we
2593 ;; hit a naked #
2602 ;; Stop after a ';', '}', or "};"
2607 ;; Found a string (this subsumes AWK regexps)?
2618 )))))
2621 ;; Is the literal defined by RANGE a string contained in a single line?
2622 ;;
2623 ;; This function might do hidden buffer changes.
2631 "Go to the beginning of the innermost C statement.
2632 With prefix arg, go back N - 1 statements. If already at the
2633 beginning of a statement then go to the beginning of the closest
2634 preceding one, moving into nested blocks if necessary (use
2636 comment or multiline string, move by sentences instead of statements.
2638 When called from a program, this function takes 3 optional args: the
2639 repetition count, a buffer position limit which is the farthest back
2640 to search for the syntactic context, and a flag saying whether to do
2641 sentence motion in or near comments and multiline strings.
2643 Note that for use in programs, `c-beginning-of-statement-1' is
2644 usually better. It has much better defined semantics than this one,
2645 which is intended for interactive use, and might therefore change to
2648 nil t))
2653 last ; start point for going back ONE chunk. Updated each chunk movement.
2656 res ; result from sub-function call
2657 not-bos ; "not beginning-of-statement"
2658 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2660 ;; Go back one statement at each iteration of the following loop.
2663 ;; Go back one "chunk" each time round the following loop, stopping
2664 ;; when we reach a statement boundary, etc.
2668 ; statement boundary, non-NIL otherwise.
2671 nil)
2675 ;; Single line string or sentence-flag is null => skip the
2676 ;; entire literal.
2681 ;; N.B. The following is essentially testing for an AWK regexp
2682 ;; at BOS:
2683 ;; Was the previous non-ws thing an end of statement?
2690 ;; Comment inside a statement or a multi-line string.
2696 res)))
2698 ;; Non-literal code.
2705 ;; We're at a tentative BOS. The next form goes
2706 ;; back over WS looking for an end of previous
2707 ;; statement.
2713 ;; Are we about to move backwards into or out of a
2714 ;; preprocessor command? If so, locate its beginning.
2722 ;; Are we about to move backwards into a literal?
2725 not-bos))
2732 "Go to the end of the innermost C statement.
2733 With prefix arg, go forward N - 1 statements. Move forward to the end
2734 of the next statement if already at end, and move into nested blocks
2736 comment or multiline string, move by sentences instead of statements.
2738 When called from a program, this function takes 3 optional args: the
2739 repetition count, a buffer position limit which is the farthest back
2740 to search for the syntactic context, and a flag saying whether to do
2741 sentence motion in or near comments and multiline strings."
2743 nil t))
2753 res
2754 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2756 ;; Go back/forward one statement at each iteration of the following loop.
2761 ;; Go forward one "chunk" each time round the following loop, stopping
2762 ;; when we reach a statement boundary, etc.
2765 ; statement boundary, non-NIL otherwise.
2768 nil)
2772 ;; sentence-flag is null => skip the entire literal.
2773 ;; or a Single line string.
2778 ;; Is there a virtual semicolon here (e.g. for AWK)?
2781 ;; Comment or multi-line string.
2787 ;; If we've just come forward out of a literal, check for
2788 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2789 ;; some other language may do in the future)
2793 ;; Non-literal code.
2796 ;; Are we about to move forward into or out of a
2797 ;; preprocessor command?
2812 ;; Are we about to move forward into a literal?
2820 \f
2821 ;; set up electric character functions to work with pending-del,
2822 ;; (a.k.a. delsel) mode. All symbols get the t value except
2823 ;; the functions which delete, which gets 'supersede.
2830 c-electric-brace
2831 c-electric-slash
2832 c-electric-star
2833 c-electric-semi&comma
2834 c-electric-lt-gt
2835 c-electric-colon
2836 c-electric-paren))
2844 \f
2845 ;; Inserting/indenting comments
2847 ;; This function might do hidden buffer changes.
2860 ;; Do not pad with one space if we're at bol.
2861 value
2872 ;; Found comment to align with.
2874 ;; Do not pad with one space if we're at bol.
2875 0
2877 ;; Recurse to handle value as a new spec.
2881 "Used by `indent-for-comment' to create and indent comments.
2882 See `c-indent-comment-alist' for a description."
2910 case-fold-search)
2912 c-indent-comments-syntactically-p)
2914 ;; BOGOSITY ALERT: if we're looking at the eol, its
2915 ;; because indent-for-comment hasn't put the comment-start
2916 ;; in the buffer yet. this will screw up the syntactic
2917 ;; analysis so we kludge in the necessary info. Another
2918 ;; kludge is that if we're at the bol, then we really want
2919 ;; to ignore any anchoring as specified by
2920 ;; c-comment-only-line-offset since it doesn't apply here.
2925 c-comment-only-line-offset
2927 c-comment-only-line-offset))))
2932 \f
2933 ;; used by outline-minor-mode
2936 ;; in otherwise-hidden text.
2941 \f
2942 ;; Movement by CPP conditionals.
2944 "Move back to the containing preprocessor conditional, leaving mark behind.
2945 A prefix argument acts as a repeat count. With a negative argument,
2946 move forward to the end of the containing preprocessor conditional.
2949 function stops at them when going backward, but not when going
2950 forward."
2960 directives."
2968 "Move forward into the next preprocessor conditional, leaving mark behind.
2969 A prefix argument acts as a repeat count. With a negative argument,
2970 move backward into the previous preprocessor conditional.
2973 function stops at them when going forward, but not when going
2974 backward."
2984 directives."
2992 "Move back across a preprocessor conditional, leaving mark behind.
2993 A prefix argument acts as a repeat count. With a negative argument,
2994 move forward across a preprocessor conditional.
2996 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2997 and have the same meanings as in `c-scan-conditionals'. If you
2998 are calling c-forward-conditional from a program, you might want
2999 to call `c-scan-conditionals' directly instead."
3007 "Move forward across a preprocessor conditional, leaving mark behind.
3008 A prefix argument acts as a repeat count. With a negative argument,
3009 move backward across a preprocessor conditional.
3011 If there aren't enough conditionals after \(or before) point, an
3012 error is signaled.
3015 the nesting level isn't changed when tracking subconditionals.
3017 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3018 and have the same meanings as in `c-scan-conditionals'. If you
3019 are calling c-forward-conditional from a program, you might want
3020 to call `c-scan-conditionals' directly instead."
3027 "Scan forward across COUNT preprocessor conditionals.
3028 With a negative argument, scan backward across preprocessor
3029 conditionals. Return the end position. Point is not moved.
3031 If there aren't enough preprocessor conditionals, throw an error.
3034 the nesting level isn't changed when tracking subconditionals.
3036 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3037 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3038 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3039 counts as -1.
3042 are treated as conditional clause limits. Normally they are ignored."
3046 new case-fold-search)
3052 ;; subdepth is the depth in "uninteresting" subtrees,
3053 ;; i.e. those that takes us farther from the target
3054 ;; depth instead of closer.
3056 found)
3058 ;; Find the "next" significant line in the proper direction.
3060 ;; Rather than searching for a # sign that
3061 ;; comes at the beginning of a line aside from
3062 ;; whitespace, search first for a string
3063 ;; starting with # sign. Then verify what
3064 ;; precedes it. This is faster on account of
3065 ;; the fastmap feature of the regexp matcher.
3068 nil t))
3070 ;; Now verify it is really a preproc line.
3078 ;; When we're not in an "uninteresting"
3079 ;; subtree, we might want to act on "elif"
3080 ;; and "else" too.
3082 ;; Always move toward the target depth.
3087 ;; Ignore the change if it'd take us
3088 ;; into an "uninteresting" subtree.
3096 ;; If we are trying to move across, and we find an
3097 ;; end before we find a beginning, get an error.
3100 "No following conditional at this level"
3102 ;; When searching forward, start from next line so
3103 ;; that we don't find the same line again.
3105 ;; We found something if we've arrived at the
3106 ;; target depth.
3109 ;; else
3116 new))
3118 \f
3119 ;; commands to indent lines, regions, defuns, and expressions
3121 "Indent current line as C code, and/or insert some whitespace.
3123 If `c-tab-always-indent' is t, always just indent the current line.
3124 If nil, indent the current line only if point is at the left margin or
3125 in the line's indentation; otherwise insert some whitespace[*]. If
3126 other than nil or t, then some whitespace[*] is inserted only within
3127 literals (comments and strings), but the line is always reindented.
3129 If `c-syntactic-indentation' is t, indentation is done according to
3130 the syntactic context. A numeric argument, regardless of its value,
3131 means indent rigidly all the lines of the expression starting after
3132 point so that this line becomes properly indented. The relative
3133 indentation among the lines of the expression is preserved.
3135 If `c-syntactic-indentation' is nil, the line is just indented one
3136 step according to `c-basic-offset'. In this mode, a numeric argument
3137 indents a number of such steps, positive or negative, and an empty
3138 prefix argument is equivalent to -1.
3140 [*] The amount and kind of whitespace inserted is controlled by the
3141 variable `c-insert-tab-function', which is called to do the actual
3142 insertion of whitespace. Normally the function in this variable
3143 just inserts a tab character, or the equivalent number of spaces,
3144 depending on the variable `indent-tabs-mode'."
3153 -1
3161 ;; Realign the line continuation backslash if inside a macro.
3163 ))))
3165 ;; If c-syntactic-indentation and got arg, always indent this
3166 ;; line as C and shift remaining lines of expression the same
3167 ;; amount.
3171 beg end)
3176 shift-amt))
3188 ;; Else use c-tab-always-indent to determine behavior.
3190 ;; CASE 1: indent when at column zero or in line's indentation,
3191 ;; otherwise insert a tab
3198 ;; CASE 2: just indent the line
3201 ;; CASE 3: if in a literal, insert a tab, but always indent the
3202 ;; line
3207 )))))
3210 "Indent each line in the balanced expression following point syntactically.
3211 If optional SHUTUP-P is non-nil, no errors are signaled if no
3212 balanced expression is found."
3215 end)
3219 ;; Find the closest following open paren that
3220 ;; ends on another line.
3228 ;; sanity check
3244 "Indent the current top-level declaration or macro syntactically.
3245 In the macro case this also has the effect of realigning any line
3246 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3252 ;; We try to be line oriented, unless there are several
3253 ;; declarations on the same line.
3265 "Indent syntactically every line whose first char is between START
3266 and END inclusive. If the optional argument QUIET is non-nil then no
3267 syntactic errors are reported, even if `c-report-syntactic-errors' is
3268 non-nil."
3274 ;; Advance to first nonblank line.
3282 ;; shut up any echo msgs on indiv lines
3288 start))
3290 syntax)
3298 ;; update progress
3300 ;; skip empty lines
3303 ;; Get syntax and indent.
3309 ;; End of current multi-line macro?
3312 ;; Fixup macro backslashes.
3315 ;; New multi-line macro?
3327 c-parsing-error))))
3330 ;; Function version of the macro for use in places that aren't
3331 ;; compiled, e.g. in the menus.
3335 "Indent active region, current line, or block starting on this line.
3336 In Transient Mark mode, when the region is active, reindent the region.
3337 Otherwise, with a prefix argument, rigidly reindent the expression
3338 starting on the current line.
3339 Otherwise reindent just the current line."
3345 \f
3346 ;; for progress reporting
3351 ;; Be silent
3353 ;; Start the progress update messages. If this Emacs doesn't have
3354 ;; a built-in timer, just be dumb about it.
3357 ;; If progress has already been initialized, do nothing. otherwise
3358 ;; initialize the counter with a vector of:
3359 ;; [start end lastsec context]
3366 context))
3368 ))
3372 nil
3377 ;; should we update? currently, update happens every 2 seconds,
3378 ;; what's the right value?
3384 )))
3388 nil
3397 \f
3398 ;;; This page handles insertion and removal of backslashes for C macros.
3401 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3402 With no argument, inserts backslashes and aligns existing backslashes.
3403 With an argument, deletes the backslashes. The backslash alignment is
3404 done according to the settings in `c-backslash-column',
3405 `c-backslash-max-column' and `c-auto-align-backslashes'.
3407 This function does not modify blank lines at the start of the region.
3408 If the region ends at the start of a line and the macro doesn't
3409 continue below it, the backslash (if any) at the end of the previous
3410 line is deleted.
3412 You can put the region around an entire macro definition and use this
3413 command to conveniently insert and align the necessary backslashes."
3416 ;; Keep the backslash trimming functions from changing the
3417 ;; whitespace around point, since in this case it's only the
3418 ;; position of point that tells the indentation of the line.
3424 column longest-line-col bs-col-after-end)
3428 ;; Nothing to do if to is at bob, since we should back up
3429 ;; and there's no line to back up to.
3430 nil
3432 ;; Do not back up the to line if line-mode is set, to make
3433 ;; e.g. c-newline-and-indent consistent regardless whether
3434 ;; the (newline) call leaves point at bol or not.
3442 ;; Set bs-col-after-end to the column of any backslash
3443 ;; following the region, or nil if there is none.
3452 ;; Back up the to line if line-mode is set, since the line
3453 ;; after the newly inserted line break should not be
3454 ;; touched in c-newline-and-indent.
3457 ;; Set bs-col-after-end to non-nil in any case, since we
3458 ;; do not want to delete the backslash at the last line.
3463 ;; Compute the smallest column number past the ends of all
3464 ;; the lines.
3468 ;; Include one more line in the max column
3469 ;; calculation, since the to line will be backslashed
3470 ;; too.
3483 ;; Try to align with surrounding backslashes.
3492 ;; Both a preceding and a following backslash.
3493 ;; Choose the greatest of them.
3496 ;; No preceding backslash. Try to align with one
3497 ;; following the region. Disregard the backslash at the
3498 ;; to line since it's likely to be bogus (e.g. when
3499 ;; called from c-newline-and-indent).
3502 ;; Don't modify blank lines at start of region.
3507 ;; Don't try to align with surrounding backslashes if
3508 ;; any line is too long.
3511 ;; Impose minimum limit and tab width alignment only if
3512 ;; we can't align with surrounding backslashes.
3516 tab-width)
3517 tab-width)))
3519 longest-line-col)))
3520 ;; Always impose maximum limit.
3523 ;; Add backslashes on all lines if the macro continues
3524 ;; after the to line.
3528 ;; Add backslashes on all lines except the last, and
3529 ;; remove any on the last line.
3537 ;; The function above leaves point on the line
3538 ;; following endmark.
3563 ;; Avoid unnecessary changes of the buffer.
3565 ;; Don't realign backslashes in string literals
3566 ;; since that would change them.
3567 )
3593 ;; Make sure there are backslashes with at least one space in
3594 ;; front of them.
3629 point-pos))
3635 \f
3636 ;;; Line breaking and paragraph filling.
3642 ;; The filling code is based on a simple theory; leave the intricacies
3643 ;; of the text handling to the currently active mode for that
3644 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3645 ;; possible to make them work correctly wrt the comment and string
3646 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3647 ;; to it, there's quite a lot of special cases to handle which makes
3648 ;; the code anything but simple. The intention is that it will work
3649 ;; with any well-written text filling package that preserves a fill
3650 ;; prefix.
3651 ;;
3652 ;; We temporarily mask comment starters and enders as necessary for
3653 ;; the filling code to do its job on a seemingly normal text block.
3654 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3655 ;; preserve it correctly (especially important when filling C++ style
3656 ;; line comments). By default, we set up and use adaptive-fill-mode,
3657 ;; which is standard in all supported Emacs flavors.
3660 ;; Determine the appropriate comment fill prefix for a block or line
3661 ;; comment. Return a cons of the prefix string and the column where
3662 ;; it ends. If fill-prefix is set, it'll override. Note that this
3663 ;; function also uses the value of point in some heuristics.
3664 ;;
3665 ;; This function might do hidden buffer changes.
3669 c-current-comment-prefix
3672 prefix-regexp
3673 comment-start-skip))
3674 prefix-line comment-prefix res comment-text-end)
3679 ;; Ugly way of getting the column after the fill
3680 ;; prefix; it'd be nice with a current-column
3681 ;; that works on strings..
3691 ;; Set fallback for comment-prefix if none is found.
3697 ;; The current line is not the comment starter, so the
3698 ;; comment has more than one line, and it can therefore be
3699 ;; used to find the comment fill prefix.
3705 ;; The line after the comment starter is inside the
3706 ;; comment, so we can use it.
3709 ;; The comment is only one line. Take the comment prefix
3710 ;; from it and keep the indentation.
3719 ;; There is only whitespace before the comment
3720 ;; starter; take the prefix straight from this line.
3725 ;; There is code before the comment starter, so we
3726 ;; have to temporarily insert and indent a new line to
3727 ;; get the right space/tab mix in the indentation.
3729 tmp)
3745 ;; The prefix ends the line with no whitespace
3746 ;; after it. Default to a single space.
3748 )))))
3761 ;; The current line is not the comment starter and
3762 ;; contains more than just the ender, so it's good enough
3763 ;; to be used for the comment fill prefix.
3773 ;; The comment is either one line or the next line contains
3774 ;; just the comment ender. In this case we have no
3775 ;; information about a suitable comment prefix, so we resort
3776 ;; to c-block-comment-prefix.
3780 ;; The point was on the comment opener line, so we might want
3781 ;; to treat this as a not yet closed comment.
3785 ;; Above `prefix-regexp' matched a nonempty prefix on the
3786 ;; second line, so let's use it. Normally it should do
3787 ;; to set `prefix-line' and let the code below pick up
3788 ;; the whole prefix, but if there's no text after the
3789 ;; match then it will probably fall back to no prefix at
3790 ;; all if the comment isn't closed yet, so in that case
3791 ;; it's better to force use of the prefix matched now.
3796 ;; There's no nonempty prefix on the line after the
3797 ;; comment opener. If the line is empty, or if the
3798 ;; text on it has less or equal indentation than the
3799 ;; comment starter we assume it's an unclosed
3800 ;; comment starter, i.e. that
3801 ;; `c-block-comment-prefix' should be used.
3802 ;; Otherwise we assume it's a closed comment where
3803 ;; the prefix really is the empty string.
3804 ;; E.g. this is an unclosed comment:
3805 ;;
3806 ;; /*
3807 ;; foo
3808 ;;
3809 ;; But this is not:
3810 ;;
3811 ;; /*
3812 ;; foo
3813 ;; */
3814 ;;
3815 ;; (Looking for the presence of the comment closer
3816 ;; rarely works since it's probably the closer of
3817 ;; some comment further down when the comment
3818 ;; really is unclosed.)
3827 ;; Otherwise the line after the comment starter is good
3828 ;; enough to find the prefix in.
3832 ;; Haven't got the comment prefix on any real line that we
3833 ;; can take it from, so we have to temporarily insert
3834 ;; `comment-prefix' on a line and indent it to find the
3835 ;; correct column and the correct mix of tabs and spaces.
3844 comment-text-end))
3849 ;; If there's ws on the current line, we'll use it
3850 ;; instead of what's ending comment-prefix.
3855 comment-prefix))
3864 ;; We insert an extra non-whitespace character
3865 ;; before the line break and after comment-prefix in
3866 ;; case it's "" or ends with whitespace.
3885 ;; prefix-line is the bol of a line on which we should try
3886 ;; to find the prefix.
3893 ;; The match is fine if there's text after it.
3899 ;; This match is better than nothing, so let's
3900 ;; remember it in case nothing better is found
3901 ;; on another line.
3905 t))))
3908 ;; Search for a line which has text after the prefix
3909 ;; so that we get the proper amount of whitespace
3910 ;; after it. We start with the current line, then
3911 ;; search backwards, then forwards.
3916 ;; The whitespace is sucked up by the
3917 ;; first [ \t]* glob if the prefix is empty.
3920 ;; If the current line doesn't have text but do
3921 ;; have whitespace after the prefix, we'll use it.
3927 ;; For line comments we can search up to and
3928 ;; including the first line.
3932 ;; For block comments we must stop before the
3933 ;; block starter.
3944 nil)
3947 ;; A good line wasn't found, but at least we have a
3948 ;; fallback that matches the comment prefix regexp.
3953 ;; There are ws or text after the prefix, so
3954 ;; let's use it.
3958 ;; Check if there's any whitespace padding
3959 ;; on the comment start line that we can
3960 ;; use after the prefix.
3978 ;; Got to mess in the buffer once again to
3979 ;; ensure the column gets correct. :P
3990 ;; Last resort: Just add a single space after
3991 ;; the prefix.
3996 ;; The line doesn't match the comment prefix regexp.
3998 ;; We have a fallback for line comments that we must use.
4001 comment-prefix)
4005 ;; Assume we are dealing with a "free text" block
4006 ;; comment where the lines doesn't have any comment
4007 ;; prefix at all and we should just fill it as
4008 ;; normal text.
4010 ))
4013 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4014 ;; masked to allow adaptive filling to work correctly. That
4015 ;; includes narrowing the buffer and, if point is inside a comment,
4016 ;; masking the comment starter and ender appropriately.
4017 ;;
4018 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4019 ;; The position of point is then less significant when doing masking
4020 ;; and narrowing.
4021 ;;
4022 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4023 ;; only if the point turns out to be inside a comment or a string.
4024 ;;
4025 ;; Note that this function does not do any hidden buffer changes.
4028 ;; beg and end limit the region to narrow. end is a marker.
4029 beg end
4030 ;; tmp-pre and tmp-post mark strings that are temporarily
4031 ;; inserted at the start and end of the region. tmp-pre is a
4032 ;; cons of the positions of the prepended string. tmp-post is
4033 ;; a marker pointing to the single character of the appended
4034 ;; string.
4035 tmp-pre tmp-post
4036 ;; If hang-ender-stuck isn't nil, the comment ender is
4037 ;; hanging. In that case it's set to the number of spaces
4038 ;; that should be between the text and the ender.
4039 hang-ender-stuck
4040 ;; auto-fill-spaces is the exact sequence of whitespace between a
4041 ;; comment's last word and the comment ender, temporarily replaced
4042 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4043 auto-fill-spaces
4048 ;; Restore point on undo. It's necessary since we do a lot of
4049 ;; hidden inserts and deletes below that should be as transparent
4050 ;; as possible.
4054 ;; Determine the limits and type of the containing literal (if any):
4055 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4056 ;; BEG and END.
4059 ;; Widen to catch comment limits correctly.
4084 ;; For each of the possible types of text (string, C comment ...)
4085 ;; determine BEG and END, the region we will narrow to. If we're in
4086 ;; a literal, constrain BEG and END to the limits of this literal.
4087 ;;
4088 ;; For some of these text types, particularly a block comment, we
4089 ;; may need to massage whitespace near literal delimiters, so that
4090 ;; these don't get filled inappropriately.
4095 ;; Limit to the comment or paragraph end, whichever
4096 ;; comes first.
4100 ;; The region includes the comment starter, so we must
4101 ;; check it.
4105 ;; Include the first line in the region.
4107 ;; The first line contains code before the
4108 ;; comment. We must fake a line that doesn't.
4119 ;; disallow "/*/"
4121 ;; There is a comment ender, and the region includes it. If
4122 ;; it's on its own line, it stays on its own line. If it's got
4123 ;; company on the line, it keeps (at least one word of) it.
4124 ;; "=====*/" counts as a comment ender here, but "===== */"
4125 ;; doesn't and "foo*/" doesn't.
4130 ;; The following conjunct was added to avoid an
4131 ;; "Invalid search bound (wrong side of point)"
4132 ;; error in the subsequent re-search. Maybe
4133 ;; another fix would be needed (2007-12-08).
4134 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4135 ; 2010-10-17 Construct removed.
4136 ; (or (< (- (cdr c-lit-limits) 2) (point))
4144 ;; The comment ender IS on its own line. Exclude this
4145 ;; line from the filling.
4148 ;; The comment ender is hanging. Replace all space between it
4149 ;; and the last word either by one or two 'x's (when
4150 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4151 ;; as the whitespace (when auto filling), and include it in
4152 ;; the region. We'll change them back to whitespace
4153 ;; afterwards. The effect of this is to glue the comment
4154 ;; ender to the last word in the comment during filling.
4171 spaces)
4174 ;; Insert a CR after the "*/", adjust END
4182 c-current-comment-prefix
4185 ;; The comment ender is prefixed by nothing but a
4186 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4187 ;; 2006/4/28). Remove it along with surrounding ws.
4191 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4193 ;; What's being tested here? 2006/4/20. FIXME!!!
4197 ;; Don't adjust point below if it's
4198 ;; before the string we replace.
4200 ;; Keep one or two spaces between the
4201 ;; text and the ender, depending on how
4202 ;; many there are now.
4207 ;; paragraph filling condenses multiple spaces to
4208 ;; single or double spaces. auto-fill doesn't.
4214 sentence-end-double-space)
4217 ;; Insert the filler first to keep marks right.
4226 ;; Point was in the middle of the string we
4227 ;; replaced above, so put it back in the same
4228 ;; relative position, counting from the end.
4230 ))
4233 ;; The region includes the comment starter.
4237 ;; Begin with the next line.
4239 ;; Fake the fill prefix in the first line.
4254 ;; Leave the start line if it's
4255 ;; nothing but an escaped newline.
4261 ;; Narrow to the macro limits if they are nearer than the
4262 ;; paragraph limits. Don't know if this is necessary but
4263 ;; do it for completeness sake (doing auto filling at all
4264 ;; inside macros is bogus to begin with since the line
4265 ;; continuation backslashes aren't handled).
4278 ;; Try to avoid comments and macros in the paragraph to
4279 ;; avoid that the adaptive fill mode gets the prefix from
4280 ;; them.
4293 ;; Temporarily insert the fill prefix after the comment
4294 ;; starter so that the first line looks like any other
4295 ;; comment line in the narrowed region.
4299 c-current-comment-prefix
4302 ;; Oops, the prefix doesn't match the comment prefix
4303 ;; regexp. This could produce very confusing
4304 ;; results with adaptive fill packages together with
4305 ;; the insert prefix magic below, since the prefix
4306 ;; often doesn't appear at all. So let's warn about
4307 ;; it.
4309 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4311 ;; Find the right spot on the line, break it, insert
4312 ;; the fill prefix and make sure we're back in the
4313 ;; same column by temporarily prefixing the first word
4314 ;; with a number of 'x'.
4318 c-current-comment-prefix
4319 comment-start-skip))
4336 ;; `apply-outside-literal' is always set to t here if
4337 ;; we're inside a literal.
4341 ;; Kludge: If the function that adapts the fill prefix
4342 ;; doesn't produce the required comment starter for
4343 ;; line comments, then force it by setting fill-prefix.
4345 ;; Kludge the kludge: filladapt-mode doesn't
4346 ;; have this problem, but it currently
4347 ;; doesn't override fill-context-prefix
4348 ;; (version 2.12).
4350 filladapt-mode))
4357 c-lit-limits c-lit-type)))))))
4359 ;; Save the relative position of point if it's outside the
4360 ;; region we're going to narrow. Want to restore it in that
4361 ;; case, but otherwise it should be moved according to the
4362 ;; called function.
4366 ;; Preparations finally done! Now we can call the
4367 ;; actual function.
4373 ;; Restore point if it was outside the region.
4386 ;; Preserve point even if it's in the middle of the string
4387 ;; we replace; save-excursion doesn't work in that case.
4403 If any of the current line is a comment or within a comment, fill the
4404 comment or the paragraph of it that point is in, preserving the
4405 comment indentation or line-starting decorations (see the
4406 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4407 details).
4409 If point is inside multiline string literal, fill it. This currently
4410 does not respect escaped newlines, except for the special case when it
4411 is the very first thing in the string. The intended use for this rule
4412 is in situations like the following:
4415 A very long description of something that you want to fill to make
4418 If point is in any other situation, i.e. in normal code, do nothing.
4420 Optional prefix ARG means justify paragraph as well."
4423 ;; Avoid infinite recursion.
4425 fill-paragraph-function)))
4427 ;; Always return t. This has the effect that if filling isn't done
4428 ;; above, it isn't done at all, and it's therefore effectively
4429 ;; disabled in normal code.
4430 t)
4433 ;; Do automatic filling if not inside a context where it should be
4434 ;; ignored.
4436 ;; The decision whether the line should be broken is actually
4437 ;; done in c-indent-new-comment-line, which do-auto-fill
4438 ;; calls to break lines. We just set this special variable
4439 ;; so that we'll know when we're called from there. It's
4440 ;; also used to detect whether fill-prefix is user set or
4441 ;; generated automatically by do-auto-fill.
4442 fill-prefix))
4446 "Break line at point and indent, continuing comment or macro if within one.
4447 If inside a comment and `comment-multi-line' is non-nil, the
4448 indentation and line prefix are preserved (see the
4449 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4450 details). If inside a single line comment and `comment-multi-line' is
4451 nil, a new comment of the same type is started on the next line and
4452 indented as appropriate for comments. If inside a macro, a line
4453 continuation backslash is inserted and aligned as appropriate, and the
4454 new line is indented according to `c-syntactic-indentation'.
4456 If a fill prefix is specified, it overrides all the above."
4457 ;; allow-auto-fill is used from c-context-line-break to allow auto
4458 ;; filling to break the line more than once. Since this function is
4459 ;; used from auto-fill itself, that's normally disabled to avoid
4460 ;; unnecessary recursion.
4469 ;; Already know the literal type and limits when called from
4470 ;; c-context-line-break.
4477 ;; Called from do-auto-fill.
4485 c-ignore-auto-fill)
4490 ;; The adaptive fill function has generated a prefix, but
4491 ;; we're on the first line in a block comment so it'll be
4492 ;; wrong. Ignore it to guess a better one below.
4496 c-line-comment-starter)
4498 ;; Kludge: If the function that adapted the fill prefix
4499 ;; doesn't produce the required comment starter for line
4500 ;; comments, then we ignore it.
4502 )))
4505 ;; A call from do-auto-fill which should be ignored.
4506 )
4508 ;; A fill-prefix overrides anything.
4517 ;; Some sort of comment.
4523 ;; Inside a comment that should be continued.
4528 c-lit-type)))
4537 ;; Skip forward past the fill prefix in case
4538 ;; we're standing in it.
4539 ;;
4540 ;; FIXME: This doesn't work well in cases like
4541 ;;
4542 ;; /* Bla bla bla bla bla
4543 ;; bla bla
4544 ;;
4545 ;; If point is on the 'B' then the line will be
4546 ;; broken after "Bla b".
4547 ;;
4548 ;; If we have an empty comment, /* */, the next
4549 ;; lot of code pushes point to the */. We fix
4550 ;; this by never allowing point to end up to the
4551 ;; right of where it started.
4558 ;; The skip takes us out of the (block)
4559 ;; comment; insert the fill prefix at bol
4560 ;; instead and keep the position.
4567 ;; Don't break in the middle of a comment starter
4568 ;; or ender.
4577 ; middle of a TAB?
4578 ;; Inside a comment that should be broken.
4581 col)
4595 ;; c-comment-indent may look at the current
4596 ;; indentation, so let's start out with the same
4597 ;; indentation as the previous one.
4602 ;; In a macro.
4604 ;; Do not clobber the alignment of the line continuation
4605 ;; slash; c-backslash-region might look at it.
4607 ;; Got an asymmetry here: In normal code this command
4608 ;; doesn't indent the next line syntactically, and otoh a
4609 ;; normal syntactically indenting newline doesn't continue
4610 ;; the macro.
4613 ;; Somewhere else in the code.
4625 ;; advice for indent-new-comment-line for older Emacsen
4629 activate preactivate)
4630 "Call `c-indent-new-comment-line' if in CC Mode."
4633 ad-do-it
4638 "Do a line break suitable to the context.
4640 When point is outside a comment or macro, insert a newline and indent
4641 according to the syntactic context, unless `c-syntactic-indentation'
4642 is nil, in which case the new line is indented as the previous
4643 non-empty line instead.
4645 When point is inside the content of a preprocessor directive, a line
4646 continuation backslash is inserted before the line break and aligned
4647 appropriately. The end of the cpp directive doesn't count as inside
4648 it.
4650 When point is inside a comment, continue it with the appropriate
4651 comment prefix (see the `c-comment-prefix-regexp' and
4652 `c-block-comment-prefix' variables for details). The end of a
4653 C++-style line comment doesn't count as inside it.
4655 When point is inside a string, only insert a backslash when it is also
4656 inside a preprocessor directive."
4661 case-fold-search)
4678 ; it, not in a string, and not in the
4679 ; cpp keyword.
4701 ;; c-indent-line may look at the current indentation, so let's
4702 ;; start out with the same indentation as the previous line.
4713 "Insert a line break suitable to the context and leave point before it.
4714 This is the `c-context-line-break' equivalent to `open-line', which is
4715 normally bound to C-o. See `c-context-line-break' for the details."
4720 ;; Temporarily insert a non-whitespace char to keep any
4721 ;; preceding whitespace intact.
4727 \f
4730 ;;; cc-cmds.el ends here