| blob | 32ce8c6a249e5343d62ab54bc748a7b9315babc6 |
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2015 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 ;; (cc-)subword might not be loaded.
264 ;; FIXME: subword-mode already comes with its
265 ;; own lighter!
266 "w"
268 ;; FIXME: Derived modes might want to use something else
269 ;; than a string for `mode-name'.
272 mode-name)))
273 ;; (setq c-submode-indicators
274 ;; (if (> (length fmt) 1)
275 ;; fmt))
279 bare-mode-name))
283 "Toggle syntactic indentation.
284 Optional numeric ARG, if supplied, turns on syntactic indentation when
285 positive, turns it off when negative, and just toggles it when zero or
286 left out.
288 When syntactic indentation is turned on (the default), the indentation
289 functions and the electric keys indent according to the syntactic
290 context keys, when applicable.
292 When it's turned off, the electric keys don't reindent, the indentation
293 functions indents every new line to the same level as the previous
295 specified by `c-basic-offset'. The indentation style has no effect in
296 this mode, nor any of the indentation associated variables,
297 e.g. `c-special-indent-hook'.
299 This command sets the variable `c-syntactic-indentation'."
306 "Toggle auto-newline feature.
307 Optional numeric ARG, if supplied, turns on auto-newline when
308 positive, turns it off when negative, and just toggles it when zero or
309 left out.
311 Turning on auto-newline automatically enables electric indentation.
314 mode line after the mode name) newlines are automatically inserted
315 after special characters such as brace, comma, semi-colon, and colon."
327 "Toggle hungry-delete-key feature.
328 Optional numeric ARG, if supplied, turns on hungry-delete when
329 positive, turns it off when negative, and just toggles it when zero or
330 left out.
333 the mode line after the mode name) the delete key gobbles all preceding
334 whitespace in one fell swoop."
341 "Toggle auto-newline and hungry-delete-key features.
342 Optional numeric ARG, if supplied, turns on auto-newline and
343 hungry-delete when positive, turns them off when negative, and just
344 toggles them when zero or left out.
346 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
354 "Toggle the electric indentation feature.
355 Optional numeric ARG, if supplied, turns on electric indentation when
356 positive, turns it off when negative, and just toggles it when zero or
357 left out."
365 \f
366 ;; Electric keys
369 "Delete the preceding character or whitespace.
371 line) then all preceding whitespace is consumed. If however a prefix
372 argument is supplied, or `c-hungry-delete-key' is nil, or point is
373 inside a literal then the function in the variable
374 `c-backspace-function' is called."
378 arg
384 "Delete the preceding character or all preceding whitespace
385 back to the previous non-whitespace character.
397 "Delete the following character or whitespace.
399 line) then all following whitespace is consumed. If however a prefix
400 argument is supplied, or `c-hungry-delete-key' is nil, or point is
401 inside a literal then the function in the variable `c-delete-function'
402 is called."
406 arg
412 "Delete the following character or all following whitespace
413 up to the next non-whitespace character.
422 ;; This function is only used in XEmacs.
424 "Deletes preceding or following character or whitespace.
425 This function either deletes forward as `c-electric-delete-forward' or
426 backward as `c-electric-backspace', depending on the configuration: If
427 the function `delete-forward-p' is defined and returns non-nil, it
428 deletes forward. Otherwise it deletes backward.
430 Note: This is the way in XEmacs to choose the correct action for the
431 [delete] key, whichever key that means. Other flavors don't use this
432 function to control that."
439 ;; This function is only used in XEmacs.
441 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
442 The direction of deletion depends on the configuration: If the
443 function `delete-forward-p' is defined and returns non-nil, it deletes
444 forward using `c-hungry-delete-forward'. Otherwise it deletes
445 backward using `c-hungry-backspace'.
447 Note: This is the way in XEmacs to choose the correct action for the
448 [delete] key, whichever key that means. Other flavors don't use this
449 function to control that."
458 If `c-electric-flag' is set, handle it specially according to the variable
459 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
460 inside a literal or a macro, nothing special happens."
474 ;; do nothing special
476 ;; place the pound character at the left edge
484 )))
487 ;; Return the syntactic context of the construct at point. (This is NOT
488 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
489 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
492 syntax)
494 ;; insert a newline to isolate the construct at point for syntactic
495 ;; analysis.
497 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
498 ;; the syntax. (There might already be an escaped NL there.)
514 ;; Turn on syntactic macro analysis to help with auto
515 ;; newlines only.
517 nil))
518 syntax))
521 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
522 ;; (not necessarily the same as the S.C. of the line it is on). Return
523 ;; NEWLINES, the list containing some combination of the symbols `before'
524 ;; and `after' saying where newlines should be inserted.
527 ;; This is the list of brace syntactic symbols that can hang.
528 ;; If any new ones are added to c-offsets-alist, they should be
529 ;; added here as well.
530 ;;
531 ;; The order of this list is important; if SYNTAX has several
532 ;; elements, the element that "wins" is the earliest in SYMS.
534 class-open class-close defun-open defun-close
535 inline-open inline-close
536 brace-list-open brace-list-close
537 brace-list-intro brace-entry-open
538 block-open block-close
539 substatement-open statement-case-open
540 extern-lang-open extern-lang-close
541 namespace-open namespace-close
542 module-open module-close
543 composition-open composition-close
544 inexpr-class-open inexpr-class-close
545 ;; `statement-cont' is here for the case with a brace
546 ;; list opener inside a statement. C.f. CASE B.2 in
547 ;; `c-guess-continued-construct'.
548 statement-cont))
549 ;; shut this up too
554 ;; Do not try to insert newlines around a special
555 ;; (Pike-style) brace list.
562 nil
563 ;; Seek the matching entry in c-hanging-braces-alist.
565 syms
566 ;; Substitute inexpr-class and class-open or
567 ;; class-close with inexpr-class-open or
568 ;; inexpr-class-close.
575 syntax)
576 c-hanging-braces-alist)
579 ;; If syntax is a function symbol, then call it using the
580 ;; defined semantics.
590 ;; Point is just after a newly inserted }. If the non-whitespace
591 ;; content of the braces is a single line of code, compact the whole
592 ;; construct to a single line, if this line isn't too long. The Right
593 ;; Thing is done with comments.
594 ;;
595 ;; Point will be left after the }, regardless of whether the clean-up is
596 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
600 mbeg1 mend1 mbeg4 mend4
601 eol-col cmnt-pos cmnt-col cmnt-gap)
606 ;; Avoid backtracking over a very large block. The one we
607 ;; deal with here can never be more than three lines.
638 ;; Necessary to put the closing brace before any line
639 ;; oriented comment to keep it syntactically significant.
640 ;; This isn't necessary for block comments, but the result
641 ;; looks nicer anyway.
657 ;; Can we trim space before comment to make the line fit?
663 t))))
667 "Insert a brace.
669 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
670 numeric ARG hasn't been supplied, the command performs several electric
671 actions:
674 the mode line) newlines are inserted before and after the brace as
675 directed by the settings in `c-hanging-braces-alist'.
677 \(b) Any auto-newlines are indented. The original line is also
678 reindented unless `c-syntactic-indentation' is nil.
680 \(c) If auto-newline is turned on, various newline cleanups based on the
681 settings of `c-cleanup-list' are done."
685 ;; We want to inhibit blinking the paren since this would be
686 ;; most disruptive. We'll blink it ourselves later on.
688 blink-paren-function case-fold-search)
694 ;; Insert the brace. Note that expand-abbrev might reindent
695 ;; the line here if there's a preceding "else" or something.
705 newlines
707 ; of the brace itself, of the line the brace ends up on.
719 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
723 ;; Only a plain newline for now - it's indented
724 ;; after the cleanups when the line has its final
725 ;; appearance.
730 ;; `syntax' is the syntactic context of the line which ends up
731 ;; with the brace on it.
734 ;; Do all appropriate clean ups
737 mbeg mend
738 )
740 ;; `}': clean up empty defun braces
745 syntax)
750 ;; make sure matching open brace isn't in a comment
756 ;; `}': compact to a one-liner defun?
765 ;; `{': clean up brace-else-brace and brace-elseif-brace
772 "else"
774 "{"
776 nil t))
788 ; (progn
789 ; (setq tmp (point))
793 "else"
795 "if"
799 ;(eq (match-end 0) tmp);
800 )
807 ;; Indent the line after the cleanups since it might
808 ;; very well indent differently due to them, e.g. if
809 ;; c-indent-one-line-block is used together with the
810 ;; one-liner-defun cleanup.
814 ;; does a newline go after the brace?
817 ))))
819 ;; blink the paren
822 old-blink-paren
829 "Insert a slash character.
831 If the slash is inserted immediately after the comment prefix in a c-style
832 comment, the comment might get closed by removing whitespace and possibly
835 Indent the line as a comment, if:
838 token and we are on a comment-only-line, or
841 comment.
843 If a numeric ARG is supplied, point is inside a literal, or
844 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
845 is inhibited."
848 indentp
849 ;; shut this up
852 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
853 ;; `c-syntactic-indentation' set.
860 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
871 c-syntactic-indentation
872 c-electric-flag
880 "Insert a star character.
881 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
882 the star is the second character of a C style comment starter on a
883 comment-only-line, indent the line as a comment. If a numeric ARG is
884 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
885 this indentation is inhibited."
889 ;; if we are in a literal, or if arg is given do not reindent the
890 ;; current line, unless this star introduces a comment-only line.
893 c-electric-flag
906 ))
909 "Insert a comma or semicolon.
911 If `c-electric-flag' is non-nil, point isn't inside a literal and a
912 numeric ARG hasn't been supplied, the command performs several electric
913 actions:
916 the mode line) a newline might be inserted. See the variable
917 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
919 \(b) Any auto-newlines are indented. The original line is also
920 reindented unless `c-syntactic-indentation' is nil.
922 \(c) If auto-newline is turned on, a comma following a brace list or a
923 semicolon following a defun might be cleaned up, depending on the
924 settings of `c-cleanup-list'."
928 ;; shut this up
938 ;; do all cleanups and newline insertions if c-auto-newline is on.
943 ;; clean ups: list-close-comma or defun-close-semi
956 ;; make sure matching open brace isn't in a comment
960 ;; reindent line
964 ;; check to see if a newline should be added
966 answer add-newline-p)
969 ;; only nil value means continue checking
973 ;; only 'stop specifically says do not add a newline
975 ))
978 )))))
981 "Insert a colon.
983 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
984 numeric ARG hasn't been supplied, the command performs several electric
985 actions:
988 the mode line) newlines are inserted before and after the colon based on
989 the settings in `c-hanging-colons-alist'.
991 \(b) Any auto-newlines are indented. The original line is also
992 reindented unless `c-syntactic-indentation' is nil.
994 \(c) If auto-newline is turned on, whitespace between two colons will be
996 `c-cleanup-list'."
1001 newlines is-scope-op
1002 ;; shut this up
1005 ;; Any electric action?
1007 ;; Unless we're at EOL, only re-indentation happens.
1012 ;; scope-operator clean-up?
1030 ;; indent the current line if it's done syntactically.
1032 ;; Cannot use the same syntax analysis as we find below,
1033 ;; since that's made with c-syntactic-indentation-in-macros
1034 ;; always set to t.
1037 ;; Calculate where, if anywhere, we want newlines.
1041 ;; Turn on syntactic macro analysis to help with auto newlines
1042 ;; only.
1045 ;; Translate substatement-label to label for this operation.
1050 ;; some language elements can only be determined by checking
1051 ;; the following line. Let's first look for ones that can be
1052 ;; found when looking on the line with the colon
1056 syntax c-hanging-colons-alist)
1063 c-hanging-colons-alist)))))
1064 ;; does a newline go before the colon? Watch out for already
1065 ;; non-hung colons. However, we don't unhang them because that
1066 ;; would be a cleanup (and anti-social).
1076 ;; does a newline go after the colon?
1080 ))))
1084 If the current language uses angle bracket parens (e.g. template
1085 arguments in C++), try to find out if the inserted character is a
1086 paren and give it paren syntax if appropriate.
1088 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1089 line will be reindented if the inserted character is a paren or if it
1090 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1091 numeric argument is supplied, or the point is inside a literal."
1095 final-pos found-delim case-fold-search)
1100 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1101 ;;;; property on the new < or > and its mate (if any) when they are template
1102 ;;;; parens. This is now done in an after-change function.
1104 ;; Indent the line if appropriate.
1108 ;; If a <, basically see if it's got "template" before it .....
1116 ;; ..... or is a C++ << operator.
1124 ;; It's a >. Either a C++ >> operator. ......
1131 ;; ...., or search back for a < which isn't already marked as an
1132 ;; opening template delimiter.
1135 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1136 ;; our position.
1159 blink-paren-function)
1160 ;; Currently (2014-10-19), the syntax-table text properties on < and >
1161 ;; are only applied in code called during Emacs redisplay. We thus
1162 ;; explicitly cause a redisplay so that these properties have been
1163 ;; applied when `blink-paren-function' gets called.
1168 "Insert a parenthesis.
1170 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1171 line is reindented unless a numeric ARG is supplied, or the parenthesis
1172 is inserted inside a literal.
1174 Whitespace between a function name and the parenthesis may get added or
1175 removed; see the variable `c-cleanup-list'.
1177 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1178 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1181 ;; shut this up
1183 case-fold-search)
1188 ;; be most disruptive. We'll blink it ourselves
1189 ;; afterwards.
1191 blink-paren-function)
1195 ;; If we're at EOL, check for new-line clean-ups.
1199 ;; clean up brace-elseif-brace
1206 "else"
1208 "if"
1210 "("
1212 nil t)
1217 ;; clean up brace-catch-brace
1224 "catch"
1226 "("
1228 nil t)
1233 ;; Check for clean-ups at function calls. These two DON'T need
1234 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1235 ;; Point is currently just after the inserted paren.
1239 ;; space-before-funcall clean-up?
1247 ;; Don't add a space into #define FOO()....
1256 ;; compact-empty-funcall clean-up?
1270 old-blink-paren
1274 "Reindent the current line if appropriate.
1276 This function is used to reindent the line after a keyword which
1280 The line is reindented if there is nothing but whitespace before the
1281 keyword on the line, the keyword is not inserted inside a literal, and
1282 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1287 c-syntactic-indentation
1294 ;; Have to temporarily insert a space so that
1295 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1296 ;; space with a nonspace to avoid messing up any whitespace
1297 ;; sensitive meddling that might be done, e.g. by
1298 ;; `c-backslash-region'.
1304 \f
1311 ;; Recent Emacsen come with their own subword support. Use that.
1315 ;; Autoload directive for emacsen that doesn't have an older CC Mode
1316 ;; version in the dist.
1323 ;; "nomenclature" functions + c-scope-operator.
1325 "Compatibility alias for `c-forward-subword'."
1338 "Compatibility alias for `c-backward-subword'."
1347 'c-backward-into-nomenclature
1351 "Insert a double colon scope operator at point.
1356 \f
1357 ;; Movement (etc.) by defuns.
1359 ;; Return non-nil if point is between the closing brace and the semicolon of
1360 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1361 ;; portion of a declaration like "struct foo {...} bar ;".
1362 ;;
1363 ;; Return the position of the main declaration. Otherwise, return nil.
1364 ;; Point is assumed to be at the top level and outside of any macro or
1365 ;; literal.
1366 ;;
1367 ;; If LIM is non-nil, it is the bound on a the backward search for the
1368 ;; beginning of the declaration.
1369 ;;
1370 ;; This function might do hidden buffer changes.
1375 bod)
1379 ;; Look for struct or union or ... If we find one, it might
1380 ;; be the return type of a function, or the like. Exclude
1381 ;; this case.
1384 c-opt-block-decls-with-vars-key
1386 eo-block t t t)
1391 bod)))))
1394 ;; Determine where we are with respect to functions (or other brace
1395 ;; constructs, included in the term "function" in the rest of this comment).
1396 ;; Point is assumed to be outside any macro or literal.
1397 ;; This is used by c-\(beginning\|end\)-of-defun.
1398 ;;
1399 ;; Return one of these symbols:
1400 ;; at-header : we're at the start of a function's header.
1401 ;; in-header : we're inside a function's header, this extending right
1402 ;; up to the brace. This bit includes any k&r declarations.
1403 ;; in-block : we're inside a function's brace block.
1404 ;; in-trailer : we're in the area between the "}" and ";" of something
1405 ;; like "struct foo {...} bar, baz;".
1406 ;; at-function-end : we're just after the closing brace (or semicolon) that
1407 ;; terminates the function.
1408 ;; outwith-function: we're not at or in any function. Being inside a
1409 ;; non-brace construct also counts as 'outwith-function'.
1410 ;;
1411 ;; This function might do hidden buffer changes.
1414 decl-result brace-decl-p
1431 ;; Find the start of the current declaration. NOTE: If we're in the
1432 ;; variables after a "struct/eval" type block, we don't get to the
1433 ;; real declaration here - we detect and correct for this later.
1435 ;;If we're in the parameters' parens, move back out of them.
1437 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1438 ;; at a declaration.
1446 ;; NOTE: If we're in a K&R region, this might be the start
1447 ;; of a parameter declaration, not the actual function.
1448 ;; It might also leave us at a label or "label" like
1449 ;; "private:".
1453 ;; Has the declaration we've gone back to got braces?
1460 ;; Might have stopped on the
1461 ;; ';' in a K&R argdecl. In
1462 ;; that case the declaration
1463 ;; should contain a block.
1473 'at-header
1479 'at-function-end
1482 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1483 decl-result))))))))
1486 ;; Skip to the opening brace of the Nth function before point. If
1487 ;; point is inside a function, this counts as the first. Point must be
1488 ;; outside any comment/string or macro.
1489 ;;
1490 ;; N must be strictly positive.
1491 ;; WHERE describes the position of point, one of the symbols `at-header',
1492 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1493 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1494 ;;
1495 ;; If we run out of functions, leave point at BOB. Return zero on success,
1496 ;; otherwise the number of {s still to go.
1497 ;;
1498 ;; This function may do hidden buffer changes
1500 ;; What we do to go back the first defun depends on where we start.
1516 ;; Each time round the loop, go back to a "{" at the outermost level.
1519 ; by a factor of ~6. Hmmm. 2006/4/5.
1524 n)
1527 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1528 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1529 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1530 ;; otherwise include the braces. If the closing brace is missing,
1531 ;; (point-max) is used instead.
1533 encl-decl)
1552 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1553 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1554 ;; braces NOT being included in the resulting region. On no account may the
1555 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1556 ;; PAREN-STATE is a list of buffer positions in the style of
1557 ;; (c-parse-state), one of which will be that of the desired opening brace,
1558 ;; if there is one.
1559 ;;
1560 ;; Return the position of the enclosing opening brace, or nil
1574 orig-point-max)))
1575 encl-decl)
1577 nil)))
1581 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1582 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1583 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1584 ;; buffer's original restriction.
1585 ;;
1586 ;; This is a very special purpose macro, which assumes the existence of
1587 ;; several variables. It is for use only in c-beginning-of-defun and
1588 ;; c-end-of-defun.
1592 lim)
1595 paren-state orig-point-min orig-point-max))
1599 "Move backward to the beginning of a defun.
1600 Every top level declaration that contains a brace paren block is
1601 considered to be a defun.
1603 With a positive argument, move backward that many defuns. A negative
1604 argument -N means move forward to the Nth following beginning. Return
1605 t unless search stops due to beginning or end of buffer.
1607 Unlike the built-in `beginning-of-defun' this tries to be smarter
1608 about finding the char with open-parenthesis syntax that starts the
1609 defun."
1623 ; structure with other users of c-state-cache.
1625 lim ; Position of { which has been widened to.
1626 where pos case-fold-search)
1631 paren-state orig-point-min orig-point-max)))
1633 ;; Move back out of any macro/comment/string we happen to be in.
1641 ;; Move forward to the closing brace of a function.
1648 ;; Move forward to the next opening brace....
1655 ;; ... and backward to the function header.
1657 t))
1659 ;; Move backward to the opening brace of a function, making successively
1660 ;; larger portions of the buffer visible as necessary.
1666 ;; Go backward to this function's header.
1670 ;; We're now there, modulo comments and whitespace.
1671 ;; Try to be line oriented; position point at the closest
1672 ;; preceding boi that isn't inside a comment, but if we hit
1673 ;; the previous declaration then we use the current point
1674 ;; instead.
1684 ;; Skip to the closing brace of the Nth function after point. If
1685 ;; point is inside a function, this counts as the first. Point must be
1686 ;; outside any comment/string or macro.
1687 ;;
1688 ;; N must be strictly positive.
1689 ;; WHERE describes the position of point, one of the symbols `at-header',
1690 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1691 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1692 ;;
1693 ;; If we run out of functions, leave point at EOB. Return zero on success,
1694 ;; otherwise the number of }s still to go.
1695 ;;
1696 ;; This function may do hidden buffer changes.
1699 ;; What we do to go forward over the first defun depends on where we
1700 ;; start. We go to the closing brace of that defun, even when we go
1701 ;; backwards to it (in a "struct foo {...} bar ;").
1717 ;; Each time round the loop, go forward to a "}" at the outermost level.
1719 ;(c-parse-state) ; This call speeds up the following one by a factor
1720 ; of ~6. Hmmm. 2006/4/5.
1725 n)
1728 "Move forward to the end of a top level declaration.
1729 With argument, do it that many times. Negative argument -N means move
1730 back to Nth preceding end. Returns t unless search stops due to
1731 beginning or end of buffer.
1733 An end of a defun occurs right after the close-parenthesis that matches
1734 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1747 ; structure with other users of c-state-cache.
1749 lim
1750 where pos case-fold-search)
1755 paren-state orig-point-min orig-point-max)))
1757 ;; Move back out of any macro/comment/string we happen to be in.
1765 ;; Move backwards to the } of a function
1777 ;; Move forward to the } of a function
1782 ;; Do we need to move forward from the brace to the semicolon?
1788 ;; We're there now, modulo comments and whitespace.
1789 ;; Try to be line oriented; position point after the next
1790 ;; newline that isn't inside a comment, but if we hit the
1791 ;; next declaration then we use the current point instead.
1805 "Return the name of the current defun, or NIL if there isn't one.
1807 with a brace block."
1811 where pos name-end case-fold-search)
1816 ;; Move back out of any macro/comment/string we happen to be in.
1823 ;; Move to the beginning of the current defun, if any, if we're not
1824 ;; already there.
1826 nil
1831 ;; Pick out the defun name, according to the type of defun.
1833 ;; struct, union, enum, or similar:
1845 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1846 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1862 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1863 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1866 ;; Objc selectors.
1878 ;; Normal function or initializer.
1890 ;; Return a cons of the beginning and end positions of the current
1891 ;; top level declaration or macro. If point is not inside any then
1892 ;; nil is returned, unless NEAR is non-nil in which case the closest
1893 ;; following one is chosen instead (if there is any). The end
1894 ;; position is at the next line, providing there is one before the
1895 ;; declaration.
1896 ;;
1897 ;; This function might do hidden buffer changes.
1905 ;; Note: Some code duplication in `c-beginning-of-defun' and
1906 ;; `c-end-of-defun'.
1910 lim pos end-pos)
1913 ;; If we moved to the outermost enclosing paren
1914 ;; then we can use c-safe-position to set the
1915 ;; limit. Can't do that otherwise since the
1916 ;; earlier paren pair on paren-state might very
1917 ;; well be part of the declaration we should go
1918 ;; to.
1920 t)
1921 ;; At top level. Make sure we aren't inside a literal.
1937 ;; We moved back over the previous defun. Skip to the next
1938 ;; one. Not using c-forward-syntactic-ws here since we
1939 ;; should not skip a macro. We can also be directly after
1940 ;; the block in a `c-opt-block-decls-with-vars-key'
1941 ;; declaration, but then we won't move significantly far
1942 ;; here.
1956 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1957 ;; declaration that doesn't end there. We're searching back and
1958 ;; forth over the block here, which can be expensive.
1970 nil
1974 nil
1976 ;; Try to be line oriented; position the limits at the
1977 ;; closest preceding boi, and after the next newline, that
1978 ;; isn't inside a comment, but if we hit a neighboring
1979 ;; declaration then we instead use the exact declaration
1980 ;; limit in that direction.
1986 pos
2002 pos))))))))
2010 "Put mark at end of the current top-level declaration or macro, point at beginning.
2011 If point is not inside any then the closest following one is
2012 chosen. Each successive call of this command extends the marked
2013 region by one function.
2015 A mark is left where the command started, unless the region is already active
2016 \(in Transient Mark mode).
2019 function does not require the declaration to contain a brace block."
2024 ;; We try to be line oriented, unless there are several
2025 ;; declarations on the same line.
2052 "Return the name of the current CPP macro, or NIL if we're not in one."
2061 \f
2062 ;; Movement by statements.
2064 ;; Point is within a comment. Is it also within a comment-prefix?
2065 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2066 ;;
2067 ;; This function might do hidden buffer changes.
2077 ;; Narrow to the "inside" of the comment (block) defined by range, as
2078 ;; follows:
2079 ;;
2080 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2081 ;; present) removed. A c++-style line comment retains its opening "//" but
2082 ;; has any final NL removed. If POINT is currently outwith these innards,
2083 ;; move it to the appropriate boundary.
2084 ;;
2085 ;; This narrowing simplifies the sentence movement functions, since it
2086 ;; eliminates awkward things at the boundaries of the comment (block).
2087 ;;
2088 ;; This function might do hidden buffer changes.
2106 ;; Move backwards to the "beginning of a sentence" within the comment
2107 ;; defined by RANGE, a cons of its starting and ending positions. If we
2108 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2109 ;; of the comment and return T.
2110 ;;
2111 ;; The BOS is either text which follows a regexp match of sentence-end,
2112 ;; or text which is a beginning of "paragraph".
2113 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2114 ;;
2115 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2116 ;; It is not a general function, but is intended only for calling from
2117 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2118 ;;
2119 ;; This function might do hidden buffer changes.
2125 last
2131 ;; First, find the previous paragraph start, if any.
2135 ; paragraph-\(start\|separate\)
2144 ;; Now seek successively earlier sentence ends between PAR-BEG and
2145 ;; HERE, until the "start of sentence" following it is earlier than
2146 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2164 nil
2166 t))))
2169 ;; Move forward to the "end of a sentence" within the comment defined by
2170 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2171 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2172 ;; return NIL. Otherwise, move point to just after the end of the comment
2173 ;; and return T.
2174 ;;
2175 ;; The EOS is just after the non-WS part of the next match of the regexp
2176 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2177 ;; no sentence-end match following point, any WS before the end of the
2178 ;; comment will count as EOS, providing we're not already in it.
2179 ;;
2180 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2181 ;; It is not a general function, but is intended only for calling from
2182 ;; c-move-over-sentence.
2183 ;;
2184 ;; This function might do hidden buffer changes.
2187 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2188 )
2194 ;; The cc-mode values of paragraph-\(start\|separate\), set
2195 ;; in c-setup-paragraph-variables, are used in the
2196 ;; following.
2205 last
2208 ;; Go forward one "comment-prefix which looks like sentence-end"
2209 ;; each time round the following:
2220 ;; Take special action if we're up against the end of a comment (of
2221 ;; either sort): Leave point just after the last non-ws text.
2228 nil
2230 t))))
2233 ;; Move backwards to the "beginning of a sentence" within the string defined
2234 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2235 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2236 ;; just before the start of the string and return T.
2237 ;;
2238 ;; The BOS is either the text which follows a regexp match of sentence-end
2239 ;; or text which is a beginning of "paragraph". For the purposes of
2240 ;; determining paragraph boundaries, escaped newlines are treated as
2241 ;; ordinary newlines.
2242 ;;
2243 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2244 ;; It is not a general function, but is intended only for calling from
2245 ;; c-move-over-sentence.
2246 ;;
2247 ;; This function might do hidden buffer changes.
2253 ;; Enhance paragraph-start and paragraph-separate also to recognize
2254 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2255 ;; these values should be customizable user options, or something.
2264 ; paragraph-\(start\|separate\)
2272 ;; Now see if we can find a sentence end after PAR-BEG.
2280 ; than here, in case point starts
2281 ; beyond the closing quote.
2286 nil
2288 t))))
2291 ;; Move forward to the "end of a sentence" within the string defined by
2292 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2293 ;; return NIL. Otherwise, move point to just after the end of the string
2294 ;; and return T.
2295 ;;
2296 ;; The EOS is just after the non-WS part of the next match of the regexp
2297 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2298 ;; no sentence-end match following point, any WS before the end of the
2299 ;; string will count as EOS, providing we're not already in it.
2300 ;;
2301 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2302 ;; It is not a general function, but is intended only for calling from
2303 ;; c-move-over-sentence.
2304 ;;
2305 ;; This function might do hidden buffer changes.
2308 last
2309 ;; Enhance paragraph-start and paragraph-separate to recognize
2310 ;; blank lines terminated by escaped EOLs.
2318 ;; The above values of paragraph-\(start\|separate\) are used
2319 ;; in the following.
2322 ;; (re-search-backward filler-here nil t) would find an empty
2323 ;; string. Therefore we simulate it by the following:
2332 ;; Try to go forward a sentence.
2337 ;; Did we move a sentence, or did we hit the end of the string?
2339 nil
2341 t))))
2344 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2345 ;; If a literal is the next thing (aside from whitespace) to be found before
2346 ;; point, return a cons of its start.end positions (enclosing the
2347 ;; delimiters). Otherwise return NIL.
2348 ;;
2349 ;; This function might do hidden buffer changes.
2353 pos)
2357 ;; to prevent `looking-at' seeing a " at point.
2361 ;; An EOL can act as an "open string" terminator in AWK.
2372 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2373 ;; If a literal is the next thing (aside from whitespace) following point,
2374 ;; return a cons of its start.end positions (enclosing the delimiters).
2375 ;; Otherwise return NIL.
2376 ;;
2377 ;; This function might do hidden buffer changes.
2390 ;; Does point immediately follow a statement "terminator"? A virtual
2391 ;; semicolon is regarded here as such. So is an opening brace ;-)
2392 ;;
2393 ;; This function might do hidden buffer changes.
2401 ;; The following (for macros) is not strict about exactly where we are
2402 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2403 ;; much. ACM 2004/3/29.
2415 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2416 ;; stopping before reaching BOB or a literal or the boundary of a
2417 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2418 ;; the position of the '#' beginning the current preprocessor directive, or
2419 ;; NIL if we're not in such.
2420 ;;
2421 ;; Return a cons (A.B), where
2422 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2423 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2424 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2425 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2426 ;;
2427 ;; The total collection of returned values is as follows:
2428 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2429 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2430 ;; a BOS - the caller must check this.
2431 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2432 ;; moved and reached the opening # of the macro.
2433 ;; (t . macro-boundary): Every other circumstance in which we're at a
2434 ;; macro-boundary. We might be at a BOS.
2435 ;;
2436 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2437 ;; code before encountering the literal/BOB or macro-boundary.
2438 ;;
2439 ;; Note that this function moves within either preprocessor commands
2440 ;; (macros) or normal code, but will not cross a boundary between the two,
2441 ;; or between two distinct preprocessor commands.
2442 ;;
2443 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2444 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2445 ;; move into parens. Also stop before `#' when it's at boi on a line.
2446 ;;
2447 ;; This function might do hidden buffer changes.
2451 ; semicolon precedes it.
2456 ;; Stop at the token after a comment.
2461 ;; If we've gone back over a LF, we might have moved into or out of
2462 ;; a preprocessor line.
2470 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2475 ;; Have we found a virtual semicolon? If so, stop, unless the next
2476 ;; statement is where we started from.
2483 ;; Hit the beginning of the buffer/region?
2489 ;; Move back a character.
2492 ;; Stop at "{" (unless it's a PIKE special brace list.)
2501 ;; Have we reached the start of a macro? This always counts as
2502 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2503 ;; here. FIXME!!! ACM 2004/3/29)
2507 ;; Stop at token just after "}" or ";".
2509 ;; If we've gone back over ;, {, or }, we're done.
2518 ;; Stop at the token after a string.
2523 ;; Nothing special: go back word characters.
2525 ))))))
2528 ;; Move forwards over code, stopping before reaching EOB or a literal
2529 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2530 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2531 ;; terminates the current preprocessor directive, or NIL if we're not in
2532 ;; such.
2533 ;;
2534 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2535 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2536 ;; seems unavoidable. Depending on the context this function is called
2537 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2538 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2539 ;; semicolons, or anything else.
2540 ;;
2541 ;; Return a cons (A.B), where
2542 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2543 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2544 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2545 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2546 ;;
2547 ;; Point is left either after the end-of-statement, or at the last non-ws
2548 ;; code before encountering the literal, or the # of the preprocessor
2549 ;; statement, or at EOB [or just after last non-WS stuff??].
2550 ;;
2551 ;; As a clarification of "after the end-of-statement", if a comment or
2552 ;; whitespace follows a completed AWK statement, that statement is treated
2553 ;; as ending just after the last non-ws character before the comment.
2554 ;;
2555 ;; Note that this function moves within either preprocessor commands
2556 ;; (macros) or normal code, but not both within the same invocation.
2557 ;;
2558 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2559 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2560 ;; stop before `{' if at top level or inside braces, though. Move by
2561 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2562 ;; the boi.
2563 ;;
2564 ;; This function might do hidden buffer changes.
2566 last)
2571 ;; If we've moved forward to a virtual semicolon, we're done.
2578 ;; Gone past the end of a macro?
2583 ;; About to hit a comment?
2588 ;; End of buffer?
2594 ;; If we encounter a '{', stop just after the previous token.
2600 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2601 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2602 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2603 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2609 ;; End of a PIKE special brace list? If so, step over it and continue.
2618 ;; Have we got a '}' after having moved? If so, stop after the
2619 ;; previous token.
2625 ;; Stop if we encounter a preprocessor line. Continue if we
2626 ;; hit a naked #
2635 ;; Stop after a ';', '}', or "};"
2640 ;; Found a string (this subsumes AWK regexps)?
2651 )))))
2654 ;; Is the literal defined by RANGE a string contained in a single line?
2655 ;;
2656 ;; This function might do hidden buffer changes.
2664 "Go to the beginning of the innermost C statement.
2665 With prefix arg, go back N - 1 statements. If already at the
2666 beginning of a statement then go to the beginning of the closest
2667 preceding one, moving into nested blocks if necessary (use
2669 comment or multiline string, move by sentences instead of statements.
2671 When called from a program, this function takes 3 optional args: the
2672 repetition count, a buffer position limit which is the farthest back
2673 to search for the syntactic context, and a flag saying whether to do
2674 sentence motion in or near comments and multiline strings.
2676 Note that for use in programs, `c-beginning-of-statement-1' is
2677 usually better. It has much better defined semantics than this one,
2678 which is intended for interactive use, and might therefore change to
2681 nil t))
2686 last ; start point for going back ONE chunk. Updated each chunk movement.
2689 res ; result from sub-function call
2690 not-bos ; "not beginning-of-statement"
2691 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2693 ;; Go back one statement at each iteration of the following loop.
2696 ;; Go back one "chunk" each time round the following loop, stopping
2697 ;; when we reach a statement boundary, etc.
2701 ; statement boundary, non-NIL otherwise.
2704 nil)
2708 ;; Single line string or sentence-flag is null => skip the
2709 ;; entire literal.
2714 ;; N.B. The following is essentially testing for an AWK regexp
2715 ;; at BOS:
2716 ;; Was the previous non-ws thing an end of statement?
2723 ;; Comment inside a statement or a multi-line string.
2729 res)))
2731 ;; Non-literal code.
2738 ;; We're at a tentative BOS. The next form goes
2739 ;; back over WS looking for an end of previous
2740 ;; statement.
2746 ;; Are we about to move backwards into or out of a
2747 ;; preprocessor command? If so, locate its beginning.
2755 ;; Are we about to move backwards into a literal?
2758 not-bos))
2765 "Go to the end of the innermost C statement.
2766 With prefix arg, go forward N - 1 statements. Move forward to the end
2767 of the next statement if already at end, and move into nested blocks
2769 comment or multiline string, move by sentences instead of statements.
2771 When called from a program, this function takes 3 optional args: the
2772 repetition count, a buffer position limit which is the farthest back
2773 to search for the syntactic context, and a flag saying whether to do
2774 sentence motion in or near comments and multiline strings."
2776 nil t))
2786 res
2787 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2789 ;; Go back/forward one statement at each iteration of the following loop.
2794 ;; Go forward one "chunk" each time round the following loop, stopping
2795 ;; when we reach a statement boundary, etc.
2798 ; statement boundary, non-NIL otherwise.
2801 nil)
2805 ;; sentence-flag is null => skip the entire literal.
2806 ;; or a Single line string.
2811 ;; Is there a virtual semicolon here (e.g. for AWK)?
2814 ;; Comment or multi-line string.
2820 ;; If we've just come forward out of a literal, check for
2821 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2822 ;; some other language may do in the future)
2826 ;; Non-literal code.
2829 ;; Are we about to move forward into or out of a
2830 ;; preprocessor command?
2845 ;; Are we about to move forward into a literal?
2853 \f
2854 ;; set up electric character functions to work with pending-del,
2855 ;; (a.k.a. delsel) mode. All symbols get the t value except
2856 ;; the functions which delete, which gets 'supersede, and (from Emacs
2857 ;; 25) `c-electric-brace' and `c-electric-paren' get special handling
2858 ;; so as to work gracefully with `electric-pair-mode'.
2865 c-electric-slash
2866 c-electric-star
2867 c-electric-semi&comma
2868 c-electric-lt-gt
2869 c-electric-colon))
2874 'delete-selection-uses-region-p
2875 t))
2878 c-electric-paren))
2886 \f
2887 ;; Inserting/indenting comments
2889 ;; This function might do hidden buffer changes.
2902 ;; Do not pad with one space if we're at bol.
2903 value
2914 ;; Found comment to align with.
2916 ;; Do not pad with one space if we're at bol.
2917 0
2919 ;; Recurse to handle value as a new spec.
2923 "Used by `indent-for-comment' to create and indent comments.
2924 See `c-indent-comment-alist' for a description."
2952 case-fold-search)
2954 c-indent-comments-syntactically-p)
2956 ;; BOGOSITY ALERT: if we're looking at the eol, its
2957 ;; because indent-for-comment hasn't put the comment-start
2958 ;; in the buffer yet. this will screw up the syntactic
2959 ;; analysis so we kludge in the necessary info. Another
2960 ;; kludge is that if we're at the bol, then we really want
2961 ;; to ignore any anchoring as specified by
2962 ;; c-comment-only-line-offset since it doesn't apply here.
2967 c-comment-only-line-offset
2969 c-comment-only-line-offset))))
2974 \f
2975 ;; used by outline-minor-mode
2978 ;; in otherwise-hidden text.
2983 \f
2984 ;; Movement by CPP conditionals.
2986 "Move back to the containing preprocessor conditional, leaving mark behind.
2987 A prefix argument acts as a repeat count. With a negative argument,
2988 move forward to the end of the containing preprocessor conditional.
2991 function stops at them when going backward, but not when going
2992 forward."
3002 directives."
3010 "Move forward into the next preprocessor conditional, leaving mark behind.
3011 A prefix argument acts as a repeat count. With a negative argument,
3012 move backward into the previous preprocessor conditional.
3015 function stops at them when going forward, but not when going
3016 backward."
3026 directives."
3034 "Move back across a preprocessor conditional, leaving mark behind.
3035 A prefix argument acts as a repeat count. With a negative argument,
3036 move forward across a preprocessor conditional.
3038 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3039 and have the same meanings as in `c-scan-conditionals'. If you
3040 are calling c-forward-conditional from a program, you might want
3041 to call `c-scan-conditionals' directly instead."
3049 "Move forward across a preprocessor conditional, leaving mark behind.
3050 A prefix argument acts as a repeat count. With a negative argument,
3051 move backward across a preprocessor conditional.
3053 If there aren't enough conditionals after \(or before) point, an
3054 error is signaled.
3057 the nesting level isn't changed when tracking subconditionals.
3059 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3060 and have the same meanings as in `c-scan-conditionals'. If you
3061 are calling c-forward-conditional from a program, you might want
3062 to call `c-scan-conditionals' directly instead."
3069 "Scan forward across COUNT preprocessor conditionals.
3070 With a negative argument, scan backward across preprocessor
3071 conditionals. Return the end position. Point is not moved.
3073 If there aren't enough preprocessor conditionals, throw an error.
3076 the nesting level isn't changed when tracking subconditionals.
3078 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3079 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3080 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3081 counts as -1.
3084 are treated as conditional clause limits. Normally they are ignored."
3088 new case-fold-search)
3094 ;; subdepth is the depth in "uninteresting" subtrees,
3095 ;; i.e. those that takes us farther from the target
3096 ;; depth instead of closer.
3098 found)
3100 ;; Find the "next" significant line in the proper direction.
3102 ;; Rather than searching for a # sign that
3103 ;; comes at the beginning of a line aside from
3104 ;; whitespace, search first for a string
3105 ;; starting with # sign. Then verify what
3106 ;; precedes it. This is faster on account of
3107 ;; the fastmap feature of the regexp matcher.
3110 nil t))
3112 ;; Now verify it is really a preproc line.
3120 ;; When we're not in an "uninteresting"
3121 ;; subtree, we might want to act on "elif"
3122 ;; and "else" too.
3124 ;; Always move toward the target depth.
3129 ;; Ignore the change if it'd take us
3130 ;; into an "uninteresting" subtree.
3138 ;; If we are trying to move across, and we find an
3139 ;; end before we find a beginning, get an error.
3142 "No following conditional at this level"
3144 ;; When searching forward, start from next line so
3145 ;; that we don't find the same line again.
3147 ;; We found something if we've arrived at the
3148 ;; target depth.
3151 ;; else
3158 new))
3160 \f
3161 ;; commands to indent lines, regions, defuns, and expressions
3163 "Indent current line as C code, and/or insert some whitespace.
3165 If `c-tab-always-indent' is t, always just indent the current line.
3166 If nil, indent the current line only if point is at the left margin or
3167 in the line's indentation; otherwise insert some whitespace[*]. If
3168 other than nil or t, then some whitespace[*] is inserted only within
3169 literals (comments and strings), but the line is always reindented.
3171 If `c-syntactic-indentation' is t, indentation is done according to
3172 the syntactic context. A numeric argument, regardless of its value,
3173 means indent rigidly all the lines of the expression starting after
3174 point so that this line becomes properly indented. The relative
3175 indentation among the lines of the expression is preserved.
3177 If `c-syntactic-indentation' is nil, the line is just indented one
3178 step according to `c-basic-offset'. In this mode, a numeric argument
3179 indents a number of such steps, positive or negative, and an empty
3180 prefix argument is equivalent to -1.
3182 [*] The amount and kind of whitespace inserted is controlled by the
3183 variable `c-insert-tab-function', which is called to do the actual
3184 insertion of whitespace. Normally the function in this variable
3185 just inserts a tab character, or the equivalent number of spaces,
3186 depending on the variable `indent-tabs-mode'."
3195 -1
3203 ;; Realign the line continuation backslash if inside a macro.
3205 ))))
3207 ;; If c-syntactic-indentation and got arg, always indent this
3208 ;; line as C and shift remaining lines of expression the same
3209 ;; amount.
3213 beg end)
3218 shift-amt))
3230 ;; Else use c-tab-always-indent to determine behavior.
3232 ;; CASE 1: indent when at column zero or in line's indentation,
3233 ;; otherwise insert a tab
3240 ;; CASE 2: just indent the line
3243 ;; CASE 3: if in a literal, insert a tab, but always indent the
3244 ;; line
3249 )))))
3252 "Indent each line in the balanced expression following point syntactically.
3253 If optional SHUTUP-P is non-nil, no errors are signaled if no
3254 balanced expression is found."
3257 end)
3261 ;; Find the closest following open paren that
3262 ;; ends on another line.
3270 ;; sanity check
3286 "Indent the current top-level declaration or macro syntactically.
3287 In the macro case this also has the effect of realigning any line
3288 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3294 ;; We try to be line oriented, unless there are several
3295 ;; declarations on the same line.
3307 "Indent syntactically every line whose first char is between START
3308 and END inclusive. If the optional argument QUIET is non-nil then no
3309 syntactic errors are reported, even if `c-report-syntactic-errors' is
3310 non-nil."
3316 ;; Advance to first nonblank line.
3324 ;; shut up any echo msgs on indiv lines
3330 start))
3332 syntax)
3340 ;; update progress
3342 ;; skip empty lines
3345 ;; Get syntax and indent.
3351 ;; End of current multi-line macro?
3354 ;; Fixup macro backslashes.
3357 ;; New multi-line macro?
3369 c-parsing-error))))
3372 ;; Function version of the macro for use in places that aren't
3373 ;; compiled, e.g. in the menus.
3377 "Indent active region, current line, or block starting on this line.
3378 In Transient Mark mode, when the region is active, reindent the region.
3379 Otherwise, with a prefix argument, rigidly reindent the expression
3380 starting on the current line.
3381 Otherwise reindent just the current line."
3387 \f
3388 ;; for progress reporting
3393 ;; Be silent
3395 ;; Start the progress update messages. If this Emacs doesn't have
3396 ;; a built-in timer, just be dumb about it.
3399 ;; If progress has already been initialized, do nothing. otherwise
3400 ;; initialize the counter with a vector of:
3401 ;; [start end lastsec context]
3408 context))
3410 ))
3414 nil
3419 ;; should we update? currently, update happens every 2 seconds,
3420 ;; what's the right value?
3426 )))
3430 nil
3439 \f
3440 ;;; This page handles insertion and removal of backslashes for C macros.
3443 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3444 With no argument, inserts backslashes and aligns existing backslashes.
3445 With an argument, deletes the backslashes. The backslash alignment is
3446 done according to the settings in `c-backslash-column',
3447 `c-backslash-max-column' and `c-auto-align-backslashes'.
3449 This function does not modify blank lines at the start of the region.
3450 If the region ends at the start of a line and the macro doesn't
3451 continue below it, the backslash (if any) at the end of the previous
3452 line is deleted.
3454 You can put the region around an entire macro definition and use this
3455 command to conveniently insert and align the necessary backslashes."
3458 ;; Keep the backslash trimming functions from changing the
3459 ;; whitespace around point, since in this case it's only the
3460 ;; position of point that tells the indentation of the line.
3466 column longest-line-col bs-col-after-end)
3470 ;; Nothing to do if to is at bob, since we should back up
3471 ;; and there's no line to back up to.
3472 nil
3474 ;; Do not back up the to line if line-mode is set, to make
3475 ;; e.g. c-newline-and-indent consistent regardless whether
3476 ;; the (newline) call leaves point at bol or not.
3484 ;; Set bs-col-after-end to the column of any backslash
3485 ;; following the region, or nil if there is none.
3494 ;; Back up the to line if line-mode is set, since the line
3495 ;; after the newly inserted line break should not be
3496 ;; touched in c-newline-and-indent.
3499 ;; Set bs-col-after-end to non-nil in any case, since we
3500 ;; do not want to delete the backslash at the last line.
3505 ;; Compute the smallest column number past the ends of all
3506 ;; the lines.
3510 ;; Include one more line in the max column
3511 ;; calculation, since the to line will be backslashed
3512 ;; too.
3525 ;; Try to align with surrounding backslashes.
3534 ;; Both a preceding and a following backslash.
3535 ;; Choose the greatest of them.
3538 ;; No preceding backslash. Try to align with one
3539 ;; following the region. Disregard the backslash at the
3540 ;; to line since it's likely to be bogus (e.g. when
3541 ;; called from c-newline-and-indent).
3544 ;; Don't modify blank lines at start of region.
3549 ;; Don't try to align with surrounding backslashes if
3550 ;; any line is too long.
3553 ;; Impose minimum limit and tab width alignment only if
3554 ;; we can't align with surrounding backslashes.
3558 tab-width)
3559 tab-width)))
3561 longest-line-col)))
3562 ;; Always impose maximum limit.
3565 ;; Add backslashes on all lines if the macro continues
3566 ;; after the to line.
3570 ;; Add backslashes on all lines except the last, and
3571 ;; remove any on the last line.
3579 ;; The function above leaves point on the line
3580 ;; following endmark.
3605 ;; Avoid unnecessary changes of the buffer.
3607 ;; Don't realign backslashes in string literals
3608 ;; since that would change them.
3609 )
3635 ;; Make sure there are backslashes with at least one space in
3636 ;; front of them.
3671 point-pos))
3677 \f
3678 ;;; Line breaking and paragraph filling.
3684 ;; The filling code is based on a simple theory; leave the intricacies
3685 ;; of the text handling to the currently active mode for that
3686 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3687 ;; possible to make them work correctly wrt the comment and string
3688 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3689 ;; to it, there's quite a lot of special cases to handle which makes
3690 ;; the code anything but simple. The intention is that it will work
3691 ;; with any well-written text filling package that preserves a fill
3692 ;; prefix.
3693 ;;
3694 ;; We temporarily mask comment starters and enders as necessary for
3695 ;; the filling code to do its job on a seemingly normal text block.
3696 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3697 ;; preserve it correctly (especially important when filling C++ style
3698 ;; line comments). By default, we set up and use adaptive-fill-mode,
3699 ;; which is standard in all supported Emacs flavors.
3702 ;; Determine the appropriate comment fill prefix for a block or line
3703 ;; comment. Return a cons of the prefix string and the column where
3704 ;; it ends. If fill-prefix is set, it'll override. Note that this
3705 ;; function also uses the value of point in some heuristics.
3706 ;;
3707 ;; This function might do hidden buffer changes.
3711 c-current-comment-prefix
3714 prefix-regexp
3715 comment-start-skip))
3716 prefix-line comment-prefix res comment-text-end)
3721 ;; Ugly way of getting the column after the fill
3722 ;; prefix; it'd be nice with a current-column
3723 ;; that works on strings..
3733 ;; Set fallback for comment-prefix if none is found.
3739 ;; The current line is not the comment starter, so the
3740 ;; comment has more than one line, and it can therefore be
3741 ;; used to find the comment fill prefix.
3747 ;; The line after the comment starter is inside the
3748 ;; comment, so we can use it.
3751 ;; The comment is only one line. Take the comment prefix
3752 ;; from it and keep the indentation.
3761 ;; There is only whitespace before the comment
3762 ;; starter; take the prefix straight from this line.
3767 ;; There is code before the comment starter, so we
3768 ;; have to temporarily insert and indent a new line to
3769 ;; get the right space/tab mix in the indentation.
3771 tmp)
3787 ;; The prefix ends the line with no whitespace
3788 ;; after it. Default to a single space.
3790 )))))
3803 ;; The current line is not the comment starter and
3804 ;; contains more than just the ender, so it's good enough
3805 ;; to be used for the comment fill prefix.
3815 ;; The comment is either one line or the next line contains
3816 ;; just the comment ender. In this case we have no
3817 ;; information about a suitable comment prefix, so we resort
3818 ;; to c-block-comment-prefix.
3822 ;; The point was on the comment opener line, so we might want
3823 ;; to treat this as a not yet closed comment.
3827 ;; Above `prefix-regexp' matched a nonempty prefix on the
3828 ;; second line, so let's use it. Normally it should do
3829 ;; to set `prefix-line' and let the code below pick up
3830 ;; the whole prefix, but if there's no text after the
3831 ;; match then it will probably fall back to no prefix at
3832 ;; all if the comment isn't closed yet, so in that case
3833 ;; it's better to force use of the prefix matched now.
3838 ;; There's no nonempty prefix on the line after the
3839 ;; comment opener. If the line is empty, or if the
3840 ;; text on it has less or equal indentation than the
3841 ;; comment starter we assume it's an unclosed
3842 ;; comment starter, i.e. that
3843 ;; `c-block-comment-prefix' should be used.
3844 ;; Otherwise we assume it's a closed comment where
3845 ;; the prefix really is the empty string.
3846 ;; E.g. this is an unclosed comment:
3847 ;;
3848 ;; /*
3849 ;; foo
3850 ;;
3851 ;; But this is not:
3852 ;;
3853 ;; /*
3854 ;; foo
3855 ;; */
3856 ;;
3857 ;; (Looking for the presence of the comment closer
3858 ;; rarely works since it's probably the closer of
3859 ;; some comment further down when the comment
3860 ;; really is unclosed.)
3869 ;; Otherwise the line after the comment starter is good
3870 ;; enough to find the prefix in.
3874 ;; Haven't got the comment prefix on any real line that we
3875 ;; can take it from, so we have to temporarily insert
3876 ;; `comment-prefix' on a line and indent it to find the
3877 ;; correct column and the correct mix of tabs and spaces.
3886 comment-text-end))
3891 ;; If there's ws on the current line, we'll use it
3892 ;; instead of what's ending comment-prefix.
3897 comment-prefix))
3906 ;; We insert an extra non-whitespace character
3907 ;; before the line break and after comment-prefix in
3908 ;; case it's "" or ends with whitespace.
3927 ;; prefix-line is the bol of a line on which we should try
3928 ;; to find the prefix.
3935 ;; The match is fine if there's text after it.
3941 ;; This match is better than nothing, so let's
3942 ;; remember it in case nothing better is found
3943 ;; on another line.
3947 t))))
3950 ;; Search for a line which has text after the prefix
3951 ;; so that we get the proper amount of whitespace
3952 ;; after it. We start with the current line, then
3953 ;; search backwards, then forwards.
3958 ;; The whitespace is sucked up by the
3959 ;; first [ \t]* glob if the prefix is empty.
3962 ;; If the current line doesn't have text but do
3963 ;; have whitespace after the prefix, we'll use it.
3969 ;; For line comments we can search up to and
3970 ;; including the first line.
3974 ;; For block comments we must stop before the
3975 ;; block starter.
3986 nil)
3989 ;; A good line wasn't found, but at least we have a
3990 ;; fallback that matches the comment prefix regexp.
3995 ;; There are ws or text after the prefix, so
3996 ;; let's use it.
4000 ;; Check if there's any whitespace padding
4001 ;; on the comment start line that we can
4002 ;; use after the prefix.
4020 ;; Got to mess in the buffer once again to
4021 ;; ensure the column gets correct. :P
4032 ;; Last resort: Just add a single space after
4033 ;; the prefix.
4038 ;; The line doesn't match the comment prefix regexp.
4040 ;; We have a fallback for line comments that we must use.
4043 comment-prefix)
4047 ;; Assume we are dealing with a "free text" block
4048 ;; comment where the lines doesn't have any comment
4049 ;; prefix at all and we should just fill it as
4050 ;; normal text.
4052 ))
4055 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4056 ;; masked to allow adaptive filling to work correctly. That
4057 ;; includes narrowing the buffer and, if point is inside a comment,
4058 ;; masking the comment starter and ender appropriately.
4059 ;;
4060 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4061 ;; The position of point is then less significant when doing masking
4062 ;; and narrowing.
4063 ;;
4064 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4065 ;; only if the point turns out to be inside a comment or a string.
4066 ;;
4067 ;; Note that this function does not do any hidden buffer changes.
4070 ;; beg and end limit the region to narrow. end is a marker.
4071 beg end
4072 ;; tmp-pre and tmp-post mark strings that are temporarily
4073 ;; inserted at the start and end of the region. tmp-pre is a
4074 ;; cons of the positions of the prepended string. tmp-post is
4075 ;; a marker pointing to the single character of the appended
4076 ;; string.
4077 tmp-pre tmp-post
4078 ;; If hang-ender-stuck isn't nil, the comment ender is
4079 ;; hanging. In that case it's set to the number of spaces
4080 ;; that should be between the text and the ender.
4081 hang-ender-stuck
4082 ;; auto-fill-spaces is the exact sequence of whitespace between a
4083 ;; comment's last word and the comment ender, temporarily replaced
4084 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4085 auto-fill-spaces
4090 ;; Restore point on undo. It's necessary since we do a lot of
4091 ;; hidden inserts and deletes below that should be as transparent
4092 ;; as possible.
4096 ;; Determine the limits and type of the containing literal (if any):
4097 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4098 ;; BEG and END.
4101 ;; Widen to catch comment limits correctly.
4126 ;; For each of the possible types of text (string, C comment ...)
4127 ;; determine BEG and END, the region we will narrow to. If we're in
4128 ;; a literal, constrain BEG and END to the limits of this literal.
4129 ;;
4130 ;; For some of these text types, particularly a block comment, we
4131 ;; may need to massage whitespace near literal delimiters, so that
4132 ;; these don't get filled inappropriately.
4137 ;; Limit to the comment or paragraph end, whichever
4138 ;; comes first.
4142 ;; The region includes the comment starter, so we must
4143 ;; check it.
4147 ;; Include the first line in the region.
4149 ;; The first line contains code before the
4150 ;; comment. We must fake a line that doesn't.
4161 ;; disallow "/*/"
4163 ;; There is a comment ender, and the region includes it. If
4164 ;; it's on its own line, it stays on its own line. If it's got
4165 ;; company on the line, it keeps (at least one word of) it.
4166 ;; "=====*/" counts as a comment ender here, but "===== */"
4167 ;; doesn't and "foo*/" doesn't.
4172 ;; The following conjunct was added to avoid an
4173 ;; "Invalid search bound (wrong side of point)"
4174 ;; error in the subsequent re-search. Maybe
4175 ;; another fix would be needed (2007-12-08).
4176 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4177 ; 2010-10-17 Construct removed.
4178 ; (or (< (- (cdr c-lit-limits) 2) (point))
4186 ;; The comment ender IS on its own line. Exclude this
4187 ;; line from the filling.
4190 ;; The comment ender is hanging. Replace all space between it
4191 ;; and the last word either by one or two 'x's (when
4192 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4193 ;; as the whitespace (when auto filling), and include it in
4194 ;; the region. We'll change them back to whitespace
4195 ;; afterwards. The effect of this is to glue the comment
4196 ;; ender to the last word in the comment during filling.
4213 spaces)
4216 ;; Insert a CR after the "*/", adjust END
4224 c-current-comment-prefix
4227 ;; The comment ender is prefixed by nothing but a
4228 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4229 ;; 2006/4/28). Remove it along with surrounding ws.
4233 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4235 ;; What's being tested here? 2006/4/20. FIXME!!!
4239 ;; Don't adjust point below if it's
4240 ;; before the string we replace.
4242 ;; Keep one or two spaces between the
4243 ;; text and the ender, depending on how
4244 ;; many there are now.
4249 ;; paragraph filling condenses multiple spaces to
4250 ;; single or double spaces. auto-fill doesn't.
4256 sentence-end-double-space)
4259 ;; Insert the filler first to keep marks right.
4268 ;; Point was in the middle of the string we
4269 ;; replaced above, so put it back in the same
4270 ;; relative position, counting from the end.
4272 ))
4275 ;; The region includes the comment starter.
4279 ;; Begin with the next line.
4281 ;; Fake the fill prefix in the first line.
4296 ;; Leave the start line if it's
4297 ;; nothing but an escaped newline.
4303 ;; Narrow to the macro limits if they are nearer than the
4304 ;; paragraph limits. Don't know if this is necessary but
4305 ;; do it for completeness sake (doing auto filling at all
4306 ;; inside macros is bogus to begin with since the line
4307 ;; continuation backslashes aren't handled).
4320 ;; Try to avoid comments and macros in the paragraph to
4321 ;; avoid that the adaptive fill mode gets the prefix from
4322 ;; them.
4335 ;; Temporarily insert the fill prefix after the comment
4336 ;; starter so that the first line looks like any other
4337 ;; comment line in the narrowed region.
4341 c-current-comment-prefix
4344 ;; Oops, the prefix doesn't match the comment prefix
4345 ;; regexp. This could produce very confusing
4346 ;; results with adaptive fill packages together with
4347 ;; the insert prefix magic below, since the prefix
4348 ;; often doesn't appear at all. So let's warn about
4349 ;; it.
4351 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4353 ;; Find the right spot on the line, break it, insert
4354 ;; the fill prefix and make sure we're back in the
4355 ;; same column by temporarily prefixing the first word
4356 ;; with a number of 'x'.
4360 c-current-comment-prefix
4361 comment-start-skip))
4378 ;; `apply-outside-literal' is always set to t here if
4379 ;; we're inside a literal.
4383 ;; Kludge: If the function that adapts the fill prefix
4384 ;; doesn't produce the required comment starter for
4385 ;; line comments, then force it by setting fill-prefix.
4387 ;; Kludge the kludge: filladapt-mode doesn't
4388 ;; have this problem, but it currently
4389 ;; doesn't override fill-context-prefix
4390 ;; (version 2.12).
4392 filladapt-mode))
4399 c-lit-limits c-lit-type)))))))
4401 ;; Save the relative position of point if it's outside the
4402 ;; region we're going to narrow. Want to restore it in that
4403 ;; case, but otherwise it should be moved according to the
4404 ;; called function.
4408 ;; Preparations finally done! Now we can call the
4409 ;; actual function.
4415 ;; Restore point if it was outside the region.
4428 ;; Preserve point even if it's in the middle of the string
4429 ;; we replace; save-excursion doesn't work in that case.
4445 If any of the current line is a comment or within a comment, fill the
4446 comment or the paragraph of it that point is in, preserving the
4447 comment indentation or line-starting decorations (see the
4448 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4449 details).
4451 If point is inside multiline string literal, fill it. This currently
4452 does not respect escaped newlines, except for the special case when it
4453 is the very first thing in the string. The intended use for this rule
4454 is in situations like the following:
4457 A very long description of something that you want to fill to make
4460 If point is in any other situation, i.e. in normal code, do nothing.
4462 Optional prefix ARG means justify paragraph as well."
4465 ;; Avoid infinite recursion.
4467 fill-paragraph-function)))
4469 ;; Always return t. This has the effect that if filling isn't done
4470 ;; above, it isn't done at all, and it's therefore effectively
4471 ;; disabled in normal code.
4472 t)
4475 ;; Do automatic filling if not inside a context where it should be
4476 ;; ignored.
4478 ;; The decision whether the line should be broken is actually
4479 ;; done in c-indent-new-comment-line, which do-auto-fill
4480 ;; calls to break lines. We just set this special variable
4481 ;; so that we'll know when we're called from there. It's
4482 ;; also used to detect whether fill-prefix is user set or
4483 ;; generated automatically by do-auto-fill.
4484 fill-prefix))
4488 "Break line at point and indent, continuing comment or macro if within one.
4489 If inside a comment and `comment-multi-line' is non-nil, the
4490 indentation and line prefix are preserved (see the
4491 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4492 details). If inside a single line comment and `comment-multi-line' is
4493 nil, a new comment of the same type is started on the next line and
4494 indented as appropriate for comments. If inside a macro, a line
4495 continuation backslash is inserted and aligned as appropriate, and the
4496 new line is indented according to `c-syntactic-indentation'.
4498 If a fill prefix is specified, it overrides all the above."
4499 ;; allow-auto-fill is used from c-context-line-break to allow auto
4500 ;; filling to break the line more than once. Since this function is
4501 ;; used from auto-fill itself, that's normally disabled to avoid
4502 ;; unnecessary recursion.
4511 ;; Already know the literal type and limits when called from
4512 ;; c-context-line-break.
4519 ;; Called from do-auto-fill.
4527 c-ignore-auto-fill)
4532 ;; The adaptive fill function has generated a prefix, but
4533 ;; we're on the first line in a block comment so it'll be
4534 ;; wrong. Ignore it to guess a better one below.
4538 c-line-comment-starter)
4540 ;; Kludge: If the function that adapted the fill prefix
4541 ;; doesn't produce the required comment starter for line
4542 ;; comments, then we ignore it.
4544 )))
4547 ;; A call from do-auto-fill which should be ignored.
4548 )
4550 ;; A fill-prefix overrides anything.
4559 ;; Some sort of comment.
4565 ;; Inside a comment that should be continued.
4570 c-lit-type)))
4579 ;; Skip forward past the fill prefix in case
4580 ;; we're standing in it.
4581 ;;
4582 ;; FIXME: This doesn't work well in cases like
4583 ;;
4584 ;; /* Bla bla bla bla bla
4585 ;; bla bla
4586 ;;
4587 ;; If point is on the 'B' then the line will be
4588 ;; broken after "Bla b".
4589 ;;
4590 ;; If we have an empty comment, /* */, the next
4591 ;; lot of code pushes point to the */. We fix
4592 ;; this by never allowing point to end up to the
4593 ;; right of where it started.
4600 ;; The skip takes us out of the (block)
4601 ;; comment; insert the fill prefix at bol
4602 ;; instead and keep the position.
4609 ;; Don't break in the middle of a comment starter
4610 ;; or ender.
4619 ; middle of a TAB?
4620 ;; Inside a comment that should be broken.
4623 col)
4637 ;; c-comment-indent may look at the current
4638 ;; indentation, so let's start out with the same
4639 ;; indentation as the previous one.
4644 ;; In a macro.
4646 ;; Do not clobber the alignment of the line continuation
4647 ;; slash; c-backslash-region might look at it.
4649 ;; Got an asymmetry here: In normal code this command
4650 ;; doesn't indent the next line syntactically, and otoh a
4651 ;; normal syntactically indenting newline doesn't continue
4652 ;; the macro.
4655 ;; Somewhere else in the code.
4667 ;; advice for indent-new-comment-line for older Emacsen
4671 activate preactivate)
4672 "Call `c-indent-new-comment-line' if in CC Mode."
4675 ad-do-it
4680 "Do a line break suitable to the context.
4682 When point is outside a comment or macro, insert a newline and indent
4683 according to the syntactic context, unless `c-syntactic-indentation'
4684 is nil, in which case the new line is indented as the previous
4685 non-empty line instead.
4687 When point is inside the content of a preprocessor directive, a line
4688 continuation backslash is inserted before the line break and aligned
4689 appropriately. The end of the cpp directive doesn't count as inside
4690 it.
4692 When point is inside a comment, continue it with the appropriate
4693 comment prefix (see the `c-comment-prefix-regexp' and
4694 `c-block-comment-prefix' variables for details). The end of a
4695 C++-style line comment doesn't count as inside it.
4697 When point is inside a string, only insert a backslash when it is also
4698 inside a preprocessor directive."
4703 case-fold-search)
4720 ; it, not in a string, and not in the
4721 ; cpp keyword.
4743 ;; c-indent-line may look at the current indentation, so let's
4744 ;; start out with the same indentation as the previous line.
4755 "Insert a line break suitable to the context and leave point before it.
4756 This is the `c-context-line-break' equivalent to `open-line', which is
4757 normally bound to C-o. See `c-context-line-break' for the details."
4762 ;; Temporarily insert a non-whitespace char to keep any
4763 ;; preceding whitespace intact.
4769 \f
4772 ;; Local Variables:
4773 ;; indent-tabs-mode: t
4774 ;; tab-width: 8
4775 ;; End:
4776 ;;; cc-cmds.el ends here