1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2016 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 ;; (cc-)subword might not be loaded.
262 (boundp 'c-subword-mode)
263 (symbol-value 'c-subword-mode))
264 ;; FIXME: subword-mode already comes with its
268 ;; FIXME: Derived modes might want to use something else
269 ;; than a string for `mode-name'.
270 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name)
271 (match-string 1 mode-name)
273 ;; (setq c-submode-indicators
274 ;; (if (> (length fmt) 1)
277 (if (> (length fmt) 1)
278 (concat bare-mode-name fmt)
280 (force-mode-line-update)))
282 (defun c-toggle-syntactic-indentation (&optional arg)
283 "Toggle syntactic indentation.
284 Optional numeric ARG, if supplied, turns on syntactic indentation when
285 positive, turns it off when negative, and just toggles it when zero or
288 When syntactic indentation is turned on (the default), the indentation
289 functions and the electric keys indent according to the syntactic
290 context keys, when applicable.
292 When it's turned off, the electric keys don't reindent, the indentation
293 functions indents every new line to the same level as the previous
294 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
295 specified by `c-basic-offset'. The indentation style has no effect in
296 this mode, nor any of the indentation associated variables,
297 e.g. `c-special-indent-hook'.
299 This command sets the variable `c-syntactic-indentation'."
301 (setq c-syntactic-indentation
302 (c-calculate-state arg c-syntactic-indentation))
303 (c-keep-region-active))
305 (defun c-toggle-auto-newline (&optional arg)
306 "Toggle auto-newline feature.
307 Optional numeric ARG, if supplied, turns on auto-newline when
308 positive, turns it off when negative, and just toggles it when zero or
311 Turning on auto-newline automatically enables electric indentation.
313 When the auto-newline feature is enabled (indicated by \"/la\" on the
314 mode line after the mode name) newlines are automatically inserted
315 after special characters such as brace, comma, semi-colon, and colon."
318 (c-calculate-state arg (and c-auto-newline c-electric-flag)))
319 (if c-auto-newline (setq c-electric-flag t))
321 (c-keep-region-active))
323 (defalias 'c-toggle-auto-state 'c-toggle-auto-newline)
324 (make-obsolete 'c-toggle-auto-state 'c-toggle-auto-newline "22.1")
326 (defun c-toggle-hungry-state (&optional arg)
327 "Toggle hungry-delete-key feature.
328 Optional numeric ARG, if supplied, turns on hungry-delete when
329 positive, turns it off when negative, and just toggles it when zero or
332 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
333 the mode line after the mode name) the delete key gobbles all preceding
334 whitespace in one fell swoop."
336 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
338 (c-keep-region-active))
340 (defun c-toggle-auto-hungry-state (&optional arg)
341 "Toggle auto-newline and hungry-delete-key features.
342 Optional numeric ARG, if supplied, turns on auto-newline and
343 hungry-delete when positive, turns them off when negative, and just
344 toggles them when zero or left out.
346 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
348 (setq c-auto-newline (c-calculate-state arg c-auto-newline))
349 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
351 (c-keep-region-active))
353 (defun c-toggle-electric-state (&optional arg)
354 "Toggle the electric indentation feature.
355 Optional numeric ARG, if supplied, turns on electric indentation when
356 positive, turns it off when negative, and just toggles it when zero or
359 (setq c-electric-flag (c-calculate-state arg c-electric-flag))
361 (when (fboundp 'electric-indent-local-mode) ; Emacs 24.4 or later.
362 (electric-indent-local-mode (if c-electric-flag 1 0)))
363 (c-keep-region-active))
368 (defun c-electric-backspace (arg)
369 "Delete the preceding character or whitespace.
370 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
371 line) then all preceding whitespace is consumed. If however a prefix
372 argument is supplied, or `c-hungry-delete-key' is nil, or point is
373 inside a literal then the function in the variable
374 `c-backspace-function' is called."
376 (if (c-save-buffer-state ()
377 (or (not c-hungry-delete-key)
380 (funcall c-backspace-function (prefix-numeric-value arg))
381 (c-hungry-delete-backwards)))
383 (defun c-hungry-delete-backwards ()
384 "Delete the preceding character or all preceding whitespace
385 back to the previous non-whitespace character.
386 See also \\[c-hungry-delete-forward]."
388 (let ((here (point)))
390 (if (/= (point) here)
391 (delete-region (point) here)
392 (funcall c-backspace-function 1))))
394 (defalias 'c-hungry-backspace 'c-hungry-delete-backwards)
396 (defun c-electric-delete-forward (arg)
397 "Delete the following character or whitespace.
398 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
399 line) then all following whitespace is consumed. If however a prefix
400 argument is supplied, or `c-hungry-delete-key' is nil, or point is
401 inside a literal then the function in the variable `c-delete-function'
404 (if (c-save-buffer-state ()
405 (or (not c-hungry-delete-key)
408 (funcall c-delete-function (prefix-numeric-value arg))
409 (c-hungry-delete-forward)))
411 (defun c-hungry-delete-forward ()
412 "Delete the following character or all following whitespace
413 up to the next non-whitespace character.
414 See also \\[c-hungry-delete-backwards]."
416 (let ((here (point)))
418 (if (/= (point) here)
419 (delete-region (point) here)
420 (funcall c-delete-function 1))))
422 ;; This function is only used in XEmacs.
423 (defun c-electric-delete (arg)
424 "Deletes preceding or following character or whitespace.
425 This function either deletes forward as `c-electric-delete-forward' or
426 backward as `c-electric-backspace', depending on the configuration: If
427 the function `delete-forward-p' is defined and returns non-nil, it
428 deletes forward. Otherwise it deletes backward.
430 Note: This is the way in XEmacs to choose the correct action for the
431 [delete] key, whichever key that means. Other flavors don't use this
432 function to control that."
434 (if (and (fboundp 'delete-forward-p)
436 (c-electric-delete-forward arg)
437 (c-electric-backspace arg)))
439 ;; This function is only used in XEmacs.
440 (defun c-hungry-delete ()
441 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
442 The direction of deletion depends on the configuration: If the
443 function `delete-forward-p' is defined and returns non-nil, it deletes
444 forward using `c-hungry-delete-forward'. Otherwise it deletes
445 backward using `c-hungry-backspace'.
447 Note: This is the way in XEmacs to choose the correct action for the
448 [delete] key, whichever key that means. Other flavors don't use this
449 function to control that."
451 (if (and (fboundp 'delete-forward-p)
453 (c-hungry-delete-forward)
454 (c-hungry-delete-backwards)))
456 (defun c-electric-pound (arg)
458 If `c-electric-flag' is set, handle it specially according to the variable
459 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
460 inside a literal or a macro, nothing special happens."
462 (if (c-save-buffer-state ()
464 (not c-electric-flag)
465 (not (memq 'alignleft c-electric-pound-behavior))
467 (skip-chars-backward " \t")
470 (and (= (forward-line -1) 0)
472 (eq (char-before) ?\\))))
474 ;; do nothing special
475 (self-insert-command (prefix-numeric-value arg))
476 ;; place the pound character at the left edge
477 (let ((pos (- (point-max) (point)))
480 (delete-horizontal-space)
481 (insert (c-last-command-char))
483 (goto-char (- (point-max) pos)))
486 (defun c-point-syntax ()
487 ;; Return the syntactic context of the construct at point. (This is NOT
488 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
489 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
490 (c-save-buffer-state (;; shut this up too
491 (c-echo-syntactic-information-p nil)
493 (c-tentative-buffer-changes
494 ;; insert a newline to isolate the construct at point for syntactic
497 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
498 ;; the syntax. (There might already be an escaped NL there.)
501 (c-skip-ws-backward (c-point 'bopl))
506 (and (c-beginning-of-macro)
507 (progn (c-end-of-macro)
512 (let ((c-syntactic-indentation-in-macros t)
513 (c-auto-newline-analysis t))
514 ;; Turn on syntactic macro analysis to help with auto
516 (setq syntax (c-guess-basic-syntax))
520 (defun c-brace-newlines (syntax)
521 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
522 ;; (not necessarily the same as the S.C. of the line it is on). Return
523 ;; NEWLINES, the list containing some combination of the symbols `before'
524 ;; and `after' saying where newlines should be inserted.
527 ;; This is the list of brace syntactic symbols that can hang.
528 ;; If any new ones are added to c-offsets-alist, they should be
529 ;; added here as well.
531 ;; The order of this list is important; if SYNTAX has several
532 ;; elements, the element that "wins" is the earliest in SYMS.
533 '(arglist-cont-nonempty ; e.g. an array literal.
534 class-open class-close defun-open defun-close
535 inline-open inline-close
536 brace-list-open brace-list-close
537 brace-list-intro brace-entry-open
538 block-open block-close
539 substatement-open statement-case-open
540 extern-lang-open extern-lang-close
541 namespace-open namespace-close
542 module-open module-close
543 composition-open composition-close
544 inexpr-class-open inexpr-class-close
545 ;; `statement-cont' is here for the case with a brace
546 ;; list opener inside a statement. C.f. CASE B.2 in
547 ;; `c-guess-continued-construct'.
550 (c-echo-syntactic-information-p nil)
551 symb-newlines) ; e.g. (substatement-open . (after))
554 ;; Do not try to insert newlines around a special
555 ;; (Pike-style) brace list.
556 (if (and c-special-brace-lists
558 (c-safe (if (= (char-before) ?{)
561 (c-looking-at-special-brace-list))))
563 ;; Seek the matching entry in c-hanging-braces-alist.
566 ;; Substitute inexpr-class and class-open or
567 ;; class-close with inexpr-class-open or
568 ;; inexpr-class-close.
569 (if (assq 'inexpr-class syntax)
570 (cond ((assq 'class-open syntax)
571 '((inexpr-class-open)))
572 ((assq 'class-close syntax)
573 '((inexpr-class-close)))
576 c-hanging-braces-alist)
577 '(ignore before after)))) ; Default, when not in c-h-b-l.
579 ;; If syntax is a function symbol, then call it using the
580 ;; defined semantics.
581 (if (and (not (consp (cdr symb-newlines)))
582 (functionp (cdr symb-newlines)))
583 (let ((c-syntactic-context syntax))
584 (funcall (cdr symb-newlines)
587 (cdr symb-newlines))))
589 (defun c-try-one-liner ()
590 ;; Point is just after a newly inserted }. If the non-whitespace
591 ;; content of the braces is a single line of code, compact the whole
592 ;; construct to a single line, if this line isn't too long. The Right
593 ;; Thing is done with comments.
595 ;; Point will be left after the }, regardless of whether the clean-up is
596 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
599 (pos (- (point-max) (point)))
600 mbeg1 mend1 mbeg4 mend4
601 eol-col cmnt-pos cmnt-col cmnt-gap)
606 ;; Avoid backtracking over a very large block. The one we
607 ;; deal with here can never be more than three lines.
608 (narrow-to-region (save-excursion
612 (and (c-safe (c-backward-sexp))
615 (narrow-to-region (point) (1- here)) ; innards of {.}
617 (cc-eval-when-compile
619 "\\(" ; (match-beginning 1)
620 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
621 "\\)" ; (match-end 1)
622 "[^ \t\r\n]+\\([ \t]+[^ \t\r\n]+\\)*" ; non-WS
623 "\\(" ; (match-beginning 4)
624 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
625 "\\)\\'"))))))) ; (match-end 4) at EOB.
627 (if (c-tentative-buffer-changes
628 (setq mbeg1 (match-beginning 1) mend1 (match-end 1)
629 mbeg4 (match-beginning 4) mend4 (match-end 4))
630 (backward-char) ; back over the `}'
632 (setq cmnt-pos (and (c-backward-single-comment)
633 (- (point) (- mend1 mbeg1)))))
634 (delete-region mbeg4 mend4)
635 (delete-region mbeg1 mend1)
636 (setq eol-col (save-excursion (end-of-line) (current-column)))
638 ;; Necessary to put the closing brace before any line
639 ;; oriented comment to keep it syntactically significant.
640 ;; This isn't necessary for block comments, but the result
641 ;; looks nicer anyway.
643 (delete-char 1) ; the `}' has blundered into a comment
645 (setq cmnt-col (1+ (current-column)))
646 (setq cmnt-pos (1+ cmnt-pos)) ; we're inserting a `}'
648 (insert-char ?\} 1) ; reinsert the `}' before the comment.
649 (setq cmnt-gap (- cmnt-col (current-column)))
650 (when (zerop cmnt-gap)
651 (insert-char ?\ 1) ; Put a space before a bare comment.
654 (or (null c-max-one-liner-length)
655 (zerop c-max-one-liner-length)
656 (<= eol-col c-max-one-liner-length)
657 ;; Can we trim space before comment to make the line fit?
659 (< (- eol-col cmnt-gap) c-max-one-liner-length)
660 (progn (goto-char cmnt-pos)
661 (backward-delete-char-untabify
662 (- eol-col c-max-one-liner-length))
664 (goto-char (- (point-max) pos))))))
666 (defun c-electric-brace (arg)
669 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
670 numeric ARG hasn't been supplied, the command performs several electric
673 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
674 the mode line) newlines are inserted before and after the brace as
675 directed by the settings in `c-hanging-braces-alist'.
677 \(b) Any auto-newlines are indented. The original line is also
678 reindented unless `c-syntactic-indentation' is nil.
680 \(c) If auto-newline is turned on, various newline cleanups based on the
681 settings of `c-cleanup-list' are done."
684 (let (safepos literal
685 ;; We want to inhibit blinking the paren since this would be
686 ;; most disruptive. We'll blink it ourselves later on.
687 (old-blink-paren blink-paren-function)
688 blink-paren-function case-fold-search)
690 (c-save-buffer-state ()
691 (setq safepos (c-safe-position (point) (c-parse-state))
692 literal (c-in-literal safepos)))
694 ;; Insert the brace. Note that expand-abbrev might reindent
695 ;; the line here if there's a preceding "else" or something.
696 (self-insert-command (prefix-numeric-value arg))
698 (when (and c-electric-flag (not literal) (not arg))
699 (if (not (looking-at "[ \t]*\\\\?$"))
700 (if c-syntactic-indentation
701 (indent-according-to-mode))
703 (let ( ;; shut this up too
704 (c-echo-syntactic-information-p nil)
706 ln-syntax br-syntax syntax) ; Syntactic context of the original line,
707 ; of the brace itself, of the line the brace ends up on.
708 (c-save-buffer-state ((c-syntactic-indentation-in-macros t)
709 (c-auto-newline-analysis t))
710 (setq ln-syntax (c-guess-basic-syntax)))
711 (if c-syntactic-indentation
712 (c-indent-line ln-syntax))
716 (setq br-syntax (c-point-syntax)
717 newlines (c-brace-newlines br-syntax))
719 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
720 (if (and (memq 'before newlines)
721 (> (current-column) (current-indentation)))
722 (if c-syntactic-indentation
723 ;; Only a plain newline for now - it's indented
724 ;; after the cleanups when the line has its final
727 (c-newline-and-indent)))
730 ;; `syntax' is the syntactic context of the line which ends up
731 ;; with the brace on it.
732 (setq syntax (if (memq 'before newlines) br-syntax ln-syntax))
734 ;; Do all appropriate clean ups
736 (pos (- (point-max) (point)))
740 ;; `}': clean up empty defun braces
741 (when (c-save-buffer-state ()
742 (and (memq 'empty-defun-braces c-cleanup-list)
743 (eq (c-last-command-char) ?\})
744 (c-intersect-lists '(defun-close class-close inline-close)
749 (eq (char-before) ?\{))
750 ;; make sure matching open brace isn't in a comment
751 (not (c-in-literal))))
752 (delete-region (point) (1- here))
753 (setq here (- (point-max) pos)))
756 ;; `}': compact to a one-liner defun?
759 (and (eq (c-last-command-char) ?\})
760 (memq 'one-liner-defun c-cleanup-list)
761 (c-intersect-lists '(defun-close) syntax)
763 (setq here (- (point-max) pos))))
765 ;; `{': clean up brace-else-brace and brace-elseif-brace
766 (when (eq (c-last-command-char) ?\{)
768 ((and (memq 'brace-else-brace c-cleanup-list)
771 "\\([ \t\n]\\|\\\\\n\\)*"
773 "\\([ \t\n]\\|\\\\\n\\)*"
777 (delete-region (match-beginning 0) (match-end 0))
778 (insert-and-inherit "} else {"))
779 ((and (memq 'brace-elseif-brace c-cleanup-list)
781 (goto-char (1- here))
785 (eq (char-before) ?\)))
786 (zerop (c-save-buffer-state nil (c-backward-token-2 1 t)))
787 (eq (char-after) ?\()
792 "\\([ \t\n]\\|\\\\\n\\)*"
794 "\\([ \t\n]\\|\\\\\n\\)+"
796 "\\([ \t\n]\\|\\\\\n\\)*"
799 ;(eq (match-end 0) tmp);
801 (delete-region mbeg mend)
805 (goto-char (- (point-max) pos))
807 ;; Indent the line after the cleanups since it might
808 ;; very well indent differently due to them, e.g. if
809 ;; c-indent-one-line-block is used together with the
810 ;; one-liner-defun cleanup.
811 (when c-syntactic-indentation
814 ;; does a newline go after the brace?
815 (if (memq 'after newlines)
816 (c-newline-and-indent))
820 (and (eq (c-last-command-char) ?\})
821 (not executing-kbd-macro)
824 (c-save-buffer-state nil
825 (c-backward-syntactic-ws safepos))
826 (funcall old-blink-paren)))))
828 (defun c-electric-slash (arg)
829 "Insert a slash character.
831 If the slash is inserted immediately after the comment prefix in a c-style
832 comment, the comment might get closed by removing whitespace and possibly
833 inserting a \"*\". See the variable `c-cleanup-list'.
835 Indent the line as a comment, if:
837 1. The slash is second of a \"//\" line oriented comment introducing
838 token and we are on a comment-only-line, or
840 2. The slash is part of a \"*/\" token that closes a block oriented
843 If a numeric ARG is supplied, point is inside a literal, or
844 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
847 (let ((literal (c-save-buffer-state () (c-in-literal)))
850 (c-echo-syntactic-information-p nil))
852 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
853 ;; `c-syntactic-indentation' set.
856 (memq 'comment-close-slash c-cleanup-list)
857 (eq (c-last-command-char) ?/)
858 (looking-at (concat "[ \t]*\\("
859 (regexp-quote comment-end) "\\)?$"))
860 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
863 (narrow-to-region (point-min) (point))
864 (back-to-indentation)
865 (looking-at (concat c-current-comment-prefix "[ \t]*$")))))
866 (delete-region (progn (forward-line 0) (point))
867 (progn (end-of-line) (point)))
868 (insert-char ?* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
870 (setq indentp (and (not arg)
871 c-syntactic-indentation
873 (eq (c-last-command-char) ?/)
874 (eq (char-before) (if literal ?* ?/))))
875 (self-insert-command (prefix-numeric-value arg))
877 (indent-according-to-mode))))
879 (defun c-electric-star (arg)
880 "Insert a star character.
881 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
882 the star is the second character of a C style comment starter on a
883 comment-only-line, indent the line as a comment. If a numeric ARG is
884 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
885 this indentation is inhibited."
888 (self-insert-command (prefix-numeric-value arg))
889 ;; if we are in a literal, or if arg is given do not reindent the
890 ;; current line, unless this star introduces a comment-only line.
891 (if (c-save-buffer-state ()
892 (and c-syntactic-indentation
895 (eq (c-in-literal) 'c)
896 (eq (char-before) ?*)
899 (skip-chars-backward "*")
900 (if (eq (char-before) ?/)
902 (skip-chars-backward " \t")
904 (let (c-echo-syntactic-information-p) ; shut this up
905 (indent-according-to-mode))
908 (defun c-electric-semi&comma (arg)
909 "Insert a comma or semicolon.
911 If `c-electric-flag' is non-nil, point isn't inside a literal and a
912 numeric ARG hasn't been supplied, the command performs several electric
915 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
916 the mode line) a newline might be inserted. See the variable
917 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
919 \(b) Any auto-newlines are indented. The original line is also
920 reindented unless `c-syntactic-indentation' is nil.
922 \(c) If auto-newline is turned on, a comma following a brace list or a
923 semicolon following a defun might be cleaned up, depending on the
924 settings of `c-cleanup-list'."
926 (let* (lim literal c-syntactic-context
929 (c-echo-syntactic-information-p nil))
931 (c-save-buffer-state ()
932 (setq lim (c-most-enclosing-brace (c-parse-state))
933 literal (c-in-literal lim)))
935 (self-insert-command (prefix-numeric-value arg))
937 (if (and c-electric-flag (not literal) (not arg))
938 ;; do all cleanups and newline insertions if c-auto-newline is on.
939 (if (or (not c-auto-newline)
940 (not (looking-at "[ \t]*\\\\?$")))
941 (if c-syntactic-indentation
943 ;; clean ups: list-close-comma or defun-close-semi
944 (let ((pos (- (point-max) (point))))
945 (if (c-save-buffer-state ()
947 (eq (c-last-command-char) ?,)
948 (memq 'list-close-comma c-cleanup-list))
950 (eq (c-last-command-char) ?\;)
951 (memq 'defun-close-semi c-cleanup-list)))
955 (eq (char-before) ?}))
956 ;; make sure matching open brace isn't in a comment
957 (not (c-in-literal lim))))
958 (delete-region (point) here))
959 (goto-char (- (point-max) pos)))
961 (when c-syntactic-indentation
962 (setq c-syntactic-context (c-guess-basic-syntax))
963 (c-indent-line c-syntactic-context))
964 ;; check to see if a newline should be added
965 (let ((criteria c-hanging-semi&comma-criteria)
966 answer add-newline-p)
968 (setq answer (funcall (car criteria)))
969 ;; only nil value means continue checking
971 (setq criteria (cdr criteria))
973 ;; only 'stop specifically says do not add a newline
974 (setq add-newline-p (not (eq answer 'stop)))
977 (c-newline-and-indent))
980 (defun c-electric-colon (arg)
983 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
984 numeric ARG hasn't been supplied, the command performs several electric
987 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
988 the mode line) newlines are inserted before and after the colon based on
989 the settings in `c-hanging-colons-alist'.
991 \(b) Any auto-newlines are indented. The original line is also
992 reindented unless `c-syntactic-indentation' is nil.
994 \(c) If auto-newline is turned on, whitespace between two colons will be
995 \"cleaned up\" leaving a scope operator, if this action is set in
999 (let* ((bod (c-point 'bod))
1000 (literal (c-save-buffer-state () (c-in-literal bod)))
1001 newlines is-scope-op
1003 (c-echo-syntactic-information-p nil))
1004 (self-insert-command (prefix-numeric-value arg))
1005 ;; Any electric action?
1006 (if (and c-electric-flag (not literal) (not arg))
1007 ;; Unless we're at EOL, only re-indentation happens.
1008 (if (not (looking-at "[ \t]*\\\\?$"))
1009 (if c-syntactic-indentation
1010 (indent-according-to-mode))
1012 ;; scope-operator clean-up?
1013 (let ((pos (- (point-max) (point)))
1015 (if (c-save-buffer-state () ; Why do we need this? [ACM, 2003-03-12]
1017 (memq 'scope-operator c-cleanup-list)
1018 (eq (char-before) ?:)
1021 (c-skip-ws-backward)
1022 (eq (char-before) ?:))
1023 (not (c-in-literal))
1024 (not (eq (char-after (- (point) 2)) ?:))))
1026 (delete-region (point) (1- here))
1027 (setq is-scope-op t)))
1028 (goto-char (- (point-max) pos)))
1030 ;; indent the current line if it's done syntactically.
1031 (if c-syntactic-indentation
1032 ;; Cannot use the same syntax analysis as we find below,
1033 ;; since that's made with c-syntactic-indentation-in-macros
1035 (indent-according-to-mode))
1037 ;; Calculate where, if anywhere, we want newlines.
1038 (c-save-buffer-state
1039 ((c-syntactic-indentation-in-macros t)
1040 (c-auto-newline-analysis t)
1041 ;; Turn on syntactic macro analysis to help with auto newlines
1043 (syntax (c-guess-basic-syntax))
1045 ;; Translate substatement-label to label for this operation.
1047 (if (eq (car (car elem)) 'substatement-label)
1048 (setcar (car elem) 'label))
1049 (setq elem (cdr elem)))
1050 ;; some language elements can only be determined by checking
1051 ;; the following line. Let's first look for ones that can be
1052 ;; found when looking on the line with the colon
1055 (or (c-lookup-lists '(case-label label access-label)
1056 syntax c-hanging-colons-alist)
1057 (c-lookup-lists '(member-init-intro inher-intro)
1061 (c-guess-basic-syntax)
1063 c-hanging-colons-alist)))))
1064 ;; does a newline go before the colon? Watch out for already
1065 ;; non-hung colons. However, we don't unhang them because that
1066 ;; would be a cleanup (and anti-social).
1067 (if (and (memq 'before newlines)
1070 (skip-chars-backward ": \t")
1072 (let ((pos (- (point-max) (point))))
1074 (c-newline-and-indent)
1075 (goto-char (- (point-max) pos))))
1076 ;; does a newline go after the colon?
1077 (if (and (memq 'after (cdr-safe newlines))
1079 (c-newline-and-indent))
1082 (defun c-electric-lt-gt (arg)
1083 "Insert a \"<\" or \">\" character.
1084 If the current language uses angle bracket parens (e.g. template
1085 arguments in C++), try to find out if the inserted character is a
1086 paren and give it paren syntax if appropriate.
1088 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1089 line will be reindented if the inserted character is a paren or if it
1090 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1091 numeric argument is supplied, or the point is inside a literal."
1094 (let ((c-echo-syntactic-information-p nil)
1095 final-pos found-delim case-fold-search)
1097 (self-insert-command (prefix-numeric-value arg))
1098 (setq final-pos (point))
1100 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1101 ;;;; property on the new < or > and its mate (if any) when they are template
1102 ;;;; parens. This is now done in an after-change function.
1104 ;; Indent the line if appropriate.
1105 (when (and c-electric-flag c-syntactic-indentation c-recognize-<>-arglists)
1107 (if (eq (c-last-command-char) ?<)
1108 ;; If a <, basically see if it's got "template" before it .....
1112 (progn (c-beginning-of-current-token) (point))))
1114 (c-backward-token-2)
1115 (looking-at c-opt-<>-sexp-key)))
1116 ;; ..... or is a C++ << operator.
1117 (and (c-major-mode-is 'c++-mode)
1119 (goto-char (1- final-pos))
1120 (c-beginning-of-current-token)
1122 (>= (match-end 0) final-pos)))
1124 ;; It's a >. Either a template/generic terminator ...
1125 (or (c-get-char-property (1- final-pos) 'syntax-table)
1126 ;; or a C++ >> operator.
1127 (and (c-major-mode-is 'c++-mode)
1129 (goto-char (1- final-pos))
1130 (c-beginning-of-current-token)
1132 (>= (match-end 0) final-pos))))))
1134 (goto-char final-pos)
1136 (indent-according-to-mode)
1137 (when (and (eq (char-before) ?>)
1138 (not executing-kbd-macro)
1139 blink-paren-function)
1140 ;; From now (2016-01-01), the syntax-table text properties on < and >
1141 ;; are applied in an after-change function, not during redisplay. Hence
1142 ;; we no longer need to call (sit-for 0) for blink paren to work.
1143 (funcall blink-paren-function)))))
1145 (defun c-electric-paren (arg)
1146 "Insert a parenthesis.
1148 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1149 line is reindented unless a numeric ARG is supplied, or the parenthesis
1150 is inserted inside a literal.
1152 Whitespace between a function name and the parenthesis may get added or
1153 removed; see the variable `c-cleanup-list'.
1155 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1156 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1158 (let ((literal (c-save-buffer-state () (c-in-literal)))
1160 (c-echo-syntactic-information-p nil)
1162 (self-insert-command (prefix-numeric-value arg))
1164 (if (and (not arg) (not literal))
1165 (let* ( ;; We want to inhibit blinking the paren since this will
1166 ;; be most disruptive. We'll blink it ourselves
1168 (old-blink-paren blink-paren-function)
1169 blink-paren-function)
1170 (if (and c-syntactic-indentation c-electric-flag)
1171 (indent-according-to-mode))
1173 ;; If we're at EOL, check for new-line clean-ups.
1174 (when (and c-electric-flag c-auto-newline
1175 (looking-at "[ \t]*\\\\?$"))
1177 ;; clean up brace-elseif-brace
1179 (and (memq 'brace-elseif-brace c-cleanup-list)
1180 (eq (c-last-command-char) ?\()
1183 "\\([ \t\n]\\|\\\\\n\\)*"
1185 "\\([ \t\n]\\|\\\\\n\\)+"
1187 "\\([ \t\n]\\|\\\\\n\\)*"
1191 (not (c-save-buffer-state () (c-in-literal))))
1192 (delete-region (match-beginning 0) (match-end 0))
1193 (insert-and-inherit "} else if ("))
1195 ;; clean up brace-catch-brace
1197 (and (memq 'brace-catch-brace c-cleanup-list)
1198 (eq (c-last-command-char) ?\()
1201 "\\([ \t\n]\\|\\\\\n\\)*"
1203 "\\([ \t\n]\\|\\\\\n\\)*"
1207 (not (c-save-buffer-state () (c-in-literal))))
1208 (delete-region (match-beginning 0) (match-end 0))
1209 (insert-and-inherit "} catch (")))
1211 ;; Check for clean-ups at function calls. These two DON'T need
1212 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1213 ;; Point is currently just after the inserted paren.
1214 (let (beg (end (1- (point))))
1217 ;; space-before-funcall clean-up?
1218 ((and (memq 'space-before-funcall c-cleanup-list)
1219 (eq (c-last-command-char) ?\()
1222 (skip-chars-backward " \t")
1224 (and (c-save-buffer-state () (c-on-identifier))
1225 ;; Don't add a space into #define FOO()....
1226 (not (and (c-beginning-of-macro)
1227 (c-forward-over-cpp-define-id)
1228 (eq (point) beg))))))
1230 (delete-region beg end)
1234 ;; compact-empty-funcall clean-up?
1235 ((c-save-buffer-state ()
1236 (and (memq 'compact-empty-funcall c-cleanup-list)
1237 (eq (c-last-command-char) ?\))
1239 (c-safe (backward-char 2))
1240 (when (looking-at "()")
1242 (skip-chars-backward " \t")
1244 (c-on-identifier)))))
1245 (delete-region beg end))))
1246 (and (eq last-input-event ?\))
1247 (not executing-kbd-macro)
1249 (funcall old-blink-paren))))))
1251 (defun c-electric-continued-statement ()
1252 "Reindent the current line if appropriate.
1254 This function is used to reindent the line after a keyword which
1255 continues an earlier statement is typed, e.g. an \"else\" or the
1256 \"while\" in a do-while block.
1258 The line is reindented if there is nothing but whitespace before the
1259 keyword on the line, the keyword is not inserted inside a literal, and
1260 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1261 (let (;; shut this up
1262 (c-echo-syntactic-information-p nil))
1263 (when (c-save-buffer-state ()
1264 (and c-electric-flag
1265 c-syntactic-indentation
1266 (not (eq (c-last-command-char) ?_))
1268 (skip-syntax-backward "w")
1271 (not (c-in-literal (c-point 'bod)))))
1272 ;; Have to temporarily insert a space so that
1273 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1274 ;; space with a nonspace to avoid messing up any whitespace
1275 ;; sensitive meddling that might be done, e.g. by
1276 ;; `c-backslash-region'.
1277 (insert-and-inherit " x")
1279 (indent-according-to-mode)
1280 (delete-char -2)))))
1284 (declare-function subword-forward "subword" (&optional arg))
1285 (declare-function subword-backward "subword" (&optional arg))
1288 ((and (fboundp 'subword-mode) (not (fboundp 'c-subword-mode)))
1289 ;; Recent Emacsen come with their own subword support. Use that.
1290 (define-obsolete-function-alias 'c-subword-mode 'subword-mode "24.3")
1291 (define-obsolete-variable-alias 'c-subword-mode 'subword-mode "24.3"))
1293 ;; Autoload directive for emacsen that doesn't have an older CC Mode
1294 ;; version in the dist.
1295 (autoload 'c-subword-mode "cc-subword"
1296 "Mode enabling subword movement and editing keys." t)))
1298 (declare-function c-forward-subword "ext:cc-subword" (&optional arg))
1299 (declare-function c-backward-subword "ext:cc-subword" (&optional arg))
1301 ;; "nomenclature" functions + c-scope-operator.
1302 (defun c-forward-into-nomenclature (&optional arg)
1303 "Compatibility alias for `c-forward-subword'."
1305 (if (fboundp 'subword-mode)
1308 (subword-forward arg))
1309 (require 'cc-subword)
1310 (c-forward-subword arg)))
1311 (make-obsolete 'c-forward-into-nomenclature
1312 (if (fboundp 'subword-mode) 'subword-forward 'c-forward-subword)
1315 (defun c-backward-into-nomenclature (&optional arg)
1316 "Compatibility alias for `c-backward-subword'."
1318 (if (fboundp 'subword-mode)
1321 (subword-backward arg))
1322 (require 'cc-subword)
1323 (c-backward-subword arg)))
1325 'c-backward-into-nomenclature
1326 (if (fboundp 'subword-mode) 'subword-backward 'c-backward-subword) "23.2")
1328 (defun c-scope-operator ()
1329 "Insert a double colon scope operator at point.
1330 No indentation or other \"electric\" behavior is performed."
1332 (insert-and-inherit "::"))
1335 ;; Movement (etc.) by defuns.
1336 (defun c-in-function-trailer-p (&optional lim)
1337 ;; Return non-nil if point is between the closing brace and the semicolon of
1338 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1339 ;; portion of a declaration like "struct foo {...} bar ;".
1341 ;; Return the position of the main declaration. Otherwise, return nil.
1342 ;; Point is assumed to be at the top level and outside of any macro or
1345 ;; If LIM is non-nil, it is the bound on a the backward search for the
1346 ;; beginning of the declaration.
1348 ;; This function might do hidden buffer changes.
1349 (and c-opt-block-decls-with-vars-key
1351 (c-syntactic-skip-backward "^;}" lim)
1352 (let ((eo-block (point))
1354 (and (eq (char-before) ?\})
1355 (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1357 ;; Look for struct or union or ... If we find one, it might
1358 ;; be the return type of a function, or the like. Exclude
1360 (c-syntactic-re-search-forward
1361 (concat "[;=([{]\\|\\("
1362 c-opt-block-decls-with-vars-key
1365 (match-beginning 1) ; Is there a "struct" etc., somewhere?
1366 (not (eq (char-before) ?_))
1367 (c-syntactic-re-search-forward "[;=([{]" eo-block t t t)
1368 (eq (char-before) ?\{)
1371 (defun c-where-wrt-brace-construct ()
1372 ;; Determine where we are with respect to functions (or other brace
1373 ;; constructs, included in the term "function" in the rest of this comment).
1374 ;; Point is assumed to be outside any macro or literal.
1375 ;; This is used by c-\(beginning\|end\)-of-defun.
1377 ;; Return one of these symbols:
1378 ;; at-header : we're at the start of a function's header.
1379 ;; in-header : we're inside a function's header, this extending right
1380 ;; up to the brace. This bit includes any k&r declarations.
1381 ;; in-block : we're inside a function's brace block.
1382 ;; in-trailer : we're in the area between the "}" and ";" of something
1383 ;; like "struct foo {...} bar, baz;".
1384 ;; at-function-end : we're just after the closing brace (or semicolon) that
1385 ;; terminates the function.
1386 ;; outwith-function: we're not at or in any function. Being inside a
1387 ;; non-brace construct also counts as 'outwith-function'.
1389 ;; This function might do hidden buffer changes.
1392 decl-result brace-decl-p
1394 (paren-state (c-parse-state))
1395 (least-enclosing (c-least-enclosing-brace paren-state)))
1398 ((and least-enclosing
1399 (eq (char-after least-enclosing) ?\{))
1401 ((c-in-function-trailer-p)
1403 ((and (not least-enclosing)
1405 (consp (car paren-state))
1406 (eq start (cdar paren-state)))
1409 ;; Find the start of the current declaration. NOTE: If we're in the
1410 ;; variables after a "struct/eval" type block, we don't get to the
1411 ;; real declaration here - we detect and correct for this later.
1413 ;;If we're in the parameters' parens, move back out of them.
1414 (if least-enclosing (goto-char least-enclosing))
1415 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1416 ;; at a declaration.
1417 (if (or (and (eolp) (not (eobp))) ; EOL is matched by "\\s>"
1419 "\\([;#]\\|\\'\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s$\\|\\s<\\|\\s>\\|\\s!\\)")))
1421 (setq kluge-start (point))
1423 (car (c-beginning-of-decl-1
1424 ;; NOTE: If we're in a K&R region, this might be the start
1425 ;; of a parameter declaration, not the actual function.
1426 ;; It might also leave us at a label or "label" like
1428 (and least-enclosing ; LIMIT for c-b-of-decl-1
1429 (c-safe-position least-enclosing paren-state)))))
1431 ;; Has the declaration we've gone back to got braces?
1432 (or (eq decl-result 'label)
1435 (and (c-syntactic-re-search-forward "[;{]" nil t t)
1436 (or (eq (char-before) ?\{)
1437 (and c-recognize-knr-p
1438 ;; Might have stopped on the
1439 ;; ';' in a K&R argdecl. In
1440 ;; that case the declaration
1441 ;; should contain a block.
1442 (c-in-knr-argdecl)))))))
1445 ((or (eq decl-result 'label) ; e.g. "private:" or invalid syntax.
1446 (= (point) kluge-start)) ; might be BOB or unbalanced parens.
1448 ((eq decl-result 'same)
1450 (if (eq (point) start)
1454 ((eq decl-result 'previous)
1455 (if (and (not brace-decl-p)
1456 (c-in-function-trailer-p))
1460 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1463 (defun c-backward-to-nth-BOF-{ (n where)
1464 ;; Skip to the opening brace of the Nth function before point. If
1465 ;; point is inside a function, this counts as the first. Point must be
1466 ;; outside any comment/string or macro.
1468 ;; N must be strictly positive.
1469 ;; WHERE describes the position of point, one of the symbols `at-header',
1470 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1471 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1473 ;; If we run out of functions, leave point at BOB. Return zero on success,
1474 ;; otherwise the number of {s still to go.
1476 ;; This function may do hidden buffer changes
1478 ;; What we do to go back the first defun depends on where we start.
1480 ((eq where 'in-block)
1481 (goto-char (c-least-enclosing-brace (c-parse-state)))
1483 ((eq where 'in-header)
1484 (c-syntactic-re-search-forward "{")
1487 ((memq where '(at-header outwith-function at-function-end in-trailer))
1488 (c-syntactic-skip-backward "^}")
1489 (when (eq (char-before) ?\})
1492 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where)))
1494 ;; Each time round the loop, go back to a "{" at the outermost level.
1495 (while (and (> n 0) (not (bobp)))
1496 (c-parse-state) ; This call speeds up the following one
1497 ; by a factor of ~6. Hmmm. 2006/4/5.
1498 (c-syntactic-skip-backward "^}")
1499 (when (eq (char-before) ?\})
1504 (defun c-narrow-to-most-enclosing-decl-block (&optional inclusive)
1505 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1506 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1507 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1508 ;; otherwise include the braces. If the closing brace is missing,
1509 ;; (point-max) is used instead.
1510 (let ((paren-state (c-parse-state))
1512 (setq encl-decl (and paren-state (c-most-enclosing-decl-block paren-state)))
1517 (progn (goto-char encl-decl)
1518 (c-beginning-of-decl-1)
1522 (goto-char encl-decl)
1523 (or (c-safe (forward-list)
1529 (defun c-widen-to-enclosing-decl-scope (paren-state orig-point-min orig-point-max)
1530 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1531 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1532 ;; braces NOT being included in the resulting region. On no account may the
1533 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1534 ;; PAREN-STATE is a list of buffer positions in the style of
1535 ;; (c-parse-state), one of which will be that of the desired opening brace,
1538 ;; Return the position of the enclosing opening brace, or nil
1539 (let (encl-decl) ; putative position of decl-scope's opening brace.
1541 (narrow-to-region orig-point-min orig-point-max)
1542 (setq encl-decl (and paren-state
1543 (c-most-enclosing-decl-block paren-state))))
1547 (narrow-to-region (1+ encl-decl)
1549 (goto-char encl-decl)
1550 (or (c-safe (forward-list)
1554 (narrow-to-region orig-point-min orig-point-max)
1558 (defmacro c-while-widening-to-decl-block (condition)
1559 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1560 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1561 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1562 ;; buffer's original restriction.
1564 ;; This is a very special purpose macro, which assumes the existence of
1565 ;; several variables. It is for use only in c-beginning-of-defun and
1569 (eq c-defun-tactic 'go-outward)
1571 (setq paren-state (c-whack-state-after lim paren-state))
1572 (setq lim (c-widen-to-enclosing-decl-scope
1573 paren-state orig-point-min orig-point-max))
1574 (setq where 'in-block))))
1576 (defun c-beginning-of-defun (&optional arg)
1577 "Move backward to the beginning of a defun.
1578 Every top level declaration that contains a brace paren block is
1579 considered to be a defun.
1581 With a positive argument, move backward that many defuns. A negative
1582 argument -N means move forward to the Nth following beginning. Return
1583 t unless search stops due to beginning or end of buffer.
1585 Unlike the built-in `beginning-of-defun' this tries to be smarter
1586 about finding the char with open-parenthesis syntax that starts the
1590 (or arg (setq arg 1))
1592 (or (not (eq this-command 'c-beginning-of-defun))
1593 (eq last-command 'c-beginning-of-defun)
1594 (c-region-is-active-p)
1597 (c-save-buffer-state
1598 (beginning-of-defun-function
1599 end-of-defun-function
1601 (paren-state (c-parse-state))
1602 (orig-point-min (point-min)) (orig-point-max (point-max))
1603 lim ; Position of { which has been widened to.
1604 where pos case-fold-search)
1607 (if (eq c-defun-tactic 'go-outward)
1608 (setq lim (c-widen-to-enclosing-decl-scope ; e.g. class, namespace.
1609 paren-state orig-point-min orig-point-max)))
1611 ;; Move back out of any macro/comment/string we happen to be in.
1612 (c-beginning-of-macro)
1613 (setq pos (c-literal-limits))
1614 (if pos (goto-char (car pos)))
1616 (setq where (c-where-wrt-brace-construct))
1619 ;; Move forward to the closing brace of a function.
1621 (if (memq where '(at-function-end outwith-function))
1622 (setq arg (1+ arg)))
1624 (c-while-widening-to-decl-block
1625 (< (setq arg (- (c-forward-to-nth-EOF-} (- arg) where))) 0)))
1626 ;; Move forward to the next opening brace....
1627 (when (and (= arg 0)
1629 (c-while-widening-to-decl-block
1630 (not (c-syntactic-re-search-forward "{" nil 'eob)))
1631 (eq (char-before) ?{)))
1633 ;; ... and backward to the function header.
1634 (c-beginning-of-decl-1)
1637 ;; Move backward to the opening brace of a function, making successively
1638 ;; larger portions of the buffer visible as necessary.
1640 (c-while-widening-to-decl-block
1641 (> (setq arg (c-backward-to-nth-BOF-{ arg where)) 0)))
1644 ;; Go backward to this function's header.
1645 (c-beginning-of-decl-1)
1648 ;; We're now there, modulo comments and whitespace.
1649 ;; Try to be line oriented; position point at the closest
1650 ;; preceding boi that isn't inside a comment, but if we hit
1651 ;; the previous declaration then we use the current point
1653 (while (and (/= (point) (c-point 'boi))
1654 (c-backward-single-comment)))
1655 (if (/= (point) (c-point 'boi))
1658 (c-keep-region-active)
1661 (defun c-forward-to-nth-EOF-} (n where)
1662 ;; Skip to the closing brace of the Nth function after point. If
1663 ;; point is inside a function, this counts as the first. Point must be
1664 ;; outside any comment/string or macro.
1666 ;; N must be strictly positive.
1667 ;; WHERE describes the position of point, one of the symbols `at-header',
1668 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1669 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1671 ;; If we run out of functions, leave point at EOB. Return zero on success,
1672 ;; otherwise the number of }s still to go.
1674 ;; This function may do hidden buffer changes.
1677 ;; What we do to go forward over the first defun depends on where we
1678 ;; start. We go to the closing brace of that defun, even when we go
1679 ;; backwards to it (in a "struct foo {...} bar ;").
1681 ((eq where 'in-block)
1682 (goto-char (c-least-enclosing-brace (c-parse-state)))
1685 ((eq where 'in-trailer)
1686 (c-syntactic-skip-backward "^}")
1688 ((memq where '(at-function-end outwith-function at-header in-header))
1689 (when (c-syntactic-re-search-forward "{" nil 'eob)
1693 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1695 ;; Each time round the loop, go forward to a "}" at the outermost level.
1696 (while (and (> n 0) (not (eobp)))
1697 ;(c-parse-state) ; This call speeds up the following one by a factor
1698 ; of ~6. Hmmm. 2006/4/5.
1699 (when (c-syntactic-re-search-forward "{" nil 'eob)
1705 (defun c-end-of-defun (&optional arg)
1706 "Move forward to the end of a top level declaration.
1707 With argument, do it that many times. Negative argument -N means move
1708 back to Nth preceding end. Returns t unless search stops due to
1709 beginning or end of buffer.
1711 An end of a defun occurs right after the close-parenthesis that matches
1712 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1714 (or arg (setq arg 1))
1716 (or (not (eq this-command 'c-end-of-defun))
1717 (eq last-command 'c-end-of-defun)
1718 (c-region-is-active-p)
1721 (c-save-buffer-state
1722 (beginning-of-defun-function
1723 end-of-defun-function
1725 (paren-state (c-parse-state))
1726 (orig-point-min (point-min)) (orig-point-max (point-max))
1728 where pos case-fold-search)
1731 (if (eq c-defun-tactic 'go-outward)
1732 (setq lim (c-widen-to-enclosing-decl-scope ; e.g. class, namespace
1733 paren-state orig-point-min orig-point-max)))
1735 ;; Move back out of any macro/comment/string we happen to be in.
1736 (c-beginning-of-macro)
1737 (setq pos (c-literal-limits))
1738 (if pos (goto-char (car pos)))
1740 (setq where (c-where-wrt-brace-construct))
1743 ;; Move backwards to the } of a function
1745 (if (memq where '(at-header outwith-function))
1746 (setq arg (1+ arg)))
1748 (c-while-widening-to-decl-block
1749 (< (setq arg (- (c-backward-to-nth-BOF-{ (- arg) where))) 0)))
1751 (c-while-widening-to-decl-block
1752 (progn (c-syntactic-skip-backward "^}")
1753 (not (eq (char-before) ?}))))))
1755 ;; Move forward to the } of a function
1757 (c-while-widening-to-decl-block
1758 (> (setq arg (c-forward-to-nth-EOF-} arg where)) 0))))
1760 ;; Do we need to move forward from the brace to the semicolon?
1762 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1763 (c-syntactic-re-search-forward ";"))
1766 ;; We're there now, modulo comments and whitespace.
1767 ;; Try to be line oriented; position point after the next
1768 ;; newline that isn't inside a comment, but if we hit the
1769 ;; next declaration then we use the current point instead.
1770 (while (and (not (bolp))
1771 (not (looking-at "\\s *$"))
1772 (c-forward-single-comment)))
1774 ((looking-at "\\s *$")
1779 (c-keep-region-active)
1782 (defun c-defun-name ()
1783 "Return the name of the current defun, or NIL if there isn't one.
1784 \"Defun\" here means a function, or other top level construct
1785 with a brace block."
1787 (c-save-buffer-state
1788 (beginning-of-defun-function end-of-defun-function
1789 where pos name-end case-fold-search)
1794 ;; Move back out of any macro/comment/string we happen to be in.
1795 (c-beginning-of-macro)
1796 (setq pos (c-literal-limits))
1797 (if pos (goto-char (car pos)))
1799 (setq where (c-where-wrt-brace-construct))
1801 ;; Move to the beginning of the current defun, if any, if we're not
1803 (if (eq where 'outwith-function)
1805 (unless (eq where 'at-header)
1806 (c-backward-to-nth-BOF-{ 1 where)
1807 (c-beginning-of-decl-1))
1809 ;; Pick out the defun name, according to the type of defun.
1811 ;; struct, union, enum, or similar:
1812 ((and (looking-at c-type-prefix-key)
1813 (progn (c-forward-token-2 2) ; over "struct foo "
1814 (or (eq (char-after) ?\{)
1815 (looking-at c-symbol-key)))) ; "struct foo bar ..."
1816 (save-match-data (c-forward-token-2))
1817 (when (eq (char-after) ?\{)
1818 (c-backward-token-2)
1819 (looking-at c-symbol-key))
1820 (match-string-no-properties 0))
1822 ((looking-at "DEFUN\\s-*(") ;"DEFUN\\_>") think of XEmacs!
1823 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1824 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1826 (c-forward-syntactic-ws)
1827 (when (eq (char-after) ?\")
1829 (c-forward-token-2)) ; over the comma and following WS.
1830 (buffer-substring-no-properties
1834 (when (looking-at ":") ; CLISP: DEFUN(PACKAGE:LISP-SYMBOL,...)
1835 (skip-chars-forward "^,"))
1836 (c-backward-syntactic-ws)
1839 ((looking-at "DEF[a-zA-Z0-9_]* *( *\\([^, ]*\\) *,")
1840 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1841 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1842 (match-string-no-properties 1))
1845 ((assq 'objc-method-intro (c-guess-basic-syntax))
1846 (let ((bound (save-excursion (c-end-of-statement) (point)))
1847 (kw-re (concat "\\(?:" c-symbol-key "\\)?:"))
1849 (when (c-syntactic-re-search-forward c-symbol-key bound t t t)
1850 (push (match-string-no-properties 0) stretches)
1851 (while (c-syntactic-re-search-forward kw-re bound t t t)
1852 (push (match-string-no-properties 0) stretches)))
1853 (apply 'concat (nreverse stretches))))
1856 ;; Normal function or initializer.
1857 (when (c-syntactic-re-search-forward "[{(]" nil t)
1859 (c-backward-syntactic-ws)
1860 (when (eq (char-before) ?\=) ; struct foo bar = {0, 0} ;
1861 (c-backward-token-2)
1862 (c-backward-syntactic-ws))
1863 (setq name-end (point))
1864 (c-backward-token-2)
1865 (buffer-substring-no-properties (point) name-end)))))))))
1867 (defun c-declaration-limits (near)
1868 ;; Return a cons of the beginning and end positions of the current
1869 ;; top level declaration or macro. If point is not inside any then
1870 ;; nil is returned, unless NEAR is non-nil in which case the closest
1871 ;; following one is chosen instead (if there is any). The end
1872 ;; position is at the next line, providing there is one before the
1875 ;; This function might do hidden buffer changes.
1878 (when (eq c-defun-tactic 'go-outward)
1879 (c-narrow-to-most-enclosing-decl-block t) ; e.g. class, namespace
1880 (or (save-restriction
1881 (c-narrow-to-most-enclosing-decl-block nil)
1883 ;; Note: Some code duplication in `c-beginning-of-defun' and
1884 ;; `c-end-of-defun'.
1886 (let ((start (point))
1887 (paren-state (c-parse-state))
1890 (goto-char (c-least-enclosing-brace paren-state))
1891 ;; If we moved to the outermost enclosing paren
1892 ;; then we can use c-safe-position to set the
1893 ;; limit. Can't do that otherwise since the
1894 ;; earlier paren pair on paren-state might very
1895 ;; well be part of the declaration we should go
1897 (setq lim (c-safe-position (point) paren-state))
1899 ;; At top level. Make sure we aren't inside a literal.
1900 (setq pos (c-literal-limits
1901 (c-safe-position (point) paren-state)))
1902 (if pos (goto-char (car pos))))
1904 (when (c-beginning-of-macro)
1913 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1915 ;; We moved back over the previous defun. Skip to the next
1916 ;; one. Not using c-forward-syntactic-ws here since we
1917 ;; should not skip a macro. We can also be directly after
1918 ;; the block in a `c-opt-block-decls-with-vars-key'
1919 ;; declaration, but then we won't move significantly far
1922 (c-forward-comments)
1924 (when (and near (c-beginning-of-macro))
1932 (if (eobp) (throw 'exit nil))
1934 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1935 ;; declaration that doesn't end there. We're searching back and
1936 ;; forth over the block here, which can be expensive.
1938 (if (and c-opt-block-decls-with-vars-key
1940 (c-backward-syntactic-ws)
1941 (eq (char-before) ?}))
1942 (eq (car (c-beginning-of-decl-1))
1946 (and (> (point) pos)
1947 (setq end-pos (point)))))
1951 (if (and (not near) (> (point) start))
1954 ;; Try to be line oriented; position the limits at the
1955 ;; closest preceding boi, and after the next newline, that
1956 ;; isn't inside a comment, but if we hit a neighboring
1957 ;; declaration then we instead use the exact declaration
1958 ;; limit in that direction.
1961 (while (and (/= (point) (c-point 'boi))
1962 (c-backward-single-comment)))
1963 (if (/= (point) (c-point 'boi))
1971 (while (and (not (bolp))
1972 (not (looking-at "\\s *$"))
1973 (c-forward-single-comment)))
1976 ((looking-at "\\s *$")
1982 (goto-char (point-min))
1983 (c-forward-decl-or-cast-1 -1 nil nil)
1984 (eq (char-after) ?\{)
1985 (cons (point-min) (point-max))))))))
1987 (defun c-mark-function ()
1988 "Put mark at end of the current top-level declaration or macro, point at beginning.
1989 If point is not inside any then the closest following one is
1990 chosen. Each successive call of this command extends the marked
1991 region by one function.
1993 A mark is left where the command started, unless the region is already active
1994 \(in Transient Mark mode).
1996 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1997 function does not require the declaration to contain a brace block."
2000 (let (decl-limits case-fold-search)
2001 (c-save-buffer-state nil
2002 ;; We try to be line oriented, unless there are several
2003 ;; declarations on the same line.
2004 (if (looking-at c-syntactic-eol)
2005 (c-backward-token-2 1 nil (c-point 'bol)))
2006 (setq decl-limits (c-declaration-limits t)))
2008 (if (not decl-limits)
2009 (error "Cannot find any declaration")
2010 (let* ((extend-region-p
2011 (and (eq this-command 'c-mark-function)
2012 (eq last-command 'c-mark-function)))
2013 (push-mark-p (and (eq this-command 'c-mark-function)
2014 (not extend-region-p)
2015 (not (c-region-is-active-p)))))
2016 (if push-mark-p (push-mark (point)))
2019 (exchange-point-and-mark)
2020 (setq decl-limits (c-declaration-limits t))
2021 (when (not decl-limits)
2022 (exchange-point-and-mark)
2023 (error "Cannot find any declaration"))
2024 (goto-char (cdr decl-limits))
2025 (exchange-point-and-mark))
2026 (goto-char (car decl-limits))
2027 (push-mark (cdr decl-limits) nil t))))))
2029 (defun c-cpp-define-name ()
2030 "Return the name of the current CPP macro, or NIL if we're not in one."
2032 (let (case-fold-search)
2034 (and c-opt-cpp-macro-define-start
2035 (c-beginning-of-macro)
2036 (looking-at c-opt-cpp-macro-define-start)
2037 (match-string-no-properties 1)))))
2040 ;; Movement by statements.
2041 (defun c-in-comment-line-prefix-p ()
2042 ;; Point is within a comment. Is it also within a comment-prefix?
2043 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2045 ;; This function might do hidden buffer changes.
2046 (let ((here (point)))
2049 (skip-chars-forward " \t")
2050 (and (looking-at c-current-comment-prefix)
2051 (/= (match-beginning 0) (match-end 0))
2052 (< here (match-end 0))))))
2054 (defun c-narrow-to-comment-innards (range)
2055 ;; Narrow to the "inside" of the comment (block) defined by range, as
2058 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2059 ;; present) removed. A c++-style line comment retains its opening "//" but
2060 ;; has any final NL removed. If POINT is currently outwith these innards,
2061 ;; move it to the appropriate boundary.
2063 ;; This narrowing simplifies the sentence movement functions, since it
2064 ;; eliminates awkward things at the boundaries of the comment (block).
2066 ;; This function might do hidden buffer changes.
2067 (let* ((lit-type (c-literal-type range))
2068 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
2069 (end (if (eq lit-type 'c)
2070 (if (and (eq (char-before (cdr range)) ?/)
2071 (eq (char-before (1- (cdr range))) ?*))
2074 (if (eq (cdr range) (point-max))
2076 (- (cdr range) 1)))))
2078 (goto-char end)) ; This would be done automatically by ...
2080 (goto-char beg)) ; ... narrow-to-region but is not documented.
2081 (narrow-to-region beg end)))
2083 (defun c-beginning-of-sentence-in-comment (range)
2084 ;; Move backwards to the "beginning of a sentence" within the comment
2085 ;; defined by RANGE, a cons of its starting and ending positions. If we
2086 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2087 ;; of the comment and return T.
2089 ;; The BOS is either text which follows a regexp match of sentence-end,
2090 ;; or text which is a beginning of "paragraph".
2091 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2093 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2094 ;; It is not a general function, but is intended only for calling from
2095 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2097 ;; This function might do hidden buffer changes.
2099 (let ((start-point (point)))
2101 (c-narrow-to-comment-innards range) ; This may move point back.
2102 (let* ((here (point))
2104 (here-filler ; matches WS and comment-prefixes at point.
2105 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
2106 "\\|[ \t\n\r\f]\\)*"))
2107 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
2108 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
2109 ;; First, find the previous paragraph start, if any.
2110 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
2112 (forward-paragraph -1) ; uses cc-mode values of
2113 ; paragraph-\(start\|separate\)
2114 (if (> (re-search-forward here-filler nil t) here)
2116 (when (>= (point) here)
2117 (forward-paragraph -2)
2118 (if (> (re-search-forward here-filler nil t) here)
2122 ;; Now seek successively earlier sentence ends between PAR-BEG and
2123 ;; HERE, until the "start of sentence" following it is earlier than
2124 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2125 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
2127 (goto-char (match-end 0)) ; tentative beginning of sentence
2128 (or (>= (point) here)
2129 (and (not (bolp)) ; Found a non-blank comment-prefix?
2131 (if (re-search-backward prefix-at-bol-here nil t)
2132 (/= (match-beginning 1) (match-end 1)))))
2133 (progn ; Skip the crud to find a real b-o-s.
2134 (if (c-in-comment-line-prefix-p)
2135 (beginning-of-line))
2136 (re-search-forward here-filler) ; always succeeds.
2137 (>= (point) here))))
2139 (re-search-forward here-filler)))
2141 (if (< (point) start-point)
2143 (goto-char (car range))
2146 (defun c-end-of-sentence-in-comment (range)
2147 ;; Move forward to the "end of a sentence" within the comment defined by
2148 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2149 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2150 ;; return NIL. Otherwise, move point to just after the end of the comment
2153 ;; The EOS is just after the non-WS part of the next match of the regexp
2154 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2155 ;; no sentence-end match following point, any WS before the end of the
2156 ;; comment will count as EOS, providing we're not already in it.
2158 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2159 ;; It is not a general function, but is intended only for calling from
2160 ;; c-move-over-sentence.
2162 ;; This function might do hidden buffer changes.
2164 (let ((start-point (point))
2165 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2168 (c-narrow-to-comment-innards range) ; This might move point forwards.
2169 (let* ((here (point))
2170 (par-end ; EOL position of last text in current/next paragraph.
2172 ;; The cc-mode values of paragraph-\(start\|separate\), set
2173 ;; in c-setup-paragraph-variables, are used in the
2175 (forward-paragraph 1)
2176 (if (eq (preceding-char) ?\n) (forward-char -1))
2177 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
2179 (forward-paragraph 2)
2180 (if (eq (preceding-char) ?\n) (forward-char -1)))
2185 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
2186 ;; Go forward one "comment-prefix which looks like sentence-end"
2187 ;; each time round the following:
2188 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
2191 (skip-chars-backward " \t\n")
2192 (or (and (not (bolp))
2193 (re-search-backward prefix-at-bol-here nil t)
2194 (/= (match-beginning 1) (match-end 1)))
2195 (<= (point) here))))
2198 ;; Take special action if we're up against the end of a comment (of
2199 ;; either sort): Leave point just after the last non-ws text.
2200 (if (eq (point) (point-max))
2201 (while (or (/= (skip-chars-backward " \t\n") 0)
2202 (and (re-search-backward prefix-at-bol-here nil t)
2203 (/= (match-beginning 1) (match-end 1))))))))
2205 (if (> (point) start-point)
2207 (goto-char (cdr range))
2210 (defun c-beginning-of-sentence-in-string (range)
2211 ;; Move backwards to the "beginning of a sentence" within the string defined
2212 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2213 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2214 ;; just before the start of the string and return T.
2216 ;; The BOS is either the text which follows a regexp match of sentence-end
2217 ;; or text which is a beginning of "paragraph". For the purposes of
2218 ;; determining paragraph boundaries, escaped newlines are treated as
2219 ;; ordinary newlines.
2221 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2222 ;; It is not a general function, but is intended only for calling from
2223 ;; c-move-over-sentence.
2225 ;; This function might do hidden buffer changes.
2227 (let* ((here (point)) last
2228 (end (1- (cdr range)))
2229 (here-filler ; matches WS and escaped newlines at point.
2230 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2231 ;; Enhance paragraph-start and paragraph-separate also to recognize
2232 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2233 ;; these values should be customizable user options, or something.
2234 (paragraph-start c-string-par-start)
2235 (paragraph-separate c-string-par-separate)
2237 (par-beg ; beginning of current (or previous) paragraph.
2240 (narrow-to-region (1+ (car range)) end)
2241 (forward-paragraph -1) ; uses above values of
2242 ; paragraph-\(start\|separate\)
2243 (if (> (re-search-forward here-filler nil t) here)
2245 (when (>= (point) here)
2246 (forward-paragraph -2)
2247 (if (> (re-search-forward here-filler nil t) here)
2250 ;; Now see if we can find a sentence end after PAR-BEG.
2251 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2253 (goto-char (match-end 0))
2257 here-filler end t) ; always succeeds. Use end rather
2258 ; than here, in case point starts
2259 ; beyond the closing quote.
2260 (>= (point) here))))
2262 (re-search-forward here-filler here t)
2263 (if (< (point) here)
2265 (goto-char (car range))
2268 (defun c-end-of-sentence-in-string (range)
2269 ;; Move forward to the "end of a sentence" within the string defined by
2270 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2271 ;; return NIL. Otherwise, move point to just after the end of the string
2274 ;; The EOS is just after the non-WS part of the next match of the regexp
2275 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2276 ;; no sentence-end match following point, any WS before the end of the
2277 ;; string will count as EOS, providing we're not already in it.
2279 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2280 ;; It is not a general function, but is intended only for calling from
2281 ;; c-move-over-sentence.
2283 ;; This function might do hidden buffer changes.
2285 (let* ((here (point))
2287 ;; Enhance paragraph-start and paragraph-separate to recognize
2288 ;; blank lines terminated by escaped EOLs.
2289 (paragraph-start c-string-par-start)
2290 (paragraph-separate c-string-par-separate)
2292 (par-end ; EOL position of last text in current/next paragraph.
2295 (narrow-to-region (car range) (1- (cdr range)))
2296 ;; The above values of paragraph-\(start\|separate\) are used
2297 ;; in the following.
2298 (forward-paragraph 1)
2300 ;; (re-search-backward filler-here nil t) would find an empty
2301 ;; string. Therefore we simulate it by the following:
2302 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2303 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2304 (unless (> (point) here)
2306 (forward-paragraph 1)
2307 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2308 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2310 ;; Try to go forward a sentence.
2311 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2313 (while (or (/= (skip-chars-backward " \t\n") 0)
2314 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2315 ;; Did we move a sentence, or did we hit the end of the string?
2316 (if (> (point) here)
2318 (goto-char (cdr range))
2321 (defun c-ascertain-preceding-literal ()
2322 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2323 ;; If a literal is the next thing (aside from whitespace) to be found before
2324 ;; point, return a cons of its start.end positions (enclosing the
2325 ;; delimiters). Otherwise return NIL.
2327 ;; This function might do hidden buffer changes.
2329 (c-collect-line-comments
2330 (let ((here (point))
2332 (if (c-backward-single-comment)
2333 (cons (point) (progn (c-forward-single-comment) (point)))
2335 ;; to prevent `looking-at' seeing a " at point.
2336 (narrow-to-region (point-min) here)
2339 ;; An EOL can act as an "open string" terminator in AWK.
2340 (looking-at c-ws*-string-limit-regexp)
2342 (progn (backward-char)
2343 (looking-at c-string-limit-regexp))))
2344 (goto-char (match-end 0)) ; just after the string terminator.
2346 (c-safe (c-backward-sexp 1) ; move back over the string.
2347 (cons (point) pos)))))))))
2349 (defun c-ascertain-following-literal ()
2350 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2351 ;; If a literal is the next thing (aside from whitespace) following point,
2352 ;; return a cons of its start.end positions (enclosing the delimiters).
2353 ;; Otherwise return NIL.
2355 ;; This function might do hidden buffer changes.
2357 (c-collect-line-comments
2360 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2361 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2364 (if (c-forward-single-comment)
2365 (cons pos (point))))))))
2367 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2368 ;; Does point immediately follow a statement "terminator"? A virtual
2369 ;; semicolon is regarded here as such. So is an opening brace ;-)
2371 ;; This function might do hidden buffer changes.
2374 (and (looking-at "[;{}]")
2375 (not (and c-special-brace-lists ; Pike special brace lists.
2376 (eq (char-after) ?{)
2377 (c-looking-at-special-brace-list)))))
2379 ;; The following (for macros) is not strict about exactly where we are
2380 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2381 ;; much. ACM 2004/3/29.
2384 (if (c-beginning-of-macro)
2385 (setq eom (progn (c-end-of-macro)
2389 (c-forward-comments)
2390 (>= (point) eom))))))
2392 (defun c-back-over-illiterals (macro-start)
2393 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2394 ;; stopping before reaching BOB or a literal or the boundary of a
2395 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2396 ;; the position of the '#' beginning the current preprocessor directive, or
2397 ;; NIL if we're not in such.
2399 ;; Return a cons (A.B), where
2400 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2401 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2402 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2403 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2405 ;; The total collection of returned values is as follows:
2406 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2407 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2408 ;; a BOS - the caller must check this.
2409 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2410 ;; moved and reached the opening # of the macro.
2411 ;; (t . macro-boundary): Every other circumstance in which we're at a
2412 ;; macro-boundary. We might be at a BOS.
2414 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2415 ;; code before encountering the literal/BOB or macro-boundary.
2417 ;; Note that this function moves within either preprocessor commands
2418 ;; (macros) or normal code, but will not cross a boundary between the two,
2419 ;; or between two distinct preprocessor commands.
2421 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2422 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2423 ;; move into parens. Also stop before `#' when it's at boi on a line.
2425 ;; This function might do hidden buffer changes.
2427 (let ((here (point))
2428 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2429 ; semicolon precedes it.
2431 (while t ;; We go back one "token" each iteration of the loop.
2434 ;; Stop at the token after a comment.
2435 ((c-backward-single-comment) ; Also functions as backwards-ws.
2437 (throw 'done '(t . literal)))
2439 ;; If we've gone back over a LF, we might have moved into or out of
2440 ;; a preprocessor line.
2441 ((and (save-excursion
2443 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2445 (< (point) macro-start)
2446 (c-beginning-of-macro)))
2448 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2449 (throw 'done (cons (or (eq (point) here)
2453 ;; Have we found a virtual semicolon? If so, stop, unless the next
2454 ;; statement is where we started from.
2455 ((and (c-at-vsemi-p)
2457 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2459 (throw 'done '(nil . nil)))
2461 ;; Hit the beginning of the buffer/region?
2465 (throw 'done '(nil . nil)))
2467 ;; Move back a character.
2468 ((progn (backward-char) nil))
2470 ;; Stop at "{" (unless it's a PIKE special brace list.)
2471 ((eq (char-after) ?\{)
2472 (if (and c-special-brace-lists
2473 (c-looking-at-special-brace-list))
2474 (skip-syntax-backward "w_") ; Speedup only.
2477 (throw 'done '(nil . nil))))
2479 ;; Have we reached the start of a macro? This always counts as
2480 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2481 ;; here. FIXME!!! ACM 2004/3/29)
2482 ((and macro-start (eq (point) macro-start))
2483 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2485 ;; Stop at token just after "}" or ";".
2486 ((looking-at "[;}]")
2487 ;; If we've gone back over ;, {, or }, we're done.
2488 (if (or (= here last)
2489 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2490 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2491 (eq (char-after) ?\;))
2493 (goto-char last) ; To the statement starting after the ; or }.
2494 (throw 'done '(nil . nil))))
2496 ;; Stop at the token after a string.
2497 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2499 (throw 'done '(t . literal)))
2501 ;; Nothing special: go back word characters.
2502 (t (skip-syntax-backward "w_")) ; Speedup only.
2505 (defun c-forward-over-illiterals (macro-end allow-early-stop)
2506 ;; Move forwards over code, stopping before reaching EOB or a literal
2507 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2508 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2509 ;; terminates the current preprocessor directive, or NIL if we're not in
2512 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2513 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2514 ;; seems unavoidable. Depending on the context this function is called
2515 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2516 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2517 ;; semicolons, or anything else.
2519 ;; Return a cons (A.B), where
2520 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2521 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2522 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2523 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2525 ;; Point is left either after the end-of-statement, or at the last non-ws
2526 ;; code before encountering the literal, or the # of the preprocessor
2527 ;; statement, or at EOB [or just after last non-WS stuff??].
2529 ;; As a clarification of "after the end-of-statement", if a comment or
2530 ;; whitespace follows a completed AWK statement, that statement is treated
2531 ;; as ending just after the last non-ws character before the comment.
2533 ;; Note that this function moves within either preprocessor commands
2534 ;; (macros) or normal code, but not both within the same invocation.
2536 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2537 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2538 ;; stop before `{' if at top level or inside braces, though. Move by
2539 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2542 ;; This function might do hidden buffer changes.
2543 (let ((here (point))
2546 (while t ;; We go one "token" forward each time round this loop.
2549 ;; If we've moved forward to a virtual semicolon, we're done.
2550 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2552 (throw 'done '(nil . nil)))
2556 ;; Gone past the end of a macro?
2557 ((and macro-end (> (point) macro-end))
2559 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2561 ;; About to hit a comment?
2562 ((save-excursion (c-forward-single-comment))
2564 (throw 'done '(t . literal)))
2570 (throw 'done '(nil . nil)))
2572 ;; If we encounter a '{', stop just after the previous token.
2573 ((and (eq (char-after) ?{)
2574 (not (and c-special-brace-lists
2575 (c-looking-at-special-brace-list)))
2576 (or allow-early-stop (/= here last))
2577 (save-excursion ; Is this a check that we're NOT at top level?
2578 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2579 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2580 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2581 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2582 (or (not (c-safe (up-list -1) t))
2583 (= (char-after) ?{))))
2585 (throw 'done '(nil . nil)))
2587 ;; End of a PIKE special brace list? If so, step over it and continue.
2588 ((and c-special-brace-lists
2589 (eq (char-after) ?})
2591 (and (c-safe (up-list -1) t)
2592 (c-looking-at-special-brace-list))))
2594 (skip-syntax-forward "w_")) ; Speedup only.
2596 ;; Have we got a '}' after having moved? If so, stop after the
2598 ((and (eq (char-after) ?})
2601 (throw 'done '(nil . nil)))
2603 ;; Stop if we encounter a preprocessor line. Continue if we
2605 ((and c-opt-cpp-prefix
2607 (eq (char-after) ?#)
2608 (= (point) (c-point 'boi)))
2609 (if (= (point) here) ; Not a macro, therefore naked #.
2611 (throw 'done '(t . macro-boundary))))
2613 ;; Stop after a ';', '}', or "};"
2614 ((looking-at ";\\|};?")
2615 (goto-char (match-end 0))
2616 (throw 'done '(nil . nil)))
2618 ;; Found a string (this subsumes AWK regexps)?
2619 ((looking-at c-string-limit-regexp)
2621 (throw 'done '(t . literal)))
2624 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2625 (skip-syntax-forward "w_") ; Speedup only.
2626 (when (and macro-end (> (point) macro-end))
2628 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2631 (defun c-one-line-string-p (range)
2632 ;; Is the literal defined by RANGE a string contained in a single line?
2634 ;; This function might do hidden buffer changes.
2636 (goto-char (car range))
2637 (and (looking-at c-string-limit-regexp)
2638 (progn (skip-chars-forward "^\n" (cdr range))
2639 (eq (point) (cdr range))))))
2641 (defun c-beginning-of-statement (&optional count lim sentence-flag)
2642 "Go to the beginning of the innermost C statement.
2643 With prefix arg, go back N - 1 statements. If already at the
2644 beginning of a statement then go to the beginning of the closest
2645 preceding one, moving into nested blocks if necessary (use
2646 \\[backward-sexp] to skip over a block). If within or next to a
2647 comment or multiline string, move by sentences instead of statements.
2649 When called from a program, this function takes 3 optional args: the
2650 repetition count, a buffer position limit which is the farthest back
2651 to search for the syntactic context, and a flag saying whether to do
2652 sentence motion in or near comments and multiline strings.
2654 Note that for use in programs, `c-beginning-of-statement-1' is
2655 usually better. It has much better defined semantics than this one,
2656 which is intended for interactive use, and might therefore change to
2657 be more \"DWIM:ey\"."
2658 (interactive (list (prefix-numeric-value current-prefix-arg)
2661 (c-end-of-statement (- count) lim sentence-flag)
2662 (c-save-buffer-state
2663 ((count (or count 1))
2664 last ; start point for going back ONE chunk. Updated each chunk movement.
2666 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2667 res ; result from sub-function call
2668 not-bos ; "not beginning-of-statement"
2669 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2671 ;; Go back one statement at each iteration of the following loop.
2672 (while (and (/= count 0)
2673 (or (not lim) (> (point) lim)))
2674 ;; Go back one "chunk" each time round the following loop, stopping
2675 ;; when we reach a statement boundary, etc.
2678 (cond ; Each arm of this cond returns NIL on reaching a desired
2679 ; statement boundary, non-NIL otherwise.
2684 (range ; point is within or approaching a literal.
2686 ;; Single line string or sentence-flag is null => skip the
2688 ((or (null sentence-flag)
2689 (c-one-line-string-p range))
2690 (goto-char (car range))
2691 (setq range (c-ascertain-preceding-literal))
2692 ;; N.B. The following is essentially testing for an AWK regexp
2694 ;; Was the previous non-ws thing an end of statement?
2697 (c-backward-comments)
2698 (c-backward-syntactic-ws))
2699 (not (or (bobp) (c-after-statement-terminator-p)))))
2701 ;; Comment inside a statement or a multi-line string.
2702 (t (when (setq res ; returns non-nil when we go out of the literal
2703 (if (eq (c-literal-type range) 'string)
2704 (c-beginning-of-sentence-in-string range)
2705 (c-beginning-of-sentence-in-comment range)))
2706 (setq range (c-ascertain-preceding-literal)))
2709 ;; Non-literal code.
2710 (t (setq res (c-back-over-illiterals macro-fence))
2711 (setq not-bos ; "not reached beginning-of-statement".
2712 (or (= (point) last)
2713 (memq (char-after) '(?\) ?\}))
2716 ;; We're at a tentative BOS. The next form goes
2717 ;; back over WS looking for an end of previous
2719 (not (save-excursion
2721 (c-backward-comments)
2722 (c-backward-syntactic-ws))
2723 (or (bobp) (c-after-statement-terminator-p)))))))
2724 ;; Are we about to move backwards into or out of a
2725 ;; preprocessor command? If so, locate its beginning.
2726 (when (eq (cdr res) 'macro-boundary)
2731 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2733 ;; Are we about to move backwards into a literal?
2734 (when (memq (cdr res) '(macro-boundary literal))
2735 (setq range (c-ascertain-preceding-literal)))
2737 (setq last (point)))
2739 (if (/= count 0) (setq count (1- count))))
2740 (c-keep-region-active))))
2742 (defun c-end-of-statement (&optional count lim sentence-flag)
2743 "Go to the end of the innermost C statement.
2744 With prefix arg, go forward N - 1 statements. Move forward to the end
2745 of the next statement if already at end, and move into nested blocks
2746 \(use \\[forward-sexp] to skip over a block). If within or next to a
2747 comment or multiline string, move by sentences instead of statements.
2749 When called from a program, this function takes 3 optional args: the
2750 repetition count, a buffer position limit which is the farthest back
2751 to search for the syntactic context, and a flag saying whether to do
2752 sentence motion in or near comments and multiline strings."
2753 (interactive (list (prefix-numeric-value current-prefix-arg)
2755 (setq count (or count 1))
2756 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2758 (c-save-buffer-state
2759 (here ; start point for going forward ONE statement. Updated each statement.
2762 (and (not (eobp)) (c-beginning-of-macro)
2763 (progn (c-end-of-macro) (point)))))
2765 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2767 ;; Go back/forward one statement at each iteration of the following loop.
2768 (while (and (/= count 0)
2769 (or (not lim) (< (point) lim)))
2770 (setq here (point)) ; ONLY HERE is HERE updated
2772 ;; Go forward one "chunk" each time round the following loop, stopping
2773 ;; when we reach a statement boundary, etc.
2775 (cond ; Each arm of this cond returns NIL on reaching a desired
2776 ; statement boundary, non-NIL otherwise.
2781 (range ; point is within a literal.
2783 ;; sentence-flag is null => skip the entire literal.
2784 ;; or a Single line string.
2785 ((or (null sentence-flag)
2786 (c-one-line-string-p range))
2787 (goto-char (cdr range))
2788 (setq range (c-ascertain-following-literal))
2789 ;; Is there a virtual semicolon here (e.g. for AWK)?
2790 (not (c-at-vsemi-p)))
2792 ;; Comment or multi-line string.
2793 (t (when (setq res ; gets non-nil when we go out of the literal
2794 (if (eq (c-literal-type range) 'string)
2795 (c-end-of-sentence-in-string range)
2796 (c-end-of-sentence-in-comment range)))
2797 (setq range (c-ascertain-following-literal)))
2798 ;; If we've just come forward out of a literal, check for
2799 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2800 ;; some other language may do in the future)
2802 (not (c-at-vsemi-p))))))
2804 ;; Non-literal code.
2805 (t (setq res (c-forward-over-illiterals macro-fence
2807 ;; Are we about to move forward into or out of a
2808 ;; preprocessor command?
2809 (when (eq (cdr res) 'macro-boundary)
2816 (progn (c-skip-ws-forward)
2817 (c-beginning-of-macro))
2818 (progn (c-end-of-macro)
2821 (c-beginning-of-macro)
2822 (progn (c-end-of-macro) (point)))))))
2823 ;; Are we about to move forward into a literal?
2824 (when (memq (cdr res) '(macro-boundary literal))
2825 (setq range (c-ascertain-following-literal)))
2828 (if (/= count 0) (setq count (1- count))))
2829 (c-keep-region-active))))
2832 ;; set up electric character functions to work with pending-del,
2833 ;; (a.k.a. delsel) mode. All symbols get the t value except
2834 ;; the functions which delete, which gets 'supersede, and (from Emacs
2835 ;; 25) `c-electric-brace' and `c-electric-paren' get special handling
2836 ;; so as to work gracefully with `electric-pair-mode'.
2840 (put sym 'delete-selection t) ; for delsel (Emacs)
2841 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2845 c-electric-semi&comma
2851 (put sym 'delete-selection (if (fboundp 'delete-selection-uses-region-p)
2852 'delete-selection-uses-region-p
2854 (put sym 'pending-delete t)))
2857 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2858 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2859 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2860 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
2861 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2862 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
2865 ;; Inserting/indenting comments
2866 (defun c-calc-comment-indent (entry)
2867 ;; This function might do hidden buffer changes.
2869 (setq entry (or (assq entry c-indent-comment-alist)
2870 (assq 'other c-indent-comment-alist)
2871 '(default . (column . nil)))))
2872 (let ((action (car (cdr entry)))
2873 (value (cdr (cdr entry)))
2874 (col (current-column)))
2875 (cond ((eq action 'space)
2877 ((eq action 'column)
2878 (unless value (setq value comment-column))
2880 ;; Do not pad with one space if we're at bol.
2882 (max (1+ col) value)))
2888 (let ((lim (c-literal-limits (c-point 'bol) t)))
2890 (goto-char (car lim))
2891 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2892 ;; Found comment to align with.
2894 ;; Do not pad with one space if we're at bol.
2896 (max (1+ col) (current-column))))))))
2897 ;; Recurse to handle value as a new spec.
2898 (c-calc-comment-indent (cdr entry)))))))
2900 (defun c-comment-indent ()
2901 "Used by `indent-for-comment' to create and indent comments.
2902 See `c-indent-comment-alist' for a description."
2905 (c-save-buffer-state
2906 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
2907 (or (when (consp lim)
2908 (goto-char (car lim))
2909 (when (looking-at "/[/*]")
2910 (skip-chars-backward " \t")
2913 (skip-chars-backward " \t")
2916 (cond ((looking-at "^/[/*]")
2918 ((progn (beginning-of-line)
2921 ((progn (back-to-indentation)
2922 (and (eq (char-after) ?})
2923 (eq (point) (1- eot))))
2925 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2926 (eq (match-end 0) eot))
2931 (if (and (memq line-type '(anchored-comment empty-line))
2932 c-indent-comments-syntactically-p)
2933 (let ((c-syntactic-context (c-guess-basic-syntax)))
2934 ;; BOGOSITY ALERT: if we're looking at the eol, its
2935 ;; because indent-for-comment hasn't put the comment-start
2936 ;; in the buffer yet. this will screw up the syntactic
2937 ;; analysis so we kludge in the necessary info. Another
2938 ;; kludge is that if we're at the bol, then we really want
2939 ;; to ignore any anchoring as specified by
2940 ;; c-comment-only-line-offset since it doesn't apply here.
2942 (c-add-syntax 'comment-intro))
2943 (let ((c-comment-only-line-offset
2944 (if (consp c-comment-only-line-offset)
2945 c-comment-only-line-offset
2946 (cons c-comment-only-line-offset
2947 c-comment-only-line-offset))))
2948 (c-get-syntactic-indentation c-syntactic-context)))
2950 (c-calc-comment-indent line-type)))))
2953 ;; used by outline-minor-mode
2954 (defun c-outline-level ()
2955 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2956 ;; in otherwise-hidden text.
2958 (skip-chars-forward "\t ")
2962 ;; Movement by CPP conditionals.
2963 (defun c-up-conditional (count)
2964 "Move back to the containing preprocessor conditional, leaving mark behind.
2965 A prefix argument acts as a repeat count. With a negative argument,
2966 move forward to the end of the containing preprocessor conditional.
2968 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2969 function stops at them when going backward, but not when going
2972 (let ((new-point (c-scan-conditionals (- count) -1)))
2974 (goto-char new-point))
2975 (c-keep-region-active))
2977 (defun c-up-conditional-with-else (count)
2978 "Move back to the containing preprocessor conditional, including \"#else\".
2979 Just like `c-up-conditional', except it also stops at \"#else\"
2982 (let ((new-point (c-scan-conditionals (- count) -1 t)))
2984 (goto-char new-point))
2985 (c-keep-region-active))
2987 (defun c-down-conditional (count)
2988 "Move forward into the next preprocessor conditional, leaving mark behind.
2989 A prefix argument acts as a repeat count. With a negative argument,
2990 move backward into the previous preprocessor conditional.
2992 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2993 function stops at them when going forward, but not when going
2996 (let ((new-point (c-scan-conditionals count 1)))
2998 (goto-char new-point))
2999 (c-keep-region-active))
3001 (defun c-down-conditional-with-else (count)
3002 "Move forward into the next preprocessor conditional, including \"#else\".
3003 Just like `c-down-conditional', except it also stops at \"#else\"
3006 (let ((new-point (c-scan-conditionals count 1 t)))
3008 (goto-char new-point))
3009 (c-keep-region-active))
3011 (defun c-backward-conditional (count &optional target-depth with-else)
3012 "Move back across a preprocessor conditional, leaving mark behind.
3013 A prefix argument acts as a repeat count. With a negative argument,
3014 move forward across a preprocessor conditional.
3016 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3017 and have the same meanings as in `c-scan-conditionals'. If you
3018 are calling c-forward-conditional from a program, you might want
3019 to call `c-scan-conditionals' directly instead."
3021 (let ((new-point (c-scan-conditionals (- count) target-depth with-else)))
3023 (goto-char new-point))
3024 (c-keep-region-active))
3026 (defun c-forward-conditional (count &optional target-depth with-else)
3027 "Move forward across a preprocessor conditional, leaving mark behind.
3028 A prefix argument acts as a repeat count. With a negative argument,
3029 move backward across a preprocessor conditional.
3031 If there aren't enough conditionals after \(or before) point, an
3034 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
3035 the nesting level isn't changed when tracking subconditionals.
3037 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3038 and have the same meanings as in `c-scan-conditionals'. If you
3039 are calling c-forward-conditional from a program, you might want
3040 to call `c-scan-conditionals' directly instead."
3042 (let ((new-point (c-scan-conditionals count target-depth with-else)))
3044 (goto-char new-point)))
3046 (defun c-scan-conditionals (count &optional target-depth with-else)
3047 "Scan forward across COUNT preprocessor conditionals.
3048 With a negative argument, scan backward across preprocessor
3049 conditionals. Return the end position. Point is not moved.
3051 If there aren't enough preprocessor conditionals, throw an error.
3053 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
3054 the nesting level isn't changed when tracking subconditionals.
3056 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3057 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3058 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3061 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
3062 are treated as conditional clause limits. Normally they are ignored."
3063 (let* ((forward (> count 0))
3064 (increment (if forward -1 1))
3065 (search-function (if forward 're-search-forward 're-search-backward))
3066 new case-fold-search)
3067 (unless (integerp target-depth)
3068 (setq target-depth (if target-depth -1 0)))
3072 ;; subdepth is the depth in "uninteresting" subtrees,
3073 ;; i.e. those that takes us farther from the target
3074 ;; depth instead of closer.
3078 ;; Find the "next" significant line in the proper direction.
3079 (while (and (not found)
3080 ;; Rather than searching for a # sign that
3081 ;; comes at the beginning of a line aside from
3082 ;; whitespace, search first for a string
3083 ;; starting with # sign. Then verify what
3084 ;; precedes it. This is faster on account of
3085 ;; the fastmap feature of the regexp matcher.
3086 (funcall search-function
3087 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
3090 ;; Now verify it is really a preproc line.
3091 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
3092 (let (dchange (directive (match-string 1)))
3093 (cond ((string= directive "if")
3094 (setq dchange (- increment)))
3095 ((string= directive "endif")
3096 (setq dchange increment))
3098 ;; When we're not in an "uninteresting"
3099 ;; subtree, we might want to act on "elif"
3101 (if (cond (with-else
3102 ;; Always move toward the target depth.
3104 (if (> target-depth 0) 1 -1)))
3105 ((string= directive "elif")
3106 (setq dchange (- increment))))
3107 ;; Ignore the change if it'd take us
3108 ;; into an "uninteresting" subtree.
3109 (if (eq (> dchange 0) (<= target-depth 0))
3110 (setq dchange nil)))))
3112 (when (or (/= subdepth 0)
3113 (eq (> dchange 0) (<= target-depth 0)))
3114 (setq subdepth (+ subdepth dchange)))
3115 (setq depth (+ depth dchange))
3116 ;; If we are trying to move across, and we find an
3117 ;; end before we find a beginning, get an error.
3118 (if (and (< depth target-depth) (< dchange 0))
3120 "No following conditional at this level"
3121 "No previous conditional at this level"))))
3122 ;; When searching forward, start from next line so
3123 ;; that we don't find the same line again.
3124 (if forward (forward-line 1))
3125 ;; We found something if we've arrived at the
3127 (if (and dchange (= depth target-depth))
3128 (setq found (point))))
3130 (if forward (forward-line 1)))))
3132 (error "No containing preprocessor conditional"))
3133 (goto-char (setq new found)))
3134 (setq count (+ count increment))))
3135 (c-keep-region-active)
3139 ;; commands to indent lines, regions, defuns, and expressions
3140 (defun c-indent-command (&optional arg)
3141 "Indent current line as C code, and/or insert some whitespace.
3143 If `c-tab-always-indent' is t, always just indent the current line.
3144 If nil, indent the current line only if point is at the left margin or
3145 in the line's indentation; otherwise insert some whitespace[*]. If
3146 other than nil or t, then some whitespace[*] is inserted only within
3147 literals (comments and strings), but the line is always reindented.
3149 If `c-syntactic-indentation' is t, indentation is done according to
3150 the syntactic context. A numeric argument, regardless of its value,
3151 means indent rigidly all the lines of the expression starting after
3152 point so that this line becomes properly indented. The relative
3153 indentation among the lines of the expression is preserved.
3155 If `c-syntactic-indentation' is nil, the line is just indented one
3156 step according to `c-basic-offset'. In this mode, a numeric argument
3157 indents a number of such steps, positive or negative, and an empty
3158 prefix argument is equivalent to -1.
3160 [*] The amount and kind of whitespace inserted is controlled by the
3161 variable `c-insert-tab-function', which is called to do the actual
3162 insertion of whitespace. Normally the function in this variable
3163 just inserts a tab character, or the equivalent number of spaces,
3164 depending on the variable `indent-tabs-mode'."
3167 (let ((indent-function
3168 (if c-syntactic-indentation
3169 (symbol-function 'indent-according-to-mode)
3171 (let ((c-macro-start c-macro-start)
3172 (steps (if (equal arg '(4))
3174 (prefix-numeric-value arg))))
3175 (c-shift-line-indentation (* steps c-basic-offset))
3176 (when (and c-auto-align-backslashes
3179 (eq (char-before) ?\\))
3180 (c-query-and-set-macro-start))
3181 ;; Realign the line continuation backslash if inside a macro.
3182 (c-backslash-region (point) (point) nil t)))
3184 (if (and c-syntactic-indentation arg)
3185 ;; If c-syntactic-indentation and got arg, always indent this
3186 ;; line as C and shift remaining lines of expression the same
3188 (let ((shift-amt (save-excursion
3189 (back-to-indentation)
3193 (setq shift-amt (- (save-excursion
3194 (back-to-indentation)
3198 (if (eq c-tab-always-indent t)
3199 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
3207 (indent-code-rigidly beg end shift-amt "#")))
3208 ;; Else use c-tab-always-indent to determine behavior.
3210 ;; CASE 1: indent when at column zero or in line's indentation,
3211 ;; otherwise insert a tab
3212 ((not c-tab-always-indent)
3214 (skip-chars-backward " \t")
3216 (funcall c-insert-tab-function)
3217 (funcall indent-function)))
3218 ;; CASE 2: just indent the line
3219 ((eq c-tab-always-indent t)
3220 (funcall indent-function))
3221 ;; CASE 3: if in a literal, insert a tab, but always indent the
3224 (if (c-save-buffer-state () (c-in-literal))
3225 (funcall c-insert-tab-function))
3226 (funcall indent-function)
3229 (defun c-indent-exp (&optional shutup-p)
3230 "Indent each line in the balanced expression following point syntactically.
3231 If optional SHUTUP-P is non-nil, no errors are signaled if no
3232 balanced expression is found."
3234 (let ((here (point-marker))
3236 (set-marker-insertion-type here t)
3238 (let ((start (save-restriction
3239 ;; Find the closest following open paren that
3240 ;; ends on another line.
3241 (narrow-to-region (point-min) (c-point 'eol))
3242 (let (beg (end (point)))
3243 (while (and (setq beg (c-down-list-forward end))
3244 (setq end (c-up-list-forward beg))))
3246 (eq (char-syntax (char-before beg)) ?\()
3251 (error "Cannot find start of balanced expression to indent"))
3253 (setq end (c-safe (scan-sexps (point) 1)))
3256 (error "Cannot find end of balanced expression to indent"))
3259 (c-indent-region (point) end)))))
3261 (set-marker here nil))))
3263 (defun c-indent-defun ()
3264 "Indent the current top-level declaration or macro syntactically.
3265 In the macro case this also has the effect of realigning any line
3266 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3268 (let ((here (point-marker)) decl-limits case-fold-search)
3271 (c-save-buffer-state nil
3272 ;; We try to be line oriented, unless there are several
3273 ;; declarations on the same line.
3274 (if (looking-at c-syntactic-eol)
3275 (c-backward-token-2 1 nil (c-point 'bol))
3276 (c-forward-token-2 0 nil (c-point 'eol)))
3277 (setq decl-limits (c-declaration-limits nil)))
3279 (c-indent-region (car decl-limits)
3280 (cdr decl-limits))))
3282 (set-marker here nil))))
3284 (defun c-indent-region (start end &optional quiet)
3285 "Indent syntactically every line whose first char is between START
3286 and END inclusive. If the optional argument QUIET is non-nil then no
3287 syntactic errors are reported, even if `c-report-syntactic-errors' is
3291 (skip-chars-backward " \t\n\r\f\v")
3294 ;; Advance to first nonblank line.
3296 (skip-chars-forward " \t\n\r\f\v")
3297 (setq start (point))
3299 (setq c-parsing-error
3300 (or (let ((endmark (copy-marker end))
3301 (c-parsing-error nil)
3302 ;; shut up any echo msgs on indiv lines
3303 (c-echo-syntactic-information-p nil)
3304 (ml-macro-start ; Start pos of multi-line macro.
3305 (and (c-save-buffer-state ()
3306 (save-excursion (c-beginning-of-macro)))
3307 (eq (char-before (c-point 'eol)) ?\\)
3309 (c-fix-backslashes nil)
3313 (c-progress-init start end 'c-indent-region)
3315 (while (and (bolp) ;; One line each time round the loop.
3317 (< (point) endmark))
3321 (unless (or (looking-at "\\s *$")
3322 (and ml-macro-start (looking-at "\\s *\\\\$")))
3323 ;; Get syntax and indent.
3324 (c-save-buffer-state nil
3325 (setq syntax (c-guess-basic-syntax)))
3326 (c-indent-line syntax t t))
3329 ;; End of current multi-line macro?
3330 (when (and c-auto-align-backslashes
3331 (not (eq (char-before (c-point 'eol)) ?\\)))
3332 ;; Fixup macro backslashes.
3333 (c-backslash-region ml-macro-start (c-point 'bonl) nil)
3334 (setq ml-macro-start nil))
3335 ;; New multi-line macro?
3336 (if (and (assq 'cpp-macro syntax)
3337 (eq (char-before (c-point 'eol)) ?\\))
3338 (setq ml-macro-start (point))))
3342 (if (and ml-macro-start c-auto-align-backslashes)
3343 (c-backslash-region ml-macro-start (c-point 'bopl) nil t)))
3344 (set-marker endmark nil)
3345 (c-progress-fini 'c-indent-region))
3346 (c-echo-parsing-error quiet))
3349 (defun c-fn-region-is-active-p ()
3350 ;; Function version of the macro for use in places that aren't
3351 ;; compiled, e.g. in the menus.
3352 (c-region-is-active-p))
3354 (defun c-indent-line-or-region (&optional arg region)
3355 "Indent active region, current line, or block starting on this line.
3356 In Transient Mark mode, when the region is active, reindent the region.
3357 Otherwise, with a prefix argument, rigidly reindent the expression
3358 starting on the current line.
3359 Otherwise reindent just the current line."
3361 (list current-prefix-arg (c-region-is-active-p)))
3363 (c-indent-region (region-beginning) (region-end))
3364 (c-indent-command arg)))
3366 ;; for progress reporting
3367 (defvar c-progress-info nil)
3369 (defun c-progress-init (start end context)
3372 ((not c-progress-interval))
3373 ;; Start the progress update messages. If this Emacs doesn't have
3374 ;; a built-in timer, just be dumb about it.
3375 ((not (fboundp 'current-time))
3376 (message "Indenting region... (this may take a while)"))
3377 ;; If progress has already been initialized, do nothing. otherwise
3378 ;; initialize the counter with a vector of:
3379 ;; [start end lastsec context]
3381 (t (setq c-progress-info (vector start
3385 (nth 1 (current-time))
3387 (message "Indenting region..."))
3390 (defun c-progress-update ()
3391 (if (not (and c-progress-info c-progress-interval))
3393 (let ((now (nth 1 (current-time)))
3394 (start (aref c-progress-info 0))
3395 (end (aref c-progress-info 1))
3396 (lastsecs (aref c-progress-info 2)))
3397 ;; should we update? currently, update happens every 2 seconds,
3398 ;; what's the right value?
3399 (if (< c-progress-interval (- now lastsecs))
3401 (message "Indenting region... (%d%% complete)"
3402 (floor (* 100.0 (- (point) start)) (- end start)))
3403 (aset c-progress-info 2 now)))
3406 (defun c-progress-fini (context)
3407 (if (not c-progress-interval)
3409 (if (or (eq context (aref c-progress-info 3))
3412 (set-marker (aref c-progress-info 1) nil)
3413 (setq c-progress-info nil)
3414 (message "Indenting region... done")))))
3418 ;;; This page handles insertion and removal of backslashes for C macros.
3420 (defun c-backslash-region (from to delete-flag &optional line-mode)
3421 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3422 With no argument, inserts backslashes and aligns existing backslashes.
3423 With an argument, deletes the backslashes. The backslash alignment is
3424 done according to the settings in `c-backslash-column',
3425 `c-backslash-max-column' and `c-auto-align-backslashes'.
3427 This function does not modify blank lines at the start of the region.
3428 If the region ends at the start of a line and the macro doesn't
3429 continue below it, the backslash (if any) at the end of the previous
3432 You can put the region around an entire macro definition and use this
3433 command to conveniently insert and align the necessary backslashes."
3434 (interactive "*r\nP")
3435 (let ((endmark (make-marker))
3436 ;; Keep the backslash trimming functions from changing the
3437 ;; whitespace around point, since in this case it's only the
3438 ;; position of point that tells the indentation of the line.
3439 (point-pos (if (save-excursion
3440 (skip-chars-backward " \t")
3441 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3444 column longest-line-col bs-col-after-end)
3447 (if (and (not line-mode) (bobp))
3448 ;; Nothing to do if to is at bob, since we should back up
3449 ;; and there's no line to back up to.
3451 (when (and (not line-mode) (bolp))
3452 ;; Do not back up the to line if line-mode is set, to make
3453 ;; e.g. c-newline-and-indent consistent regardless whether
3454 ;; the (newline) call leaves point at bol or not.
3459 (set-marker endmark (point))
3461 (c-delete-backslashes-forward endmark point-pos))
3462 ;; Set bs-col-after-end to the column of any backslash
3463 ;; following the region, or nil if there is none.
3464 (setq bs-col-after-end
3465 (and (progn (end-of-line)
3466 (eq (char-before) ?\\))
3467 (= (forward-line 1) 0)
3468 (progn (end-of-line)
3469 (eq (char-before) ?\\))
3470 (1- (current-column))))
3472 ;; Back up the to line if line-mode is set, since the line
3473 ;; after the newly inserted line break should not be
3474 ;; touched in c-newline-and-indent.
3475 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3476 (unless bs-col-after-end
3477 ;; Set bs-col-after-end to non-nil in any case, since we
3478 ;; do not want to delete the backslash at the last line.
3479 (setq bs-col-after-end t)))
3481 (not c-auto-align-backslashes))
3483 ;; Compute the smallest column number past the ends of all
3485 (setq longest-line-col 0)
3487 (if bs-col-after-end
3488 ;; Include one more line in the max column
3489 ;; calculation, since the to line will be backslashed
3493 (while (and (>= (point) from)
3495 (if (eq (char-before) ?\\)
3497 (skip-chars-backward " \t")
3498 (setq longest-line-col (max longest-line-col
3499 (1+ (current-column))))
3503 ;; Try to align with surrounding backslashes.
3506 (if (and (not (bobp))
3507 (progn (backward-char)
3508 (eq (char-before) ?\\)))
3510 (setq column (1- (current-column)))
3511 (if (numberp bs-col-after-end)
3512 ;; Both a preceding and a following backslash.
3513 ;; Choose the greatest of them.
3514 (setq column (max column bs-col-after-end)))
3516 ;; No preceding backslash. Try to align with one
3517 ;; following the region. Disregard the backslash at the
3518 ;; to line since it's likely to be bogus (e.g. when
3519 ;; called from c-newline-and-indent).
3520 (if (numberp bs-col-after-end)
3521 (setq column bs-col-after-end))
3522 ;; Don't modify blank lines at start of region.
3524 (while (and (< (point) to) (bolp) (eolp))
3526 (if (and column (< column longest-line-col))
3527 ;; Don't try to align with surrounding backslashes if
3528 ;; any line is too long.
3531 ;; Impose minimum limit and tab width alignment only if
3532 ;; we can't align with surrounding backslashes.
3533 (if (> (% longest-line-col tab-width) 0)
3534 (setq longest-line-col
3535 (* (/ (+ longest-line-col tab-width -1)
3538 (setq column (max c-backslash-column
3540 ;; Always impose maximum limit.
3541 (setq column (min column c-backslash-max-column)))
3542 (if bs-col-after-end
3543 ;; Add backslashes on all lines if the macro continues
3544 ;; after the to line.
3546 (set-marker endmark to)
3547 (c-append-backslashes-forward endmark column point-pos))
3548 ;; Add backslashes on all lines except the last, and
3549 ;; remove any on the last line.
3554 (set-marker endmark (1- (point)))))
3556 (c-append-backslashes-forward endmark column point-pos)
3557 ;; The function above leaves point on the line
3558 ;; following endmark.
3559 (set-marker endmark (point)))
3560 (set-marker endmark to))
3561 (c-delete-backslashes-forward endmark point-pos)))))
3562 (set-marker endmark nil)
3563 (if (markerp point-pos)
3564 (set-marker point-pos nil))))
3566 (defun c-append-backslashes-forward (to-mark column point-pos)
3567 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3571 (<= (point) to-mark)
3573 (let ((start (point)) (inserted nil) end col)
3575 (unless (eq (char-before) ?\\)
3578 (setq state (parse-partial-sexp
3579 start (point) nil nil state))
3581 (setq col (current-column))
3583 ;; Avoid unnecessary changes of the buffer.
3584 (cond ((and (not inserted) (nth 3 state))
3585 ;; Don't realign backslashes in string literals
3586 ;; since that would change them.
3593 (skip-chars-backward
3594 " \t" (if (>= (point) point-pos) point-pos))
3598 ((and (= col column)
3599 (memq (char-before) '(?\ ?\t))))
3603 (or (/= (skip-chars-backward
3604 " \t" (if (>= (point) point-pos) point-pos))
3606 (/= (char-after) ?\ )))
3607 (delete-region (point) end)
3608 (indent-to column 1)))
3610 (zerop (forward-line 1)))
3611 (bolp))) ; forward-line has funny behavior at eob.
3613 ;; Make sure there are backslashes with at least one space in
3617 (<= (point) to-mark)
3619 (let ((start (point)))
3621 (setq state (parse-partial-sexp
3622 start (point) nil nil state))
3624 (if (eq (char-before) ?\\)
3625 (unless (nth 3 state)
3627 (unless (and (memq (char-before) '(?\ ?\t))
3628 (/= (point) point-pos))
3631 (if (and (memq (char-before) '(?\ ?\t))
3632 (/= (point) point-pos))
3636 (zerop (forward-line 1)))
3637 (bolp)))))) ; forward-line has funny behavior at eob.
3639 (defun c-delete-backslashes-forward (to-mark point-pos)
3641 (and (<= (point) to-mark)
3644 (if (eq (char-before) ?\\)
3647 (progn (backward-char)
3648 (skip-chars-backward " \t" (if (>= (point) point-pos)
3651 (zerop (forward-line 1)))
3652 (bolp)))) ; forward-line has funny behavior at eob.
3656 ;;; Line breaking and paragraph filling.
3658 (defvar c-auto-fill-prefix t)
3659 (defvar c-lit-limits nil)
3660 (defvar c-lit-type nil)
3662 ;; The filling code is based on a simple theory; leave the intricacies
3663 ;; of the text handling to the currently active mode for that
3664 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3665 ;; possible to make them work correctly wrt the comment and string
3666 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3667 ;; to it, there's quite a lot of special cases to handle which makes
3668 ;; the code anything but simple. The intention is that it will work
3669 ;; with any well-written text filling package that preserves a fill
3672 ;; We temporarily mask comment starters and enders as necessary for
3673 ;; the filling code to do its job on a seemingly normal text block.
3674 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3675 ;; preserve it correctly (especially important when filling C++ style
3676 ;; line comments). By default, we set up and use adaptive-fill-mode,
3677 ;; which is standard in all supported Emacs flavors.
3679 (defun c-guess-fill-prefix (lit-limits lit-type)
3680 ;; Determine the appropriate comment fill prefix for a block or line
3681 ;; comment. Return a cons of the prefix string and the column where
3682 ;; it ends. If fill-prefix is set, it'll override. Note that this
3683 ;; function also uses the value of point in some heuristics.
3685 ;; This function might do hidden buffer changes.
3687 (let* ((here (point))
3688 (prefix-regexp (concat "[ \t]*\\("
3689 c-current-comment-prefix
3691 (comment-start-regexp (if (eq lit-type 'c++)
3693 comment-start-skip))
3694 prefix-line comment-prefix res comment-text-end)
3698 (setq res (cons fill-prefix
3699 ;; Ugly way of getting the column after the fill
3700 ;; prefix; it'd be nice with a current-column
3701 ;; that works on strings..
3702 (let ((start (point)))
3705 (insert-and-inherit "\n" fill-prefix)
3707 (delete-region start (point)))))))
3711 ;; Set fallback for comment-prefix if none is found.
3712 (setq comment-prefix "// "
3713 comment-text-end (cdr lit-limits))
3716 (if (> (point) (car lit-limits))
3717 ;; The current line is not the comment starter, so the
3718 ;; comment has more than one line, and it can therefore be
3719 ;; used to find the comment fill prefix.
3720 (setq prefix-line (point))
3722 (goto-char (car lit-limits))
3723 (if (and (= (forward-line 1) 0)
3724 (< (point) (cdr lit-limits)))
3725 ;; The line after the comment starter is inside the
3726 ;; comment, so we can use it.
3727 (setq prefix-line (point))
3729 ;; The comment is only one line. Take the comment prefix
3730 ;; from it and keep the indentation.
3731 (goto-char (car lit-limits))
3732 (if (looking-at prefix-regexp)
3733 (goto-char (match-end 0))
3735 (skip-chars-forward " \t"))
3738 (if (eq (c-point 'boi) (car lit-limits))
3739 ;; There is only whitespace before the comment
3740 ;; starter; take the prefix straight from this line.
3741 (setq str (buffer-substring-no-properties
3742 (c-point 'bol) (point))
3743 col (current-column))
3745 ;; There is code before the comment starter, so we
3746 ;; have to temporarily insert and indent a new line to
3747 ;; get the right space/tab mix in the indentation.
3748 (let ((prefix-len (- (point) (car lit-limits)))
3752 (goto-char (car lit-limits))
3753 (indent-to (prog1 (current-column)
3756 (forward-char prefix-len)
3757 (setq str (buffer-substring-no-properties
3758 (c-point 'bol) (point))
3759 col (current-column)))
3760 (delete-region (car lit-limits) tmp))))
3763 (if (or (string-match "\\s \\'" str) (not (eolp)))
3765 ;; The prefix ends the line with no whitespace
3766 ;; after it. Default to a single space.
3767 (cons (concat str " ") (1+ col))))
3771 (setq comment-text-end
3773 (goto-char (- (cdr lit-limits) 2))
3774 (if (looking-at "\\*/") (point) (cdr lit-limits))))
3778 (if (and (> (point) (car lit-limits))
3779 (not (and (looking-at "[ \t]*\\*/")
3780 (eq (cdr lit-limits) (match-end 0)))))
3781 ;; The current line is not the comment starter and
3782 ;; contains more than just the ender, so it's good enough
3783 ;; to be used for the comment fill prefix.
3784 (setq prefix-line (point))
3785 (goto-char (car lit-limits))
3787 (cond ((or (/= (forward-line 1) 0)
3788 (>= (point) (cdr lit-limits))
3789 (and (looking-at "[ \t]*\\*/")
3790 (eq (cdr lit-limits) (match-end 0)))
3791 (and (looking-at prefix-regexp)
3792 (<= (1- (cdr lit-limits)) (match-end 0))))
3793 ;; The comment is either one line or the next line contains
3794 ;; just the comment ender. In this case we have no
3795 ;; information about a suitable comment prefix, so we resort
3796 ;; to c-block-comment-prefix.
3797 (setq comment-prefix (or c-block-comment-prefix "")))
3800 ;; The point was on the comment opener line, so we might want
3801 ;; to treat this as a not yet closed comment.
3803 (if (and (match-beginning 1)
3804 (/= (match-beginning 1) (match-end 1)))
3805 ;; Above `prefix-regexp' matched a nonempty prefix on the
3806 ;; second line, so let's use it. Normally it should do
3807 ;; to set `prefix-line' and let the code below pick up
3808 ;; the whole prefix, but if there's no text after the
3809 ;; match then it will probably fall back to no prefix at
3810 ;; all if the comment isn't closed yet, so in that case
3811 ;; it's better to force use of the prefix matched now.
3812 (if (= (match-end 0) (c-point 'eol))
3813 (setq comment-prefix (match-string 1))
3814 (setq prefix-line (point)))
3816 ;; There's no nonempty prefix on the line after the
3817 ;; comment opener. If the line is empty, or if the
3818 ;; text on it has less or equal indentation than the
3819 ;; comment starter we assume it's an unclosed
3820 ;; comment starter, i.e. that
3821 ;; `c-block-comment-prefix' should be used.
3822 ;; Otherwise we assume it's a closed comment where
3823 ;; the prefix really is the empty string.
3824 ;; E.g. this is an unclosed comment:
3835 ;; (Looking for the presence of the comment closer
3836 ;; rarely works since it's probably the closer of
3837 ;; some comment further down when the comment
3838 ;; really is unclosed.)
3839 (if (<= (save-excursion (back-to-indentation)
3841 (save-excursion (goto-char (car lit-limits))
3843 (setq comment-prefix (or c-block-comment-prefix ""))
3844 (setq prefix-line (point)))))
3847 ;; Otherwise the line after the comment starter is good
3848 ;; enough to find the prefix in.
3849 (setq prefix-line (point))))
3851 (when comment-prefix
3852 ;; Haven't got the comment prefix on any real line that we
3853 ;; can take it from, so we have to temporarily insert
3854 ;; `comment-prefix' on a line and indent it to find the
3855 ;; correct column and the correct mix of tabs and spaces.
3857 (let (tmp-pre tmp-post)
3861 (goto-char (car lit-limits))
3862 (if (looking-at comment-start-regexp)
3863 (goto-char (min (match-end 0)
3866 (skip-chars-forward " \t"))
3868 (when (eq (char-syntax (char-before)) ?\ )
3869 ;; If there's ws on the current line, we'll use it
3870 ;; instead of what's ending comment-prefix.
3871 (setq comment-prefix
3872 (concat (substring comment-prefix
3876 (buffer-substring-no-properties
3878 (skip-chars-backward " \t")
3882 (setq tmp-pre (point-marker))
3884 ;; We insert an extra non-whitespace character
3885 ;; before the line break and after comment-prefix in
3886 ;; case it's "" or ends with whitespace.
3887 (insert-and-inherit "x\n" comment-prefix "x")
3888 (setq tmp-post (point-marker))
3890 (indent-according-to-mode)
3892 (goto-char (1- tmp-post))
3893 (cons (buffer-substring-no-properties
3894 (c-point 'bol) (point))
3898 (delete-region tmp-pre tmp-post)
3899 (set-marker tmp-pre nil)
3900 (set-marker tmp-post nil))))))))))
3902 (or res ; Found a good prefix above.
3905 ;; prefix-line is the bol of a line on which we should try
3906 ;; to find the prefix.
3907 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3910 (when (and (looking-at prefix-regexp)
3911 (<= (match-end 0) comment-text-end))
3912 (unless (eq (match-end 0) (c-point 'eol))
3913 ;; The match is fine if there's text after it.
3914 (throw 'found (cons (buffer-substring-no-properties
3915 (match-beginning 0) (match-end 0))
3916 (progn (goto-char (match-end 0))
3917 (current-column)))))
3919 ;; This match is better than nothing, so let's
3920 ;; remember it in case nothing better is found
3922 (setq fb-string (buffer-substring-no-properties
3923 (match-beginning 0) (match-end 0))
3924 fb-endpos (match-end 0)))
3928 ;; Search for a line which has text after the prefix
3929 ;; so that we get the proper amount of whitespace
3930 ;; after it. We start with the current line, then
3931 ;; search backwards, then forwards.
3933 (goto-char prefix-line)
3934 (when (and (funcall test-line)
3935 (or (/= (match-end 1) (match-end 0))
3936 ;; The whitespace is sucked up by the
3937 ;; first [ \t]* glob if the prefix is empty.
3938 (and (= (match-beginning 1) (match-end 1))
3939 (/= (match-beginning 0) (match-end 0)))))
3940 ;; If the current line doesn't have text but do
3941 ;; have whitespace after the prefix, we'll use it.
3942 (throw 'found (cons fb-string
3943 (progn (goto-char fb-endpos)
3944 (current-column)))))
3946 (if (eq lit-type 'c++)
3947 ;; For line comments we can search up to and
3948 ;; including the first line.
3949 (while (and (zerop (forward-line -1))
3950 (>= (point) (car lit-limits)))
3951 (funcall test-line))
3952 ;; For block comments we must stop before the
3954 (while (and (zerop (forward-line -1))
3955 (> (point) (car lit-limits)))
3956 (funcall test-line)))
3958 (goto-char prefix-line)
3959 (while (and (zerop (forward-line 1))
3960 (< (point) (cdr lit-limits)))
3961 (funcall test-line))
3963 (goto-char prefix-line)
3967 ;; A good line wasn't found, but at least we have a
3968 ;; fallback that matches the comment prefix regexp.
3969 (cond ((or (string-match "\\s \\'" fb-string)
3971 (goto-char fb-endpos)
3973 ;; There are ws or text after the prefix, so
3975 (cons fb-string (current-column)))
3978 ;; Check if there's any whitespace padding
3979 ;; on the comment start line that we can
3980 ;; use after the prefix.
3981 (goto-char (car lit-limits))
3982 (if (looking-at comment-start-regexp)
3983 (goto-char (match-end 0))
3985 (skip-chars-forward " \t"))
3987 (eq (char-syntax (char-before)) ?\ )))
3989 (setq fb-string (buffer-substring-no-properties
3991 (skip-chars-backward " \t")
3994 (goto-char fb-endpos)
3995 (skip-chars-backward " \t")
3997 (let ((tmp (point)))
3998 ;; Got to mess in the buffer once again to
3999 ;; ensure the column gets correct. :P
4002 (insert-and-inherit fb-string)
4003 (cons (buffer-substring-no-properties
4007 (delete-region tmp (point)))))
4010 ;; Last resort: Just add a single space after
4012 (cons (concat fb-string " ")
4013 (progn (goto-char fb-endpos)
4014 (1+ (current-column)))))))
4016 ;; The line doesn't match the comment prefix regexp.
4018 ;; We have a fallback for line comments that we must use.
4019 (cons (concat (buffer-substring-no-properties
4020 prefix-line (c-point 'boi))
4022 (progn (back-to-indentation)
4023 (+ (current-column) (length comment-prefix))))
4025 ;; Assume we are dealing with a "free text" block
4026 ;; comment where the lines doesn't have any comment
4027 ;; prefix at all and we should just fill it as
4032 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
4033 ;; Calls FUN with ARGS ar arguments while the current paragraph is
4034 ;; masked to allow adaptive filling to work correctly. That
4035 ;; includes narrowing the buffer and, if point is inside a comment,
4036 ;; masking the comment starter and ender appropriately.
4038 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4039 ;; The position of point is then less significant when doing masking
4042 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4043 ;; only if the point turns out to be inside a comment or a string.
4045 ;; Note that this function does not do any hidden buffer changes.
4048 ;; beg and end limit the region to narrow. end is a marker.
4050 ;; tmp-pre and tmp-post mark strings that are temporarily
4051 ;; inserted at the start and end of the region. tmp-pre is a
4052 ;; cons of the positions of the prepended string. tmp-post is
4053 ;; a marker pointing to the single character of the appended
4056 ;; If hang-ender-stuck isn't nil, the comment ender is
4057 ;; hanging. In that case it's set to the number of spaces
4058 ;; that should be between the text and the ender.
4060 ;; auto-fill-spaces is the exact sequence of whitespace between a
4061 ;; comment's last word and the comment ender, temporarily replaced
4062 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4065 (c-lit-limits c-lit-limits)
4066 (c-lit-type c-lit-type))
4068 ;; Restore point on undo. It's necessary since we do a lot of
4069 ;; hidden inserts and deletes below that should be as transparent
4071 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
4072 (setq buffer-undo-list (cons (point) buffer-undo-list)))
4074 ;; Determine the limits and type of the containing literal (if any):
4075 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4077 (c-save-buffer-state ()
4079 ;; Widen to catch comment limits correctly.
4081 (unless c-lit-limits
4082 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
4083 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
4085 (setq c-lit-type (c-literal-type c-lit-limits))))
4088 (unless (c-safe (backward-char)
4092 (forward-paragraph))
4093 (setq end (point-marker)))
4095 (unless (c-safe (forward-char)
4096 (backward-paragraph)
4099 (backward-paragraph))
4100 (setq beg (point))))
4104 ;; For each of the possible types of text (string, C comment ...)
4105 ;; determine BEG and END, the region we will narrow to. If we're in
4106 ;; a literal, constrain BEG and END to the limits of this literal.
4108 ;; For some of these text types, particularly a block comment, we
4109 ;; may need to massage whitespace near literal delimiters, so that
4110 ;; these don't get filled inappropriately.
4113 ((eq c-lit-type 'c++) ; Line comment.
4115 ;; Limit to the comment or paragraph end, whichever
4117 (set-marker end (min end (cdr c-lit-limits)))
4119 (when (<= beg (car c-lit-limits))
4120 ;; The region includes the comment starter, so we must
4122 (goto-char (car c-lit-limits))
4123 (back-to-indentation)
4124 (if (eq (point) (car c-lit-limits))
4125 ;; Include the first line in the region.
4126 (setq beg (c-point 'bol))
4127 ;; The first line contains code before the
4128 ;; comment. We must fake a line that doesn't.
4131 (setq apply-outside-literal t))
4133 ((eq c-lit-type 'c) ; Block comment.
4135 (or (> end (cdr c-lit-limits))
4136 (and (= end (cdr c-lit-limits))
4137 (eq (char-before end) ?/)
4138 (eq (char-before (1- end)) ?*)
4140 (> (- (cdr c-lit-limits) (car c-lit-limits)) 3)))
4141 ;; There is a comment ender, and the region includes it. If
4142 ;; it's on its own line, it stays on its own line. If it's got
4143 ;; company on the line, it keeps (at least one word of) it.
4144 ;; "=====*/" counts as a comment ender here, but "===== */"
4145 ;; doesn't and "foo*/" doesn't.
4148 (goto-char (cdr c-lit-limits))
4150 ;; The following conjunct was added to avoid an
4151 ;; "Invalid search bound (wrong side of point)"
4152 ;; error in the subsequent re-search. Maybe
4153 ;; another fix would be needed (2007-12-08).
4154 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4155 ; 2010-10-17 Construct removed.
4156 ; (or (< (- (cdr c-lit-limits) 2) (point))
4158 (search-forward-regexp
4159 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
4160 (- (cdr c-lit-limits) 2) t)
4161 (not (search-forward-regexp
4163 (- (cdr c-lit-limits) 2) 'limit))
4164 ;; The comment ender IS on its own line. Exclude this
4165 ;; line from the filling.
4166 (set-marker end (c-point 'bol))));)
4168 ;; The comment ender is hanging. Replace all space between it
4169 ;; and the last word either by one or two 'x's (when
4170 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4171 ;; as the whitespace (when auto filling), and include it in
4172 ;; the region. We'll change them back to whitespace
4173 ;; afterwards. The effect of this is to glue the comment
4174 ;; ender to the last word in the comment during filling.
4175 (let* ((ender-start (save-excursion
4176 (goto-char (cdr c-lit-limits))
4177 (skip-syntax-backward "^w ")
4179 (ender-column (save-excursion
4180 (goto-char ender-start)
4182 (point-rel (- ender-start here))
4183 (sentence-ends-comment
4185 (goto-char ender-start)
4186 (and (search-backward-regexp
4187 (c-sentence-end) (c-point 'bol) t)
4188 (goto-char (match-end 0))
4189 (looking-at "[ \t]*")
4190 (= (match-end 0) ender-start))))
4194 ;; Insert a CR after the "*/", adjust END
4195 (goto-char (cdr c-lit-limits))
4196 (setq tmp-post (point-marker))
4198 (set-marker end (point))
4200 (forward-line -1) ; last line of the comment
4201 (if (and (looking-at (concat "[ \t]*\\(\\("
4202 c-current-comment-prefix
4204 (eq ender-start (match-end 0)))
4205 ;; The comment ender is prefixed by nothing but a
4206 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4207 ;; 2006/4/28). Remove it along with surrounding ws.
4208 (setq spaces (- (match-end 1) (match-end 2)))
4209 (goto-char ender-start))
4210 (skip-chars-backward " \t\r\n") ; Surely this can be
4211 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4213 ;; What's being tested here? 2006/4/20. FIXME!!!
4214 (if (/= (point) ender-start)
4216 (if (<= here (point))
4217 ;; Don't adjust point below if it's
4218 ;; before the string we replace.
4219 (setq point-rel -1))
4220 ;; Keep one or two spaces between the
4221 ;; text and the ender, depending on how
4222 ;; many there are now.
4224 (setq spaces (- ender-column (current-column))))
4225 (setq auto-fill-spaces (c-delete-and-extract-region
4226 (point) ender-start))
4227 ;; paragraph filling condenses multiple spaces to
4228 ;; single or double spaces. auto-fill doesn't.
4233 (if (and sentence-ends-comment
4234 sentence-end-double-space)
4237 ;; Insert the filler first to keep marks right.
4238 (insert-char ?x spaces t)
4239 (setq hang-ender-stuck spaces)
4241 (and (>= point-rel 0)
4242 (- (point) (min point-rel spaces)))))
4243 (setq point-rel nil)))
4246 ;; Point was in the middle of the string we
4247 ;; replaced above, so put it back in the same
4248 ;; relative position, counting from the end.
4249 (goto-char point-rel)))
4252 (when (<= beg (car c-lit-limits))
4253 ;; The region includes the comment starter.
4255 (goto-char (car c-lit-limits))
4256 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
4257 ;; Begin with the next line.
4258 (setq beg (c-point 'bonl))
4259 ;; Fake the fill prefix in the first line.
4262 (setq apply-outside-literal t))
4264 ((eq c-lit-type 'string) ; String.
4266 (when (>= end (cdr c-lit-limits))
4267 (goto-char (1- (cdr c-lit-limits)))
4268 (setq tmp-post (point-marker))
4270 (set-marker end (point)))
4271 (when (<= beg (car c-lit-limits))
4272 (goto-char (1+ (car c-lit-limits)))
4273 (setq beg (if (looking-at "\\\\$")
4274 ;; Leave the start line if it's
4275 ;; nothing but an escaped newline.
4278 (setq apply-outside-literal t))
4280 ((eq c-lit-type 'pound) ; Macro
4281 ;; Narrow to the macro limits if they are nearer than the
4282 ;; paragraph limits. Don't know if this is necessary but
4283 ;; do it for completeness sake (doing auto filling at all
4284 ;; inside macros is bogus to begin with since the line
4285 ;; continuation backslashes aren't handled).
4287 (c-save-buffer-state ()
4288 (c-beginning-of-macro)
4295 (set-marker end (point))))))
4298 ;; Try to avoid comments and macros in the paragraph to
4299 ;; avoid that the adaptive fill mode gets the prefix from
4301 (c-save-buffer-state nil
4304 (c-forward-syntactic-ws end)
4308 (c-backward-syntactic-ws beg)
4310 (set-marker end (point))))))
4313 ;; Temporarily insert the fill prefix after the comment
4314 ;; starter so that the first line looks like any other
4315 ;; comment line in the narrowed region.
4316 (setq fill (c-save-buffer-state nil
4317 (c-guess-fill-prefix c-lit-limits c-lit-type)))
4318 (unless (string-match (concat "\\`[ \t]*\\("
4319 c-current-comment-prefix
4322 ;; Oops, the prefix doesn't match the comment prefix
4323 ;; regexp. This could produce very confusing
4324 ;; results with adaptive fill packages together with
4325 ;; the insert prefix magic below, since the prefix
4326 ;; often doesn't appear at all. So let's warn about
4329 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4331 ;; Find the right spot on the line, break it, insert
4332 ;; the fill prefix and make sure we're back in the
4333 ;; same column by temporarily prefixing the first word
4334 ;; with a number of 'x'.
4336 (goto-char (car c-lit-limits))
4337 (if (looking-at (if (eq c-lit-type 'c++)
4338 c-current-comment-prefix
4339 comment-start-skip))
4340 (goto-char (match-end 0))
4342 (skip-chars-forward " \t"))
4343 (while (and (< (current-column) (cdr fill))
4346 (let ((col (current-column)))
4347 (setq beg (1+ (point))
4348 tmp-pre (list (point)))
4351 (insert-and-inherit "\n" (car fill))
4352 (insert-char ?x (- col (current-column)) t))
4353 (setcdr tmp-pre (point))))))
4355 (when apply-outside-literal
4356 ;; `apply-outside-literal' is always set to t here if
4357 ;; we're inside a literal.
4361 ;; Kludge: If the function that adapts the fill prefix
4362 ;; doesn't produce the required comment starter for
4363 ;; line comments, then force it by setting fill-prefix.
4364 (when (and (eq c-lit-type 'c++)
4365 ;; Kludge the kludge: filladapt-mode doesn't
4366 ;; have this problem, but it currently
4367 ;; doesn't override fill-context-prefix
4369 (not (and (boundp 'filladapt-mode)
4373 (or (fill-context-prefix beg end)
4375 (c-save-buffer-state nil
4376 (car (or fill (c-guess-fill-prefix
4377 c-lit-limits c-lit-type)))))))
4379 ;; Save the relative position of point if it's outside the
4380 ;; region we're going to narrow. Want to restore it in that
4381 ;; case, but otherwise it should be moved according to the
4383 (point-rel (cond ((< (point) beg) (- (point) beg))
4384 ((> (point) end) (- (point) end)))))
4386 ;; Preparations finally done! Now we can call the
4390 (narrow-to-region beg end)
4393 ;; Restore point if it was outside the region.
4395 (goto-char (+ beg point-rel))
4396 (goto-char (+ end point-rel))))))))
4398 (when (consp tmp-pre)
4399 (delete-region (car tmp-pre) (cdr tmp-pre)))
4403 (goto-char tmp-post)
4405 (when hang-ender-stuck
4406 ;; Preserve point even if it's in the middle of the string
4407 ;; we replace; save-excursion doesn't work in that case.
4409 (goto-char tmp-post)
4410 (skip-syntax-backward "^w ")
4411 (forward-char (- hang-ender-stuck))
4412 (if (or fill-paragraph (not auto-fill-spaces))
4413 (insert-char ?\ hang-ender-stuck t)
4414 (insert auto-fill-spaces))
4415 (delete-char hang-ender-stuck)
4417 (set-marker tmp-post nil))
4419 (set-marker end nil))))
4421 (defun c-fill-paragraph (&optional arg)
4422 "Like \\[fill-paragraph] but handles C and C++ style comments.
4423 If any of the current line is a comment or within a comment, fill the
4424 comment or the paragraph of it that point is in, preserving the
4425 comment indentation or line-starting decorations (see the
4426 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4429 If point is inside multiline string literal, fill it. This currently
4430 does not respect escaped newlines, except for the special case when it
4431 is the very first thing in the string. The intended use for this rule
4432 is in situations like the following:
4434 char description[] = \"\\
4435 A very long description of something that you want to fill to make
4436 nicely formatted output.\";
4438 If point is in any other situation, i.e. in normal code, do nothing.
4440 Optional prefix ARG means justify paragraph as well."
4442 (let ((fill-paragraph-function
4443 ;; Avoid infinite recursion.
4444 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4445 fill-paragraph-function)))
4446 (c-mask-paragraph t nil 'fill-paragraph arg))
4447 ;; Always return t. This has the effect that if filling isn't done
4448 ;; above, it isn't done at all, and it's therefore effectively
4449 ;; disabled in normal code.
4452 (defun c-do-auto-fill ()
4453 ;; Do automatic filling if not inside a context where it should be
4455 (let ((c-auto-fill-prefix
4456 ;; The decision whether the line should be broken is actually
4457 ;; done in c-indent-new-comment-line, which do-auto-fill
4458 ;; calls to break lines. We just set this special variable
4459 ;; so that we'll know when we're called from there. It's
4460 ;; also used to detect whether fill-prefix is user set or
4461 ;; generated automatically by do-auto-fill.
4463 (c-mask-paragraph nil t 'do-auto-fill)))
4465 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4466 "Break line at point and indent, continuing comment or macro if within one.
4467 If inside a comment and `comment-multi-line' is non-nil, the
4468 indentation and line prefix are preserved (see the
4469 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4470 details). If inside a single line comment and `comment-multi-line' is
4471 nil, a new comment of the same type is started on the next line and
4472 indented as appropriate for comments. If inside a macro, a line
4473 continuation backslash is inserted and aligned as appropriate, and the
4474 new line is indented according to `c-syntactic-indentation'.
4476 If a fill prefix is specified, it overrides all the above."
4477 ;; allow-auto-fill is used from c-context-line-break to allow auto
4478 ;; filling to break the line more than once. Since this function is
4479 ;; used from auto-fill itself, that's normally disabled to avoid
4480 ;; unnecessary recursion.
4482 (let ((fill-prefix fill-prefix)
4485 (delete-horizontal-space)
4487 (insert-and-inherit ?\n)
4488 (newline (if allow-auto-fill nil 1)))))
4489 ;; Already know the literal type and limits when called from
4490 ;; c-context-line-break.
4491 (c-lit-limits c-lit-limits)
4492 (c-lit-type c-lit-type)
4493 (c-macro-start c-macro-start))
4495 (c-save-buffer-state ()
4496 (when (not (eq c-auto-fill-prefix t))
4497 ;; Called from do-auto-fill.
4498 (unless c-lit-limits
4499 (setq c-lit-limits (c-literal-limits nil nil t)))
4501 (setq c-lit-type (c-literal-type c-lit-limits)))
4502 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4503 ((null c-lit-type) 'code)
4506 (setq fill-prefix t) ; Used as flag in the cond.
4507 (if (and (null c-auto-fill-prefix)
4509 (<= (c-point 'bol) (car c-lit-limits)))
4510 ;; The adaptive fill function has generated a prefix, but
4511 ;; we're on the first line in a block comment so it'll be
4512 ;; wrong. Ignore it to guess a better one below.
4513 (setq fill-prefix nil)
4514 (when (and (eq c-lit-type 'c++)
4515 (not (string-match (concat "\\`[ \t]*"
4516 c-line-comment-starter)
4517 (or fill-prefix ""))))
4518 ;; Kludge: If the function that adapted the fill prefix
4519 ;; doesn't produce the required comment starter for line
4520 ;; comments, then we ignore it.
4521 (setq fill-prefix nil)))
4524 (cond ((eq fill-prefix t)
4525 ;; A call from do-auto-fill which should be ignored.
4528 ;; A fill-prefix overrides anything.
4529 (funcall do-line-break)
4530 (insert-and-inherit fill-prefix))
4531 ((c-save-buffer-state ()
4532 (unless c-lit-limits
4533 (setq c-lit-limits (c-literal-limits)))
4535 (setq c-lit-type (c-literal-type c-lit-limits)))
4536 (memq c-lit-type '(c c++)))
4537 ;; Some sort of comment.
4538 (if (or comment-multi-line
4540 (goto-char (car c-lit-limits))
4542 (< (point) (cdr c-lit-limits))))
4543 ;; Inside a comment that should be continued.
4544 (let ((fill (c-save-buffer-state nil
4545 (c-guess-fill-prefix
4547 (c-collect-line-comments c-lit-limits))
4550 (start-col (current-column))
4552 (or (and (eq c-lit-type 'c)
4554 (goto-char (- (cdr c-lit-limits) 2))
4555 (if (looking-at "\\*/") (point))))
4556 (cdr c-lit-limits))))
4557 ;; Skip forward past the fill prefix in case
4558 ;; we're standing in it.
4560 ;; FIXME: This doesn't work well in cases like
4562 ;; /* Bla bla bla bla bla
4565 ;; If point is on the 'B' then the line will be
4566 ;; broken after "Bla b".
4568 ;; If we have an empty comment, /* */, the next
4569 ;; lot of code pushes point to the */. We fix
4570 ;; this by never allowing point to end up to the
4571 ;; right of where it started.
4572 (while (and (< (current-column) (cdr fill))
4575 (if (and (> (point) comment-text-end)
4576 (> (c-point 'bol) (car c-lit-limits)))
4578 ;; The skip takes us out of the (block)
4579 ;; comment; insert the fill prefix at bol
4580 ;; instead and keep the position.
4581 (setq pos (copy-marker pos t))
4583 (insert-and-inherit (car fill))
4584 (if soft (insert-and-inherit ?\n) (newline 1))
4586 (set-marker pos nil))
4587 ;; Don't break in the middle of a comment starter
4589 (cond ((> (point) comment-text-end)
4590 (goto-char comment-text-end))
4591 ((< (point) (+ (car c-lit-limits) 2))
4592 (goto-char (+ (car c-lit-limits) 2))))
4593 (funcall do-line-break)
4594 (insert-and-inherit (car fill))
4595 (if (> (current-column) start-col)
4596 (move-to-column start-col)))) ; can this hit the
4598 ;; Inside a comment that should be broken.
4599 (let ((comment-start comment-start)
4600 (comment-end comment-end)
4602 (if (eq c-lit-type 'c)
4603 (unless (string-match "[ \t]*/\\*" comment-start)
4604 (setq comment-start "/* " comment-end " */"))
4605 (unless (string-match "[ \t]*//" comment-start)
4606 (setq comment-start "// " comment-end "")))
4607 (setq col (save-excursion
4608 (back-to-indentation)
4610 (funcall do-line-break)
4611 (when (and comment-end (not (equal comment-end "")))
4613 (insert-and-inherit comment-end)
4615 ;; c-comment-indent may look at the current
4616 ;; indentation, so let's start out with the same
4617 ;; indentation as the previous one.
4619 (insert-and-inherit comment-start)
4620 (indent-for-comment))))
4621 ((c-query-and-set-macro-start)
4623 (unless (looking-at "[ \t]*\\\\$")
4624 ;; Do not clobber the alignment of the line continuation
4625 ;; slash; c-backslash-region might look at it.
4626 (delete-horizontal-space))
4627 ;; Got an asymmetry here: In normal code this command
4628 ;; doesn't indent the next line syntactically, and otoh a
4629 ;; normal syntactically indenting newline doesn't continue
4631 (c-newline-and-indent (if allow-auto-fill nil 1)))
4633 ;; Somewhere else in the code.
4634 (let ((col (save-excursion
4636 (while (and (looking-at "[ \t]*\\\\?$")
4637 (= (forward-line -1) 0)))
4638 (current-indentation))))
4639 (funcall do-line-break)
4640 (indent-to col))))))
4642 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
4643 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line "21.1")
4645 ;; advice for indent-new-comment-line for older Emacsen
4646 (unless (boundp 'comment-line-break-function)
4647 (defvar c-inside-line-break-advice nil)
4648 (defadvice indent-new-comment-line (around c-line-break-advice
4649 activate preactivate)
4650 "Call `c-indent-new-comment-line' if in CC Mode."
4651 (if (or c-inside-line-break-advice
4652 (not c-buffer-is-cc-mode))
4654 (let ((c-inside-line-break-advice t))
4655 (c-indent-new-comment-line (ad-get-arg 0))))))
4657 (defun c-context-line-break ()
4658 "Do a line break suitable to the context.
4660 When point is outside a comment or macro, insert a newline and indent
4661 according to the syntactic context, unless `c-syntactic-indentation'
4662 is nil, in which case the new line is indented as the previous
4663 non-empty line instead.
4665 When point is inside the content of a preprocessor directive, a line
4666 continuation backslash is inserted before the line break and aligned
4667 appropriately. The end of the cpp directive doesn't count as inside
4670 When point is inside a comment, continue it with the appropriate
4671 comment prefix (see the `c-comment-prefix-regexp' and
4672 `c-block-comment-prefix' variables for details). The end of a
4673 C++-style line comment doesn't count as inside it.
4675 When point is inside a string, only insert a backslash when it is also
4676 inside a preprocessor directive."
4679 (let* (c-lit-limits c-lit-type
4680 (c-macro-start c-macro-start)
4683 (c-save-buffer-state ()
4684 (setq c-lit-limits (c-literal-limits nil nil t)
4685 c-lit-type (c-literal-type c-lit-limits))
4686 (when (eq c-lit-type 'c++)
4687 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4688 (c-query-and-set-macro-start))
4691 ((or (eq c-lit-type 'c)
4692 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4694 (skip-chars-forward " \t")
4696 (1- (cdr c-lit-limits))))
4697 (and (numberp c-macro-start) ; Macro, but not at the very end of
4698 ; it, not in a string, and not in the
4700 (not (eq c-lit-type 'string))
4701 (or (not (looking-at "\\s *$"))
4702 (eq (char-before) ?\\))
4704 (goto-char c-macro-start)
4705 (if (looking-at c-opt-cpp-start)
4706 (goto-char (match-end 0)))
4709 (let ((comment-multi-line t)
4711 (c-indent-new-comment-line nil t)))
4713 ((eq c-lit-type 'string)
4714 (if (and (numberp c-macro-start)
4715 (not (eq (char-before) ?\\)))
4719 (t (delete-horizontal-space)
4721 ;; c-indent-line may look at the current indentation, so let's
4722 ;; start out with the same indentation as the previous line.
4723 (let ((col (save-excursion
4726 (while (and (looking-at "[ \t]*\\\\?$")
4727 (= (forward-line -1) 0)))
4728 (current-indentation))))
4730 (indent-according-to-mode)))))
4732 (defun c-context-open-line ()
4733 "Insert a line break suitable to the context and leave point before it.
4734 This is the `c-context-line-break' equivalent to `open-line', which is
4735 normally bound to C-o. See `c-context-line-break' for the details."
4737 (let ((here (point)))
4740 ;; Temporarily insert a non-whitespace char to keep any
4741 ;; preceding whitespace intact.
4743 (c-context-line-break))
4748 (cc-provide 'cc-cmds)
4751 ;; indent-tabs-mode: t
4754 ;;; cc-cmds.el ends here