| blob | 5c8bbebf31b23a98404ea0713e395f61cf660b16 |
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2017 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 <https://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
57 "Indent the current line according to the syntactic context,
58 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
59 syntactic information for the current line. Be silent about syntactic
60 errors if the optional argument QUIET is non-nil, even if
61 `c-report-syntactic-errors' is non-nil. Normally the position of
62 point is used to decide where the old indentation is on a lines that
63 is otherwise empty \(ignoring any line continuation backslash), but
64 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
65 indentation change \(in columns)."
71 bs-col
72 shift-amt)
77 ;; Don't use "\\s " - ^L doesn't count as WS
78 ;; here
82 ;; Delete all whitespace after point if there's only whitespace
83 ;; on the line, so that any code that does back-to-indentation
84 ;; or similar gets the current column in this case. If this
85 ;; removes a line continuation backslash it'll be restored
86 ;; at the end.
88 ;; Should try to keep the backslash alignment
89 ;; in this case.
101 c-syntactic-context))))
106 c-syntactic-context))
108 c-echo-syntactic-information-p
110 c-syntactic-context indent))
114 c-parsing-error)
115 c-parsing-error))
120 t
122 nil))))
131 ;; Realign the line continuation backslash.
133 shift-amt))
136 "Insert a newline and indent the new line.
137 This function fixes line continuation backslashes if inside a macro,
138 and takes care to set the indentation before calling
139 `indent-according-to-mode', so that lineup functions like
140 `c-lineup-dont-change' works better."
142 ;; TODO: Backslashes before eol in comments and literals aren't
143 ;; kept intact.
145 ;; Avoid calling c-backslash-region from c-indent-line if it's
146 ;; called during the newline call, which can happen due to
147 ;; c-electric-continued-statement, for example. We also don't
148 ;; want any backslash alignment from indent-according-to-mode.
150 has-backslash insert-backslash
151 start col)
161 has-backslash t)
168 ;; The backslash stayed on the previous line. Insert one
169 ;; before calling c-backslash-region, so that
170 ;; bs-col-after-end in it works better. Fixup the
171 ;; backslashes on the newly inserted line.
175 ;; The backslash moved to the new line, if there was any. Let
176 ;; c-backslash-region fix a backslash on the previous line,
177 ;; and the one that might be on the new line.
178 ;; c-auto-align-backslashes is intentionally ignored here;
179 ;; maybe the moved backslash should be left alone if it's set,
180 ;; but we fix both lines on the grounds that the old backslash
181 ;; has been moved anyway and is now in a different context.
184 ;; Reindent syntactically. The indentation done above is not
185 ;; wasted, since c-indent-line might look at the current
186 ;; indentation.
189 ;; We temporarily insert another line break, so that the
190 ;; lineup functions will see the line as empty. That makes
191 ;; e.g. c-lineup-cpp-define more intuitive since it then
192 ;; proceeds to the preceding line in this case.
203 ;; Must align the backslash again after reindentation. The
204 ;; c-backslash-region call above can't be optimized to ignore
205 ;; this line, since it then won't align correctly with the
206 ;; lines below if the first line in the macro is broken.
210 "Show syntactic information for current line.
211 With universal argument, inserts the analysis as a comment on that line."
215 ;; Use `c-syntactic-context' in the same way as
216 ;; `c-indent-line', to be consistent.
217 c-syntactic-context
230 ols))
234 ols)))
240 ))
244 "Insert a comment with the syntactic analysis on every line in the region."
254 \f
255 ;; Minor mode functions.
256 ;; `c-block-comment-flag' gets initialized to the current mode's default in
257 ;; c-basic-common-init.
269 ;; (cc-)subword might not be loaded.
272 ;; FIXME: subword-mode already comes with its
273 ;; own lighter!
274 "w"
276 ;; FIXME: Derived modes might want to use something else
277 ;; than a string for `mode-name'.
280 mode-name)))
284 bare-mode-name))
288 "Toggle syntactic indentation.
289 Optional numeric ARG, if supplied, turns on syntactic indentation when
290 positive, turns it off when negative, and just toggles it when zero or
291 left out.
293 When syntactic indentation is turned on (the default), the indentation
294 functions and the electric keys indent according to the syntactic
295 context keys, when applicable.
297 When it's turned off, the electric keys don't reindent, the indentation
298 functions indents every new line to the same level as the previous
300 specified by `c-basic-offset'. The indentation style has no effect in
301 this mode, nor any of the indentation associated variables,
302 e.g. `c-special-indent-hook'.
304 This command sets the variable `c-syntactic-indentation'."
311 "Toggle auto-newline feature.
312 Optional numeric ARG, if supplied, turns on auto-newline when
313 positive, turns it off when negative, and just toggles it when zero or
314 left out.
316 Turning on auto-newline automatically enables electric indentation.
319 mode line after the mode name) newlines are automatically inserted
320 after special characters such as brace, comma, semi-colon, and colon."
332 "Toggle hungry-delete-key feature.
333 Optional numeric ARG, if supplied, turns on hungry-delete when
334 positive, turns it off when negative, and just toggles it when zero or
335 left out.
338 the mode line after the mode name) the delete key gobbles all preceding
339 whitespace in one fell swoop."
346 "Toggle auto-newline and hungry-delete-key features.
347 Optional numeric ARG, if supplied, turns on auto-newline and
348 hungry-delete when positive, turns them off when negative, and just
349 toggles them when zero or left out.
351 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
359 "Toggle the electric indentation feature.
360 Optional numeric ARG, if supplied, turns on electric indentation when
361 positive, turns it off when negative, and just toggles it when zero or
362 left out."
371 "Toggle the comment style between block and line comments.
372 Optional numeric ARG, if supplied, switches to block comment
373 style when positive, to line comment style when negative, and
374 just toggles it when zero or left out.
376 This action does nothing when the mode only has one comment style."
386 c-block-comment-starter
387 c-line-comment-starter)
396 \f
397 ;; Electric keys
400 "Delete the preceding character or whitespace.
402 line) then all preceding whitespace is consumed. If however a prefix
403 argument is supplied, or `c-hungry-delete-key' is nil, or point is
404 inside a literal then the function in the variable
405 `c-backspace-function' is called."
409 arg
415 "Delete the preceding character or all preceding whitespace
416 back to the previous non-whitespace character.
428 "Delete the following character or whitespace.
430 line) then all following whitespace is consumed. If however a prefix
431 argument is supplied, or `c-hungry-delete-key' is nil, or point is
432 inside a literal then the function in the variable `c-delete-function'
433 is called."
437 arg
443 "Delete the following character or all following whitespace
444 up to the next non-whitespace character.
453 ;; This function is only used in XEmacs.
455 "Deletes preceding or following character or whitespace.
456 This function either deletes forward as `c-electric-delete-forward' or
457 backward as `c-electric-backspace', depending on the configuration: If
458 the function `delete-forward-p' is defined and returns non-nil, it
459 deletes forward. Otherwise it deletes backward.
461 Note: This is the way in XEmacs to choose the correct action for the
462 [delete] key, whichever key that means. Other flavors don't use this
463 function to control that."
470 ;; This function is only used in XEmacs.
472 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
473 The direction of deletion depends on the configuration: If the
474 function `delete-forward-p' is defined and returns non-nil, it deletes
475 forward using `c-hungry-delete-forward'. Otherwise it deletes
476 backward using `c-hungry-backspace'.
478 Note: This is the way in XEmacs to choose the correct action for the
479 [delete] key, whichever key that means. Other flavors don't use this
480 function to control that."
489 If `c-electric-flag' is set, handle it specially according to the variable
490 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
491 inside a literal or a macro, nothing special happens."
505 ;; do nothing special
507 ;; place the pound character at the left edge
515 )))
518 ;; Return the syntactic context of the construct at point. (This is NOT
519 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
520 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
523 syntax)
525 ;; insert a newline to isolate the construct at point for syntactic
526 ;; analysis.
528 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
529 ;; the syntax. (There might already be an escaped NL there.)
545 ;; Turn on syntactic macro analysis to help with auto
546 ;; newlines only.
548 nil))
549 syntax))
552 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
553 ;; (not necessarily the same as the S.C. of the line it is on). Return
554 ;; NEWLINES, the list containing some combination of the symbols `before'
555 ;; and `after' saying where newlines should be inserted.
558 ;; This is the list of brace syntactic symbols that can hang.
559 ;; If any new ones are added to c-offsets-alist, they should be
560 ;; added here as well.
561 ;;
562 ;; The order of this list is important; if SYNTAX has several
563 ;; elements, the element that "wins" is the earliest in SYMS.
565 class-open class-close defun-open defun-close
566 inline-open inline-close
567 brace-list-open brace-list-close
568 brace-list-intro brace-entry-open
569 block-open block-close
570 substatement-open statement-case-open
571 extern-lang-open extern-lang-close
572 namespace-open namespace-close
573 module-open module-close
574 composition-open composition-close
575 inexpr-class-open inexpr-class-close
576 ;; `statement-cont' is here for the case with a brace
577 ;; list opener inside a statement. C.f. CASE B.2 in
578 ;; `c-guess-continued-construct'.
579 statement-cont))
580 ;; shut this up too
585 ;; Do not try to insert newlines around a special
586 ;; (Pike-style) brace list.
593 nil
594 ;; Seek the matching entry in c-hanging-braces-alist.
596 syms
597 ;; Substitute inexpr-class and class-open or
598 ;; class-close with inexpr-class-open or
599 ;; inexpr-class-close.
606 syntax)
607 c-hanging-braces-alist)
610 ;; If syntax is a function symbol, then call it using the
611 ;; defined semantics.
621 ;; Point is just after a newly inserted }. If the non-whitespace
622 ;; content of the braces is a single line of code, compact the whole
623 ;; construct to a single line, if this line isn't too long. The Right
624 ;; Thing is done with comments.
625 ;;
626 ;; Point will be left after the }, regardless of whether the clean-up is
627 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
631 mbeg1 mend1 mbeg4 mend4
632 eol-col cmnt-pos cmnt-col cmnt-gap)
637 ;; Avoid backtracking over a very large block. The one we
638 ;; deal with here can never be more than three lines.
669 ;; Necessary to put the closing brace before any line
670 ;; oriented comment to keep it syntactically significant.
671 ;; This isn't necessary for block comments, but the result
672 ;; looks nicer anyway.
688 ;; Can we trim space before comment to make the line fit?
694 t))))
698 "Insert a brace.
700 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
701 numeric ARG hasn't been supplied, the command performs several electric
702 actions:
705 the mode line) newlines are inserted before and after the brace as
706 directed by the settings in `c-hanging-braces-alist'.
708 \(b) Any auto-newlines are indented. The original line is also
709 reindented unless `c-syntactic-indentation' is nil.
711 \(c) If auto-newline is turned on, various newline cleanups based on the
712 settings of `c-cleanup-list' are done."
716 ;; We want to inhibit blinking the paren since this would be
717 ;; most disruptive. We'll blink it ourselves later on.
719 blink-paren-function case-fold-search)
725 ;; Insert the brace. Note that expand-abbrev might reindent
726 ;; the line here if there's a preceding "else" or something.
736 newlines
738 ; of the brace itself, of the line the brace ends up on.
750 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
754 ;; Only a plain newline for now - it's indented
755 ;; after the cleanups when the line has its final
756 ;; appearance.
761 ;; `syntax' is the syntactic context of the line which ends up
762 ;; with the brace on it.
765 ;; Do all appropriate clean ups
768 mbeg mend
769 )
771 ;; `}': clean up empty defun braces
776 syntax)
781 ;; make sure matching open brace isn't in a comment
787 ;; `}': compact to a one-liner defun?
796 ;; `{': clean up brace-else-brace and brace-elseif-brace
803 "else"
805 "{"
807 nil t))
819 ; (progn
820 ; (setq tmp (point))
824 "else"
826 "if"
830 ;(eq (match-end 0) tmp);
831 )
838 ;; Indent the line after the cleanups since it might
839 ;; very well indent differently due to them, e.g. if
840 ;; c-indent-one-line-block is used together with the
841 ;; one-liner-defun cleanup.
845 ;; does a newline go after the brace?
848 ))))
850 ;; blink the paren
853 old-blink-paren
860 "Insert a slash character.
862 If the slash is inserted immediately after the comment prefix in a c-style
863 comment, the comment might get closed by removing whitespace and possibly
866 Indent the line as a comment, if:
869 token and we are on a comment-only-line, or
872 comment.
874 If a numeric ARG is supplied, point is inside a literal, or
875 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
876 is inhibited."
879 indentp
880 ;; shut this up
883 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
884 ;; `c-syntactic-indentation' set.
891 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
902 c-syntactic-indentation
903 c-electric-flag
911 "Insert a star character.
912 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
913 the star is the second character of a C style comment starter on a
914 comment-only-line, indent the line as a comment. If a numeric ARG is
915 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
916 this indentation is inhibited."
920 ;; if we are in a literal, or if arg is given do not reindent the
921 ;; current line, unless this star introduces a comment-only line.
924 c-electric-flag
937 ))
940 "Insert a comma or semicolon.
942 If `c-electric-flag' is non-nil, point isn't inside a literal and a
943 numeric ARG hasn't been supplied, the command performs several electric
944 actions:
947 the mode line) a newline might be inserted. See the variable
948 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
950 \(b) Any auto-newlines are indented. The original line is also
951 reindented unless `c-syntactic-indentation' is nil.
953 \(c) If auto-newline is turned on, a comma following a brace list or a
954 semicolon following a defun might be cleaned up, depending on the
955 settings of `c-cleanup-list'."
959 ;; shut this up
969 ;; do all cleanups and newline insertions if c-auto-newline is on.
974 ;; clean ups: list-close-comma or defun-close-semi
987 ;; make sure matching open brace isn't in a comment
991 ;; reindent line
995 ;; check to see if a newline should be added
997 answer add-newline-p)
1000 ;; only nil value means continue checking
1004 ;; only 'stop specifically says do not add a newline
1006 ))
1009 )))))
1012 "Insert a colon.
1014 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
1015 numeric ARG hasn't been supplied, the command performs several electric
1016 actions:
1019 the mode line) newlines are inserted before and after the colon based on
1020 the settings in `c-hanging-colons-alist'.
1022 \(b) Any auto-newlines are indented. The original line is also
1023 reindented unless `c-syntactic-indentation' is nil.
1025 \(c) If auto-newline is turned on, whitespace between two colons will be
1027 `c-cleanup-list'."
1032 newlines is-scope-op
1033 ;; shut this up
1036 ;; Any electric action?
1038 ;; Unless we're at EOL, only re-indentation happens.
1043 ;; scope-operator clean-up?
1061 ;; indent the current line if it's done syntactically.
1063 ;; Cannot use the same syntax analysis as we find below,
1064 ;; since that's made with c-syntactic-indentation-in-macros
1065 ;; always set to t.
1068 ;; Calculate where, if anywhere, we want newlines.
1072 ;; Turn on syntactic macro analysis to help with auto newlines
1073 ;; only.
1076 ;; Translate substatement-label to label for this operation.
1081 ;; some language elements can only be determined by checking
1082 ;; the following line. Let's first look for ones that can be
1083 ;; found when looking on the line with the colon
1087 syntax c-hanging-colons-alist)
1094 c-hanging-colons-alist)))))
1095 ;; does a newline go before the colon? Watch out for already
1096 ;; non-hung colons. However, we don't unhang them because that
1097 ;; would be a cleanup (and anti-social).
1107 ;; does a newline go after the colon?
1111 ))))
1115 If the current language uses angle bracket parens (e.g. template
1116 arguments in C++), try to find out if the inserted character is a
1117 paren and give it paren syntax if appropriate.
1119 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1120 line will be reindented if the inserted character is a paren or if it
1121 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1122 numeric argument is supplied, or the point is inside a literal."
1126 final-pos found-delim case-fold-search)
1131 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1132 ;;;; property on the new < or > and its mate (if any) when they are template
1133 ;;;; parens. This is now done in an after-change function.
1135 ;; Indent the line if appropriate.
1139 ;; If a <, basically see if it's got "template" before it .....
1147 ;; ..... or is a C++ << operator.
1155 ;; It's a >. Either a template/generic terminator ...
1157 ;; or a C++ >> operator.
1170 blink-paren-function)
1171 ;; From now (2016-01-01), the syntax-table text properties on < and >
1172 ;; are applied in an after-change function, not during redisplay. Hence
1173 ;; we no longer need to call (sit-for 0) for blink paren to work.
1177 "Insert a parenthesis.
1179 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1180 line is reindented unless a numeric ARG is supplied, or the parenthesis
1181 is inserted inside a literal.
1183 Whitespace between a function name and the parenthesis may get added or
1184 removed; see the variable `c-cleanup-list'.
1186 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1187 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1190 ;; shut this up
1192 case-fold-search)
1197 ;; be most disruptive. We'll blink it ourselves
1198 ;; afterwards.
1200 blink-paren-function)
1204 ;; If we're at EOL, check for new-line clean-ups.
1208 ;; clean up brace-elseif-brace
1215 "else"
1217 "if"
1219 "("
1221 nil t)
1226 ;; clean up brace-catch-brace
1233 "catch"
1235 "("
1237 nil t)
1242 ;; Check for clean-ups at function calls. These two DON'T need
1243 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1244 ;; Point is currently just after the inserted paren.
1248 ;; space-before-funcall clean-up?
1256 ;; Don't add a space into #define FOO()....
1265 ;; compact-empty-funcall clean-up?
1279 old-blink-paren
1283 "Reindent the current line if appropriate.
1285 This function is used to reindent the line after a keyword which
1289 The line is reindented if there is nothing but whitespace before the
1290 keyword on the line, the keyword is not inserted inside a literal, and
1291 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1296 c-syntactic-indentation
1303 ;; Have to temporarily insert a space so that
1304 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1305 ;; space with a nonspace to avoid messing up any whitespace
1306 ;; sensitive meddling that might be done, e.g. by
1307 ;; `c-backslash-region'.
1313 \f
1320 ;; Recent Emacsen come with their own subword support. Use that.
1324 ;; Autoload directive for emacsen that doesn't have an older CC Mode
1325 ;; version in the dist.
1332 ;; "nomenclature" functions + c-scope-operator.
1334 "Compatibility alias for `c-forward-subword'."
1347 "Compatibility alias for `c-backward-subword'."
1356 'c-backward-into-nomenclature
1360 "Insert a double colon scope operator at point.
1365 \f
1366 ;; Movement (etc.) by defuns.
1368 ;; Return non-nil if point is between the closing brace and the semicolon of
1369 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1370 ;; portion of a declaration like "struct foo {...} bar ;".
1371 ;;
1372 ;; Return the position of the main declaration. Otherwise, return nil.
1373 ;; Point is assumed to be at the top level and outside of any macro or
1374 ;; literal.
1375 ;;
1376 ;; If LIM is non-nil, it is the bound on a the backward search for the
1377 ;; beginning of the declaration.
1378 ;;
1379 ;; This function might do hidden buffer changes.
1384 bod)
1388 ;; Look for struct or union or ... If we find one, it might
1389 ;; be the return type of a function, or the like. Exclude
1390 ;; this case.
1393 c-opt-block-decls-with-vars-key
1395 eo-block t t t)
1400 bod)))))
1403 ;; Determine where we are with respect to functions (or other brace
1404 ;; constructs, included in the term "function" in the rest of this comment).
1405 ;; Point is assumed to be outside any macro or literal.
1406 ;; This is used by c-\(beginning\|end\)-of-defun.
1407 ;;
1408 ;; Return one of these symbols:
1409 ;; at-header : we're at the start of a function's header.
1410 ;; in-header : we're inside a function's header, this extending right
1411 ;; up to the brace. This bit includes any k&r declarations.
1412 ;; in-block : we're inside a function's brace block.
1413 ;; in-trailer : we're in the area between the "}" and ";" of something
1414 ;; like "struct foo {...} bar, baz;".
1415 ;; at-function-end : we're just after the closing brace (or semicolon) that
1416 ;; terminates the function.
1417 ;; outwith-function: we're not at or in any function. Being inside a
1418 ;; non-brace construct also counts as 'outwith-function'.
1419 ;;
1420 ;; This function might do hidden buffer changes.
1423 decl-result brace-decl-p
1440 ;; Find the start of the current declaration. NOTE: If we're in the
1441 ;; variables after a "struct/eval" type block, we don't get to the
1442 ;; real declaration here - we detect and correct for this later.
1444 ;;If we're in the parameters' parens, move back out of them.
1446 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1447 ;; at a declaration.
1455 ;; NOTE: If we're in a K&R region, this might be the start
1456 ;; of a parameter declaration, not the actual function.
1457 ;; It might also leave us at a label or "label" like
1458 ;; "private:".
1462 ;; Has the declaration we've gone back to got braces?
1469 ;; Might have stopped on the
1470 ;; ';' in a K&R argdecl. In
1471 ;; that case the declaration
1472 ;; should contain a block.
1482 'at-header
1488 'at-function-end
1491 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1492 decl-result))))))))
1495 ;; Skip to the opening brace of the Nth function before point. If
1496 ;; point is inside a function, this counts as the first. Point must be
1497 ;; outside any comment/string or macro.
1498 ;;
1499 ;; N must be strictly positive.
1500 ;; WHERE describes the position of point, one of the symbols `at-header',
1501 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1502 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1503 ;;
1504 ;; If we run out of functions, leave point at BOB. Return zero on success,
1505 ;; otherwise the number of {s still to go.
1506 ;;
1507 ;; This function may do hidden buffer changes
1509 ;; What we do to go back the first defun depends on where we start.
1525 ;; Each time round the loop, go back to a "{" at the outermost level.
1528 ; by a factor of ~6. Hmmm. 2006/4/5.
1533 n)
1536 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1537 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1538 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1539 ;; otherwise include the braces and the declaration which introduces them.
1540 ;; If the closing brace is missing, (point-max) is used instead. LEVEL, if
1541 ;; non-nil, says narrow to the LEVELth decl-block outward, default value
1542 ;; being 1.
1544 encl-decl)
1570 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1571 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1572 ;; braces NOT being included in the resulting region. On no account may the
1573 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1574 ;; PAREN-STATE is a list of buffer positions in the style of
1575 ;; (c-parse-state), one of which will be that of the desired opening brace,
1576 ;; if there is one.
1577 ;;
1578 ;; Return the position of the enclosing opening brace, or nil
1592 orig-point-max)))
1593 encl-decl)
1595 nil)))
1599 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1600 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1601 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1602 ;; buffer's original restriction.
1603 ;;
1604 ;; This is a very special purpose macro, which assumes the existence of
1605 ;; several variables. It is for use only in c-beginning-of-defun and
1606 ;; c-end-of-defun.
1610 lim)
1613 paren-state orig-point-min orig-point-max))
1617 "Move backward to the beginning of a defun.
1618 Every top level declaration that contains a brace paren block is
1619 considered to be a defun.
1621 With a positive argument, move backward that many defuns. A negative
1622 argument -N means move forward to the Nth following beginning. Return
1623 t unless search stops due to beginning or end of buffer.
1625 Unlike the built-in `beginning-of-defun' this tries to be smarter
1626 about finding the char with open-parenthesis syntax that starts the
1627 defun."
1639 end-of-defun-function
1642 lim ; Position of { which has been widened to.
1643 where pos case-fold-search)
1648 paren-state orig-point-min orig-point-max)))
1650 ;; Move back out of any macro/comment/string we happen to be in.
1658 ;; Move forward to the closing brace of a function.
1665 ;; Move forward to the next opening brace....
1672 ;; ... and backward to the function header.
1674 t))
1676 ;; Move backward to the opening brace of a function, making successively
1677 ;; larger portions of the buffer visible as necessary.
1683 ;; Go backward to this function's header.
1687 ;; We're now there, modulo comments and whitespace.
1688 ;; Try to be line oriented; position point at the closest
1689 ;; preceding boi that isn't inside a comment, but if we hit
1690 ;; the previous declaration then we use the current point
1691 ;; instead.
1701 ;; Skip to the closing brace of the Nth function after point. If
1702 ;; point is inside a function, this counts as the first. Point must be
1703 ;; outside any comment/string or macro.
1704 ;;
1705 ;; N must be strictly positive.
1706 ;; WHERE describes the position of point, one of the symbols `at-header',
1707 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1708 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1709 ;;
1710 ;; If we run out of functions, leave point at EOB. Return zero on success,
1711 ;; otherwise the number of }s still to go.
1712 ;;
1713 ;; This function may do hidden buffer changes.
1716 ;; What we do to go forward over the first defun depends on where we
1717 ;; start. We go to the closing brace of that defun, even when we go
1718 ;; backwards to it (in a "struct foo {...} bar ;").
1734 ;; Each time round the loop, go forward to a "}" at the outermost level.
1736 ;(c-parse-state) ; This call speeds up the following one by a factor
1737 ; of ~6. Hmmm. 2006/4/5.
1742 n)
1745 "Move forward to the end of a top level declaration.
1746 With argument, do it that many times. Negative argument -N means move
1747 back to Nth preceding end. Returns t unless search stops due to
1748 beginning or end of buffer.
1750 An end of a defun occurs right after the close-parenthesis that matches
1751 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1762 end-of-defun-function
1765 lim
1766 where pos case-fold-search)
1771 paren-state orig-point-min orig-point-max)))
1773 ;; Move back out of any macro/comment/string we happen to be in.
1781 ;; Move backwards to the } of a function
1793 ;; Move forward to the } of a function
1798 ;; Do we need to move forward from the brace to the semicolon?
1804 ;; We're there now, modulo comments and whitespace.
1805 ;; Try to be line oriented; position point after the next
1806 ;; newline that isn't inside a comment, but if we hit the
1807 ;; next declaration then we use the current point instead.
1821 "Return the name of the current defun, or NIL if there isn't one.
1823 with a brace block."
1827 where pos name-end case-fold-search)
1832 ;; Move back out of any macro/comment/string we happen to be in.
1839 ;; Move to the beginning of the current defun, if any, if we're not
1840 ;; already there.
1842 nil
1850 ;; Pick out the defun name, according to the type of defun.
1852 ;; struct, union, enum, or similar:
1863 ; be several identifiers.
1867 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1868 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1884 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1885 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1888 ;; Objc selectors.
1900 ;; Normal function or initializer.
1913 ;; Return a cons of the beginning and end positions of the current
1914 ;; top level declaration or macro. If point is not inside any then
1915 ;; nil is returned, unless NEAR is non-nil in which case the closest
1916 ;; following one is chosen instead (if there is any). The end
1917 ;; position is at the next line, providing there is one before the
1918 ;; declaration.
1919 ;;
1920 ;; This function might do hidden buffer changes.
1925 lim pos end-pos where)
1926 ;; Narrow enclosing brace blocks out, as required by the values of
1927 ;; `c-defun-tactic', `near', and the position of point.
1944 ;; Note: Some code duplication in `c-beginning-of-defun' and
1945 ;; `c-end-of-defun'.
1949 ;; If we moved to the outermost enclosing paren
1950 ;; then we can use c-safe-position to set the
1951 ;; limit. Can't do that otherwise since the
1952 ;; earlier paren pair on paren-state might very
1953 ;; well be part of the declaration we should go
1954 ;; to.
1956 t)
1957 ;; At top level. Make sure we aren't inside a literal.
1979 ;; We moved back over the previous defun. Skip to the next
1980 ;; one. Not using c-forward-syntactic-ws here since we
1981 ;; should not skip a macro. We can also be directly after
1982 ;; the block in a `c-opt-block-decls-with-vars-key'
1983 ;; declaration, but then we won't move significantly far
1984 ;; here.
1998 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1999 ;; declaration that doesn't end there. We're searching back and
2000 ;; forth over the block here, which can be expensive.
2012 nil
2016 nil
2018 ;; Try to be line oriented; position the limits at the
2019 ;; closest preceding boi, and after the next newline, that
2020 ;; isn't inside a comment, but if we hit a neighboring
2021 ;; declaration then we instead use the exact declaration
2022 ;; limit in that direction.
2028 pos
2044 pos))))))
2052 "Put mark at end of the current top-level declaration or macro, point at beginning.
2053 If point is not inside any then the closest following one is
2054 chosen. Each successive call of this command extends the marked
2055 region by one function.
2057 A mark is left where the command started, unless the region is already active
2058 \(in Transient Mark mode).
2061 function does not require the declaration to contain a brace block."
2066 ;; We try to be line oriented, unless there are several
2067 ;; declarations on the same line.
2094 "Return the name of the current CPP macro, or NIL if we're not in one."
2103 \f
2104 ;; Movement by statements.
2106 ;; Point is within a comment. Is it also within a comment-prefix?
2107 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2108 ;;
2109 ;; This function might do hidden buffer changes.
2119 ;; Narrow to the "inside" of the comment (block) defined by range, as
2120 ;; follows:
2121 ;;
2122 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2123 ;; present) removed. A c++-style line comment retains its opening "//" but
2124 ;; has any final NL removed. If POINT is currently outwith these innards,
2125 ;; move it to the appropriate boundary.
2126 ;;
2127 ;; This narrowing simplifies the sentence movement functions, since it
2128 ;; eliminates awkward things at the boundaries of the comment (block).
2129 ;;
2130 ;; This function might do hidden buffer changes.
2148 ;; Move backwards to the "beginning of a sentence" within the comment
2149 ;; defined by RANGE, a cons of its starting and ending positions. If we
2150 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2151 ;; of the comment and return T.
2152 ;;
2153 ;; The BOS is either text which follows a regexp match of sentence-end,
2154 ;; or text which is a beginning of "paragraph".
2155 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2156 ;;
2157 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2158 ;; It is not a general function, but is intended only for calling from
2159 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2160 ;;
2161 ;; This function might do hidden buffer changes.
2167 last
2173 ;; First, find the previous paragraph start, if any.
2177 ; paragraph-\(start\|separate\)
2186 ;; Now seek successively earlier sentence ends between PAR-BEG and
2187 ;; HERE, until the "start of sentence" following it is earlier than
2188 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2206 nil
2208 t))))
2211 ;; Move forward to the "end of a sentence" within the comment defined by
2212 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2213 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2214 ;; return NIL. Otherwise, move point to just after the end of the comment
2215 ;; and return T.
2216 ;;
2217 ;; The EOS is just after the non-WS part of the next match of the regexp
2218 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2219 ;; no sentence-end match following point, any WS before the end of the
2220 ;; comment will count as EOS, providing we're not already in it.
2221 ;;
2222 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2223 ;; It is not a general function, but is intended only for calling from
2224 ;; c-move-over-sentence.
2225 ;;
2226 ;; This function might do hidden buffer changes.
2229 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2230 )
2236 ;; The cc-mode values of paragraph-\(start\|separate\), set
2237 ;; in c-setup-paragraph-variables, are used in the
2238 ;; following.
2247 last
2250 ;; Go forward one "comment-prefix which looks like sentence-end"
2251 ;; each time round the following:
2262 ;; Take special action if we're up against the end of a comment (of
2263 ;; either sort): Leave point just after the last non-ws text.
2270 nil
2272 t))))
2275 ;; Move backwards to the "beginning of a sentence" within the string defined
2276 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2277 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2278 ;; just before the start of the string and return T.
2279 ;;
2280 ;; The BOS is either the text which follows a regexp match of sentence-end
2281 ;; or text which is a beginning of "paragraph". For the purposes of
2282 ;; determining paragraph boundaries, escaped newlines are treated as
2283 ;; ordinary newlines.
2284 ;;
2285 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2286 ;; It is not a general function, but is intended only for calling from
2287 ;; c-move-over-sentence.
2288 ;;
2289 ;; This function might do hidden buffer changes.
2295 ;; Enhance paragraph-start and paragraph-separate also to recognize
2296 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2297 ;; these values should be customizable user options, or something.
2306 ; paragraph-\(start\|separate\)
2314 ;; Now see if we can find a sentence end after PAR-BEG.
2322 ; than here, in case point starts
2323 ; beyond the closing quote.
2328 nil
2330 t))))
2333 ;; Move forward to the "end of a sentence" within the string defined by
2334 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2335 ;; return NIL. Otherwise, move point to just after the end of the string
2336 ;; and return T.
2337 ;;
2338 ;; The EOS is just after the non-WS part of the next match of the regexp
2339 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2340 ;; no sentence-end match following point, any WS before the end of the
2341 ;; string will count as EOS, providing we're not already in it.
2342 ;;
2343 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2344 ;; It is not a general function, but is intended only for calling from
2345 ;; c-move-over-sentence.
2346 ;;
2347 ;; This function might do hidden buffer changes.
2350 last
2351 ;; Enhance paragraph-start and paragraph-separate to recognize
2352 ;; blank lines terminated by escaped EOLs.
2360 ;; The above values of paragraph-\(start\|separate\) are used
2361 ;; in the following.
2364 ;; (re-search-backward filler-here nil t) would find an empty
2365 ;; string. Therefore we simulate it by the following:
2374 ;; Try to go forward a sentence.
2379 ;; Did we move a sentence, or did we hit the end of the string?
2381 nil
2383 t))))
2386 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2387 ;; If a literal is the next thing (aside from whitespace) to be found before
2388 ;; point, return a cons of its start.end positions (enclosing the
2389 ;; delimiters). Otherwise return NIL.
2390 ;;
2391 ;; This function might do hidden buffer changes.
2395 pos)
2399 ;; to prevent `looking-at' seeing a " at point.
2403 ;; An EOL can act as an "open string" terminator in AWK.
2414 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2415 ;; If a literal is the next thing (aside from whitespace) following point,
2416 ;; return a cons of its start.end positions (enclosing the delimiters).
2417 ;; Otherwise return NIL.
2418 ;;
2419 ;; This function might do hidden buffer changes.
2432 ;; Does point immediately follow a statement "terminator"? A virtual
2433 ;; semicolon is regarded here as such. So is an opening brace ;-)
2434 ;;
2435 ;; This function might do hidden buffer changes.
2443 ;; The following (for macros) is not strict about exactly where we are
2444 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2445 ;; much. ACM 2004/3/29.
2457 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2458 ;; stopping before reaching BOB or a literal or the boundary of a
2459 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2460 ;; the position of the '#' beginning the current preprocessor directive, or
2461 ;; NIL if we're not in such.
2462 ;;
2463 ;; Return a cons (A.B), where
2464 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2465 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2466 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2467 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2468 ;;
2469 ;; The total collection of returned values is as follows:
2470 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2471 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2472 ;; a BOS - the caller must check this.
2473 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2474 ;; moved and reached the opening # of the macro.
2475 ;; (t . macro-boundary): Every other circumstance in which we're at a
2476 ;; macro-boundary. We might be at a BOS.
2477 ;;
2478 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2479 ;; code before encountering the literal/BOB or macro-boundary.
2480 ;;
2481 ;; Note that this function moves within either preprocessor commands
2482 ;; (macros) or normal code, but will not cross a boundary between the two,
2483 ;; or between two distinct preprocessor commands.
2484 ;;
2485 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2486 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2487 ;; move into parens. Also stop before `#' when it's at boi on a line.
2488 ;;
2489 ;; This function might do hidden buffer changes.
2493 ; semicolon precedes it.
2498 ;; Stop at the token after a comment.
2503 ;; If we've gone back over a LF, we might have moved into or out of
2504 ;; a preprocessor line.
2512 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2517 ;; Have we found a virtual semicolon? If so, stop, unless the next
2518 ;; statement is where we started from.
2525 ;; Hit the beginning of the buffer/region?
2531 ;; Move back a character.
2534 ;; Stop at "{" (unless it's a PIKE special brace list.)
2543 ;; Have we reached the start of a macro? This always counts as
2544 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2545 ;; here. FIXME!!! ACM 2004/3/29)
2549 ;; Stop at token just after "}" or ";".
2551 ;; If we've gone back over ;, {, or }, we're done.
2560 ;; Stop at the token after a string.
2565 ;; Nothing special: go back word characters.
2567 ))))))
2570 ;; Move forwards over code, stopping before reaching EOB or a literal
2571 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2572 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2573 ;; terminates the current preprocessor directive, or NIL if we're not in
2574 ;; such.
2575 ;;
2576 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2577 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2578 ;; seems unavoidable. Depending on the context this function is called
2579 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2580 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2581 ;; semicolons, or anything else.
2582 ;;
2583 ;; Return a cons (A.B), where
2584 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2585 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2586 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2587 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2588 ;;
2589 ;; Point is left either after the end-of-statement, or at the last non-ws
2590 ;; code before encountering the literal, or the # of the preprocessor
2591 ;; statement, or at EOB [or just after last non-WS stuff??].
2592 ;;
2593 ;; As a clarification of "after the end-of-statement", if a comment or
2594 ;; whitespace follows a completed AWK statement, that statement is treated
2595 ;; as ending just after the last non-ws character before the comment.
2596 ;;
2597 ;; Note that this function moves within either preprocessor commands
2598 ;; (macros) or normal code, but not both within the same invocation.
2599 ;;
2600 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2601 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2602 ;; stop before `{' if at top level or inside braces, though. Move by
2603 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2604 ;; the boi.
2605 ;;
2606 ;; This function might do hidden buffer changes.
2608 last)
2613 ;; If we've moved forward to a virtual semicolon, we're done.
2620 ;; Gone past the end of a macro?
2625 ;; About to hit a comment?
2630 ;; End of buffer?
2636 ;; If we encounter a '{', stop just after the previous token.
2642 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2643 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2644 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2645 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2651 ;; End of a PIKE special brace list? If so, step over it and continue.
2660 ;; Have we got a '}' after having moved? If so, stop after the
2661 ;; previous token.
2667 ;; Stop if we encounter a preprocessor line. Continue if we
2668 ;; hit a naked #
2677 ;; Stop after a ';', '}', or "};"
2682 ;; Found a string (this subsumes AWK regexps)?
2693 )))))
2696 ;; Is the literal defined by RANGE a string contained in a single line?
2697 ;;
2698 ;; This function might do hidden buffer changes.
2706 "Go to the beginning of the innermost C statement.
2707 With prefix arg, go back N - 1 statements. If already at the
2708 beginning of a statement then go to the beginning of the closest
2709 preceding one, moving into nested blocks if necessary (use
2711 comment or multiline string, move by sentences instead of statements.
2713 When called from a program, this function takes 3 optional args: the
2714 repetition count, a buffer position limit which is the farthest back
2715 to search for the syntactic context, and a flag saying whether to do
2716 sentence motion in or near comments and multiline strings.
2718 Note that for use in programs, `c-beginning-of-statement-1' is
2719 usually better. It has much better defined semantics than this one,
2720 which is intended for interactive use, and might therefore change to
2723 nil t))
2728 last ; start point for going back ONE chunk. Updated each chunk movement.
2731 res ; result from sub-function call
2732 not-bos ; "not beginning-of-statement"
2733 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2735 ;; Go back one statement at each iteration of the following loop.
2738 ;; Go back one "chunk" each time round the following loop, stopping
2739 ;; when we reach a statement boundary, etc.
2743 ; statement boundary, non-NIL otherwise.
2746 nil)
2750 ;; Single line string or sentence-flag is null => skip the
2751 ;; entire literal.
2756 ;; N.B. The following is essentially testing for an AWK regexp
2757 ;; at BOS:
2758 ;; Was the previous non-ws thing an end of statement?
2765 ;; Comment inside a statement or a multi-line string.
2771 res)))
2773 ;; Non-literal code.
2780 ;; We're at a tentative BOS. The next form goes
2781 ;; back over WS looking for an end of previous
2782 ;; statement.
2788 ;; Are we about to move backwards into or out of a
2789 ;; preprocessor command? If so, locate its beginning.
2797 ;; Are we about to move backwards into a literal?
2800 not-bos))
2807 "Go to the end of the innermost C statement.
2808 With prefix arg, go forward N - 1 statements. Move forward to the end
2809 of the next statement if already at end, and move into nested blocks
2811 comment or multiline string, move by sentences instead of statements.
2813 When called from a program, this function takes 3 optional args: the
2814 repetition count, a buffer position limit which is the farthest back
2815 to search for the syntactic context, and a flag saying whether to do
2816 sentence motion in or near comments and multiline strings."
2818 nil t))
2828 res
2829 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2831 ;; Go back/forward one statement at each iteration of the following loop.
2836 ;; Go forward one "chunk" each time round the following loop, stopping
2837 ;; when we reach a statement boundary, etc.
2840 ; statement boundary, non-NIL otherwise.
2843 nil)
2847 ;; sentence-flag is null => skip the entire literal.
2848 ;; or a Single line string.
2853 ;; Is there a virtual semicolon here (e.g. for AWK)?
2856 ;; Comment or multi-line string.
2862 ;; If we've just come forward out of a literal, check for
2863 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2864 ;; some other language may do in the future)
2868 ;; Non-literal code.
2871 ;; Are we about to move forward into or out of a
2872 ;; preprocessor command?
2887 ;; Are we about to move forward into a literal?
2895 \f
2896 ;; set up electric character functions to work with pending-del,
2897 ;; (a.k.a. delsel) mode. All symbols get the t value except
2898 ;; the functions which delete, which gets 'supersede, and (from Emacs
2899 ;; 25) `c-electric-brace' and `c-electric-paren' get special handling
2900 ;; so as to work gracefully with `electric-pair-mode'.
2907 c-electric-slash
2908 c-electric-star
2909 c-electric-semi&comma
2910 c-electric-lt-gt
2911 c-electric-colon))
2916 'delete-selection-uses-region-p
2917 t))
2920 c-electric-paren))
2928 \f
2929 ;; Inserting/indenting comments
2931 ;; This function might do hidden buffer changes.
2944 ;; Do not pad with one space if we're at bol.
2945 value
2956 ;; Found comment to align with.
2958 ;; Do not pad with one space if we're at bol.
2959 0
2961 ;; Recurse to handle value as a new spec.
2965 "Used by `indent-for-comment' to create and indent comments.
2966 See `c-indent-comment-alist' for a description."
2994 case-fold-search)
2996 c-indent-comments-syntactically-p)
2998 ;; BOGOSITY ALERT: if we're looking at the eol, its
2999 ;; because indent-for-comment hasn't put the comment-start
3000 ;; in the buffer yet. this will screw up the syntactic
3001 ;; analysis so we kludge in the necessary info. Another
3002 ;; kludge is that if we're at the bol, then we really want
3003 ;; to ignore any anchoring as specified by
3004 ;; c-comment-only-line-offset since it doesn't apply here.
3009 c-comment-only-line-offset
3011 c-comment-only-line-offset))))
3016 \f
3017 ;; used by outline-minor-mode
3020 ;; in otherwise-hidden text.
3025 \f
3026 ;; Movement by CPP conditionals.
3028 "Move back to the containing preprocessor conditional, leaving mark behind.
3029 A prefix argument acts as a repeat count. With a negative argument,
3030 move forward to the end of the containing preprocessor conditional.
3033 function stops at them when going backward, but not when going
3034 forward."
3044 directives."
3052 "Move forward into the next preprocessor conditional, leaving mark behind.
3053 A prefix argument acts as a repeat count. With a negative argument,
3054 move backward into the previous preprocessor conditional.
3057 function stops at them when going forward, but not when going
3058 backward."
3068 directives."
3076 "Move back across a preprocessor conditional, leaving mark behind.
3077 A prefix argument acts as a repeat count. With a negative argument,
3078 move forward across a preprocessor conditional.
3080 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3081 and have the same meanings as in `c-scan-conditionals'. If you
3082 are calling c-forward-conditional from a program, you might want
3083 to call `c-scan-conditionals' directly instead."
3091 "Move forward across a preprocessor conditional, leaving mark behind.
3092 A prefix argument acts as a repeat count. With a negative argument,
3093 move backward across a preprocessor conditional.
3095 If there aren't enough conditionals after \(or before) point, an
3096 error is signaled.
3099 the nesting level isn't changed when tracking subconditionals.
3101 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3102 and have the same meanings as in `c-scan-conditionals'. If you
3103 are calling c-forward-conditional from a program, you might want
3104 to call `c-scan-conditionals' directly instead."
3111 "Scan forward across COUNT preprocessor conditionals.
3112 With a negative argument, scan backward across preprocessor
3113 conditionals. Return the end position. Point is not moved.
3115 If there aren't enough preprocessor conditionals, throw an error.
3118 the nesting level isn't changed when tracking subconditionals.
3120 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3121 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3122 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3123 counts as -1.
3126 are treated as conditional clause limits. Normally they are ignored."
3130 new case-fold-search)
3136 ;; subdepth is the depth in "uninteresting" subtrees,
3137 ;; i.e. those that takes us farther from the target
3138 ;; depth instead of closer.
3140 found)
3142 ;; Find the "next" significant line in the proper direction.
3144 ;; Rather than searching for a # sign that
3145 ;; comes at the beginning of a line aside from
3146 ;; whitespace, search first for a string
3147 ;; starting with # sign. Then verify what
3148 ;; precedes it. This is faster on account of
3149 ;; the fastmap feature of the regexp matcher.
3152 nil t))
3154 ;; Now verify it is really a preproc line.
3162 ;; When we're not in an "uninteresting"
3163 ;; subtree, we might want to act on "elif"
3164 ;; and "else" too.
3166 ;; Always move toward the target depth.
3171 ;; Ignore the change if it'd take us
3172 ;; into an "uninteresting" subtree.
3180 ;; If we are trying to move across, and we find an
3181 ;; end before we find a beginning, get an error.
3184 "No following conditional at this level"
3186 ;; When searching forward, start from next line so
3187 ;; that we don't find the same line again.
3189 ;; We found something if we've arrived at the
3190 ;; target depth.
3193 ;; else
3200 new))
3202 \f
3203 ;; commands to indent lines, regions, defuns, and expressions
3205 "Indent current line as C code, and/or insert some whitespace.
3207 If `c-tab-always-indent' is t, always just indent the current line.
3208 If nil, indent the current line only if point is at the left margin or
3209 in the line's indentation; otherwise insert some whitespace[*]. If
3210 other than nil or t, then some whitespace[*] is inserted only within
3211 literals (comments and strings), but the line is always reindented.
3213 If `c-syntactic-indentation' is t, indentation is done according to
3214 the syntactic context. A numeric argument, regardless of its value,
3215 means indent rigidly all the lines of the expression starting after
3216 point so that this line becomes properly indented. The relative
3217 indentation among the lines of the expression is preserved.
3219 If `c-syntactic-indentation' is nil, the line is just indented one
3220 step according to `c-basic-offset'. In this mode, a numeric argument
3221 indents a number of such steps, positive or negative, and an empty
3222 prefix argument is equivalent to -1.
3224 [*] The amount and kind of whitespace inserted is controlled by the
3225 variable `c-insert-tab-function', which is called to do the actual
3226 insertion of whitespace. Normally the function in this variable
3227 just inserts a tab character, or the equivalent number of spaces,
3228 depending on the variable `indent-tabs-mode'."
3237 -1
3245 ;; Realign the line continuation backslash if inside a macro.
3247 ))))
3249 ;; If c-syntactic-indentation and got arg, always indent this
3250 ;; line as C and shift remaining lines of expression the same
3251 ;; amount.
3255 beg end)
3260 shift-amt))
3272 ;; Else use c-tab-always-indent to determine behavior.
3274 ;; CASE 1: indent when at column zero or in line's indentation,
3275 ;; otherwise insert a tab
3282 ;; CASE 2: just indent the line
3285 ;; CASE 3: if in a literal, insert a tab, but always indent the
3286 ;; line
3291 )))))
3294 "Indent each line in the balanced expression following point syntactically.
3295 If optional SHUTUP-P is non-nil, no errors are signaled if no
3296 balanced expression is found."
3299 end)
3303 ;; Find the closest following open paren that
3304 ;; ends on another line.
3312 ;; sanity check
3328 "Indent the current top-level declaration or macro syntactically.
3329 In the macro case this also has the effect of realigning any line
3330 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3336 ;; We try to be line oriented, unless there are several
3337 ;; declarations on the same line.
3349 "Indent syntactically every line whose first char is between START
3350 and END inclusive. If the optional argument QUIET is non-nil then no
3351 syntactic errors are reported, even if `c-report-syntactic-errors' is
3352 non-nil."
3358 ;; Advance to first nonblank line.
3366 ;; shut up any echo msgs on indiv lines
3372 start))
3374 syntax)
3382 ;; update progress
3384 ;; skip empty lines
3387 ;; Get syntax and indent.
3393 ;; End of current multi-line macro?
3396 ;; Fixup macro backslashes.
3399 ;; New multi-line macro?
3411 c-parsing-error))))
3414 ;; Function version of the macro for use in places that aren't
3415 ;; compiled, e.g. in the menus.
3419 "Indent active region, current line, or block starting on this line.
3420 In Transient Mark mode, when the region is active, reindent the region.
3421 Otherwise, with a prefix argument, rigidly reindent the expression
3422 starting on the current line.
3423 Otherwise reindent just the current line."
3429 \f
3430 ;; for progress reporting
3435 ;; Be silent
3437 ;; Start the progress update messages. If this Emacs doesn't have
3438 ;; a built-in timer, just be dumb about it.
3441 ;; If progress has already been initialized, do nothing. otherwise
3442 ;; initialize the counter with a vector of:
3443 ;; [start end lastsec context]
3450 context))
3452 ))
3456 nil
3461 ;; should we update? currently, update happens every 2 seconds,
3462 ;; what's the right value?
3468 )))
3472 nil
3481 \f
3482 ;;; This page handles insertion and removal of backslashes for C macros.
3485 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3486 With no argument, inserts backslashes and aligns existing backslashes.
3487 With an argument, deletes the backslashes. The backslash alignment is
3488 done according to the settings in `c-backslash-column',
3489 `c-backslash-max-column' and `c-auto-align-backslashes'.
3491 This function does not modify blank lines at the start of the region.
3492 If the region ends at the start of a line and the macro doesn't
3493 continue below it, the backslash (if any) at the end of the previous
3494 line is deleted.
3496 You can put the region around an entire macro definition and use this
3497 command to conveniently insert and align the necessary backslashes."
3500 ;; Keep the backslash trimming functions from changing the
3501 ;; whitespace around point, since in this case it's only the
3502 ;; position of point that tells the indentation of the line.
3508 column longest-line-col bs-col-after-end)
3512 ;; Nothing to do if to is at bob, since we should back up
3513 ;; and there's no line to back up to.
3514 nil
3516 ;; Do not back up the to line if line-mode is set, to make
3517 ;; e.g. c-newline-and-indent consistent regardless whether
3518 ;; the (newline) call leaves point at bol or not.
3526 ;; Set bs-col-after-end to the column of any backslash
3527 ;; following the region, or nil if there is none.
3536 ;; Back up the to line if line-mode is set, since the line
3537 ;; after the newly inserted line break should not be
3538 ;; touched in c-newline-and-indent.
3541 ;; Set bs-col-after-end to non-nil in any case, since we
3542 ;; do not want to delete the backslash at the last line.
3547 ;; Compute the smallest column number past the ends of all
3548 ;; the lines.
3552 ;; Include one more line in the max column
3553 ;; calculation, since the to line will be backslashed
3554 ;; too.
3567 ;; Try to align with surrounding backslashes.
3576 ;; Both a preceding and a following backslash.
3577 ;; Choose the greatest of them.
3580 ;; No preceding backslash. Try to align with one
3581 ;; following the region. Disregard the backslash at the
3582 ;; to line since it's likely to be bogus (e.g. when
3583 ;; called from c-newline-and-indent).
3586 ;; Don't modify blank lines at start of region.
3591 ;; Don't try to align with surrounding backslashes if
3592 ;; any line is too long.
3595 ;; Impose minimum limit and tab width alignment only if
3596 ;; we can't align with surrounding backslashes.
3600 tab-width)
3601 tab-width)))
3603 longest-line-col)))
3604 ;; Always impose maximum limit.
3607 ;; Add backslashes on all lines if the macro continues
3608 ;; after the to line.
3612 ;; Add backslashes on all lines except the last, and
3613 ;; remove any on the last line.
3621 ;; The function above leaves point on the line
3622 ;; following endmark.
3647 ;; Avoid unnecessary changes of the buffer.
3649 ;; Don't realign backslashes in string literals
3650 ;; since that would change them.
3651 )
3677 ;; Make sure there are backslashes with at least one space in
3678 ;; front of them.
3713 point-pos))
3719 \f
3720 ;;; Line breaking and paragraph filling.
3726 ;; The filling code is based on a simple theory; leave the intricacies
3727 ;; of the text handling to the currently active mode for that
3728 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3729 ;; possible to make them work correctly wrt the comment and string
3730 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3731 ;; to it, there's quite a lot of special cases to handle which makes
3732 ;; the code anything but simple. The intention is that it will work
3733 ;; with any well-written text filling package that preserves a fill
3734 ;; prefix.
3735 ;;
3736 ;; We temporarily mask comment starters and enders as necessary for
3737 ;; the filling code to do its job on a seemingly normal text block.
3738 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3739 ;; preserve it correctly (especially important when filling C++ style
3740 ;; line comments). By default, we set up and use adaptive-fill-mode,
3741 ;; which is standard in all supported Emacs flavors.
3744 ;; Determine the appropriate comment fill prefix for a block or line
3745 ;; comment. Return a cons of the prefix string and the column where
3746 ;; it ends. If fill-prefix is set, it'll override. Note that this
3747 ;; function also uses the value of point in some heuristics.
3748 ;;
3749 ;; This function might do hidden buffer changes.
3753 c-current-comment-prefix
3756 prefix-regexp
3757 comment-start-skip))
3758 prefix-line comment-prefix res comment-text-end)
3763 ;; Ugly way of getting the column after the fill
3764 ;; prefix; it'd be nice with a current-column
3765 ;; that works on strings..
3775 ;; Set fallback for comment-prefix if none is found.
3781 ;; The current line is not the comment starter, so the
3782 ;; comment has more than one line, and it can therefore be
3783 ;; used to find the comment fill prefix.
3789 ;; The line after the comment starter is inside the
3790 ;; comment, so we can use it.
3793 ;; The comment is only one line. Take the comment prefix
3794 ;; from it and keep the indentation.
3803 ;; There is only whitespace before the comment
3804 ;; starter; take the prefix straight from this line.
3809 ;; There is code before the comment starter, so we
3810 ;; have to temporarily insert and indent a new line to
3811 ;; get the right space/tab mix in the indentation.
3813 tmp)
3829 ;; The prefix ends the line with no whitespace
3830 ;; after it. Default to a single space.
3832 )))))
3845 ;; The current line is not the comment starter and
3846 ;; contains more than just the ender, so it's good enough
3847 ;; to be used for the comment fill prefix.
3857 ;; The comment is either one line or the next line contains
3858 ;; just the comment ender. In this case we have no
3859 ;; information about a suitable comment prefix, so we resort
3860 ;; to c-block-comment-prefix.
3864 ;; The point was on the comment opener line, so we might want
3865 ;; to treat this as a not yet closed comment.
3869 ;; Above `prefix-regexp' matched a nonempty prefix on the
3870 ;; second line, so let's use it. Normally it should do
3871 ;; to set `prefix-line' and let the code below pick up
3872 ;; the whole prefix, but if there's no text after the
3873 ;; match then it will probably fall back to no prefix at
3874 ;; all if the comment isn't closed yet, so in that case
3875 ;; it's better to force use of the prefix matched now.
3880 ;; There's no nonempty prefix on the line after the
3881 ;; comment opener. If the line is empty, or if the
3882 ;; text on it has less or equal indentation than the
3883 ;; comment starter we assume it's an unclosed
3884 ;; comment starter, i.e. that
3885 ;; `c-block-comment-prefix' should be used.
3886 ;; Otherwise we assume it's a closed comment where
3887 ;; the prefix really is the empty string.
3888 ;; E.g. this is an unclosed comment:
3889 ;;
3890 ;; /*
3891 ;; foo
3892 ;;
3893 ;; But this is not:
3894 ;;
3895 ;; /*
3896 ;; foo
3897 ;; */
3898 ;;
3899 ;; (Looking for the presence of the comment closer
3900 ;; rarely works since it's probably the closer of
3901 ;; some comment further down when the comment
3902 ;; really is unclosed.)
3911 ;; Otherwise the line after the comment starter is good
3912 ;; enough to find the prefix in.
3916 ;; Haven't got the comment prefix on any real line that we
3917 ;; can take it from, so we have to temporarily insert
3918 ;; `comment-prefix' on a line and indent it to find the
3919 ;; correct column and the correct mix of tabs and spaces.
3928 comment-text-end))
3933 ;; If there's ws on the current line, we'll use it
3934 ;; instead of what's ending comment-prefix.
3939 comment-prefix))
3948 ;; We insert an extra non-whitespace character
3949 ;; before the line break and after comment-prefix in
3950 ;; case it's "" or ends with whitespace.
3969 ;; prefix-line is the bol of a line on which we should try
3970 ;; to find the prefix.
3977 ;; The match is fine if there's text after it.
3983 ;; This match is better than nothing, so let's
3984 ;; remember it in case nothing better is found
3985 ;; on another line.
3989 t))))
3992 ;; Search for a line which has text after the prefix
3993 ;; so that we get the proper amount of whitespace
3994 ;; after it. We start with the current line, then
3995 ;; search backwards, then forwards.
4000 ;; The whitespace is sucked up by the
4001 ;; first [ \t]* glob if the prefix is empty.
4004 ;; If the current line doesn't have text but do
4005 ;; have whitespace after the prefix, we'll use it.
4011 ;; For line comments we can search up to and
4012 ;; including the first line.
4016 ;; For block comments we must stop before the
4017 ;; block starter.
4028 nil)
4031 ;; A good line wasn't found, but at least we have a
4032 ;; fallback that matches the comment prefix regexp.
4037 ;; There are ws or text after the prefix, so
4038 ;; let's use it.
4042 ;; Check if there's any whitespace padding
4043 ;; on the comment start line that we can
4044 ;; use after the prefix.
4062 ;; Got to mess in the buffer once again to
4063 ;; ensure the column gets correct. :P
4074 ;; Last resort: Just add a single space after
4075 ;; the prefix.
4080 ;; The line doesn't match the comment prefix regexp.
4082 ;; We have a fallback for line comments that we must use.
4085 comment-prefix)
4089 ;; Assume we are dealing with a "free text" block
4090 ;; comment where the lines doesn't have any comment
4091 ;; prefix at all and we should just fill it as
4092 ;; normal text.
4094 ))
4097 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4098 ;; masked to allow adaptive filling to work correctly. That
4099 ;; includes narrowing the buffer and, if point is inside a comment,
4100 ;; masking the comment starter and ender appropriately.
4101 ;;
4102 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4103 ;; The position of point is then less significant when doing masking
4104 ;; and narrowing.
4105 ;;
4106 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4107 ;; only if the point turns out to be inside a comment or a string.
4108 ;;
4109 ;; Note that this function does not do any hidden buffer changes.
4112 ;; beg and end limit the region to narrow. end is a marker.
4113 beg end
4114 ;; tmp-pre and tmp-post mark strings that are temporarily
4115 ;; inserted at the start and end of the region. tmp-pre is a
4116 ;; cons of the positions of the prepended string. tmp-post is
4117 ;; a marker pointing to the single character of the appended
4118 ;; string.
4119 tmp-pre tmp-post
4120 ;; If hang-ender-stuck isn't nil, the comment ender is
4121 ;; hanging. In that case it's set to the number of spaces
4122 ;; that should be between the text and the ender.
4123 hang-ender-stuck
4124 ;; auto-fill-spaces is the exact sequence of whitespace between a
4125 ;; comment's last word and the comment ender, temporarily replaced
4126 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4127 auto-fill-spaces
4132 ;; Restore point on undo. It's necessary since we do a lot of
4133 ;; hidden inserts and deletes below that should be as transparent
4134 ;; as possible.
4138 ;; Determine the limits and type of the containing literal (if any):
4139 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4140 ;; BEG and END.
4143 ;; Widen to catch comment limits correctly.
4168 ;; For each of the possible types of text (string, C comment ...)
4169 ;; determine BEG and END, the region we will narrow to. If we're in
4170 ;; a literal, constrain BEG and END to the limits of this literal.
4171 ;;
4172 ;; For some of these text types, particularly a block comment, we
4173 ;; may need to massage whitespace near literal delimiters, so that
4174 ;; these don't get filled inappropriately.
4179 ;; Limit to the comment or paragraph end, whichever
4180 ;; comes first.
4184 ;; The region includes the comment starter, so we must
4185 ;; check it.
4189 ;; Include the first line in the region.
4191 ;; The first line contains code before the
4192 ;; comment. We must fake a line that doesn't.
4203 ;; disallow "/*/"
4205 ;; There is a comment ender, and the region includes it. If
4206 ;; it's on its own line, it stays on its own line. If it's got
4207 ;; company on the line, it keeps (at least one word of) it.
4208 ;; "=====*/" counts as a comment ender here, but "===== */"
4209 ;; doesn't and "foo*/" doesn't.
4214 ;; The following conjunct was added to avoid an
4215 ;; "Invalid search bound (wrong side of point)"
4216 ;; error in the subsequent re-search. Maybe
4217 ;; another fix would be needed (2007-12-08).
4218 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4219 ; 2010-10-17 Construct removed.
4220 ; (or (< (- (cdr c-lit-limits) 2) (point))
4228 ;; The comment ender IS on its own line. Exclude this
4229 ;; line from the filling.
4232 ;; The comment ender is hanging. Replace all space between it
4233 ;; and the last word either by one or two 'x's (when
4234 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4235 ;; as the whitespace (when auto filling), and include it in
4236 ;; the region. We'll change them back to whitespace
4237 ;; afterwards. The effect of this is to glue the comment
4238 ;; ender to the last word in the comment during filling.
4255 spaces)
4258 ;; Insert a CR after the "*/", adjust END
4266 c-current-comment-prefix
4269 ;; The comment ender is prefixed by nothing but a
4270 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4271 ;; 2006/4/28). Remove it along with surrounding ws.
4275 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4277 ;; What's being tested here? 2006/4/20. FIXME!!!
4281 ;; Don't adjust point below if it's
4282 ;; before the string we replace.
4284 ;; Keep one or two spaces between the
4285 ;; text and the ender, depending on how
4286 ;; many there are now.
4291 ;; paragraph filling condenses multiple spaces to
4292 ;; single or double spaces. auto-fill doesn't.
4298 sentence-end-double-space)
4301 ;; Insert the filler first to keep marks right.
4310 ;; Point was in the middle of the string we
4311 ;; replaced above, so put it back in the same
4312 ;; relative position, counting from the end.
4314 ))
4317 ;; The region includes the comment starter.
4321 ;; Begin with the next line.
4323 ;; Fake the fill prefix in the first line.
4338 ;; Leave the start line if it's
4339 ;; nothing but an escaped newline.
4345 ;; Narrow to the macro limits if they are nearer than the
4346 ;; paragraph limits. Don't know if this is necessary but
4347 ;; do it for completeness sake (doing auto filling at all
4348 ;; inside macros is bogus to begin with since the line
4349 ;; continuation backslashes aren't handled).
4362 ;; Try to avoid comments and macros in the paragraph to
4363 ;; avoid that the adaptive fill mode gets the prefix from
4364 ;; them.
4377 ;; Temporarily insert the fill prefix after the comment
4378 ;; starter so that the first line looks like any other
4379 ;; comment line in the narrowed region.
4383 c-current-comment-prefix
4386 ;; Oops, the prefix doesn't match the comment prefix
4387 ;; regexp. This could produce very confusing
4388 ;; results with adaptive fill packages together with
4389 ;; the insert prefix magic below, since the prefix
4390 ;; often doesn't appear at all. So let's warn about
4391 ;; it.
4393 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4395 ;; Find the right spot on the line, break it, insert
4396 ;; the fill prefix and make sure we're back in the
4397 ;; same column by temporarily prefixing the first word
4398 ;; with a number of 'x'.
4402 c-current-comment-prefix
4403 comment-start-skip))
4420 ;; `apply-outside-literal' is always set to t here if
4421 ;; we're inside a literal.
4425 ;; Kludge: If the function that adapts the fill prefix
4426 ;; doesn't produce the required comment starter for
4427 ;; line comments, then force it by setting fill-prefix.
4429 ;; Kludge the kludge: filladapt-mode doesn't
4430 ;; have this problem, but it currently
4431 ;; doesn't override fill-context-prefix
4432 ;; (version 2.12).
4434 filladapt-mode))
4441 c-lit-limits c-lit-type)))))))
4443 ;; Save the relative position of point if it's outside the
4444 ;; region we're going to narrow. Want to restore it in that
4445 ;; case, but otherwise it should be moved according to the
4446 ;; called function.
4450 ;; Preparations finally done! Now we can call the
4451 ;; actual function.
4457 ;; Restore point if it was outside the region.
4470 ;; Preserve point even if it's in the middle of the string
4471 ;; we replace; save-excursion doesn't work in that case.
4487 If any of the current line is a comment or within a comment, fill the
4488 comment or the paragraph of it that point is in, preserving the
4489 comment indentation or line-starting decorations (see the
4490 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4491 details).
4493 If point is inside multiline string literal, fill it. This currently
4494 does not respect escaped newlines, except for the special case when it
4495 is the very first thing in the string. The intended use for this rule
4496 is in situations like the following:
4499 A very long description of something that you want to fill to make
4502 If point is in any other situation, i.e. in normal code, do nothing.
4504 Optional prefix ARG means justify paragraph as well."
4507 ;; Avoid infinite recursion.
4509 fill-paragraph-function)))
4511 ;; Always return t. This has the effect that if filling isn't done
4512 ;; above, it isn't done at all, and it's therefore effectively
4513 ;; disabled in normal code.
4514 t)
4517 ;; Do automatic filling if not inside a context where it should be
4518 ;; ignored.
4520 ;; The decision whether the line should be broken is actually
4521 ;; done in c-indent-new-comment-line, which do-auto-fill
4522 ;; calls to break lines. We just set this special variable
4523 ;; so that we'll know when we're called from there. It's
4524 ;; also used to detect whether fill-prefix is user set or
4525 ;; generated automatically by do-auto-fill.
4526 fill-prefix))
4530 "Break line at point and indent, continuing comment or macro if within one.
4531 If inside a comment and `comment-multi-line' is non-nil, the
4532 indentation and line prefix are preserved (see the
4533 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4534 details). If inside a single line comment and `comment-multi-line' is
4535 nil, a new comment of the same type is started on the next line and
4536 indented as appropriate for comments. If inside a macro, a line
4537 continuation backslash is inserted and aligned as appropriate, and the
4538 new line is indented according to `c-syntactic-indentation'.
4540 If a fill prefix is specified, it overrides all the above."
4541 ;; allow-auto-fill is used from c-context-line-break to allow auto
4542 ;; filling to break the line more than once. Since this function is
4543 ;; used from auto-fill itself, that's normally disabled to avoid
4544 ;; unnecessary recursion.
4553 ;; Already know the literal type and limits when called from
4554 ;; c-context-line-break.
4561 ;; Called from do-auto-fill.
4569 c-ignore-auto-fill)
4574 ;; The adaptive fill function has generated a prefix, but
4575 ;; we're on the first line in a block comment so it'll be
4576 ;; wrong. Ignore it to guess a better one below.
4580 c-line-comment-starter)
4582 ;; Kludge: If the function that adapted the fill prefix
4583 ;; doesn't produce the required comment starter for line
4584 ;; comments, then we ignore it.
4586 )))
4589 ;; A call from do-auto-fill which should be ignored.
4590 )
4592 ;; A fill-prefix overrides anything.
4601 ;; Some sort of comment.
4607 ;; Inside a comment that should be continued.
4612 c-lit-type)))
4621 ;; Skip forward past the fill prefix in case
4622 ;; we're standing in it.
4623 ;;
4624 ;; FIXME: This doesn't work well in cases like
4625 ;;
4626 ;; /* Bla bla bla bla bla
4627 ;; bla bla
4628 ;;
4629 ;; If point is on the 'B' then the line will be
4630 ;; broken after "Bla b".
4631 ;;
4632 ;; If we have an empty comment, /* */, the next
4633 ;; lot of code pushes point to the */. We fix
4634 ;; this by never allowing point to end up to the
4635 ;; right of where it started.
4642 ;; The skip takes us out of the (block)
4643 ;; comment; insert the fill prefix at bol
4644 ;; instead and keep the position.
4651 ;; Don't break in the middle of a comment starter
4652 ;; or ender.
4661 ; middle of a TAB?
4662 ;; Inside a comment that should be broken.
4665 col)
4679 ;; c-comment-indent may look at the current
4680 ;; indentation, so let's start out with the same
4681 ;; indentation as the previous one.
4686 ;; In a macro.
4688 ;; Do not clobber the alignment of the line continuation
4689 ;; slash; c-backslash-region might look at it.
4691 ;; Got an asymmetry here: In normal code this command
4692 ;; doesn't indent the next line syntactically, and otoh a
4693 ;; normal syntactically indenting newline doesn't continue
4694 ;; the macro.
4697 ;; Somewhere else in the code.
4709 ;; advice for indent-new-comment-line for older Emacsen
4713 activate preactivate)
4714 "Call `c-indent-new-comment-line' if in CC Mode."
4717 ad-do-it
4722 "Do a line break suitable to the context.
4724 When point is outside a comment or macro, insert a newline and indent
4725 according to the syntactic context, unless `c-syntactic-indentation'
4726 is nil, in which case the new line is indented as the previous
4727 non-empty line instead.
4729 When point is inside the content of a preprocessor directive, a line
4730 continuation backslash is inserted before the line break and aligned
4731 appropriately. The end of the cpp directive doesn't count as inside
4732 it.
4734 When point is inside a comment, continue it with the appropriate
4735 comment prefix (see the `c-comment-prefix-regexp' and
4736 `c-block-comment-prefix' variables for details). The end of a
4737 C++-style line comment doesn't count as inside it.
4739 When point is inside a string, only insert a backslash when it is also
4740 inside a preprocessor directive."
4745 case-fold-search)
4762 ; it, not in a string, and not in the
4763 ; cpp keyword.
4785 ;; c-indent-line may look at the current indentation, so let's
4786 ;; start out with the same indentation as the previous line.
4797 "Insert a line break suitable to the context and leave point before it.
4798 This is the `c-context-line-break' equivalent to `open-line', which is
4799 normally bound to C-o. See `c-context-line-break' for the details."
4804 ;; Temporarily insert a non-whitespace char to keep any
4805 ;; preceding whitespace intact.
4811 \f
4814 ;; Local Variables:
4815 ;; indent-tabs-mode: t
4816 ;; tab-width: 8
4817 ;; End:
4818 ;;; cc-cmds.el ends here