| blob | 68075f356ab8a6c17de8433c5254b21152362ecc |
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.
1320 ;; "nomenclature" functions + c-scope-operator.
1322 "Compatibility alias for `c-forward-subword'."
1335 "Compatibility alias for `c-backward-subword'."
1344 'c-backward-into-nomenclature
1348 "Insert a double colon scope operator at point.
1353 \f
1354 ;; Movement (etc.) by defuns.
1356 ;; Return non-nil if point is between the closing brace and the semicolon of
1357 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1358 ;; portion of a declaration like "struct foo {...} bar ;".
1359 ;;
1360 ;; Return the position of the main declaration. Otherwise, return nil.
1361 ;; Point is assumed to be at the top level and outside of any macro or
1362 ;; literal.
1363 ;;
1364 ;; If LIM is non-nil, it is the bound on a the backward search for the
1365 ;; beginning of the declaration.
1366 ;;
1367 ;; This function might do hidden buffer changes.
1372 bod)
1376 ;; Look for struct or union or ... If we find one, it might
1377 ;; be the return type of a function, or the like. Exclude
1378 ;; this case.
1381 c-opt-block-decls-with-vars-key
1383 eo-block t t t)
1388 bod)))))
1391 ;; Determine where we are with respect to functions (or other brace
1392 ;; constructs, included in the term "function" in the rest of this comment).
1393 ;; Point is assumed to be outside any macro or literal.
1394 ;; This is used by c-\(beginning\|end\)-of-defun.
1395 ;;
1396 ;; Return one of these symbols:
1397 ;; at-header : we're at the start of a function's header.
1398 ;; in-header : we're inside a function's header, this extending right
1399 ;; up to the brace. This bit includes any k&r declarations.
1400 ;; in-block : we're inside a function's brace block.
1401 ;; in-trailer : we're in the area between the "}" and ";" of something
1402 ;; like "struct foo {...} bar, baz;".
1403 ;; at-function-end : we're just after the closing brace (or semicolon) that
1404 ;; terminates the function.
1405 ;; outwith-function: we're not at or in any function. Being inside a
1406 ;; non-brace construct also counts as 'outwith-function'.
1407 ;;
1408 ;; This function might do hidden buffer changes.
1411 decl-result brace-decl-p
1428 ;; Find the start of the current declaration. NOTE: If we're in the
1429 ;; variables after a "struct/eval" type block, we don't get to the
1430 ;; real declaration here - we detect and correct for this later.
1432 ;;If we're in the parameters' parens, move back out of them.
1434 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1435 ;; at a declaration.
1443 ;; NOTE: If we're in a K&R region, this might be the start
1444 ;; of a parameter declaration, not the actual function.
1445 ;; It might also leave us at a label or "label" like
1446 ;; "private:".
1450 ;; Has the declaration we've gone back to got braces?
1457 ;; Might have stopped on the
1458 ;; ';' in a K&R argdecl. In
1459 ;; that case the declaration
1460 ;; should contain a block.
1470 'at-header
1476 'at-function-end
1479 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1480 decl-result))))))))
1483 ;; Skip to the opening brace of the Nth function before point. If
1484 ;; point is inside a function, this counts as the first. Point must be
1485 ;; outside any comment/string or macro.
1486 ;;
1487 ;; N must be strictly positive.
1488 ;; WHERE describes the position of point, one of the symbols `at-header',
1489 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1490 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1491 ;;
1492 ;; If we run out of functions, leave point at BOB. Return zero on success,
1493 ;; otherwise the number of {s still to go.
1494 ;;
1495 ;; This function may do hidden buffer changes
1497 ;; What we do to go back the first defun depends on where we start.
1513 ;; Each time round the loop, go back to a "{" at the outermost level.
1516 ; by a factor of ~6. Hmmm. 2006/4/5.
1521 n)
1524 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1525 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1526 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1527 ;; otherwise include the braces. If the closing brace is missing,
1528 ;; (point-max) is used instead.
1530 encl-decl)
1549 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1550 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1551 ;; braces NOT being included in the resulting region. On no account may the
1552 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1553 ;; PAREN-STATE is a list of buffer positions in the style of
1554 ;; (c-parse-state), one of which will be that of the desired opening brace,
1555 ;; if there is one.
1556 ;;
1557 ;; Return the position of the enclosing opening brace, or nil
1571 orig-point-max)))
1572 encl-decl)
1574 nil)))
1578 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1579 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1580 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1581 ;; buffer's original restriction.
1582 ;;
1583 ;; This is a very special purpose macro, which assumes the existence of
1584 ;; several variables. It is for use only in c-beginning-of-defun and
1585 ;; c-end-of-defun.
1589 lim)
1592 paren-state orig-point-min orig-point-max))
1596 "Move backward to the beginning of a defun.
1597 Every top level declaration that contains a brace paren block is
1598 considered to be a defun.
1600 With a positive argument, move backward that many defuns. A negative
1601 argument -N means move forward to the Nth following beginning. Return
1602 t unless search stops due to beginning or end of buffer.
1604 Unlike the built-in `beginning-of-defun' this tries to be smarter
1605 about finding the char with open-parenthesis syntax that starts the
1606 defun."
1620 ; structure with other users of c-state-cache.
1622 lim ; Position of { which has been widened to.
1623 where pos case-fold-search)
1628 paren-state orig-point-min orig-point-max)))
1630 ;; Move back out of any macro/comment/string we happen to be in.
1638 ;; Move forward to the closing brace of a function.
1645 ;; Move forward to the next opening brace....
1652 ;; ... and backward to the function header.
1654 t))
1656 ;; Move backward to the opening brace of a function, making successively
1657 ;; larger portions of the buffer visible as necessary.
1663 ;; Go backward to this function's header.
1667 ;; We're now there, modulo comments and whitespace.
1668 ;; Try to be line oriented; position point at the closest
1669 ;; preceding boi that isn't inside a comment, but if we hit
1670 ;; the previous declaration then we use the current point
1671 ;; instead.
1681 ;; Skip to the closing brace of the Nth function after point. If
1682 ;; point is inside a function, this counts as the first. Point must be
1683 ;; outside any comment/string or macro.
1684 ;;
1685 ;; N must be strictly positive.
1686 ;; WHERE describes the position of point, one of the symbols `at-header',
1687 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1688 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1689 ;;
1690 ;; If we run out of functions, leave point at EOB. Return zero on success,
1691 ;; otherwise the number of }s still to go.
1692 ;;
1693 ;; This function may do hidden buffer changes.
1696 ;; What we do to go forward over the first defun depends on where we
1697 ;; start. We go to the closing brace of that defun, even when we go
1698 ;; backwards to it (in a "struct foo {...} bar ;").
1714 ;; Each time round the loop, go forward to a "}" at the outermost level.
1716 ;(c-parse-state) ; This call speeds up the following one by a factor
1717 ; of ~6. Hmmm. 2006/4/5.
1722 n)
1725 "Move forward to the end of a top level declaration.
1726 With argument, do it that many times. Negative argument -N means move
1727 back to Nth preceding end. Returns t unless search stops due to
1728 beginning or end of buffer.
1730 An end of a defun occurs right after the close-parenthesis that matches
1731 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1744 ; structure with other users of c-state-cache.
1746 lim
1747 where pos case-fold-search)
1752 paren-state orig-point-min orig-point-max)))
1754 ;; Move back out of any macro/comment/string we happen to be in.
1762 ;; Move backwards to the } of a function
1774 ;; Move forward to the } of a function
1779 ;; Do we need to move forward from the brace to the semicolon?
1785 ;; We're there now, modulo comments and whitespace.
1786 ;; Try to be line oriented; position point after the next
1787 ;; newline that isn't inside a comment, but if we hit the
1788 ;; next declaration then we use the current point instead.
1802 "Return the name of the current defun, or NIL if there isn't one.
1804 with a brace block."
1808 where pos name-end case-fold-search)
1813 ;; Move back out of any macro/comment/string we happen to be in.
1820 ;; Move to the beginning of the current defun, if any, if we're not
1821 ;; already there.
1823 nil
1828 ;; Pick out the defun name, according to the type of defun.
1830 ;; struct, union, enum, or similar:
1842 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1843 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1859 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1860 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1863 ;; Objc selectors.
1875 ;; Normal function or initializer.
1887 ;; Return a cons of the beginning and end positions of the current
1888 ;; top level declaration or macro. If point is not inside any then
1889 ;; nil is returned, unless NEAR is non-nil in which case the closest
1890 ;; following one is chosen instead (if there is any). The end
1891 ;; position is at the next line, providing there is one before the
1892 ;; declaration.
1893 ;;
1894 ;; This function might do hidden buffer changes.
1902 ;; Note: Some code duplication in `c-beginning-of-defun' and
1903 ;; `c-end-of-defun'.
1907 lim pos end-pos)
1910 ;; If we moved to the outermost enclosing paren
1911 ;; then we can use c-safe-position to set the
1912 ;; limit. Can't do that otherwise since the
1913 ;; earlier paren pair on paren-state might very
1914 ;; well be part of the declaration we should go
1915 ;; to.
1917 t)
1918 ;; At top level. Make sure we aren't inside a literal.
1934 ;; We moved back over the previous defun. Skip to the next
1935 ;; one. Not using c-forward-syntactic-ws here since we
1936 ;; should not skip a macro. We can also be directly after
1937 ;; the block in a `c-opt-block-decls-with-vars-key'
1938 ;; declaration, but then we won't move significantly far
1939 ;; here.
1953 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1954 ;; declaration that doesn't end there. We're searching back and
1955 ;; forth over the block here, which can be expensive.
1967 nil
1971 nil
1973 ;; Try to be line oriented; position the limits at the
1974 ;; closest preceding boi, and after the next newline, that
1975 ;; isn't inside a comment, but if we hit a neighboring
1976 ;; declaration then we instead use the exact declaration
1977 ;; limit in that direction.
1983 pos
1999 pos))))))))
2007 "Put mark at end of the current top-level declaration or macro, point at beginning.
2008 If point is not inside any then the closest following one is
2009 chosen. Each successive call of this command extends the marked
2010 region by one function.
2012 A mark is left where the command started, unless the region is already active
2013 \(in Transient Mark mode).
2016 function does not require the declaration to contain a brace block."
2021 ;; We try to be line oriented, unless there are several
2022 ;; declarations on the same line.
2049 "Return the name of the current CPP macro, or NIL if we're not in one."
2058 \f
2059 ;; Movement by statements.
2061 ;; Point is within a comment. Is it also within a comment-prefix?
2062 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2063 ;;
2064 ;; This function might do hidden buffer changes.
2074 ;; Narrow to the "inside" of the comment (block) defined by range, as
2075 ;; follows:
2076 ;;
2077 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2078 ;; present) removed. A c++-style line comment retains its opening "//" but
2079 ;; has any final NL removed. If POINT is currently outwith these innards,
2080 ;; move it to the appropriate boundary.
2081 ;;
2082 ;; This narrowing simplifies the sentence movement functions, since it
2083 ;; eliminates awkward things at the boundaries of the comment (block).
2084 ;;
2085 ;; This function might do hidden buffer changes.
2103 ;; Move backwards to the "beginning of a sentence" within the comment
2104 ;; defined by RANGE, a cons of its starting and ending positions. If we
2105 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2106 ;; of the comment and return T.
2107 ;;
2108 ;; The BOS is either text which follows a regexp match of sentence-end,
2109 ;; or text which is a beginning of "paragraph".
2110 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2111 ;;
2112 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2113 ;; It is not a general function, but is intended only for calling from
2114 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2115 ;;
2116 ;; This function might do hidden buffer changes.
2122 last
2128 ;; First, find the previous paragraph start, if any.
2132 ; paragraph-\(start\|separate\)
2141 ;; Now seek successively earlier sentence ends between PAR-BEG and
2142 ;; HERE, until the "start of sentence" following it is earlier than
2143 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2161 nil
2163 t))))
2166 ;; Move forward to the "end of a sentence" within the comment defined by
2167 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2168 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2169 ;; return NIL. Otherwise, move point to just after the end of the comment
2170 ;; and return T.
2171 ;;
2172 ;; The EOS is just after the non-WS part of the next match of the regexp
2173 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2174 ;; no sentence-end match following point, any WS before the end of the
2175 ;; comment will count as EOS, providing we're not already in it.
2176 ;;
2177 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2178 ;; It is not a general function, but is intended only for calling from
2179 ;; c-move-over-sentence.
2180 ;;
2181 ;; This function might do hidden buffer changes.
2184 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2185 )
2191 ;; The cc-mode values of paragraph-\(start\|separate\), set
2192 ;; in c-setup-paragraph-variables, are used in the
2193 ;; following.
2202 last
2205 ;; Go forward one "comment-prefix which looks like sentence-end"
2206 ;; each time round the following:
2217 ;; Take special action if we're up against the end of a comment (of
2218 ;; either sort): Leave point just after the last non-ws text.
2225 nil
2227 t))))
2230 ;; Move backwards to the "beginning of a sentence" within the string defined
2231 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2232 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2233 ;; just before the start of the string and return T.
2234 ;;
2235 ;; The BOS is either the text which follows a regexp match of sentence-end
2236 ;; or text which is a beginning of "paragraph". For the purposes of
2237 ;; determining paragraph boundaries, escaped newlines are treated as
2238 ;; ordinary newlines.
2239 ;;
2240 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2241 ;; It is not a general function, but is intended only for calling from
2242 ;; c-move-over-sentence.
2243 ;;
2244 ;; This function might do hidden buffer changes.
2250 ;; Enhance paragraph-start and paragraph-separate also to recognize
2251 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2252 ;; these values should be customizable user options, or something.
2261 ; paragraph-\(start\|separate\)
2269 ;; Now see if we can find a sentence end after PAR-BEG.
2277 ; than here, in case point starts
2278 ; beyond the closing quote.
2283 nil
2285 t))))
2288 ;; Move forward to the "end of a sentence" within the string defined by
2289 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2290 ;; return NIL. Otherwise, move point to just after the end of the string
2291 ;; and return T.
2292 ;;
2293 ;; The EOS is just after the non-WS part of the next match of the regexp
2294 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2295 ;; no sentence-end match following point, any WS before the end of the
2296 ;; string will count as EOS, providing we're not already in it.
2297 ;;
2298 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2299 ;; It is not a general function, but is intended only for calling from
2300 ;; c-move-over-sentence.
2301 ;;
2302 ;; This function might do hidden buffer changes.
2305 last
2306 ;; Enhance paragraph-start and paragraph-separate to recognize
2307 ;; blank lines terminated by escaped EOLs.
2315 ;; The above values of paragraph-\(start\|separate\) are used
2316 ;; in the following.
2319 ;; (re-search-backward filler-here nil t) would find an empty
2320 ;; string. Therefore we simulate it by the following:
2329 ;; Try to go forward a sentence.
2334 ;; Did we move a sentence, or did we hit the end of the string?
2336 nil
2338 t))))
2341 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2342 ;; If a literal is the next thing (aside from whitespace) to be found before
2343 ;; point, return a cons of its start.end positions (enclosing the
2344 ;; delimiters). Otherwise return NIL.
2345 ;;
2346 ;; This function might do hidden buffer changes.
2350 pos)
2354 ;; to prevent `looking-at' seeing a " at point.
2358 ;; An EOL can act as an "open string" terminator in AWK.
2369 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2370 ;; If a literal is the next thing (aside from whitespace) following point,
2371 ;; return a cons of its start.end positions (enclosing the delimiters).
2372 ;; Otherwise return NIL.
2373 ;;
2374 ;; This function might do hidden buffer changes.
2387 ;; Does point immediately follow a statement "terminator"? A virtual
2388 ;; semicolon is regarded here as such. So is an opening brace ;-)
2389 ;;
2390 ;; This function might do hidden buffer changes.
2398 ;; The following (for macros) is not strict about exactly where we are
2399 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2400 ;; much. ACM 2004/3/29.
2412 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2413 ;; stopping before reaching BOB or a literal or the boundary of a
2414 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2415 ;; the position of the '#' beginning the current preprocessor directive, or
2416 ;; NIL if we're not in such.
2417 ;;
2418 ;; Return a cons (A.B), where
2419 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2420 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2421 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2422 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2423 ;;
2424 ;; The total collection of returned values is as follows:
2425 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2426 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2427 ;; a BOS - the caller must check this.
2428 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2429 ;; moved and reached the opening # of the macro.
2430 ;; (t . macro-boundary): Every other circumstance in which we're at a
2431 ;; macro-boundary. We might be at a BOS.
2432 ;;
2433 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2434 ;; code before encountering the literal/BOB or macro-boundary.
2435 ;;
2436 ;; Note that this function moves within either preprocessor commands
2437 ;; (macros) or normal code, but will not cross a boundary between the two,
2438 ;; or between two distinct preprocessor commands.
2439 ;;
2440 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2441 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2442 ;; move into parens. Also stop before `#' when it's at boi on a line.
2443 ;;
2444 ;; This function might do hidden buffer changes.
2448 ; semicolon precedes it.
2453 ;; Stop at the token after a comment.
2458 ;; If we've gone back over a LF, we might have moved into or out of
2459 ;; a preprocessor line.
2467 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2472 ;; Have we found a virtual semicolon? If so, stop, unless the next
2473 ;; statement is where we started from.
2480 ;; Hit the beginning of the buffer/region?
2486 ;; Move back a character.
2489 ;; Stop at "{" (unless it's a PIKE special brace list.)
2498 ;; Have we reached the start of a macro? This always counts as
2499 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2500 ;; here. FIXME!!! ACM 2004/3/29)
2504 ;; Stop at token just after "}" or ";".
2506 ;; If we've gone back over ;, {, or }, we're done.
2515 ;; Stop at the token after a string.
2520 ;; Nothing special: go back word characters.
2522 ))))))
2525 ;; Move forwards over code, stopping before reaching EOB or a literal
2526 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2527 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2528 ;; terminates the current preprocessor directive, or NIL if we're not in
2529 ;; such.
2530 ;;
2531 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2532 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2533 ;; seems unavoidable. Depending on the context this function is called
2534 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2535 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2536 ;; semicolons, or anything else.
2537 ;;
2538 ;; Return a cons (A.B), where
2539 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2540 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2541 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2542 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2543 ;;
2544 ;; Point is left either after the end-of-statement, or at the last non-ws
2545 ;; code before encountering the literal, or the # of the preprocessor
2546 ;; statement, or at EOB [or just after last non-WS stuff??].
2547 ;;
2548 ;; As a clarification of "after the end-of-statement", if a comment or
2549 ;; whitespace follows a completed AWK statement, that statement is treated
2550 ;; as ending just after the last non-ws character before the comment.
2551 ;;
2552 ;; Note that this function moves within either preprocessor commands
2553 ;; (macros) or normal code, but not both within the same invocation.
2554 ;;
2555 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2556 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2557 ;; stop before `{' if at top level or inside braces, though. Move by
2558 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2559 ;; the boi.
2560 ;;
2561 ;; This function might do hidden buffer changes.
2563 last)
2568 ;; If we've moved forward to a virtual semicolon, we're done.
2575 ;; Gone past the end of a macro?
2580 ;; About to hit a comment?
2585 ;; End of buffer?
2591 ;; If we encounter a '{', stop just after the previous token.
2597 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2598 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2599 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2600 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2606 ;; End of a PIKE special brace list? If so, step over it and continue.
2615 ;; Have we got a '}' after having moved? If so, stop after the
2616 ;; previous token.
2622 ;; Stop if we encounter a preprocessor line. Continue if we
2623 ;; hit a naked #
2632 ;; Stop after a ';', '}', or "};"
2637 ;; Found a string (this subsumes AWK regexps)?
2648 )))))
2651 ;; Is the literal defined by RANGE a string contained in a single line?
2652 ;;
2653 ;; This function might do hidden buffer changes.
2661 "Go to the beginning of the innermost C statement.
2662 With prefix arg, go back N - 1 statements. If already at the
2663 beginning of a statement then go to the beginning of the closest
2664 preceding one, moving into nested blocks if necessary (use
2666 comment or multiline string, move by sentences instead of statements.
2668 When called from a program, this function takes 3 optional args: the
2669 repetition count, a buffer position limit which is the farthest back
2670 to search for the syntactic context, and a flag saying whether to do
2671 sentence motion in or near comments and multiline strings.
2673 Note that for use in programs, `c-beginning-of-statement-1' is
2674 usually better. It has much better defined semantics than this one,
2675 which is intended for interactive use, and might therefore change to
2678 nil t))
2683 last ; start point for going back ONE chunk. Updated each chunk movement.
2686 res ; result from sub-function call
2687 not-bos ; "not beginning-of-statement"
2688 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2690 ;; Go back one statement at each iteration of the following loop.
2693 ;; Go back one "chunk" each time round the following loop, stopping
2694 ;; when we reach a statement boundary, etc.
2698 ; statement boundary, non-NIL otherwise.
2701 nil)
2705 ;; Single line string or sentence-flag is null => skip the
2706 ;; entire literal.
2711 ;; N.B. The following is essentially testing for an AWK regexp
2712 ;; at BOS:
2713 ;; Was the previous non-ws thing an end of statement?
2720 ;; Comment inside a statement or a multi-line string.
2726 res)))
2728 ;; Non-literal code.
2735 ;; We're at a tentative BOS. The next form goes
2736 ;; back over WS looking for an end of previous
2737 ;; statement.
2743 ;; Are we about to move backwards into or out of a
2744 ;; preprocessor command? If so, locate its beginning.
2752 ;; Are we about to move backwards into a literal?
2755 not-bos))
2762 "Go to the end of the innermost C statement.
2763 With prefix arg, go forward N - 1 statements. Move forward to the end
2764 of the next statement if already at end, and move into nested blocks
2766 comment or multiline string, move by sentences instead of statements.
2768 When called from a program, this function takes 3 optional args: the
2769 repetition count, a buffer position limit which is the farthest back
2770 to search for the syntactic context, and a flag saying whether to do
2771 sentence motion in or near comments and multiline strings."
2773 nil t))
2783 res
2784 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2786 ;; Go back/forward one statement at each iteration of the following loop.
2791 ;; Go forward one "chunk" each time round the following loop, stopping
2792 ;; when we reach a statement boundary, etc.
2795 ; statement boundary, non-NIL otherwise.
2798 nil)
2802 ;; sentence-flag is null => skip the entire literal.
2803 ;; or a Single line string.
2808 ;; Is there a virtual semicolon here (e.g. for AWK)?
2811 ;; Comment or multi-line string.
2817 ;; If we've just come forward out of a literal, check for
2818 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2819 ;; some other language may do in the future)
2823 ;; Non-literal code.
2826 ;; Are we about to move forward into or out of a
2827 ;; preprocessor command?
2842 ;; Are we about to move forward into a literal?
2850 \f
2851 ;; set up electric character functions to work with pending-del,
2852 ;; (a.k.a. delsel) mode. All symbols get the t value except
2853 ;; the functions which delete, which gets 'supersede.
2860 c-electric-brace
2861 c-electric-slash
2862 c-electric-star
2863 c-electric-semi&comma
2864 c-electric-lt-gt
2865 c-electric-colon
2866 c-electric-paren))
2874 \f
2875 ;; Inserting/indenting comments
2877 ;; This function might do hidden buffer changes.
2890 ;; Do not pad with one space if we're at bol.
2891 value
2902 ;; Found comment to align with.
2904 ;; Do not pad with one space if we're at bol.
2905 0
2907 ;; Recurse to handle value as a new spec.
2911 "Used by `indent-for-comment' to create and indent comments.
2912 See `c-indent-comment-alist' for a description."
2940 case-fold-search)
2942 c-indent-comments-syntactically-p)
2944 ;; BOGOSITY ALERT: if we're looking at the eol, its
2945 ;; because indent-for-comment hasn't put the comment-start
2946 ;; in the buffer yet. this will screw up the syntactic
2947 ;; analysis so we kludge in the necessary info. Another
2948 ;; kludge is that if we're at the bol, then we really want
2949 ;; to ignore any anchoring as specified by
2950 ;; c-comment-only-line-offset since it doesn't apply here.
2955 c-comment-only-line-offset
2957 c-comment-only-line-offset))))
2962 \f
2963 ;; used by outline-minor-mode
2966 ;; in otherwise-hidden text.
2971 \f
2972 ;; Movement by CPP conditionals.
2974 "Move back to the containing preprocessor conditional, leaving mark behind.
2975 A prefix argument acts as a repeat count. With a negative argument,
2976 move forward to the end of the containing preprocessor conditional.
2979 function stops at them when going backward, but not when going
2980 forward."
2990 directives."
2998 "Move forward into the next preprocessor conditional, leaving mark behind.
2999 A prefix argument acts as a repeat count. With a negative argument,
3000 move backward into the previous preprocessor conditional.
3003 function stops at them when going forward, but not when going
3004 backward."
3014 directives."
3022 "Move back across a preprocessor conditional, leaving mark behind.
3023 A prefix argument acts as a repeat count. With a negative argument,
3024 move forward across a preprocessor conditional.
3026 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3027 and have the same meanings as in `c-scan-conditionals'. If you
3028 are calling c-forward-conditional from a program, you might want
3029 to call `c-scan-conditionals' directly instead."
3037 "Move forward across a preprocessor conditional, leaving mark behind.
3038 A prefix argument acts as a repeat count. With a negative argument,
3039 move backward across a preprocessor conditional.
3041 If there aren't enough conditionals after \(or before) point, an
3042 error is signaled.
3045 the nesting level isn't changed when tracking subconditionals.
3047 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3048 and have the same meanings as in `c-scan-conditionals'. If you
3049 are calling c-forward-conditional from a program, you might want
3050 to call `c-scan-conditionals' directly instead."
3057 "Scan forward across COUNT preprocessor conditionals.
3058 With a negative argument, scan backward across preprocessor
3059 conditionals. Return the end position. Point is not moved.
3061 If there aren't enough preprocessor conditionals, throw an error.
3064 the nesting level isn't changed when tracking subconditionals.
3066 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3067 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3068 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3069 counts as -1.
3072 are treated as conditional clause limits. Normally they are ignored."
3076 new case-fold-search)
3082 ;; subdepth is the depth in "uninteresting" subtrees,
3083 ;; i.e. those that takes us farther from the target
3084 ;; depth instead of closer.
3086 found)
3088 ;; Find the "next" significant line in the proper direction.
3090 ;; Rather than searching for a # sign that
3091 ;; comes at the beginning of a line aside from
3092 ;; whitespace, search first for a string
3093 ;; starting with # sign. Then verify what
3094 ;; precedes it. This is faster on account of
3095 ;; the fastmap feature of the regexp matcher.
3098 nil t))
3100 ;; Now verify it is really a preproc line.
3108 ;; When we're not in an "uninteresting"
3109 ;; subtree, we might want to act on "elif"
3110 ;; and "else" too.
3112 ;; Always move toward the target depth.
3117 ;; Ignore the change if it'd take us
3118 ;; into an "uninteresting" subtree.
3126 ;; If we are trying to move across, and we find an
3127 ;; end before we find a beginning, get an error.
3130 "No following conditional at this level"
3132 ;; When searching forward, start from next line so
3133 ;; that we don't find the same line again.
3135 ;; We found something if we've arrived at the
3136 ;; target depth.
3139 ;; else
3146 new))
3148 \f
3149 ;; commands to indent lines, regions, defuns, and expressions
3151 "Indent current line as C code, and/or insert some whitespace.
3153 If `c-tab-always-indent' is t, always just indent the current line.
3154 If nil, indent the current line only if point is at the left margin or
3155 in the line's indentation; otherwise insert some whitespace[*]. If
3156 other than nil or t, then some whitespace[*] is inserted only within
3157 literals (comments and strings), but the line is always reindented.
3159 If `c-syntactic-indentation' is t, indentation is done according to
3160 the syntactic context. A numeric argument, regardless of its value,
3161 means indent rigidly all the lines of the expression starting after
3162 point so that this line becomes properly indented. The relative
3163 indentation among the lines of the expression is preserved.
3165 If `c-syntactic-indentation' is nil, the line is just indented one
3166 step according to `c-basic-offset'. In this mode, a numeric argument
3167 indents a number of such steps, positive or negative, and an empty
3168 prefix argument is equivalent to -1.
3170 [*] The amount and kind of whitespace inserted is controlled by the
3171 variable `c-insert-tab-function', which is called to do the actual
3172 insertion of whitespace. Normally the function in this variable
3173 just inserts a tab character, or the equivalent number of spaces,
3174 depending on the variable `indent-tabs-mode'."
3183 -1
3191 ;; Realign the line continuation backslash if inside a macro.
3193 ))))
3195 ;; If c-syntactic-indentation and got arg, always indent this
3196 ;; line as C and shift remaining lines of expression the same
3197 ;; amount.
3201 beg end)
3206 shift-amt))
3218 ;; Else use c-tab-always-indent to determine behavior.
3220 ;; CASE 1: indent when at column zero or in line's indentation,
3221 ;; otherwise insert a tab
3228 ;; CASE 2: just indent the line
3231 ;; CASE 3: if in a literal, insert a tab, but always indent the
3232 ;; line
3237 )))))
3240 "Indent each line in the balanced expression following point syntactically.
3241 If optional SHUTUP-P is non-nil, no errors are signaled if no
3242 balanced expression is found."
3245 end)
3249 ;; Find the closest following open paren that
3250 ;; ends on another line.
3258 ;; sanity check
3274 "Indent the current top-level declaration or macro syntactically.
3275 In the macro case this also has the effect of realigning any line
3276 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3282 ;; We try to be line oriented, unless there are several
3283 ;; declarations on the same line.
3295 "Indent syntactically every line whose first char is between START
3296 and END inclusive. If the optional argument QUIET is non-nil then no
3297 syntactic errors are reported, even if `c-report-syntactic-errors' is
3298 non-nil."
3304 ;; Advance to first nonblank line.
3312 ;; shut up any echo msgs on indiv lines
3318 start))
3320 syntax)
3328 ;; update progress
3330 ;; skip empty lines
3333 ;; Get syntax and indent.
3339 ;; End of current multi-line macro?
3342 ;; Fixup macro backslashes.
3345 ;; New multi-line macro?
3357 c-parsing-error))))
3360 ;; Function version of the macro for use in places that aren't
3361 ;; compiled, e.g. in the menus.
3365 "Indent active region, current line, or block starting on this line.
3366 In Transient Mark mode, when the region is active, reindent the region.
3367 Otherwise, with a prefix argument, rigidly reindent the expression
3368 starting on the current line.
3369 Otherwise reindent just the current line."
3375 \f
3376 ;; for progress reporting
3381 ;; Be silent
3383 ;; Start the progress update messages. If this Emacs doesn't have
3384 ;; a built-in timer, just be dumb about it.
3387 ;; If progress has already been initialized, do nothing. otherwise
3388 ;; initialize the counter with a vector of:
3389 ;; [start end lastsec context]
3396 context))
3398 ))
3402 nil
3407 ;; should we update? currently, update happens every 2 seconds,
3408 ;; what's the right value?
3414 )))
3418 nil
3427 \f
3428 ;;; This page handles insertion and removal of backslashes for C macros.
3431 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3432 With no argument, inserts backslashes and aligns existing backslashes.
3433 With an argument, deletes the backslashes. The backslash alignment is
3434 done according to the settings in `c-backslash-column',
3435 `c-backslash-max-column' and `c-auto-align-backslashes'.
3437 This function does not modify blank lines at the start of the region.
3438 If the region ends at the start of a line and the macro doesn't
3439 continue below it, the backslash (if any) at the end of the previous
3440 line is deleted.
3442 You can put the region around an entire macro definition and use this
3443 command to conveniently insert and align the necessary backslashes."
3446 ;; Keep the backslash trimming functions from changing the
3447 ;; whitespace around point, since in this case it's only the
3448 ;; position of point that tells the indentation of the line.
3454 column longest-line-col bs-col-after-end)
3458 ;; Nothing to do if to is at bob, since we should back up
3459 ;; and there's no line to back up to.
3460 nil
3462 ;; Do not back up the to line if line-mode is set, to make
3463 ;; e.g. c-newline-and-indent consistent regardless whether
3464 ;; the (newline) call leaves point at bol or not.
3472 ;; Set bs-col-after-end to the column of any backslash
3473 ;; following the region, or nil if there is none.
3482 ;; Back up the to line if line-mode is set, since the line
3483 ;; after the newly inserted line break should not be
3484 ;; touched in c-newline-and-indent.
3487 ;; Set bs-col-after-end to non-nil in any case, since we
3488 ;; do not want to delete the backslash at the last line.
3493 ;; Compute the smallest column number past the ends of all
3494 ;; the lines.
3498 ;; Include one more line in the max column
3499 ;; calculation, since the to line will be backslashed
3500 ;; too.
3513 ;; Try to align with surrounding backslashes.
3522 ;; Both a preceding and a following backslash.
3523 ;; Choose the greatest of them.
3526 ;; No preceding backslash. Try to align with one
3527 ;; following the region. Disregard the backslash at the
3528 ;; to line since it's likely to be bogus (e.g. when
3529 ;; called from c-newline-and-indent).
3532 ;; Don't modify blank lines at start of region.
3537 ;; Don't try to align with surrounding backslashes if
3538 ;; any line is too long.
3541 ;; Impose minimum limit and tab width alignment only if
3542 ;; we can't align with surrounding backslashes.
3546 tab-width)
3547 tab-width)))
3549 longest-line-col)))
3550 ;; Always impose maximum limit.
3553 ;; Add backslashes on all lines if the macro continues
3554 ;; after the to line.
3558 ;; Add backslashes on all lines except the last, and
3559 ;; remove any on the last line.
3567 ;; The function above leaves point on the line
3568 ;; following endmark.
3593 ;; Avoid unnecessary changes of the buffer.
3595 ;; Don't realign backslashes in string literals
3596 ;; since that would change them.
3597 )
3623 ;; Make sure there are backslashes with at least one space in
3624 ;; front of them.
3659 point-pos))
3665 \f
3666 ;;; Line breaking and paragraph filling.
3672 ;; The filling code is based on a simple theory; leave the intricacies
3673 ;; of the text handling to the currently active mode for that
3674 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3675 ;; possible to make them work correctly wrt the comment and string
3676 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3677 ;; to it, there's quite a lot of special cases to handle which makes
3678 ;; the code anything but simple. The intention is that it will work
3679 ;; with any well-written text filling package that preserves a fill
3680 ;; prefix.
3681 ;;
3682 ;; We temporarily mask comment starters and enders as necessary for
3683 ;; the filling code to do its job on a seemingly normal text block.
3684 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3685 ;; preserve it correctly (especially important when filling C++ style
3686 ;; line comments). By default, we set up and use adaptive-fill-mode,
3687 ;; which is standard in all supported Emacs flavors.
3690 ;; Determine the appropriate comment fill prefix for a block or line
3691 ;; comment. Return a cons of the prefix string and the column where
3692 ;; it ends. If fill-prefix is set, it'll override. Note that this
3693 ;; function also uses the value of point in some heuristics.
3694 ;;
3695 ;; This function might do hidden buffer changes.
3699 c-current-comment-prefix
3702 prefix-regexp
3703 comment-start-skip))
3704 prefix-line comment-prefix res comment-text-end)
3709 ;; Ugly way of getting the column after the fill
3710 ;; prefix; it'd be nice with a current-column
3711 ;; that works on strings..
3721 ;; Set fallback for comment-prefix if none is found.
3727 ;; The current line is not the comment starter, so the
3728 ;; comment has more than one line, and it can therefore be
3729 ;; used to find the comment fill prefix.
3735 ;; The line after the comment starter is inside the
3736 ;; comment, so we can use it.
3739 ;; The comment is only one line. Take the comment prefix
3740 ;; from it and keep the indentation.
3749 ;; There is only whitespace before the comment
3750 ;; starter; take the prefix straight from this line.
3755 ;; There is code before the comment starter, so we
3756 ;; have to temporarily insert and indent a new line to
3757 ;; get the right space/tab mix in the indentation.
3759 tmp)
3775 ;; The prefix ends the line with no whitespace
3776 ;; after it. Default to a single space.
3778 )))))
3791 ;; The current line is not the comment starter and
3792 ;; contains more than just the ender, so it's good enough
3793 ;; to be used for the comment fill prefix.
3803 ;; The comment is either one line or the next line contains
3804 ;; just the comment ender. In this case we have no
3805 ;; information about a suitable comment prefix, so we resort
3806 ;; to c-block-comment-prefix.
3810 ;; The point was on the comment opener line, so we might want
3811 ;; to treat this as a not yet closed comment.
3815 ;; Above `prefix-regexp' matched a nonempty prefix on the
3816 ;; second line, so let's use it. Normally it should do
3817 ;; to set `prefix-line' and let the code below pick up
3818 ;; the whole prefix, but if there's no text after the
3819 ;; match then it will probably fall back to no prefix at
3820 ;; all if the comment isn't closed yet, so in that case
3821 ;; it's better to force use of the prefix matched now.
3826 ;; There's no nonempty prefix on the line after the
3827 ;; comment opener. If the line is empty, or if the
3828 ;; text on it has less or equal indentation than the
3829 ;; comment starter we assume it's an unclosed
3830 ;; comment starter, i.e. that
3831 ;; `c-block-comment-prefix' should be used.
3832 ;; Otherwise we assume it's a closed comment where
3833 ;; the prefix really is the empty string.
3834 ;; E.g. this is an unclosed comment:
3835 ;;
3836 ;; /*
3837 ;; foo
3838 ;;
3839 ;; But this is not:
3840 ;;
3841 ;; /*
3842 ;; foo
3843 ;; */
3844 ;;
3845 ;; (Looking for the presence of the comment closer
3846 ;; rarely works since it's probably the closer of
3847 ;; some comment further down when the comment
3848 ;; really is unclosed.)
3857 ;; Otherwise the line after the comment starter is good
3858 ;; enough to find the prefix in.
3862 ;; Haven't got the comment prefix on any real line that we
3863 ;; can take it from, so we have to temporarily insert
3864 ;; `comment-prefix' on a line and indent it to find the
3865 ;; correct column and the correct mix of tabs and spaces.
3874 comment-text-end))
3879 ;; If there's ws on the current line, we'll use it
3880 ;; instead of what's ending comment-prefix.
3885 comment-prefix))
3894 ;; We insert an extra non-whitespace character
3895 ;; before the line break and after comment-prefix in
3896 ;; case it's "" or ends with whitespace.
3915 ;; prefix-line is the bol of a line on which we should try
3916 ;; to find the prefix.
3923 ;; The match is fine if there's text after it.
3929 ;; This match is better than nothing, so let's
3930 ;; remember it in case nothing better is found
3931 ;; on another line.
3935 t))))
3938 ;; Search for a line which has text after the prefix
3939 ;; so that we get the proper amount of whitespace
3940 ;; after it. We start with the current line, then
3941 ;; search backwards, then forwards.
3946 ;; The whitespace is sucked up by the
3947 ;; first [ \t]* glob if the prefix is empty.
3950 ;; If the current line doesn't have text but do
3951 ;; have whitespace after the prefix, we'll use it.
3957 ;; For line comments we can search up to and
3958 ;; including the first line.
3962 ;; For block comments we must stop before the
3963 ;; block starter.
3974 nil)
3977 ;; A good line wasn't found, but at least we have a
3978 ;; fallback that matches the comment prefix regexp.
3983 ;; There are ws or text after the prefix, so
3984 ;; let's use it.
3988 ;; Check if there's any whitespace padding
3989 ;; on the comment start line that we can
3990 ;; use after the prefix.
4008 ;; Got to mess in the buffer once again to
4009 ;; ensure the column gets correct. :P
4020 ;; Last resort: Just add a single space after
4021 ;; the prefix.
4026 ;; The line doesn't match the comment prefix regexp.
4028 ;; We have a fallback for line comments that we must use.
4031 comment-prefix)
4035 ;; Assume we are dealing with a "free text" block
4036 ;; comment where the lines doesn't have any comment
4037 ;; prefix at all and we should just fill it as
4038 ;; normal text.
4040 ))
4043 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4044 ;; masked to allow adaptive filling to work correctly. That
4045 ;; includes narrowing the buffer and, if point is inside a comment,
4046 ;; masking the comment starter and ender appropriately.
4047 ;;
4048 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4049 ;; The position of point is then less significant when doing masking
4050 ;; and narrowing.
4051 ;;
4052 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4053 ;; only if the point turns out to be inside a comment or a string.
4054 ;;
4055 ;; Note that this function does not do any hidden buffer changes.
4058 ;; beg and end limit the region to narrow. end is a marker.
4059 beg end
4060 ;; tmp-pre and tmp-post mark strings that are temporarily
4061 ;; inserted at the start and end of the region. tmp-pre is a
4062 ;; cons of the positions of the prepended string. tmp-post is
4063 ;; a marker pointing to the single character of the appended
4064 ;; string.
4065 tmp-pre tmp-post
4066 ;; If hang-ender-stuck isn't nil, the comment ender is
4067 ;; hanging. In that case it's set to the number of spaces
4068 ;; that should be between the text and the ender.
4069 hang-ender-stuck
4070 ;; auto-fill-spaces is the exact sequence of whitespace between a
4071 ;; comment's last word and the comment ender, temporarily replaced
4072 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4073 auto-fill-spaces
4078 ;; Restore point on undo. It's necessary since we do a lot of
4079 ;; hidden inserts and deletes below that should be as transparent
4080 ;; as possible.
4084 ;; Determine the limits and type of the containing literal (if any):
4085 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4086 ;; BEG and END.
4089 ;; Widen to catch comment limits correctly.
4114 ;; For each of the possible types of text (string, C comment ...)
4115 ;; determine BEG and END, the region we will narrow to. If we're in
4116 ;; a literal, constrain BEG and END to the limits of this literal.
4117 ;;
4118 ;; For some of these text types, particularly a block comment, we
4119 ;; may need to massage whitespace near literal delimiters, so that
4120 ;; these don't get filled inappropriately.
4125 ;; Limit to the comment or paragraph end, whichever
4126 ;; comes first.
4130 ;; The region includes the comment starter, so we must
4131 ;; check it.
4135 ;; Include the first line in the region.
4137 ;; The first line contains code before the
4138 ;; comment. We must fake a line that doesn't.
4149 ;; disallow "/*/"
4151 ;; There is a comment ender, and the region includes it. If
4152 ;; it's on its own line, it stays on its own line. If it's got
4153 ;; company on the line, it keeps (at least one word of) it.
4154 ;; "=====*/" counts as a comment ender here, but "===== */"
4155 ;; doesn't and "foo*/" doesn't.
4160 ;; The following conjunct was added to avoid an
4161 ;; "Invalid search bound (wrong side of point)"
4162 ;; error in the subsequent re-search. Maybe
4163 ;; another fix would be needed (2007-12-08).
4164 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4165 ; 2010-10-17 Construct removed.
4166 ; (or (< (- (cdr c-lit-limits) 2) (point))
4174 ;; The comment ender IS on its own line. Exclude this
4175 ;; line from the filling.
4178 ;; The comment ender is hanging. Replace all space between it
4179 ;; and the last word either by one or two 'x's (when
4180 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4181 ;; as the whitespace (when auto filling), and include it in
4182 ;; the region. We'll change them back to whitespace
4183 ;; afterwards. The effect of this is to glue the comment
4184 ;; ender to the last word in the comment during filling.
4201 spaces)
4204 ;; Insert a CR after the "*/", adjust END
4212 c-current-comment-prefix
4215 ;; The comment ender is prefixed by nothing but a
4216 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4217 ;; 2006/4/28). Remove it along with surrounding ws.
4221 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4223 ;; What's being tested here? 2006/4/20. FIXME!!!
4227 ;; Don't adjust point below if it's
4228 ;; before the string we replace.
4230 ;; Keep one or two spaces between the
4231 ;; text and the ender, depending on how
4232 ;; many there are now.
4237 ;; paragraph filling condenses multiple spaces to
4238 ;; single or double spaces. auto-fill doesn't.
4244 sentence-end-double-space)
4247 ;; Insert the filler first to keep marks right.
4256 ;; Point was in the middle of the string we
4257 ;; replaced above, so put it back in the same
4258 ;; relative position, counting from the end.
4260 ))
4263 ;; The region includes the comment starter.
4267 ;; Begin with the next line.
4269 ;; Fake the fill prefix in the first line.
4284 ;; Leave the start line if it's
4285 ;; nothing but an escaped newline.
4291 ;; Narrow to the macro limits if they are nearer than the
4292 ;; paragraph limits. Don't know if this is necessary but
4293 ;; do it for completeness sake (doing auto filling at all
4294 ;; inside macros is bogus to begin with since the line
4295 ;; continuation backslashes aren't handled).
4308 ;; Try to avoid comments and macros in the paragraph to
4309 ;; avoid that the adaptive fill mode gets the prefix from
4310 ;; them.
4323 ;; Temporarily insert the fill prefix after the comment
4324 ;; starter so that the first line looks like any other
4325 ;; comment line in the narrowed region.
4329 c-current-comment-prefix
4332 ;; Oops, the prefix doesn't match the comment prefix
4333 ;; regexp. This could produce very confusing
4334 ;; results with adaptive fill packages together with
4335 ;; the insert prefix magic below, since the prefix
4336 ;; often doesn't appear at all. So let's warn about
4337 ;; it.
4339 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4341 ;; Find the right spot on the line, break it, insert
4342 ;; the fill prefix and make sure we're back in the
4343 ;; same column by temporarily prefixing the first word
4344 ;; with a number of 'x'.
4348 c-current-comment-prefix
4349 comment-start-skip))
4366 ;; `apply-outside-literal' is always set to t here if
4367 ;; we're inside a literal.
4371 ;; Kludge: If the function that adapts the fill prefix
4372 ;; doesn't produce the required comment starter for
4373 ;; line comments, then force it by setting fill-prefix.
4375 ;; Kludge the kludge: filladapt-mode doesn't
4376 ;; have this problem, but it currently
4377 ;; doesn't override fill-context-prefix
4378 ;; (version 2.12).
4380 filladapt-mode))
4387 c-lit-limits c-lit-type)))))))
4389 ;; Save the relative position of point if it's outside the
4390 ;; region we're going to narrow. Want to restore it in that
4391 ;; case, but otherwise it should be moved according to the
4392 ;; called function.
4396 ;; Preparations finally done! Now we can call the
4397 ;; actual function.
4403 ;; Restore point if it was outside the region.
4416 ;; Preserve point even if it's in the middle of the string
4417 ;; we replace; save-excursion doesn't work in that case.
4433 If any of the current line is a comment or within a comment, fill the
4434 comment or the paragraph of it that point is in, preserving the
4435 comment indentation or line-starting decorations (see the
4436 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4437 details).
4439 If point is inside multiline string literal, fill it. This currently
4440 does not respect escaped newlines, except for the special case when it
4441 is the very first thing in the string. The intended use for this rule
4442 is in situations like the following:
4445 A very long description of something that you want to fill to make
4448 If point is in any other situation, i.e. in normal code, do nothing.
4450 Optional prefix ARG means justify paragraph as well."
4453 ;; Avoid infinite recursion.
4455 fill-paragraph-function)))
4457 ;; Always return t. This has the effect that if filling isn't done
4458 ;; above, it isn't done at all, and it's therefore effectively
4459 ;; disabled in normal code.
4460 t)
4463 ;; Do automatic filling if not inside a context where it should be
4464 ;; ignored.
4466 ;; The decision whether the line should be broken is actually
4467 ;; done in c-indent-new-comment-line, which do-auto-fill
4468 ;; calls to break lines. We just set this special variable
4469 ;; so that we'll know when we're called from there. It's
4470 ;; also used to detect whether fill-prefix is user set or
4471 ;; generated automatically by do-auto-fill.
4472 fill-prefix))
4476 "Break line at point and indent, continuing comment or macro if within one.
4477 If inside a comment and `comment-multi-line' is non-nil, the
4478 indentation and line prefix are preserved (see the
4479 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4480 details). If inside a single line comment and `comment-multi-line' is
4481 nil, a new comment of the same type is started on the next line and
4482 indented as appropriate for comments. If inside a macro, a line
4483 continuation backslash is inserted and aligned as appropriate, and the
4484 new line is indented according to `c-syntactic-indentation'.
4486 If a fill prefix is specified, it overrides all the above."
4487 ;; allow-auto-fill is used from c-context-line-break to allow auto
4488 ;; filling to break the line more than once. Since this function is
4489 ;; used from auto-fill itself, that's normally disabled to avoid
4490 ;; unnecessary recursion.
4499 ;; Already know the literal type and limits when called from
4500 ;; c-context-line-break.
4507 ;; Called from do-auto-fill.
4515 c-ignore-auto-fill)
4520 ;; The adaptive fill function has generated a prefix, but
4521 ;; we're on the first line in a block comment so it'll be
4522 ;; wrong. Ignore it to guess a better one below.
4526 c-line-comment-starter)
4528 ;; Kludge: If the function that adapted the fill prefix
4529 ;; doesn't produce the required comment starter for line
4530 ;; comments, then we ignore it.
4532 )))
4535 ;; A call from do-auto-fill which should be ignored.
4536 )
4538 ;; A fill-prefix overrides anything.
4547 ;; Some sort of comment.
4553 ;; Inside a comment that should be continued.
4558 c-lit-type)))
4567 ;; Skip forward past the fill prefix in case
4568 ;; we're standing in it.
4569 ;;
4570 ;; FIXME: This doesn't work well in cases like
4571 ;;
4572 ;; /* Bla bla bla bla bla
4573 ;; bla bla
4574 ;;
4575 ;; If point is on the 'B' then the line will be
4576 ;; broken after "Bla b".
4577 ;;
4578 ;; If we have an empty comment, /* */, the next
4579 ;; lot of code pushes point to the */. We fix
4580 ;; this by never allowing point to end up to the
4581 ;; right of where it started.
4588 ;; The skip takes us out of the (block)
4589 ;; comment; insert the fill prefix at bol
4590 ;; instead and keep the position.
4597 ;; Don't break in the middle of a comment starter
4598 ;; or ender.
4607 ; middle of a TAB?
4608 ;; Inside a comment that should be broken.
4611 col)
4625 ;; c-comment-indent may look at the current
4626 ;; indentation, so let's start out with the same
4627 ;; indentation as the previous one.
4632 ;; In a macro.
4634 ;; Do not clobber the alignment of the line continuation
4635 ;; slash; c-backslash-region might look at it.
4637 ;; Got an asymmetry here: In normal code this command
4638 ;; doesn't indent the next line syntactically, and otoh a
4639 ;; normal syntactically indenting newline doesn't continue
4640 ;; the macro.
4643 ;; Somewhere else in the code.
4655 ;; advice for indent-new-comment-line for older Emacsen
4659 activate preactivate)
4660 "Call `c-indent-new-comment-line' if in CC Mode."
4663 ad-do-it
4668 "Do a line break suitable to the context.
4670 When point is outside a comment or macro, insert a newline and indent
4671 according to the syntactic context, unless `c-syntactic-indentation'
4672 is nil, in which case the new line is indented as the previous
4673 non-empty line instead.
4675 When point is inside the content of a preprocessor directive, a line
4676 continuation backslash is inserted before the line break and aligned
4677 appropriately. The end of the cpp directive doesn't count as inside
4678 it.
4680 When point is inside a comment, continue it with the appropriate
4681 comment prefix (see the `c-comment-prefix-regexp' and
4682 `c-block-comment-prefix' variables for details). The end of a
4683 C++-style line comment doesn't count as inside it.
4685 When point is inside a string, only insert a backslash when it is also
4686 inside a preprocessor directive."
4691 case-fold-search)
4708 ; it, not in a string, and not in the
4709 ; cpp keyword.
4731 ;; c-indent-line may look at the current indentation, so let's
4732 ;; start out with the same indentation as the previous line.
4743 "Insert a line break suitable to the context and leave point before it.
4744 This is the `c-context-line-break' equivalent to `open-line', which is
4745 normally bound to C-o. See `c-context-line-break' for the details."
4750 ;; Temporarily insert a non-whitespace char to keep any
4751 ;; preceding whitespace intact.
4757 \f
4760 ;;; Local Variables:
4761 ;;; indent-tabs-mode: t
4762 ;;; tab-width: 8
4763 ;;; End:
4764 ;;; cc-cmds.el ends here