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, 2010, 2011
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 ;; Keywords: c languages
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.
54 ;; Indentation / Display syntax functions
55 (defvar c-fix-backslashes t)
57 (defun c-indent-line (&optional syntax quiet ignore-point-pos)
58 "Indent the current line according to the syntactic context,
59 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
60 syntactic information for the current line. Be silent about syntactic
61 errors if the optional argument QUIET is non-nil, even if
62 `c-report-syntactic-errors' is non-nil. Normally the position of
63 point is used to decide where the old indentation is on a lines that
64 is otherwise empty \(ignoring any line continuation backslash), but
65 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
66 indentation change \(in columns)."
68 (let ((line-cont-backslash (save-excursion
70 (eq (char-before) ?\\)))
71 (c-fix-backslashes c-fix-backslashes)
74 (when (and (not ignore-point-pos)
77 (looking-at (if line-cont-backslash
78 ;; Don't use "\\s " - ^L doesn't count as WS
82 (<= (point) (match-end 1)))
83 ;; Delete all whitespace after point if there's only whitespace
84 ;; on the line, so that any code that does back-to-indentation
85 ;; or similar gets the current column in this case. If this
86 ;; removes a line continuation backslash it'll be restored
88 (unless c-auto-align-backslashes
89 ;; Should try to keep the backslash alignment
92 (goto-char (match-end 0))
93 (setq bs-col (1- (current-column)))))
94 (delete-region (point) (match-end 0))
95 (setq c-fix-backslashes t))
96 (if c-syntactic-indentation
98 (or (let ((c-parsing-error nil)
101 (and (boundp 'c-syntactic-context)
102 c-syntactic-context))))
103 (c-save-buffer-state (indent)
104 (unless c-syntactic-context
105 (setq c-syntactic-context (c-guess-basic-syntax)))
106 (setq indent (c-get-syntactic-indentation
107 c-syntactic-context))
108 (and (not (c-echo-parsing-error quiet))
109 c-echo-syntactic-information-p
110 (message "syntax: %s, indent: %d"
111 c-syntactic-context indent))
112 (setq shift-amt (- indent (current-indentation))))
113 (c-shift-line-indentation shift-amt)
114 (run-hooks 'c-special-indent-hook)
119 (while (and (= (forward-line -1) 0)
120 (if (looking-at "\\s *\\\\?$")
122 (setq indent (current-indentation))
124 (setq shift-amt (- indent (current-indentation)))
125 (c-shift-line-indentation shift-amt)))
126 (when (and c-fix-backslashes line-cont-backslash)
131 (when c-auto-align-backslashes
132 ;; Realign the line continuation backslash.
133 (c-backslash-region (point) (point) nil t))))
136 (defun c-newline-and-indent (&optional newline-arg)
137 "Insert a newline and indent the new line.
138 This function fixes line continuation backslashes if inside a macro,
139 and takes care to set the indentation before calling
140 `indent-according-to-mode', so that lineup functions like
141 `c-lineup-dont-change' works better."
143 ;; TODO: Backslashes before eol in comments and literals aren't
145 (let ((c-macro-start (c-query-macro-start))
146 ;; Avoid calling c-backslash-region from c-indent-line if it's
147 ;; called during the newline call, which can happen due to
148 ;; c-electric-continued-statement, for example. We also don't
149 ;; want any backslash alignment from indent-according-to-mode.
150 (c-fix-backslashes nil)
151 has-backslash insert-backslash
156 (while (and (looking-at "[ \t]*\\\\?$")
157 (= (forward-line -1) 0)))
158 (setq col (current-indentation)))
160 (if (and (eolp) (eq (char-before) ?\\))
161 (setq insert-backslash t
163 (setq has-backslash (eq (char-before (c-point 'eol)) ?\\))))
164 (newline newline-arg)
169 ;; The backslash stayed on the previous line. Insert one
170 ;; before calling c-backslash-region, so that
171 ;; bs-col-after-end in it works better. Fixup the
172 ;; backslashes on the newly inserted line.
175 (c-backslash-region (point) (point) nil t))
176 ;; The backslash moved to the new line, if there was any. Let
177 ;; c-backslash-region fix a backslash on the previous line,
178 ;; and the one that might be on the new line.
179 ;; c-auto-align-backslashes is intentionally ignored here;
180 ;; maybe the moved backslash should be left alone if it's set,
181 ;; but we fix both lines on the grounds that the old backslash
182 ;; has been moved anyway and is now in a different context.
183 (c-backslash-region start (if has-backslash (point) start) nil t)))
184 (when c-syntactic-indentation
185 ;; Reindent syntactically. The indentation done above is not
186 ;; wasted, since c-indent-line might look at the current
188 (let ((c-syntactic-context (c-save-buffer-state nil
189 (c-guess-basic-syntax))))
190 ;; We temporarily insert another line break, so that the
191 ;; lineup functions will see the line as empty. That makes
192 ;; e.g. c-lineup-cpp-define more intuitive since it then
193 ;; proceeds to the preceding line in this case.
195 (delete-horizontal-space)
196 (setq start (- (point-max) (point)))
200 (indent-according-to-mode))
201 (goto-char (- (point-max) start))
204 ;; Must align the backslash again after reindentation. The
205 ;; c-backslash-region call above can't be optimized to ignore
206 ;; this line, since it then won't align correctly with the
207 ;; lines below if the first line in the macro is broken.
208 (c-backslash-region (point) (point) nil t)))))
210 (defun c-show-syntactic-information (arg)
211 "Show syntactic information for current line.
212 With universal argument, inserts the analysis as a comment on that line."
214 (let* ((c-parsing-error nil)
215 (syntax (if (boundp 'c-syntactic-context)
216 ;; Use `c-syntactic-context' in the same way as
217 ;; `c-indent-line', to be consistent.
219 (c-save-buffer-state nil
220 (c-guess-basic-syntax)))))
221 (if (not (consp arg))
223 (message "Syntactic analysis: %s" syntax)
227 (setq elem (pop syntax))
228 (when (setq pos (c-langelem-pos elem))
229 (push (c-put-overlay pos (1+ pos)
232 (when (setq pos (c-langelem-2nd-pos elem))
233 (push (c-put-overlay pos (1+ pos)
234 'face 'secondary-selection)
238 (c-delete-overlay (pop ols)))))
240 (insert-and-inherit (format "%s" syntax))
242 (c-keep-region-active))
244 (defun c-syntactic-information-on-region (from to)
245 "Insert a comment with the syntactic analysis on every line in the region."
249 (narrow-to-region from to)
250 (goto-char (point-min))
252 (c-show-syntactic-information '(0))
256 ;; Minor mode functions.
257 (defun c-update-modeline ()
258 (let ((fmt (format "/%s%s%s%s"
259 (if c-electric-flag "l" "")
260 (if (and c-electric-flag c-auto-newline)
262 (if c-hungry-delete-key "h" "")
264 ;; subword might not be loaded.
265 (boundp 'subword-mode)
266 (symbol-value 'subword-mode))
269 ;; FIXME: Derived modes might want to use something else
270 ;; than a string for `mode-name'.
271 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name)
272 (match-string 1 mode-name)
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 "22.1")
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 found-delim)
1093 (self-insert-command (prefix-numeric-value arg))
1094 (setq final-pos (point))
1096 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1097 ;;;; property on the new < or > and its mate (if any) when they are template
1098 ;;;; parens. This is now done in an after-change function.
1100 ;; Indent the line if appropriate.
1101 (when (and c-electric-flag c-syntactic-indentation c-recognize-<>-arglists)
1103 (if (eq last-command-event ?<)
1104 ;; If a <, basically see if it's got "template" before it .....
1108 (progn (c-beginning-of-current-token) (point))))
1110 (c-backward-token-2)
1111 (looking-at c-opt-<>-sexp-key)))
1112 ;; ..... or is a C++ << operator.
1113 (and (c-major-mode-is 'c++-mode)
1115 (goto-char (1- final-pos))
1116 (c-beginning-of-current-token)
1118 (>= (match-end 0) final-pos)))
1120 ;; It's a >. Either a C++ >> operator. ......
1121 (or (and (c-major-mode-is 'c++-mode)
1123 (goto-char (1- final-pos))
1124 (c-beginning-of-current-token)
1126 (>= (match-end 0) final-pos))
1127 ;; ...., or search back for a < which isn't already marked as an
1128 ;; opening template delimiter.
1131 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1133 (narrow-to-region (point-min) final-pos)
1134 (goto-char final-pos)
1138 (c-syntactic-skip-backward "^<;}" nil t)
1139 (eq (char-before) ?<))
1142 (looking-at "\\s\("))))
1143 (and (eq (char-after) ?<)
1144 (not (looking-at "\\s\("))
1145 (progn (c-backward-syntactic-ws)
1146 (c-simple-skip-symbol-backward))
1147 (or (looking-at c-opt-<>-sexp-key)
1148 (not (looking-at c-keywords-regexp)))))))))
1150 (goto-char final-pos)
1152 (indent-according-to-mode)
1153 (when (and (eq (char-before) ?>)
1154 (not executing-kbd-macro)
1155 blink-paren-function)
1156 ;; Note: Most paren blink functions, such as the standard
1157 ;; `blink-matching-open', currently doesn't handle paren chars
1158 ;; marked with text properties very well. Maybe we should avoid
1159 ;; this call for the time being?
1160 (funcall blink-paren-function)))))
1162 (defun c-electric-paren (arg)
1163 "Insert a parenthesis.
1165 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1166 line is reindented unless a numeric ARG is supplied, or the parenthesis
1167 is inserted inside a literal.
1169 Whitespace between a function name and the parenthesis may get added or
1170 removed; see the variable `c-cleanup-list'.
1172 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1173 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1175 (let ((literal (c-save-buffer-state () (c-in-literal)))
1177 (c-echo-syntactic-information-p nil))
1178 (self-insert-command (prefix-numeric-value arg))
1180 (if (and (not arg) (not literal))
1181 (let* ( ;; We want to inhibit blinking the paren since this will
1182 ;; be most disruptive. We'll blink it ourselves
1184 (old-blink-paren blink-paren-function)
1185 blink-paren-function)
1186 (if (and c-syntactic-indentation c-electric-flag)
1187 (indent-according-to-mode))
1189 ;; If we're at EOL, check for new-line clean-ups.
1190 (when (and c-electric-flag c-auto-newline
1191 (looking-at "[ \t]*\\\\?$"))
1193 ;; clean up brace-elseif-brace
1195 (and (memq 'brace-elseif-brace c-cleanup-list)
1196 (eq last-command-event ?\()
1199 "\\([ \t\n]\\|\\\\\n\\)*"
1201 "\\([ \t\n]\\|\\\\\n\\)+"
1203 "\\([ \t\n]\\|\\\\\n\\)*"
1207 (not (c-save-buffer-state () (c-in-literal))))
1208 (delete-region (match-beginning 0) (match-end 0))
1209 (insert-and-inherit "} else if ("))
1211 ;; clean up brace-catch-brace
1213 (and (memq 'brace-catch-brace c-cleanup-list)
1214 (eq last-command-event ?\()
1217 "\\([ \t\n]\\|\\\\\n\\)*"
1219 "\\([ \t\n]\\|\\\\\n\\)*"
1223 (not (c-save-buffer-state () (c-in-literal))))
1224 (delete-region (match-beginning 0) (match-end 0))
1225 (insert-and-inherit "} catch (")))
1227 ;; Check for clean-ups at function calls. These two DON'T need
1228 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1229 ;; Point is currently just after the inserted paren.
1230 (let (beg (end (1- (point))))
1233 ;; space-before-funcall clean-up?
1234 ((and (memq 'space-before-funcall c-cleanup-list)
1235 (eq last-command-event ?\()
1238 (skip-chars-backward " \t")
1240 (and (c-save-buffer-state () (c-on-identifier))
1241 ;; Don't add a space into #define FOO()....
1242 (not (and (c-beginning-of-macro)
1243 (c-forward-over-cpp-define-id)
1244 (eq (point) beg))))))
1246 (delete-region beg end)
1250 ;; compact-empty-funcall clean-up?
1251 ((c-save-buffer-state ()
1252 (and (memq 'compact-empty-funcall c-cleanup-list)
1253 (eq last-command-event ?\))
1255 (c-safe (backward-char 2))
1256 (when (looking-at "()")
1258 (skip-chars-backward " \t")
1260 (c-on-identifier)))))
1261 (delete-region beg end))))
1262 (and (eq last-input-event ?\))
1263 (not executing-kbd-macro)
1265 (funcall old-blink-paren))))))
1267 (defun c-electric-continued-statement ()
1268 "Reindent the current line if appropriate.
1270 This function is used to reindent the line after a keyword which
1271 continues an earlier statement is typed, e.g. an \"else\" or the
1272 \"while\" in a do-while block.
1274 The line is reindented if there is nothing but whitespace before the
1275 keyword on the line, the keyword is not inserted inside a literal, and
1276 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1277 (let (;; shut this up
1278 (c-echo-syntactic-information-p nil))
1279 (when (c-save-buffer-state ()
1280 (and c-electric-flag
1281 c-syntactic-indentation
1282 (not (eq last-command-event ?_))
1284 (skip-syntax-backward "w")
1287 (not (c-in-literal (c-point 'bod)))))
1288 ;; Have to temporarily insert a space so that
1289 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1290 ;; space with a nonspace to avoid messing up any whitespace
1291 ;; sensitive meddling that might be done, e.g. by
1292 ;; `c-backslash-region'.
1293 (insert-and-inherit " x")
1295 (indent-according-to-mode)
1296 (delete-char -2)))))
1300 (declare-function subword-forward "subword" (&optional arg))
1301 (declare-function subword-backward "subword" (&optional arg))
1303 ;; "nomenclature" functions + c-scope-operator.
1304 (defun c-forward-into-nomenclature (&optional arg)
1305 "Compatibility alias for `c-forward-subword'."
1308 (subword-forward arg))
1309 (make-obsolete 'c-forward-into-nomenclature 'subword-forward "23.2")
1311 (defun c-backward-into-nomenclature (&optional arg)
1312 "Compatibility alias for `c-backward-subword'."
1315 (subword-backward arg))
1316 (make-obsolete 'c-backward-into-nomenclature 'subword-backward "23.2")
1318 (defun c-scope-operator ()
1319 "Insert a double colon scope operator at point.
1320 No indentation or other \"electric\" behavior is performed."
1322 (insert-and-inherit "::"))
1325 ;; Movement (etc.) by defuns.
1326 (defun c-in-function-trailer-p (&optional lim)
1327 ;; Return non-nil if point is between the closing brace and the semicolon of
1328 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1329 ;; portion of a declaration like "struct foo {...} bar ;".
1331 ;; Return the position of the main declaration. Otherwise, return nil.
1332 ;; Point is assumed to be at the top level and outside of any macro or
1335 ;; If LIM is non-nil, it is the bound on a the backward search for the
1336 ;; beginning of the declaration.
1338 ;; This function might do hidden buffer changes.
1339 (and c-opt-block-decls-with-vars-key
1341 (c-syntactic-skip-backward "^;}" lim)
1342 (let ((eo-block (point))
1344 (and (eq (char-before) ?\})
1345 (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1347 ;; Look for struct or union or ... If we find one, it might
1348 ;; be the return type of a function, or the like. Exclude
1350 (c-syntactic-re-search-forward
1351 (concat "[;=\(\[{]\\|\\("
1352 c-opt-block-decls-with-vars-key
1355 (match-beginning 1) ; Is there a "struct" etc., somewhere?
1356 (not (eq (char-before) ?_))
1357 (c-syntactic-re-search-forward "[;=\(\[{]" eo-block t t t)
1358 (eq (char-before) ?\{)
1361 (defun c-where-wrt-brace-construct ()
1362 ;; Determine where we are with respect to functions (or other brace
1363 ;; constructs, included in the term "function" in the rest of this comment).
1364 ;; Point is assumed to be outside any macro or literal.
1365 ;; This is used by c-\(begining\|end\)-of-defun.
1367 ;; Return one of these symbols:
1368 ;; at-header : we're at the start of a function's header.
1369 ;; in-header : we're inside a function's header, this extending right
1370 ;; up to the brace. This bit includes any k&r declarations.
1371 ;; in-block : we're inside a function's brace block.
1372 ;; in-trailer : we're in the area between the "}" and ";" of something
1373 ;; like "struct foo {...} bar, baz;".
1374 ;; at-function-end : we're just after the closing brace (or semicolon) that
1375 ;; terminates the function.
1376 ;; outwith-function: we're not at or in any function. Being inside a
1377 ;; non-brace construct also counts as 'outwith-function'.
1379 ;; This function might do hidden buffer changes.
1382 decl-result brace-decl-p
1384 (paren-state (c-parse-state))
1385 (least-enclosing (c-least-enclosing-brace paren-state)))
1388 ((and least-enclosing
1389 (eq (char-after least-enclosing) ?\{))
1391 ((c-in-function-trailer-p)
1393 ((and (not least-enclosing)
1395 (consp (car paren-state))
1396 (eq start (cdar paren-state)))
1399 ;; Find the start of the current declaration. NOTE: If we're in the
1400 ;; variables after a "struct/eval" type block, we don't get to the
1401 ;; real declaration here - we detect and correct for this later.
1403 ;;If we're in the parameters' parens, move back out of them.
1404 (if least-enclosing (goto-char least-enclosing))
1405 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1406 ;; at a declaration.
1407 (if (or (and (eolp) (not (eobp))) ; EOL is matched by "\\s>"
1409 "\\([;#]\\|\\'\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s$\\|\\s<\\|\\s>\\|\\s!\\)")))
1411 (setq kluge-start (point))
1413 (car (c-beginning-of-decl-1
1414 ;; NOTE: If we're in a K&R region, this might be the start
1415 ;; of a parameter declaration, not the actual function.
1416 (and least-enclosing ; LIMIT for c-b-of-decl-1
1417 (c-safe-position least-enclosing paren-state)))))
1419 ;; Has the declaration we've gone back to got braces?
1422 (and (c-syntactic-re-search-forward "[;{]" nil t t)
1423 (or (eq (char-before) ?\{)
1424 (and c-recognize-knr-p
1425 ;; Might have stopped on the
1426 ;; ';' in a K&R argdecl. In
1427 ;; that case the declaration
1428 ;; should contain a block.
1429 (c-in-knr-argdecl))))))
1432 ((= (point) kluge-start) ; might be BOB or unbalanced parens.
1434 ((eq decl-result 'same)
1436 (if (eq (point) start)
1440 ((eq decl-result 'previous)
1441 (if (and (not brace-decl-p)
1442 (c-in-function-trailer-p))
1446 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1449 (defun c-backward-to-nth-BOF-{ (n where)
1450 ;; Skip to the opening brace of the Nth function before point. If
1451 ;; point is inside a function, this counts as the first. Point must be
1452 ;; outside any comment/string or macro.
1454 ;; N must be strictly positive.
1455 ;; WHERE describes the position of point, one of the symbols `at-header',
1456 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1457 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1459 ;; If we run out of functions, leave point at BOB. Return zero on success,
1460 ;; otherwise the number of {s still to go.
1462 ;; This function may do hidden buffer changes
1464 ;; What we do to go back the first defun depends on where we start.
1466 ((eq where 'in-block)
1467 (goto-char (c-least-enclosing-brace (c-parse-state)))
1469 ((eq where 'in-header)
1470 (c-syntactic-re-search-forward "{")
1473 ((memq where '(at-header outwith-function at-function-end in-trailer))
1474 (c-syntactic-skip-backward "^}")
1475 (when (eq (char-before) ?\})
1478 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where)))
1480 ;; Each time round the loop, go back to a "{" at the outermost level.
1481 (while (and (> n 0) (not (bobp)))
1482 (c-parse-state) ; This call speeds up the following one
1483 ; by a factor of ~6. Hmmm. 2006/4/5.
1484 (c-syntactic-skip-backward "^}")
1485 (when (eq (char-before) ?\})
1490 (defun c-beginning-of-defun (&optional arg)
1491 "Move backward to the beginning of a defun.
1492 Every top level declaration that contains a brace paren block is
1493 considered to be a defun.
1495 With a positive argument, move backward that many defuns. A negative
1496 argument -N means move forward to the Nth following beginning. Return
1497 t unless search stops due to beginning or end of buffer.
1499 Unlike the built-in `beginning-of-defun' this tries to be smarter
1500 about finding the char with open-parenthesis syntax that starts the
1504 (or arg (setq arg 1))
1506 (or (not (eq this-command 'c-beginning-of-defun))
1507 (eq last-command 'c-beginning-of-defun)
1508 (and transient-mark-mode mark-active)
1511 (c-save-buffer-state
1512 (beginning-of-defun-function end-of-defun-function
1514 where paren-state pos)
1516 ;; Move back out of any macro/comment/string we happen to be in.
1517 (c-beginning-of-macro)
1518 (setq pos (c-literal-limits))
1519 (if pos (goto-char (car pos)))
1521 (setq where (c-where-wrt-brace-construct))
1524 ;; Move forward to the closing brace of a function.
1526 (if (memq where '(at-function-end outwith-function))
1527 (setq arg (1+ arg)))
1529 (setq arg (c-forward-to-nth-EOF-} (- arg) where)))
1530 ;; Move forward to the next opening brace....
1531 (when (and (= arg 0)
1532 (c-syntactic-re-search-forward "{" nil 'eob))
1534 ;; ... and backward to the function header.
1535 (c-beginning-of-decl-1)
1538 ;; Move backward to the opening brace of a function.
1539 (when (and (> arg 0)
1540 (eq (setq arg (c-backward-to-nth-BOF-{ arg where)) 0))
1542 ;; Go backward to this function's header.
1543 (c-beginning-of-decl-1)
1546 ;; We're now there, modulo comments and whitespace.
1547 ;; Try to be line oriented; position point at the closest
1548 ;; preceding boi that isn't inside a comment, but if we hit
1549 ;; the previous declaration then we use the current point
1551 (while (and (/= (point) (c-point 'boi))
1552 (c-backward-single-comment)))
1553 (if (/= (point) (c-point 'boi))
1556 (c-keep-region-active)
1559 (defun c-forward-to-nth-EOF-} (n where)
1560 ;; Skip to the closing brace of the Nth function after point. If
1561 ;; point is inside a function, this counts as the first. Point must be
1562 ;; outside any comment/string or macro.
1564 ;; N must be strictly positive.
1565 ;; WHERE describes the position of point, one of the symbols `at-header',
1566 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1567 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1569 ;; If we run out of functions, leave point at EOB. Return zero on success,
1570 ;; otherwise the number of }s still to go.
1572 ;; This function may do hidden buffer changes.
1575 ;; What we do to go forward over the first defun depends on where we
1576 ;; start. We go to the closing brace of that defun, even when we go
1577 ;; backwards to it (in a "struct foo {...} bar ;").
1579 ((eq where 'in-block)
1580 (goto-char (c-least-enclosing-brace (c-parse-state)))
1583 ((eq where 'in-trailer)
1584 (c-syntactic-skip-backward "^}")
1586 ((memq where '(at-function-end outwith-function at-header in-header))
1587 (when (c-syntactic-re-search-forward "{" nil 'eob)
1591 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1593 ;; Each time round the loop, go forward to a "}" at the outermost level.
1594 (while (and (> n 0) (not (eobp)))
1595 ;(c-parse-state) ; This call speeds up the following one by a factor
1596 ; of ~6. Hmmm. 2006/4/5.
1597 (when (c-syntactic-re-search-forward "{" nil 'eob)
1603 (defun c-end-of-defun (&optional arg)
1604 "Move forward to the end of a top level declaration.
1605 With argument, do it that many times. Negative argument -N means move
1606 back to Nth preceding end. Returns t unless search stops due to
1607 beginning or end of buffer.
1609 An end of a defun occurs right after the close-parenthesis that matches
1610 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1612 (or arg (setq arg 1))
1614 (or (not (eq this-command 'c-end-of-defun))
1615 (eq last-command 'c-end-of-defun)
1616 (and transient-mark-mode mark-active)
1619 (c-save-buffer-state
1620 (beginning-of-defun-function end-of-defun-function
1622 where paren-state pos)
1624 ;; Move back out of any macro/comment/string we happen to be in.
1625 (c-beginning-of-macro)
1626 (setq pos (c-literal-limits))
1627 (if pos (goto-char (car pos)))
1629 (setq where (c-where-wrt-brace-construct))
1632 ;; Move backwards to the } of a function
1634 (if (memq where '(at-header outwith-function))
1635 (setq arg (1+ arg)))
1637 (setq arg (c-backward-to-nth-BOF-{ (- arg) where)))
1639 (c-syntactic-skip-backward "^}")))
1641 ;; Move forward to the } of a function
1643 (setq arg (c-forward-to-nth-EOF-} arg where))))
1645 ;; Do we need to move forward from the brace to the semicolon?
1647 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1648 (c-syntactic-re-search-forward ";"))
1651 ;; We're there now, modulo comments and whitespace.
1652 ;; Try to be line oriented; position point after the next
1653 ;; newline that isn't inside a comment, but if we hit the
1654 ;; next declaration then we use the current point instead.
1655 (while (and (not (bolp))
1656 (not (looking-at "\\s *$"))
1657 (c-forward-single-comment)))
1659 ((looking-at "\\s *$")
1664 (c-keep-region-active)
1667 (defun c-defun-name ()
1668 "Return the name of the current defun, or NIL if there isn't one.
1669 \"Defun\" here means a function, or other top level construct
1670 with a brace block."
1672 (c-save-buffer-state
1673 (beginning-of-defun-function end-of-defun-function
1679 ;; Move back out of any macro/comment/string we happen to be in.
1680 (c-beginning-of-macro)
1681 (setq pos (c-literal-limits))
1682 (if pos (goto-char (car pos)))
1684 (setq where (c-where-wrt-brace-construct))
1686 ;; Move to the beginning of the current defun, if any, if we're not
1688 (if (eq where 'outwith-function)
1690 (unless (eq where 'at-header)
1691 (c-backward-to-nth-BOF-{ 1 where)
1692 (c-beginning-of-decl-1))
1694 ;; Pick out the defun name, according to the type of defun.
1696 ;; struct, union, enum, or similar:
1697 ((and (looking-at c-type-prefix-key)
1698 (progn (c-forward-token-2 2) ; over "struct foo "
1699 (or (eq (char-after) ?\{)
1700 (looking-at c-symbol-key)))) ; "struct foo bar ..."
1701 (save-match-data (c-forward-token-2))
1702 (when (eq (char-after) ?\{)
1703 (c-backward-token-2)
1704 (looking-at c-symbol-key))
1705 (match-string-no-properties 0))
1707 ((looking-at "DEFUN\\_>")
1708 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1709 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1711 (c-forward-syntactic-ws)
1712 (when (eq (char-after) ?\")
1714 (c-forward-token-2)) ; over the comma and following WS.
1715 (buffer-substring-no-properties
1719 (when (looking-at ":") ; CLISP: DEFUN(PACKAGE:LISP-SYMBOL,...)
1720 (skip-chars-forward "^,"))
1721 (c-backward-syntactic-ws)
1724 ((looking-at "DEF[a-zA-Z0-9_]* *( *\\([^, ]*\\) *,")
1725 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1726 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1727 (match-string-no-properties 1))
1730 ;; Normal function or initializer.
1731 (when (c-syntactic-re-search-forward "[{(]" nil t)
1733 (c-backward-syntactic-ws)
1734 (when (eq (char-before) ?\=) ; struct foo bar = {0, 0} ;
1735 (c-backward-token-2)
1736 (c-backward-syntactic-ws))
1737 (setq name-end (point))
1738 (c-backward-token-2)
1739 (buffer-substring-no-properties (point) name-end)))))))))
1741 (defun c-declaration-limits (near)
1742 ;; Return a cons of the beginning and end positions of the current
1743 ;; top level declaration or macro. If point is not inside any then
1744 ;; nil is returned, unless NEAR is non-nil in which case the closest
1745 ;; following one is chosen instead (if there is any). The end
1746 ;; position is at the next line, providing there is one before the
1749 ;; This function might do hidden buffer changes.
1752 ;; Note: Some code duplication in `c-beginning-of-defun' and
1753 ;; `c-end-of-defun'.
1755 (let ((start (point))
1756 (paren-state (c-parse-state))
1759 (goto-char (c-least-enclosing-brace paren-state))
1760 ;; If we moved to the outermost enclosing paren then we
1761 ;; can use c-safe-position to set the limit. Can't do
1762 ;; that otherwise since the earlier paren pair on
1763 ;; paren-state might very well be part of the
1764 ;; declaration we should go to.
1765 (setq lim (c-safe-position (point) paren-state))
1767 ;; At top level. Make sure we aren't inside a literal.
1768 (setq pos (c-literal-limits
1769 (c-safe-position (point) paren-state)))
1770 (if pos (goto-char (car pos))))
1772 (when (c-beginning-of-macro)
1781 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1783 ;; We moved back over the previous defun. Skip to the next
1784 ;; one. Not using c-forward-syntactic-ws here since we
1785 ;; should not skip a macro. We can also be directly after
1786 ;; the block in a `c-opt-block-decls-with-vars-key'
1787 ;; declaration, but then we won't move significantly far
1790 (c-forward-comments)
1792 (when (and near (c-beginning-of-macro))
1800 (if (eobp) (throw 'exit nil))
1802 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1803 ;; declaration that doesn't end there. We're searching back and
1804 ;; forth over the block here, which can be expensive.
1806 (if (and c-opt-block-decls-with-vars-key
1808 (c-backward-syntactic-ws)
1809 (eq (char-before) ?}))
1810 (eq (car (c-beginning-of-decl-1))
1814 (and (> (point) pos)
1815 (setq end-pos (point)))))
1819 (if (and (not near) (> (point) start))
1822 ;; Try to be line oriented; position the limits at the
1823 ;; closest preceding boi, and after the next newline, that
1824 ;; isn't inside a comment, but if we hit a neighboring
1825 ;; declaration then we instead use the exact declaration
1826 ;; limit in that direction.
1829 (while (and (/= (point) (c-point 'boi))
1830 (c-backward-single-comment)))
1831 (if (/= (point) (c-point 'boi))
1839 (while (and (not (bolp))
1840 (not (looking-at "\\s *$"))
1841 (c-forward-single-comment)))
1844 ((looking-at "\\s *$")
1851 (defun c-mark-function ()
1852 "Put mark at end of the current top-level declaration or macro, point at beginning.
1853 If point is not inside any then the closest following one is chosen.
1855 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1856 function does not require the declaration to contain a brace block."
1860 (c-save-buffer-state nil
1861 ;; We try to be line oriented, unless there are several
1862 ;; declarations on the same line.
1863 (if (looking-at c-syntactic-eol)
1864 (c-backward-token-2 1 nil (c-point 'bol)))
1865 (setq decl-limits (c-declaration-limits t)))
1867 (if (not decl-limits)
1868 (error "Cannot find any declaration")
1869 (goto-char (car decl-limits))
1870 (push-mark (cdr decl-limits) nil t))))
1872 (defun c-cpp-define-name ()
1873 "Return the name of the current CPP macro, or NIL if we're not in one."
1876 (and c-opt-cpp-macro-define-start
1877 (c-beginning-of-macro)
1878 (looking-at c-opt-cpp-macro-define-start)
1879 (match-string-no-properties 1))))
1882 ;; Movement by statements.
1883 (defun c-in-comment-line-prefix-p ()
1884 ;; Point is within a comment. Is it also within a comment-prefix?
1885 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1887 ;; This function might do hidden buffer changes.
1888 (let ((here (point)))
1891 (skip-chars-forward " \t")
1892 (and (looking-at c-current-comment-prefix)
1893 (/= (match-beginning 0) (match-end 0))
1894 (< here (match-end 0))))))
1896 (defun c-narrow-to-comment-innards (range)
1897 ;; Narrow to the "inside" of the comment (block) defined by range, as
1900 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
1901 ;; present) removed. A c++-style line comment retains its opening "//" but
1902 ;; has any final NL removed. If POINT is currently outwith these innards,
1903 ;; move it to the appropriate boundary.
1905 ;; This narrowing simplifies the sentence movement functions, since it
1906 ;; eliminates awkward things at the boundaries of the comment (block).
1908 ;; This function might do hidden buffer changes.
1909 (let* ((lit-type (c-literal-type range))
1910 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
1911 (end (if (eq lit-type 'c)
1912 (if (and (eq (char-before (cdr range)) ?/)
1913 (eq (char-before (1- (cdr range))) ?*))
1916 (if (eq (cdr range) (point-max))
1918 (- (cdr range) 1)))))
1920 (goto-char end)) ; This would be done automatically by ...
1922 (goto-char beg)) ; ... narrow-to-region but is not documented.
1923 (narrow-to-region beg end)))
1925 (defun c-beginning-of-sentence-in-comment (range)
1926 ;; Move backwards to the "beginning of a sentence" within the comment
1927 ;; defined by RANGE, a cons of its starting and ending positions. If we
1928 ;; find a BOS, return NIL. Otherwise, move point to just before the start
1929 ;; of the comment and return T.
1931 ;; The BOS is either text which follows a regexp match of sentence-end,
1932 ;; or text which is a beginning of "paragraph".
1933 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
1935 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1936 ;; It is not a general function, but is intended only for calling from
1937 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
1939 ;; This function might do hidden buffer changes.
1941 (let ((start-point (point)))
1943 (c-narrow-to-comment-innards range) ; This may move point back.
1944 (let* ((here (point))
1946 (here-filler ; matches WS and comment-prefices at point.
1947 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
1948 "\\|[ \t\n\r\f]\\)*"))
1949 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
1950 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
1951 ;; First, find the previous paragraph start, if any.
1952 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
1954 (forward-paragraph -1) ; uses cc-mode values of
1955 ; paragraph-\(start\|separate\)
1956 (if (> (re-search-forward here-filler nil t) here)
1958 (when (>= (point) here)
1959 (forward-paragraph -2)
1960 (if (> (re-search-forward here-filler nil t) here)
1964 ;; Now seek successively earlier sentence ends between PAR-BEG and
1965 ;; HERE, until the "start of sentence" following it is earlier than
1966 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
1967 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
1969 (goto-char (match-end 0)) ; tentative beginning of sentence
1970 (or (>= (point) here)
1971 (and (not (bolp)) ; Found a non-blank comment-prefix?
1973 (if (re-search-backward prefix-at-bol-here nil t)
1974 (/= (match-beginning 1) (match-end 1)))))
1975 (progn ; Skip the crud to find a real b-o-s.
1976 (if (c-in-comment-line-prefix-p)
1977 (beginning-of-line))
1978 (re-search-forward here-filler) ; always succeeds.
1979 (>= (point) here))))
1981 (re-search-forward here-filler)))
1983 (if (< (point) start-point)
1985 (goto-char (car range))
1988 (defun c-end-of-sentence-in-comment (range)
1989 ;; Move forward to the "end of a sentence" within the comment defined by
1990 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
1991 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
1992 ;; return NIL. Otherwise, move point to just after the end of the comment
1995 ;; The EOS is just after the non-WS part of the next match of the regexp
1996 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
1997 ;; no sentence-end match following point, any WS before the end of the
1998 ;; comment will count as EOS, providing we're not already in it.
2000 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2001 ;; It is not a general function, but is intended only for calling from
2002 ;; c-move-over-sentence.
2004 ;; This function might do hidden buffer changes.
2006 (let ((start-point (point))
2007 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2010 (c-narrow-to-comment-innards range) ; This might move point forwards.
2011 (let* ((here (point))
2012 (par-end ; EOL position of last text in current/next paragraph.
2014 ;; The cc-mode values of paragraph-\(start\|separate\), set
2015 ;; in c-setup-paragraph-variables, are used in the
2017 (forward-paragraph 1)
2018 (if (eq (preceding-char) ?\n) (forward-char -1))
2019 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
2021 (forward-paragraph 2)
2022 (if (eq (preceding-char) ?\n) (forward-char -1)))
2027 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
2028 ;; Go forward one "comment-prefix which looks like sentence-end"
2029 ;; each time round the following:
2030 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
2033 (skip-chars-backward " \t\n")
2034 (or (and (not (bolp))
2035 (re-search-backward prefix-at-bol-here nil t)
2036 (/= (match-beginning 1) (match-end 1)))
2037 (<= (point) here))))
2040 ;; Take special action if we're up against the end of a comment (of
2041 ;; either sort): Leave point just after the last non-ws text.
2042 (if (eq (point) (point-max))
2043 (while (or (/= (skip-chars-backward " \t\n") 0)
2044 (and (re-search-backward prefix-at-bol-here nil t)
2045 (/= (match-beginning 1) (match-end 1))))))))
2047 (if (> (point) start-point)
2049 (goto-char (cdr range))
2052 (defun c-beginning-of-sentence-in-string (range)
2053 ;; Move backwards to the "beginning of a sentence" within the string defined
2054 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2055 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2056 ;; just before the start of the string and return T.
2058 ;; The BOS is either the text which follows a regexp match of sentence-end
2059 ;; or text which is a beginning of "paragraph". For the purposes of
2060 ;; determining paragraph boundaries, escaped newlines are treated as
2061 ;; ordinary newlines.
2063 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2064 ;; It is not a general function, but is intended only for calling from
2065 ;; c-move-over-sentence.
2067 ;; This function might do hidden buffer changes.
2069 (let* ((here (point)) last
2070 (end (1- (cdr range)))
2071 (here-filler ; matches WS and escaped newlines at point.
2072 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2073 ;; Enhance paragraph-start and paragraph-separate also to recognise
2074 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2075 ;; these values should be customizable user options, or something.
2076 (paragraph-start c-string-par-start)
2077 (paragraph-separate c-string-par-separate)
2079 (par-beg ; beginning of current (or previous) paragraph.
2082 (narrow-to-region (1+ (car range)) end)
2083 (forward-paragraph -1) ; uses above values of
2084 ; paragraph-\(start\|separate\)
2085 (if (> (re-search-forward here-filler nil t) here)
2087 (when (>= (point) here)
2088 (forward-paragraph -2)
2089 (if (> (re-search-forward here-filler nil t) here)
2092 ;; Now see if we can find a sentence end after PAR-BEG.
2093 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2095 (goto-char (match-end 0))
2099 here-filler end t) ; always succeeds. Use end rather
2100 ; than here, in case point starts
2101 ; beyond the closing quote.
2102 (>= (point) here))))
2104 (re-search-forward here-filler here t)
2105 (if (< (point) here)
2107 (goto-char (car range))
2110 (defun c-end-of-sentence-in-string (range)
2111 ;; Move forward to the "end of a sentence" within the string defined by
2112 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2113 ;; return NIL. Otherwise, move point to just after the end of the string
2116 ;; The EOS is just after the non-WS part of the next match of the regexp
2117 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2118 ;; no sentence-end match following point, any WS before the end of the
2119 ;; string will count as EOS, providing we're not already in it.
2121 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2122 ;; It is not a general function, but is intended only for calling from
2123 ;; c-move-over-sentence.
2125 ;; This function might do hidden buffer changes.
2127 (let* ((here (point))
2129 ;; Enhance paragraph-start and paragraph-separate to recognise
2130 ;; blank lines terminated by escaped EOLs.
2131 (paragraph-start c-string-par-start)
2132 (paragraph-separate c-string-par-separate)
2134 (par-end ; EOL position of last text in current/next paragraph.
2137 (narrow-to-region (car range) (1- (cdr range)))
2138 ;; The above values of paragraph-\(start\|separate\) are used
2139 ;; in the following.
2140 (forward-paragraph 1)
2142 ;; (re-search-backward filler-here nil t) would find an empty
2143 ;; string. Therefore we simulate it by the following:
2144 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2145 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2146 (unless (> (point) here)
2148 (forward-paragraph 1)
2149 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2150 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2152 ;; Try to go forward a sentence.
2153 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2155 (while (or (/= (skip-chars-backward " \t\n") 0)
2156 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2157 ;; Did we move a sentence, or did we hit the end of the string?
2158 (if (> (point) here)
2160 (goto-char (cdr range))
2163 (defun c-ascertain-preceding-literal ()
2164 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2165 ;; If a literal is the next thing (aside from whitespace) to be found before
2166 ;; point, return a cons of its start.end positions (enclosing the
2167 ;; delimiters). Otherwise return NIL.
2169 ;; This function might do hidden buffer changes.
2171 (c-collect-line-comments
2172 (let ((here (point))
2174 (if (c-backward-single-comment)
2175 (cons (point) (progn (c-forward-single-comment) (point)))
2177 ;; to prevent `looking-at' seeing a " at point.
2178 (narrow-to-region (point-min) here)
2181 ;; An EOL can act as an "open string" terminator in AWK.
2182 (looking-at c-ws*-string-limit-regexp)
2184 (progn (backward-char)
2185 (looking-at c-string-limit-regexp))))
2186 (goto-char (match-end 0)) ; just after the string terminator.
2188 (c-safe (c-backward-sexp 1) ; move back over the string.
2189 (cons (point) pos)))))))))
2191 (defun c-ascertain-following-literal ()
2192 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2193 ;; If a literal is the next thing (aside from whitespace) following point,
2194 ;; return a cons of its start.end positions (enclosing the delimiters).
2195 ;; Otherwise return NIL.
2197 ;; This function might do hidden buffer changes.
2199 (c-collect-line-comments
2202 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2203 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2206 (if (c-forward-single-comment)
2207 (cons pos (point))))))))
2209 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2210 ;; Does point immediately follow a statement "terminator"? A virtual
2211 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2213 ;; This function might do hidden buffer changes.
2216 (and (looking-at "[;{}]")
2217 (not (and c-special-brace-lists ; Pike special brace lists.
2218 (eq (char-after) ?{)
2219 (c-looking-at-special-brace-list)))))
2221 ;; The following (for macros) is not strict about exactly where we are
2222 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2223 ;; much. ACM 2004/3/29.
2226 (if (c-beginning-of-macro)
2227 (setq eom (progn (c-end-of-macro)
2231 (c-forward-comments)
2232 (>= (point) eom))))))
2234 (defun c-back-over-illiterals (macro-start)
2235 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2236 ;; stopping before reaching BOB or a literal or the boundary of a
2237 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2238 ;; the position of the '#' beginning the current preprocessor directive, or
2239 ;; NIL if we're not in such.
2241 ;; Return a cons (A.B), where
2242 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2243 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2244 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2245 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2247 ;; The total collection of returned values is as follows:
2248 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2249 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2250 ;; a BOS - the caller must check this.
2251 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2252 ;; moved and reached the opening # of the macro.
2253 ;; (t . macro-boundary): Every other circumstance in which we're at a
2254 ;; macro-boundary. We might be at a BOS.
2256 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2257 ;; code before encountering the literal/BOB or macro-boundary.
2259 ;; Note that this function moves within either preprocessor commands
2260 ;; (macros) or normal code, but will not cross a boundary between the two,
2261 ;; or between two distinct preprocessor commands.
2263 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2264 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2265 ;; move into parens. Also stop before `#' when it's at boi on a line.
2267 ;; This function might do hidden buffer changes.
2269 (let ((here (point))
2270 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2271 ; semicolon precedes it.
2273 (while t ;; We go back one "token" each iteration of the loop.
2276 ;; Stop at the token after a comment.
2277 ((c-backward-single-comment) ; Also functions as backwards-ws.
2279 (throw 'done '(t . literal)))
2281 ;; If we've gone back over a LF, we might have moved into or out of
2282 ;; a preprocessor line.
2283 ((and (save-excursion
2285 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2287 (< (point) macro-start)
2288 (c-beginning-of-macro)))
2290 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2291 (throw 'done (cons (or (eq (point) here)
2295 ;; Have we found a virtual semicolon? If so, stop, unless the next
2296 ;; statement is where we started from.
2297 ((and (c-at-vsemi-p)
2299 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2301 (throw 'done '(nil . nil)))
2303 ;; Hit the beginning of the buffer/region?
2307 (throw 'done '(nil . nil)))
2309 ;; Move back a character.
2310 ((progn (backward-char) nil))
2312 ;; Stop at "{" (unless it's a PIKE special brace list.)
2313 ((eq (char-after) ?\{)
2314 (if (and c-special-brace-lists
2315 (c-looking-at-special-brace-list))
2316 (skip-syntax-backward "w_") ; Speedup only.
2319 (throw 'done '(nil . nil))))
2321 ;; Have we reached the start of a macro? This always counts as
2322 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2323 ;; here. FIXME!!! ACM 2004/3/29)
2324 ((and macro-start (eq (point) macro-start))
2325 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2327 ;; Stop at token just after "}" or ";".
2328 ((looking-at "[;}]")
2329 ;; If we've gone back over ;, {, or }, we're done.
2330 (if (or (= here last)
2331 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2332 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2333 (eq (char-after) ?\;))
2335 (goto-char last) ; To the statement starting after the ; or }.
2336 (throw 'done '(nil . nil))))
2338 ;; Stop at the token after a string.
2339 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2341 (throw 'done '(t . literal)))
2343 ;; Nothing special: go back word characters.
2344 (t (skip-syntax-backward "w_")) ; Speedup only.
2347 (defun c-forward-over-illiterals (macro-end allow-early-stop)
2348 ;; Move forwards over code, stopping before reaching EOB or a literal
2349 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2350 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2351 ;; terminates the current preprocessor directive, or NIL if we're not in
2354 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2355 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2356 ;; seems unavoidable. Depending on the context this function is called
2357 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2358 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2359 ;; semicolons, or anything else.
2361 ;; Return a cons (A.B), where
2362 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2363 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2364 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2365 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2367 ;; Point is left either after the end-of-statement, or at the last non-ws
2368 ;; code before encountering the literal, or the # of the preprocessor
2369 ;; statement, or at EOB [or just after last non-WS stuff??].
2371 ;; As a clarification of "after the end-of-statement", if a comment or
2372 ;; whitespace follows a completed AWK statement, that statement is treated
2373 ;; as ending just after the last non-ws character before the comment.
2375 ;; Note that this function moves within either preprocessor commands
2376 ;; (macros) or normal code, but not both within the same invocation.
2378 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2379 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2380 ;; stop before `{' if at top level or inside braces, though. Move by
2381 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2384 ;; This function might do hidden buffer changes.
2385 (let ((here (point))
2388 (while t ;; We go one "token" forward each time round this loop.
2391 ;; If we've moved forward to a virtual semicolon, we're done.
2392 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2394 (throw 'done '(nil . nil)))
2398 ;; Gone past the end of a macro?
2399 ((and macro-end (> (point) macro-end))
2401 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2403 ;; About to hit a comment?
2404 ((save-excursion (c-forward-single-comment))
2406 (throw 'done '(t . literal)))
2412 (throw 'done '(nil . nil)))
2414 ;; If we encounter a '{', stop just after the previous token.
2415 ((and (eq (char-after) ?{)
2416 (not (and c-special-brace-lists
2417 (c-looking-at-special-brace-list)))
2418 (or allow-early-stop (/= here last))
2419 (save-excursion ; Is this a check that we're NOT at top level?
2420 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2421 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2422 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2423 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2424 (or (not (c-safe (up-list -1) t))
2425 (= (char-after) ?{))))
2427 (throw 'done '(nil . nil)))
2429 ;; End of a PIKE special brace list? If so, step over it and continue.
2430 ((and c-special-brace-lists
2431 (eq (char-after) ?})
2433 (and (c-safe (up-list -1) t)
2434 (c-looking-at-special-brace-list))))
2436 (skip-syntax-forward "w_")) ; Speedup only.
2438 ;; Have we got a '}' after having moved? If so, stop after the
2440 ((and (eq (char-after) ?})
2443 (throw 'done '(nil . nil)))
2445 ;; Stop if we encounter a preprocessor line.
2446 ((and (not macro-end)
2447 (eq (char-after) ?#)
2448 (= (point) (c-point 'boi)))
2450 ;(throw 'done (cons (eq (point) here) 'macro-boundary))) ; Changed 2003/3/26
2451 (throw 'done '(t . macro-boundary)))
2453 ;; Stop after a ';', '}', or "};"
2454 ((looking-at ";\\|};?")
2455 (goto-char (match-end 0))
2456 (throw 'done '(nil . nil)))
2458 ;; Found a string (this subsumes AWK regexps)?
2459 ((looking-at c-string-limit-regexp)
2461 (throw 'done '(t . literal)))
2464 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2465 (skip-syntax-forward "w_") ; Speedup only.
2466 (when (and macro-end (> (point) macro-end))
2468 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2471 (defun c-one-line-string-p (range)
2472 ;; Is the literal defined by RANGE a string contained in a single line?
2474 ;; This function might do hidden buffer changes.
2476 (goto-char (car range))
2477 (and (looking-at c-string-limit-regexp)
2478 (progn (skip-chars-forward "^\n" (cdr range))
2479 (eq (point) (cdr range))))))
2481 (defun c-beginning-of-statement (&optional count lim sentence-flag)
2482 "Go to the beginning of the innermost C statement.
2483 With prefix arg, go back N - 1 statements. If already at the
2484 beginning of a statement then go to the beginning of the closest
2485 preceding one, moving into nested blocks if necessary (use
2486 \\[backward-sexp] to skip over a block). If within or next to a
2487 comment or multiline string, move by sentences instead of statements.
2489 When called from a program, this function takes 3 optional args: the
2490 repetition count, a buffer position limit which is the farthest back
2491 to search for the syntactic context, and a flag saying whether to do
2492 sentence motion in or near comments and multiline strings.
2494 Note that for use in programs, `c-beginning-of-statement-1' is
2495 usually better. It has much better defined semantics than this one,
2496 which is intended for interactive use, and might therefore change to
2497 be more \"DWIM:ey\"."
2498 (interactive (list (prefix-numeric-value current-prefix-arg)
2501 (c-end-of-statement (- count) lim sentence-flag)
2502 (c-save-buffer-state
2503 ((count (or count 1))
2504 last ; start point for going back ONE chunk. Updated each chunk movement.
2506 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2507 res ; result from sub-function call
2508 not-bos ; "not beginning-of-statement"
2509 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2511 ;; Go back one statement at each iteration of the following loop.
2512 (while (and (/= count 0)
2513 (or (not lim) (> (point) lim)))
2514 ;; Go back one "chunk" each time round the following loop, stopping
2515 ;; when we reach a statement boundary, etc.
2518 (cond ; Each arm of this cond returns NIL on reaching a desired
2519 ; statement boundary, non-NIL otherwise.
2524 (range ; point is within or approaching a literal.
2526 ;; Single line string or sentence-flag is null => skip the
2528 ((or (null sentence-flag)
2529 (c-one-line-string-p range))
2530 (goto-char (car range))
2531 (setq range (c-ascertain-preceding-literal))
2532 ;; N.B. The following is essentially testing for an AWK regexp
2534 ;; Was the previous non-ws thing an end of statement?
2537 (c-backward-comments)
2538 (c-backward-syntactic-ws))
2539 (not (or (bobp) (c-after-statement-terminator-p)))))
2541 ;; Comment inside a statement or a multi-line string.
2542 (t (when (setq res ; returns non-nil when we go out of the literal
2543 (if (eq (c-literal-type range) 'string)
2544 (c-beginning-of-sentence-in-string range)
2545 (c-beginning-of-sentence-in-comment range)))
2546 (setq range (c-ascertain-preceding-literal)))
2549 ;; Non-literal code.
2550 (t (setq res (c-back-over-illiterals macro-fence))
2551 (setq not-bos ; "not reached beginning-of-statement".
2552 (or (= (point) last)
2553 (memq (char-after) '(?\) ?\}))
2556 ;; We're at a tentative BOS. The next form goes
2557 ;; back over WS looking for an end of previous
2559 (not (save-excursion
2561 (c-backward-comments)
2562 (c-backward-syntactic-ws))
2563 (or (bobp) (c-after-statement-terminator-p)))))))
2564 ;; Are we about to move backwards into or out of a
2565 ;; preprocessor command? If so, locate it's beginning.
2566 (when (eq (cdr res) 'macro-boundary)
2571 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2573 ;; Are we about to move backwards into a literal?
2574 (when (memq (cdr res) '(macro-boundary literal))
2575 (setq range (c-ascertain-preceding-literal)))
2577 (setq last (point)))
2579 (if (/= count 0) (setq count (1- count))))
2580 (c-keep-region-active))))
2582 (defun c-end-of-statement (&optional count lim sentence-flag)
2583 "Go to the end of the innermost C statement.
2584 With prefix arg, go forward N - 1 statements. Move forward to the end
2585 of the next statement if already at end, and move into nested blocks
2586 \(use \\[forward-sexp] to skip over a block). If within or next to a
2587 comment or multiline string, move by sentences instead of statements.
2589 When called from a program, this function takes 3 optional args: the
2590 repetition count, a buffer position limit which is the farthest back
2591 to search for the syntactic context, and a flag saying whether to do
2592 sentence motion in or near comments and multiline strings."
2593 (interactive (list (prefix-numeric-value current-prefix-arg)
2595 (setq count (or count 1))
2596 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2598 (c-save-buffer-state
2599 (here ; start point for going forward ONE statement. Updated each statement.
2602 (and (not (eobp)) (c-beginning-of-macro)
2603 (progn (c-end-of-macro) (point)))))
2605 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2607 ;; Go back/forward one statement at each iteration of the following loop.
2608 (while (and (/= count 0)
2609 (or (not lim) (< (point) lim)))
2610 (setq here (point)) ; ONLY HERE is HERE updated
2612 ;; Go forward one "chunk" each time round the following loop, stopping
2613 ;; when we reach a statement boundary, etc.
2615 (cond ; Each arm of this cond returns NIL on reaching a desired
2616 ; statement boundary, non-NIL otherwise.
2621 (range ; point is within a literal.
2623 ;; sentence-flag is null => skip the entire literal.
2624 ;; or a Single line string.
2625 ((or (null sentence-flag)
2626 (c-one-line-string-p range))
2627 (goto-char (cdr range))
2628 (setq range (c-ascertain-following-literal))
2629 ;; Is there a virtual semicolon here (e.g. for AWK)?
2630 (not (c-at-vsemi-p)))
2632 ;; Comment or multi-line string.
2633 (t (when (setq res ; gets non-nil when we go out of the literal
2634 (if (eq (c-literal-type range) 'string)
2635 (c-end-of-sentence-in-string range)
2636 (c-end-of-sentence-in-comment range)))
2637 (setq range (c-ascertain-following-literal)))
2638 ;; If we've just come forward out of a literal, check for
2639 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2640 ;; some other language may do in the future)
2642 (not (c-at-vsemi-p))))))
2644 ;; Non-literal code.
2645 (t (setq res (c-forward-over-illiterals macro-fence
2647 ;; Are we about to move forward into or out of a
2648 ;; preprocessor command?
2649 (when (eq (cdr res) 'macro-boundary)
2654 (progn (c-skip-ws-forward)
2655 (c-beginning-of-macro))
2656 (progn (c-end-of-macro)
2658 ;; Are we about to move forward into a literal?
2659 (when (memq (cdr res) '(macro-boundary literal))
2660 (setq range (c-ascertain-following-literal)))
2663 (if (/= count 0) (setq count (1- count))))
2664 (c-keep-region-active))))
2667 ;; set up electric character functions to work with pending-del,
2668 ;; (a.k.a. delsel) mode. All symbols get the t value except
2669 ;; the functions which delete, which gets 'supersede.
2673 (put sym 'delete-selection t) ; for delsel (Emacs)
2674 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2679 c-electric-semi&comma
2683 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2684 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2685 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2686 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
2687 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2688 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
2691 ;; Inserting/indenting comments
2692 (defun c-calc-comment-indent (entry)
2693 ;; This function might do hidden buffer changes.
2695 (setq entry (or (assq entry c-indent-comment-alist)
2696 (assq 'other c-indent-comment-alist)
2697 '(default . (column . nil)))))
2698 (let ((action (car (cdr entry)))
2699 (value (cdr (cdr entry)))
2700 (col (current-column)))
2701 (cond ((eq action 'space)
2703 ((eq action 'column)
2704 (unless value (setq value comment-column))
2706 ;; Do not pad with one space if we're at bol.
2708 (max (1+ col) value)))
2714 (let ((lim (c-literal-limits (c-point 'bol) t)))
2716 (goto-char (car lim))
2717 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2718 ;; Found comment to align with.
2720 ;; Do not pad with one space if we're at bol.
2722 (max (1+ col) (current-column))))))))
2723 ;; Recurse to handle value as a new spec.
2724 (c-calc-comment-indent (cdr entry)))))))
2726 (defun c-comment-indent ()
2727 "Used by `indent-for-comment' to create and indent comments.
2728 See `c-indent-comment-alist' for a description."
2731 (c-save-buffer-state
2732 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
2733 (or (when (consp lim)
2734 (goto-char (car lim))
2735 (when (looking-at "/[/*]")
2736 (skip-chars-backward " \t")
2739 (skip-chars-backward " \t")
2742 (cond ((looking-at "^/[/*]")
2744 ((progn (beginning-of-line)
2747 ((progn (back-to-indentation)
2748 (and (eq (char-after) ?})
2749 (eq (point) (1- eot))))
2751 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2752 (eq (match-end 0) eot))
2756 (if (and (memq line-type '(anchored-comment empty-line))
2757 c-indent-comments-syntactically-p)
2758 (let ((c-syntactic-context (c-guess-basic-syntax)))
2759 ;; BOGOSITY ALERT: if we're looking at the eol, its
2760 ;; because indent-for-comment hasn't put the comment-start
2761 ;; in the buffer yet. this will screw up the syntactic
2762 ;; analysis so we kludge in the necessary info. Another
2763 ;; kludge is that if we're at the bol, then we really want
2764 ;; to ignore any anchoring as specified by
2765 ;; c-comment-only-line-offset since it doesn't apply here.
2767 (c-add-syntax 'comment-intro))
2768 (let ((c-comment-only-line-offset
2769 (if (consp c-comment-only-line-offset)
2770 c-comment-only-line-offset
2771 (cons c-comment-only-line-offset
2772 c-comment-only-line-offset))))
2773 (c-get-syntactic-indentation c-syntactic-context)))
2775 (c-calc-comment-indent line-type)))))
2778 ;; used by outline-minor-mode
2779 (defun c-outline-level ()
2780 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2781 ;; in otherwise-hidden text.
2783 (skip-chars-forward "\t ")
2787 ;; Movement by CPP conditionals.
2788 (defun c-up-conditional (count)
2789 "Move back to the containing preprocessor conditional, leaving mark behind.
2790 A prefix argument acts as a repeat count. With a negative argument,
2791 move forward to the end of the containing preprocessor conditional.
2793 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2794 function stops at them when going backward, but not when going
2797 (let ((new-point (c-scan-conditionals (- count) -1)))
2799 (goto-char new-point))
2800 (c-keep-region-active))
2802 (defun c-up-conditional-with-else (count)
2803 "Move back to the containing preprocessor conditional, including \"#else\".
2804 Just like `c-up-conditional', except it also stops at \"#else\"
2807 (let ((new-point (c-scan-conditionals (- count) -1 t)))
2809 (goto-char new-point))
2810 (c-keep-region-active))
2812 (defun c-down-conditional (count)
2813 "Move forward into the next preprocessor conditional, leaving mark behind.
2814 A prefix argument acts as a repeat count. With a negative argument,
2815 move backward into the previous preprocessor conditional.
2817 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2818 function stops at them when going forward, but not when going
2821 (let ((new-point (c-scan-conditionals count 1)))
2823 (goto-char new-point))
2824 (c-keep-region-active))
2826 (defun c-down-conditional-with-else (count)
2827 "Move forward into the next preprocessor conditional, including \"#else\".
2828 Just like `c-down-conditional', except it also stops at \"#else\"
2831 (let ((new-point (c-scan-conditionals count 1 t)))
2833 (goto-char new-point))
2834 (c-keep-region-active))
2836 (defun c-backward-conditional (count &optional target-depth with-else)
2837 "Move back across a preprocessor conditional, leaving mark behind.
2838 A prefix argument acts as a repeat count. With a negative argument,
2839 move forward across a preprocessor conditional.
2841 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2842 and have the same meanings as in `c-scan-conditionals'. If you
2843 are calling c-forward-conditional from a program, you might want
2844 to call `c-scan-conditionals' directly instead."
2846 (let ((new-point (c-scan-conditionals (- count) target-depth with-else)))
2848 (goto-char new-point))
2849 (c-keep-region-active))
2851 (defun c-forward-conditional (count &optional target-depth with-else)
2852 "Move forward across a preprocessor conditional, leaving mark behind.
2853 A prefix argument acts as a repeat count. With a negative argument,
2854 move backward across a preprocessor conditional.
2856 If there aren't enough conditionals after \(or before) point, an
2859 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2860 the nesting level isn't changed when tracking subconditionals.
2862 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2863 and have the same meanings as in `c-scan-conditionals'. If you
2864 are calling c-forward-conditional from a program, you might want
2865 to call `c-scan-conditionals' directly instead."
2867 (let ((new-point (c-scan-conditionals count target-depth with-else)))
2869 (goto-char new-point)))
2871 (defun c-scan-conditionals (count &optional target-depth with-else)
2872 "Scan forward across COUNT preprocessor conditionals.
2873 With a negative argument, scan backward across preprocessor
2874 conditionals. Return the end position. Point is not moved.
2876 If there aren't enough preprocessor conditionals, throw an error.
2878 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2879 the nesting level isn't changed when tracking subconditionals.
2881 The optional argument TARGET-DEPTH specifies the wanted nesting depth
2882 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
2883 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
2886 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
2887 are treated as conditional clause limits. Normally they are ignored."
2888 (let* ((forward (> count 0))
2889 (increment (if forward -1 1))
2890 (search-function (if forward 're-search-forward 're-search-backward))
2892 (unless (integerp target-depth)
2893 (setq target-depth (if target-depth -1 0)))
2897 ;; subdepth is the depth in "uninteresting" subtrees,
2898 ;; i.e. those that takes us farther from the target
2899 ;; depth instead of closer.
2903 ;; Find the "next" significant line in the proper direction.
2904 (while (and (not found)
2905 ;; Rather than searching for a # sign that
2906 ;; comes at the beginning of a line aside from
2907 ;; whitespace, search first for a string
2908 ;; starting with # sign. Then verify what
2909 ;; precedes it. This is faster on account of
2910 ;; the fastmap feature of the regexp matcher.
2911 (funcall search-function
2912 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
2915 ;; Now verify it is really a preproc line.
2916 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
2917 (let (dchange (directive (match-string 1)))
2918 (cond ((string= directive "if")
2919 (setq dchange (- increment)))
2920 ((string= directive "endif")
2921 (setq dchange increment))
2923 ;; When we're not in an "uninteresting"
2924 ;; subtree, we might want to act on "elif"
2926 (if (cond (with-else
2927 ;; Always move toward the target depth.
2929 (if (> target-depth 0) 1 -1)))
2930 ((string= directive "elif")
2931 (setq dchange (- increment))))
2932 ;; Ignore the change if it'd take us
2933 ;; into an "uninteresting" subtree.
2934 (if (eq (> dchange 0) (<= target-depth 0))
2935 (setq dchange nil)))))
2937 (when (or (/= subdepth 0)
2938 (eq (> dchange 0) (<= target-depth 0)))
2939 (setq subdepth (+ subdepth dchange)))
2940 (setq depth (+ depth dchange))
2941 ;; If we are trying to move across, and we find an
2942 ;; end before we find a beginning, get an error.
2943 (if (and (< depth target-depth) (< dchange 0))
2945 "No following conditional at this level"
2946 "No previous conditional at this level"))))
2947 ;; When searching forward, start from next line so
2948 ;; that we don't find the same line again.
2949 (if forward (forward-line 1))
2950 ;; We found something if we've arrived at the
2952 (if (and dchange (= depth target-depth))
2953 (setq found (point))))
2955 (if forward (forward-line 1)))))
2957 (error "No containing preprocessor conditional"))
2958 (goto-char (setq new found)))
2959 (setq count (+ count increment))))
2960 (c-keep-region-active)
2964 ;; commands to indent lines, regions, defuns, and expressions
2965 (defun c-indent-command (&optional arg)
2966 "Indent current line as C code, and/or insert some whitespace.
2968 If `c-tab-always-indent' is t, always just indent the current line.
2969 If nil, indent the current line only if point is at the left margin or
2970 in the line's indentation; otherwise insert some whitespace[*]. If
2971 other than nil or t, then some whitespace[*] is inserted only within
2972 literals (comments and strings), but the line is always reindented.
2974 If `c-syntactic-indentation' is t, indentation is done according to
2975 the syntactic context. A numeric argument, regardless of its value,
2976 means indent rigidly all the lines of the expression starting after
2977 point so that this line becomes properly indented. The relative
2978 indentation among the lines of the expression is preserved.
2980 If `c-syntactic-indentation' is nil, the line is just indented one
2981 step according to `c-basic-offset'. In this mode, a numeric argument
2982 indents a number of such steps, positive or negative, and an empty
2983 prefix argument is equivalent to -1.
2985 [*] The amount and kind of whitespace inserted is controlled by the
2986 variable `c-insert-tab-function', which is called to do the actual
2987 insertion of whitespace. Normally the function in this variable
2988 just inserts a tab character, or the equivalent number of spaces,
2989 depending on the variable `indent-tabs-mode'."
2992 (let ((indent-function
2993 (if c-syntactic-indentation
2994 (symbol-function 'indent-according-to-mode)
2996 (let ((c-macro-start c-macro-start)
2997 (steps (if (equal arg '(4))
2999 (prefix-numeric-value arg))))
3000 (c-shift-line-indentation (* steps c-basic-offset))
3001 (when (and c-auto-align-backslashes
3004 (eq (char-before) ?\\))
3005 (c-query-and-set-macro-start))
3006 ;; Realign the line continuation backslash if inside a macro.
3007 (c-backslash-region (point) (point) nil t)))
3009 (if (and c-syntactic-indentation arg)
3010 ;; If c-syntactic-indentation and got arg, always indent this
3011 ;; line as C and shift remaining lines of expression the same
3013 (let ((shift-amt (save-excursion
3014 (back-to-indentation)
3018 (setq shift-amt (- (save-excursion
3019 (back-to-indentation)
3023 (if (eq c-tab-always-indent t)
3024 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
3032 (indent-code-rigidly beg end shift-amt "#")))
3033 ;; Else use c-tab-always-indent to determine behavior.
3035 ;; CASE 1: indent when at column zero or in line's indentation,
3036 ;; otherwise insert a tab
3037 ((not c-tab-always-indent)
3039 (skip-chars-backward " \t")
3041 (funcall c-insert-tab-function)
3042 (funcall indent-function)))
3043 ;; CASE 2: just indent the line
3044 ((eq c-tab-always-indent t)
3045 (funcall indent-function))
3046 ;; CASE 3: if in a literal, insert a tab, but always indent the
3049 (if (c-save-buffer-state () (c-in-literal))
3050 (funcall c-insert-tab-function))
3051 (funcall indent-function)
3054 (defun c-indent-exp (&optional shutup-p)
3055 "Indent each line in the balanced expression following point syntactically.
3056 If optional SHUTUP-P is non-nil, no errors are signaled if no
3057 balanced expression is found."
3059 (let ((here (point-marker))
3061 (set-marker-insertion-type here t)
3063 (let ((start (save-restriction
3064 ;; Find the closest following open paren that
3065 ;; ends on another line.
3066 (narrow-to-region (point-min) (c-point 'eol))
3067 (let (beg (end (point)))
3068 (while (and (setq beg (c-down-list-forward end))
3069 (setq end (c-up-list-forward beg))))
3071 (eq (char-syntax (char-before beg)) ?\()
3076 (error "Cannot find start of balanced expression to indent"))
3078 (setq end (c-safe (scan-sexps (point) 1)))
3081 (error "Cannot find end of balanced expression to indent"))
3084 (c-indent-region (point) end)))))
3086 (set-marker here nil))))
3088 (defun c-indent-defun ()
3089 "Indent the current top-level declaration or macro syntactically.
3090 In the macro case this also has the effect of realigning any line
3091 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3093 (let ((here (point-marker)) decl-limits)
3096 (c-save-buffer-state nil
3097 ;; We try to be line oriented, unless there are several
3098 ;; declarations on the same line.
3099 (if (looking-at c-syntactic-eol)
3100 (c-backward-token-2 1 nil (c-point 'bol))
3101 (c-forward-token-2 0 nil (c-point 'eol)))
3102 (setq decl-limits (c-declaration-limits nil)))
3104 (c-indent-region (car decl-limits)
3105 (cdr decl-limits))))
3107 (set-marker here nil))))
3109 (defun c-indent-region (start end &optional quiet)
3110 "Indent syntactically every line whose first char is between START
3111 and END inclusive. If the optional argument QUIET is non-nil then no
3112 syntactic errors are reported, even if `c-report-syntactic-errors' is
3116 (skip-chars-backward " \t\n\r\f\v")
3119 ;; Advance to first nonblank line.
3121 (skip-chars-forward " \t\n\r\f\v")
3122 (setq start (point))
3124 (setq c-parsing-error
3125 (or (let ((endmark (copy-marker end))
3126 (c-parsing-error nil)
3127 ;; shut up any echo msgs on indiv lines
3128 (c-echo-syntactic-information-p nil)
3129 (ml-macro-start ; Start pos of multi-line macro.
3130 (and (c-save-buffer-state ()
3131 (save-excursion (c-beginning-of-macro)))
3132 (eq (char-before (c-point 'eol)) ?\\)
3134 (c-fix-backslashes nil)
3138 (c-progress-init start end 'c-indent-region)
3140 (while (and (bolp) ;; One line each time round the loop.
3142 (< (point) endmark))
3146 (unless (or (looking-at "\\s *$")
3147 (and ml-macro-start (looking-at "\\s *\\\\$")))
3148 ;; Get syntax and indent.
3149 (c-save-buffer-state nil
3150 (setq syntax (c-guess-basic-syntax)))
3151 (c-indent-line syntax t t))
3154 ;; End of current multi-line macro?
3155 (when (and c-auto-align-backslashes
3156 (not (eq (char-before (c-point 'eol)) ?\\)))
3157 ;; Fixup macro backslashes.
3158 (c-backslash-region ml-macro-start (c-point 'bonl) nil)
3159 (setq ml-macro-start nil))
3160 ;; New multi-line macro?
3161 (if (and (assq 'cpp-macro syntax)
3162 (eq (char-before (c-point 'eol)) ?\\))
3163 (setq ml-macro-start (point))))
3167 (if (and ml-macro-start c-auto-align-backslashes)
3168 (c-backslash-region ml-macro-start (c-point 'bopl) nil t)))
3169 (set-marker endmark nil)
3170 (c-progress-fini 'c-indent-region))
3171 (c-echo-parsing-error quiet))
3174 (defun c-fn-region-is-active-p ()
3175 ;; Function version of the macro for use in places that aren't
3176 ;; compiled, e.g. in the menus.
3177 (c-region-is-active-p))
3179 (defun c-indent-line-or-region (&optional arg region)
3180 "Indent active region, current line, or block starting on this line.
3181 In Transient Mark mode, when the region is active, reindent the region.
3182 Otherwise, with a prefix argument, rigidly reindent the expression
3183 starting on the current line.
3184 Otherwise reindent just the current line."
3186 (list current-prefix-arg (use-region-p)))
3188 (c-indent-region (region-beginning) (region-end))
3189 (c-indent-command arg)))
3191 ;; for progress reporting
3192 (defvar c-progress-info nil)
3194 (defun c-progress-init (start end context)
3197 ((not c-progress-interval))
3198 ;; Start the progress update messages. If this Emacs doesn't have
3199 ;; a built-in timer, just be dumb about it.
3200 ((not (fboundp 'current-time))
3201 (message "Indenting region... (this may take a while)"))
3202 ;; If progress has already been initialized, do nothing. otherwise
3203 ;; initialize the counter with a vector of:
3204 ;; [start end lastsec context]
3206 (t (setq c-progress-info (vector start
3210 (nth 1 (current-time))
3212 (message "Indenting region..."))
3215 (defun c-progress-update ()
3216 (if (not (and c-progress-info c-progress-interval))
3218 (let ((now (nth 1 (current-time)))
3219 (start (aref c-progress-info 0))
3220 (end (aref c-progress-info 1))
3221 (lastsecs (aref c-progress-info 2)))
3222 ;; should we update? currently, update happens every 2 seconds,
3223 ;; what's the right value?
3224 (if (< c-progress-interval (- now lastsecs))
3226 (message "Indenting region... (%d%% complete)"
3227 (/ (* 100 (- (point) start)) (- end start)))
3228 (aset c-progress-info 2 now)))
3231 (defun c-progress-fini (context)
3232 (if (not c-progress-interval)
3234 (if (or (eq context (aref c-progress-info 3))
3237 (set-marker (aref c-progress-info 1) nil)
3238 (setq c-progress-info nil)
3239 (message "Indenting region... done")))))
3243 ;;; This page handles insertion and removal of backslashes for C macros.
3245 (defun c-backslash-region (from to delete-flag &optional line-mode)
3246 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3247 With no argument, inserts backslashes and aligns existing backslashes.
3248 With an argument, deletes the backslashes. The backslash alignment is
3249 done according to the settings in `c-backslash-column',
3250 `c-backslash-max-column' and `c-auto-align-backslashes'.
3252 This function does not modify blank lines at the start of the region.
3253 If the region ends at the start of a line and the macro doesn't
3254 continue below it, the backslash (if any) at the end of the previous
3257 You can put the region around an entire macro definition and use this
3258 command to conveniently insert and align the necessary backslashes."
3259 (interactive "*r\nP")
3260 (let ((endmark (make-marker))
3261 ;; Keep the backslash trimming functions from changing the
3262 ;; whitespace around point, since in this case it's only the
3263 ;; position of point that tells the indentation of the line.
3264 (point-pos (if (save-excursion
3265 (skip-chars-backward " \t")
3266 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3269 column longest-line-col bs-col-after-end)
3272 (if (and (not line-mode) (bobp))
3273 ;; Nothing to do if to is at bob, since we should back up
3274 ;; and there's no line to back up to.
3276 (when (and (not line-mode) (bolp))
3277 ;; Do not back up the to line if line-mode is set, to make
3278 ;; e.g. c-newline-and-indent consistent regardless whether
3279 ;; the (newline) call leaves point at bol or not.
3284 (set-marker endmark (point))
3286 (c-delete-backslashes-forward endmark point-pos))
3287 ;; Set bs-col-after-end to the column of any backslash
3288 ;; following the region, or nil if there is none.
3289 (setq bs-col-after-end
3290 (and (progn (end-of-line)
3291 (eq (char-before) ?\\))
3292 (= (forward-line 1) 0)
3293 (progn (end-of-line)
3294 (eq (char-before) ?\\))
3295 (1- (current-column))))
3297 ;; Back up the to line if line-mode is set, since the line
3298 ;; after the newly inserted line break should not be
3299 ;; touched in c-newline-and-indent.
3300 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3301 (unless bs-col-after-end
3302 ;; Set bs-col-after-end to non-nil in any case, since we
3303 ;; do not want to delete the backslash at the last line.
3304 (setq bs-col-after-end t)))
3306 (not c-auto-align-backslashes))
3308 ;; Compute the smallest column number past the ends of all
3310 (setq longest-line-col 0)
3312 (if bs-col-after-end
3313 ;; Include one more line in the max column
3314 ;; calculation, since the to line will be backslashed
3318 (while (and (>= (point) from)
3320 (if (eq (char-before) ?\\)
3322 (skip-chars-backward " \t")
3323 (setq longest-line-col (max longest-line-col
3324 (1+ (current-column))))
3328 ;; Try to align with surrounding backslashes.
3331 (if (and (not (bobp))
3332 (progn (backward-char)
3333 (eq (char-before) ?\\)))
3335 (setq column (1- (current-column)))
3336 (if (numberp bs-col-after-end)
3337 ;; Both a preceding and a following backslash.
3338 ;; Choose the greatest of them.
3339 (setq column (max column bs-col-after-end)))
3341 ;; No preceding backslash. Try to align with one
3342 ;; following the region. Disregard the backslash at the
3343 ;; to line since it's likely to be bogus (e.g. when
3344 ;; called from c-newline-and-indent).
3345 (if (numberp bs-col-after-end)
3346 (setq column bs-col-after-end))
3347 ;; Don't modify blank lines at start of region.
3349 (while (and (< (point) to) (bolp) (eolp))
3351 (if (and column (< column longest-line-col))
3352 ;; Don't try to align with surrounding backslashes if
3353 ;; any line is too long.
3356 ;; Impose minimum limit and tab width alignment only if
3357 ;; we can't align with surrounding backslashes.
3358 (if (> (% longest-line-col tab-width) 0)
3359 (setq longest-line-col
3360 (* (/ (+ longest-line-col tab-width -1)
3363 (setq column (max c-backslash-column
3365 ;; Always impose maximum limit.
3366 (setq column (min column c-backslash-max-column)))
3367 (if bs-col-after-end
3368 ;; Add backslashes on all lines if the macro continues
3369 ;; after the to line.
3371 (set-marker endmark to)
3372 (c-append-backslashes-forward endmark column point-pos))
3373 ;; Add backslashes on all lines except the last, and
3374 ;; remove any on the last line.
3379 (set-marker endmark (1- (point)))))
3381 (c-append-backslashes-forward endmark column point-pos)
3382 ;; The function above leaves point on the line
3383 ;; following endmark.
3384 (set-marker endmark (point)))
3385 (set-marker endmark to))
3386 (c-delete-backslashes-forward endmark point-pos)))))
3387 (set-marker endmark nil)
3388 (if (markerp point-pos)
3389 (set-marker point-pos nil))))
3391 (defun c-append-backslashes-forward (to-mark column point-pos)
3392 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3396 (<= (point) to-mark)
3398 (let ((start (point)) (inserted nil) end col)
3400 (unless (eq (char-before) ?\\)
3403 (setq state (parse-partial-sexp
3404 start (point) nil nil state))
3406 (setq col (current-column))
3408 ;; Avoid unnecessary changes of the buffer.
3409 (cond ((and (not inserted) (nth 3 state))
3410 ;; Don't realign backslashes in string literals
3411 ;; since that would change them.
3418 (skip-chars-backward
3419 " \t" (if (>= (point) point-pos) point-pos))
3423 ((and (= col column)
3424 (memq (char-before) '(?\ ?\t))))
3428 (or (/= (skip-chars-backward
3429 " \t" (if (>= (point) point-pos) point-pos))
3431 (/= (char-after) ?\ )))
3432 (delete-region (point) end)
3433 (indent-to column 1)))
3435 (zerop (forward-line 1)))
3436 (bolp))) ; forward-line has funny behavior at eob.
3438 ;; Make sure there are backslashes with at least one space in
3442 (<= (point) to-mark)
3444 (let ((start (point)))
3446 (setq state (parse-partial-sexp
3447 start (point) nil nil state))
3449 (if (eq (char-before) ?\\)
3450 (unless (nth 3 state)
3452 (unless (and (memq (char-before) '(?\ ?\t))
3453 (/= (point) point-pos))
3456 (if (and (memq (char-before) '(?\ ?\t))
3457 (/= (point) point-pos))
3461 (zerop (forward-line 1)))
3462 (bolp)))))) ; forward-line has funny behavior at eob.
3464 (defun c-delete-backslashes-forward (to-mark point-pos)
3466 (and (<= (point) to-mark)
3469 (if (eq (char-before) ?\\)
3472 (progn (backward-char)
3473 (skip-chars-backward " \t" (if (>= (point) point-pos)
3476 (zerop (forward-line 1)))
3477 (bolp)))) ; forward-line has funny behavior at eob.
3481 ;;; Line breaking and paragraph filling.
3483 (defvar c-auto-fill-prefix t)
3484 (defvar c-lit-limits nil)
3485 (defvar c-lit-type nil)
3487 ;; The filling code is based on a simple theory; leave the intricacies
3488 ;; of the text handling to the currently active mode for that
3489 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3490 ;; possible to make them work correctly wrt the comment and string
3491 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3492 ;; to it, there's quite a lot of special cases to handle which makes
3493 ;; the code anything but simple. The intention is that it will work
3494 ;; with any well-written text filling package that preserves a fill
3497 ;; We temporarily mask comment starters and enders as necessary for
3498 ;; the filling code to do its job on a seemingly normal text block.
3499 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3500 ;; preserve it correctly (especially important when filling C++ style
3501 ;; line comments). By default, we set up and use adaptive-fill-mode,
3502 ;; which is standard in all supported Emacs flavors.
3504 (defun c-guess-fill-prefix (lit-limits lit-type)
3505 ;; Determine the appropriate comment fill prefix for a block or line
3506 ;; comment. Return a cons of the prefix string and the column where
3507 ;; it ends. If fill-prefix is set, it'll override. Note that this
3508 ;; function also uses the value of point in some heuristics.
3510 ;; This function might do hidden buffer changes.
3512 (let* ((here (point))
3513 (prefix-regexp (concat "[ \t]*\\("
3514 c-current-comment-prefix
3516 (comment-start-regexp (if (eq lit-type 'c++)
3518 comment-start-skip))
3519 prefix-line comment-prefix res comment-text-end)
3523 (setq res (cons fill-prefix
3524 ;; Ugly way of getting the column after the fill
3525 ;; prefix; it'd be nice with a current-column
3526 ;; that works on strings..
3527 (let ((start (point)))
3530 (insert-and-inherit "\n" fill-prefix)
3532 (delete-region start (point)))))))
3536 ;; Set fallback for comment-prefix if none is found.
3537 (setq comment-prefix "// "
3538 comment-text-end (cdr lit-limits))
3541 (if (> (point) (car lit-limits))
3542 ;; The current line is not the comment starter, so the
3543 ;; comment has more than one line, and it can therefore be
3544 ;; used to find the comment fill prefix.
3545 (setq prefix-line (point))
3547 (goto-char (car lit-limits))
3548 (if (and (= (forward-line 1) 0)
3549 (< (point) (cdr lit-limits)))
3550 ;; The line after the comment starter is inside the
3551 ;; comment, so we can use it.
3552 (setq prefix-line (point))
3554 ;; The comment is only one line. Take the comment prefix
3555 ;; from it and keep the indentation.
3556 (goto-char (car lit-limits))
3557 (if (looking-at prefix-regexp)
3558 (goto-char (match-end 0))
3560 (skip-chars-forward " \t"))
3563 (if (eq (c-point 'boi) (car lit-limits))
3564 ;; There is only whitespace before the comment
3565 ;; starter; take the prefix straight from this line.
3566 (setq str (buffer-substring-no-properties
3567 (c-point 'bol) (point))
3568 col (current-column))
3570 ;; There is code before the comment starter, so we
3571 ;; have to temporarily insert and indent a new line to
3572 ;; get the right space/tab mix in the indentation.
3573 (let ((prefix-len (- (point) (car lit-limits)))
3577 (goto-char (car lit-limits))
3578 (indent-to (prog1 (current-column)
3581 (forward-char prefix-len)
3582 (setq str (buffer-substring-no-properties
3583 (c-point 'bol) (point))
3584 col (current-column)))
3585 (delete-region (car lit-limits) tmp))))
3588 (if (or (string-match "\\s \\'" str) (not (eolp)))
3590 ;; The prefix ends the line with no whitespace
3591 ;; after it. Default to a single space.
3592 (cons (concat str " ") (1+ col))))
3596 (setq comment-text-end
3598 (goto-char (- (cdr lit-limits) 2))
3599 (if (looking-at "\\*/") (point) (cdr lit-limits))))
3603 (if (and (> (point) (car lit-limits))
3604 (not (and (looking-at "[ \t]*\\*/")
3605 (eq (cdr lit-limits) (match-end 0)))))
3606 ;; The current line is not the comment starter and
3607 ;; contains more than just the ender, so it's good enough
3608 ;; to be used for the comment fill prefix.
3609 (setq prefix-line (point))
3610 (goto-char (car lit-limits))
3612 (cond ((or (/= (forward-line 1) 0)
3613 (>= (point) (cdr lit-limits))
3614 (and (looking-at "[ \t]*\\*/")
3615 (eq (cdr lit-limits) (match-end 0)))
3616 (and (looking-at prefix-regexp)
3617 (<= (1- (cdr lit-limits)) (match-end 0))))
3618 ;; The comment is either one line or the next line contains
3619 ;; just the comment ender. In this case we have no
3620 ;; information about a suitable comment prefix, so we resort
3621 ;; to c-block-comment-prefix.
3622 (setq comment-prefix (or c-block-comment-prefix "")))
3625 ;; The point was on the comment opener line, so we might want
3626 ;; to treat this as a not yet closed comment.
3628 (if (and (match-beginning 1)
3629 (/= (match-beginning 1) (match-end 1)))
3630 ;; Above `prefix-regexp' matched a nonempty prefix on the
3631 ;; second line, so let's use it. Normally it should do
3632 ;; to set `prefix-line' and let the code below pick up
3633 ;; the whole prefix, but if there's no text after the
3634 ;; match then it will probably fall back to no prefix at
3635 ;; all if the comment isn't closed yet, so in that case
3636 ;; it's better to force use of the prefix matched now.
3637 (if (= (match-end 0) (c-point 'eol))
3638 (setq comment-prefix (match-string 1))
3639 (setq prefix-line (point)))
3641 ;; There's no nonempty prefix on the line after the
3642 ;; comment opener. If the line is empty, or if the
3643 ;; text on it has less or equal indentation than the
3644 ;; comment starter we assume it's an unclosed
3645 ;; comment starter, i.e. that
3646 ;; `c-block-comment-prefix' should be used.
3647 ;; Otherwise we assume it's a closed comment where
3648 ;; the prefix really is the empty string.
3649 ;; E.g. this is an unclosed comment:
3660 ;; (Looking for the presence of the comment closer
3661 ;; rarely works since it's probably the closer of
3662 ;; some comment further down when the comment
3663 ;; really is unclosed.)
3664 (if (<= (save-excursion (back-to-indentation)
3666 (save-excursion (goto-char (car lit-limits))
3668 (setq comment-prefix (or c-block-comment-prefix ""))
3669 (setq prefix-line (point)))))
3672 ;; Otherwise the line after the comment starter is good
3673 ;; enough to find the prefix in.
3674 (setq prefix-line (point))))
3676 (when comment-prefix
3677 ;; Haven't got the comment prefix on any real line that we
3678 ;; can take it from, so we have to temporarily insert
3679 ;; `comment-prefix' on a line and indent it to find the
3680 ;; correct column and the correct mix of tabs and spaces.
3682 (let (tmp-pre tmp-post)
3686 (goto-char (car lit-limits))
3687 (if (looking-at comment-start-regexp)
3688 (goto-char (min (match-end 0)
3691 (skip-chars-forward " \t"))
3693 (when (eq (char-syntax (char-before)) ?\ )
3694 ;; If there's ws on the current line, we'll use it
3695 ;; instead of what's ending comment-prefix.
3696 (setq comment-prefix
3697 (concat (substring comment-prefix
3701 (buffer-substring-no-properties
3703 (skip-chars-backward " \t")
3707 (setq tmp-pre (point-marker))
3709 ;; We insert an extra non-whitespace character
3710 ;; before the line break and after comment-prefix in
3711 ;; case it's "" or ends with whitespace.
3712 (insert-and-inherit "x\n" comment-prefix "x")
3713 (setq tmp-post (point-marker))
3715 (indent-according-to-mode)
3717 (goto-char (1- tmp-post))
3718 (cons (buffer-substring-no-properties
3719 (c-point 'bol) (point))
3723 (delete-region tmp-pre tmp-post)
3724 (set-marker tmp-pre nil)
3725 (set-marker tmp-post nil))))))))))
3727 (or res ; Found a good prefix above.
3730 ;; prefix-line is the bol of a line on which we should try
3731 ;; to find the prefix.
3732 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3735 (when (and (looking-at prefix-regexp)
3736 (<= (match-end 0) comment-text-end))
3737 (unless (eq (match-end 0) (c-point 'eol))
3738 ;; The match is fine if there's text after it.
3739 (throw 'found (cons (buffer-substring-no-properties
3740 (match-beginning 0) (match-end 0))
3741 (progn (goto-char (match-end 0))
3742 (current-column)))))
3744 ;; This match is better than nothing, so let's
3745 ;; remember it in case nothing better is found
3747 (setq fb-string (buffer-substring-no-properties
3748 (match-beginning 0) (match-end 0))
3749 fb-endpos (match-end 0)))
3753 ;; Search for a line which has text after the prefix
3754 ;; so that we get the proper amount of whitespace
3755 ;; after it. We start with the current line, then
3756 ;; search backwards, then forwards.
3758 (goto-char prefix-line)
3759 (when (and (funcall test-line)
3760 (or (/= (match-end 1) (match-end 0))
3761 ;; The whitespace is sucked up by the
3762 ;; first [ \t]* glob if the prefix is empty.
3763 (and (= (match-beginning 1) (match-end 1))
3764 (/= (match-beginning 0) (match-end 0)))))
3765 ;; If the current line doesn't have text but do
3766 ;; have whitespace after the prefix, we'll use it.
3767 (throw 'found (cons fb-string
3768 (progn (goto-char fb-endpos)
3769 (current-column)))))
3771 (if (eq lit-type 'c++)
3772 ;; For line comments we can search up to and
3773 ;; including the first line.
3774 (while (and (zerop (forward-line -1))
3775 (>= (point) (car lit-limits)))
3776 (funcall test-line))
3777 ;; For block comments we must stop before the
3779 (while (and (zerop (forward-line -1))
3780 (> (point) (car lit-limits)))
3781 (funcall test-line)))
3783 (goto-char prefix-line)
3784 (while (and (zerop (forward-line 1))
3785 (< (point) (cdr lit-limits)))
3786 (funcall test-line))
3788 (goto-char prefix-line)
3792 ;; A good line wasn't found, but at least we have a
3793 ;; fallback that matches the comment prefix regexp.
3794 (cond ((or (string-match "\\s \\'" fb-string)
3796 (goto-char fb-endpos)
3798 ;; There are ws or text after the prefix, so
3800 (cons fb-string (current-column)))
3803 ;; Check if there's any whitespace padding
3804 ;; on the comment start line that we can
3805 ;; use after the prefix.
3806 (goto-char (car lit-limits))
3807 (if (looking-at comment-start-regexp)
3808 (goto-char (match-end 0))
3810 (skip-chars-forward " \t"))
3812 (eq (char-syntax (char-before)) ?\ )))
3814 (setq fb-string (buffer-substring-no-properties
3816 (skip-chars-backward " \t")
3819 (goto-char fb-endpos)
3820 (skip-chars-backward " \t")
3822 (let ((tmp (point)))
3823 ;; Got to mess in the buffer once again to
3824 ;; ensure the column gets correct. :P
3827 (insert-and-inherit fb-string)
3828 (cons (buffer-substring-no-properties
3832 (delete-region tmp (point)))))
3835 ;; Last resort: Just add a single space after
3837 (cons (concat fb-string " ")
3838 (progn (goto-char fb-endpos)
3839 (1+ (current-column)))))))
3841 ;; The line doesn't match the comment prefix regexp.
3843 ;; We have a fallback for line comments that we must use.
3844 (cons (concat (buffer-substring-no-properties
3845 prefix-line (c-point 'boi))
3847 (progn (back-to-indentation)
3848 (+ (current-column) (length comment-prefix))))
3850 ;; Assume we are dealing with a "free text" block
3851 ;; comment where the lines doesn't have any comment
3852 ;; prefix at all and we should just fill it as
3857 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
3858 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3859 ;; masked to allow adaptive filling to work correctly. That
3860 ;; includes narrowing the buffer and, if point is inside a comment,
3861 ;; masking the comment starter and ender appropriately.
3863 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3864 ;; The position of point is then less significant when doing masking
3867 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3868 ;; only if the point turns out to be inside a comment or a string.
3870 ;; Note that this function does not do any hidden buffer changes.
3873 ;; beg and end limit the region to narrow. end is a marker.
3875 ;; tmp-pre and tmp-post mark strings that are temporarily
3876 ;; inserted at the start and end of the region. tmp-pre is a
3877 ;; cons of the positions of the prepended string. tmp-post is
3878 ;; a marker pointing to the single character of the appended
3881 ;; If hang-ender-stuck isn't nil, the comment ender is
3882 ;; hanging. In that case it's set to the number of spaces
3883 ;; that should be between the text and the ender.
3885 ;; auto-fill-spaces is the exact sequence of whitespace between a
3886 ;; comment's last word and the comment ender, temporarily replaced
3887 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
3890 (c-lit-limits c-lit-limits)
3891 (c-lit-type c-lit-type))
3893 ;; Restore point on undo. It's necessary since we do a lot of
3894 ;; hidden inserts and deletes below that should be as transparent
3896 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
3897 (setq buffer-undo-list (cons (point) buffer-undo-list)))
3899 ;; Determine the limits and type of the containing literal (if any):
3900 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
3902 (c-save-buffer-state ()
3904 ;; Widen to catch comment limits correctly.
3906 (unless c-lit-limits
3907 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
3908 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
3910 (setq c-lit-type (c-literal-type c-lit-limits))))
3913 (unless (c-safe (backward-char)
3917 (forward-paragraph))
3918 (setq end (point-marker)))
3920 (unless (c-safe (forward-char)
3921 (backward-paragraph)
3924 (backward-paragraph))
3925 (setq beg (point))))
3929 ;; For each of the possible types of text (string, C comment ...)
3930 ;; determine BEG and END, the region we will narrow to. If we're in
3931 ;; a literal, constrain BEG and END to the limits of this literal.
3933 ;; For some of these text types, particularly a block comment, we
3934 ;; may need to massage whitespace near literal delimiters, so that
3935 ;; these don't get filled inappropriately.
3938 ((eq c-lit-type 'c++) ; Line comment.
3940 ;; Limit to the comment or paragraph end, whichever
3942 (set-marker end (min end (cdr c-lit-limits)))
3944 (when (<= beg (car c-lit-limits))
3945 ;; The region includes the comment starter, so we must
3947 (goto-char (car c-lit-limits))
3948 (back-to-indentation)
3949 (if (eq (point) (car c-lit-limits))
3950 ;; Include the first line in the region.
3951 (setq beg (c-point 'bol))
3952 ;; The first line contains code before the
3953 ;; comment. We must fake a line that doesn't.
3956 (setq apply-outside-literal t))
3958 ((eq c-lit-type 'c) ; Block comment.
3960 (or (> end (cdr c-lit-limits))
3961 (and (= end (cdr c-lit-limits))
3962 (eq (char-before end) ?/)
3963 (eq (char-before (1- end)) ?*)
3965 (> (- (cdr c-lit-limits) (car c-lit-limits)) 3)))
3966 ;; There is a comment ender, and the region includes it. If
3967 ;; it's on its own line, it stays on its own line. If it's got
3968 ;; company on the line, it keeps (at least one word of) it.
3969 ;; "=====*/" counts as a comment ender here, but "===== */"
3970 ;; doesn't and "foo*/" doesn't.
3973 (goto-char (cdr c-lit-limits))
3975 ;; The following conjunct was added to avoid an
3976 ;; "Invalid search bound (wrong side of point)"
3977 ;; error in the subsequent re-search. Maybe
3978 ;; another fix would be needed (2007-12-08).
3979 ; (or (<= (- (cdr c-lit-limits) 2) (point))
3980 ; 2010-10-17 Construct removed.
3981 ; (or (< (- (cdr c-lit-limits) 2) (point))
3983 (search-forward-regexp
3984 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
3985 (- (cdr c-lit-limits) 2) t)
3986 (not (search-forward-regexp
3988 (- (cdr c-lit-limits) 2) 'limit))
3989 ;; The comment ender IS on its own line. Exclude this
3990 ;; line from the filling.
3991 (set-marker end (c-point 'bol))));)
3993 ;; The comment ender is hanging. Replace all space between it
3994 ;; and the last word either by one or two 'x's (when
3995 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
3996 ;; as the whitespace (when auto filling), and include it in
3997 ;; the region. We'll change them back to whitespace
3998 ;; afterwards. The effect of this is to glue the comment
3999 ;; ender to the last word in the comment during filling.
4000 (let* ((ender-start (save-excursion
4001 (goto-char (cdr c-lit-limits))
4002 (skip-syntax-backward "^w ")
4004 (ender-column (save-excursion
4005 (goto-char ender-start)
4007 (point-rel (- ender-start here))
4008 (sentence-ends-comment
4010 (goto-char ender-start)
4011 (and (search-backward-regexp
4012 (c-sentence-end) (c-point 'bol) t)
4013 (goto-char (match-end 0))
4014 (looking-at "[ \t]*")
4015 (= (match-end 0) ender-start))))
4019 ;; Insert a CR after the "*/", adjust END
4020 (goto-char (cdr c-lit-limits))
4021 (setq tmp-post (point-marker))
4023 (set-marker end (point))
4025 (forward-line -1) ; last line of the comment
4026 (if (and (looking-at (concat "[ \t]*\\(\\("
4027 c-current-comment-prefix
4029 (eq ender-start (match-end 0)))
4030 ;; The comment ender is prefixed by nothing but a
4031 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4032 ;; 2006/4/28). Remove it along with surrounding ws.
4033 (setq spaces (- (match-end 1) (match-end 2)))
4034 (goto-char ender-start))
4035 (skip-chars-backward " \t\r\n") ; Surely this can be
4036 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4038 ;; What's being tested here? 2006/4/20. FIXME!!!
4039 (if (/= (point) ender-start)
4041 (if (<= here (point))
4042 ;; Don't adjust point below if it's
4043 ;; before the string we replace.
4044 (setq point-rel -1))
4045 ;; Keep one or two spaces between the
4046 ;; text and the ender, depending on how
4047 ;; many there are now.
4049 (setq spaces (- ender-column (current-column))))
4050 (setq auto-fill-spaces (c-delete-and-extract-region
4051 (point) ender-start))
4052 ;; paragraph filling condenses multiple spaces to
4053 ;; single or double spaces. auto-fill doesn't.
4058 (if (and sentence-ends-comment
4059 sentence-end-double-space)
4062 ;; Insert the filler first to keep marks right.
4063 (insert-char ?x spaces t)
4064 (setq hang-ender-stuck spaces)
4066 (and (>= point-rel 0)
4067 (- (point) (min point-rel spaces)))))
4068 (setq point-rel nil)))
4071 ;; Point was in the middle of the string we
4072 ;; replaced above, so put it back in the same
4073 ;; relative position, counting from the end.
4074 (goto-char point-rel)))
4077 (when (<= beg (car c-lit-limits))
4078 ;; The region includes the comment starter.
4080 (goto-char (car c-lit-limits))
4081 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
4082 ;; Begin with the next line.
4083 (setq beg (c-point 'bonl))
4084 ;; Fake the fill prefix in the first line.
4087 (setq apply-outside-literal t))
4089 ((eq c-lit-type 'string) ; String.
4091 (when (>= end (cdr c-lit-limits))
4092 (goto-char (1- (cdr c-lit-limits)))
4093 (setq tmp-post (point-marker))
4095 (set-marker end (point)))
4096 (when (<= beg (car c-lit-limits))
4097 (goto-char (1+ (car c-lit-limits)))
4098 (setq beg (if (looking-at "\\\\$")
4099 ;; Leave the start line if it's
4100 ;; nothing but an escaped newline.
4103 (setq apply-outside-literal t))
4105 ((eq c-lit-type 'pound) ; Macro
4106 ;; Narrow to the macro limits if they are nearer than the
4107 ;; paragraph limits. Don't know if this is necessary but
4108 ;; do it for completeness sake (doing auto filling at all
4109 ;; inside macros is bogus to begin with since the line
4110 ;; continuation backslashes aren't handled).
4112 (c-save-buffer-state ()
4113 (c-beginning-of-macro)
4120 (set-marker end (point))))))
4123 ;; Try to avoid comments and macros in the paragraph to
4124 ;; avoid that the adaptive fill mode gets the prefix from
4126 (c-save-buffer-state nil
4129 (c-forward-syntactic-ws end)
4133 (c-backward-syntactic-ws beg)
4135 (set-marker end (point))))))
4138 ;; Temporarily insert the fill prefix after the comment
4139 ;; starter so that the first line looks like any other
4140 ;; comment line in the narrowed region.
4141 (setq fill (c-save-buffer-state nil
4142 (c-guess-fill-prefix c-lit-limits c-lit-type)))
4143 (unless (string-match (concat "\\`[ \t]*\\("
4144 c-current-comment-prefix
4147 ;; Oops, the prefix doesn't match the comment prefix
4148 ;; regexp. This could produce very confusing
4149 ;; results with adaptive fill packages together with
4150 ;; the insert prefix magic below, since the prefix
4151 ;; often doesn't appear at all. So let's warn about
4154 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4156 ;; Find the right spot on the line, break it, insert
4157 ;; the fill prefix and make sure we're back in the
4158 ;; same column by temporarily prefixing the first word
4159 ;; with a number of 'x'.
4161 (goto-char (car c-lit-limits))
4162 (if (looking-at (if (eq c-lit-type 'c++)
4163 c-current-comment-prefix
4164 comment-start-skip))
4165 (goto-char (match-end 0))
4167 (skip-chars-forward " \t"))
4168 (while (and (< (current-column) (cdr fill))
4171 (let ((col (current-column)))
4172 (setq beg (1+ (point))
4173 tmp-pre (list (point)))
4176 (insert-and-inherit "\n" (car fill))
4177 (insert-char ?x (- col (current-column)) t))
4178 (setcdr tmp-pre (point))))))
4180 (when apply-outside-literal
4181 ;; `apply-outside-literal' is always set to t here if
4182 ;; we're inside a literal.
4186 ;; Kludge: If the function that adapts the fill prefix
4187 ;; doesn't produce the required comment starter for
4188 ;; line comments, then force it by setting fill-prefix.
4189 (when (and (eq c-lit-type 'c++)
4190 ;; Kludge the kludge: filladapt-mode doesn't
4191 ;; have this problem, but it currently
4192 ;; doesn't override fill-context-prefix
4194 (not (and (boundp 'filladapt-mode)
4198 (or (fill-context-prefix beg end)
4200 (c-save-buffer-state nil
4201 (car (or fill (c-guess-fill-prefix
4202 c-lit-limits c-lit-type)))))))
4204 ;; Save the relative position of point if it's outside the
4205 ;; region we're going to narrow. Want to restore it in that
4206 ;; case, but otherwise it should be moved according to the
4208 (point-rel (cond ((< (point) beg) (- (point) beg))
4209 ((> (point) end) (- (point) end)))))
4211 ;; Preparations finally done! Now we can call the
4215 (narrow-to-region beg end)
4218 ;; Restore point if it was outside the region.
4220 (goto-char (+ beg point-rel))
4221 (goto-char (+ end point-rel))))))))
4223 (when (consp tmp-pre)
4224 (delete-region (car tmp-pre) (cdr tmp-pre)))
4228 (goto-char tmp-post)
4230 (when hang-ender-stuck
4231 ;; Preserve point even if it's in the middle of the string
4232 ;; we replace; save-excursion doesn't work in that case.
4234 (goto-char tmp-post)
4235 (skip-syntax-backward "^w ")
4236 (forward-char (- hang-ender-stuck))
4237 (if (or fill-paragraph (not auto-fill-spaces))
4238 (insert-char ?\ hang-ender-stuck t)
4239 (insert auto-fill-spaces))
4240 (delete-char hang-ender-stuck)
4242 (set-marker tmp-post nil))
4244 (set-marker end nil))))
4246 (defun c-fill-paragraph (&optional arg)
4247 "Like \\[fill-paragraph] but handles C and C++ style comments.
4248 If any of the current line is a comment or within a comment, fill the
4249 comment or the paragraph of it that point is in, preserving the
4250 comment indentation or line-starting decorations (see the
4251 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4254 If point is inside multiline string literal, fill it. This currently
4255 does not respect escaped newlines, except for the special case when it
4256 is the very first thing in the string. The intended use for this rule
4257 is in situations like the following:
4259 char description[] = \"\\
4260 A very long description of something that you want to fill to make
4261 nicely formatted output.\"\;
4263 If point is in any other situation, i.e. in normal code, do nothing.
4265 Optional prefix ARG means justify paragraph as well."
4267 (let ((fill-paragraph-function
4268 ;; Avoid infinite recursion.
4269 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4270 fill-paragraph-function))
4271 (start-point (point-marker)))
4273 t nil (lambda () (fill-region-as-paragraph (point-min) (point-max) arg)))
4274 (goto-char start-point))
4275 ;; Always return t. This has the effect that if filling isn't done
4276 ;; above, it isn't done at all, and it's therefore effectively
4277 ;; disabled in normal code.
4280 (defun c-do-auto-fill ()
4281 ;; Do automatic filling if not inside a context where it should be
4283 (let ((c-auto-fill-prefix
4284 ;; The decision whether the line should be broken is actually
4285 ;; done in c-indent-new-comment-line, which do-auto-fill
4286 ;; calls to break lines. We just set this special variable
4287 ;; so that we'll know when we're called from there. It's
4288 ;; also used to detect whether fill-prefix is user set or
4289 ;; generated automatically by do-auto-fill.
4291 (c-mask-paragraph nil t 'do-auto-fill)))
4293 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4294 "Break line at point and indent, continuing comment or macro if within one.
4295 If inside a comment and `comment-multi-line' is non-nil, the
4296 indentation and line prefix are preserved (see the
4297 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4298 details). If inside a single line comment and `comment-multi-line' is
4299 nil, a new comment of the same type is started on the next line and
4300 indented as appropriate for comments. If inside a macro, a line
4301 continuation backslash is inserted and aligned as appropriate, and the
4302 new line is indented according to `c-syntactic-indentation'.
4304 If a fill prefix is specified, it overrides all the above."
4305 ;; allow-auto-fill is used from c-context-line-break to allow auto
4306 ;; filling to break the line more than once. Since this function is
4307 ;; used from auto-fill itself, that's normally disabled to avoid
4308 ;; unnecessary recursion.
4310 (let ((fill-prefix fill-prefix)
4313 (delete-horizontal-space)
4315 (insert-and-inherit ?\n)
4316 (newline (if allow-auto-fill nil 1)))))
4317 ;; Already know the literal type and limits when called from
4318 ;; c-context-line-break.
4319 (c-lit-limits c-lit-limits)
4320 (c-lit-type c-lit-type)
4321 (c-macro-start c-macro-start))
4323 (c-save-buffer-state ()
4324 (when (not (eq c-auto-fill-prefix t))
4325 ;; Called from do-auto-fill.
4326 (unless c-lit-limits
4327 (setq c-lit-limits (c-literal-limits nil nil t)))
4329 (setq c-lit-type (c-literal-type c-lit-limits)))
4330 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4331 ((null c-lit-type) 'code)
4334 (setq fill-prefix t) ; Used as flag in the cond.
4335 (if (and (null c-auto-fill-prefix)
4337 (<= (c-point 'bol) (car c-lit-limits)))
4338 ;; The adaptive fill function has generated a prefix, but
4339 ;; we're on the first line in a block comment so it'll be
4340 ;; wrong. Ignore it to guess a better one below.
4341 (setq fill-prefix nil)
4342 (when (and (eq c-lit-type 'c++)
4343 (not (string-match (concat "\\`[ \t]*"
4344 c-line-comment-starter)
4345 (or fill-prefix ""))))
4346 ;; Kludge: If the function that adapted the fill prefix
4347 ;; doesn't produce the required comment starter for line
4348 ;; comments, then we ignore it.
4349 (setq fill-prefix nil)))
4352 (cond ((eq fill-prefix t)
4353 ;; A call from do-auto-fill which should be ignored.
4356 ;; A fill-prefix overrides anything.
4357 (funcall do-line-break)
4358 (insert-and-inherit fill-prefix))
4359 ((c-save-buffer-state ()
4360 (unless c-lit-limits
4361 (setq c-lit-limits (c-literal-limits)))
4363 (setq c-lit-type (c-literal-type c-lit-limits)))
4364 (memq c-lit-type '(c c++)))
4365 ;; Some sort of comment.
4366 (if (or comment-multi-line
4368 (goto-char (car c-lit-limits))
4370 (< (point) (cdr c-lit-limits))))
4371 ;; Inside a comment that should be continued.
4372 (let ((fill (c-save-buffer-state nil
4373 (c-guess-fill-prefix
4375 (c-collect-line-comments c-lit-limits))
4378 (start-col (current-column))
4380 (or (and (eq c-lit-type 'c)
4382 (goto-char (- (cdr c-lit-limits) 2))
4383 (if (looking-at "\\*/") (point))))
4384 (cdr c-lit-limits))))
4385 ;; Skip forward past the fill prefix in case
4386 ;; we're standing in it.
4388 ;; FIXME: This doesn't work well in cases like
4390 ;; /* Bla bla bla bla bla
4393 ;; If point is on the 'B' then the line will be
4394 ;; broken after "Bla b".
4396 ;; If we have an empty comment, /* */, the next
4397 ;; lot of code pushes point to the */. We fix
4398 ;; this by never allowing point to end up to the
4399 ;; right of where it started.
4400 (while (and (< (current-column) (cdr fill))
4403 (if (and (> (point) comment-text-end)
4404 (> (c-point 'bol) (car c-lit-limits)))
4406 ;; The skip takes us out of the (block)
4407 ;; comment; insert the fill prefix at bol
4408 ;; instead and keep the position.
4409 (setq pos (copy-marker pos t))
4411 (insert-and-inherit (car fill))
4412 (if soft (insert-and-inherit ?\n) (newline 1))
4414 (set-marker pos nil))
4415 ;; Don't break in the middle of a comment starter
4417 (cond ((> (point) comment-text-end)
4418 (goto-char comment-text-end))
4419 ((< (point) (+ (car c-lit-limits) 2))
4420 (goto-char (+ (car c-lit-limits) 2))))
4421 (funcall do-line-break)
4422 (insert-and-inherit (car fill))
4423 (if (> (current-column) start-col)
4424 (move-to-column start-col)))) ; can this hit the
4426 ;; Inside a comment that should be broken.
4427 (let ((comment-start comment-start)
4428 (comment-end comment-end)
4430 (if (eq c-lit-type 'c)
4431 (unless (string-match "[ \t]*/\\*" comment-start)
4432 (setq comment-start "/* " comment-end " */"))
4433 (unless (string-match "[ \t]*//" comment-start)
4434 (setq comment-start "// " comment-end "")))
4435 (setq col (save-excursion
4436 (back-to-indentation)
4438 (funcall do-line-break)
4439 (when (and comment-end (not (equal comment-end "")))
4441 (insert-and-inherit comment-end)
4443 ;; c-comment-indent may look at the current
4444 ;; indentation, so let's start out with the same
4445 ;; indentation as the previous one.
4447 (insert-and-inherit comment-start)
4448 (indent-for-comment))))
4449 ((c-query-and-set-macro-start)
4451 (unless (looking-at "[ \t]*\\\\$")
4452 ;; Do not clobber the alignment of the line continuation
4453 ;; slash; c-backslash-region might look at it.
4454 (delete-horizontal-space))
4455 ;; Got an asymmetry here: In normal code this command
4456 ;; doesn't indent the next line syntactically, and otoh a
4457 ;; normal syntactically indenting newline doesn't continue
4459 (c-newline-and-indent (if allow-auto-fill nil 1)))
4461 ;; Somewhere else in the code.
4462 (let ((col (save-excursion
4464 (while (and (looking-at "[ \t]*\\\\?$")
4465 (= (forward-line -1) 0)))
4466 (current-indentation))))
4467 (funcall do-line-break)
4468 (indent-to col))))))
4470 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
4471 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line "21.1")
4473 ;; advice for indent-new-comment-line for older Emacsen
4474 (unless (boundp 'comment-line-break-function)
4475 (defvar c-inside-line-break-advice nil)
4476 (defadvice indent-new-comment-line (around c-line-break-advice
4477 activate preactivate)
4478 "Call `c-indent-new-comment-line' if in CC Mode."
4479 (if (or c-inside-line-break-advice
4480 (not c-buffer-is-cc-mode))
4482 (let ((c-inside-line-break-advice t))
4483 (c-indent-new-comment-line (ad-get-arg 0))))))
4485 (defun c-context-line-break ()
4486 "Do a line break suitable to the context.
4488 When point is outside a comment or macro, insert a newline and indent
4489 according to the syntactic context, unless `c-syntactic-indentation'
4490 is nil, in which case the new line is indented as the previous
4491 non-empty line instead.
4493 When point is inside the content of a preprocessor directive, a line
4494 continuation backslash is inserted before the line break and aligned
4495 appropriately. The end of the cpp directive doesn't count as inside
4498 When point is inside a comment, continue it with the appropriate
4499 comment prefix (see the `c-comment-prefix-regexp' and
4500 `c-block-comment-prefix' variables for details). The end of a
4501 C++-style line comment doesn't count as inside it.
4503 When point is inside a string, only insert a backslash when it is also
4504 inside a preprocessor directive."
4507 (let* (c-lit-limits c-lit-type
4508 (c-macro-start c-macro-start))
4510 (c-save-buffer-state ()
4511 (setq c-lit-limits (c-literal-limits nil nil t)
4512 c-lit-type (c-literal-type c-lit-limits))
4513 (when (eq c-lit-type 'c++)
4514 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4515 (c-query-and-set-macro-start))
4518 ((or (eq c-lit-type 'c)
4519 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4521 (skip-chars-forward " \t")
4523 (1- (cdr c-lit-limits))))
4524 (and (numberp c-macro-start) ; Macro, but not at the very end of
4525 ; it, not in a string, and not in the
4527 (not (eq c-lit-type 'string))
4528 (or (not (looking-at "\\s *$"))
4529 (eq (char-before) ?\\))
4531 (goto-char c-macro-start)
4532 (if (looking-at c-opt-cpp-start)
4533 (goto-char (match-end 0)))
4536 (let ((comment-multi-line t)
4538 (c-indent-new-comment-line nil t)))
4540 ((eq c-lit-type 'string)
4541 (if (and (numberp c-macro-start)
4542 (not (eq (char-before) ?\\)))
4546 (t (delete-horizontal-space)
4548 ;; c-indent-line may look at the current indentation, so let's
4549 ;; start out with the same indentation as the previous line.
4550 (let ((col (save-excursion
4553 (while (and (looking-at "[ \t]*\\\\?$")
4554 (= (forward-line -1) 0)))
4555 (current-indentation))))
4557 (indent-according-to-mode)))))
4559 (defun c-context-open-line ()
4560 "Insert a line break suitable to the context and leave point before it.
4561 This is the `c-context-line-break' equivalent to `open-line', which is
4562 normally bound to C-o. See `c-context-line-break' for the details."
4564 (let ((here (point)))
4567 ;; Temporarily insert a non-whitespace char to keep any
4568 ;; preceding whitespace intact.
4570 (c-context-line-break))
4575 (cc-provide 'cc-cmds)
4577 ;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
4578 ;;; cc-cmds.el ends here