1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
11 ;; 1987 Stewart Clamen
12 ;; 1985 Richard M. Stallman
13 ;; Maintainer: bug-cc-mode@gnu.org
14 ;; Created: 22-Apr-1997 (split from cc-mode.el)
15 ;; Version: See cc-mode.el
16 ;; Keywords: c languages oop
18 ;; This file is part of GNU Emacs.
20 ;; GNU Emacs is free software: you can redistribute it and/or modify
21 ;; it under the terms of the GNU General Public License as published by
22 ;; the Free Software Foundation, either version 3 of the License, or
23 ;; (at your option) any later version.
25 ;; GNU Emacs is distributed in the hope that it will be useful,
26 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
27 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 ;; GNU General Public License for more details.
30 ;; You should have received a copy of the GNU General Public License
31 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
39 (if (and (boundp 'byte-compile-dest-file
)
40 (stringp byte-compile-dest-file
))
41 (cons (file-name-directory byte-compile-dest-file
) load-path
)
43 (load "cc-bytecomp" nil t
)))
47 (cc-require 'cc-engine
)
49 ;; Silence the compiler.
50 (cc-bytecomp-defun delete-forward-p) ; XEmacs
51 (cc-bytecomp-defvar filladapt-mode
) ; c-fill-paragraph contains a kludge
52 ; which looks at this.
53 (cc-bytecomp-defun c-forward-subword)
54 (cc-bytecomp-defun c-backward-subword)
56 ;; Indentation / Display syntax functions
57 (defvar c-fix-backslashes t
)
59 (defun c-indent-line (&optional syntax quiet ignore-point-pos
)
60 "Indent the current line according to the syntactic context,
61 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
62 syntactic information for the current line. Be silent about syntactic
63 errors if the optional argument QUIET is non-nil, even if
64 `c-report-syntactic-errors' is non-nil. Normally the position of
65 point is used to decide where the old indentation is on a lines that
66 is otherwise empty \(ignoring any line continuation backslash), but
67 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
68 indentation change \(in columns)."
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
80 ;; Don't use "\\s " - ^L doesn't count as WS
84 (<= (point) (match-end 1)))
85 ;; Delete all whitespace after point if there's only whitespace
86 ;; on the line, so that any code that does back-to-indentation
87 ;; or similar gets the current column in this case. If this
88 ;; removes a line continuation backslash it'll be restored
90 (unless c-auto-align-backslashes
91 ;; Should try to keep the backslash alignment
94 (goto-char (match-end 0))
95 (setq bs-col
(1- (current-column)))))
96 (delete-region (point) (match-end 0))
97 (setq c-fix-backslashes t
))
98 (if c-syntactic-indentation
100 (or (let ((c-parsing-error nil
)
103 (and (boundp 'c-syntactic-context
)
104 c-syntactic-context
))))
105 (c-save-buffer-state (indent)
106 (unless c-syntactic-context
107 (setq c-syntactic-context
(c-guess-basic-syntax)))
108 (setq indent
(c-get-syntactic-indentation
109 c-syntactic-context
))
110 (and (not (c-echo-parsing-error quiet
))
111 c-echo-syntactic-information-p
112 (message "syntax: %s, indent: %d"
113 c-syntactic-context indent
))
114 (setq shift-amt
(- indent
(current-indentation))))
115 (c-shift-line-indentation shift-amt
)
116 (run-hooks 'c-special-indent-hook
)
121 (while (and (= (forward-line -
1) 0)
122 (if (looking-at "\\s *\\\\?$")
124 (setq indent
(current-indentation))
126 (setq shift-amt
(- indent
(current-indentation)))
127 (c-shift-line-indentation shift-amt
)))
128 (when (and c-fix-backslashes line-cont-backslash
)
133 (when c-auto-align-backslashes
134 ;; Realign the line continuation backslash.
135 (c-backslash-region (point) (point) nil t
))))
138 (defun c-newline-and-indent (&optional newline-arg
)
139 "Insert a newline and indent the new line.
140 This function fixes line continuation backslashes if inside a macro,
141 and takes care to set the indentation before calling
142 `indent-according-to-mode', so that lineup functions like
143 `c-lineup-dont-change' works better."
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
))
225 (message "Syntactic analysis: %s" syntax
)
229 (setq elem
(pop syntax
))
230 (when (setq pos
(c-langelem-pos elem
))
231 (push (c-put-overlay pos
(1+ pos
)
234 (when (setq pos
(c-langelem-2nd-pos elem
))
235 (push (c-put-overlay pos
(1+ pos
)
236 'face
'secondary-selection
)
240 (c-delete-overlay (pop ols
)))))
242 (insert-and-inherit (format "%s" syntax
))
244 (c-keep-region-active))
246 (defun c-syntactic-information-on-region (from to
)
247 "Insert a comment with the syntactic analysis on every line in the region."
251 (narrow-to-region from to
)
252 (goto-char (point-min))
254 (c-show-syntactic-information '(0))
258 ;; Minor mode functions.
259 (defun c-update-modeline ()
260 (let ((fmt (format "/%s%s%s%s"
261 (if c-electric-flag
"l" "")
262 (if (and c-electric-flag c-auto-newline
)
264 (if c-hungry-delete-key
"h" "")
266 ;; cc-subword might not be loaded.
267 (boundp 'c-subword-mode
)
268 (symbol-value 'c-subword-mode
))
271 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name
)
272 (substring mode-name
(match-beginning 1) (match-end 1))
274 ;; (setq c-submode-indicators
275 ;; (if (> (length fmt) 1)
278 (if (> (length fmt
) 1)
279 (concat bare-mode-name fmt
)
281 (force-mode-line-update)))
283 (defun c-toggle-syntactic-indentation (&optional arg
)
284 "Toggle syntactic indentation.
285 Optional numeric ARG, if supplied, turns on syntactic indentation when
286 positive, turns it off when negative, and just toggles it when zero or
289 When syntactic indentation is turned on (the default), the indentation
290 functions and the electric keys indent according to the syntactic
291 context keys, when applicable.
293 When it's turned off, the electric keys don't reindent, the indentation
294 functions indents every new line to the same level as the previous
295 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
296 specified by `c-basic-offset'. The indentation style has no effect in
297 this mode, nor any of the indentation associated variables,
298 e.g. `c-special-indent-hook'.
300 This command sets the variable `c-syntactic-indentation'."
302 (setq c-syntactic-indentation
303 (c-calculate-state arg c-syntactic-indentation
))
304 (c-keep-region-active))
306 (defun c-toggle-auto-newline (&optional arg
)
307 "Toggle auto-newline feature.
308 Optional numeric ARG, if supplied, turns on auto-newline when
309 positive, turns it off when negative, and just toggles it when zero or
312 Turning on auto-newline automatically enables electric indentation.
314 When the auto-newline feature is enabled (indicated by \"/la\" on the
315 modeline after the mode name) newlines are automatically inserted
316 after special characters such as brace, comma, semi-colon, and colon."
319 (c-calculate-state arg
(and c-auto-newline c-electric-flag
)))
320 (if c-auto-newline
(setq c-electric-flag t
))
322 (c-keep-region-active))
324 (defalias 'c-toggle-auto-state
'c-toggle-auto-newline
)
325 (make-obsolete 'c-toggle-auto-state
'c-toggle-auto-newline
)
327 (defun c-toggle-hungry-state (&optional arg
)
328 "Toggle hungry-delete-key feature.
329 Optional numeric ARG, if supplied, turns on hungry-delete when
330 positive, turns it off when negative, and just toggles it when zero or
333 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
334 the modeline after the mode name) the delete key gobbles all preceding
335 whitespace in one fell swoop."
337 (setq c-hungry-delete-key
(c-calculate-state arg c-hungry-delete-key
))
339 (c-keep-region-active))
341 (defun c-toggle-auto-hungry-state (&optional arg
)
342 "Toggle auto-newline and hungry-delete-key features.
343 Optional numeric ARG, if supplied, turns on auto-newline and
344 hungry-delete when positive, turns them off when negative, and just
345 toggles them when zero or left out.
347 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
349 (setq c-auto-newline
(c-calculate-state arg c-auto-newline
))
350 (setq c-hungry-delete-key
(c-calculate-state arg c-hungry-delete-key
))
352 (c-keep-region-active))
354 (defun c-toggle-electric-state (&optional arg
)
355 "Toggle the electric indentation feature.
356 Optional numeric ARG, if supplied, turns on electric indentation when
357 positive, turns it off when negative, and just toggles it when zero or
360 (setq c-electric-flag
(c-calculate-state arg c-electric-flag
))
362 (c-keep-region-active))
367 (defun c-electric-backspace (arg)
368 "Delete the preceding character or whitespace.
369 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
370 line) then all preceding whitespace is consumed. If however a prefix
371 argument is supplied, or `c-hungry-delete-key' is nil, or point is
372 inside a literal then the function in the variable
373 `c-backspace-function' is called."
375 (if (c-save-buffer-state ()
376 (or (not c-hungry-delete-key
)
379 (funcall c-backspace-function
(prefix-numeric-value arg
))
380 (c-hungry-delete-backwards)))
382 (defun c-hungry-delete-backwards ()
383 "Delete the preceding character or all preceding whitespace
384 back to the previous non-whitespace character.
385 See also \\[c-hungry-delete-forward]."
387 (let ((here (point)))
389 (if (/= (point) here
)
390 (delete-region (point) here
)
391 (funcall c-backspace-function
1))))
393 (defalias 'c-hungry-backspace
'c-hungry-delete-backwards
)
395 (defun c-electric-delete-forward (arg)
396 "Delete the following character or whitespace.
397 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
398 line) then all following whitespace is consumed. If however a prefix
399 argument is supplied, or `c-hungry-delete-key' is nil, or point is
400 inside a literal then the function in the variable `c-delete-function'
403 (if (c-save-buffer-state ()
404 (or (not c-hungry-delete-key
)
407 (funcall c-delete-function
(prefix-numeric-value arg
))
408 (c-hungry-delete-forward)))
410 (defun c-hungry-delete-forward ()
411 "Delete the following character or all following whitespace
412 up to the next non-whitespace character.
413 See also \\[c-hungry-delete-backwards]."
415 (let ((here (point)))
417 (if (/= (point) here
)
418 (delete-region (point) here
)
419 (funcall c-delete-function
1))))
421 ;; This function is only used in XEmacs.
422 (defun c-electric-delete (arg)
423 "Deletes preceding or following character or whitespace.
424 This function either deletes forward as `c-electric-delete-forward' or
425 backward as `c-electric-backspace', depending on the configuration: If
426 the function `delete-forward-p' is defined and returns non-nil, it
427 deletes forward. Otherwise it deletes backward.
429 Note: This is the way in XEmacs to choose the correct action for the
430 \[delete] key, whichever key that means. Other flavors don't use this
431 function to control that."
433 (if (and (fboundp 'delete-forward-p
)
435 (c-electric-delete-forward arg
)
436 (c-electric-backspace arg
)))
438 ;; This function is only used in XEmacs.
439 (defun c-hungry-delete ()
440 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
441 The direction of deletion depends on the configuration: If the
442 function `delete-forward-p' is defined and returns non-nil, it deletes
443 forward using `c-hungry-delete-forward'. Otherwise it deletes
444 backward using `c-hungry-backspace'.
446 Note: This is the way in XEmacs to choose the correct action for the
447 \[delete] key, whichever key that means. Other flavors don't use this
448 function to control that."
450 (if (and (fboundp 'delete-forward-p
)
452 (c-hungry-delete-forward)
453 (c-hungry-delete-backwards)))
455 (defun c-electric-pound (arg)
457 If `c-electric-flag' is set, handle it specially according to the variable
458 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
459 inside a literal or a macro, nothing special happens."
461 (if (c-save-buffer-state ()
463 (not c-electric-flag
)
464 (not (memq 'alignleft c-electric-pound-behavior
))
466 (skip-chars-backward " \t")
469 (and (= (forward-line -
1) 0)
471 (eq (char-before) ?
\\))))
473 ;; do nothing special
474 (self-insert-command (prefix-numeric-value arg
))
475 ;; place the pound character at the left edge
476 (let ((pos (- (point-max) (point)))
479 (delete-horizontal-space)
480 (insert last-command-event
)
482 (goto-char (- (point-max) pos
)))
485 (defun c-point-syntax ()
486 ;; Return the syntactic context of the construct at point. (This is NOT
487 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
488 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
489 (c-save-buffer-state (;; shut this up too
490 (c-echo-syntactic-information-p nil
)
492 (c-tentative-buffer-changes
493 ;; insert a newline to isolate the construct at point for syntactic
496 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
497 ;; the syntax. (There might already be an escaped NL there.)
498 (when (or (c-at-vsemi-p (1- (point)))
502 (and (c-beginning-of-macro)
503 (progn (c-end-of-macro)
508 (let ((c-syntactic-indentation-in-macros t
)
509 (c-auto-newline-analysis t
))
510 ;; Turn on syntactic macro analysis to help with auto
512 (setq syntax
(c-guess-basic-syntax))
516 (defun c-brace-newlines (syntax)
517 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
518 ;; (not necessarily the same as the S.C. of the line it is on). Return
519 ;; NEWLINES, the list containing some combination of the symbols `before'
520 ;; and `after' saying where newlines should be inserted.
523 ;; This is the list of brace syntactic symbols that can hang.
524 ;; If any new ones are added to c-offsets-alist, they should be
525 ;; added here as well.
527 ;; The order of this list is important; if SYNTAX has several
528 ;; elements, the element that "wins" is the earliest in SYMS.
529 '(arglist-cont-nonempty ; e.g. an array literal.
530 class-open class-close defun-open defun-close
531 inline-open inline-close
532 brace-list-open brace-list-close
533 brace-list-intro brace-entry-open
534 block-open block-close
535 substatement-open statement-case-open
536 extern-lang-open extern-lang-close
537 namespace-open namespace-close
538 module-open module-close
539 composition-open composition-close
540 inexpr-class-open inexpr-class-close
541 ;; `statement-cont' is here for the case with a brace
542 ;; list opener inside a statement. C.f. CASE B.2 in
543 ;; `c-guess-continued-construct'.
546 (c-echo-syntactic-information-p nil
)
547 symb-newlines
) ; e.g. (substatement-open . (after))
550 ;; Do not try to insert newlines around a special
551 ;; (Pike-style) brace list.
552 (if (and c-special-brace-lists
554 (c-safe (if (= (char-before) ?
{)
557 (c-looking-at-special-brace-list))))
559 ;; Seek the matching entry in c-hanging-braces-alist.
562 ;; Substitute inexpr-class and class-open or
563 ;; class-close with inexpr-class-open or
564 ;; inexpr-class-close.
565 (if (assq 'inexpr-class syntax
)
566 (cond ((assq 'class-open syntax
)
567 '((inexpr-class-open)))
568 ((assq 'class-close syntax
)
569 '((inexpr-class-close)))
572 c-hanging-braces-alist
)
573 '(ignore before after
)))) ; Default, when not in c-h-b-l.
575 ;; If syntax is a function symbol, then call it using the
576 ;; defined semantics.
577 (if (and (not (consp (cdr symb-newlines
)))
578 (functionp (cdr symb-newlines
)))
579 (let ((c-syntactic-context syntax
))
580 (funcall (cdr symb-newlines
)
583 (cdr symb-newlines
))))
585 (defun c-try-one-liner ()
586 ;; Point is just after a newly inserted }. If the non-whitespace
587 ;; content of the braces is a single line of code, compact the whole
588 ;; construct to a single line, if this line isn't too long. The Right
589 ;; Thing is done with comments.
591 ;; Point will be left after the }, regardless of whether the clean-up is
592 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
595 (pos (- (point-max) (point)))
596 mbeg1 mend1 mbeg4 mend4
597 eol-col cmnt-pos cmnt-col cmnt-gap
)
602 ;; Avoid backtracking over a very large block. The one we
603 ;; deal with here can never be more than three lines.
604 (narrow-to-region (save-excursion
608 (and (c-safe (c-backward-sexp))
611 (narrow-to-region (point) (1- here
)) ; innards of {.}
613 (cc-eval-when-compile
615 "\\(" ; (match-beginning 1)
616 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
617 "\\)" ; (match-end 1)
618 "[^ \t\r\n]+\\([ \t]+[^ \t\r\n]+\\)*" ; non-WS
619 "\\(" ; (match-beginning 4)
620 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
621 "\\)\\'"))))))) ; (match-end 4) at EOB.
623 (if (c-tentative-buffer-changes
624 (setq mbeg1
(match-beginning 1) mend1
(match-end 1)
625 mbeg4
(match-beginning 4) mend4
(match-end 4))
626 (backward-char) ; back over the `}'
628 (setq cmnt-pos
(and (c-backward-single-comment)
629 (- (point) (- mend1 mbeg1
)))))
630 (delete-region mbeg4 mend4
)
631 (delete-region mbeg1 mend1
)
632 (setq eol-col
(save-excursion (end-of-line) (current-column)))
634 ;; Necessary to put the closing brace before any line
635 ;; oriented comment to keep it syntactically significant.
636 ;; This isn't necessary for block comments, but the result
637 ;; looks nicer anyway.
639 (delete-char 1) ; the `}' has blundered into a comment
641 (setq cmnt-col
(1+ (current-column)))
642 (setq cmnt-pos
(1+ cmnt-pos
)) ; we're inserting a `}'
644 (insert-char ?\
} 1) ; reinsert the `}' before the comment.
645 (setq cmnt-gap
(- cmnt-col
(current-column)))
646 (when (zerop cmnt-gap
)
647 (insert-char ?\
1) ; Put a space before a bare comment.
650 (or (null c-max-one-liner-length
)
651 (zerop c-max-one-liner-length
)
652 (<= eol-col c-max-one-liner-length
)
653 ;; Can we trim space before comment to make the line fit?
655 (< (- eol-col cmnt-gap
) c-max-one-liner-length
)
656 (progn (goto-char cmnt-pos
)
657 (backward-delete-char-untabify
658 (- eol-col c-max-one-liner-length
))
660 (goto-char (- (point-max) pos
))))))
662 (defun c-electric-brace (arg)
665 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
666 numeric ARG hasn't been supplied, the command performs several electric
669 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
670 the mode line) newlines are inserted before and after the brace as
671 directed by the settings in `c-hanging-braces-alist'.
673 \(b) Any auto-newlines are indented. The original line is also
674 reindented unless `c-syntactic-indentation' is nil.
676 \(c) If auto-newline is turned on, various newline cleanups based on the
677 settings of `c-cleanup-list' are done."
680 (let (safepos literal
681 ;; We want to inhibit blinking the paren since this would be
682 ;; most disruptive. We'll blink it ourselves later on.
683 (old-blink-paren blink-paren-function
)
684 blink-paren-function
)
686 (c-save-buffer-state ()
687 (setq safepos
(c-safe-position (point) (c-parse-state))
688 literal
(c-in-literal safepos
)))
690 ;; Insert the brace. Note that expand-abbrev might reindent
691 ;; the line here if there's a preceding "else" or something.
692 (self-insert-command (prefix-numeric-value arg
))
694 (when (and c-electric-flag
(not literal
) (not arg
))
695 (if (not (looking-at "[ \t]*\\\\?$"))
696 (if c-syntactic-indentation
697 (indent-according-to-mode))
699 (let ( ;; shut this up too
700 (c-echo-syntactic-information-p nil
)
702 ln-syntax br-syntax syntax
) ; Syntactic context of the original line,
703 ; of the brace itself, of the line the brace ends up on.
704 (c-save-buffer-state ((c-syntactic-indentation-in-macros t
)
705 (c-auto-newline-analysis t
))
706 (setq ln-syntax
(c-guess-basic-syntax)))
707 (if c-syntactic-indentation
708 (c-indent-line ln-syntax
))
712 (setq br-syntax
(c-point-syntax)
713 newlines
(c-brace-newlines br-syntax
))
715 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
716 (if (and (memq 'before newlines
)
717 (> (current-column) (current-indentation)))
718 (if c-syntactic-indentation
719 ;; Only a plain newline for now - it's indented
720 ;; after the cleanups when the line has its final
723 (c-newline-and-indent)))
726 ;; `syntax' is the syntactic context of the line which ends up
727 ;; with the brace on it.
728 (setq syntax
(if (memq 'before newlines
) br-syntax ln-syntax
))
730 ;; Do all appropriate clean ups
732 (pos (- (point-max) (point)))
736 ;; `}': clean up empty defun braces
737 (when (c-save-buffer-state ()
738 (and (memq 'empty-defun-braces c-cleanup-list
)
739 (eq last-command-event ?\
})
740 (c-intersect-lists '(defun-close class-close inline-close
)
745 (eq (char-before) ?\
{))
746 ;; make sure matching open brace isn't in a comment
747 (not (c-in-literal))))
748 (delete-region (point) (1- here
))
749 (setq here
(- (point-max) pos
)))
752 ;; `}': compact to a one-liner defun?
755 (and (eq last-command-event ?\
})
756 (memq 'one-liner-defun
c-cleanup-list)
757 (c-intersect-lists '(defun-close) syntax
)
759 (setq here
(- (point-max) pos
))))
761 ;; `{': clean up brace-else-brace and brace-elseif-brace
762 (when (eq last-command-event ?\
{)
764 ((and (memq 'brace-else-brace c-cleanup-list
)
767 "\\([ \t\n]\\|\\\\\n\\)*"
769 "\\([ \t\n]\\|\\\\\n\\)*"
773 (delete-region (match-beginning 0) (match-end 0))
774 (insert-and-inherit "} else {"))
775 ((and (memq 'brace-elseif-brace c-cleanup-list
)
777 (goto-char (1- here
))
781 (eq (char-before) ?\
)))
782 (zerop (c-save-buffer-state nil
(c-backward-token-2 1 t
)))
783 (eq (char-after) ?\
()
788 "\\([ \t\n]\\|\\\\\n\\)*"
790 "\\([ \t\n]\\|\\\\\n\\)+"
792 "\\([ \t\n]\\|\\\\\n\\)*"
795 ;(eq (match-end 0) tmp);
797 (delete-region mbeg mend
)
801 (goto-char (- (point-max) pos
))
803 ;; Indent the line after the cleanups since it might
804 ;; very well indent differently due to them, e.g. if
805 ;; c-indent-one-line-block is used together with the
806 ;; one-liner-defun cleanup.
807 (when c-syntactic-indentation
810 ;; does a newline go after the brace?
811 (if (memq 'after newlines
)
812 (c-newline-and-indent))
816 (and (eq last-command-event ?\
})
817 (not executing-kbd-macro
)
820 (c-save-buffer-state nil
821 (c-backward-syntactic-ws safepos
))
822 (funcall old-blink-paren
)))))
824 (defun c-electric-slash (arg)
825 "Insert a slash character.
827 If the slash is inserted immediately after the comment prefix in a c-style
828 comment, the comment might get closed by removing whitespace and possibly
829 inserting a \"*\". See the variable `c-cleanup-list'.
831 Indent the line as a comment, if:
833 1. The slash is second of a \"//\" line oriented comment introducing
834 token and we are on a comment-only-line, or
836 2. The slash is part of a \"*/\" token that closes a block oriented
839 If a numeric ARG is supplied, point is inside a literal, or
840 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
843 (let ((literal (c-save-buffer-state () (c-in-literal)))
846 (c-echo-syntactic-information-p nil
))
848 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
849 ;; `c-syntactic-indentation' set.
852 (memq 'comment-close-slash c-cleanup-list
)
853 (eq last-command-event ?
/)
854 (looking-at (concat "[ \t]*\\("
855 (regexp-quote comment-end
) "\\)?$"))
856 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
859 (narrow-to-region (point-min) (point))
860 (back-to-indentation)
861 (looking-at (concat c-current-comment-prefix
"[ \t]*$")))))
862 (delete-region (progn (forward-line 0) (point))
863 (progn (end-of-line) (point)))
864 (insert-char ?
* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
866 (setq indentp
(and (not arg
)
867 c-syntactic-indentation
869 (eq last-command-event ?
/)
870 (eq (char-before) (if literal ?
* ?
/))))
871 (self-insert-command (prefix-numeric-value arg
))
873 (indent-according-to-mode))))
875 (defun c-electric-star (arg)
876 "Insert a star character.
877 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
878 the star is the second character of a C style comment starter on a
879 comment-only-line, indent the line as a comment. If a numeric ARG is
880 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
881 this indentation is inhibited."
884 (self-insert-command (prefix-numeric-value arg
))
885 ;; if we are in a literal, or if arg is given do not reindent the
886 ;; current line, unless this star introduces a comment-only line.
887 (if (c-save-buffer-state ()
888 (and c-syntactic-indentation
891 (eq (c-in-literal) 'c
)
892 (eq (char-before) ?
*)
895 (skip-chars-backward "*")
896 (if (eq (char-before) ?
/)
898 (skip-chars-backward " \t")
900 (let (c-echo-syntactic-information-p) ; shut this up
901 (indent-according-to-mode))
904 (defun c-electric-semi&comma
(arg)
905 "Insert a comma or semicolon.
907 If `c-electric-flag' is non-nil, point isn't inside a literal and a
908 numeric ARG hasn't been supplied, the command performs several electric
911 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
912 the mode line) a newline might be inserted. See the variable
913 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
915 \(b) Any auto-newlines are indented. The original line is also
916 reindented unless `c-syntactic-indentation' is nil.
918 \(c) If auto-newline is turned on, a comma following a brace list or a
919 semicolon following a defun might be cleaned up, depending on the
920 settings of `c-cleanup-list'."
922 (let* (lim literal c-syntactic-context
925 (c-echo-syntactic-information-p nil
))
927 (c-save-buffer-state ()
928 (setq lim
(c-most-enclosing-brace (c-parse-state))
929 literal
(c-in-literal lim
)))
931 (self-insert-command (prefix-numeric-value arg
))
933 (if (and c-electric-flag
(not literal
) (not arg
))
934 ;; do all cleanups and newline insertions if c-auto-newline is on.
935 (if (or (not c-auto-newline
)
936 (not (looking-at "[ \t]*\\\\?$")))
937 (if c-syntactic-indentation
939 ;; clean ups: list-close-comma or defun-close-semi
940 (let ((pos (- (point-max) (point))))
941 (if (c-save-buffer-state ()
943 (eq last-command-event ?
,)
944 (memq 'list-close-comma c-cleanup-list
))
946 (eq last-command-event ?\
;)
947 (memq 'defun-close-semi c-cleanup-list
)))
951 (eq (char-before) ?
}))
952 ;; make sure matching open brace isn't in a comment
953 (not (c-in-literal lim
))))
954 (delete-region (point) here
))
955 (goto-char (- (point-max) pos
)))
957 (when c-syntactic-indentation
958 (setq c-syntactic-context
(c-guess-basic-syntax))
959 (c-indent-line c-syntactic-context
))
960 ;; check to see if a newline should be added
961 (let ((criteria c-hanging-semi
&comma-criteria
)
962 answer add-newline-p
)
964 (setq answer
(funcall (car criteria
)))
965 ;; only nil value means continue checking
967 (setq criteria
(cdr criteria
))
969 ;; only 'stop specifically says do not add a newline
970 (setq add-newline-p
(not (eq answer
'stop
)))
973 (c-newline-and-indent))
976 (defun c-electric-colon (arg)
979 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
980 numeric ARG hasn't been supplied, the command performs several electric
983 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
984 the mode line) newlines are inserted before and after the colon based on
985 the settings in `c-hanging-colons-alist'.
987 \(b) Any auto-newlines are indented. The original line is also
988 reindented unless `c-syntactic-indentation' is nil.
990 \(c) If auto-newline is turned on, whitespace between two colons will be
991 \"cleaned up\" leaving a scope operator, if this action is set in
995 (let* ((bod (c-point 'bod
))
996 (literal (c-save-buffer-state () (c-in-literal bod
)))
999 (c-echo-syntactic-information-p nil
))
1000 (self-insert-command (prefix-numeric-value arg
))
1001 ;; Any electric action?
1002 (if (and c-electric-flag
(not literal
) (not arg
))
1003 ;; Unless we're at EOL, only re-indentation happens.
1004 (if (not (looking-at "[ \t]*\\\\?$"))
1005 (if c-syntactic-indentation
1006 (indent-according-to-mode))
1008 ;; scope-operator clean-up?
1009 (let ((pos (- (point-max) (point)))
1011 (if (c-save-buffer-state () ; Why do we need this? [ACM, 2003-03-12]
1013 (memq 'scope-operator c-cleanup-list
)
1014 (eq (char-before) ?
:)
1017 (c-skip-ws-backward)
1018 (eq (char-before) ?
:))
1019 (not (c-in-literal))
1020 (not (eq (char-after (- (point) 2)) ?
:))))
1022 (delete-region (point) (1- here
))
1023 (setq is-scope-op t
)))
1024 (goto-char (- (point-max) pos
)))
1026 ;; indent the current line if it's done syntactically.
1027 (if c-syntactic-indentation
1028 ;; Cannot use the same syntax analysis as we find below,
1029 ;; since that's made with c-syntactic-indentation-in-macros
1031 (indent-according-to-mode))
1033 ;; Calculate where, if anywhere, we want newlines.
1034 (c-save-buffer-state
1035 ((c-syntactic-indentation-in-macros t
)
1036 (c-auto-newline-analysis t
)
1037 ;; Turn on syntactic macro analysis to help with auto newlines
1039 (syntax (c-guess-basic-syntax))
1041 ;; Translate substatement-label to label for this operation.
1043 (if (eq (car (car elem
)) 'substatement-label
)
1044 (setcar (car elem
) 'label
))
1045 (setq elem
(cdr elem
)))
1046 ;; some language elements can only be determined by checking
1047 ;; the following line. Lets first look for ones that can be
1048 ;; found when looking on the line with the colon
1051 (or (c-lookup-lists '(case-label label access-label
)
1052 syntax c-hanging-colons-alist
)
1053 (c-lookup-lists '(member-init-intro inher-intro
)
1057 (c-guess-basic-syntax)
1059 c-hanging-colons-alist
)))))
1060 ;; does a newline go before the colon? Watch out for already
1061 ;; non-hung colons. However, we don't unhang them because that
1062 ;; would be a cleanup (and anti-social).
1063 (if (and (memq 'before newlines
)
1066 (skip-chars-backward ": \t")
1068 (let ((pos (- (point-max) (point))))
1070 (c-newline-and-indent)
1071 (goto-char (- (point-max) pos
))))
1072 ;; does a newline go after the colon?
1073 (if (and (memq 'after
(cdr-safe newlines
))
1075 (c-newline-and-indent))
1078 (defun c-electric-lt-gt (arg)
1079 "Insert a \"<\" or \">\" character.
1080 If the current language uses angle bracket parens (e.g. template
1081 arguments in C++), try to find out if the inserted character is a
1082 paren and give it paren syntax if appropriate.
1084 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1085 line will be reindented if the inserted character is a paren or if it
1086 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1087 numeric argument is supplied, or the point is inside a literal."
1090 (let ((c-echo-syntactic-information-p nil
)
1091 final-pos close-paren-inserted
)
1093 (self-insert-command (prefix-numeric-value arg
))
1094 (setq final-pos
(point))
1096 (c-save-buffer-state (c-parse-and-markup-<>-arglists
1097 c-restricted-
<>-arglists
1100 (when c-recognize-
<>-arglists
1101 (if (eq last-command-event ?
<)
1106 (c-beginning-of-current-token)
1109 (c-backward-token-2)
1110 (looking-at c-opt-
<>-sexp-key
)))
1111 (c-mark-<-as-paren
(1- final-pos
)))
1113 ;; It's a ">". Check if there's an earlier "<" which either has
1114 ;; open paren syntax already or that can be recognized as an arglist
1115 ;; together with this ">". Note that this won't work in cases like
1116 ;; "template <x, a < b, y>" but they ought to be rare.
1119 ;; Narrow to avoid that `c-forward-<>-arglist' below searches past
1121 (narrow-to-region (point-min) final-pos
)
1125 (goto-char final-pos
)
1126 (c-syntactic-skip-backward "^<;}" nil t
)
1127 (eq (char-before) ?
<))
1130 ;; If the "<" already got open paren syntax we know we
1131 ;; have the matching closer. Handle it and exit the
1133 (if (looking-at "\\s\(")
1135 (c-mark->-as-paren
(1- final-pos
))
1136 (setq close-paren-inserted t
)
1141 (setq <-pos
(point))
1142 (c-backward-syntactic-ws)
1143 (c-simple-skip-symbol-backward))
1144 (or (looking-at c-opt-
<>-sexp-key
)
1145 (not (looking-at c-keywords-regexp
)))
1147 (let ((c-parse-and-markup-<>-arglists t
)
1148 c-restricted-
<>-arglists
1150 (c-most-enclosing-brace (c-parse-state))))
1151 (when (and containing-sexp
1152 (progn (goto-char containing-sexp
)
1153 (eq (char-after) ?\
())
1154 (not (eq (get-text-property (point) 'c-type
)
1155 'c-decl-arg-start
)))
1156 (setq c-restricted-
<>-arglists t
))
1158 (c-forward-<>-arglist nil
))
1160 ;; Loop here if the "<" we found above belongs to a nested
1161 ;; angle bracket sexp. When we start over we'll find the
1162 ;; previous or surrounding sexp.
1163 (if (< (point) final-pos
)
1165 (setq close-paren-inserted t
)
1167 (goto-char final-pos
)
1169 ;; Indent the line if appropriate.
1170 (when (and c-electric-flag c-syntactic-indentation
)
1172 (when (prog1 (or (looking-at "\\s\(\\|\\s\)")
1173 (and (c-major-mode-is 'c
++-mode
)
1175 (c-beginning-of-current-token)
1176 (looking-at "<<\\|>>"))
1177 (= (match-end 0) final-pos
)))
1178 (goto-char final-pos
))
1179 (indent-according-to-mode)))
1181 (when (and close-paren-inserted
1182 (not executing-kbd-macro
)
1183 blink-paren-function
)
1184 ;; Note: Most paren blink functions, such as the standard
1185 ;; `blink-matching-open', currently doesn't handle paren chars
1186 ;; marked with text properties very well. Maybe we should avoid
1187 ;; this call for the time being?
1188 (funcall blink-paren-function
))))
1190 (defun c-electric-paren (arg)
1191 "Insert a parenthesis.
1193 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1194 line is reindented unless a numeric ARG is supplied, or the parenthesis
1195 is inserted inside a literal.
1197 Whitespace between a function name and the parenthesis may get added or
1198 removed; see the variable `c-cleanup-list'.
1200 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1201 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1203 (let ((literal (c-save-buffer-state () (c-in-literal)))
1205 (c-echo-syntactic-information-p nil
))
1206 (self-insert-command (prefix-numeric-value arg
))
1208 (if (and (not arg
) (not literal
))
1209 (let* ( ;; We want to inhibit blinking the paren since this will
1210 ;; be most disruptive. We'll blink it ourselves
1212 (old-blink-paren blink-paren-function
)
1213 blink-paren-function
)
1214 (if (and c-syntactic-indentation c-electric-flag
)
1215 (indent-according-to-mode))
1217 ;; If we're at EOL, check for new-line clean-ups.
1218 (when (and c-electric-flag c-auto-newline
1219 (looking-at "[ \t]*\\\\?$"))
1221 ;; clean up brace-elseif-brace
1223 (and (memq 'brace-elseif-brace c-cleanup-list
)
1224 (eq last-command-event ?\
()
1227 "\\([ \t\n]\\|\\\\\n\\)*"
1229 "\\([ \t\n]\\|\\\\\n\\)+"
1231 "\\([ \t\n]\\|\\\\\n\\)*"
1235 (not (c-save-buffer-state () (c-in-literal))))
1236 (delete-region (match-beginning 0) (match-end 0))
1237 (insert-and-inherit "} else if ("))
1239 ;; clean up brace-catch-brace
1241 (and (memq 'brace-catch-brace c-cleanup-list
)
1242 (eq last-command-event ?\
()
1245 "\\([ \t\n]\\|\\\\\n\\)*"
1247 "\\([ \t\n]\\|\\\\\n\\)*"
1251 (not (c-save-buffer-state () (c-in-literal))))
1252 (delete-region (match-beginning 0) (match-end 0))
1253 (insert-and-inherit "} catch (")))
1255 ;; Check for clean-ups at function calls. These two DON'T need
1256 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1257 ;; Point is currently just after the inserted paren.
1258 (let (beg (end (1- (point))))
1261 ;; space-before-funcall clean-up?
1262 ((and (memq 'space-before-funcall c-cleanup-list
)
1263 (eq last-command-event ?\
()
1266 (skip-chars-backward " \t")
1268 (and (c-save-buffer-state () (c-on-identifier))
1269 ;; Don't add a space into #define FOO()....
1270 (not (and (c-beginning-of-macro)
1271 (c-forward-over-cpp-define-id)
1272 (eq (point) beg
))))))
1274 (delete-region beg end
)
1278 ;; compact-empty-funcall clean-up?
1279 ((c-save-buffer-state ()
1280 (and (memq 'compact-empty-funcall c-cleanup-list
)
1281 (eq last-command-event ?\
))
1283 (c-safe (backward-char 2))
1284 (when (looking-at "()")
1286 (skip-chars-backward " \t")
1288 (c-on-identifier)))))
1289 (delete-region beg end
))))
1290 (and (eq last-input-event ?\
))
1291 (not executing-kbd-macro
)
1293 (funcall old-blink-paren
))))))
1295 (defun c-electric-continued-statement ()
1296 "Reindent the current line if appropriate.
1298 This function is used to reindent the line after a keyword which
1299 continues an earlier statement is typed, e.g. an \"else\" or the
1300 \"while\" in a do-while block.
1302 The line is reindented if there is nothing but whitespace before the
1303 keyword on the line, the keyword is not inserted inside a literal, and
1304 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1305 (let (;; shut this up
1306 (c-echo-syntactic-information-p nil
))
1307 (when (c-save-buffer-state ()
1308 (and c-electric-flag
1309 c-syntactic-indentation
1310 (not (eq last-command-event ?_
))
1312 (skip-syntax-backward "w")
1315 (not (c-in-literal (c-point 'bod
)))))
1316 ;; Have to temporarily insert a space so that
1317 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1318 ;; space with a nonspace to avoid messing up any whitespace
1319 ;; sensitive meddling that might be done, e.g. by
1320 ;; `c-backslash-region'.
1321 (insert-and-inherit " x")
1323 (indent-according-to-mode)
1324 (delete-char -
2)))))
1327 ;; "nomenclature" functions + c-scope-operator.
1328 (defun c-forward-into-nomenclature (&optional arg
)
1329 "Compatibility alias for `c-forward-subword'."
1331 (require 'cc-subword
)
1332 (c-forward-subword arg
))
1333 (make-obsolete 'c-forward-into-nomenclature
'c-forward-subword
)
1335 (defun c-backward-into-nomenclature (&optional arg
)
1336 "Compatibility alias for `c-backward-subword'."
1338 (require 'cc-subword
)
1339 (c-backward-subword arg
))
1340 (make-obsolete 'c-backward-into-nomenclature
'c-backward-subword
)
1342 (defun c-scope-operator ()
1343 "Insert a double colon scope operator at point.
1344 No indentation or other \"electric\" behavior is performed."
1346 (insert-and-inherit "::"))
1349 ;; Movement (etc.) by defuns.
1350 (defun c-in-function-trailer-p (&optional lim
)
1351 ;; Return non-nil if point is between the closing brace and the semicolon of
1352 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1353 ;; portion of a declaration like "struct foo {...} bar ;".
1355 ;; Return the position of the main declaration. Otherwise, return nil.
1356 ;; Point is assumed to be at the top level and outside of any macro or
1359 ;; If LIM is non-nil, it is the bound on a the backward search for the
1360 ;; beginning of the declaration.
1362 ;; This function might do hidden buffer changes.
1363 (and c-opt-block-decls-with-vars-key
1365 (c-syntactic-skip-backward "^;}" lim
)
1366 (let ((eo-block (point))
1368 (and (eq (char-before) ?\
})
1369 (eq (car (c-beginning-of-decl-1 lim
)) 'previous
)
1371 ;; Look for struct or union or ... If we find one, it might
1372 ;; be the return type of a function, or the like. Exclude
1374 (c-syntactic-re-search-forward
1375 (concat "[;=\(\[{]\\|\\("
1376 c-opt-block-decls-with-vars-key
1379 (match-beginning 1) ; Is there a "struct" etc., somewhere?
1380 (not (eq (char-before) ?_
))
1381 (c-syntactic-re-search-forward "[;=\(\[{]" eo-block t t t
)
1382 (eq (char-before) ?\
{)
1385 (defun c-where-wrt-brace-construct ()
1386 ;; Determine where we are with respect to functions (or other brace
1387 ;; constructs, included in the term "function" in the rest of this comment).
1388 ;; Point is assumed to be outside any macro or literal.
1389 ;; This is used by c-\(begining\|end\)-of-defun.
1391 ;; Return one of these symbols:
1392 ;; at-header : we're at the start of a function's header.
1393 ;; in-header : we're inside a function's header, this extending right
1394 ;; up to the brace. This bit includes any k&r declarations.
1395 ;; in-block : we're inside a function's brace block.
1396 ;; in-trailer : we're in the area between the "}" and ";" of something
1397 ;; like "struct foo {...} bar, baz;".
1398 ;; at-function-end : we're just after the closing brace (or semicolon) that
1399 ;; terminates the function.
1400 ;; outwith-function: we're not at or in any function. Being inside a
1401 ;; non-brace construct also counts as 'outwith-function'.
1403 ;; This function might do hidden buffer changes.
1406 decl-result brace-decl-p
1408 (paren-state (c-parse-state))
1409 (least-enclosing (c-least-enclosing-brace paren-state
)))
1412 ((and least-enclosing
1413 (eq (char-after least-enclosing
) ?\
{))
1415 ((c-in-function-trailer-p)
1417 ((and (not least-enclosing
)
1419 (consp (car paren-state
))
1420 (eq start
(cdar paren-state
)))
1423 ;; Find the start of the current declaration. NOTE: If we're in the
1424 ;; variables after a "struct/eval" type block, we don't get to the
1425 ;; real declaration here - we detect and correct for this later.
1427 ;;If we're in the parameters' parens, move back out of them.
1428 (if least-enclosing
(goto-char least-enclosing
))
1429 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1430 ;; at a declaration.
1431 (if (or (and (eolp) (not (eobp))) ; EOL is matched by "\\s>"
1433 "\\([;#]\\|\\'\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s$\\|\\s<\\|\\s>\\|\\s!\\)")))
1435 (setq kluge-start
(point))
1437 (car (c-beginning-of-decl-1
1438 ;; NOTE: If we're in a K&R region, this might be the start
1439 ;; of a parameter declaration, not the actual function.
1440 (and least-enclosing
; LIMIT for c-b-of-decl-1
1441 (c-safe-position least-enclosing paren-state
)))))
1443 ;; Has the declaration we've gone back to got braces?
1446 (and (c-syntactic-re-search-forward "[;{]" nil t t
)
1447 (or (eq (char-before) ?\
{)
1448 (and c-recognize-knr-p
1449 ;; Might have stopped on the
1450 ;; ';' in a K&R argdecl. In
1451 ;; that case the declaration
1452 ;; should contain a block.
1453 (c-in-knr-argdecl))))))
1456 ((= (point) kluge-start
) ; might be BOB or unbalanced parens.
1458 ((eq decl-result
'same
)
1460 (if (eq (point) start
)
1464 ((eq decl-result
'previous
)
1465 (if (and (not brace-decl-p
)
1466 (c-in-function-trailer-p))
1470 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1473 (defun c-backward-to-nth-BOF-{ (n where
)
1474 ;; Skip to the opening brace of the Nth function before point. If
1475 ;; point is inside a function, this counts as the first. Point must be
1476 ;; outside any comment/string or macro.
1478 ;; N must be strictly positive.
1479 ;; WHERE describes the position of point, one of the symbols `at-header',
1480 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1481 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1483 ;; If we run out of functions, leave point at BOB. Return zero on success,
1484 ;; otherwise the number of {s still to go.
1486 ;; This function may do hidden buffer changes
1488 ;; What we do to go back the first defun depends on where we start.
1490 ((eq where
'in-block
)
1491 (goto-char (c-least-enclosing-brace (c-parse-state)))
1493 ((eq where
'in-header
)
1494 (c-syntactic-re-search-forward "{")
1497 ((memq where
'(at-header outwith-function at-function-end in-trailer
))
1498 (c-syntactic-skip-backward "^}")
1499 (when (eq (char-before) ?\
})
1502 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where
)))
1504 ;; Each time round the loop, go back to a "{" at the outermost level.
1505 (while (and (> n
0) (not (bobp)))
1506 (c-parse-state) ; This call speeds up the following one
1507 ; by a factor of ~6. Hmmm. 2006/4/5.
1508 (c-syntactic-skip-backward "^}")
1509 (when (eq (char-before) ?\
})
1514 (defun c-beginning-of-defun (&optional arg
)
1515 "Move backward to the beginning of a defun.
1516 Every top level declaration that contains a brace paren block is
1517 considered to be a defun.
1519 With a positive argument, move backward that many defuns. A negative
1520 argument -N means move forward to the Nth following beginning. Return
1521 t unless search stops due to beginning or end of buffer.
1523 Unlike the built-in `beginning-of-defun' this tries to be smarter
1524 about finding the char with open-parenthesis syntax that starts the
1528 (or arg
(setq arg
1))
1530 (c-save-buffer-state
1531 (beginning-of-defun-function end-of-defun-function
1533 where paren-state pos
)
1535 ;; Move back out of any macro/comment/string we happen to be in.
1536 (c-beginning-of-macro)
1537 (setq pos
(c-literal-limits))
1538 (if pos
(goto-char (car pos
)))
1540 (setq where
(c-where-wrt-brace-construct))
1543 ;; Move forward to the closing brace of a function.
1545 (if (memq where
'(at-function-end outwith-function
))
1546 (setq arg
(1+ arg
)))
1548 (setq arg
(c-forward-to-nth-EOF-} (- arg
) where
)))
1549 ;; Move forward to the next opening brace....
1550 (when (and (= arg
0)
1551 (c-syntactic-re-search-forward "{" nil
'eob
))
1553 ;; ... and backward to the function header.
1554 (c-beginning-of-decl-1)
1557 ;; Move backward to the opening brace of a function.
1558 (when (and (> arg
0)
1559 (eq (setq arg
(c-backward-to-nth-BOF-{ arg where
)) 0))
1561 ;; Go backward to this function's header.
1562 (c-beginning-of-decl-1)
1565 ;; We're now there, modulo comments and whitespace.
1566 ;; Try to be line oriented; position point at the closest
1567 ;; preceding boi that isn't inside a comment, but if we hit
1568 ;; the previous declaration then we use the current point
1570 (while (and (/= (point) (c-point 'boi
))
1571 (c-backward-single-comment)))
1572 (if (/= (point) (c-point 'boi
))
1575 (c-keep-region-active)
1578 (defun c-forward-to-nth-EOF-} (n where
)
1579 ;; Skip to the closing brace of the Nth function after point. If
1580 ;; point is inside a function, this counts as the first. Point must be
1581 ;; outside any comment/string or macro.
1583 ;; N must be strictly positive.
1584 ;; WHERE describes the position of point, one of the symbols `at-header',
1585 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1586 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1588 ;; If we run out of functions, leave point at EOB. Return zero on success,
1589 ;; otherwise the number of }s still to go.
1591 ;; This function may do hidden buffer changes.
1594 ;; What we do to go forward over the first defun depends on where we
1595 ;; start. We go to the closing brace of that defun, even when we go
1596 ;; backwards to it (in a "struct foo {...} bar ;").
1598 ((eq where
'in-block
)
1599 (goto-char (c-least-enclosing-brace (c-parse-state)))
1602 ((eq where
'in-trailer
)
1603 (c-syntactic-skip-backward "^}")
1605 ((memq where
'(at-function-end outwith-function at-header in-header
))
1606 (when (c-syntactic-re-search-forward "{" nil
'eob
)
1610 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where
)))
1612 ;; Each time round the loop, go forward to a "}" at the outermost level.
1613 (while (and (> n
0) (not (eobp)))
1614 ;(c-parse-state) ; This call speeds up the following one by a factor
1615 ; of ~6. Hmmm. 2006/4/5.
1616 (when (c-syntactic-re-search-forward "{" nil
'eob
)
1622 (defun c-end-of-defun (&optional arg
)
1623 "Move forward to the end of a top level declaration.
1624 With argument, do it that many times. Negative argument -N means move
1625 back to Nth preceding end. Returns t unless search stops due to
1626 beginning or end of buffer.
1628 An end of a defun occurs right after the close-parenthesis that matches
1629 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1631 (or arg
(setq arg
1))
1633 (c-save-buffer-state
1634 (beginning-of-defun-function end-of-defun-function
1636 where paren-state pos
)
1638 ;; Move back out of any macro/comment/string we happen to be in.
1639 (c-beginning-of-macro)
1640 (setq pos
(c-literal-limits))
1641 (if pos
(goto-char (car pos
)))
1643 (setq where
(c-where-wrt-brace-construct))
1646 ;; Move backwards to the } of a function
1648 (if (memq where
'(at-header outwith-function
))
1649 (setq arg
(1+ arg
)))
1651 (setq arg
(c-backward-to-nth-BOF-{ (- arg
) where
)))
1653 (c-syntactic-skip-backward "^}")))
1655 ;; Move forward to the } of a function
1657 (setq arg
(c-forward-to-nth-EOF-} arg where
))))
1659 ;; Do we need to move forward from the brace to the semicolon?
1661 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1662 (c-syntactic-re-search-forward ";"))
1665 ;; We're there now, modulo comments and whitespace.
1666 ;; Try to be line oriented; position point after the next
1667 ;; newline that isn't inside a comment, but if we hit the
1668 ;; next declaration then we use the current point instead.
1669 (while (and (not (bolp))
1670 (not (looking-at "\\s *$"))
1671 (c-forward-single-comment)))
1673 ((looking-at "\\s *$")
1678 (c-keep-region-active)
1681 (defun c-defun-name ()
1682 "Return the name of the current defun, or NIL if there isn't one.
1683 \"Defun\" here means a function, or other top level construct
1684 with a brace block."
1686 (c-save-buffer-state
1687 (beginning-of-defun-function end-of-defun-function
1693 ;; Move back out of any macro/comment/string we happen to be in.
1694 (c-beginning-of-macro)
1695 (setq pos
(c-literal-limits))
1696 (if pos
(goto-char (car pos
)))
1698 (setq where
(c-where-wrt-brace-construct))
1700 ;; Move to the beginning of the current defun, if any, if we're not
1702 (if (eq where
'outwith-function
)
1704 (unless (eq where
'at-header
)
1705 (c-backward-to-nth-BOF-{ 1 where
)
1706 (c-beginning-of-decl-1))
1708 ;; Pick out the defun name, according to the type of defun.
1710 ;; struct, union, enum, or similar:
1711 ((and (looking-at c-type-prefix-key
)
1712 (progn (c-forward-token-2 2) ; over "struct foo "
1713 (or (eq (char-after) ?\
{)
1714 (looking-at c-symbol-key
)))) ; "struct foo bar ..."
1715 (save-match-data (c-forward-token-2))
1716 (when (eq (char-after) ?\
{)
1717 (c-backward-token-2)
1718 (looking-at c-symbol-key
))
1719 (match-string-no-properties 0))
1721 ((looking-at "DEFUN\\_>")
1722 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1723 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1725 (c-forward-syntactic-ws)
1726 (when (eq (char-after) ?
\")
1728 (c-forward-token-2)) ; over the comma and following WS.
1729 (buffer-substring-no-properties
1733 (when (looking-at ":") ; CLISP: DEFUN(PACKAGE:LISP-SYMBOL,...)
1734 (skip-chars-forward "^,"))
1735 (c-backward-syntactic-ws)
1738 ((looking-at "DEF[a-zA-Z0-9_]* *( *\\([^, ]*\\) *,")
1739 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1740 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1741 (match-string-no-properties 1))
1744 ;; Normal function or initializer.
1745 (when (c-syntactic-re-search-forward "[{(]" nil t
)
1747 (c-backward-syntactic-ws)
1748 (when (eq (char-before) ?\
=) ; struct foo bar = {0, 0} ;
1749 (c-backward-token-2)
1750 (c-backward-syntactic-ws))
1751 (setq name-end
(point))
1752 (c-backward-token-2)
1753 (buffer-substring-no-properties (point) name-end
)))))))))
1755 (defun c-declaration-limits (near)
1756 ;; Return a cons of the beginning and end positions of the current
1757 ;; top level declaration or macro. If point is not inside any then
1758 ;; nil is returned, unless NEAR is non-nil in which case the closest
1759 ;; following one is chosen instead (if there is any). The end
1760 ;; position is at the next line, providing there is one before the
1763 ;; This function might do hidden buffer changes.
1766 ;; Note: Some code duplication in `c-beginning-of-defun' and
1767 ;; `c-end-of-defun'.
1769 (let ((start (point))
1770 (paren-state (c-parse-state))
1773 (goto-char (c-least-enclosing-brace paren-state
))
1774 ;; If we moved to the outermost enclosing paren then we
1775 ;; can use c-safe-position to set the limit. Can't do
1776 ;; that otherwise since the earlier paren pair on
1777 ;; paren-state might very well be part of the
1778 ;; declaration we should go to.
1779 (setq lim
(c-safe-position (point) paren-state
))
1781 ;; At top level. Make sure we aren't inside a literal.
1782 (setq pos
(c-literal-limits
1783 (c-safe-position (point) paren-state
)))
1784 (if pos
(goto-char (car pos
))))
1786 (when (c-beginning-of-macro)
1795 (when (or (eq (car (c-beginning-of-decl-1 lim
)) 'previous
)
1797 ;; We moved back over the previous defun. Skip to the next
1798 ;; one. Not using c-forward-syntactic-ws here since we
1799 ;; should not skip a macro. We can also be directly after
1800 ;; the block in a `c-opt-block-decls-with-vars-key'
1801 ;; declaration, but then we won't move significantly far
1804 (c-forward-comments)
1806 (when (and near
(c-beginning-of-macro))
1814 (if (eobp) (throw 'exit nil
))
1816 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1817 ;; declaration that doesn't end there. We're searching back and
1818 ;; forth over the block here, which can be expensive.
1820 (if (and c-opt-block-decls-with-vars-key
1822 (c-backward-syntactic-ws)
1823 (eq (char-before) ?
}))
1824 (eq (car (c-beginning-of-decl-1))
1828 (and (> (point) pos
)
1829 (setq end-pos
(point)))))
1833 (if (and (not near
) (> (point) start
))
1836 ;; Try to be line oriented; position the limits at the
1837 ;; closest preceding boi, and after the next newline, that
1838 ;; isn't inside a comment, but if we hit a neighboring
1839 ;; declaration then we instead use the exact declaration
1840 ;; limit in that direction.
1843 (while (and (/= (point) (c-point 'boi
))
1844 (c-backward-single-comment)))
1845 (if (/= (point) (c-point 'boi
))
1853 (while (and (not (bolp))
1854 (not (looking-at "\\s *$"))
1855 (c-forward-single-comment)))
1858 ((looking-at "\\s *$")
1865 (defun c-mark-function ()
1866 "Put mark at end of the current top-level declaration or macro, point at beginning.
1867 If point is not inside any then the closest following one is chosen.
1869 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1870 function does not require the declaration to contain a brace block."
1874 (c-save-buffer-state nil
1875 ;; We try to be line oriented, unless there are several
1876 ;; declarations on the same line.
1877 (if (looking-at c-syntactic-eol
)
1878 (c-backward-token-2 1 nil
(c-point 'bol
)))
1879 (setq decl-limits
(c-declaration-limits t
)))
1881 (if (not decl-limits
)
1882 (error "Cannot find any declaration")
1883 (goto-char (car decl-limits
))
1884 (push-mark (cdr decl-limits
) nil t
))))
1886 (defun c-cpp-define-name ()
1887 "Return the name of the current CPP macro, or NIL if we're not in one."
1890 (and c-opt-cpp-macro-define-start
1891 (c-beginning-of-macro)
1892 (looking-at c-opt-cpp-macro-define-start
)
1893 (match-string-no-properties 1))))
1896 ;; Movement by statements.
1897 (defun c-in-comment-line-prefix-p ()
1898 ;; Point is within a comment. Is it also within a comment-prefix?
1899 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1901 ;; This function might do hidden buffer changes.
1902 (let ((here (point)))
1905 (skip-chars-forward " \t")
1906 (and (looking-at c-current-comment-prefix
)
1907 (/= (match-beginning 0) (match-end 0))
1908 (< here
(match-end 0))))))
1910 (defun c-narrow-to-comment-innards (range)
1911 ;; Narrow to the "inside" of the comment (block) defined by range, as
1914 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
1915 ;; present) removed. A c++-style line comment retains its opening "//" but
1916 ;; has any final NL removed. If POINT is currently outwith these innards,
1917 ;; move it to the appropriate boundary.
1919 ;; This narrowing simplifies the sentence movement functions, since it
1920 ;; eliminates awkward things at the boundaries of the comment (block).
1922 ;; This function might do hidden buffer changes.
1923 (let* ((lit-type (c-literal-type range
))
1924 (beg (if (eq lit-type
'c
) (+ (car range
) 2) (car range
)))
1925 (end (if (eq lit-type
'c
)
1926 (if (and (eq (char-before (cdr range
)) ?
/)
1927 (eq (char-before (1- (cdr range
))) ?
*))
1930 (if (eq (cdr range
) (point-max))
1932 (- (cdr range
) 1)))))
1934 (goto-char end
)) ; This would be done automatically by ...
1936 (goto-char beg
)) ; ... narrow-to-region but is not documented.
1937 (narrow-to-region beg end
)))
1939 (defun c-beginning-of-sentence-in-comment (range)
1940 ;; Move backwards to the "beginning of a sentence" within the comment
1941 ;; defined by RANGE, a cons of its starting and ending positions. If we
1942 ;; find a BOS, return NIL. Otherwise, move point to just before the start
1943 ;; of the comment and return T.
1945 ;; The BOS is either text which follows a regexp match of sentence-end,
1946 ;; or text which is a beginning of "paragraph".
1947 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
1949 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1950 ;; It is not a general function, but is intended only for calling from
1951 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
1953 ;; This function might do hidden buffer changes.
1955 (let ((start-point (point)))
1957 (c-narrow-to-comment-innards range
) ; This may move point back.
1958 (let* ((here (point))
1960 (here-filler ; matches WS and comment-prefices at point.
1961 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix
"\\)"
1962 "\\|[ \t\n\r\f]\\)*"))
1963 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
1964 (concat "^[ \t]*\\(" c-current-comment-prefix
"\\)[ \t\n\r\f]*\\="))
1965 ;; First, find the previous paragraph start, if any.
1966 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
1968 (forward-paragraph -
1) ; uses cc-mode values of
1969 ; paragraph-\(start\|separate\)
1970 (if (> (re-search-forward here-filler nil t
) here
)
1972 (when (>= (point) here
)
1973 (forward-paragraph -
2)
1974 (if (> (re-search-forward here-filler nil t
) here
)
1978 ;; Now seek successively earlier sentence ends between PAR-BEG and
1979 ;; HERE, until the "start of sentence" following it is earlier than
1980 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
1981 (while (and (re-search-backward (c-sentence-end) par-beg
'limit
)
1983 (goto-char (match-end 0)) ; tentative beginning of sentence
1984 (or (>= (point) here
)
1985 (and (not (bolp)) ; Found a non-blank comment-prefix?
1987 (if (re-search-backward prefix-at-bol-here nil t
)
1988 (/= (match-beginning 1) (match-end 1)))))
1989 (progn ; Skip the crud to find a real b-o-s.
1990 (if (c-in-comment-line-prefix-p)
1991 (beginning-of-line))
1992 (re-search-forward here-filler
) ; always succeeds.
1993 (>= (point) here
))))
1995 (re-search-forward here-filler
)))
1997 (if (< (point) start-point
)
1999 (goto-char (car range
))
2002 (defun c-end-of-sentence-in-comment (range)
2003 ;; Move forward to the "end of a sentence" within the comment defined by
2004 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2005 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2006 ;; return NIL. Otherwise, move point to just after the end of the comment
2009 ;; The EOS is just after the non-WS part of the next match of the regexp
2010 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2011 ;; no sentence-end match following point, any WS before the end of the
2012 ;; comment will count as EOS, providing we're not already in it.
2014 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2015 ;; It is not a general function, but is intended only for calling from
2016 ;; c-move-over-sentence.
2018 ;; This function might do hidden buffer changes.
2020 (let ((start-point (point))
2021 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2024 (c-narrow-to-comment-innards range
) ; This might move point forwards.
2025 (let* ((here (point))
2026 (par-end ; EOL position of last text in current/next paragraph.
2028 ;; The cc-mode values of paragraph-\(start\|separate\), set
2029 ;; in c-setup-paragraph-variables, are used in the
2031 (forward-paragraph 1)
2032 (if (eq (preceding-char) ?
\n) (forward-char -
1))
2033 (when (<= (point) here
) ; can happen, e.g., when HERE is at EOL.
2035 (forward-paragraph 2)
2036 (if (eq (preceding-char) ?
\n) (forward-char -
1)))
2041 (concat "^[ \t]*\\(" c-current-comment-prefix
"\\)\\=")))
2042 ;; Go forward one "comment-prefix which looks like sentence-end"
2043 ;; each time round the following:
2044 (while (and (re-search-forward (c-sentence-end) par-end
'limit
)
2047 (skip-chars-backward " \t\n")
2048 (or (and (not (bolp))
2049 (re-search-backward prefix-at-bol-here nil t
)
2050 (/= (match-beginning 1) (match-end 1)))
2051 (<= (point) here
))))
2054 ;; Take special action if we're up against the end of a comment (of
2055 ;; either sort): Leave point just after the last non-ws text.
2056 (if (eq (point) (point-max))
2057 (while (or (/= (skip-chars-backward " \t\n") 0)
2058 (and (re-search-backward prefix-at-bol-here nil t
)
2059 (/= (match-beginning 1) (match-end 1))))))))
2061 (if (> (point) start-point
)
2063 (goto-char (cdr range
))
2066 (defun c-beginning-of-sentence-in-string (range)
2067 ;; Move backwards to the "beginning of a sentence" within the string defined
2068 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2069 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2070 ;; just before the start of the string and return T.
2072 ;; The BOS is either the text which follows a regexp match of sentence-end
2073 ;; or text which is a beginning of "paragraph". For the purposes of
2074 ;; determining paragraph boundaries, escaped newlines are treated as
2075 ;; ordinary newlines.
2077 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2078 ;; It is not a general function, but is intended only for calling from
2079 ;; c-move-over-sentence.
2081 ;; This function might do hidden buffer changes.
2083 (let* ((here (point)) last
2084 (end (1- (cdr range
)))
2085 (here-filler ; matches WS and escaped newlines at point.
2086 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2087 ;; Enhance paragraph-start and paragraph-separate also to recognise
2088 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2089 ;; these values should be customizable user options, or something.
2090 (paragraph-start c-string-par-start
)
2091 (paragraph-separate c-string-par-separate
)
2093 (par-beg ; beginning of current (or previous) paragraph.
2096 (narrow-to-region (1+ (car range
)) end
)
2097 (forward-paragraph -
1) ; uses above values of
2098 ; paragraph-\(start\|separate\)
2099 (if (> (re-search-forward here-filler nil t
) here
)
2101 (when (>= (point) here
)
2102 (forward-paragraph -
2)
2103 (if (> (re-search-forward here-filler nil t
) here
)
2106 ;; Now see if we can find a sentence end after PAR-BEG.
2107 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg
'limit
)
2109 (goto-char (match-end 0))
2113 here-filler end t
) ; always succeeds. Use end rather
2114 ; than here, in case point starts
2115 ; beyond the closing quote.
2116 (>= (point) here
))))
2118 (re-search-forward here-filler here t
)
2119 (if (< (point) here
)
2121 (goto-char (car range
))
2124 (defun c-end-of-sentence-in-string (range)
2125 ;; Move forward to the "end of a sentence" within the string defined by
2126 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2127 ;; return NIL. Otherwise, move point to just after the end of the string
2130 ;; The EOS is just after the non-WS part of the next match of the regexp
2131 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2132 ;; no sentence-end match following point, any WS before the end of the
2133 ;; string will count as EOS, providing we're not already in it.
2135 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2136 ;; It is not a general function, but is intended only for calling from
2137 ;; c-move-over-sentence.
2139 ;; This function might do hidden buffer changes.
2141 (let* ((here (point))
2143 ;; Enhance paragraph-start and paragraph-separate to recognise
2144 ;; blank lines terminated by escaped EOLs.
2145 (paragraph-start c-string-par-start
)
2146 (paragraph-separate c-string-par-separate
)
2148 (par-end ; EOL position of last text in current/next paragraph.
2151 (narrow-to-region (car range
) (1- (cdr range
)))
2152 ;; The above values of paragraph-\(start\|separate\) are used
2153 ;; in the following.
2154 (forward-paragraph 1)
2156 ;; (re-search-backward filler-here nil t) would find an empty
2157 ;; string. Therefore we simulate it by the following:
2158 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2159 (re-search-backward "\\\\\\($\\)\\=" nil t
)))
2160 (unless (> (point) here
)
2162 (forward-paragraph 1)
2163 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2164 (re-search-backward "\\\\\\($\\)\\=" nil t
))))
2166 ;; Try to go forward a sentence.
2167 (when (re-search-forward c-sentence-end-with-esc-eol par-end
'limit
)
2169 (while (or (/= (skip-chars-backward " \t\n") 0)
2170 (re-search-backward "\\\\\\($\\)\\=" nil t
))))
2171 ;; Did we move a sentence, or did we hit the end of the string?
2172 (if (> (point) here
)
2174 (goto-char (cdr range
))
2177 (defun c-ascertain-preceding-literal ()
2178 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2179 ;; If a literal is the next thing (aside from whitespace) to be found before
2180 ;; point, return a cons of its start.end positions (enclosing the
2181 ;; delimiters). Otherwise return NIL.
2183 ;; This function might do hidden buffer changes.
2185 (c-collect-line-comments
2186 (let ((here (point))
2188 (if (c-backward-single-comment)
2189 (cons (point) (progn (c-forward-single-comment) (point)))
2191 ;; to prevent `looking-at' seeing a " at point.
2192 (narrow-to-region (point-min) here
)
2195 ;; An EOL can act as an "open string" terminator in AWK.
2196 (looking-at c-ws
*-string-limit-regexp
)
2198 (progn (backward-char)
2199 (looking-at c-string-limit-regexp
))))
2200 (goto-char (match-end 0)) ; just after the string terminator.
2202 (c-safe (c-backward-sexp 1) ; move back over the string.
2203 (cons (point) pos
)))))))))
2205 (defun c-ascertain-following-literal ()
2206 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2207 ;; If a literal is the next thing (aside from whitespace) following point,
2208 ;; return a cons of its start.end positions (enclosing the delimiters).
2209 ;; Otherwise return NIL.
2211 ;; This function might do hidden buffer changes.
2213 (c-collect-line-comments
2216 (if (looking-at c-string-limit-regexp
) ; string-delimiter.
2217 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2220 (if (c-forward-single-comment)
2221 (cons pos
(point))))))))
2223 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2224 ;; Does point immediately follow a statement "terminator"? A virtual
2225 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2227 ;; This function might do hidden buffer changes.
2230 (and (looking-at "[;{}]")
2231 (not (and c-special-brace-lists
; Pike special brace lists.
2232 (eq (char-after) ?
{)
2233 (c-looking-at-special-brace-list)))))
2235 ;; The following (for macros) is not strict about exactly where we are
2236 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2237 ;; much. ACM 2004/3/29.
2240 (if (c-beginning-of-macro)
2241 (setq eom
(progn (c-end-of-macro)
2245 (c-forward-comments)
2246 (>= (point) eom
))))))
2248 (defun c-back-over-illiterals (macro-start)
2249 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2250 ;; stopping before reaching BOB or a literal or the boundary of a
2251 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2252 ;; the position of the '#' beginning the current preprocessor directive, or
2253 ;; NIL if we're not in such.
2255 ;; Return a cons (A.B), where
2256 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2257 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2258 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2259 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2261 ;; The total collection of returned values is as follows:
2262 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2263 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2264 ;; a BOS - the caller must check this.
2265 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2266 ;; moved and reached the opening # of the macro.
2267 ;; (t . macro-boundary): Every other circumstance in which we're at a
2268 ;; macro-boundary. We might be at a BOS.
2270 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2271 ;; code before encountering the literal/BOB or macro-boundary.
2273 ;; Note that this function moves within either preprocessor commands
2274 ;; (macros) or normal code, but will not cross a boundary between the two,
2275 ;; or between two distinct preprocessor commands.
2277 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2278 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2279 ;; move into parens. Also stop before `#' when it's at boi on a line.
2281 ;; This function might do hidden buffer changes.
2283 (let ((here (point))
2284 last
) ; marks the position of non-ws code, what'll be BOS if, say, a
2285 ; semicolon precedes it.
2287 (while t
;; We go back one "token" each iteration of the loop.
2290 ;; Stop at the token after a comment.
2291 ((c-backward-single-comment) ; Also functions as backwards-ws.
2293 (throw 'done
'(t . literal
)))
2295 ;; If we've gone back over a LF, we might have moved into or out of
2296 ;; a preprocessor line.
2297 ((and (save-excursion
2299 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t
))
2301 (< (point) macro-start
)
2302 (c-beginning-of-macro)))
2304 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2305 (throw 'done
(cons (or (eq (point) here
)
2309 ;; Have we found a virtual semicolon? If so, stop, unless the next
2310 ;; statement is where we started from.
2311 ((and (c-at-vsemi-p)
2313 (not (memq (char-after last
) '(?\
) ?
})))) ; we've moved back from ) or }
2315 (throw 'done
'(nil . nil
)))
2317 ;; Hit the beginning of the buffer/region?
2321 (throw 'done
'(nil . nil
)))
2323 ;; Move back a character.
2324 ((progn (backward-char) nil
))
2326 ;; Stop at "{" (unless it's a PIKE special brace list.)
2327 ((eq (char-after) ?\
{)
2328 (if (and c-special-brace-lists
2329 (c-looking-at-special-brace-list))
2330 (skip-syntax-backward "w_") ; Speedup only.
2333 (throw 'done
'(nil . nil
))))
2335 ;; Have we reached the start of a macro? This always counts as
2336 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2337 ;; here. FIXME!!! ACM 2004/3/29)
2338 ((and macro-start
(eq (point) macro-start
))
2339 (throw 'done
(cons (eq (point) here
) 'macro-boundary
)))
2341 ;; Stop at token just after "}" or ";".
2342 ((looking-at "[;}]")
2343 ;; If we've gone back over ;, {, or }, we're done.
2344 (if (or (= here last
)
2345 (memq (char-after last
) '(?\
) ?
}))) ; we've moved back from ) or }
2346 (if (and (eq (char-before) ?
}) ; If };, treat them as a unit.
2347 (eq (char-after) ?\
;))
2349 (goto-char last
) ; To the statement starting after the ; or }.
2350 (throw 'done
'(nil . nil
))))
2352 ;; Stop at the token after a string.
2353 ((looking-at c-string-limit-regexp
) ; Just gone back over a string terminator?
2355 (throw 'done
'(t . literal
)))
2357 ;; Nothing special: go back word characters.
2358 (t (skip-syntax-backward "w_")) ; Speedup only.
2361 (defun c-forward-over-illiterals (macro-end allow-early-stop
)
2362 ;; Move forwards over code, stopping before reaching EOB or a literal
2363 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2364 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2365 ;; terminates the current preprocessor directive, or NIL if we're not in
2368 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2369 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2370 ;; seems unavoidable. Depending on the context this function is called
2371 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2372 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2373 ;; semicolons, or anything else.
2375 ;; Return a cons (A.B), where
2376 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2377 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2378 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2379 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2381 ;; Point is left either after the end-of-statement, or at the last non-ws
2382 ;; code before encountering the literal, or the # of the preprocessor
2383 ;; statement, or at EOB [or just after last non-WS stuff??].
2385 ;; As a clarification of "after the end-of-statement", if a comment or
2386 ;; whitespace follows a completed AWK statement, that statement is treated
2387 ;; as ending just after the last non-ws character before the comment.
2389 ;; Note that this function moves within either preprocessor commands
2390 ;; (macros) or normal code, but not both within the same invocation.
2392 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2393 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2394 ;; stop before `{' if at top level or inside braces, though. Move by
2395 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2398 ;; This function might do hidden buffer changes.
2399 (let ((here (point))
2402 (while t
;; We go one "token" forward each time round this loop.
2405 ;; If we've moved forward to a virtual semicolon, we're done.
2406 (if (and (> last here
) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2408 (throw 'done
'(nil . nil
)))
2412 ;; Gone past the end of a macro?
2413 ((and macro-end
(> (point) macro-end
))
2415 (throw 'done
(cons (eq (point) here
) 'macro-boundary
)))
2417 ;; About to hit a comment?
2418 ((save-excursion (c-forward-single-comment))
2420 (throw 'done
'(t . literal
)))
2426 (throw 'done
'(nil . nil
)))
2428 ;; If we encounter a '{', stop just after the previous token.
2429 ((and (eq (char-after) ?
{)
2430 (not (and c-special-brace-lists
2431 (c-looking-at-special-brace-list)))
2432 (or allow-early-stop
(/= here last
))
2433 (save-excursion ; Is this a check that we're NOT at top level?
2434 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2435 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2436 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2437 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2438 (or (not (c-safe (up-list -
1) t
))
2439 (= (char-after) ?
{))))
2441 (throw 'done
'(nil . nil
)))
2443 ;; End of a PIKE special brace list? If so, step over it and continue.
2444 ((and c-special-brace-lists
2445 (eq (char-after) ?
})
2447 (and (c-safe (up-list -
1) t
)
2448 (c-looking-at-special-brace-list))))
2450 (skip-syntax-forward "w_")) ; Speedup only.
2452 ;; Have we got a '}' after having moved? If so, stop after the
2454 ((and (eq (char-after) ?
})
2457 (throw 'done
'(nil . nil
)))
2459 ;; Stop if we encounter a preprocessor line.
2460 ((and (not macro-end
)
2461 (eq (char-after) ?
#)
2462 (= (point) (c-point 'boi
)))
2464 ;(throw 'done (cons (eq (point) here) 'macro-boundary))) ; Changed 2003/3/26
2465 (throw 'done
'(t . macro-boundary
)))
2467 ;; Stop after a ';', '}', or "};"
2468 ((looking-at ";\\|};?")
2469 (goto-char (match-end 0))
2470 (throw 'done
'(nil . nil
)))
2472 ;; Found a string (this subsumes AWK regexps)?
2473 ((looking-at c-string-limit-regexp
)
2475 (throw 'done
'(t . literal
)))
2478 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2479 (skip-syntax-forward "w_") ; Speedup only.
2480 (when (and macro-end
(> (point) macro-end
))
2482 (throw 'done
(cons (eq (point) here
) 'macro-boundary
))))
2485 (defun c-one-line-string-p (range)
2486 ;; Is the literal defined by RANGE a string contained in a single line?
2488 ;; This function might do hidden buffer changes.
2490 (goto-char (car range
))
2491 (and (looking-at c-string-limit-regexp
)
2492 (progn (skip-chars-forward "^\n" (cdr range
))
2493 (eq (point) (cdr range
))))))
2495 (defun c-beginning-of-statement (&optional count lim sentence-flag
)
2496 "Go to the beginning of the innermost C statement.
2497 With prefix arg, go back N - 1 statements. If already at the
2498 beginning of a statement then go to the beginning of the closest
2499 preceding one, moving into nested blocks if necessary (use
2500 \\[backward-sexp] to skip over a block). If within or next to a
2501 comment or multiline string, move by sentences instead of statements.
2503 When called from a program, this function takes 3 optional args: the
2504 repetition count, a buffer position limit which is the farthest back
2505 to search for the syntactic context, and a flag saying whether to do
2506 sentence motion in or near comments and multiline strings.
2508 Note that for use in programs, `c-beginning-of-statement-1' is
2509 usually better. It has much better defined semantics than this one,
2510 which is intended for interactive use, and might therefore change to
2511 be more \"DWIM:ey\"."
2512 (interactive (list (prefix-numeric-value current-prefix-arg
)
2515 (c-end-of-statement (- count
) lim sentence-flag
)
2516 (c-save-buffer-state
2517 ((count (or count
1))
2518 last
; start point for going back ONE chunk. Updated each chunk movement.
2520 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2521 res
; result from sub-function call
2522 not-bos
; "not beginning-of-statement"
2523 (range (c-collect-line-comments (c-literal-limits lim
)))) ; (start.end) of current literal or NIL
2525 ;; Go back one statement at each iteration of the following loop.
2526 (while (and (/= count
0)
2527 (or (not lim
) (> (point) lim
)))
2528 ;; Go back one "chunk" each time round the following loop, stopping
2529 ;; when we reach a statement boundary, etc.
2532 (cond ; Each arm of this cond returns NIL on reaching a desired
2533 ; statement boundary, non-NIL otherwise.
2538 (range ; point is within or approaching a literal.
2540 ;; Single line string or sentence-flag is null => skip the
2542 ((or (null sentence-flag
)
2543 (c-one-line-string-p range
))
2544 (goto-char (car range
))
2545 (setq range
(c-ascertain-preceding-literal))
2546 ;; N.B. The following is essentially testing for an AWK regexp
2548 ;; Was the previous non-ws thing an end of statement?
2551 (c-backward-comments)
2552 (c-backward-syntactic-ws))
2553 (not (or (bobp) (c-after-statement-terminator-p)))))
2555 ;; Comment inside a statement or a multi-line string.
2556 (t (when (setq res
; returns non-nil when we go out of the literal
2557 (if (eq (c-literal-type range
) 'string
)
2558 (c-beginning-of-sentence-in-string range
)
2559 (c-beginning-of-sentence-in-comment range
)))
2560 (setq range
(c-ascertain-preceding-literal)))
2563 ;; Non-literal code.
2564 (t (setq res
(c-back-over-illiterals macro-fence
))
2565 (setq not-bos
; "not reached beginning-of-statement".
2566 (or (= (point) last
)
2567 (memq (char-after) '(?\
) ?\
}))
2570 ;; We're at a tentative BOS. The next form goes
2571 ;; back over WS looking for an end of previous
2573 (not (save-excursion
2575 (c-backward-comments)
2576 (c-backward-syntactic-ws))
2577 (or (bobp) (c-after-statement-terminator-p)))))))
2578 ;; Are we about to move backwards into or out of a
2579 ;; preprocessor command? If so, locate it's beginning.
2580 (when (eq (cdr res
) 'macro-boundary
)
2585 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2587 ;; Are we about to move backwards into a literal?
2588 (when (memq (cdr res
) '(macro-boundary literal
))
2589 (setq range
(c-ascertain-preceding-literal)))
2591 (setq last
(point)))
2593 (if (/= count
0) (setq count
(1- count
))))
2594 (c-keep-region-active))))
2596 (defun c-end-of-statement (&optional count lim sentence-flag
)
2597 "Go to the end of the innermost C statement.
2598 With prefix arg, go forward N - 1 statements. Move forward to the end
2599 of the next statement if already at end, and move into nested blocks
2600 \(use \\[forward-sexp] to skip over a block). If within or next to a
2601 comment or multiline string, move by sentences instead of statements.
2603 When called from a program, this function takes 3 optional args: the
2604 repetition count, a buffer position limit which is the farthest back
2605 to search for the syntactic context, and a flag saying whether to do
2606 sentence motion in or near comments and multiline strings."
2607 (interactive (list (prefix-numeric-value current-prefix-arg
)
2609 (setq count
(or count
1))
2610 (if (< count
0) (c-beginning-of-statement (- count
) lim sentence-flag
)
2612 (c-save-buffer-state
2613 (here ; start point for going forward ONE statement. Updated each statement.
2616 (and (not (eobp)) (c-beginning-of-macro)
2617 (progn (c-end-of-macro) (point)))))
2619 (range (c-collect-line-comments (c-literal-limits lim
)))) ; (start.end) of current literal or NIL
2621 ;; Go back/forward one statement at each iteration of the following loop.
2622 (while (and (/= count
0)
2623 (or (not lim
) (< (point) lim
)))
2624 (setq here
(point)) ; ONLY HERE is HERE updated
2626 ;; Go forward one "chunk" each time round the following loop, stopping
2627 ;; when we reach a statement boundary, etc.
2629 (cond ; Each arm of this cond returns NIL on reaching a desired
2630 ; statement boundary, non-NIL otherwise.
2635 (range ; point is within a literal.
2637 ;; sentence-flag is null => skip the entire literal.
2638 ;; or a Single line string.
2639 ((or (null sentence-flag
)
2640 (c-one-line-string-p range
))
2641 (goto-char (cdr range
))
2642 (setq range
(c-ascertain-following-literal))
2643 ;; Is there a virtual semicolon here (e.g. for AWK)?
2644 (not (c-at-vsemi-p)))
2646 ;; Comment or multi-line string.
2647 (t (when (setq res
; gets non-nil when we go out of the literal
2648 (if (eq (c-literal-type range
) 'string
)
2649 (c-end-of-sentence-in-string range
)
2650 (c-end-of-sentence-in-comment range
)))
2651 (setq range
(c-ascertain-following-literal)))
2652 ;; If we've just come forward out of a literal, check for
2653 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2654 ;; some other language may do in the future)
2656 (not (c-at-vsemi-p))))))
2658 ;; Non-literal code.
2659 (t (setq res
(c-forward-over-illiterals macro-fence
2661 ;; Are we about to move forward into or out of a
2662 ;; preprocessor command?
2663 (when (eq (cdr res
) 'macro-boundary
)
2668 (progn (c-skip-ws-forward)
2669 (c-beginning-of-macro))
2670 (progn (c-end-of-macro)
2672 ;; Are we about to move forward into a literal?
2673 (when (memq (cdr res
) '(macro-boundary literal
))
2674 (setq range
(c-ascertain-following-literal)))
2677 (if (/= count
0) (setq count
(1- count
))))
2678 (c-keep-region-active))))
2681 ;; set up electric character functions to work with pending-del,
2682 ;; (a.k.a. delsel) mode. All symbols get the t value except
2683 ;; the functions which delete, which gets 'supersede.
2687 (put sym
'delete-selection t
) ; for delsel (Emacs)
2688 (put sym
'pending-delete t
))) ; for pending-del (XEmacs)
2693 c-electric-semi
&comma
2697 (put 'c-electric-delete
'delete-selection
'supersede
) ; delsel
2698 (put 'c-electric-delete
'pending-delete
'supersede
) ; pending-del
2699 (put 'c-electric-backspace
'delete-selection
'supersede
) ; delsel
2700 (put 'c-electric-backspace
'pending-delete
'supersede
) ; pending-del
2701 (put 'c-electric-delete-forward
'delete-selection
'supersede
) ; delsel
2702 (put 'c-electric-delete-forward
'pending-delete
'supersede
) ; pending-del
2705 ;; Inserting/indenting comments
2706 (defun c-calc-comment-indent (entry)
2707 ;; This function might do hidden buffer changes.
2709 (setq entry
(or (assq entry c-indent-comment-alist
)
2710 (assq 'other c-indent-comment-alist
)
2711 '(default .
(column . nil
)))))
2712 (let ((action (car (cdr entry
)))
2713 (value (cdr (cdr entry
)))
2714 (col (current-column)))
2715 (cond ((eq action
'space
)
2717 ((eq action
'column
)
2718 (unless value
(setq value comment-column
))
2720 ;; Do not pad with one space if we're at bol.
2722 (max (1+ col
) value
)))
2728 (let ((lim (c-literal-limits (c-point 'bol
) t
)))
2730 (goto-char (car lim
))
2731 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2732 ;; Found comment to align with.
2734 ;; Do not pad with one space if we're at bol.
2736 (max (1+ col
) (current-column))))))))
2737 ;; Recurse to handle value as a new spec.
2738 (c-calc-comment-indent (cdr entry
)))))))
2740 (defun c-comment-indent ()
2741 "Used by `indent-for-comment' to create and indent comments.
2742 See `c-indent-comment-alist' for a description."
2745 (c-save-buffer-state
2746 ((eot (let ((lim (c-literal-limits (c-point 'bol
) t
)))
2747 (or (when (consp lim
)
2748 (goto-char (car lim
))
2749 (when (looking-at "/[/*]")
2750 (skip-chars-backward " \t")
2753 (skip-chars-backward " \t")
2756 (cond ((looking-at "^/[/*]")
2758 ((progn (beginning-of-line)
2761 ((progn (back-to-indentation)
2762 (and (eq (char-after) ?
})
2763 (eq (point) (1- eot
))))
2765 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2766 (eq (match-end 0) eot
))
2770 (if (and (memq line-type
'(anchored-comment empty-line
))
2771 c-indent-comments-syntactically-p
)
2772 (let ((c-syntactic-context (c-guess-basic-syntax)))
2773 ;; BOGOSITY ALERT: if we're looking at the eol, its
2774 ;; because indent-for-comment hasn't put the comment-start
2775 ;; in the buffer yet. this will screw up the syntactic
2776 ;; analysis so we kludge in the necessary info. Another
2777 ;; kludge is that if we're at the bol, then we really want
2778 ;; to ignore any anchoring as specified by
2779 ;; c-comment-only-line-offset since it doesn't apply here.
2781 (c-add-syntax 'comment-intro
))
2782 (let ((c-comment-only-line-offset
2783 (if (consp c-comment-only-line-offset
)
2784 c-comment-only-line-offset
2785 (cons c-comment-only-line-offset
2786 c-comment-only-line-offset
))))
2787 (c-get-syntactic-indentation c-syntactic-context
)))
2789 (c-calc-comment-indent line-type
)))))
2792 ;; used by outline-minor-mode
2793 (defun c-outline-level ()
2794 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2795 ;; in otherwise-hidden text.
2797 (skip-chars-forward "\t ")
2801 ;; Movement by CPP conditionals.
2802 (defun c-up-conditional (count)
2803 "Move back to the containing preprocessor conditional, leaving mark behind.
2804 A prefix argument acts as a repeat count. With a negative argument,
2805 move forward to the end of the containing preprocessor conditional.
2807 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2808 function stops at them when going backward, but not when going
2811 (c-forward-conditional (- count
) -
1)
2812 (c-keep-region-active))
2814 (defun c-up-conditional-with-else (count)
2815 "Move back to the containing preprocessor conditional, including \"#else\".
2816 Just like `c-up-conditional', except it also stops at \"#else\"
2819 (c-forward-conditional (- count
) -
1 t
)
2820 (c-keep-region-active))
2822 (defun c-down-conditional (count)
2823 "Move forward into the next preprocessor conditional, leaving mark behind.
2824 A prefix argument acts as a repeat count. With a negative argument,
2825 move backward into the previous preprocessor conditional.
2827 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2828 function stops at them when going forward, but not when going
2831 (c-forward-conditional count
1)
2832 (c-keep-region-active))
2834 (defun c-down-conditional-with-else (count)
2835 "Move forward into the next preprocessor conditional, including \"#else\".
2836 Just like `c-down-conditional', except it also stops at \"#else\"
2839 (c-forward-conditional count
1 t
)
2840 (c-keep-region-active))
2842 (defun c-backward-conditional (count &optional target-depth with-else
)
2843 "Move back across a preprocessor conditional, leaving mark behind.
2844 A prefix argument acts as a repeat count. With a negative argument,
2845 move forward across a preprocessor conditional."
2847 (c-forward-conditional (- count
) target-depth with-else
)
2848 (c-keep-region-active))
2850 (defun c-forward-conditional (count &optional target-depth with-else
)
2851 "Move forward across a preprocessor conditional, leaving mark behind.
2852 A prefix argument acts as a repeat count. With a negative argument,
2853 move backward across a preprocessor conditional.
2855 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2856 the nesting level isn't changed when tracking subconditionals.
2858 The optional argument TARGET-DEPTH specifies the wanted nesting depth
2859 after each scan. I.e. if TARGET-DEPTH is -1, the function will move
2860 out of the enclosing conditional. A non-integer non-nil TARGET-DEPTH
2863 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
2864 are treated as conditional clause limits. Normally they are ignored."
2866 (let* ((forward (> count
0))
2867 (increment (if forward -
1 1))
2868 (search-function (if forward
're-search-forward
're-search-backward
))
2870 (unless (integerp target-depth
)
2871 (setq target-depth
(if target-depth -
1 0)))
2875 ;; subdepth is the depth in "uninteresting" subtrees,
2876 ;; i.e. those that takes us farther from the target
2877 ;; depth instead of closer.
2881 ;; Find the "next" significant line in the proper direction.
2882 (while (and (not found
)
2883 ;; Rather than searching for a # sign that
2884 ;; comes at the beginning of a line aside from
2885 ;; whitespace, search first for a string
2886 ;; starting with # sign. Then verify what
2887 ;; precedes it. This is faster on account of
2888 ;; the fastmap feature of the regexp matcher.
2889 (funcall search-function
2890 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
2893 ;; Now verify it is really a preproc line.
2894 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
2895 (let (dchange (directive (match-string 1)))
2896 (cond ((string= directive
"if")
2897 (setq dchange
(- increment
)))
2898 ((string= directive
"endif")
2899 (setq dchange increment
))
2901 ;; When we're not in an "uninteresting"
2902 ;; subtree, we might want to act on "elif"
2904 (if (cond (with-else
2905 ;; Always move toward the target depth.
2907 (if (> target-depth
0) 1 -
1)))
2908 ((string= directive
"elif")
2909 (setq dchange
(- increment
))))
2910 ;; Ignore the change if it'd take us
2911 ;; into an "uninteresting" subtree.
2912 (if (eq (> dchange
0) (<= target-depth
0))
2913 (setq dchange nil
)))))
2915 (when (or (/= subdepth
0)
2916 (eq (> dchange
0) (<= target-depth
0)))
2917 (setq subdepth
(+ subdepth dchange
)))
2918 (setq depth
(+ depth dchange
))
2919 ;; If we are trying to move across, and we find an
2920 ;; end before we find a beginning, get an error.
2921 (if (and (< depth target-depth
) (< dchange
0))
2923 "No following conditional at this level"
2924 "No previous conditional at this level"))))
2925 ;; When searching forward, start from next line so
2926 ;; that we don't find the same line again.
2927 (if forward
(forward-line 1))
2928 ;; We found something if we've arrived at the
2930 (if (and dchange
(= depth target-depth
))
2931 (setq found
(point))))
2933 (if forward
(forward-line 1)))))
2935 (error "No containing preprocessor conditional"))
2936 (goto-char (setq new found
)))
2937 (setq count
(+ count increment
))))
2940 (c-keep-region-active))
2943 ;; commands to indent lines, regions, defuns, and expressions
2944 (defun c-indent-command (&optional arg
)
2945 "Indent current line as C code, and/or insert some whitespace.
2947 If `c-tab-always-indent' is t, always just indent the current line.
2948 If nil, indent the current line only if point is at the left margin or
2949 in the line's indentation; otherwise insert some whitespace[*]. If
2950 other than nil or t, then some whitespace[*] is inserted only within
2951 literals (comments and strings), but the line is always reindented.
2953 If `c-syntactic-indentation' is t, indentation is done according to
2954 the syntactic context. A numeric argument, regardless of its value,
2955 means indent rigidly all the lines of the expression starting after
2956 point so that this line becomes properly indented. The relative
2957 indentation among the lines of the expression is preserved.
2959 If `c-syntactic-indentation' is nil, the line is just indented one
2960 step according to `c-basic-offset'. In this mode, a numeric argument
2961 indents a number of such steps, positive or negative, and an empty
2962 prefix argument is equivalent to -1.
2964 [*] The amount and kind of whitespace inserted is controlled by the
2965 variable `c-insert-tab-function', which is called to do the actual
2966 insertion of whitespace. Normally the function in this variable
2967 just inserts a tab character, or the equivalent number of spaces,
2968 depending on the variable `indent-tabs-mode'."
2971 (let ((indent-function
2972 (if c-syntactic-indentation
2973 (symbol-function 'indent-according-to-mode
)
2975 (let ((c-macro-start c-macro-start
)
2976 (steps (if (equal arg
'(4))
2978 (prefix-numeric-value arg
))))
2979 (c-shift-line-indentation (* steps c-basic-offset
))
2980 (when (and c-auto-align-backslashes
2983 (eq (char-before) ?
\\))
2984 (c-query-and-set-macro-start))
2985 ;; Realign the line continuation backslash if inside a macro.
2986 (c-backslash-region (point) (point) nil t
)))
2988 (if (and c-syntactic-indentation arg
)
2989 ;; If c-syntactic-indentation and got arg, always indent this
2990 ;; line as C and shift remaining lines of expression the same
2992 (let ((shift-amt (save-excursion
2993 (back-to-indentation)
2997 (setq shift-amt
(- (save-excursion
2998 (back-to-indentation)
3002 (if (eq c-tab-always-indent t
)
3003 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
3011 (indent-code-rigidly beg end shift-amt
"#")))
3012 ;; Else use c-tab-always-indent to determine behavior.
3014 ;; CASE 1: indent when at column zero or in line's indentation,
3015 ;; otherwise insert a tab
3016 ((not c-tab-always-indent
)
3018 (skip-chars-backward " \t")
3020 (funcall c-insert-tab-function
)
3021 (funcall indent-function
)))
3022 ;; CASE 2: just indent the line
3023 ((eq c-tab-always-indent t
)
3024 (funcall indent-function
))
3025 ;; CASE 3: if in a literal, insert a tab, but always indent the
3028 (if (c-save-buffer-state () (c-in-literal))
3029 (funcall c-insert-tab-function
))
3030 (funcall indent-function
)
3033 (defun c-indent-exp (&optional shutup-p
)
3034 "Indent each line in the balanced expression following point syntactically.
3035 If optional SHUTUP-P is non-nil, no errors are signaled if no
3036 balanced expression is found."
3038 (let ((here (point-marker))
3040 (set-marker-insertion-type here t
)
3042 (let ((start (save-restriction
3043 ;; Find the closest following open paren that
3044 ;; ends on another line.
3045 (narrow-to-region (point-min) (c-point 'eol
))
3046 (let (beg (end (point)))
3047 (while (and (setq beg
(c-down-list-forward end
))
3048 (setq end
(c-up-list-forward beg
))))
3050 (eq (char-syntax (char-before beg
)) ?\
()
3055 (error "Cannot find start of balanced expression to indent"))
3057 (setq end
(c-safe (scan-sexps (point) 1)))
3060 (error "Cannot find end of balanced expression to indent"))
3063 (c-indent-region (point) end
)))))
3065 (set-marker here nil
))))
3067 (defun c-indent-defun ()
3068 "Indent the current top-level declaration or macro syntactically.
3069 In the macro case this also has the effect of realigning any line
3070 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3072 (let ((here (point-marker)) decl-limits
)
3075 (c-save-buffer-state nil
3076 ;; We try to be line oriented, unless there are several
3077 ;; declarations on the same line.
3078 (if (looking-at c-syntactic-eol
)
3079 (c-backward-token-2 1 nil
(c-point 'bol
))
3080 (c-forward-token-2 0 nil
(c-point 'eol
)))
3081 (setq decl-limits
(c-declaration-limits nil
)))
3083 (c-indent-region (car decl-limits
)
3084 (cdr decl-limits
))))
3086 (set-marker here nil
))))
3088 (defun c-indent-region (start end
&optional quiet
)
3089 "Indent syntactically every line whose first char is between START
3090 and END inclusive. If the optional argument QUIET is non-nil then no
3091 syntactic errors are reported, even if `c-report-syntactic-errors' is
3095 (skip-chars-backward " \t\n\r\f\v")
3098 ;; Advance to first nonblank line.
3100 (skip-chars-forward " \t\n\r\f\v")
3101 (setq start
(point))
3103 (setq c-parsing-error
3104 (or (let ((endmark (copy-marker end
))
3105 (c-parsing-error nil
)
3106 ;; shut up any echo msgs on indiv lines
3107 (c-echo-syntactic-information-p nil
)
3108 (ml-macro-start ; Start pos of multi-line macro.
3109 (and (c-save-buffer-state ()
3110 (save-excursion (c-beginning-of-macro)))
3111 (eq (char-before (c-point 'eol
)) ?
\\)
3113 (c-fix-backslashes nil
)
3117 (c-progress-init start end
'c-indent-region
)
3119 (while (and (bolp) ;; One line each time round the loop.
3121 (< (point) endmark
))
3125 (unless (or (looking-at "\\s *$")
3126 (and ml-macro-start
(looking-at "\\s *\\\\$")))
3127 ;; Get syntax and indent.
3128 (c-save-buffer-state nil
3129 (setq syntax
(c-guess-basic-syntax)))
3130 (c-indent-line syntax t t
))
3133 ;; End of current multi-line macro?
3134 (when (and c-auto-align-backslashes
3135 (not (eq (char-before (c-point 'eol
)) ?
\\)))
3136 ;; Fixup macro backslashes.
3137 (c-backslash-region ml-macro-start
(c-point 'bonl
) nil
)
3138 (setq ml-macro-start nil
))
3139 ;; New multi-line macro?
3140 (if (and (assq 'cpp-macro syntax
)
3141 (eq (char-before (c-point 'eol
)) ?
\\))
3142 (setq ml-macro-start
(point))))
3146 (if (and ml-macro-start c-auto-align-backslashes
)
3147 (c-backslash-region ml-macro-start
(c-point 'bopl
) nil t
)))
3148 (set-marker endmark nil
)
3149 (c-progress-fini 'c-indent-region
))
3150 (c-echo-parsing-error quiet
))
3153 (defun c-fn-region-is-active-p ()
3154 ;; Function version of the macro for use in places that aren't
3155 ;; compiled, e.g. in the menus.
3156 (c-region-is-active-p))
3158 (defun c-indent-line-or-region (&optional arg region
)
3159 "Indent active region, current line, or block starting on this line.
3160 In Transient Mark mode, when the region is active, reindent the region.
3161 Otherwise, with a prefix argument, rigidly reindent the expression
3162 starting on the current line.
3163 Otherwise reindent just the current line."
3165 (list current-prefix-arg
(use-region-p)))
3167 (c-indent-region (region-beginning) (region-end))
3168 (c-indent-command arg
)))
3170 ;; for progress reporting
3171 (defvar c-progress-info nil
)
3173 (defun c-progress-init (start end context
)
3176 ((not c-progress-interval
))
3177 ;; Start the progress update messages. If this Emacs doesn't have
3178 ;; a built-in timer, just be dumb about it.
3179 ((not (fboundp 'current-time
))
3180 (message "Indenting region... (this may take a while)"))
3181 ;; If progress has already been initialized, do nothing. otherwise
3182 ;; initialize the counter with a vector of:
3183 ;; [start end lastsec context]
3185 (t (setq c-progress-info
(vector start
3189 (nth 1 (current-time))
3191 (message "Indenting region..."))
3194 (defun c-progress-update ()
3195 (if (not (and c-progress-info c-progress-interval
))
3197 (let ((now (nth 1 (current-time)))
3198 (start (aref c-progress-info
0))
3199 (end (aref c-progress-info
1))
3200 (lastsecs (aref c-progress-info
2)))
3201 ;; should we update? currently, update happens every 2 seconds,
3202 ;; what's the right value?
3203 (if (< c-progress-interval
(- now lastsecs
))
3205 (message "Indenting region... (%d%% complete)"
3206 (/ (* 100 (- (point) start
)) (- end start
)))
3207 (aset c-progress-info
2 now
)))
3210 (defun c-progress-fini (context)
3211 (if (not c-progress-interval
)
3213 (if (or (eq context
(aref c-progress-info
3))
3216 (set-marker (aref c-progress-info
1) nil
)
3217 (setq c-progress-info nil
)
3218 (message "Indenting region... done")))))
3222 ;;; This page handles insertion and removal of backslashes for C macros.
3224 (defun c-backslash-region (from to delete-flag
&optional line-mode
)
3225 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3226 With no argument, inserts backslashes and aligns existing backslashes.
3227 With an argument, deletes the backslashes. The backslash alignment is
3228 done according to the settings in `c-backslash-column',
3229 `c-backslash-max-column' and `c-auto-align-backslashes'.
3231 This function does not modify blank lines at the start of the region.
3232 If the region ends at the start of a line and the macro doesn't
3233 continue below it, the backslash (if any) at the end of the previous
3236 You can put the region around an entire macro definition and use this
3237 command to conveniently insert and align the necessary backslashes."
3238 (interactive "*r\nP")
3239 (let ((endmark (make-marker))
3240 ;; Keep the backslash trimming functions from changing the
3241 ;; whitespace around point, since in this case it's only the
3242 ;; position of point that tells the indentation of the line.
3243 (point-pos (if (save-excursion
3244 (skip-chars-backward " \t")
3245 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3248 column longest-line-col bs-col-after-end
)
3251 (if (and (not line-mode
) (bobp))
3252 ;; Nothing to do if to is at bob, since we should back up
3253 ;; and there's no line to back up to.
3255 (when (and (not line-mode
) (bolp))
3256 ;; Do not back up the to line if line-mode is set, to make
3257 ;; e.g. c-newline-and-indent consistent regardless whether
3258 ;; the (newline) call leaves point at bol or not.
3263 (set-marker endmark
(point))
3265 (c-delete-backslashes-forward endmark point-pos
))
3266 ;; Set bs-col-after-end to the column of any backslash
3267 ;; following the region, or nil if there is none.
3268 (setq bs-col-after-end
3269 (and (progn (end-of-line)
3270 (eq (char-before) ?
\\))
3271 (= (forward-line 1) 0)
3272 (progn (end-of-line)
3273 (eq (char-before) ?
\\))
3274 (1- (current-column))))
3276 ;; Back up the to line if line-mode is set, since the line
3277 ;; after the newly inserted line break should not be
3278 ;; touched in c-newline-and-indent.
3279 (setq to
(max from
(or (c-safe (c-point 'eopl
)) from
)))
3280 (unless bs-col-after-end
3281 ;; Set bs-col-after-end to non-nil in any case, since we
3282 ;; do not want to delete the backslash at the last line.
3283 (setq bs-col-after-end t
)))
3285 (not c-auto-align-backslashes
))
3287 ;; Compute the smallest column number past the ends of all
3289 (setq longest-line-col
0)
3291 (if bs-col-after-end
3292 ;; Include one more line in the max column
3293 ;; calculation, since the to line will be backslashed
3297 (while (and (>= (point) from
)
3299 (if (eq (char-before) ?
\\)
3301 (skip-chars-backward " \t")
3302 (setq longest-line-col
(max longest-line-col
3303 (1+ (current-column))))
3307 ;; Try to align with surrounding backslashes.
3310 (if (and (not (bobp))
3311 (progn (backward-char)
3312 (eq (char-before) ?
\\)))
3314 (setq column
(1- (current-column)))
3315 (if (numberp bs-col-after-end
)
3316 ;; Both a preceding and a following backslash.
3317 ;; Choose the greatest of them.
3318 (setq column
(max column bs-col-after-end
)))
3320 ;; No preceding backslash. Try to align with one
3321 ;; following the region. Disregard the backslash at the
3322 ;; to line since it's likely to be bogus (e.g. when
3323 ;; called from c-newline-and-indent).
3324 (if (numberp bs-col-after-end
)
3325 (setq column bs-col-after-end
))
3326 ;; Don't modify blank lines at start of region.
3328 (while (and (< (point) to
) (bolp) (eolp))
3330 (if (and column
(< column longest-line-col
))
3331 ;; Don't try to align with surrounding backslashes if
3332 ;; any line is too long.
3335 ;; Impose minimum limit and tab width alignment only if
3336 ;; we can't align with surrounding backslashes.
3337 (if (> (% longest-line-col tab-width
) 0)
3338 (setq longest-line-col
3339 (* (/ (+ longest-line-col tab-width -
1)
3342 (setq column
(max c-backslash-column
3344 ;; Always impose maximum limit.
3345 (setq column
(min column c-backslash-max-column
)))
3346 (if bs-col-after-end
3347 ;; Add backslashes on all lines if the macro continues
3348 ;; after the to line.
3350 (set-marker endmark to
)
3351 (c-append-backslashes-forward endmark column point-pos
))
3352 ;; Add backslashes on all lines except the last, and
3353 ;; remove any on the last line.
3358 (set-marker endmark
(1- (point)))))
3360 (c-append-backslashes-forward endmark column point-pos
)
3361 ;; The function above leaves point on the line
3362 ;; following endmark.
3363 (set-marker endmark
(point)))
3364 (set-marker endmark to
))
3365 (c-delete-backslashes-forward endmark point-pos
)))))
3366 (set-marker endmark nil
)
3367 (if (markerp point-pos
)
3368 (set-marker point-pos nil
))))
3370 (defun c-append-backslashes-forward (to-mark column point-pos
)
3371 (let ((state (parse-partial-sexp (c-point 'bol
) (point))))
3375 (<= (point) to-mark
)
3377 (let ((start (point)) (inserted nil
) end col
)
3379 (unless (eq (char-before) ?
\\)
3382 (setq state
(parse-partial-sexp
3383 start
(point) nil nil state
))
3385 (setq col
(current-column))
3387 ;; Avoid unnecessary changes of the buffer.
3388 (cond ((and (not inserted
) (nth 3 state
))
3389 ;; Don't realign backslashes in string literals
3390 ;; since that would change them.
3397 (skip-chars-backward
3398 " \t" (if (>= (point) point-pos
) point-pos
))
3402 ((and (= col column
)
3403 (memq (char-before) '(?\ ?
\t))))
3407 (or (/= (skip-chars-backward
3408 " \t" (if (>= (point) point-pos
) point-pos
))
3410 (/= (char-after) ?\
)))
3411 (delete-region (point) end
)
3412 (indent-to column
1)))
3414 (zerop (forward-line 1)))
3415 (bolp))) ; forward-line has funny behavior at eob.
3417 ;; Make sure there are backslashes with at least one space in
3421 (<= (point) to-mark
)
3423 (let ((start (point)))
3425 (setq state
(parse-partial-sexp
3426 start
(point) nil nil state
))
3428 (if (eq (char-before) ?
\\)
3429 (unless (nth 3 state
)
3431 (unless (and (memq (char-before) '(?\ ?
\t))
3432 (/= (point) point-pos
))
3435 (if (and (memq (char-before) '(?\ ?
\t))
3436 (/= (point) point-pos
))
3440 (zerop (forward-line 1)))
3441 (bolp)))))) ; forward-line has funny behavior at eob.
3443 (defun c-delete-backslashes-forward (to-mark point-pos
)
3445 (and (<= (point) to-mark
)
3448 (if (eq (char-before) ?
\\)
3451 (progn (backward-char)
3452 (skip-chars-backward " \t" (if (>= (point) point-pos
)
3455 (zerop (forward-line 1)))
3456 (bolp)))) ; forward-line has funny behavior at eob.
3460 ;;; Line breaking and paragraph filling.
3462 (defvar c-auto-fill-prefix t
)
3463 (defvar c-lit-limits nil
)
3464 (defvar c-lit-type nil
)
3466 ;; The filling code is based on a simple theory; leave the intricacies
3467 ;; of the text handling to the currently active mode for that
3468 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3469 ;; possible to make them work correctly wrt the comment and string
3470 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3471 ;; to it, there's quite a lot of special cases to handle which makes
3472 ;; the code anything but simple. The intention is that it will work
3473 ;; with any well-written text filling package that preserves a fill
3476 ;; We temporarily mask comment starters and enders as necessary for
3477 ;; the filling code to do its job on a seemingly normal text block.
3478 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3479 ;; preserve it correctly (especially important when filling C++ style
3480 ;; line comments). By default, we set up and use adaptive-fill-mode,
3481 ;; which is standard in all supported Emacs flavors.
3483 (defun c-guess-fill-prefix (lit-limits lit-type
)
3484 ;; Determine the appropriate comment fill prefix for a block or line
3485 ;; comment. Return a cons of the prefix string and the column where
3486 ;; it ends. If fill-prefix is set, it'll override. Note that this
3487 ;; function also uses the value of point in some heuristics.
3489 ;; This function might do hidden buffer changes.
3491 (let* ((here (point))
3492 (prefix-regexp (concat "[ \t]*\\("
3493 c-current-comment-prefix
3495 (comment-start-regexp (if (eq lit-type
'c
++)
3497 comment-start-skip
))
3498 prefix-line comment-prefix res comment-text-end
)
3502 (setq res
(cons fill-prefix
3503 ;; Ugly way of getting the column after the fill
3504 ;; prefix; it'd be nice with a current-column
3505 ;; that works on strings..
3506 (let ((start (point)))
3509 (insert-and-inherit "\n" fill-prefix
)
3511 (delete-region start
(point)))))))
3515 ;; Set fallback for comment-prefix if none is found.
3516 (setq comment-prefix
"// "
3517 comment-text-end
(cdr lit-limits
))
3520 (if (> (point) (car lit-limits
))
3521 ;; The current line is not the comment starter, so the
3522 ;; comment has more than one line, and it can therefore be
3523 ;; used to find the comment fill prefix.
3524 (setq prefix-line
(point))
3526 (goto-char (car lit-limits
))
3527 (if (and (= (forward-line 1) 0)
3528 (< (point) (cdr lit-limits
)))
3529 ;; The line after the comment starter is inside the
3530 ;; comment, so we can use it.
3531 (setq prefix-line
(point))
3533 ;; The comment is only one line. Take the comment prefix
3534 ;; from it and keep the indentation.
3535 (goto-char (car lit-limits
))
3536 (if (looking-at prefix-regexp
)
3537 (goto-char (match-end 0))
3539 (skip-chars-forward " \t"))
3542 (if (eq (c-point 'boi
) (car lit-limits
))
3543 ;; There is only whitespace before the comment
3544 ;; starter; take the prefix straight from this line.
3545 (setq str
(buffer-substring-no-properties
3546 (c-point 'bol
) (point))
3547 col
(current-column))
3549 ;; There is code before the comment starter, so we
3550 ;; have to temporarily insert and indent a new line to
3551 ;; get the right space/tab mix in the indentation.
3552 (let ((prefix-len (- (point) (car lit-limits
)))
3556 (goto-char (car lit-limits
))
3557 (indent-to (prog1 (current-column)
3560 (forward-char prefix-len
)
3561 (setq str
(buffer-substring-no-properties
3562 (c-point 'bol
) (point))
3563 col
(current-column)))
3564 (delete-region (car lit-limits
) tmp
))))
3567 (if (or (string-match "\\s \\'" str
) (not (eolp)))
3569 ;; The prefix ends the line with no whitespace
3570 ;; after it. Default to a single space.
3571 (cons (concat str
" ") (1+ col
))))
3575 (setq comment-text-end
3577 (goto-char (- (cdr lit-limits
) 2))
3578 (if (looking-at "\\*/") (point) (cdr lit-limits
))))
3582 (if (and (> (point) (car lit-limits
))
3583 (not (and (looking-at "[ \t]*\\*/")
3584 (eq (cdr lit-limits
) (match-end 0)))))
3585 ;; The current line is not the comment starter and
3586 ;; contains more than just the ender, so it's good enough
3587 ;; to be used for the comment fill prefix.
3588 (setq prefix-line
(point))
3589 (goto-char (car lit-limits
))
3591 (cond ((or (/= (forward-line 1) 0)
3592 (>= (point) (cdr lit-limits
))
3593 (and (looking-at "[ \t]*\\*/")
3594 (eq (cdr lit-limits
) (match-end 0)))
3595 (and (looking-at prefix-regexp
)
3596 (<= (1- (cdr lit-limits
)) (match-end 0))))
3597 ;; The comment is either one line or the next line contains
3598 ;; just the comment ender. In this case we have no
3599 ;; information about a suitable comment prefix, so we resort
3600 ;; to c-block-comment-prefix.
3601 (setq comment-prefix
(or c-block-comment-prefix
"")))
3604 ;; The point was on the comment opener line, so we might want
3605 ;; to treat this as a not yet closed comment.
3607 (if (and (match-beginning 1)
3608 (/= (match-beginning 1) (match-end 1)))
3609 ;; Above `prefix-regexp' matched a nonempty prefix on the
3610 ;; second line, so let's use it. Normally it should do
3611 ;; to set `prefix-line' and let the code below pick up
3612 ;; the whole prefix, but if there's no text after the
3613 ;; match then it will probably fall back to no prefix at
3614 ;; all if the comment isn't closed yet, so in that case
3615 ;; it's better to force use of the prefix matched now.
3616 (if (= (match-end 0) (c-point 'eol
))
3617 (setq comment-prefix
(match-string 1))
3618 (setq prefix-line
(point)))
3620 ;; There's no nonempty prefix on the line after the
3621 ;; comment opener. If the line is empty, or if the
3622 ;; text on it has less or equal indentation than the
3623 ;; comment starter we assume it's an unclosed
3624 ;; comment starter, i.e. that
3625 ;; `c-block-comment-prefix' should be used.
3626 ;; Otherwise we assume it's a closed comment where
3627 ;; the prefix really is the empty string.
3628 ;; E.g. this is an unclosed comment:
3639 ;; (Looking for the presence of the comment closer
3640 ;; rarely works since it's probably the closer of
3641 ;; some comment further down when the comment
3642 ;; really is unclosed.)
3643 (if (<= (save-excursion (back-to-indentation)
3645 (save-excursion (goto-char (car lit-limits
))
3647 (setq comment-prefix
(or c-block-comment-prefix
""))
3648 (setq prefix-line
(point)))))
3651 ;; Otherwise the line after the comment starter is good
3652 ;; enough to find the prefix in.
3653 (setq prefix-line
(point))))
3655 (when comment-prefix
3656 ;; Haven't got the comment prefix on any real line that we
3657 ;; can take it from, so we have to temporarily insert
3658 ;; `comment-prefix' on a line and indent it to find the
3659 ;; correct column and the correct mix of tabs and spaces.
3661 (let (tmp-pre tmp-post
)
3665 (goto-char (car lit-limits
))
3666 (if (looking-at comment-start-regexp
)
3667 (goto-char (min (match-end 0)
3670 (skip-chars-forward " \t"))
3672 (when (eq (char-syntax (char-before)) ?\
)
3673 ;; If there's ws on the current line, we'll use it
3674 ;; instead of what's ending comment-prefix.
3675 (setq comment-prefix
3676 (concat (substring comment-prefix
3680 (buffer-substring-no-properties
3682 (skip-chars-backward " \t")
3686 (setq tmp-pre
(point-marker))
3688 ;; We insert an extra non-whitespace character
3689 ;; before the line break and after comment-prefix in
3690 ;; case it's "" or ends with whitespace.
3691 (insert-and-inherit "x\n" comment-prefix
"x")
3692 (setq tmp-post
(point-marker))
3694 (indent-according-to-mode)
3696 (goto-char (1- tmp-post
))
3697 (cons (buffer-substring-no-properties
3698 (c-point 'bol
) (point))
3702 (delete-region tmp-pre tmp-post
)
3703 (set-marker tmp-pre nil
)
3704 (set-marker tmp-post nil
))))))))))
3706 (or res
; Found a good prefix above.
3709 ;; prefix-line is the bol of a line on which we should try
3710 ;; to find the prefix.
3711 (let* (fb-string fb-endpos
; Contains any fallback prefix found.
3714 (when (and (looking-at prefix-regexp
)
3715 (<= (match-end 0) comment-text-end
))
3716 (unless (eq (match-end 0) (c-point 'eol
))
3717 ;; The match is fine if there's text after it.
3718 (throw 'found
(cons (buffer-substring-no-properties
3719 (match-beginning 0) (match-end 0))
3720 (progn (goto-char (match-end 0))
3721 (current-column)))))
3723 ;; This match is better than nothing, so let's
3724 ;; remember it in case nothing better is found
3726 (setq fb-string
(buffer-substring-no-properties
3727 (match-beginning 0) (match-end 0))
3728 fb-endpos
(match-end 0)))
3732 ;; Search for a line which has text after the prefix
3733 ;; so that we get the proper amount of whitespace
3734 ;; after it. We start with the current line, then
3735 ;; search backwards, then forwards.
3737 (goto-char prefix-line
)
3738 (when (and (funcall test-line
)
3739 (or (/= (match-end 1) (match-end 0))
3740 ;; The whitespace is sucked up by the
3741 ;; first [ \t]* glob if the prefix is empty.
3742 (and (= (match-beginning 1) (match-end 1))
3743 (/= (match-beginning 0) (match-end 0)))))
3744 ;; If the current line doesn't have text but do
3745 ;; have whitespace after the prefix, we'll use it.
3746 (throw 'found
(cons fb-string
3747 (progn (goto-char fb-endpos
)
3748 (current-column)))))
3750 (if (eq lit-type
'c
++)
3751 ;; For line comments we can search up to and
3752 ;; including the first line.
3753 (while (and (zerop (forward-line -
1))
3754 (>= (point) (car lit-limits
)))
3755 (funcall test-line
))
3756 ;; For block comments we must stop before the
3758 (while (and (zerop (forward-line -
1))
3759 (> (point) (car lit-limits
)))
3760 (funcall test-line
)))
3762 (goto-char prefix-line
)
3763 (while (and (zerop (forward-line 1))
3764 (< (point) (cdr lit-limits
)))
3765 (funcall test-line
))
3767 (goto-char prefix-line
)
3771 ;; A good line wasn't found, but at least we have a
3772 ;; fallback that matches the comment prefix regexp.
3773 (cond ((or (string-match "\\s \\'" fb-string
)
3775 (goto-char fb-endpos
)
3777 ;; There are ws or text after the prefix, so
3779 (cons fb-string
(current-column)))
3782 ;; Check if there's any whitespace padding
3783 ;; on the comment start line that we can
3784 ;; use after the prefix.
3785 (goto-char (car lit-limits
))
3786 (if (looking-at comment-start-regexp
)
3787 (goto-char (match-end 0))
3789 (skip-chars-forward " \t"))
3791 (eq (char-syntax (char-before)) ?\
)))
3793 (setq fb-string
(buffer-substring-no-properties
3795 (skip-chars-backward " \t")
3798 (goto-char fb-endpos
)
3799 (skip-chars-backward " \t")
3801 (let ((tmp (point)))
3802 ;; Got to mess in the buffer once again to
3803 ;; ensure the column gets correct. :P
3806 (insert-and-inherit fb-string
)
3807 (cons (buffer-substring-no-properties
3811 (delete-region tmp
(point)))))
3814 ;; Last resort: Just add a single space after
3816 (cons (concat fb-string
" ")
3817 (progn (goto-char fb-endpos
)
3818 (1+ (current-column)))))))
3820 ;; The line doesn't match the comment prefix regexp.
3822 ;; We have a fallback for line comments that we must use.
3823 (cons (concat (buffer-substring-no-properties
3824 prefix-line
(c-point 'boi
))
3826 (progn (back-to-indentation)
3827 (+ (current-column) (length comment-prefix
))))
3829 ;; Assume we are dealing with a "free text" block
3830 ;; comment where the lines doesn't have any comment
3831 ;; prefix at all and we should just fill it as
3836 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun
&rest args
)
3837 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3838 ;; masked to allow adaptive filling to work correctly. That
3839 ;; includes narrowing the buffer and, if point is inside a comment,
3840 ;; masking the comment starter and ender appropriately.
3842 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3843 ;; The position of point is then less significant when doing masking
3846 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3847 ;; only if the point turns out to be inside a comment or a string.
3849 ;; Note that this function does not do any hidden buffer changes.
3852 ;; beg and end limit the region to narrow. end is a marker.
3854 ;; tmp-pre and tmp-post mark strings that are temporarily
3855 ;; inserted at the start and end of the region. tmp-pre is a
3856 ;; cons of the positions of the prepended string. tmp-post is
3857 ;; a marker pointing to the single character of the appended
3860 ;; If hang-ender-stuck isn't nil, the comment ender is
3861 ;; hanging. In that case it's set to the number of spaces
3862 ;; that should be between the text and the ender.
3864 ;; auto-fill-spaces is the exact sequence of whitespace between a
3865 ;; comment's last word and the comment ender, temporarily replaced
3866 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
3869 (c-lit-limits c-lit-limits
)
3870 (c-lit-type c-lit-type
))
3872 ;; Restore point on undo. It's necessary since we do a lot of
3873 ;; hidden inserts and deletes below that should be as transparent
3875 (if (and buffer-undo-list
(not (eq buffer-undo-list t
)))
3876 (setq buffer-undo-list
(cons (point) buffer-undo-list
)))
3878 ;; Determine the limits and type of the containing literal (if any):
3879 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
3881 (c-save-buffer-state ()
3883 ;; Widen to catch comment limits correctly.
3885 (unless c-lit-limits
3886 (setq c-lit-limits
(c-literal-limits nil fill-paragraph
)))
3887 (setq c-lit-limits
(c-collect-line-comments c-lit-limits
))
3889 (setq c-lit-type
(c-literal-type c-lit-limits
))))
3892 (unless (c-safe (backward-char)
3896 (forward-paragraph))
3897 (setq end
(point-marker)))
3899 (unless (c-safe (forward-char)
3900 (backward-paragraph)
3903 (backward-paragraph))
3904 (setq beg
(point))))
3908 ;; For each of the possible types of text (string, C comment ...)
3909 ;; determine BEG and END, the region we will narrow to. If we're in
3910 ;; a literal, constrain BEG and END to the limits of this literal.
3912 ;; For some of these text types, particularly a block comment, we
3913 ;; may need to massage whitespace near literal delimiters, so that
3914 ;; these don't get filled inappropriately.
3917 ((eq c-lit-type
'c
++) ; Line comment.
3919 ;; Limit to the comment or paragraph end, whichever
3921 (set-marker end
(min end
(cdr c-lit-limits
)))
3923 (when (<= beg
(car c-lit-limits
))
3924 ;; The region includes the comment starter, so we must
3926 (goto-char (car c-lit-limits
))
3927 (back-to-indentation)
3928 (if (eq (point) (car c-lit-limits
))
3929 ;; Include the first line in the region.
3930 (setq beg
(c-point 'bol
))
3931 ;; The first line contains code before the
3932 ;; comment. We must fake a line that doesn't.
3935 (setq apply-outside-literal t
))
3937 ((eq c-lit-type
'c
) ; Block comment.
3939 (or (> end
(cdr c-lit-limits
))
3940 (and (= end
(cdr c-lit-limits
))
3941 (eq (char-before end
) ?
/)
3942 (eq (char-before (1- end
)) ?
*)
3944 (> (- (cdr c-lit-limits
) (car c-lit-limits
)) 3)))
3945 ;; There is a comment ender, and the region includes it. If
3946 ;; it's on its own line, it stays on its own line. If it's got
3947 ;; company on the line, it keeps (at least one word of) it.
3948 ;; "=====*/" counts as a comment ender here, but "===== */"
3949 ;; doesn't and "foo*/" doesn't.
3952 (goto-char (cdr c-lit-limits
))
3954 ;; The following conjunct was added to avoid an
3955 ;; "Invalid search bound (wrong side of point)"
3956 ;; error in the subsequent re-search. Maybe
3957 ;; another fix would be needed (2007-12-08).
3958 (and (> (- (cdr c-lit-limits
) 2) (point))
3959 (search-forward-regexp
3960 (concat "\\=[ \t]*\\(" c-current-comment-prefix
"\\)")
3961 (- (cdr c-lit-limits
) 2) t
)
3962 (not (search-forward-regexp
3964 (- (cdr c-lit-limits
) 2) 'limit
))
3965 ;; The comment ender IS on its own line. Exclude
3966 ;; this line from the filling.
3967 (set-marker end
(c-point 'bol
))))
3969 ;; The comment ender is hanging. Replace all space between it
3970 ;; and the last word either by one or two 'x's (when
3971 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
3972 ;; as the whitespace (when auto filling), and include it in
3973 ;; the region. We'll change them back to whitespace
3974 ;; afterwards. The effect of this is to glue the comment
3975 ;; ender to the last word in the comment during filling.
3976 (let* ((ender-start (save-excursion
3977 (goto-char (cdr c-lit-limits
))
3978 (skip-syntax-backward "^w ")
3980 (ender-column (save-excursion
3981 (goto-char ender-start
)
3983 (point-rel (- ender-start here
))
3987 ;; Insert a CR after the "*/", adjust END
3988 (goto-char (cdr c-lit-limits
))
3989 (setq tmp-post
(point-marker))
3991 (set-marker end
(point))
3993 (forward-line -
1) ; last line of the comment
3994 (if (and (looking-at (concat "[ \t]*\\(\\("
3995 c-current-comment-prefix
3997 (eq ender-start
(match-end 0)))
3998 ;; The comment ender is prefixed by nothing but a
3999 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4000 ;; 2006/4/28). Remove it along with surrounding ws.
4001 (setq spaces
(- (match-end 1) (match-end 2)))
4002 (goto-char ender-start
))
4003 (skip-chars-backward " \t\r\n") ; Surely this can be
4004 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4006 ;; What's being tested here? 2006/4/20. FIXME!!!
4007 (if (/= (point) ender-start
)
4009 (if (<= here
(point))
4010 ;; Don't adjust point below if it's
4011 ;; before the string we replace.
4012 (setq point-rel -
1))
4013 ;; Keep one or two spaces between the
4014 ;; text and the ender, depending on how
4015 ;; many there are now.
4017 (setq spaces
(- ender-column
(current-column))))
4018 (setq auto-fill-spaces
(c-delete-and-extract-region
4019 (point) ender-start
))
4020 ;; paragraph filling condenses multiple spaces to
4021 ;; single or double spaces. auto-fill doesn't.
4026 (if sentence-end-double-space
2 1))
4028 ;; Insert the filler first to keep marks right.
4029 (insert-char ?x spaces t
)
4030 (setq hang-ender-stuck spaces
)
4032 (and (>= point-rel
0)
4033 (- (point) (min point-rel spaces
)))))
4034 (setq point-rel nil
)))
4037 ;; Point was in the middle of the string we
4038 ;; replaced above, so put it back in the same
4039 ;; relative position, counting from the end.
4040 (goto-char point-rel
)))
4043 (when (<= beg
(car c-lit-limits
))
4044 ;; The region includes the comment starter.
4046 (goto-char (car c-lit-limits
))
4047 (if (looking-at (concat "\\(" comment-start-skip
"\\)$"))
4048 ;; Begin with the next line.
4049 (setq beg
(c-point 'bonl
))
4050 ;; Fake the fill prefix in the first line.
4053 (setq apply-outside-literal t
))
4055 ((eq c-lit-type
'string
) ; String.
4057 (when (>= end
(cdr c-lit-limits
))
4058 (goto-char (1- (cdr c-lit-limits
)))
4059 (setq tmp-post
(point-marker))
4061 (set-marker end
(point)))
4062 (when (<= beg
(car c-lit-limits
))
4063 (goto-char (1+ (car c-lit-limits
)))
4064 (setq beg
(if (looking-at "\\\\$")
4065 ;; Leave the start line if it's
4066 ;; nothing but an escaped newline.
4069 (setq apply-outside-literal t
))
4071 ((eq c-lit-type
'pound
) ; Macro
4072 ;; Narrow to the macro limits if they are nearer than the
4073 ;; paragraph limits. Don't know if this is necessary but
4074 ;; do it for completeness sake (doing auto filling at all
4075 ;; inside macros is bogus to begin with since the line
4076 ;; continuation backslashes aren't handled).
4078 (c-save-buffer-state ()
4079 (c-beginning-of-macro)
4086 (set-marker end
(point))))))
4089 ;; Try to avoid comments and macros in the paragraph to
4090 ;; avoid that the adaptive fill mode gets the prefix from
4092 (c-save-buffer-state nil
4095 (c-forward-syntactic-ws end
)
4099 (c-backward-syntactic-ws beg
)
4101 (set-marker end
(point))))))
4104 ;; Temporarily insert the fill prefix after the comment
4105 ;; starter so that the first line looks like any other
4106 ;; comment line in the narrowed region.
4107 (setq fill
(c-save-buffer-state nil
4108 (c-guess-fill-prefix c-lit-limits c-lit-type
)))
4109 (unless (string-match (concat "\\`[ \t]*\\("
4110 c-current-comment-prefix
4113 ;; Oops, the prefix doesn't match the comment prefix
4114 ;; regexp. This could produce very confusing
4115 ;; results with adaptive fill packages together with
4116 ;; the insert prefix magic below, since the prefix
4117 ;; often doesn't appear at all. So let's warn about
4120 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4122 ;; Find the right spot on the line, break it, insert
4123 ;; the fill prefix and make sure we're back in the
4124 ;; same column by temporarily prefixing the first word
4125 ;; with a number of 'x'.
4127 (goto-char (car c-lit-limits
))
4128 (if (looking-at (if (eq c-lit-type
'c
++)
4129 c-current-comment-prefix
4130 comment-start-skip
))
4131 (goto-char (match-end 0))
4133 (skip-chars-forward " \t"))
4134 (while (and (< (current-column) (cdr fill
))
4137 (let ((col (current-column)))
4138 (setq beg
(1+ (point))
4139 tmp-pre
(list (point)))
4142 (insert-and-inherit "\n" (car fill
))
4143 (insert-char ?x
(- col
(current-column)) t
))
4144 (setcdr tmp-pre
(point))))))
4146 (when apply-outside-literal
4147 ;; `apply-outside-literal' is always set to t here if
4148 ;; we're inside a literal.
4152 ;; Kludge: If the function that adapts the fill prefix
4153 ;; doesn't produce the required comment starter for
4154 ;; line comments, then force it by setting fill-prefix.
4155 (when (and (eq c-lit-type
'c
++)
4156 ;; Kludge the kludge: filladapt-mode doesn't
4157 ;; have this problem, but it currently
4158 ;; doesn't override fill-context-prefix
4160 (not (and (boundp 'filladapt-mode
)
4164 (or (fill-context-prefix beg end
)
4166 (c-save-buffer-state nil
4167 (car (or fill
(c-guess-fill-prefix
4168 c-lit-limits c-lit-type
)))))))
4170 ;; Save the relative position of point if it's outside the
4171 ;; region we're going to narrow. Want to restore it in that
4172 ;; case, but otherwise it should be moved according to the
4174 (point-rel (cond ((< (point) beg
) (- (point) beg
))
4175 ((> (point) end
) (- (point) end
)))))
4177 ;; Preparations finally done! Now we can call the
4181 (narrow-to-region beg end
)
4184 ;; Restore point if it was outside the region.
4186 (goto-char (+ beg point-rel
))
4187 (goto-char (+ end point-rel
))))))))
4189 (when (consp tmp-pre
)
4190 (delete-region (car tmp-pre
) (cdr tmp-pre
)))
4194 (goto-char tmp-post
)
4196 (when hang-ender-stuck
4197 ;; Preserve point even if it's in the middle of the string
4198 ;; we replace; save-excursion doesn't work in that case.
4200 (goto-char tmp-post
)
4201 (skip-syntax-backward "^w ")
4202 (forward-char (- hang-ender-stuck
))
4203 (if (or fill-paragraph
(not auto-fill-spaces
))
4204 (insert-char ?\ hang-ender-stuck t
)
4205 (insert auto-fill-spaces
))
4206 (delete-char hang-ender-stuck
)
4208 (set-marker tmp-post nil
))
4210 (set-marker end nil
))))
4212 (defun c-fill-paragraph (&optional arg
)
4213 "Like \\[fill-paragraph] but handles C and C++ style comments.
4214 If any of the current line is a comment or within a comment, fill the
4215 comment or the paragraph of it that point is in, preserving the
4216 comment indentation or line-starting decorations (see the
4217 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4220 If point is inside multiline string literal, fill it. This currently
4221 does not respect escaped newlines, except for the special case when it
4222 is the very first thing in the string. The intended use for this rule
4223 is in situations like the following:
4225 char description[] = \"\\
4226 A very long description of something that you want to fill to make
4227 nicely formatted output.\"\;
4229 If point is in any other situation, i.e. in normal code, do nothing.
4231 Optional prefix ARG means justify paragraph as well."
4233 (let ((fill-paragraph-function
4234 ;; Avoid infinite recursion.
4235 (if (not (eq fill-paragraph-function
'c-fill-paragraph
))
4236 fill-paragraph-function
)))
4237 (c-mask-paragraph t nil
'fill-paragraph arg
))
4238 ;; Always return t. This has the effect that if filling isn't done
4239 ;; above, it isn't done at all, and it's therefore effectively
4240 ;; disabled in normal code.
4243 (defun c-do-auto-fill ()
4244 ;; Do automatic filling if not inside a context where it should be
4246 (let ((c-auto-fill-prefix
4247 ;; The decision whether the line should be broken is actually
4248 ;; done in c-indent-new-comment-line, which do-auto-fill
4249 ;; calls to break lines. We just set this special variable
4250 ;; so that we'll know when we're called from there. It's
4251 ;; also used to detect whether fill-prefix is user set or
4252 ;; generated automatically by do-auto-fill.
4254 (c-mask-paragraph nil t
'do-auto-fill
)))
4256 (defun c-indent-new-comment-line (&optional soft allow-auto-fill
)
4257 "Break line at point and indent, continuing comment or macro if within one.
4258 If inside a comment and `comment-multi-line' is non-nil, the
4259 indentation and line prefix are preserved (see the
4260 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4261 details). If inside a single line comment and `comment-multi-line' is
4262 nil, a new comment of the same type is started on the next line and
4263 indented as appropriate for comments. If inside a macro, a line
4264 continuation backslash is inserted and aligned as appropriate, and the
4265 new line is indented according to `c-syntactic-indentation'.
4267 If a fill prefix is specified, it overrides all the above."
4268 ;; allow-auto-fill is used from c-context-line-break to allow auto
4269 ;; filling to break the line more than once. Since this function is
4270 ;; used from auto-fill itself, that's normally disabled to avoid
4271 ;; unnecessary recursion.
4273 (let ((fill-prefix fill-prefix
)
4276 (delete-horizontal-space)
4278 (insert-and-inherit ?
\n)
4279 (newline (if allow-auto-fill nil
1)))))
4280 ;; Already know the literal type and limits when called from
4281 ;; c-context-line-break.
4282 (c-lit-limits c-lit-limits
)
4283 (c-lit-type c-lit-type
)
4284 (c-macro-start c-macro-start
))
4286 (c-save-buffer-state ()
4287 (when (not (eq c-auto-fill-prefix t
))
4288 ;; Called from do-auto-fill.
4289 (unless c-lit-limits
4290 (setq c-lit-limits
(c-literal-limits nil nil t
)))
4292 (setq c-lit-type
(c-literal-type c-lit-limits
)))
4293 (if (memq (cond ((c-query-and-set-macro-start) 'cpp
)
4294 ((null c-lit-type
) 'code
)
4297 (setq fill-prefix t
) ; Used as flag in the cond.
4298 (if (and (null c-auto-fill-prefix
)
4300 (<= (c-point 'bol
) (car c-lit-limits
)))
4301 ;; The adaptive fill function has generated a prefix, but
4302 ;; we're on the first line in a block comment so it'll be
4303 ;; wrong. Ignore it to guess a better one below.
4304 (setq fill-prefix nil
)
4305 (when (and (eq c-lit-type
'c
++)
4306 (not (string-match (concat "\\`[ \t]*"
4307 c-line-comment-starter
)
4308 (or fill-prefix
""))))
4309 ;; Kludge: If the function that adapted the fill prefix
4310 ;; doesn't produce the required comment starter for line
4311 ;; comments, then we ignore it.
4312 (setq fill-prefix nil
)))
4315 (cond ((eq fill-prefix t
)
4316 ;; A call from do-auto-fill which should be ignored.
4319 ;; A fill-prefix overrides anything.
4320 (funcall do-line-break
)
4321 (insert-and-inherit fill-prefix
))
4322 ((c-save-buffer-state ()
4323 (unless c-lit-limits
4324 (setq c-lit-limits
(c-literal-limits)))
4326 (setq c-lit-type
(c-literal-type c-lit-limits
)))
4327 (memq c-lit-type
'(c c
++)))
4328 ;; Some sort of comment.
4329 (if (or comment-multi-line
4331 (goto-char (car c-lit-limits
))
4333 (< (point) (cdr c-lit-limits
))))
4334 ;; Inside a comment that should be continued.
4335 (let ((fill (c-save-buffer-state nil
4336 (c-guess-fill-prefix
4338 (c-collect-line-comments c-lit-limits
))
4341 (start-col (current-column))
4343 (or (and (eq c-lit-type
'c
)
4345 (goto-char (- (cdr c-lit-limits
) 2))
4346 (if (looking-at "\\*/") (point))))
4347 (cdr c-lit-limits
))))
4348 ;; Skip forward past the fill prefix in case
4349 ;; we're standing in it.
4351 ;; FIXME: This doesn't work well in cases like
4353 ;; /* Bla bla bla bla bla
4356 ;; If point is on the 'B' then the line will be
4357 ;; broken after "Bla b".
4359 ;; If we have an empty comment, /* */, the next
4360 ;; lot of code pushes point to the */. We fix
4361 ;; this by never allowing point to end up to the
4362 ;; right of where it started.
4363 (while (and (< (current-column) (cdr fill
))
4366 (if (and (> (point) comment-text-end
)
4367 (> (c-point 'bol
) (car c-lit-limits
)))
4369 ;; The skip takes us out of the (block)
4370 ;; comment; insert the fill prefix at bol
4371 ;; instead and keep the position.
4372 (setq pos
(copy-marker pos t
))
4374 (insert-and-inherit (car fill
))
4375 (if soft
(insert-and-inherit ?
\n) (newline 1))
4377 (set-marker pos nil
))
4378 ;; Don't break in the middle of a comment starter
4380 (cond ((> (point) comment-text-end
)
4381 (goto-char comment-text-end
))
4382 ((< (point) (+ (car c-lit-limits
) 2))
4383 (goto-char (+ (car c-lit-limits
) 2))))
4384 (funcall do-line-break
)
4385 (insert-and-inherit (car fill
))
4386 (if (> (current-column) start-col
)
4387 (move-to-column start-col
)))) ; can this hit the
4389 ;; Inside a comment that should be broken.
4390 (let ((comment-start comment-start
)
4391 (comment-end comment-end
)
4393 (if (eq c-lit-type
'c
)
4394 (unless (string-match "[ \t]*/\\*" comment-start
)
4395 (setq comment-start
"/* " comment-end
" */"))
4396 (unless (string-match "[ \t]*//" comment-start
)
4397 (setq comment-start
"// " comment-end
"")))
4398 (setq col
(save-excursion
4399 (back-to-indentation)
4401 (funcall do-line-break
)
4402 (when (and comment-end
(not (equal comment-end
"")))
4404 (insert-and-inherit comment-end
)
4406 ;; c-comment-indent may look at the current
4407 ;; indentation, so let's start out with the same
4408 ;; indentation as the previous one.
4410 (insert-and-inherit comment-start
)
4411 (indent-for-comment))))
4412 ((c-query-and-set-macro-start)
4414 (unless (looking-at "[ \t]*\\\\$")
4415 ;; Do not clobber the alignment of the line continuation
4416 ;; slash; c-backslash-region might look at it.
4417 (delete-horizontal-space))
4418 ;; Got an asymmetry here: In normal code this command
4419 ;; doesn't indent the next line syntactically, and otoh a
4420 ;; normal syntactically indenting newline doesn't continue
4422 (c-newline-and-indent (if allow-auto-fill nil
1)))
4424 ;; Somewhere else in the code.
4425 (let ((col (save-excursion
4427 (while (and (looking-at "[ \t]*\\\\?$")
4428 (= (forward-line -
1) 0)))
4429 (current-indentation))))
4430 (funcall do-line-break
)
4431 (indent-to col
))))))
4433 (defalias 'c-comment-line-break-function
'c-indent-new-comment-line
)
4434 (make-obsolete 'c-comment-line-break-function
'c-indent-new-comment-line
)
4436 ;; advice for indent-new-comment-line for older Emacsen
4437 (unless (boundp 'comment-line-break-function
)
4438 (defvar c-inside-line-break-advice nil
)
4439 (defadvice indent-new-comment-line
(around c-line-break-advice
4440 activate preactivate
)
4441 "Call `c-indent-new-comment-line' if in CC Mode."
4442 (if (or c-inside-line-break-advice
4443 (not c-buffer-is-cc-mode
))
4445 (let ((c-inside-line-break-advice t
))
4446 (c-indent-new-comment-line (ad-get-arg 0))))))
4448 (defun c-context-line-break ()
4449 "Do a line break suitable to the context.
4451 When point is outside a comment or macro, insert a newline and indent
4452 according to the syntactic context, unless `c-syntactic-indentation'
4453 is nil, in which case the new line is indented as the previous
4454 non-empty line instead.
4456 When point is inside the content of a preprocessor directive, a line
4457 continuation backslash is inserted before the line break and aligned
4458 appropriately. The end of the cpp directive doesn't count as inside
4461 When point is inside a comment, continue it with the appropriate
4462 comment prefix (see the `c-comment-prefix-regexp' and
4463 `c-block-comment-prefix' variables for details). The end of a
4464 C++-style line comment doesn't count as inside it.
4466 When point is inside a string, only insert a backslash when it is also
4467 inside a preprocessor directive."
4470 (let* (c-lit-limits c-lit-type
4471 (c-macro-start c-macro-start
))
4473 (c-save-buffer-state ()
4474 (setq c-lit-limits
(c-literal-limits nil nil t
)
4475 c-lit-type
(c-literal-type c-lit-limits
))
4476 (when (eq c-lit-type
'c
++)
4477 (setq c-lit-limits
(c-collect-line-comments c-lit-limits
)))
4478 (c-query-and-set-macro-start))
4481 ((or (eq c-lit-type
'c
)
4482 (and (eq c-lit-type
'c
++) ; C++ comment, but not at the very end of it.
4484 (skip-chars-forward " \t")
4486 (1- (cdr c-lit-limits
))))
4487 (and (numberp c-macro-start
) ; Macro, but not at the very end of
4488 ; it, not in a string, and not in the
4490 (not (eq c-lit-type
'string
))
4491 (or (not (looking-at "\\s *$"))
4492 (eq (char-before) ?
\\))
4494 (goto-char c-macro-start
)
4495 (if (looking-at c-opt-cpp-start
)
4496 (goto-char (match-end 0)))
4499 (let ((comment-multi-line t
)
4501 (c-indent-new-comment-line nil t
)))
4503 ((eq c-lit-type
'string
)
4504 (if (and (numberp c-macro-start
)
4505 (not (eq (char-before) ?
\\)))
4509 (t (delete-horizontal-space)
4511 ;; c-indent-line may look at the current indentation, so let's
4512 ;; start out with the same indentation as the previous line.
4513 (let ((col (save-excursion
4516 (while (and (looking-at "[ \t]*\\\\?$")
4517 (= (forward-line -
1) 0)))
4518 (current-indentation))))
4520 (indent-according-to-mode)))))
4522 (defun c-context-open-line ()
4523 "Insert a line break suitable to the context and leave point before it.
4524 This is the `c-context-line-break' equivalent to `open-line', which is
4525 normally bound to C-o. See `c-context-line-break' for the details."
4527 (let ((here (point)))
4530 ;; Temporarily insert a non-whitespace char to keep any
4531 ;; preceding whitespace intact.
4533 (c-context-line-break))
4538 (cc-provide 'cc-cmds
)
4540 ;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
4541 ;;; cc-cmds.el ends here