1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software
7 ;; Authors: 1998- Martin Stjernholm
8 ;; 1992-1999 Barry A. Warsaw
9 ;; 1987 Dave Detlefs and Stewart Clamen
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Version: See cc-mode.el
14 ;; Keywords: c languages oop
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 2, or (at your option)
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 this program; see the file COPYING. If not, write to
30 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
31 ;; Boston, MA 02110-1301, USA.
39 (if (and (boundp 'byte-compile-dest-file)
40 (stringp byte-compile-dest-file))
41 (cons (file-name-directory byte-compile-dest-file) load-path)
43 (load "cc-bytecomp" nil t)))
47 (cc-require 'cc-engine)
49 ;; Silence the compiler.
50 (cc-bytecomp-defun delete-forward-p) ; XEmacs
51 (cc-bytecomp-defvar filladapt-mode) ; c-fill-paragraph contains a kludge
52 ; which looks at this.
53 (cc-bytecomp-defun c-forward-subword)
54 (cc-bytecomp-defun c-backward-subword)
56 ;; Indentation / Display syntax functions
57 (defvar c-fix-backslashes t)
59 (defun c-indent-line (&optional syntax quiet ignore-point-pos)
60 "Indent the current line according to the syntactic context,
61 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
62 syntactic information for the current line. Be silent about syntactic
63 errors if the optional argument QUIET is non-nil, even if
64 `c-report-syntactic-errors' is non-nil. Normally the position of
65 point is used to decide where the old indentation is on a lines that
66 is otherwise empty \(ignoring any line continuation backslash), but
67 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
68 indentation change \(in columns)."
70 (let ((line-cont-backslash (save-excursion
72 (eq (char-before) ?\\)))
73 (c-fix-backslashes c-fix-backslashes)
76 (when (and (not ignore-point-pos)
79 (looking-at (if line-cont-backslash
82 (<= (point) (match-end 1)))
83 ;; Delete all whitespace after point if there's only whitespace
84 ;; on the line, so that any code that does back-to-indentation
85 ;; or similar gets the current column in this case. If this
86 ;; removes a line continuation backslash it'll be restored
88 (unless c-auto-align-backslashes
89 ;; Should try to keep the backslash alignment
92 (goto-char (match-end 0))
93 (setq bs-col (1- (current-column)))))
94 (delete-region (point) (match-end 0))
95 (setq c-fix-backslashes t))
96 (if c-syntactic-indentation
98 (or (let ((c-parsing-error nil)
101 (and (boundp 'c-syntactic-context)
102 c-syntactic-context))))
103 (c-save-buffer-state (indent)
104 (unless c-syntactic-context
105 (setq c-syntactic-context (c-guess-basic-syntax)))
106 (setq indent (c-get-syntactic-indentation
107 c-syntactic-context))
108 (and (not (c-echo-parsing-error quiet))
109 c-echo-syntactic-information-p
110 (message "syntax: %s, indent: %d"
111 c-syntactic-context indent))
112 (setq shift-amt (- indent (current-indentation))))
113 (c-shift-line-indentation shift-amt)
114 (run-hooks 'c-special-indent-hook)
119 (while (and (= (forward-line -1) 0)
120 (if (looking-at "\\s *\\\\?$")
122 (setq indent (current-indentation))
124 (setq shift-amt (- indent (current-indentation)))
125 (c-shift-line-indentation shift-amt)))
126 (when (and c-fix-backslashes line-cont-backslash)
131 (when c-auto-align-backslashes
132 ;; Realign the line continuation backslash.
133 (c-backslash-region (point) (point) nil t))))
136 (defun c-newline-and-indent (&optional newline-arg)
137 "Insert a newline and indent the new line.
138 This function fixes line continuation backslashes if inside a macro,
139 and takes care to set the indentation before calling
140 `indent-according-to-mode', so that lineup functions like
141 `c-lineup-dont-change' works better."
143 ;; TODO: Backslashes before eol in comments and literals aren't
145 (let ((c-macro-start (c-query-macro-start))
146 ;; Avoid calling c-backslash-region from c-indent-line if it's
147 ;; called during the newline call, which can happen due to
148 ;; c-electric-continued-statement, for example. We also don't
149 ;; want any backslash alignment from indent-according-to-mode.
150 (c-fix-backslashes nil)
151 has-backslash insert-backslash
156 (while (and (looking-at "[ \t]*\\\\?$")
157 (= (forward-line -1) 0)))
158 (setq col (current-indentation)))
160 (if (and (eolp) (eq (char-before) ?\\))
161 (setq insert-backslash t
163 (setq has-backslash (eq (char-before (c-point 'eol)) ?\\))))
164 (newline newline-arg)
169 ;; The backslash stayed on the previous line. Insert one
170 ;; before calling c-backslash-region, so that
171 ;; bs-col-after-end in it works better. Fixup the
172 ;; backslashes on the newly inserted line.
175 (c-backslash-region (point) (point) nil t))
176 ;; The backslash moved to the new line, if there was any. Let
177 ;; c-backslash-region fix a backslash on the previous line,
178 ;; and the one that might be on the new line.
179 ;; c-auto-align-backslashes is intentionally ignored here;
180 ;; maybe the moved backslash should be left alone if it's set,
181 ;; but we fix both lines on the grounds that the old backslash
182 ;; has been moved anyway and is now in a different context.
183 (c-backslash-region start (if has-backslash (point) start) nil t)))
184 (when c-syntactic-indentation
185 ;; Reindent syntactically. The indentation done above is not
186 ;; wasted, since c-indent-line might look at the current
188 (let ((c-syntactic-context (c-save-buffer-state nil
189 (c-guess-basic-syntax))))
190 ;; We temporarily insert another line break, so that the
191 ;; lineup functions will see the line as empty. That makes
192 ;; e.g. c-lineup-cpp-define more intuitive since it then
193 ;; proceeds to the preceding line in this case.
195 (delete-horizontal-space)
196 (setq start (- (point-max) (point)))
200 (indent-according-to-mode))
201 (goto-char (- (point-max) start))
204 ;; Must align the backslash again after reindentation. The
205 ;; c-backslash-region call above can't be optimized to ignore
206 ;; this line, since it then won't align correctly with the
207 ;; lines below if the first line in the macro is broken.
208 (c-backslash-region (point) (point) nil t)))))
210 (defun c-show-syntactic-information (arg)
211 "Show syntactic information for current line.
212 With universal argument, inserts the analysis as a comment on that line."
214 (let* ((c-parsing-error nil)
215 (syntax (if (boundp 'c-syntactic-context)
216 ;; Use `c-syntactic-context' in the same way as
217 ;; `c-indent-line', to be consistent.
219 (c-save-buffer-state nil
220 (c-guess-basic-syntax)))))
221 (if (not (consp arg))
223 (message "Syntactic analysis: %s" syntax)
227 (setq elem (pop syntax))
228 (when (setq pos (c-langelem-pos elem))
229 (push (c-put-overlay pos (1+ pos)
232 (when (setq pos (c-langelem-2nd-pos elem))
233 (push (c-put-overlay pos (1+ pos)
234 'face 'secondary-selection)
238 (c-delete-overlay (pop ols)))))
240 (insert-and-inherit (format "%s" syntax))
242 (c-keep-region-active))
244 (defun c-syntactic-information-on-region (from to)
245 "Insert a comment with the syntactic analysis on every line in the region."
249 (narrow-to-region from to)
250 (goto-char (point-min))
252 (c-show-syntactic-information '(0))
256 ;; Minor mode functions.
257 (defun c-update-modeline ()
258 (let ((fmt (format "/%s%s%s%s"
259 (if c-electric-flag "l" "")
260 (if (and c-electric-flag c-auto-newline)
262 (if c-hungry-delete-key "h" "")
264 ;; cc-subword might not be loaded.
265 (boundp 'c-subword-mode)
266 (symbol-value 'c-subword-mode))
269 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name)
270 (substring mode-name (match-beginning 1) (match-end 1))
272 ;; (setq c-submode-indicators
273 ;; (if (> (length fmt) 1)
276 (if (> (length fmt) 1)
277 (concat bare-mode-name fmt)
279 (force-mode-line-update)))
281 (defun c-toggle-syntactic-indentation (&optional arg)
282 "Toggle syntactic indentation.
283 Optional numeric ARG, if supplied, turns on syntactic indentation when
284 positive, turns it off when negative, and just toggles it when zero or
287 When syntactic indentation is turned on (the default), the indentation
288 functions and the electric keys indent according to the syntactic
289 context keys, when applicable.
291 When it's turned off, the electric keys don't reindent, the indentation
292 functions indents every new line to the same level as the previous
293 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
294 specified by `c-basic-offset'. The indentation style has no effect in
295 this mode, nor any of the indentation associated variables,
296 e.g. `c-special-indent-hook'.
298 This command sets the variable `c-syntactic-indentation'."
300 (setq c-syntactic-indentation
301 (c-calculate-state arg c-syntactic-indentation))
302 (c-keep-region-active))
304 (defun c-toggle-auto-newline (&optional arg)
305 "Toggle auto-newline feature.
306 Optional numeric ARG, if supplied, turns on auto-newline when
307 positive, turns it off when negative, and just toggles it when zero or
310 Turning on auto-newline automatically enables electric indentation.
312 When the auto-newline feature is enabled (indicated by \"/la\" on the
313 modeline after the mode name) newlines are automatically inserted
314 after special characters such as brace, comma, semi-colon, and colon."
317 (c-calculate-state arg (and c-auto-newline c-electric-flag)))
318 (if c-auto-newline (setq c-electric-flag t))
320 (c-keep-region-active))
322 (defalias 'c-toggle-auto-state 'c-toggle-auto-newline)
323 (make-obsolete 'c-toggle-auto-state 'c-toggle-auto-newline)
325 (defun c-toggle-hungry-state (&optional arg)
326 "Toggle hungry-delete-key feature.
327 Optional numeric ARG, if supplied, turns on hungry-delete when
328 positive, turns it off when negative, and just toggles it when zero or
331 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
332 the modeline after the mode name) the delete key gobbles all preceding
333 whitespace in one fell swoop."
335 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
337 (c-keep-region-active))
339 (defun c-toggle-auto-hungry-state (&optional arg)
340 "Toggle auto-newline and hungry-delete-key features.
341 Optional numeric ARG, if supplied, turns on auto-newline and
342 hungry-delete when positive, turns them off when negative, and just
343 toggles them when zero or left out.
345 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
347 (setq c-auto-newline (c-calculate-state arg c-auto-newline))
348 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
350 (c-keep-region-active))
352 (defun c-toggle-electric-state (&optional arg)
353 "Toggle the electric indentation feature.
354 Optional numeric ARG, if supplied, turns on electric indentation when
355 positive, turns it off when negative, and just toggles it when zero or
358 (setq c-electric-flag (c-calculate-state arg c-electric-flag))
360 (c-keep-region-active))
365 (defun c-electric-backspace (arg)
366 "Delete the preceding character or whitespace.
367 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
368 line) then all preceding whitespace is consumed. If however a prefix
369 argument is supplied, or `c-hungry-delete-key' is nil, or point is
370 inside a literal then the function in the variable
371 `c-backspace-function' is called."
373 (if (c-save-buffer-state ()
374 (or (not c-hungry-delete-key)
377 (funcall c-backspace-function (prefix-numeric-value arg))
378 (c-hungry-delete-backwards)))
380 (defun c-hungry-delete-backwards ()
381 "Delete the preceding character or all preceding whitespace
382 back to the previous non-whitespace character.
383 See also \\[c-hungry-delete-forward]."
385 (let ((here (point)))
387 (if (/= (point) here)
388 (delete-region (point) here)
389 (funcall c-backspace-function 1))))
391 (defalias 'c-hungry-backspace 'c-hungry-delete-backwards)
393 (defun c-electric-delete-forward (arg)
394 "Delete the following character or whitespace.
395 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
396 line) then all following whitespace is consumed. If however a prefix
397 argument is supplied, or `c-hungry-delete-key' is nil, or point is
398 inside a literal then the function in the variable `c-delete-function'
401 (if (c-save-buffer-state ()
402 (or (not c-hungry-delete-key)
405 (funcall c-delete-function (prefix-numeric-value arg))
406 (c-hungry-delete-forward)))
408 (defun c-hungry-delete-forward ()
409 "Delete the following character or all following whitespace
410 up to the next non-whitespace character.
411 See also \\[c-hungry-delete-backwards]."
413 (let ((here (point)))
415 (if (/= (point) here)
416 (delete-region (point) here)
417 (funcall c-delete-function 1))))
419 ;; This function is only used in XEmacs.
420 (defun c-electric-delete (arg)
421 "Deletes preceding or following character or whitespace.
422 This function either deletes forward as `c-electric-delete-forward' or
423 backward as `c-electric-backspace', depending on the configuration: If
424 the function `delete-forward-p' is defined and returns non-nil, it
425 deletes forward. Otherwise it deletes backward.
427 Note: This is the way in XEmacs to choose the correct action for the
428 \[delete] key, whichever key that means. Other flavors don't use this
429 function to control that."
431 (if (and (fboundp 'delete-forward-p)
433 (c-electric-delete-forward arg)
434 (c-electric-backspace arg)))
436 ;; This function is only used in XEmacs.
437 (defun c-hungry-delete ()
438 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
439 The direction of deletion depends on the configuration: If the
440 function `delete-forward-p' is defined and returns non-nil, it deletes
441 forward using `c-hungry-delete-forward'. Otherwise it deletes
442 backward using `c-hungry-backspace'.
444 Note: This is the way in XEmacs to choose the correct action for the
445 \[delete] key, whichever key that means. Other flavors don't use this
446 function to control that."
448 (if (and (fboundp 'delete-forward-p)
450 (c-hungry-delete-forward)
451 (c-hungry-delete-backwards)))
453 (defun c-electric-pound (arg)
455 If `c-electric-flag' is set, handle it specially according to the variable
456 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
457 inside a literal or a macro, nothing special happens."
459 (if (c-save-buffer-state ()
461 (not c-electric-flag)
462 (not (memq 'alignleft c-electric-pound-behavior))
464 (skip-chars-backward " \t")
467 (and (= (forward-line -1) 0)
469 (eq (char-before) ?\\))))
471 ;; do nothing special
472 (self-insert-command (prefix-numeric-value arg))
473 ;; place the pound character at the left edge
474 (let ((pos (- (point-max) (point)))
477 (delete-horizontal-space)
478 (insert last-command-char)
480 (goto-char (- (point-max) pos)))
483 (defun c-point-syntax ()
484 ;; Return the syntactic context of the construct at point. (This is NOT
485 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
486 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
487 (c-save-buffer-state (;; shut this up too
488 (c-echo-syntactic-information-p nil)
490 (c-tentative-buffer-changes
491 ;; insert a newline to isolate the construct at point for syntactic
494 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
495 ;; the syntax. (There might already be an escaped NL there.)
496 (when (or (c-at-vsemi-p (1- (point)))
500 (and (c-beginning-of-macro)
501 (progn (c-end-of-macro)
506 (let ((c-syntactic-indentation-in-macros t)
507 (c-auto-newline-analysis t))
508 ;; Turn on syntactic macro analysis to help with auto
510 (setq syntax (c-guess-basic-syntax))
514 (defun c-brace-newlines (syntax)
515 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
516 ;; (not necessarily the same as the S.C. of the line it is on). Return
517 ;; NEWLINES, the list containing some combination of the symbols `before'
518 ;; and `after' saying where newlines should be inserted.
521 ;; This is the list of brace syntactic symbols that can hang.
522 ;; If any new ones are added to c-offsets-alist, they should be
523 ;; added here as well.
524 '(class-open class-close defun-open defun-close
525 inline-open inline-close
526 brace-list-open brace-list-close
527 brace-list-intro brace-entry-open
528 block-open block-close
529 substatement-open statement-case-open
530 extern-lang-open extern-lang-close
531 namespace-open namespace-close
532 module-open module-close
533 composition-open composition-close
534 inexpr-class-open inexpr-class-close
535 ;; `statement-cont' is here for the case with a brace
536 ;; list opener inside a statement. C.f. CASE B.2 in
537 ;; `c-guess-continued-construct'.
540 (c-echo-syntactic-information-p nil)
541 symb-newlines) ; e.g. (substatement-open . (after))
544 ;; Do not try to insert newlines around a special
545 ;; (Pike-style) brace list.
546 (if (and c-special-brace-lists
548 (c-safe (if (= (char-before) ?{)
551 (c-looking-at-special-brace-list))))
553 ;; Seek the matching entry in c-hanging-braces-alist.
556 ;; Substitute inexpr-class and class-open or
557 ;; class-close with inexpr-class-open or
558 ;; inexpr-class-close.
559 (if (assq 'inexpr-class syntax)
560 (cond ((assq 'class-open syntax)
561 '((inexpr-class-open)))
562 ((assq 'class-close syntax)
563 '((inexpr-class-close)))
566 c-hanging-braces-alist)
567 '(ignore before after)))) ; Default, when not in c-h-b-l.
569 ;; If syntax is a function symbol, then call it using the
570 ;; defined semantics.
571 (if (and (not (consp (cdr symb-newlines)))
572 (functionp (cdr symb-newlines)))
573 (let ((c-syntactic-context syntax))
574 (funcall (cdr symb-newlines)
577 (cdr symb-newlines))))
579 (defun c-try-one-liner ()
580 ;; Point is just after a newly inserted }. If the non-whitespace
581 ;; content of the braces is a single line of code, compact the whole
582 ;; construct to a single line, if this line isn't too long. The Right
583 ;; Thing is done with comments.
585 ;; Point will be left after the }, regardless of whether the clean-up is
586 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
589 (pos (- (point-max) (point)))
590 mbeg1 mend1 mbeg4 mend4
591 eol-col cmnt-pos cmnt-col cmnt-gap)
596 ;; Avoid backtracking over a very large block. The one we
597 ;; deal with here can never be more than three lines.
598 (narrow-to-region (save-excursion
602 (and (c-safe (c-backward-sexp))
605 (narrow-to-region (point) (1- here)) ; innards of {.}
607 (cc-eval-when-compile
609 "\\(" ; (match-beginning 1)
610 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
611 "\\)" ; (match-end 1)
612 "[^ \t\r\n]+\\([ \t]+[^ \t\r\n]+\\)*" ; non-WS
613 "\\(" ; (match-beginning 4)
614 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
615 "\\)\\'"))))))) ; (match-end 4) at EOB.
617 (if (c-tentative-buffer-changes
618 (setq mbeg1 (match-beginning 1) mend1 (match-end 1)
619 mbeg4 (match-beginning 4) mend4 (match-end 4))
620 (backward-char) ; back over the `}'
622 (setq cmnt-pos (and (c-backward-single-comment)
623 (- (point) (- mend1 mbeg1)))))
624 (delete-region mbeg4 mend4)
625 (delete-region mbeg1 mend1)
626 (setq eol-col (save-excursion (end-of-line) (current-column)))
628 ;; Necessary to put the closing brace before any line
629 ;; oriented comment to keep it syntactically significant.
630 ;; This isn't necessary for block comments, but the result
631 ;; looks nicer anyway.
633 (delete-char 1) ; the `}' has blundered into a comment
635 (setq cmnt-col (1+ (current-column)))
636 (setq cmnt-pos (1+ cmnt-pos)) ; we're inserting a `}'
638 (insert-char ?\} 1) ; reinsert the `}' before the comment.
639 (setq cmnt-gap (- cmnt-col (current-column)))
640 (when (zerop cmnt-gap)
641 (insert-char ?\ 1) ; Put a space before a bare comment.
644 (or (null c-max-one-liner-length)
645 (zerop c-max-one-liner-length)
646 (<= eol-col c-max-one-liner-length)
647 ;; Can we trim space before comment to make the line fit?
649 (< (- eol-col cmnt-gap) c-max-one-liner-length)
650 (progn (goto-char cmnt-pos)
651 (backward-delete-char-untabify
652 (- eol-col c-max-one-liner-length))
654 (goto-char (- (point-max) pos))))))
656 (defun c-electric-brace (arg)
659 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
660 numeric ARG hasn't been supplied, the command performs several electric
663 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
664 the mode line) newlines are inserted before and after the brace as
665 directed by the settings in `c-hanging-braces-alist'.
667 \(b) Any auto-newlines are indented. The original line is also
668 reindented unless `c-syntactic-indentation' is nil.
670 \(c) If auto-newline is turned on, various newline cleanups based on the
671 settings of `c-cleanup-list' are done."
674 (let (safepos literal
675 ;; We want to inhibit blinking the paren since this would be
676 ;; most disruptive. We'll blink it ourselves later on.
677 (old-blink-paren blink-paren-function)
678 blink-paren-function)
680 (c-save-buffer-state ()
681 (setq safepos (c-safe-position (point) (c-parse-state))
682 literal (c-in-literal safepos)))
684 ;; Insert the brace. Note that expand-abbrev might reindent
685 ;; the line here if there's a preceding "else" or something.
686 (self-insert-command (prefix-numeric-value arg))
688 (when (and c-electric-flag (not literal) (not arg))
689 (if (not (looking-at "[ \t]*\\\\?$"))
690 (if c-syntactic-indentation
691 (indent-according-to-mode))
693 (let ( ;; shut this up too
694 (c-echo-syntactic-information-p nil)
696 ln-syntax br-syntax syntax) ; Syntactic context of the original line,
697 ; of the brace itself, of the line the brace ends up on.
698 (c-save-buffer-state ((c-syntactic-indentation-in-macros t)
699 (c-auto-newline-analysis t))
700 (setq ln-syntax (c-guess-basic-syntax)))
701 (if c-syntactic-indentation
702 (c-indent-line ln-syntax))
706 (setq br-syntax (c-point-syntax)
707 newlines (c-brace-newlines br-syntax))
709 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
710 (if (and (memq 'before newlines)
711 (> (current-column) (current-indentation)))
712 (if c-syntactic-indentation
713 ;; Only a plain newline for now - it's indented
714 ;; after the cleanups when the line has its final
717 (c-newline-and-indent)))
720 ;; `syntax' is the syntactic context of the line which ends up
721 ;; with the brace on it.
722 (setq syntax (if (memq 'before newlines) br-syntax ln-syntax))
724 ;; Do all appropriate clean ups
726 (pos (- (point-max) (point)))
730 ;; `}': clean up empty defun braces
731 (when (c-save-buffer-state ()
732 (and (memq 'empty-defun-braces c-cleanup-list)
733 (eq last-command-char ?\})
734 (c-intersect-lists '(defun-close class-close inline-close)
739 (eq (char-before) ?\{))
740 ;; make sure matching open brace isn't in a comment
741 (not (c-in-literal))))
742 (delete-region (point) (1- here))
743 (setq here (- (point-max) pos)))
746 ;; `}': compact to a one-liner defun?
749 (and (eq last-command-char ?\})
750 (memq 'one-liner-defun c-cleanup-list)
751 (c-intersect-lists '(defun-close) syntax)
753 (setq here (- (point-max) pos))))
755 ;; `{': clean up brace-else-brace and brace-elseif-brace
756 (when (eq last-command-char ?\{)
758 ((and (memq 'brace-else-brace c-cleanup-list)
761 "\\([ \t\n]\\|\\\\\n\\)*"
763 "\\([ \t\n]\\|\\\\\n\\)*"
767 (delete-region (match-beginning 0) (match-end 0))
768 (insert-and-inherit "} else {"))
769 ((and (memq 'brace-elseif-brace c-cleanup-list)
771 (goto-char (1- here))
775 (eq (char-before) ?\)))
776 (zerop (c-save-buffer-state nil (c-backward-token-2 1 t)))
777 (eq (char-after) ?\()
782 "\\([ \t\n]\\|\\\\\n\\)*"
784 "\\([ \t\n]\\|\\\\\n\\)+"
786 "\\([ \t\n]\\|\\\\\n\\)*"
789 ;(eq (match-end 0) tmp);
791 (delete-region mbeg mend)
795 (goto-char (- (point-max) pos))
797 ;; Indent the line after the cleanups since it might
798 ;; very well indent differently due to them, e.g. if
799 ;; c-indent-one-line-block is used together with the
800 ;; one-liner-defun cleanup.
801 (when c-syntactic-indentation
804 ;; does a newline go after the brace?
805 (if (memq 'after newlines)
806 (c-newline-and-indent))
810 (and (eq last-command-char ?\})
811 (not executing-kbd-macro)
814 (c-save-buffer-state nil
815 (c-backward-syntactic-ws safepos))
816 (funcall old-blink-paren)))))
818 (defun c-electric-slash (arg)
819 "Insert a slash character.
821 If the slash is inserted immediately after the comment prefix in a c-style
822 comment, the comment might get closed by removing whitespace and possibly
823 inserting a \"*\". See the variable `c-cleanup-list'.
825 Indent the line as a comment, if:
827 1. The slash is second of a \"//\" line oriented comment introducing
828 token and we are on a comment-only-line, or
830 2. The slash is part of a \"*/\" token that closes a block oriented
833 If a numeric ARG is supplied, point is inside a literal, or
834 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
837 (let ((literal (c-save-buffer-state () (c-in-literal)))
840 (c-echo-syntactic-information-p nil))
842 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
843 ;; `c-syntactic-indentation' set.
846 (memq 'comment-close-slash c-cleanup-list)
847 (eq last-command-char ?/)
848 (looking-at (concat "[ \t]*\\("
849 (regexp-quote comment-end) "\\)?$"))
850 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
853 (narrow-to-region (point-min) (point))
854 (back-to-indentation)
855 (looking-at (concat c-current-comment-prefix "[ \t]*$")))))
856 (kill-region (progn (forward-line 0) (point))
857 (progn (end-of-line) (point)))
858 (insert-char ?* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
860 (setq indentp (and (not arg)
861 c-syntactic-indentation
863 (eq last-command-char ?/)
864 (eq (char-before) (if literal ?* ?/))))
865 (self-insert-command (prefix-numeric-value arg))
867 (indent-according-to-mode))))
869 (defun c-electric-star (arg)
870 "Insert a star character.
871 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
872 the star is the second character of a C style comment starter on a
873 comment-only-line, indent the line as a comment. If a numeric ARG is
874 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
875 this indentation is inhibited."
878 (self-insert-command (prefix-numeric-value arg))
879 ;; if we are in a literal, or if arg is given do not reindent the
880 ;; current line, unless this star introduces a comment-only line.
881 (if (c-save-buffer-state ()
882 (and c-syntactic-indentation
885 (eq (c-in-literal) 'c)
886 (eq (char-before) ?*)
889 (skip-chars-backward "*")
890 (if (eq (char-before) ?/)
892 (skip-chars-backward " \t")
894 (let (c-echo-syntactic-information-p) ; shut this up
895 (indent-according-to-mode))
898 (defun c-electric-semi&comma (arg)
899 "Insert a comma or semicolon.
901 If `c-electric-flag' is non-nil, point isn't inside a literal and a
902 numeric ARG hasn't been supplied, the command performs several electric
905 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
906 the mode line) a newline might be inserted. See the variable
907 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
909 \(b) Any auto-newlines are indented. The original line is also
910 reindented unless `c-syntactic-indentation' is nil.
912 \(c) If auto-newline is turned on, a comma following a brace list or a
913 semicolon following a defun might be cleaned up, depending on the
914 settings of `c-cleanup-list'."
916 (let* (lim literal c-syntactic-context
919 (c-echo-syntactic-information-p nil))
921 (c-save-buffer-state ()
922 (setq lim (c-most-enclosing-brace (c-parse-state))
923 literal (c-in-literal lim)))
925 (self-insert-command (prefix-numeric-value arg))
927 (if (and c-electric-flag (not literal) (not arg))
928 ;; do all cleanups and newline insertions if c-auto-newline is on.
929 (if (or (not c-auto-newline)
930 (not (looking-at "[ \t]*\\\\?$")))
931 (if c-syntactic-indentation
933 ;; clean ups: list-close-comma or defun-close-semi
934 (let ((pos (- (point-max) (point))))
935 (if (c-save-buffer-state ()
937 (eq last-command-char ?,)
938 (memq 'list-close-comma c-cleanup-list))
940 (eq last-command-char ?\;)
941 (memq 'defun-close-semi c-cleanup-list)))
945 (eq (char-before) ?}))
946 ;; make sure matching open brace isn't in a comment
947 (not (c-in-literal lim))))
948 (delete-region (point) here))
949 (goto-char (- (point-max) pos)))
951 (when c-syntactic-indentation
952 (setq c-syntactic-context (c-guess-basic-syntax))
953 (c-indent-line c-syntactic-context))
954 ;; check to see if a newline should be added
955 (let ((criteria c-hanging-semi&comma-criteria)
956 answer add-newline-p)
958 (setq answer (funcall (car criteria)))
959 ;; only nil value means continue checking
961 (setq criteria (cdr criteria))
963 ;; only 'stop specifically says do not add a newline
964 (setq add-newline-p (not (eq answer 'stop)))
967 (c-newline-and-indent))
970 (defun c-electric-colon (arg)
973 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
974 numeric ARG hasn't been supplied, the command performs several electric
977 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
978 the mode line) newlines are inserted before and after the colon based on
979 the settings in `c-hanging-colons-alist'.
981 \(b) Any auto-newlines are indented. The original line is also
982 reindented unless `c-syntactic-indentation' is nil.
984 \(c) If auto-newline is turned on, whitespace between two colons will be
985 \"cleaned up\" leaving a scope operator, if this action is set in
989 (let* ((bod (c-point 'bod))
990 (literal (c-save-buffer-state () (c-in-literal bod)))
993 (c-echo-syntactic-information-p nil))
994 (self-insert-command (prefix-numeric-value arg))
995 ;; Any electric action?
996 (if (and c-electric-flag (not literal) (not arg))
997 ;; Unless we're at EOL, only re-indentation happens.
998 (if (not (looking-at "[ \t]*\\\\?$"))
999 (if c-syntactic-indentation
1000 (indent-according-to-mode))
1002 ;; scope-operator clean-up?
1003 (let ((pos (- (point-max) (point)))
1005 (if (c-save-buffer-state () ; Why do we need this? [ACM, 2003-03-12]
1007 (memq 'scope-operator c-cleanup-list)
1008 (eq (char-before) ?:)
1011 (c-skip-ws-backward)
1012 (eq (char-before) ?:))
1013 (not (c-in-literal))
1014 (not (eq (char-after (- (point) 2)) ?:))))
1016 (delete-region (point) (1- here))
1017 (setq is-scope-op t)))
1018 (goto-char (- (point-max) pos)))
1020 ;; indent the current line if it's done syntactically.
1021 (if c-syntactic-indentation
1022 ;; Cannot use the same syntax analysis as we find below,
1023 ;; since that's made with c-syntactic-indentation-in-macros
1025 (indent-according-to-mode))
1027 ;; Calculate where, if anywhere, we want newlines.
1028 (c-save-buffer-state
1029 ((c-syntactic-indentation-in-macros t)
1030 (c-auto-newline-analysis t)
1031 ;; Turn on syntactic macro analysis to help with auto newlines
1033 (syntax (c-guess-basic-syntax))
1035 ;; Translate substatement-label to label for this operation.
1037 (if (eq (car (car elem)) 'substatement-label)
1038 (setcar (car elem) 'label))
1039 (setq elem (cdr elem)))
1040 ;; some language elements can only be determined by checking
1041 ;; the following line. Lets first look for ones that can be
1042 ;; found when looking on the line with the colon
1045 (or (c-lookup-lists '(case-label label access-label)
1046 syntax c-hanging-colons-alist)
1047 (c-lookup-lists '(member-init-intro inher-intro)
1051 (c-guess-basic-syntax)
1053 c-hanging-colons-alist)))))
1054 ;; does a newline go before the colon? Watch out for already
1055 ;; non-hung colons. However, we don't unhang them because that
1056 ;; would be a cleanup (and anti-social).
1057 (if (and (memq 'before newlines)
1060 (skip-chars-backward ": \t")
1062 (let ((pos (- (point-max) (point))))
1064 (c-newline-and-indent)
1065 (goto-char (- (point-max) pos))))
1066 ;; does a newline go after the colon?
1067 (if (and (memq 'after (cdr-safe newlines))
1069 (c-newline-and-indent))
1072 (defun c-electric-lt-gt (arg)
1073 "Insert a \"<\" or \">\" character.
1074 If the current language uses angle bracket parens (e.g. template
1075 arguments in C++), try to find out if the inserted character is a
1076 paren and give it paren syntax if appropriate.
1078 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1079 line will be reindented if the inserted character is a paren or if it
1080 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1081 numeric argument is supplied, or the point is inside a literal."
1084 (let ((c-echo-syntactic-information-p nil)
1085 final-pos close-paren-inserted)
1087 (self-insert-command (prefix-numeric-value arg))
1088 (setq final-pos (point))
1090 (c-save-buffer-state (c-parse-and-markup-<>-arglists
1091 c-restricted-<>-arglists
1094 (when c-recognize-<>-arglists
1095 (if (eq last-command-char ?<)
1100 (c-beginning-of-current-token)
1103 (c-backward-token-2)
1104 (looking-at c-opt-<>-sexp-key)))
1105 (c-mark-<-as-paren (1- final-pos)))
1107 ;; It's a ">". Check if there's an earlier "<" which either has
1108 ;; open paren syntax already or that can be recognized as an arglist
1109 ;; together with this ">". Note that this won't work in cases like
1110 ;; "template <x, a < b, y>" but they ought to be rare.
1113 ;; Narrow to avoid that `c-forward-<>-arglist' below searches past
1115 (narrow-to-region (point-min) final-pos)
1119 (goto-char final-pos)
1120 (c-syntactic-skip-backward "^<;}" nil t)
1121 (eq (char-before) ?<))
1124 ;; If the "<" already got open paren syntax we know we
1125 ;; have the matching closer. Handle it and exit the
1127 (if (looking-at "\\s\(")
1129 (c-mark->-as-paren (1- final-pos))
1130 (setq close-paren-inserted t)
1135 (setq <-pos (point))
1136 (c-backward-syntactic-ws)
1137 (c-simple-skip-symbol-backward))
1138 (or (looking-at c-opt-<>-sexp-key)
1139 (not (looking-at c-keywords-regexp)))
1141 (let ((c-parse-and-markup-<>-arglists t)
1142 c-restricted-<>-arglists
1144 (c-most-enclosing-brace (c-parse-state))))
1145 (when (and containing-sexp
1146 (progn (goto-char containing-sexp)
1147 (eq (char-after) ?\())
1148 (not (eq (get-text-property (point) 'c-type)
1149 'c-decl-arg-start)))
1150 (setq c-restricted-<>-arglists t))
1152 (c-forward-<>-arglist nil))
1154 ;; Loop here if the "<" we found above belongs to a nested
1155 ;; angle bracket sexp. When we start over we'll find the
1156 ;; previous or surrounding sexp.
1157 (if (< (point) final-pos)
1159 (setq close-paren-inserted t)
1161 (goto-char final-pos)
1163 ;; Indent the line if appropriate.
1164 (when (and c-electric-flag c-syntactic-indentation)
1166 (when (prog1 (or (looking-at "\\s\(\\|\\s\)")
1167 (and (c-major-mode-is 'c++-mode)
1169 (c-beginning-of-current-token)
1170 (looking-at "<<\\|>>"))
1171 (= (match-end 0) final-pos)))
1172 (goto-char final-pos))
1173 (indent-according-to-mode)))
1175 (when (and close-paren-inserted
1176 (not executing-kbd-macro)
1177 blink-paren-function)
1178 ;; Note: Most paren blink functions, such as the standard
1179 ;; `blink-matching-open', currently doesn't handle paren chars
1180 ;; marked with text properties very well. Maybe we should avoid
1181 ;; this call for the time being?
1182 (funcall blink-paren-function))))
1184 (defun c-electric-paren (arg)
1185 "Insert a parenthesis.
1187 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1188 line is reindented unless a numeric ARG is supplied, or the parenthesis
1189 is inserted inside a literal.
1191 Whitespace between a function name and the parenthesis may get added or
1192 removed; see the variable `c-cleanup-list'.
1194 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1195 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1197 (let ((literal (c-save-buffer-state () (c-in-literal)))
1199 (c-echo-syntactic-information-p nil))
1200 (self-insert-command (prefix-numeric-value arg))
1202 (if (and (not arg) (not literal))
1203 (let* ( ;; We want to inhibit blinking the paren since this will
1204 ;; be most disruptive. We'll blink it ourselves
1206 (old-blink-paren blink-paren-function)
1207 blink-paren-function)
1208 (if (and c-syntactic-indentation c-electric-flag)
1209 (indent-according-to-mode))
1211 ;; If we're at EOL, check for new-line clean-ups.
1212 (when (and c-electric-flag c-auto-newline
1213 (looking-at "[ \t]*\\\\?$"))
1215 ;; clean up brace-elseif-brace
1217 (and (memq 'brace-elseif-brace c-cleanup-list)
1218 (eq last-command-char ?\()
1221 "\\([ \t\n]\\|\\\\\n\\)*"
1223 "\\([ \t\n]\\|\\\\\n\\)+"
1225 "\\([ \t\n]\\|\\\\\n\\)*"
1229 (not (c-save-buffer-state () (c-in-literal))))
1230 (delete-region (match-beginning 0) (match-end 0))
1231 (insert-and-inherit "} else if ("))
1233 ;; clean up brace-catch-brace
1235 (and (memq 'brace-catch-brace c-cleanup-list)
1236 (eq last-command-char ?\()
1239 "\\([ \t\n]\\|\\\\\n\\)*"
1241 "\\([ \t\n]\\|\\\\\n\\)*"
1245 (not (c-save-buffer-state () (c-in-literal))))
1246 (delete-region (match-beginning 0) (match-end 0))
1247 (insert-and-inherit "} catch (")))
1249 ;; Check for clean-ups at function calls. These two DON'T need
1250 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1251 ;; Point is currently just after the inserted paren.
1252 (let (beg (end (1- (point))))
1255 ;; space-before-funcall clean-up?
1256 ((and (memq 'space-before-funcall c-cleanup-list)
1257 (eq last-command-char ?\()
1260 (skip-chars-backward " \t")
1262 (c-save-buffer-state () (c-on-identifier))
1263 ;; Don't add a space into #define FOO()....
1264 (not (and (c-beginning-of-macro)
1265 (c-forward-over-cpp-define-id)
1266 (eq (point) beg)))))
1268 (delete-region beg end)
1272 ;; compact-empty-funcall clean-up?
1273 ((c-save-buffer-state ()
1274 (and (memq 'compact-empty-funcall c-cleanup-list)
1275 (eq last-command-char ?\))
1277 (c-safe (backward-char 2))
1278 (when (looking-at "()")
1280 (skip-chars-backward " \t")
1282 (c-on-identifier)))))
1283 (delete-region beg end))))
1284 (and (eq last-input-event ?\))
1285 (not executing-kbd-macro)
1287 (funcall old-blink-paren))))))
1289 (defun c-electric-continued-statement ()
1290 "Reindent the current line if appropriate.
1292 This function is used to reindent the line after a keyword which
1293 continues an earlier statement is typed, e.g. an \"else\" or the
1294 \"while\" in a do-while block.
1296 The line is reindented if there is nothing but whitespace before the
1297 keyword on the line, the keyword is not inserted inside a literal, and
1298 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1299 (let (;; shut this up
1300 (c-echo-syntactic-information-p nil))
1301 (when (c-save-buffer-state ()
1302 (and c-electric-flag
1303 c-syntactic-indentation
1304 (not (eq last-command-char ?_))
1306 (skip-syntax-backward "w")
1309 (not (c-in-literal (c-point 'bod)))))
1310 ;; Have to temporarily insert a space so that
1311 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1312 ;; space with a nonspace to avoid messing up any whitespace
1313 ;; sensitive meddling that might be done, e.g. by
1314 ;; `c-backslash-region'.
1315 (insert-and-inherit " x")
1317 (indent-according-to-mode)
1318 (delete-char -2)))))
1321 ;; "nomenclature" functions + c-scope-operator.
1322 (defun c-forward-into-nomenclature (&optional arg)
1323 "Compatibility alias for `c-forward-subword'."
1325 (require 'cc-subword)
1326 (c-forward-subword arg))
1327 (make-obsolete 'c-forward-into-nomenclature 'c-forward-subword)
1329 (defun c-backward-into-nomenclature (&optional arg)
1330 "Compatibility alias for `c-backward-subword'."
1332 (require 'cc-subword)
1333 (c-backward-subword arg))
1334 (make-obsolete 'c-backward-into-nomenclature 'c-backward-subword)
1336 (defun c-scope-operator ()
1337 "Insert a double colon scope operator at point.
1338 No indentation or other \"electric\" behavior is performed."
1340 (insert-and-inherit "::"))
1343 ;; Movement (etc.) by defuns.
1344 (defun c-in-function-trailer-p (&optional lim)
1345 ;; Return non-nil if point is between the closing brace and the semicolon of
1346 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1347 ;; portion of a declaration like "struct foo {...} bar ;".
1349 ;; Return the position of the main declaration. Otherwise, return nil.
1350 ;; Point is assumed to be at the top level and outside of any macro or
1353 ;; If LIM is non-nil, it is the bound on a the backward search for the
1354 ;; beginning of the declaration.
1356 ;; This function might do hidden buffer changes.
1357 (and c-opt-block-decls-with-vars-key
1359 (c-syntactic-skip-backward "^;}" lim)
1360 (and (eq (char-before) ?\})
1361 (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1362 (looking-at c-opt-block-decls-with-vars-key)
1365 (defun c-where-wrt-brace-construct ()
1366 ;; Determine where we are with respect to functions (or other brace
1367 ;; constructs, included in the term "function" in the rest of this comment).
1368 ;; Point is assumed to be outside any macro or literal.
1369 ;; This is used by c-\(begining\|end\)-of-defun.
1371 ;; Return one of these symbols:
1372 ;; at-header : we're at the start of a function's header.
1373 ;; in-header : we're inside a function's header, this extending right
1374 ;; up to the brace. This bit includes any k&r declarations.
1375 ;; in-block : we're inside a function's brace block.
1376 ;; in-trailer : we're in the area between the "}" and ";" of something
1377 ;; like "struct foo {...} bar, baz;".
1378 ;; at-function-end : we're just after the closing brace (or semicolon) that
1379 ;; terminates the function.
1380 ;; outwith-function: we're not at or in any function. Being inside a
1381 ;; non-brace construct also counts as 'outwith-function'.
1383 ;; This function might do hidden buffer changes.
1387 decl-result brace-decl-p
1389 (paren-state (c-parse-state))
1390 (least-enclosing (c-least-enclosing-brace paren-state)))
1393 ((and least-enclosing
1394 (eq (char-after least-enclosing) ?\{))
1396 ((c-in-function-trailer-p)
1398 ((and (not least-enclosing)
1400 (consp (car paren-state))
1401 (eq start (cdar paren-state)))
1404 ;; Find the start of the current declaration. NOTE: If we're in the
1405 ;; variables after a "struct/eval" type block, we don't get to the
1406 ;; real declaration here - we detect and correct for this later.
1408 ;;If we're in the parameters' parens, move back out of them.
1409 (if least-enclosing (goto-char least-enclosing))
1410 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1411 ;; at a declaration.
1412 (if (or (and (eolp) (not (eobp))) ; EOL is matched by "\\s>"
1414 "\\([;#]\\|\\'\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s$\\|\\s<\\|\\s>\\|\\s!\\)")))
1416 (setq kluge-start (point))
1418 (car (c-beginning-of-decl-1
1419 (and least-enclosing ; LIMIT for c-b-of-decl-1
1420 (c-safe-position least-enclosing paren-state)))))
1422 ;; Has the declaration we've gone back to got braces?
1423 (setq pos (point)) ; the search limit for c-recognize-knr-p
1426 (and (c-syntactic-re-search-forward "[;{]" nil t t)
1427 (or (eq (char-before) ?\{)
1428 (and c-recognize-knr-p
1429 ;; Might have stopped on the
1430 ;; ';' in a K&R argdecl. In
1431 ;; that case the declaration
1432 ;; should contain a block.
1433 (c-in-knr-argdecl pos))))))
1436 ((= (point) kluge-start) ; might be BOB or unbalanced parens.
1438 ((eq decl-result 'same)
1440 (if (eq (point) start)
1444 ((eq decl-result 'previous)
1445 (if (and (not brace-decl-p)
1446 (c-in-function-trailer-p))
1450 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1453 (defun c-backward-to-nth-BOF-{ (n where)
1454 ;; Skip to the opening brace of the Nth function before point. If
1455 ;; point is inside a function, this counts as the first. Point must be
1456 ;; outside any comment/string or macro.
1458 ;; N must be strictly positive.
1459 ;; WHERE describes the position of point, one of the symbols `at-header',
1460 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1461 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1463 ;; If we run out of functions, leave point at BOB. Return zero on success,
1464 ;; otherwise the number of {s still to go.
1466 ;; This function may do hidden buffer changes
1468 ;; What we do to go back the first defun depends on where we start.
1470 ((eq where 'in-block)
1471 (goto-char (c-least-enclosing-brace (c-parse-state)))
1473 ((eq where 'in-header)
1474 (c-syntactic-re-search-forward "{")
1477 (;; (or (eq where 'at-header) (eq where 'outwith-function)
1478 ;; (eq where 'at-function-end) (eq where 'in-trailer))
1479 (memq where '(at-header outwith-function at-function-end in-trailer))
1480 (c-syntactic-skip-backward "^}")
1481 (when (eq (char-before) ?\})
1484 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where)))
1486 ;; Each time round the loop, go back to a "{" at the outermost level.
1487 (while (and (> n 0) (not (bobp)))
1488 (c-parse-state) ; This call speeds up the following one
1489 ; by a factor of ~6. Hmmm. 2006/4/5.
1490 (c-syntactic-skip-backward "^}")
1491 (when (eq (char-before) ?\})
1496 (defun c-beginning-of-defun (&optional arg)
1497 "Move backward to the beginning of a defun.
1498 Every top level declaration that contains a brace paren block is
1499 considered to be a defun.
1501 With a positive argument, move backward that many defuns. A negative
1502 argument -N means move forward to the Nth following beginning. Return
1503 t unless search stops due to beginning or end of buffer.
1505 Unlike the built-in `beginning-of-defun' this tries to be smarter
1506 about finding the char with open-parenthesis syntax that starts the
1510 (or arg (setq arg 1))
1512 (c-save-buffer-state
1514 where paren-state pos)
1516 ;; Move back out of any macro/comment/string we happen to be in.
1517 (c-beginning-of-macro)
1518 (setq pos (c-literal-limits))
1519 (if pos (goto-char (car pos)))
1521 (setq where (c-where-wrt-brace-construct))
1524 ;; Move forward to the closing brace of a function.
1526 (if ;; (or (eq where 'at-function-end) (eq where 'outwith-function))
1527 (memq where '(at-function-end outwith-function))
1528 (setq arg (1+ arg)))
1530 (setq arg (c-forward-to-nth-EOF-} (- arg) where)))
1531 ;; Move forward to the next opening brace....
1532 (when (and (= arg 0)
1533 (c-syntactic-re-search-forward "{" nil t))
1535 ;; ... and backward to the function header.
1536 (c-beginning-of-decl-1)
1539 ;; Move backward to the opening brace of a function.
1540 (when (and (> arg 0)
1541 (eq (setq arg (c-backward-to-nth-BOF-{ arg where)) 0))
1543 ;; Go backward to this function's header.
1544 (c-beginning-of-decl-1)
1547 ;; We're now there, modulo comments and whitespace.
1548 ;; Try to be line oriented; position point at the closest
1549 ;; preceding boi that isn't inside a comment, but if we hit
1550 ;; the previous declaration then we use the current point
1552 (while (and (/= (point) (c-point 'boi))
1553 (c-backward-single-comment)))
1554 (if (/= (point) (c-point 'boi))
1557 (c-keep-region-active)
1560 (defun c-forward-to-nth-EOF-} (n where)
1561 ;; Skip to the closing brace of the Nth function after point. If
1562 ;; point is inside a function, this counts as the first. Point must be
1563 ;; outside any comment/string or macro.
1565 ;; N must be strictly positive.
1566 ;; WHERE describes the position of point, one of the symbols `at-header',
1567 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1568 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1570 ;; If we run out of functions, leave point at EOB. Return zero on success,
1571 ;; otherwise the number of }s still to go.
1573 ;; This function may do hidden buffer changes.
1576 ;; What we do to go forward over the first defun depends on where we
1577 ;; start. We go to the closing brace of that defun, even when we go
1578 ;; backwards to it (in a "struct foo {...} bar ;").
1580 ((eq where 'in-block)
1581 (goto-char (c-least-enclosing-brace (c-parse-state)))
1584 ((eq where 'in-trailer)
1585 (c-syntactic-skip-backward "^}")
1587 (;; (or (eq where 'at-function-end) (eq where 'outwith-function)
1588 ;; (eq where 'at-header) (eq where 'in-header))
1589 (memq where '(at-function-end outwith-function at-header in-header))
1590 (c-syntactic-re-search-forward "{")
1594 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1596 ;; Each time round the loop, go forward to a "}" at the outermost level.
1597 (while (and (> n 0) (not (eobp)))
1598 ;(c-parse-state) ; This call speeds up the following one by a factor
1599 ; of ~6. Hmmm. 2006/4/5.
1600 (when (c-syntactic-re-search-forward "{" nil 'eob)
1606 (defun c-end-of-defun (&optional arg)
1607 "Move forward to the end of a top level declaration.
1608 With argument, do it that many times. Negative argument -N means move
1609 back to Nth preceding end. Returns t unless search stops due to
1610 beginning or end of buffer.
1612 An end of a defun occurs right after the close-parenthesis that matches
1613 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1615 (or arg (setq arg 1))
1617 (c-save-buffer-state
1619 where paren-state pos)
1621 ;; Move back out of any macro/comment/string we happen to be in.
1622 (c-beginning-of-macro)
1623 (setq pos (c-literal-limits))
1624 (if pos (goto-char (car pos)))
1626 (setq where (c-where-wrt-brace-construct))
1629 ;; Move backwards to the } of a function
1631 (if ;; (or (eq where 'at-header) (eq where 'outwith-function))
1632 (memq where '(at-header outwith-function))
1633 (setq arg (1+ arg)))
1635 (setq arg (c-backward-to-nth-BOF-{ (- arg) where)))
1636 (when (and (= arg 0)
1637 (c-syntactic-skip-backward "^}")
1638 (eq (char-before) ?\}))
1641 ;; Move forward to the } of a function
1643 (setq arg (c-forward-to-nth-EOF-} arg where))))
1645 ;; Do we need to move forward from the brace to the semicolon?
1647 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1648 (c-syntactic-re-search-forward ";"))
1651 ;; We're there now, modulo comments and whitespace.
1652 ;; Try to be line oriented; position point after the next
1653 ;; newline that isn't inside a comment, but if we hit the
1654 ;; next declaration then we use the current point instead.
1655 (while (and (not (bolp))
1656 (not (looking-at "\\s *$"))
1657 (c-forward-single-comment)))
1659 ((looking-at "\\s *$")
1664 (c-keep-region-active)
1667 (defun c-declaration-limits (near)
1668 ;; Return a cons of the beginning and end positions of the current
1669 ;; top level declaration or macro. If point is not inside any then
1670 ;; nil is returned, unless NEAR is non-nil in which case the closest
1671 ;; following one is chosen instead (if there is any). The end
1672 ;; position is at the next line, providing there is one before the
1675 ;; This function might do hidden buffer changes.
1678 ;; Note: Some code duplication in `c-beginning-of-defun' and
1679 ;; `c-end-of-defun'.
1681 (let ((start (point))
1682 (paren-state (c-parse-state))
1685 (goto-char (c-least-enclosing-brace paren-state))
1686 ;; If we moved to the outermost enclosing paren then we
1687 ;; can use c-safe-position to set the limit. Can't do
1688 ;; that otherwise since the earlier paren pair on
1689 ;; paren-state might very well be part of the
1690 ;; declaration we should go to.
1691 (setq lim (c-safe-position (point) paren-state))
1693 ;; At top level. Make sure we aren't inside a literal.
1694 (setq pos (c-literal-limits
1695 (c-safe-position (point) paren-state)))
1696 (if pos (goto-char (car pos))))
1698 (when (c-beginning-of-macro)
1707 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1709 ;; We moved back over the previous defun. Skip to the next
1710 ;; one. Not using c-forward-syntactic-ws here since we
1711 ;; should not skip a macro. We can also be directly after
1712 ;; the block in a `c-opt-block-decls-with-vars-key'
1713 ;; declaration, but then we won't move significantly far
1716 (c-forward-comments)
1718 (when (and near (c-beginning-of-macro))
1726 (if (eobp) (throw 'exit nil))
1728 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1729 ;; declaration that doesn't end there. We're searching back and
1730 ;; forth over the block here, which can be expensive.
1732 (if (and c-opt-block-decls-with-vars-key
1734 (c-backward-syntactic-ws)
1735 (eq (char-before) ?}))
1736 (eq (car (c-beginning-of-decl-1))
1740 (and (> (point) pos)
1741 (setq end-pos (point)))))
1745 (if (and (not near) (> (point) start))
1748 ;; Try to be line oriented; position the limits at the
1749 ;; closest preceding boi, and after the next newline, that
1750 ;; isn't inside a comment, but if we hit a neighboring
1751 ;; declaration then we instead use the exact declaration
1752 ;; limit in that direction.
1755 (while (and (/= (point) (c-point 'boi))
1756 (c-backward-single-comment)))
1757 (if (/= (point) (c-point 'boi))
1765 (while (and (not (bolp))
1766 (not (looking-at "\\s *$"))
1767 (c-forward-single-comment)))
1770 ((looking-at "\\s *$")
1777 (defun c-mark-function ()
1778 "Put mark at end of the current top-level declaration or macro, point at beginning.
1779 If point is not inside any then the closest following one is chosen.
1781 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1782 function does not require the declaration to contain a brace block."
1786 (c-save-buffer-state nil
1787 ;; We try to be line oriented, unless there are several
1788 ;; declarations on the same line.
1789 (if (looking-at c-syntactic-eol)
1790 (c-backward-token-2 1 nil (c-point 'bol)))
1791 (setq decl-limits (c-declaration-limits t)))
1793 (if (not decl-limits)
1794 (error "Cannot find any declaration")
1795 (goto-char (car decl-limits))
1796 (push-mark (cdr decl-limits) nil t))))
1799 ;; Movement by statements.
1800 (defun c-in-comment-line-prefix-p ()
1801 ;; Point is within a comment. Is it also within a comment-prefix?
1802 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1804 ;; This function might do hidden buffer changes.
1805 (let ((here (point)))
1808 (skip-chars-forward " \t")
1809 (and (looking-at c-current-comment-prefix)
1810 (/= (match-beginning 0) (match-end 0))
1811 (< here (match-end 0))))))
1813 (defun c-narrow-to-comment-innards (range)
1814 ;; Narrow to the "inside" of the comment (block) defined by range, as
1817 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
1818 ;; present) removed. A c++-style line comment retains its opening "//" but
1819 ;; has any final NL removed. If POINT is currently outwith these innards,
1820 ;; move it to the appropriate boundary.
1822 ;; This narrowing simplifies the sentence movement functions, since it
1823 ;; eliminates awkward things at the boundaries of the comment (block).
1825 ;; This function might do hidden buffer changes.
1826 (let* ((lit-type (c-literal-type range))
1827 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
1828 (end (if (eq lit-type 'c)
1829 (if (and (eq (char-before (cdr range)) ?/)
1830 (eq (char-before (1- (cdr range))) ?*))
1833 (if (eq (cdr range) (point-max))
1835 (- (cdr range) 1)))))
1837 (goto-char end)) ; This would be done automatically by ...
1839 (goto-char beg)) ; ... narrow-to-region but is not documented.
1840 (narrow-to-region beg end)))
1842 (defun c-beginning-of-sentence-in-comment (range)
1843 ;; Move backwards to the "beginning of a sentence" within the comment
1844 ;; defined by RANGE, a cons of its starting and ending positions. If we
1845 ;; find a BOS, return NIL. Otherwise, move point to just before the start
1846 ;; of the comment and return T.
1848 ;; The BOS is either text which follows a regexp match of sentence-end,
1849 ;; or text which is a beginning of "paragraph".
1850 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
1852 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1853 ;; It is not a general function, but is intended only for calling from
1854 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
1856 ;; This function might do hidden buffer changes.
1858 (let ((start-point (point)))
1860 (c-narrow-to-comment-innards range) ; This may move point back.
1861 (let* ((here (point))
1863 (here-filler ; matches WS and comment-prefices at point.
1864 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
1865 "\\|[ \t\n\r\f]\\)*"))
1866 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
1867 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
1868 ;; First, find the previous paragraph start, if any.
1869 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
1871 (forward-paragraph -1) ; uses cc-mode values of
1872 ; paragraph-\(start\|separate\)
1873 (if (> (re-search-forward here-filler nil t) here)
1875 (when (>= (point) here)
1876 (forward-paragraph -2)
1877 (if (> (re-search-forward here-filler nil t) here)
1881 ;; Now seek successively earlier sentence ends between PAR-BEG and
1882 ;; HERE, until the "start of sentence" following it is earlier than
1883 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
1884 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
1886 (goto-char (match-end 0)) ; tentative beginning of sentence
1887 (or (>= (point) here)
1888 (and (not (bolp)) ; Found a non-blank comment-prefix?
1890 (if (re-search-backward prefix-at-bol-here nil t)
1891 (/= (match-beginning 1) (match-end 1)))))
1892 (progn ; Skip the crud to find a real b-o-s.
1893 (if (c-in-comment-line-prefix-p)
1894 (beginning-of-line))
1895 (re-search-forward here-filler) ; always succeeds.
1896 (>= (point) here))))
1898 (re-search-forward here-filler)))
1900 (if (< (point) start-point)
1902 (goto-char (car range))
1905 (defun c-end-of-sentence-in-comment (range)
1906 ;; Move forward to the "end of a sentence" within the comment defined by
1907 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
1908 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
1909 ;; return NIL. Otherwise, move point to just after the end of the comment
1912 ;; The EOS is just after the non-WS part of the next match of the regexp
1913 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
1914 ;; no sentence-end match following point, any WS before the end of the
1915 ;; comment will count as EOS, providing we're not already in it.
1917 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1918 ;; It is not a general function, but is intended only for calling from
1919 ;; c-move-over-sentence.
1921 ;; This function might do hidden buffer changes.
1923 (let ((start-point (point))
1924 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
1927 (c-narrow-to-comment-innards range) ; This might move point forwards.
1928 (let* ((here (point))
1929 (par-end ; EOL position of last text in current/next paragraph.
1931 ;; The cc-mode values of paragraph-\(start\|separate\), set
1932 ;; in c-setup-paragraph-variables, are used in the
1934 (forward-paragraph 1)
1935 (if (eq (preceding-char) ?\n) (forward-char -1))
1936 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
1938 (forward-paragraph 2)
1939 (if (eq (preceding-char) ?\n) (forward-char -1)))
1944 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
1945 ;; Go forward one "comment-prefix which looks like sentence-end"
1946 ;; each time round the following:
1947 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
1950 (skip-chars-backward " \t\n")
1951 (or (and (not (bolp))
1952 (re-search-backward prefix-at-bol-here nil t)
1953 (/= (match-beginning 1) (match-end 1)))
1954 (<= (point) here))))
1957 ;; Take special action if we're up against the end of a comment (of
1958 ;; either sort): Leave point just after the last non-ws text.
1959 (if (eq (point) (point-max))
1960 (while (or (/= (skip-chars-backward " \t\n") 0)
1961 (and (re-search-backward prefix-at-bol-here nil t)
1962 (/= (match-beginning 1) (match-end 1))))))))
1964 (if (> (point) start-point)
1966 (goto-char (cdr range))
1969 (defun c-beginning-of-sentence-in-string (range)
1970 ;; Move backwards to the "beginning of a sentence" within the string defined
1971 ;; by RANGE, a cons of its starting and ending positions (enclosing the
1972 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
1973 ;; just before the start of the string and return T.
1975 ;; The BOS is either the text which follows a regexp match of sentence-end
1976 ;; or text which is a beginning of "paragraph". For the purposes of
1977 ;; determining paragraph boundaries, escaped newlines are treated as
1978 ;; ordinary newlines.
1980 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1981 ;; It is not a general function, but is intended only for calling from
1982 ;; c-move-over-sentence.
1984 ;; This function might do hidden buffer changes.
1986 (let* ((here (point)) last
1987 (end (1- (cdr range)))
1988 (here-filler ; matches WS and escaped newlines at point.
1989 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
1990 ;; Enhance paragraph-start and paragraph-separate also to recognise
1991 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
1992 ;; these values should be customizable user options, or something.
1993 (paragraph-start c-string-par-start)
1994 (paragraph-separate c-string-par-separate)
1996 (par-beg ; beginning of current (or previous) paragraph.
1999 (narrow-to-region (1+ (car range)) end)
2000 (forward-paragraph -1) ; uses above values of
2001 ; paragraph-\(start\|separate\)
2002 (if (> (re-search-forward here-filler nil t) here)
2004 (when (>= (point) here)
2005 (forward-paragraph -2)
2006 (if (> (re-search-forward here-filler nil t) here)
2009 ;; Now see if we can find a sentence end after PAR-BEG.
2010 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2012 (goto-char (match-end 0))
2016 here-filler end t) ; always succeeds. Use end rather
2017 ; than here, in case point starts
2018 ; beyond the closing quote.
2019 (>= (point) here))))
2021 (re-search-forward here-filler here t)
2022 (if (< (point) here)
2024 (goto-char (car range))
2027 (defun c-end-of-sentence-in-string (range)
2028 ;; Move forward to the "end of a sentence" within the string defined by
2029 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2030 ;; return NIL. Otherwise, move point to just after the end of the string
2033 ;; The EOS is just after the non-WS part of the next match of the regexp
2034 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2035 ;; no sentence-end match following point, any WS before the end of the
2036 ;; string will count as EOS, providing we're not already in it.
2038 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2039 ;; It is not a general function, but is intended only for calling from
2040 ;; c-move-over-sentence.
2042 ;; This function might do hidden buffer changes.
2044 (let* ((here (point))
2046 ;; Enhance paragraph-start and paragraph-separate to recognise
2047 ;; blank lines terminated by escaped EOLs.
2048 (paragraph-start c-string-par-start)
2049 (paragraph-separate c-string-par-separate)
2051 (par-end ; EOL position of last text in current/next paragraph.
2054 (narrow-to-region (car range) (1- (cdr range)))
2055 ;; The above values of paragraph-\(start\|separate\) are used
2056 ;; in the following.
2057 (forward-paragraph 1)
2059 ;; (re-search-backward filler-here nil t) would find an empty
2060 ;; string. Therefore we simulate it by the following:
2061 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2062 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2063 (unless (> (point) here)
2065 (forward-paragraph 1)
2066 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2067 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2069 ;; Try to go forward a sentence.
2070 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2072 (while (or (/= (skip-chars-backward " \t\n") 0)
2073 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2074 ;; Did we move a sentence, or did we hit the end of the string?
2075 (if (> (point) here)
2077 (goto-char (cdr range))
2080 (defun c-ascertain-preceding-literal ()
2081 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2082 ;; If a literal is the next thing (aside from whitespace) to be found before
2083 ;; point, return a cons of its start.end positions (enclosing the
2084 ;; delimiters). Otherwise return NIL.
2086 ;; This function might do hidden buffer changes.
2088 (c-collect-line-comments
2089 (let ((here (point))
2091 (if (c-backward-single-comment)
2092 (cons (point) (progn (c-forward-single-comment) (point)))
2094 ;; to prevent `looking-at' seeing a " at point.
2095 (narrow-to-region (point-min) here)
2098 ;; An EOL can act as an "open string" terminator in AWK.
2099 (looking-at c-ws*-string-limit-regexp)
2101 (progn (backward-char)
2102 (looking-at c-string-limit-regexp))))
2103 (goto-char (match-end 0)) ; just after the string terminator.
2105 (c-safe (c-backward-sexp 1) ; move back over the string.
2106 (cons (point) pos)))))))))
2108 (defun c-ascertain-following-literal ()
2109 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2110 ;; If a literal is the next thing (aside from whitespace) following point,
2111 ;; return a cons of its start.end positions (enclosing the delimiters).
2112 ;; Otherwise return NIL.
2114 ;; This function might do hidden buffer changes.
2116 (c-collect-line-comments
2119 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2120 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2123 (if (c-forward-single-comment)
2124 (cons pos (point))))))))
2126 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2127 ;; Does point immediately follow a statement "terminator"? A virtual
2128 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2130 ;; This function might do hidden buffer changes.
2133 (and (looking-at "[;{}]")
2134 (not (and c-special-brace-lists ; Pike special brace lists.
2135 (eq (char-after) ?{)
2136 (c-looking-at-special-brace-list)))))
2138 ;; The following (for macros) is not strict about exactly where we are
2139 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2140 ;; much. ACM 2004/3/29.
2143 (if (c-beginning-of-macro)
2144 (setq eom (progn (c-end-of-macro)
2148 (c-forward-comments)
2149 (>= (point) eom))))))
2151 (defun c-back-over-illiterals (macro-start)
2152 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2153 ;; stopping before reaching BOB or a literal or the boundary of a
2154 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2155 ;; the position of the '#' beginning the current preprocessor directive, or
2156 ;; NIL if we're not in such.
2158 ;; Return a cons (A.B), where
2159 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2160 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2161 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2162 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2164 ;; The total collection of returned values is as follows:
2165 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2166 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2167 ;; a BOS - the caller must check this.
2168 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2169 ;; moved and reached the opening # of the macro.
2170 ;; (t . macro-boundary): Every other circumstance in which we're at a
2171 ;; macro-boundary. We might be at a BOS.
2173 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2174 ;; code before encountering the literal/BOB or macro-boundary.
2176 ;; Note that this function moves within either preprocessor commands
2177 ;; (macros) or normal code, but will not cross a boundary between the two,
2178 ;; or between two distinct preprocessor commands.
2180 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2181 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2182 ;; move into parens. Also stop before `#' when it's at boi on a line.
2184 ;; This function might do hidden buffer changes.
2186 (let ((here (point))
2187 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2188 ; semicolon precedes it.
2190 (while t ;; We go back one "token" each iteration of the loop.
2193 ;; Stop at the token after a comment.
2194 ((c-backward-single-comment) ; Also functions as backwards-ws.
2196 (throw 'done '(t . literal)))
2198 ;; If we've gone back over a LF, we might have moved into or out of
2199 ;; a preprocessor line.
2200 ((and (save-excursion
2202 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2204 (< (point) macro-start)
2205 (c-beginning-of-macro)))
2207 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2208 (throw 'done (cons (or (eq (point) here)
2212 ;; Have we found a virtual semicolon? If so, stop, unless the next
2213 ;; statement is where we started from.
2214 ((and (c-at-vsemi-p)
2216 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2218 (throw 'done '(nil . nil)))
2220 ;; Hit the beginning of the buffer/region?
2224 (throw 'done '(nil . nil)))
2226 ;; Move back a character.
2227 ((progn (backward-char) nil))
2229 ;; Stop at "{" (unless it's a PIKE special brace list.)
2230 ((eq (char-after) ?\{)
2231 (if (and c-special-brace-lists
2232 (c-looking-at-special-brace-list))
2233 (skip-syntax-backward "w_") ; Speedup only.
2236 (throw 'done '(nil . nil))))
2238 ;; Have we reached the start of a macro? This always counts as
2239 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2240 ;; here. FIXME!!! ACM 2004/3/29)
2241 ((and macro-start (eq (point) macro-start))
2242 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2244 ;; Stop at token just after "}" or ";".
2245 ((looking-at "[;}]")
2246 ;; If we've gone back over ;, {, or }, we're done.
2247 (if (or (= here last)
2248 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2249 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2250 (eq (char-after) ?\;))
2252 (goto-char last) ; To the statement starting after the ; or }.
2253 (throw 'done '(nil . nil))))
2255 ;; Stop at the token after a string.
2256 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2258 (throw 'done '(t . literal)))
2260 ;; Nothing special: go back word characters.
2261 (t (skip-syntax-backward "w_")) ; Speedup only.
2264 (defun c-forward-over-illiterals (macro-end allow-early-stop)
2265 ;; Move forwards over code, stopping before reaching EOB or a literal
2266 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2267 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2268 ;; terminates the current preprocessor directive, or NIL if we're not in
2271 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2272 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2273 ;; seems unavoidable. Depending on the context this function is called
2274 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2275 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2276 ;; semicolons, or anything else.
2278 ;; Return a cons (A.B), where
2279 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2280 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2281 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2282 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2284 ;; Point is left either after the end-of-statement, or at the last non-ws
2285 ;; code before encountering the literal, or the # of the preprocessor
2286 ;; statement, or at EOB [or just after last non-WS stuff??].
2288 ;; As a clarification of "after the end-of-statement", if a comment or
2289 ;; whitespace follows a completed AWK statement, that statement is treated
2290 ;; as ending just after the last non-ws character before the comment.
2292 ;; Note that this function moves within either preprocessor commands
2293 ;; (macros) or normal code, but not both within the same invocation.
2295 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2296 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2297 ;; stop before `{' if at top level or inside braces, though. Move by
2298 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2301 ;; This function might do hidden buffer changes.
2302 (let ((here (point))
2305 (while t ;; We go one "token" forward each time round this loop.
2308 ;; If we've moved forward to a virtual semicolon, we're done.
2309 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2311 (throw 'done '(nil . nil)))
2315 ;; Gone past the end of a macro?
2316 ((and macro-end (> (point) macro-end))
2318 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2320 ;; About to hit a comment?
2321 ((save-excursion (c-forward-single-comment))
2323 (throw 'done '(t . literal)))
2329 (throw 'done '(nil . nil)))
2331 ;; If we encounter a '{', stop just after the previous token.
2332 ((and (eq (char-after) ?{)
2333 (not (and c-special-brace-lists
2334 (c-looking-at-special-brace-list)))
2335 (or allow-early-stop (/= here last))
2336 (save-excursion ; Is this a check that we're NOT at top level?
2337 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2338 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2339 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2340 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2341 (or (not (c-safe (up-list -1) t))
2342 (= (char-after) ?{))))
2344 (throw 'done '(nil . nil)))
2346 ;; End of a PIKE special brace list? If so, step over it and continue.
2347 ((and c-special-brace-lists
2348 (eq (char-after) ?})
2350 (and (c-safe (up-list -1) t)
2351 (c-looking-at-special-brace-list))))
2353 (skip-syntax-forward "w_")) ; Speedup only.
2355 ;; Have we got a '}' after having moved? If so, stop after the
2357 ((and (eq (char-after) ?})
2360 (throw 'done '(nil . nil)))
2362 ;; Stop if we encounter a preprocessor line.
2363 ((and (not macro-end)
2364 (eq (char-after) ?#)
2365 (= (point) (c-point 'boi)))
2367 ;(throw 'done (cons (eq (point) here) 'macro-boundary))) ; Changed 2003/3/26
2368 (throw 'done '(t . macro-boundary)))
2370 ;; Stop after a ';', '}', or "};"
2371 ((looking-at ";\\|};?")
2372 (goto-char (match-end 0))
2373 (throw 'done '(nil . nil)))
2375 ;; Found a string (this subsumes AWK regexps)?
2376 ((looking-at c-string-limit-regexp)
2378 (throw 'done '(t . literal)))
2381 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2382 (skip-syntax-forward "w_") ; Speedup only.
2383 (when (and macro-end (> (point) macro-end))
2385 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2388 (defun c-one-line-string-p (range)
2389 ;; Is the literal defined by RANGE a string contained in a single line?
2391 ;; This function might do hidden buffer changes.
2393 (goto-char (car range))
2394 (and (looking-at c-string-limit-regexp)
2395 (progn (skip-chars-forward "^\n" (cdr range))
2396 (eq (point) (cdr range))))))
2398 (defun c-beginning-of-statement (&optional count lim sentence-flag)
2399 "Go to the beginning of the innermost C statement.
2400 With prefix arg, go back N - 1 statements. If already at the
2401 beginning of a statement then go to the beginning of the closest
2402 preceding one, moving into nested blocks if necessary (use
2403 \\[backward-sexp] to skip over a block). If within or next to a
2404 comment or multiline string, move by sentences instead of statements.
2406 When called from a program, this function takes 3 optional args: the
2407 repetition count, a buffer position limit which is the farthest back
2408 to search for the syntactic context, and a flag saying whether to do
2409 sentence motion in or near comments and multiline strings.
2411 Note that for use in programs, `c-beginning-of-statement-1' is
2412 usually better. It has much better defined semantics than this one,
2413 which is intended for interactive use, and might therefore change to
2414 be more \"DWIM:ey\"."
2415 (interactive (list (prefix-numeric-value current-prefix-arg)
2418 (c-end-of-statement (- count) lim sentence-flag)
2419 (c-save-buffer-state
2420 ((count (or count 1))
2421 last ; start point for going back ONE chunk. Updated each chunk movement.
2423 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2424 res ; result from sub-function call
2425 not-bos ; "not beginning-of-statement"
2426 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2428 ;; Go back one statement at each iteration of the following loop.
2429 (while (and (/= count 0)
2430 (or (not lim) (> (point) lim)))
2431 ;; Go back one "chunk" each time round the following loop, stopping
2432 ;; when we reach a statement boundary, etc.
2435 (cond ; Each arm of this cond returns NIL on reaching a desired
2436 ; statement boundary, non-NIL otherwise.
2441 (range ; point is within or approaching a literal.
2443 ;; Single line string or sentence-flag is null => skip the
2445 ((or (null sentence-flag)
2446 (c-one-line-string-p range))
2447 (goto-char (car range))
2448 (setq range (c-ascertain-preceding-literal))
2449 ;; N.B. The following is essentially testing for an AWK regexp
2451 ;; Was the previous non-ws thing an end of statement?
2454 (c-backward-comments)
2455 (c-backward-syntactic-ws))
2456 (not (or (bobp) (c-after-statement-terminator-p)))))
2458 ;; Comment inside a statement or a multi-line string.
2459 (t (when (setq res ; returns non-nil when we go out of the literal
2460 (if (eq (c-literal-type range) 'string)
2461 (c-beginning-of-sentence-in-string range)
2462 (c-beginning-of-sentence-in-comment range)))
2463 (setq range (c-ascertain-preceding-literal)))
2466 ;; Non-literal code.
2467 (t (setq res (c-back-over-illiterals macro-fence))
2468 (setq not-bos ; "not reached beginning-of-statement".
2469 (or (= (point) last)
2470 (memq (char-after) '(?\) ?\}))
2473 ;; We're at a tentative BOS. The next form goes
2474 ;; back over WS looking for an end of previous
2476 (not (save-excursion
2478 (c-backward-comments)
2479 (c-backward-syntactic-ws))
2480 (or (bobp) (c-after-statement-terminator-p)))))))
2481 ;; Are we about to move backwards into or out of a
2482 ;; preprocessor command? If so, locate it's beginning.
2483 (when (eq (cdr res) 'macro-boundary)
2488 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2490 ;; Are we about to move backwards into a literal?
2491 (when (memq (cdr res) '(macro-boundary literal))
2492 (setq range (c-ascertain-preceding-literal)))
2494 (setq last (point)))
2496 (if (/= count 0) (setq count (1- count))))
2497 (c-keep-region-active))))
2499 (defun c-end-of-statement (&optional count lim sentence-flag)
2500 "Go to the end of the innermost C statement.
2501 With prefix arg, go forward N - 1 statements. Move forward to the end
2502 of the next statement if already at end, and move into nested blocks
2503 \(use \\[forward-sexp] to skip over a block). If within or next to a
2504 comment or multiline string, move by sentences instead of statements.
2506 When called from a program, this function takes 3 optional args: the
2507 repetition count, a buffer position limit which is the farthest back
2508 to search for the syntactic context, and a flag saying whether to do
2509 sentence motion in or near comments and multiline strings."
2510 (interactive (list (prefix-numeric-value current-prefix-arg)
2512 (setq count (or count 1))
2513 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2515 (c-save-buffer-state
2516 (here ; start point for going forward ONE statement. Updated each statement.
2519 (and (not (eobp)) (c-beginning-of-macro)
2520 (progn (c-end-of-macro) (point)))))
2522 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2524 ;; Go back/forward one statement at each iteration of the following loop.
2525 (while (and (/= count 0)
2526 (or (not lim) (< (point) lim)))
2527 (setq here (point)) ; ONLY HERE is HERE updated
2529 ;; Go forward one "chunk" each time round the following loop, stopping
2530 ;; when we reach a statement boundary, etc.
2532 (cond ; Each arm of this cond returns NIL on reaching a desired
2533 ; statement boundary, non-NIL otherwise.
2538 (range ; point is within a literal.
2540 ;; sentence-flag is null => skip the entire literal.
2541 ;; or a Single line string.
2542 ((or (null sentence-flag)
2543 (c-one-line-string-p range))
2544 (goto-char (cdr range))
2545 (setq range (c-ascertain-following-literal))
2546 ;; Is there a virtual semicolon here (e.g. for AWK)?
2547 (not (c-at-vsemi-p)))
2549 ;; Comment or multi-line string.
2550 (t (when (setq res ; gets non-nil when we go out of the literal
2551 (if (eq (c-literal-type range) 'string)
2552 (c-end-of-sentence-in-string range)
2553 (c-end-of-sentence-in-comment range)))
2554 (setq range (c-ascertain-following-literal)))
2555 ;; If we've just come forward out of a literal, check for
2556 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2557 ;; some other language may do in the future)
2559 (not (c-at-vsemi-p))))))
2561 ;; Non-literal code.
2562 (t (setq res (c-forward-over-illiterals macro-fence
2564 ;; Are we about to move forward into or out of a
2565 ;; preprocessor command?
2566 (when (eq (cdr res) 'macro-boundary)
2571 (progn (c-skip-ws-forward)
2572 (c-beginning-of-macro))
2573 (progn (c-end-of-macro)
2575 ;; Are we about to move forward into a literal?
2576 (when (memq (cdr res) '(macro-boundary literal))
2577 (setq range (c-ascertain-following-literal)))
2580 (if (/= count 0) (setq count (1- count))))
2581 (c-keep-region-active))))
2584 ;; set up electric character functions to work with pending-del,
2585 ;; (a.k.a. delsel) mode. All symbols get the t value except
2586 ;; the functions which delete, which gets 'supersede.
2590 (put sym 'delete-selection t) ; for delsel (Emacs)
2591 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2596 c-electric-semi&comma
2600 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2601 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2602 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2603 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
2604 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2605 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
2608 ;; Inserting/indenting comments
2609 (defun c-calc-comment-indent (entry)
2610 ;; This function might do hidden buffer changes.
2612 (setq entry (or (assq entry c-indent-comment-alist)
2613 (assq 'other c-indent-comment-alist)
2614 '(default . (column . nil)))))
2615 (let ((action (car (cdr entry)))
2616 (value (cdr (cdr entry)))
2617 (col (current-column)))
2618 (cond ((eq action 'space)
2620 ((eq action 'column)
2621 (unless value (setq value comment-column))
2623 ;; Do not pad with one space if we're at bol.
2625 (max (1+ col) value)))
2631 (let ((lim (c-literal-limits (c-point 'bol) t)))
2633 (goto-char (car lim))
2634 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2635 ;; Found comment to align with.
2637 ;; Do not pad with one space if we're at bol.
2639 (max (1+ col) (current-column))))))))
2640 ;; Recurse to handle value as a new spec.
2641 (c-calc-comment-indent (cdr entry)))))))
2643 (defun c-comment-indent ()
2644 "Used by `indent-for-comment' to create and indent comments.
2645 See `c-indent-comment-alist' for a description."
2648 (c-save-buffer-state
2649 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
2650 (or (when (consp lim)
2651 (goto-char (car lim))
2652 (when (looking-at "/[/*]")
2653 (skip-chars-backward " \t")
2656 (skip-chars-backward " \t")
2659 (cond ((looking-at "^/[/*]")
2661 ((progn (beginning-of-line)
2664 ((progn (back-to-indentation)
2665 (and (eq (char-after) ?})
2666 (eq (point) (1- eot))))
2668 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2669 (eq (match-end 0) eot))
2673 (if (and (memq line-type '(anchored-comment empty-line))
2674 c-indent-comments-syntactically-p)
2675 (let ((c-syntactic-context (c-guess-basic-syntax)))
2676 ;; BOGOSITY ALERT: if we're looking at the eol, its
2677 ;; because indent-for-comment hasn't put the comment-start
2678 ;; in the buffer yet. this will screw up the syntactic
2679 ;; analysis so we kludge in the necessary info. Another
2680 ;; kludge is that if we're at the bol, then we really want
2681 ;; to ignore any anchoring as specified by
2682 ;; c-comment-only-line-offset since it doesn't apply here.
2684 (c-add-syntax 'comment-intro))
2685 (let ((c-comment-only-line-offset
2686 (if (consp c-comment-only-line-offset)
2687 c-comment-only-line-offset
2688 (cons c-comment-only-line-offset
2689 c-comment-only-line-offset))))
2690 (c-get-syntactic-indentation c-syntactic-context)))
2692 (c-calc-comment-indent line-type)))))
2695 ;; used by outline-minor-mode
2696 (defun c-outline-level ()
2697 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2698 ;; in otherwise-hidden text.
2700 (skip-chars-forward "\t ")
2704 ;; Movement by CPP conditionals.
2705 (defun c-up-conditional (count)
2706 "Move back to the containing preprocessor conditional, leaving mark behind.
2707 A prefix argument acts as a repeat count. With a negative argument,
2708 move forward to the end of the containing preprocessor conditional.
2710 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2711 function stops at them when going backward, but not when going
2714 (c-forward-conditional (- count) -1)
2715 (c-keep-region-active))
2717 (defun c-up-conditional-with-else (count)
2718 "Move back to the containing preprocessor conditional, including \"#else\".
2719 Just like `c-up-conditional', except it also stops at \"#else\"
2722 (c-forward-conditional (- count) -1 t)
2723 (c-keep-region-active))
2725 (defun c-down-conditional (count)
2726 "Move forward into the next preprocessor conditional, leaving mark behind.
2727 A prefix argument acts as a repeat count. With a negative argument,
2728 move backward into the previous preprocessor conditional.
2730 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2731 function stops at them when going forward, but not when going
2734 (c-forward-conditional count 1)
2735 (c-keep-region-active))
2737 (defun c-down-conditional-with-else (count)
2738 "Move forward into the next preprocessor conditional, including \"#else\".
2739 Just like `c-down-conditional', except it also stops at \"#else\"
2742 (c-forward-conditional count 1 t)
2743 (c-keep-region-active))
2745 (defun c-backward-conditional (count &optional target-depth with-else)
2746 "Move back across a preprocessor conditional, leaving mark behind.
2747 A prefix argument acts as a repeat count. With a negative argument,
2748 move forward across a preprocessor conditional."
2750 (c-forward-conditional (- count) target-depth with-else)
2751 (c-keep-region-active))
2753 (defun c-forward-conditional (count &optional target-depth with-else)
2754 "Move forward across a preprocessor conditional, leaving mark behind.
2755 A prefix argument acts as a repeat count. With a negative argument,
2756 move backward across a preprocessor conditional.
2758 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2759 the nesting level isn't changed when tracking subconditionals.
2761 The optional argument TARGET-DEPTH specifies the wanted nesting depth
2762 after each scan. I.e. if TARGET-DEPTH is -1, the function will move
2763 out of the enclosing conditional. A non-integer non-nil TARGET-DEPTH
2766 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
2767 are treated as conditional clause limits. Normally they are ignored."
2769 (let* ((forward (> count 0))
2770 (increment (if forward -1 1))
2771 (search-function (if forward 're-search-forward 're-search-backward))
2773 (unless (integerp target-depth)
2774 (setq target-depth (if target-depth -1 0)))
2778 ;; subdepth is the depth in "uninteresting" subtrees,
2779 ;; i.e. those that takes us farther from the target
2780 ;; depth instead of closer.
2784 ;; Find the "next" significant line in the proper direction.
2785 (while (and (not found)
2786 ;; Rather than searching for a # sign that
2787 ;; comes at the beginning of a line aside from
2788 ;; whitespace, search first for a string
2789 ;; starting with # sign. Then verify what
2790 ;; precedes it. This is faster on account of
2791 ;; the fastmap feature of the regexp matcher.
2792 (funcall search-function
2793 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
2796 ;; Now verify it is really a preproc line.
2797 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
2798 (let (dchange (directive (match-string 1)))
2799 (cond ((string= directive "if")
2800 (setq dchange (- increment)))
2801 ((string= directive "endif")
2802 (setq dchange increment))
2804 ;; When we're not in an "uninteresting"
2805 ;; subtree, we might want to act on "elif"
2807 (if (cond (with-else
2808 ;; Always move toward the target depth.
2810 (if (> target-depth 0) 1 -1)))
2811 ((string= directive "elif")
2812 (setq dchange (- increment))))
2813 ;; Ignore the change if it'd take us
2814 ;; into an "uninteresting" subtree.
2815 (if (eq (> dchange 0) (<= target-depth 0))
2816 (setq dchange nil)))))
2818 (when (or (/= subdepth 0)
2819 (eq (> dchange 0) (<= target-depth 0)))
2820 (setq subdepth (+ subdepth dchange)))
2821 (setq depth (+ depth dchange))
2822 ;; If we are trying to move across, and we find an
2823 ;; end before we find a beginning, get an error.
2824 (if (and (< depth target-depth) (< dchange 0))
2826 "No following conditional at this level"
2827 "No previous conditional at this level"))))
2828 ;; When searching forward, start from next line so
2829 ;; that we don't find the same line again.
2830 (if forward (forward-line 1))
2831 ;; We found something if we've arrived at the
2833 (if (and dchange (= depth target-depth))
2834 (setq found (point))))
2836 (if forward (forward-line 1)))))
2838 (error "No containing preprocessor conditional"))
2839 (goto-char (setq new found)))
2840 (setq count (+ count increment))))
2843 (c-keep-region-active))
2846 ;; commands to indent lines, regions, defuns, and expressions
2847 (defun c-indent-command (&optional arg)
2848 "Indent current line as C code, and/or insert some whitespace.
2850 If `c-tab-always-indent' is t, always just indent the current line.
2851 If nil, indent the current line only if point is at the left margin or
2852 in the line's indentation; otherwise insert some whitespace[*]. If
2853 other than nil or t, then some whitespace[*] is inserted only within
2854 literals (comments and strings), but the line is always reindented.
2856 If `c-syntactic-indentation' is t, indentation is done according to
2857 the syntactic context. A numeric argument, regardless of its value,
2858 means indent rigidly all the lines of the expression starting after
2859 point so that this line becomes properly indented. The relative
2860 indentation among the lines of the expression is preserved.
2862 If `c-syntactic-indentation' is nil, the line is just indented one
2863 step according to `c-basic-offset'. In this mode, a numeric argument
2864 indents a number of such steps, positive or negative, and an empty
2865 prefix argument is equivalent to -1.
2867 [*] The amount and kind of whitespace inserted is controlled by the
2868 variable `c-insert-tab-function', which is called to do the actual
2869 insertion of whitespace. Normally the function in this variable
2870 just inserts a tab character, or the equivalent number of spaces,
2871 depending on the variable `indent-tabs-mode'."
2874 (let ((indent-function
2875 (if c-syntactic-indentation
2876 (symbol-function 'indent-according-to-mode)
2878 (let ((c-macro-start c-macro-start)
2879 (steps (if (equal arg '(4))
2881 (prefix-numeric-value arg))))
2882 (c-shift-line-indentation (* steps c-basic-offset))
2883 (when (and c-auto-align-backslashes
2886 (eq (char-before) ?\\))
2887 (c-query-and-set-macro-start))
2888 ;; Realign the line continuation backslash if inside a macro.
2889 (c-backslash-region (point) (point) nil t)))
2891 (if (and c-syntactic-indentation arg)
2892 ;; If c-syntactic-indentation and got arg, always indent this
2893 ;; line as C and shift remaining lines of expression the same
2895 (let ((shift-amt (save-excursion
2896 (back-to-indentation)
2900 (setq shift-amt (- (save-excursion
2901 (back-to-indentation)
2905 (if (eq c-tab-always-indent t)
2906 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
2914 (indent-code-rigidly beg end shift-amt "#")))
2915 ;; Else use c-tab-always-indent to determine behavior.
2917 ;; CASE 1: indent when at column zero or in line's indentation,
2918 ;; otherwise insert a tab
2919 ((not c-tab-always-indent)
2921 (skip-chars-backward " \t")
2923 (funcall c-insert-tab-function)
2924 (funcall indent-function)))
2925 ;; CASE 2: just indent the line
2926 ((eq c-tab-always-indent t)
2927 (funcall indent-function))
2928 ;; CASE 3: if in a literal, insert a tab, but always indent the
2931 (if (c-save-buffer-state () (c-in-literal))
2932 (funcall c-insert-tab-function))
2933 (funcall indent-function)
2936 (defun c-indent-exp (&optional shutup-p)
2937 "Indent each line in the balanced expression following point syntactically.
2938 If optional SHUTUP-P is non-nil, no errors are signaled if no
2939 balanced expression is found."
2941 (let ((here (point-marker))
2943 (set-marker-insertion-type here t)
2945 (let ((start (save-restriction
2946 ;; Find the closest following open paren that
2947 ;; ends on another line.
2948 (narrow-to-region (point-min) (c-point 'eol))
2949 (let (beg (end (point)))
2950 (while (and (setq beg (c-down-list-forward end))
2951 (setq end (c-up-list-forward beg))))
2953 (eq (char-syntax (char-before beg)) ?\()
2958 (error "Cannot find start of balanced expression to indent"))
2960 (setq end (c-safe (scan-sexps (point) 1)))
2963 (error "Cannot find end of balanced expression to indent"))
2966 (c-indent-region (point) end)))))
2968 (set-marker here nil))))
2970 (defun c-indent-defun ()
2971 "Indent the current top-level declaration or macro syntactically.
2972 In the macro case this also has the effect of realigning any line
2973 continuation backslashes, unless `c-auto-align-backslashes' is nil."
2975 (let ((here (point-marker)) decl-limits)
2978 (c-save-buffer-state nil
2979 ;; We try to be line oriented, unless there are several
2980 ;; declarations on the same line.
2981 (if (looking-at c-syntactic-eol)
2982 (c-backward-token-2 1 nil (c-point 'bol))
2983 (c-forward-token-2 0 nil (c-point 'eol)))
2984 (setq decl-limits (c-declaration-limits nil)))
2986 (c-indent-region (car decl-limits)
2987 (cdr decl-limits))))
2989 (set-marker here nil))))
2991 (defun c-indent-region (start end &optional quiet)
2992 "Indent syntactically every line whose first char is between START
2993 and END inclusive. If the optional argument QUIET is non-nil then no
2994 syntactic errors are reported, even if `c-report-syntactic-errors' is
2998 (skip-chars-backward " \t\n\r\f\v")
3001 ;; Advance to first nonblank line.
3003 (skip-chars-forward " \t\n\r\f\v")
3004 (setq start (point))
3006 (setq c-parsing-error
3007 (or (let ((endmark (copy-marker end))
3008 (c-parsing-error nil)
3009 ;; shut up any echo msgs on indiv lines
3010 (c-echo-syntactic-information-p nil)
3011 (in-macro (and c-auto-align-backslashes
3012 (c-save-buffer-state ()
3013 (save-excursion (c-beginning-of-macro)))
3015 (c-fix-backslashes nil)
3019 (c-progress-init start end 'c-indent-region)
3022 (< (point) endmark))
3026 (skip-chars-forward " \t\n")
3028 ;; Get syntax and indent.
3029 (c-save-buffer-state nil
3030 (setq syntax (c-guess-basic-syntax)))
3031 (if (and c-auto-align-backslashes
3032 (assq 'cpp-macro syntax))
3033 ;; Record macro start.
3034 (setq in-macro (point)))
3036 (if (looking-at "\\s *\\\\$")
3038 (c-indent-line syntax t t)
3039 (if (progn (end-of-line)
3040 (not (eq (char-before) ?\\)))
3042 ;; Fixup macro backslashes.
3044 (c-backslash-region in-macro (point) nil)
3045 (setq in-macro nil))
3047 (c-indent-line syntax t t)
3050 (c-backslash-region in-macro (c-point 'bopl) nil t)))
3051 (set-marker endmark nil)
3052 (c-progress-fini 'c-indent-region))
3053 (c-echo-parsing-error quiet))
3056 (defun c-fn-region-is-active-p ()
3057 ;; Function version of the macro for use in places that aren't
3058 ;; compiled, e.g. in the menus.
3059 (c-region-is-active-p))
3061 (defun c-indent-line-or-region ()
3062 "When the region is active, indent it syntactically. Otherwise
3063 indent the current line syntactically."
3064 ;; Emacs has a variable called mark-active, XEmacs uses region-active-p
3066 (if (c-region-is-active-p)
3067 (c-indent-region (region-beginning) (region-end))
3071 ;; for progress reporting
3072 (defvar c-progress-info nil)
3074 (defun c-progress-init (start end context)
3077 ((not c-progress-interval))
3078 ;; Start the progress update messages. If this Emacs doesn't have
3079 ;; a built-in timer, just be dumb about it.
3080 ((not (fboundp 'current-time))
3081 (message "Indenting region... (this may take a while)"))
3082 ;; If progress has already been initialized, do nothing. otherwise
3083 ;; initialize the counter with a vector of:
3084 ;; [start end lastsec context]
3086 (t (setq c-progress-info (vector start
3090 (nth 1 (current-time))
3092 (message "Indenting region..."))
3095 (defun c-progress-update ()
3096 (if (not (and c-progress-info c-progress-interval))
3098 (let ((now (nth 1 (current-time)))
3099 (start (aref c-progress-info 0))
3100 (end (aref c-progress-info 1))
3101 (lastsecs (aref c-progress-info 2)))
3102 ;; should we update? currently, update happens every 2 seconds,
3103 ;; what's the right value?
3104 (if (< c-progress-interval (- now lastsecs))
3106 (message "Indenting region... (%d%% complete)"
3107 (/ (* 100 (- (point) start)) (- end start)))
3108 (aset c-progress-info 2 now)))
3111 (defun c-progress-fini (context)
3112 (if (not c-progress-interval)
3114 (if (or (eq context (aref c-progress-info 3))
3117 (set-marker (aref c-progress-info 1) nil)
3118 (setq c-progress-info nil)
3119 (message "Indenting region... done")))))
3123 ;;; This page handles insertion and removal of backslashes for C macros.
3125 (defun c-backslash-region (from to delete-flag &optional line-mode)
3126 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3127 With no argument, inserts backslashes and aligns existing backslashes.
3128 With an argument, deletes the backslashes. The backslash alignment is
3129 done according to the settings in `c-backslash-column',
3130 `c-backslash-max-column' and `c-auto-align-backslashes'.
3132 This function does not modify blank lines at the start of the region.
3133 If the region ends at the start of a line and the macro doesn't
3134 continue below it, the backslash (if any) at the end of the previous
3137 You can put the region around an entire macro definition and use this
3138 command to conveniently insert and align the necessary backslashes."
3139 (interactive "*r\nP")
3140 (let ((endmark (make-marker))
3141 ;; Keep the backslash trimming functions from changing the
3142 ;; whitespace around point, since in this case it's only the
3143 ;; position of point that tells the indentation of the line.
3144 (point-pos (if (save-excursion
3145 (skip-chars-backward " \t")
3146 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3149 column longest-line-col bs-col-after-end)
3152 (if (and (not line-mode) (bobp))
3153 ;; Nothing to do if to is at bob, since we should back up
3154 ;; and there's no line to back up to.
3156 (when (and (not line-mode) (bolp))
3157 ;; Do not back up the to line if line-mode is set, to make
3158 ;; e.g. c-newline-and-indent consistent regardless whether
3159 ;; the (newline) call leaves point at bol or not.
3164 (set-marker endmark (point))
3166 (c-delete-backslashes-forward endmark point-pos))
3167 ;; Set bs-col-after-end to the column of any backslash
3168 ;; following the region, or nil if there is none.
3169 (setq bs-col-after-end
3170 (and (progn (end-of-line)
3171 (eq (char-before) ?\\))
3172 (= (forward-line 1) 0)
3173 (progn (end-of-line)
3174 (eq (char-before) ?\\))
3175 (1- (current-column))))
3177 ;; Back up the to line if line-mode is set, since the line
3178 ;; after the newly inserted line break should not be
3179 ;; touched in c-newline-and-indent.
3180 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3181 (unless bs-col-after-end
3182 ;; Set bs-col-after-end to non-nil in any case, since we
3183 ;; do not want to delete the backslash at the last line.
3184 (setq bs-col-after-end t)))
3186 (not c-auto-align-backslashes))
3188 ;; Compute the smallest column number past the ends of all
3190 (setq longest-line-col 0)
3192 (if bs-col-after-end
3193 ;; Include one more line in the max column
3194 ;; calculation, since the to line will be backslashed
3198 (while (and (>= (point) from)
3200 (if (eq (char-before) ?\\)
3202 (skip-chars-backward " \t")
3203 (setq longest-line-col (max longest-line-col
3204 (1+ (current-column))))
3208 ;; Try to align with surrounding backslashes.
3211 (if (and (not (bobp))
3212 (progn (backward-char)
3213 (eq (char-before) ?\\)))
3215 (setq column (1- (current-column)))
3216 (if (numberp bs-col-after-end)
3217 ;; Both a preceding and a following backslash.
3218 ;; Choose the greatest of them.
3219 (setq column (max column bs-col-after-end)))
3221 ;; No preceding backslash. Try to align with one
3222 ;; following the region. Disregard the backslash at the
3223 ;; to line since it's likely to be bogus (e.g. when
3224 ;; called from c-newline-and-indent).
3225 (if (numberp bs-col-after-end)
3226 (setq column bs-col-after-end))
3227 ;; Don't modify blank lines at start of region.
3229 (while (and (< (point) to) (bolp) (eolp))
3231 (if (and column (< column longest-line-col))
3232 ;; Don't try to align with surrounding backslashes if
3233 ;; any line is too long.
3236 ;; Impose minimum limit and tab width alignment only if
3237 ;; we can't align with surrounding backslashes.
3238 (if (> (% longest-line-col tab-width) 0)
3239 (setq longest-line-col
3240 (* (/ (+ longest-line-col tab-width -1)
3243 (setq column (max c-backslash-column
3245 ;; Always impose maximum limit.
3246 (setq column (min column c-backslash-max-column)))
3247 (if bs-col-after-end
3248 ;; Add backslashes on all lines if the macro continues
3249 ;; after the to line.
3251 (set-marker endmark to)
3252 (c-append-backslashes-forward endmark column point-pos))
3253 ;; Add backslashes on all lines except the last, and
3254 ;; remove any on the last line.
3259 (set-marker endmark (1- (point)))))
3261 (c-append-backslashes-forward endmark column point-pos)
3262 ;; The function above leaves point on the line
3263 ;; following endmark.
3264 (set-marker endmark (point)))
3265 (set-marker endmark to))
3266 (c-delete-backslashes-forward endmark point-pos)))))
3267 (set-marker endmark nil)
3268 (if (markerp point-pos)
3269 (set-marker point-pos nil))))
3271 (defun c-append-backslashes-forward (to-mark column point-pos)
3272 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3276 (<= (point) to-mark)
3278 (let ((start (point)) (inserted nil) end col)
3280 (unless (eq (char-before) ?\\)
3283 (setq state (parse-partial-sexp
3284 start (point) nil nil state))
3286 (setq col (current-column))
3288 ;; Avoid unnecessary changes of the buffer.
3289 (cond ((and (not inserted) (nth 3 state))
3290 ;; Don't realign backslashes in string literals
3291 ;; since that would change them.
3298 (skip-chars-backward
3299 " \t" (if (>= (point) point-pos) point-pos))
3303 ((and (= col column)
3304 (memq (char-before) '(?\ ?\t))))
3308 (or (/= (skip-chars-backward
3309 " \t" (if (>= (point) point-pos) point-pos))
3311 (/= (char-after) ?\ )))
3312 (delete-region (point) end)
3313 (indent-to column 1)))
3315 (zerop (forward-line 1)))
3316 (bolp))) ; forward-line has funny behavior at eob.
3318 ;; Make sure there are backslashes with at least one space in
3322 (<= (point) to-mark)
3324 (let ((start (point)))
3326 (setq state (parse-partial-sexp
3327 start (point) nil nil state))
3329 (if (eq (char-before) ?\\)
3330 (unless (nth 3 state)
3332 (unless (and (memq (char-before) '(?\ ?\t))
3333 (/= (point) point-pos))
3336 (if (and (memq (char-before) '(?\ ?\t))
3337 (/= (point) point-pos))
3341 (zerop (forward-line 1)))
3342 (bolp)))))) ; forward-line has funny behavior at eob.
3344 (defun c-delete-backslashes-forward (to-mark point-pos)
3346 (and (<= (point) to-mark)
3349 (if (eq (char-before) ?\\)
3352 (progn (backward-char)
3353 (skip-chars-backward " \t" (if (>= (point) point-pos)
3356 (zerop (forward-line 1)))
3357 (bolp)))) ; forward-line has funny behavior at eob.
3361 ;;; Line breaking and paragraph filling.
3363 (defvar c-auto-fill-prefix t)
3364 (defvar c-lit-limits nil)
3365 (defvar c-lit-type nil)
3367 ;; The filling code is based on a simple theory; leave the intricacies
3368 ;; of the text handling to the currently active mode for that
3369 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3370 ;; possible to make them work correctly wrt the comment and string
3371 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3372 ;; to it, there's quite a lot of special cases to handle which makes
3373 ;; the code anything but simple. The intention is that it will work
3374 ;; with any well-written text filling package that preserves a fill
3377 ;; We temporarily mask comment starters and enders as necessary for
3378 ;; the filling code to do its job on a seemingly normal text block.
3379 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3380 ;; preserve it correctly (especially important when filling C++ style
3381 ;; line comments). By default, we set up and use adaptive-fill-mode,
3382 ;; which is standard in all supported Emacs flavors.
3384 (defun c-guess-fill-prefix (lit-limits lit-type)
3385 ;; Determine the appropriate comment fill prefix for a block or line
3386 ;; comment. Return a cons of the prefix string and the column where
3387 ;; it ends. If fill-prefix is set, it'll override. Note that this
3388 ;; function also uses the value of point in some heuristics.
3390 ;; This function might do hidden buffer changes.
3392 (let* ((here (point))
3393 (prefix-regexp (concat "[ \t]*\\("
3394 c-current-comment-prefix
3396 (comment-start-regexp (if (eq lit-type 'c++)
3398 comment-start-skip))
3399 prefix-line comment-prefix res comment-text-end)
3403 (setq res (cons fill-prefix
3404 ;; Ugly way of getting the column after the fill
3405 ;; prefix; it'd be nice with a current-column
3406 ;; that works on strings..
3407 (let ((start (point)))
3410 (insert-and-inherit "\n" fill-prefix)
3412 (delete-region start (point)))))))
3416 ;; Set fallback for comment-prefix if none is found.
3417 (setq comment-prefix "// "
3418 comment-text-end (cdr lit-limits))
3421 (if (> (point) (car lit-limits))
3422 ;; The current line is not the comment starter, so the
3423 ;; comment has more than one line, and it can therefore be
3424 ;; used to find the comment fill prefix.
3425 (setq prefix-line (point))
3427 (goto-char (car lit-limits))
3428 (if (and (= (forward-line 1) 0)
3429 (< (point) (cdr lit-limits)))
3430 ;; The line after the comment starter is inside the
3431 ;; comment, so we can use it.
3432 (setq prefix-line (point))
3434 ;; The comment is only one line. Take the comment prefix
3435 ;; from it and keep the indentation.
3436 (goto-char (car lit-limits))
3437 (if (looking-at prefix-regexp)
3438 (goto-char (match-end 0))
3440 (skip-chars-forward " \t"))
3443 (if (eq (c-point 'boi) (car lit-limits))
3444 ;; There is only whitespace before the comment
3445 ;; starter; take the prefix straight from this line.
3446 (setq str (buffer-substring-no-properties
3447 (c-point 'bol) (point))
3448 col (current-column))
3450 ;; There is code before the comment starter, so we
3451 ;; have to temporarily insert and indent a new line to
3452 ;; get the right space/tab mix in the indentation.
3453 (let ((prefix-len (- (point) (car lit-limits)))
3457 (goto-char (car lit-limits))
3458 (indent-to (prog1 (current-column)
3461 (forward-char prefix-len)
3462 (setq str (buffer-substring-no-properties
3463 (c-point 'bol) (point))
3464 col (current-column)))
3465 (delete-region (car lit-limits) tmp))))
3468 (if (or (string-match "\\s \\'" str) (not (eolp)))
3470 ;; The prefix ends the line with no whitespace
3471 ;; after it. Default to a single space.
3472 (cons (concat str " ") (1+ col))))
3476 (setq comment-text-end
3478 (goto-char (- (cdr lit-limits) 2))
3479 (if (looking-at "\\*/") (point) (cdr lit-limits))))
3483 (if (and (> (point) (car lit-limits))
3484 (not (and (looking-at "[ \t]*\\*/")
3485 (eq (cdr lit-limits) (match-end 0)))))
3486 ;; The current line is not the comment starter and
3487 ;; contains more than just the ender, so it's good enough
3488 ;; to be used for the comment fill prefix.
3489 (setq prefix-line (point))
3490 (goto-char (car lit-limits))
3492 (cond ((or (/= (forward-line 1) 0)
3493 (>= (point) (cdr lit-limits))
3494 (and (looking-at "[ \t]*\\*/")
3495 (eq (cdr lit-limits) (match-end 0)))
3496 (and (looking-at prefix-regexp)
3497 (<= (1- (cdr lit-limits)) (match-end 0))))
3498 ;; The comment is either one line or the next line contains
3499 ;; just the comment ender. In this case we have no
3500 ;; information about a suitable comment prefix, so we resort
3501 ;; to c-block-comment-prefix.
3502 (setq comment-prefix (or c-block-comment-prefix "")))
3505 ;; The point was on the comment opener line, so we might want
3506 ;; to treat this as a not yet closed comment.
3508 (if (and (match-beginning 1)
3509 (/= (match-beginning 1) (match-end 1)))
3510 ;; Above `prefix-regexp' matched a nonempty prefix on the
3511 ;; second line, so let's use it. Normally it should do
3512 ;; to set `prefix-line' and let the code below pick up
3513 ;; the whole prefix, but if there's no text after the
3514 ;; match then it will probably fall back to no prefix at
3515 ;; all if the comment isn't closed yet, so in that case
3516 ;; it's better to force use of the prefix matched now.
3517 (if (= (match-end 0) (c-point 'eol))
3518 (setq comment-prefix (match-string 1))
3519 (setq prefix-line (point)))
3521 ;; There's no nonempty prefix on the line after the
3522 ;; comment opener. If the line is empty, or if the
3523 ;; text on it has less or equal indentation than the
3524 ;; comment starter we assume it's an unclosed
3525 ;; comment starter, i.e. that
3526 ;; `c-block-comment-prefix' should be used.
3527 ;; Otherwise we assume it's a closed comment where
3528 ;; the prefix really is the empty string.
3529 ;; E.g. this is an unclosed comment:
3540 ;; (Looking for the presence of the comment closer
3541 ;; rarely works since it's probably the closer of
3542 ;; some comment further down when the comment
3543 ;; really is unclosed.)
3544 (if (<= (save-excursion (back-to-indentation)
3546 (save-excursion (goto-char (car lit-limits))
3548 (setq comment-prefix (or c-block-comment-prefix ""))
3549 (setq prefix-line (point)))))
3552 ;; Otherwise the line after the comment starter is good
3553 ;; enough to find the prefix in.
3554 (setq prefix-line (point))))
3556 (when comment-prefix
3557 ;; Haven't got the comment prefix on any real line that we
3558 ;; can take it from, so we have to temporarily insert
3559 ;; `comment-prefix' on a line and indent it to find the
3560 ;; correct column and the correct mix of tabs and spaces.
3562 (let (tmp-pre tmp-post)
3566 (goto-char (car lit-limits))
3567 (if (looking-at comment-start-regexp)
3568 (goto-char (min (match-end 0)
3571 (skip-chars-forward " \t"))
3573 (when (eq (char-syntax (char-before)) ?\ )
3574 ;; If there's ws on the current line, we'll use it
3575 ;; instead of what's ending comment-prefix.
3576 (setq comment-prefix
3577 (concat (substring comment-prefix
3581 (buffer-substring-no-properties
3583 (skip-chars-backward " \t")
3587 (setq tmp-pre (point-marker))
3589 ;; We insert an extra non-whitespace character
3590 ;; before the line break and after comment-prefix in
3591 ;; case it's "" or ends with whitespace.
3592 (insert-and-inherit "x\n" comment-prefix "x")
3593 (setq tmp-post (point-marker))
3595 (indent-according-to-mode)
3597 (goto-char (1- tmp-post))
3598 (cons (buffer-substring-no-properties
3599 (c-point 'bol) (point))
3603 (delete-region tmp-pre tmp-post)
3604 (set-marker tmp-pre nil)
3605 (set-marker tmp-post nil))))))))))
3607 (or res ; Found a good prefix above.
3610 ;; prefix-line is the bol of a line on which we should try
3611 ;; to find the prefix.
3612 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3615 (when (and (looking-at prefix-regexp)
3616 (<= (match-end 0) comment-text-end))
3617 (unless (eq (match-end 0) (c-point 'eol))
3618 ;; The match is fine if there's text after it.
3619 (throw 'found (cons (buffer-substring-no-properties
3620 (match-beginning 0) (match-end 0))
3621 (progn (goto-char (match-end 0))
3622 (current-column)))))
3624 ;; This match is better than nothing, so let's
3625 ;; remember it in case nothing better is found
3627 (setq fb-string (buffer-substring-no-properties
3628 (match-beginning 0) (match-end 0))
3629 fb-endpos (match-end 0)))
3633 ;; Search for a line which has text after the prefix
3634 ;; so that we get the proper amount of whitespace
3635 ;; after it. We start with the current line, then
3636 ;; search backwards, then forwards.
3638 (goto-char prefix-line)
3639 (when (and (funcall test-line)
3640 (or (/= (match-end 1) (match-end 0))
3641 ;; The whitespace is sucked up by the
3642 ;; first [ \t]* glob if the prefix is empty.
3643 (and (= (match-beginning 1) (match-end 1))
3644 (/= (match-beginning 0) (match-end 0)))))
3645 ;; If the current line doesn't have text but do
3646 ;; have whitespace after the prefix, we'll use it.
3647 (throw 'found (cons fb-string
3648 (progn (goto-char fb-endpos)
3649 (current-column)))))
3651 (if (eq lit-type 'c++)
3652 ;; For line comments we can search up to and
3653 ;; including the first line.
3654 (while (and (zerop (forward-line -1))
3655 (>= (point) (car lit-limits)))
3656 (funcall test-line))
3657 ;; For block comments we must stop before the
3659 (while (and (zerop (forward-line -1))
3660 (> (point) (car lit-limits)))
3661 (funcall test-line)))
3663 (goto-char prefix-line)
3664 (while (and (zerop (forward-line 1))
3665 (< (point) (cdr lit-limits)))
3666 (funcall test-line))
3668 (goto-char prefix-line)
3672 ;; A good line wasn't found, but at least we have a
3673 ;; fallback that matches the comment prefix regexp.
3674 (cond ((or (string-match "\\s \\'" fb-string)
3676 (goto-char fb-endpos)
3678 ;; There are ws or text after the prefix, so
3680 (cons fb-string (current-column)))
3683 ;; Check if there's any whitespace padding
3684 ;; on the comment start line that we can
3685 ;; use after the prefix.
3686 (goto-char (car lit-limits))
3687 (if (looking-at comment-start-regexp)
3688 (goto-char (match-end 0))
3690 (skip-chars-forward " \t"))
3692 (eq (char-syntax (char-before)) ?\ )))
3694 (setq fb-string (buffer-substring-no-properties
3696 (skip-chars-backward " \t")
3699 (goto-char fb-endpos)
3700 (skip-chars-backward " \t")
3702 (let ((tmp (point)))
3703 ;; Got to mess in the buffer once again to
3704 ;; ensure the column gets correct. :P
3707 (insert-and-inherit fb-string)
3708 (cons (buffer-substring-no-properties
3712 (delete-region tmp (point)))))
3715 ;; Last resort: Just add a single space after
3717 (cons (concat fb-string " ")
3718 (progn (goto-char fb-endpos)
3719 (1+ (current-column)))))))
3721 ;; The line doesn't match the comment prefix regexp.
3723 ;; We have a fallback for line comments that we must use.
3724 (cons (concat (buffer-substring-no-properties
3725 prefix-line (c-point 'boi))
3727 (progn (back-to-indentation)
3728 (+ (current-column) (length comment-prefix))))
3730 ;; Assume we are dealing with a "free text" block
3731 ;; comment where the lines doesn't have any comment
3732 ;; prefix at all and we should just fill it as
3737 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
3738 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3739 ;; masked to allow adaptive filling to work correctly. That
3740 ;; includes narrowing the buffer and, if point is inside a comment,
3741 ;; masking the comment starter and ender appropriately.
3743 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3744 ;; The position of point is then less significant when doing masking
3747 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3748 ;; only if the point turns out to be inside a comment or a string.
3750 ;; Note that this function does not do any hidden buffer changes.
3753 ;; beg and end limits the region to narrow. end is a marker.
3755 ;; tmp-pre and tmp-post mark strings that are temporarily
3756 ;; inserted at the start and end of the region. tmp-pre is a
3757 ;; cons of the positions of the prepended string. tmp-post is
3758 ;; a marker pointing to the single character of the appended
3761 ;; If hang-ender-stuck isn't nil, the comment ender is
3762 ;; hanging. In that case it's set to the number of spaces
3763 ;; that should be between the text and the ender.
3765 ;; auto-fill-spaces is the exact sequence of whitespace between a
3766 ;; comment's last word and the comment ender, temporarily replaced
3767 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
3770 (c-lit-limits c-lit-limits)
3771 (c-lit-type c-lit-type))
3773 ;; Restore point on undo. It's necessary since we do a lot of
3774 ;; hidden inserts and deletes below that should be as transparent
3776 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
3777 (setq buffer-undo-list (cons (point) buffer-undo-list)))
3779 ;; Determine the limits and type of the containing literal (if any):
3780 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
3782 (c-save-buffer-state ()
3784 ;; Widen to catch comment limits correctly.
3786 (unless c-lit-limits
3787 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
3788 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
3790 (setq c-lit-type (c-literal-type c-lit-limits))))
3793 (unless (c-safe (backward-char)
3797 (forward-paragraph))
3798 (setq end (point-marker)))
3800 (unless (c-safe (forward-char)
3801 (backward-paragraph)
3804 (backward-paragraph))
3805 (setq beg (point))))
3809 ;; For each of the possible types of text (string, C comment ...)
3810 ;; determine BEG and END, the region we will narrow to. If we're in
3811 ;; a literal, constrain BEG and END to the limits of this literal.
3813 ;; For some of these text types, particularly a block comment, we
3814 ;; may need to massage whitespace near literal delimiters, so that
3815 ;; these don't get filled inappropriately.
3818 ((eq c-lit-type 'c++) ; Line comment.
3820 ;; Limit to the comment or paragraph end, whichever
3822 (set-marker end (min end (cdr c-lit-limits)))
3824 (when (<= beg (car c-lit-limits))
3825 ;; The region includes the comment starter, so we must
3827 (goto-char (car c-lit-limits))
3828 (back-to-indentation)
3829 (if (eq (point) (car c-lit-limits))
3830 ;; Include the first line in the region.
3831 (setq beg (c-point 'bol))
3832 ;; The first line contains code before the
3833 ;; comment. We must fake a line that doesn't.
3836 (setq apply-outside-literal t))
3838 ((eq c-lit-type 'c) ; Block comment.
3839 (when (>= end (cdr c-lit-limits))
3840 ;; The region includes the comment ender. If it's on its own
3841 ;; line, it stays on its own line. If it's got company on the
3842 ;; line, it keeps (at least one word of) it. "=====*/" counts
3843 ;; as a comment ender here, but "===== */" doesn't and "foo*/"
3847 (goto-char (cdr c-lit-limits))
3849 (and (search-forward-regexp
3850 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
3851 (- (cdr c-lit-limits) 2) t)
3852 (not (search-forward-regexp
3854 (- (cdr c-lit-limits) 2) 'limit))
3855 ;; The comment ender IS on its own line. Exclude
3856 ;; this line from the filling.
3857 (set-marker end (c-point 'bol))))
3859 ;; The comment ender is hanging. Replace all space between it
3860 ;; and the last word either by one or two 'x's (when
3861 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
3862 ;; as the whitespace (when auto filling), and include it in
3863 ;; the region. We'll change them back to whitespace
3864 ;; afterwards. The effect of this is to glue the comment
3865 ;; ender to the last word in the comment during filling.
3866 (let* ((ender-start (save-excursion
3867 (goto-char (cdr c-lit-limits))
3868 (skip-syntax-backward "^w ")
3870 (ender-column (save-excursion
3871 (goto-char ender-start)
3873 (point-rel (- ender-start here))
3877 ;; Insert a CR after the "*/", adjust END
3878 (goto-char (cdr c-lit-limits))
3879 (setq tmp-post (point-marker))
3881 (set-marker end (point))
3883 (forward-line -1) ; last line of the comment
3884 (if (and (looking-at (concat "[ \t]*\\(\\("
3885 c-current-comment-prefix
3887 (eq ender-start (match-end 0)))
3888 ;; The comment ender is prefixed by nothing but a
3889 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
3890 ;; 2006/4/28). Remove it along with surrounding ws.
3891 (setq spaces (- (match-end 1) (match-end 2)))
3892 (goto-char ender-start))
3893 (skip-chars-backward " \t\r\n") ; Surely this can be
3894 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
3896 ;; What's being tested here? 2006/4/20. FIXME!!!
3897 (if (/= (point) ender-start)
3899 (if (<= here (point))
3900 ;; Don't adjust point below if it's
3901 ;; before the string we replace.
3902 (setq point-rel -1))
3903 ;; Keep one or two spaces between the
3904 ;; text and the ender, depending on how
3905 ;; many there are now.
3907 (setq spaces (- ender-column (current-column))))
3908 (setq auto-fill-spaces (c-delete-and-extract-region
3909 (point) ender-start))
3910 ;; paragraph filling condenses multiple spaces to
3911 ;; single or double spaces. auto-fill doesn't.
3916 (if sentence-end-double-space 2 1))
3918 ;; Insert the filler first to keep marks right.
3919 (insert-char ?x spaces t)
3920 (setq hang-ender-stuck spaces)
3922 (and (>= point-rel 0)
3923 (- (point) (min point-rel spaces)))))
3924 (setq point-rel nil)))
3927 ;; Point was in the middle of the string we
3928 ;; replaced above, so put it back in the same
3929 ;; relative position, counting from the end.
3930 (goto-char point-rel)))
3933 (when (<= beg (car c-lit-limits))
3934 ;; The region includes the comment starter.
3936 (goto-char (car c-lit-limits))
3937 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
3938 ;; Begin with the next line.
3939 (setq beg (c-point 'bonl))
3940 ;; Fake the fill prefix in the first line.
3943 (setq apply-outside-literal t))
3945 ((eq c-lit-type 'string) ; String.
3947 (when (>= end (cdr c-lit-limits))
3948 (goto-char (1- (cdr c-lit-limits)))
3949 (setq tmp-post (point-marker))
3951 (set-marker end (point)))
3952 (when (<= beg (car c-lit-limits))
3953 (goto-char (1+ (car c-lit-limits)))
3954 (setq beg (if (looking-at "\\\\$")
3955 ;; Leave the start line if it's
3956 ;; nothing but an escaped newline.
3959 (setq apply-outside-literal t))
3961 ((eq c-lit-type 'pound) ; Macro
3962 ;; Narrow to the macro limits if they are nearer than the
3963 ;; paragraph limits. Don't know if this is necessary but
3964 ;; do it for completeness sake (doing auto filling at all
3965 ;; inside macros is bogus to begin with since the line
3966 ;; continuation backslashes aren't handled).
3968 (c-save-buffer-state ()
3969 (c-beginning-of-macro)
3976 (set-marker end (point))))))
3979 ;; Try to avoid comments and macros in the paragraph to
3980 ;; avoid that the adaptive fill mode gets the prefix from
3982 (c-save-buffer-state nil
3985 (c-forward-syntactic-ws end)
3989 (c-backward-syntactic-ws beg)
3991 (set-marker end (point))))))
3994 ;; Temporarily insert the fill prefix after the comment
3995 ;; starter so that the first line looks like any other
3996 ;; comment line in the narrowed region.
3997 (setq fill (c-save-buffer-state nil
3998 (c-guess-fill-prefix c-lit-limits c-lit-type)))
3999 (unless (string-match (concat "\\`[ \t]*\\("
4000 c-current-comment-prefix
4003 ;; Oops, the prefix doesn't match the comment prefix
4004 ;; regexp. This could produce very confusing
4005 ;; results with adaptive fill packages together with
4006 ;; the insert prefix magic below, since the prefix
4007 ;; often doesn't appear at all. So let's warn about
4010 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4012 ;; Find the right spot on the line, break it, insert
4013 ;; the fill prefix and make sure we're back in the
4014 ;; same column by temporarily prefixing the first word
4015 ;; with a number of 'x'.
4017 (goto-char (car c-lit-limits))
4018 (if (looking-at (if (eq c-lit-type 'c++)
4019 c-current-comment-prefix
4020 comment-start-skip))
4021 (goto-char (match-end 0))
4023 (skip-chars-forward " \t"))
4024 (while (and (< (current-column) (cdr fill))
4027 (let ((col (current-column)))
4028 (setq beg (1+ (point))
4029 tmp-pre (list (point)))
4032 (insert-and-inherit "\n" (car fill))
4033 (insert-char ?x (- col (current-column)) t))
4034 (setcdr tmp-pre (point))))))
4036 (when apply-outside-literal
4037 ;; `apply-outside-literal' is always set to t here if
4038 ;; we're inside a literal.
4042 ;; Kludge: If the function that adapts the fill prefix
4043 ;; doesn't produce the required comment starter for
4044 ;; line comments, then force it by setting fill-prefix.
4045 (when (and (eq c-lit-type 'c++)
4046 ;; Kludge the kludge: filladapt-mode doesn't
4047 ;; have this problem, but it currently
4048 ;; doesn't override fill-context-prefix
4050 (not (and (boundp 'filladapt-mode)
4054 (or (fill-context-prefix beg end)
4056 (c-save-buffer-state nil
4057 (car (or fill (c-guess-fill-prefix
4058 c-lit-limits c-lit-type)))))))
4060 ;; Save the relative position of point if it's outside the
4061 ;; region we're going to narrow. Want to restore it in that
4062 ;; case, but otherwise it should be moved according to the
4064 (point-rel (cond ((< (point) beg) (- (point) beg))
4065 ((> (point) end) (- (point) end)))))
4067 ;; Preparations finally done! Now we can call the
4071 (narrow-to-region beg end)
4074 ;; Restore point if it was outside the region.
4076 (goto-char (+ beg point-rel))
4077 (goto-char (+ end point-rel))))))))
4079 (when (consp tmp-pre)
4080 (delete-region (car tmp-pre) (cdr tmp-pre)))
4084 (goto-char tmp-post)
4086 (when hang-ender-stuck
4087 ;; Preserve point even if it's in the middle of the string
4088 ;; we replace; save-excursion doesn't work in that case.
4090 (goto-char tmp-post)
4091 (skip-syntax-backward "^w ")
4092 (forward-char (- hang-ender-stuck))
4093 (if (or fill-paragraph (not auto-fill-spaces))
4094 (insert-char ?\ hang-ender-stuck t)
4095 (insert auto-fill-spaces)
4096 (setq here (- here (- hang-ender-stuck (length auto-fill-spaces)))))
4097 (delete-char hang-ender-stuck)
4099 (set-marker tmp-post nil))
4101 (set-marker end nil))))
4103 (defun c-fill-paragraph (&optional arg)
4104 "Like \\[fill-paragraph] but handles C and C++ style comments.
4105 If any of the current line is a comment or within a comment, fill the
4106 comment or the paragraph of it that point is in, preserving the
4107 comment indentation or line-starting decorations (see the
4108 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4111 If point is inside multiline string literal, fill it. This currently
4112 does not respect escaped newlines, except for the special case when it
4113 is the very first thing in the string. The intended use for this rule
4114 is in situations like the following:
4116 char description[] = \"\\
4117 A very long description of something that you want to fill to make
4118 nicely formatted output.\"\;
4120 If point is in any other situation, i.e. in normal code, do nothing.
4122 Optional prefix ARG means justify paragraph as well."
4124 (let ((fill-paragraph-function
4125 ;; Avoid infinite recursion.
4126 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4127 fill-paragraph-function)))
4128 (c-mask-paragraph t nil 'fill-paragraph arg))
4129 ;; Always return t. This has the effect that if filling isn't done
4130 ;; above, it isn't done at all, and it's therefore effectively
4131 ;; disabled in normal code.
4134 (defun c-do-auto-fill ()
4135 ;; Do automatic filling if not inside a context where it should be
4137 (let ((c-auto-fill-prefix
4138 ;; The decision whether the line should be broken is actually
4139 ;; done in c-indent-new-comment-line, which do-auto-fill
4140 ;; calls to break lines. We just set this special variable
4141 ;; so that we'll know when we're called from there. It's
4142 ;; also used to detect whether fill-prefix is user set or
4143 ;; generated automatically by do-auto-fill.
4145 (c-mask-paragraph nil t 'do-auto-fill)))
4147 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4148 "Break line at point and indent, continuing comment or macro if within one.
4149 If inside a comment and `comment-multi-line' is non-nil, the
4150 indentation and line prefix are preserved (see the
4151 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4152 details). If inside a single line comment and `comment-multi-line' is
4153 nil, a new comment of the same type is started on the next line and
4154 indented as appropriate for comments. If inside a macro, a line
4155 continuation backslash is inserted and aligned as appropriate, and the
4156 new line is indented according to `c-syntactic-indentation'.
4158 If a fill prefix is specified, it overrides all the above."
4159 ;; allow-auto-fill is used from c-context-line-break to allow auto
4160 ;; filling to break the line more than once. Since this function is
4161 ;; used from auto-fill itself, that's normally disabled to avoid
4162 ;; unnecessary recursion.
4164 (let ((fill-prefix fill-prefix)
4167 (delete-horizontal-space)
4169 (insert-and-inherit ?\n)
4170 (newline (if allow-auto-fill nil 1)))))
4171 ;; Already know the literal type and limits when called from
4172 ;; c-context-line-break.
4173 (c-lit-limits c-lit-limits)
4174 (c-lit-type c-lit-type)
4175 (c-macro-start c-macro-start))
4177 (c-save-buffer-state ()
4178 (when (not (eq c-auto-fill-prefix t))
4179 ;; Called from do-auto-fill.
4180 (unless c-lit-limits
4181 (setq c-lit-limits (c-literal-limits nil nil t)))
4183 (setq c-lit-type (c-literal-type c-lit-limits)))
4184 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4185 ((null c-lit-type) 'code)
4188 (setq fill-prefix t) ; Used as flag in the cond.
4189 (if (and (null c-auto-fill-prefix)
4191 (<= (c-point 'bol) (car c-lit-limits)))
4192 ;; The adaptive fill function has generated a prefix, but
4193 ;; we're on the first line in a block comment so it'll be
4194 ;; wrong. Ignore it to guess a better one below.
4195 (setq fill-prefix nil)
4196 (when (and (eq c-lit-type 'c++)
4197 (not (string-match (concat "\\`[ \t]*"
4198 c-line-comment-starter)
4199 (or fill-prefix ""))))
4200 ;; Kludge: If the function that adapted the fill prefix
4201 ;; doesn't produce the required comment starter for line
4202 ;; comments, then we ignore it.
4203 (setq fill-prefix nil)))
4206 (cond ((eq fill-prefix t)
4207 ;; A call from do-auto-fill which should be ignored.
4210 ;; A fill-prefix overrides anything.
4211 (funcall do-line-break)
4212 (insert-and-inherit fill-prefix))
4213 ((c-save-buffer-state ()
4214 (unless c-lit-limits
4215 (setq c-lit-limits (c-literal-limits)))
4217 (setq c-lit-type (c-literal-type c-lit-limits)))
4218 (memq c-lit-type '(c c++)))
4219 ;; Some sort of comment.
4220 (if (or comment-multi-line
4222 (goto-char (car c-lit-limits))
4224 (< (point) (cdr c-lit-limits))))
4225 ;; Inside a comment that should be continued.
4226 (let ((fill (c-save-buffer-state nil
4227 (c-guess-fill-prefix
4229 (c-collect-line-comments c-lit-limits))
4233 (or (and (eq c-lit-type 'c)
4235 (goto-char (- (cdr c-lit-limits) 2))
4236 (if (looking-at "\\*/") (point))))
4237 (cdr c-lit-limits))))
4238 ;; Skip forward past the fill prefix in case
4239 ;; we're standing in it.
4241 ;; FIXME: This doesn't work well in cases like
4243 ;; /* Bla bla bla bla bla
4246 ;; If point is on the 'B' then the line will be
4247 ;; broken after "Bla b".
4248 (while (and (< (current-column) (cdr fill))
4251 (if (and (> (point) comment-text-end)
4252 (> (c-point 'bol) (car c-lit-limits)))
4254 ;; The skip takes us out of the (block)
4255 ;; comment; insert the fill prefix at bol
4256 ;; instead and keep the position.
4257 (setq pos (copy-marker pos t))
4259 (insert-and-inherit (car fill))
4260 (if soft (insert-and-inherit ?\n) (newline 1))
4262 (set-marker pos nil))
4263 ;; Don't break in the middle of a comment starter
4265 (cond ((> (point) comment-text-end)
4266 (goto-char comment-text-end))
4267 ((< (point) (+ (car c-lit-limits) 2))
4268 (goto-char (+ (car c-lit-limits) 2))))
4269 (funcall do-line-break)
4270 (insert-and-inherit (car fill))))
4271 ;; Inside a comment that should be broken.
4272 (let ((comment-start comment-start)
4273 (comment-end comment-end)
4275 (if (eq c-lit-type 'c)
4276 (unless (string-match "[ \t]*/\\*" comment-start)
4277 (setq comment-start "/* " comment-end " */"))
4278 (unless (string-match "[ \t]*//" comment-start)
4279 (setq comment-start "// " comment-end "")))
4280 (setq col (save-excursion
4281 (back-to-indentation)
4283 (funcall do-line-break)
4284 (when (and comment-end (not (equal comment-end "")))
4286 (insert-and-inherit comment-end)
4288 ;; c-comment-indent may look at the current
4289 ;; indentation, so let's start out with the same
4290 ;; indentation as the previous one.
4292 (insert-and-inherit comment-start)
4293 (indent-for-comment))))
4294 ((c-query-and-set-macro-start)
4296 (unless (looking-at "[ \t]*\\\\$")
4297 ;; Do not clobber the alignment of the line continuation
4298 ;; slash; c-backslash-region might look at it.
4299 (delete-horizontal-space))
4300 ;; Got an asymmetry here: In normal code this command
4301 ;; doesn't indent the next line syntactically, and otoh a
4302 ;; normal syntactically indenting newline doesn't continue
4304 (c-newline-and-indent (if allow-auto-fill nil 1)))
4306 ;; Somewhere else in the code.
4307 (let ((col (save-excursion
4309 (while (and (looking-at "[ \t]*\\\\?$")
4310 (= (forward-line -1) 0)))
4311 (current-indentation))))
4312 (funcall do-line-break)
4313 (indent-to col))))))
4315 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
4316 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line)
4318 ;; advice for indent-new-comment-line for older Emacsen
4319 (unless (boundp 'comment-line-break-function)
4320 (defvar c-inside-line-break-advice nil)
4321 (defadvice indent-new-comment-line (around c-line-break-advice
4322 activate preactivate)
4323 "Call `c-indent-new-comment-line' if in CC Mode."
4324 (if (or c-inside-line-break-advice
4325 (not c-buffer-is-cc-mode))
4327 (let ((c-inside-line-break-advice t))
4328 (c-indent-new-comment-line (ad-get-arg 0))))))
4330 (defun c-context-line-break ()
4331 "Do a line break suitable to the context.
4333 When point is outside a comment or macro, insert a newline and indent
4334 according to the syntactic context, unless `c-syntactic-indentation'
4335 is nil, in which case the new line is indented as the previous
4336 non-empty line instead.
4338 When point is inside the content of a preprocessor directive, a line
4339 continuation backslash is inserted before the line break and aligned
4340 appropriately. The end of the cpp directive doesn't count as inside
4343 When point is inside a comment, continue it with the appropriate
4344 comment prefix (see the `c-comment-prefix-regexp' and
4345 `c-block-comment-prefix' variables for details). The end of a
4346 C++-style line comment doesn't count as inside it.
4348 When point is inside a string, only insert a backslash when it is also
4349 inside a preprocessor directive."
4352 (let* (c-lit-limits c-lit-type
4353 (c-macro-start c-macro-start))
4355 (c-save-buffer-state ()
4356 (setq c-lit-limits (c-literal-limits nil nil t)
4357 c-lit-type (c-literal-type c-lit-limits))
4358 (when (eq c-lit-type 'c++)
4359 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4360 (c-query-and-set-macro-start))
4363 ((or (eq c-lit-type 'c)
4364 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4366 (skip-chars-forward " \t")
4368 (1- (cdr c-lit-limits))))
4369 (and (numberp c-macro-start) ; Macro, but not at the very end of
4370 ; it, not in a string, and not in the
4372 (not (eq c-lit-type 'string))
4373 (or (not (looking-at "\\s *$"))
4374 (eq (char-before) ?\\))
4376 (goto-char c-macro-start)
4377 (if (looking-at c-opt-cpp-start)
4378 (goto-char (match-end 0)))
4381 (let ((comment-multi-line t)
4383 (c-indent-new-comment-line nil t)))
4385 ((eq c-lit-type 'string)
4386 (if (and (numberp c-macro-start)
4387 (not (eq (char-before) ?\\)))
4391 (t (delete-horizontal-space)
4393 ;; c-indent-line may look at the current indentation, so let's
4394 ;; start out with the same indentation as the previous line.
4395 (let ((col (save-excursion
4398 (while (and (looking-at "[ \t]*\\\\?$")
4399 (= (forward-line -1) 0)))
4400 (current-indentation))))
4402 (indent-according-to-mode)))))
4404 (defun c-context-open-line ()
4405 "Insert a line break suitable to the context and leave point before it.
4406 This is the `c-context-line-break' equivalent to `open-line', which is
4407 normally bound to C-o. See `c-context-line-break' for the details."
4409 (let ((here (point)))
4412 ;; Temporarily insert a non-whitespace char to keep any
4413 ;; preceding whitespace intact.
4415 (c-context-line-break))
4420 (cc-provide 'cc-cmds)
4422 ;;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
4423 ;;; cc-cmds.el ends here