1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
37 (if (and (boundp 'byte-compile-dest-file)
38 (stringp byte-compile-dest-file))
39 (cons (file-name-directory byte-compile-dest-file) load-path)
41 (load "cc-bytecomp" nil t)))
45 (cc-require 'cc-engine)
47 ;; Silence the compiler.
48 (cc-bytecomp-defvar filladapt-mode) ; c-fill-paragraph contains a kludge
49 ; which looks at this.
51 ;; Indentation / Display syntax functions
52 (defvar c-fix-backslashes t)
54 (defun c-indent-line (&optional syntax quiet ignore-point-pos)
55 "Indent the current line according to the syntactic context,
56 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
57 syntactic information for the current line. Be silent about syntactic
58 errors if the optional argument QUIET is non-nil, even if
59 `c-report-syntactic-errors' is non-nil. Normally the position of
60 point is used to decide where the old indentation is on a lines that
61 is otherwise empty \(ignoring any line continuation backslash), but
62 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
63 indentation change \(in columns)."
65 (let ((line-cont-backslash (save-excursion
67 (eq (char-before) ?\\)))
68 (c-fix-backslashes c-fix-backslashes)
71 (when (and (not ignore-point-pos)
74 (looking-at (if line-cont-backslash
75 ;; Don't use "\\s " - ^L doesn't count as WS
79 (<= (point) (match-end 1)))
80 ;; Delete all whitespace after point if there's only whitespace
81 ;; on the line, so that any code that does back-to-indentation
82 ;; or similar gets the current column in this case. If this
83 ;; removes a line continuation backslash it'll be restored
85 (unless c-auto-align-backslashes
86 ;; Should try to keep the backslash alignment
89 (goto-char (match-end 0))
90 (setq bs-col (1- (current-column)))))
91 (delete-region (point) (match-end 0))
92 (setq c-fix-backslashes t))
93 (if c-syntactic-indentation
95 (or (let ((c-parsing-error nil)
98 (and (boundp 'c-syntactic-context)
99 c-syntactic-context))))
100 (c-save-buffer-state (indent)
101 (unless c-syntactic-context
102 (setq c-syntactic-context (c-guess-basic-syntax)))
103 (setq indent (c-get-syntactic-indentation
104 c-syntactic-context))
105 (and (not (c-echo-parsing-error quiet))
106 c-echo-syntactic-information-p
107 (message "syntax: %s, indent: %d"
108 c-syntactic-context indent))
109 (setq shift-amt (- indent (current-indentation))))
110 (c-shift-line-indentation shift-amt)
111 (run-hooks 'c-special-indent-hook)
116 (while (and (= (forward-line -1) 0)
117 (if (looking-at "\\s *\\\\?$")
119 (setq indent (current-indentation))
121 (setq shift-amt (- indent (current-indentation)))
122 (c-shift-line-indentation shift-amt)))
123 (when (and c-fix-backslashes line-cont-backslash)
128 (when c-auto-align-backslashes
129 ;; Realign the line continuation backslash.
130 (c-backslash-region (point) (point) nil t))))
133 (defun c-newline-and-indent (&optional newline-arg)
134 "Insert a newline and indent the new line.
135 This function fixes line continuation backslashes if inside a macro,
136 and takes care to set the indentation before calling
137 `indent-according-to-mode', so that lineup functions like
138 `c-lineup-dont-change' works better."
140 ;; TODO: Backslashes before eol in comments and literals aren't
142 (let ((c-macro-start (c-query-macro-start))
143 ;; Avoid calling c-backslash-region from c-indent-line if it's
144 ;; called during the newline call, which can happen due to
145 ;; c-electric-continued-statement, for example. We also don't
146 ;; want any backslash alignment from indent-according-to-mode.
147 (c-fix-backslashes nil)
148 has-backslash insert-backslash
153 (while (and (looking-at "[ \t]*\\\\?$")
154 (= (forward-line -1) 0)))
155 (setq col (current-indentation)))
157 (if (and (eolp) (eq (char-before) ?\\))
158 (setq insert-backslash t
160 (setq has-backslash (eq (char-before (c-point 'eol)) ?\\))))
161 (newline newline-arg)
166 ;; The backslash stayed on the previous line. Insert one
167 ;; before calling c-backslash-region, so that
168 ;; bs-col-after-end in it works better. Fixup the
169 ;; backslashes on the newly inserted line.
172 (c-backslash-region (point) (point) nil t))
173 ;; The backslash moved to the new line, if there was any. Let
174 ;; c-backslash-region fix a backslash on the previous line,
175 ;; and the one that might be on the new line.
176 ;; c-auto-align-backslashes is intentionally ignored here;
177 ;; maybe the moved backslash should be left alone if it's set,
178 ;; but we fix both lines on the grounds that the old backslash
179 ;; has been moved anyway and is now in a different context.
180 (c-backslash-region start (if has-backslash (point) start) nil t)))
181 (when c-syntactic-indentation
182 ;; Reindent syntactically. The indentation done above is not
183 ;; wasted, since c-indent-line might look at the current
185 (let ((c-syntactic-context (c-save-buffer-state nil
186 (c-guess-basic-syntax))))
187 ;; We temporarily insert another line break, so that the
188 ;; lineup functions will see the line as empty. That makes
189 ;; e.g. c-lineup-cpp-define more intuitive since it then
190 ;; proceeds to the preceding line in this case.
192 (delete-horizontal-space)
193 (setq start (- (point-max) (point)))
197 (indent-according-to-mode))
198 (goto-char (- (point-max) start))
201 ;; Must align the backslash again after reindentation. The
202 ;; c-backslash-region call above can't be optimized to ignore
203 ;; this line, since it then won't align correctly with the
204 ;; lines below if the first line in the macro is broken.
205 (c-backslash-region (point) (point) nil t)))))
207 (defun c-show-syntactic-information (arg)
208 "Show syntactic information for current line.
209 With universal argument, inserts the analysis as a comment on that line."
211 (let* ((c-parsing-error nil)
212 (syntax (if (boundp 'c-syntactic-context)
213 ;; Use `c-syntactic-context' in the same way as
214 ;; `c-indent-line', to be consistent.
216 (c-save-buffer-state nil
217 (c-guess-basic-syntax)))))
218 (if (not (consp arg))
220 (message "Syntactic analysis: %s" syntax)
224 (setq elem (pop syntax))
225 (when (setq pos (c-langelem-pos elem))
226 (push (c-put-overlay pos (1+ pos)
229 (when (setq pos (c-langelem-2nd-pos elem))
230 (push (c-put-overlay pos (1+ pos)
231 'face 'secondary-selection)
235 (c-delete-overlay (pop ols)))))
237 (insert-and-inherit (format "%s" syntax))
239 (c-keep-region-active))
241 (defun c-syntactic-information-on-region (from to)
242 "Insert a comment with the syntactic analysis on every line in the region."
246 (narrow-to-region from to)
247 (goto-char (point-min))
249 (c-show-syntactic-information '(0))
253 ;; Minor mode functions.
254 (defun c-update-modeline ()
255 (let ((fmt (format "/%s%s%s%s"
256 (if c-electric-flag "l" "")
257 (if (and c-electric-flag c-auto-newline)
259 (if c-hungry-delete-key "h" "")
261 ;; subword might not be loaded.
262 (boundp 'subword-mode)
263 (symbol-value 'subword-mode))
266 ;; FIXME: Derived modes might want to use something else
267 ;; than a string for `mode-name'.
268 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name)
269 (match-string 1 mode-name)
271 ;; (setq c-submode-indicators
272 ;; (if (> (length fmt) 1)
275 (if (> (length fmt) 1)
276 (concat bare-mode-name fmt)
278 (force-mode-line-update)))
280 (defun c-toggle-syntactic-indentation (&optional arg)
281 "Toggle syntactic indentation.
282 Optional numeric ARG, if supplied, turns on syntactic indentation when
283 positive, turns it off when negative, and just toggles it when zero or
286 When syntactic indentation is turned on (the default), the indentation
287 functions and the electric keys indent according to the syntactic
288 context keys, when applicable.
290 When it's turned off, the electric keys don't reindent, the indentation
291 functions indents every new line to the same level as the previous
292 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
293 specified by `c-basic-offset'. The indentation style has no effect in
294 this mode, nor any of the indentation associated variables,
295 e.g. `c-special-indent-hook'.
297 This command sets the variable `c-syntactic-indentation'."
299 (setq c-syntactic-indentation
300 (c-calculate-state arg c-syntactic-indentation))
301 (c-keep-region-active))
303 (defun c-toggle-auto-newline (&optional arg)
304 "Toggle auto-newline feature.
305 Optional numeric ARG, if supplied, turns on auto-newline when
306 positive, turns it off when negative, and just toggles it when zero or
309 Turning on auto-newline automatically enables electric indentation.
311 When the auto-newline feature is enabled (indicated by \"/la\" on the
312 mode line after the mode name) newlines are automatically inserted
313 after special characters such as brace, comma, semi-colon, and colon."
316 (c-calculate-state arg (and c-auto-newline c-electric-flag)))
317 (if c-auto-newline (setq c-electric-flag t))
319 (c-keep-region-active))
321 (defalias 'c-toggle-auto-state 'c-toggle-auto-newline)
322 (make-obsolete 'c-toggle-auto-state 'c-toggle-auto-newline "22.1")
324 (defun c-toggle-hungry-state (&optional arg)
325 "Toggle hungry-delete-key feature.
326 Optional numeric ARG, if supplied, turns on hungry-delete when
327 positive, turns it off when negative, and just toggles it when zero or
330 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
331 the mode line after the mode name) the delete key gobbles all preceding
332 whitespace in one fell swoop."
334 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
336 (c-keep-region-active))
338 (defun c-toggle-auto-hungry-state (&optional arg)
339 "Toggle auto-newline and hungry-delete-key features.
340 Optional numeric ARG, if supplied, turns on auto-newline and
341 hungry-delete when positive, turns them off when negative, and just
342 toggles them when zero or left out.
344 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
346 (setq c-auto-newline (c-calculate-state arg c-auto-newline))
347 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
349 (c-keep-region-active))
351 (defun c-toggle-electric-state (&optional arg)
352 "Toggle the electric indentation feature.
353 Optional numeric ARG, if supplied, turns on electric indentation when
354 positive, turns it off when negative, and just toggles it when zero or
357 (setq c-electric-flag (c-calculate-state arg c-electric-flag))
359 (when (fboundp 'electric-indent-local-mode) ; Emacs 24.4 or later.
360 (electric-indent-local-mode (if c-electric-flag 1 0)))
361 (c-keep-region-active))
366 (defun c-electric-backspace (arg)
367 "Delete the preceding character or whitespace.
368 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
369 line) then all preceding whitespace is consumed. If however a prefix
370 argument is supplied, or `c-hungry-delete-key' is nil, or point is
371 inside a literal then the function in the variable
372 `c-backspace-function' is called."
374 (if (c-save-buffer-state ()
375 (or (not c-hungry-delete-key)
378 (funcall c-backspace-function (prefix-numeric-value arg))
379 (c-hungry-delete-backwards)))
381 (defun c-hungry-delete-backwards ()
382 "Delete the preceding character or all preceding whitespace
383 back to the previous non-whitespace character.
384 See also \\[c-hungry-delete-forward]."
386 (let ((here (point)))
388 (if (/= (point) here)
389 (delete-region (point) here)
390 (funcall c-backspace-function 1))))
392 (defalias 'c-hungry-backspace 'c-hungry-delete-backwards)
394 (defun c-electric-delete-forward (arg)
395 "Delete the following character or whitespace.
396 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
397 line) then all following whitespace is consumed. If however a prefix
398 argument is supplied, or `c-hungry-delete-key' is nil, or point is
399 inside a literal then the function in the variable `c-delete-function'
402 (if (c-save-buffer-state ()
403 (or (not c-hungry-delete-key)
406 (funcall c-delete-function (prefix-numeric-value arg))
407 (c-hungry-delete-forward)))
409 (defun c-hungry-delete-forward ()
410 "Delete the following character or all following whitespace
411 up to the next non-whitespace character.
412 See also \\[c-hungry-delete-backwards]."
414 (let ((here (point)))
416 (if (/= (point) here)
417 (delete-region (point) here)
418 (funcall c-delete-function 1))))
420 ;; This function is only used in XEmacs.
421 (defun c-electric-delete (arg)
422 "Deletes preceding or following character or whitespace.
423 This function either deletes forward as `c-electric-delete-forward' or
424 backward as `c-electric-backspace', depending on the configuration: If
425 the function `delete-forward-p' is defined and returns non-nil, it
426 deletes forward. Otherwise it deletes backward.
428 Note: This is the way in XEmacs to choose the correct action for the
429 \[delete] key, whichever key that means. Other flavors don't use this
430 function to control that."
432 (if (and (fboundp 'delete-forward-p)
434 (c-electric-delete-forward arg)
435 (c-electric-backspace arg)))
437 ;; This function is only used in XEmacs.
438 (defun c-hungry-delete ()
439 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
440 The direction of deletion depends on the configuration: If the
441 function `delete-forward-p' is defined and returns non-nil, it deletes
442 forward using `c-hungry-delete-forward'. Otherwise it deletes
443 backward using `c-hungry-backspace'.
445 Note: This is the way in XEmacs to choose the correct action for the
446 \[delete] key, whichever key that means. Other flavors don't use this
447 function to control that."
449 (if (and (fboundp 'delete-forward-p)
451 (c-hungry-delete-forward)
452 (c-hungry-delete-backwards)))
454 (defun c-electric-pound (arg)
456 If `c-electric-flag' is set, handle it specially according to the variable
457 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
458 inside a literal or a macro, nothing special happens."
460 (if (c-save-buffer-state ()
462 (not c-electric-flag)
463 (not (memq 'alignleft c-electric-pound-behavior))
465 (skip-chars-backward " \t")
468 (and (= (forward-line -1) 0)
470 (eq (char-before) ?\\))))
472 ;; do nothing special
473 (self-insert-command (prefix-numeric-value arg))
474 ;; place the pound character at the left edge
475 (let ((pos (- (point-max) (point)))
478 (delete-horizontal-space)
479 (insert (c-last-command-char))
481 (goto-char (- (point-max) pos)))
484 (defun c-point-syntax ()
485 ;; Return the syntactic context of the construct at point. (This is NOT
486 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
487 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
488 (c-save-buffer-state (;; shut this up too
489 (c-echo-syntactic-information-p nil)
491 (c-tentative-buffer-changes
492 ;; insert a newline to isolate the construct at point for syntactic
495 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
496 ;; the syntax. (There might already be an escaped NL there.)
499 (c-skip-ws-backward (c-point 'bopl))
504 (and (c-beginning-of-macro)
505 (progn (c-end-of-macro)
510 (let ((c-syntactic-indentation-in-macros t)
511 (c-auto-newline-analysis t))
512 ;; Turn on syntactic macro analysis to help with auto
514 (setq syntax (c-guess-basic-syntax))
518 (defun c-brace-newlines (syntax)
519 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
520 ;; (not necessarily the same as the S.C. of the line it is on). Return
521 ;; NEWLINES, the list containing some combination of the symbols `before'
522 ;; and `after' saying where newlines should be inserted.
525 ;; This is the list of brace syntactic symbols that can hang.
526 ;; If any new ones are added to c-offsets-alist, they should be
527 ;; added here as well.
529 ;; The order of this list is important; if SYNTAX has several
530 ;; elements, the element that "wins" is the earliest in SYMS.
531 '(arglist-cont-nonempty ; e.g. an array literal.
532 class-open class-close defun-open defun-close
533 inline-open inline-close
534 brace-list-open brace-list-close
535 brace-list-intro brace-entry-open
536 block-open block-close
537 substatement-open statement-case-open
538 extern-lang-open extern-lang-close
539 namespace-open namespace-close
540 module-open module-close
541 composition-open composition-close
542 inexpr-class-open inexpr-class-close
543 ;; `statement-cont' is here for the case with a brace
544 ;; list opener inside a statement. C.f. CASE B.2 in
545 ;; `c-guess-continued-construct'.
548 (c-echo-syntactic-information-p nil)
549 symb-newlines) ; e.g. (substatement-open . (after))
552 ;; Do not try to insert newlines around a special
553 ;; (Pike-style) brace list.
554 (if (and c-special-brace-lists
556 (c-safe (if (= (char-before) ?{)
559 (c-looking-at-special-brace-list))))
561 ;; Seek the matching entry in c-hanging-braces-alist.
564 ;; Substitute inexpr-class and class-open or
565 ;; class-close with inexpr-class-open or
566 ;; inexpr-class-close.
567 (if (assq 'inexpr-class syntax)
568 (cond ((assq 'class-open syntax)
569 '((inexpr-class-open)))
570 ((assq 'class-close syntax)
571 '((inexpr-class-close)))
574 c-hanging-braces-alist)
575 '(ignore before after)))) ; Default, when not in c-h-b-l.
577 ;; If syntax is a function symbol, then call it using the
578 ;; defined semantics.
579 (if (and (not (consp (cdr symb-newlines)))
580 (functionp (cdr symb-newlines)))
581 (let ((c-syntactic-context syntax))
582 (funcall (cdr symb-newlines)
585 (cdr symb-newlines))))
587 (defun c-try-one-liner ()
588 ;; Point is just after a newly inserted }. If the non-whitespace
589 ;; content of the braces is a single line of code, compact the whole
590 ;; construct to a single line, if this line isn't too long. The Right
591 ;; Thing is done with comments.
593 ;; Point will be left after the }, regardless of whether the clean-up is
594 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
597 (pos (- (point-max) (point)))
598 mbeg1 mend1 mbeg4 mend4
599 eol-col cmnt-pos cmnt-col cmnt-gap)
604 ;; Avoid backtracking over a very large block. The one we
605 ;; deal with here can never be more than three lines.
606 (narrow-to-region (save-excursion
610 (and (c-safe (c-backward-sexp))
613 (narrow-to-region (point) (1- here)) ; innards of {.}
615 (cc-eval-when-compile
617 "\\(" ; (match-beginning 1)
618 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
619 "\\)" ; (match-end 1)
620 "[^ \t\r\n]+\\([ \t]+[^ \t\r\n]+\\)*" ; non-WS
621 "\\(" ; (match-beginning 4)
622 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
623 "\\)\\'"))))))) ; (match-end 4) at EOB.
625 (if (c-tentative-buffer-changes
626 (setq mbeg1 (match-beginning 1) mend1 (match-end 1)
627 mbeg4 (match-beginning 4) mend4 (match-end 4))
628 (backward-char) ; back over the `}'
630 (setq cmnt-pos (and (c-backward-single-comment)
631 (- (point) (- mend1 mbeg1)))))
632 (delete-region mbeg4 mend4)
633 (delete-region mbeg1 mend1)
634 (setq eol-col (save-excursion (end-of-line) (current-column)))
636 ;; Necessary to put the closing brace before any line
637 ;; oriented comment to keep it syntactically significant.
638 ;; This isn't necessary for block comments, but the result
639 ;; looks nicer anyway.
641 (delete-char 1) ; the `}' has blundered into a comment
643 (setq cmnt-col (1+ (current-column)))
644 (setq cmnt-pos (1+ cmnt-pos)) ; we're inserting a `}'
646 (insert-char ?\} 1) ; reinsert the `}' before the comment.
647 (setq cmnt-gap (- cmnt-col (current-column)))
648 (when (zerop cmnt-gap)
649 (insert-char ?\ 1) ; Put a space before a bare comment.
652 (or (null c-max-one-liner-length)
653 (zerop c-max-one-liner-length)
654 (<= eol-col c-max-one-liner-length)
655 ;; Can we trim space before comment to make the line fit?
657 (< (- eol-col cmnt-gap) c-max-one-liner-length)
658 (progn (goto-char cmnt-pos)
659 (backward-delete-char-untabify
660 (- eol-col c-max-one-liner-length))
662 (goto-char (- (point-max) pos))))))
664 (defun c-electric-brace (arg)
667 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
668 numeric ARG hasn't been supplied, the command performs several electric
671 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
672 the mode line) newlines are inserted before and after the brace as
673 directed by the settings in `c-hanging-braces-alist'.
675 \(b) Any auto-newlines are indented. The original line is also
676 reindented unless `c-syntactic-indentation' is nil.
678 \(c) If auto-newline is turned on, various newline cleanups based on the
679 settings of `c-cleanup-list' are done."
682 (let (safepos literal
683 ;; We want to inhibit blinking the paren since this would be
684 ;; most disruptive. We'll blink it ourselves later on.
685 (old-blink-paren blink-paren-function)
686 blink-paren-function case-fold-search)
688 (c-save-buffer-state ()
689 (setq safepos (c-safe-position (point) (c-parse-state))
690 literal (c-in-literal safepos)))
692 ;; Insert the brace. Note that expand-abbrev might reindent
693 ;; the line here if there's a preceding "else" or something.
694 (self-insert-command (prefix-numeric-value arg))
696 (when (and c-electric-flag (not literal) (not arg))
697 (if (not (looking-at "[ \t]*\\\\?$"))
698 (if c-syntactic-indentation
699 (indent-according-to-mode))
701 (let ( ;; shut this up too
702 (c-echo-syntactic-information-p nil)
704 ln-syntax br-syntax syntax) ; Syntactic context of the original line,
705 ; of the brace itself, of the line the brace ends up on.
706 (c-save-buffer-state ((c-syntactic-indentation-in-macros t)
707 (c-auto-newline-analysis t))
708 (setq ln-syntax (c-guess-basic-syntax)))
709 (if c-syntactic-indentation
710 (c-indent-line ln-syntax))
714 (setq br-syntax (c-point-syntax)
715 newlines (c-brace-newlines br-syntax))
717 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
718 (if (and (memq 'before newlines)
719 (> (current-column) (current-indentation)))
720 (if c-syntactic-indentation
721 ;; Only a plain newline for now - it's indented
722 ;; after the cleanups when the line has its final
725 (c-newline-and-indent)))
728 ;; `syntax' is the syntactic context of the line which ends up
729 ;; with the brace on it.
730 (setq syntax (if (memq 'before newlines) br-syntax ln-syntax))
732 ;; Do all appropriate clean ups
734 (pos (- (point-max) (point)))
738 ;; `}': clean up empty defun braces
739 (when (c-save-buffer-state ()
740 (and (memq 'empty-defun-braces c-cleanup-list)
741 (eq (c-last-command-char) ?\})
742 (c-intersect-lists '(defun-close class-close inline-close)
747 (eq (char-before) ?\{))
748 ;; make sure matching open brace isn't in a comment
749 (not (c-in-literal))))
750 (delete-region (point) (1- here))
751 (setq here (- (point-max) pos)))
754 ;; `}': compact to a one-liner defun?
757 (and (eq (c-last-command-char) ?\})
758 (memq 'one-liner-defun c-cleanup-list)
759 (c-intersect-lists '(defun-close) syntax)
761 (setq here (- (point-max) pos))))
763 ;; `{': clean up brace-else-brace and brace-elseif-brace
764 (when (eq (c-last-command-char) ?\{)
766 ((and (memq 'brace-else-brace c-cleanup-list)
769 "\\([ \t\n]\\|\\\\\n\\)*"
771 "\\([ \t\n]\\|\\\\\n\\)*"
775 (delete-region (match-beginning 0) (match-end 0))
776 (insert-and-inherit "} else {"))
777 ((and (memq 'brace-elseif-brace c-cleanup-list)
779 (goto-char (1- here))
783 (eq (char-before) ?\)))
784 (zerop (c-save-buffer-state nil (c-backward-token-2 1 t)))
785 (eq (char-after) ?\()
790 "\\([ \t\n]\\|\\\\\n\\)*"
792 "\\([ \t\n]\\|\\\\\n\\)+"
794 "\\([ \t\n]\\|\\\\\n\\)*"
797 ;(eq (match-end 0) tmp);
799 (delete-region mbeg mend)
803 (goto-char (- (point-max) pos))
805 ;; Indent the line after the cleanups since it might
806 ;; very well indent differently due to them, e.g. if
807 ;; c-indent-one-line-block is used together with the
808 ;; one-liner-defun cleanup.
809 (when c-syntactic-indentation
812 ;; does a newline go after the brace?
813 (if (memq 'after newlines)
814 (c-newline-and-indent))
818 (and (eq (c-last-command-char) ?\})
819 (not executing-kbd-macro)
822 (c-save-buffer-state nil
823 (c-backward-syntactic-ws safepos))
824 (funcall old-blink-paren)))))
826 (defun c-electric-slash (arg)
827 "Insert a slash character.
829 If the slash is inserted immediately after the comment prefix in a c-style
830 comment, the comment might get closed by removing whitespace and possibly
831 inserting a \"*\". See the variable `c-cleanup-list'.
833 Indent the line as a comment, if:
835 1. The slash is second of a \"//\" line oriented comment introducing
836 token and we are on a comment-only-line, or
838 2. The slash is part of a \"*/\" token that closes a block oriented
841 If a numeric ARG is supplied, point is inside a literal, or
842 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
845 (let ((literal (c-save-buffer-state () (c-in-literal)))
848 (c-echo-syntactic-information-p nil))
850 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
851 ;; `c-syntactic-indentation' set.
854 (memq 'comment-close-slash c-cleanup-list)
855 (eq (c-last-command-char) ?/)
856 (looking-at (concat "[ \t]*\\("
857 (regexp-quote comment-end) "\\)?$"))
858 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
861 (narrow-to-region (point-min) (point))
862 (back-to-indentation)
863 (looking-at (concat c-current-comment-prefix "[ \t]*$")))))
864 (delete-region (progn (forward-line 0) (point))
865 (progn (end-of-line) (point)))
866 (insert-char ?* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
868 (setq indentp (and (not arg)
869 c-syntactic-indentation
871 (eq (c-last-command-char) ?/)
872 (eq (char-before) (if literal ?* ?/))))
873 (self-insert-command (prefix-numeric-value arg))
875 (indent-according-to-mode))))
877 (defun c-electric-star (arg)
878 "Insert a star character.
879 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
880 the star is the second character of a C style comment starter on a
881 comment-only-line, indent the line as a comment. If a numeric ARG is
882 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
883 this indentation is inhibited."
886 (self-insert-command (prefix-numeric-value arg))
887 ;; if we are in a literal, or if arg is given do not reindent the
888 ;; current line, unless this star introduces a comment-only line.
889 (if (c-save-buffer-state ()
890 (and c-syntactic-indentation
893 (eq (c-in-literal) 'c)
894 (eq (char-before) ?*)
897 (skip-chars-backward "*")
898 (if (eq (char-before) ?/)
900 (skip-chars-backward " \t")
902 (let (c-echo-syntactic-information-p) ; shut this up
903 (indent-according-to-mode))
906 (defun c-electric-semi&comma (arg)
907 "Insert a comma or semicolon.
909 If `c-electric-flag' is non-nil, point isn't inside a literal and a
910 numeric ARG hasn't been supplied, the command performs several electric
913 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
914 the mode line) a newline might be inserted. See the variable
915 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
917 \(b) Any auto-newlines are indented. The original line is also
918 reindented unless `c-syntactic-indentation' is nil.
920 \(c) If auto-newline is turned on, a comma following a brace list or a
921 semicolon following a defun might be cleaned up, depending on the
922 settings of `c-cleanup-list'."
924 (let* (lim literal c-syntactic-context
927 (c-echo-syntactic-information-p nil))
929 (c-save-buffer-state ()
930 (setq lim (c-most-enclosing-brace (c-parse-state))
931 literal (c-in-literal lim)))
933 (self-insert-command (prefix-numeric-value arg))
935 (if (and c-electric-flag (not literal) (not arg))
936 ;; do all cleanups and newline insertions if c-auto-newline is on.
937 (if (or (not c-auto-newline)
938 (not (looking-at "[ \t]*\\\\?$")))
939 (if c-syntactic-indentation
941 ;; clean ups: list-close-comma or defun-close-semi
942 (let ((pos (- (point-max) (point))))
943 (if (c-save-buffer-state ()
945 (eq (c-last-command-char) ?,)
946 (memq 'list-close-comma c-cleanup-list))
948 (eq (c-last-command-char) ?\;)
949 (memq 'defun-close-semi c-cleanup-list)))
953 (eq (char-before) ?}))
954 ;; make sure matching open brace isn't in a comment
955 (not (c-in-literal lim))))
956 (delete-region (point) here))
957 (goto-char (- (point-max) pos)))
959 (when c-syntactic-indentation
960 (setq c-syntactic-context (c-guess-basic-syntax))
961 (c-indent-line c-syntactic-context))
962 ;; check to see if a newline should be added
963 (let ((criteria c-hanging-semi&comma-criteria)
964 answer add-newline-p)
966 (setq answer (funcall (car criteria)))
967 ;; only nil value means continue checking
969 (setq criteria (cdr criteria))
971 ;; only 'stop specifically says do not add a newline
972 (setq add-newline-p (not (eq answer 'stop)))
975 (c-newline-and-indent))
978 (defun c-electric-colon (arg)
981 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
982 numeric ARG hasn't been supplied, the command performs several electric
985 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
986 the mode line) newlines are inserted before and after the colon based on
987 the settings in `c-hanging-colons-alist'.
989 \(b) Any auto-newlines are indented. The original line is also
990 reindented unless `c-syntactic-indentation' is nil.
992 \(c) If auto-newline is turned on, whitespace between two colons will be
993 \"cleaned up\" leaving a scope operator, if this action is set in
997 (let* ((bod (c-point 'bod))
998 (literal (c-save-buffer-state () (c-in-literal bod)))
1001 (c-echo-syntactic-information-p nil))
1002 (self-insert-command (prefix-numeric-value arg))
1003 ;; Any electric action?
1004 (if (and c-electric-flag (not literal) (not arg))
1005 ;; Unless we're at EOL, only re-indentation happens.
1006 (if (not (looking-at "[ \t]*\\\\?$"))
1007 (if c-syntactic-indentation
1008 (indent-according-to-mode))
1010 ;; scope-operator clean-up?
1011 (let ((pos (- (point-max) (point)))
1013 (if (c-save-buffer-state () ; Why do we need this? [ACM, 2003-03-12]
1015 (memq 'scope-operator c-cleanup-list)
1016 (eq (char-before) ?:)
1019 (c-skip-ws-backward)
1020 (eq (char-before) ?:))
1021 (not (c-in-literal))
1022 (not (eq (char-after (- (point) 2)) ?:))))
1024 (delete-region (point) (1- here))
1025 (setq is-scope-op t)))
1026 (goto-char (- (point-max) pos)))
1028 ;; indent the current line if it's done syntactically.
1029 (if c-syntactic-indentation
1030 ;; Cannot use the same syntax analysis as we find below,
1031 ;; since that's made with c-syntactic-indentation-in-macros
1033 (indent-according-to-mode))
1035 ;; Calculate where, if anywhere, we want newlines.
1036 (c-save-buffer-state
1037 ((c-syntactic-indentation-in-macros t)
1038 (c-auto-newline-analysis t)
1039 ;; Turn on syntactic macro analysis to help with auto newlines
1041 (syntax (c-guess-basic-syntax))
1043 ;; Translate substatement-label to label for this operation.
1045 (if (eq (car (car elem)) 'substatement-label)
1046 (setcar (car elem) 'label))
1047 (setq elem (cdr elem)))
1048 ;; some language elements can only be determined by checking
1049 ;; the following line. Let's first look for ones that can be
1050 ;; found when looking on the line with the colon
1053 (or (c-lookup-lists '(case-label label access-label)
1054 syntax c-hanging-colons-alist)
1055 (c-lookup-lists '(member-init-intro inher-intro)
1059 (c-guess-basic-syntax)
1061 c-hanging-colons-alist)))))
1062 ;; does a newline go before the colon? Watch out for already
1063 ;; non-hung colons. However, we don't unhang them because that
1064 ;; would be a cleanup (and anti-social).
1065 (if (and (memq 'before newlines)
1068 (skip-chars-backward ": \t")
1070 (let ((pos (- (point-max) (point))))
1072 (c-newline-and-indent)
1073 (goto-char (- (point-max) pos))))
1074 ;; does a newline go after the colon?
1075 (if (and (memq 'after (cdr-safe newlines))
1077 (c-newline-and-indent))
1080 (defun c-electric-lt-gt (arg)
1081 "Insert a \"<\" or \">\" character.
1082 If the current language uses angle bracket parens (e.g. template
1083 arguments in C++), try to find out if the inserted character is a
1084 paren and give it paren syntax if appropriate.
1086 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1087 line will be reindented if the inserted character is a paren or if it
1088 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1089 numeric argument is supplied, or the point is inside a literal."
1092 (let ((c-echo-syntactic-information-p nil)
1093 final-pos found-delim case-fold-search)
1095 (self-insert-command (prefix-numeric-value arg))
1096 (setq final-pos (point))
1098 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1099 ;;;; property on the new < or > and its mate (if any) when they are template
1100 ;;;; parens. This is now done in an after-change function.
1102 ;; Indent the line if appropriate.
1103 (when (and c-electric-flag c-syntactic-indentation c-recognize-<>-arglists)
1105 (if (eq (c-last-command-char) ?<)
1106 ;; If a <, basically see if it's got "template" before it .....
1110 (progn (c-beginning-of-current-token) (point))))
1112 (c-backward-token-2)
1113 (looking-at c-opt-<>-sexp-key)))
1114 ;; ..... or is a C++ << operator.
1115 (and (c-major-mode-is 'c++-mode)
1117 (goto-char (1- final-pos))
1118 (c-beginning-of-current-token)
1120 (>= (match-end 0) final-pos)))
1122 ;; It's a >. Either a C++ >> operator. ......
1123 (or (and (c-major-mode-is 'c++-mode)
1125 (goto-char (1- final-pos))
1126 (c-beginning-of-current-token)
1128 (>= (match-end 0) final-pos))
1129 ;; ...., or search back for a < which isn't already marked as an
1130 ;; opening template delimiter.
1133 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1135 (narrow-to-region (point-min) final-pos)
1136 (goto-char final-pos)
1140 (c-syntactic-skip-backward "^<;}" nil t)
1141 (eq (char-before) ?<))
1144 (looking-at "\\s\("))))
1145 (and (eq (char-after) ?<)
1146 (not (looking-at "\\s\("))
1147 (progn (c-backward-syntactic-ws)
1148 (c-simple-skip-symbol-backward))
1149 (or (looking-at c-opt-<>-sexp-key)
1150 (not (looking-at c-keywords-regexp)))))))))
1152 (goto-char final-pos)
1154 (indent-according-to-mode)
1155 (when (and (eq (char-before) ?>)
1156 (not executing-kbd-macro)
1157 blink-paren-function)
1158 ;; Currently (2014-10-19), the syntax-table text properties on < and >
1159 ;; are only applied in code called during Emacs redisplay. We thus
1160 ;; explicitly cause a redisplay so that these properties have been
1161 ;; applied when `blink-paren-function' gets called.
1163 (funcall blink-paren-function)))))
1165 (defun c-electric-paren (arg)
1166 "Insert a parenthesis.
1168 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1169 line is reindented unless a numeric ARG is supplied, or the parenthesis
1170 is inserted inside a literal.
1172 Whitespace between a function name and the parenthesis may get added or
1173 removed; see the variable `c-cleanup-list'.
1175 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1176 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1178 (let ((literal (c-save-buffer-state () (c-in-literal)))
1180 (c-echo-syntactic-information-p nil)
1182 (self-insert-command (prefix-numeric-value arg))
1184 (if (and (not arg) (not literal))
1185 (let* ( ;; We want to inhibit blinking the paren since this will
1186 ;; be most disruptive. We'll blink it ourselves
1188 (old-blink-paren blink-paren-function)
1189 blink-paren-function)
1190 (if (and c-syntactic-indentation c-electric-flag)
1191 (indent-according-to-mode))
1193 ;; If we're at EOL, check for new-line clean-ups.
1194 (when (and c-electric-flag c-auto-newline
1195 (looking-at "[ \t]*\\\\?$"))
1197 ;; clean up brace-elseif-brace
1199 (and (memq 'brace-elseif-brace c-cleanup-list)
1200 (eq (c-last-command-char) ?\()
1203 "\\([ \t\n]\\|\\\\\n\\)*"
1205 "\\([ \t\n]\\|\\\\\n\\)+"
1207 "\\([ \t\n]\\|\\\\\n\\)*"
1211 (not (c-save-buffer-state () (c-in-literal))))
1212 (delete-region (match-beginning 0) (match-end 0))
1213 (insert-and-inherit "} else if ("))
1215 ;; clean up brace-catch-brace
1217 (and (memq 'brace-catch-brace c-cleanup-list)
1218 (eq (c-last-command-char) ?\()
1221 "\\([ \t\n]\\|\\\\\n\\)*"
1223 "\\([ \t\n]\\|\\\\\n\\)*"
1227 (not (c-save-buffer-state () (c-in-literal))))
1228 (delete-region (match-beginning 0) (match-end 0))
1229 (insert-and-inherit "} catch (")))
1231 ;; Check for clean-ups at function calls. These two DON'T need
1232 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1233 ;; Point is currently just after the inserted paren.
1234 (let (beg (end (1- (point))))
1237 ;; space-before-funcall clean-up?
1238 ((and (memq 'space-before-funcall c-cleanup-list)
1239 (eq (c-last-command-char) ?\()
1242 (skip-chars-backward " \t")
1244 (and (c-save-buffer-state () (c-on-identifier))
1245 ;; Don't add a space into #define FOO()....
1246 (not (and (c-beginning-of-macro)
1247 (c-forward-over-cpp-define-id)
1248 (eq (point) beg))))))
1250 (delete-region beg end)
1254 ;; compact-empty-funcall clean-up?
1255 ((c-save-buffer-state ()
1256 (and (memq 'compact-empty-funcall c-cleanup-list)
1257 (eq (c-last-command-char) ?\))
1259 (c-safe (backward-char 2))
1260 (when (looking-at "()")
1262 (skip-chars-backward " \t")
1264 (c-on-identifier)))))
1265 (delete-region beg end))))
1266 (and (eq last-input-event ?\))
1267 (not executing-kbd-macro)
1269 (funcall old-blink-paren))))))
1271 (defun c-electric-continued-statement ()
1272 "Reindent the current line if appropriate.
1274 This function is used to reindent the line after a keyword which
1275 continues an earlier statement is typed, e.g. an \"else\" or the
1276 \"while\" in a do-while block.
1278 The line is reindented if there is nothing but whitespace before the
1279 keyword on the line, the keyword is not inserted inside a literal, and
1280 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1281 (let (;; shut this up
1282 (c-echo-syntactic-information-p nil))
1283 (when (c-save-buffer-state ()
1284 (and c-electric-flag
1285 c-syntactic-indentation
1286 (not (eq (c-last-command-char) ?_))
1288 (skip-syntax-backward "w")
1291 (not (c-in-literal (c-point 'bod)))))
1292 ;; Have to temporarily insert a space so that
1293 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1294 ;; space with a nonspace to avoid messing up any whitespace
1295 ;; sensitive meddling that might be done, e.g. by
1296 ;; `c-backslash-region'.
1297 (insert-and-inherit " x")
1299 (indent-according-to-mode)
1300 (delete-char -2)))))
1304 (declare-function subword-forward "subword" (&optional arg))
1305 (declare-function subword-backward "subword" (&optional arg))
1307 ;; "nomenclature" functions + c-scope-operator.
1308 (defun c-forward-into-nomenclature (&optional arg)
1309 "Compatibility alias for `c-forward-subword'."
1311 (if (fboundp 'subword-mode)
1314 (subword-forward arg))
1315 (require 'cc-subword)
1316 (c-forward-subword arg)))
1317 (make-obsolete 'c-forward-into-nomenclature
1318 (if (fboundp 'subword-mode) 'subword-forward 'c-forward-subword)
1321 (defun c-backward-into-nomenclature (&optional arg)
1322 "Compatibility alias for `c-backward-subword'."
1324 (if (fboundp 'subword-mode)
1327 (subword-backward arg))
1328 (require 'cc-subword)
1329 (c-backward-subword arg)))
1331 'c-backward-into-nomenclature
1332 (if (fboundp 'subword-mode) 'subword-backward 'c-backward-subword) "23.2")
1334 (defun c-scope-operator ()
1335 "Insert a double colon scope operator at point.
1336 No indentation or other \"electric\" behavior is performed."
1338 (insert-and-inherit "::"))
1341 ;; Movement (etc.) by defuns.
1342 (defun c-in-function-trailer-p (&optional lim)
1343 ;; Return non-nil if point is between the closing brace and the semicolon of
1344 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1345 ;; portion of a declaration like "struct foo {...} bar ;".
1347 ;; Return the position of the main declaration. Otherwise, return nil.
1348 ;; Point is assumed to be at the top level and outside of any macro or
1351 ;; If LIM is non-nil, it is the bound on a the backward search for the
1352 ;; beginning of the declaration.
1354 ;; This function might do hidden buffer changes.
1355 (and c-opt-block-decls-with-vars-key
1357 (c-syntactic-skip-backward "^;}" lim)
1358 (let ((eo-block (point))
1360 (and (eq (char-before) ?\})
1361 (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1363 ;; Look for struct or union or ... If we find one, it might
1364 ;; be the return type of a function, or the like. Exclude
1366 (c-syntactic-re-search-forward
1367 (concat "[;=\(\[{]\\|\\("
1368 c-opt-block-decls-with-vars-key
1371 (match-beginning 1) ; Is there a "struct" etc., somewhere?
1372 (not (eq (char-before) ?_))
1373 (c-syntactic-re-search-forward "[;=\(\[{]" eo-block t t t)
1374 (eq (char-before) ?\{)
1377 (defun c-where-wrt-brace-construct ()
1378 ;; Determine where we are with respect to functions (or other brace
1379 ;; constructs, included in the term "function" in the rest of this comment).
1380 ;; Point is assumed to be outside any macro or literal.
1381 ;; This is used by c-\(beginning\|end\)-of-defun.
1383 ;; Return one of these symbols:
1384 ;; at-header : we're at the start of a function's header.
1385 ;; in-header : we're inside a function's header, this extending right
1386 ;; up to the brace. This bit includes any k&r declarations.
1387 ;; in-block : we're inside a function's brace block.
1388 ;; in-trailer : we're in the area between the "}" and ";" of something
1389 ;; like "struct foo {...} bar, baz;".
1390 ;; at-function-end : we're just after the closing brace (or semicolon) that
1391 ;; terminates the function.
1392 ;; outwith-function: we're not at or in any function. Being inside a
1393 ;; non-brace construct also counts as 'outwith-function'.
1395 ;; This function might do hidden buffer changes.
1398 decl-result brace-decl-p
1400 (paren-state (c-parse-state))
1401 (least-enclosing (c-least-enclosing-brace paren-state)))
1404 ((and least-enclosing
1405 (eq (char-after least-enclosing) ?\{))
1407 ((c-in-function-trailer-p)
1409 ((and (not least-enclosing)
1411 (consp (car paren-state))
1412 (eq start (cdar paren-state)))
1415 ;; Find the start of the current declaration. NOTE: If we're in the
1416 ;; variables after a "struct/eval" type block, we don't get to the
1417 ;; real declaration here - we detect and correct for this later.
1419 ;;If we're in the parameters' parens, move back out of them.
1420 (if least-enclosing (goto-char least-enclosing))
1421 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1422 ;; at a declaration.
1423 (if (or (and (eolp) (not (eobp))) ; EOL is matched by "\\s>"
1425 "\\([;#]\\|\\'\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s$\\|\\s<\\|\\s>\\|\\s!\\)")))
1427 (setq kluge-start (point))
1429 (car (c-beginning-of-decl-1
1430 ;; NOTE: If we're in a K&R region, this might be the start
1431 ;; of a parameter declaration, not the actual function.
1432 ;; It might also leave us at a label or "label" like
1434 (and least-enclosing ; LIMIT for c-b-of-decl-1
1435 (c-safe-position least-enclosing paren-state)))))
1437 ;; Has the declaration we've gone back to got braces?
1438 (or (eq decl-result 'label)
1441 (and (c-syntactic-re-search-forward "[;{]" nil t t)
1442 (or (eq (char-before) ?\{)
1443 (and c-recognize-knr-p
1444 ;; Might have stopped on the
1445 ;; ';' in a K&R argdecl. In
1446 ;; that case the declaration
1447 ;; should contain a block.
1448 (c-in-knr-argdecl)))))))
1451 ((or (eq decl-result 'label) ; e.g. "private:" or invalid syntax.
1452 (= (point) kluge-start)) ; might be BOB or unbalanced parens.
1454 ((eq decl-result 'same)
1456 (if (eq (point) start)
1460 ((eq decl-result 'previous)
1461 (if (and (not brace-decl-p)
1462 (c-in-function-trailer-p))
1466 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1469 (defun c-backward-to-nth-BOF-{ (n where)
1470 ;; Skip to the opening brace of the Nth function before point. If
1471 ;; point is inside a function, this counts as the first. Point must be
1472 ;; outside any comment/string or macro.
1474 ;; N must be strictly positive.
1475 ;; WHERE describes the position of point, one of the symbols `at-header',
1476 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1477 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1479 ;; If we run out of functions, leave point at BOB. Return zero on success,
1480 ;; otherwise the number of {s still to go.
1482 ;; This function may do hidden buffer changes
1484 ;; What we do to go back the first defun depends on where we start.
1486 ((eq where 'in-block)
1487 (goto-char (c-least-enclosing-brace (c-parse-state)))
1489 ((eq where 'in-header)
1490 (c-syntactic-re-search-forward "{")
1493 ((memq where '(at-header outwith-function at-function-end in-trailer))
1494 (c-syntactic-skip-backward "^}")
1495 (when (eq (char-before) ?\})
1498 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where)))
1500 ;; Each time round the loop, go back to a "{" at the outermost level.
1501 (while (and (> n 0) (not (bobp)))
1502 (c-parse-state) ; This call speeds up the following one
1503 ; by a factor of ~6. Hmmm. 2006/4/5.
1504 (c-syntactic-skip-backward "^}")
1505 (when (eq (char-before) ?\})
1510 (defun c-narrow-to-most-enclosing-decl-block (&optional inclusive)
1511 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1512 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1513 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1514 ;; otherwise include the braces. If the closing brace is missing,
1515 ;; (point-max) is used instead.
1516 (let ((paren-state (c-parse-state))
1518 (setq encl-decl (and paren-state (c-most-enclosing-decl-block paren-state)))
1523 (progn (goto-char encl-decl)
1524 (c-beginning-of-decl-1)
1528 (goto-char encl-decl)
1529 (or (c-safe (forward-list)
1535 (defun c-widen-to-enclosing-decl-scope (paren-state orig-point-min orig-point-max)
1536 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1537 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1538 ;; braces NOT being included in the resulting region. On no account may the
1539 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1540 ;; PAREN-STATE is a list of buffer positions in the style of
1541 ;; (c-parse-state), one of which will be that of the desired opening brace,
1544 ;; Return the position of the enclosing opening brace, or nil
1545 (let (encl-decl) ; putative position of decl-scope's opening brace.
1547 (narrow-to-region orig-point-min orig-point-max)
1548 (setq encl-decl (and paren-state
1549 (c-most-enclosing-decl-block paren-state))))
1553 (narrow-to-region (1+ encl-decl)
1555 (goto-char encl-decl)
1556 (or (c-safe (forward-list)
1560 (narrow-to-region orig-point-min orig-point-max)
1564 (defmacro c-while-widening-to-decl-block (condition)
1565 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1566 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1567 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1568 ;; buffer's original restriction.
1570 ;; This is a very special purpose macro, which assumes the existence of
1571 ;; several variables. It is for use only in c-beginning-of-defun and
1575 (eq c-defun-tactic 'go-outward)
1577 (setq paren-state (c-whack-state-after lim paren-state))
1578 (setq lim (c-widen-to-enclosing-decl-scope
1579 paren-state orig-point-min orig-point-max))
1580 (setq where 'in-block))))
1582 (defun c-beginning-of-defun (&optional arg)
1583 "Move backward to the beginning of a defun.
1584 Every top level declaration that contains a brace paren block is
1585 considered to be a defun.
1587 With a positive argument, move backward that many defuns. A negative
1588 argument -N means move forward to the Nth following beginning. Return
1589 t unless search stops due to beginning or end of buffer.
1591 Unlike the built-in `beginning-of-defun' this tries to be smarter
1592 about finding the char with open-parenthesis syntax that starts the
1596 (or arg (setq arg 1))
1598 (or (not (eq this-command 'c-beginning-of-defun))
1599 (eq last-command 'c-beginning-of-defun)
1600 (c-region-is-active-p)
1603 (c-save-buffer-state
1604 (beginning-of-defun-function end-of-defun-function
1606 (paren-state (copy-tree (c-parse-state))) ; This must not share list
1607 ; structure with other users of c-state-cache.
1608 (orig-point-min (point-min)) (orig-point-max (point-max))
1609 lim ; Position of { which has been widened to.
1610 where pos case-fold-search)
1613 (if (eq c-defun-tactic 'go-outward)
1614 (setq lim (c-widen-to-enclosing-decl-scope ; e.g. class, namespace.
1615 paren-state orig-point-min orig-point-max)))
1617 ;; Move back out of any macro/comment/string we happen to be in.
1618 (c-beginning-of-macro)
1619 (setq pos (c-literal-limits))
1620 (if pos (goto-char (car pos)))
1622 (setq where (c-where-wrt-brace-construct))
1625 ;; Move forward to the closing brace of a function.
1627 (if (memq where '(at-function-end outwith-function))
1628 (setq arg (1+ arg)))
1630 (c-while-widening-to-decl-block
1631 (< (setq arg (- (c-forward-to-nth-EOF-} (- arg) where))) 0)))
1632 ;; Move forward to the next opening brace....
1633 (when (and (= arg 0)
1635 (c-while-widening-to-decl-block
1636 (not (c-syntactic-re-search-forward "{" nil 'eob)))
1637 (eq (char-before) ?{)))
1639 ;; ... and backward to the function header.
1640 (c-beginning-of-decl-1)
1643 ;; Move backward to the opening brace of a function, making successively
1644 ;; larger portions of the buffer visible as necessary.
1646 (c-while-widening-to-decl-block
1647 (> (setq arg (c-backward-to-nth-BOF-{ arg where)) 0)))
1650 ;; Go backward to this function's header.
1651 (c-beginning-of-decl-1)
1654 ;; We're now there, modulo comments and whitespace.
1655 ;; Try to be line oriented; position point at the closest
1656 ;; preceding boi that isn't inside a comment, but if we hit
1657 ;; the previous declaration then we use the current point
1659 (while (and (/= (point) (c-point 'boi))
1660 (c-backward-single-comment)))
1661 (if (/= (point) (c-point 'boi))
1664 (c-keep-region-active)
1667 (defun c-forward-to-nth-EOF-} (n where)
1668 ;; Skip to the closing brace of the Nth function after point. If
1669 ;; point is inside a function, this counts as the first. Point must be
1670 ;; outside any comment/string or macro.
1672 ;; N must be strictly positive.
1673 ;; WHERE describes the position of point, one of the symbols `at-header',
1674 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1675 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1677 ;; If we run out of functions, leave point at EOB. Return zero on success,
1678 ;; otherwise the number of }s still to go.
1680 ;; This function may do hidden buffer changes.
1683 ;; What we do to go forward over the first defun depends on where we
1684 ;; start. We go to the closing brace of that defun, even when we go
1685 ;; backwards to it (in a "struct foo {...} bar ;").
1687 ((eq where 'in-block)
1688 (goto-char (c-least-enclosing-brace (c-parse-state)))
1691 ((eq where 'in-trailer)
1692 (c-syntactic-skip-backward "^}")
1694 ((memq where '(at-function-end outwith-function at-header in-header))
1695 (when (c-syntactic-re-search-forward "{" nil 'eob)
1699 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1701 ;; Each time round the loop, go forward to a "}" at the outermost level.
1702 (while (and (> n 0) (not (eobp)))
1703 ;(c-parse-state) ; This call speeds up the following one by a factor
1704 ; of ~6. Hmmm. 2006/4/5.
1705 (when (c-syntactic-re-search-forward "{" nil 'eob)
1711 (defun c-end-of-defun (&optional arg)
1712 "Move forward to the end of a top level declaration.
1713 With argument, do it that many times. Negative argument -N means move
1714 back to Nth preceding end. Returns t unless search stops due to
1715 beginning or end of buffer.
1717 An end of a defun occurs right after the close-parenthesis that matches
1718 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1720 (or arg (setq arg 1))
1722 (or (not (eq this-command 'c-end-of-defun))
1723 (eq last-command 'c-end-of-defun)
1724 (c-region-is-active-p)
1727 (c-save-buffer-state
1728 (beginning-of-defun-function end-of-defun-function
1730 (paren-state (copy-tree (c-parse-state))) ; This must not share list
1731 ; structure with other users of c-state-cache.
1732 (orig-point-min (point-min)) (orig-point-max (point-max))
1734 where pos case-fold-search)
1737 (if (eq c-defun-tactic 'go-outward)
1738 (setq lim (c-widen-to-enclosing-decl-scope ; e.g. class, namespace
1739 paren-state orig-point-min orig-point-max)))
1741 ;; Move back out of any macro/comment/string we happen to be in.
1742 (c-beginning-of-macro)
1743 (setq pos (c-literal-limits))
1744 (if pos (goto-char (car pos)))
1746 (setq where (c-where-wrt-brace-construct))
1749 ;; Move backwards to the } of a function
1751 (if (memq where '(at-header outwith-function))
1752 (setq arg (1+ arg)))
1754 (c-while-widening-to-decl-block
1755 (< (setq arg (- (c-backward-to-nth-BOF-{ (- arg) where))) 0)))
1757 (c-while-widening-to-decl-block
1758 (progn (c-syntactic-skip-backward "^}")
1759 (not (eq (char-before) ?}))))))
1761 ;; Move forward to the } of a function
1763 (c-while-widening-to-decl-block
1764 (> (setq arg (c-forward-to-nth-EOF-} arg where)) 0))))
1766 ;; Do we need to move forward from the brace to the semicolon?
1768 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1769 (c-syntactic-re-search-forward ";"))
1772 ;; We're there now, modulo comments and whitespace.
1773 ;; Try to be line oriented; position point after the next
1774 ;; newline that isn't inside a comment, but if we hit the
1775 ;; next declaration then we use the current point instead.
1776 (while (and (not (bolp))
1777 (not (looking-at "\\s *$"))
1778 (c-forward-single-comment)))
1780 ((looking-at "\\s *$")
1785 (c-keep-region-active)
1788 (defun c-defun-name ()
1789 "Return the name of the current defun, or NIL if there isn't one.
1790 \"Defun\" here means a function, or other top level construct
1791 with a brace block."
1793 (c-save-buffer-state
1794 (beginning-of-defun-function end-of-defun-function
1795 where pos name-end case-fold-search)
1800 ;; Move back out of any macro/comment/string we happen to be in.
1801 (c-beginning-of-macro)
1802 (setq pos (c-literal-limits))
1803 (if pos (goto-char (car pos)))
1805 (setq where (c-where-wrt-brace-construct))
1807 ;; Move to the beginning of the current defun, if any, if we're not
1809 (if (eq where 'outwith-function)
1811 (unless (eq where 'at-header)
1812 (c-backward-to-nth-BOF-{ 1 where)
1813 (c-beginning-of-decl-1))
1815 ;; Pick out the defun name, according to the type of defun.
1817 ;; struct, union, enum, or similar:
1818 ((and (looking-at c-type-prefix-key)
1819 (progn (c-forward-token-2 2) ; over "struct foo "
1820 (or (eq (char-after) ?\{)
1821 (looking-at c-symbol-key)))) ; "struct foo bar ..."
1822 (save-match-data (c-forward-token-2))
1823 (when (eq (char-after) ?\{)
1824 (c-backward-token-2)
1825 (looking-at c-symbol-key))
1826 (match-string-no-properties 0))
1828 ((looking-at "DEFUN\\s-*(") ;"DEFUN\\_>") think of XEmacs!
1829 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1830 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1832 (c-forward-syntactic-ws)
1833 (when (eq (char-after) ?\")
1835 (c-forward-token-2)) ; over the comma and following WS.
1836 (buffer-substring-no-properties
1840 (when (looking-at ":") ; CLISP: DEFUN(PACKAGE:LISP-SYMBOL,...)
1841 (skip-chars-forward "^,"))
1842 (c-backward-syntactic-ws)
1845 ((looking-at "DEF[a-zA-Z0-9_]* *( *\\([^, ]*\\) *,")
1846 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1847 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1848 (match-string-no-properties 1))
1851 ((assq 'objc-method-intro (c-guess-basic-syntax))
1852 (let ((bound (save-excursion (c-end-of-statement) (point)))
1853 (kw-re (concat "\\(?:" c-symbol-key "\\)?:"))
1855 (when (c-syntactic-re-search-forward c-symbol-key bound t t t)
1856 (push (match-string-no-properties 0) stretches)
1857 (while (c-syntactic-re-search-forward kw-re bound t t t)
1858 (push (match-string-no-properties 0) stretches)))
1859 (apply 'concat (nreverse stretches))))
1862 ;; Normal function or initializer.
1863 (when (c-syntactic-re-search-forward "[{(]" nil t)
1865 (c-backward-syntactic-ws)
1866 (when (eq (char-before) ?\=) ; struct foo bar = {0, 0} ;
1867 (c-backward-token-2)
1868 (c-backward-syntactic-ws))
1869 (setq name-end (point))
1870 (c-backward-token-2)
1871 (buffer-substring-no-properties (point) name-end)))))))))
1873 (defun c-declaration-limits (near)
1874 ;; Return a cons of the beginning and end positions of the current
1875 ;; top level declaration or macro. If point is not inside any then
1876 ;; nil is returned, unless NEAR is non-nil in which case the closest
1877 ;; following one is chosen instead (if there is any). The end
1878 ;; position is at the next line, providing there is one before the
1881 ;; This function might do hidden buffer changes.
1884 (when (eq c-defun-tactic 'go-outward)
1885 (c-narrow-to-most-enclosing-decl-block t) ; e.g. class, namespace
1886 (or (save-restriction
1887 (c-narrow-to-most-enclosing-decl-block nil)
1889 ;; Note: Some code duplication in `c-beginning-of-defun' and
1890 ;; `c-end-of-defun'.
1892 (let ((start (point))
1893 (paren-state (c-parse-state))
1896 (goto-char (c-least-enclosing-brace paren-state))
1897 ;; If we moved to the outermost enclosing paren
1898 ;; then we can use c-safe-position to set the
1899 ;; limit. Can't do that otherwise since the
1900 ;; earlier paren pair on paren-state might very
1901 ;; well be part of the declaration we should go
1903 (setq lim (c-safe-position (point) paren-state))
1905 ;; At top level. Make sure we aren't inside a literal.
1906 (setq pos (c-literal-limits
1907 (c-safe-position (point) paren-state)))
1908 (if pos (goto-char (car pos))))
1910 (when (c-beginning-of-macro)
1919 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1921 ;; We moved back over the previous defun. Skip to the next
1922 ;; one. Not using c-forward-syntactic-ws here since we
1923 ;; should not skip a macro. We can also be directly after
1924 ;; the block in a `c-opt-block-decls-with-vars-key'
1925 ;; declaration, but then we won't move significantly far
1928 (c-forward-comments)
1930 (when (and near (c-beginning-of-macro))
1938 (if (eobp) (throw 'exit nil))
1940 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1941 ;; declaration that doesn't end there. We're searching back and
1942 ;; forth over the block here, which can be expensive.
1944 (if (and c-opt-block-decls-with-vars-key
1946 (c-backward-syntactic-ws)
1947 (eq (char-before) ?}))
1948 (eq (car (c-beginning-of-decl-1))
1952 (and (> (point) pos)
1953 (setq end-pos (point)))))
1957 (if (and (not near) (> (point) start))
1960 ;; Try to be line oriented; position the limits at the
1961 ;; closest preceding boi, and after the next newline, that
1962 ;; isn't inside a comment, but if we hit a neighboring
1963 ;; declaration then we instead use the exact declaration
1964 ;; limit in that direction.
1967 (while (and (/= (point) (c-point 'boi))
1968 (c-backward-single-comment)))
1969 (if (/= (point) (c-point 'boi))
1977 (while (and (not (bolp))
1978 (not (looking-at "\\s *$"))
1979 (c-forward-single-comment)))
1982 ((looking-at "\\s *$")
1988 (goto-char (point-min))
1989 (c-forward-decl-or-cast-1 -1 nil nil)
1990 (eq (char-after) ?\{)
1991 (cons (point-min) (point-max))))))))
1993 (defun c-mark-function ()
1994 "Put mark at end of the current top-level declaration or macro, point at beginning.
1995 If point is not inside any then the closest following one is
1996 chosen. Each successive call of this command extends the marked
1997 region by one function.
1999 A mark is left where the command started, unless the region is already active
2000 \(in Transient Mark mode).
2002 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
2003 function does not require the declaration to contain a brace block."
2006 (let (decl-limits case-fold-search)
2007 (c-save-buffer-state nil
2008 ;; We try to be line oriented, unless there are several
2009 ;; declarations on the same line.
2010 (if (looking-at c-syntactic-eol)
2011 (c-backward-token-2 1 nil (c-point 'bol)))
2012 (setq decl-limits (c-declaration-limits t)))
2014 (if (not decl-limits)
2015 (error "Cannot find any declaration")
2016 (let* ((extend-region-p
2017 (and (eq this-command 'c-mark-function)
2018 (eq last-command 'c-mark-function)))
2019 (push-mark-p (and (eq this-command 'c-mark-function)
2020 (not extend-region-p)
2021 (not (c-region-is-active-p)))))
2022 (if push-mark-p (push-mark (point)))
2025 (exchange-point-and-mark)
2026 (setq decl-limits (c-declaration-limits t))
2027 (when (not decl-limits)
2028 (exchange-point-and-mark)
2029 (error "Cannot find any declaration"))
2030 (goto-char (cdr decl-limits))
2031 (exchange-point-and-mark))
2032 (goto-char (car decl-limits))
2033 (push-mark (cdr decl-limits) nil t))))))
2035 (defun c-cpp-define-name ()
2036 "Return the name of the current CPP macro, or NIL if we're not in one."
2038 (let (case-fold-search)
2040 (and c-opt-cpp-macro-define-start
2041 (c-beginning-of-macro)
2042 (looking-at c-opt-cpp-macro-define-start)
2043 (match-string-no-properties 1)))))
2046 ;; Movement by statements.
2047 (defun c-in-comment-line-prefix-p ()
2048 ;; Point is within a comment. Is it also within a comment-prefix?
2049 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2051 ;; This function might do hidden buffer changes.
2052 (let ((here (point)))
2055 (skip-chars-forward " \t")
2056 (and (looking-at c-current-comment-prefix)
2057 (/= (match-beginning 0) (match-end 0))
2058 (< here (match-end 0))))))
2060 (defun c-narrow-to-comment-innards (range)
2061 ;; Narrow to the "inside" of the comment (block) defined by range, as
2064 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2065 ;; present) removed. A c++-style line comment retains its opening "//" but
2066 ;; has any final NL removed. If POINT is currently outwith these innards,
2067 ;; move it to the appropriate boundary.
2069 ;; This narrowing simplifies the sentence movement functions, since it
2070 ;; eliminates awkward things at the boundaries of the comment (block).
2072 ;; This function might do hidden buffer changes.
2073 (let* ((lit-type (c-literal-type range))
2074 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
2075 (end (if (eq lit-type 'c)
2076 (if (and (eq (char-before (cdr range)) ?/)
2077 (eq (char-before (1- (cdr range))) ?*))
2080 (if (eq (cdr range) (point-max))
2082 (- (cdr range) 1)))))
2084 (goto-char end)) ; This would be done automatically by ...
2086 (goto-char beg)) ; ... narrow-to-region but is not documented.
2087 (narrow-to-region beg end)))
2089 (defun c-beginning-of-sentence-in-comment (range)
2090 ;; Move backwards to the "beginning of a sentence" within the comment
2091 ;; defined by RANGE, a cons of its starting and ending positions. If we
2092 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2093 ;; of the comment and return T.
2095 ;; The BOS is either text which follows a regexp match of sentence-end,
2096 ;; or text which is a beginning of "paragraph".
2097 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2099 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2100 ;; It is not a general function, but is intended only for calling from
2101 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2103 ;; This function might do hidden buffer changes.
2105 (let ((start-point (point)))
2107 (c-narrow-to-comment-innards range) ; This may move point back.
2108 (let* ((here (point))
2110 (here-filler ; matches WS and comment-prefixes at point.
2111 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
2112 "\\|[ \t\n\r\f]\\)*"))
2113 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
2114 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
2115 ;; First, find the previous paragraph start, if any.
2116 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
2118 (forward-paragraph -1) ; uses cc-mode values of
2119 ; paragraph-\(start\|separate\)
2120 (if (> (re-search-forward here-filler nil t) here)
2122 (when (>= (point) here)
2123 (forward-paragraph -2)
2124 (if (> (re-search-forward here-filler nil t) here)
2128 ;; Now seek successively earlier sentence ends between PAR-BEG and
2129 ;; HERE, until the "start of sentence" following it is earlier than
2130 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2131 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
2133 (goto-char (match-end 0)) ; tentative beginning of sentence
2134 (or (>= (point) here)
2135 (and (not (bolp)) ; Found a non-blank comment-prefix?
2137 (if (re-search-backward prefix-at-bol-here nil t)
2138 (/= (match-beginning 1) (match-end 1)))))
2139 (progn ; Skip the crud to find a real b-o-s.
2140 (if (c-in-comment-line-prefix-p)
2141 (beginning-of-line))
2142 (re-search-forward here-filler) ; always succeeds.
2143 (>= (point) here))))
2145 (re-search-forward here-filler)))
2147 (if (< (point) start-point)
2149 (goto-char (car range))
2152 (defun c-end-of-sentence-in-comment (range)
2153 ;; Move forward to the "end of a sentence" within the comment defined by
2154 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2155 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2156 ;; return NIL. Otherwise, move point to just after the end of the comment
2159 ;; The EOS is just after the non-WS part of the next match of the regexp
2160 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2161 ;; no sentence-end match following point, any WS before the end of the
2162 ;; comment will count as EOS, providing we're not already in it.
2164 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2165 ;; It is not a general function, but is intended only for calling from
2166 ;; c-move-over-sentence.
2168 ;; This function might do hidden buffer changes.
2170 (let ((start-point (point))
2171 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2174 (c-narrow-to-comment-innards range) ; This might move point forwards.
2175 (let* ((here (point))
2176 (par-end ; EOL position of last text in current/next paragraph.
2178 ;; The cc-mode values of paragraph-\(start\|separate\), set
2179 ;; in c-setup-paragraph-variables, are used in the
2181 (forward-paragraph 1)
2182 (if (eq (preceding-char) ?\n) (forward-char -1))
2183 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
2185 (forward-paragraph 2)
2186 (if (eq (preceding-char) ?\n) (forward-char -1)))
2191 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
2192 ;; Go forward one "comment-prefix which looks like sentence-end"
2193 ;; each time round the following:
2194 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
2197 (skip-chars-backward " \t\n")
2198 (or (and (not (bolp))
2199 (re-search-backward prefix-at-bol-here nil t)
2200 (/= (match-beginning 1) (match-end 1)))
2201 (<= (point) here))))
2204 ;; Take special action if we're up against the end of a comment (of
2205 ;; either sort): Leave point just after the last non-ws text.
2206 (if (eq (point) (point-max))
2207 (while (or (/= (skip-chars-backward " \t\n") 0)
2208 (and (re-search-backward prefix-at-bol-here nil t)
2209 (/= (match-beginning 1) (match-end 1))))))))
2211 (if (> (point) start-point)
2213 (goto-char (cdr range))
2216 (defun c-beginning-of-sentence-in-string (range)
2217 ;; Move backwards to the "beginning of a sentence" within the string defined
2218 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2219 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2220 ;; just before the start of the string and return T.
2222 ;; The BOS is either the text which follows a regexp match of sentence-end
2223 ;; or text which is a beginning of "paragraph". For the purposes of
2224 ;; determining paragraph boundaries, escaped newlines are treated as
2225 ;; ordinary newlines.
2227 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2228 ;; It is not a general function, but is intended only for calling from
2229 ;; c-move-over-sentence.
2231 ;; This function might do hidden buffer changes.
2233 (let* ((here (point)) last
2234 (end (1- (cdr range)))
2235 (here-filler ; matches WS and escaped newlines at point.
2236 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2237 ;; Enhance paragraph-start and paragraph-separate also to recognize
2238 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2239 ;; these values should be customizable user options, or something.
2240 (paragraph-start c-string-par-start)
2241 (paragraph-separate c-string-par-separate)
2243 (par-beg ; beginning of current (or previous) paragraph.
2246 (narrow-to-region (1+ (car range)) end)
2247 (forward-paragraph -1) ; uses above values of
2248 ; paragraph-\(start\|separate\)
2249 (if (> (re-search-forward here-filler nil t) here)
2251 (when (>= (point) here)
2252 (forward-paragraph -2)
2253 (if (> (re-search-forward here-filler nil t) here)
2256 ;; Now see if we can find a sentence end after PAR-BEG.
2257 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2259 (goto-char (match-end 0))
2263 here-filler end t) ; always succeeds. Use end rather
2264 ; than here, in case point starts
2265 ; beyond the closing quote.
2266 (>= (point) here))))
2268 (re-search-forward here-filler here t)
2269 (if (< (point) here)
2271 (goto-char (car range))
2274 (defun c-end-of-sentence-in-string (range)
2275 ;; Move forward to the "end of a sentence" within the string defined by
2276 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2277 ;; return NIL. Otherwise, move point to just after the end of the string
2280 ;; The EOS is just after the non-WS part of the next match of the regexp
2281 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2282 ;; no sentence-end match following point, any WS before the end of the
2283 ;; string will count as EOS, providing we're not already in it.
2285 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2286 ;; It is not a general function, but is intended only for calling from
2287 ;; c-move-over-sentence.
2289 ;; This function might do hidden buffer changes.
2291 (let* ((here (point))
2293 ;; Enhance paragraph-start and paragraph-separate to recognize
2294 ;; blank lines terminated by escaped EOLs.
2295 (paragraph-start c-string-par-start)
2296 (paragraph-separate c-string-par-separate)
2298 (par-end ; EOL position of last text in current/next paragraph.
2301 (narrow-to-region (car range) (1- (cdr range)))
2302 ;; The above values of paragraph-\(start\|separate\) are used
2303 ;; in the following.
2304 (forward-paragraph 1)
2306 ;; (re-search-backward filler-here nil t) would find an empty
2307 ;; string. Therefore we simulate it by the following:
2308 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2309 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2310 (unless (> (point) here)
2312 (forward-paragraph 1)
2313 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2314 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2316 ;; Try to go forward a sentence.
2317 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2319 (while (or (/= (skip-chars-backward " \t\n") 0)
2320 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2321 ;; Did we move a sentence, or did we hit the end of the string?
2322 (if (> (point) here)
2324 (goto-char (cdr range))
2327 (defun c-ascertain-preceding-literal ()
2328 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2329 ;; If a literal is the next thing (aside from whitespace) to be found before
2330 ;; point, return a cons of its start.end positions (enclosing the
2331 ;; delimiters). Otherwise return NIL.
2333 ;; This function might do hidden buffer changes.
2335 (c-collect-line-comments
2336 (let ((here (point))
2338 (if (c-backward-single-comment)
2339 (cons (point) (progn (c-forward-single-comment) (point)))
2341 ;; to prevent `looking-at' seeing a " at point.
2342 (narrow-to-region (point-min) here)
2345 ;; An EOL can act as an "open string" terminator in AWK.
2346 (looking-at c-ws*-string-limit-regexp)
2348 (progn (backward-char)
2349 (looking-at c-string-limit-regexp))))
2350 (goto-char (match-end 0)) ; just after the string terminator.
2352 (c-safe (c-backward-sexp 1) ; move back over the string.
2353 (cons (point) pos)))))))))
2355 (defun c-ascertain-following-literal ()
2356 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2357 ;; If a literal is the next thing (aside from whitespace) following point,
2358 ;; return a cons of its start.end positions (enclosing the delimiters).
2359 ;; Otherwise return NIL.
2361 ;; This function might do hidden buffer changes.
2363 (c-collect-line-comments
2366 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2367 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2370 (if (c-forward-single-comment)
2371 (cons pos (point))))))))
2373 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2374 ;; Does point immediately follow a statement "terminator"? A virtual
2375 ;; semicolon is regarded here as such. So is an opening brace ;-)
2377 ;; This function might do hidden buffer changes.
2380 (and (looking-at "[;{}]")
2381 (not (and c-special-brace-lists ; Pike special brace lists.
2382 (eq (char-after) ?{)
2383 (c-looking-at-special-brace-list)))))
2385 ;; The following (for macros) is not strict about exactly where we are
2386 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2387 ;; much. ACM 2004/3/29.
2390 (if (c-beginning-of-macro)
2391 (setq eom (progn (c-end-of-macro)
2395 (c-forward-comments)
2396 (>= (point) eom))))))
2398 (defun c-back-over-illiterals (macro-start)
2399 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2400 ;; stopping before reaching BOB or a literal or the boundary of a
2401 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2402 ;; the position of the '#' beginning the current preprocessor directive, or
2403 ;; NIL if we're not in such.
2405 ;; Return a cons (A.B), where
2406 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2407 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2408 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2409 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2411 ;; The total collection of returned values is as follows:
2412 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2413 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2414 ;; a BOS - the caller must check this.
2415 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2416 ;; moved and reached the opening # of the macro.
2417 ;; (t . macro-boundary): Every other circumstance in which we're at a
2418 ;; macro-boundary. We might be at a BOS.
2420 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2421 ;; code before encountering the literal/BOB or macro-boundary.
2423 ;; Note that this function moves within either preprocessor commands
2424 ;; (macros) or normal code, but will not cross a boundary between the two,
2425 ;; or between two distinct preprocessor commands.
2427 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2428 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2429 ;; move into parens. Also stop before `#' when it's at boi on a line.
2431 ;; This function might do hidden buffer changes.
2433 (let ((here (point))
2434 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2435 ; semicolon precedes it.
2437 (while t ;; We go back one "token" each iteration of the loop.
2440 ;; Stop at the token after a comment.
2441 ((c-backward-single-comment) ; Also functions as backwards-ws.
2443 (throw 'done '(t . literal)))
2445 ;; If we've gone back over a LF, we might have moved into or out of
2446 ;; a preprocessor line.
2447 ((and (save-excursion
2449 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2451 (< (point) macro-start)
2452 (c-beginning-of-macro)))
2454 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2455 (throw 'done (cons (or (eq (point) here)
2459 ;; Have we found a virtual semicolon? If so, stop, unless the next
2460 ;; statement is where we started from.
2461 ((and (c-at-vsemi-p)
2463 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2465 (throw 'done '(nil . nil)))
2467 ;; Hit the beginning of the buffer/region?
2471 (throw 'done '(nil . nil)))
2473 ;; Move back a character.
2474 ((progn (backward-char) nil))
2476 ;; Stop at "{" (unless it's a PIKE special brace list.)
2477 ((eq (char-after) ?\{)
2478 (if (and c-special-brace-lists
2479 (c-looking-at-special-brace-list))
2480 (skip-syntax-backward "w_") ; Speedup only.
2483 (throw 'done '(nil . nil))))
2485 ;; Have we reached the start of a macro? This always counts as
2486 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2487 ;; here. FIXME!!! ACM 2004/3/29)
2488 ((and macro-start (eq (point) macro-start))
2489 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2491 ;; Stop at token just after "}" or ";".
2492 ((looking-at "[;}]")
2493 ;; If we've gone back over ;, {, or }, we're done.
2494 (if (or (= here last)
2495 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2496 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2497 (eq (char-after) ?\;))
2499 (goto-char last) ; To the statement starting after the ; or }.
2500 (throw 'done '(nil . nil))))
2502 ;; Stop at the token after a string.
2503 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2505 (throw 'done '(t . literal)))
2507 ;; Nothing special: go back word characters.
2508 (t (skip-syntax-backward "w_")) ; Speedup only.
2511 (defun c-forward-over-illiterals (macro-end allow-early-stop)
2512 ;; Move forwards over code, stopping before reaching EOB or a literal
2513 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2514 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2515 ;; terminates the current preprocessor directive, or NIL if we're not in
2518 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2519 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2520 ;; seems unavoidable. Depending on the context this function is called
2521 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2522 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2523 ;; semicolons, or anything else.
2525 ;; Return a cons (A.B), where
2526 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2527 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2528 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2529 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2531 ;; Point is left either after the end-of-statement, or at the last non-ws
2532 ;; code before encountering the literal, or the # of the preprocessor
2533 ;; statement, or at EOB [or just after last non-WS stuff??].
2535 ;; As a clarification of "after the end-of-statement", if a comment or
2536 ;; whitespace follows a completed AWK statement, that statement is treated
2537 ;; as ending just after the last non-ws character before the comment.
2539 ;; Note that this function moves within either preprocessor commands
2540 ;; (macros) or normal code, but not both within the same invocation.
2542 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2543 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2544 ;; stop before `{' if at top level or inside braces, though. Move by
2545 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2548 ;; This function might do hidden buffer changes.
2549 (let ((here (point))
2552 (while t ;; We go one "token" forward each time round this loop.
2555 ;; If we've moved forward to a virtual semicolon, we're done.
2556 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2558 (throw 'done '(nil . nil)))
2562 ;; Gone past the end of a macro?
2563 ((and macro-end (> (point) macro-end))
2565 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2567 ;; About to hit a comment?
2568 ((save-excursion (c-forward-single-comment))
2570 (throw 'done '(t . literal)))
2576 (throw 'done '(nil . nil)))
2578 ;; If we encounter a '{', stop just after the previous token.
2579 ((and (eq (char-after) ?{)
2580 (not (and c-special-brace-lists
2581 (c-looking-at-special-brace-list)))
2582 (or allow-early-stop (/= here last))
2583 (save-excursion ; Is this a check that we're NOT at top level?
2584 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2585 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2586 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2587 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2588 (or (not (c-safe (up-list -1) t))
2589 (= (char-after) ?{))))
2591 (throw 'done '(nil . nil)))
2593 ;; End of a PIKE special brace list? If so, step over it and continue.
2594 ((and c-special-brace-lists
2595 (eq (char-after) ?})
2597 (and (c-safe (up-list -1) t)
2598 (c-looking-at-special-brace-list))))
2600 (skip-syntax-forward "w_")) ; Speedup only.
2602 ;; Have we got a '}' after having moved? If so, stop after the
2604 ((and (eq (char-after) ?})
2607 (throw 'done '(nil . nil)))
2609 ;; Stop if we encounter a preprocessor line. Continue if we
2611 ((and c-opt-cpp-prefix
2613 (eq (char-after) ?#)
2614 (= (point) (c-point 'boi)))
2615 (if (= (point) here) ; Not a macro, therefore naked #.
2617 (throw 'done '(t . macro-boundary))))
2619 ;; Stop after a ';', '}', or "};"
2620 ((looking-at ";\\|};?")
2621 (goto-char (match-end 0))
2622 (throw 'done '(nil . nil)))
2624 ;; Found a string (this subsumes AWK regexps)?
2625 ((looking-at c-string-limit-regexp)
2627 (throw 'done '(t . literal)))
2630 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2631 (skip-syntax-forward "w_") ; Speedup only.
2632 (when (and macro-end (> (point) macro-end))
2634 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2637 (defun c-one-line-string-p (range)
2638 ;; Is the literal defined by RANGE a string contained in a single line?
2640 ;; This function might do hidden buffer changes.
2642 (goto-char (car range))
2643 (and (looking-at c-string-limit-regexp)
2644 (progn (skip-chars-forward "^\n" (cdr range))
2645 (eq (point) (cdr range))))))
2647 (defun c-beginning-of-statement (&optional count lim sentence-flag)
2648 "Go to the beginning of the innermost C statement.
2649 With prefix arg, go back N - 1 statements. If already at the
2650 beginning of a statement then go to the beginning of the closest
2651 preceding one, moving into nested blocks if necessary (use
2652 \\[backward-sexp] to skip over a block). If within or next to a
2653 comment or multiline string, move by sentences instead of statements.
2655 When called from a program, this function takes 3 optional args: the
2656 repetition count, a buffer position limit which is the farthest back
2657 to search for the syntactic context, and a flag saying whether to do
2658 sentence motion in or near comments and multiline strings.
2660 Note that for use in programs, `c-beginning-of-statement-1' is
2661 usually better. It has much better defined semantics than this one,
2662 which is intended for interactive use, and might therefore change to
2663 be more \"DWIM:ey\"."
2664 (interactive (list (prefix-numeric-value current-prefix-arg)
2667 (c-end-of-statement (- count) lim sentence-flag)
2668 (c-save-buffer-state
2669 ((count (or count 1))
2670 last ; start point for going back ONE chunk. Updated each chunk movement.
2672 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2673 res ; result from sub-function call
2674 not-bos ; "not beginning-of-statement"
2675 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2677 ;; Go back one statement at each iteration of the following loop.
2678 (while (and (/= count 0)
2679 (or (not lim) (> (point) lim)))
2680 ;; Go back one "chunk" each time round the following loop, stopping
2681 ;; when we reach a statement boundary, etc.
2684 (cond ; Each arm of this cond returns NIL on reaching a desired
2685 ; statement boundary, non-NIL otherwise.
2690 (range ; point is within or approaching a literal.
2692 ;; Single line string or sentence-flag is null => skip the
2694 ((or (null sentence-flag)
2695 (c-one-line-string-p range))
2696 (goto-char (car range))
2697 (setq range (c-ascertain-preceding-literal))
2698 ;; N.B. The following is essentially testing for an AWK regexp
2700 ;; Was the previous non-ws thing an end of statement?
2703 (c-backward-comments)
2704 (c-backward-syntactic-ws))
2705 (not (or (bobp) (c-after-statement-terminator-p)))))
2707 ;; Comment inside a statement or a multi-line string.
2708 (t (when (setq res ; returns non-nil when we go out of the literal
2709 (if (eq (c-literal-type range) 'string)
2710 (c-beginning-of-sentence-in-string range)
2711 (c-beginning-of-sentence-in-comment range)))
2712 (setq range (c-ascertain-preceding-literal)))
2715 ;; Non-literal code.
2716 (t (setq res (c-back-over-illiterals macro-fence))
2717 (setq not-bos ; "not reached beginning-of-statement".
2718 (or (= (point) last)
2719 (memq (char-after) '(?\) ?\}))
2722 ;; We're at a tentative BOS. The next form goes
2723 ;; back over WS looking for an end of previous
2725 (not (save-excursion
2727 (c-backward-comments)
2728 (c-backward-syntactic-ws))
2729 (or (bobp) (c-after-statement-terminator-p)))))))
2730 ;; Are we about to move backwards into or out of a
2731 ;; preprocessor command? If so, locate its beginning.
2732 (when (eq (cdr res) 'macro-boundary)
2737 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2739 ;; Are we about to move backwards into a literal?
2740 (when (memq (cdr res) '(macro-boundary literal))
2741 (setq range (c-ascertain-preceding-literal)))
2743 (setq last (point)))
2745 (if (/= count 0) (setq count (1- count))))
2746 (c-keep-region-active))))
2748 (defun c-end-of-statement (&optional count lim sentence-flag)
2749 "Go to the end of the innermost C statement.
2750 With prefix arg, go forward N - 1 statements. Move forward to the end
2751 of the next statement if already at end, and move into nested blocks
2752 \(use \\[forward-sexp] to skip over a block). If within or next to a
2753 comment or multiline string, move by sentences instead of statements.
2755 When called from a program, this function takes 3 optional args: the
2756 repetition count, a buffer position limit which is the farthest back
2757 to search for the syntactic context, and a flag saying whether to do
2758 sentence motion in or near comments and multiline strings."
2759 (interactive (list (prefix-numeric-value current-prefix-arg)
2761 (setq count (or count 1))
2762 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2764 (c-save-buffer-state
2765 (here ; start point for going forward ONE statement. Updated each statement.
2768 (and (not (eobp)) (c-beginning-of-macro)
2769 (progn (c-end-of-macro) (point)))))
2771 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2773 ;; Go back/forward one statement at each iteration of the following loop.
2774 (while (and (/= count 0)
2775 (or (not lim) (< (point) lim)))
2776 (setq here (point)) ; ONLY HERE is HERE updated
2778 ;; Go forward one "chunk" each time round the following loop, stopping
2779 ;; when we reach a statement boundary, etc.
2781 (cond ; Each arm of this cond returns NIL on reaching a desired
2782 ; statement boundary, non-NIL otherwise.
2787 (range ; point is within a literal.
2789 ;; sentence-flag is null => skip the entire literal.
2790 ;; or a Single line string.
2791 ((or (null sentence-flag)
2792 (c-one-line-string-p range))
2793 (goto-char (cdr range))
2794 (setq range (c-ascertain-following-literal))
2795 ;; Is there a virtual semicolon here (e.g. for AWK)?
2796 (not (c-at-vsemi-p)))
2798 ;; Comment or multi-line string.
2799 (t (when (setq res ; gets non-nil when we go out of the literal
2800 (if (eq (c-literal-type range) 'string)
2801 (c-end-of-sentence-in-string range)
2802 (c-end-of-sentence-in-comment range)))
2803 (setq range (c-ascertain-following-literal)))
2804 ;; If we've just come forward out of a literal, check for
2805 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2806 ;; some other language may do in the future)
2808 (not (c-at-vsemi-p))))))
2810 ;; Non-literal code.
2811 (t (setq res (c-forward-over-illiterals macro-fence
2813 ;; Are we about to move forward into or out of a
2814 ;; preprocessor command?
2815 (when (eq (cdr res) 'macro-boundary)
2822 (progn (c-skip-ws-forward)
2823 (c-beginning-of-macro))
2824 (progn (c-end-of-macro)
2827 (c-beginning-of-macro)
2828 (progn (c-end-of-macro) (point)))))))
2829 ;; Are we about to move forward into a literal?
2830 (when (memq (cdr res) '(macro-boundary literal))
2831 (setq range (c-ascertain-following-literal)))
2834 (if (/= count 0) (setq count (1- count))))
2835 (c-keep-region-active))))
2838 ;; set up electric character functions to work with pending-del,
2839 ;; (a.k.a. delsel) mode. All symbols get the t value except
2840 ;; the functions which delete, which gets 'supersede.
2844 (put sym 'delete-selection t) ; for delsel (Emacs)
2845 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2850 c-electric-semi&comma
2854 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2855 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2856 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2857 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
2858 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2859 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
2862 ;; Inserting/indenting comments
2863 (defun c-calc-comment-indent (entry)
2864 ;; This function might do hidden buffer changes.
2866 (setq entry (or (assq entry c-indent-comment-alist)
2867 (assq 'other c-indent-comment-alist)
2868 '(default . (column . nil)))))
2869 (let ((action (car (cdr entry)))
2870 (value (cdr (cdr entry)))
2871 (col (current-column)))
2872 (cond ((eq action 'space)
2874 ((eq action 'column)
2875 (unless value (setq value comment-column))
2877 ;; Do not pad with one space if we're at bol.
2879 (max (1+ col) value)))
2885 (let ((lim (c-literal-limits (c-point 'bol) t)))
2887 (goto-char (car lim))
2888 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2889 ;; Found comment to align with.
2891 ;; Do not pad with one space if we're at bol.
2893 (max (1+ col) (current-column))))))))
2894 ;; Recurse to handle value as a new spec.
2895 (c-calc-comment-indent (cdr entry)))))))
2897 (defun c-comment-indent ()
2898 "Used by `indent-for-comment' to create and indent comments.
2899 See `c-indent-comment-alist' for a description."
2902 (c-save-buffer-state
2903 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
2904 (or (when (consp lim)
2905 (goto-char (car lim))
2906 (when (looking-at "/[/*]")
2907 (skip-chars-backward " \t")
2910 (skip-chars-backward " \t")
2913 (cond ((looking-at "^/[/*]")
2915 ((progn (beginning-of-line)
2918 ((progn (back-to-indentation)
2919 (and (eq (char-after) ?})
2920 (eq (point) (1- eot))))
2922 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2923 (eq (match-end 0) eot))
2928 (if (and (memq line-type '(anchored-comment empty-line))
2929 c-indent-comments-syntactically-p)
2930 (let ((c-syntactic-context (c-guess-basic-syntax)))
2931 ;; BOGOSITY ALERT: if we're looking at the eol, its
2932 ;; because indent-for-comment hasn't put the comment-start
2933 ;; in the buffer yet. this will screw up the syntactic
2934 ;; analysis so we kludge in the necessary info. Another
2935 ;; kludge is that if we're at the bol, then we really want
2936 ;; to ignore any anchoring as specified by
2937 ;; c-comment-only-line-offset since it doesn't apply here.
2939 (c-add-syntax 'comment-intro))
2940 (let ((c-comment-only-line-offset
2941 (if (consp c-comment-only-line-offset)
2942 c-comment-only-line-offset
2943 (cons c-comment-only-line-offset
2944 c-comment-only-line-offset))))
2945 (c-get-syntactic-indentation c-syntactic-context)))
2947 (c-calc-comment-indent line-type)))))
2950 ;; used by outline-minor-mode
2951 (defun c-outline-level ()
2952 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2953 ;; in otherwise-hidden text.
2955 (skip-chars-forward "\t ")
2959 ;; Movement by CPP conditionals.
2960 (defun c-up-conditional (count)
2961 "Move back to the containing preprocessor conditional, leaving mark behind.
2962 A prefix argument acts as a repeat count. With a negative argument,
2963 move forward to the end of the containing preprocessor conditional.
2965 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2966 function stops at them when going backward, but not when going
2969 (let ((new-point (c-scan-conditionals (- count) -1)))
2971 (goto-char new-point))
2972 (c-keep-region-active))
2974 (defun c-up-conditional-with-else (count)
2975 "Move back to the containing preprocessor conditional, including \"#else\".
2976 Just like `c-up-conditional', except it also stops at \"#else\"
2979 (let ((new-point (c-scan-conditionals (- count) -1 t)))
2981 (goto-char new-point))
2982 (c-keep-region-active))
2984 (defun c-down-conditional (count)
2985 "Move forward into the next preprocessor conditional, leaving mark behind.
2986 A prefix argument acts as a repeat count. With a negative argument,
2987 move backward into the previous preprocessor conditional.
2989 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2990 function stops at them when going forward, but not when going
2993 (let ((new-point (c-scan-conditionals count 1)))
2995 (goto-char new-point))
2996 (c-keep-region-active))
2998 (defun c-down-conditional-with-else (count)
2999 "Move forward into the next preprocessor conditional, including \"#else\".
3000 Just like `c-down-conditional', except it also stops at \"#else\"
3003 (let ((new-point (c-scan-conditionals count 1 t)))
3005 (goto-char new-point))
3006 (c-keep-region-active))
3008 (defun c-backward-conditional (count &optional target-depth with-else)
3009 "Move back across a preprocessor conditional, leaving mark behind.
3010 A prefix argument acts as a repeat count. With a negative argument,
3011 move forward across a preprocessor conditional.
3013 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3014 and have the same meanings as in `c-scan-conditionals'. If you
3015 are calling c-forward-conditional from a program, you might want
3016 to call `c-scan-conditionals' directly instead."
3018 (let ((new-point (c-scan-conditionals (- count) target-depth with-else)))
3020 (goto-char new-point))
3021 (c-keep-region-active))
3023 (defun c-forward-conditional (count &optional target-depth with-else)
3024 "Move forward across a preprocessor conditional, leaving mark behind.
3025 A prefix argument acts as a repeat count. With a negative argument,
3026 move backward across a preprocessor conditional.
3028 If there aren't enough conditionals after \(or before) point, an
3031 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
3032 the nesting level isn't changed when tracking subconditionals.
3034 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3035 and have the same meanings as in `c-scan-conditionals'. If you
3036 are calling c-forward-conditional from a program, you might want
3037 to call `c-scan-conditionals' directly instead."
3039 (let ((new-point (c-scan-conditionals count target-depth with-else)))
3041 (goto-char new-point)))
3043 (defun c-scan-conditionals (count &optional target-depth with-else)
3044 "Scan forward across COUNT preprocessor conditionals.
3045 With a negative argument, scan backward across preprocessor
3046 conditionals. Return the end position. Point is not moved.
3048 If there aren't enough preprocessor conditionals, throw an error.
3050 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
3051 the nesting level isn't changed when tracking subconditionals.
3053 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3054 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3055 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3058 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
3059 are treated as conditional clause limits. Normally they are ignored."
3060 (let* ((forward (> count 0))
3061 (increment (if forward -1 1))
3062 (search-function (if forward 're-search-forward 're-search-backward))
3063 new case-fold-search)
3064 (unless (integerp target-depth)
3065 (setq target-depth (if target-depth -1 0)))
3069 ;; subdepth is the depth in "uninteresting" subtrees,
3070 ;; i.e. those that takes us farther from the target
3071 ;; depth instead of closer.
3075 ;; Find the "next" significant line in the proper direction.
3076 (while (and (not found)
3077 ;; Rather than searching for a # sign that
3078 ;; comes at the beginning of a line aside from
3079 ;; whitespace, search first for a string
3080 ;; starting with # sign. Then verify what
3081 ;; precedes it. This is faster on account of
3082 ;; the fastmap feature of the regexp matcher.
3083 (funcall search-function
3084 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
3087 ;; Now verify it is really a preproc line.
3088 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
3089 (let (dchange (directive (match-string 1)))
3090 (cond ((string= directive "if")
3091 (setq dchange (- increment)))
3092 ((string= directive "endif")
3093 (setq dchange increment))
3095 ;; When we're not in an "uninteresting"
3096 ;; subtree, we might want to act on "elif"
3098 (if (cond (with-else
3099 ;; Always move toward the target depth.
3101 (if (> target-depth 0) 1 -1)))
3102 ((string= directive "elif")
3103 (setq dchange (- increment))))
3104 ;; Ignore the change if it'd take us
3105 ;; into an "uninteresting" subtree.
3106 (if (eq (> dchange 0) (<= target-depth 0))
3107 (setq dchange nil)))))
3109 (when (or (/= subdepth 0)
3110 (eq (> dchange 0) (<= target-depth 0)))
3111 (setq subdepth (+ subdepth dchange)))
3112 (setq depth (+ depth dchange))
3113 ;; If we are trying to move across, and we find an
3114 ;; end before we find a beginning, get an error.
3115 (if (and (< depth target-depth) (< dchange 0))
3117 "No following conditional at this level"
3118 "No previous conditional at this level"))))
3119 ;; When searching forward, start from next line so
3120 ;; that we don't find the same line again.
3121 (if forward (forward-line 1))
3122 ;; We found something if we've arrived at the
3124 (if (and dchange (= depth target-depth))
3125 (setq found (point))))
3127 (if forward (forward-line 1)))))
3129 (error "No containing preprocessor conditional"))
3130 (goto-char (setq new found)))
3131 (setq count (+ count increment))))
3132 (c-keep-region-active)
3136 ;; commands to indent lines, regions, defuns, and expressions
3137 (defun c-indent-command (&optional arg)
3138 "Indent current line as C code, and/or insert some whitespace.
3140 If `c-tab-always-indent' is t, always just indent the current line.
3141 If nil, indent the current line only if point is at the left margin or
3142 in the line's indentation; otherwise insert some whitespace[*]. If
3143 other than nil or t, then some whitespace[*] is inserted only within
3144 literals (comments and strings), but the line is always reindented.
3146 If `c-syntactic-indentation' is t, indentation is done according to
3147 the syntactic context. A numeric argument, regardless of its value,
3148 means indent rigidly all the lines of the expression starting after
3149 point so that this line becomes properly indented. The relative
3150 indentation among the lines of the expression is preserved.
3152 If `c-syntactic-indentation' is nil, the line is just indented one
3153 step according to `c-basic-offset'. In this mode, a numeric argument
3154 indents a number of such steps, positive or negative, and an empty
3155 prefix argument is equivalent to -1.
3157 [*] The amount and kind of whitespace inserted is controlled by the
3158 variable `c-insert-tab-function', which is called to do the actual
3159 insertion of whitespace. Normally the function in this variable
3160 just inserts a tab character, or the equivalent number of spaces,
3161 depending on the variable `indent-tabs-mode'."
3164 (let ((indent-function
3165 (if c-syntactic-indentation
3166 (symbol-function 'indent-according-to-mode)
3168 (let ((c-macro-start c-macro-start)
3169 (steps (if (equal arg '(4))
3171 (prefix-numeric-value arg))))
3172 (c-shift-line-indentation (* steps c-basic-offset))
3173 (when (and c-auto-align-backslashes
3176 (eq (char-before) ?\\))
3177 (c-query-and-set-macro-start))
3178 ;; Realign the line continuation backslash if inside a macro.
3179 (c-backslash-region (point) (point) nil t)))
3181 (if (and c-syntactic-indentation arg)
3182 ;; If c-syntactic-indentation and got arg, always indent this
3183 ;; line as C and shift remaining lines of expression the same
3185 (let ((shift-amt (save-excursion
3186 (back-to-indentation)
3190 (setq shift-amt (- (save-excursion
3191 (back-to-indentation)
3195 (if (eq c-tab-always-indent t)
3196 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
3204 (indent-code-rigidly beg end shift-amt "#")))
3205 ;; Else use c-tab-always-indent to determine behavior.
3207 ;; CASE 1: indent when at column zero or in line's indentation,
3208 ;; otherwise insert a tab
3209 ((not c-tab-always-indent)
3211 (skip-chars-backward " \t")
3213 (funcall c-insert-tab-function)
3214 (funcall indent-function)))
3215 ;; CASE 2: just indent the line
3216 ((eq c-tab-always-indent t)
3217 (funcall indent-function))
3218 ;; CASE 3: if in a literal, insert a tab, but always indent the
3221 (if (c-save-buffer-state () (c-in-literal))
3222 (funcall c-insert-tab-function))
3223 (funcall indent-function)
3226 (defun c-indent-exp (&optional shutup-p)
3227 "Indent each line in the balanced expression following point syntactically.
3228 If optional SHUTUP-P is non-nil, no errors are signaled if no
3229 balanced expression is found."
3231 (let ((here (point-marker))
3233 (set-marker-insertion-type here t)
3235 (let ((start (save-restriction
3236 ;; Find the closest following open paren that
3237 ;; ends on another line.
3238 (narrow-to-region (point-min) (c-point 'eol))
3239 (let (beg (end (point)))
3240 (while (and (setq beg (c-down-list-forward end))
3241 (setq end (c-up-list-forward beg))))
3243 (eq (char-syntax (char-before beg)) ?\()
3248 (error "Cannot find start of balanced expression to indent"))
3250 (setq end (c-safe (scan-sexps (point) 1)))
3253 (error "Cannot find end of balanced expression to indent"))
3256 (c-indent-region (point) end)))))
3258 (set-marker here nil))))
3260 (defun c-indent-defun ()
3261 "Indent the current top-level declaration or macro syntactically.
3262 In the macro case this also has the effect of realigning any line
3263 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3265 (let ((here (point-marker)) decl-limits case-fold-search)
3268 (c-save-buffer-state nil
3269 ;; We try to be line oriented, unless there are several
3270 ;; declarations on the same line.
3271 (if (looking-at c-syntactic-eol)
3272 (c-backward-token-2 1 nil (c-point 'bol))
3273 (c-forward-token-2 0 nil (c-point 'eol)))
3274 (setq decl-limits (c-declaration-limits nil)))
3276 (c-indent-region (car decl-limits)
3277 (cdr decl-limits))))
3279 (set-marker here nil))))
3281 (defun c-indent-region (start end &optional quiet)
3282 "Indent syntactically every line whose first char is between START
3283 and END inclusive. If the optional argument QUIET is non-nil then no
3284 syntactic errors are reported, even if `c-report-syntactic-errors' is
3288 (skip-chars-backward " \t\n\r\f\v")
3291 ;; Advance to first nonblank line.
3293 (skip-chars-forward " \t\n\r\f\v")
3294 (setq start (point))
3296 (setq c-parsing-error
3297 (or (let ((endmark (copy-marker end))
3298 (c-parsing-error nil)
3299 ;; shut up any echo msgs on indiv lines
3300 (c-echo-syntactic-information-p nil)
3301 (ml-macro-start ; Start pos of multi-line macro.
3302 (and (c-save-buffer-state ()
3303 (save-excursion (c-beginning-of-macro)))
3304 (eq (char-before (c-point 'eol)) ?\\)
3306 (c-fix-backslashes nil)
3310 (c-progress-init start end 'c-indent-region)
3312 (while (and (bolp) ;; One line each time round the loop.
3314 (< (point) endmark))
3318 (unless (or (looking-at "\\s *$")
3319 (and ml-macro-start (looking-at "\\s *\\\\$")))
3320 ;; Get syntax and indent.
3321 (c-save-buffer-state nil
3322 (setq syntax (c-guess-basic-syntax)))
3323 (c-indent-line syntax t t))
3326 ;; End of current multi-line macro?
3327 (when (and c-auto-align-backslashes
3328 (not (eq (char-before (c-point 'eol)) ?\\)))
3329 ;; Fixup macro backslashes.
3330 (c-backslash-region ml-macro-start (c-point 'bonl) nil)
3331 (setq ml-macro-start nil))
3332 ;; New multi-line macro?
3333 (if (and (assq 'cpp-macro syntax)
3334 (eq (char-before (c-point 'eol)) ?\\))
3335 (setq ml-macro-start (point))))
3339 (if (and ml-macro-start c-auto-align-backslashes)
3340 (c-backslash-region ml-macro-start (c-point 'bopl) nil t)))
3341 (set-marker endmark nil)
3342 (c-progress-fini 'c-indent-region))
3343 (c-echo-parsing-error quiet))
3346 (defun c-fn-region-is-active-p ()
3347 ;; Function version of the macro for use in places that aren't
3348 ;; compiled, e.g. in the menus.
3349 (c-region-is-active-p))
3351 (defun c-indent-line-or-region (&optional arg region)
3352 "Indent active region, current line, or block starting on this line.
3353 In Transient Mark mode, when the region is active, reindent the region.
3354 Otherwise, with a prefix argument, rigidly reindent the expression
3355 starting on the current line.
3356 Otherwise reindent just the current line."
3358 (list current-prefix-arg (c-region-is-active-p)))
3360 (c-indent-region (region-beginning) (region-end))
3361 (c-indent-command arg)))
3363 ;; for progress reporting
3364 (defvar c-progress-info nil)
3366 (defun c-progress-init (start end context)
3369 ((not c-progress-interval))
3370 ;; Start the progress update messages. If this Emacs doesn't have
3371 ;; a built-in timer, just be dumb about it.
3372 ((not (fboundp 'current-time))
3373 (message "Indenting region... (this may take a while)"))
3374 ;; If progress has already been initialized, do nothing. otherwise
3375 ;; initialize the counter with a vector of:
3376 ;; [start end lastsec context]
3378 (t (setq c-progress-info (vector start
3382 (nth 1 (current-time))
3384 (message "Indenting region..."))
3387 (defun c-progress-update ()
3388 (if (not (and c-progress-info c-progress-interval))
3390 (let ((now (nth 1 (current-time)))
3391 (start (aref c-progress-info 0))
3392 (end (aref c-progress-info 1))
3393 (lastsecs (aref c-progress-info 2)))
3394 ;; should we update? currently, update happens every 2 seconds,
3395 ;; what's the right value?
3396 (if (< c-progress-interval (- now lastsecs))
3398 (message "Indenting region... (%d%% complete)"
3399 (/ (* 100 (- (point) start)) (- end start)))
3400 (aset c-progress-info 2 now)))
3403 (defun c-progress-fini (context)
3404 (if (not c-progress-interval)
3406 (if (or (eq context (aref c-progress-info 3))
3409 (set-marker (aref c-progress-info 1) nil)
3410 (setq c-progress-info nil)
3411 (message "Indenting region... done")))))
3415 ;;; This page handles insertion and removal of backslashes for C macros.
3417 (defun c-backslash-region (from to delete-flag &optional line-mode)
3418 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3419 With no argument, inserts backslashes and aligns existing backslashes.
3420 With an argument, deletes the backslashes. The backslash alignment is
3421 done according to the settings in `c-backslash-column',
3422 `c-backslash-max-column' and `c-auto-align-backslashes'.
3424 This function does not modify blank lines at the start of the region.
3425 If the region ends at the start of a line and the macro doesn't
3426 continue below it, the backslash (if any) at the end of the previous
3429 You can put the region around an entire macro definition and use this
3430 command to conveniently insert and align the necessary backslashes."
3431 (interactive "*r\nP")
3432 (let ((endmark (make-marker))
3433 ;; Keep the backslash trimming functions from changing the
3434 ;; whitespace around point, since in this case it's only the
3435 ;; position of point that tells the indentation of the line.
3436 (point-pos (if (save-excursion
3437 (skip-chars-backward " \t")
3438 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3441 column longest-line-col bs-col-after-end)
3444 (if (and (not line-mode) (bobp))
3445 ;; Nothing to do if to is at bob, since we should back up
3446 ;; and there's no line to back up to.
3448 (when (and (not line-mode) (bolp))
3449 ;; Do not back up the to line if line-mode is set, to make
3450 ;; e.g. c-newline-and-indent consistent regardless whether
3451 ;; the (newline) call leaves point at bol or not.
3456 (set-marker endmark (point))
3458 (c-delete-backslashes-forward endmark point-pos))
3459 ;; Set bs-col-after-end to the column of any backslash
3460 ;; following the region, or nil if there is none.
3461 (setq bs-col-after-end
3462 (and (progn (end-of-line)
3463 (eq (char-before) ?\\))
3464 (= (forward-line 1) 0)
3465 (progn (end-of-line)
3466 (eq (char-before) ?\\))
3467 (1- (current-column))))
3469 ;; Back up the to line if line-mode is set, since the line
3470 ;; after the newly inserted line break should not be
3471 ;; touched in c-newline-and-indent.
3472 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3473 (unless bs-col-after-end
3474 ;; Set bs-col-after-end to non-nil in any case, since we
3475 ;; do not want to delete the backslash at the last line.
3476 (setq bs-col-after-end t)))
3478 (not c-auto-align-backslashes))
3480 ;; Compute the smallest column number past the ends of all
3482 (setq longest-line-col 0)
3484 (if bs-col-after-end
3485 ;; Include one more line in the max column
3486 ;; calculation, since the to line will be backslashed
3490 (while (and (>= (point) from)
3492 (if (eq (char-before) ?\\)
3494 (skip-chars-backward " \t")
3495 (setq longest-line-col (max longest-line-col
3496 (1+ (current-column))))
3500 ;; Try to align with surrounding backslashes.
3503 (if (and (not (bobp))
3504 (progn (backward-char)
3505 (eq (char-before) ?\\)))
3507 (setq column (1- (current-column)))
3508 (if (numberp bs-col-after-end)
3509 ;; Both a preceding and a following backslash.
3510 ;; Choose the greatest of them.
3511 (setq column (max column bs-col-after-end)))
3513 ;; No preceding backslash. Try to align with one
3514 ;; following the region. Disregard the backslash at the
3515 ;; to line since it's likely to be bogus (e.g. when
3516 ;; called from c-newline-and-indent).
3517 (if (numberp bs-col-after-end)
3518 (setq column bs-col-after-end))
3519 ;; Don't modify blank lines at start of region.
3521 (while (and (< (point) to) (bolp) (eolp))
3523 (if (and column (< column longest-line-col))
3524 ;; Don't try to align with surrounding backslashes if
3525 ;; any line is too long.
3528 ;; Impose minimum limit and tab width alignment only if
3529 ;; we can't align with surrounding backslashes.
3530 (if (> (% longest-line-col tab-width) 0)
3531 (setq longest-line-col
3532 (* (/ (+ longest-line-col tab-width -1)
3535 (setq column (max c-backslash-column
3537 ;; Always impose maximum limit.
3538 (setq column (min column c-backslash-max-column)))
3539 (if bs-col-after-end
3540 ;; Add backslashes on all lines if the macro continues
3541 ;; after the to line.
3543 (set-marker endmark to)
3544 (c-append-backslashes-forward endmark column point-pos))
3545 ;; Add backslashes on all lines except the last, and
3546 ;; remove any on the last line.
3551 (set-marker endmark (1- (point)))))
3553 (c-append-backslashes-forward endmark column point-pos)
3554 ;; The function above leaves point on the line
3555 ;; following endmark.
3556 (set-marker endmark (point)))
3557 (set-marker endmark to))
3558 (c-delete-backslashes-forward endmark point-pos)))))
3559 (set-marker endmark nil)
3560 (if (markerp point-pos)
3561 (set-marker point-pos nil))))
3563 (defun c-append-backslashes-forward (to-mark column point-pos)
3564 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3568 (<= (point) to-mark)
3570 (let ((start (point)) (inserted nil) end col)
3572 (unless (eq (char-before) ?\\)
3575 (setq state (parse-partial-sexp
3576 start (point) nil nil state))
3578 (setq col (current-column))
3580 ;; Avoid unnecessary changes of the buffer.
3581 (cond ((and (not inserted) (nth 3 state))
3582 ;; Don't realign backslashes in string literals
3583 ;; since that would change them.
3590 (skip-chars-backward
3591 " \t" (if (>= (point) point-pos) point-pos))
3595 ((and (= col column)
3596 (memq (char-before) '(?\ ?\t))))
3600 (or (/= (skip-chars-backward
3601 " \t" (if (>= (point) point-pos) point-pos))
3603 (/= (char-after) ?\ )))
3604 (delete-region (point) end)
3605 (indent-to column 1)))
3607 (zerop (forward-line 1)))
3608 (bolp))) ; forward-line has funny behavior at eob.
3610 ;; Make sure there are backslashes with at least one space in
3614 (<= (point) to-mark)
3616 (let ((start (point)))
3618 (setq state (parse-partial-sexp
3619 start (point) nil nil state))
3621 (if (eq (char-before) ?\\)
3622 (unless (nth 3 state)
3624 (unless (and (memq (char-before) '(?\ ?\t))
3625 (/= (point) point-pos))
3628 (if (and (memq (char-before) '(?\ ?\t))
3629 (/= (point) point-pos))
3633 (zerop (forward-line 1)))
3634 (bolp)))))) ; forward-line has funny behavior at eob.
3636 (defun c-delete-backslashes-forward (to-mark point-pos)
3638 (and (<= (point) to-mark)
3641 (if (eq (char-before) ?\\)
3644 (progn (backward-char)
3645 (skip-chars-backward " \t" (if (>= (point) point-pos)
3648 (zerop (forward-line 1)))
3649 (bolp)))) ; forward-line has funny behavior at eob.
3653 ;;; Line breaking and paragraph filling.
3655 (defvar c-auto-fill-prefix t)
3656 (defvar c-lit-limits nil)
3657 (defvar c-lit-type nil)
3659 ;; The filling code is based on a simple theory; leave the intricacies
3660 ;; of the text handling to the currently active mode for that
3661 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3662 ;; possible to make them work correctly wrt the comment and string
3663 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3664 ;; to it, there's quite a lot of special cases to handle which makes
3665 ;; the code anything but simple. The intention is that it will work
3666 ;; with any well-written text filling package that preserves a fill
3669 ;; We temporarily mask comment starters and enders as necessary for
3670 ;; the filling code to do its job on a seemingly normal text block.
3671 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3672 ;; preserve it correctly (especially important when filling C++ style
3673 ;; line comments). By default, we set up and use adaptive-fill-mode,
3674 ;; which is standard in all supported Emacs flavors.
3676 (defun c-guess-fill-prefix (lit-limits lit-type)
3677 ;; Determine the appropriate comment fill prefix for a block or line
3678 ;; comment. Return a cons of the prefix string and the column where
3679 ;; it ends. If fill-prefix is set, it'll override. Note that this
3680 ;; function also uses the value of point in some heuristics.
3682 ;; This function might do hidden buffer changes.
3684 (let* ((here (point))
3685 (prefix-regexp (concat "[ \t]*\\("
3686 c-current-comment-prefix
3688 (comment-start-regexp (if (eq lit-type 'c++)
3690 comment-start-skip))
3691 prefix-line comment-prefix res comment-text-end)
3695 (setq res (cons fill-prefix
3696 ;; Ugly way of getting the column after the fill
3697 ;; prefix; it'd be nice with a current-column
3698 ;; that works on strings..
3699 (let ((start (point)))
3702 (insert-and-inherit "\n" fill-prefix)
3704 (delete-region start (point)))))))
3708 ;; Set fallback for comment-prefix if none is found.
3709 (setq comment-prefix "// "
3710 comment-text-end (cdr lit-limits))
3713 (if (> (point) (car lit-limits))
3714 ;; The current line is not the comment starter, so the
3715 ;; comment has more than one line, and it can therefore be
3716 ;; used to find the comment fill prefix.
3717 (setq prefix-line (point))
3719 (goto-char (car lit-limits))
3720 (if (and (= (forward-line 1) 0)
3721 (< (point) (cdr lit-limits)))
3722 ;; The line after the comment starter is inside the
3723 ;; comment, so we can use it.
3724 (setq prefix-line (point))
3726 ;; The comment is only one line. Take the comment prefix
3727 ;; from it and keep the indentation.
3728 (goto-char (car lit-limits))
3729 (if (looking-at prefix-regexp)
3730 (goto-char (match-end 0))
3732 (skip-chars-forward " \t"))
3735 (if (eq (c-point 'boi) (car lit-limits))
3736 ;; There is only whitespace before the comment
3737 ;; starter; take the prefix straight from this line.
3738 (setq str (buffer-substring-no-properties
3739 (c-point 'bol) (point))
3740 col (current-column))
3742 ;; There is code before the comment starter, so we
3743 ;; have to temporarily insert and indent a new line to
3744 ;; get the right space/tab mix in the indentation.
3745 (let ((prefix-len (- (point) (car lit-limits)))
3749 (goto-char (car lit-limits))
3750 (indent-to (prog1 (current-column)
3753 (forward-char prefix-len)
3754 (setq str (buffer-substring-no-properties
3755 (c-point 'bol) (point))
3756 col (current-column)))
3757 (delete-region (car lit-limits) tmp))))
3760 (if (or (string-match "\\s \\'" str) (not (eolp)))
3762 ;; The prefix ends the line with no whitespace
3763 ;; after it. Default to a single space.
3764 (cons (concat str " ") (1+ col))))
3768 (setq comment-text-end
3770 (goto-char (- (cdr lit-limits) 2))
3771 (if (looking-at "\\*/") (point) (cdr lit-limits))))
3775 (if (and (> (point) (car lit-limits))
3776 (not (and (looking-at "[ \t]*\\*/")
3777 (eq (cdr lit-limits) (match-end 0)))))
3778 ;; The current line is not the comment starter and
3779 ;; contains more than just the ender, so it's good enough
3780 ;; to be used for the comment fill prefix.
3781 (setq prefix-line (point))
3782 (goto-char (car lit-limits))
3784 (cond ((or (/= (forward-line 1) 0)
3785 (>= (point) (cdr lit-limits))
3786 (and (looking-at "[ \t]*\\*/")
3787 (eq (cdr lit-limits) (match-end 0)))
3788 (and (looking-at prefix-regexp)
3789 (<= (1- (cdr lit-limits)) (match-end 0))))
3790 ;; The comment is either one line or the next line contains
3791 ;; just the comment ender. In this case we have no
3792 ;; information about a suitable comment prefix, so we resort
3793 ;; to c-block-comment-prefix.
3794 (setq comment-prefix (or c-block-comment-prefix "")))
3797 ;; The point was on the comment opener line, so we might want
3798 ;; to treat this as a not yet closed comment.
3800 (if (and (match-beginning 1)
3801 (/= (match-beginning 1) (match-end 1)))
3802 ;; Above `prefix-regexp' matched a nonempty prefix on the
3803 ;; second line, so let's use it. Normally it should do
3804 ;; to set `prefix-line' and let the code below pick up
3805 ;; the whole prefix, but if there's no text after the
3806 ;; match then it will probably fall back to no prefix at
3807 ;; all if the comment isn't closed yet, so in that case
3808 ;; it's better to force use of the prefix matched now.
3809 (if (= (match-end 0) (c-point 'eol))
3810 (setq comment-prefix (match-string 1))
3811 (setq prefix-line (point)))
3813 ;; There's no nonempty prefix on the line after the
3814 ;; comment opener. If the line is empty, or if the
3815 ;; text on it has less or equal indentation than the
3816 ;; comment starter we assume it's an unclosed
3817 ;; comment starter, i.e. that
3818 ;; `c-block-comment-prefix' should be used.
3819 ;; Otherwise we assume it's a closed comment where
3820 ;; the prefix really is the empty string.
3821 ;; E.g. this is an unclosed comment:
3832 ;; (Looking for the presence of the comment closer
3833 ;; rarely works since it's probably the closer of
3834 ;; some comment further down when the comment
3835 ;; really is unclosed.)
3836 (if (<= (save-excursion (back-to-indentation)
3838 (save-excursion (goto-char (car lit-limits))
3840 (setq comment-prefix (or c-block-comment-prefix ""))
3841 (setq prefix-line (point)))))
3844 ;; Otherwise the line after the comment starter is good
3845 ;; enough to find the prefix in.
3846 (setq prefix-line (point))))
3848 (when comment-prefix
3849 ;; Haven't got the comment prefix on any real line that we
3850 ;; can take it from, so we have to temporarily insert
3851 ;; `comment-prefix' on a line and indent it to find the
3852 ;; correct column and the correct mix of tabs and spaces.
3854 (let (tmp-pre tmp-post)
3858 (goto-char (car lit-limits))
3859 (if (looking-at comment-start-regexp)
3860 (goto-char (min (match-end 0)
3863 (skip-chars-forward " \t"))
3865 (when (eq (char-syntax (char-before)) ?\ )
3866 ;; If there's ws on the current line, we'll use it
3867 ;; instead of what's ending comment-prefix.
3868 (setq comment-prefix
3869 (concat (substring comment-prefix
3873 (buffer-substring-no-properties
3875 (skip-chars-backward " \t")
3879 (setq tmp-pre (point-marker))
3881 ;; We insert an extra non-whitespace character
3882 ;; before the line break and after comment-prefix in
3883 ;; case it's "" or ends with whitespace.
3884 (insert-and-inherit "x\n" comment-prefix "x")
3885 (setq tmp-post (point-marker))
3887 (indent-according-to-mode)
3889 (goto-char (1- tmp-post))
3890 (cons (buffer-substring-no-properties
3891 (c-point 'bol) (point))
3895 (delete-region tmp-pre tmp-post)
3896 (set-marker tmp-pre nil)
3897 (set-marker tmp-post nil))))))))))
3899 (or res ; Found a good prefix above.
3902 ;; prefix-line is the bol of a line on which we should try
3903 ;; to find the prefix.
3904 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3907 (when (and (looking-at prefix-regexp)
3908 (<= (match-end 0) comment-text-end))
3909 (unless (eq (match-end 0) (c-point 'eol))
3910 ;; The match is fine if there's text after it.
3911 (throw 'found (cons (buffer-substring-no-properties
3912 (match-beginning 0) (match-end 0))
3913 (progn (goto-char (match-end 0))
3914 (current-column)))))
3916 ;; This match is better than nothing, so let's
3917 ;; remember it in case nothing better is found
3919 (setq fb-string (buffer-substring-no-properties
3920 (match-beginning 0) (match-end 0))
3921 fb-endpos (match-end 0)))
3925 ;; Search for a line which has text after the prefix
3926 ;; so that we get the proper amount of whitespace
3927 ;; after it. We start with the current line, then
3928 ;; search backwards, then forwards.
3930 (goto-char prefix-line)
3931 (when (and (funcall test-line)
3932 (or (/= (match-end 1) (match-end 0))
3933 ;; The whitespace is sucked up by the
3934 ;; first [ \t]* glob if the prefix is empty.
3935 (and (= (match-beginning 1) (match-end 1))
3936 (/= (match-beginning 0) (match-end 0)))))
3937 ;; If the current line doesn't have text but do
3938 ;; have whitespace after the prefix, we'll use it.
3939 (throw 'found (cons fb-string
3940 (progn (goto-char fb-endpos)
3941 (current-column)))))
3943 (if (eq lit-type 'c++)
3944 ;; For line comments we can search up to and
3945 ;; including the first line.
3946 (while (and (zerop (forward-line -1))
3947 (>= (point) (car lit-limits)))
3948 (funcall test-line))
3949 ;; For block comments we must stop before the
3951 (while (and (zerop (forward-line -1))
3952 (> (point) (car lit-limits)))
3953 (funcall test-line)))
3955 (goto-char prefix-line)
3956 (while (and (zerop (forward-line 1))
3957 (< (point) (cdr lit-limits)))
3958 (funcall test-line))
3960 (goto-char prefix-line)
3964 ;; A good line wasn't found, but at least we have a
3965 ;; fallback that matches the comment prefix regexp.
3966 (cond ((or (string-match "\\s \\'" fb-string)
3968 (goto-char fb-endpos)
3970 ;; There are ws or text after the prefix, so
3972 (cons fb-string (current-column)))
3975 ;; Check if there's any whitespace padding
3976 ;; on the comment start line that we can
3977 ;; use after the prefix.
3978 (goto-char (car lit-limits))
3979 (if (looking-at comment-start-regexp)
3980 (goto-char (match-end 0))
3982 (skip-chars-forward " \t"))
3984 (eq (char-syntax (char-before)) ?\ )))
3986 (setq fb-string (buffer-substring-no-properties
3988 (skip-chars-backward " \t")
3991 (goto-char fb-endpos)
3992 (skip-chars-backward " \t")
3994 (let ((tmp (point)))
3995 ;; Got to mess in the buffer once again to
3996 ;; ensure the column gets correct. :P
3999 (insert-and-inherit fb-string)
4000 (cons (buffer-substring-no-properties
4004 (delete-region tmp (point)))))
4007 ;; Last resort: Just add a single space after
4009 (cons (concat fb-string " ")
4010 (progn (goto-char fb-endpos)
4011 (1+ (current-column)))))))
4013 ;; The line doesn't match the comment prefix regexp.
4015 ;; We have a fallback for line comments that we must use.
4016 (cons (concat (buffer-substring-no-properties
4017 prefix-line (c-point 'boi))
4019 (progn (back-to-indentation)
4020 (+ (current-column) (length comment-prefix))))
4022 ;; Assume we are dealing with a "free text" block
4023 ;; comment where the lines doesn't have any comment
4024 ;; prefix at all and we should just fill it as
4029 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
4030 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4031 ;; masked to allow adaptive filling to work correctly. That
4032 ;; includes narrowing the buffer and, if point is inside a comment,
4033 ;; masking the comment starter and ender appropriately.
4035 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4036 ;; The position of point is then less significant when doing masking
4039 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4040 ;; only if the point turns out to be inside a comment or a string.
4042 ;; Note that this function does not do any hidden buffer changes.
4045 ;; beg and end limit the region to narrow. end is a marker.
4047 ;; tmp-pre and tmp-post mark strings that are temporarily
4048 ;; inserted at the start and end of the region. tmp-pre is a
4049 ;; cons of the positions of the prepended string. tmp-post is
4050 ;; a marker pointing to the single character of the appended
4053 ;; If hang-ender-stuck isn't nil, the comment ender is
4054 ;; hanging. In that case it's set to the number of spaces
4055 ;; that should be between the text and the ender.
4057 ;; auto-fill-spaces is the exact sequence of whitespace between a
4058 ;; comment's last word and the comment ender, temporarily replaced
4059 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4062 (c-lit-limits c-lit-limits)
4063 (c-lit-type c-lit-type))
4065 ;; Restore point on undo. It's necessary since we do a lot of
4066 ;; hidden inserts and deletes below that should be as transparent
4068 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
4069 (setq buffer-undo-list (cons (point) buffer-undo-list)))
4071 ;; Determine the limits and type of the containing literal (if any):
4072 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4074 (c-save-buffer-state ()
4076 ;; Widen to catch comment limits correctly.
4078 (unless c-lit-limits
4079 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
4080 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
4082 (setq c-lit-type (c-literal-type c-lit-limits))))
4085 (unless (c-safe (backward-char)
4089 (forward-paragraph))
4090 (setq end (point-marker)))
4092 (unless (c-safe (forward-char)
4093 (backward-paragraph)
4096 (backward-paragraph))
4097 (setq beg (point))))
4101 ;; For each of the possible types of text (string, C comment ...)
4102 ;; determine BEG and END, the region we will narrow to. If we're in
4103 ;; a literal, constrain BEG and END to the limits of this literal.
4105 ;; For some of these text types, particularly a block comment, we
4106 ;; may need to massage whitespace near literal delimiters, so that
4107 ;; these don't get filled inappropriately.
4110 ((eq c-lit-type 'c++) ; Line comment.
4112 ;; Limit to the comment or paragraph end, whichever
4114 (set-marker end (min end (cdr c-lit-limits)))
4116 (when (<= beg (car c-lit-limits))
4117 ;; The region includes the comment starter, so we must
4119 (goto-char (car c-lit-limits))
4120 (back-to-indentation)
4121 (if (eq (point) (car c-lit-limits))
4122 ;; Include the first line in the region.
4123 (setq beg (c-point 'bol))
4124 ;; The first line contains code before the
4125 ;; comment. We must fake a line that doesn't.
4128 (setq apply-outside-literal t))
4130 ((eq c-lit-type 'c) ; Block comment.
4132 (or (> end (cdr c-lit-limits))
4133 (and (= end (cdr c-lit-limits))
4134 (eq (char-before end) ?/)
4135 (eq (char-before (1- end)) ?*)
4137 (> (- (cdr c-lit-limits) (car c-lit-limits)) 3)))
4138 ;; There is a comment ender, and the region includes it. If
4139 ;; it's on its own line, it stays on its own line. If it's got
4140 ;; company on the line, it keeps (at least one word of) it.
4141 ;; "=====*/" counts as a comment ender here, but "===== */"
4142 ;; doesn't and "foo*/" doesn't.
4145 (goto-char (cdr c-lit-limits))
4147 ;; The following conjunct was added to avoid an
4148 ;; "Invalid search bound (wrong side of point)"
4149 ;; error in the subsequent re-search. Maybe
4150 ;; another fix would be needed (2007-12-08).
4151 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4152 ; 2010-10-17 Construct removed.
4153 ; (or (< (- (cdr c-lit-limits) 2) (point))
4155 (search-forward-regexp
4156 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
4157 (- (cdr c-lit-limits) 2) t)
4158 (not (search-forward-regexp
4160 (- (cdr c-lit-limits) 2) 'limit))
4161 ;; The comment ender IS on its own line. Exclude this
4162 ;; line from the filling.
4163 (set-marker end (c-point 'bol))));)
4165 ;; The comment ender is hanging. Replace all space between it
4166 ;; and the last word either by one or two 'x's (when
4167 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4168 ;; as the whitespace (when auto filling), and include it in
4169 ;; the region. We'll change them back to whitespace
4170 ;; afterwards. The effect of this is to glue the comment
4171 ;; ender to the last word in the comment during filling.
4172 (let* ((ender-start (save-excursion
4173 (goto-char (cdr c-lit-limits))
4174 (skip-syntax-backward "^w ")
4176 (ender-column (save-excursion
4177 (goto-char ender-start)
4179 (point-rel (- ender-start here))
4180 (sentence-ends-comment
4182 (goto-char ender-start)
4183 (and (search-backward-regexp
4184 (c-sentence-end) (c-point 'bol) t)
4185 (goto-char (match-end 0))
4186 (looking-at "[ \t]*")
4187 (= (match-end 0) ender-start))))
4191 ;; Insert a CR after the "*/", adjust END
4192 (goto-char (cdr c-lit-limits))
4193 (setq tmp-post (point-marker))
4195 (set-marker end (point))
4197 (forward-line -1) ; last line of the comment
4198 (if (and (looking-at (concat "[ \t]*\\(\\("
4199 c-current-comment-prefix
4201 (eq ender-start (match-end 0)))
4202 ;; The comment ender is prefixed by nothing but a
4203 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4204 ;; 2006/4/28). Remove it along with surrounding ws.
4205 (setq spaces (- (match-end 1) (match-end 2)))
4206 (goto-char ender-start))
4207 (skip-chars-backward " \t\r\n") ; Surely this can be
4208 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4210 ;; What's being tested here? 2006/4/20. FIXME!!!
4211 (if (/= (point) ender-start)
4213 (if (<= here (point))
4214 ;; Don't adjust point below if it's
4215 ;; before the string we replace.
4216 (setq point-rel -1))
4217 ;; Keep one or two spaces between the
4218 ;; text and the ender, depending on how
4219 ;; many there are now.
4221 (setq spaces (- ender-column (current-column))))
4222 (setq auto-fill-spaces (c-delete-and-extract-region
4223 (point) ender-start))
4224 ;; paragraph filling condenses multiple spaces to
4225 ;; single or double spaces. auto-fill doesn't.
4230 (if (and sentence-ends-comment
4231 sentence-end-double-space)
4234 ;; Insert the filler first to keep marks right.
4235 (insert-char ?x spaces t)
4236 (setq hang-ender-stuck spaces)
4238 (and (>= point-rel 0)
4239 (- (point) (min point-rel spaces)))))
4240 (setq point-rel nil)))
4243 ;; Point was in the middle of the string we
4244 ;; replaced above, so put it back in the same
4245 ;; relative position, counting from the end.
4246 (goto-char point-rel)))
4249 (when (<= beg (car c-lit-limits))
4250 ;; The region includes the comment starter.
4252 (goto-char (car c-lit-limits))
4253 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
4254 ;; Begin with the next line.
4255 (setq beg (c-point 'bonl))
4256 ;; Fake the fill prefix in the first line.
4259 (setq apply-outside-literal t))
4261 ((eq c-lit-type 'string) ; String.
4263 (when (>= end (cdr c-lit-limits))
4264 (goto-char (1- (cdr c-lit-limits)))
4265 (setq tmp-post (point-marker))
4267 (set-marker end (point)))
4268 (when (<= beg (car c-lit-limits))
4269 (goto-char (1+ (car c-lit-limits)))
4270 (setq beg (if (looking-at "\\\\$")
4271 ;; Leave the start line if it's
4272 ;; nothing but an escaped newline.
4275 (setq apply-outside-literal t))
4277 ((eq c-lit-type 'pound) ; Macro
4278 ;; Narrow to the macro limits if they are nearer than the
4279 ;; paragraph limits. Don't know if this is necessary but
4280 ;; do it for completeness sake (doing auto filling at all
4281 ;; inside macros is bogus to begin with since the line
4282 ;; continuation backslashes aren't handled).
4284 (c-save-buffer-state ()
4285 (c-beginning-of-macro)
4292 (set-marker end (point))))))
4295 ;; Try to avoid comments and macros in the paragraph to
4296 ;; avoid that the adaptive fill mode gets the prefix from
4298 (c-save-buffer-state nil
4301 (c-forward-syntactic-ws end)
4305 (c-backward-syntactic-ws beg)
4307 (set-marker end (point))))))
4310 ;; Temporarily insert the fill prefix after the comment
4311 ;; starter so that the first line looks like any other
4312 ;; comment line in the narrowed region.
4313 (setq fill (c-save-buffer-state nil
4314 (c-guess-fill-prefix c-lit-limits c-lit-type)))
4315 (unless (string-match (concat "\\`[ \t]*\\("
4316 c-current-comment-prefix
4319 ;; Oops, the prefix doesn't match the comment prefix
4320 ;; regexp. This could produce very confusing
4321 ;; results with adaptive fill packages together with
4322 ;; the insert prefix magic below, since the prefix
4323 ;; often doesn't appear at all. So let's warn about
4326 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4328 ;; Find the right spot on the line, break it, insert
4329 ;; the fill prefix and make sure we're back in the
4330 ;; same column by temporarily prefixing the first word
4331 ;; with a number of 'x'.
4333 (goto-char (car c-lit-limits))
4334 (if (looking-at (if (eq c-lit-type 'c++)
4335 c-current-comment-prefix
4336 comment-start-skip))
4337 (goto-char (match-end 0))
4339 (skip-chars-forward " \t"))
4340 (while (and (< (current-column) (cdr fill))
4343 (let ((col (current-column)))
4344 (setq beg (1+ (point))
4345 tmp-pre (list (point)))
4348 (insert-and-inherit "\n" (car fill))
4349 (insert-char ?x (- col (current-column)) t))
4350 (setcdr tmp-pre (point))))))
4352 (when apply-outside-literal
4353 ;; `apply-outside-literal' is always set to t here if
4354 ;; we're inside a literal.
4358 ;; Kludge: If the function that adapts the fill prefix
4359 ;; doesn't produce the required comment starter for
4360 ;; line comments, then force it by setting fill-prefix.
4361 (when (and (eq c-lit-type 'c++)
4362 ;; Kludge the kludge: filladapt-mode doesn't
4363 ;; have this problem, but it currently
4364 ;; doesn't override fill-context-prefix
4366 (not (and (boundp 'filladapt-mode)
4370 (or (fill-context-prefix beg end)
4372 (c-save-buffer-state nil
4373 (car (or fill (c-guess-fill-prefix
4374 c-lit-limits c-lit-type)))))))
4376 ;; Save the relative position of point if it's outside the
4377 ;; region we're going to narrow. Want to restore it in that
4378 ;; case, but otherwise it should be moved according to the
4380 (point-rel (cond ((< (point) beg) (- (point) beg))
4381 ((> (point) end) (- (point) end)))))
4383 ;; Preparations finally done! Now we can call the
4387 (narrow-to-region beg end)
4390 ;; Restore point if it was outside the region.
4392 (goto-char (+ beg point-rel))
4393 (goto-char (+ end point-rel))))))))
4395 (when (consp tmp-pre)
4396 (delete-region (car tmp-pre) (cdr tmp-pre)))
4400 (goto-char tmp-post)
4402 (when hang-ender-stuck
4403 ;; Preserve point even if it's in the middle of the string
4404 ;; we replace; save-excursion doesn't work in that case.
4406 (goto-char tmp-post)
4407 (skip-syntax-backward "^w ")
4408 (forward-char (- hang-ender-stuck))
4409 (if (or fill-paragraph (not auto-fill-spaces))
4410 (insert-char ?\ hang-ender-stuck t)
4411 (insert auto-fill-spaces))
4412 (delete-char hang-ender-stuck)
4414 (set-marker tmp-post nil))
4416 (set-marker end nil))))
4418 (defun c-fill-paragraph (&optional arg)
4419 "Like \\[fill-paragraph] but handles C and C++ style comments.
4420 If any of the current line is a comment or within a comment, fill the
4421 comment or the paragraph of it that point is in, preserving the
4422 comment indentation or line-starting decorations (see the
4423 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4426 If point is inside multiline string literal, fill it. This currently
4427 does not respect escaped newlines, except for the special case when it
4428 is the very first thing in the string. The intended use for this rule
4429 is in situations like the following:
4431 char description[] = \"\\
4432 A very long description of something that you want to fill to make
4433 nicely formatted output.\"\;
4435 If point is in any other situation, i.e. in normal code, do nothing.
4437 Optional prefix ARG means justify paragraph as well."
4439 (let ((fill-paragraph-function
4440 ;; Avoid infinite recursion.
4441 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4442 fill-paragraph-function)))
4443 (c-mask-paragraph t nil 'fill-paragraph arg))
4444 ;; Always return t. This has the effect that if filling isn't done
4445 ;; above, it isn't done at all, and it's therefore effectively
4446 ;; disabled in normal code.
4449 (defun c-do-auto-fill ()
4450 ;; Do automatic filling if not inside a context where it should be
4452 (let ((c-auto-fill-prefix
4453 ;; The decision whether the line should be broken is actually
4454 ;; done in c-indent-new-comment-line, which do-auto-fill
4455 ;; calls to break lines. We just set this special variable
4456 ;; so that we'll know when we're called from there. It's
4457 ;; also used to detect whether fill-prefix is user set or
4458 ;; generated automatically by do-auto-fill.
4460 (c-mask-paragraph nil t 'do-auto-fill)))
4462 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4463 "Break line at point and indent, continuing comment or macro if within one.
4464 If inside a comment and `comment-multi-line' is non-nil, the
4465 indentation and line prefix are preserved (see the
4466 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4467 details). If inside a single line comment and `comment-multi-line' is
4468 nil, a new comment of the same type is started on the next line and
4469 indented as appropriate for comments. If inside a macro, a line
4470 continuation backslash is inserted and aligned as appropriate, and the
4471 new line is indented according to `c-syntactic-indentation'.
4473 If a fill prefix is specified, it overrides all the above."
4474 ;; allow-auto-fill is used from c-context-line-break to allow auto
4475 ;; filling to break the line more than once. Since this function is
4476 ;; used from auto-fill itself, that's normally disabled to avoid
4477 ;; unnecessary recursion.
4479 (let ((fill-prefix fill-prefix)
4482 (delete-horizontal-space)
4484 (insert-and-inherit ?\n)
4485 (newline (if allow-auto-fill nil 1)))))
4486 ;; Already know the literal type and limits when called from
4487 ;; c-context-line-break.
4488 (c-lit-limits c-lit-limits)
4489 (c-lit-type c-lit-type)
4490 (c-macro-start c-macro-start))
4492 (c-save-buffer-state ()
4493 (when (not (eq c-auto-fill-prefix t))
4494 ;; Called from do-auto-fill.
4495 (unless c-lit-limits
4496 (setq c-lit-limits (c-literal-limits nil nil t)))
4498 (setq c-lit-type (c-literal-type c-lit-limits)))
4499 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4500 ((null c-lit-type) 'code)
4503 (setq fill-prefix t) ; Used as flag in the cond.
4504 (if (and (null c-auto-fill-prefix)
4506 (<= (c-point 'bol) (car c-lit-limits)))
4507 ;; The adaptive fill function has generated a prefix, but
4508 ;; we're on the first line in a block comment so it'll be
4509 ;; wrong. Ignore it to guess a better one below.
4510 (setq fill-prefix nil)
4511 (when (and (eq c-lit-type 'c++)
4512 (not (string-match (concat "\\`[ \t]*"
4513 c-line-comment-starter)
4514 (or fill-prefix ""))))
4515 ;; Kludge: If the function that adapted the fill prefix
4516 ;; doesn't produce the required comment starter for line
4517 ;; comments, then we ignore it.
4518 (setq fill-prefix nil)))
4521 (cond ((eq fill-prefix t)
4522 ;; A call from do-auto-fill which should be ignored.
4525 ;; A fill-prefix overrides anything.
4526 (funcall do-line-break)
4527 (insert-and-inherit fill-prefix))
4528 ((c-save-buffer-state ()
4529 (unless c-lit-limits
4530 (setq c-lit-limits (c-literal-limits)))
4532 (setq c-lit-type (c-literal-type c-lit-limits)))
4533 (memq c-lit-type '(c c++)))
4534 ;; Some sort of comment.
4535 (if (or comment-multi-line
4537 (goto-char (car c-lit-limits))
4539 (< (point) (cdr c-lit-limits))))
4540 ;; Inside a comment that should be continued.
4541 (let ((fill (c-save-buffer-state nil
4542 (c-guess-fill-prefix
4544 (c-collect-line-comments c-lit-limits))
4547 (start-col (current-column))
4549 (or (and (eq c-lit-type 'c)
4551 (goto-char (- (cdr c-lit-limits) 2))
4552 (if (looking-at "\\*/") (point))))
4553 (cdr c-lit-limits))))
4554 ;; Skip forward past the fill prefix in case
4555 ;; we're standing in it.
4557 ;; FIXME: This doesn't work well in cases like
4559 ;; /* Bla bla bla bla bla
4562 ;; If point is on the 'B' then the line will be
4563 ;; broken after "Bla b".
4565 ;; If we have an empty comment, /* */, the next
4566 ;; lot of code pushes point to the */. We fix
4567 ;; this by never allowing point to end up to the
4568 ;; right of where it started.
4569 (while (and (< (current-column) (cdr fill))
4572 (if (and (> (point) comment-text-end)
4573 (> (c-point 'bol) (car c-lit-limits)))
4575 ;; The skip takes us out of the (block)
4576 ;; comment; insert the fill prefix at bol
4577 ;; instead and keep the position.
4578 (setq pos (copy-marker pos t))
4580 (insert-and-inherit (car fill))
4581 (if soft (insert-and-inherit ?\n) (newline 1))
4583 (set-marker pos nil))
4584 ;; Don't break in the middle of a comment starter
4586 (cond ((> (point) comment-text-end)
4587 (goto-char comment-text-end))
4588 ((< (point) (+ (car c-lit-limits) 2))
4589 (goto-char (+ (car c-lit-limits) 2))))
4590 (funcall do-line-break)
4591 (insert-and-inherit (car fill))
4592 (if (> (current-column) start-col)
4593 (move-to-column start-col)))) ; can this hit the
4595 ;; Inside a comment that should be broken.
4596 (let ((comment-start comment-start)
4597 (comment-end comment-end)
4599 (if (eq c-lit-type 'c)
4600 (unless (string-match "[ \t]*/\\*" comment-start)
4601 (setq comment-start "/* " comment-end " */"))
4602 (unless (string-match "[ \t]*//" comment-start)
4603 (setq comment-start "// " comment-end "")))
4604 (setq col (save-excursion
4605 (back-to-indentation)
4607 (funcall do-line-break)
4608 (when (and comment-end (not (equal comment-end "")))
4610 (insert-and-inherit comment-end)
4612 ;; c-comment-indent may look at the current
4613 ;; indentation, so let's start out with the same
4614 ;; indentation as the previous one.
4616 (insert-and-inherit comment-start)
4617 (indent-for-comment))))
4618 ((c-query-and-set-macro-start)
4620 (unless (looking-at "[ \t]*\\\\$")
4621 ;; Do not clobber the alignment of the line continuation
4622 ;; slash; c-backslash-region might look at it.
4623 (delete-horizontal-space))
4624 ;; Got an asymmetry here: In normal code this command
4625 ;; doesn't indent the next line syntactically, and otoh a
4626 ;; normal syntactically indenting newline doesn't continue
4628 (c-newline-and-indent (if allow-auto-fill nil 1)))
4630 ;; Somewhere else in the code.
4631 (let ((col (save-excursion
4633 (while (and (looking-at "[ \t]*\\\\?$")
4634 (= (forward-line -1) 0)))
4635 (current-indentation))))
4636 (funcall do-line-break)
4637 (indent-to col))))))
4639 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
4640 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line "21.1")
4642 ;; advice for indent-new-comment-line for older Emacsen
4643 (unless (boundp 'comment-line-break-function)
4644 (defvar c-inside-line-break-advice nil)
4645 (defadvice indent-new-comment-line (around c-line-break-advice
4646 activate preactivate)
4647 "Call `c-indent-new-comment-line' if in CC Mode."
4648 (if (or c-inside-line-break-advice
4649 (not c-buffer-is-cc-mode))
4651 (let ((c-inside-line-break-advice t))
4652 (c-indent-new-comment-line (ad-get-arg 0))))))
4654 (defun c-context-line-break ()
4655 "Do a line break suitable to the context.
4657 When point is outside a comment or macro, insert a newline and indent
4658 according to the syntactic context, unless `c-syntactic-indentation'
4659 is nil, in which case the new line is indented as the previous
4660 non-empty line instead.
4662 When point is inside the content of a preprocessor directive, a line
4663 continuation backslash is inserted before the line break and aligned
4664 appropriately. The end of the cpp directive doesn't count as inside
4667 When point is inside a comment, continue it with the appropriate
4668 comment prefix (see the `c-comment-prefix-regexp' and
4669 `c-block-comment-prefix' variables for details). The end of a
4670 C++-style line comment doesn't count as inside it.
4672 When point is inside a string, only insert a backslash when it is also
4673 inside a preprocessor directive."
4676 (let* (c-lit-limits c-lit-type
4677 (c-macro-start c-macro-start)
4680 (c-save-buffer-state ()
4681 (setq c-lit-limits (c-literal-limits nil nil t)
4682 c-lit-type (c-literal-type c-lit-limits))
4683 (when (eq c-lit-type 'c++)
4684 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4685 (c-query-and-set-macro-start))
4688 ((or (eq c-lit-type 'c)
4689 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4691 (skip-chars-forward " \t")
4693 (1- (cdr c-lit-limits))))
4694 (and (numberp c-macro-start) ; Macro, but not at the very end of
4695 ; it, not in a string, and not in the
4697 (not (eq c-lit-type 'string))
4698 (or (not (looking-at "\\s *$"))
4699 (eq (char-before) ?\\))
4701 (goto-char c-macro-start)
4702 (if (looking-at c-opt-cpp-start)
4703 (goto-char (match-end 0)))
4706 (let ((comment-multi-line t)
4708 (c-indent-new-comment-line nil t)))
4710 ((eq c-lit-type 'string)
4711 (if (and (numberp c-macro-start)
4712 (not (eq (char-before) ?\\)))
4716 (t (delete-horizontal-space)
4718 ;; c-indent-line may look at the current indentation, so let's
4719 ;; start out with the same indentation as the previous line.
4720 (let ((col (save-excursion
4723 (while (and (looking-at "[ \t]*\\\\?$")
4724 (= (forward-line -1) 0)))
4725 (current-indentation))))
4727 (indent-according-to-mode)))))
4729 (defun c-context-open-line ()
4730 "Insert a line break suitable to the context and leave point before it.
4731 This is the `c-context-line-break' equivalent to `open-line', which is
4732 normally bound to C-o. See `c-context-line-break' for the details."
4734 (let ((here (point)))
4737 ;; Temporarily insert a non-whitespace char to keep any
4738 ;; preceding whitespace intact.
4740 (c-context-line-break))
4745 (cc-provide 'cc-cmds)
4747 ;;; Local Variables:
4748 ;;; indent-tabs-mode: t
4751 ;;; cc-cmds.el ends here