| blob | 8a51ca81cfae3286ef77f9ee7082aa1043d734cb |
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
10 ;; 1987 Dave Detlefs and Stewart Clamen
11 ;; 1985 Richard M. Stallman
12 ;; Maintainer: bug-cc-mode@gnu.org
13 ;; Created: 22-Apr-1997 (split from cc-mode.el)
14 ;; Version: See cc-mode.el
15 ;; Keywords: c languages oop
17 ;; This file is part of GNU Emacs.
19 ;; GNU Emacs is free software: you can redistribute it and/or modify
20 ;; it under the terms of the GNU General Public License as published by
21 ;; the Free Software Foundation, either version 3 of the License, or
22 ;; (at your option) any later version.
24 ;; GNU Emacs is distributed in the hope that it will be useful,
25 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
26 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 ;; GNU General Public License for more details.
29 ;; You should have received a copy of the GNU General Public License
30 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 ;;; Commentary:
34 ;;; Code:
41 load-path)))
48 ;; Silence the compiler.
51 ; which looks at this.
54 \f
55 ;; Indentation / Display syntax functions
59 "Indent the current line according to the syntactic context,
60 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
61 syntactic information for the current line. Be silent about syntactic
62 errors if the optional argument QUIET is non-nil, even if
63 `c-report-syntactic-errors' is non-nil. Normally the position of
64 point is used to decide where the old indentation is on a lines that
65 is otherwise empty \(ignoring any line continuation backslash), but
66 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
67 indentation change \(in columns)."
73 bs-col
74 shift-amt)
79 ;; Don't use "\\s " - ^L doesn't count as WS
80 ;; here
84 ;; Delete all whitespace after point if there's only whitespace
85 ;; on the line, so that any code that does back-to-indentation
86 ;; or similar gets the current column in this case. If this
87 ;; removes a line continuation backslash it'll be restored
88 ;; at the end.
90 ;; Should try to keep the backslash alignment
91 ;; in this case.
103 c-syntactic-context))))
108 c-syntactic-context))
110 c-echo-syntactic-information-p
112 c-syntactic-context indent))
116 c-parsing-error)
117 c-parsing-error))
122 t
124 nil))))
133 ;; Realign the line continuation backslash.
135 shift-amt))
138 "Insert a newline and indent the new line.
139 This function fixes line continuation backslashes if inside a macro,
140 and takes care to set the indentation before calling
141 `indent-according-to-mode', so that lineup functions like
142 `c-lineup-dont-change' works better."
144 ;; TODO: Backslashes before eol in comments and literals aren't
145 ;; kept intact.
147 ;; Avoid calling c-backslash-region from c-indent-line if it's
148 ;; called during the newline call, which can happen due to
149 ;; c-electric-continued-statement, for example. We also don't
150 ;; want any backslash alignment from indent-according-to-mode.
152 has-backslash insert-backslash
153 start col)
163 has-backslash t)
170 ;; The backslash stayed on the previous line. Insert one
171 ;; before calling c-backslash-region, so that
172 ;; bs-col-after-end in it works better. Fixup the
173 ;; backslashes on the newly inserted line.
177 ;; The backslash moved to the new line, if there was any. Let
178 ;; c-backslash-region fix a backslash on the previous line,
179 ;; and the one that might be on the new line.
180 ;; c-auto-align-backslashes is intentionally ignored here;
181 ;; maybe the moved backslash should be left alone if it's set,
182 ;; but we fix both lines on the grounds that the old backslash
183 ;; has been moved anyway and is now in a different context.
186 ;; Reindent syntactically. The indentation done above is not
187 ;; wasted, since c-indent-line might look at the current
188 ;; indentation.
191 ;; We temporarily insert another line break, so that the
192 ;; lineup functions will see the line as empty. That makes
193 ;; e.g. c-lineup-cpp-define more intuitive since it then
194 ;; proceeds to the preceding line in this case.
205 ;; Must align the backslash again after reindentation. The
206 ;; c-backslash-region call above can't be optimized to ignore
207 ;; this line, since it then won't align correctly with the
208 ;; lines below if the first line in the macro is broken.
212 "Show syntactic information for current line.
213 With universal argument, inserts the analysis as a comment on that line."
217 ;; Use `c-syntactic-context' in the same way as
218 ;; `c-indent-line', to be consistent.
219 c-syntactic-context
232 ols))
236 ols)))
242 ))
246 "Insert a comment with the syntactic analysis on every line in the region."
256 \f
257 ;; Minor mode functions.
265 ;; cc-subword might not be loaded.
268 "w"
272 mode-name)))
273 ;; (setq c-submode-indicators
274 ;; (if (> (length fmt) 1)
275 ;; fmt))
279 bare-mode-name))
283 "Toggle syntactic indentation.
284 Optional numeric ARG, if supplied, turns on syntactic indentation when
285 positive, turns it off when negative, and just toggles it when zero or
286 left out.
288 When syntactic indentation is turned on (the default), the indentation
289 functions and the electric keys indent according to the syntactic
290 context keys, when applicable.
292 When it's turned off, the electric keys don't reindent, the indentation
293 functions indents every new line to the same level as the previous
295 specified by `c-basic-offset'. The indentation style has no effect in
296 this mode, nor any of the indentation associated variables,
297 e.g. `c-special-indent-hook'.
299 This command sets the variable `c-syntactic-indentation'."
306 "Toggle auto-newline feature.
307 Optional numeric ARG, if supplied, turns on auto-newline when
308 positive, turns it off when negative, and just toggles it when zero or
309 left out.
311 Turning on auto-newline automatically enables electric indentation.
314 modeline after the mode name) newlines are automatically inserted
315 after special characters such as brace, comma, semi-colon, and colon."
327 "Toggle hungry-delete-key feature.
328 Optional numeric ARG, if supplied, turns on hungry-delete when
329 positive, turns it off when negative, and just toggles it when zero or
330 left out.
333 the modeline after the mode name) the delete key gobbles all preceding
334 whitespace in one fell swoop."
341 "Toggle auto-newline and hungry-delete-key features.
342 Optional numeric ARG, if supplied, turns on auto-newline and
343 hungry-delete when positive, turns them off when negative, and just
344 toggles them when zero or left out.
346 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
354 "Toggle the electric indentation feature.
355 Optional numeric ARG, if supplied, turns on electric indentation when
356 positive, turns it off when negative, and just toggles it when zero or
357 left out."
363 \f
364 ;; Electric keys
367 "Delete the preceding character or whitespace.
369 line) then all preceding whitespace is consumed. If however a prefix
370 argument is supplied, or `c-hungry-delete-key' is nil, or point is
371 inside a literal then the function in the variable
372 `c-backspace-function' is called."
376 arg
382 "Delete the preceding character or all preceding whitespace
383 back to the previous non-whitespace character.
395 "Delete the following character or whitespace.
397 line) then all following whitespace is consumed. If however a prefix
398 argument is supplied, or `c-hungry-delete-key' is nil, or point is
399 inside a literal then the function in the variable `c-delete-function'
400 is called."
404 arg
410 "Delete the following character or all following whitespace
411 up to the next non-whitespace character.
420 ;; This function is only used in XEmacs.
422 "Deletes preceding or following character or whitespace.
423 This function either deletes forward as `c-electric-delete-forward' or
424 backward as `c-electric-backspace', depending on the configuration: If
425 the function `delete-forward-p' is defined and returns non-nil, it
426 deletes forward. Otherwise it deletes backward.
428 Note: This is the way in XEmacs to choose the correct action for the
429 \[delete] key, whichever key that means. Other flavors don't use this
430 function to control that."
437 ;; This function is only used in XEmacs.
439 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
440 The direction of deletion depends on the configuration: If the
441 function `delete-forward-p' is defined and returns non-nil, it deletes
442 forward using `c-hungry-delete-forward'. Otherwise it deletes
443 backward using `c-hungry-backspace'.
445 Note: This is the way in XEmacs to choose the correct action for the
446 \[delete] key, whichever key that means. Other flavors don't use this
447 function to control that."
456 If `c-electric-flag' is set, handle it specially according to the variable
457 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
458 inside a literal or a macro, nothing special happens."
472 ;; do nothing special
474 ;; place the pound character at the left edge
482 )))
485 ;; Return the syntactic context of the construct at point. (This is NOT
486 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
487 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
490 syntax)
492 ;; insert a newline to isolate the construct at point for syntactic
493 ;; analysis.
495 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
496 ;; the syntax. (There might already be an escaped NL there.)
509 ;; Turn on syntactic macro analysis to help with auto
510 ;; newlines only.
512 nil))
513 syntax))
516 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
517 ;; (not necessarily the same as the S.C. of the line it is on). Return
518 ;; NEWLINES, the list containing some combination of the symbols `before'
519 ;; and `after' saying where newlines should be inserted.
522 ;; This is the list of brace syntactic symbols that can hang.
523 ;; If any new ones are added to c-offsets-alist, they should be
524 ;; added here as well.
525 ;;
526 ;; The order of this list is important; if SYNTAX has several
527 ;; elements, the element that "wins" is the earliest in SYMS.
529 class-open class-close defun-open defun-close
530 inline-open inline-close
531 brace-list-open brace-list-close
532 brace-list-intro brace-entry-open
533 block-open block-close
534 substatement-open statement-case-open
535 extern-lang-open extern-lang-close
536 namespace-open namespace-close
537 module-open module-close
538 composition-open composition-close
539 inexpr-class-open inexpr-class-close
540 ;; `statement-cont' is here for the case with a brace
541 ;; list opener inside a statement. C.f. CASE B.2 in
542 ;; `c-guess-continued-construct'.
543 statement-cont))
544 ;; shut this up too
549 ;; Do not try to insert newlines around a special
550 ;; (Pike-style) brace list.
557 nil
558 ;; Seek the matching entry in c-hanging-braces-alist.
560 syms
561 ;; Substitute inexpr-class and class-open or
562 ;; class-close with inexpr-class-open or
563 ;; inexpr-class-close.
570 syntax)
571 c-hanging-braces-alist)
574 ;; If syntax is a function symbol, then call it using the
575 ;; defined semantics.
585 ;; Point is just after a newly inserted }. If the non-whitespace
586 ;; content of the braces is a single line of code, compact the whole
587 ;; construct to a single line, if this line isn't too long. The Right
588 ;; Thing is done with comments.
589 ;;
590 ;; Point will be left after the }, regardless of whether the clean-up is
591 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
595 mbeg1 mend1 mbeg4 mend4
596 eol-col cmnt-pos cmnt-col cmnt-gap)
601 ;; Avoid backtracking over a very large block. The one we
602 ;; deal with here can never be more than three lines.
633 ;; Necessary to put the closing brace before any line
634 ;; oriented comment to keep it syntactically significant.
635 ;; This isn't necessary for block comments, but the result
636 ;; looks nicer anyway.
652 ;; Can we trim space before comment to make the line fit?
658 t))))
662 "Insert a brace.
664 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
665 numeric ARG hasn't been supplied, the command performs several electric
666 actions:
669 the mode line) newlines are inserted before and after the brace as
670 directed by the settings in `c-hanging-braces-alist'.
672 \(b) Any auto-newlines are indented. The original line is also
673 reindented unless `c-syntactic-indentation' is nil.
675 \(c) If auto-newline is turned on, various newline cleanups based on the
676 settings of `c-cleanup-list' are done."
680 ;; We want to inhibit blinking the paren since this would be
681 ;; most disruptive. We'll blink it ourselves later on.
683 blink-paren-function)
689 ;; Insert the brace. Note that expand-abbrev might reindent
690 ;; the line here if there's a preceding "else" or something.
700 newlines
702 ; of the brace itself, of the line the brace ends up on.
714 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
718 ;; Only a plain newline for now - it's indented
719 ;; after the cleanups when the line has its final
720 ;; appearance.
725 ;; `syntax' is the syntactic context of the line which ends up
726 ;; with the brace on it.
729 ;; Do all appropriate clean ups
732 mbeg mend
733 )
735 ;; `}': clean up empty defun braces
740 syntax)
745 ;; make sure matching open brace isn't in a comment
751 ;; `}': compact to a one-liner defun?
760 ;; `{': clean up brace-else-brace and brace-elseif-brace
767 "else"
769 "{"
771 nil t))
783 ; (progn
784 ; (setq tmp (point))
788 "else"
790 "if"
794 ;(eq (match-end 0) tmp);
795 )
802 ;; Indent the line after the cleanups since it might
803 ;; very well indent differently due to them, e.g. if
804 ;; c-indent-one-line-block is used together with the
805 ;; one-liner-defun cleanup.
809 ;; does a newline go after the brace?
812 ))))
814 ;; blink the paren
817 old-blink-paren
824 "Insert a slash character.
826 If the slash is inserted immediately after the comment prefix in a c-style
827 comment, the comment might get closed by removing whitespace and possibly
830 Indent the line as a comment, if:
833 token and we are on a comment-only-line, or
836 comment.
838 If a numeric ARG is supplied, point is inside a literal, or
839 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
840 is inhibited."
843 indentp
844 ;; shut this up
847 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
848 ;; `c-syntactic-indentation' set.
855 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
866 c-syntactic-indentation
867 c-electric-flag
875 "Insert a star character.
876 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
877 the star is the second character of a C style comment starter on a
878 comment-only-line, indent the line as a comment. If a numeric ARG is
879 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
880 this indentation is inhibited."
884 ;; if we are in a literal, or if arg is given do not reindent the
885 ;; current line, unless this star introduces a comment-only line.
888 c-electric-flag
901 ))
904 "Insert a comma or semicolon.
906 If `c-electric-flag' is non-nil, point isn't inside a literal and a
907 numeric ARG hasn't been supplied, the command performs several electric
908 actions:
911 the mode line) a newline might be inserted. See the variable
912 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
914 \(b) Any auto-newlines are indented. The original line is also
915 reindented unless `c-syntactic-indentation' is nil.
917 \(c) If auto-newline is turned on, a comma following a brace list or a
918 semicolon following a defun might be cleaned up, depending on the
919 settings of `c-cleanup-list'."
923 ;; shut this up
933 ;; do all cleanups and newline insertions if c-auto-newline is on.
938 ;; clean ups: list-close-comma or defun-close-semi
951 ;; make sure matching open brace isn't in a comment
955 ;; reindent line
959 ;; check to see if a newline should be added
961 answer add-newline-p)
964 ;; only nil value means continue checking
968 ;; only 'stop specifically says do not add a newline
970 ))
973 )))))
976 "Insert a colon.
978 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
979 numeric ARG hasn't been supplied, the command performs several electric
980 actions:
983 the mode line) newlines are inserted before and after the colon based on
984 the settings in `c-hanging-colons-alist'.
986 \(b) Any auto-newlines are indented. The original line is also
987 reindented unless `c-syntactic-indentation' is nil.
989 \(c) If auto-newline is turned on, whitespace between two colons will be
991 `c-cleanup-list'."
996 newlines is-scope-op
997 ;; shut this up
1000 ;; Any electric action?
1002 ;; Unless we're at EOL, only re-indentation happens.
1007 ;; scope-operator clean-up?
1025 ;; indent the current line if it's done syntactically.
1027 ;; Cannot use the same syntax analysis as we find below,
1028 ;; since that's made with c-syntactic-indentation-in-macros
1029 ;; always set to t.
1032 ;; Calculate where, if anywhere, we want newlines.
1036 ;; Turn on syntactic macro analysis to help with auto newlines
1037 ;; only.
1040 ;; Translate substatement-label to label for this operation.
1045 ;; some language elements can only be determined by checking
1046 ;; the following line. Lets first look for ones that can be
1047 ;; found when looking on the line with the colon
1051 syntax c-hanging-colons-alist)
1058 c-hanging-colons-alist)))))
1059 ;; does a newline go before the colon? Watch out for already
1060 ;; non-hung colons. However, we don't unhang them because that
1061 ;; would be a cleanup (and anti-social).
1071 ;; does a newline go after the colon?
1075 ))))
1079 If the current language uses angle bracket parens (e.g. template
1080 arguments in C++), try to find out if the inserted character is a
1081 paren and give it paren syntax if appropriate.
1083 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1084 line will be reindented if the inserted character is a paren or if it
1085 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1086 numeric argument is supplied, or the point is inside a literal."
1090 final-pos close-paren-inserted)
1096 c-restricted-<>-arglists
1112 ;; It's a ">". Check if there's an earlier "<" which either has
1113 ;; open paren syntax already or that can be recognized as an arglist
1114 ;; together with this ">". Note that this won't work in cases like
1115 ;; "template <x, a < b, y>" but they ought to be rare.
1118 ;; Narrow to avoid that `c-forward-<>-arglist' below searches past
1119 ;; our position.
1129 ;; If the "<" already got open paren syntax we know we
1130 ;; have the matching closer. Handle it and exit the
1131 ;; loop.
1136 nil)
1137 t))
1147 c-restricted-<>-arglists
1159 ;; Loop here if the "<" we found above belongs to a nested
1160 ;; angle bracket sexp. When we start over we'll find the
1161 ;; previous or surrounding sexp.
1163 t
1165 nil)))))))
1168 ;; Indent the line if appropriate.
1182 blink-paren-function)
1183 ;; Note: Most paren blink functions, such as the standard
1184 ;; `blink-matching-open', currently doesn't handle paren chars
1185 ;; marked with text properties very well. Maybe we should avoid
1186 ;; this call for the time being?
1190 "Insert a parenthesis.
1192 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1193 line is reindented unless a numeric ARG is supplied, or the parenthesis
1194 is inserted inside a literal.
1196 Whitespace between a function name and the parenthesis may get added or
1197 removed; see the variable `c-cleanup-list'.
1199 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1200 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1203 ;; shut this up
1209 ;; be most disruptive. We'll blink it ourselves
1210 ;; afterwards.
1212 blink-paren-function)
1216 ;; If we're at EOL, check for new-line clean-ups.
1220 ;; clean up brace-elseif-brace
1227 "else"
1229 "if"
1231 "("
1233 nil t)
1238 ;; clean up brace-catch-brace
1245 "catch"
1247 "("
1249 nil t)
1254 ;; Check for clean-ups at function calls. These two DON'T need
1255 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1256 ;; Point is currently just after the inserted paren.
1260 ;; space-before-funcall clean-up?
1268 ;; Don't add a space into #define FOO()....
1277 ;; compact-empty-funcall clean-up?
1291 old-blink-paren
1295 "Reindent the current line if appropriate.
1297 This function is used to reindent the line after a keyword which
1301 The line is reindented if there is nothing but whitespace before the
1302 keyword on the line, the keyword is not inserted inside a literal, and
1303 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1308 c-syntactic-indentation
1315 ;; Have to temporarily insert a space so that
1316 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1317 ;; space with a nonspace to avoid messing up any whitespace
1318 ;; sensitive meddling that might be done, e.g. by
1319 ;; `c-backslash-region'.
1325 \f
1326 ;; "nomenclature" functions + c-scope-operator.
1328 "Compatibility alias for `c-forward-subword'."
1335 "Compatibility alias for `c-backward-subword'."
1342 "Insert a double colon scope operator at point.
1347 \f
1348 ;; Movement (etc.) by defuns.
1350 ;; Return non-nil if point is between the closing brace and the semicolon of
1351 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1352 ;; portion of a declaration like "struct foo {...} bar ;".
1353 ;;
1354 ;; Return the position of the main declaration. Otherwise, return nil.
1355 ;; Point is assumed to be at the top level and outside of any macro or
1356 ;; literal.
1357 ;;
1358 ;; If LIM is non-nil, it is the bound on a the backward search for the
1359 ;; beginning of the declaration.
1360 ;;
1361 ;; This function might do hidden buffer changes.
1366 bod)
1370 ;; Look for struct or union or ... If we find one, it might
1371 ;; be the return type of a function, or the like. Exclude
1372 ;; this case.
1375 c-opt-block-decls-with-vars-key
1377 eo-block t t t)
1382 bod)))))
1385 ;; Determine where we are with respect to functions (or other brace
1386 ;; constructs, included in the term "function" in the rest of this comment).
1387 ;; Point is assumed to be outside any macro or literal.
1388 ;; This is used by c-\(begining\|end\)-of-defun.
1389 ;;
1390 ;; Return one of these symbols:
1391 ;; at-header : we're at the start of a function's header.
1392 ;; in-header : we're inside a function's header, this extending right
1393 ;; up to the brace. This bit includes any k&r declarations.
1394 ;; in-block : we're inside a function's brace block.
1395 ;; in-trailer : we're in the area between the "}" and ";" of something
1396 ;; like "struct foo {...} bar, baz;".
1397 ;; at-function-end : we're just after the closing brace (or semicolon) that
1398 ;; terminates the function.
1399 ;; outwith-function: we're not at or in any function. Being inside a
1400 ;; non-brace construct also counts as 'outwith-function'.
1401 ;;
1402 ;; This function might do hidden buffer changes.
1405 decl-result brace-decl-p
1422 ;; Find the start of the current declaration. NOTE: If we're in the
1423 ;; variables after a "struct/eval" type block, we don't get to the
1424 ;; real declaration here - we detect and correct for this later.
1426 ;;If we're in the parameters' parens, move back out of them.
1428 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1429 ;; at a declaration.
1437 ;; NOTE: If we're in a K&R region, this might be the start
1438 ;; of a parameter declaration, not the actual function.
1442 ;; Has the declaration we've gone back to got braces?
1448 ;; Might have stopped on the
1449 ;; ';' in a K&R argdecl. In
1450 ;; that case the declaration
1451 ;; should contain a block.
1460 'at-header
1466 'at-function-end
1469 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1470 decl-result))))))))
1473 ;; Skip to the opening brace of the Nth function before point. If
1474 ;; point is inside a function, this counts as the first. Point must be
1475 ;; outside any comment/string or macro.
1476 ;;
1477 ;; N must be strictly positive.
1478 ;; WHERE describes the position of point, one of the symbols `at-header',
1479 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1480 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1481 ;;
1482 ;; If we run out of functions, leave point at BOB. Return zero on success,
1483 ;; otherwise the number of {s still to go.
1484 ;;
1485 ;; This function may do hidden buffer changes
1487 ;; What we do to go back the first defun depends on where we start.
1503 ;; Each time round the loop, go back to a "{" at the outermost level.
1506 ; by a factor of ~6. Hmmm. 2006/4/5.
1511 n)
1514 "Move backward to the beginning of a defun.
1515 Every top level declaration that contains a brace paren block is
1516 considered to be a defun.
1518 With a positive argument, move backward that many defuns. A negative
1519 argument -N means move forward to the Nth following beginning. Return
1520 t unless search stops due to beginning or end of buffer.
1522 Unlike the built-in `beginning-of-defun' this tries to be smarter
1523 about finding the char with open-parenthesis syntax that starts the
1524 defun."
1532 where paren-state pos)
1534 ;; Move back out of any macro/comment/string we happen to be in.
1542 ;; Move forward to the closing brace of a function.
1548 ;; Move forward to the next opening brace....
1552 ;; ... and backward to the function header.
1554 t))
1556 ;; Move backward to the opening brace of a function.
1560 ;; Go backward to this function's header.
1564 ;; We're now there, modulo comments and whitespace.
1565 ;; Try to be line oriented; position point at the closest
1566 ;; preceding boi that isn't inside a comment, but if we hit
1567 ;; the previous declaration then we use the current point
1568 ;; instead.
1578 ;; Skip to the closing brace of the Nth function after point. If
1579 ;; point is inside a function, this counts as the first. Point must be
1580 ;; outside any comment/string or macro.
1581 ;;
1582 ;; N must be strictly positive.
1583 ;; WHERE describes the position of point, one of the symbols `at-header',
1584 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1585 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1586 ;;
1587 ;; If we run out of functions, leave point at EOB. Return zero on success,
1588 ;; otherwise the number of }s still to go.
1589 ;;
1590 ;; This function may do hidden buffer changes.
1593 ;; What we do to go forward over the first defun depends on where we
1594 ;; start. We go to the closing brace of that defun, even when we go
1595 ;; backwards to it (in a "struct foo {...} bar ;").
1611 ;; Each time round the loop, go forward to a "}" at the outermost level.
1613 ;(c-parse-state) ; This call speeds up the following one by a factor
1614 ; of ~6. Hmmm. 2006/4/5.
1619 n)
1622 "Move forward to the end of a top level declaration.
1623 With argument, do it that many times. Negative argument -N means move
1624 back to Nth preceding end. Returns t unless search stops due to
1625 beginning or end of buffer.
1627 An end of a defun occurs right after the close-parenthesis that matches
1628 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1635 where paren-state pos)
1637 ;; Move back out of any macro/comment/string we happen to be in.
1645 ;; Move backwards to the } of a function
1654 ;; Move forward to the } of a function
1658 ;; Do we need to move forward from the brace to the semicolon?
1664 ;; We're there now, modulo comments and whitespace.
1665 ;; Try to be line oriented; position point after the next
1666 ;; newline that isn't inside a comment, but if we hit the
1667 ;; next declaration then we use the current point instead.
1681 "Return the name of the current defun, or NIL if there isn't one.
1683 with a brace block."
1687 where pos name-end)
1690 ;; Move back out of any macro/comment/string we happen to be in.
1697 ;; Move to the beginning of the current defun, if any, if we're not
1698 ;; already there.
1700 nil
1705 ;; Pick out the defun name, according to the type of defun.
1710 ;; struct, union, enum, or similar:
1717 name-end))
1720 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1721 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1735 ;; Normal function or initializer.
1747 ;; Return a cons of the beginning and end positions of the current
1748 ;; top level declaration or macro. If point is not inside any then
1749 ;; nil is returned, unless NEAR is non-nil in which case the closest
1750 ;; following one is chosen instead (if there is any). The end
1751 ;; position is at the next line, providing there is one before the
1752 ;; declaration.
1753 ;;
1754 ;; This function might do hidden buffer changes.
1757 ;; Note: Some code duplication in `c-beginning-of-defun' and
1758 ;; `c-end-of-defun'.
1762 lim pos end-pos)
1765 ;; If we moved to the outermost enclosing paren then we
1766 ;; can use c-safe-position to set the limit. Can't do
1767 ;; that otherwise since the earlier paren pair on
1768 ;; paren-state might very well be part of the
1769 ;; declaration we should go to.
1771 t)
1772 ;; At top level. Make sure we aren't inside a literal.
1788 ;; We moved back over the previous defun. Skip to the next
1789 ;; one. Not using c-forward-syntactic-ws here since we
1790 ;; should not skip a macro. We can also be directly after
1791 ;; the block in a `c-opt-block-decls-with-vars-key'
1792 ;; declaration, but then we won't move significantly far
1793 ;; here.
1807 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1808 ;; declaration that doesn't end there. We're searching back and
1809 ;; forth over the block here, which can be expensive.
1821 nil
1825 nil
1827 ;; Try to be line oriented; position the limits at the
1828 ;; closest preceding boi, and after the next newline, that
1829 ;; isn't inside a comment, but if we hit a neighboring
1830 ;; declaration then we instead use the exact declaration
1831 ;; limit in that direction.
1837 pos
1853 pos)))))
1854 ))))
1857 "Put mark at end of the current top-level declaration or macro, point at beginning.
1858 If point is not inside any then the closest following one is chosen.
1861 function does not require the declaration to contain a brace block."
1866 ;; We try to be line oriented, unless there are several
1867 ;; declarations on the same line.
1878 "Return the name of the current CPP macro, or NIL if we're not in one."
1886 \f
1887 ;; Movement by statements.
1889 ;; Point is within a comment. Is it also within a comment-prefix?
1890 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1891 ;;
1892 ;; This function might do hidden buffer changes.
1902 ;; Narrow to the "inside" of the comment (block) defined by range, as
1903 ;; follows:
1904 ;;
1905 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
1906 ;; present) removed. A c++-style line comment retains its opening "//" but
1907 ;; has any final NL removed. If POINT is currently outwith these innards,
1908 ;; move it to the appropriate boundary.
1909 ;;
1910 ;; This narrowing simplifies the sentence movement functions, since it
1911 ;; eliminates awkward things at the boundaries of the comment (block).
1912 ;;
1913 ;; This function might do hidden buffer changes.
1931 ;; Move backwards to the "beginning of a sentence" within the comment
1932 ;; defined by RANGE, a cons of its starting and ending positions. If we
1933 ;; find a BOS, return NIL. Otherwise, move point to just before the start
1934 ;; of the comment and return T.
1935 ;;
1936 ;; The BOS is either text which follows a regexp match of sentence-end,
1937 ;; or text which is a beginning of "paragraph".
1938 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
1939 ;;
1940 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1941 ;; It is not a general function, but is intended only for calling from
1942 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
1943 ;;
1944 ;; This function might do hidden buffer changes.
1950 last
1956 ;; First, find the previous paragraph start, if any.
1960 ; paragraph-\(start\|separate\)
1969 ;; Now seek successively earlier sentence ends between PAR-BEG and
1970 ;; HERE, until the "start of sentence" following it is earlier than
1971 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
1989 nil
1991 t))))
1994 ;; Move forward to the "end of a sentence" within the comment defined by
1995 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
1996 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
1997 ;; return NIL. Otherwise, move point to just after the end of the comment
1998 ;; and return T.
1999 ;;
2000 ;; The EOS is just after the non-WS part of the next match of the regexp
2001 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2002 ;; no sentence-end match following point, any WS before the end of the
2003 ;; comment will count as EOS, providing we're not already in it.
2004 ;;
2005 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2006 ;; It is not a general function, but is intended only for calling from
2007 ;; c-move-over-sentence.
2008 ;;
2009 ;; This function might do hidden buffer changes.
2012 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2013 )
2019 ;; The cc-mode values of paragraph-\(start\|separate\), set
2020 ;; in c-setup-paragraph-variables, are used in the
2021 ;; following.
2030 last
2033 ;; Go forward one "comment-prefix which looks like sentence-end"
2034 ;; each time round the following:
2045 ;; Take special action if we're up against the end of a comment (of
2046 ;; either sort): Leave point just after the last non-ws text.
2053 nil
2055 t))))
2058 ;; Move backwards to the "beginning of a sentence" within the string defined
2059 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2060 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2061 ;; just before the start of the string and return T.
2062 ;;
2063 ;; The BOS is either the text which follows a regexp match of sentence-end
2064 ;; or text which is a beginning of "paragraph". For the purposes of
2065 ;; determining paragraph boundaries, escaped newlines are treated as
2066 ;; ordinary newlines.
2067 ;;
2068 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2069 ;; It is not a general function, but is intended only for calling from
2070 ;; c-move-over-sentence.
2071 ;;
2072 ;; This function might do hidden buffer changes.
2078 ;; Enhance paragraph-start and paragraph-separate also to recognise
2079 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2080 ;; these values should be customizable user options, or something.
2089 ; paragraph-\(start\|separate\)
2097 ;; Now see if we can find a sentence end after PAR-BEG.
2105 ; than here, in case point starts
2106 ; beyond the closing quote.
2111 nil
2113 t))))
2116 ;; Move forward to the "end of a sentence" within the string defined by
2117 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2118 ;; return NIL. Otherwise, move point to just after the end of the string
2119 ;; and return T.
2120 ;;
2121 ;; The EOS is just after the non-WS part of the next match of the regexp
2122 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2123 ;; no sentence-end match following point, any WS before the end of the
2124 ;; string will count as EOS, providing we're not already in it.
2125 ;;
2126 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2127 ;; It is not a general function, but is intended only for calling from
2128 ;; c-move-over-sentence.
2129 ;;
2130 ;; This function might do hidden buffer changes.
2133 last
2134 ;; Enhance paragraph-start and paragraph-separate to recognise
2135 ;; blank lines terminated by escaped EOLs.
2143 ;; The above values of paragraph-\(start\|separate\) are used
2144 ;; in the following.
2147 ;; (re-search-backward filler-here nil t) would find an empty
2148 ;; string. Therefore we simulate it by the following:
2157 ;; Try to go forward a sentence.
2162 ;; Did we move a sentence, or did we hit the end of the string?
2164 nil
2166 t))))
2169 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2170 ;; If a literal is the next thing (aside from whitespace) to be found before
2171 ;; point, return a cons of its start.end positions (enclosing the
2172 ;; delimiters). Otherwise return NIL.
2173 ;;
2174 ;; This function might do hidden buffer changes.
2178 pos)
2182 ;; to prevent `looking-at' seeing a " at point.
2186 ;; An EOL can act as an "open string" terminator in AWK.
2197 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2198 ;; If a literal is the next thing (aside from whitespace) following point,
2199 ;; return a cons of its start.end positions (enclosing the delimiters).
2200 ;; Otherwise return NIL.
2201 ;;
2202 ;; This function might do hidden buffer changes.
2215 ;; Does point immediately follow a statement "terminator"? A virtual
2216 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2217 ;;
2218 ;; This function might do hidden buffer changes.
2226 ;; The following (for macros) is not strict about exactly where we are
2227 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2228 ;; much. ACM 2004/3/29.
2240 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2241 ;; stopping before reaching BOB or a literal or the boundary of a
2242 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2243 ;; the position of the '#' beginning the current preprocessor directive, or
2244 ;; NIL if we're not in such.
2245 ;;
2246 ;; Return a cons (A.B), where
2247 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2248 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2249 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2250 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2251 ;;
2252 ;; The total collection of returned values is as follows:
2253 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2254 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2255 ;; a BOS - the caller must check this.
2256 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2257 ;; moved and reached the opening # of the macro.
2258 ;; (t . macro-boundary): Every other circumstance in which we're at a
2259 ;; macro-boundary. We might be at a BOS.
2260 ;;
2261 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2262 ;; code before encountering the literal/BOB or macro-boundary.
2263 ;;
2264 ;; Note that this function moves within either preprocessor commands
2265 ;; (macros) or normal code, but will not cross a boundary between the two,
2266 ;; or between two distinct preprocessor commands.
2267 ;;
2268 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2269 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2270 ;; move into parens. Also stop before `#' when it's at boi on a line.
2271 ;;
2272 ;; This function might do hidden buffer changes.
2276 ; semicolon precedes it.
2281 ;; Stop at the token after a comment.
2286 ;; If we've gone back over a LF, we might have moved into or out of
2287 ;; a preprocessor line.
2295 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2300 ;; Have we found a virtual semicolon? If so, stop, unless the next
2301 ;; statement is where we started from.
2308 ;; Hit the beginning of the buffer/region?
2314 ;; Move back a character.
2317 ;; Stop at "{" (unless it's a PIKE special brace list.)
2326 ;; Have we reached the start of a macro? This always counts as
2327 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2328 ;; here. FIXME!!! ACM 2004/3/29)
2332 ;; Stop at token just after "}" or ";".
2334 ;; If we've gone back over ;, {, or }, we're done.
2343 ;; Stop at the token after a string.
2348 ;; Nothing special: go back word characters.
2350 ))))))
2353 ;; Move forwards over code, stopping before reaching EOB or a literal
2354 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2355 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2356 ;; terminates the current preprocessor directive, or NIL if we're not in
2357 ;; such.
2358 ;;
2359 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2360 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2361 ;; seems unavoidable. Depending on the context this function is called
2362 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2363 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2364 ;; semicolons, or anything else.
2365 ;;
2366 ;; Return a cons (A.B), where
2367 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2368 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2369 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2370 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2371 ;;
2372 ;; Point is left either after the end-of-statement, or at the last non-ws
2373 ;; code before encountering the literal, or the # of the preprocessor
2374 ;; statement, or at EOB [or just after last non-WS stuff??].
2375 ;;
2376 ;; As a clarification of "after the end-of-statement", if a comment or
2377 ;; whitespace follows a completed AWK statement, that statement is treated
2378 ;; as ending just after the last non-ws character before the comment.
2379 ;;
2380 ;; Note that this function moves within either preprocessor commands
2381 ;; (macros) or normal code, but not both within the same invocation.
2382 ;;
2383 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2384 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2385 ;; stop before `{' if at top level or inside braces, though. Move by
2386 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2387 ;; the boi.
2388 ;;
2389 ;; This function might do hidden buffer changes.
2391 last)
2396 ;; If we've moved forward to a virtual semicolon, we're done.
2403 ;; Gone past the end of a macro?
2408 ;; About to hit a comment?
2413 ;; End of buffer?
2419 ;; If we encounter a '{', stop just after the previous token.
2425 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2426 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2427 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2428 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2434 ;; End of a PIKE special brace list? If so, step over it and continue.
2443 ;; Have we got a '}' after having moved? If so, stop after the
2444 ;; previous token.
2450 ;; Stop if we encounter a preprocessor line.
2455 ;(throw 'done (cons (eq (point) here) 'macro-boundary))) ; Changed 2003/3/26
2458 ;; Stop after a ';', '}', or "};"
2463 ;; Found a string (this subsumes AWK regexps)?
2474 )))))
2477 ;; Is the literal defined by RANGE a string contained in a single line?
2478 ;;
2479 ;; This function might do hidden buffer changes.
2487 "Go to the beginning of the innermost C statement.
2488 With prefix arg, go back N - 1 statements. If already at the
2489 beginning of a statement then go to the beginning of the closest
2490 preceding one, moving into nested blocks if necessary (use
2492 comment or multiline string, move by sentences instead of statements.
2494 When called from a program, this function takes 3 optional args: the
2495 repetition count, a buffer position limit which is the farthest back
2496 to search for the syntactic context, and a flag saying whether to do
2497 sentence motion in or near comments and multiline strings.
2499 Note that for use in programs, `c-beginning-of-statement-1' is
2500 usually better. It has much better defined semantics than this one,
2501 which is intended for interactive use, and might therefore change to
2504 nil t))
2509 last ; start point for going back ONE chunk. Updated each chunk movement.
2512 res ; result from sub-function call
2513 not-bos ; "not beginning-of-statement"
2514 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2516 ;; Go back one statement at each iteration of the following loop.
2519 ;; Go back one "chunk" each time round the following loop, stopping
2520 ;; when we reach a statement boundary, etc.
2524 ; statement boundary, non-NIL otherwise.
2527 nil)
2531 ;; Single line string or sentence-flag is null => skip the
2532 ;; entire literal.
2537 ;; N.B. The following is essentially testing for an AWK regexp
2538 ;; at BOS:
2539 ;; Was the previous non-ws thing an end of statement?
2546 ;; Comment inside a statement or a multi-line string.
2552 res)))
2554 ;; Non-literal code.
2561 ;; We're at a tentative BOS. The next form goes
2562 ;; back over WS looking for an end of previous
2563 ;; statement.
2569 ;; Are we about to move backwards into or out of a
2570 ;; preprocessor command? If so, locate it's beginning.
2578 ;; Are we about to move backwards into a literal?
2581 not-bos))
2588 "Go to the end of the innermost C statement.
2589 With prefix arg, go forward N - 1 statements. Move forward to the end
2590 of the next statement if already at end, and move into nested blocks
2592 comment or multiline string, move by sentences instead of statements.
2594 When called from a program, this function takes 3 optional args: the
2595 repetition count, a buffer position limit which is the farthest back
2596 to search for the syntactic context, and a flag saying whether to do
2597 sentence motion in or near comments and multiline strings."
2599 nil t))
2609 res
2610 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2612 ;; Go back/forward one statement at each iteration of the following loop.
2617 ;; Go forward one "chunk" each time round the following loop, stopping
2618 ;; when we reach a statement boundary, etc.
2621 ; statement boundary, non-NIL otherwise.
2624 nil)
2628 ;; sentence-flag is null => skip the entire literal.
2629 ;; or a Single line string.
2634 ;; Is there a virtual semicolon here (e.g. for AWK)?
2637 ;; Comment or multi-line string.
2643 ;; If we've just come forward out of a literal, check for
2644 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2645 ;; some other language may do in the future)
2649 ;; Non-literal code.
2652 ;; Are we about to move forward into or out of a
2653 ;; preprocessor command?
2663 ;; Are we about to move forward into a literal?
2671 \f
2672 ;; set up electric character functions to work with pending-del,
2673 ;; (a.k.a. delsel) mode. All symbols get the t value except
2674 ;; the functions which delete, which gets 'supersede.
2681 c-electric-brace
2682 c-electric-slash
2683 c-electric-star
2684 c-electric-semi&comma
2685 c-electric-lt-gt
2686 c-electric-colon
2687 c-electric-paren))
2695 \f
2696 ;; Inserting/indenting comments
2698 ;; This function might do hidden buffer changes.
2711 ;; Do not pad with one space if we're at bol.
2712 value
2723 ;; Found comment to align with.
2725 ;; Do not pad with one space if we're at bol.
2726 0
2728 ;; Recurse to handle value as a new spec.
2732 "Used by `indent-for-comment' to create and indent comments.
2733 See `c-indent-comment-alist' for a description."
2762 c-indent-comments-syntactically-p)
2764 ;; BOGOSITY ALERT: if we're looking at the eol, its
2765 ;; because indent-for-comment hasn't put the comment-start
2766 ;; in the buffer yet. this will screw up the syntactic
2767 ;; analysis so we kludge in the necessary info. Another
2768 ;; kludge is that if we're at the bol, then we really want
2769 ;; to ignore any anchoring as specified by
2770 ;; c-comment-only-line-offset since it doesn't apply here.
2775 c-comment-only-line-offset
2777 c-comment-only-line-offset))))
2782 \f
2783 ;; used by outline-minor-mode
2786 ;; in otherwise-hidden text.
2791 \f
2792 ;; Movement by CPP conditionals.
2794 "Move back to the containing preprocessor conditional, leaving mark behind.
2795 A prefix argument acts as a repeat count. With a negative argument,
2796 move forward to the end of the containing preprocessor conditional.
2799 function stops at them when going backward, but not when going
2800 forward."
2808 directives."
2814 "Move forward into the next preprocessor conditional, leaving mark behind.
2815 A prefix argument acts as a repeat count. With a negative argument,
2816 move backward into the previous preprocessor conditional.
2819 function stops at them when going forward, but not when going
2820 backward."
2828 directives."
2834 "Move back across a preprocessor conditional, leaving mark behind.
2835 A prefix argument acts as a repeat count. With a negative argument,
2836 move forward across a preprocessor conditional."
2842 "Move forward across a preprocessor conditional, leaving mark behind.
2843 A prefix argument acts as a repeat count. With a negative argument,
2844 move backward across a preprocessor conditional.
2847 the nesting level isn't changed when tracking subconditionals.
2849 The optional argument TARGET-DEPTH specifies the wanted nesting depth
2850 after each scan. I.e. if TARGET-DEPTH is -1, the function will move
2851 out of the enclosing conditional. A non-integer non-nil TARGET-DEPTH
2852 counts as -1.
2855 are treated as conditional clause limits. Normally they are ignored."
2866 ;; subdepth is the depth in "uninteresting" subtrees,
2867 ;; i.e. those that takes us farther from the target
2868 ;; depth instead of closer.
2870 found)
2872 ;; Find the "next" significant line in the proper direction.
2874 ;; Rather than searching for a # sign that
2875 ;; comes at the beginning of a line aside from
2876 ;; whitespace, search first for a string
2877 ;; starting with # sign. Then verify what
2878 ;; precedes it. This is faster on account of
2879 ;; the fastmap feature of the regexp matcher.
2882 nil t))
2884 ;; Now verify it is really a preproc line.
2892 ;; When we're not in an "uninteresting"
2893 ;; subtree, we might want to act on "elif"
2894 ;; and "else" too.
2896 ;; Always move toward the target depth.
2901 ;; Ignore the change if it'd take us
2902 ;; into an "uninteresting" subtree.
2910 ;; If we are trying to move across, and we find an
2911 ;; end before we find a beginning, get an error.
2914 "No following conditional at this level"
2916 ;; When searching forward, start from next line so
2917 ;; that we don't find the same line again.
2919 ;; We found something if we've arrived at the
2920 ;; target depth.
2923 ;; else
2933 \f
2934 ;; commands to indent lines, regions, defuns, and expressions
2936 "Indent current line as C code, and/or insert some whitespace.
2938 If `c-tab-always-indent' is t, always just indent the current line.
2939 If nil, indent the current line only if point is at the left margin or
2940 in the line's indentation; otherwise insert some whitespace[*]. If
2941 other than nil or t, then some whitespace[*] is inserted only within
2942 literals (comments and strings), but the line is always reindented.
2944 If `c-syntactic-indentation' is t, indentation is done according to
2945 the syntactic context. A numeric argument, regardless of its value,
2946 means indent rigidly all the lines of the expression starting after
2947 point so that this line becomes properly indented. The relative
2948 indentation among the lines of the expression is preserved.
2950 If `c-syntactic-indentation' is nil, the line is just indented one
2951 step according to `c-basic-offset'. In this mode, a numeric argument
2952 indents a number of such steps, positive or negative, and an empty
2953 prefix argument is equivalent to -1.
2955 [*] The amount and kind of whitespace inserted is controlled by the
2956 variable `c-insert-tab-function', which is called to do the actual
2957 insertion of whitespace. Normally the function in this variable
2958 just inserts a tab character, or the equivalent number of spaces,
2959 depending on the variable `indent-tabs-mode'."
2968 -1
2976 ;; Realign the line continuation backslash if inside a macro.
2978 ))))
2980 ;; If c-syntactic-indentation and got arg, always indent this
2981 ;; line as C and shift remaining lines of expression the same
2982 ;; amount.
2986 beg end)
2991 shift-amt))
3003 ;; Else use c-tab-always-indent to determine behavior.
3005 ;; CASE 1: indent when at column zero or in line's indentation,
3006 ;; otherwise insert a tab
3013 ;; CASE 2: just indent the line
3016 ;; CASE 3: if in a literal, insert a tab, but always indent the
3017 ;; line
3022 )))))
3025 "Indent each line in the balanced expression following point syntactically.
3026 If optional SHUTUP-P is non-nil, no errors are signaled if no
3027 balanced expression is found."
3030 end)
3034 ;; Find the closest following open paren that
3035 ;; ends on another line.
3043 ;; sanity check
3059 "Indent the current top-level declaration or macro syntactically.
3060 In the macro case this also has the effect of realigning any line
3061 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3067 ;; We try to be line oriented, unless there are several
3068 ;; declarations on the same line.
3080 "Indent syntactically every line whose first char is between START
3081 and END inclusive. If the optional argument QUIET is non-nil then no
3082 syntactic errors are reported, even if `c-report-syntactic-errors' is
3083 non-nil."
3089 ;; Advance to first nonblank line.
3097 ;; shut up any echo msgs on indiv lines
3103 start))
3105 syntax)
3113 ;; update progress
3115 ;; skip empty lines
3118 ;; Get syntax and indent.
3124 ;; End of current multi-line macro?
3127 ;; Fixup macro backslashes.
3130 ;; New multi-line macro?
3142 c-parsing-error))))
3145 ;; Function version of the macro for use in places that aren't
3146 ;; compiled, e.g. in the menus.
3150 "Indent active region, current line, or block starting on this line.
3151 In Transient Mark mode, when the region is active, reindent the region.
3152 Othewise, with a prefix argument, rigidly reindent the expression
3153 starting on the current line.
3154 Otherwise reindent just the current line."
3160 \f
3161 ;; for progress reporting
3166 ;; Be silent
3168 ;; Start the progress update messages. If this Emacs doesn't have
3169 ;; a built-in timer, just be dumb about it.
3172 ;; If progress has already been initialized, do nothing. otherwise
3173 ;; initialize the counter with a vector of:
3174 ;; [start end lastsec context]
3181 context))
3183 ))
3187 nil
3192 ;; should we update? currently, update happens every 2 seconds,
3193 ;; what's the right value?
3199 )))
3203 nil
3212 \f
3213 ;;; This page handles insertion and removal of backslashes for C macros.
3216 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3217 With no argument, inserts backslashes and aligns existing backslashes.
3218 With an argument, deletes the backslashes. The backslash alignment is
3219 done according to the settings in `c-backslash-column',
3220 `c-backslash-max-column' and `c-auto-align-backslashes'.
3222 This function does not modify blank lines at the start of the region.
3223 If the region ends at the start of a line and the macro doesn't
3224 continue below it, the backslash (if any) at the end of the previous
3225 line is deleted.
3227 You can put the region around an entire macro definition and use this
3228 command to conveniently insert and align the necessary backslashes."
3231 ;; Keep the backslash trimming functions from changing the
3232 ;; whitespace around point, since in this case it's only the
3233 ;; position of point that tells the indentation of the line.
3239 column longest-line-col bs-col-after-end)
3243 ;; Nothing to do if to is at bob, since we should back up
3244 ;; and there's no line to back up to.
3245 nil
3247 ;; Do not back up the to line if line-mode is set, to make
3248 ;; e.g. c-newline-and-indent consistent regardless whether
3249 ;; the (newline) call leaves point at bol or not.
3257 ;; Set bs-col-after-end to the column of any backslash
3258 ;; following the region, or nil if there is none.
3267 ;; Back up the to line if line-mode is set, since the line
3268 ;; after the newly inserted line break should not be
3269 ;; touched in c-newline-and-indent.
3272 ;; Set bs-col-after-end to non-nil in any case, since we
3273 ;; do not want to delete the backslash at the last line.
3278 ;; Compute the smallest column number past the ends of all
3279 ;; the lines.
3283 ;; Include one more line in the max column
3284 ;; calculation, since the to line will be backslashed
3285 ;; too.
3298 ;; Try to align with surrounding backslashes.
3307 ;; Both a preceding and a following backslash.
3308 ;; Choose the greatest of them.
3311 ;; No preceding backslash. Try to align with one
3312 ;; following the region. Disregard the backslash at the
3313 ;; to line since it's likely to be bogus (e.g. when
3314 ;; called from c-newline-and-indent).
3317 ;; Don't modify blank lines at start of region.
3322 ;; Don't try to align with surrounding backslashes if
3323 ;; any line is too long.
3326 ;; Impose minimum limit and tab width alignment only if
3327 ;; we can't align with surrounding backslashes.
3331 tab-width)
3332 tab-width)))
3334 longest-line-col)))
3335 ;; Always impose maximum limit.
3338 ;; Add backslashes on all lines if the macro continues
3339 ;; after the to line.
3343 ;; Add backslashes on all lines except the last, and
3344 ;; remove any on the last line.
3352 ;; The function above leaves point on the line
3353 ;; following endmark.
3378 ;; Avoid unnecessary changes of the buffer.
3380 ;; Don't realign backslashes in string literals
3381 ;; since that would change them.
3382 )
3408 ;; Make sure there are backslashes with at least one space in
3409 ;; front of them.
3444 point-pos))
3450 \f
3451 ;;; Line breaking and paragraph filling.
3457 ;; The filling code is based on a simple theory; leave the intricacies
3458 ;; of the text handling to the currently active mode for that
3459 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3460 ;; possible to make them work correctly wrt the comment and string
3461 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3462 ;; to it, there's quite a lot of special cases to handle which makes
3463 ;; the code anything but simple. The intention is that it will work
3464 ;; with any well-written text filling package that preserves a fill
3465 ;; prefix.
3466 ;;
3467 ;; We temporarily mask comment starters and enders as necessary for
3468 ;; the filling code to do its job on a seemingly normal text block.
3469 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3470 ;; preserve it correctly (especially important when filling C++ style
3471 ;; line comments). By default, we set up and use adaptive-fill-mode,
3472 ;; which is standard in all supported Emacs flavors.
3475 ;; Determine the appropriate comment fill prefix for a block or line
3476 ;; comment. Return a cons of the prefix string and the column where
3477 ;; it ends. If fill-prefix is set, it'll override. Note that this
3478 ;; function also uses the value of point in some heuristics.
3479 ;;
3480 ;; This function might do hidden buffer changes.
3484 c-current-comment-prefix
3487 prefix-regexp
3488 comment-start-skip))
3489 prefix-line comment-prefix res comment-text-end)
3494 ;; Ugly way of getting the column after the fill
3495 ;; prefix; it'd be nice with a current-column
3496 ;; that works on strings..
3506 ;; Set fallback for comment-prefix if none is found.
3512 ;; The current line is not the comment starter, so the
3513 ;; comment has more than one line, and it can therefore be
3514 ;; used to find the comment fill prefix.
3520 ;; The line after the comment starter is inside the
3521 ;; comment, so we can use it.
3524 ;; The comment is only one line. Take the comment prefix
3525 ;; from it and keep the indentation.
3534 ;; There is only whitespace before the comment
3535 ;; starter; take the prefix straight from this line.
3540 ;; There is code before the comment starter, so we
3541 ;; have to temporarily insert and indent a new line to
3542 ;; get the right space/tab mix in the indentation.
3544 tmp)
3560 ;; The prefix ends the line with no whitespace
3561 ;; after it. Default to a single space.
3563 )))))
3576 ;; The current line is not the comment starter and
3577 ;; contains more than just the ender, so it's good enough
3578 ;; to be used for the comment fill prefix.
3588 ;; The comment is either one line or the next line contains
3589 ;; just the comment ender. In this case we have no
3590 ;; information about a suitable comment prefix, so we resort
3591 ;; to c-block-comment-prefix.
3595 ;; The point was on the comment opener line, so we might want
3596 ;; to treat this as a not yet closed comment.
3600 ;; Above `prefix-regexp' matched a nonempty prefix on the
3601 ;; second line, so let's use it. Normally it should do
3602 ;; to set `prefix-line' and let the code below pick up
3603 ;; the whole prefix, but if there's no text after the
3604 ;; match then it will probably fall back to no prefix at
3605 ;; all if the comment isn't closed yet, so in that case
3606 ;; it's better to force use of the prefix matched now.
3611 ;; There's no nonempty prefix on the line after the
3612 ;; comment opener. If the line is empty, or if the
3613 ;; text on it has less or equal indentation than the
3614 ;; comment starter we assume it's an unclosed
3615 ;; comment starter, i.e. that
3616 ;; `c-block-comment-prefix' should be used.
3617 ;; Otherwise we assume it's a closed comment where
3618 ;; the prefix really is the empty string.
3619 ;; E.g. this is an unclosed comment:
3620 ;;
3621 ;; /*
3622 ;; foo
3623 ;;
3624 ;; But this is not:
3625 ;;
3626 ;; /*
3627 ;; foo
3628 ;; */
3629 ;;
3630 ;; (Looking for the presence of the comment closer
3631 ;; rarely works since it's probably the closer of
3632 ;; some comment further down when the comment
3633 ;; really is unclosed.)
3642 ;; Otherwise the line after the comment starter is good
3643 ;; enough to find the prefix in.
3647 ;; Haven't got the comment prefix on any real line that we
3648 ;; can take it from, so we have to temporarily insert
3649 ;; `comment-prefix' on a line and indent it to find the
3650 ;; correct column and the correct mix of tabs and spaces.
3659 comment-text-end))
3664 ;; If there's ws on the current line, we'll use it
3665 ;; instead of what's ending comment-prefix.
3670 comment-prefix))
3679 ;; We insert an extra non-whitespace character
3680 ;; before the line break and after comment-prefix in
3681 ;; case it's "" or ends with whitespace.
3700 ;; prefix-line is the bol of a line on which we should try
3701 ;; to find the prefix.
3708 ;; The match is fine if there's text after it.
3714 ;; This match is better than nothing, so let's
3715 ;; remember it in case nothing better is found
3716 ;; on another line.
3720 t))))
3723 ;; Search for a line which has text after the prefix
3724 ;; so that we get the proper amount of whitespace
3725 ;; after it. We start with the current line, then
3726 ;; search backwards, then forwards.
3731 ;; The whitespace is sucked up by the
3732 ;; first [ \t]* glob if the prefix is empty.
3735 ;; If the current line doesn't have text but do
3736 ;; have whitespace after the prefix, we'll use it.
3742 ;; For line comments we can search up to and
3743 ;; including the first line.
3747 ;; For block comments we must stop before the
3748 ;; block starter.
3759 nil)
3762 ;; A good line wasn't found, but at least we have a
3763 ;; fallback that matches the comment prefix regexp.
3768 ;; There are ws or text after the prefix, so
3769 ;; let's use it.
3773 ;; Check if there's any whitespace padding
3774 ;; on the comment start line that we can
3775 ;; use after the prefix.
3793 ;; Got to mess in the buffer once again to
3794 ;; ensure the column gets correct. :P
3805 ;; Last resort: Just add a single space after
3806 ;; the prefix.
3811 ;; The line doesn't match the comment prefix regexp.
3813 ;; We have a fallback for line comments that we must use.
3816 comment-prefix)
3820 ;; Assume we are dealing with a "free text" block
3821 ;; comment where the lines doesn't have any comment
3822 ;; prefix at all and we should just fill it as
3823 ;; normal text.
3825 ))
3828 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3829 ;; masked to allow adaptive filling to work correctly. That
3830 ;; includes narrowing the buffer and, if point is inside a comment,
3831 ;; masking the comment starter and ender appropriately.
3832 ;;
3833 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3834 ;; The position of point is then less significant when doing masking
3835 ;; and narrowing.
3836 ;;
3837 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3838 ;; only if the point turns out to be inside a comment or a string.
3839 ;;
3840 ;; Note that this function does not do any hidden buffer changes.
3843 ;; beg and end limit the region to narrow. end is a marker.
3844 beg end
3845 ;; tmp-pre and tmp-post mark strings that are temporarily
3846 ;; inserted at the start and end of the region. tmp-pre is a
3847 ;; cons of the positions of the prepended string. tmp-post is
3848 ;; a marker pointing to the single character of the appended
3849 ;; string.
3850 tmp-pre tmp-post
3851 ;; If hang-ender-stuck isn't nil, the comment ender is
3852 ;; hanging. In that case it's set to the number of spaces
3853 ;; that should be between the text and the ender.
3854 hang-ender-stuck
3855 ;; auto-fill-spaces is the exact sequence of whitespace between a
3856 ;; comment's last word and the comment ender, temporarily replaced
3857 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
3858 auto-fill-spaces
3863 ;; Restore point on undo. It's necessary since we do a lot of
3864 ;; hidden inserts and deletes below that should be as transparent
3865 ;; as possible.
3869 ;; Determine the limits and type of the containing literal (if any):
3870 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
3871 ;; BEG and END.
3874 ;; Widen to catch comment limits correctly.
3899 ;; For each of the possible types of text (string, C comment ...)
3900 ;; determine BEG and END, the region we will narrow to. If we're in
3901 ;; a literal, constrain BEG and END to the limits of this literal.
3902 ;;
3903 ;; For some of these text types, particularly a block comment, we
3904 ;; may need to massage whitespace near literal delimiters, so that
3905 ;; these don't get filled inappropriately.
3910 ;; Limit to the comment or paragraph end, whichever
3911 ;; comes first.
3915 ;; The region includes the comment starter, so we must
3916 ;; check it.
3920 ;; Include the first line in the region.
3922 ;; The first line contains code before the
3923 ;; comment. We must fake a line that doesn't.
3934 ;; disallow "/*/"
3936 ;; There is a comment ender, and the region includes it. If
3937 ;; it's on its own line, it stays on its own line. If it's got
3938 ;; company on the line, it keeps (at least one word of) it.
3939 ;; "=====*/" counts as a comment ender here, but "===== */"
3940 ;; doesn't and "foo*/" doesn't.
3945 ;; The following conjunct was added to avoid an
3946 ;; "Invalid search bound (wrong side of point)"
3947 ;; error in the subsequent re-search. Maybe
3948 ;; another fix would be needed (2007-12-08).
3956 ;; The comment ender IS on its own line. Exclude
3957 ;; this line from the filling.
3960 ;; The comment ender is hanging. Replace all space between it
3961 ;; and the last word either by one or two 'x's (when
3962 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
3963 ;; as the whitespace (when auto filling), and include it in
3964 ;; the region. We'll change them back to whitespace
3965 ;; afterwards. The effect of this is to glue the comment
3966 ;; ender to the last word in the comment during filling.
3975 spaces)
3978 ;; Insert a CR after the "*/", adjust END
3986 c-current-comment-prefix
3989 ;; The comment ender is prefixed by nothing but a
3990 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
3991 ;; 2006/4/28). Remove it along with surrounding ws.
3995 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
3997 ;; What's being tested here? 2006/4/20. FIXME!!!
4001 ;; Don't adjust point below if it's
4002 ;; before the string we replace.
4004 ;; Keep one or two spaces between the
4005 ;; text and the ender, depending on how
4006 ;; many there are now.
4011 ;; paragraph filling condenses multiple spaces to
4012 ;; single or double spaces. auto-fill doesn't.
4019 ;; Insert the filler first to keep marks right.
4028 ;; Point was in the middle of the string we
4029 ;; replaced above, so put it back in the same
4030 ;; relative position, counting from the end.
4032 ))
4035 ;; The region includes the comment starter.
4039 ;; Begin with the next line.
4041 ;; Fake the fill prefix in the first line.
4056 ;; Leave the start line if it's
4057 ;; nothing but an escaped newline.
4063 ;; Narrow to the macro limits if they are nearer than the
4064 ;; paragraph limits. Don't know if this is necessary but
4065 ;; do it for completeness sake (doing auto filling at all
4066 ;; inside macros is bogus to begin with since the line
4067 ;; continuation backslashes aren't handled).
4080 ;; Try to avoid comments and macros in the paragraph to
4081 ;; avoid that the adaptive fill mode gets the prefix from
4082 ;; them.
4095 ;; Temporarily insert the fill prefix after the comment
4096 ;; starter so that the first line looks like any other
4097 ;; comment line in the narrowed region.
4101 c-current-comment-prefix
4104 ;; Oops, the prefix doesn't match the comment prefix
4105 ;; regexp. This could produce very confusing
4106 ;; results with adaptive fill packages together with
4107 ;; the insert prefix magic below, since the prefix
4108 ;; often doesn't appear at all. So let's warn about
4109 ;; it.
4111 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4113 ;; Find the right spot on the line, break it, insert
4114 ;; the fill prefix and make sure we're back in the
4115 ;; same column by temporarily prefixing the first word
4116 ;; with a number of 'x'.
4120 c-current-comment-prefix
4121 comment-start-skip))
4138 ;; `apply-outside-literal' is always set to t here if
4139 ;; we're inside a literal.
4143 ;; Kludge: If the function that adapts the fill prefix
4144 ;; doesn't produce the required comment starter for
4145 ;; line comments, then force it by setting fill-prefix.
4147 ;; Kludge the kludge: filladapt-mode doesn't
4148 ;; have this problem, but it currently
4149 ;; doesn't override fill-context-prefix
4150 ;; (version 2.12).
4152 filladapt-mode))
4159 c-lit-limits c-lit-type)))))))
4161 ;; Save the relative position of point if it's outside the
4162 ;; region we're going to narrow. Want to restore it in that
4163 ;; case, but otherwise it should be moved according to the
4164 ;; called function.
4168 ;; Preparations finally done! Now we can call the
4169 ;; actual function.
4175 ;; Restore point if it was outside the region.
4188 ;; Preserve point even if it's in the middle of the string
4189 ;; we replace; save-excursion doesn't work in that case.
4206 If any of the current line is a comment or within a comment, fill the
4207 comment or the paragraph of it that point is in, preserving the
4208 comment indentation or line-starting decorations (see the
4209 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4210 details).
4212 If point is inside multiline string literal, fill it. This currently
4213 does not respect escaped newlines, except for the special case when it
4214 is the very first thing in the string. The intended use for this rule
4215 is in situations like the following:
4218 A very long description of something that you want to fill to make
4221 If point is in any other situation, i.e. in normal code, do nothing.
4223 Optional prefix ARG means justify paragraph as well."
4226 ;; Avoid infinite recursion.
4228 fill-paragraph-function)))
4230 ;; Always return t. This has the effect that if filling isn't done
4231 ;; above, it isn't done at all, and it's therefore effectively
4232 ;; disabled in normal code.
4233 t)
4236 ;; Do automatic filling if not inside a context where it should be
4237 ;; ignored.
4239 ;; The decision whether the line should be broken is actually
4240 ;; done in c-indent-new-comment-line, which do-auto-fill
4241 ;; calls to break lines. We just set this special variable
4242 ;; so that we'll know when we're called from there. It's
4243 ;; also used to detect whether fill-prefix is user set or
4244 ;; generated automatically by do-auto-fill.
4245 fill-prefix))
4249 "Break line at point and indent, continuing comment or macro if within one.
4250 If inside a comment and `comment-multi-line' is non-nil, the
4251 indentation and line prefix are preserved (see the
4252 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4253 details). If inside a single line comment and `comment-multi-line' is
4254 nil, a new comment of the same type is started on the next line and
4255 indented as appropriate for comments. If inside a macro, a line
4256 continuation backslash is inserted and aligned as appropriate, and the
4257 new line is indented according to `c-syntactic-indentation'.
4259 If a fill prefix is specified, it overrides all the above."
4260 ;; allow-auto-fill is used from c-context-line-break to allow auto
4261 ;; filling to break the line more than once. Since this function is
4262 ;; used from auto-fill itself, that's normally disabled to avoid
4263 ;; unnecessary recursion.
4272 ;; Already know the literal type and limits when called from
4273 ;; c-context-line-break.
4280 ;; Called from do-auto-fill.
4288 c-ignore-auto-fill)
4293 ;; The adaptive fill function has generated a prefix, but
4294 ;; we're on the first line in a block comment so it'll be
4295 ;; wrong. Ignore it to guess a better one below.
4299 c-line-comment-starter)
4301 ;; Kludge: If the function that adapted the fill prefix
4302 ;; doesn't produce the required comment starter for line
4303 ;; comments, then we ignore it.
4305 )))
4308 ;; A call from do-auto-fill which should be ignored.
4309 )
4311 ;; A fill-prefix overrides anything.
4320 ;; Some sort of comment.
4326 ;; Inside a comment that should be continued.
4331 c-lit-type)))
4340 ;; Skip forward past the fill prefix in case
4341 ;; we're standing in it.
4342 ;;
4343 ;; FIXME: This doesn't work well in cases like
4344 ;;
4345 ;; /* Bla bla bla bla bla
4346 ;; bla bla
4347 ;;
4348 ;; If point is on the 'B' then the line will be
4349 ;; broken after "Bla b".
4350 ;;
4351 ;; If we have an empty comment, /* */, the next
4352 ;; lot of code pushes point to the */. We fix
4353 ;; this by never allowing point to end up to the
4354 ;; right of where it started.
4361 ;; The skip takes us out of the (block)
4362 ;; comment; insert the fill prefix at bol
4363 ;; instead and keep the position.
4370 ;; Don't break in the middle of a comment starter
4371 ;; or ender.
4380 ; middle of a TAB?
4381 ;; Inside a comment that should be broken.
4384 col)
4398 ;; c-comment-indent may look at the current
4399 ;; indentation, so let's start out with the same
4400 ;; indentation as the previous one.
4405 ;; In a macro.
4407 ;; Do not clobber the alignment of the line continuation
4408 ;; slash; c-backslash-region might look at it.
4410 ;; Got an asymmetry here: In normal code this command
4411 ;; doesn't indent the next line syntactically, and otoh a
4412 ;; normal syntactically indenting newline doesn't continue
4413 ;; the macro.
4416 ;; Somewhere else in the code.
4428 ;; advice for indent-new-comment-line for older Emacsen
4432 activate preactivate)
4433 "Call `c-indent-new-comment-line' if in CC Mode."
4436 ad-do-it
4441 "Do a line break suitable to the context.
4443 When point is outside a comment or macro, insert a newline and indent
4444 according to the syntactic context, unless `c-syntactic-indentation'
4445 is nil, in which case the new line is indented as the previous
4446 non-empty line instead.
4448 When point is inside the content of a preprocessor directive, a line
4449 continuation backslash is inserted before the line break and aligned
4450 appropriately. The end of the cpp directive doesn't count as inside
4451 it.
4453 When point is inside a comment, continue it with the appropriate
4454 comment prefix (see the `c-comment-prefix-regexp' and
4455 `c-block-comment-prefix' variables for details). The end of a
4456 C++-style line comment doesn't count as inside it.
4458 When point is inside a string, only insert a backslash when it is also
4459 inside a preprocessor directive."
4480 ; it, not in a string, and not in the
4481 ; cpp keyword.
4503 ;; c-indent-line may look at the current indentation, so let's
4504 ;; start out with the same indentation as the previous line.
4515 "Insert a line break suitable to the context and leave point before it.
4516 This is the `c-context-line-break' equivalent to `open-line', which is
4517 normally bound to C-o. See `c-context-line-break' for the details."
4522 ;; Temporarily insert a non-whitespace char to keep any
4523 ;; preceding whitespace intact.
4529 \f
4532 ;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
4533 ;;; cc-cmds.el ends here