1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985,1987,1992-2003 Free Software Foundation, Inc.
5 ;; Authors: 1998- Martin Stjernholm
6 ;; 1992-1999 Barry A. Warsaw
7 ;; 1987 Dave Detlefs and Stewart Clamen
8 ;; 1985 Richard M. Stallman
9 ;; Maintainer: bug-cc-mode@gnu.org
10 ;; Created: 22-Apr-1997 (split from cc-mode.el)
11 ;; Version: See cc-mode.el
12 ;; Keywords: c languages oop
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software; you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation; either version 2, or (at your option)
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs; see the file COPYING. If not, write to
28 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
29 ;; Boston, MA 02111-1307, USA.
37 (if (and (boundp 'byte-compile-dest-file)
38 (stringp byte-compile-dest-file))
39 (cons (file-name-directory byte-compile-dest-file) load-path)
41 (load "cc-bytecomp" nil t)))
45 (cc-require 'cc-engine)
47 ;; Silence the compiler.
48 (cc-bytecomp-defvar delete-key-deletes-forward) ; XEmacs 20+
49 (cc-bytecomp-defun delete-forward-p) ; XEmacs 21+
50 (cc-bytecomp-obsolete-fun insert-and-inherit) ; Marked obsolete in XEmacs 19
51 (cc-bytecomp-defvar filladapt-mode) ; c-fill-paragraph contains a kludge
52 ; which looks at this.
55 (defvar c-fix-backslashes t)
57 (defun c-indent-line (&optional syntax quiet ignore-point-pos)
58 "Indent the current line according to the syntactic context,
59 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
60 syntactic information for the current line. Be silent about syntactic
61 errors if the optional argument QUIET is non-nil, even if
62 `c-report-syntactic-errors' is non-nil. Normally the position of
63 point is used to decide where the old indentation is on a lines that
64 is otherwise empty \(ignoring any line continuation backslash), but
65 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
66 indentation change \(in columns)."
68 ;; This function does not do any hidden buffer changes.
70 (let ((line-cont-backslash (save-excursion
72 (eq (char-before) ?\\)))
73 (c-fix-backslashes c-fix-backslashes)
76 (when (and (not ignore-point-pos)
79 (looking-at (if line-cont-backslash
82 (<= (point) (match-end 1)))
83 ;; Delete all whitespace after point if there's only whitespace
84 ;; on the line, so that any code that does back-to-indentation
85 ;; or similar gets the current column in this case. If this
86 ;; removes a line continuation backslash it'll be restored
88 (unless c-auto-align-backslashes
89 ;; Should try to keep the backslash alignment
92 (goto-char (match-end 0))
93 (setq bs-col (1- (current-column)))))
94 (delete-region (point) (match-end 0))
95 (setq c-fix-backslashes t))
96 (if c-syntactic-indentation
98 (or (let ((c-parsing-error nil)
101 (and (boundp 'c-syntactic-context)
102 c-syntactic-context))))
103 (c-save-buffer-state (indent)
104 (unless c-syntactic-context
105 (setq c-syntactic-context (c-guess-basic-syntax)))
106 (setq indent (c-get-syntactic-indentation
107 c-syntactic-context))
108 (and (not (c-echo-parsing-error quiet))
109 c-echo-syntactic-information-p
110 (message "syntax: %s, indent: %d"
111 c-syntactic-context indent))
112 (setq shift-amt (- indent (current-indentation))))
113 (c-shift-line-indentation shift-amt)
114 (run-hooks 'c-special-indent-hook)
119 (while (and (= (forward-line -1) 0)
120 (if (looking-at "\\s *\\\\?$")
122 (setq indent (current-indentation))
124 (setq shift-amt (- indent (current-indentation)))
125 (c-shift-line-indentation shift-amt)))
126 (when (and c-fix-backslashes line-cont-backslash)
131 (when c-auto-align-backslashes
132 ;; Realign the line continuation backslash.
133 (c-backslash-region (point) (point) nil t))))
136 (defun c-newline-and-indent (&optional newline-arg)
137 "Inserts a newline and indents the new line.
138 This function fixes line continuation backslashes if inside a macro,
139 and takes care to set the indentation before calling
140 `indent-according-to-mode', so that lineup functions like
141 `c-lineup-dont-change' works better."
143 ;; This function does not do any hidden buffer changes.
145 ;; TODO: Backslashes before eol in comments and literals aren't
147 (let ((c-macro-start (c-query-macro-start))
148 ;; Avoid calling c-backslash-region from c-indent-line if it's
149 ;; called during the newline call, which can happen due to
150 ;; c-electric-continued-statement, for example. We also don't
151 ;; want any backslash alignment from indent-according-to-mode.
152 (c-fix-backslashes nil)
153 has-backslash insert-backslash
158 (while (and (looking-at "[ \t]*\\\\?$")
159 (= (forward-line -1) 0)))
160 (setq col (current-indentation)))
162 (if (and (eolp) (eq (char-before) ?\\))
163 (setq insert-backslash t
165 (setq has-backslash (eq (char-before (c-point 'eol)) ?\\))))
166 (newline newline-arg)
171 ;; The backslash stayed on the previous line. Insert one
172 ;; before calling c-backslash-region, so that
173 ;; bs-col-after-end in it works better. Fixup the
174 ;; backslashes on the newly inserted line.
177 (c-backslash-region (point) (point) nil t))
178 ;; The backslash moved to the new line, if there was any. Let
179 ;; c-backslash-region fix a backslash on the previous line,
180 ;; and the one that might be on the new line.
181 ;; c-auto-align-backslashes is intentionally ignored here;
182 ;; maybe the moved backslash should be left alone if it's set,
183 ;; but we fix both lines on the grounds that the old backslash
184 ;; has been moved anyway and is now in a different context.
185 (c-backslash-region start (if has-backslash (point) start) nil t)))
186 (when c-syntactic-indentation
187 ;; Reindent syntactically. The indentation done above is not
188 ;; wasted, since c-indent-line might look at the current
190 (let ((c-syntactic-context (c-save-buffer-state nil
191 (c-guess-basic-syntax))))
192 ;; We temporarily insert another line break, so that the
193 ;; lineup functions will see the line as empty. That makes
194 ;; e.g. c-lineup-cpp-define more intuitive since it then
195 ;; proceeds to the preceding line in this case.
197 (delete-horizontal-space)
198 (setq start (- (point-max) (point)))
202 (indent-according-to-mode))
203 (goto-char (- (point-max) start))
206 ;; Must align the backslash again after reindentation. The
207 ;; c-backslash-region call above can't be optimized to ignore
208 ;; this line, since it then won't align correctly with the
209 ;; lines below if the first line in the macro is broken.
210 (c-backslash-region (point) (point) nil t)))))
212 (defun c-show-syntactic-information (arg)
213 "Show syntactic information for current line.
214 With universal argument, inserts the analysis as a comment on that line."
216 (let* ((c-parsing-error nil)
217 (syntax (if (boundp 'c-syntactic-context)
218 ;; Use `c-syntactic-context' in the same way as
219 ;; `c-indent-line', to be consistent.
221 (c-save-buffer-state nil
222 (c-guess-basic-syntax)))))
223 (if (not (consp arg))
224 (message "syntactic analysis: %s" syntax)
226 (insert-and-inherit (format "%s" syntax))
228 (c-keep-region-active))
230 (defun c-syntactic-information-on-region (from to)
231 "Inserts a comment with the syntactic analysis on every line in the region."
235 (narrow-to-region from to)
236 (goto-char (point-min))
238 (c-show-syntactic-information '(0))
242 (defun c-toggle-syntactic-indentation (&optional arg)
243 "Toggle syntactic indentation.
244 Optional numeric ARG, if supplied, turns on syntactic indentation when
245 positive, turns it off when negative, and just toggles it when zero or
248 When syntactic indentation is turned on (the default), the indentation
249 functions and the electric keys indent according to the syntactic
250 context keys, when applicable.
252 When it's turned off, the electric keys does no reindentation, the
253 indentation functions indents every new line to the same level as the
254 previous nonempty line, and \\[c-indent-command] adjusts the
255 indentation in seps specified `c-basic-offset'. The indentation style
256 has no effect in this mode, nor any of the indentation associated
257 variables, e.g. `c-special-indent-hook'.
259 This command sets the variable `c-syntactic-indentation'."
261 (setq c-syntactic-indentation
262 (c-calculate-state arg c-syntactic-indentation))
263 (c-keep-region-active))
265 (defun c-toggle-auto-state (&optional arg)
266 "Toggle auto-newline feature.
267 Optional numeric ARG, if supplied, turns on auto-newline when
268 positive, turns it off when negative, and just toggles it when zero or
271 When the auto-newline feature is enabled (as evidenced by the `/a' or
272 `/ah' on the modeline after the mode name) newlines are automatically
273 inserted after special characters such as brace, comma, semi-colon,
276 (setq c-auto-newline (c-calculate-state arg c-auto-newline))
278 (c-keep-region-active))
280 (defun c-toggle-hungry-state (&optional arg)
281 "Toggle hungry-delete-key feature.
282 Optional numeric ARG, if supplied, turns on hungry-delete when
283 positive, turns it off when negative, and just toggles it when zero or
286 When the hungry-delete-key feature is enabled (as evidenced by the
287 `/h' or `/ah' on the modeline after the mode name) the delete key
288 gobbles all preceding whitespace in one fell swoop."
290 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
292 (c-keep-region-active))
294 (defun c-toggle-auto-hungry-state (&optional arg)
295 "Toggle auto-newline and hungry-delete-key features.
296 Optional numeric ARG, if supplied, turns on auto-newline and
297 hungry-delete when positive, turns them off when negative, and just
298 toggles them when zero or left out.
300 See `c-toggle-auto-state' and `c-toggle-hungry-state' for details."
302 (setq c-auto-newline (c-calculate-state arg c-auto-newline))
303 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
305 (c-keep-region-active))
310 (defun c-electric-backspace (arg)
311 "Delete the preceding character or whitespace.
312 If `c-hungry-delete-key' is non-nil, as evidenced by the \"/h\" or
313 \"/ah\" string on the mode line, then all preceding whitespace is
314 consumed. If however a prefix argument is supplied, or
315 `c-hungry-delete-key' is nil, or point is inside a literal then the
316 function in the variable `c-backspace-function' is called."
318 (if (or (not c-hungry-delete-key)
321 (funcall c-backspace-function (prefix-numeric-value arg))
322 (c-hungry-backspace)))
324 (defun c-hungry-backspace ()
325 "Delete the preceding character or all preceding whitespace
326 back to the previous non-whitespace character.
327 See also \\[c-hungry-delete-forward]."
329 (let ((here (point)))
331 (if (/= (point) here)
332 (delete-region (point) here)
333 (funcall c-backspace-function 1))))
335 (defun c-electric-delete-forward (arg)
336 "Delete the following character or whitespace.
337 If `c-hungry-delete-key' is non-nil, as evidenced by the \"/h\" or
338 \"/ah\" string on the mode line, then all following whitespace is
339 consumed. If however a prefix argument is supplied, or
340 `c-hungry-delete-key' is nil, or point is inside a literal then the
341 function in the variable `c-delete-function' is called."
343 (if (or (not c-hungry-delete-key)
346 (funcall c-delete-function (prefix-numeric-value arg))
347 (c-hungry-delete-forward)))
349 (defun c-hungry-delete-forward ()
350 "Delete the following character or all following whitespace
351 up to the next non-whitespace character.
352 See also \\[c-hungry-backspace]."
354 (let ((here (point)))
356 (if (/= (point) here)
357 (delete-region (point) here)
358 (funcall c-delete-function 1))))
360 ;; This function is only used in XEmacs.
361 (defun c-electric-delete (arg)
362 "Deletes preceding or following character or whitespace.
363 This function either deletes forward as `c-electric-delete-forward' or
364 backward as `c-electric-backspace', depending on the configuration:
366 If the function `delete-forward-p' is defined (XEmacs 21) and returns
367 non-nil, it deletes forward. Else, if the variable
368 `delete-key-deletes-forward' is defined (XEmacs 20) and is set to
369 non-nil, it deletes forward. Otherwise it deletes backward.
371 Note: This is the way in XEmacs 20 and later to choose the correct
372 action for the [delete] key, whichever key that means. In other
373 flavors this function isn't used, instead it's left to the user to
374 bind [delete] to either \\[c-electric-delete-forward] or \\[c-electric-backspace] as appropriate
375 \(the keymap `function-key-map' is useful for that). Emacs 21 handles
376 that automatically, though."
378 (if (or (and (fboundp 'delete-forward-p) ;XEmacs 21
380 (and (boundp 'delete-key-deletes-forward) ;XEmacs 20
381 delete-key-deletes-forward))
382 (c-electric-delete-forward arg)
383 (c-electric-backspace arg)))
385 (defun c-electric-pound (arg)
386 "Electric pound (`#') insertion.
387 Inserts a `#' character specially depending on the variable
388 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if
389 point is inside a literal or a macro, nothing special happens."
392 (not (memq 'alignleft c-electric-pound-behavior))
394 (skip-chars-backward " \t")
397 (and (= (forward-line -1) 0)
399 (eq (char-before) ?\\))))
401 ;; do nothing special
402 (self-insert-command (prefix-numeric-value arg))
403 ;; place the pound character at the left edge
404 (let ((pos (- (point-max) (point)))
407 (delete-horizontal-space)
408 (insert last-command-char)
410 (goto-char (- (point-max) pos)))
413 (defun c-electric-brace (arg)
416 If the auto-newline feature is turned on, as evidenced by the \"/a\"
417 or \"/ah\" string on the mode line, newlines are inserted before and
418 after braces based on the value of `c-hanging-braces-alist'.
420 Also, the line is re-indented unless a numeric ARG is supplied, the
421 brace is inserted inside a literal, or `c-syntactic-indentation' is
424 This function does various newline cleanups based on the value of
427 (let* ((safepos (c-safe-position (point) (c-parse-state)))
428 (literal (c-in-literal safepos))
429 ;; We want to inhibit blinking the paren since this will be
430 ;; most disruptive. We'll blink it ourselves later on.
431 (old-blink-paren blink-paren-function)
432 blink-paren-function)
435 (self-insert-command (prefix-numeric-value arg)))
436 ((not (looking-at "[ \t]*\\\\?$"))
437 (self-insert-command (prefix-numeric-value arg))
438 (if c-syntactic-indentation
439 (indent-according-to-mode)))
442 ;; This is the list of brace syntactic symbols that can
443 ;; hang. If any new ones are added to c-offsets-alist,
444 ;; they should be added here as well.
445 '(class-open class-close defun-open defun-close
446 inline-open inline-close
447 brace-list-open brace-list-close
448 brace-list-intro brace-entry-open
449 block-open block-close
450 substatement-open statement-case-open
451 extern-lang-open extern-lang-close
452 namespace-open namespace-close
453 module-open module-close
454 composition-open composition-close
455 inexpr-class-open inexpr-class-close
456 ;; `statement-cont' is here for the case with a brace
457 ;; list opener inside a statement. C.f. CASE B.2 in
458 ;; `c-guess-continued-construct'.
460 (insertion-point (point))
461 (preserve-p (and (not (bobp))
462 (eq ?\ (char-syntax (char-before)))))
464 (c-echo-syntactic-information-p nil)
465 delete-temp-newline syntax newlines)
466 ;; only insert a newline if there is non-whitespace behind us
467 (when (save-excursion
468 (skip-chars-backward " \t")
470 (c-newline-and-indent)
471 ;; Set markers around the newline and indention inserted
472 ;; above. We insert the start marker here and not before
473 ;; the call to kludge around a misfeature in expand-abbrev:
474 ;; If the line contains e.g. "else" then expand-abbrev will
475 ;; be called when c-newline-and-indent inserts the newline.
476 ;; That function first removes the abbrev "else" and then
477 ;; inserts the expansion, which is an identical "else" in
478 ;; this case. So the marker that we put after "else" would
480 (setq delete-temp-newline
481 (cons (save-excursion
483 (if (eq (char-before) ?\\)
484 ;; Ignore a line continuation.
486 (skip-chars-backward " \t")
487 (copy-marker (point) t))
491 (if (eq last-command-char ?{)
492 (setq c-state-cache (cons (point) c-state-cache)))
493 (self-insert-command (prefix-numeric-value arg))
494 (c-save-buffer-state ((c-syntactic-indentation-in-macros t)
495 (c-auto-newline-analysis t))
496 ;; Turn on syntactic macro analysis to help with auto
498 (setq syntax (c-guess-basic-syntax)))
504 ;; Substitute inexpr-class and class-open or
505 ;; class-close with inexpr-class-open or
506 ;; inexpr-class-close.
507 (if (assq 'inexpr-class syntax)
508 (cond ((assq 'class-open syntax)
509 '((inexpr-class-open)))
510 ((assq 'class-close syntax)
511 '((inexpr-class-close)))
514 c-hanging-braces-alist)
515 '(ignore before after))))
516 ;; Do not try to insert newlines around a special
517 ;; (Pike-style) brace list.
518 (if (and c-special-brace-lists
520 (c-save-buffer-state nil
521 (c-safe (if (= (char-before) ?{)
524 (c-looking-at-special-brace-list)))))
526 ;; If syntax is a function symbol, then call it using the
527 ;; defined semantics.
528 (if (and (not (consp (cdr newlines)))
529 (functionp (cdr newlines)))
530 (let ((c-syntactic-context syntax))
532 (funcall (cdr newlines)
535 ;; does a newline go before the open brace?
536 (when (memq 'before newlines)
537 ;; we leave the newline we've put in there before,
538 ;; but we need to re-indent the line above
539 (when delete-temp-newline
540 (set-marker (car delete-temp-newline) nil)
541 (set-marker (cdr delete-temp-newline) nil)
542 (setq delete-temp-newline nil))
543 (when c-syntactic-indentation
544 (let ((pos (- (point-max) (point)))
547 (indent-according-to-mode)
548 (goto-char (- (point-max) pos))
549 ;; if the buffer has changed due to the
550 ;; indentation, we need to recalculate syntax for
552 (if (/= (point) here)
554 ((c-syntactic-indentation-in-macros t)
555 (c-auto-newline-analysis t))
556 ;; Turn on syntactic macro analysis to help
557 ;; with auto newlines only.
558 (setq syntax (c-guess-basic-syntax))))))))
559 ;; must remove the newline we just stuck in (if we really did it)
560 (when delete-temp-newline
562 (delete-region (car delete-temp-newline)
563 (cdr delete-temp-newline))
564 (goto-char (car delete-temp-newline))
565 (set-marker (car delete-temp-newline) nil)
566 (set-marker (cdr delete-temp-newline) nil)
567 ;; if there is whitespace before point, then preserve
568 ;; at least one space.
572 (if (not (memq 'before newlines))
573 ;; since we're hanging the brace, we need to recalculate
575 (c-save-buffer-state ((c-syntactic-indentation-in-macros t)
576 (c-auto-newline-analysis t))
577 ;; Turn on syntactic macro analysis to help with auto
579 (setq syntax (c-guess-basic-syntax))))
580 (when c-syntactic-indentation
581 ;; Now adjust the line's indentation. Don't update the state
582 ;; cache since c-guess-basic-syntax isn't called when
583 ;; c-syntactic-context is set.
584 (let* ((c-syntactic-context syntax))
585 (indent-according-to-mode)))
586 ;; Do all appropriate clean ups
588 (pos (- (point-max) (point)))
590 ;; clean up empty defun braces
591 (if (and c-auto-newline
592 (memq 'empty-defun-braces c-cleanup-list)
593 (eq last-command-char ?\})
594 (c-intersect-lists '(defun-close class-close inline-close)
599 (eq (char-before) ?\{))
600 ;; make sure matching open brace isn't in a comment
601 (not (c-in-literal)))
602 (delete-region (point) (1- here)))
603 ;; clean up brace-else-brace and brace-elseif-brace
604 (when (and c-auto-newline
605 (eq last-command-char ?\{))
607 ((and (memq 'brace-else-brace c-cleanup-list)
610 "\\([ \t\n]\\|\\\\\n\\)*"
612 "\\([ \t\n]\\|\\\\\n\\)*"
616 (setq mbeg (match-beginning 0)
618 (eq (match-end 0) here)))
619 (delete-region mbeg mend)
620 (insert-and-inherit "} else {"))
621 ((and (memq 'brace-elseif-brace c-cleanup-list)
623 (goto-char (1- here))
627 (eq (char-before) ?\)))
628 (zerop (c-save-buffer-state nil (c-backward-token-2 1 t)))
629 (eq (char-after) ?\()
634 "\\([ \t\n]\\|\\\\\n\\)*"
636 "\\([ \t\n]\\|\\\\\n\\)+"
638 "\\([ \t\n]\\|\\\\\n\\)*")
640 (eq (match-end 0) tmp))
641 (delete-region mbeg mend)
644 (goto-char (- (point-max) pos))
646 ;; does a newline go after the brace?
647 (if (memq 'after newlines)
648 (c-newline-and-indent))
651 (and (eq last-command-char ?\})
652 (not executing-kbd-macro)
655 (c-save-buffer-state nil
656 (c-backward-syntactic-ws safepos))
657 (funcall old-blink-paren)))))
659 (defun c-electric-slash (arg)
660 "Insert a slash character.
662 Indent the line as a comment, if:
664 1. The slash is second of a `//' line oriented comment introducing
665 token and we are on a comment-only-line, or
667 2. The slash is part of a `*/' token that closes a block oriented
670 If a numeric ARG is supplied, point is inside a literal, or
671 `c-syntactic-indentation' is nil, indentation is inhibited."
673 (let* ((ch (char-before))
674 (literal (c-in-literal))
675 (indentp (and c-syntactic-indentation
677 (eq last-command-char ?/)
684 (c-echo-syntactic-information-p nil))
685 (self-insert-command (prefix-numeric-value arg))
687 (indent-according-to-mode))))
689 (defun c-electric-star (arg)
690 "Insert a star character.
691 If the star is the second character of a C style comment introducing
692 construct, and we are on a comment-only-line, indent line as comment.
693 If a numeric ARG is supplied, point is inside a literal, or
694 `c-syntactic-indentation' is nil, indentation is inhibited."
696 (self-insert-command (prefix-numeric-value arg))
697 ;; if we are in a literal, or if arg is given do not re-indent the
698 ;; current line, unless this star introduces a comment-only line.
699 (if (and c-syntactic-indentation
701 (eq (c-in-literal) 'c)
702 (eq (char-before) ?*)
705 (skip-chars-backward "*")
706 (if (eq (char-before) ?/)
708 (skip-chars-backward " \t")
710 (let (c-echo-syntactic-information-p) ; shut this up
711 (indent-according-to-mode))
714 (defun c-electric-semi&comma (arg)
715 "Insert a comma or semicolon.
716 When the auto-newline feature is turned on, as evidenced by the \"/a\"
717 or \"/ah\" string on the mode line, a newline might be inserted. See
718 the variable `c-hanging-semi&comma-criteria' for how newline insertion
721 When a semicolon is inserted, the line is re-indented unless a numeric
722 arg is supplied, point is inside a literal, or
723 `c-syntactic-indentation' is nil.
725 Based on the value of `c-cleanup-list', this function cleans up commas
726 following brace lists and semicolons following defuns."
728 (let* ((lim (c-most-enclosing-brace (c-parse-state)))
729 (literal (c-in-literal lim))
732 (c-echo-syntactic-information-p nil))
734 (self-insert-command (prefix-numeric-value arg))
735 ;; do some special stuff with the character
736 (self-insert-command (prefix-numeric-value arg))
737 ;; do all cleanups and newline insertions if c-auto-newline is
739 (if (or (not c-auto-newline)
740 (not (looking-at "[ \t]*\\\\?$")))
741 (if c-syntactic-indentation
742 (indent-according-to-mode))
744 (let ((pos (- (point-max) (point))))
746 (eq last-command-char ?,)
747 (memq 'list-close-comma c-cleanup-list))
749 (eq last-command-char ?\;)
750 (memq 'defun-close-semi c-cleanup-list)))
754 (eq (char-before) ?}))
755 ;; make sure matching open brace isn't in a comment
756 (not (c-in-literal lim)))
757 (delete-region (point) here))
758 (goto-char (- (point-max) pos)))
760 (if c-syntactic-indentation
761 (indent-according-to-mode))
762 ;; check to see if a newline should be added
763 (let ((criteria c-hanging-semi&comma-criteria)
764 answer add-newline-p)
766 (setq answer (funcall (car criteria)))
767 ;; only nil value means continue checking
769 (setq criteria (cdr criteria))
771 ;; only 'stop specifically says do not add a newline
772 (setq add-newline-p (not (eq answer 'stop)))
775 (c-newline-and-indent))
778 (defun c-electric-colon (arg)
781 If the auto-newline feature is turned on, as evidenced by the \"/a\"
782 or \"/ah\" string on the mode line, newlines are inserted before and
783 after colons based on the value of `c-hanging-colons-alist'.
785 Also, the line is re-indented unless a numeric ARG is supplied, the
786 colon is inserted inside a literal, or `c-syntactic-indentation' is
789 This function cleans up double colon scope operators based on the
790 value of `c-cleanup-list'."
792 (let* ((bod (c-point 'bod))
793 (literal (c-in-literal bod))
796 (c-echo-syntactic-information-p nil))
799 (self-insert-command (prefix-numeric-value arg)))
800 ((not (looking-at "[ \t]*\\\\?$"))
801 (self-insert-command (prefix-numeric-value arg))
802 (if c-syntactic-indentation
803 (indent-according-to-mode)))
805 ;; insert the colon, then do any specified cleanups
806 (self-insert-command (prefix-numeric-value arg))
807 (let ((pos (- (point-max) (point)))
809 (if (and c-auto-newline
810 (memq 'scope-operator c-cleanup-list)
811 (eq (char-before) ?:)
815 (eq (char-before) ?:))
817 (not (eq (char-after (- (point) 2)) ?:)))
819 (delete-region (point) (1- here))
820 (setq is-scope-op t)))
821 (goto-char (- (point-max) pos)))
822 ;; indent the current line if it's done syntactically.
823 (if c-syntactic-indentation
824 ;; Cannot use the same syntax analysis as we find below,
825 ;; since that's made with c-syntactic-indentation-in-macros
827 (indent-according-to-mode))
829 ((c-syntactic-indentation-in-macros t)
830 (c-auto-newline-analysis t)
831 ;; Turn on syntactic macro analysis to help with auto newlines
833 (syntax (c-guess-basic-syntax))
835 ;; Translate substatement-label to label for this operation.
837 (if (eq (car (car elem)) 'substatement-label)
838 (setcar (car elem) 'label))
839 (setq elem (cdr elem)))
840 ;; some language elements can only be determined by checking
841 ;; the following line. Lets first look for ones that can be
842 ;; found when looking on the line with the colon
845 (or (c-lookup-lists '(case-label label access-label)
846 syntax c-hanging-colons-alist)
847 (c-lookup-lists '(member-init-intro inher-intro)
851 (c-guess-basic-syntax)
853 c-hanging-colons-alist)))))
854 ;; does a newline go before the colon? Watch out for already
855 ;; non-hung colons. However, we don't unhang them because that
856 ;; would be a cleanup (and anti-social).
857 (if (and (memq 'before newlines)
860 (skip-chars-backward ": \t")
862 (let ((pos (- (point-max) (point))))
864 (c-newline-and-indent)
865 (goto-char (- (point-max) pos))))
866 ;; does a newline go after the colon?
867 (if (and (memq 'after (cdr-safe newlines))
869 (c-newline-and-indent))
872 (defun c-electric-lt-gt (arg)
873 "Insert a less-than, or greater-than character.
874 The line will be re-indented if the character inserted is the second
875 of a C++ style stream operator and the buffer is in C++ mode.
876 Exceptions are when a numeric argument is supplied, point is inside a
877 literal, or `c-syntactic-indentation' is nil, in which case the line
878 will not be re-indented."
880 (let ((indentp (and c-syntactic-indentation
882 (eq (char-before) last-command-char)
883 (not (c-in-literal))))
885 (c-echo-syntactic-information-p nil))
886 (self-insert-command (prefix-numeric-value arg))
888 (indent-according-to-mode))))
890 (defun c-electric-paren (arg)
891 "Insert a parenthesis.
893 Some newline cleanups are done if appropriate; see the variable
896 Also, the line is re-indented unless a numeric ARG is supplied, the
897 parenthesis is inserted inside a literal, or `c-syntactic-indentation'
900 (let ((literal (c-in-literal (c-point 'bod)))
902 (c-echo-syntactic-information-p nil))
904 (self-insert-command (prefix-numeric-value arg))
905 ;; do some special stuff with the character
906 (let* (;; We want to inhibit blinking the paren since this will
907 ;; be most disruptive. We'll blink it ourselves
909 (old-blink-paren blink-paren-function)
910 blink-paren-function)
911 (self-insert-command (prefix-numeric-value arg))
912 (if c-syntactic-indentation
913 (indent-according-to-mode))
914 (when (looking-at "[ \t]*\\\\?$")
916 ;; Do all appropriate clean ups
918 (pos (- (point-max) (point)))
920 ;; clean up brace-elseif-brace
921 (if (and (memq 'brace-elseif-brace c-cleanup-list)
922 (eq last-command-char ?\()
925 "\\([ \t\n]\\|\\\\\n\\)*"
927 "\\([ \t\n]\\|\\\\\n\\)+"
929 "\\([ \t\n]\\|\\\\\n\\)*"
933 (setq mbeg (match-beginning 0)
936 (not (c-in-literal)))
938 (delete-region mbeg mend)
939 (insert-and-inherit "} else if ("))
940 ;; clean up brace-catch-brace
942 (if (and (memq 'brace-catch-brace c-cleanup-list)
943 (eq last-command-char ?\()
946 "\\([ \t\n]\\|\\\\\n\\)*"
948 "\\([ \t\n]\\|\\\\\n\\)*"
952 (setq mbeg (match-beginning 0)
955 (not (c-in-literal)))
957 (delete-region mbeg mend)
958 (insert-and-inherit "} catch ("))))
959 (goto-char (- (point-max) pos))
961 (let (beg (end (1- (point))))
962 (cond ((and (memq 'space-before-funcall c-cleanup-list)
963 (eq last-command-char ?\()
966 (skip-chars-backward " \t")
970 (delete-region beg end)
973 ((and (memq 'compact-empty-funcall c-cleanup-list)
974 (eq last-command-char ?\))
976 (c-safe (backward-char 2))
977 (when (looking-at "()")
979 (skip-chars-backward " \t")
982 (delete-region beg end))))
983 (and (not executing-kbd-macro)
985 (funcall old-blink-paren))))))
987 (defun c-electric-continued-statement ()
988 "Reindent the current line if appropriate.
990 This function is used to reindent the line after a keyword which
991 continues an earlier statement is typed, e.g. an \"else\" or the
992 \"while\" in a do-while block.
994 The line is reindented if there is nothing but whitespace before the
995 keyword on the line, the keyword is not inserted inside a literal, and
996 `c-syntactic-indentation' is non-nil."
997 (let (;; shut this up
998 (c-echo-syntactic-information-p nil))
999 (when (and c-syntactic-indentation
1000 (not (eq last-command-char ?_))
1002 (skip-syntax-backward "w")
1005 (not (c-in-literal (c-point 'bod))))
1006 ;; Have to temporarily insert a space so that
1007 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1008 ;; space with a nonspace to avoid messing up any whitespace
1009 ;; sensitive meddling that might be done, e.g. by
1010 ;; `c-backslash-region'.
1011 (insert-and-inherit " x")
1013 (indent-according-to-mode)
1014 (delete-char -2)))))
1017 ;; better movement routines for ThisStyleOfVariablesCommonInCPlusPlus
1018 ;; originally contributed by Terry_Glanfield.Southern@rxuk.xerox.com
1019 (defun c-forward-into-nomenclature (&optional arg)
1020 "Move forward to end of a nomenclature section or word.
1021 With arg, do it arg times."
1023 (let ((case-fold-search nil))
1026 (cc-eval-when-compile
1027 (concat "\\W*\\([" c-upper "]*[" c-lower c-digit "]*\\)"))
1029 (while (and (< arg 0)
1031 (cc-eval-when-compile
1033 "\\(\\(\\W\\|[" c-lower c-digit "]\\)[" c-upper "]+"
1037 (setq arg (1+ arg)))))
1038 (c-keep-region-active))
1040 (defun c-backward-into-nomenclature (&optional arg)
1041 "Move backward to beginning of a nomenclature section or word.
1042 With optional ARG, move that many times. If ARG is negative, move
1045 (c-forward-into-nomenclature (- arg))
1046 (c-keep-region-active))
1048 (defun c-scope-operator ()
1049 "Insert a double colon scope operator at point.
1050 No indentation or other \"electric\" behavior is performed."
1052 (insert-and-inherit "::"))
1054 (defun c-beginning-of-defun (&optional arg)
1055 "Move backward to the beginning of a defun.
1056 Every top level declaration that contains a brace paren block is
1057 considered to be a defun.
1059 With a positive argument, move backward that many defuns. A negative
1060 argument -N means move forward to the Nth following beginning. Return
1061 t unless search stops due to beginning or end of buffer.
1063 Unlike the built-in `beginning-of-defun' this tries to be smarter
1064 about finding the char with open-parenthesis syntax that starts the
1068 (or arg (setq arg 1))
1071 (when (c-end-of-defun (- arg))
1072 (c-save-buffer-state nil (c-forward-syntactic-ws))
1075 (c-save-buffer-state (paren-state lim pos)
1078 ;; Note: Partial code duplication in `c-end-of-defun' and
1079 ;; `c-declaration-limits'.
1081 (setq paren-state (c-parse-state))
1083 (goto-char (c-least-enclosing-brace paren-state))
1084 ;; If we moved to the outermost enclosing paren
1085 ;; then we can use c-safe-position to set the
1086 ;; limit. Can't do that otherwise since the
1087 ;; earlier paren pair on paren-state might very
1088 ;; well be part of the declaration we should go
1090 (setq lim (c-safe-position (point) paren-state))
1092 ;; At top level. Make sure we aren't inside a literal.
1093 (setq pos (c-literal-limits
1094 (c-safe-position (point) paren-state)))
1095 (if pos (goto-char (car pos))))
1097 (while (let ((start (point)))
1098 (c-beginning-of-decl-1 lim)
1099 (if (= (point) start)
1100 ;; Didn't move. Might be due to bob or unbalanced
1101 ;; parens. Try to continue if it's the latter.
1102 (unless (c-safe (goto-char
1103 (c-down-list-backward (point))))
1104 ;; Didn't work, so it's bob then.
1105 (goto-char (point-min))
1109 ;; Check if the declaration contains a brace
1110 ;; block. If not, we try another one.
1112 (not (and (c-syntactic-re-search-forward "[;{]" nil t t)
1113 (or (eq (char-before) ?{)
1114 (and c-recognize-knr-p
1115 ;; Might have stopped on the
1116 ;; ';' in a K&R argdecl. In
1117 ;; that case the declaration
1118 ;; should contain a block.
1119 (c-in-knr-argdecl pos)))))))
1122 ;; Check if `c-beginning-of-decl-1' put us after the block
1123 ;; in a declaration that doesn't end there. We're searching
1124 ;; back and forth over the block here, which can be
1127 (if (and c-opt-block-decls-with-vars-key
1129 (c-backward-syntactic-ws)
1130 (eq (char-before) ?}))
1131 (eq (car (c-beginning-of-decl-1))
1140 ;; Try to be line oriented; position point at the closest
1141 ;; preceding boi that isn't inside a comment, but if we hit
1142 ;; the previous declaration then we use the current point
1144 (while (and (/= (point) (c-point 'boi))
1145 (c-backward-single-comment)))
1146 (if (/= (point) (c-point 'boi))
1149 (setq arg (1- arg)))))
1150 (c-keep-region-active)
1153 (defun c-end-of-defun (&optional arg)
1154 "Move forward to the end of a top level declaration.
1155 With argument, do it that many times. Negative argument -N means move
1156 back to Nth preceding end. Returns t unless search stops due to
1157 beginning or end of buffer.
1159 An end of a defun occurs right after the close-parenthesis that matches
1160 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1163 (or arg (setq arg 1))
1166 (when (c-beginning-of-defun (- arg))
1167 (c-save-buffer-state nil (c-backward-syntactic-ws))
1170 (c-save-buffer-state (paren-state lim pos)
1173 ;; Note: Partial code duplication in `c-beginning-of-defun'
1174 ;; and `c-declaration-limits'.
1176 (setq paren-state (c-parse-state))
1178 (goto-char (c-least-enclosing-brace paren-state))
1179 ;; If we moved to the outermost enclosing paren
1180 ;; then we can use c-safe-position to set the
1181 ;; limit. Can't do that otherwise since the
1182 ;; earlier paren pair on paren-state might very
1183 ;; well be part of the declaration we should go
1185 (setq lim (c-safe-position (point) paren-state))
1187 ;; At top level. Make sure we aren't inside a literal.
1188 (setq pos (car-safe (c-literal-limits
1189 (c-safe-position (point) paren-state))))
1190 (if pos (goto-char pos)))
1192 ;; Have to move to the start first so that `c-end-of-decl-1'
1193 ;; has the correct start position.
1195 (when (memq (car (c-beginning-of-decl-1 lim))
1197 ;; We moved back over the previous defun or a macro. Move
1198 ;; to the next token; it's the start of the next
1199 ;; declaration. We can also be directly after the block
1200 ;; in a `c-opt-block-decls-with-vars-key' declaration, but
1201 ;; then we won't move significantly far here.
1203 (c-forward-token-2 0))
1205 (while (let ((start (point)))
1207 (if (= (point) start)
1208 ;; Didn't move. Might be due to eob or unbalanced
1209 ;; parens. Try to continue if it's the latter.
1210 (if (c-safe (goto-char (c-up-list-forward (point))))
1212 ;; Didn't work, so it's eob then.
1213 (goto-char (point-max))
1217 ;; Check if the declaration contains a brace
1218 ;; block. If not, we try another one.
1221 (not (c-syntactic-re-search-forward "{" pos t t))))))
1224 ;; Try to be line oriented; position point after the next
1225 ;; newline that isn't inside a comment, but if we hit the
1226 ;; next declaration then we use the current point instead.
1227 (while (and (not (bolp))
1228 (not (looking-at "\\s *$"))
1229 (c-forward-single-comment)))
1231 ((looking-at "\\s *$")
1236 (setq arg (1- arg)))))
1237 (c-keep-region-active)
1240 (defun c-declaration-limits (near)
1241 ;; Return a cons of the beginning and end positions of the current
1242 ;; top level declaration or macro. If point is not inside any then
1243 ;; nil is returned, unless NEAR is non-nil in which case the closest
1244 ;; following one is chosen instead (if there is any). The end
1245 ;; position is at the next line, providing there is one before the
1249 ;; Note: Some code duplication in `c-beginning-of-defun' and
1250 ;; `c-end-of-defun'.
1252 (let ((start (point))
1253 (paren-state (c-parse-state))
1256 (goto-char (c-least-enclosing-brace paren-state))
1257 ;; If we moved to the outermost enclosing paren then we
1258 ;; can use c-safe-position to set the limit. Can't do
1259 ;; that otherwise since the earlier paren pair on
1260 ;; paren-state might very well be part of the
1261 ;; declaration we should go to.
1262 (setq lim (c-safe-position (point) paren-state))
1264 ;; At top level. Make sure we aren't inside a literal.
1265 (setq pos (c-literal-limits
1266 (c-safe-position (point) paren-state)))
1267 (if pos (goto-char (car pos))))
1269 (when (c-beginning-of-macro)
1278 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1280 ;; We moved back over the previous defun. Skip to the next
1281 ;; one. Not using c-forward-syntactic-ws here since we
1282 ;; should not skip a macro. We can also be directly after
1283 ;; the block in a `c-opt-block-decls-with-vars-key'
1284 ;; declaration, but then we won't move significantly far
1287 (c-forward-comments)
1289 (when (and near (c-beginning-of-macro))
1297 (if (eobp) (throw 'exit nil))
1299 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1300 ;; declaration that doesn't end there. We're searching back and
1301 ;; forth over the block here, which can be expensive.
1303 (if (and c-opt-block-decls-with-vars-key
1305 (c-backward-syntactic-ws)
1306 (eq (char-before) ?}))
1307 (eq (car (c-beginning-of-decl-1))
1311 (and (> (point) pos)
1312 (setq end-pos (point)))))
1316 (if (and (not near) (> (point) start))
1319 ;; Try to be line oriented; position the limits at the
1320 ;; closest preceding boi, and after the next newline, that
1321 ;; isn't inside a comment, but if we hit a neighboring
1322 ;; declaration then we instead use the exact declaration
1323 ;; limit in that direction.
1326 (while (and (/= (point) (c-point 'boi))
1327 (c-backward-single-comment)))
1328 (if (/= (point) (c-point 'boi))
1336 (while (and (not (bolp))
1337 (not (looking-at "\\s *$"))
1338 (c-forward-single-comment)))
1341 ((looking-at "\\s *$")
1348 (defun c-mark-function ()
1349 "Put mark at end of the current top-level declaration or macro, point at beginning.
1350 If point is not inside any then the closest following one is chosen.
1352 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1353 function does not require the declaration to contain a brace block."
1357 (c-save-buffer-state nil
1358 ;; We try to be line oriented, unless there are several
1359 ;; declarations on the same line.
1360 (if (looking-at c-syntactic-eol)
1361 (c-backward-token-2 1 nil (c-point 'bol)))
1362 (setq decl-limits (c-declaration-limits t)))
1364 (if (not decl-limits)
1365 (error "Cannot find any declaration")
1366 (goto-char (car decl-limits))
1367 (push-mark (cdr decl-limits) nil t))))
1370 (defun c-beginning-of-statement (&optional count lim sentence-flag)
1371 "Go to the beginning of the innermost C statement.
1372 With prefix arg, go back N - 1 statements. If already at the
1373 beginning of a statement then go to the beginning of the closest
1374 preceding one, moving into nested blocks if necessary (use
1375 \\[backward-sexp] to skip over a block). If within or next to a
1376 comment or multiline string, move by sentences instead of statements.
1378 When called from a program, this function takes 3 optional args: the
1379 repetition count, a buffer position limit which is the farthest back
1380 to search for the syntactic context, and a flag saying whether to do
1381 sentence motion in or near comments and multiline strings.
1383 Note that `c-beginning-of-statement-1' is usually better to use from
1384 programs. It has much more well defined semantics than this one,
1385 which is intended for interactive use and might therefore change to be
1387 (interactive (list (prefix-numeric-value current-prefix-arg)
1389 (c-save-buffer-state
1390 ((count (or count 1))
1392 (range (c-collect-line-comments (c-literal-limits lim))))
1393 (while (and (/= count 0)
1394 (or (not lim) (> (point) lim)))
1396 (if (and (not range) sentence-flag)
1398 ;; Find the comment next to point if we're not in one.
1400 (if (c-backward-single-comment)
1401 (setq range (cons (point)
1402 (progn (c-forward-single-comment)
1404 (c-skip-ws-backward)
1405 (setq range (point))
1407 (if (eq (char-before) ?\")
1408 (c-safe (c-backward-sexp 1)
1409 (cons (point) range)))))
1411 (if (eq (char-after) ?\")
1412 (setq range (cons (point)
1416 (setq range (point))
1417 (setq range (if (c-forward-single-comment)
1418 (cons range (point))
1420 (setq range (c-collect-line-comments range))))
1421 (if (and (< count 0) (= here (point-max)))
1422 ;; Special case because eob might be in a literal.
1425 (if (and sentence-flag
1426 (or (/= (char-syntax (char-after (car range))) ?\")
1427 ;; Only visit a string if it spans more than one line.
1429 (goto-char (car range))
1430 (skip-chars-forward "^\n" (cdr range))
1431 (< (point) (cdr range)))))
1432 (let* ((lit-type (c-literal-type range))
1433 (line-prefix (concat "[ \t]*\\("
1434 c-current-comment-prefix
1436 (beg (if (eq lit-type 'string)
1439 (goto-char (car range))
1441 (looking-at comment-start-skip)
1444 (looking-at line-prefix)
1446 (end (- (cdr range) (if (eq lit-type 'c) 2 1)))
1447 (beg-of-para (if (eq lit-type 'string)
1451 (if (looking-at line-prefix)
1452 (goto-char (match-end 0)))))))
1454 ;; Move by sentence, but not past the limit of the
1455 ;; literal, narrowed to the appropriate
1457 (narrow-to-region (save-excursion
1458 (let ((pos (min here end)))
1460 (forward-paragraph -1)
1461 (if (looking-at paragraph-separate)
1463 (when (> (point) beg)
1464 (funcall beg-of-para)
1465 (when (>= (point) pos)
1466 (forward-paragraph -2)
1467 (funcall beg-of-para)))
1470 (c-safe (forward-sentence (if (< count 0) 1 -1)))
1471 (if (and (memq lit-type '(c c++))
1472 ;; Check if we stopped due to a comment
1473 ;; prefix and not a sentence end.
1474 (/= (point) (point-min))
1475 (/= (point) (point-max))
1478 (looking-at line-prefix))
1479 (>= (point) (match-beginning 0))
1480 (/= (match-beginning 1) (match-end 1))
1481 (or (< (point) (match-end 0))
1483 (= (point) (match-end 0))
1484 ;; The comment prefix may contain
1485 ;; characters that is regarded as end
1490 (forward-paragraph -1)
1491 (< (point) (match-beginning 0)))
1494 (or (not (re-search-backward
1499 (c-point 'eol)))))))))
1500 (setq count (+ count (if (< count 0) -1 1)))
1503 ;; In block comments, if there's only
1504 ;; horizontal ws between the text and the
1505 ;; comment ender, stop before it. Stop after
1506 ;; the ender if there's either nothing or
1507 ;; newlines between.
1508 (when (and (eq lit-type 'c)
1509 (eq (point) (point-max)))
1511 (when (or (= (skip-chars-backward " \t") 0)
1512 (eq (point) (point-max))
1514 (goto-char (cdr range)))))
1515 (when (and (eq (point) (point-min))
1516 (looking-at "[ \t]*\\\\?$"))
1517 ;; Stop before instead of after the comment
1518 ;; starter if nothing follows it.
1520 (goto-char (car range))
1521 (if (and (eq lit-type 'string) (/= (point) here))
1522 (setq count (1+ count)
1524 ;; See if we should escape the literal.
1526 (if (< (point) here)
1527 (setq count (1- count))
1528 (goto-char (car range))
1530 (if (> (point) here)
1531 (setq count (1+ count))
1532 (goto-char (cdr range))
1534 (goto-char (if (> count 0) (car range) (cdr range)))
1539 ;; Stop before `{' and after `;', `{', `}' and `};'
1540 ;; when not followed by `}' or `)', but on the other
1541 ;; side of the syntactic ws. Move by sexps and move
1542 ;; into parens. Also stop before `#' when it's at boi
1544 (let ((literal-pos (not sentence-flag))
1545 last last-below-line)
1549 (when (and (or (eq (char-after) ?\{)
1550 (and (eq (char-after) ?#)
1551 (eq (point) (c-point 'boi)))
1554 (unless (and c-special-brace-lists
1555 (eq (char-after) ?{)
1556 (c-looking-at-special-brace-list))
1557 (if (and (eq (char-after) ?#)
1558 (numberp last-below-line)
1559 (not (eq last-below-line here)))
1560 (goto-char last-below-line))
1562 ;; Don't know why I added the following, but it
1563 ;; doesn't work when point is preceded by a line
1564 ;; style comment. /mast
1565 ;;(c-skip-ws-backward)
1567 (c-backward-comments)
1568 (when (c-backward-single-comment)
1569 ;; Record position of first comment.
1571 (c-forward-single-comment)
1572 (setq literal-pos (point)))
1573 (c-backward-comments)))
1574 (unless last-below-line
1576 (re-search-forward "\\(^\\|[^\\]\\)$" last t))
1577 (setq last-below-line last)))
1578 (cond ((bobp) ; Must handle bob specially.
1583 ((progn (backward-char)
1584 (looking-at "[;{}]"))
1585 (if (and c-special-brace-lists
1586 (eq (char-after) ?{)
1587 (c-looking-at-special-brace-list))
1588 (skip-syntax-backward "w_") ; Speedup only.
1589 (if (or (= here last)
1590 (memq (char-after last) '(?\) ?})))
1591 (if (and (eq (char-before) ?})
1592 (eq (char-after) ?\;))
1596 ((= (char-syntax (char-after)) ?\")
1597 (let ((end (point)))
1601 (skip-chars-forward "^\n" end)
1602 (when (< (point) end)
1603 ;; Break at multiline string.
1604 (setq literal-pos (1+ end))
1606 (t (skip-syntax-backward "w_")) ; Speedup only.
1608 (if (and (numberp literal-pos)
1609 (< (point) literal-pos))
1610 ;; We jumped over a comment or string that
1611 ;; should be investigated.
1612 (goto-char literal-pos)
1613 (setq count (1- count))))
1615 (goto-char (point-min))
1618 ;; Stop before `{', `}', and `#' when it's at boi on a
1619 ;; line, but on the other side of the syntactic ws, and
1620 ;; after `;', `}' and `};'. Only stop before `{' if at
1621 ;; top level or inside braces, though. Move by sexps
1622 ;; and move into parens. Also stop at eol of lines
1623 ;; with `#' at the boi.
1624 (let ((literal-pos (not sentence-flag))
1630 (c-forward-comments)
1633 ;; Record position of first comment.
1634 (setq literal-pos (point))
1635 (c-forward-single-comment))
1636 (c-forward-comments)
1637 (setq literal-pos nil)))
1638 (cond ((and (eq (char-after) ?{)
1639 (not (and c-special-brace-lists
1640 (c-looking-at-special-brace-list)))
1643 (or (not (c-safe (up-list -1) t))
1644 (= (char-after) ?{))))
1647 ((and c-special-brace-lists
1648 (eq (char-after) ?})
1650 (and (c-safe (up-list -1) t)
1651 (c-looking-at-special-brace-list))))
1653 (skip-syntax-forward "w_")) ; Speedup only.
1654 ((and (eq (char-after) ?})
1658 ; ((and (eq (char-after) ?#)
1659 ; (= (point) (c-point 'boi)))
1661 ; (or (re-search-forward "\\(^\\|[^\\]\\)$" nil t)
1662 ; (goto-char (point-max)))
1665 ((looking-at ";\\|};?")
1666 (goto-char (match-end 0))
1668 ((= (char-syntax (char-after)) ?\")
1669 (let ((beg (point)))
1672 (skip-chars-backward "^\n" beg)
1673 (when (> (point) beg)
1674 ;; Break at multiline string.
1675 (setq literal-pos beg)
1679 (skip-syntax-forward "w_")) ; Speedup only.
1681 (if (and (numberp literal-pos)
1682 (> (point) literal-pos))
1683 ;; We jumped over a comment that should be investigated.
1684 (goto-char literal-pos)
1685 (setq count (1+ count))))
1687 (goto-char (point-max))
1690 ;; If we haven't moved we're near a buffer limit.
1691 (when (and (not (zerop count)) (= (point) here))
1692 (goto-char (if (> count 0) (point-min) (point-max)))
1694 (c-keep-region-active))
1696 (defun c-end-of-statement (&optional count lim sentence-flag)
1697 "Go to the end of the innermost C statement.
1698 With prefix arg, go forward N - 1 statements. Move forward to the end
1699 of the next statement if already at end, and move into nested blocks
1700 \(use \\[forward-sexp] to skip over a block). If within or next to a
1701 comment or multiline string, move by sentences instead of statements.
1703 When called from a program, this function takes 3 optional args: the
1704 repetition count, a buffer position limit which is the farthest back
1705 to search for the syntactic context, and a flag saying whether to do
1706 sentence motion in or near comments and multiline strings."
1707 (interactive (list (prefix-numeric-value current-prefix-arg)
1709 (c-beginning-of-statement (- (or count 1)) lim sentence-flag)
1710 (c-keep-region-active))
1713 ;; set up electric character functions to work with pending-del,
1714 ;; (a.k.a. delsel) mode. All symbols get the t value except
1715 ;; the functions which delete, which gets 'supersede.
1719 (put sym 'delete-selection t) ; for delsel (Emacs)
1720 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
1725 c-electric-semi&comma
1729 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
1730 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
1731 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
1732 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
1733 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
1734 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
1737 (defun c-calc-comment-indent (entry)
1739 (setq entry (or (assq entry c-indent-comment-alist)
1740 (assq 'other c-indent-comment-alist)
1741 '(default . (column . nil)))))
1742 (let ((action (car (cdr entry)))
1743 (value (cdr (cdr entry)))
1744 (col (current-column)))
1745 (cond ((eq action 'space)
1747 ((eq action 'column)
1748 (unless value (setq value comment-column))
1750 ;; Do not pad with one space if we're at bol.
1752 (max (1+ col) value)))
1758 (let ((lim (c-literal-limits (c-point 'bol) t)))
1760 (goto-char (car lim))
1761 (when (looking-at "/[/*]")
1762 ;; Found comment to align with.
1764 ;; Do not pad with one space if we're at bol.
1766 (max (1+ col) (current-column))))))))
1767 ;; Recurse to handle value as a new spec.
1768 (c-calc-comment-indent (cdr entry)))))))
1770 (defun c-comment-indent ()
1771 "Used by `indent-for-comment' to create and indent comments.
1772 See `c-indent-comment-alist' for a description."
1775 (c-save-buffer-state
1776 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
1777 (or (when (consp lim)
1778 (goto-char (car lim))
1779 (when (looking-at "/[/*]")
1780 (skip-chars-backward " \t")
1783 (skip-chars-backward " \t")
1786 (cond ((looking-at "^/[/*]")
1788 ((progn (beginning-of-line)
1791 ((progn (back-to-indentation)
1792 (and (eq (char-after) ?})
1793 (eq (point) (1- eot))))
1795 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
1796 (eq (match-end 0) eot))
1800 (if (and (memq line-type '(anchored-comment empty-line))
1801 c-indent-comments-syntactically-p)
1802 (let ((c-syntactic-context (c-guess-basic-syntax)))
1803 ;; BOGOSITY ALERT: if we're looking at the eol, its
1804 ;; because indent-for-comment hasn't put the comment-start
1805 ;; in the buffer yet. this will screw up the syntactic
1806 ;; analysis so we kludge in the necessary info. Another
1807 ;; kludge is that if we're at the bol, then we really want
1808 ;; to ignore any anchoring as specified by
1809 ;; c-comment-only-line-offset since it doesn't apply here.
1811 (c-add-syntax 'comment-intro))
1812 (let ((c-comment-only-line-offset
1813 (if (consp c-comment-only-line-offset)
1814 c-comment-only-line-offset
1815 (cons c-comment-only-line-offset
1816 c-comment-only-line-offset))))
1817 (c-get-syntactic-indentation c-syntactic-context)))
1819 (c-calc-comment-indent line-type)))))
1822 ;; used by outline-minor-mode
1823 (defun c-outline-level ()
1824 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
1825 ;; in otherwise-hidden text.
1827 (skip-chars-forward "\t ")
1831 (defun c-up-conditional (count)
1832 "Move back to the containing preprocessor conditional, leaving mark behind.
1833 A prefix argument acts as a repeat count. With a negative argument,
1834 move forward to the end of the containing preprocessor conditional.
1836 `#elif' is treated like `#else' followed by `#if', so the function
1837 stops at them when going backward, but not when going forward."
1839 (c-forward-conditional (- count) -1)
1840 (c-keep-region-active))
1842 (defun c-up-conditional-with-else (count)
1843 "Move back to the containing preprocessor conditional, including `#else'.
1844 Just like `c-up-conditional', except it also stops at `#else'
1847 (c-forward-conditional (- count) -1 t)
1848 (c-keep-region-active))
1850 (defun c-down-conditional (count)
1851 "Move forward into the next preprocessor conditional, leaving mark behind.
1852 A prefix argument acts as a repeat count. With a negative argument,
1853 move backward into the previous preprocessor conditional.
1855 `#elif' is treated like `#else' followed by `#if', so the function
1856 stops at them when going forward, but not when going backward."
1858 (c-forward-conditional count 1)
1859 (c-keep-region-active))
1861 (defun c-down-conditional-with-else (count)
1862 "Move forward into the next preprocessor conditional, including `#else'.
1863 Just like `c-down-conditional', except it also stops at `#else'
1866 (c-forward-conditional count 1 t)
1867 (c-keep-region-active))
1869 (defun c-backward-conditional (count &optional target-depth with-else)
1870 "Move back across a preprocessor conditional, leaving mark behind.
1871 A prefix argument acts as a repeat count. With a negative argument,
1872 move forward across a preprocessor conditional."
1874 (c-forward-conditional (- count) target-depth with-else)
1875 (c-keep-region-active))
1877 (defun c-forward-conditional (count &optional target-depth with-else)
1878 "Move forward across a preprocessor conditional, leaving mark behind.
1879 A prefix argument acts as a repeat count. With a negative argument,
1880 move backward across a preprocessor conditional.
1882 `#elif' is treated like `#else' followed by `#if', except that the
1883 nesting level isn't changed when tracking subconditionals.
1885 The optional argument TARGET-DEPTH specifies the wanted nesting depth
1886 after each scan. I.e. if TARGET-DEPTH is -1, the function will move
1887 out of the enclosing conditional. A non-integer non-nil TARGET-DEPTH
1890 If the optional argument WITH-ELSE is non-nil, `#else' directives are
1891 treated as conditional clause limits. Normally they are ignored."
1893 (let* ((forward (> count 0))
1894 (increment (if forward -1 1))
1895 (search-function (if forward 're-search-forward 're-search-backward))
1897 (unless (integerp target-depth)
1898 (setq target-depth (if target-depth -1 0)))
1902 ;; subdepth is the depth in "uninteresting" subtrees,
1903 ;; i.e. those that takes us farther from the target
1904 ;; depth instead of closer.
1908 ;; Find the "next" significant line in the proper direction.
1909 (while (and (not found)
1910 ;; Rather than searching for a # sign that
1911 ;; comes at the beginning of a line aside from
1912 ;; whitespace, search first for a string
1913 ;; starting with # sign. Then verify what
1914 ;; precedes it. This is faster on account of
1915 ;; the fastmap feature of the regexp matcher.
1916 (funcall search-function
1917 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
1920 ;; Now verify it is really a preproc line.
1921 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
1922 (let (dchange (directive (match-string 1)))
1923 (cond ((string= directive "if")
1924 (setq dchange (- increment)))
1925 ((string= directive "endif")
1926 (setq dchange increment))
1928 ;; When we're not in an "uninteresting"
1929 ;; subtree, we might want to act on "elif"
1931 (if (cond (with-else
1932 ;; Always move toward the target depth.
1934 (if (> target-depth 0) 1 -1)))
1935 ((string= directive "elif")
1936 (setq dchange (- increment))))
1937 ;; Ignore the change if it'd take us
1938 ;; into an "uninteresting" subtree.
1939 (if (eq (> dchange 0) (<= target-depth 0))
1940 (setq dchange nil)))))
1942 (when (or (/= subdepth 0)
1943 (eq (> dchange 0) (<= target-depth 0)))
1944 (setq subdepth (+ subdepth dchange)))
1945 (setq depth (+ depth dchange))
1946 ;; If we are trying to move across, and we find an
1947 ;; end before we find a beginning, get an error.
1948 (if (and (< depth target-depth) (< dchange 0))
1950 "No following conditional at this level"
1951 "No previous conditional at this level"))))
1952 ;; When searching forward, start from next line so
1953 ;; that we don't find the same line again.
1954 (if forward (forward-line 1))
1955 ;; We found something if we've arrived at the
1957 (if (and dchange (= depth target-depth))
1958 (setq found (point))))
1960 (if forward (forward-line 1)))))
1962 (error "No containing preprocessor conditional"))
1963 (goto-char (setq new found)))
1964 (setq count (+ count increment))))
1967 (c-keep-region-active))
1970 ;; commands to indent lines, regions, defuns, and expressions
1971 (defun c-indent-command (&optional arg)
1972 "Indent current line as C code, and/or insert some whitespace.
1974 If `c-tab-always-indent' is t, always just indent the current line.
1975 If nil, indent the current line only if point is at the left margin or
1976 in the line's indentation; otherwise insert some whitespace[*]. If
1977 other than nil or t, then some whitespace[*] is inserted only within
1978 literals (comments and strings), but the line is always reindented.
1980 If `c-syntactic-indentation' is t, indentation is done according to
1981 the syntactic context. A numeric argument, regardless of its value,
1982 means indent rigidly all the lines of the expression starting after
1983 point so that this line becomes properly indented. The relative
1984 indentation among the lines of the expression is preserved.
1986 If `c-syntactic-indentation' is nil, the line is just indented one
1987 step according to `c-basic-offset'. In this mode, a numeric argument
1988 indents a number of such steps, positive or negative, and an empty
1989 prefix argument is equivalent to -1.
1991 [*] The amount and kind of whitespace inserted is controlled by the
1992 variable `c-insert-tab-function', which is called to do the actual
1993 insertion of whitespace. Normally the function in this variable
1994 just inserts a tab character, or the equivalent number of spaces,
1995 depending on the variable `indent-tabs-mode'."
1998 (let ((indent-function
1999 (if c-syntactic-indentation
2000 (symbol-function 'indent-according-to-mode)
2002 (let ((c-macro-start c-macro-start)
2003 (steps (cond ((not current-prefix-arg) 1)
2004 ((equal current-prefix-arg '(4)) -1)
2006 (c-shift-line-indentation (* steps c-basic-offset))
2007 (when (and c-auto-align-backslashes
2010 (eq (char-before) ?\\))
2011 (c-query-and-set-macro-start))
2012 ;; Realign the line continuation backslash if inside a macro.
2013 (c-backslash-region (point) (point) nil t)))
2015 (if (and c-syntactic-indentation current-prefix-arg)
2016 ;; If c-syntactic-indentation and got arg, always indent this
2017 ;; line as C and shift remaining lines of expression the same
2019 (let ((shift-amt (save-excursion
2020 (back-to-indentation)
2024 (setq shift-amt (- (save-excursion
2025 (back-to-indentation)
2029 (if (eq c-tab-always-indent t)
2030 (beginning-of-line))
2038 (indent-code-rigidly beg end shift-amt "#")))
2039 ;; Else use c-tab-always-indent to determine behavior.
2041 ;; CASE 1: indent when at column zero or in lines indentation,
2042 ;; otherwise insert a tab
2043 ((not c-tab-always-indent)
2045 (skip-chars-backward " \t")
2047 (funcall c-insert-tab-function)
2048 (funcall indent-function)))
2049 ;; CASE 2: just indent the line
2050 ((eq c-tab-always-indent t)
2051 (funcall indent-function))
2052 ;; CASE 3: if in a literal, insert a tab, but always indent the
2056 (funcall c-insert-tab-function))
2057 (funcall indent-function)
2060 (defun c-indent-exp (&optional shutup-p)
2061 "Indent each line in the balanced expression following point syntactically.
2062 If optional SHUTUP-P is non-nil, no errors are signalled if no
2063 balanced expression is found."
2065 (let ((here (point-marker))
2067 (set-marker-insertion-type here t)
2069 (let ((start (save-restriction
2070 ;; Find the closest following open paren that
2071 ;; ends on another line.
2072 (narrow-to-region (point-min) (c-point 'eol))
2073 (let (beg (end (point)))
2074 (while (and (setq beg (c-down-list-forward end))
2075 (setq end (c-up-list-forward beg))))
2077 (eq (char-syntax (char-before beg)) ?\()
2082 (error "Cannot find start of balanced expression to indent"))
2084 (setq end (c-safe (scan-sexps (point) 1)))
2087 (error "Cannot find end of balanced expression to indent"))
2090 (c-indent-region (point) end)))))
2092 (set-marker here nil))))
2094 (defun c-indent-defun ()
2095 "Indent the current top-level declaration or macro syntactically.
2096 In the macro case this also has the effect of realigning any line
2097 continuation backslashes, unless `c-auto-align-backslashes' is nil."
2099 (let ((here (point-marker)) decl-limits)
2102 (c-save-buffer-state nil
2103 ;; We try to be line oriented, unless there are several
2104 ;; declarations on the same line.
2105 (if (looking-at c-syntactic-eol)
2106 (c-backward-token-2 1 nil (c-point 'bol))
2107 (c-forward-token-2 0 nil (c-point 'eol)))
2108 (setq decl-limits (c-declaration-limits nil)))
2110 (c-indent-region (car decl-limits)
2111 (cdr decl-limits))))
2113 (set-marker here nil))))
2115 (defun c-indent-region (start end &optional quiet)
2116 "Indent syntactically every line whose first char is between START
2117 and END inclusive. If the optional argument QUIET is non-nil then no
2118 syntactic errors are reported, even if `c-report-syntactic-errors' is
2122 (skip-chars-backward " \t\n\r\f\v")
2125 ;; Advance to first nonblank line.
2127 (skip-chars-forward " \t\n\r\f\v")
2128 (setq start (point))
2130 (setq c-parsing-error
2131 (or (let ((endmark (copy-marker end))
2132 (c-parsing-error nil)
2133 ;; shut up any echo msgs on indiv lines
2134 (c-echo-syntactic-information-p nil)
2135 (in-macro (and c-auto-align-backslashes
2136 (save-excursion (c-beginning-of-macro))
2138 (c-fix-backslashes nil)
2142 (c-progress-init start end 'c-indent-region)
2145 (< (point) endmark))
2149 (skip-chars-forward " \t\n")
2151 ;; Get syntax and indent.
2152 (c-save-buffer-state nil
2153 (setq syntax (c-guess-basic-syntax)))
2154 (if (and c-auto-align-backslashes
2155 (assq 'cpp-macro syntax))
2156 ;; Record macro start.
2157 (setq in-macro (point)))
2159 (if (looking-at "\\s *\\\\$")
2161 (c-indent-line syntax t t)
2162 (if (progn (end-of-line)
2163 (not (eq (char-before) ?\\)))
2165 ;; Fixup macro backslashes.
2167 (c-backslash-region in-macro (point) nil)
2168 (setq in-macro nil))
2170 (c-indent-line syntax t t)
2173 (c-backslash-region in-macro (c-point 'bopl) nil t)))
2174 (set-marker endmark nil)
2175 (c-progress-fini 'c-indent-region))
2176 (c-echo-parsing-error quiet))
2179 (defun c-fn-region-is-active-p ()
2180 ;; Function version of the macro for use in places that aren't
2181 ;; compiled, e.g. in the menus.
2183 ;; This function does not do any hidden buffer changes.
2184 (c-region-is-active-p))
2186 (defun c-indent-line-or-region ()
2187 "When the region is active, indent it syntactically. Otherwise
2188 indent the current line syntactically."
2189 ;; Emacs has a variable called mark-active, XEmacs uses region-active-p
2191 (if (c-region-is-active-p)
2192 (c-indent-region (region-beginning) (region-end))
2196 ;; for progress reporting
2197 (defvar c-progress-info nil)
2199 (defun c-progress-init (start end context)
2200 ;; This function does not do any hidden buffer changes.
2203 ((not c-progress-interval))
2204 ;; Start the progress update messages. If this Emacs doesn't have
2205 ;; a built-in timer, just be dumb about it.
2206 ((not (fboundp 'current-time))
2207 (message "Indenting region... (this may take a while)"))
2208 ;; If progress has already been initialized, do nothing. otherwise
2209 ;; initialize the counter with a vector of:
2210 ;; [start end lastsec context]
2212 (t (setq c-progress-info (vector start
2216 (nth 1 (current-time))
2218 (message "Indenting region..."))
2221 (defun c-progress-update ()
2222 ;; This function does not do any hidden buffer changes.
2223 (if (not (and c-progress-info c-progress-interval))
2225 (let ((now (nth 1 (current-time)))
2226 (start (aref c-progress-info 0))
2227 (end (aref c-progress-info 1))
2228 (lastsecs (aref c-progress-info 2)))
2229 ;; should we update? currently, update happens every 2 seconds,
2230 ;; what's the right value?
2231 (if (< c-progress-interval (- now lastsecs))
2233 (message "Indenting region... (%d%% complete)"
2234 (/ (* 100 (- (point) start)) (- end start)))
2235 (aset c-progress-info 2 now)))
2238 (defun c-progress-fini (context)
2239 ;; This function does not do any hidden buffer changes.
2240 (if (not c-progress-interval)
2242 (if (or (eq context (aref c-progress-info 3))
2245 (set-marker (aref c-progress-info 1) nil)
2246 (setq c-progress-info nil)
2247 (message "Indenting region... done")))))
2251 ;;; This page handles insertion and removal of backslashes for C macros.
2253 (defun c-backslash-region (from to delete-flag &optional line-mode)
2254 "Insert, align, or delete end-of-line backslashes on the lines in the region.
2255 With no argument, inserts backslashes and aligns existing backslashes.
2256 With an argument, deletes the backslashes. The backslash alignment is
2257 done according to the settings in `c-backslash-column',
2258 `c-backslash-max-column' and `c-auto-align-backslashes'.
2260 This function does not modify blank lines at the start of the region.
2261 If the region ends at the start of a line and the macro doesn't
2262 continue below it, the backslash (if any) at the end of the previous
2265 You can put the region around an entire macro definition and use this
2266 command to conveniently insert and align the necessary backslashes."
2267 (interactive "*r\nP")
2268 (let ((endmark (make-marker))
2269 ;; Keep the backslash trimming functions from changing the
2270 ;; whitespace around point, since in this case it's only the
2271 ;; position of point that tells the indentation of the line.
2272 (point-pos (if (save-excursion
2273 (skip-chars-backward " \t")
2274 (and (bolp) (looking-at "[ \t]*\\\\?$")))
2277 column longest-line-col bs-col-after-end)
2280 (if (and (not line-mode) (bobp))
2281 ;; Nothing to do if to is at bob, since we should back up
2282 ;; and there's no line to back up to.
2284 (when (and (not line-mode) (bolp))
2285 ;; Do not back up the to line if line-mode is set, to make
2286 ;; e.g. c-newline-and-indent consistent regardless whether
2287 ;; the (newline) call leaves point at bol or not.
2292 (set-marker endmark (point))
2294 (c-delete-backslashes-forward endmark point-pos))
2295 ;; Set bs-col-after-end to the column of any backslash
2296 ;; following the region, or nil if there is none.
2297 (setq bs-col-after-end
2298 (and (progn (end-of-line)
2299 (eq (char-before) ?\\))
2300 (= (forward-line 1) 0)
2301 (progn (end-of-line)
2302 (eq (char-before) ?\\))
2303 (1- (current-column))))
2305 ;; Back up the to line if line-mode is set, since the line
2306 ;; after the newly inserted line break should not be
2307 ;; touched in c-newline-and-indent.
2308 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
2309 (unless bs-col-after-end
2310 ;; Set bs-col-after-end to non-nil in any case, since we
2311 ;; do not want to delete the backslash at the last line.
2312 (setq bs-col-after-end t)))
2314 (not c-auto-align-backslashes))
2316 ;; Compute the smallest column number past the ends of all
2318 (setq longest-line-col 0)
2320 (if bs-col-after-end
2321 ;; Include one more line in the max column
2322 ;; calculation, since the to line will be backslashed
2326 (while (and (>= (point) from)
2328 (if (eq (char-before) ?\\)
2330 (skip-chars-backward " \t")
2331 (setq longest-line-col (max longest-line-col
2332 (1+ (current-column))))
2336 ;; Try to align with surrounding backslashes.
2339 (if (and (not (bobp))
2340 (progn (backward-char)
2341 (eq (char-before) ?\\)))
2343 (setq column (1- (current-column)))
2344 (if (numberp bs-col-after-end)
2345 ;; Both a preceding and a following backslash.
2346 ;; Choose the greatest of them.
2347 (setq column (max column bs-col-after-end)))
2349 ;; No preceding backslash. Try to align with one
2350 ;; following the region. Disregard the backslash at the
2351 ;; to line since it's likely to be bogus (e.g. when
2352 ;; called from c-newline-and-indent).
2353 (if (numberp bs-col-after-end)
2354 (setq column bs-col-after-end))
2355 ;; Don't modify blank lines at start of region.
2357 (while (and (< (point) to) (bolp) (eolp))
2359 (if (and column (< column longest-line-col))
2360 ;; Don't try to align with surrounding backslashes if
2361 ;; any line is too long.
2364 ;; Impose minimum limit and tab width alignment only if
2365 ;; we can't align with surrounding backslashes.
2366 (if (> (% longest-line-col tab-width) 0)
2367 (setq longest-line-col
2368 (* (/ (+ longest-line-col tab-width -1)
2371 (setq column (max c-backslash-column
2373 ;; Always impose maximum limit.
2374 (setq column (min column c-backslash-max-column)))
2375 (if bs-col-after-end
2376 ;; Add backslashes on all lines if the macro continues
2377 ;; after the to line.
2379 (set-marker endmark to)
2380 (c-append-backslashes-forward endmark column point-pos))
2381 ;; Add backslashes on all lines except the last, and
2382 ;; remove any on the last line.
2387 (set-marker endmark (1- (point)))))
2389 (c-append-backslashes-forward endmark column point-pos)
2390 ;; The function above leaves point on the line
2391 ;; following endmark.
2392 (set-marker endmark (point)))
2393 (set-marker endmark to))
2394 (c-delete-backslashes-forward endmark point-pos)))))
2395 (set-marker endmark nil)
2396 (if (markerp point-pos)
2397 (set-marker point-pos nil))))
2399 (defun c-append-backslashes-forward (to-mark column point-pos)
2400 ;; This function does not do any hidden buffer changes.
2401 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
2405 (<= (point) to-mark)
2407 (let ((start (point)) (inserted nil) end col)
2409 (unless (eq (char-before) ?\\)
2412 (setq state (parse-partial-sexp
2413 start (point) nil nil state))
2415 (setq col (current-column))
2417 ;; Avoid unnecessary changes of the buffer.
2418 (cond ((and (not inserted) (nth 3 state))
2419 ;; Don't realign backslashes in string literals
2420 ;; since that would change them.
2427 (skip-chars-backward
2428 " \t" (if (>= (point) point-pos) point-pos))
2432 ((and (= col column)
2433 (memq (char-before) '(?\ ?\t))))
2437 (or (/= (skip-chars-backward
2438 " \t" (if (>= (point) point-pos) point-pos))
2440 (/= (char-after) ?\ )))
2441 (delete-region (point) end)
2442 (indent-to column 1)))
2444 (zerop (forward-line 1)))
2445 (bolp))) ; forward-line has funny behavior at eob.
2447 ;; Make sure there are backslashes with at least one space in
2451 (<= (point) to-mark)
2453 (let ((start (point)))
2455 (setq state (parse-partial-sexp
2456 start (point) nil nil state))
2458 (if (eq (char-before) ?\\)
2459 (unless (nth 3 state)
2461 (unless (and (memq (char-before) '(?\ ?\t))
2462 (/= (point) point-pos))
2465 (if (and (memq (char-before) '(?\ ?\t))
2466 (/= (point) point-pos))
2470 (zerop (forward-line 1)))
2471 (bolp)))))) ; forward-line has funny behavior at eob.
2473 (defun c-delete-backslashes-forward (to-mark point-pos)
2474 ;; This function does not do any hidden buffer changes.
2476 (and (<= (point) to-mark)
2479 (if (eq (char-before) ?\\)
2482 (progn (backward-char)
2483 (skip-chars-backward " \t" (if (>= (point) point-pos)
2486 (zerop (forward-line 1)))
2487 (bolp)))) ; forward-line has funny behavior at eob.
2491 ;;; Line breaking and paragraph filling.
2493 (defvar c-auto-fill-prefix t)
2494 (defvar c-lit-limits nil)
2495 (defvar c-lit-type nil)
2497 ;; The filling code is based on a simple theory; leave the intricacies
2498 ;; of the text handling to the currently active mode for that
2499 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
2500 ;; possible to make them work correctly wrt the comment and string
2501 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
2502 ;; to it, there's quite a lot of special cases to handle which makes
2503 ;; the code anything but simple. The intention is that it will work
2504 ;; with any well-written text filling package that preserves a fill
2507 ;; We temporarily mask comment starters and enders as necessary for
2508 ;; the filling code to do its job on a seemingly normal text block.
2509 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
2510 ;; preserve it correctly (especially important when filling C++ style
2511 ;; line comments). By default, we set up and use adaptive-fill-mode,
2512 ;; which is standard in all supported Emacs flavors.
2514 (defun c-guess-fill-prefix (lit-limits lit-type)
2515 ;; Determine the appropriate comment fill prefix for a block or line
2516 ;; comment. Return a cons of the prefix string and the column where
2517 ;; it ends. If fill-prefix is set, it'll override. Note that this
2518 ;; function also uses the value of point in some heuristics.
2520 (let* ((here (point))
2521 (prefix-regexp (concat "[ \t]*\\("
2522 c-current-comment-prefix
2524 (comment-start-regexp (if (eq lit-type 'c++)
2526 comment-start-skip))
2527 prefix-line comment-prefix res comment-text-end)
2531 (setq res (cons fill-prefix
2532 ;; Ugly way of getting the column after the fill
2533 ;; prefix; it'd be nice with a current-column
2534 ;; that works on strings..
2535 (let ((start (point)))
2538 (insert-and-inherit "\n" fill-prefix)
2540 (delete-region start (point)))))))
2544 ;; Set fallback for comment-prefix if none is found.
2545 (setq comment-prefix "// "
2546 comment-text-end (cdr lit-limits))
2549 (if (> (point) (car lit-limits))
2550 ;; The current line is not the comment starter, so the
2551 ;; comment has more than one line, and it can therefore be
2552 ;; used to find the comment fill prefix.
2553 (setq prefix-line (point))
2555 (goto-char (car lit-limits))
2556 (if (and (= (forward-line 1) 0)
2557 (< (point) (cdr lit-limits)))
2558 ;; The line after the comment starter is inside the
2559 ;; comment, so we can use it.
2560 (setq prefix-line (point))
2562 ;; The comment is only one line. Take the comment prefix
2563 ;; from it and keep the indentation.
2564 (goto-char (car lit-limits))
2565 (if (looking-at prefix-regexp)
2566 (goto-char (match-end 0))
2568 (skip-chars-forward " \t"))
2571 (if (eq (c-point 'boi) (car lit-limits))
2572 ;; There is only whitespace before the comment
2573 ;; starter; take the prefix straight from this line.
2574 (setq str (buffer-substring-no-properties
2575 (c-point 'bol) (point))
2576 col (current-column))
2578 ;; There is code before the comment starter, so we
2579 ;; have to temporarily insert and indent a new line to
2580 ;; get the right space/tab mix in the indentation.
2581 (let ((prefix-len (- (point) (car lit-limits)))
2585 (goto-char (car lit-limits))
2586 (indent-to (prog1 (current-column)
2589 (forward-char prefix-len)
2590 (setq str (buffer-substring-no-properties
2591 (c-point 'bol) (point))
2592 col (current-column)))
2593 (delete-region (car lit-limits) tmp))))
2596 (if (or (string-match "\\s \\'" str) (not (eolp)))
2598 ;; The prefix ends the line with no whitespace
2599 ;; after it. Default to a single space.
2600 (cons (concat str " ") (1+ col))))
2604 (setq comment-text-end
2606 (goto-char (- (cdr lit-limits) 2))
2607 (if (looking-at "\\*/") (point) (cdr lit-limits))))
2611 (if (and (> (point) (car lit-limits))
2612 (not (and (looking-at "[ \t]*\\*/")
2613 (eq (cdr lit-limits) (match-end 0)))))
2614 ;; The current line is not the comment starter and
2615 ;; contains more than just the ender, so it's good enough
2616 ;; to be used for the comment fill prefix.
2617 (setq prefix-line (point))
2618 (goto-char (car lit-limits))
2620 (cond ((or (/= (forward-line 1) 0)
2621 (>= (point) (cdr lit-limits))
2622 (and (looking-at "[ \t]*\\*/")
2623 (eq (cdr lit-limits) (match-end 0)))
2624 (and (looking-at prefix-regexp)
2625 (<= (1- (cdr lit-limits)) (match-end 0))))
2626 ;; The comment is either one line or the next line contains
2627 ;; just the comment ender. In this case we have no
2628 ;; information about a suitable comment prefix, so we resort
2629 ;; to c-block-comment-prefix.
2630 (setq comment-prefix (or c-block-comment-prefix "")))
2633 ;; The point was on the comment opener line, so we might want
2634 ;; to treat this as a not yet closed comment.
2636 (if (and (match-beginning 1)
2637 (/= (match-beginning 1) (match-end 1)))
2638 ;; Above `prefix-regexp' matched a nonempty prefix on the
2639 ;; second line, so let's use it. Normally it should do
2640 ;; to set `prefix-line' and let the code below pick up
2641 ;; the whole prefix, but if there's no text after the
2642 ;; match then it will probably fall back to no prefix at
2643 ;; all if the comment isn't closed yet, so in that case
2644 ;; it's better to force use of the prefix matched now.
2645 (if (= (match-end 0) (c-point 'eol))
2646 (setq comment-prefix (match-string 1))
2647 (setq prefix-line (point)))
2649 ;; There's no nonempty prefix on the line after the
2650 ;; comment opener. If the line is empty, or if the
2651 ;; text on it has less or equal indentation than the
2652 ;; comment starter we assume it's an unclosed
2653 ;; comment starter, i.e. that
2654 ;; `c-block-comment-prefix' should be used.
2655 ;; Otherwise we assume it's a closed comment where
2656 ;; the prefix really is the empty string.
2657 ;; E.g. this is an unclosed comment:
2668 ;; (Looking for the presence of the comment closer
2669 ;; rarely works since it's probably the closer of
2670 ;; some comment further down when the comment
2671 ;; really is unclosed.)
2672 (if (<= (save-excursion (back-to-indentation)
2674 (save-excursion (goto-char (car lit-limits))
2676 (setq comment-prefix (or c-block-comment-prefix ""))
2677 (setq prefix-line (point)))))
2680 ;; Otherwise the line after the comment starter is good
2681 ;; enough to find the prefix in.
2682 (setq prefix-line (point))))
2684 (when comment-prefix
2685 ;; Haven't got the comment prefix on any real line that we
2686 ;; can take it from, so we have to temporarily insert
2687 ;; `comment-prefix' on a line and indent it to find the
2688 ;; correct column and the correct mix of tabs and spaces.
2690 (let (tmp-pre tmp-post)
2694 (goto-char (car lit-limits))
2695 (if (looking-at comment-start-regexp)
2696 (goto-char (min (match-end 0)
2699 (skip-chars-forward " \t"))
2701 (when (eq (char-syntax (char-before)) ?\ )
2702 ;; If there's ws on the current line, we'll use it
2703 ;; instead of what's ending comment-prefix.
2704 (setq comment-prefix
2705 (concat (substring comment-prefix
2709 (buffer-substring-no-properties
2711 (skip-chars-backward " \t")
2715 (setq tmp-pre (point-marker))
2717 ;; We insert an extra non-whitespace character
2718 ;; before the line break and after comment-prefix in
2719 ;; case it's "" or ends with whitespace.
2720 (insert-and-inherit "x\n" comment-prefix "x")
2721 (setq tmp-post (point-marker))
2723 (indent-according-to-mode)
2725 (goto-char (1- tmp-post))
2726 (cons (buffer-substring-no-properties
2727 (c-point 'bol) (point))
2731 (delete-region tmp-pre tmp-post)
2732 (set-marker tmp-pre nil)
2733 (set-marker tmp-post nil))))))))))
2735 (or res ; Found a good prefix above.
2738 ;; prefix-line is the bol of a line on which we should try
2739 ;; to find the prefix.
2740 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
2743 (when (and (looking-at prefix-regexp)
2744 (<= (match-end 0) comment-text-end))
2745 (unless (eq (match-end 0) (c-point 'eol))
2746 ;; The match is fine if there's text after it.
2747 (throw 'found (cons (buffer-substring-no-properties
2748 (match-beginning 0) (match-end 0))
2749 (progn (goto-char (match-end 0))
2750 (current-column)))))
2752 ;; This match is better than nothing, so let's
2753 ;; remember it in case nothing better is found
2755 (setq fb-string (buffer-substring-no-properties
2756 (match-beginning 0) (match-end 0))
2757 fb-endpos (match-end 0)))
2761 ;; Search for a line which has text after the prefix
2762 ;; so that we get the proper amount of whitespace
2763 ;; after it. We start with the current line, then
2764 ;; search backwards, then forwards.
2766 (goto-char prefix-line)
2767 (when (and (funcall test-line)
2768 (or (/= (match-end 1) (match-end 0))
2769 ;; The whitespace is sucked up by the
2770 ;; first [ \t]* glob if the prefix is empty.
2771 (and (= (match-beginning 1) (match-end 1))
2772 (/= (match-beginning 0) (match-end 0)))))
2773 ;; If the current line doesn't have text but do
2774 ;; have whitespace after the prefix, we'll use it.
2775 (throw 'found (cons fb-string
2776 (progn (goto-char fb-endpos)
2777 (current-column)))))
2779 (if (eq lit-type 'c++)
2780 ;; For line comments we can search up to and
2781 ;; including the first line.
2782 (while (and (zerop (forward-line -1))
2783 (>= (point) (car lit-limits)))
2784 (funcall test-line))
2785 ;; For block comments we must stop before the
2787 (while (and (zerop (forward-line -1))
2788 (> (point) (car lit-limits)))
2789 (funcall test-line)))
2791 (goto-char prefix-line)
2792 (while (and (zerop (forward-line 1))
2793 (< (point) (cdr lit-limits)))
2794 (funcall test-line))
2796 (goto-char prefix-line)
2800 ;; A good line wasn't found, but at least we have a
2801 ;; fallback that matches the comment prefix regexp.
2802 (cond ((or (string-match "\\s \\'" fb-string)
2804 (goto-char fb-endpos)
2806 ;; There are ws or text after the prefix, so
2808 (cons fb-string (current-column)))
2811 ;; Check if there's any whitespace padding
2812 ;; on the comment start line that we can
2813 ;; use after the prefix.
2814 (goto-char (car lit-limits))
2815 (if (looking-at comment-start-regexp)
2816 (goto-char (match-end 0))
2818 (skip-chars-forward " \t"))
2820 (eq (char-syntax (char-before)) ?\ )))
2822 (setq fb-string (buffer-substring-no-properties
2824 (skip-chars-backward " \t")
2827 (goto-char fb-endpos)
2828 (skip-chars-backward " \t")
2830 (let ((tmp (point)))
2831 ;; Got to mess in the buffer once again to
2832 ;; ensure the column gets correct. :P
2835 (insert-and-inherit fb-string)
2836 (cons (buffer-substring-no-properties
2840 (delete-region tmp (point)))))
2843 ;; Last resort: Just add a single space after
2845 (cons (concat fb-string " ")
2846 (progn (goto-char fb-endpos)
2847 (1+ (current-column)))))))
2849 ;; The line doesn't match the comment prefix regexp.
2851 ;; We have a fallback for line comments that we must use.
2852 (cons (concat (buffer-substring-no-properties
2853 prefix-line (c-point 'boi))
2855 (progn (back-to-indentation)
2856 (+ (current-column) (length comment-prefix))))
2858 ;; Assume we are dealing with a "free text" block
2859 ;; comment where the lines doesn't have any comment
2860 ;; prefix at all and we should just fill it as
2865 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
2866 ;; Calls FUN with ARGS ar arguments while the current paragraph is
2867 ;; masked to allow adaptive filling to work correctly. That
2868 ;; includes narrowing the buffer and, if point is inside a comment,
2869 ;; masking the comment starter and ender appropriately.
2871 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
2872 ;; The position of point is then less significant when doing masking
2875 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
2876 ;; only if the point turns out to be inside a comment or a string.
2878 ;; This function does not do any hidden buffer changes.
2881 ;; beg and end limits the region to narrow. end is a marker.
2883 ;; tmp-pre and tmp-post mark strings that are temporarily
2884 ;; inserted at the start and end of the region. tmp-pre is a
2885 ;; cons of the positions of the prepended string. tmp-post is
2886 ;; a marker pointing to the single character of the appended
2889 ;; If hang-ender-stuck isn't nil, the comment ender is
2890 ;; hanging. In that case it's set to the number of spaces
2891 ;; that should be between the text and the ender.
2894 (c-lit-limits c-lit-limits)
2895 (c-lit-type c-lit-type))
2897 ;; Restore point on undo. It's necessary since we do a lot of
2898 ;; hidden inserts and deletes below that should be as transparent
2900 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
2901 (setq buffer-undo-list (cons (point) buffer-undo-list)))
2904 ;; Widen to catch comment limits correctly.
2906 (unless c-lit-limits
2907 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
2908 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
2910 (setq c-lit-type (c-literal-type c-lit-limits))))
2913 (unless (c-safe (backward-char)
2917 (forward-paragraph))
2918 (setq end (point-marker)))
2920 (unless (c-safe (forward-char)
2921 (backward-paragraph)
2924 (backward-paragraph))
2931 ((eq c-lit-type 'c++) ; Line comment.
2933 ;; Limit to the comment or paragraph end, whichever
2935 (set-marker end (min end (cdr c-lit-limits)))
2937 (when (<= beg (car c-lit-limits))
2938 ;; The region includes the comment starter, so we must
2940 (goto-char (car c-lit-limits))
2941 (back-to-indentation)
2942 (if (eq (point) (car c-lit-limits))
2943 ;; Include the first line in the region.
2944 (setq beg (c-point 'bol))
2945 ;; The first line contains code before the
2946 ;; comment. We must fake a line that doesn't.
2949 (setq apply-outside-literal t))
2951 ((eq c-lit-type 'c) ; Block comment.
2952 (when (>= end (cdr c-lit-limits))
2953 ;; The region includes the comment ender which we might
2954 ;; want to keep together with the last word.
2955 (unless (save-excursion
2956 (goto-char (cdr c-lit-limits))
2958 (and (looking-at (concat "[ \t]*\\("
2959 c-current-comment-prefix
2961 (eq (cdr c-lit-limits) (match-end 0))
2962 ;; The comment ender is on a line of its
2963 ;; own. Keep it that way.
2964 (set-marker end (point))))
2967 ;; The comment ender should hang. Replace all
2968 ;; cruft between it and the last word with one or
2969 ;; two 'x' and include it in the region. We'll
2970 ;; change them back to spaces afterwards. This
2971 ;; isn't done when auto filling, since that'd
2972 ;; effectively make it impossible to insert extra
2973 ;; spaces before the comment ender.
2974 (let* ((ender-start (save-excursion
2975 (goto-char (cdr c-lit-limits))
2976 (skip-syntax-backward "^w ")
2978 (point-rel (- ender-start here))
2982 (goto-char (cdr c-lit-limits))
2983 (setq tmp-post (point-marker))
2985 (set-marker end (point))
2987 (if (and (looking-at (concat "[ \t]*\\(\\("
2988 c-current-comment-prefix
2990 (eq ender-start (match-end 0)))
2991 ;; The comment ender is prefixed by nothing
2992 ;; but a comment line prefix. Remove it
2993 ;; along with surrounding ws.
2994 (setq spaces (- (match-end 1) (match-end 2)))
2995 (goto-char ender-start))
2996 (skip-chars-backward " \t\r\n")
2998 (if (/= (point) ender-start)
3000 (if (<= here (point))
3001 ;; Don't adjust point below if it's
3002 ;; before the string we replace.
3003 (setq point-rel -1))
3004 ;; Keep one or two spaces between the
3005 ;; text and the ender, depending on how
3006 ;; many there are now.
3008 (setq spaces (- ender-start (point))))
3012 (if sentence-end-double-space 2 1))
3014 ;; Insert the filler first to keep marks right.
3015 (insert-char ?x spaces t)
3016 (delete-region (point) (+ ender-start spaces))
3017 (setq hang-ender-stuck spaces)
3019 (and (>= point-rel 0)
3020 (- (point) (min point-rel spaces)))))
3021 (setq point-rel nil)))
3024 ;; Point was in the middle of the string we
3025 ;; replaced above, so put it back in the same
3026 ;; relative position, counting from the end.
3027 (goto-char point-rel)))
3029 ;; We're doing auto filling. Just move the marker
3030 ;; to the comment end to ignore any code after the
3032 (move-marker end (cdr c-lit-limits)))))
3034 (when (<= beg (car c-lit-limits))
3035 ;; The region includes the comment starter.
3037 (goto-char (car c-lit-limits))
3038 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
3039 ;; Begin with the next line.
3040 (setq beg (c-point 'bonl))
3041 ;; Fake the fill prefix in the first line.
3044 (setq apply-outside-literal t))
3046 ((eq c-lit-type 'string) ; String.
3048 (when (>= end (cdr c-lit-limits))
3049 (goto-char (1- (cdr c-lit-limits)))
3050 (setq tmp-post (point-marker))
3052 (set-marker end (point)))
3053 (when (<= beg (car c-lit-limits))
3054 (goto-char (1+ (car c-lit-limits)))
3055 (setq beg (if (looking-at "\\\\$")
3056 ;; Leave the start line if it's
3057 ;; nothing but an escaped newline.
3060 (setq apply-outside-literal t))
3062 ((eq c-lit-type 'pound) ; Macro
3063 ;; Narrow to the macro limits if they are nearer than the
3064 ;; paragraph limits. Don't know if this is necessary but
3065 ;; do it for completeness sake (doing auto filling at all
3066 ;; inside macros is bogus to begin with since the line
3067 ;; continuation backslashes aren't handled).
3069 (c-beginning-of-macro)
3076 (set-marker end (point)))))
3079 ;; Try to avoid comments and macros in the paragraph to
3080 ;; avoid that the adaptive fill mode gets the prefix from
3082 (c-save-buffer-state nil
3085 (c-forward-syntactic-ws end)
3089 (c-backward-syntactic-ws beg)
3091 (set-marker end (point))))))
3094 ;; Temporarily insert the fill prefix after the comment
3095 ;; starter so that the first line looks like any other
3096 ;; comment line in the narrowed region.
3097 (setq fill (c-save-buffer-state nil
3098 (c-guess-fill-prefix c-lit-limits c-lit-type)))
3099 (unless (string-match (concat "\\`[ \t]*\\("
3100 c-current-comment-prefix
3103 ;; Oops, the prefix doesn't match the comment prefix
3104 ;; regexp. This could produce very confusing
3105 ;; results with adaptive fill packages together with
3106 ;; the insert prefix magic below, since the prefix
3107 ;; often doesn't appear at all. So let's warn about
3110 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
3112 ;; Find the right spot on the line, break it, insert
3113 ;; the fill prefix and make sure we're back in the
3114 ;; same column by temporarily prefixing the first word
3115 ;; with a number of 'x'.
3117 (goto-char (car c-lit-limits))
3118 (if (looking-at (if (eq c-lit-type 'c++)
3119 c-current-comment-prefix
3120 comment-start-skip))
3121 (goto-char (match-end 0))
3123 (skip-chars-forward " \t"))
3124 (while (and (< (current-column) (cdr fill))
3127 (let ((col (current-column)))
3128 (setq beg (1+ (point))
3129 tmp-pre (list (point)))
3132 (insert-and-inherit "\n" (car fill))
3133 (insert-char ?x (- col (current-column)) t))
3134 (setcdr tmp-pre (point))))))
3136 (when apply-outside-literal
3137 ;; `apply-outside-literal' is always set to t here if
3138 ;; we're inside a literal.
3142 ;; Kludge: If the function that adapts the fill prefix
3143 ;; doesn't produce the required comment starter for
3144 ;; line comments, then force it by setting fill-prefix.
3145 (when (and (eq c-lit-type 'c++)
3146 ;; Kludge the kludge: filladapt-mode doesn't
3147 ;; have this problem, but it currently
3148 ;; doesn't override fill-context-prefix
3150 (not (and (boundp 'filladapt-mode)
3154 (or (fill-context-prefix beg end)
3156 (c-save-buffer-state nil
3157 (car (or fill (c-guess-fill-prefix
3158 c-lit-limits c-lit-type)))))))
3160 ;; Save the relative position of point if it's outside the
3161 ;; region we're going to narrow. Want to restore it in that
3162 ;; case, but otherwise it should be moved according to the
3164 (point-rel (cond ((< (point) beg) (- (point) beg))
3165 ((> (point) end) (- (point) end)))))
3167 ;; Preparations finally done! Now we can call the
3171 (narrow-to-region beg end)
3174 ;; Restore point if it was outside the region.
3176 (goto-char (+ beg point-rel))
3177 (goto-char (+ end point-rel))))))))
3179 (when (consp tmp-pre)
3180 (delete-region (car tmp-pre) (cdr tmp-pre)))
3184 (goto-char tmp-post)
3186 (when hang-ender-stuck
3187 ;; Preserve point even if it's in the middle of the string
3188 ;; we replace; save-excursion doesn't work in that case.
3190 (goto-char tmp-post)
3191 (skip-syntax-backward "^w ")
3192 (forward-char (- hang-ender-stuck))
3193 (insert-char ?\ hang-ender-stuck t)
3194 (delete-char hang-ender-stuck)
3196 (set-marker tmp-post nil))
3198 (set-marker end nil))))
3200 (defun c-fill-paragraph (&optional arg)
3201 "Like \\[fill-paragraph] but handles C and C++ style comments.
3202 If any of the current line is a comment or within a comment, fill the
3203 comment or the paragraph of it that point is in, preserving the
3204 comment indentation or line-starting decorations (see the
3205 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
3208 If point is inside multiline string literal, fill it. This currently
3209 does not respect escaped newlines, except for the special case when it
3210 is the very first thing in the string. The intended use for this rule
3211 is in situations like the following:
3213 char description[] = \"\\
3214 A very long description of something that you want to fill to make
3215 nicely formatted output.\"\;
3217 If point is in any other situation, i.e. in normal code, do nothing.
3219 Optional prefix ARG means justify paragraph as well."
3221 (let ((fill-paragraph-function
3222 ;; Avoid infinite recursion.
3223 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
3224 fill-paragraph-function)))
3225 (c-mask-paragraph t nil 'fill-paragraph arg))
3226 ;; Always return t. This has the effect that if filling isn't done
3227 ;; above, it isn't done at all, and it's therefore effectively
3228 ;; disabled in normal code.
3231 (defun c-do-auto-fill ()
3232 ;; Do automatic filling if not inside a context where it should be
3235 ;; This function does not do any hidden buffer changes.
3236 (let ((c-auto-fill-prefix
3237 ;; The decision whether the line should be broken is actually
3238 ;; done in c-indent-new-comment-line, which do-auto-fill
3239 ;; calls to break lines. We just set this special variable
3240 ;; so that we'll know when we're called from there. It's
3241 ;; also used to detect whether fill-prefix is user set or
3242 ;; generated automatically by do-auto-fill.
3244 (c-mask-paragraph nil t 'do-auto-fill)))
3246 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
3247 "Break line at point and indent, continuing comment or macro if within one.
3248 If inside a comment and `comment-multi-line' is non-nil, the
3249 indentation and line prefix are preserved (see the
3250 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
3251 details). If inside a single line comment and `comment-multi-line' is
3252 nil, a new comment of the same type is started on the next line and
3253 indented as appropriate for comments. If inside a macro, a line
3254 continuation backslash is inserted and aligned as appropriate, and the
3255 new line is indented according to `c-syntactic-indentation'.
3257 If a fill prefix is specified, it overrides all the above."
3258 ;; allow-auto-fill is used from c-context-line-break to allow auto
3259 ;; filling to break the line more than once. Since this function is
3260 ;; used from auto-fill itself, that's normally disabled to avoid
3261 ;; unnecessary recursion.
3263 (let ((fill-prefix fill-prefix)
3266 (delete-horizontal-space)
3268 (insert-and-inherit ?\n)
3269 (newline (if allow-auto-fill nil 1)))))
3270 ;; Already know the literal type and limits when called from
3271 ;; c-context-line-break.
3272 (c-lit-limits c-lit-limits)
3273 (c-lit-type c-lit-type)
3274 (c-macro-start c-macro-start))
3275 (when (not (eq c-auto-fill-prefix t))
3276 ;; Called from do-auto-fill.
3277 (unless c-lit-limits
3278 (setq c-lit-limits (c-literal-limits nil nil t)))
3280 (setq c-lit-type (c-literal-type c-lit-limits)))
3281 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
3282 ((null c-lit-type) 'code)
3285 (setq fill-prefix t) ; Used as flag in the cond.
3286 (if (and (null c-auto-fill-prefix)
3288 (<= (c-point 'bol) (car c-lit-limits)))
3289 ;; The adaptive fill function has generated a prefix, but
3290 ;; we're on the first line in a block comment so it'll be
3291 ;; wrong. Ignore it to guess a better one below.
3292 (setq fill-prefix nil)
3293 (when (and (eq c-lit-type 'c++)
3294 (not (string-match "\\`[ \t]*//" (or fill-prefix ""))))
3295 ;; Kludge: If the function that adapted the fill prefix
3296 ;; doesn't produce the required comment starter for line
3297 ;; comments, then we ignore it.
3298 (setq fill-prefix nil)))
3300 (cond ((eq fill-prefix t)
3301 ;; A call from do-auto-fill which should be ignored.
3304 ;; A fill-prefix overrides anything.
3305 (funcall do-line-break)
3306 (insert-and-inherit fill-prefix))
3308 (unless c-lit-limits
3309 (setq c-lit-limits (c-literal-limits)))
3311 (setq c-lit-type (c-literal-type c-lit-limits)))
3312 (memq c-lit-type '(c c++)))
3313 ;; Some sort of comment.
3314 (if (or comment-multi-line
3316 (goto-char (car c-lit-limits))
3318 (< (point) (cdr c-lit-limits))))
3319 ;; Inside a comment that should be continued.
3320 (let ((fill (c-save-buffer-state nil
3321 (c-guess-fill-prefix
3323 (c-collect-line-comments c-lit-limits))
3327 (or (and (eq c-lit-type 'c)
3329 (goto-char (- (cdr c-lit-limits) 2))
3330 (if (looking-at "\\*/") (point))))
3331 (cdr c-lit-limits))))
3332 ;; Skip forward past the fill prefix in case
3333 ;; we're standing in it.
3335 ;; FIXME: This doesn't work well in cases like
3337 ;; /* Bla bla bla bla bla
3340 ;; If point is on the 'B' then the line will be
3341 ;; broken after "Bla b".
3342 (while (and (< (current-column) (cdr fill))
3345 (if (and (> (point) comment-text-end)
3346 (> (c-point 'bol) (car c-lit-limits)))
3348 ;; The skip takes us out of the (block)
3349 ;; comment; insert the fill prefix at bol
3350 ;; instead and keep the position.
3351 (setq pos (copy-marker pos t))
3353 (insert-and-inherit (car fill))
3354 (if soft (insert-and-inherit ?\n) (newline 1))
3356 (set-marker pos nil))
3357 ;; Don't break in the middle of a comment starter
3359 (cond ((> (point) comment-text-end)
3360 (goto-char comment-text-end))
3361 ((< (point) (+ (car c-lit-limits) 2))
3362 (goto-char (+ (car c-lit-limits) 2))))
3363 (funcall do-line-break)
3364 (insert-and-inherit (car fill))))
3365 ;; Inside a comment that should be broken.
3366 (let ((comment-start comment-start)
3367 (comment-end comment-end)
3369 (if (eq c-lit-type 'c)
3370 (unless (string-match "[ \t]*/\\*" comment-start)
3371 (setq comment-start "/* " comment-end " */"))
3372 (unless (string-match "[ \t]*//" comment-start)
3373 (setq comment-start "// " comment-end "")))
3374 (setq col (save-excursion
3375 (back-to-indentation)
3377 (funcall do-line-break)
3378 (when (and comment-end (not (equal comment-end "")))
3380 (insert-and-inherit comment-end)
3382 ;; c-comment-indent may look at the current
3383 ;; indentation, so let's start out with the same
3384 ;; indentation as the previous one.
3386 (insert-and-inherit comment-start)
3387 (indent-for-comment))))
3388 ((c-query-and-set-macro-start)
3390 (unless (looking-at "[ \t]*\\\\$")
3391 ;; Do not clobber the alignment of the line continuation
3392 ;; slash; c-backslash-region might look at it.
3393 (delete-horizontal-space))
3394 ;; Got an asymmetry here: In normal code this command
3395 ;; doesn't indent the next line syntactically, and otoh a
3396 ;; normal syntactically indenting newline doesn't continue
3398 (c-newline-and-indent (if allow-auto-fill nil 1)))
3400 ;; Somewhere else in the code.
3401 (let ((col (save-excursion
3403 (while (and (looking-at "[ \t]*\\\\?$")
3404 (= (forward-line -1) 0)))
3405 (current-indentation))))
3406 (funcall do-line-break)
3407 (indent-to col))))))
3409 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
3410 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line)
3412 ;; advice for indent-new-comment-line for older Emacsen
3413 (unless (boundp 'comment-line-break-function)
3414 (defvar c-inside-line-break-advice nil)
3415 (defadvice indent-new-comment-line (around c-line-break-advice
3416 activate preactivate)
3417 "Call `c-indent-new-comment-line' if in CC Mode."
3418 (if (or c-inside-line-break-advice
3419 (not c-buffer-is-cc-mode))
3421 (let ((c-inside-line-break-advice t))
3422 (c-indent-new-comment-line (ad-get-arg 0))))))
3424 (defun c-context-line-break ()
3425 "Do a line break suitable to the context.
3427 When point is outside a comment or macro, insert a newline and indent
3428 according to the syntactic context, unless `c-syntactic-indentation'
3429 is nil, in which case the new line is indented as the previous
3430 non-empty line instead.
3432 When point is inside the content of a preprocessor directive, a line
3433 continuation backslash is inserted before the line break and aligned
3434 appropriately. The end of the cpp directive doesn't count as inside
3437 When point is inside a comment, continue it with the appropriate
3438 comment prefix (see the `c-comment-prefix-regexp' and
3439 `c-block-comment-prefix' variables for details). The end of a
3440 C++-style line comment doesn't count as inside it."
3442 (let* ((c-lit-limits (c-literal-limits nil nil t))
3443 (c-lit-type (c-literal-type c-lit-limits))
3444 (c-macro-start c-macro-start))
3445 (if (or (eq c-lit-type 'c)
3446 (and (eq c-lit-type 'c++)
3448 (skip-chars-forward " \t")
3450 (1- (cdr (setq c-lit-limits
3451 (c-collect-line-comments c-lit-limits))))))
3452 (and (or (not (looking-at "\\s *$"))
3453 (eq (char-before) ?\\))
3454 (c-query-and-set-macro-start)
3456 (goto-char c-macro-start)
3457 (if (looking-at c-opt-cpp-start)
3458 (goto-char (match-end 0)))
3461 (let ((comment-multi-line t)
3463 (c-indent-new-comment-line nil t))
3464 (delete-horizontal-space)
3466 ;; c-indent-line may look at the current indentation, so let's
3467 ;; start out with the same indentation as the previous line.
3468 (let ((col (save-excursion
3470 (while (and (looking-at "[ \t]*\\\\?$")
3471 (= (forward-line -1) 0)))
3472 (current-indentation))))
3474 (indent-according-to-mode))))
3476 (defun c-context-open-line ()
3477 "Insert a line break suitable to the context and leave point before it.
3478 This is the `c-context-line-break' equivalent to `open-line', which is
3479 normally bound to C-o. See `c-context-line-break' for the details."
3481 (let ((here (point)))
3484 ;; Temporarily insert a non-whitespace char to keep any
3485 ;; preceding whitespace intact.
3487 (c-context-line-break))
3492 (cc-provide 'cc-cmds)
3494 ;;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
3495 ;;; cc-cmds.el ends here