1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
10 ;; 1987 Dave Detlefs and Stewart Clamen
11 ;; 1985 Richard M. Stallman
12 ;; Maintainer: bug-cc-mode@gnu.org
13 ;; Created: 22-Apr-1997 (split from cc-mode.el)
14 ;; Version: See cc-mode.el
15 ;; Keywords: c languages oop
17 ;; This file is part of GNU Emacs.
19 ;; GNU Emacs is free software; you can redistribute it and/or modify
20 ;; it under the terms of the GNU General Public License as published by
21 ;; the Free Software Foundation; either version 2, or (at your option)
24 ;; GNU Emacs is distributed in the hope that it will be useful,
25 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
26 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 ;; GNU General Public License for more details.
29 ;; You should have received a copy of the GNU General Public License
30 ;; along with this program; see the file COPYING. If not, write to
31 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
32 ;; Boston, MA 02110-1301, USA.
40 (if (and (boundp 'byte-compile-dest-file)
41 (stringp byte-compile-dest-file))
42 (cons (file-name-directory byte-compile-dest-file) load-path)
44 (load "cc-bytecomp" nil t)))
48 (cc-require 'cc-engine)
50 ;; Silence the compiler.
51 (cc-bytecomp-defun delete-forward-p) ; XEmacs
52 (cc-bytecomp-defvar filladapt-mode) ; c-fill-paragraph contains a kludge
53 ; which looks at this.
54 (cc-bytecomp-defun c-forward-subword)
55 (cc-bytecomp-defun c-backward-subword)
57 ;; Indentation / Display syntax functions
58 (defvar c-fix-backslashes t)
60 (defun c-indent-line (&optional syntax quiet ignore-point-pos)
61 "Indent the current line according to the syntactic context,
62 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
63 syntactic information for the current line. Be silent about syntactic
64 errors if the optional argument QUIET is non-nil, even if
65 `c-report-syntactic-errors' is non-nil. Normally the position of
66 point is used to decide where the old indentation is on a lines that
67 is otherwise empty \(ignoring any line continuation backslash), but
68 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
69 indentation change \(in columns)."
71 (let ((line-cont-backslash (save-excursion
73 (eq (char-before) ?\\)))
74 (c-fix-backslashes c-fix-backslashes)
77 (when (and (not ignore-point-pos)
80 (looking-at (if line-cont-backslash
83 (<= (point) (match-end 1)))
84 ;; Delete all whitespace after point if there's only whitespace
85 ;; on the line, so that any code that does back-to-indentation
86 ;; or similar gets the current column in this case. If this
87 ;; removes a line continuation backslash it'll be restored
89 (unless c-auto-align-backslashes
90 ;; Should try to keep the backslash alignment
93 (goto-char (match-end 0))
94 (setq bs-col (1- (current-column)))))
95 (delete-region (point) (match-end 0))
96 (setq c-fix-backslashes t))
97 (if c-syntactic-indentation
99 (or (let ((c-parsing-error nil)
102 (and (boundp 'c-syntactic-context)
103 c-syntactic-context))))
104 (c-save-buffer-state (indent)
105 (unless c-syntactic-context
106 (setq c-syntactic-context (c-guess-basic-syntax)))
107 (setq indent (c-get-syntactic-indentation
108 c-syntactic-context))
109 (and (not (c-echo-parsing-error quiet))
110 c-echo-syntactic-information-p
111 (message "syntax: %s, indent: %d"
112 c-syntactic-context indent))
113 (setq shift-amt (- indent (current-indentation))))
114 (c-shift-line-indentation shift-amt)
115 (run-hooks 'c-special-indent-hook)
120 (while (and (= (forward-line -1) 0)
121 (if (looking-at "\\s *\\\\?$")
123 (setq indent (current-indentation))
125 (setq shift-amt (- indent (current-indentation)))
126 (c-shift-line-indentation shift-amt)))
127 (when (and c-fix-backslashes line-cont-backslash)
132 (when c-auto-align-backslashes
133 ;; Realign the line continuation backslash.
134 (c-backslash-region (point) (point) nil t))))
137 (defun c-newline-and-indent (&optional newline-arg)
138 "Insert a newline and indent the new line.
139 This function fixes line continuation backslashes if inside a macro,
140 and takes care to set the indentation before calling
141 `indent-according-to-mode', so that lineup functions like
142 `c-lineup-dont-change' works better."
144 ;; TODO: Backslashes before eol in comments and literals aren't
146 (let ((c-macro-start (c-query-macro-start))
147 ;; Avoid calling c-backslash-region from c-indent-line if it's
148 ;; called during the newline call, which can happen due to
149 ;; c-electric-continued-statement, for example. We also don't
150 ;; want any backslash alignment from indent-according-to-mode.
151 (c-fix-backslashes nil)
152 has-backslash insert-backslash
157 (while (and (looking-at "[ \t]*\\\\?$")
158 (= (forward-line -1) 0)))
159 (setq col (current-indentation)))
161 (if (and (eolp) (eq (char-before) ?\\))
162 (setq insert-backslash t
164 (setq has-backslash (eq (char-before (c-point 'eol)) ?\\))))
165 (newline newline-arg)
170 ;; The backslash stayed on the previous line. Insert one
171 ;; before calling c-backslash-region, so that
172 ;; bs-col-after-end in it works better. Fixup the
173 ;; backslashes on the newly inserted line.
176 (c-backslash-region (point) (point) nil t))
177 ;; The backslash moved to the new line, if there was any. Let
178 ;; c-backslash-region fix a backslash on the previous line,
179 ;; and the one that might be on the new line.
180 ;; c-auto-align-backslashes is intentionally ignored here;
181 ;; maybe the moved backslash should be left alone if it's set,
182 ;; but we fix both lines on the grounds that the old backslash
183 ;; has been moved anyway and is now in a different context.
184 (c-backslash-region start (if has-backslash (point) start) nil t)))
185 (when c-syntactic-indentation
186 ;; Reindent syntactically. The indentation done above is not
187 ;; wasted, since c-indent-line might look at the current
189 (let ((c-syntactic-context (c-save-buffer-state nil
190 (c-guess-basic-syntax))))
191 ;; We temporarily insert another line break, so that the
192 ;; lineup functions will see the line as empty. That makes
193 ;; e.g. c-lineup-cpp-define more intuitive since it then
194 ;; proceeds to the preceding line in this case.
196 (delete-horizontal-space)
197 (setq start (- (point-max) (point)))
201 (indent-according-to-mode))
202 (goto-char (- (point-max) start))
205 ;; Must align the backslash again after reindentation. The
206 ;; c-backslash-region call above can't be optimized to ignore
207 ;; this line, since it then won't align correctly with the
208 ;; lines below if the first line in the macro is broken.
209 (c-backslash-region (point) (point) nil t)))))
211 (defun c-show-syntactic-information (arg)
212 "Show syntactic information for current line.
213 With universal argument, inserts the analysis as a comment on that line."
215 (let* ((c-parsing-error nil)
216 (syntax (if (boundp 'c-syntactic-context)
217 ;; Use `c-syntactic-context' in the same way as
218 ;; `c-indent-line', to be consistent.
220 (c-save-buffer-state nil
221 (c-guess-basic-syntax)))))
222 (if (not (consp arg))
224 (message "Syntactic analysis: %s" syntax)
228 (setq elem (pop syntax))
229 (when (setq pos (c-langelem-pos elem))
230 (push (c-put-overlay pos (1+ pos)
233 (when (setq pos (c-langelem-2nd-pos elem))
234 (push (c-put-overlay pos (1+ pos)
235 'face 'secondary-selection)
239 (c-delete-overlay (pop ols)))))
241 (insert-and-inherit (format "%s" syntax))
243 (c-keep-region-active))
245 (defun c-syntactic-information-on-region (from to)
246 "Insert a comment with the syntactic analysis on every line in the region."
250 (narrow-to-region from to)
251 (goto-char (point-min))
253 (c-show-syntactic-information '(0))
257 ;; Minor mode functions.
258 (defun c-update-modeline ()
259 (let ((fmt (format "/%s%s%s%s"
260 (if c-electric-flag "l" "")
261 (if (and c-electric-flag c-auto-newline)
263 (if c-hungry-delete-key "h" "")
265 ;; cc-subword might not be loaded.
266 (boundp 'c-subword-mode)
267 (symbol-value 'c-subword-mode))
270 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name)
271 (substring mode-name (match-beginning 1) (match-end 1))
273 ;; (setq c-submode-indicators
274 ;; (if (> (length fmt) 1)
277 (if (> (length fmt) 1)
278 (concat bare-mode-name fmt)
280 (force-mode-line-update)))
282 (defun c-toggle-syntactic-indentation (&optional arg)
283 "Toggle syntactic indentation.
284 Optional numeric ARG, if supplied, turns on syntactic indentation when
285 positive, turns it off when negative, and just toggles it when zero or
288 When syntactic indentation is turned on (the default), the indentation
289 functions and the electric keys indent according to the syntactic
290 context keys, when applicable.
292 When it's turned off, the electric keys don't reindent, the indentation
293 functions indents every new line to the same level as the previous
294 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
295 specified by `c-basic-offset'. The indentation style has no effect in
296 this mode, nor any of the indentation associated variables,
297 e.g. `c-special-indent-hook'.
299 This command sets the variable `c-syntactic-indentation'."
301 (setq c-syntactic-indentation
302 (c-calculate-state arg c-syntactic-indentation))
303 (c-keep-region-active))
305 (defun c-toggle-auto-newline (&optional arg)
306 "Toggle auto-newline feature.
307 Optional numeric ARG, if supplied, turns on auto-newline when
308 positive, turns it off when negative, and just toggles it when zero or
311 Turning on auto-newline automatically enables electric indentation.
313 When the auto-newline feature is enabled (indicated by \"/la\" on the
314 modeline after the mode name) newlines are automatically inserted
315 after special characters such as brace, comma, semi-colon, and colon."
318 (c-calculate-state arg (and c-auto-newline c-electric-flag)))
319 (if c-auto-newline (setq c-electric-flag t))
321 (c-keep-region-active))
323 (defalias 'c-toggle-auto-state 'c-toggle-auto-newline)
324 (make-obsolete 'c-toggle-auto-state 'c-toggle-auto-newline)
326 (defun c-toggle-hungry-state (&optional arg)
327 "Toggle hungry-delete-key feature.
328 Optional numeric ARG, if supplied, turns on hungry-delete when
329 positive, turns it off when negative, and just toggles it when zero or
332 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
333 the modeline after the mode name) the delete key gobbles all preceding
334 whitespace in one fell swoop."
336 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
338 (c-keep-region-active))
340 (defun c-toggle-auto-hungry-state (&optional arg)
341 "Toggle auto-newline and hungry-delete-key features.
342 Optional numeric ARG, if supplied, turns on auto-newline and
343 hungry-delete when positive, turns them off when negative, and just
344 toggles them when zero or left out.
346 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
348 (setq c-auto-newline (c-calculate-state arg c-auto-newline))
349 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
351 (c-keep-region-active))
353 (defun c-toggle-electric-state (&optional arg)
354 "Toggle the electric indentation feature.
355 Optional numeric ARG, if supplied, turns on electric indentation when
356 positive, turns it off when negative, and just toggles it when zero or
359 (setq c-electric-flag (c-calculate-state arg c-electric-flag))
361 (c-keep-region-active))
366 (defun c-electric-backspace (arg)
367 "Delete the preceding character or whitespace.
368 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
369 line) then all preceding whitespace is consumed. If however a prefix
370 argument is supplied, or `c-hungry-delete-key' is nil, or point is
371 inside a literal then the function in the variable
372 `c-backspace-function' is called."
374 (if (c-save-buffer-state ()
375 (or (not c-hungry-delete-key)
378 (funcall c-backspace-function (prefix-numeric-value arg))
379 (c-hungry-delete-backwards)))
381 (defun c-hungry-delete-backwards ()
382 "Delete the preceding character or all preceding whitespace
383 back to the previous non-whitespace character.
384 See also \\[c-hungry-delete-forward]."
386 (let ((here (point)))
388 (if (/= (point) here)
389 (delete-region (point) here)
390 (funcall c-backspace-function 1))))
392 (defalias 'c-hungry-backspace 'c-hungry-delete-backwards)
394 (defun c-electric-delete-forward (arg)
395 "Delete the following character or whitespace.
396 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
397 line) then all following whitespace is consumed. If however a prefix
398 argument is supplied, or `c-hungry-delete-key' is nil, or point is
399 inside a literal then the function in the variable `c-delete-function'
402 (if (c-save-buffer-state ()
403 (or (not c-hungry-delete-key)
406 (funcall c-delete-function (prefix-numeric-value arg))
407 (c-hungry-delete-forward)))
409 (defun c-hungry-delete-forward ()
410 "Delete the following character or all following whitespace
411 up to the next non-whitespace character.
412 See also \\[c-hungry-delete-backwards]."
414 (let ((here (point)))
416 (if (/= (point) here)
417 (delete-region (point) here)
418 (funcall c-delete-function 1))))
420 ;; This function is only used in XEmacs.
421 (defun c-electric-delete (arg)
422 "Deletes preceding or following character or whitespace.
423 This function either deletes forward as `c-electric-delete-forward' or
424 backward as `c-electric-backspace', depending on the configuration: If
425 the function `delete-forward-p' is defined and returns non-nil, it
426 deletes forward. Otherwise it deletes backward.
428 Note: This is the way in XEmacs to choose the correct action for the
429 \[delete] key, whichever key that means. Other flavors don't use this
430 function to control that."
432 (if (and (fboundp 'delete-forward-p)
434 (c-electric-delete-forward arg)
435 (c-electric-backspace arg)))
437 ;; This function is only used in XEmacs.
438 (defun c-hungry-delete ()
439 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
440 The direction of deletion depends on the configuration: If the
441 function `delete-forward-p' is defined and returns non-nil, it deletes
442 forward using `c-hungry-delete-forward'. Otherwise it deletes
443 backward using `c-hungry-backspace'.
445 Note: This is the way in XEmacs to choose the correct action for the
446 \[delete] key, whichever key that means. Other flavors don't use this
447 function to control that."
449 (if (and (fboundp 'delete-forward-p)
451 (c-hungry-delete-forward)
452 (c-hungry-delete-backwards)))
454 (defun c-electric-pound (arg)
456 If `c-electric-flag' is set, handle it specially according to the variable
457 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
458 inside a literal or a macro, nothing special happens."
460 (if (c-save-buffer-state ()
462 (not c-electric-flag)
463 (not (memq 'alignleft c-electric-pound-behavior))
465 (skip-chars-backward " \t")
468 (and (= (forward-line -1) 0)
470 (eq (char-before) ?\\))))
472 ;; do nothing special
473 (self-insert-command (prefix-numeric-value arg))
474 ;; place the pound character at the left edge
475 (let ((pos (- (point-max) (point)))
478 (delete-horizontal-space)
479 (insert last-command-char)
481 (goto-char (- (point-max) pos)))
484 (defun c-point-syntax ()
485 ;; Return the syntactic context of the construct at point. (This is NOT
486 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
487 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
488 (c-save-buffer-state (;; shut this up too
489 (c-echo-syntactic-information-p nil)
491 (c-tentative-buffer-changes
492 ;; insert a newline to isolate the construct at point for syntactic
495 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
496 ;; the syntax. (There might already be an escaped NL there.)
497 (when (or (c-at-vsemi-p (1- (point)))
501 (and (c-beginning-of-macro)
502 (progn (c-end-of-macro)
507 (let ((c-syntactic-indentation-in-macros t)
508 (c-auto-newline-analysis t))
509 ;; Turn on syntactic macro analysis to help with auto
511 (setq syntax (c-guess-basic-syntax))
515 (defun c-brace-newlines (syntax)
516 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
517 ;; (not necessarily the same as the S.C. of the line it is on). Return
518 ;; NEWLINES, the list containing some combination of the symbols `before'
519 ;; and `after' saying where newlines should be inserted.
522 ;; This is the list of brace syntactic symbols that can hang.
523 ;; If any new ones are added to c-offsets-alist, they should be
524 ;; added here as well.
525 '(class-open class-close defun-open defun-close
526 inline-open inline-close
527 brace-list-open brace-list-close
528 brace-list-intro brace-entry-open
529 block-open block-close
530 substatement-open statement-case-open
531 extern-lang-open extern-lang-close
532 namespace-open namespace-close
533 module-open module-close
534 composition-open composition-close
535 inexpr-class-open inexpr-class-close
536 ;; `statement-cont' is here for the case with a brace
537 ;; list opener inside a statement. C.f. CASE B.2 in
538 ;; `c-guess-continued-construct'.
541 (c-echo-syntactic-information-p nil)
542 symb-newlines) ; e.g. (substatement-open . (after))
545 ;; Do not try to insert newlines around a special
546 ;; (Pike-style) brace list.
547 (if (and c-special-brace-lists
549 (c-safe (if (= (char-before) ?{)
552 (c-looking-at-special-brace-list))))
554 ;; Seek the matching entry in c-hanging-braces-alist.
557 ;; Substitute inexpr-class and class-open or
558 ;; class-close with inexpr-class-open or
559 ;; inexpr-class-close.
560 (if (assq 'inexpr-class syntax)
561 (cond ((assq 'class-open syntax)
562 '((inexpr-class-open)))
563 ((assq 'class-close syntax)
564 '((inexpr-class-close)))
567 c-hanging-braces-alist)
568 '(ignore before after)))) ; Default, when not in c-h-b-l.
570 ;; If syntax is a function symbol, then call it using the
571 ;; defined semantics.
572 (if (and (not (consp (cdr symb-newlines)))
573 (functionp (cdr symb-newlines)))
574 (let ((c-syntactic-context syntax))
575 (funcall (cdr symb-newlines)
578 (cdr symb-newlines))))
580 (defun c-try-one-liner ()
581 ;; Point is just after a newly inserted }. If the non-whitespace
582 ;; content of the braces is a single line of code, compact the whole
583 ;; construct to a single line, if this line isn't too long. The Right
584 ;; Thing is done with comments.
586 ;; Point will be left after the }, regardless of whether the clean-up is
587 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
590 (pos (- (point-max) (point)))
591 mbeg1 mend1 mbeg4 mend4
592 eol-col cmnt-pos cmnt-col cmnt-gap)
597 ;; Avoid backtracking over a very large block. The one we
598 ;; deal with here can never be more than three lines.
599 (narrow-to-region (save-excursion
603 (and (c-safe (c-backward-sexp))
606 (narrow-to-region (point) (1- here)) ; innards of {.}
608 (cc-eval-when-compile
610 "\\(" ; (match-beginning 1)
611 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
612 "\\)" ; (match-end 1)
613 "[^ \t\r\n]+\\([ \t]+[^ \t\r\n]+\\)*" ; non-WS
614 "\\(" ; (match-beginning 4)
615 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
616 "\\)\\'"))))))) ; (match-end 4) at EOB.
618 (if (c-tentative-buffer-changes
619 (setq mbeg1 (match-beginning 1) mend1 (match-end 1)
620 mbeg4 (match-beginning 4) mend4 (match-end 4))
621 (backward-char) ; back over the `}'
623 (setq cmnt-pos (and (c-backward-single-comment)
624 (- (point) (- mend1 mbeg1)))))
625 (delete-region mbeg4 mend4)
626 (delete-region mbeg1 mend1)
627 (setq eol-col (save-excursion (end-of-line) (current-column)))
629 ;; Necessary to put the closing brace before any line
630 ;; oriented comment to keep it syntactically significant.
631 ;; This isn't necessary for block comments, but the result
632 ;; looks nicer anyway.
634 (delete-char 1) ; the `}' has blundered into a comment
636 (setq cmnt-col (1+ (current-column)))
637 (setq cmnt-pos (1+ cmnt-pos)) ; we're inserting a `}'
639 (insert-char ?\} 1) ; reinsert the `}' before the comment.
640 (setq cmnt-gap (- cmnt-col (current-column)))
641 (when (zerop cmnt-gap)
642 (insert-char ?\ 1) ; Put a space before a bare comment.
645 (or (null c-max-one-liner-length)
646 (zerop c-max-one-liner-length)
647 (<= eol-col c-max-one-liner-length)
648 ;; Can we trim space before comment to make the line fit?
650 (< (- eol-col cmnt-gap) c-max-one-liner-length)
651 (progn (goto-char cmnt-pos)
652 (backward-delete-char-untabify
653 (- eol-col c-max-one-liner-length))
655 (goto-char (- (point-max) pos))))))
657 (defun c-electric-brace (arg)
660 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
661 numeric ARG hasn't been supplied, the command performs several electric
664 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
665 the mode line) newlines are inserted before and after the brace as
666 directed by the settings in `c-hanging-braces-alist'.
668 \(b) Any auto-newlines are indented. The original line is also
669 reindented unless `c-syntactic-indentation' is nil.
671 \(c) If auto-newline is turned on, various newline cleanups based on the
672 settings of `c-cleanup-list' are done."
675 (let (safepos literal
676 ;; We want to inhibit blinking the paren since this would be
677 ;; most disruptive. We'll blink it ourselves later on.
678 (old-blink-paren blink-paren-function)
679 blink-paren-function)
681 (c-save-buffer-state ()
682 (setq safepos (c-safe-position (point) (c-parse-state))
683 literal (c-in-literal safepos)))
685 ;; Insert the brace. Note that expand-abbrev might reindent
686 ;; the line here if there's a preceding "else" or something.
687 (self-insert-command (prefix-numeric-value arg))
689 (when (and c-electric-flag (not literal) (not arg))
690 (if (not (looking-at "[ \t]*\\\\?$"))
691 (if c-syntactic-indentation
692 (indent-according-to-mode))
694 (let ( ;; shut this up too
695 (c-echo-syntactic-information-p nil)
697 ln-syntax br-syntax syntax) ; Syntactic context of the original line,
698 ; of the brace itself, of the line the brace ends up on.
699 (c-save-buffer-state ((c-syntactic-indentation-in-macros t)
700 (c-auto-newline-analysis t))
701 (setq ln-syntax (c-guess-basic-syntax)))
702 (if c-syntactic-indentation
703 (c-indent-line ln-syntax))
707 (setq br-syntax (c-point-syntax)
708 newlines (c-brace-newlines br-syntax))
710 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
711 (if (and (memq 'before newlines)
712 (> (current-column) (current-indentation)))
713 (if c-syntactic-indentation
714 ;; Only a plain newline for now - it's indented
715 ;; after the cleanups when the line has its final
718 (c-newline-and-indent)))
721 ;; `syntax' is the syntactic context of the line which ends up
722 ;; with the brace on it.
723 (setq syntax (if (memq 'before newlines) br-syntax ln-syntax))
725 ;; Do all appropriate clean ups
727 (pos (- (point-max) (point)))
731 ;; `}': clean up empty defun braces
732 (when (c-save-buffer-state ()
733 (and (memq 'empty-defun-braces c-cleanup-list)
734 (eq last-command-char ?\})
735 (c-intersect-lists '(defun-close class-close inline-close)
740 (eq (char-before) ?\{))
741 ;; make sure matching open brace isn't in a comment
742 (not (c-in-literal))))
743 (delete-region (point) (1- here))
744 (setq here (- (point-max) pos)))
747 ;; `}': compact to a one-liner defun?
750 (and (eq last-command-char ?\})
751 (memq 'one-liner-defun c-cleanup-list)
752 (c-intersect-lists '(defun-close) syntax)
754 (setq here (- (point-max) pos))))
756 ;; `{': clean up brace-else-brace and brace-elseif-brace
757 (when (eq last-command-char ?\{)
759 ((and (memq 'brace-else-brace c-cleanup-list)
762 "\\([ \t\n]\\|\\\\\n\\)*"
764 "\\([ \t\n]\\|\\\\\n\\)*"
768 (delete-region (match-beginning 0) (match-end 0))
769 (insert-and-inherit "} else {"))
770 ((and (memq 'brace-elseif-brace c-cleanup-list)
772 (goto-char (1- here))
776 (eq (char-before) ?\)))
777 (zerop (c-save-buffer-state nil (c-backward-token-2 1 t)))
778 (eq (char-after) ?\()
783 "\\([ \t\n]\\|\\\\\n\\)*"
785 "\\([ \t\n]\\|\\\\\n\\)+"
787 "\\([ \t\n]\\|\\\\\n\\)*"
790 ;(eq (match-end 0) tmp);
792 (delete-region mbeg mend)
796 (goto-char (- (point-max) pos))
798 ;; Indent the line after the cleanups since it might
799 ;; very well indent differently due to them, e.g. if
800 ;; c-indent-one-line-block is used together with the
801 ;; one-liner-defun cleanup.
802 (when c-syntactic-indentation
805 ;; does a newline go after the brace?
806 (if (memq 'after newlines)
807 (c-newline-and-indent))
811 (and (eq last-command-char ?\})
812 (not executing-kbd-macro)
815 (c-save-buffer-state nil
816 (c-backward-syntactic-ws safepos))
817 (funcall old-blink-paren)))))
819 (defun c-electric-slash (arg)
820 "Insert a slash character.
822 If the slash is inserted immediately after the comment prefix in a c-style
823 comment, the comment might get closed by removing whitespace and possibly
824 inserting a \"*\". See the variable `c-cleanup-list'.
826 Indent the line as a comment, if:
828 1. The slash is second of a \"//\" line oriented comment introducing
829 token and we are on a comment-only-line, or
831 2. The slash is part of a \"*/\" token that closes a block oriented
834 If a numeric ARG is supplied, point is inside a literal, or
835 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
838 (let ((literal (c-save-buffer-state () (c-in-literal)))
841 (c-echo-syntactic-information-p nil))
843 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
844 ;; `c-syntactic-indentation' set.
847 (memq 'comment-close-slash c-cleanup-list)
848 (eq last-command-char ?/)
849 (looking-at (concat "[ \t]*\\("
850 (regexp-quote comment-end) "\\)?$"))
851 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
854 (narrow-to-region (point-min) (point))
855 (back-to-indentation)
856 (looking-at (concat c-current-comment-prefix "[ \t]*$")))))
857 (kill-region (progn (forward-line 0) (point))
858 (progn (end-of-line) (point)))
859 (insert-char ?* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
861 (setq indentp (and (not arg)
862 c-syntactic-indentation
864 (eq last-command-char ?/)
865 (eq (char-before) (if literal ?* ?/))))
866 (self-insert-command (prefix-numeric-value arg))
868 (indent-according-to-mode))))
870 (defun c-electric-star (arg)
871 "Insert a star character.
872 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
873 the star is the second character of a C style comment starter on a
874 comment-only-line, indent the line as a comment. If a numeric ARG is
875 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
876 this indentation is inhibited."
879 (self-insert-command (prefix-numeric-value arg))
880 ;; if we are in a literal, or if arg is given do not reindent the
881 ;; current line, unless this star introduces a comment-only line.
882 (if (c-save-buffer-state ()
883 (and c-syntactic-indentation
886 (eq (c-in-literal) 'c)
887 (eq (char-before) ?*)
890 (skip-chars-backward "*")
891 (if (eq (char-before) ?/)
893 (skip-chars-backward " \t")
895 (let (c-echo-syntactic-information-p) ; shut this up
896 (indent-according-to-mode))
899 (defun c-electric-semi&comma (arg)
900 "Insert a comma or semicolon.
902 If `c-electric-flag' is non-nil, point isn't inside a literal and a
903 numeric ARG hasn't been supplied, the command performs several electric
906 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
907 the mode line) a newline might be inserted. See the variable
908 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
910 \(b) Any auto-newlines are indented. The original line is also
911 reindented unless `c-syntactic-indentation' is nil.
913 \(c) If auto-newline is turned on, a comma following a brace list or a
914 semicolon following a defun might be cleaned up, depending on the
915 settings of `c-cleanup-list'."
917 (let* (lim literal c-syntactic-context
920 (c-echo-syntactic-information-p nil))
922 (c-save-buffer-state ()
923 (setq lim (c-most-enclosing-brace (c-parse-state))
924 literal (c-in-literal lim)))
926 (self-insert-command (prefix-numeric-value arg))
928 (if (and c-electric-flag (not literal) (not arg))
929 ;; do all cleanups and newline insertions if c-auto-newline is on.
930 (if (or (not c-auto-newline)
931 (not (looking-at "[ \t]*\\\\?$")))
932 (if c-syntactic-indentation
934 ;; clean ups: list-close-comma or defun-close-semi
935 (let ((pos (- (point-max) (point))))
936 (if (c-save-buffer-state ()
938 (eq last-command-char ?,)
939 (memq 'list-close-comma c-cleanup-list))
941 (eq last-command-char ?\;)
942 (memq 'defun-close-semi c-cleanup-list)))
946 (eq (char-before) ?}))
947 ;; make sure matching open brace isn't in a comment
948 (not (c-in-literal lim))))
949 (delete-region (point) here))
950 (goto-char (- (point-max) pos)))
952 (when c-syntactic-indentation
953 (setq c-syntactic-context (c-guess-basic-syntax))
954 (c-indent-line c-syntactic-context))
955 ;; check to see if a newline should be added
956 (let ((criteria c-hanging-semi&comma-criteria)
957 answer add-newline-p)
959 (setq answer (funcall (car criteria)))
960 ;; only nil value means continue checking
962 (setq criteria (cdr criteria))
964 ;; only 'stop specifically says do not add a newline
965 (setq add-newline-p (not (eq answer 'stop)))
968 (c-newline-and-indent))
971 (defun c-electric-colon (arg)
974 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
975 numeric ARG hasn't been supplied, the command performs several electric
978 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
979 the mode line) newlines are inserted before and after the colon based on
980 the settings in `c-hanging-colons-alist'.
982 \(b) Any auto-newlines are indented. The original line is also
983 reindented unless `c-syntactic-indentation' is nil.
985 \(c) If auto-newline is turned on, whitespace between two colons will be
986 \"cleaned up\" leaving a scope operator, if this action is set in
990 (let* ((bod (c-point 'bod))
991 (literal (c-save-buffer-state () (c-in-literal bod)))
994 (c-echo-syntactic-information-p nil))
995 (self-insert-command (prefix-numeric-value arg))
996 ;; Any electric action?
997 (if (and c-electric-flag (not literal) (not arg))
998 ;; Unless we're at EOL, only re-indentation happens.
999 (if (not (looking-at "[ \t]*\\\\?$"))
1000 (if c-syntactic-indentation
1001 (indent-according-to-mode))
1003 ;; scope-operator clean-up?
1004 (let ((pos (- (point-max) (point)))
1006 (if (c-save-buffer-state () ; Why do we need this? [ACM, 2003-03-12]
1008 (memq 'scope-operator c-cleanup-list)
1009 (eq (char-before) ?:)
1012 (c-skip-ws-backward)
1013 (eq (char-before) ?:))
1014 (not (c-in-literal))
1015 (not (eq (char-after (- (point) 2)) ?:))))
1017 (delete-region (point) (1- here))
1018 (setq is-scope-op t)))
1019 (goto-char (- (point-max) pos)))
1021 ;; indent the current line if it's done syntactically.
1022 (if c-syntactic-indentation
1023 ;; Cannot use the same syntax analysis as we find below,
1024 ;; since that's made with c-syntactic-indentation-in-macros
1026 (indent-according-to-mode))
1028 ;; Calculate where, if anywhere, we want newlines.
1029 (c-save-buffer-state
1030 ((c-syntactic-indentation-in-macros t)
1031 (c-auto-newline-analysis t)
1032 ;; Turn on syntactic macro analysis to help with auto newlines
1034 (syntax (c-guess-basic-syntax))
1036 ;; Translate substatement-label to label for this operation.
1038 (if (eq (car (car elem)) 'substatement-label)
1039 (setcar (car elem) 'label))
1040 (setq elem (cdr elem)))
1041 ;; some language elements can only be determined by checking
1042 ;; the following line. Lets first look for ones that can be
1043 ;; found when looking on the line with the colon
1046 (or (c-lookup-lists '(case-label label access-label)
1047 syntax c-hanging-colons-alist)
1048 (c-lookup-lists '(member-init-intro inher-intro)
1052 (c-guess-basic-syntax)
1054 c-hanging-colons-alist)))))
1055 ;; does a newline go before the colon? Watch out for already
1056 ;; non-hung colons. However, we don't unhang them because that
1057 ;; would be a cleanup (and anti-social).
1058 (if (and (memq 'before newlines)
1061 (skip-chars-backward ": \t")
1063 (let ((pos (- (point-max) (point))))
1065 (c-newline-and-indent)
1066 (goto-char (- (point-max) pos))))
1067 ;; does a newline go after the colon?
1068 (if (and (memq 'after (cdr-safe newlines))
1070 (c-newline-and-indent))
1073 (defun c-electric-lt-gt (arg)
1074 "Insert a \"<\" or \">\" character.
1075 If the current language uses angle bracket parens (e.g. template
1076 arguments in C++), try to find out if the inserted character is a
1077 paren and give it paren syntax if appropriate.
1079 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1080 line will be reindented if the inserted character is a paren or if it
1081 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1082 numeric argument is supplied, or the point is inside a literal."
1085 (let ((c-echo-syntactic-information-p nil)
1086 final-pos close-paren-inserted)
1088 (self-insert-command (prefix-numeric-value arg))
1089 (setq final-pos (point))
1091 (c-save-buffer-state (c-parse-and-markup-<>-arglists
1092 c-restricted-<>-arglists
1095 (when c-recognize-<>-arglists
1096 (if (eq last-command-char ?<)
1101 (c-beginning-of-current-token)
1104 (c-backward-token-2)
1105 (looking-at c-opt-<>-sexp-key)))
1106 (c-mark-<-as-paren (1- final-pos)))
1108 ;; It's a ">". Check if there's an earlier "<" which either has
1109 ;; open paren syntax already or that can be recognized as an arglist
1110 ;; together with this ">". Note that this won't work in cases like
1111 ;; "template <x, a < b, y>" but they ought to be rare.
1114 ;; Narrow to avoid that `c-forward-<>-arglist' below searches past
1116 (narrow-to-region (point-min) final-pos)
1120 (goto-char final-pos)
1121 (c-syntactic-skip-backward "^<;}" nil t)
1122 (eq (char-before) ?<))
1125 ;; If the "<" already got open paren syntax we know we
1126 ;; have the matching closer. Handle it and exit the
1128 (if (looking-at "\\s\(")
1130 (c-mark->-as-paren (1- final-pos))
1131 (setq close-paren-inserted t)
1136 (setq <-pos (point))
1137 (c-backward-syntactic-ws)
1138 (c-simple-skip-symbol-backward))
1139 (or (looking-at c-opt-<>-sexp-key)
1140 (not (looking-at c-keywords-regexp)))
1142 (let ((c-parse-and-markup-<>-arglists t)
1143 c-restricted-<>-arglists
1145 (c-most-enclosing-brace (c-parse-state))))
1146 (when (and containing-sexp
1147 (progn (goto-char containing-sexp)
1148 (eq (char-after) ?\())
1149 (not (eq (get-text-property (point) 'c-type)
1150 'c-decl-arg-start)))
1151 (setq c-restricted-<>-arglists t))
1153 (c-forward-<>-arglist nil))
1155 ;; Loop here if the "<" we found above belongs to a nested
1156 ;; angle bracket sexp. When we start over we'll find the
1157 ;; previous or surrounding sexp.
1158 (if (< (point) final-pos)
1160 (setq close-paren-inserted t)
1162 (goto-char final-pos)
1164 ;; Indent the line if appropriate.
1165 (when (and c-electric-flag c-syntactic-indentation)
1167 (when (prog1 (or (looking-at "\\s\(\\|\\s\)")
1168 (and (c-major-mode-is 'c++-mode)
1170 (c-beginning-of-current-token)
1171 (looking-at "<<\\|>>"))
1172 (= (match-end 0) final-pos)))
1173 (goto-char final-pos))
1174 (indent-according-to-mode)))
1176 (when (and close-paren-inserted
1177 (not executing-kbd-macro)
1178 blink-paren-function)
1179 ;; Note: Most paren blink functions, such as the standard
1180 ;; `blink-matching-open', currently doesn't handle paren chars
1181 ;; marked with text properties very well. Maybe we should avoid
1182 ;; this call for the time being?
1183 (funcall blink-paren-function))))
1185 (defun c-electric-paren (arg)
1186 "Insert a parenthesis.
1188 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1189 line is reindented unless a numeric ARG is supplied, or the parenthesis
1190 is inserted inside a literal.
1192 Whitespace between a function name and the parenthesis may get added or
1193 removed; see the variable `c-cleanup-list'.
1195 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1196 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1198 (let ((literal (c-save-buffer-state () (c-in-literal)))
1200 (c-echo-syntactic-information-p nil))
1201 (self-insert-command (prefix-numeric-value arg))
1203 (if (and (not arg) (not literal))
1204 (let* ( ;; We want to inhibit blinking the paren since this will
1205 ;; be most disruptive. We'll blink it ourselves
1207 (old-blink-paren blink-paren-function)
1208 blink-paren-function)
1209 (if (and c-syntactic-indentation c-electric-flag)
1210 (indent-according-to-mode))
1212 ;; If we're at EOL, check for new-line clean-ups.
1213 (when (and c-electric-flag c-auto-newline
1214 (looking-at "[ \t]*\\\\?$"))
1216 ;; clean up brace-elseif-brace
1218 (and (memq 'brace-elseif-brace c-cleanup-list)
1219 (eq last-command-char ?\()
1222 "\\([ \t\n]\\|\\\\\n\\)*"
1224 "\\([ \t\n]\\|\\\\\n\\)+"
1226 "\\([ \t\n]\\|\\\\\n\\)*"
1230 (not (c-save-buffer-state () (c-in-literal))))
1231 (delete-region (match-beginning 0) (match-end 0))
1232 (insert-and-inherit "} else if ("))
1234 ;; clean up brace-catch-brace
1236 (and (memq 'brace-catch-brace c-cleanup-list)
1237 (eq last-command-char ?\()
1240 "\\([ \t\n]\\|\\\\\n\\)*"
1242 "\\([ \t\n]\\|\\\\\n\\)*"
1246 (not (c-save-buffer-state () (c-in-literal))))
1247 (delete-region (match-beginning 0) (match-end 0))
1248 (insert-and-inherit "} catch (")))
1250 ;; Check for clean-ups at function calls. These two DON'T need
1251 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1252 ;; Point is currently just after the inserted paren.
1253 (let (beg (end (1- (point))))
1256 ;; space-before-funcall clean-up?
1257 ((and (memq 'space-before-funcall c-cleanup-list)
1258 (eq last-command-char ?\()
1261 (skip-chars-backward " \t")
1263 (c-save-buffer-state () (c-on-identifier))
1264 ;; Don't add a space into #define FOO()....
1265 (not (and (c-beginning-of-macro)
1266 (c-forward-over-cpp-define-id)
1267 (eq (point) beg)))))
1269 (delete-region beg end)
1273 ;; compact-empty-funcall clean-up?
1274 ((c-save-buffer-state ()
1275 (and (memq 'compact-empty-funcall c-cleanup-list)
1276 (eq last-command-char ?\))
1278 (c-safe (backward-char 2))
1279 (when (looking-at "()")
1281 (skip-chars-backward " \t")
1283 (c-on-identifier)))))
1284 (delete-region beg end))))
1285 (and (eq last-input-event ?\))
1286 (not executing-kbd-macro)
1288 (funcall old-blink-paren))))))
1290 (defun c-electric-continued-statement ()
1291 "Reindent the current line if appropriate.
1293 This function is used to reindent the line after a keyword which
1294 continues an earlier statement is typed, e.g. an \"else\" or the
1295 \"while\" in a do-while block.
1297 The line is reindented if there is nothing but whitespace before the
1298 keyword on the line, the keyword is not inserted inside a literal, and
1299 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1300 (let (;; shut this up
1301 (c-echo-syntactic-information-p nil))
1302 (when (c-save-buffer-state ()
1303 (and c-electric-flag
1304 c-syntactic-indentation
1305 (not (eq last-command-char ?_))
1307 (skip-syntax-backward "w")
1310 (not (c-in-literal (c-point 'bod)))))
1311 ;; Have to temporarily insert a space so that
1312 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1313 ;; space with a nonspace to avoid messing up any whitespace
1314 ;; sensitive meddling that might be done, e.g. by
1315 ;; `c-backslash-region'.
1316 (insert-and-inherit " x")
1318 (indent-according-to-mode)
1319 (delete-char -2)))))
1322 ;; "nomenclature" functions + c-scope-operator.
1323 (defun c-forward-into-nomenclature (&optional arg)
1324 "Compatibility alias for `c-forward-subword'."
1326 (require 'cc-subword)
1327 (c-forward-subword arg))
1328 (make-obsolete 'c-forward-into-nomenclature 'c-forward-subword)
1330 (defun c-backward-into-nomenclature (&optional arg)
1331 "Compatibility alias for `c-backward-subword'."
1333 (require 'cc-subword)
1334 (c-backward-subword arg))
1335 (make-obsolete 'c-backward-into-nomenclature 'c-backward-subword)
1337 (defun c-scope-operator ()
1338 "Insert a double colon scope operator at point.
1339 No indentation or other \"electric\" behavior is performed."
1341 (insert-and-inherit "::"))
1344 ;; Movement (etc.) by defuns.
1345 (defun c-in-function-trailer-p (&optional lim)
1346 ;; Return non-nil if point is between the closing brace and the semicolon of
1347 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1348 ;; portion of a declaration like "struct foo {...} bar ;".
1350 ;; Return the position of the main declaration. Otherwise, return nil.
1351 ;; Point is assumed to be at the top level and outside of any macro or
1354 ;; If LIM is non-nil, it is the bound on a the backward search for the
1355 ;; beginning of the declaration.
1357 ;; This function might do hidden buffer changes.
1358 (and c-opt-block-decls-with-vars-key
1360 (c-syntactic-skip-backward "^;}" lim)
1361 (and (eq (char-before) ?\})
1362 (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1363 (looking-at c-opt-block-decls-with-vars-key)
1366 (defun c-where-wrt-brace-construct ()
1367 ;; Determine where we are with respect to functions (or other brace
1368 ;; constructs, included in the term "function" in the rest of this comment).
1369 ;; Point is assumed to be outside any macro or literal.
1370 ;; This is used by c-\(begining\|end\)-of-defun.
1372 ;; Return one of these symbols:
1373 ;; at-header : we're at the start of a function's header.
1374 ;; in-header : we're inside a function's header, this extending right
1375 ;; up to the brace. This bit includes any k&r declarations.
1376 ;; in-block : we're inside a function's brace block.
1377 ;; in-trailer : we're in the area between the "}" and ";" of something
1378 ;; like "struct foo {...} bar, baz;".
1379 ;; at-function-end : we're just after the closing brace (or semicolon) that
1380 ;; terminates the function.
1381 ;; outwith-function: we're not at or in any function. Being inside a
1382 ;; non-brace construct also counts as 'outwith-function'.
1384 ;; 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 ;; NOTE: If we're in a K&R region, this might be the start
1420 ;; of a parameter declaration, not the actual function.
1421 (and least-enclosing ; LIMIT for c-b-of-decl-1
1422 (c-safe-position least-enclosing paren-state)))))
1424 ;; Has the declaration we've gone back to got braces?
1427 (and (c-syntactic-re-search-forward "[;{]" nil t t)
1428 (or (eq (char-before) ?\{)
1429 (and c-recognize-knr-p
1430 ;; Might have stopped on the
1431 ;; ';' in a K&R argdecl. In
1432 ;; that case the declaration
1433 ;; should contain a block.
1434 (c-in-knr-argdecl))))))
1437 ((= (point) kluge-start) ; might be BOB or unbalanced parens.
1439 ((eq decl-result 'same)
1441 (if (eq (point) start)
1445 ((eq decl-result 'previous)
1446 (if (and (not brace-decl-p)
1447 (c-in-function-trailer-p))
1451 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1454 (defun c-backward-to-nth-BOF-{ (n where)
1455 ;; Skip to the opening brace of the Nth function before point. If
1456 ;; point is inside a function, this counts as the first. Point must be
1457 ;; outside any comment/string or macro.
1459 ;; N must be strictly positive.
1460 ;; WHERE describes the position of point, one of the symbols `at-header',
1461 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1462 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1464 ;; If we run out of functions, leave point at BOB. Return zero on success,
1465 ;; otherwise the number of {s still to go.
1467 ;; This function may do hidden buffer changes
1469 ;; What we do to go back the first defun depends on where we start.
1471 ((eq where 'in-block)
1472 (goto-char (c-least-enclosing-brace (c-parse-state)))
1474 ((eq where 'in-header)
1475 (c-syntactic-re-search-forward "{")
1478 (;; (or (eq where 'at-header) (eq where 'outwith-function)
1479 ;; (eq where 'at-function-end) (eq where 'in-trailer))
1480 (memq where '(at-header outwith-function at-function-end in-trailer))
1481 (c-syntactic-skip-backward "^}")
1482 (when (eq (char-before) ?\})
1485 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where)))
1487 ;; Each time round the loop, go back to a "{" at the outermost level.
1488 (while (and (> n 0) (not (bobp)))
1489 (c-parse-state) ; This call speeds up the following one
1490 ; by a factor of ~6. Hmmm. 2006/4/5.
1491 (c-syntactic-skip-backward "^}")
1492 (when (eq (char-before) ?\})
1497 (defun c-beginning-of-defun (&optional arg)
1498 "Move backward to the beginning of a defun.
1499 Every top level declaration that contains a brace paren block is
1500 considered to be a defun.
1502 With a positive argument, move backward that many defuns. A negative
1503 argument -N means move forward to the Nth following beginning. Return
1504 t unless search stops due to beginning or end of buffer.
1506 Unlike the built-in `beginning-of-defun' this tries to be smarter
1507 about finding the char with open-parenthesis syntax that starts the
1511 (or arg (setq arg 1))
1513 (c-save-buffer-state
1515 where paren-state pos)
1517 ;; Move back out of any macro/comment/string we happen to be in.
1518 (c-beginning-of-macro)
1519 (setq pos (c-literal-limits))
1520 (if pos (goto-char (car pos)))
1522 (setq where (c-where-wrt-brace-construct))
1525 ;; Move forward to the closing brace of a function.
1527 (if ;; (or (eq where 'at-function-end) (eq where 'outwith-function))
1528 (memq where '(at-function-end outwith-function))
1529 (setq arg (1+ arg)))
1531 (setq arg (c-forward-to-nth-EOF-} (- arg) where)))
1532 ;; Move forward to the next opening brace....
1533 (when (and (= arg 0)
1534 (c-syntactic-re-search-forward "{" nil t))
1536 ;; ... and backward to the function header.
1537 (c-beginning-of-decl-1)
1540 ;; Move backward to the opening brace of a function.
1541 (when (and (> arg 0)
1542 (eq (setq arg (c-backward-to-nth-BOF-{ arg where)) 0))
1544 ;; Go backward to this function's header.
1545 (c-beginning-of-decl-1)
1548 ;; We're now there, modulo comments and whitespace.
1549 ;; Try to be line oriented; position point at the closest
1550 ;; preceding boi that isn't inside a comment, but if we hit
1551 ;; the previous declaration then we use the current point
1553 (while (and (/= (point) (c-point 'boi))
1554 (c-backward-single-comment)))
1555 (if (/= (point) (c-point 'boi))
1558 (c-keep-region-active)
1561 (defun c-forward-to-nth-EOF-} (n where)
1562 ;; Skip to the closing brace of the Nth function after point. If
1563 ;; point is inside a function, this counts as the first. Point must be
1564 ;; outside any comment/string or macro.
1566 ;; N must be strictly positive.
1567 ;; WHERE describes the position of point, one of the symbols `at-header',
1568 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1569 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1571 ;; If we run out of functions, leave point at EOB. Return zero on success,
1572 ;; otherwise the number of }s still to go.
1574 ;; This function may do hidden buffer changes.
1577 ;; What we do to go forward over the first defun depends on where we
1578 ;; start. We go to the closing brace of that defun, even when we go
1579 ;; backwards to it (in a "struct foo {...} bar ;").
1581 ((eq where 'in-block)
1582 (goto-char (c-least-enclosing-brace (c-parse-state)))
1585 ((eq where 'in-trailer)
1586 (c-syntactic-skip-backward "^}")
1588 (;; (or (eq where 'at-function-end) (eq where 'outwith-function)
1589 ;; (eq where 'at-header) (eq where 'in-header))
1590 (memq where '(at-function-end outwith-function at-header in-header))
1591 (c-syntactic-re-search-forward "{")
1595 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1597 ;; Each time round the loop, go forward to a "}" at the outermost level.
1598 (while (and (> n 0) (not (eobp)))
1599 ;(c-parse-state) ; This call speeds up the following one by a factor
1600 ; of ~6. Hmmm. 2006/4/5.
1601 (when (c-syntactic-re-search-forward "{" nil 'eob)
1607 (defun c-end-of-defun (&optional arg)
1608 "Move forward to the end of a top level declaration.
1609 With argument, do it that many times. Negative argument -N means move
1610 back to Nth preceding end. Returns t unless search stops due to
1611 beginning or end of buffer.
1613 An end of a defun occurs right after the close-parenthesis that matches
1614 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1616 (or arg (setq arg 1))
1618 (c-save-buffer-state
1620 where paren-state pos)
1622 ;; Move back out of any macro/comment/string we happen to be in.
1623 (c-beginning-of-macro)
1624 (setq pos (c-literal-limits))
1625 (if pos (goto-char (car pos)))
1627 (setq where (c-where-wrt-brace-construct))
1630 ;; Move backwards to the } of a function
1632 (if ;; (or (eq where 'at-header) (eq where 'outwith-function))
1633 (memq where '(at-header outwith-function))
1634 (setq arg (1+ arg)))
1636 (setq arg (c-backward-to-nth-BOF-{ (- arg) where)))
1637 (when (and (= arg 0)
1638 (c-syntactic-skip-backward "^}")
1639 (eq (char-before) ?\}))
1642 ;; Move forward to the } of a function
1644 (setq arg (c-forward-to-nth-EOF-} arg where))))
1646 ;; Do we need to move forward from the brace to the semicolon?
1648 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1649 (c-syntactic-re-search-forward ";"))
1652 ;; We're there now, modulo comments and whitespace.
1653 ;; Try to be line oriented; position point after the next
1654 ;; newline that isn't inside a comment, but if we hit the
1655 ;; next declaration then we use the current point instead.
1656 (while (and (not (bolp))
1657 (not (looking-at "\\s *$"))
1658 (c-forward-single-comment)))
1660 ((looking-at "\\s *$")
1665 (c-keep-region-active)
1668 (defun c-declaration-limits (near)
1669 ;; Return a cons of the beginning and end positions of the current
1670 ;; top level declaration or macro. If point is not inside any then
1671 ;; nil is returned, unless NEAR is non-nil in which case the closest
1672 ;; following one is chosen instead (if there is any). The end
1673 ;; position is at the next line, providing there is one before the
1676 ;; This function might do hidden buffer changes.
1679 ;; Note: Some code duplication in `c-beginning-of-defun' and
1680 ;; `c-end-of-defun'.
1682 (let ((start (point))
1683 (paren-state (c-parse-state))
1686 (goto-char (c-least-enclosing-brace paren-state))
1687 ;; If we moved to the outermost enclosing paren then we
1688 ;; can use c-safe-position to set the limit. Can't do
1689 ;; that otherwise since the earlier paren pair on
1690 ;; paren-state might very well be part of the
1691 ;; declaration we should go to.
1692 (setq lim (c-safe-position (point) paren-state))
1694 ;; At top level. Make sure we aren't inside a literal.
1695 (setq pos (c-literal-limits
1696 (c-safe-position (point) paren-state)))
1697 (if pos (goto-char (car pos))))
1699 (when (c-beginning-of-macro)
1708 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1710 ;; We moved back over the previous defun. Skip to the next
1711 ;; one. Not using c-forward-syntactic-ws here since we
1712 ;; should not skip a macro. We can also be directly after
1713 ;; the block in a `c-opt-block-decls-with-vars-key'
1714 ;; declaration, but then we won't move significantly far
1717 (c-forward-comments)
1719 (when (and near (c-beginning-of-macro))
1727 (if (eobp) (throw 'exit nil))
1729 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1730 ;; declaration that doesn't end there. We're searching back and
1731 ;; forth over the block here, which can be expensive.
1733 (if (and c-opt-block-decls-with-vars-key
1735 (c-backward-syntactic-ws)
1736 (eq (char-before) ?}))
1737 (eq (car (c-beginning-of-decl-1))
1741 (and (> (point) pos)
1742 (setq end-pos (point)))))
1746 (if (and (not near) (> (point) start))
1749 ;; Try to be line oriented; position the limits at the
1750 ;; closest preceding boi, and after the next newline, that
1751 ;; isn't inside a comment, but if we hit a neighboring
1752 ;; declaration then we instead use the exact declaration
1753 ;; limit in that direction.
1756 (while (and (/= (point) (c-point 'boi))
1757 (c-backward-single-comment)))
1758 (if (/= (point) (c-point 'boi))
1766 (while (and (not (bolp))
1767 (not (looking-at "\\s *$"))
1768 (c-forward-single-comment)))
1771 ((looking-at "\\s *$")
1778 (defun c-mark-function ()
1779 "Put mark at end of the current top-level declaration or macro, point at beginning.
1780 If point is not inside any then the closest following one is chosen.
1782 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1783 function does not require the declaration to contain a brace block."
1787 (c-save-buffer-state nil
1788 ;; We try to be line oriented, unless there are several
1789 ;; declarations on the same line.
1790 (if (looking-at c-syntactic-eol)
1791 (c-backward-token-2 1 nil (c-point 'bol)))
1792 (setq decl-limits (c-declaration-limits t)))
1794 (if (not decl-limits)
1795 (error "Cannot find any declaration")
1796 (goto-char (car decl-limits))
1797 (push-mark (cdr decl-limits) nil t))))
1800 ;; Movement by statements.
1801 (defun c-in-comment-line-prefix-p ()
1802 ;; Point is within a comment. Is it also within a comment-prefix?
1803 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1805 ;; This function might do hidden buffer changes.
1806 (let ((here (point)))
1809 (skip-chars-forward " \t")
1810 (and (looking-at c-current-comment-prefix)
1811 (/= (match-beginning 0) (match-end 0))
1812 (< here (match-end 0))))))
1814 (defun c-narrow-to-comment-innards (range)
1815 ;; Narrow to the "inside" of the comment (block) defined by range, as
1818 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
1819 ;; present) removed. A c++-style line comment retains its opening "//" but
1820 ;; has any final NL removed. If POINT is currently outwith these innards,
1821 ;; move it to the appropriate boundary.
1823 ;; This narrowing simplifies the sentence movement functions, since it
1824 ;; eliminates awkward things at the boundaries of the comment (block).
1826 ;; This function might do hidden buffer changes.
1827 (let* ((lit-type (c-literal-type range))
1828 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
1829 (end (if (eq lit-type 'c)
1830 (if (and (eq (char-before (cdr range)) ?/)
1831 (eq (char-before (1- (cdr range))) ?*))
1834 (if (eq (cdr range) (point-max))
1836 (- (cdr range) 1)))))
1838 (goto-char end)) ; This would be done automatically by ...
1840 (goto-char beg)) ; ... narrow-to-region but is not documented.
1841 (narrow-to-region beg end)))
1843 (defun c-beginning-of-sentence-in-comment (range)
1844 ;; Move backwards to the "beginning of a sentence" within the comment
1845 ;; defined by RANGE, a cons of its starting and ending positions. If we
1846 ;; find a BOS, return NIL. Otherwise, move point to just before the start
1847 ;; of the comment and return T.
1849 ;; The BOS is either text which follows a regexp match of sentence-end,
1850 ;; or text which is a beginning of "paragraph".
1851 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
1853 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1854 ;; It is not a general function, but is intended only for calling from
1855 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
1857 ;; This function might do hidden buffer changes.
1859 (let ((start-point (point)))
1861 (c-narrow-to-comment-innards range) ; This may move point back.
1862 (let* ((here (point))
1864 (here-filler ; matches WS and comment-prefices at point.
1865 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
1866 "\\|[ \t\n\r\f]\\)*"))
1867 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
1868 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
1869 ;; First, find the previous paragraph start, if any.
1870 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
1872 (forward-paragraph -1) ; uses cc-mode values of
1873 ; paragraph-\(start\|separate\)
1874 (if (> (re-search-forward here-filler nil t) here)
1876 (when (>= (point) here)
1877 (forward-paragraph -2)
1878 (if (> (re-search-forward here-filler nil t) here)
1882 ;; Now seek successively earlier sentence ends between PAR-BEG and
1883 ;; HERE, until the "start of sentence" following it is earlier than
1884 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
1885 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
1887 (goto-char (match-end 0)) ; tentative beginning of sentence
1888 (or (>= (point) here)
1889 (and (not (bolp)) ; Found a non-blank comment-prefix?
1891 (if (re-search-backward prefix-at-bol-here nil t)
1892 (/= (match-beginning 1) (match-end 1)))))
1893 (progn ; Skip the crud to find a real b-o-s.
1894 (if (c-in-comment-line-prefix-p)
1895 (beginning-of-line))
1896 (re-search-forward here-filler) ; always succeeds.
1897 (>= (point) here))))
1899 (re-search-forward here-filler)))
1901 (if (< (point) start-point)
1903 (goto-char (car range))
1906 (defun c-end-of-sentence-in-comment (range)
1907 ;; Move forward to the "end of a sentence" within the comment defined by
1908 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
1909 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
1910 ;; return NIL. Otherwise, move point to just after the end of the comment
1913 ;; The EOS is just after the non-WS part of the next match of the regexp
1914 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
1915 ;; no sentence-end match following point, any WS before the end of the
1916 ;; comment will count as EOS, providing we're not already in it.
1918 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1919 ;; It is not a general function, but is intended only for calling from
1920 ;; c-move-over-sentence.
1922 ;; This function might do hidden buffer changes.
1924 (let ((start-point (point))
1925 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
1928 (c-narrow-to-comment-innards range) ; This might move point forwards.
1929 (let* ((here (point))
1930 (par-end ; EOL position of last text in current/next paragraph.
1932 ;; The cc-mode values of paragraph-\(start\|separate\), set
1933 ;; in c-setup-paragraph-variables, are used in the
1935 (forward-paragraph 1)
1936 (if (eq (preceding-char) ?\n) (forward-char -1))
1937 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
1939 (forward-paragraph 2)
1940 (if (eq (preceding-char) ?\n) (forward-char -1)))
1945 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
1946 ;; Go forward one "comment-prefix which looks like sentence-end"
1947 ;; each time round the following:
1948 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
1951 (skip-chars-backward " \t\n")
1952 (or (and (not (bolp))
1953 (re-search-backward prefix-at-bol-here nil t)
1954 (/= (match-beginning 1) (match-end 1)))
1955 (<= (point) here))))
1958 ;; Take special action if we're up against the end of a comment (of
1959 ;; either sort): Leave point just after the last non-ws text.
1960 (if (eq (point) (point-max))
1961 (while (or (/= (skip-chars-backward " \t\n") 0)
1962 (and (re-search-backward prefix-at-bol-here nil t)
1963 (/= (match-beginning 1) (match-end 1))))))))
1965 (if (> (point) start-point)
1967 (goto-char (cdr range))
1970 (defun c-beginning-of-sentence-in-string (range)
1971 ;; Move backwards to the "beginning of a sentence" within the string defined
1972 ;; by RANGE, a cons of its starting and ending positions (enclosing the
1973 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
1974 ;; just before the start of the string and return T.
1976 ;; The BOS is either the text which follows a regexp match of sentence-end
1977 ;; or text which is a beginning of "paragraph". For the purposes of
1978 ;; determining paragraph boundaries, escaped newlines are treated as
1979 ;; ordinary newlines.
1981 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1982 ;; It is not a general function, but is intended only for calling from
1983 ;; c-move-over-sentence.
1985 ;; This function might do hidden buffer changes.
1987 (let* ((here (point)) last
1988 (end (1- (cdr range)))
1989 (here-filler ; matches WS and escaped newlines at point.
1990 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
1991 ;; Enhance paragraph-start and paragraph-separate also to recognise
1992 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
1993 ;; these values should be customizable user options, or something.
1994 (paragraph-start c-string-par-start)
1995 (paragraph-separate c-string-par-separate)
1997 (par-beg ; beginning of current (or previous) paragraph.
2000 (narrow-to-region (1+ (car range)) end)
2001 (forward-paragraph -1) ; uses above values of
2002 ; paragraph-\(start\|separate\)
2003 (if (> (re-search-forward here-filler nil t) here)
2005 (when (>= (point) here)
2006 (forward-paragraph -2)
2007 (if (> (re-search-forward here-filler nil t) here)
2010 ;; Now see if we can find a sentence end after PAR-BEG.
2011 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2013 (goto-char (match-end 0))
2017 here-filler end t) ; always succeeds. Use end rather
2018 ; than here, in case point starts
2019 ; beyond the closing quote.
2020 (>= (point) here))))
2022 (re-search-forward here-filler here t)
2023 (if (< (point) here)
2025 (goto-char (car range))
2028 (defun c-end-of-sentence-in-string (range)
2029 ;; Move forward to the "end of a sentence" within the string defined by
2030 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2031 ;; return NIL. Otherwise, move point to just after the end of the string
2034 ;; The EOS is just after the non-WS part of the next match of the regexp
2035 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2036 ;; no sentence-end match following point, any WS before the end of the
2037 ;; string will count as EOS, providing we're not already in it.
2039 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2040 ;; It is not a general function, but is intended only for calling from
2041 ;; c-move-over-sentence.
2043 ;; This function might do hidden buffer changes.
2045 (let* ((here (point))
2047 ;; Enhance paragraph-start and paragraph-separate to recognise
2048 ;; blank lines terminated by escaped EOLs.
2049 (paragraph-start c-string-par-start)
2050 (paragraph-separate c-string-par-separate)
2052 (par-end ; EOL position of last text in current/next paragraph.
2055 (narrow-to-region (car range) (1- (cdr range)))
2056 ;; The above values of paragraph-\(start\|separate\) are used
2057 ;; in the following.
2058 (forward-paragraph 1)
2060 ;; (re-search-backward filler-here nil t) would find an empty
2061 ;; string. Therefore we simulate it by the following:
2062 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2063 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2064 (unless (> (point) here)
2066 (forward-paragraph 1)
2067 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2068 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2070 ;; Try to go forward a sentence.
2071 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2073 (while (or (/= (skip-chars-backward " \t\n") 0)
2074 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2075 ;; Did we move a sentence, or did we hit the end of the string?
2076 (if (> (point) here)
2078 (goto-char (cdr range))
2081 (defun c-ascertain-preceding-literal ()
2082 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2083 ;; If a literal is the next thing (aside from whitespace) to be found before
2084 ;; point, return a cons of its start.end positions (enclosing the
2085 ;; delimiters). Otherwise return NIL.
2087 ;; This function might do hidden buffer changes.
2089 (c-collect-line-comments
2090 (let ((here (point))
2092 (if (c-backward-single-comment)
2093 (cons (point) (progn (c-forward-single-comment) (point)))
2095 ;; to prevent `looking-at' seeing a " at point.
2096 (narrow-to-region (point-min) here)
2099 ;; An EOL can act as an "open string" terminator in AWK.
2100 (looking-at c-ws*-string-limit-regexp)
2102 (progn (backward-char)
2103 (looking-at c-string-limit-regexp))))
2104 (goto-char (match-end 0)) ; just after the string terminator.
2106 (c-safe (c-backward-sexp 1) ; move back over the string.
2107 (cons (point) pos)))))))))
2109 (defun c-ascertain-following-literal ()
2110 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2111 ;; If a literal is the next thing (aside from whitespace) following point,
2112 ;; return a cons of its start.end positions (enclosing the delimiters).
2113 ;; Otherwise return NIL.
2115 ;; This function might do hidden buffer changes.
2117 (c-collect-line-comments
2120 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2121 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2124 (if (c-forward-single-comment)
2125 (cons pos (point))))))))
2127 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2128 ;; Does point immediately follow a statement "terminator"? A virtual
2129 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2131 ;; This function might do hidden buffer changes.
2134 (and (looking-at "[;{}]")
2135 (not (and c-special-brace-lists ; Pike special brace lists.
2136 (eq (char-after) ?{)
2137 (c-looking-at-special-brace-list)))))
2139 ;; The following (for macros) is not strict about exactly where we are
2140 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2141 ;; much. ACM 2004/3/29.
2144 (if (c-beginning-of-macro)
2145 (setq eom (progn (c-end-of-macro)
2149 (c-forward-comments)
2150 (>= (point) eom))))))
2152 (defun c-back-over-illiterals (macro-start)
2153 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2154 ;; stopping before reaching BOB or a literal or the boundary of a
2155 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2156 ;; the position of the '#' beginning the current preprocessor directive, or
2157 ;; NIL if we're not in such.
2159 ;; Return a cons (A.B), where
2160 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2161 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2162 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2163 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2165 ;; The total collection of returned values is as follows:
2166 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2167 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2168 ;; a BOS - the caller must check this.
2169 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2170 ;; moved and reached the opening # of the macro.
2171 ;; (t . macro-boundary): Every other circumstance in which we're at a
2172 ;; macro-boundary. We might be at a BOS.
2174 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2175 ;; code before encountering the literal/BOB or macro-boundary.
2177 ;; Note that this function moves within either preprocessor commands
2178 ;; (macros) or normal code, but will not cross a boundary between the two,
2179 ;; or between two distinct preprocessor commands.
2181 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2182 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2183 ;; move into parens. Also stop before `#' when it's at boi on a line.
2185 ;; This function might do hidden buffer changes.
2187 (let ((here (point))
2188 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2189 ; semicolon precedes it.
2191 (while t ;; We go back one "token" each iteration of the loop.
2194 ;; Stop at the token after a comment.
2195 ((c-backward-single-comment) ; Also functions as backwards-ws.
2197 (throw 'done '(t . literal)))
2199 ;; If we've gone back over a LF, we might have moved into or out of
2200 ;; a preprocessor line.
2201 ((and (save-excursion
2203 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2205 (< (point) macro-start)
2206 (c-beginning-of-macro)))
2208 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2209 (throw 'done (cons (or (eq (point) here)
2213 ;; Have we found a virtual semicolon? If so, stop, unless the next
2214 ;; statement is where we started from.
2215 ((and (c-at-vsemi-p)
2217 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2219 (throw 'done '(nil . nil)))
2221 ;; Hit the beginning of the buffer/region?
2225 (throw 'done '(nil . nil)))
2227 ;; Move back a character.
2228 ((progn (backward-char) nil))
2230 ;; Stop at "{" (unless it's a PIKE special brace list.)
2231 ((eq (char-after) ?\{)
2232 (if (and c-special-brace-lists
2233 (c-looking-at-special-brace-list))
2234 (skip-syntax-backward "w_") ; Speedup only.
2237 (throw 'done '(nil . nil))))
2239 ;; Have we reached the start of a macro? This always counts as
2240 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2241 ;; here. FIXME!!! ACM 2004/3/29)
2242 ((and macro-start (eq (point) macro-start))
2243 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2245 ;; Stop at token just after "}" or ";".
2246 ((looking-at "[;}]")
2247 ;; If we've gone back over ;, {, or }, we're done.
2248 (if (or (= here last)
2249 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2250 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2251 (eq (char-after) ?\;))
2253 (goto-char last) ; To the statement starting after the ; or }.
2254 (throw 'done '(nil . nil))))
2256 ;; Stop at the token after a string.
2257 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2259 (throw 'done '(t . literal)))
2261 ;; Nothing special: go back word characters.
2262 (t (skip-syntax-backward "w_")) ; Speedup only.
2265 (defun c-forward-over-illiterals (macro-end allow-early-stop)
2266 ;; Move forwards over code, stopping before reaching EOB or a literal
2267 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2268 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2269 ;; terminates the current preprocessor directive, or NIL if we're not in
2272 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2273 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2274 ;; seems unavoidable. Depending on the context this function is called
2275 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2276 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2277 ;; semicolons, or anything else.
2279 ;; Return a cons (A.B), where
2280 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2281 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2282 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2283 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2285 ;; Point is left either after the end-of-statement, or at the last non-ws
2286 ;; code before encountering the literal, or the # of the preprocessor
2287 ;; statement, or at EOB [or just after last non-WS stuff??].
2289 ;; As a clarification of "after the end-of-statement", if a comment or
2290 ;; whitespace follows a completed AWK statement, that statement is treated
2291 ;; as ending just after the last non-ws character before the comment.
2293 ;; Note that this function moves within either preprocessor commands
2294 ;; (macros) or normal code, but not both within the same invocation.
2296 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2297 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2298 ;; stop before `{' if at top level or inside braces, though. Move by
2299 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2302 ;; This function might do hidden buffer changes.
2303 (let ((here (point))
2306 (while t ;; We go one "token" forward each time round this loop.
2309 ;; If we've moved forward to a virtual semicolon, we're done.
2310 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2312 (throw 'done '(nil . nil)))
2316 ;; Gone past the end of a macro?
2317 ((and macro-end (> (point) macro-end))
2319 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2321 ;; About to hit a comment?
2322 ((save-excursion (c-forward-single-comment))
2324 (throw 'done '(t . literal)))
2330 (throw 'done '(nil . nil)))
2332 ;; If we encounter a '{', stop just after the previous token.
2333 ((and (eq (char-after) ?{)
2334 (not (and c-special-brace-lists
2335 (c-looking-at-special-brace-list)))
2336 (or allow-early-stop (/= here last))
2337 (save-excursion ; Is this a check that we're NOT at top level?
2338 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2339 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2340 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2341 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2342 (or (not (c-safe (up-list -1) t))
2343 (= (char-after) ?{))))
2345 (throw 'done '(nil . nil)))
2347 ;; End of a PIKE special brace list? If so, step over it and continue.
2348 ((and c-special-brace-lists
2349 (eq (char-after) ?})
2351 (and (c-safe (up-list -1) t)
2352 (c-looking-at-special-brace-list))))
2354 (skip-syntax-forward "w_")) ; Speedup only.
2356 ;; Have we got a '}' after having moved? If so, stop after the
2358 ((and (eq (char-after) ?})
2361 (throw 'done '(nil . nil)))
2363 ;; Stop if we encounter a preprocessor line.
2364 ((and (not macro-end)
2365 (eq (char-after) ?#)
2366 (= (point) (c-point 'boi)))
2368 ;(throw 'done (cons (eq (point) here) 'macro-boundary))) ; Changed 2003/3/26
2369 (throw 'done '(t . macro-boundary)))
2371 ;; Stop after a ';', '}', or "};"
2372 ((looking-at ";\\|};?")
2373 (goto-char (match-end 0))
2374 (throw 'done '(nil . nil)))
2376 ;; Found a string (this subsumes AWK regexps)?
2377 ((looking-at c-string-limit-regexp)
2379 (throw 'done '(t . literal)))
2382 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2383 (skip-syntax-forward "w_") ; Speedup only.
2384 (when (and macro-end (> (point) macro-end))
2386 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2389 (defun c-one-line-string-p (range)
2390 ;; Is the literal defined by RANGE a string contained in a single line?
2392 ;; This function might do hidden buffer changes.
2394 (goto-char (car range))
2395 (and (looking-at c-string-limit-regexp)
2396 (progn (skip-chars-forward "^\n" (cdr range))
2397 (eq (point) (cdr range))))))
2399 (defun c-beginning-of-statement (&optional count lim sentence-flag)
2400 "Go to the beginning of the innermost C statement.
2401 With prefix arg, go back N - 1 statements. If already at the
2402 beginning of a statement then go to the beginning of the closest
2403 preceding one, moving into nested blocks if necessary (use
2404 \\[backward-sexp] to skip over a block). If within or next to a
2405 comment or multiline string, move by sentences instead of statements.
2407 When called from a program, this function takes 3 optional args: the
2408 repetition count, a buffer position limit which is the farthest back
2409 to search for the syntactic context, and a flag saying whether to do
2410 sentence motion in or near comments and multiline strings.
2412 Note that for use in programs, `c-beginning-of-statement-1' is
2413 usually better. It has much better defined semantics than this one,
2414 which is intended for interactive use, and might therefore change to
2415 be more \"DWIM:ey\"."
2416 (interactive (list (prefix-numeric-value current-prefix-arg)
2419 (c-end-of-statement (- count) lim sentence-flag)
2420 (c-save-buffer-state
2421 ((count (or count 1))
2422 last ; start point for going back ONE chunk. Updated each chunk movement.
2424 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2425 res ; result from sub-function call
2426 not-bos ; "not beginning-of-statement"
2427 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2429 ;; Go back one statement at each iteration of the following loop.
2430 (while (and (/= count 0)
2431 (or (not lim) (> (point) lim)))
2432 ;; Go back one "chunk" each time round the following loop, stopping
2433 ;; when we reach a statement boundary, etc.
2436 (cond ; Each arm of this cond returns NIL on reaching a desired
2437 ; statement boundary, non-NIL otherwise.
2442 (range ; point is within or approaching a literal.
2444 ;; Single line string or sentence-flag is null => skip the
2446 ((or (null sentence-flag)
2447 (c-one-line-string-p range))
2448 (goto-char (car range))
2449 (setq range (c-ascertain-preceding-literal))
2450 ;; N.B. The following is essentially testing for an AWK regexp
2452 ;; Was the previous non-ws thing an end of statement?
2455 (c-backward-comments)
2456 (c-backward-syntactic-ws))
2457 (not (or (bobp) (c-after-statement-terminator-p)))))
2459 ;; Comment inside a statement or a multi-line string.
2460 (t (when (setq res ; returns non-nil when we go out of the literal
2461 (if (eq (c-literal-type range) 'string)
2462 (c-beginning-of-sentence-in-string range)
2463 (c-beginning-of-sentence-in-comment range)))
2464 (setq range (c-ascertain-preceding-literal)))
2467 ;; Non-literal code.
2468 (t (setq res (c-back-over-illiterals macro-fence))
2469 (setq not-bos ; "not reached beginning-of-statement".
2470 (or (= (point) last)
2471 (memq (char-after) '(?\) ?\}))
2474 ;; We're at a tentative BOS. The next form goes
2475 ;; back over WS looking for an end of previous
2477 (not (save-excursion
2479 (c-backward-comments)
2480 (c-backward-syntactic-ws))
2481 (or (bobp) (c-after-statement-terminator-p)))))))
2482 ;; Are we about to move backwards into or out of a
2483 ;; preprocessor command? If so, locate it's beginning.
2484 (when (eq (cdr res) 'macro-boundary)
2489 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2491 ;; Are we about to move backwards into a literal?
2492 (when (memq (cdr res) '(macro-boundary literal))
2493 (setq range (c-ascertain-preceding-literal)))
2495 (setq last (point)))
2497 (if (/= count 0) (setq count (1- count))))
2498 (c-keep-region-active))))
2500 (defun c-end-of-statement (&optional count lim sentence-flag)
2501 "Go to the end of the innermost C statement.
2502 With prefix arg, go forward N - 1 statements. Move forward to the end
2503 of the next statement if already at end, and move into nested blocks
2504 \(use \\[forward-sexp] to skip over a block). If within or next to a
2505 comment or multiline string, move by sentences instead of statements.
2507 When called from a program, this function takes 3 optional args: the
2508 repetition count, a buffer position limit which is the farthest back
2509 to search for the syntactic context, and a flag saying whether to do
2510 sentence motion in or near comments and multiline strings."
2511 (interactive (list (prefix-numeric-value current-prefix-arg)
2513 (setq count (or count 1))
2514 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2516 (c-save-buffer-state
2517 (here ; start point for going forward ONE statement. Updated each statement.
2520 (and (not (eobp)) (c-beginning-of-macro)
2521 (progn (c-end-of-macro) (point)))))
2523 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2525 ;; Go back/forward one statement at each iteration of the following loop.
2526 (while (and (/= count 0)
2527 (or (not lim) (< (point) lim)))
2528 (setq here (point)) ; ONLY HERE is HERE updated
2530 ;; Go forward one "chunk" each time round the following loop, stopping
2531 ;; when we reach a statement boundary, etc.
2533 (cond ; Each arm of this cond returns NIL on reaching a desired
2534 ; statement boundary, non-NIL otherwise.
2539 (range ; point is within a literal.
2541 ;; sentence-flag is null => skip the entire literal.
2542 ;; or a Single line string.
2543 ((or (null sentence-flag)
2544 (c-one-line-string-p range))
2545 (goto-char (cdr range))
2546 (setq range (c-ascertain-following-literal))
2547 ;; Is there a virtual semicolon here (e.g. for AWK)?
2548 (not (c-at-vsemi-p)))
2550 ;; Comment or multi-line string.
2551 (t (when (setq res ; gets non-nil when we go out of the literal
2552 (if (eq (c-literal-type range) 'string)
2553 (c-end-of-sentence-in-string range)
2554 (c-end-of-sentence-in-comment range)))
2555 (setq range (c-ascertain-following-literal)))
2556 ;; If we've just come forward out of a literal, check for
2557 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2558 ;; some other language may do in the future)
2560 (not (c-at-vsemi-p))))))
2562 ;; Non-literal code.
2563 (t (setq res (c-forward-over-illiterals macro-fence
2565 ;; Are we about to move forward into or out of a
2566 ;; preprocessor command?
2567 (when (eq (cdr res) 'macro-boundary)
2572 (progn (c-skip-ws-forward)
2573 (c-beginning-of-macro))
2574 (progn (c-end-of-macro)
2576 ;; Are we about to move forward into a literal?
2577 (when (memq (cdr res) '(macro-boundary literal))
2578 (setq range (c-ascertain-following-literal)))
2581 (if (/= count 0) (setq count (1- count))))
2582 (c-keep-region-active))))
2585 ;; set up electric character functions to work with pending-del,
2586 ;; (a.k.a. delsel) mode. All symbols get the t value except
2587 ;; the functions which delete, which gets 'supersede.
2591 (put sym 'delete-selection t) ; for delsel (Emacs)
2592 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2597 c-electric-semi&comma
2601 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2602 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2603 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2604 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
2605 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2606 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
2609 ;; Inserting/indenting comments
2610 (defun c-calc-comment-indent (entry)
2611 ;; This function might do hidden buffer changes.
2613 (setq entry (or (assq entry c-indent-comment-alist)
2614 (assq 'other c-indent-comment-alist)
2615 '(default . (column . nil)))))
2616 (let ((action (car (cdr entry)))
2617 (value (cdr (cdr entry)))
2618 (col (current-column)))
2619 (cond ((eq action 'space)
2621 ((eq action 'column)
2622 (unless value (setq value comment-column))
2624 ;; Do not pad with one space if we're at bol.
2626 (max (1+ col) value)))
2632 (let ((lim (c-literal-limits (c-point 'bol) t)))
2634 (goto-char (car lim))
2635 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2636 ;; Found comment to align with.
2638 ;; Do not pad with one space if we're at bol.
2640 (max (1+ col) (current-column))))))))
2641 ;; Recurse to handle value as a new spec.
2642 (c-calc-comment-indent (cdr entry)))))))
2644 (defun c-comment-indent ()
2645 "Used by `indent-for-comment' to create and indent comments.
2646 See `c-indent-comment-alist' for a description."
2649 (c-save-buffer-state
2650 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
2651 (or (when (consp lim)
2652 (goto-char (car lim))
2653 (when (looking-at "/[/*]")
2654 (skip-chars-backward " \t")
2657 (skip-chars-backward " \t")
2660 (cond ((looking-at "^/[/*]")
2662 ((progn (beginning-of-line)
2665 ((progn (back-to-indentation)
2666 (and (eq (char-after) ?})
2667 (eq (point) (1- eot))))
2669 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2670 (eq (match-end 0) eot))
2674 (if (and (memq line-type '(anchored-comment empty-line))
2675 c-indent-comments-syntactically-p)
2676 (let ((c-syntactic-context (c-guess-basic-syntax)))
2677 ;; BOGOSITY ALERT: if we're looking at the eol, its
2678 ;; because indent-for-comment hasn't put the comment-start
2679 ;; in the buffer yet. this will screw up the syntactic
2680 ;; analysis so we kludge in the necessary info. Another
2681 ;; kludge is that if we're at the bol, then we really want
2682 ;; to ignore any anchoring as specified by
2683 ;; c-comment-only-line-offset since it doesn't apply here.
2685 (c-add-syntax 'comment-intro))
2686 (let ((c-comment-only-line-offset
2687 (if (consp c-comment-only-line-offset)
2688 c-comment-only-line-offset
2689 (cons c-comment-only-line-offset
2690 c-comment-only-line-offset))))
2691 (c-get-syntactic-indentation c-syntactic-context)))
2693 (c-calc-comment-indent line-type)))))
2696 ;; used by outline-minor-mode
2697 (defun c-outline-level ()
2698 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2699 ;; in otherwise-hidden text.
2701 (skip-chars-forward "\t ")
2705 ;; Movement by CPP conditionals.
2706 (defun c-up-conditional (count)
2707 "Move back to the containing preprocessor conditional, leaving mark behind.
2708 A prefix argument acts as a repeat count. With a negative argument,
2709 move forward to the end of the containing preprocessor conditional.
2711 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2712 function stops at them when going backward, but not when going
2715 (c-forward-conditional (- count) -1)
2716 (c-keep-region-active))
2718 (defun c-up-conditional-with-else (count)
2719 "Move back to the containing preprocessor conditional, including \"#else\".
2720 Just like `c-up-conditional', except it also stops at \"#else\"
2723 (c-forward-conditional (- count) -1 t)
2724 (c-keep-region-active))
2726 (defun c-down-conditional (count)
2727 "Move forward into the next preprocessor conditional, leaving mark behind.
2728 A prefix argument acts as a repeat count. With a negative argument,
2729 move backward into the previous preprocessor conditional.
2731 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2732 function stops at them when going forward, but not when going
2735 (c-forward-conditional count 1)
2736 (c-keep-region-active))
2738 (defun c-down-conditional-with-else (count)
2739 "Move forward into the next preprocessor conditional, including \"#else\".
2740 Just like `c-down-conditional', except it also stops at \"#else\"
2743 (c-forward-conditional count 1 t)
2744 (c-keep-region-active))
2746 (defun c-backward-conditional (count &optional target-depth with-else)
2747 "Move back across a preprocessor conditional, leaving mark behind.
2748 A prefix argument acts as a repeat count. With a negative argument,
2749 move forward across a preprocessor conditional."
2751 (c-forward-conditional (- count) target-depth with-else)
2752 (c-keep-region-active))
2754 (defun c-forward-conditional (count &optional target-depth with-else)
2755 "Move forward across a preprocessor conditional, leaving mark behind.
2756 A prefix argument acts as a repeat count. With a negative argument,
2757 move backward across a preprocessor conditional.
2759 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2760 the nesting level isn't changed when tracking subconditionals.
2762 The optional argument TARGET-DEPTH specifies the wanted nesting depth
2763 after each scan. I.e. if TARGET-DEPTH is -1, the function will move
2764 out of the enclosing conditional. A non-integer non-nil TARGET-DEPTH
2767 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
2768 are treated as conditional clause limits. Normally they are ignored."
2770 (let* ((forward (> count 0))
2771 (increment (if forward -1 1))
2772 (search-function (if forward 're-search-forward 're-search-backward))
2774 (unless (integerp target-depth)
2775 (setq target-depth (if target-depth -1 0)))
2779 ;; subdepth is the depth in "uninteresting" subtrees,
2780 ;; i.e. those that takes us farther from the target
2781 ;; depth instead of closer.
2785 ;; Find the "next" significant line in the proper direction.
2786 (while (and (not found)
2787 ;; Rather than searching for a # sign that
2788 ;; comes at the beginning of a line aside from
2789 ;; whitespace, search first for a string
2790 ;; starting with # sign. Then verify what
2791 ;; precedes it. This is faster on account of
2792 ;; the fastmap feature of the regexp matcher.
2793 (funcall search-function
2794 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
2797 ;; Now verify it is really a preproc line.
2798 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
2799 (let (dchange (directive (match-string 1)))
2800 (cond ((string= directive "if")
2801 (setq dchange (- increment)))
2802 ((string= directive "endif")
2803 (setq dchange increment))
2805 ;; When we're not in an "uninteresting"
2806 ;; subtree, we might want to act on "elif"
2808 (if (cond (with-else
2809 ;; Always move toward the target depth.
2811 (if (> target-depth 0) 1 -1)))
2812 ((string= directive "elif")
2813 (setq dchange (- increment))))
2814 ;; Ignore the change if it'd take us
2815 ;; into an "uninteresting" subtree.
2816 (if (eq (> dchange 0) (<= target-depth 0))
2817 (setq dchange nil)))))
2819 (when (or (/= subdepth 0)
2820 (eq (> dchange 0) (<= target-depth 0)))
2821 (setq subdepth (+ subdepth dchange)))
2822 (setq depth (+ depth dchange))
2823 ;; If we are trying to move across, and we find an
2824 ;; end before we find a beginning, get an error.
2825 (if (and (< depth target-depth) (< dchange 0))
2827 "No following conditional at this level"
2828 "No previous conditional at this level"))))
2829 ;; When searching forward, start from next line so
2830 ;; that we don't find the same line again.
2831 (if forward (forward-line 1))
2832 ;; We found something if we've arrived at the
2834 (if (and dchange (= depth target-depth))
2835 (setq found (point))))
2837 (if forward (forward-line 1)))))
2839 (error "No containing preprocessor conditional"))
2840 (goto-char (setq new found)))
2841 (setq count (+ count increment))))
2844 (c-keep-region-active))
2847 ;; commands to indent lines, regions, defuns, and expressions
2848 (defun c-indent-command (&optional arg)
2849 "Indent current line as C code, and/or insert some whitespace.
2851 If `c-tab-always-indent' is t, always just indent the current line.
2852 If nil, indent the current line only if point is at the left margin or
2853 in the line's indentation; otherwise insert some whitespace[*]. If
2854 other than nil or t, then some whitespace[*] is inserted only within
2855 literals (comments and strings), but the line is always reindented.
2857 If `c-syntactic-indentation' is t, indentation is done according to
2858 the syntactic context. A numeric argument, regardless of its value,
2859 means indent rigidly all the lines of the expression starting after
2860 point so that this line becomes properly indented. The relative
2861 indentation among the lines of the expression is preserved.
2863 If `c-syntactic-indentation' is nil, the line is just indented one
2864 step according to `c-basic-offset'. In this mode, a numeric argument
2865 indents a number of such steps, positive or negative, and an empty
2866 prefix argument is equivalent to -1.
2868 [*] The amount and kind of whitespace inserted is controlled by the
2869 variable `c-insert-tab-function', which is called to do the actual
2870 insertion of whitespace. Normally the function in this variable
2871 just inserts a tab character, or the equivalent number of spaces,
2872 depending on the variable `indent-tabs-mode'."
2875 (let ((indent-function
2876 (if c-syntactic-indentation
2877 (symbol-function 'indent-according-to-mode)
2879 (let ((c-macro-start c-macro-start)
2880 (steps (if (equal arg '(4))
2882 (prefix-numeric-value arg))))
2883 (c-shift-line-indentation (* steps c-basic-offset))
2884 (when (and c-auto-align-backslashes
2887 (eq (char-before) ?\\))
2888 (c-query-and-set-macro-start))
2889 ;; Realign the line continuation backslash if inside a macro.
2890 (c-backslash-region (point) (point) nil t)))
2892 (if (and c-syntactic-indentation arg)
2893 ;; If c-syntactic-indentation and got arg, always indent this
2894 ;; line as C and shift remaining lines of expression the same
2896 (let ((shift-amt (save-excursion
2897 (back-to-indentation)
2901 (setq shift-amt (- (save-excursion
2902 (back-to-indentation)
2906 (if (eq c-tab-always-indent t)
2907 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
2915 (indent-code-rigidly beg end shift-amt "#")))
2916 ;; Else use c-tab-always-indent to determine behavior.
2918 ;; CASE 1: indent when at column zero or in line's indentation,
2919 ;; otherwise insert a tab
2920 ((not c-tab-always-indent)
2922 (skip-chars-backward " \t")
2924 (funcall c-insert-tab-function)
2925 (funcall indent-function)))
2926 ;; CASE 2: just indent the line
2927 ((eq c-tab-always-indent t)
2928 (funcall indent-function))
2929 ;; CASE 3: if in a literal, insert a tab, but always indent the
2932 (if (c-save-buffer-state () (c-in-literal))
2933 (funcall c-insert-tab-function))
2934 (funcall indent-function)
2937 (defun c-indent-exp (&optional shutup-p)
2938 "Indent each line in the balanced expression following point syntactically.
2939 If optional SHUTUP-P is non-nil, no errors are signaled if no
2940 balanced expression is found."
2942 (let ((here (point-marker))
2944 (set-marker-insertion-type here t)
2946 (let ((start (save-restriction
2947 ;; Find the closest following open paren that
2948 ;; ends on another line.
2949 (narrow-to-region (point-min) (c-point 'eol))
2950 (let (beg (end (point)))
2951 (while (and (setq beg (c-down-list-forward end))
2952 (setq end (c-up-list-forward beg))))
2954 (eq (char-syntax (char-before beg)) ?\()
2959 (error "Cannot find start of balanced expression to indent"))
2961 (setq end (c-safe (scan-sexps (point) 1)))
2964 (error "Cannot find end of balanced expression to indent"))
2967 (c-indent-region (point) end)))))
2969 (set-marker here nil))))
2971 (defun c-indent-defun ()
2972 "Indent the current top-level declaration or macro syntactically.
2973 In the macro case this also has the effect of realigning any line
2974 continuation backslashes, unless `c-auto-align-backslashes' is nil."
2976 (let ((here (point-marker)) decl-limits)
2979 (c-save-buffer-state nil
2980 ;; We try to be line oriented, unless there are several
2981 ;; declarations on the same line.
2982 (if (looking-at c-syntactic-eol)
2983 (c-backward-token-2 1 nil (c-point 'bol))
2984 (c-forward-token-2 0 nil (c-point 'eol)))
2985 (setq decl-limits (c-declaration-limits nil)))
2987 (c-indent-region (car decl-limits)
2988 (cdr decl-limits))))
2990 (set-marker here nil))))
2992 (defun c-indent-region (start end &optional quiet)
2993 "Indent syntactically every line whose first char is between START
2994 and END inclusive. If the optional argument QUIET is non-nil then no
2995 syntactic errors are reported, even if `c-report-syntactic-errors' is
2999 (skip-chars-backward " \t\n\r\f\v")
3002 ;; Advance to first nonblank line.
3004 (skip-chars-forward " \t\n\r\f\v")
3005 (setq start (point))
3007 (setq c-parsing-error
3008 (or (let ((endmark (copy-marker end))
3009 (c-parsing-error nil)
3010 ;; shut up any echo msgs on indiv lines
3011 (c-echo-syntactic-information-p nil)
3012 (in-macro (and c-auto-align-backslashes
3013 (c-save-buffer-state ()
3014 (save-excursion (c-beginning-of-macro)))
3016 (c-fix-backslashes nil)
3020 (c-progress-init start end 'c-indent-region)
3023 (< (point) endmark))
3027 (skip-chars-forward " \t\n")
3029 ;; Get syntax and indent.
3030 (c-save-buffer-state nil
3031 (setq syntax (c-guess-basic-syntax)))
3032 (if (and c-auto-align-backslashes
3033 (assq 'cpp-macro syntax))
3034 ;; Record macro start.
3035 (setq in-macro (point)))
3037 (if (looking-at "\\s *\\\\$")
3039 (c-indent-line syntax t t)
3040 (if (progn (end-of-line)
3041 (not (eq (char-before) ?\\)))
3043 ;; Fixup macro backslashes.
3045 (c-backslash-region in-macro (point) nil)
3046 (setq in-macro nil))
3048 (c-indent-line syntax t t)
3051 (c-backslash-region in-macro (c-point 'bopl) nil t)))
3052 (set-marker endmark nil)
3053 (c-progress-fini 'c-indent-region))
3054 (c-echo-parsing-error quiet))
3057 (defun c-fn-region-is-active-p ()
3058 ;; Function version of the macro for use in places that aren't
3059 ;; compiled, e.g. in the menus.
3060 (c-region-is-active-p))
3062 (defun c-indent-line-or-region ()
3063 "When the region is active, indent it syntactically. Otherwise
3064 indent the current line syntactically."
3065 ;; Emacs has a variable called mark-active, XEmacs uses region-active-p
3067 (if (c-region-is-active-p)
3068 (c-indent-region (region-beginning) (region-end))
3072 ;; for progress reporting
3073 (defvar c-progress-info nil)
3075 (defun c-progress-init (start end context)
3078 ((not c-progress-interval))
3079 ;; Start the progress update messages. If this Emacs doesn't have
3080 ;; a built-in timer, just be dumb about it.
3081 ((not (fboundp 'current-time))
3082 (message "Indenting region... (this may take a while)"))
3083 ;; If progress has already been initialized, do nothing. otherwise
3084 ;; initialize the counter with a vector of:
3085 ;; [start end lastsec context]
3087 (t (setq c-progress-info (vector start
3091 (nth 1 (current-time))
3093 (message "Indenting region..."))
3096 (defun c-progress-update ()
3097 (if (not (and c-progress-info c-progress-interval))
3099 (let ((now (nth 1 (current-time)))
3100 (start (aref c-progress-info 0))
3101 (end (aref c-progress-info 1))
3102 (lastsecs (aref c-progress-info 2)))
3103 ;; should we update? currently, update happens every 2 seconds,
3104 ;; what's the right value?
3105 (if (< c-progress-interval (- now lastsecs))
3107 (message "Indenting region... (%d%% complete)"
3108 (/ (* 100 (- (point) start)) (- end start)))
3109 (aset c-progress-info 2 now)))
3112 (defun c-progress-fini (context)
3113 (if (not c-progress-interval)
3115 (if (or (eq context (aref c-progress-info 3))
3118 (set-marker (aref c-progress-info 1) nil)
3119 (setq c-progress-info nil)
3120 (message "Indenting region... done")))))
3124 ;;; This page handles insertion and removal of backslashes for C macros.
3126 (defun c-backslash-region (from to delete-flag &optional line-mode)
3127 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3128 With no argument, inserts backslashes and aligns existing backslashes.
3129 With an argument, deletes the backslashes. The backslash alignment is
3130 done according to the settings in `c-backslash-column',
3131 `c-backslash-max-column' and `c-auto-align-backslashes'.
3133 This function does not modify blank lines at the start of the region.
3134 If the region ends at the start of a line and the macro doesn't
3135 continue below it, the backslash (if any) at the end of the previous
3138 You can put the region around an entire macro definition and use this
3139 command to conveniently insert and align the necessary backslashes."
3140 (interactive "*r\nP")
3141 (let ((endmark (make-marker))
3142 ;; Keep the backslash trimming functions from changing the
3143 ;; whitespace around point, since in this case it's only the
3144 ;; position of point that tells the indentation of the line.
3145 (point-pos (if (save-excursion
3146 (skip-chars-backward " \t")
3147 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3150 column longest-line-col bs-col-after-end)
3153 (if (and (not line-mode) (bobp))
3154 ;; Nothing to do if to is at bob, since we should back up
3155 ;; and there's no line to back up to.
3157 (when (and (not line-mode) (bolp))
3158 ;; Do not back up the to line if line-mode is set, to make
3159 ;; e.g. c-newline-and-indent consistent regardless whether
3160 ;; the (newline) call leaves point at bol or not.
3165 (set-marker endmark (point))
3167 (c-delete-backslashes-forward endmark point-pos))
3168 ;; Set bs-col-after-end to the column of any backslash
3169 ;; following the region, or nil if there is none.
3170 (setq bs-col-after-end
3171 (and (progn (end-of-line)
3172 (eq (char-before) ?\\))
3173 (= (forward-line 1) 0)
3174 (progn (end-of-line)
3175 (eq (char-before) ?\\))
3176 (1- (current-column))))
3178 ;; Back up the to line if line-mode is set, since the line
3179 ;; after the newly inserted line break should not be
3180 ;; touched in c-newline-and-indent.
3181 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3182 (unless bs-col-after-end
3183 ;; Set bs-col-after-end to non-nil in any case, since we
3184 ;; do not want to delete the backslash at the last line.
3185 (setq bs-col-after-end t)))
3187 (not c-auto-align-backslashes))
3189 ;; Compute the smallest column number past the ends of all
3191 (setq longest-line-col 0)
3193 (if bs-col-after-end
3194 ;; Include one more line in the max column
3195 ;; calculation, since the to line will be backslashed
3199 (while (and (>= (point) from)
3201 (if (eq (char-before) ?\\)
3203 (skip-chars-backward " \t")
3204 (setq longest-line-col (max longest-line-col
3205 (1+ (current-column))))
3209 ;; Try to align with surrounding backslashes.
3212 (if (and (not (bobp))
3213 (progn (backward-char)
3214 (eq (char-before) ?\\)))
3216 (setq column (1- (current-column)))
3217 (if (numberp bs-col-after-end)
3218 ;; Both a preceding and a following backslash.
3219 ;; Choose the greatest of them.
3220 (setq column (max column bs-col-after-end)))
3222 ;; No preceding backslash. Try to align with one
3223 ;; following the region. Disregard the backslash at the
3224 ;; to line since it's likely to be bogus (e.g. when
3225 ;; called from c-newline-and-indent).
3226 (if (numberp bs-col-after-end)
3227 (setq column bs-col-after-end))
3228 ;; Don't modify blank lines at start of region.
3230 (while (and (< (point) to) (bolp) (eolp))
3232 (if (and column (< column longest-line-col))
3233 ;; Don't try to align with surrounding backslashes if
3234 ;; any line is too long.
3237 ;; Impose minimum limit and tab width alignment only if
3238 ;; we can't align with surrounding backslashes.
3239 (if (> (% longest-line-col tab-width) 0)
3240 (setq longest-line-col
3241 (* (/ (+ longest-line-col tab-width -1)
3244 (setq column (max c-backslash-column
3246 ;; Always impose maximum limit.
3247 (setq column (min column c-backslash-max-column)))
3248 (if bs-col-after-end
3249 ;; Add backslashes on all lines if the macro continues
3250 ;; after the to line.
3252 (set-marker endmark to)
3253 (c-append-backslashes-forward endmark column point-pos))
3254 ;; Add backslashes on all lines except the last, and
3255 ;; remove any on the last line.
3260 (set-marker endmark (1- (point)))))
3262 (c-append-backslashes-forward endmark column point-pos)
3263 ;; The function above leaves point on the line
3264 ;; following endmark.
3265 (set-marker endmark (point)))
3266 (set-marker endmark to))
3267 (c-delete-backslashes-forward endmark point-pos)))))
3268 (set-marker endmark nil)
3269 (if (markerp point-pos)
3270 (set-marker point-pos nil))))
3272 (defun c-append-backslashes-forward (to-mark column point-pos)
3273 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3277 (<= (point) to-mark)
3279 (let ((start (point)) (inserted nil) end col)
3281 (unless (eq (char-before) ?\\)
3284 (setq state (parse-partial-sexp
3285 start (point) nil nil state))
3287 (setq col (current-column))
3289 ;; Avoid unnecessary changes of the buffer.
3290 (cond ((and (not inserted) (nth 3 state))
3291 ;; Don't realign backslashes in string literals
3292 ;; since that would change them.
3299 (skip-chars-backward
3300 " \t" (if (>= (point) point-pos) point-pos))
3304 ((and (= col column)
3305 (memq (char-before) '(?\ ?\t))))
3309 (or (/= (skip-chars-backward
3310 " \t" (if (>= (point) point-pos) point-pos))
3312 (/= (char-after) ?\ )))
3313 (delete-region (point) end)
3314 (indent-to column 1)))
3316 (zerop (forward-line 1)))
3317 (bolp))) ; forward-line has funny behavior at eob.
3319 ;; Make sure there are backslashes with at least one space in
3323 (<= (point) to-mark)
3325 (let ((start (point)))
3327 (setq state (parse-partial-sexp
3328 start (point) nil nil state))
3330 (if (eq (char-before) ?\\)
3331 (unless (nth 3 state)
3333 (unless (and (memq (char-before) '(?\ ?\t))
3334 (/= (point) point-pos))
3337 (if (and (memq (char-before) '(?\ ?\t))
3338 (/= (point) point-pos))
3342 (zerop (forward-line 1)))
3343 (bolp)))))) ; forward-line has funny behavior at eob.
3345 (defun c-delete-backslashes-forward (to-mark point-pos)
3347 (and (<= (point) to-mark)
3350 (if (eq (char-before) ?\\)
3353 (progn (backward-char)
3354 (skip-chars-backward " \t" (if (>= (point) point-pos)
3357 (zerop (forward-line 1)))
3358 (bolp)))) ; forward-line has funny behavior at eob.
3362 ;;; Line breaking and paragraph filling.
3364 (defvar c-auto-fill-prefix t)
3365 (defvar c-lit-limits nil)
3366 (defvar c-lit-type nil)
3368 ;; The filling code is based on a simple theory; leave the intricacies
3369 ;; of the text handling to the currently active mode for that
3370 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3371 ;; possible to make them work correctly wrt the comment and string
3372 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3373 ;; to it, there's quite a lot of special cases to handle which makes
3374 ;; the code anything but simple. The intention is that it will work
3375 ;; with any well-written text filling package that preserves a fill
3378 ;; We temporarily mask comment starters and enders as necessary for
3379 ;; the filling code to do its job on a seemingly normal text block.
3380 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3381 ;; preserve it correctly (especially important when filling C++ style
3382 ;; line comments). By default, we set up and use adaptive-fill-mode,
3383 ;; which is standard in all supported Emacs flavors.
3385 (defun c-guess-fill-prefix (lit-limits lit-type)
3386 ;; Determine the appropriate comment fill prefix for a block or line
3387 ;; comment. Return a cons of the prefix string and the column where
3388 ;; it ends. If fill-prefix is set, it'll override. Note that this
3389 ;; function also uses the value of point in some heuristics.
3391 ;; This function might do hidden buffer changes.
3393 (let* ((here (point))
3394 (prefix-regexp (concat "[ \t]*\\("
3395 c-current-comment-prefix
3397 (comment-start-regexp (if (eq lit-type 'c++)
3399 comment-start-skip))
3400 prefix-line comment-prefix res comment-text-end)
3404 (setq res (cons fill-prefix
3405 ;; Ugly way of getting the column after the fill
3406 ;; prefix; it'd be nice with a current-column
3407 ;; that works on strings..
3408 (let ((start (point)))
3411 (insert-and-inherit "\n" fill-prefix)
3413 (delete-region start (point)))))))
3417 ;; Set fallback for comment-prefix if none is found.
3418 (setq comment-prefix "// "
3419 comment-text-end (cdr lit-limits))
3422 (if (> (point) (car lit-limits))
3423 ;; The current line is not the comment starter, so the
3424 ;; comment has more than one line, and it can therefore be
3425 ;; used to find the comment fill prefix.
3426 (setq prefix-line (point))
3428 (goto-char (car lit-limits))
3429 (if (and (= (forward-line 1) 0)
3430 (< (point) (cdr lit-limits)))
3431 ;; The line after the comment starter is inside the
3432 ;; comment, so we can use it.
3433 (setq prefix-line (point))
3435 ;; The comment is only one line. Take the comment prefix
3436 ;; from it and keep the indentation.
3437 (goto-char (car lit-limits))
3438 (if (looking-at prefix-regexp)
3439 (goto-char (match-end 0))
3441 (skip-chars-forward " \t"))
3444 (if (eq (c-point 'boi) (car lit-limits))
3445 ;; There is only whitespace before the comment
3446 ;; starter; take the prefix straight from this line.
3447 (setq str (buffer-substring-no-properties
3448 (c-point 'bol) (point))
3449 col (current-column))
3451 ;; There is code before the comment starter, so we
3452 ;; have to temporarily insert and indent a new line to
3453 ;; get the right space/tab mix in the indentation.
3454 (let ((prefix-len (- (point) (car lit-limits)))
3458 (goto-char (car lit-limits))
3459 (indent-to (prog1 (current-column)
3462 (forward-char prefix-len)
3463 (setq str (buffer-substring-no-properties
3464 (c-point 'bol) (point))
3465 col (current-column)))
3466 (delete-region (car lit-limits) tmp))))
3469 (if (or (string-match "\\s \\'" str) (not (eolp)))
3471 ;; The prefix ends the line with no whitespace
3472 ;; after it. Default to a single space.
3473 (cons (concat str " ") (1+ col))))
3477 (setq comment-text-end
3479 (goto-char (- (cdr lit-limits) 2))
3480 (if (looking-at "\\*/") (point) (cdr lit-limits))))
3484 (if (and (> (point) (car lit-limits))
3485 (not (and (looking-at "[ \t]*\\*/")
3486 (eq (cdr lit-limits) (match-end 0)))))
3487 ;; The current line is not the comment starter and
3488 ;; contains more than just the ender, so it's good enough
3489 ;; to be used for the comment fill prefix.
3490 (setq prefix-line (point))
3491 (goto-char (car lit-limits))
3493 (cond ((or (/= (forward-line 1) 0)
3494 (>= (point) (cdr lit-limits))
3495 (and (looking-at "[ \t]*\\*/")
3496 (eq (cdr lit-limits) (match-end 0)))
3497 (and (looking-at prefix-regexp)
3498 (<= (1- (cdr lit-limits)) (match-end 0))))
3499 ;; The comment is either one line or the next line contains
3500 ;; just the comment ender. In this case we have no
3501 ;; information about a suitable comment prefix, so we resort
3502 ;; to c-block-comment-prefix.
3503 (setq comment-prefix (or c-block-comment-prefix "")))
3506 ;; The point was on the comment opener line, so we might want
3507 ;; to treat this as a not yet closed comment.
3509 (if (and (match-beginning 1)
3510 (/= (match-beginning 1) (match-end 1)))
3511 ;; Above `prefix-regexp' matched a nonempty prefix on the
3512 ;; second line, so let's use it. Normally it should do
3513 ;; to set `prefix-line' and let the code below pick up
3514 ;; the whole prefix, but if there's no text after the
3515 ;; match then it will probably fall back to no prefix at
3516 ;; all if the comment isn't closed yet, so in that case
3517 ;; it's better to force use of the prefix matched now.
3518 (if (= (match-end 0) (c-point 'eol))
3519 (setq comment-prefix (match-string 1))
3520 (setq prefix-line (point)))
3522 ;; There's no nonempty prefix on the line after the
3523 ;; comment opener. If the line is empty, or if the
3524 ;; text on it has less or equal indentation than the
3525 ;; comment starter we assume it's an unclosed
3526 ;; comment starter, i.e. that
3527 ;; `c-block-comment-prefix' should be used.
3528 ;; Otherwise we assume it's a closed comment where
3529 ;; the prefix really is the empty string.
3530 ;; E.g. this is an unclosed comment:
3541 ;; (Looking for the presence of the comment closer
3542 ;; rarely works since it's probably the closer of
3543 ;; some comment further down when the comment
3544 ;; really is unclosed.)
3545 (if (<= (save-excursion (back-to-indentation)
3547 (save-excursion (goto-char (car lit-limits))
3549 (setq comment-prefix (or c-block-comment-prefix ""))
3550 (setq prefix-line (point)))))
3553 ;; Otherwise the line after the comment starter is good
3554 ;; enough to find the prefix in.
3555 (setq prefix-line (point))))
3557 (when comment-prefix
3558 ;; Haven't got the comment prefix on any real line that we
3559 ;; can take it from, so we have to temporarily insert
3560 ;; `comment-prefix' on a line and indent it to find the
3561 ;; correct column and the correct mix of tabs and spaces.
3563 (let (tmp-pre tmp-post)
3567 (goto-char (car lit-limits))
3568 (if (looking-at comment-start-regexp)
3569 (goto-char (min (match-end 0)
3572 (skip-chars-forward " \t"))
3574 (when (eq (char-syntax (char-before)) ?\ )
3575 ;; If there's ws on the current line, we'll use it
3576 ;; instead of what's ending comment-prefix.
3577 (setq comment-prefix
3578 (concat (substring comment-prefix
3582 (buffer-substring-no-properties
3584 (skip-chars-backward " \t")
3588 (setq tmp-pre (point-marker))
3590 ;; We insert an extra non-whitespace character
3591 ;; before the line break and after comment-prefix in
3592 ;; case it's "" or ends with whitespace.
3593 (insert-and-inherit "x\n" comment-prefix "x")
3594 (setq tmp-post (point-marker))
3596 (indent-according-to-mode)
3598 (goto-char (1- tmp-post))
3599 (cons (buffer-substring-no-properties
3600 (c-point 'bol) (point))
3604 (delete-region tmp-pre tmp-post)
3605 (set-marker tmp-pre nil)
3606 (set-marker tmp-post nil))))))))))
3608 (or res ; Found a good prefix above.
3611 ;; prefix-line is the bol of a line on which we should try
3612 ;; to find the prefix.
3613 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3616 (when (and (looking-at prefix-regexp)
3617 (<= (match-end 0) comment-text-end))
3618 (unless (eq (match-end 0) (c-point 'eol))
3619 ;; The match is fine if there's text after it.
3620 (throw 'found (cons (buffer-substring-no-properties
3621 (match-beginning 0) (match-end 0))
3622 (progn (goto-char (match-end 0))
3623 (current-column)))))
3625 ;; This match is better than nothing, so let's
3626 ;; remember it in case nothing better is found
3628 (setq fb-string (buffer-substring-no-properties
3629 (match-beginning 0) (match-end 0))
3630 fb-endpos (match-end 0)))
3634 ;; Search for a line which has text after the prefix
3635 ;; so that we get the proper amount of whitespace
3636 ;; after it. We start with the current line, then
3637 ;; search backwards, then forwards.
3639 (goto-char prefix-line)
3640 (when (and (funcall test-line)
3641 (or (/= (match-end 1) (match-end 0))
3642 ;; The whitespace is sucked up by the
3643 ;; first [ \t]* glob if the prefix is empty.
3644 (and (= (match-beginning 1) (match-end 1))
3645 (/= (match-beginning 0) (match-end 0)))))
3646 ;; If the current line doesn't have text but do
3647 ;; have whitespace after the prefix, we'll use it.
3648 (throw 'found (cons fb-string
3649 (progn (goto-char fb-endpos)
3650 (current-column)))))
3652 (if (eq lit-type 'c++)
3653 ;; For line comments we can search up to and
3654 ;; including the first line.
3655 (while (and (zerop (forward-line -1))
3656 (>= (point) (car lit-limits)))
3657 (funcall test-line))
3658 ;; For block comments we must stop before the
3660 (while (and (zerop (forward-line -1))
3661 (> (point) (car lit-limits)))
3662 (funcall test-line)))
3664 (goto-char prefix-line)
3665 (while (and (zerop (forward-line 1))
3666 (< (point) (cdr lit-limits)))
3667 (funcall test-line))
3669 (goto-char prefix-line)
3673 ;; A good line wasn't found, but at least we have a
3674 ;; fallback that matches the comment prefix regexp.
3675 (cond ((or (string-match "\\s \\'" fb-string)
3677 (goto-char fb-endpos)
3679 ;; There are ws or text after the prefix, so
3681 (cons fb-string (current-column)))
3684 ;; Check if there's any whitespace padding
3685 ;; on the comment start line that we can
3686 ;; use after the prefix.
3687 (goto-char (car lit-limits))
3688 (if (looking-at comment-start-regexp)
3689 (goto-char (match-end 0))
3691 (skip-chars-forward " \t"))
3693 (eq (char-syntax (char-before)) ?\ )))
3695 (setq fb-string (buffer-substring-no-properties
3697 (skip-chars-backward " \t")
3700 (goto-char fb-endpos)
3701 (skip-chars-backward " \t")
3703 (let ((tmp (point)))
3704 ;; Got to mess in the buffer once again to
3705 ;; ensure the column gets correct. :P
3708 (insert-and-inherit fb-string)
3709 (cons (buffer-substring-no-properties
3713 (delete-region tmp (point)))))
3716 ;; Last resort: Just add a single space after
3718 (cons (concat fb-string " ")
3719 (progn (goto-char fb-endpos)
3720 (1+ (current-column)))))))
3722 ;; The line doesn't match the comment prefix regexp.
3724 ;; We have a fallback for line comments that we must use.
3725 (cons (concat (buffer-substring-no-properties
3726 prefix-line (c-point 'boi))
3728 (progn (back-to-indentation)
3729 (+ (current-column) (length comment-prefix))))
3731 ;; Assume we are dealing with a "free text" block
3732 ;; comment where the lines doesn't have any comment
3733 ;; prefix at all and we should just fill it as
3738 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
3739 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3740 ;; masked to allow adaptive filling to work correctly. That
3741 ;; includes narrowing the buffer and, if point is inside a comment,
3742 ;; masking the comment starter and ender appropriately.
3744 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3745 ;; The position of point is then less significant when doing masking
3748 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3749 ;; only if the point turns out to be inside a comment or a string.
3751 ;; Note that this function does not do any hidden buffer changes.
3754 ;; beg and end limit the region to narrow. end is a marker.
3756 ;; tmp-pre and tmp-post mark strings that are temporarily
3757 ;; inserted at the start and end of the region. tmp-pre is a
3758 ;; cons of the positions of the prepended string. tmp-post is
3759 ;; a marker pointing to the single character of the appended
3762 ;; If hang-ender-stuck isn't nil, the comment ender is
3763 ;; hanging. In that case it's set to the number of spaces
3764 ;; that should be between the text and the ender.
3766 ;; auto-fill-spaces is the exact sequence of whitespace between a
3767 ;; comment's last word and the comment ender, temporarily replaced
3768 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
3771 (c-lit-limits c-lit-limits)
3772 (c-lit-type c-lit-type))
3774 ;; Restore point on undo. It's necessary since we do a lot of
3775 ;; hidden inserts and deletes below that should be as transparent
3777 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
3778 (setq buffer-undo-list (cons (point) buffer-undo-list)))
3780 ;; Determine the limits and type of the containing literal (if any):
3781 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
3783 (c-save-buffer-state ()
3785 ;; Widen to catch comment limits correctly.
3787 (unless c-lit-limits
3788 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
3789 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
3791 (setq c-lit-type (c-literal-type c-lit-limits))))
3794 (unless (c-safe (backward-char)
3798 (forward-paragraph))
3799 (setq end (point-marker)))
3801 (unless (c-safe (forward-char)
3802 (backward-paragraph)
3805 (backward-paragraph))
3806 (setq beg (point))))
3810 ;; For each of the possible types of text (string, C comment ...)
3811 ;; determine BEG and END, the region we will narrow to. If we're in
3812 ;; a literal, constrain BEG and END to the limits of this literal.
3814 ;; For some of these text types, particularly a block comment, we
3815 ;; may need to massage whitespace near literal delimiters, so that
3816 ;; these don't get filled inappropriately.
3819 ((eq c-lit-type 'c++) ; Line comment.
3821 ;; Limit to the comment or paragraph end, whichever
3823 (set-marker end (min end (cdr c-lit-limits)))
3825 (when (<= beg (car c-lit-limits))
3826 ;; The region includes the comment starter, so we must
3828 (goto-char (car c-lit-limits))
3829 (back-to-indentation)
3830 (if (eq (point) (car c-lit-limits))
3831 ;; Include the first line in the region.
3832 (setq beg (c-point 'bol))
3833 ;; The first line contains code before the
3834 ;; comment. We must fake a line that doesn't.
3837 (setq apply-outside-literal t))
3839 ((eq c-lit-type 'c) ; Block comment.
3841 (or (> end (cdr c-lit-limits))
3842 (and (= end (cdr c-lit-limits))
3843 (eq (char-before end) ?/)
3844 (eq (char-before (1- end)) ?*)
3846 (> (- (cdr c-lit-limits) (car c-lit-limits)) 3)))
3847 ;; There is a comment ender, and the region includes it. If
3848 ;; it's on its own line, it stays on its own line. If it's got
3849 ;; company on the line, it keeps (at least one word of) it.
3850 ;; "=====*/" counts as a comment ender here, but "===== */"
3851 ;; doesn't and "foo*/" doesn't.
3854 (goto-char (cdr c-lit-limits))
3856 (and (search-forward-regexp
3857 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
3858 (- (cdr c-lit-limits) 2) t)
3859 (not (search-forward-regexp
3861 (- (cdr c-lit-limits) 2) 'limit))
3862 ;; The comment ender IS on its own line. Exclude
3863 ;; this line from the filling.
3864 (set-marker end (c-point 'bol))))
3866 ;; The comment ender is hanging. Replace all space between it
3867 ;; and the last word either by one or two 'x's (when
3868 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
3869 ;; as the whitespace (when auto filling), and include it in
3870 ;; the region. We'll change them back to whitespace
3871 ;; afterwards. The effect of this is to glue the comment
3872 ;; ender to the last word in the comment during filling.
3873 (let* ((ender-start (save-excursion
3874 (goto-char (cdr c-lit-limits))
3875 (skip-syntax-backward "^w ")
3877 (ender-column (save-excursion
3878 (goto-char ender-start)
3880 (point-rel (- ender-start here))
3884 ;; Insert a CR after the "*/", adjust END
3885 (goto-char (cdr c-lit-limits))
3886 (setq tmp-post (point-marker))
3888 (set-marker end (point))
3890 (forward-line -1) ; last line of the comment
3891 (if (and (looking-at (concat "[ \t]*\\(\\("
3892 c-current-comment-prefix
3894 (eq ender-start (match-end 0)))
3895 ;; The comment ender is prefixed by nothing but a
3896 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
3897 ;; 2006/4/28). Remove it along with surrounding ws.
3898 (setq spaces (- (match-end 1) (match-end 2)))
3899 (goto-char ender-start))
3900 (skip-chars-backward " \t\r\n") ; Surely this can be
3901 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
3903 ;; What's being tested here? 2006/4/20. FIXME!!!
3904 (if (/= (point) ender-start)
3906 (if (<= here (point))
3907 ;; Don't adjust point below if it's
3908 ;; before the string we replace.
3909 (setq point-rel -1))
3910 ;; Keep one or two spaces between the
3911 ;; text and the ender, depending on how
3912 ;; many there are now.
3914 (setq spaces (- ender-column (current-column))))
3915 (setq auto-fill-spaces (c-delete-and-extract-region
3916 (point) ender-start))
3917 ;; paragraph filling condenses multiple spaces to
3918 ;; single or double spaces. auto-fill doesn't.
3923 (if sentence-end-double-space 2 1))
3925 ;; Insert the filler first to keep marks right.
3926 (insert-char ?x spaces t)
3927 (setq hang-ender-stuck spaces)
3929 (and (>= point-rel 0)
3930 (- (point) (min point-rel spaces)))))
3931 (setq point-rel nil)))
3934 ;; Point was in the middle of the string we
3935 ;; replaced above, so put it back in the same
3936 ;; relative position, counting from the end.
3937 (goto-char point-rel)))
3940 (when (<= beg (car c-lit-limits))
3941 ;; The region includes the comment starter.
3943 (goto-char (car c-lit-limits))
3944 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
3945 ;; Begin with the next line.
3946 (setq beg (c-point 'bonl))
3947 ;; Fake the fill prefix in the first line.
3950 (setq apply-outside-literal t))
3952 ((eq c-lit-type 'string) ; String.
3954 (when (>= end (cdr c-lit-limits))
3955 (goto-char (1- (cdr c-lit-limits)))
3956 (setq tmp-post (point-marker))
3958 (set-marker end (point)))
3959 (when (<= beg (car c-lit-limits))
3960 (goto-char (1+ (car c-lit-limits)))
3961 (setq beg (if (looking-at "\\\\$")
3962 ;; Leave the start line if it's
3963 ;; nothing but an escaped newline.
3966 (setq apply-outside-literal t))
3968 ((eq c-lit-type 'pound) ; Macro
3969 ;; Narrow to the macro limits if they are nearer than the
3970 ;; paragraph limits. Don't know if this is necessary but
3971 ;; do it for completeness sake (doing auto filling at all
3972 ;; inside macros is bogus to begin with since the line
3973 ;; continuation backslashes aren't handled).
3975 (c-save-buffer-state ()
3976 (c-beginning-of-macro)
3983 (set-marker end (point))))))
3986 ;; Try to avoid comments and macros in the paragraph to
3987 ;; avoid that the adaptive fill mode gets the prefix from
3989 (c-save-buffer-state nil
3992 (c-forward-syntactic-ws end)
3996 (c-backward-syntactic-ws beg)
3998 (set-marker end (point))))))
4001 ;; Temporarily insert the fill prefix after the comment
4002 ;; starter so that the first line looks like any other
4003 ;; comment line in the narrowed region.
4004 (setq fill (c-save-buffer-state nil
4005 (c-guess-fill-prefix c-lit-limits c-lit-type)))
4006 (unless (string-match (concat "\\`[ \t]*\\("
4007 c-current-comment-prefix
4010 ;; Oops, the prefix doesn't match the comment prefix
4011 ;; regexp. This could produce very confusing
4012 ;; results with adaptive fill packages together with
4013 ;; the insert prefix magic below, since the prefix
4014 ;; often doesn't appear at all. So let's warn about
4017 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4019 ;; Find the right spot on the line, break it, insert
4020 ;; the fill prefix and make sure we're back in the
4021 ;; same column by temporarily prefixing the first word
4022 ;; with a number of 'x'.
4024 (goto-char (car c-lit-limits))
4025 (if (looking-at (if (eq c-lit-type 'c++)
4026 c-current-comment-prefix
4027 comment-start-skip))
4028 (goto-char (match-end 0))
4030 (skip-chars-forward " \t"))
4031 (while (and (< (current-column) (cdr fill))
4034 (let ((col (current-column)))
4035 (setq beg (1+ (point))
4036 tmp-pre (list (point)))
4039 (insert-and-inherit "\n" (car fill))
4040 (insert-char ?x (- col (current-column)) t))
4041 (setcdr tmp-pre (point))))))
4043 (when apply-outside-literal
4044 ;; `apply-outside-literal' is always set to t here if
4045 ;; we're inside a literal.
4049 ;; Kludge: If the function that adapts the fill prefix
4050 ;; doesn't produce the required comment starter for
4051 ;; line comments, then force it by setting fill-prefix.
4052 (when (and (eq c-lit-type 'c++)
4053 ;; Kludge the kludge: filladapt-mode doesn't
4054 ;; have this problem, but it currently
4055 ;; doesn't override fill-context-prefix
4057 (not (and (boundp 'filladapt-mode)
4061 (or (fill-context-prefix beg end)
4063 (c-save-buffer-state nil
4064 (car (or fill (c-guess-fill-prefix
4065 c-lit-limits c-lit-type)))))))
4067 ;; Save the relative position of point if it's outside the
4068 ;; region we're going to narrow. Want to restore it in that
4069 ;; case, but otherwise it should be moved according to the
4071 (point-rel (cond ((< (point) beg) (- (point) beg))
4072 ((> (point) end) (- (point) end)))))
4074 ;; Preparations finally done! Now we can call the
4078 (narrow-to-region beg end)
4081 ;; Restore point if it was outside the region.
4083 (goto-char (+ beg point-rel))
4084 (goto-char (+ end point-rel))))))))
4086 (when (consp tmp-pre)
4087 (delete-region (car tmp-pre) (cdr tmp-pre)))
4091 (goto-char tmp-post)
4093 (when hang-ender-stuck
4094 ;; Preserve point even if it's in the middle of the string
4095 ;; we replace; save-excursion doesn't work in that case.
4097 (goto-char tmp-post)
4098 (skip-syntax-backward "^w ")
4099 (forward-char (- hang-ender-stuck))
4100 (if (or fill-paragraph (not auto-fill-spaces))
4101 (insert-char ?\ hang-ender-stuck t)
4102 (insert auto-fill-spaces)
4103 (setq here (- here (- hang-ender-stuck (length auto-fill-spaces)))))
4104 (delete-char hang-ender-stuck)
4106 (set-marker tmp-post nil))
4108 (set-marker end nil))))
4110 (defun c-fill-paragraph (&optional arg)
4111 "Like \\[fill-paragraph] but handles C and C++ style comments.
4112 If any of the current line is a comment or within a comment, fill the
4113 comment or the paragraph of it that point is in, preserving the
4114 comment indentation or line-starting decorations (see the
4115 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4118 If point is inside multiline string literal, fill it. This currently
4119 does not respect escaped newlines, except for the special case when it
4120 is the very first thing in the string. The intended use for this rule
4121 is in situations like the following:
4123 char description[] = \"\\
4124 A very long description of something that you want to fill to make
4125 nicely formatted output.\"\;
4127 If point is in any other situation, i.e. in normal code, do nothing.
4129 Optional prefix ARG means justify paragraph as well."
4131 (let ((fill-paragraph-function
4132 ;; Avoid infinite recursion.
4133 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4134 fill-paragraph-function)))
4135 (c-mask-paragraph t nil 'fill-paragraph arg))
4136 ;; Always return t. This has the effect that if filling isn't done
4137 ;; above, it isn't done at all, and it's therefore effectively
4138 ;; disabled in normal code.
4141 (defun c-do-auto-fill ()
4142 ;; Do automatic filling if not inside a context where it should be
4144 (let ((c-auto-fill-prefix
4145 ;; The decision whether the line should be broken is actually
4146 ;; done in c-indent-new-comment-line, which do-auto-fill
4147 ;; calls to break lines. We just set this special variable
4148 ;; so that we'll know when we're called from there. It's
4149 ;; also used to detect whether fill-prefix is user set or
4150 ;; generated automatically by do-auto-fill.
4152 (c-mask-paragraph nil t 'do-auto-fill)))
4154 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4155 "Break line at point and indent, continuing comment or macro if within one.
4156 If inside a comment and `comment-multi-line' is non-nil, the
4157 indentation and line prefix are preserved (see the
4158 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4159 details). If inside a single line comment and `comment-multi-line' is
4160 nil, a new comment of the same type is started on the next line and
4161 indented as appropriate for comments. If inside a macro, a line
4162 continuation backslash is inserted and aligned as appropriate, and the
4163 new line is indented according to `c-syntactic-indentation'.
4165 If a fill prefix is specified, it overrides all the above."
4166 ;; allow-auto-fill is used from c-context-line-break to allow auto
4167 ;; filling to break the line more than once. Since this function is
4168 ;; used from auto-fill itself, that's normally disabled to avoid
4169 ;; unnecessary recursion.
4171 (let ((fill-prefix fill-prefix)
4174 (delete-horizontal-space)
4176 (insert-and-inherit ?\n)
4177 (newline (if allow-auto-fill nil 1)))))
4178 ;; Already know the literal type and limits when called from
4179 ;; c-context-line-break.
4180 (c-lit-limits c-lit-limits)
4181 (c-lit-type c-lit-type)
4182 (c-macro-start c-macro-start))
4184 (c-save-buffer-state ()
4185 (when (not (eq c-auto-fill-prefix t))
4186 ;; Called from do-auto-fill.
4187 (unless c-lit-limits
4188 (setq c-lit-limits (c-literal-limits nil nil t)))
4190 (setq c-lit-type (c-literal-type c-lit-limits)))
4191 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4192 ((null c-lit-type) 'code)
4195 (setq fill-prefix t) ; Used as flag in the cond.
4196 (if (and (null c-auto-fill-prefix)
4198 (<= (c-point 'bol) (car c-lit-limits)))
4199 ;; The adaptive fill function has generated a prefix, but
4200 ;; we're on the first line in a block comment so it'll be
4201 ;; wrong. Ignore it to guess a better one below.
4202 (setq fill-prefix nil)
4203 (when (and (eq c-lit-type 'c++)
4204 (not (string-match (concat "\\`[ \t]*"
4205 c-line-comment-starter)
4206 (or fill-prefix ""))))
4207 ;; Kludge: If the function that adapted the fill prefix
4208 ;; doesn't produce the required comment starter for line
4209 ;; comments, then we ignore it.
4210 (setq fill-prefix nil)))
4213 (cond ((eq fill-prefix t)
4214 ;; A call from do-auto-fill which should be ignored.
4217 ;; A fill-prefix overrides anything.
4218 (funcall do-line-break)
4219 (insert-and-inherit fill-prefix))
4220 ((c-save-buffer-state ()
4221 (unless c-lit-limits
4222 (setq c-lit-limits (c-literal-limits)))
4224 (setq c-lit-type (c-literal-type c-lit-limits)))
4225 (memq c-lit-type '(c c++)))
4226 ;; Some sort of comment.
4227 (if (or comment-multi-line
4229 (goto-char (car c-lit-limits))
4231 (< (point) (cdr c-lit-limits))))
4232 ;; Inside a comment that should be continued.
4233 (let ((fill (c-save-buffer-state nil
4234 (c-guess-fill-prefix
4236 (c-collect-line-comments c-lit-limits))
4240 (or (and (eq c-lit-type 'c)
4242 (goto-char (- (cdr c-lit-limits) 2))
4243 (if (looking-at "\\*/") (point))))
4244 (cdr c-lit-limits))))
4245 ;; Skip forward past the fill prefix in case
4246 ;; we're standing in it.
4248 ;; FIXME: This doesn't work well in cases like
4250 ;; /* Bla bla bla bla bla
4253 ;; If point is on the 'B' then the line will be
4254 ;; broken after "Bla b".
4255 (while (and (< (current-column) (cdr fill))
4258 (if (and (> (point) comment-text-end)
4259 (> (c-point 'bol) (car c-lit-limits)))
4261 ;; The skip takes us out of the (block)
4262 ;; comment; insert the fill prefix at bol
4263 ;; instead and keep the position.
4264 (setq pos (copy-marker pos t))
4266 (insert-and-inherit (car fill))
4267 (if soft (insert-and-inherit ?\n) (newline 1))
4269 (set-marker pos nil))
4270 ;; Don't break in the middle of a comment starter
4272 (cond ((> (point) comment-text-end)
4273 (goto-char comment-text-end))
4274 ((< (point) (+ (car c-lit-limits) 2))
4275 (goto-char (+ (car c-lit-limits) 2))))
4276 (funcall do-line-break)
4277 (insert-and-inherit (car fill))))
4278 ;; Inside a comment that should be broken.
4279 (let ((comment-start comment-start)
4280 (comment-end comment-end)
4282 (if (eq c-lit-type 'c)
4283 (unless (string-match "[ \t]*/\\*" comment-start)
4284 (setq comment-start "/* " comment-end " */"))
4285 (unless (string-match "[ \t]*//" comment-start)
4286 (setq comment-start "// " comment-end "")))
4287 (setq col (save-excursion
4288 (back-to-indentation)
4290 (funcall do-line-break)
4291 (when (and comment-end (not (equal comment-end "")))
4293 (insert-and-inherit comment-end)
4295 ;; c-comment-indent may look at the current
4296 ;; indentation, so let's start out with the same
4297 ;; indentation as the previous one.
4299 (insert-and-inherit comment-start)
4300 (indent-for-comment))))
4301 ((c-query-and-set-macro-start)
4303 (unless (looking-at "[ \t]*\\\\$")
4304 ;; Do not clobber the alignment of the line continuation
4305 ;; slash; c-backslash-region might look at it.
4306 (delete-horizontal-space))
4307 ;; Got an asymmetry here: In normal code this command
4308 ;; doesn't indent the next line syntactically, and otoh a
4309 ;; normal syntactically indenting newline doesn't continue
4311 (c-newline-and-indent (if allow-auto-fill nil 1)))
4313 ;; Somewhere else in the code.
4314 (let ((col (save-excursion
4316 (while (and (looking-at "[ \t]*\\\\?$")
4317 (= (forward-line -1) 0)))
4318 (current-indentation))))
4319 (funcall do-line-break)
4320 (indent-to col))))))
4322 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
4323 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line)
4325 ;; advice for indent-new-comment-line for older Emacsen
4326 (unless (boundp 'comment-line-break-function)
4327 (defvar c-inside-line-break-advice nil)
4328 (defadvice indent-new-comment-line (around c-line-break-advice
4329 activate preactivate)
4330 "Call `c-indent-new-comment-line' if in CC Mode."
4331 (if (or c-inside-line-break-advice
4332 (not c-buffer-is-cc-mode))
4334 (let ((c-inside-line-break-advice t))
4335 (c-indent-new-comment-line (ad-get-arg 0))))))
4337 (defun c-context-line-break ()
4338 "Do a line break suitable to the context.
4340 When point is outside a comment or macro, insert a newline and indent
4341 according to the syntactic context, unless `c-syntactic-indentation'
4342 is nil, in which case the new line is indented as the previous
4343 non-empty line instead.
4345 When point is inside the content of a preprocessor directive, a line
4346 continuation backslash is inserted before the line break and aligned
4347 appropriately. The end of the cpp directive doesn't count as inside
4350 When point is inside a comment, continue it with the appropriate
4351 comment prefix (see the `c-comment-prefix-regexp' and
4352 `c-block-comment-prefix' variables for details). The end of a
4353 C++-style line comment doesn't count as inside it.
4355 When point is inside a string, only insert a backslash when it is also
4356 inside a preprocessor directive."
4359 (let* (c-lit-limits c-lit-type
4360 (c-macro-start c-macro-start))
4362 (c-save-buffer-state ()
4363 (setq c-lit-limits (c-literal-limits nil nil t)
4364 c-lit-type (c-literal-type c-lit-limits))
4365 (when (eq c-lit-type 'c++)
4366 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4367 (c-query-and-set-macro-start))
4370 ((or (eq c-lit-type 'c)
4371 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4373 (skip-chars-forward " \t")
4375 (1- (cdr c-lit-limits))))
4376 (and (numberp c-macro-start) ; Macro, but not at the very end of
4377 ; it, not in a string, and not in the
4379 (not (eq c-lit-type 'string))
4380 (or (not (looking-at "\\s *$"))
4381 (eq (char-before) ?\\))
4383 (goto-char c-macro-start)
4384 (if (looking-at c-opt-cpp-start)
4385 (goto-char (match-end 0)))
4388 (let ((comment-multi-line t)
4390 (c-indent-new-comment-line nil t)))
4392 ((eq c-lit-type 'string)
4393 (if (and (numberp c-macro-start)
4394 (not (eq (char-before) ?\\)))
4398 (t (delete-horizontal-space)
4400 ;; c-indent-line may look at the current indentation, so let's
4401 ;; start out with the same indentation as the previous line.
4402 (let ((col (save-excursion
4405 (while (and (looking-at "[ \t]*\\\\?$")
4406 (= (forward-line -1) 0)))
4407 (current-indentation))))
4409 (indent-according-to-mode)))))
4411 (defun c-context-open-line ()
4412 "Insert a line break suitable to the context and leave point before it.
4413 This is the `c-context-line-break' equivalent to `open-line', which is
4414 normally bound to C-o. See `c-context-line-break' for the details."
4416 (let ((here (point)))
4419 ;; Temporarily insert a non-whitespace char to keep any
4420 ;; preceding whitespace intact.
4422 (c-context-line-break))
4427 (cc-provide 'cc-cmds)
4429 ;;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
4430 ;;; cc-cmds.el ends here