| blob | 7cd0a0b0ae21c0c306c290210d8b51fbacf4dfbc |
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.)
508 ;; Turn on syntactic macro analysis to help with auto
509 ;; newlines only.
511 nil))
512 syntax))
515 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
516 ;; (not necessarily the same as the S.C. of the line it is on). Return
517 ;; NEWLINES, the list containing some combination of the symbols `before'
518 ;; and `after' saying where newlines should be inserted.
521 ;; This is the list of brace syntactic symbols that can hang.
522 ;; If any new ones are added to c-offsets-alist, they should be
523 ;; added here as well.
524 ;;
525 ;; The order of this list is important; if SYNTAX has several
526 ;; elements, the element that "wins" is the earliest in SYMS.
528 class-open class-close defun-open defun-close
529 inline-open inline-close
530 brace-list-open brace-list-close
531 brace-list-intro brace-entry-open
532 block-open block-close
533 substatement-open statement-case-open
534 extern-lang-open extern-lang-close
535 namespace-open namespace-close
536 module-open module-close
537 composition-open composition-close
538 inexpr-class-open inexpr-class-close
539 ;; `statement-cont' is here for the case with a brace
540 ;; list opener inside a statement. C.f. CASE B.2 in
541 ;; `c-guess-continued-construct'.
542 statement-cont))
543 ;; shut this up too
548 ;; Do not try to insert newlines around a special
549 ;; (Pike-style) brace list.
556 nil
557 ;; Seek the matching entry in c-hanging-braces-alist.
559 syms
560 ;; Substitute inexpr-class and class-open or
561 ;; class-close with inexpr-class-open or
562 ;; inexpr-class-close.
569 syntax)
570 c-hanging-braces-alist)
573 ;; If syntax is a function symbol, then call it using the
574 ;; defined semantics.
584 ;; Point is just after a newly inserted }. If the non-whitespace
585 ;; content of the braces is a single line of code, compact the whole
586 ;; construct to a single line, if this line isn't too long. The Right
587 ;; Thing is done with comments.
588 ;;
589 ;; Point will be left after the }, regardless of whether the clean-up is
590 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
594 mbeg1 mend1 mbeg4 mend4
595 eol-col cmnt-pos cmnt-col cmnt-gap)
600 ;; Avoid backtracking over a very large block. The one we
601 ;; deal with here can never be more than three lines.
632 ;; Necessary to put the closing brace before any line
633 ;; oriented comment to keep it syntactically significant.
634 ;; This isn't necessary for block comments, but the result
635 ;; looks nicer anyway.
651 ;; Can we trim space before comment to make the line fit?
657 t))))
661 "Insert a brace.
663 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
664 numeric ARG hasn't been supplied, the command performs several electric
665 actions:
668 the mode line) newlines are inserted before and after the brace as
669 directed by the settings in `c-hanging-braces-alist'.
671 \(b) Any auto-newlines are indented. The original line is also
672 reindented unless `c-syntactic-indentation' is nil.
674 \(c) If auto-newline is turned on, various newline cleanups based on the
675 settings of `c-cleanup-list' are done."
679 ;; We want to inhibit blinking the paren since this would be
680 ;; most disruptive. We'll blink it ourselves later on.
682 blink-paren-function case-fold-search)
688 ;; Insert the brace. Note that expand-abbrev might reindent
689 ;; the line here if there's a preceding "else" or something.
699 newlines
701 ; of the brace itself, of the line the brace ends up on.
713 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
717 ;; Only a plain newline for now - it's indented
718 ;; after the cleanups when the line has its final
719 ;; appearance.
724 ;; `syntax' is the syntactic context of the line which ends up
725 ;; with the brace on it.
728 ;; Do all appropriate clean ups
731 mbeg mend
732 )
734 ;; `}': clean up empty defun braces
739 syntax)
744 ;; make sure matching open brace isn't in a comment
750 ;; `}': compact to a one-liner defun?
759 ;; `{': clean up brace-else-brace and brace-elseif-brace
766 "else"
768 "{"
770 nil t))
782 ; (progn
783 ; (setq tmp (point))
787 "else"
789 "if"
793 ;(eq (match-end 0) tmp);
794 )
801 ;; Indent the line after the cleanups since it might
802 ;; very well indent differently due to them, e.g. if
803 ;; c-indent-one-line-block is used together with the
804 ;; one-liner-defun cleanup.
808 ;; does a newline go after the brace?
811 ))))
813 ;; blink the paren
816 old-blink-paren
823 "Insert a slash character.
825 If the slash is inserted immediately after the comment prefix in a c-style
826 comment, the comment might get closed by removing whitespace and possibly
829 Indent the line as a comment, if:
832 token and we are on a comment-only-line, or
835 comment.
837 If a numeric ARG is supplied, point is inside a literal, or
838 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
839 is inhibited."
842 indentp
843 ;; shut this up
846 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
847 ;; `c-syntactic-indentation' set.
854 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
865 c-syntactic-indentation
866 c-electric-flag
874 "Insert a star character.
875 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
876 the star is the second character of a C style comment starter on a
877 comment-only-line, indent the line as a comment. If a numeric ARG is
878 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
879 this indentation is inhibited."
883 ;; if we are in a literal, or if arg is given do not reindent the
884 ;; current line, unless this star introduces a comment-only line.
887 c-electric-flag
900 ))
903 "Insert a comma or semicolon.
905 If `c-electric-flag' is non-nil, point isn't inside a literal and a
906 numeric ARG hasn't been supplied, the command performs several electric
907 actions:
910 the mode line) a newline might be inserted. See the variable
911 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
913 \(b) Any auto-newlines are indented. The original line is also
914 reindented unless `c-syntactic-indentation' is nil.
916 \(c) If auto-newline is turned on, a comma following a brace list or a
917 semicolon following a defun might be cleaned up, depending on the
918 settings of `c-cleanup-list'."
922 ;; shut this up
932 ;; do all cleanups and newline insertions if c-auto-newline is on.
937 ;; clean ups: list-close-comma or defun-close-semi
950 ;; make sure matching open brace isn't in a comment
954 ;; reindent line
958 ;; check to see if a newline should be added
960 answer add-newline-p)
963 ;; only nil value means continue checking
967 ;; only 'stop specifically says do not add a newline
969 ))
972 )))))
975 "Insert a colon.
977 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
978 numeric ARG hasn't been supplied, the command performs several electric
979 actions:
982 the mode line) newlines are inserted before and after the colon based on
983 the settings in `c-hanging-colons-alist'.
985 \(b) Any auto-newlines are indented. The original line is also
986 reindented unless `c-syntactic-indentation' is nil.
988 \(c) If auto-newline is turned on, whitespace between two colons will be
990 `c-cleanup-list'."
995 newlines is-scope-op
996 ;; shut this up
999 ;; Any electric action?
1001 ;; Unless we're at EOL, only re-indentation happens.
1006 ;; scope-operator clean-up?
1024 ;; indent the current line if it's done syntactically.
1026 ;; Cannot use the same syntax analysis as we find below,
1027 ;; since that's made with c-syntactic-indentation-in-macros
1028 ;; always set to t.
1031 ;; Calculate where, if anywhere, we want newlines.
1035 ;; Turn on syntactic macro analysis to help with auto newlines
1036 ;; only.
1039 ;; Translate substatement-label to label for this operation.
1044 ;; some language elements can only be determined by checking
1045 ;; the following line. Let's first look for ones that can be
1046 ;; found when looking on the line with the colon
1050 syntax c-hanging-colons-alist)
1057 c-hanging-colons-alist)))))
1058 ;; does a newline go before the colon? Watch out for already
1059 ;; non-hung colons. However, we don't unhang them because that
1060 ;; would be a cleanup (and anti-social).
1070 ;; does a newline go after the colon?
1074 ))))
1078 If the current language uses angle bracket parens (e.g. template
1079 arguments in C++), try to find out if the inserted character is a
1080 paren and give it paren syntax if appropriate.
1082 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1083 line will be reindented if the inserted character is a paren or if it
1084 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1085 numeric argument is supplied, or the point is inside a literal."
1089 final-pos close-paren-inserted found-delim case-fold-search)
1094 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1095 ;;;; property on the new < or > and its mate (if any) when they are template
1096 ;;;; parens. This is now done in an after-change function.
1098 ;; Indent the line if appropriate.
1102 ;; If a <, basically see if it's got "template" before it .....
1110 ;; ..... or is a C++ << operator.
1118 ;; It's a >. Either a C++ >> operator. ......
1125 ;; ...., or search back for a < which isn't already marked as an
1126 ;; opening template delimiter.
1129 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1130 ;; our position.
1153 blink-paren-function)
1154 ;; Note: Most paren blink functions, such as the standard
1155 ;; `blink-matching-open', currently doesn't handle paren chars
1156 ;; marked with text properties very well. Maybe we should avoid
1157 ;; this call for the time being?
1161 "Insert a parenthesis.
1163 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1164 line is reindented unless a numeric ARG is supplied, or the parenthesis
1165 is inserted inside a literal.
1167 Whitespace between a function name and the parenthesis may get added or
1168 removed; see the variable `c-cleanup-list'.
1170 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1171 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1174 ;; shut this up
1176 case-fold-search)
1181 ;; be most disruptive. We'll blink it ourselves
1182 ;; afterwards.
1184 blink-paren-function)
1188 ;; If we're at EOL, check for new-line clean-ups.
1192 ;; clean up brace-elseif-brace
1199 "else"
1201 "if"
1203 "("
1205 nil t)
1210 ;; clean up brace-catch-brace
1217 "catch"
1219 "("
1221 nil t)
1226 ;; Check for clean-ups at function calls. These two DON'T need
1227 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1228 ;; Point is currently just after the inserted paren.
1232 ;; space-before-funcall clean-up?
1240 ;; Don't add a space into #define FOO()....
1249 ;; compact-empty-funcall clean-up?
1263 old-blink-paren
1267 "Reindent the current line if appropriate.
1269 This function is used to reindent the line after a keyword which
1273 The line is reindented if there is nothing but whitespace before the
1274 keyword on the line, the keyword is not inserted inside a literal, and
1275 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1280 c-syntactic-indentation
1287 ;; Have to temporarily insert a space so that
1288 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1289 ;; space with a nonspace to avoid messing up any whitespace
1290 ;; sensitive meddling that might be done, e.g. by
1291 ;; `c-backslash-region'.
1297 \f
1302 ;; "nomenclature" functions + c-scope-operator.
1304 "Compatibility alias for `c-forward-subword'."
1311 "Compatibility alias for `c-backward-subword'."
1318 "Insert a double colon scope operator at point.
1323 \f
1324 ;; Movement (etc.) by defuns.
1326 ;; Return non-nil if point is between the closing brace and the semicolon of
1327 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1328 ;; portion of a declaration like "struct foo {...} bar ;".
1329 ;;
1330 ;; Return the position of the main declaration. Otherwise, return nil.
1331 ;; Point is assumed to be at the top level and outside of any macro or
1332 ;; literal.
1333 ;;
1334 ;; If LIM is non-nil, it is the bound on a the backward search for the
1335 ;; beginning of the declaration.
1336 ;;
1337 ;; This function might do hidden buffer changes.
1342 bod)
1346 ;; Look for struct or union or ... If we find one, it might
1347 ;; be the return type of a function, or the like. Exclude
1348 ;; this case.
1351 c-opt-block-decls-with-vars-key
1353 eo-block t t t)
1358 bod)))))
1361 ;; Determine where we are with respect to functions (or other brace
1362 ;; constructs, included in the term "function" in the rest of this comment).
1363 ;; Point is assumed to be outside any macro or literal.
1364 ;; This is used by c-\(beginning\|end\)-of-defun.
1365 ;;
1366 ;; Return one of these symbols:
1367 ;; at-header : we're at the start of a function's header.
1368 ;; in-header : we're inside a function's header, this extending right
1369 ;; up to the brace. This bit includes any k&r declarations.
1370 ;; in-block : we're inside a function's brace block.
1371 ;; in-trailer : we're in the area between the "}" and ";" of something
1372 ;; like "struct foo {...} bar, baz;".
1373 ;; at-function-end : we're just after the closing brace (or semicolon) that
1374 ;; terminates the function.
1375 ;; outwith-function: we're not at or in any function. Being inside a
1376 ;; non-brace construct also counts as 'outwith-function'.
1377 ;;
1378 ;; This function might do hidden buffer changes.
1381 decl-result brace-decl-p
1398 ;; Find the start of the current declaration. NOTE: If we're in the
1399 ;; variables after a "struct/eval" type block, we don't get to the
1400 ;; real declaration here - we detect and correct for this later.
1402 ;;If we're in the parameters' parens, move back out of them.
1404 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1405 ;; at a declaration.
1413 ;; NOTE: If we're in a K&R region, this might be the start
1414 ;; of a parameter declaration, not the actual function.
1418 ;; Has the declaration we've gone back to got braces?
1424 ;; Might have stopped on the
1425 ;; ';' in a K&R argdecl. In
1426 ;; that case the declaration
1427 ;; should contain a block.
1436 'at-header
1442 'at-function-end
1445 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1446 decl-result))))))))
1449 ;; Skip to the opening brace of the Nth function before point. If
1450 ;; point is inside a function, this counts as the first. Point must be
1451 ;; outside any comment/string or macro.
1452 ;;
1453 ;; N must be strictly positive.
1454 ;; WHERE describes the position of point, one of the symbols `at-header',
1455 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1456 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1457 ;;
1458 ;; If we run out of functions, leave point at BOB. Return zero on success,
1459 ;; otherwise the number of {s still to go.
1460 ;;
1461 ;; This function may do hidden buffer changes
1463 ;; What we do to go back the first defun depends on where we start.
1479 ;; Each time round the loop, go back to a "{" at the outermost level.
1482 ; by a factor of ~6. Hmmm. 2006/4/5.
1487 n)
1490 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1491 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1492 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1493 ;; otherwise include the braces. If the closing brace is missing,
1494 ;; (point-max) is used instead.
1496 encl-decl)
1515 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1516 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1517 ;; braces NOT being included in the resulting region. On no account may the
1518 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1519 ;; PAREN-STATE is a list of buffer positions in the style of
1520 ;; (c-parse-state), one of which will be that of the desired opening brace,
1521 ;; if there is one.
1522 ;;
1523 ;; Return the position of the enclosing opening brace, or nil
1537 orig-point-max)))
1538 encl-decl)
1540 nil)))
1544 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1545 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1546 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1547 ;; buffer's original restriction.
1548 ;;
1549 ;; This is a very special purpose macro, which assumes the existence of
1550 ;; several variables. It is for use only in c-beginning-of-defun and
1551 ;; c-end-of-defun.
1555 lim)
1558 paren-state orig-point-min orig-point-max))
1562 "Move backward to the beginning of a defun.
1563 Every top level declaration that contains a brace paren block is
1564 considered to be a defun.
1566 With a positive argument, move backward that many defuns. A negative
1567 argument -N means move forward to the Nth following beginning. Return
1568 t unless search stops due to beginning or end of buffer.
1570 Unlike the built-in `beginning-of-defun' this tries to be smarter
1571 about finding the char with open-parenthesis syntax that starts the
1572 defun."
1586 ; structure with other users of c-state-cache.
1588 lim ; Position of { which has been widened to.
1589 where pos case-fold-search)
1594 paren-state orig-point-min orig-point-max)))
1596 ;; Move back out of any macro/comment/string we happen to be in.
1604 ;; Move forward to the closing brace of a function.
1611 ;; Move forward to the next opening brace....
1618 ;; ... and backward to the function header.
1620 t))
1622 ;; Move backward to the opening brace of a function, making successively
1623 ;; larger portions of the buffer visible as necessary.
1629 ;; Go backward to this function's header.
1633 ;; We're now there, modulo comments and whitespace.
1634 ;; Try to be line oriented; position point at the closest
1635 ;; preceding boi that isn't inside a comment, but if we hit
1636 ;; the previous declaration then we use the current point
1637 ;; instead.
1647 ;; Skip to the closing brace of the Nth function after point. If
1648 ;; point is inside a function, this counts as the first. Point must be
1649 ;; outside any comment/string or macro.
1650 ;;
1651 ;; N must be strictly positive.
1652 ;; WHERE describes the position of point, one of the symbols `at-header',
1653 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1654 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1655 ;;
1656 ;; If we run out of functions, leave point at EOB. Return zero on success,
1657 ;; otherwise the number of }s still to go.
1658 ;;
1659 ;; This function may do hidden buffer changes.
1662 ;; What we do to go forward over the first defun depends on where we
1663 ;; start. We go to the closing brace of that defun, even when we go
1664 ;; backwards to it (in a "struct foo {...} bar ;").
1680 ;; Each time round the loop, go forward to a "}" at the outermost level.
1682 ;(c-parse-state) ; This call speeds up the following one by a factor
1683 ; of ~6. Hmmm. 2006/4/5.
1688 n)
1691 "Move forward to the end of a top level declaration.
1692 With argument, do it that many times. Negative argument -N means move
1693 back to Nth preceding end. Returns t unless search stops due to
1694 beginning or end of buffer.
1696 An end of a defun occurs right after the close-parenthesis that matches
1697 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1710 ; structure with other users of c-state-cache.
1712 lim
1713 where pos case-fold-search)
1718 paren-state orig-point-min orig-point-max)))
1720 ;; Move back out of any macro/comment/string we happen to be in.
1728 ;; Move backwards to the } of a function
1740 ;; Move forward to the } of a function
1745 ;; Do we need to move forward from the brace to the semicolon?
1751 ;; We're there now, modulo comments and whitespace.
1752 ;; Try to be line oriented; position point after the next
1753 ;; newline that isn't inside a comment, but if we hit the
1754 ;; next declaration then we use the current point instead.
1768 "Return the name of the current defun, or NIL if there isn't one.
1770 with a brace block."
1774 where pos name-end case-fold-search)
1779 ;; Move back out of any macro/comment/string we happen to be in.
1786 ;; Move to the beginning of the current defun, if any, if we're not
1787 ;; already there.
1789 nil
1794 ;; Pick out the defun name, according to the type of defun.
1796 ;; struct, union, enum, or similar:
1808 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1809 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1825 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1826 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1829 ;; Objc selectors.
1841 ;; Normal function or initializer.
1853 ;; Return a cons of the beginning and end positions of the current
1854 ;; top level declaration or macro. If point is not inside any then
1855 ;; nil is returned, unless NEAR is non-nil in which case the closest
1856 ;; following one is chosen instead (if there is any). The end
1857 ;; position is at the next line, providing there is one before the
1858 ;; declaration.
1859 ;;
1860 ;; This function might do hidden buffer changes.
1868 ;; Note: Some code duplication in `c-beginning-of-defun' and
1869 ;; `c-end-of-defun'.
1873 lim pos end-pos)
1876 ;; If we moved to the outermost enclosing paren
1877 ;; then we can use c-safe-position to set the
1878 ;; limit. Can't do that otherwise since the
1879 ;; earlier paren pair on paren-state might very
1880 ;; well be part of the declaration we should go
1881 ;; to.
1883 t)
1884 ;; At top level. Make sure we aren't inside a literal.
1900 ;; We moved back over the previous defun. Skip to the next
1901 ;; one. Not using c-forward-syntactic-ws here since we
1902 ;; should not skip a macro. We can also be directly after
1903 ;; the block in a `c-opt-block-decls-with-vars-key'
1904 ;; declaration, but then we won't move significantly far
1905 ;; here.
1919 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1920 ;; declaration that doesn't end there. We're searching back and
1921 ;; forth over the block here, which can be expensive.
1933 nil
1937 nil
1939 ;; Try to be line oriented; position the limits at the
1940 ;; closest preceding boi, and after the next newline, that
1941 ;; isn't inside a comment, but if we hit a neighboring
1942 ;; declaration then we instead use the exact declaration
1943 ;; limit in that direction.
1949 pos
1965 pos))))))))
1973 "Put mark at end of the current top-level declaration or macro, point at beginning.
1974 If point is not inside any then the closest following one is
1975 chosen. Each successive call of this command extends the marked
1976 region by one function.
1978 A mark is left where the command started, unless the region is already active
1979 \(in Transient Mark mode).
1982 function does not require the declaration to contain a brace block."
1987 ;; We try to be line oriented, unless there are several
1988 ;; declarations on the same line.
2015 "Return the name of the current CPP macro, or NIL if we're not in one."
2024 \f
2025 ;; Movement by statements.
2027 ;; Point is within a comment. Is it also within a comment-prefix?
2028 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2029 ;;
2030 ;; This function might do hidden buffer changes.
2040 ;; Narrow to the "inside" of the comment (block) defined by range, as
2041 ;; follows:
2042 ;;
2043 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2044 ;; present) removed. A c++-style line comment retains its opening "//" but
2045 ;; has any final NL removed. If POINT is currently outwith these innards,
2046 ;; move it to the appropriate boundary.
2047 ;;
2048 ;; This narrowing simplifies the sentence movement functions, since it
2049 ;; eliminates awkward things at the boundaries of the comment (block).
2050 ;;
2051 ;; This function might do hidden buffer changes.
2069 ;; Move backwards to the "beginning of a sentence" within the comment
2070 ;; defined by RANGE, a cons of its starting and ending positions. If we
2071 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2072 ;; of the comment and return T.
2073 ;;
2074 ;; The BOS is either text which follows a regexp match of sentence-end,
2075 ;; or text which is a beginning of "paragraph".
2076 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2077 ;;
2078 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2079 ;; It is not a general function, but is intended only for calling from
2080 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2081 ;;
2082 ;; This function might do hidden buffer changes.
2088 last
2094 ;; First, find the previous paragraph start, if any.
2098 ; paragraph-\(start\|separate\)
2107 ;; Now seek successively earlier sentence ends between PAR-BEG and
2108 ;; HERE, until the "start of sentence" following it is earlier than
2109 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2127 nil
2129 t))))
2132 ;; Move forward to the "end of a sentence" within the comment defined by
2133 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2134 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2135 ;; return NIL. Otherwise, move point to just after the end of the comment
2136 ;; and return T.
2137 ;;
2138 ;; The EOS is just after the non-WS part of the next match of the regexp
2139 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2140 ;; no sentence-end match following point, any WS before the end of the
2141 ;; comment will count as EOS, providing we're not already in it.
2142 ;;
2143 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2144 ;; It is not a general function, but is intended only for calling from
2145 ;; c-move-over-sentence.
2146 ;;
2147 ;; This function might do hidden buffer changes.
2150 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2151 )
2157 ;; The cc-mode values of paragraph-\(start\|separate\), set
2158 ;; in c-setup-paragraph-variables, are used in the
2159 ;; following.
2168 last
2171 ;; Go forward one "comment-prefix which looks like sentence-end"
2172 ;; each time round the following:
2183 ;; Take special action if we're up against the end of a comment (of
2184 ;; either sort): Leave point just after the last non-ws text.
2191 nil
2193 t))))
2196 ;; Move backwards to the "beginning of a sentence" within the string defined
2197 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2198 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2199 ;; just before the start of the string and return T.
2200 ;;
2201 ;; The BOS is either the text which follows a regexp match of sentence-end
2202 ;; or text which is a beginning of "paragraph". For the purposes of
2203 ;; determining paragraph boundaries, escaped newlines are treated as
2204 ;; ordinary newlines.
2205 ;;
2206 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2207 ;; It is not a general function, but is intended only for calling from
2208 ;; c-move-over-sentence.
2209 ;;
2210 ;; This function might do hidden buffer changes.
2216 ;; Enhance paragraph-start and paragraph-separate also to recognize
2217 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2218 ;; these values should be customizable user options, or something.
2227 ; paragraph-\(start\|separate\)
2235 ;; Now see if we can find a sentence end after PAR-BEG.
2243 ; than here, in case point starts
2244 ; beyond the closing quote.
2249 nil
2251 t))))
2254 ;; Move forward to the "end of a sentence" within the string defined by
2255 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2256 ;; return NIL. Otherwise, move point to just after the end of the string
2257 ;; and return T.
2258 ;;
2259 ;; The EOS is just after the non-WS part of the next match of the regexp
2260 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2261 ;; no sentence-end match following point, any WS before the end of the
2262 ;; string will count as EOS, providing we're not already in it.
2263 ;;
2264 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2265 ;; It is not a general function, but is intended only for calling from
2266 ;; c-move-over-sentence.
2267 ;;
2268 ;; This function might do hidden buffer changes.
2271 last
2272 ;; Enhance paragraph-start and paragraph-separate to recognize
2273 ;; blank lines terminated by escaped EOLs.
2281 ;; The above values of paragraph-\(start\|separate\) are used
2282 ;; in the following.
2285 ;; (re-search-backward filler-here nil t) would find an empty
2286 ;; string. Therefore we simulate it by the following:
2295 ;; Try to go forward a sentence.
2300 ;; Did we move a sentence, or did we hit the end of the string?
2302 nil
2304 t))))
2307 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2308 ;; If a literal is the next thing (aside from whitespace) to be found before
2309 ;; point, return a cons of its start.end positions (enclosing the
2310 ;; delimiters). Otherwise return NIL.
2311 ;;
2312 ;; This function might do hidden buffer changes.
2316 pos)
2320 ;; to prevent `looking-at' seeing a " at point.
2324 ;; An EOL can act as an "open string" terminator in AWK.
2335 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2336 ;; If a literal is the next thing (aside from whitespace) following point,
2337 ;; return a cons of its start.end positions (enclosing the delimiters).
2338 ;; Otherwise return NIL.
2339 ;;
2340 ;; This function might do hidden buffer changes.
2353 ;; Does point immediately follow a statement "terminator"? A virtual
2354 ;; semicolon is regarded here as such. So is an opening brace ;-)
2355 ;;
2356 ;; This function might do hidden buffer changes.
2364 ;; The following (for macros) is not strict about exactly where we are
2365 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2366 ;; much. ACM 2004/3/29.
2378 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2379 ;; stopping before reaching BOB or a literal or the boundary of a
2380 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2381 ;; the position of the '#' beginning the current preprocessor directive, or
2382 ;; NIL if we're not in such.
2383 ;;
2384 ;; Return a cons (A.B), where
2385 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2386 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2387 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2388 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2389 ;;
2390 ;; The total collection of returned values is as follows:
2391 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2392 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2393 ;; a BOS - the caller must check this.
2394 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2395 ;; moved and reached the opening # of the macro.
2396 ;; (t . macro-boundary): Every other circumstance in which we're at a
2397 ;; macro-boundary. We might be at a BOS.
2398 ;;
2399 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2400 ;; code before encountering the literal/BOB or macro-boundary.
2401 ;;
2402 ;; Note that this function moves within either preprocessor commands
2403 ;; (macros) or normal code, but will not cross a boundary between the two,
2404 ;; or between two distinct preprocessor commands.
2405 ;;
2406 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2407 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2408 ;; move into parens. Also stop before `#' when it's at boi on a line.
2409 ;;
2410 ;; This function might do hidden buffer changes.
2414 ; semicolon precedes it.
2419 ;; Stop at the token after a comment.
2424 ;; If we've gone back over a LF, we might have moved into or out of
2425 ;; a preprocessor line.
2433 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2438 ;; Have we found a virtual semicolon? If so, stop, unless the next
2439 ;; statement is where we started from.
2446 ;; Hit the beginning of the buffer/region?
2452 ;; Move back a character.
2455 ;; Stop at "{" (unless it's a PIKE special brace list.)
2464 ;; Have we reached the start of a macro? This always counts as
2465 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2466 ;; here. FIXME!!! ACM 2004/3/29)
2470 ;; Stop at token just after "}" or ";".
2472 ;; If we've gone back over ;, {, or }, we're done.
2481 ;; Stop at the token after a string.
2486 ;; Nothing special: go back word characters.
2488 ))))))
2491 ;; Move forwards over code, stopping before reaching EOB or a literal
2492 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2493 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2494 ;; terminates the current preprocessor directive, or NIL if we're not in
2495 ;; such.
2496 ;;
2497 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2498 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2499 ;; seems unavoidable. Depending on the context this function is called
2500 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2501 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2502 ;; semicolons, or anything else.
2503 ;;
2504 ;; Return a cons (A.B), where
2505 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2506 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2507 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2508 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2509 ;;
2510 ;; Point is left either after the end-of-statement, or at the last non-ws
2511 ;; code before encountering the literal, or the # of the preprocessor
2512 ;; statement, or at EOB [or just after last non-WS stuff??].
2513 ;;
2514 ;; As a clarification of "after the end-of-statement", if a comment or
2515 ;; whitespace follows a completed AWK statement, that statement is treated
2516 ;; as ending just after the last non-ws character before the comment.
2517 ;;
2518 ;; Note that this function moves within either preprocessor commands
2519 ;; (macros) or normal code, but not both within the same invocation.
2520 ;;
2521 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2522 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2523 ;; stop before `{' if at top level or inside braces, though. Move by
2524 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2525 ;; the boi.
2526 ;;
2527 ;; This function might do hidden buffer changes.
2529 last)
2534 ;; If we've moved forward to a virtual semicolon, we're done.
2541 ;; Gone past the end of a macro?
2546 ;; About to hit a comment?
2551 ;; End of buffer?
2557 ;; If we encounter a '{', stop just after the previous token.
2563 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2564 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2565 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2566 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2572 ;; End of a PIKE special brace list? If so, step over it and continue.
2581 ;; Have we got a '}' after having moved? If so, stop after the
2582 ;; previous token.
2588 ;; Stop if we encounter a preprocessor line. Continue if we
2589 ;; hit a naked #
2598 ;; Stop after a ';', '}', or "};"
2603 ;; Found a string (this subsumes AWK regexps)?
2614 )))))
2617 ;; Is the literal defined by RANGE a string contained in a single line?
2618 ;;
2619 ;; This function might do hidden buffer changes.
2627 "Go to the beginning of the innermost C statement.
2628 With prefix arg, go back N - 1 statements. If already at the
2629 beginning of a statement then go to the beginning of the closest
2630 preceding one, moving into nested blocks if necessary (use
2632 comment or multiline string, move by sentences instead of statements.
2634 When called from a program, this function takes 3 optional args: the
2635 repetition count, a buffer position limit which is the farthest back
2636 to search for the syntactic context, and a flag saying whether to do
2637 sentence motion in or near comments and multiline strings.
2639 Note that for use in programs, `c-beginning-of-statement-1' is
2640 usually better. It has much better defined semantics than this one,
2641 which is intended for interactive use, and might therefore change to
2644 nil t))
2649 last ; start point for going back ONE chunk. Updated each chunk movement.
2652 res ; result from sub-function call
2653 not-bos ; "not beginning-of-statement"
2654 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2656 ;; Go back one statement at each iteration of the following loop.
2659 ;; Go back one "chunk" each time round the following loop, stopping
2660 ;; when we reach a statement boundary, etc.
2664 ; statement boundary, non-NIL otherwise.
2667 nil)
2671 ;; Single line string or sentence-flag is null => skip the
2672 ;; entire literal.
2677 ;; N.B. The following is essentially testing for an AWK regexp
2678 ;; at BOS:
2679 ;; Was the previous non-ws thing an end of statement?
2686 ;; Comment inside a statement or a multi-line string.
2692 res)))
2694 ;; Non-literal code.
2701 ;; We're at a tentative BOS. The next form goes
2702 ;; back over WS looking for an end of previous
2703 ;; statement.
2709 ;; Are we about to move backwards into or out of a
2710 ;; preprocessor command? If so, locate its beginning.
2718 ;; Are we about to move backwards into a literal?
2721 not-bos))
2728 "Go to the end of the innermost C statement.
2729 With prefix arg, go forward N - 1 statements. Move forward to the end
2730 of the next statement if already at end, and move into nested blocks
2732 comment or multiline string, move by sentences instead of statements.
2734 When called from a program, this function takes 3 optional args: the
2735 repetition count, a buffer position limit which is the farthest back
2736 to search for the syntactic context, and a flag saying whether to do
2737 sentence motion in or near comments and multiline strings."
2739 nil t))
2749 res
2750 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2752 ;; Go back/forward one statement at each iteration of the following loop.
2757 ;; Go forward one "chunk" each time round the following loop, stopping
2758 ;; when we reach a statement boundary, etc.
2761 ; statement boundary, non-NIL otherwise.
2764 nil)
2768 ;; sentence-flag is null => skip the entire literal.
2769 ;; or a Single line string.
2774 ;; Is there a virtual semicolon here (e.g. for AWK)?
2777 ;; Comment or multi-line string.
2783 ;; If we've just come forward out of a literal, check for
2784 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2785 ;; some other language may do in the future)
2789 ;; Non-literal code.
2792 ;; Are we about to move forward into or out of a
2793 ;; preprocessor command?
2808 ;; Are we about to move forward into a literal?
2816 \f
2817 ;; set up electric character functions to work with pending-del,
2818 ;; (a.k.a. delsel) mode. All symbols get the t value except
2819 ;; the functions which delete, which gets 'supersede.
2826 c-electric-brace
2827 c-electric-slash
2828 c-electric-star
2829 c-electric-semi&comma
2830 c-electric-lt-gt
2831 c-electric-colon
2832 c-electric-paren))
2840 \f
2841 ;; Inserting/indenting comments
2843 ;; This function might do hidden buffer changes.
2856 ;; Do not pad with one space if we're at bol.
2857 value
2868 ;; Found comment to align with.
2870 ;; Do not pad with one space if we're at bol.
2871 0
2873 ;; Recurse to handle value as a new spec.
2877 "Used by `indent-for-comment' to create and indent comments.
2878 See `c-indent-comment-alist' for a description."
2906 case-fold-search)
2908 c-indent-comments-syntactically-p)
2910 ;; BOGOSITY ALERT: if we're looking at the eol, its
2911 ;; because indent-for-comment hasn't put the comment-start
2912 ;; in the buffer yet. this will screw up the syntactic
2913 ;; analysis so we kludge in the necessary info. Another
2914 ;; kludge is that if we're at the bol, then we really want
2915 ;; to ignore any anchoring as specified by
2916 ;; c-comment-only-line-offset since it doesn't apply here.
2921 c-comment-only-line-offset
2923 c-comment-only-line-offset))))
2928 \f
2929 ;; used by outline-minor-mode
2932 ;; in otherwise-hidden text.
2937 \f
2938 ;; Movement by CPP conditionals.
2940 "Move back to the containing preprocessor conditional, leaving mark behind.
2941 A prefix argument acts as a repeat count. With a negative argument,
2942 move forward to the end of the containing preprocessor conditional.
2945 function stops at them when going backward, but not when going
2946 forward."
2956 directives."
2964 "Move forward into the next preprocessor conditional, leaving mark behind.
2965 A prefix argument acts as a repeat count. With a negative argument,
2966 move backward into the previous preprocessor conditional.
2969 function stops at them when going forward, but not when going
2970 backward."
2980 directives."
2988 "Move back across a preprocessor conditional, leaving mark behind.
2989 A prefix argument acts as a repeat count. With a negative argument,
2990 move forward across a preprocessor conditional.
2992 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2993 and have the same meanings as in `c-scan-conditionals'. If you
2994 are calling c-forward-conditional from a program, you might want
2995 to call `c-scan-conditionals' directly instead."
3003 "Move forward across a preprocessor conditional, leaving mark behind.
3004 A prefix argument acts as a repeat count. With a negative argument,
3005 move backward across a preprocessor conditional.
3007 If there aren't enough conditionals after \(or before) point, an
3008 error is signaled.
3011 the nesting level isn't changed when tracking subconditionals.
3013 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3014 and have the same meanings as in `c-scan-conditionals'. If you
3015 are calling c-forward-conditional from a program, you might want
3016 to call `c-scan-conditionals' directly instead."
3023 "Scan forward across COUNT preprocessor conditionals.
3024 With a negative argument, scan backward across preprocessor
3025 conditionals. Return the end position. Point is not moved.
3027 If there aren't enough preprocessor conditionals, throw an error.
3030 the nesting level isn't changed when tracking subconditionals.
3032 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3033 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3034 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3035 counts as -1.
3038 are treated as conditional clause limits. Normally they are ignored."
3042 new case-fold-search)
3048 ;; subdepth is the depth in "uninteresting" subtrees,
3049 ;; i.e. those that takes us farther from the target
3050 ;; depth instead of closer.
3052 found)
3054 ;; Find the "next" significant line in the proper direction.
3056 ;; Rather than searching for a # sign that
3057 ;; comes at the beginning of a line aside from
3058 ;; whitespace, search first for a string
3059 ;; starting with # sign. Then verify what
3060 ;; precedes it. This is faster on account of
3061 ;; the fastmap feature of the regexp matcher.
3064 nil t))
3066 ;; Now verify it is really a preproc line.
3074 ;; When we're not in an "uninteresting"
3075 ;; subtree, we might want to act on "elif"
3076 ;; and "else" too.
3078 ;; Always move toward the target depth.
3083 ;; Ignore the change if it'd take us
3084 ;; into an "uninteresting" subtree.
3092 ;; If we are trying to move across, and we find an
3093 ;; end before we find a beginning, get an error.
3096 "No following conditional at this level"
3098 ;; When searching forward, start from next line so
3099 ;; that we don't find the same line again.
3101 ;; We found something if we've arrived at the
3102 ;; target depth.
3105 ;; else
3112 new))
3114 \f
3115 ;; commands to indent lines, regions, defuns, and expressions
3117 "Indent current line as C code, and/or insert some whitespace.
3119 If `c-tab-always-indent' is t, always just indent the current line.
3120 If nil, indent the current line only if point is at the left margin or
3121 in the line's indentation; otherwise insert some whitespace[*]. If
3122 other than nil or t, then some whitespace[*] is inserted only within
3123 literals (comments and strings), but the line is always reindented.
3125 If `c-syntactic-indentation' is t, indentation is done according to
3126 the syntactic context. A numeric argument, regardless of its value,
3127 means indent rigidly all the lines of the expression starting after
3128 point so that this line becomes properly indented. The relative
3129 indentation among the lines of the expression is preserved.
3131 If `c-syntactic-indentation' is nil, the line is just indented one
3132 step according to `c-basic-offset'. In this mode, a numeric argument
3133 indents a number of such steps, positive or negative, and an empty
3134 prefix argument is equivalent to -1.
3136 [*] The amount and kind of whitespace inserted is controlled by the
3137 variable `c-insert-tab-function', which is called to do the actual
3138 insertion of whitespace. Normally the function in this variable
3139 just inserts a tab character, or the equivalent number of spaces,
3140 depending on the variable `indent-tabs-mode'."
3149 -1
3157 ;; Realign the line continuation backslash if inside a macro.
3159 ))))
3161 ;; If c-syntactic-indentation and got arg, always indent this
3162 ;; line as C and shift remaining lines of expression the same
3163 ;; amount.
3167 beg end)
3172 shift-amt))
3184 ;; Else use c-tab-always-indent to determine behavior.
3186 ;; CASE 1: indent when at column zero or in line's indentation,
3187 ;; otherwise insert a tab
3194 ;; CASE 2: just indent the line
3197 ;; CASE 3: if in a literal, insert a tab, but always indent the
3198 ;; line
3203 )))))
3206 "Indent each line in the balanced expression following point syntactically.
3207 If optional SHUTUP-P is non-nil, no errors are signaled if no
3208 balanced expression is found."
3211 end)
3215 ;; Find the closest following open paren that
3216 ;; ends on another line.
3224 ;; sanity check
3240 "Indent the current top-level declaration or macro syntactically.
3241 In the macro case this also has the effect of realigning any line
3242 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3248 ;; We try to be line oriented, unless there are several
3249 ;; declarations on the same line.
3261 "Indent syntactically every line whose first char is between START
3262 and END inclusive. If the optional argument QUIET is non-nil then no
3263 syntactic errors are reported, even if `c-report-syntactic-errors' is
3264 non-nil."
3270 ;; Advance to first nonblank line.
3278 ;; shut up any echo msgs on indiv lines
3284 start))
3286 syntax)
3294 ;; update progress
3296 ;; skip empty lines
3299 ;; Get syntax and indent.
3305 ;; End of current multi-line macro?
3308 ;; Fixup macro backslashes.
3311 ;; New multi-line macro?
3323 c-parsing-error))))
3326 ;; Function version of the macro for use in places that aren't
3327 ;; compiled, e.g. in the menus.
3331 "Indent active region, current line, or block starting on this line.
3332 In Transient Mark mode, when the region is active, reindent the region.
3333 Otherwise, with a prefix argument, rigidly reindent the expression
3334 starting on the current line.
3335 Otherwise reindent just the current line."
3341 \f
3342 ;; for progress reporting
3347 ;; Be silent
3349 ;; Start the progress update messages. If this Emacs doesn't have
3350 ;; a built-in timer, just be dumb about it.
3353 ;; If progress has already been initialized, do nothing. otherwise
3354 ;; initialize the counter with a vector of:
3355 ;; [start end lastsec context]
3362 context))
3364 ))
3368 nil
3373 ;; should we update? currently, update happens every 2 seconds,
3374 ;; what's the right value?
3380 )))
3384 nil
3393 \f
3394 ;;; This page handles insertion and removal of backslashes for C macros.
3397 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3398 With no argument, inserts backslashes and aligns existing backslashes.
3399 With an argument, deletes the backslashes. The backslash alignment is
3400 done according to the settings in `c-backslash-column',
3401 `c-backslash-max-column' and `c-auto-align-backslashes'.
3403 This function does not modify blank lines at the start of the region.
3404 If the region ends at the start of a line and the macro doesn't
3405 continue below it, the backslash (if any) at the end of the previous
3406 line is deleted.
3408 You can put the region around an entire macro definition and use this
3409 command to conveniently insert and align the necessary backslashes."
3412 ;; Keep the backslash trimming functions from changing the
3413 ;; whitespace around point, since in this case it's only the
3414 ;; position of point that tells the indentation of the line.
3420 column longest-line-col bs-col-after-end)
3424 ;; Nothing to do if to is at bob, since we should back up
3425 ;; and there's no line to back up to.
3426 nil
3428 ;; Do not back up the to line if line-mode is set, to make
3429 ;; e.g. c-newline-and-indent consistent regardless whether
3430 ;; the (newline) call leaves point at bol or not.
3438 ;; Set bs-col-after-end to the column of any backslash
3439 ;; following the region, or nil if there is none.
3448 ;; Back up the to line if line-mode is set, since the line
3449 ;; after the newly inserted line break should not be
3450 ;; touched in c-newline-and-indent.
3453 ;; Set bs-col-after-end to non-nil in any case, since we
3454 ;; do not want to delete the backslash at the last line.
3459 ;; Compute the smallest column number past the ends of all
3460 ;; the lines.
3464 ;; Include one more line in the max column
3465 ;; calculation, since the to line will be backslashed
3466 ;; too.
3479 ;; Try to align with surrounding backslashes.
3488 ;; Both a preceding and a following backslash.
3489 ;; Choose the greatest of them.
3492 ;; No preceding backslash. Try to align with one
3493 ;; following the region. Disregard the backslash at the
3494 ;; to line since it's likely to be bogus (e.g. when
3495 ;; called from c-newline-and-indent).
3498 ;; Don't modify blank lines at start of region.
3503 ;; Don't try to align with surrounding backslashes if
3504 ;; any line is too long.
3507 ;; Impose minimum limit and tab width alignment only if
3508 ;; we can't align with surrounding backslashes.
3512 tab-width)
3513 tab-width)))
3515 longest-line-col)))
3516 ;; Always impose maximum limit.
3519 ;; Add backslashes on all lines if the macro continues
3520 ;; after the to line.
3524 ;; Add backslashes on all lines except the last, and
3525 ;; remove any on the last line.
3533 ;; The function above leaves point on the line
3534 ;; following endmark.
3559 ;; Avoid unnecessary changes of the buffer.
3561 ;; Don't realign backslashes in string literals
3562 ;; since that would change them.
3563 )
3589 ;; Make sure there are backslashes with at least one space in
3590 ;; front of them.
3625 point-pos))
3631 \f
3632 ;;; Line breaking and paragraph filling.
3638 ;; The filling code is based on a simple theory; leave the intricacies
3639 ;; of the text handling to the currently active mode for that
3640 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3641 ;; possible to make them work correctly wrt the comment and string
3642 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3643 ;; to it, there's quite a lot of special cases to handle which makes
3644 ;; the code anything but simple. The intention is that it will work
3645 ;; with any well-written text filling package that preserves a fill
3646 ;; prefix.
3647 ;;
3648 ;; We temporarily mask comment starters and enders as necessary for
3649 ;; the filling code to do its job on a seemingly normal text block.
3650 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3651 ;; preserve it correctly (especially important when filling C++ style
3652 ;; line comments). By default, we set up and use adaptive-fill-mode,
3653 ;; which is standard in all supported Emacs flavors.
3656 ;; Determine the appropriate comment fill prefix for a block or line
3657 ;; comment. Return a cons of the prefix string and the column where
3658 ;; it ends. If fill-prefix is set, it'll override. Note that this
3659 ;; function also uses the value of point in some heuristics.
3660 ;;
3661 ;; This function might do hidden buffer changes.
3665 c-current-comment-prefix
3668 prefix-regexp
3669 comment-start-skip))
3670 prefix-line comment-prefix res comment-text-end)
3675 ;; Ugly way of getting the column after the fill
3676 ;; prefix; it'd be nice with a current-column
3677 ;; that works on strings..
3687 ;; Set fallback for comment-prefix if none is found.
3693 ;; The current line is not the comment starter, so the
3694 ;; comment has more than one line, and it can therefore be
3695 ;; used to find the comment fill prefix.
3701 ;; The line after the comment starter is inside the
3702 ;; comment, so we can use it.
3705 ;; The comment is only one line. Take the comment prefix
3706 ;; from it and keep the indentation.
3715 ;; There is only whitespace before the comment
3716 ;; starter; take the prefix straight from this line.
3721 ;; There is code before the comment starter, so we
3722 ;; have to temporarily insert and indent a new line to
3723 ;; get the right space/tab mix in the indentation.
3725 tmp)
3741 ;; The prefix ends the line with no whitespace
3742 ;; after it. Default to a single space.
3744 )))))
3757 ;; The current line is not the comment starter and
3758 ;; contains more than just the ender, so it's good enough
3759 ;; to be used for the comment fill prefix.
3769 ;; The comment is either one line or the next line contains
3770 ;; just the comment ender. In this case we have no
3771 ;; information about a suitable comment prefix, so we resort
3772 ;; to c-block-comment-prefix.
3776 ;; The point was on the comment opener line, so we might want
3777 ;; to treat this as a not yet closed comment.
3781 ;; Above `prefix-regexp' matched a nonempty prefix on the
3782 ;; second line, so let's use it. Normally it should do
3783 ;; to set `prefix-line' and let the code below pick up
3784 ;; the whole prefix, but if there's no text after the
3785 ;; match then it will probably fall back to no prefix at
3786 ;; all if the comment isn't closed yet, so in that case
3787 ;; it's better to force use of the prefix matched now.
3792 ;; There's no nonempty prefix on the line after the
3793 ;; comment opener. If the line is empty, or if the
3794 ;; text on it has less or equal indentation than the
3795 ;; comment starter we assume it's an unclosed
3796 ;; comment starter, i.e. that
3797 ;; `c-block-comment-prefix' should be used.
3798 ;; Otherwise we assume it's a closed comment where
3799 ;; the prefix really is the empty string.
3800 ;; E.g. this is an unclosed comment:
3801 ;;
3802 ;; /*
3803 ;; foo
3804 ;;
3805 ;; But this is not:
3806 ;;
3807 ;; /*
3808 ;; foo
3809 ;; */
3810 ;;
3811 ;; (Looking for the presence of the comment closer
3812 ;; rarely works since it's probably the closer of
3813 ;; some comment further down when the comment
3814 ;; really is unclosed.)
3823 ;; Otherwise the line after the comment starter is good
3824 ;; enough to find the prefix in.
3828 ;; Haven't got the comment prefix on any real line that we
3829 ;; can take it from, so we have to temporarily insert
3830 ;; `comment-prefix' on a line and indent it to find the
3831 ;; correct column and the correct mix of tabs and spaces.
3840 comment-text-end))
3845 ;; If there's ws on the current line, we'll use it
3846 ;; instead of what's ending comment-prefix.
3851 comment-prefix))
3860 ;; We insert an extra non-whitespace character
3861 ;; before the line break and after comment-prefix in
3862 ;; case it's "" or ends with whitespace.
3881 ;; prefix-line is the bol of a line on which we should try
3882 ;; to find the prefix.
3889 ;; The match is fine if there's text after it.
3895 ;; This match is better than nothing, so let's
3896 ;; remember it in case nothing better is found
3897 ;; on another line.
3901 t))))
3904 ;; Search for a line which has text after the prefix
3905 ;; so that we get the proper amount of whitespace
3906 ;; after it. We start with the current line, then
3907 ;; search backwards, then forwards.
3912 ;; The whitespace is sucked up by the
3913 ;; first [ \t]* glob if the prefix is empty.
3916 ;; If the current line doesn't have text but do
3917 ;; have whitespace after the prefix, we'll use it.
3923 ;; For line comments we can search up to and
3924 ;; including the first line.
3928 ;; For block comments we must stop before the
3929 ;; block starter.
3940 nil)
3943 ;; A good line wasn't found, but at least we have a
3944 ;; fallback that matches the comment prefix regexp.
3949 ;; There are ws or text after the prefix, so
3950 ;; let's use it.
3954 ;; Check if there's any whitespace padding
3955 ;; on the comment start line that we can
3956 ;; use after the prefix.
3974 ;; Got to mess in the buffer once again to
3975 ;; ensure the column gets correct. :P
3986 ;; Last resort: Just add a single space after
3987 ;; the prefix.
3992 ;; The line doesn't match the comment prefix regexp.
3994 ;; We have a fallback for line comments that we must use.
3997 comment-prefix)
4001 ;; Assume we are dealing with a "free text" block
4002 ;; comment where the lines doesn't have any comment
4003 ;; prefix at all and we should just fill it as
4004 ;; normal text.
4006 ))
4009 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4010 ;; masked to allow adaptive filling to work correctly. That
4011 ;; includes narrowing the buffer and, if point is inside a comment,
4012 ;; masking the comment starter and ender appropriately.
4013 ;;
4014 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4015 ;; The position of point is then less significant when doing masking
4016 ;; and narrowing.
4017 ;;
4018 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4019 ;; only if the point turns out to be inside a comment or a string.
4020 ;;
4021 ;; Note that this function does not do any hidden buffer changes.
4024 ;; beg and end limit the region to narrow. end is a marker.
4025 beg end
4026 ;; tmp-pre and tmp-post mark strings that are temporarily
4027 ;; inserted at the start and end of the region. tmp-pre is a
4028 ;; cons of the positions of the prepended string. tmp-post is
4029 ;; a marker pointing to the single character of the appended
4030 ;; string.
4031 tmp-pre tmp-post
4032 ;; If hang-ender-stuck isn't nil, the comment ender is
4033 ;; hanging. In that case it's set to the number of spaces
4034 ;; that should be between the text and the ender.
4035 hang-ender-stuck
4036 ;; auto-fill-spaces is the exact sequence of whitespace between a
4037 ;; comment's last word and the comment ender, temporarily replaced
4038 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4039 auto-fill-spaces
4044 ;; Restore point on undo. It's necessary since we do a lot of
4045 ;; hidden inserts and deletes below that should be as transparent
4046 ;; as possible.
4050 ;; Determine the limits and type of the containing literal (if any):
4051 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4052 ;; BEG and END.
4055 ;; Widen to catch comment limits correctly.
4080 ;; For each of the possible types of text (string, C comment ...)
4081 ;; determine BEG and END, the region we will narrow to. If we're in
4082 ;; a literal, constrain BEG and END to the limits of this literal.
4083 ;;
4084 ;; For some of these text types, particularly a block comment, we
4085 ;; may need to massage whitespace near literal delimiters, so that
4086 ;; these don't get filled inappropriately.
4091 ;; Limit to the comment or paragraph end, whichever
4092 ;; comes first.
4096 ;; The region includes the comment starter, so we must
4097 ;; check it.
4101 ;; Include the first line in the region.
4103 ;; The first line contains code before the
4104 ;; comment. We must fake a line that doesn't.
4115 ;; disallow "/*/"
4117 ;; There is a comment ender, and the region includes it. If
4118 ;; it's on its own line, it stays on its own line. If it's got
4119 ;; company on the line, it keeps (at least one word of) it.
4120 ;; "=====*/" counts as a comment ender here, but "===== */"
4121 ;; doesn't and "foo*/" doesn't.
4126 ;; The following conjunct was added to avoid an
4127 ;; "Invalid search bound (wrong side of point)"
4128 ;; error in the subsequent re-search. Maybe
4129 ;; another fix would be needed (2007-12-08).
4130 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4131 ; 2010-10-17 Construct removed.
4132 ; (or (< (- (cdr c-lit-limits) 2) (point))
4140 ;; The comment ender IS on its own line. Exclude this
4141 ;; line from the filling.
4144 ;; The comment ender is hanging. Replace all space between it
4145 ;; and the last word either by one or two 'x's (when
4146 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4147 ;; as the whitespace (when auto filling), and include it in
4148 ;; the region. We'll change them back to whitespace
4149 ;; afterwards. The effect of this is to glue the comment
4150 ;; ender to the last word in the comment during filling.
4167 spaces)
4170 ;; Insert a CR after the "*/", adjust END
4178 c-current-comment-prefix
4181 ;; The comment ender is prefixed by nothing but a
4182 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4183 ;; 2006/4/28). Remove it along with surrounding ws.
4187 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4189 ;; What's being tested here? 2006/4/20. FIXME!!!
4193 ;; Don't adjust point below if it's
4194 ;; before the string we replace.
4196 ;; Keep one or two spaces between the
4197 ;; text and the ender, depending on how
4198 ;; many there are now.
4203 ;; paragraph filling condenses multiple spaces to
4204 ;; single or double spaces. auto-fill doesn't.
4210 sentence-end-double-space)
4213 ;; Insert the filler first to keep marks right.
4222 ;; Point was in the middle of the string we
4223 ;; replaced above, so put it back in the same
4224 ;; relative position, counting from the end.
4226 ))
4229 ;; The region includes the comment starter.
4233 ;; Begin with the next line.
4235 ;; Fake the fill prefix in the first line.
4250 ;; Leave the start line if it's
4251 ;; nothing but an escaped newline.
4257 ;; Narrow to the macro limits if they are nearer than the
4258 ;; paragraph limits. Don't know if this is necessary but
4259 ;; do it for completeness sake (doing auto filling at all
4260 ;; inside macros is bogus to begin with since the line
4261 ;; continuation backslashes aren't handled).
4274 ;; Try to avoid comments and macros in the paragraph to
4275 ;; avoid that the adaptive fill mode gets the prefix from
4276 ;; them.
4289 ;; Temporarily insert the fill prefix after the comment
4290 ;; starter so that the first line looks like any other
4291 ;; comment line in the narrowed region.
4295 c-current-comment-prefix
4298 ;; Oops, the prefix doesn't match the comment prefix
4299 ;; regexp. This could produce very confusing
4300 ;; results with adaptive fill packages together with
4301 ;; the insert prefix magic below, since the prefix
4302 ;; often doesn't appear at all. So let's warn about
4303 ;; it.
4305 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4307 ;; Find the right spot on the line, break it, insert
4308 ;; the fill prefix and make sure we're back in the
4309 ;; same column by temporarily prefixing the first word
4310 ;; with a number of 'x'.
4314 c-current-comment-prefix
4315 comment-start-skip))
4332 ;; `apply-outside-literal' is always set to t here if
4333 ;; we're inside a literal.
4337 ;; Kludge: If the function that adapts the fill prefix
4338 ;; doesn't produce the required comment starter for
4339 ;; line comments, then force it by setting fill-prefix.
4341 ;; Kludge the kludge: filladapt-mode doesn't
4342 ;; have this problem, but it currently
4343 ;; doesn't override fill-context-prefix
4344 ;; (version 2.12).
4346 filladapt-mode))
4353 c-lit-limits c-lit-type)))))))
4355 ;; Save the relative position of point if it's outside the
4356 ;; region we're going to narrow. Want to restore it in that
4357 ;; case, but otherwise it should be moved according to the
4358 ;; called function.
4362 ;; Preparations finally done! Now we can call the
4363 ;; actual function.
4369 ;; Restore point if it was outside the region.
4382 ;; Preserve point even if it's in the middle of the string
4383 ;; we replace; save-excursion doesn't work in that case.
4399 If any of the current line is a comment or within a comment, fill the
4400 comment or the paragraph of it that point is in, preserving the
4401 comment indentation or line-starting decorations (see the
4402 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4403 details).
4405 If point is inside multiline string literal, fill it. This currently
4406 does not respect escaped newlines, except for the special case when it
4407 is the very first thing in the string. The intended use for this rule
4408 is in situations like the following:
4411 A very long description of something that you want to fill to make
4414 If point is in any other situation, i.e. in normal code, do nothing.
4416 Optional prefix ARG means justify paragraph as well."
4419 ;; Avoid infinite recursion.
4421 fill-paragraph-function)))
4423 ;; Always return t. This has the effect that if filling isn't done
4424 ;; above, it isn't done at all, and it's therefore effectively
4425 ;; disabled in normal code.
4426 t)
4429 ;; Do automatic filling if not inside a context where it should be
4430 ;; ignored.
4432 ;; The decision whether the line should be broken is actually
4433 ;; done in c-indent-new-comment-line, which do-auto-fill
4434 ;; calls to break lines. We just set this special variable
4435 ;; so that we'll know when we're called from there. It's
4436 ;; also used to detect whether fill-prefix is user set or
4437 ;; generated automatically by do-auto-fill.
4438 fill-prefix))
4442 "Break line at point and indent, continuing comment or macro if within one.
4443 If inside a comment and `comment-multi-line' is non-nil, the
4444 indentation and line prefix are preserved (see the
4445 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4446 details). If inside a single line comment and `comment-multi-line' is
4447 nil, a new comment of the same type is started on the next line and
4448 indented as appropriate for comments. If inside a macro, a line
4449 continuation backslash is inserted and aligned as appropriate, and the
4450 new line is indented according to `c-syntactic-indentation'.
4452 If a fill prefix is specified, it overrides all the above."
4453 ;; allow-auto-fill is used from c-context-line-break to allow auto
4454 ;; filling to break the line more than once. Since this function is
4455 ;; used from auto-fill itself, that's normally disabled to avoid
4456 ;; unnecessary recursion.
4465 ;; Already know the literal type and limits when called from
4466 ;; c-context-line-break.
4473 ;; Called from do-auto-fill.
4481 c-ignore-auto-fill)
4486 ;; The adaptive fill function has generated a prefix, but
4487 ;; we're on the first line in a block comment so it'll be
4488 ;; wrong. Ignore it to guess a better one below.
4492 c-line-comment-starter)
4494 ;; Kludge: If the function that adapted the fill prefix
4495 ;; doesn't produce the required comment starter for line
4496 ;; comments, then we ignore it.
4498 )))
4501 ;; A call from do-auto-fill which should be ignored.
4502 )
4504 ;; A fill-prefix overrides anything.
4513 ;; Some sort of comment.
4519 ;; Inside a comment that should be continued.
4524 c-lit-type)))
4533 ;; Skip forward past the fill prefix in case
4534 ;; we're standing in it.
4535 ;;
4536 ;; FIXME: This doesn't work well in cases like
4537 ;;
4538 ;; /* Bla bla bla bla bla
4539 ;; bla bla
4540 ;;
4541 ;; If point is on the 'B' then the line will be
4542 ;; broken after "Bla b".
4543 ;;
4544 ;; If we have an empty comment, /* */, the next
4545 ;; lot of code pushes point to the */. We fix
4546 ;; this by never allowing point to end up to the
4547 ;; right of where it started.
4554 ;; The skip takes us out of the (block)
4555 ;; comment; insert the fill prefix at bol
4556 ;; instead and keep the position.
4563 ;; Don't break in the middle of a comment starter
4564 ;; or ender.
4573 ; middle of a TAB?
4574 ;; Inside a comment that should be broken.
4577 col)
4591 ;; c-comment-indent may look at the current
4592 ;; indentation, so let's start out with the same
4593 ;; indentation as the previous one.
4598 ;; In a macro.
4600 ;; Do not clobber the alignment of the line continuation
4601 ;; slash; c-backslash-region might look at it.
4603 ;; Got an asymmetry here: In normal code this command
4604 ;; doesn't indent the next line syntactically, and otoh a
4605 ;; normal syntactically indenting newline doesn't continue
4606 ;; the macro.
4609 ;; Somewhere else in the code.
4621 ;; advice for indent-new-comment-line for older Emacsen
4625 activate preactivate)
4626 "Call `c-indent-new-comment-line' if in CC Mode."
4629 ad-do-it
4634 "Do a line break suitable to the context.
4636 When point is outside a comment or macro, insert a newline and indent
4637 according to the syntactic context, unless `c-syntactic-indentation'
4638 is nil, in which case the new line is indented as the previous
4639 non-empty line instead.
4641 When point is inside the content of a preprocessor directive, a line
4642 continuation backslash is inserted before the line break and aligned
4643 appropriately. The end of the cpp directive doesn't count as inside
4644 it.
4646 When point is inside a comment, continue it with the appropriate
4647 comment prefix (see the `c-comment-prefix-regexp' and
4648 `c-block-comment-prefix' variables for details). The end of a
4649 C++-style line comment doesn't count as inside it.
4651 When point is inside a string, only insert a backslash when it is also
4652 inside a preprocessor directive."
4657 case-fold-search)
4674 ; it, not in a string, and not in the
4675 ; cpp keyword.
4697 ;; c-indent-line may look at the current indentation, so let's
4698 ;; start out with the same indentation as the previous line.
4709 "Insert a line break suitable to the context and leave point before it.
4710 This is the `c-context-line-break' equivalent to `open-line', which is
4711 normally bound to C-o. See `c-context-line-break' for the details."
4716 ;; Temporarily insert a non-whitespace char to keep any
4717 ;; preceding whitespace intact.
4723 \f
4726 ;;; cc-cmds.el ends here