| blob | bf651f8ae99af0d6c2d68bc02f49d7edf67ce51b |
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs
9 ;; 1987 Stewart Clamen
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
14 ;; Package: cc-mode
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 ;;; Commentary:
33 ;;; Code:
40 load-path)))
47 ;; Silence the compiler.
49 ; which looks at this.
50 \f
51 ;; Indentation / Display syntax functions
55 "Indent the current line according to the syntactic context,
56 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
57 syntactic information for the current line. Be silent about syntactic
58 errors if the optional argument QUIET is non-nil, even if
59 `c-report-syntactic-errors' is non-nil. Normally the position of
60 point is used to decide where the old indentation is on a lines that
61 is otherwise empty \(ignoring any line continuation backslash), but
62 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
63 indentation change \(in columns)."
69 bs-col
70 shift-amt)
75 ;; Don't use "\\s " - ^L doesn't count as WS
76 ;; here
80 ;; Delete all whitespace after point if there's only whitespace
81 ;; on the line, so that any code that does back-to-indentation
82 ;; or similar gets the current column in this case. If this
83 ;; removes a line continuation backslash it'll be restored
84 ;; at the end.
86 ;; Should try to keep the backslash alignment
87 ;; in this case.
99 c-syntactic-context))))
104 c-syntactic-context))
106 c-echo-syntactic-information-p
108 c-syntactic-context indent))
112 c-parsing-error)
113 c-parsing-error))
118 t
120 nil))))
129 ;; Realign the line continuation backslash.
131 shift-amt))
134 "Insert a newline and indent the new line.
135 This function fixes line continuation backslashes if inside a macro,
136 and takes care to set the indentation before calling
137 `indent-according-to-mode', so that lineup functions like
138 `c-lineup-dont-change' works better."
140 ;; TODO: Backslashes before eol in comments and literals aren't
141 ;; kept intact.
143 ;; Avoid calling c-backslash-region from c-indent-line if it's
144 ;; called during the newline call, which can happen due to
145 ;; c-electric-continued-statement, for example. We also don't
146 ;; want any backslash alignment from indent-according-to-mode.
148 has-backslash insert-backslash
149 start col)
159 has-backslash t)
166 ;; The backslash stayed on the previous line. Insert one
167 ;; before calling c-backslash-region, so that
168 ;; bs-col-after-end in it works better. Fixup the
169 ;; backslashes on the newly inserted line.
173 ;; The backslash moved to the new line, if there was any. Let
174 ;; c-backslash-region fix a backslash on the previous line,
175 ;; and the one that might be on the new line.
176 ;; c-auto-align-backslashes is intentionally ignored here;
177 ;; maybe the moved backslash should be left alone if it's set,
178 ;; but we fix both lines on the grounds that the old backslash
179 ;; has been moved anyway and is now in a different context.
182 ;; Reindent syntactically. The indentation done above is not
183 ;; wasted, since c-indent-line might look at the current
184 ;; indentation.
187 ;; We temporarily insert another line break, so that the
188 ;; lineup functions will see the line as empty. That makes
189 ;; e.g. c-lineup-cpp-define more intuitive since it then
190 ;; proceeds to the preceding line in this case.
201 ;; Must align the backslash again after reindentation. The
202 ;; c-backslash-region call above can't be optimized to ignore
203 ;; this line, since it then won't align correctly with the
204 ;; lines below if the first line in the macro is broken.
208 "Show syntactic information for current line.
209 With universal argument, inserts the analysis as a comment on that line."
213 ;; Use `c-syntactic-context' in the same way as
214 ;; `c-indent-line', to be consistent.
215 c-syntactic-context
228 ols))
232 ols)))
238 ))
242 "Insert a comment with the syntactic analysis on every line in the region."
252 \f
253 ;; Minor mode functions.
261 ;; subword might not be loaded.
264 "w"
266 ;; FIXME: Derived modes might want to use something else
267 ;; than a string for `mode-name'.
270 mode-name)))
271 ;; (setq c-submode-indicators
272 ;; (if (> (length fmt) 1)
273 ;; fmt))
277 bare-mode-name))
281 "Toggle syntactic indentation.
282 Optional numeric ARG, if supplied, turns on syntactic indentation when
283 positive, turns it off when negative, and just toggles it when zero or
284 left out.
286 When syntactic indentation is turned on (the default), the indentation
287 functions and the electric keys indent according to the syntactic
288 context keys, when applicable.
290 When it's turned off, the electric keys don't reindent, the indentation
291 functions indents every new line to the same level as the previous
293 specified by `c-basic-offset'. The indentation style has no effect in
294 this mode, nor any of the indentation associated variables,
295 e.g. `c-special-indent-hook'.
297 This command sets the variable `c-syntactic-indentation'."
304 "Toggle auto-newline feature.
305 Optional numeric ARG, if supplied, turns on auto-newline when
306 positive, turns it off when negative, and just toggles it when zero or
307 left out.
309 Turning on auto-newline automatically enables electric indentation.
312 mode line after the mode name) newlines are automatically inserted
313 after special characters such as brace, comma, semi-colon, and colon."
325 "Toggle hungry-delete-key feature.
326 Optional numeric ARG, if supplied, turns on hungry-delete when
327 positive, turns it off when negative, and just toggles it when zero or
328 left out.
331 the mode line after the mode name) the delete key gobbles all preceding
332 whitespace in one fell swoop."
339 "Toggle auto-newline and hungry-delete-key features.
340 Optional numeric ARG, if supplied, turns on auto-newline and
341 hungry-delete when positive, turns them off when negative, and just
342 toggles them when zero or left out.
344 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
352 "Toggle the electric indentation feature.
353 Optional numeric ARG, if supplied, turns on electric indentation when
354 positive, turns it off when negative, and just toggles it when zero or
355 left out."
361 \f
362 ;; Electric keys
365 "Delete the preceding character or whitespace.
367 line) then all preceding whitespace is consumed. If however a prefix
368 argument is supplied, or `c-hungry-delete-key' is nil, or point is
369 inside a literal then the function in the variable
370 `c-backspace-function' is called."
374 arg
380 "Delete the preceding character or all preceding whitespace
381 back to the previous non-whitespace character.
393 "Delete the following character or whitespace.
395 line) then all following whitespace is consumed. If however a prefix
396 argument is supplied, or `c-hungry-delete-key' is nil, or point is
397 inside a literal then the function in the variable `c-delete-function'
398 is called."
402 arg
408 "Delete the following character or all following whitespace
409 up to the next non-whitespace character.
418 ;; This function is only used in XEmacs.
420 "Deletes preceding or following character or whitespace.
421 This function either deletes forward as `c-electric-delete-forward' or
422 backward as `c-electric-backspace', depending on the configuration: If
423 the function `delete-forward-p' is defined and returns non-nil, it
424 deletes forward. Otherwise it deletes backward.
426 Note: This is the way in XEmacs to choose the correct action for the
427 \[delete] key, whichever key that means. Other flavors don't use this
428 function to control that."
435 ;; This function is only used in XEmacs.
437 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
438 The direction of deletion depends on the configuration: If the
439 function `delete-forward-p' is defined and returns non-nil, it deletes
440 forward using `c-hungry-delete-forward'. Otherwise it deletes
441 backward using `c-hungry-backspace'.
443 Note: This is the way in XEmacs to choose the correct action for the
444 \[delete] key, whichever key that means. Other flavors don't use this
445 function to control that."
454 If `c-electric-flag' is set, handle it specially according to the variable
455 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
456 inside a literal or a macro, nothing special happens."
470 ;; do nothing special
472 ;; place the pound character at the left edge
480 )))
483 ;; Return the syntactic context of the construct at point. (This is NOT
484 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
485 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
488 syntax)
490 ;; insert a newline to isolate the construct at point for syntactic
491 ;; analysis.
493 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
494 ;; the syntax. (There might already be an escaped NL there.)
510 ;; Turn on syntactic macro analysis to help with auto
511 ;; newlines only.
513 nil))
514 syntax))
517 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
518 ;; (not necessarily the same as the S.C. of the line it is on). Return
519 ;; NEWLINES, the list containing some combination of the symbols `before'
520 ;; and `after' saying where newlines should be inserted.
523 ;; This is the list of brace syntactic symbols that can hang.
524 ;; If any new ones are added to c-offsets-alist, they should be
525 ;; added here as well.
526 ;;
527 ;; The order of this list is important; if SYNTAX has several
528 ;; elements, the element that "wins" is the earliest in SYMS.
530 class-open class-close defun-open defun-close
531 inline-open inline-close
532 brace-list-open brace-list-close
533 brace-list-intro brace-entry-open
534 block-open block-close
535 substatement-open statement-case-open
536 extern-lang-open extern-lang-close
537 namespace-open namespace-close
538 module-open module-close
539 composition-open composition-close
540 inexpr-class-open inexpr-class-close
541 ;; `statement-cont' is here for the case with a brace
542 ;; list opener inside a statement. C.f. CASE B.2 in
543 ;; `c-guess-continued-construct'.
544 statement-cont))
545 ;; shut this up too
550 ;; Do not try to insert newlines around a special
551 ;; (Pike-style) brace list.
558 nil
559 ;; Seek the matching entry in c-hanging-braces-alist.
561 syms
562 ;; Substitute inexpr-class and class-open or
563 ;; class-close with inexpr-class-open or
564 ;; inexpr-class-close.
571 syntax)
572 c-hanging-braces-alist)
575 ;; If syntax is a function symbol, then call it using the
576 ;; defined semantics.
586 ;; Point is just after a newly inserted }. If the non-whitespace
587 ;; content of the braces is a single line of code, compact the whole
588 ;; construct to a single line, if this line isn't too long. The Right
589 ;; Thing is done with comments.
590 ;;
591 ;; Point will be left after the }, regardless of whether the clean-up is
592 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
596 mbeg1 mend1 mbeg4 mend4
597 eol-col cmnt-pos cmnt-col cmnt-gap)
602 ;; Avoid backtracking over a very large block. The one we
603 ;; deal with here can never be more than three lines.
634 ;; Necessary to put the closing brace before any line
635 ;; oriented comment to keep it syntactically significant.
636 ;; This isn't necessary for block comments, but the result
637 ;; looks nicer anyway.
653 ;; Can we trim space before comment to make the line fit?
659 t))))
663 "Insert a brace.
665 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
666 numeric ARG hasn't been supplied, the command performs several electric
667 actions:
670 the mode line) newlines are inserted before and after the brace as
671 directed by the settings in `c-hanging-braces-alist'.
673 \(b) Any auto-newlines are indented. The original line is also
674 reindented unless `c-syntactic-indentation' is nil.
676 \(c) If auto-newline is turned on, various newline cleanups based on the
677 settings of `c-cleanup-list' are done."
681 ;; We want to inhibit blinking the paren since this would be
682 ;; most disruptive. We'll blink it ourselves later on.
684 blink-paren-function case-fold-search)
690 ;; Insert the brace. Note that expand-abbrev might reindent
691 ;; the line here if there's a preceding "else" or something.
701 newlines
703 ; of the brace itself, of the line the brace ends up on.
715 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
719 ;; Only a plain newline for now - it's indented
720 ;; after the cleanups when the line has its final
721 ;; appearance.
726 ;; `syntax' is the syntactic context of the line which ends up
727 ;; with the brace on it.
730 ;; Do all appropriate clean ups
733 mbeg mend
734 )
736 ;; `}': clean up empty defun braces
741 syntax)
746 ;; make sure matching open brace isn't in a comment
752 ;; `}': compact to a one-liner defun?
761 ;; `{': clean up brace-else-brace and brace-elseif-brace
768 "else"
770 "{"
772 nil t))
784 ; (progn
785 ; (setq tmp (point))
789 "else"
791 "if"
795 ;(eq (match-end 0) tmp);
796 )
803 ;; Indent the line after the cleanups since it might
804 ;; very well indent differently due to them, e.g. if
805 ;; c-indent-one-line-block is used together with the
806 ;; one-liner-defun cleanup.
810 ;; does a newline go after the brace?
813 ))))
815 ;; blink the paren
818 old-blink-paren
825 "Insert a slash character.
827 If the slash is inserted immediately after the comment prefix in a c-style
828 comment, the comment might get closed by removing whitespace and possibly
831 Indent the line as a comment, if:
834 token and we are on a comment-only-line, or
837 comment.
839 If a numeric ARG is supplied, point is inside a literal, or
840 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
841 is inhibited."
844 indentp
845 ;; shut this up
848 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
849 ;; `c-syntactic-indentation' set.
856 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
867 c-syntactic-indentation
868 c-electric-flag
876 "Insert a star character.
877 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
878 the star is the second character of a C style comment starter on a
879 comment-only-line, indent the line as a comment. If a numeric ARG is
880 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
881 this indentation is inhibited."
885 ;; if we are in a literal, or if arg is given do not reindent the
886 ;; current line, unless this star introduces a comment-only line.
889 c-electric-flag
902 ))
905 "Insert a comma or semicolon.
907 If `c-electric-flag' is non-nil, point isn't inside a literal and a
908 numeric ARG hasn't been supplied, the command performs several electric
909 actions:
912 the mode line) a newline might be inserted. See the variable
913 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
915 \(b) Any auto-newlines are indented. The original line is also
916 reindented unless `c-syntactic-indentation' is nil.
918 \(c) If auto-newline is turned on, a comma following a brace list or a
919 semicolon following a defun might be cleaned up, depending on the
920 settings of `c-cleanup-list'."
924 ;; shut this up
934 ;; do all cleanups and newline insertions if c-auto-newline is on.
939 ;; clean ups: list-close-comma or defun-close-semi
952 ;; make sure matching open brace isn't in a comment
956 ;; reindent line
960 ;; check to see if a newline should be added
962 answer add-newline-p)
965 ;; only nil value means continue checking
969 ;; only 'stop specifically says do not add a newline
971 ))
974 )))))
977 "Insert a colon.
979 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
980 numeric ARG hasn't been supplied, the command performs several electric
981 actions:
984 the mode line) newlines are inserted before and after the colon based on
985 the settings in `c-hanging-colons-alist'.
987 \(b) Any auto-newlines are indented. The original line is also
988 reindented unless `c-syntactic-indentation' is nil.
990 \(c) If auto-newline is turned on, whitespace between two colons will be
992 `c-cleanup-list'."
997 newlines is-scope-op
998 ;; shut this up
1001 ;; Any electric action?
1003 ;; Unless we're at EOL, only re-indentation happens.
1008 ;; scope-operator clean-up?
1026 ;; indent the current line if it's done syntactically.
1028 ;; Cannot use the same syntax analysis as we find below,
1029 ;; since that's made with c-syntactic-indentation-in-macros
1030 ;; always set to t.
1033 ;; Calculate where, if anywhere, we want newlines.
1037 ;; Turn on syntactic macro analysis to help with auto newlines
1038 ;; only.
1041 ;; Translate substatement-label to label for this operation.
1046 ;; some language elements can only be determined by checking
1047 ;; the following line. Let's first look for ones that can be
1048 ;; found when looking on the line with the colon
1052 syntax c-hanging-colons-alist)
1059 c-hanging-colons-alist)))))
1060 ;; does a newline go before the colon? Watch out for already
1061 ;; non-hung colons. However, we don't unhang them because that
1062 ;; would be a cleanup (and anti-social).
1072 ;; does a newline go after the colon?
1076 ))))
1080 If the current language uses angle bracket parens (e.g. template
1081 arguments in C++), try to find out if the inserted character is a
1082 paren and give it paren syntax if appropriate.
1084 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1085 line will be reindented if the inserted character is a paren or if it
1086 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1087 numeric argument is supplied, or the point is inside a literal."
1091 final-pos close-paren-inserted found-delim case-fold-search)
1096 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1097 ;;;; property on the new < or > and its mate (if any) when they are template
1098 ;;;; parens. This is now done in an after-change function.
1100 ;; Indent the line if appropriate.
1104 ;; If a <, basically see if it's got "template" before it .....
1112 ;; ..... or is a C++ << operator.
1120 ;; It's a >. Either a C++ >> operator. ......
1127 ;; ...., or search back for a < which isn't already marked as an
1128 ;; opening template delimiter.
1131 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1132 ;; our position.
1155 blink-paren-function)
1156 ;; Note: Most paren blink functions, such as the standard
1157 ;; `blink-matching-open', currently doesn't handle paren chars
1158 ;; marked with text properties very well. Maybe we should avoid
1159 ;; this call for the time being?
1163 "Insert a parenthesis.
1165 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1166 line is reindented unless a numeric ARG is supplied, or the parenthesis
1167 is inserted inside a literal.
1169 Whitespace between a function name and the parenthesis may get added or
1170 removed; see the variable `c-cleanup-list'.
1172 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1173 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1176 ;; shut this up
1178 case-fold-search)
1183 ;; be most disruptive. We'll blink it ourselves
1184 ;; afterwards.
1186 blink-paren-function)
1190 ;; If we're at EOL, check for new-line clean-ups.
1194 ;; clean up brace-elseif-brace
1201 "else"
1203 "if"
1205 "("
1207 nil t)
1212 ;; clean up brace-catch-brace
1219 "catch"
1221 "("
1223 nil t)
1228 ;; Check for clean-ups at function calls. These two DON'T need
1229 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1230 ;; Point is currently just after the inserted paren.
1234 ;; space-before-funcall clean-up?
1242 ;; Don't add a space into #define FOO()....
1251 ;; compact-empty-funcall clean-up?
1265 old-blink-paren
1269 "Reindent the current line if appropriate.
1271 This function is used to reindent the line after a keyword which
1275 The line is reindented if there is nothing but whitespace before the
1276 keyword on the line, the keyword is not inserted inside a literal, and
1277 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1282 c-syntactic-indentation
1289 ;; Have to temporarily insert a space so that
1290 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1291 ;; space with a nonspace to avoid messing up any whitespace
1292 ;; sensitive meddling that might be done, e.g. by
1293 ;; `c-backslash-region'.
1299 \f
1304 ;; "nomenclature" functions + c-scope-operator.
1306 "Compatibility alias for `c-forward-subword'."
1313 "Compatibility alias for `c-backward-subword'."
1320 "Insert a double colon scope operator at point.
1325 \f
1326 ;; Movement (etc.) by defuns.
1328 ;; Return non-nil if point is between the closing brace and the semicolon of
1329 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1330 ;; portion of a declaration like "struct foo {...} bar ;".
1331 ;;
1332 ;; Return the position of the main declaration. Otherwise, return nil.
1333 ;; Point is assumed to be at the top level and outside of any macro or
1334 ;; literal.
1335 ;;
1336 ;; If LIM is non-nil, it is the bound on a the backward search for the
1337 ;; beginning of the declaration.
1338 ;;
1339 ;; This function might do hidden buffer changes.
1344 bod)
1348 ;; Look for struct or union or ... If we find one, it might
1349 ;; be the return type of a function, or the like. Exclude
1350 ;; this case.
1353 c-opt-block-decls-with-vars-key
1355 eo-block t t t)
1360 bod)))))
1363 ;; Determine where we are with respect to functions (or other brace
1364 ;; constructs, included in the term "function" in the rest of this comment).
1365 ;; Point is assumed to be outside any macro or literal.
1366 ;; This is used by c-\(beginning\|end\)-of-defun.
1367 ;;
1368 ;; Return one of these symbols:
1369 ;; at-header : we're at the start of a function's header.
1370 ;; in-header : we're inside a function's header, this extending right
1371 ;; up to the brace. This bit includes any k&r declarations.
1372 ;; in-block : we're inside a function's brace block.
1373 ;; in-trailer : we're in the area between the "}" and ";" of something
1374 ;; like "struct foo {...} bar, baz;".
1375 ;; at-function-end : we're just after the closing brace (or semicolon) that
1376 ;; terminates the function.
1377 ;; outwith-function: we're not at or in any function. Being inside a
1378 ;; non-brace construct also counts as 'outwith-function'.
1379 ;;
1380 ;; This function might do hidden buffer changes.
1383 decl-result brace-decl-p
1400 ;; Find the start of the current declaration. NOTE: If we're in the
1401 ;; variables after a "struct/eval" type block, we don't get to the
1402 ;; real declaration here - we detect and correct for this later.
1404 ;;If we're in the parameters' parens, move back out of them.
1406 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1407 ;; at a declaration.
1415 ;; NOTE: If we're in a K&R region, this might be the start
1416 ;; of a parameter declaration, not the actual function.
1420 ;; Has the declaration we've gone back to got braces?
1426 ;; Might have stopped on the
1427 ;; ';' in a K&R argdecl. In
1428 ;; that case the declaration
1429 ;; should contain a block.
1438 'at-header
1444 'at-function-end
1447 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1448 decl-result))))))))
1451 ;; Skip to the opening brace of the Nth function before point. If
1452 ;; point is inside a function, this counts as the first. Point must be
1453 ;; outside any comment/string or macro.
1454 ;;
1455 ;; N must be strictly positive.
1456 ;; WHERE describes the position of point, one of the symbols `at-header',
1457 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1458 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1459 ;;
1460 ;; If we run out of functions, leave point at BOB. Return zero on success,
1461 ;; otherwise the number of {s still to go.
1462 ;;
1463 ;; This function may do hidden buffer changes
1465 ;; What we do to go back the first defun depends on where we start.
1481 ;; Each time round the loop, go back to a "{" at the outermost level.
1484 ; by a factor of ~6. Hmmm. 2006/4/5.
1489 n)
1492 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1493 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1494 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1495 ;; otherwise include the braces. If the closing brace is missing,
1496 ;; (point-max) is used instead.
1498 encl-decl)
1517 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1518 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1519 ;; braces NOT being included in the resulting region. On no account may the
1520 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1521 ;; PAREN-STATE is a list of buffer positions in the style of
1522 ;; (c-parse-state), one of which will be that of the desired opening brace,
1523 ;; if there is one.
1524 ;;
1525 ;; Return the position of the enclosing opening brace, or nil
1539 orig-point-max)))
1540 encl-decl)
1542 nil)))
1546 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1547 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1548 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1549 ;; buffer's original restriction.
1550 ;;
1551 ;; This is a very special purpose macro, which assumes the existence of
1552 ;; several variables. It is for use only in c-beginning-of-defun and
1553 ;; c-end-of-defun.
1557 lim)
1560 paren-state orig-point-min orig-point-max))
1564 "Move backward to the beginning of a defun.
1565 Every top level declaration that contains a brace paren block is
1566 considered to be a defun.
1568 With a positive argument, move backward that many defuns. A negative
1569 argument -N means move forward to the Nth following beginning. Return
1570 t unless search stops due to beginning or end of buffer.
1572 Unlike the built-in `beginning-of-defun' this tries to be smarter
1573 about finding the char with open-parenthesis syntax that starts the
1574 defun."
1588 ; structure with other users of c-state-cache.
1590 lim ; Position of { which has been widened to.
1591 where pos case-fold-search)
1596 paren-state orig-point-min orig-point-max)))
1598 ;; Move back out of any macro/comment/string we happen to be in.
1606 ;; Move forward to the closing brace of a function.
1613 ;; Move forward to the next opening brace....
1620 ;; ... and backward to the function header.
1622 t))
1624 ;; Move backward to the opening brace of a function, making successively
1625 ;; larger portions of the buffer visible as necessary.
1631 ;; Go backward to this function's header.
1635 ;; We're now there, modulo comments and whitespace.
1636 ;; Try to be line oriented; position point at the closest
1637 ;; preceding boi that isn't inside a comment, but if we hit
1638 ;; the previous declaration then we use the current point
1639 ;; instead.
1649 ;; Skip to the closing brace of the Nth function after point. If
1650 ;; point is inside a function, this counts as the first. Point must be
1651 ;; outside any comment/string or macro.
1652 ;;
1653 ;; N must be strictly positive.
1654 ;; WHERE describes the position of point, one of the symbols `at-header',
1655 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1656 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1657 ;;
1658 ;; If we run out of functions, leave point at EOB. Return zero on success,
1659 ;; otherwise the number of }s still to go.
1660 ;;
1661 ;; This function may do hidden buffer changes.
1664 ;; What we do to go forward over the first defun depends on where we
1665 ;; start. We go to the closing brace of that defun, even when we go
1666 ;; backwards to it (in a "struct foo {...} bar ;").
1682 ;; Each time round the loop, go forward to a "}" at the outermost level.
1684 ;(c-parse-state) ; This call speeds up the following one by a factor
1685 ; of ~6. Hmmm. 2006/4/5.
1690 n)
1693 "Move forward to the end of a top level declaration.
1694 With argument, do it that many times. Negative argument -N means move
1695 back to Nth preceding end. Returns t unless search stops due to
1696 beginning or end of buffer.
1698 An end of a defun occurs right after the close-parenthesis that matches
1699 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1712 ; structure with other users of c-state-cache.
1714 lim
1715 where pos case-fold-search)
1720 paren-state orig-point-min orig-point-max)))
1722 ;; Move back out of any macro/comment/string we happen to be in.
1730 ;; Move backwards to the } of a function
1742 ;; Move forward to the } of a function
1747 ;; Do we need to move forward from the brace to the semicolon?
1753 ;; We're there now, modulo comments and whitespace.
1754 ;; Try to be line oriented; position point after the next
1755 ;; newline that isn't inside a comment, but if we hit the
1756 ;; next declaration then we use the current point instead.
1770 "Return the name of the current defun, or NIL if there isn't one.
1772 with a brace block."
1776 where pos name-end case-fold-search)
1781 ;; Move back out of any macro/comment/string we happen to be in.
1788 ;; Move to the beginning of the current defun, if any, if we're not
1789 ;; already there.
1791 nil
1796 ;; Pick out the defun name, according to the type of defun.
1798 ;; struct, union, enum, or similar:
1810 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1811 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1827 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1828 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1831 ;; Objc selectors.
1843 ;; Normal function or initializer.
1855 ;; Return a cons of the beginning and end positions of the current
1856 ;; top level declaration or macro. If point is not inside any then
1857 ;; nil is returned, unless NEAR is non-nil in which case the closest
1858 ;; following one is chosen instead (if there is any). The end
1859 ;; position is at the next line, providing there is one before the
1860 ;; declaration.
1861 ;;
1862 ;; This function might do hidden buffer changes.
1870 ;; Note: Some code duplication in `c-beginning-of-defun' and
1871 ;; `c-end-of-defun'.
1875 lim pos end-pos)
1878 ;; If we moved to the outermost enclosing paren
1879 ;; then we can use c-safe-position to set the
1880 ;; limit. Can't do that otherwise since the
1881 ;; earlier paren pair on paren-state might very
1882 ;; well be part of the declaration we should go
1883 ;; to.
1885 t)
1886 ;; At top level. Make sure we aren't inside a literal.
1902 ;; We moved back over the previous defun. Skip to the next
1903 ;; one. Not using c-forward-syntactic-ws here since we
1904 ;; should not skip a macro. We can also be directly after
1905 ;; the block in a `c-opt-block-decls-with-vars-key'
1906 ;; declaration, but then we won't move significantly far
1907 ;; here.
1921 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1922 ;; declaration that doesn't end there. We're searching back and
1923 ;; forth over the block here, which can be expensive.
1935 nil
1939 nil
1941 ;; Try to be line oriented; position the limits at the
1942 ;; closest preceding boi, and after the next newline, that
1943 ;; isn't inside a comment, but if we hit a neighboring
1944 ;; declaration then we instead use the exact declaration
1945 ;; limit in that direction.
1951 pos
1967 pos))))))))
1975 "Put mark at end of the current top-level declaration or macro, point at beginning.
1976 If point is not inside any then the closest following one is
1977 chosen. Each successive call of this command extends the marked
1978 region by one function.
1980 A mark is left where the command started, unless the region is already active
1981 \(in Transient Mark mode).
1984 function does not require the declaration to contain a brace block."
1989 ;; We try to be line oriented, unless there are several
1990 ;; declarations on the same line.
2017 "Return the name of the current CPP macro, or NIL if we're not in one."
2026 \f
2027 ;; Movement by statements.
2029 ;; Point is within a comment. Is it also within a comment-prefix?
2030 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2031 ;;
2032 ;; This function might do hidden buffer changes.
2042 ;; Narrow to the "inside" of the comment (block) defined by range, as
2043 ;; follows:
2044 ;;
2045 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2046 ;; present) removed. A c++-style line comment retains its opening "//" but
2047 ;; has any final NL removed. If POINT is currently outwith these innards,
2048 ;; move it to the appropriate boundary.
2049 ;;
2050 ;; This narrowing simplifies the sentence movement functions, since it
2051 ;; eliminates awkward things at the boundaries of the comment (block).
2052 ;;
2053 ;; This function might do hidden buffer changes.
2071 ;; Move backwards to the "beginning of a sentence" within the comment
2072 ;; defined by RANGE, a cons of its starting and ending positions. If we
2073 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2074 ;; of the comment and return T.
2075 ;;
2076 ;; The BOS is either text which follows a regexp match of sentence-end,
2077 ;; or text which is a beginning of "paragraph".
2078 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2079 ;;
2080 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2081 ;; It is not a general function, but is intended only for calling from
2082 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2083 ;;
2084 ;; This function might do hidden buffer changes.
2090 last
2096 ;; First, find the previous paragraph start, if any.
2100 ; paragraph-\(start\|separate\)
2109 ;; Now seek successively earlier sentence ends between PAR-BEG and
2110 ;; HERE, until the "start of sentence" following it is earlier than
2111 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2129 nil
2131 t))))
2134 ;; Move forward to the "end of a sentence" within the comment defined by
2135 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2136 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2137 ;; return NIL. Otherwise, move point to just after the end of the comment
2138 ;; and return T.
2139 ;;
2140 ;; The EOS is just after the non-WS part of the next match of the regexp
2141 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2142 ;; no sentence-end match following point, any WS before the end of the
2143 ;; comment will count as EOS, providing we're not already in it.
2144 ;;
2145 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2146 ;; It is not a general function, but is intended only for calling from
2147 ;; c-move-over-sentence.
2148 ;;
2149 ;; This function might do hidden buffer changes.
2152 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2153 )
2159 ;; The cc-mode values of paragraph-\(start\|separate\), set
2160 ;; in c-setup-paragraph-variables, are used in the
2161 ;; following.
2170 last
2173 ;; Go forward one "comment-prefix which looks like sentence-end"
2174 ;; each time round the following:
2185 ;; Take special action if we're up against the end of a comment (of
2186 ;; either sort): Leave point just after the last non-ws text.
2193 nil
2195 t))))
2198 ;; Move backwards to the "beginning of a sentence" within the string defined
2199 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2200 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2201 ;; just before the start of the string and return T.
2202 ;;
2203 ;; The BOS is either the text which follows a regexp match of sentence-end
2204 ;; or text which is a beginning of "paragraph". For the purposes of
2205 ;; determining paragraph boundaries, escaped newlines are treated as
2206 ;; ordinary newlines.
2207 ;;
2208 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2209 ;; It is not a general function, but is intended only for calling from
2210 ;; c-move-over-sentence.
2211 ;;
2212 ;; This function might do hidden buffer changes.
2218 ;; Enhance paragraph-start and paragraph-separate also to recognize
2219 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2220 ;; these values should be customizable user options, or something.
2229 ; paragraph-\(start\|separate\)
2237 ;; Now see if we can find a sentence end after PAR-BEG.
2245 ; than here, in case point starts
2246 ; beyond the closing quote.
2251 nil
2253 t))))
2256 ;; Move forward to the "end of a sentence" within the string defined by
2257 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2258 ;; return NIL. Otherwise, move point to just after the end of the string
2259 ;; and return T.
2260 ;;
2261 ;; The EOS is just after the non-WS part of the next match of the regexp
2262 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2263 ;; no sentence-end match following point, any WS before the end of the
2264 ;; string will count as EOS, providing we're not already in it.
2265 ;;
2266 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2267 ;; It is not a general function, but is intended only for calling from
2268 ;; c-move-over-sentence.
2269 ;;
2270 ;; This function might do hidden buffer changes.
2273 last
2274 ;; Enhance paragraph-start and paragraph-separate to recognize
2275 ;; blank lines terminated by escaped EOLs.
2283 ;; The above values of paragraph-\(start\|separate\) are used
2284 ;; in the following.
2287 ;; (re-search-backward filler-here nil t) would find an empty
2288 ;; string. Therefore we simulate it by the following:
2297 ;; Try to go forward a sentence.
2302 ;; Did we move a sentence, or did we hit the end of the string?
2304 nil
2306 t))))
2309 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2310 ;; If a literal is the next thing (aside from whitespace) to be found before
2311 ;; point, return a cons of its start.end positions (enclosing the
2312 ;; delimiters). Otherwise return NIL.
2313 ;;
2314 ;; This function might do hidden buffer changes.
2318 pos)
2322 ;; to prevent `looking-at' seeing a " at point.
2326 ;; An EOL can act as an "open string" terminator in AWK.
2337 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2338 ;; If a literal is the next thing (aside from whitespace) following point,
2339 ;; return a cons of its start.end positions (enclosing the delimiters).
2340 ;; Otherwise return NIL.
2341 ;;
2342 ;; This function might do hidden buffer changes.
2355 ;; Does point immediately follow a statement "terminator"? A virtual
2356 ;; semicolon is regarded here as such. So is an opening brace ;-)
2357 ;;
2358 ;; This function might do hidden buffer changes.
2366 ;; The following (for macros) is not strict about exactly where we are
2367 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2368 ;; much. ACM 2004/3/29.
2380 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2381 ;; stopping before reaching BOB or a literal or the boundary of a
2382 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2383 ;; the position of the '#' beginning the current preprocessor directive, or
2384 ;; NIL if we're not in such.
2385 ;;
2386 ;; Return a cons (A.B), where
2387 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2388 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2389 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2390 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2391 ;;
2392 ;; The total collection of returned values is as follows:
2393 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2394 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2395 ;; a BOS - the caller must check this.
2396 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2397 ;; moved and reached the opening # of the macro.
2398 ;; (t . macro-boundary): Every other circumstance in which we're at a
2399 ;; macro-boundary. We might be at a BOS.
2400 ;;
2401 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2402 ;; code before encountering the literal/BOB or macro-boundary.
2403 ;;
2404 ;; Note that this function moves within either preprocessor commands
2405 ;; (macros) or normal code, but will not cross a boundary between the two,
2406 ;; or between two distinct preprocessor commands.
2407 ;;
2408 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2409 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2410 ;; move into parens. Also stop before `#' when it's at boi on a line.
2411 ;;
2412 ;; This function might do hidden buffer changes.
2416 ; semicolon precedes it.
2421 ;; Stop at the token after a comment.
2426 ;; If we've gone back over a LF, we might have moved into or out of
2427 ;; a preprocessor line.
2435 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2440 ;; Have we found a virtual semicolon? If so, stop, unless the next
2441 ;; statement is where we started from.
2448 ;; Hit the beginning of the buffer/region?
2454 ;; Move back a character.
2457 ;; Stop at "{" (unless it's a PIKE special brace list.)
2466 ;; Have we reached the start of a macro? This always counts as
2467 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2468 ;; here. FIXME!!! ACM 2004/3/29)
2472 ;; Stop at token just after "}" or ";".
2474 ;; If we've gone back over ;, {, or }, we're done.
2483 ;; Stop at the token after a string.
2488 ;; Nothing special: go back word characters.
2490 ))))))
2493 ;; Move forwards over code, stopping before reaching EOB or a literal
2494 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2495 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2496 ;; terminates the current preprocessor directive, or NIL if we're not in
2497 ;; such.
2498 ;;
2499 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2500 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2501 ;; seems unavoidable. Depending on the context this function is called
2502 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2503 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2504 ;; semicolons, or anything else.
2505 ;;
2506 ;; Return a cons (A.B), where
2507 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2508 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2509 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2510 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2511 ;;
2512 ;; Point is left either after the end-of-statement, or at the last non-ws
2513 ;; code before encountering the literal, or the # of the preprocessor
2514 ;; statement, or at EOB [or just after last non-WS stuff??].
2515 ;;
2516 ;; As a clarification of "after the end-of-statement", if a comment or
2517 ;; whitespace follows a completed AWK statement, that statement is treated
2518 ;; as ending just after the last non-ws character before the comment.
2519 ;;
2520 ;; Note that this function moves within either preprocessor commands
2521 ;; (macros) or normal code, but not both within the same invocation.
2522 ;;
2523 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2524 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2525 ;; stop before `{' if at top level or inside braces, though. Move by
2526 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2527 ;; the boi.
2528 ;;
2529 ;; This function might do hidden buffer changes.
2531 last)
2536 ;; If we've moved forward to a virtual semicolon, we're done.
2543 ;; Gone past the end of a macro?
2548 ;; About to hit a comment?
2553 ;; End of buffer?
2559 ;; If we encounter a '{', stop just after the previous token.
2565 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2566 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2567 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2568 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2574 ;; End of a PIKE special brace list? If so, step over it and continue.
2583 ;; Have we got a '}' after having moved? If so, stop after the
2584 ;; previous token.
2590 ;; Stop if we encounter a preprocessor line. Continue if we
2591 ;; hit a naked #
2600 ;; Stop after a ';', '}', or "};"
2605 ;; Found a string (this subsumes AWK regexps)?
2616 )))))
2619 ;; Is the literal defined by RANGE a string contained in a single line?
2620 ;;
2621 ;; This function might do hidden buffer changes.
2629 "Go to the beginning of the innermost C statement.
2630 With prefix arg, go back N - 1 statements. If already at the
2631 beginning of a statement then go to the beginning of the closest
2632 preceding one, moving into nested blocks if necessary (use
2634 comment or multiline string, move by sentences instead of statements.
2636 When called from a program, this function takes 3 optional args: the
2637 repetition count, a buffer position limit which is the farthest back
2638 to search for the syntactic context, and a flag saying whether to do
2639 sentence motion in or near comments and multiline strings.
2641 Note that for use in programs, `c-beginning-of-statement-1' is
2642 usually better. It has much better defined semantics than this one,
2643 which is intended for interactive use, and might therefore change to
2646 nil t))
2651 last ; start point for going back ONE chunk. Updated each chunk movement.
2654 res ; result from sub-function call
2655 not-bos ; "not beginning-of-statement"
2656 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2658 ;; Go back one statement at each iteration of the following loop.
2661 ;; Go back one "chunk" each time round the following loop, stopping
2662 ;; when we reach a statement boundary, etc.
2666 ; statement boundary, non-NIL otherwise.
2669 nil)
2673 ;; Single line string or sentence-flag is null => skip the
2674 ;; entire literal.
2679 ;; N.B. The following is essentially testing for an AWK regexp
2680 ;; at BOS:
2681 ;; Was the previous non-ws thing an end of statement?
2688 ;; Comment inside a statement or a multi-line string.
2694 res)))
2696 ;; Non-literal code.
2703 ;; We're at a tentative BOS. The next form goes
2704 ;; back over WS looking for an end of previous
2705 ;; statement.
2711 ;; Are we about to move backwards into or out of a
2712 ;; preprocessor command? If so, locate its beginning.
2720 ;; Are we about to move backwards into a literal?
2723 not-bos))
2730 "Go to the end of the innermost C statement.
2731 With prefix arg, go forward N - 1 statements. Move forward to the end
2732 of the next statement if already at end, and move into nested blocks
2734 comment or multiline string, move by sentences instead of statements.
2736 When called from a program, this function takes 3 optional args: the
2737 repetition count, a buffer position limit which is the farthest back
2738 to search for the syntactic context, and a flag saying whether to do
2739 sentence motion in or near comments and multiline strings."
2741 nil t))
2751 res
2752 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2754 ;; Go back/forward one statement at each iteration of the following loop.
2759 ;; Go forward one "chunk" each time round the following loop, stopping
2760 ;; when we reach a statement boundary, etc.
2763 ; statement boundary, non-NIL otherwise.
2766 nil)
2770 ;; sentence-flag is null => skip the entire literal.
2771 ;; or a Single line string.
2776 ;; Is there a virtual semicolon here (e.g. for AWK)?
2779 ;; Comment or multi-line string.
2785 ;; If we've just come forward out of a literal, check for
2786 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2787 ;; some other language may do in the future)
2791 ;; Non-literal code.
2794 ;; Are we about to move forward into or out of a
2795 ;; preprocessor command?
2810 ;; Are we about to move forward into a literal?
2818 \f
2819 ;; set up electric character functions to work with pending-del,
2820 ;; (a.k.a. delsel) mode. All symbols get the t value except
2821 ;; the functions which delete, which gets 'supersede.
2828 c-electric-brace
2829 c-electric-slash
2830 c-electric-star
2831 c-electric-semi&comma
2832 c-electric-lt-gt
2833 c-electric-colon
2834 c-electric-paren))
2842 \f
2843 ;; Inserting/indenting comments
2845 ;; This function might do hidden buffer changes.
2858 ;; Do not pad with one space if we're at bol.
2859 value
2870 ;; Found comment to align with.
2872 ;; Do not pad with one space if we're at bol.
2873 0
2875 ;; Recurse to handle value as a new spec.
2879 "Used by `indent-for-comment' to create and indent comments.
2880 See `c-indent-comment-alist' for a description."
2908 case-fold-search)
2910 c-indent-comments-syntactically-p)
2912 ;; BOGOSITY ALERT: if we're looking at the eol, its
2913 ;; because indent-for-comment hasn't put the comment-start
2914 ;; in the buffer yet. this will screw up the syntactic
2915 ;; analysis so we kludge in the necessary info. Another
2916 ;; kludge is that if we're at the bol, then we really want
2917 ;; to ignore any anchoring as specified by
2918 ;; c-comment-only-line-offset since it doesn't apply here.
2923 c-comment-only-line-offset
2925 c-comment-only-line-offset))))
2930 \f
2931 ;; used by outline-minor-mode
2934 ;; in otherwise-hidden text.
2939 \f
2940 ;; Movement by CPP conditionals.
2942 "Move back to the containing preprocessor conditional, leaving mark behind.
2943 A prefix argument acts as a repeat count. With a negative argument,
2944 move forward to the end of the containing preprocessor conditional.
2947 function stops at them when going backward, but not when going
2948 forward."
2958 directives."
2966 "Move forward into the next preprocessor conditional, leaving mark behind.
2967 A prefix argument acts as a repeat count. With a negative argument,
2968 move backward into the previous preprocessor conditional.
2971 function stops at them when going forward, but not when going
2972 backward."
2982 directives."
2990 "Move back across a preprocessor conditional, leaving mark behind.
2991 A prefix argument acts as a repeat count. With a negative argument,
2992 move forward across a preprocessor conditional.
2994 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2995 and have the same meanings as in `c-scan-conditionals'. If you
2996 are calling c-forward-conditional from a program, you might want
2997 to call `c-scan-conditionals' directly instead."
3005 "Move forward across a preprocessor conditional, leaving mark behind.
3006 A prefix argument acts as a repeat count. With a negative argument,
3007 move backward across a preprocessor conditional.
3009 If there aren't enough conditionals after \(or before) point, an
3010 error is signaled.
3013 the nesting level isn't changed when tracking subconditionals.
3015 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3016 and have the same meanings as in `c-scan-conditionals'. If you
3017 are calling c-forward-conditional from a program, you might want
3018 to call `c-scan-conditionals' directly instead."
3025 "Scan forward across COUNT preprocessor conditionals.
3026 With a negative argument, scan backward across preprocessor
3027 conditionals. Return the end position. Point is not moved.
3029 If there aren't enough preprocessor conditionals, throw an error.
3032 the nesting level isn't changed when tracking subconditionals.
3034 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3035 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3036 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3037 counts as -1.
3040 are treated as conditional clause limits. Normally they are ignored."
3044 new case-fold-search)
3050 ;; subdepth is the depth in "uninteresting" subtrees,
3051 ;; i.e. those that takes us farther from the target
3052 ;; depth instead of closer.
3054 found)
3056 ;; Find the "next" significant line in the proper direction.
3058 ;; Rather than searching for a # sign that
3059 ;; comes at the beginning of a line aside from
3060 ;; whitespace, search first for a string
3061 ;; starting with # sign. Then verify what
3062 ;; precedes it. This is faster on account of
3063 ;; the fastmap feature of the regexp matcher.
3066 nil t))
3068 ;; Now verify it is really a preproc line.
3076 ;; When we're not in an "uninteresting"
3077 ;; subtree, we might want to act on "elif"
3078 ;; and "else" too.
3080 ;; Always move toward the target depth.
3085 ;; Ignore the change if it'd take us
3086 ;; into an "uninteresting" subtree.
3094 ;; If we are trying to move across, and we find an
3095 ;; end before we find a beginning, get an error.
3098 "No following conditional at this level"
3100 ;; When searching forward, start from next line so
3101 ;; that we don't find the same line again.
3103 ;; We found something if we've arrived at the
3104 ;; target depth.
3107 ;; else
3114 new))
3116 \f
3117 ;; commands to indent lines, regions, defuns, and expressions
3119 "Indent current line as C code, and/or insert some whitespace.
3121 If `c-tab-always-indent' is t, always just indent the current line.
3122 If nil, indent the current line only if point is at the left margin or
3123 in the line's indentation; otherwise insert some whitespace[*]. If
3124 other than nil or t, then some whitespace[*] is inserted only within
3125 literals (comments and strings), but the line is always reindented.
3127 If `c-syntactic-indentation' is t, indentation is done according to
3128 the syntactic context. A numeric argument, regardless of its value,
3129 means indent rigidly all the lines of the expression starting after
3130 point so that this line becomes properly indented. The relative
3131 indentation among the lines of the expression is preserved.
3133 If `c-syntactic-indentation' is nil, the line is just indented one
3134 step according to `c-basic-offset'. In this mode, a numeric argument
3135 indents a number of such steps, positive or negative, and an empty
3136 prefix argument is equivalent to -1.
3138 [*] The amount and kind of whitespace inserted is controlled by the
3139 variable `c-insert-tab-function', which is called to do the actual
3140 insertion of whitespace. Normally the function in this variable
3141 just inserts a tab character, or the equivalent number of spaces,
3142 depending on the variable `indent-tabs-mode'."
3151 -1
3159 ;; Realign the line continuation backslash if inside a macro.
3161 ))))
3163 ;; If c-syntactic-indentation and got arg, always indent this
3164 ;; line as C and shift remaining lines of expression the same
3165 ;; amount.
3169 beg end)
3174 shift-amt))
3186 ;; Else use c-tab-always-indent to determine behavior.
3188 ;; CASE 1: indent when at column zero or in line's indentation,
3189 ;; otherwise insert a tab
3196 ;; CASE 2: just indent the line
3199 ;; CASE 3: if in a literal, insert a tab, but always indent the
3200 ;; line
3205 )))))
3208 "Indent each line in the balanced expression following point syntactically.
3209 If optional SHUTUP-P is non-nil, no errors are signaled if no
3210 balanced expression is found."
3213 end)
3217 ;; Find the closest following open paren that
3218 ;; ends on another line.
3226 ;; sanity check
3242 "Indent the current top-level declaration or macro syntactically.
3243 In the macro case this also has the effect of realigning any line
3244 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3250 ;; We try to be line oriented, unless there are several
3251 ;; declarations on the same line.
3263 "Indent syntactically every line whose first char is between START
3264 and END inclusive. If the optional argument QUIET is non-nil then no
3265 syntactic errors are reported, even if `c-report-syntactic-errors' is
3266 non-nil."
3272 ;; Advance to first nonblank line.
3280 ;; shut up any echo msgs on indiv lines
3286 start))
3288 syntax)
3296 ;; update progress
3298 ;; skip empty lines
3301 ;; Get syntax and indent.
3307 ;; End of current multi-line macro?
3310 ;; Fixup macro backslashes.
3313 ;; New multi-line macro?
3325 c-parsing-error))))
3328 ;; Function version of the macro for use in places that aren't
3329 ;; compiled, e.g. in the menus.
3333 "Indent active region, current line, or block starting on this line.
3334 In Transient Mark mode, when the region is active, reindent the region.
3335 Otherwise, with a prefix argument, rigidly reindent the expression
3336 starting on the current line.
3337 Otherwise reindent just the current line."
3343 \f
3344 ;; for progress reporting
3349 ;; Be silent
3351 ;; Start the progress update messages. If this Emacs doesn't have
3352 ;; a built-in timer, just be dumb about it.
3355 ;; If progress has already been initialized, do nothing. otherwise
3356 ;; initialize the counter with a vector of:
3357 ;; [start end lastsec context]
3364 context))
3366 ))
3370 nil
3375 ;; should we update? currently, update happens every 2 seconds,
3376 ;; what's the right value?
3382 )))
3386 nil
3395 \f
3396 ;;; This page handles insertion and removal of backslashes for C macros.
3399 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3400 With no argument, inserts backslashes and aligns existing backslashes.
3401 With an argument, deletes the backslashes. The backslash alignment is
3402 done according to the settings in `c-backslash-column',
3403 `c-backslash-max-column' and `c-auto-align-backslashes'.
3405 This function does not modify blank lines at the start of the region.
3406 If the region ends at the start of a line and the macro doesn't
3407 continue below it, the backslash (if any) at the end of the previous
3408 line is deleted.
3410 You can put the region around an entire macro definition and use this
3411 command to conveniently insert and align the necessary backslashes."
3414 ;; Keep the backslash trimming functions from changing the
3415 ;; whitespace around point, since in this case it's only the
3416 ;; position of point that tells the indentation of the line.
3422 column longest-line-col bs-col-after-end)
3426 ;; Nothing to do if to is at bob, since we should back up
3427 ;; and there's no line to back up to.
3428 nil
3430 ;; Do not back up the to line if line-mode is set, to make
3431 ;; e.g. c-newline-and-indent consistent regardless whether
3432 ;; the (newline) call leaves point at bol or not.
3440 ;; Set bs-col-after-end to the column of any backslash
3441 ;; following the region, or nil if there is none.
3450 ;; Back up the to line if line-mode is set, since the line
3451 ;; after the newly inserted line break should not be
3452 ;; touched in c-newline-and-indent.
3455 ;; Set bs-col-after-end to non-nil in any case, since we
3456 ;; do not want to delete the backslash at the last line.
3461 ;; Compute the smallest column number past the ends of all
3462 ;; the lines.
3466 ;; Include one more line in the max column
3467 ;; calculation, since the to line will be backslashed
3468 ;; too.
3481 ;; Try to align with surrounding backslashes.
3490 ;; Both a preceding and a following backslash.
3491 ;; Choose the greatest of them.
3494 ;; No preceding backslash. Try to align with one
3495 ;; following the region. Disregard the backslash at the
3496 ;; to line since it's likely to be bogus (e.g. when
3497 ;; called from c-newline-and-indent).
3500 ;; Don't modify blank lines at start of region.
3505 ;; Don't try to align with surrounding backslashes if
3506 ;; any line is too long.
3509 ;; Impose minimum limit and tab width alignment only if
3510 ;; we can't align with surrounding backslashes.
3514 tab-width)
3515 tab-width)))
3517 longest-line-col)))
3518 ;; Always impose maximum limit.
3521 ;; Add backslashes on all lines if the macro continues
3522 ;; after the to line.
3526 ;; Add backslashes on all lines except the last, and
3527 ;; remove any on the last line.
3535 ;; The function above leaves point on the line
3536 ;; following endmark.
3561 ;; Avoid unnecessary changes of the buffer.
3563 ;; Don't realign backslashes in string literals
3564 ;; since that would change them.
3565 )
3591 ;; Make sure there are backslashes with at least one space in
3592 ;; front of them.
3627 point-pos))
3633 \f
3634 ;;; Line breaking and paragraph filling.
3640 ;; The filling code is based on a simple theory; leave the intricacies
3641 ;; of the text handling to the currently active mode for that
3642 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3643 ;; possible to make them work correctly wrt the comment and string
3644 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3645 ;; to it, there's quite a lot of special cases to handle which makes
3646 ;; the code anything but simple. The intention is that it will work
3647 ;; with any well-written text filling package that preserves a fill
3648 ;; prefix.
3649 ;;
3650 ;; We temporarily mask comment starters and enders as necessary for
3651 ;; the filling code to do its job on a seemingly normal text block.
3652 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3653 ;; preserve it correctly (especially important when filling C++ style
3654 ;; line comments). By default, we set up and use adaptive-fill-mode,
3655 ;; which is standard in all supported Emacs flavors.
3658 ;; Determine the appropriate comment fill prefix for a block or line
3659 ;; comment. Return a cons of the prefix string and the column where
3660 ;; it ends. If fill-prefix is set, it'll override. Note that this
3661 ;; function also uses the value of point in some heuristics.
3662 ;;
3663 ;; This function might do hidden buffer changes.
3667 c-current-comment-prefix
3670 prefix-regexp
3671 comment-start-skip))
3672 prefix-line comment-prefix res comment-text-end)
3677 ;; Ugly way of getting the column after the fill
3678 ;; prefix; it'd be nice with a current-column
3679 ;; that works on strings..
3689 ;; Set fallback for comment-prefix if none is found.
3695 ;; The current line is not the comment starter, so the
3696 ;; comment has more than one line, and it can therefore be
3697 ;; used to find the comment fill prefix.
3703 ;; The line after the comment starter is inside the
3704 ;; comment, so we can use it.
3707 ;; The comment is only one line. Take the comment prefix
3708 ;; from it and keep the indentation.
3717 ;; There is only whitespace before the comment
3718 ;; starter; take the prefix straight from this line.
3723 ;; There is code before the comment starter, so we
3724 ;; have to temporarily insert and indent a new line to
3725 ;; get the right space/tab mix in the indentation.
3727 tmp)
3743 ;; The prefix ends the line with no whitespace
3744 ;; after it. Default to a single space.
3746 )))))
3759 ;; The current line is not the comment starter and
3760 ;; contains more than just the ender, so it's good enough
3761 ;; to be used for the comment fill prefix.
3771 ;; The comment is either one line or the next line contains
3772 ;; just the comment ender. In this case we have no
3773 ;; information about a suitable comment prefix, so we resort
3774 ;; to c-block-comment-prefix.
3778 ;; The point was on the comment opener line, so we might want
3779 ;; to treat this as a not yet closed comment.
3783 ;; Above `prefix-regexp' matched a nonempty prefix on the
3784 ;; second line, so let's use it. Normally it should do
3785 ;; to set `prefix-line' and let the code below pick up
3786 ;; the whole prefix, but if there's no text after the
3787 ;; match then it will probably fall back to no prefix at
3788 ;; all if the comment isn't closed yet, so in that case
3789 ;; it's better to force use of the prefix matched now.
3794 ;; There's no nonempty prefix on the line after the
3795 ;; comment opener. If the line is empty, or if the
3796 ;; text on it has less or equal indentation than the
3797 ;; comment starter we assume it's an unclosed
3798 ;; comment starter, i.e. that
3799 ;; `c-block-comment-prefix' should be used.
3800 ;; Otherwise we assume it's a closed comment where
3801 ;; the prefix really is the empty string.
3802 ;; E.g. this is an unclosed comment:
3803 ;;
3804 ;; /*
3805 ;; foo
3806 ;;
3807 ;; But this is not:
3808 ;;
3809 ;; /*
3810 ;; foo
3811 ;; */
3812 ;;
3813 ;; (Looking for the presence of the comment closer
3814 ;; rarely works since it's probably the closer of
3815 ;; some comment further down when the comment
3816 ;; really is unclosed.)
3825 ;; Otherwise the line after the comment starter is good
3826 ;; enough to find the prefix in.
3830 ;; Haven't got the comment prefix on any real line that we
3831 ;; can take it from, so we have to temporarily insert
3832 ;; `comment-prefix' on a line and indent it to find the
3833 ;; correct column and the correct mix of tabs and spaces.
3842 comment-text-end))
3847 ;; If there's ws on the current line, we'll use it
3848 ;; instead of what's ending comment-prefix.
3853 comment-prefix))
3862 ;; We insert an extra non-whitespace character
3863 ;; before the line break and after comment-prefix in
3864 ;; case it's "" or ends with whitespace.
3883 ;; prefix-line is the bol of a line on which we should try
3884 ;; to find the prefix.
3891 ;; The match is fine if there's text after it.
3897 ;; This match is better than nothing, so let's
3898 ;; remember it in case nothing better is found
3899 ;; on another line.
3903 t))))
3906 ;; Search for a line which has text after the prefix
3907 ;; so that we get the proper amount of whitespace
3908 ;; after it. We start with the current line, then
3909 ;; search backwards, then forwards.
3914 ;; The whitespace is sucked up by the
3915 ;; first [ \t]* glob if the prefix is empty.
3918 ;; If the current line doesn't have text but do
3919 ;; have whitespace after the prefix, we'll use it.
3925 ;; For line comments we can search up to and
3926 ;; including the first line.
3930 ;; For block comments we must stop before the
3931 ;; block starter.
3942 nil)
3945 ;; A good line wasn't found, but at least we have a
3946 ;; fallback that matches the comment prefix regexp.
3951 ;; There are ws or text after the prefix, so
3952 ;; let's use it.
3956 ;; Check if there's any whitespace padding
3957 ;; on the comment start line that we can
3958 ;; use after the prefix.
3976 ;; Got to mess in the buffer once again to
3977 ;; ensure the column gets correct. :P
3988 ;; Last resort: Just add a single space after
3989 ;; the prefix.
3994 ;; The line doesn't match the comment prefix regexp.
3996 ;; We have a fallback for line comments that we must use.
3999 comment-prefix)
4003 ;; Assume we are dealing with a "free text" block
4004 ;; comment where the lines doesn't have any comment
4005 ;; prefix at all and we should just fill it as
4006 ;; normal text.
4008 ))
4011 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4012 ;; masked to allow adaptive filling to work correctly. That
4013 ;; includes narrowing the buffer and, if point is inside a comment,
4014 ;; masking the comment starter and ender appropriately.
4015 ;;
4016 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4017 ;; The position of point is then less significant when doing masking
4018 ;; and narrowing.
4019 ;;
4020 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4021 ;; only if the point turns out to be inside a comment or a string.
4022 ;;
4023 ;; Note that this function does not do any hidden buffer changes.
4026 ;; beg and end limit the region to narrow. end is a marker.
4027 beg end
4028 ;; tmp-pre and tmp-post mark strings that are temporarily
4029 ;; inserted at the start and end of the region. tmp-pre is a
4030 ;; cons of the positions of the prepended string. tmp-post is
4031 ;; a marker pointing to the single character of the appended
4032 ;; string.
4033 tmp-pre tmp-post
4034 ;; If hang-ender-stuck isn't nil, the comment ender is
4035 ;; hanging. In that case it's set to the number of spaces
4036 ;; that should be between the text and the ender.
4037 hang-ender-stuck
4038 ;; auto-fill-spaces is the exact sequence of whitespace between a
4039 ;; comment's last word and the comment ender, temporarily replaced
4040 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4041 auto-fill-spaces
4046 ;; Restore point on undo. It's necessary since we do a lot of
4047 ;; hidden inserts and deletes below that should be as transparent
4048 ;; as possible.
4052 ;; Determine the limits and type of the containing literal (if any):
4053 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4054 ;; BEG and END.
4057 ;; Widen to catch comment limits correctly.
4082 ;; For each of the possible types of text (string, C comment ...)
4083 ;; determine BEG and END, the region we will narrow to. If we're in
4084 ;; a literal, constrain BEG and END to the limits of this literal.
4085 ;;
4086 ;; For some of these text types, particularly a block comment, we
4087 ;; may need to massage whitespace near literal delimiters, so that
4088 ;; these don't get filled inappropriately.
4093 ;; Limit to the comment or paragraph end, whichever
4094 ;; comes first.
4098 ;; The region includes the comment starter, so we must
4099 ;; check it.
4103 ;; Include the first line in the region.
4105 ;; The first line contains code before the
4106 ;; comment. We must fake a line that doesn't.
4117 ;; disallow "/*/"
4119 ;; There is a comment ender, and the region includes it. If
4120 ;; it's on its own line, it stays on its own line. If it's got
4121 ;; company on the line, it keeps (at least one word of) it.
4122 ;; "=====*/" counts as a comment ender here, but "===== */"
4123 ;; doesn't and "foo*/" doesn't.
4128 ;; The following conjunct was added to avoid an
4129 ;; "Invalid search bound (wrong side of point)"
4130 ;; error in the subsequent re-search. Maybe
4131 ;; another fix would be needed (2007-12-08).
4132 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4133 ; 2010-10-17 Construct removed.
4134 ; (or (< (- (cdr c-lit-limits) 2) (point))
4142 ;; The comment ender IS on its own line. Exclude this
4143 ;; line from the filling.
4146 ;; The comment ender is hanging. Replace all space between it
4147 ;; and the last word either by one or two 'x's (when
4148 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4149 ;; as the whitespace (when auto filling), and include it in
4150 ;; the region. We'll change them back to whitespace
4151 ;; afterwards. The effect of this is to glue the comment
4152 ;; ender to the last word in the comment during filling.
4169 spaces)
4172 ;; Insert a CR after the "*/", adjust END
4180 c-current-comment-prefix
4183 ;; The comment ender is prefixed by nothing but a
4184 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4185 ;; 2006/4/28). Remove it along with surrounding ws.
4189 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4191 ;; What's being tested here? 2006/4/20. FIXME!!!
4195 ;; Don't adjust point below if it's
4196 ;; before the string we replace.
4198 ;; Keep one or two spaces between the
4199 ;; text and the ender, depending on how
4200 ;; many there are now.
4205 ;; paragraph filling condenses multiple spaces to
4206 ;; single or double spaces. auto-fill doesn't.
4212 sentence-end-double-space)
4215 ;; Insert the filler first to keep marks right.
4224 ;; Point was in the middle of the string we
4225 ;; replaced above, so put it back in the same
4226 ;; relative position, counting from the end.
4228 ))
4231 ;; The region includes the comment starter.
4235 ;; Begin with the next line.
4237 ;; Fake the fill prefix in the first line.
4252 ;; Leave the start line if it's
4253 ;; nothing but an escaped newline.
4259 ;; Narrow to the macro limits if they are nearer than the
4260 ;; paragraph limits. Don't know if this is necessary but
4261 ;; do it for completeness sake (doing auto filling at all
4262 ;; inside macros is bogus to begin with since the line
4263 ;; continuation backslashes aren't handled).
4276 ;; Try to avoid comments and macros in the paragraph to
4277 ;; avoid that the adaptive fill mode gets the prefix from
4278 ;; them.
4291 ;; Temporarily insert the fill prefix after the comment
4292 ;; starter so that the first line looks like any other
4293 ;; comment line in the narrowed region.
4297 c-current-comment-prefix
4300 ;; Oops, the prefix doesn't match the comment prefix
4301 ;; regexp. This could produce very confusing
4302 ;; results with adaptive fill packages together with
4303 ;; the insert prefix magic below, since the prefix
4304 ;; often doesn't appear at all. So let's warn about
4305 ;; it.
4307 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4309 ;; Find the right spot on the line, break it, insert
4310 ;; the fill prefix and make sure we're back in the
4311 ;; same column by temporarily prefixing the first word
4312 ;; with a number of 'x'.
4316 c-current-comment-prefix
4317 comment-start-skip))
4334 ;; `apply-outside-literal' is always set to t here if
4335 ;; we're inside a literal.
4339 ;; Kludge: If the function that adapts the fill prefix
4340 ;; doesn't produce the required comment starter for
4341 ;; line comments, then force it by setting fill-prefix.
4343 ;; Kludge the kludge: filladapt-mode doesn't
4344 ;; have this problem, but it currently
4345 ;; doesn't override fill-context-prefix
4346 ;; (version 2.12).
4348 filladapt-mode))
4355 c-lit-limits c-lit-type)))))))
4357 ;; Save the relative position of point if it's outside the
4358 ;; region we're going to narrow. Want to restore it in that
4359 ;; case, but otherwise it should be moved according to the
4360 ;; called function.
4364 ;; Preparations finally done! Now we can call the
4365 ;; actual function.
4371 ;; Restore point if it was outside the region.
4384 ;; Preserve point even if it's in the middle of the string
4385 ;; we replace; save-excursion doesn't work in that case.
4401 If any of the current line is a comment or within a comment, fill the
4402 comment or the paragraph of it that point is in, preserving the
4403 comment indentation or line-starting decorations (see the
4404 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4405 details).
4407 If point is inside multiline string literal, fill it. This currently
4408 does not respect escaped newlines, except for the special case when it
4409 is the very first thing in the string. The intended use for this rule
4410 is in situations like the following:
4413 A very long description of something that you want to fill to make
4416 If point is in any other situation, i.e. in normal code, do nothing.
4418 Optional prefix ARG means justify paragraph as well."
4421 ;; Avoid infinite recursion.
4423 fill-paragraph-function)))
4425 ;; Always return t. This has the effect that if filling isn't done
4426 ;; above, it isn't done at all, and it's therefore effectively
4427 ;; disabled in normal code.
4428 t)
4431 ;; Do automatic filling if not inside a context where it should be
4432 ;; ignored.
4434 ;; The decision whether the line should be broken is actually
4435 ;; done in c-indent-new-comment-line, which do-auto-fill
4436 ;; calls to break lines. We just set this special variable
4437 ;; so that we'll know when we're called from there. It's
4438 ;; also used to detect whether fill-prefix is user set or
4439 ;; generated automatically by do-auto-fill.
4440 fill-prefix))
4444 "Break line at point and indent, continuing comment or macro if within one.
4445 If inside a comment and `comment-multi-line' is non-nil, the
4446 indentation and line prefix are preserved (see the
4447 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4448 details). If inside a single line comment and `comment-multi-line' is
4449 nil, a new comment of the same type is started on the next line and
4450 indented as appropriate for comments. If inside a macro, a line
4451 continuation backslash is inserted and aligned as appropriate, and the
4452 new line is indented according to `c-syntactic-indentation'.
4454 If a fill prefix is specified, it overrides all the above."
4455 ;; allow-auto-fill is used from c-context-line-break to allow auto
4456 ;; filling to break the line more than once. Since this function is
4457 ;; used from auto-fill itself, that's normally disabled to avoid
4458 ;; unnecessary recursion.
4467 ;; Already know the literal type and limits when called from
4468 ;; c-context-line-break.
4475 ;; Called from do-auto-fill.
4483 c-ignore-auto-fill)
4488 ;; The adaptive fill function has generated a prefix, but
4489 ;; we're on the first line in a block comment so it'll be
4490 ;; wrong. Ignore it to guess a better one below.
4494 c-line-comment-starter)
4496 ;; Kludge: If the function that adapted the fill prefix
4497 ;; doesn't produce the required comment starter for line
4498 ;; comments, then we ignore it.
4500 )))
4503 ;; A call from do-auto-fill which should be ignored.
4504 )
4506 ;; A fill-prefix overrides anything.
4515 ;; Some sort of comment.
4521 ;; Inside a comment that should be continued.
4526 c-lit-type)))
4535 ;; Skip forward past the fill prefix in case
4536 ;; we're standing in it.
4537 ;;
4538 ;; FIXME: This doesn't work well in cases like
4539 ;;
4540 ;; /* Bla bla bla bla bla
4541 ;; bla bla
4542 ;;
4543 ;; If point is on the 'B' then the line will be
4544 ;; broken after "Bla b".
4545 ;;
4546 ;; If we have an empty comment, /* */, the next
4547 ;; lot of code pushes point to the */. We fix
4548 ;; this by never allowing point to end up to the
4549 ;; right of where it started.
4556 ;; The skip takes us out of the (block)
4557 ;; comment; insert the fill prefix at bol
4558 ;; instead and keep the position.
4565 ;; Don't break in the middle of a comment starter
4566 ;; or ender.
4575 ; middle of a TAB?
4576 ;; Inside a comment that should be broken.
4579 col)
4593 ;; c-comment-indent may look at the current
4594 ;; indentation, so let's start out with the same
4595 ;; indentation as the previous one.
4600 ;; In a macro.
4602 ;; Do not clobber the alignment of the line continuation
4603 ;; slash; c-backslash-region might look at it.
4605 ;; Got an asymmetry here: In normal code this command
4606 ;; doesn't indent the next line syntactically, and otoh a
4607 ;; normal syntactically indenting newline doesn't continue
4608 ;; the macro.
4611 ;; Somewhere else in the code.
4623 ;; advice for indent-new-comment-line for older Emacsen
4627 activate preactivate)
4628 "Call `c-indent-new-comment-line' if in CC Mode."
4631 ad-do-it
4636 "Do a line break suitable to the context.
4638 When point is outside a comment or macro, insert a newline and indent
4639 according to the syntactic context, unless `c-syntactic-indentation'
4640 is nil, in which case the new line is indented as the previous
4641 non-empty line instead.
4643 When point is inside the content of a preprocessor directive, a line
4644 continuation backslash is inserted before the line break and aligned
4645 appropriately. The end of the cpp directive doesn't count as inside
4646 it.
4648 When point is inside a comment, continue it with the appropriate
4649 comment prefix (see the `c-comment-prefix-regexp' and
4650 `c-block-comment-prefix' variables for details). The end of a
4651 C++-style line comment doesn't count as inside it.
4653 When point is inside a string, only insert a backslash when it is also
4654 inside a preprocessor directive."
4659 case-fold-search)
4676 ; it, not in a string, and not in the
4677 ; cpp keyword.
4699 ;; c-indent-line may look at the current indentation, so let's
4700 ;; start out with the same indentation as the previous line.
4711 "Insert a line break suitable to the context and leave point before it.
4712 This is the `c-context-line-break' equivalent to `open-line', which is
4713 normally bound to C-o. See `c-context-line-break' for the details."
4718 ;; Temporarily insert a non-whitespace char to keep any
4719 ;; preceding whitespace intact.
4725 \f
4728 ;;; cc-cmds.el ends here