| blob | eec6873dc190580b2f80457208542e75aadfcbf4 |
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2012 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.
50 ; which looks at this.
51 \f
52 ;; Indentation / Display syntax functions
56 "Indent the current line according to the syntactic context,
57 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
58 syntactic information for the current line. Be silent about syntactic
59 errors if the optional argument QUIET is non-nil, even if
60 `c-report-syntactic-errors' is non-nil. Normally the position of
61 point is used to decide where the old indentation is on a lines that
62 is otherwise empty \(ignoring any line continuation backslash), but
63 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
64 indentation change \(in columns)."
70 bs-col
71 shift-amt)
76 ;; Don't use "\\s " - ^L doesn't count as WS
77 ;; here
81 ;; Delete all whitespace after point if there's only whitespace
82 ;; on the line, so that any code that does back-to-indentation
83 ;; or similar gets the current column in this case. If this
84 ;; removes a line continuation backslash it'll be restored
85 ;; at the end.
87 ;; Should try to keep the backslash alignment
88 ;; in this case.
100 c-syntactic-context))))
105 c-syntactic-context))
107 c-echo-syntactic-information-p
109 c-syntactic-context indent))
113 c-parsing-error)
114 c-parsing-error))
119 t
121 nil))))
130 ;; Realign the line continuation backslash.
132 shift-amt))
135 "Insert a newline and indent the new line.
136 This function fixes line continuation backslashes if inside a macro,
137 and takes care to set the indentation before calling
138 `indent-according-to-mode', so that lineup functions like
139 `c-lineup-dont-change' works better."
141 ;; TODO: Backslashes before eol in comments and literals aren't
142 ;; kept intact.
144 ;; Avoid calling c-backslash-region from c-indent-line if it's
145 ;; called during the newline call, which can happen due to
146 ;; c-electric-continued-statement, for example. We also don't
147 ;; want any backslash alignment from indent-according-to-mode.
149 has-backslash insert-backslash
150 start col)
160 has-backslash t)
167 ;; The backslash stayed on the previous line. Insert one
168 ;; before calling c-backslash-region, so that
169 ;; bs-col-after-end in it works better. Fixup the
170 ;; backslashes on the newly inserted line.
174 ;; The backslash moved to the new line, if there was any. Let
175 ;; c-backslash-region fix a backslash on the previous line,
176 ;; and the one that might be on the new line.
177 ;; c-auto-align-backslashes is intentionally ignored here;
178 ;; maybe the moved backslash should be left alone if it's set,
179 ;; but we fix both lines on the grounds that the old backslash
180 ;; has been moved anyway and is now in a different context.
183 ;; Reindent syntactically. The indentation done above is not
184 ;; wasted, since c-indent-line might look at the current
185 ;; indentation.
188 ;; We temporarily insert another line break, so that the
189 ;; lineup functions will see the line as empty. That makes
190 ;; e.g. c-lineup-cpp-define more intuitive since it then
191 ;; proceeds to the preceding line in this case.
202 ;; Must align the backslash again after reindentation. The
203 ;; c-backslash-region call above can't be optimized to ignore
204 ;; this line, since it then won't align correctly with the
205 ;; lines below if the first line in the macro is broken.
209 "Show syntactic information for current line.
210 With universal argument, inserts the analysis as a comment on that line."
214 ;; Use `c-syntactic-context' in the same way as
215 ;; `c-indent-line', to be consistent.
216 c-syntactic-context
229 ols))
233 ols)))
239 ))
243 "Insert a comment with the syntactic analysis on every line in the region."
253 \f
254 ;; Minor mode functions.
262 ;; subword might not be loaded.
265 "w"
267 ;; FIXME: Derived modes might want to use something else
268 ;; than a string for `mode-name'.
271 mode-name)))
272 ;; (setq c-submode-indicators
273 ;; (if (> (length fmt) 1)
274 ;; fmt))
278 bare-mode-name))
282 "Toggle syntactic indentation.
283 Optional numeric ARG, if supplied, turns on syntactic indentation when
284 positive, turns it off when negative, and just toggles it when zero or
285 left out.
287 When syntactic indentation is turned on (the default), the indentation
288 functions and the electric keys indent according to the syntactic
289 context keys, when applicable.
291 When it's turned off, the electric keys don't reindent, the indentation
292 functions indents every new line to the same level as the previous
294 specified by `c-basic-offset'. The indentation style has no effect in
295 this mode, nor any of the indentation associated variables,
296 e.g. `c-special-indent-hook'.
298 This command sets the variable `c-syntactic-indentation'."
305 "Toggle auto-newline feature.
306 Optional numeric ARG, if supplied, turns on auto-newline when
307 positive, turns it off when negative, and just toggles it when zero or
308 left out.
310 Turning on auto-newline automatically enables electric indentation.
313 mode line after the mode name) newlines are automatically inserted
314 after special characters such as brace, comma, semi-colon, and colon."
326 "Toggle hungry-delete-key feature.
327 Optional numeric ARG, if supplied, turns on hungry-delete when
328 positive, turns it off when negative, and just toggles it when zero or
329 left out.
332 the mode line after the mode name) the delete key gobbles all preceding
333 whitespace in one fell swoop."
340 "Toggle auto-newline and hungry-delete-key features.
341 Optional numeric ARG, if supplied, turns on auto-newline and
342 hungry-delete when positive, turns them off when negative, and just
343 toggles them when zero or left out.
345 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
353 "Toggle the electric indentation feature.
354 Optional numeric ARG, if supplied, turns on electric indentation when
355 positive, turns it off when negative, and just toggles it when zero or
356 left out."
362 \f
363 ;; Electric keys
366 "Delete the preceding character or whitespace.
368 line) then all preceding whitespace is consumed. If however a prefix
369 argument is supplied, or `c-hungry-delete-key' is nil, or point is
370 inside a literal then the function in the variable
371 `c-backspace-function' is called."
375 arg
381 "Delete the preceding character or all preceding whitespace
382 back to the previous non-whitespace character.
394 "Delete the following character or whitespace.
396 line) then all following whitespace is consumed. If however a prefix
397 argument is supplied, or `c-hungry-delete-key' is nil, or point is
398 inside a literal then the function in the variable `c-delete-function'
399 is called."
403 arg
409 "Delete the following character or all following whitespace
410 up to the next non-whitespace character.
419 ;; This function is only used in XEmacs.
421 "Deletes preceding or following character or whitespace.
422 This function either deletes forward as `c-electric-delete-forward' or
423 backward as `c-electric-backspace', depending on the configuration: If
424 the function `delete-forward-p' is defined and returns non-nil, it
425 deletes forward. Otherwise it deletes backward.
427 Note: This is the way in XEmacs to choose the correct action for the
428 \[delete] key, whichever key that means. Other flavors don't use this
429 function to control that."
436 ;; This function is only used in XEmacs.
438 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
439 The direction of deletion depends on the configuration: If the
440 function `delete-forward-p' is defined and returns non-nil, it deletes
441 forward using `c-hungry-delete-forward'. Otherwise it deletes
442 backward using `c-hungry-backspace'.
444 Note: This is the way in XEmacs to choose the correct action for the
445 \[delete] key, whichever key that means. Other flavors don't use this
446 function to control that."
455 If `c-electric-flag' is set, handle it specially according to the variable
456 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
457 inside a literal or a macro, nothing special happens."
471 ;; do nothing special
473 ;; place the pound character at the left edge
481 )))
484 ;; Return the syntactic context of the construct at point. (This is NOT
485 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
486 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
489 syntax)
491 ;; insert a newline to isolate the construct at point for syntactic
492 ;; analysis.
494 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
495 ;; the syntax. (There might already be an escaped NL there.)
511 ;; Turn on syntactic macro analysis to help with auto
512 ;; newlines only.
514 nil))
515 syntax))
518 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
519 ;; (not necessarily the same as the S.C. of the line it is on). Return
520 ;; NEWLINES, the list containing some combination of the symbols `before'
521 ;; and `after' saying where newlines should be inserted.
524 ;; This is the list of brace syntactic symbols that can hang.
525 ;; If any new ones are added to c-offsets-alist, they should be
526 ;; added here as well.
527 ;;
528 ;; The order of this list is important; if SYNTAX has several
529 ;; elements, the element that "wins" is the earliest in SYMS.
531 class-open class-close defun-open defun-close
532 inline-open inline-close
533 brace-list-open brace-list-close
534 brace-list-intro brace-entry-open
535 block-open block-close
536 substatement-open statement-case-open
537 extern-lang-open extern-lang-close
538 namespace-open namespace-close
539 module-open module-close
540 composition-open composition-close
541 inexpr-class-open inexpr-class-close
542 ;; `statement-cont' is here for the case with a brace
543 ;; list opener inside a statement. C.f. CASE B.2 in
544 ;; `c-guess-continued-construct'.
545 statement-cont))
546 ;; shut this up too
551 ;; Do not try to insert newlines around a special
552 ;; (Pike-style) brace list.
559 nil
560 ;; Seek the matching entry in c-hanging-braces-alist.
562 syms
563 ;; Substitute inexpr-class and class-open or
564 ;; class-close with inexpr-class-open or
565 ;; inexpr-class-close.
572 syntax)
573 c-hanging-braces-alist)
576 ;; If syntax is a function symbol, then call it using the
577 ;; defined semantics.
587 ;; Point is just after a newly inserted }. If the non-whitespace
588 ;; content of the braces is a single line of code, compact the whole
589 ;; construct to a single line, if this line isn't too long. The Right
590 ;; Thing is done with comments.
591 ;;
592 ;; Point will be left after the }, regardless of whether the clean-up is
593 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
597 mbeg1 mend1 mbeg4 mend4
598 eol-col cmnt-pos cmnt-col cmnt-gap)
603 ;; Avoid backtracking over a very large block. The one we
604 ;; deal with here can never be more than three lines.
635 ;; Necessary to put the closing brace before any line
636 ;; oriented comment to keep it syntactically significant.
637 ;; This isn't necessary for block comments, but the result
638 ;; looks nicer anyway.
654 ;; Can we trim space before comment to make the line fit?
660 t))))
664 "Insert a brace.
666 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
667 numeric ARG hasn't been supplied, the command performs several electric
668 actions:
671 the mode line) newlines are inserted before and after the brace as
672 directed by the settings in `c-hanging-braces-alist'.
674 \(b) Any auto-newlines are indented. The original line is also
675 reindented unless `c-syntactic-indentation' is nil.
677 \(c) If auto-newline is turned on, various newline cleanups based on the
678 settings of `c-cleanup-list' are done."
682 ;; We want to inhibit blinking the paren since this would be
683 ;; most disruptive. We'll blink it ourselves later on.
685 blink-paren-function case-fold-search)
691 ;; Insert the brace. Note that expand-abbrev might reindent
692 ;; the line here if there's a preceding "else" or something.
702 newlines
704 ; of the brace itself, of the line the brace ends up on.
716 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
720 ;; Only a plain newline for now - it's indented
721 ;; after the cleanups when the line has its final
722 ;; appearance.
727 ;; `syntax' is the syntactic context of the line which ends up
728 ;; with the brace on it.
731 ;; Do all appropriate clean ups
734 mbeg mend
735 )
737 ;; `}': clean up empty defun braces
742 syntax)
747 ;; make sure matching open brace isn't in a comment
753 ;; `}': compact to a one-liner defun?
762 ;; `{': clean up brace-else-brace and brace-elseif-brace
769 "else"
771 "{"
773 nil t))
785 ; (progn
786 ; (setq tmp (point))
790 "else"
792 "if"
796 ;(eq (match-end 0) tmp);
797 )
804 ;; Indent the line after the cleanups since it might
805 ;; very well indent differently due to them, e.g. if
806 ;; c-indent-one-line-block is used together with the
807 ;; one-liner-defun cleanup.
811 ;; does a newline go after the brace?
814 ))))
816 ;; blink the paren
819 old-blink-paren
826 "Insert a slash character.
828 If the slash is inserted immediately after the comment prefix in a c-style
829 comment, the comment might get closed by removing whitespace and possibly
832 Indent the line as a comment, if:
835 token and we are on a comment-only-line, or
838 comment.
840 If a numeric ARG is supplied, point is inside a literal, or
841 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
842 is inhibited."
845 indentp
846 ;; shut this up
849 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
850 ;; `c-syntactic-indentation' set.
857 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
868 c-syntactic-indentation
869 c-electric-flag
877 "Insert a star character.
878 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
879 the star is the second character of a C style comment starter on a
880 comment-only-line, indent the line as a comment. If a numeric ARG is
881 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
882 this indentation is inhibited."
886 ;; if we are in a literal, or if arg is given do not reindent the
887 ;; current line, unless this star introduces a comment-only line.
890 c-electric-flag
903 ))
906 "Insert a comma or semicolon.
908 If `c-electric-flag' is non-nil, point isn't inside a literal and a
909 numeric ARG hasn't been supplied, the command performs several electric
910 actions:
913 the mode line) a newline might be inserted. See the variable
914 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
916 \(b) Any auto-newlines are indented. The original line is also
917 reindented unless `c-syntactic-indentation' is nil.
919 \(c) If auto-newline is turned on, a comma following a brace list or a
920 semicolon following a defun might be cleaned up, depending on the
921 settings of `c-cleanup-list'."
925 ;; shut this up
935 ;; do all cleanups and newline insertions if c-auto-newline is on.
940 ;; clean ups: list-close-comma or defun-close-semi
953 ;; make sure matching open brace isn't in a comment
957 ;; reindent line
961 ;; check to see if a newline should be added
963 answer add-newline-p)
966 ;; only nil value means continue checking
970 ;; only 'stop specifically says do not add a newline
972 ))
975 )))))
978 "Insert a colon.
980 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
981 numeric ARG hasn't been supplied, the command performs several electric
982 actions:
985 the mode line) newlines are inserted before and after the colon based on
986 the settings in `c-hanging-colons-alist'.
988 \(b) Any auto-newlines are indented. The original line is also
989 reindented unless `c-syntactic-indentation' is nil.
991 \(c) If auto-newline is turned on, whitespace between two colons will be
993 `c-cleanup-list'."
998 newlines is-scope-op
999 ;; shut this up
1002 ;; Any electric action?
1004 ;; Unless we're at EOL, only re-indentation happens.
1009 ;; scope-operator clean-up?
1027 ;; indent the current line if it's done syntactically.
1029 ;; Cannot use the same syntax analysis as we find below,
1030 ;; since that's made with c-syntactic-indentation-in-macros
1031 ;; always set to t.
1034 ;; Calculate where, if anywhere, we want newlines.
1038 ;; Turn on syntactic macro analysis to help with auto newlines
1039 ;; only.
1042 ;; Translate substatement-label to label for this operation.
1047 ;; some language elements can only be determined by checking
1048 ;; the following line. Let's first look for ones that can be
1049 ;; found when looking on the line with the colon
1053 syntax c-hanging-colons-alist)
1060 c-hanging-colons-alist)))))
1061 ;; does a newline go before the colon? Watch out for already
1062 ;; non-hung colons. However, we don't unhang them because that
1063 ;; would be a cleanup (and anti-social).
1073 ;; does a newline go after the colon?
1077 ))))
1081 If the current language uses angle bracket parens (e.g. template
1082 arguments in C++), try to find out if the inserted character is a
1083 paren and give it paren syntax if appropriate.
1085 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1086 line will be reindented if the inserted character is a paren or if it
1087 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1088 numeric argument is supplied, or the point is inside a literal."
1092 final-pos close-paren-inserted found-delim case-fold-search)
1097 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1098 ;;;; property on the new < or > and its mate (if any) when they are template
1099 ;;;; parens. This is now done in an after-change function.
1101 ;; Indent the line if appropriate.
1105 ;; If a <, basically see if it's got "template" before it .....
1113 ;; ..... or is a C++ << operator.
1121 ;; It's a >. Either a C++ >> operator. ......
1128 ;; ...., or search back for a < which isn't already marked as an
1129 ;; opening template delimiter.
1132 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1133 ;; our position.
1156 blink-paren-function)
1157 ;; Note: Most paren blink functions, such as the standard
1158 ;; `blink-matching-open', currently doesn't handle paren chars
1159 ;; marked with text properties very well. Maybe we should avoid
1160 ;; this call for the time being?
1164 "Insert a parenthesis.
1166 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1167 line is reindented unless a numeric ARG is supplied, or the parenthesis
1168 is inserted inside a literal.
1170 Whitespace between a function name and the parenthesis may get added or
1171 removed; see the variable `c-cleanup-list'.
1173 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1174 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1177 ;; shut this up
1179 case-fold-search)
1184 ;; be most disruptive. We'll blink it ourselves
1185 ;; afterwards.
1187 blink-paren-function)
1191 ;; If we're at EOL, check for new-line clean-ups.
1195 ;; clean up brace-elseif-brace
1202 "else"
1204 "if"
1206 "("
1208 nil t)
1213 ;; clean up brace-catch-brace
1220 "catch"
1222 "("
1224 nil t)
1229 ;; Check for clean-ups at function calls. These two DON'T need
1230 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1231 ;; Point is currently just after the inserted paren.
1235 ;; space-before-funcall clean-up?
1243 ;; Don't add a space into #define FOO()....
1252 ;; compact-empty-funcall clean-up?
1266 old-blink-paren
1270 "Reindent the current line if appropriate.
1272 This function is used to reindent the line after a keyword which
1276 The line is reindented if there is nothing but whitespace before the
1277 keyword on the line, the keyword is not inserted inside a literal, and
1278 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1283 c-syntactic-indentation
1290 ;; Have to temporarily insert a space so that
1291 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1292 ;; space with a nonspace to avoid messing up any whitespace
1293 ;; sensitive meddling that might be done, e.g. by
1294 ;; `c-backslash-region'.
1300 \f
1305 ;; "nomenclature" functions + c-scope-operator.
1307 "Compatibility alias for `c-forward-subword'."
1314 "Compatibility alias for `c-backward-subword'."
1321 "Insert a double colon scope operator at point.
1326 \f
1327 ;; Movement (etc.) by defuns.
1329 ;; Return non-nil if point is between the closing brace and the semicolon of
1330 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1331 ;; portion of a declaration like "struct foo {...} bar ;".
1332 ;;
1333 ;; Return the position of the main declaration. Otherwise, return nil.
1334 ;; Point is assumed to be at the top level and outside of any macro or
1335 ;; literal.
1336 ;;
1337 ;; If LIM is non-nil, it is the bound on a the backward search for the
1338 ;; beginning of the declaration.
1339 ;;
1340 ;; This function might do hidden buffer changes.
1345 bod)
1349 ;; Look for struct or union or ... If we find one, it might
1350 ;; be the return type of a function, or the like. Exclude
1351 ;; this case.
1354 c-opt-block-decls-with-vars-key
1356 eo-block t t t)
1361 bod)))))
1364 ;; Determine where we are with respect to functions (or other brace
1365 ;; constructs, included in the term "function" in the rest of this comment).
1366 ;; Point is assumed to be outside any macro or literal.
1367 ;; This is used by c-\(beginning\|end\)-of-defun.
1368 ;;
1369 ;; Return one of these symbols:
1370 ;; at-header : we're at the start of a function's header.
1371 ;; in-header : we're inside a function's header, this extending right
1372 ;; up to the brace. This bit includes any k&r declarations.
1373 ;; in-block : we're inside a function's brace block.
1374 ;; in-trailer : we're in the area between the "}" and ";" of something
1375 ;; like "struct foo {...} bar, baz;".
1376 ;; at-function-end : we're just after the closing brace (or semicolon) that
1377 ;; terminates the function.
1378 ;; outwith-function: we're not at or in any function. Being inside a
1379 ;; non-brace construct also counts as 'outwith-function'.
1380 ;;
1381 ;; This function might do hidden buffer changes.
1384 decl-result brace-decl-p
1401 ;; Find the start of the current declaration. NOTE: If we're in the
1402 ;; variables after a "struct/eval" type block, we don't get to the
1403 ;; real declaration here - we detect and correct for this later.
1405 ;;If we're in the parameters' parens, move back out of them.
1407 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1408 ;; at a declaration.
1416 ;; NOTE: If we're in a K&R region, this might be the start
1417 ;; of a parameter declaration, not the actual function.
1421 ;; Has the declaration we've gone back to got braces?
1427 ;; Might have stopped on the
1428 ;; ';' in a K&R argdecl. In
1429 ;; that case the declaration
1430 ;; should contain a block.
1439 'at-header
1445 'at-function-end
1448 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1449 decl-result))))))))
1452 ;; Skip to the opening brace of the Nth function before point. If
1453 ;; point is inside a function, this counts as the first. Point must be
1454 ;; outside any comment/string or macro.
1455 ;;
1456 ;; N must be strictly positive.
1457 ;; WHERE describes the position of point, one of the symbols `at-header',
1458 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1459 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1460 ;;
1461 ;; If we run out of functions, leave point at BOB. Return zero on success,
1462 ;; otherwise the number of {s still to go.
1463 ;;
1464 ;; This function may do hidden buffer changes
1466 ;; What we do to go back the first defun depends on where we start.
1482 ;; Each time round the loop, go back to a "{" at the outermost level.
1485 ; by a factor of ~6. Hmmm. 2006/4/5.
1490 n)
1493 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1494 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1495 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1496 ;; otherwise include the braces. If the closing brace is missing,
1497 ;; (point-max) is used instead.
1499 encl-decl)
1518 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1519 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1520 ;; braces NOT being included in the resulting region. On no account may the
1521 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1522 ;; PAREN-STATE is a list of buffer positions in the style of
1523 ;; (c-parse-state), one of which will be that of the desired opening brace,
1524 ;; if there is one.
1525 ;;
1526 ;; Return the position of the enclosing opening brace, or nil
1540 orig-point-max)))
1541 encl-decl)
1543 nil)))
1547 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1548 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1549 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1550 ;; buffer's original restriction.
1551 ;;
1552 ;; This is a very special purpose macro, which assumes the existence of
1553 ;; several variables. It is for use only in c-beginning-of-defun and
1554 ;; c-end-of-defun.
1558 lim)
1561 paren-state orig-point-min orig-point-max))
1565 "Move backward to the beginning of a defun.
1566 Every top level declaration that contains a brace paren block is
1567 considered to be a defun.
1569 With a positive argument, move backward that many defuns. A negative
1570 argument -N means move forward to the Nth following beginning. Return
1571 t unless search stops due to beginning or end of buffer.
1573 Unlike the built-in `beginning-of-defun' this tries to be smarter
1574 about finding the char with open-parenthesis syntax that starts the
1575 defun."
1589 ; structure with other users of c-state-cache.
1591 lim ; Position of { which has been widened to.
1592 where pos case-fold-search)
1597 paren-state orig-point-min orig-point-max)))
1599 ;; Move back out of any macro/comment/string we happen to be in.
1607 ;; Move forward to the closing brace of a function.
1614 ;; Move forward to the next opening brace....
1621 ;; ... and backward to the function header.
1623 t))
1625 ;; Move backward to the opening brace of a function, making successively
1626 ;; larger portions of the buffer visible as necessary.
1632 ;; Go backward to this function's header.
1636 ;; We're now there, modulo comments and whitespace.
1637 ;; Try to be line oriented; position point at the closest
1638 ;; preceding boi that isn't inside a comment, but if we hit
1639 ;; the previous declaration then we use the current point
1640 ;; instead.
1650 ;; Skip to the closing brace of the Nth function after point. If
1651 ;; point is inside a function, this counts as the first. Point must be
1652 ;; outside any comment/string or macro.
1653 ;;
1654 ;; N must be strictly positive.
1655 ;; WHERE describes the position of point, one of the symbols `at-header',
1656 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1657 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1658 ;;
1659 ;; If we run out of functions, leave point at EOB. Return zero on success,
1660 ;; otherwise the number of }s still to go.
1661 ;;
1662 ;; This function may do hidden buffer changes.
1665 ;; What we do to go forward over the first defun depends on where we
1666 ;; start. We go to the closing brace of that defun, even when we go
1667 ;; backwards to it (in a "struct foo {...} bar ;").
1683 ;; Each time round the loop, go forward to a "}" at the outermost level.
1685 ;(c-parse-state) ; This call speeds up the following one by a factor
1686 ; of ~6. Hmmm. 2006/4/5.
1691 n)
1694 "Move forward to the end of a top level declaration.
1695 With argument, do it that many times. Negative argument -N means move
1696 back to Nth preceding end. Returns t unless search stops due to
1697 beginning or end of buffer.
1699 An end of a defun occurs right after the close-parenthesis that matches
1700 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1713 ; structure with other users of c-state-cache.
1715 lim
1716 where pos case-fold-search)
1721 paren-state orig-point-min orig-point-max)))
1723 ;; Move back out of any macro/comment/string we happen to be in.
1731 ;; Move backwards to the } of a function
1743 ;; Move forward to the } of a function
1748 ;; Do we need to move forward from the brace to the semicolon?
1754 ;; We're there now, modulo comments and whitespace.
1755 ;; Try to be line oriented; position point after the next
1756 ;; newline that isn't inside a comment, but if we hit the
1757 ;; next declaration then we use the current point instead.
1771 "Return the name of the current defun, or NIL if there isn't one.
1773 with a brace block."
1777 where pos name-end case-fold-search)
1782 ;; Move back out of any macro/comment/string we happen to be in.
1789 ;; Move to the beginning of the current defun, if any, if we're not
1790 ;; already there.
1792 nil
1797 ;; Pick out the defun name, according to the type of defun.
1799 ;; struct, union, enum, or similar:
1811 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1812 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1828 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1829 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1832 ;; Objc selectors.
1844 ;; Normal function or initializer.
1856 ;; Return a cons of the beginning and end positions of the current
1857 ;; top level declaration or macro. If point is not inside any then
1858 ;; nil is returned, unless NEAR is non-nil in which case the closest
1859 ;; following one is chosen instead (if there is any). The end
1860 ;; position is at the next line, providing there is one before the
1861 ;; declaration.
1862 ;;
1863 ;; This function might do hidden buffer changes.
1871 ;; Note: Some code duplication in `c-beginning-of-defun' and
1872 ;; `c-end-of-defun'.
1876 lim pos end-pos)
1879 ;; If we moved to the outermost enclosing paren
1880 ;; then we can use c-safe-position to set the
1881 ;; limit. Can't do that otherwise since the
1882 ;; earlier paren pair on paren-state might very
1883 ;; well be part of the declaration we should go
1884 ;; to.
1886 t)
1887 ;; At top level. Make sure we aren't inside a literal.
1903 ;; We moved back over the previous defun. Skip to the next
1904 ;; one. Not using c-forward-syntactic-ws here since we
1905 ;; should not skip a macro. We can also be directly after
1906 ;; the block in a `c-opt-block-decls-with-vars-key'
1907 ;; declaration, but then we won't move significantly far
1908 ;; here.
1922 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1923 ;; declaration that doesn't end there. We're searching back and
1924 ;; forth over the block here, which can be expensive.
1936 nil
1940 nil
1942 ;; Try to be line oriented; position the limits at the
1943 ;; closest preceding boi, and after the next newline, that
1944 ;; isn't inside a comment, but if we hit a neighboring
1945 ;; declaration then we instead use the exact declaration
1946 ;; limit in that direction.
1952 pos
1968 pos))))))))
1976 "Put mark at end of the current top-level declaration or macro, point at beginning.
1977 If point is not inside any then the closest following one is
1978 chosen. Each successive call of this command extends the marked
1979 region by one function.
1981 A mark is left where the command started, unless the region is already active
1982 \(in Transient Mark mode).
1985 function does not require the declaration to contain a brace block."
1990 ;; We try to be line oriented, unless there are several
1991 ;; declarations on the same line.
2018 "Return the name of the current CPP macro, or NIL if we're not in one."
2027 \f
2028 ;; Movement by statements.
2030 ;; Point is within a comment. Is it also within a comment-prefix?
2031 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2032 ;;
2033 ;; This function might do hidden buffer changes.
2043 ;; Narrow to the "inside" of the comment (block) defined by range, as
2044 ;; follows:
2045 ;;
2046 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2047 ;; present) removed. A c++-style line comment retains its opening "//" but
2048 ;; has any final NL removed. If POINT is currently outwith these innards,
2049 ;; move it to the appropriate boundary.
2050 ;;
2051 ;; This narrowing simplifies the sentence movement functions, since it
2052 ;; eliminates awkward things at the boundaries of the comment (block).
2053 ;;
2054 ;; This function might do hidden buffer changes.
2072 ;; Move backwards to the "beginning of a sentence" within the comment
2073 ;; defined by RANGE, a cons of its starting and ending positions. If we
2074 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2075 ;; of the comment and return T.
2076 ;;
2077 ;; The BOS is either text which follows a regexp match of sentence-end,
2078 ;; or text which is a beginning of "paragraph".
2079 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2080 ;;
2081 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2082 ;; It is not a general function, but is intended only for calling from
2083 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2084 ;;
2085 ;; This function might do hidden buffer changes.
2091 last
2097 ;; First, find the previous paragraph start, if any.
2101 ; paragraph-\(start\|separate\)
2110 ;; Now seek successively earlier sentence ends between PAR-BEG and
2111 ;; HERE, until the "start of sentence" following it is earlier than
2112 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2130 nil
2132 t))))
2135 ;; Move forward to the "end of a sentence" within the comment defined by
2136 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2137 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2138 ;; return NIL. Otherwise, move point to just after the end of the comment
2139 ;; and return T.
2140 ;;
2141 ;; The EOS is just after the non-WS part of the next match of the regexp
2142 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2143 ;; no sentence-end match following point, any WS before the end of the
2144 ;; comment will count as EOS, providing we're not already in it.
2145 ;;
2146 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2147 ;; It is not a general function, but is intended only for calling from
2148 ;; c-move-over-sentence.
2149 ;;
2150 ;; This function might do hidden buffer changes.
2153 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2154 )
2160 ;; The cc-mode values of paragraph-\(start\|separate\), set
2161 ;; in c-setup-paragraph-variables, are used in the
2162 ;; following.
2171 last
2174 ;; Go forward one "comment-prefix which looks like sentence-end"
2175 ;; each time round the following:
2186 ;; Take special action if we're up against the end of a comment (of
2187 ;; either sort): Leave point just after the last non-ws text.
2194 nil
2196 t))))
2199 ;; Move backwards to the "beginning of a sentence" within the string defined
2200 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2201 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2202 ;; just before the start of the string and return T.
2203 ;;
2204 ;; The BOS is either the text which follows a regexp match of sentence-end
2205 ;; or text which is a beginning of "paragraph". For the purposes of
2206 ;; determining paragraph boundaries, escaped newlines are treated as
2207 ;; ordinary newlines.
2208 ;;
2209 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2210 ;; It is not a general function, but is intended only for calling from
2211 ;; c-move-over-sentence.
2212 ;;
2213 ;; This function might do hidden buffer changes.
2219 ;; Enhance paragraph-start and paragraph-separate also to recognize
2220 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2221 ;; these values should be customizable user options, or something.
2230 ; paragraph-\(start\|separate\)
2238 ;; Now see if we can find a sentence end after PAR-BEG.
2246 ; than here, in case point starts
2247 ; beyond the closing quote.
2252 nil
2254 t))))
2257 ;; Move forward to the "end of a sentence" within the string defined by
2258 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2259 ;; return NIL. Otherwise, move point to just after the end of the string
2260 ;; and return T.
2261 ;;
2262 ;; The EOS is just after the non-WS part of the next match of the regexp
2263 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2264 ;; no sentence-end match following point, any WS before the end of the
2265 ;; string will count as EOS, providing we're not already in it.
2266 ;;
2267 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2268 ;; It is not a general function, but is intended only for calling from
2269 ;; c-move-over-sentence.
2270 ;;
2271 ;; This function might do hidden buffer changes.
2274 last
2275 ;; Enhance paragraph-start and paragraph-separate to recognize
2276 ;; blank lines terminated by escaped EOLs.
2284 ;; The above values of paragraph-\(start\|separate\) are used
2285 ;; in the following.
2288 ;; (re-search-backward filler-here nil t) would find an empty
2289 ;; string. Therefore we simulate it by the following:
2298 ;; Try to go forward a sentence.
2303 ;; Did we move a sentence, or did we hit the end of the string?
2305 nil
2307 t))))
2310 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2311 ;; If a literal is the next thing (aside from whitespace) to be found before
2312 ;; point, return a cons of its start.end positions (enclosing the
2313 ;; delimiters). Otherwise return NIL.
2314 ;;
2315 ;; This function might do hidden buffer changes.
2319 pos)
2323 ;; to prevent `looking-at' seeing a " at point.
2327 ;; An EOL can act as an "open string" terminator in AWK.
2338 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2339 ;; If a literal is the next thing (aside from whitespace) following point,
2340 ;; return a cons of its start.end positions (enclosing the delimiters).
2341 ;; Otherwise return NIL.
2342 ;;
2343 ;; This function might do hidden buffer changes.
2356 ;; Does point immediately follow a statement "terminator"? A virtual
2357 ;; semicolon is regarded here as such. So is an opening brace ;-)
2358 ;;
2359 ;; This function might do hidden buffer changes.
2367 ;; The following (for macros) is not strict about exactly where we are
2368 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2369 ;; much. ACM 2004/3/29.
2381 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2382 ;; stopping before reaching BOB or a literal or the boundary of a
2383 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2384 ;; the position of the '#' beginning the current preprocessor directive, or
2385 ;; NIL if we're not in such.
2386 ;;
2387 ;; Return a cons (A.B), where
2388 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2389 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2390 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2391 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2392 ;;
2393 ;; The total collection of returned values is as follows:
2394 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2395 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2396 ;; a BOS - the caller must check this.
2397 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2398 ;; moved and reached the opening # of the macro.
2399 ;; (t . macro-boundary): Every other circumstance in which we're at a
2400 ;; macro-boundary. We might be at a BOS.
2401 ;;
2402 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2403 ;; code before encountering the literal/BOB or macro-boundary.
2404 ;;
2405 ;; Note that this function moves within either preprocessor commands
2406 ;; (macros) or normal code, but will not cross a boundary between the two,
2407 ;; or between two distinct preprocessor commands.
2408 ;;
2409 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2410 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2411 ;; move into parens. Also stop before `#' when it's at boi on a line.
2412 ;;
2413 ;; This function might do hidden buffer changes.
2417 ; semicolon precedes it.
2422 ;; Stop at the token after a comment.
2427 ;; If we've gone back over a LF, we might have moved into or out of
2428 ;; a preprocessor line.
2436 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2441 ;; Have we found a virtual semicolon? If so, stop, unless the next
2442 ;; statement is where we started from.
2449 ;; Hit the beginning of the buffer/region?
2455 ;; Move back a character.
2458 ;; Stop at "{" (unless it's a PIKE special brace list.)
2467 ;; Have we reached the start of a macro? This always counts as
2468 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2469 ;; here. FIXME!!! ACM 2004/3/29)
2473 ;; Stop at token just after "}" or ";".
2475 ;; If we've gone back over ;, {, or }, we're done.
2484 ;; Stop at the token after a string.
2489 ;; Nothing special: go back word characters.
2491 ))))))
2494 ;; Move forwards over code, stopping before reaching EOB or a literal
2495 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2496 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2497 ;; terminates the current preprocessor directive, or NIL if we're not in
2498 ;; such.
2499 ;;
2500 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2501 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2502 ;; seems unavoidable. Depending on the context this function is called
2503 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2504 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2505 ;; semicolons, or anything else.
2506 ;;
2507 ;; Return a cons (A.B), where
2508 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2509 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2510 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2511 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2512 ;;
2513 ;; Point is left either after the end-of-statement, or at the last non-ws
2514 ;; code before encountering the literal, or the # of the preprocessor
2515 ;; statement, or at EOB [or just after last non-WS stuff??].
2516 ;;
2517 ;; As a clarification of "after the end-of-statement", if a comment or
2518 ;; whitespace follows a completed AWK statement, that statement is treated
2519 ;; as ending just after the last non-ws character before the comment.
2520 ;;
2521 ;; Note that this function moves within either preprocessor commands
2522 ;; (macros) or normal code, but not both within the same invocation.
2523 ;;
2524 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2525 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2526 ;; stop before `{' if at top level or inside braces, though. Move by
2527 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2528 ;; the boi.
2529 ;;
2530 ;; This function might do hidden buffer changes.
2532 last)
2537 ;; If we've moved forward to a virtual semicolon, we're done.
2544 ;; Gone past the end of a macro?
2549 ;; About to hit a comment?
2554 ;; End of buffer?
2560 ;; If we encounter a '{', stop just after the previous token.
2566 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2567 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2568 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2569 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2575 ;; End of a PIKE special brace list? If so, step over it and continue.
2584 ;; Have we got a '}' after having moved? If so, stop after the
2585 ;; previous token.
2591 ;; Stop if we encounter a preprocessor line. Continue if we
2592 ;; hit a naked #
2601 ;; Stop after a ';', '}', or "};"
2606 ;; Found a string (this subsumes AWK regexps)?
2617 )))))
2620 ;; Is the literal defined by RANGE a string contained in a single line?
2621 ;;
2622 ;; This function might do hidden buffer changes.
2630 "Go to the beginning of the innermost C statement.
2631 With prefix arg, go back N - 1 statements. If already at the
2632 beginning of a statement then go to the beginning of the closest
2633 preceding one, moving into nested blocks if necessary (use
2635 comment or multiline string, move by sentences instead of statements.
2637 When called from a program, this function takes 3 optional args: the
2638 repetition count, a buffer position limit which is the farthest back
2639 to search for the syntactic context, and a flag saying whether to do
2640 sentence motion in or near comments and multiline strings.
2642 Note that for use in programs, `c-beginning-of-statement-1' is
2643 usually better. It has much better defined semantics than this one,
2644 which is intended for interactive use, and might therefore change to
2647 nil t))
2652 last ; start point for going back ONE chunk. Updated each chunk movement.
2655 res ; result from sub-function call
2656 not-bos ; "not beginning-of-statement"
2657 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2659 ;; Go back one statement at each iteration of the following loop.
2662 ;; Go back one "chunk" each time round the following loop, stopping
2663 ;; when we reach a statement boundary, etc.
2667 ; statement boundary, non-NIL otherwise.
2670 nil)
2674 ;; Single line string or sentence-flag is null => skip the
2675 ;; entire literal.
2680 ;; N.B. The following is essentially testing for an AWK regexp
2681 ;; at BOS:
2682 ;; Was the previous non-ws thing an end of statement?
2689 ;; Comment inside a statement or a multi-line string.
2695 res)))
2697 ;; Non-literal code.
2704 ;; We're at a tentative BOS. The next form goes
2705 ;; back over WS looking for an end of previous
2706 ;; statement.
2712 ;; Are we about to move backwards into or out of a
2713 ;; preprocessor command? If so, locate its beginning.
2721 ;; Are we about to move backwards into a literal?
2724 not-bos))
2731 "Go to the end of the innermost C statement.
2732 With prefix arg, go forward N - 1 statements. Move forward to the end
2733 of the next statement if already at end, and move into nested blocks
2735 comment or multiline string, move by sentences instead of statements.
2737 When called from a program, this function takes 3 optional args: the
2738 repetition count, a buffer position limit which is the farthest back
2739 to search for the syntactic context, and a flag saying whether to do
2740 sentence motion in or near comments and multiline strings."
2742 nil t))
2752 res
2753 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2755 ;; Go back/forward one statement at each iteration of the following loop.
2760 ;; Go forward one "chunk" each time round the following loop, stopping
2761 ;; when we reach a statement boundary, etc.
2764 ; statement boundary, non-NIL otherwise.
2767 nil)
2771 ;; sentence-flag is null => skip the entire literal.
2772 ;; or a Single line string.
2777 ;; Is there a virtual semicolon here (e.g. for AWK)?
2780 ;; Comment or multi-line string.
2786 ;; If we've just come forward out of a literal, check for
2787 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2788 ;; some other language may do in the future)
2792 ;; Non-literal code.
2795 ;; Are we about to move forward into or out of a
2796 ;; preprocessor command?
2811 ;; Are we about to move forward into a literal?
2819 \f
2820 ;; set up electric character functions to work with pending-del,
2821 ;; (a.k.a. delsel) mode. All symbols get the t value except
2822 ;; the functions which delete, which gets 'supersede.
2829 c-electric-brace
2830 c-electric-slash
2831 c-electric-star
2832 c-electric-semi&comma
2833 c-electric-lt-gt
2834 c-electric-colon
2835 c-electric-paren))
2843 \f
2844 ;; Inserting/indenting comments
2846 ;; This function might do hidden buffer changes.
2859 ;; Do not pad with one space if we're at bol.
2860 value
2871 ;; Found comment to align with.
2873 ;; Do not pad with one space if we're at bol.
2874 0
2876 ;; Recurse to handle value as a new spec.
2880 "Used by `indent-for-comment' to create and indent comments.
2881 See `c-indent-comment-alist' for a description."
2909 case-fold-search)
2911 c-indent-comments-syntactically-p)
2913 ;; BOGOSITY ALERT: if we're looking at the eol, its
2914 ;; because indent-for-comment hasn't put the comment-start
2915 ;; in the buffer yet. this will screw up the syntactic
2916 ;; analysis so we kludge in the necessary info. Another
2917 ;; kludge is that if we're at the bol, then we really want
2918 ;; to ignore any anchoring as specified by
2919 ;; c-comment-only-line-offset since it doesn't apply here.
2924 c-comment-only-line-offset
2926 c-comment-only-line-offset))))
2931 \f
2932 ;; used by outline-minor-mode
2935 ;; in otherwise-hidden text.
2940 \f
2941 ;; Movement by CPP conditionals.
2943 "Move back to the containing preprocessor conditional, leaving mark behind.
2944 A prefix argument acts as a repeat count. With a negative argument,
2945 move forward to the end of the containing preprocessor conditional.
2948 function stops at them when going backward, but not when going
2949 forward."
2959 directives."
2967 "Move forward into the next preprocessor conditional, leaving mark behind.
2968 A prefix argument acts as a repeat count. With a negative argument,
2969 move backward into the previous preprocessor conditional.
2972 function stops at them when going forward, but not when going
2973 backward."
2983 directives."
2991 "Move back across a preprocessor conditional, leaving mark behind.
2992 A prefix argument acts as a repeat count. With a negative argument,
2993 move forward across a preprocessor conditional.
2995 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2996 and have the same meanings as in `c-scan-conditionals'. If you
2997 are calling c-forward-conditional from a program, you might want
2998 to call `c-scan-conditionals' directly instead."
3006 "Move forward across a preprocessor conditional, leaving mark behind.
3007 A prefix argument acts as a repeat count. With a negative argument,
3008 move backward across a preprocessor conditional.
3010 If there aren't enough conditionals after \(or before) point, an
3011 error is signaled.
3014 the nesting level isn't changed when tracking subconditionals.
3016 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3017 and have the same meanings as in `c-scan-conditionals'. If you
3018 are calling c-forward-conditional from a program, you might want
3019 to call `c-scan-conditionals' directly instead."
3026 "Scan forward across COUNT preprocessor conditionals.
3027 With a negative argument, scan backward across preprocessor
3028 conditionals. Return the end position. Point is not moved.
3030 If there aren't enough preprocessor conditionals, throw an error.
3033 the nesting level isn't changed when tracking subconditionals.
3035 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3036 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3037 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3038 counts as -1.
3041 are treated as conditional clause limits. Normally they are ignored."
3045 new case-fold-search)
3051 ;; subdepth is the depth in "uninteresting" subtrees,
3052 ;; i.e. those that takes us farther from the target
3053 ;; depth instead of closer.
3055 found)
3057 ;; Find the "next" significant line in the proper direction.
3059 ;; Rather than searching for a # sign that
3060 ;; comes at the beginning of a line aside from
3061 ;; whitespace, search first for a string
3062 ;; starting with # sign. Then verify what
3063 ;; precedes it. This is faster on account of
3064 ;; the fastmap feature of the regexp matcher.
3067 nil t))
3069 ;; Now verify it is really a preproc line.
3077 ;; When we're not in an "uninteresting"
3078 ;; subtree, we might want to act on "elif"
3079 ;; and "else" too.
3081 ;; Always move toward the target depth.
3086 ;; Ignore the change if it'd take us
3087 ;; into an "uninteresting" subtree.
3095 ;; If we are trying to move across, and we find an
3096 ;; end before we find a beginning, get an error.
3099 "No following conditional at this level"
3101 ;; When searching forward, start from next line so
3102 ;; that we don't find the same line again.
3104 ;; We found something if we've arrived at the
3105 ;; target depth.
3108 ;; else
3115 new))
3117 \f
3118 ;; commands to indent lines, regions, defuns, and expressions
3120 "Indent current line as C code, and/or insert some whitespace.
3122 If `c-tab-always-indent' is t, always just indent the current line.
3123 If nil, indent the current line only if point is at the left margin or
3124 in the line's indentation; otherwise insert some whitespace[*]. If
3125 other than nil or t, then some whitespace[*] is inserted only within
3126 literals (comments and strings), but the line is always reindented.
3128 If `c-syntactic-indentation' is t, indentation is done according to
3129 the syntactic context. A numeric argument, regardless of its value,
3130 means indent rigidly all the lines of the expression starting after
3131 point so that this line becomes properly indented. The relative
3132 indentation among the lines of the expression is preserved.
3134 If `c-syntactic-indentation' is nil, the line is just indented one
3135 step according to `c-basic-offset'. In this mode, a numeric argument
3136 indents a number of such steps, positive or negative, and an empty
3137 prefix argument is equivalent to -1.
3139 [*] The amount and kind of whitespace inserted is controlled by the
3140 variable `c-insert-tab-function', which is called to do the actual
3141 insertion of whitespace. Normally the function in this variable
3142 just inserts a tab character, or the equivalent number of spaces,
3143 depending on the variable `indent-tabs-mode'."
3152 -1
3160 ;; Realign the line continuation backslash if inside a macro.
3162 ))))
3164 ;; If c-syntactic-indentation and got arg, always indent this
3165 ;; line as C and shift remaining lines of expression the same
3166 ;; amount.
3170 beg end)
3175 shift-amt))
3187 ;; Else use c-tab-always-indent to determine behavior.
3189 ;; CASE 1: indent when at column zero or in line's indentation,
3190 ;; otherwise insert a tab
3197 ;; CASE 2: just indent the line
3200 ;; CASE 3: if in a literal, insert a tab, but always indent the
3201 ;; line
3206 )))))
3209 "Indent each line in the balanced expression following point syntactically.
3210 If optional SHUTUP-P is non-nil, no errors are signaled if no
3211 balanced expression is found."
3214 end)
3218 ;; Find the closest following open paren that
3219 ;; ends on another line.
3227 ;; sanity check
3243 "Indent the current top-level declaration or macro syntactically.
3244 In the macro case this also has the effect of realigning any line
3245 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3251 ;; We try to be line oriented, unless there are several
3252 ;; declarations on the same line.
3264 "Indent syntactically every line whose first char is between START
3265 and END inclusive. If the optional argument QUIET is non-nil then no
3266 syntactic errors are reported, even if `c-report-syntactic-errors' is
3267 non-nil."
3273 ;; Advance to first nonblank line.
3281 ;; shut up any echo msgs on indiv lines
3287 start))
3289 syntax)
3297 ;; update progress
3299 ;; skip empty lines
3302 ;; Get syntax and indent.
3308 ;; End of current multi-line macro?
3311 ;; Fixup macro backslashes.
3314 ;; New multi-line macro?
3326 c-parsing-error))))
3329 ;; Function version of the macro for use in places that aren't
3330 ;; compiled, e.g. in the menus.
3334 "Indent active region, current line, or block starting on this line.
3335 In Transient Mark mode, when the region is active, reindent the region.
3336 Otherwise, with a prefix argument, rigidly reindent the expression
3337 starting on the current line.
3338 Otherwise reindent just the current line."
3344 \f
3345 ;; for progress reporting
3350 ;; Be silent
3352 ;; Start the progress update messages. If this Emacs doesn't have
3353 ;; a built-in timer, just be dumb about it.
3356 ;; If progress has already been initialized, do nothing. otherwise
3357 ;; initialize the counter with a vector of:
3358 ;; [start end lastsec context]
3365 context))
3367 ))
3371 nil
3376 ;; should we update? currently, update happens every 2 seconds,
3377 ;; what's the right value?
3383 )))
3387 nil
3396 \f
3397 ;;; This page handles insertion and removal of backslashes for C macros.
3400 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3401 With no argument, inserts backslashes and aligns existing backslashes.
3402 With an argument, deletes the backslashes. The backslash alignment is
3403 done according to the settings in `c-backslash-column',
3404 `c-backslash-max-column' and `c-auto-align-backslashes'.
3406 This function does not modify blank lines at the start of the region.
3407 If the region ends at the start of a line and the macro doesn't
3408 continue below it, the backslash (if any) at the end of the previous
3409 line is deleted.
3411 You can put the region around an entire macro definition and use this
3412 command to conveniently insert and align the necessary backslashes."
3415 ;; Keep the backslash trimming functions from changing the
3416 ;; whitespace around point, since in this case it's only the
3417 ;; position of point that tells the indentation of the line.
3423 column longest-line-col bs-col-after-end)
3427 ;; Nothing to do if to is at bob, since we should back up
3428 ;; and there's no line to back up to.
3429 nil
3431 ;; Do not back up the to line if line-mode is set, to make
3432 ;; e.g. c-newline-and-indent consistent regardless whether
3433 ;; the (newline) call leaves point at bol or not.
3441 ;; Set bs-col-after-end to the column of any backslash
3442 ;; following the region, or nil if there is none.
3451 ;; Back up the to line if line-mode is set, since the line
3452 ;; after the newly inserted line break should not be
3453 ;; touched in c-newline-and-indent.
3456 ;; Set bs-col-after-end to non-nil in any case, since we
3457 ;; do not want to delete the backslash at the last line.
3462 ;; Compute the smallest column number past the ends of all
3463 ;; the lines.
3467 ;; Include one more line in the max column
3468 ;; calculation, since the to line will be backslashed
3469 ;; too.
3482 ;; Try to align with surrounding backslashes.
3491 ;; Both a preceding and a following backslash.
3492 ;; Choose the greatest of them.
3495 ;; No preceding backslash. Try to align with one
3496 ;; following the region. Disregard the backslash at the
3497 ;; to line since it's likely to be bogus (e.g. when
3498 ;; called from c-newline-and-indent).
3501 ;; Don't modify blank lines at start of region.
3506 ;; Don't try to align with surrounding backslashes if
3507 ;; any line is too long.
3510 ;; Impose minimum limit and tab width alignment only if
3511 ;; we can't align with surrounding backslashes.
3515 tab-width)
3516 tab-width)))
3518 longest-line-col)))
3519 ;; Always impose maximum limit.
3522 ;; Add backslashes on all lines if the macro continues
3523 ;; after the to line.
3527 ;; Add backslashes on all lines except the last, and
3528 ;; remove any on the last line.
3536 ;; The function above leaves point on the line
3537 ;; following endmark.
3562 ;; Avoid unnecessary changes of the buffer.
3564 ;; Don't realign backslashes in string literals
3565 ;; since that would change them.
3566 )
3592 ;; Make sure there are backslashes with at least one space in
3593 ;; front of them.
3628 point-pos))
3634 \f
3635 ;;; Line breaking and paragraph filling.
3641 ;; The filling code is based on a simple theory; leave the intricacies
3642 ;; of the text handling to the currently active mode for that
3643 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3644 ;; possible to make them work correctly wrt the comment and string
3645 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3646 ;; to it, there's quite a lot of special cases to handle which makes
3647 ;; the code anything but simple. The intention is that it will work
3648 ;; with any well-written text filling package that preserves a fill
3649 ;; prefix.
3650 ;;
3651 ;; We temporarily mask comment starters and enders as necessary for
3652 ;; the filling code to do its job on a seemingly normal text block.
3653 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3654 ;; preserve it correctly (especially important when filling C++ style
3655 ;; line comments). By default, we set up and use adaptive-fill-mode,
3656 ;; which is standard in all supported Emacs flavors.
3659 ;; Determine the appropriate comment fill prefix for a block or line
3660 ;; comment. Return a cons of the prefix string and the column where
3661 ;; it ends. If fill-prefix is set, it'll override. Note that this
3662 ;; function also uses the value of point in some heuristics.
3663 ;;
3664 ;; This function might do hidden buffer changes.
3668 c-current-comment-prefix
3671 prefix-regexp
3672 comment-start-skip))
3673 prefix-line comment-prefix res comment-text-end)
3678 ;; Ugly way of getting the column after the fill
3679 ;; prefix; it'd be nice with a current-column
3680 ;; that works on strings..
3690 ;; Set fallback for comment-prefix if none is found.
3696 ;; The current line is not the comment starter, so the
3697 ;; comment has more than one line, and it can therefore be
3698 ;; used to find the comment fill prefix.
3704 ;; The line after the comment starter is inside the
3705 ;; comment, so we can use it.
3708 ;; The comment is only one line. Take the comment prefix
3709 ;; from it and keep the indentation.
3718 ;; There is only whitespace before the comment
3719 ;; starter; take the prefix straight from this line.
3724 ;; There is code before the comment starter, so we
3725 ;; have to temporarily insert and indent a new line to
3726 ;; get the right space/tab mix in the indentation.
3728 tmp)
3744 ;; The prefix ends the line with no whitespace
3745 ;; after it. Default to a single space.
3747 )))))
3760 ;; The current line is not the comment starter and
3761 ;; contains more than just the ender, so it's good enough
3762 ;; to be used for the comment fill prefix.
3772 ;; The comment is either one line or the next line contains
3773 ;; just the comment ender. In this case we have no
3774 ;; information about a suitable comment prefix, so we resort
3775 ;; to c-block-comment-prefix.
3779 ;; The point was on the comment opener line, so we might want
3780 ;; to treat this as a not yet closed comment.
3784 ;; Above `prefix-regexp' matched a nonempty prefix on the
3785 ;; second line, so let's use it. Normally it should do
3786 ;; to set `prefix-line' and let the code below pick up
3787 ;; the whole prefix, but if there's no text after the
3788 ;; match then it will probably fall back to no prefix at
3789 ;; all if the comment isn't closed yet, so in that case
3790 ;; it's better to force use of the prefix matched now.
3795 ;; There's no nonempty prefix on the line after the
3796 ;; comment opener. If the line is empty, or if the
3797 ;; text on it has less or equal indentation than the
3798 ;; comment starter we assume it's an unclosed
3799 ;; comment starter, i.e. that
3800 ;; `c-block-comment-prefix' should be used.
3801 ;; Otherwise we assume it's a closed comment where
3802 ;; the prefix really is the empty string.
3803 ;; E.g. this is an unclosed comment:
3804 ;;
3805 ;; /*
3806 ;; foo
3807 ;;
3808 ;; But this is not:
3809 ;;
3810 ;; /*
3811 ;; foo
3812 ;; */
3813 ;;
3814 ;; (Looking for the presence of the comment closer
3815 ;; rarely works since it's probably the closer of
3816 ;; some comment further down when the comment
3817 ;; really is unclosed.)
3826 ;; Otherwise the line after the comment starter is good
3827 ;; enough to find the prefix in.
3831 ;; Haven't got the comment prefix on any real line that we
3832 ;; can take it from, so we have to temporarily insert
3833 ;; `comment-prefix' on a line and indent it to find the
3834 ;; correct column and the correct mix of tabs and spaces.
3843 comment-text-end))
3848 ;; If there's ws on the current line, we'll use it
3849 ;; instead of what's ending comment-prefix.
3854 comment-prefix))
3863 ;; We insert an extra non-whitespace character
3864 ;; before the line break and after comment-prefix in
3865 ;; case it's "" or ends with whitespace.
3884 ;; prefix-line is the bol of a line on which we should try
3885 ;; to find the prefix.
3892 ;; The match is fine if there's text after it.
3898 ;; This match is better than nothing, so let's
3899 ;; remember it in case nothing better is found
3900 ;; on another line.
3904 t))))
3907 ;; Search for a line which has text after the prefix
3908 ;; so that we get the proper amount of whitespace
3909 ;; after it. We start with the current line, then
3910 ;; search backwards, then forwards.
3915 ;; The whitespace is sucked up by the
3916 ;; first [ \t]* glob if the prefix is empty.
3919 ;; If the current line doesn't have text but do
3920 ;; have whitespace after the prefix, we'll use it.
3926 ;; For line comments we can search up to and
3927 ;; including the first line.
3931 ;; For block comments we must stop before the
3932 ;; block starter.
3943 nil)
3946 ;; A good line wasn't found, but at least we have a
3947 ;; fallback that matches the comment prefix regexp.
3952 ;; There are ws or text after the prefix, so
3953 ;; let's use it.
3957 ;; Check if there's any whitespace padding
3958 ;; on the comment start line that we can
3959 ;; use after the prefix.
3977 ;; Got to mess in the buffer once again to
3978 ;; ensure the column gets correct. :P
3989 ;; Last resort: Just add a single space after
3990 ;; the prefix.
3995 ;; The line doesn't match the comment prefix regexp.
3997 ;; We have a fallback for line comments that we must use.
4000 comment-prefix)
4004 ;; Assume we are dealing with a "free text" block
4005 ;; comment where the lines doesn't have any comment
4006 ;; prefix at all and we should just fill it as
4007 ;; normal text.
4009 ))
4012 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4013 ;; masked to allow adaptive filling to work correctly. That
4014 ;; includes narrowing the buffer and, if point is inside a comment,
4015 ;; masking the comment starter and ender appropriately.
4016 ;;
4017 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4018 ;; The position of point is then less significant when doing masking
4019 ;; and narrowing.
4020 ;;
4021 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4022 ;; only if the point turns out to be inside a comment or a string.
4023 ;;
4024 ;; Note that this function does not do any hidden buffer changes.
4027 ;; beg and end limit the region to narrow. end is a marker.
4028 beg end
4029 ;; tmp-pre and tmp-post mark strings that are temporarily
4030 ;; inserted at the start and end of the region. tmp-pre is a
4031 ;; cons of the positions of the prepended string. tmp-post is
4032 ;; a marker pointing to the single character of the appended
4033 ;; string.
4034 tmp-pre tmp-post
4035 ;; If hang-ender-stuck isn't nil, the comment ender is
4036 ;; hanging. In that case it's set to the number of spaces
4037 ;; that should be between the text and the ender.
4038 hang-ender-stuck
4039 ;; auto-fill-spaces is the exact sequence of whitespace between a
4040 ;; comment's last word and the comment ender, temporarily replaced
4041 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4042 auto-fill-spaces
4047 ;; Restore point on undo. It's necessary since we do a lot of
4048 ;; hidden inserts and deletes below that should be as transparent
4049 ;; as possible.
4053 ;; Determine the limits and type of the containing literal (if any):
4054 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4055 ;; BEG and END.
4058 ;; Widen to catch comment limits correctly.
4083 ;; For each of the possible types of text (string, C comment ...)
4084 ;; determine BEG and END, the region we will narrow to. If we're in
4085 ;; a literal, constrain BEG and END to the limits of this literal.
4086 ;;
4087 ;; For some of these text types, particularly a block comment, we
4088 ;; may need to massage whitespace near literal delimiters, so that
4089 ;; these don't get filled inappropriately.
4094 ;; Limit to the comment or paragraph end, whichever
4095 ;; comes first.
4099 ;; The region includes the comment starter, so we must
4100 ;; check it.
4104 ;; Include the first line in the region.
4106 ;; The first line contains code before the
4107 ;; comment. We must fake a line that doesn't.
4118 ;; disallow "/*/"
4120 ;; There is a comment ender, and the region includes it. If
4121 ;; it's on its own line, it stays on its own line. If it's got
4122 ;; company on the line, it keeps (at least one word of) it.
4123 ;; "=====*/" counts as a comment ender here, but "===== */"
4124 ;; doesn't and "foo*/" doesn't.
4129 ;; The following conjunct was added to avoid an
4130 ;; "Invalid search bound (wrong side of point)"
4131 ;; error in the subsequent re-search. Maybe
4132 ;; another fix would be needed (2007-12-08).
4133 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4134 ; 2010-10-17 Construct removed.
4135 ; (or (< (- (cdr c-lit-limits) 2) (point))
4143 ;; The comment ender IS on its own line. Exclude this
4144 ;; line from the filling.
4147 ;; The comment ender is hanging. Replace all space between it
4148 ;; and the last word either by one or two 'x's (when
4149 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4150 ;; as the whitespace (when auto filling), and include it in
4151 ;; the region. We'll change them back to whitespace
4152 ;; afterwards. The effect of this is to glue the comment
4153 ;; ender to the last word in the comment during filling.
4170 spaces)
4173 ;; Insert a CR after the "*/", adjust END
4181 c-current-comment-prefix
4184 ;; The comment ender is prefixed by nothing but a
4185 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4186 ;; 2006/4/28). Remove it along with surrounding ws.
4190 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4192 ;; What's being tested here? 2006/4/20. FIXME!!!
4196 ;; Don't adjust point below if it's
4197 ;; before the string we replace.
4199 ;; Keep one or two spaces between the
4200 ;; text and the ender, depending on how
4201 ;; many there are now.
4206 ;; paragraph filling condenses multiple spaces to
4207 ;; single or double spaces. auto-fill doesn't.
4213 sentence-end-double-space)
4216 ;; Insert the filler first to keep marks right.
4225 ;; Point was in the middle of the string we
4226 ;; replaced above, so put it back in the same
4227 ;; relative position, counting from the end.
4229 ))
4232 ;; The region includes the comment starter.
4236 ;; Begin with the next line.
4238 ;; Fake the fill prefix in the first line.
4253 ;; Leave the start line if it's
4254 ;; nothing but an escaped newline.
4260 ;; Narrow to the macro limits if they are nearer than the
4261 ;; paragraph limits. Don't know if this is necessary but
4262 ;; do it for completeness sake (doing auto filling at all
4263 ;; inside macros is bogus to begin with since the line
4264 ;; continuation backslashes aren't handled).
4277 ;; Try to avoid comments and macros in the paragraph to
4278 ;; avoid that the adaptive fill mode gets the prefix from
4279 ;; them.
4292 ;; Temporarily insert the fill prefix after the comment
4293 ;; starter so that the first line looks like any other
4294 ;; comment line in the narrowed region.
4298 c-current-comment-prefix
4301 ;; Oops, the prefix doesn't match the comment prefix
4302 ;; regexp. This could produce very confusing
4303 ;; results with adaptive fill packages together with
4304 ;; the insert prefix magic below, since the prefix
4305 ;; often doesn't appear at all. So let's warn about
4306 ;; it.
4308 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4310 ;; Find the right spot on the line, break it, insert
4311 ;; the fill prefix and make sure we're back in the
4312 ;; same column by temporarily prefixing the first word
4313 ;; with a number of 'x'.
4317 c-current-comment-prefix
4318 comment-start-skip))
4335 ;; `apply-outside-literal' is always set to t here if
4336 ;; we're inside a literal.
4340 ;; Kludge: If the function that adapts the fill prefix
4341 ;; doesn't produce the required comment starter for
4342 ;; line comments, then force it by setting fill-prefix.
4344 ;; Kludge the kludge: filladapt-mode doesn't
4345 ;; have this problem, but it currently
4346 ;; doesn't override fill-context-prefix
4347 ;; (version 2.12).
4349 filladapt-mode))
4356 c-lit-limits c-lit-type)))))))
4358 ;; Save the relative position of point if it's outside the
4359 ;; region we're going to narrow. Want to restore it in that
4360 ;; case, but otherwise it should be moved according to the
4361 ;; called function.
4365 ;; Preparations finally done! Now we can call the
4366 ;; actual function.
4372 ;; Restore point if it was outside the region.
4385 ;; Preserve point even if it's in the middle of the string
4386 ;; we replace; save-excursion doesn't work in that case.
4402 If any of the current line is a comment or within a comment, fill the
4403 comment or the paragraph of it that point is in, preserving the
4404 comment indentation or line-starting decorations (see the
4405 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4406 details).
4408 If point is inside multiline string literal, fill it. This currently
4409 does not respect escaped newlines, except for the special case when it
4410 is the very first thing in the string. The intended use for this rule
4411 is in situations like the following:
4414 A very long description of something that you want to fill to make
4417 If point is in any other situation, i.e. in normal code, do nothing.
4419 Optional prefix ARG means justify paragraph as well."
4422 ;; Avoid infinite recursion.
4424 fill-paragraph-function)))
4426 ;; Always return t. This has the effect that if filling isn't done
4427 ;; above, it isn't done at all, and it's therefore effectively
4428 ;; disabled in normal code.
4429 t)
4432 ;; Do automatic filling if not inside a context where it should be
4433 ;; ignored.
4435 ;; The decision whether the line should be broken is actually
4436 ;; done in c-indent-new-comment-line, which do-auto-fill
4437 ;; calls to break lines. We just set this special variable
4438 ;; so that we'll know when we're called from there. It's
4439 ;; also used to detect whether fill-prefix is user set or
4440 ;; generated automatically by do-auto-fill.
4441 fill-prefix))
4445 "Break line at point and indent, continuing comment or macro if within one.
4446 If inside a comment and `comment-multi-line' is non-nil, the
4447 indentation and line prefix are preserved (see the
4448 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4449 details). If inside a single line comment and `comment-multi-line' is
4450 nil, a new comment of the same type is started on the next line and
4451 indented as appropriate for comments. If inside a macro, a line
4452 continuation backslash is inserted and aligned as appropriate, and the
4453 new line is indented according to `c-syntactic-indentation'.
4455 If a fill prefix is specified, it overrides all the above."
4456 ;; allow-auto-fill is used from c-context-line-break to allow auto
4457 ;; filling to break the line more than once. Since this function is
4458 ;; used from auto-fill itself, that's normally disabled to avoid
4459 ;; unnecessary recursion.
4468 ;; Already know the literal type and limits when called from
4469 ;; c-context-line-break.
4476 ;; Called from do-auto-fill.
4484 c-ignore-auto-fill)
4489 ;; The adaptive fill function has generated a prefix, but
4490 ;; we're on the first line in a block comment so it'll be
4491 ;; wrong. Ignore it to guess a better one below.
4495 c-line-comment-starter)
4497 ;; Kludge: If the function that adapted the fill prefix
4498 ;; doesn't produce the required comment starter for line
4499 ;; comments, then we ignore it.
4501 )))
4504 ;; A call from do-auto-fill which should be ignored.
4505 )
4507 ;; A fill-prefix overrides anything.
4516 ;; Some sort of comment.
4522 ;; Inside a comment that should be continued.
4527 c-lit-type)))
4536 ;; Skip forward past the fill prefix in case
4537 ;; we're standing in it.
4538 ;;
4539 ;; FIXME: This doesn't work well in cases like
4540 ;;
4541 ;; /* Bla bla bla bla bla
4542 ;; bla bla
4543 ;;
4544 ;; If point is on the 'B' then the line will be
4545 ;; broken after "Bla b".
4546 ;;
4547 ;; If we have an empty comment, /* */, the next
4548 ;; lot of code pushes point to the */. We fix
4549 ;; this by never allowing point to end up to the
4550 ;; right of where it started.
4557 ;; The skip takes us out of the (block)
4558 ;; comment; insert the fill prefix at bol
4559 ;; instead and keep the position.
4566 ;; Don't break in the middle of a comment starter
4567 ;; or ender.
4576 ; middle of a TAB?
4577 ;; Inside a comment that should be broken.
4580 col)
4594 ;; c-comment-indent may look at the current
4595 ;; indentation, so let's start out with the same
4596 ;; indentation as the previous one.
4601 ;; In a macro.
4603 ;; Do not clobber the alignment of the line continuation
4604 ;; slash; c-backslash-region might look at it.
4606 ;; Got an asymmetry here: In normal code this command
4607 ;; doesn't indent the next line syntactically, and otoh a
4608 ;; normal syntactically indenting newline doesn't continue
4609 ;; the macro.
4612 ;; Somewhere else in the code.
4624 ;; advice for indent-new-comment-line for older Emacsen
4628 activate preactivate)
4629 "Call `c-indent-new-comment-line' if in CC Mode."
4632 ad-do-it
4637 "Do a line break suitable to the context.
4639 When point is outside a comment or macro, insert a newline and indent
4640 according to the syntactic context, unless `c-syntactic-indentation'
4641 is nil, in which case the new line is indented as the previous
4642 non-empty line instead.
4644 When point is inside the content of a preprocessor directive, a line
4645 continuation backslash is inserted before the line break and aligned
4646 appropriately. The end of the cpp directive doesn't count as inside
4647 it.
4649 When point is inside a comment, continue it with the appropriate
4650 comment prefix (see the `c-comment-prefix-regexp' and
4651 `c-block-comment-prefix' variables for details). The end of a
4652 C++-style line comment doesn't count as inside it.
4654 When point is inside a string, only insert a backslash when it is also
4655 inside a preprocessor directive."
4660 case-fold-search)
4677 ; it, not in a string, and not in the
4678 ; cpp keyword.
4700 ;; c-indent-line may look at the current indentation, so let's
4701 ;; start out with the same indentation as the previous line.
4712 "Insert a line break suitable to the context and leave point before it.
4713 This is the `c-context-line-break' equivalent to `open-line', which is
4714 normally bound to C-o. See `c-context-line-break' for the details."
4719 ;; Temporarily insert a non-whitespace char to keep any
4720 ;; preceding whitespace intact.
4726 \f
4729 ;;; cc-cmds.el ends here