1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2012 Free Software Foundation, Inc.
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
37 (if (and (boundp 'byte-compile-dest-file
)
38 (stringp byte-compile-dest-file
))
39 (cons (file-name-directory byte-compile-dest-file
) load-path
)
41 (load "cc-bytecomp" nil t
)))
45 (cc-require 'cc-engine
)
47 ;; Silence the compiler.
48 (cc-bytecomp-defun delete-forward-p) ; XEmacs
49 (cc-bytecomp-defvar filladapt-mode
) ; c-fill-paragraph contains a kludge
50 ; which looks at this.
52 ;; Indentation / Display syntax functions
53 (defvar c-fix-backslashes t
)
55 (defun c-indent-line (&optional syntax quiet ignore-point-pos
)
56 "Indent the current line according to the syntactic context,
57 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
58 syntactic information for the current line. Be silent about syntactic
59 errors if the optional argument QUIET is non-nil, even if
60 `c-report-syntactic-errors' is non-nil. Normally the position of
61 point is used to decide where the old indentation is on a lines that
62 is otherwise empty \(ignoring any line continuation backslash), but
63 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
64 indentation change \(in columns)."
66 (let ((line-cont-backslash (save-excursion
68 (eq (char-before) ?
\\)))
69 (c-fix-backslashes c-fix-backslashes
)
72 (when (and (not ignore-point-pos
)
75 (looking-at (if line-cont-backslash
76 ;; Don't use "\\s " - ^L doesn't count as WS
80 (<= (point) (match-end 1)))
81 ;; Delete all whitespace after point if there's only whitespace
82 ;; on the line, so that any code that does back-to-indentation
83 ;; or similar gets the current column in this case. If this
84 ;; removes a line continuation backslash it'll be restored
86 (unless c-auto-align-backslashes
87 ;; Should try to keep the backslash alignment
90 (goto-char (match-end 0))
91 (setq bs-col
(1- (current-column)))))
92 (delete-region (point) (match-end 0))
93 (setq c-fix-backslashes t
))
94 (if c-syntactic-indentation
96 (or (let ((c-parsing-error nil
)
99 (and (boundp 'c-syntactic-context
)
100 c-syntactic-context
))))
101 (c-save-buffer-state (indent)
102 (unless c-syntactic-context
103 (setq c-syntactic-context
(c-guess-basic-syntax)))
104 (setq indent
(c-get-syntactic-indentation
105 c-syntactic-context
))
106 (and (not (c-echo-parsing-error quiet
))
107 c-echo-syntactic-information-p
108 (message "syntax: %s, indent: %d"
109 c-syntactic-context indent
))
110 (setq shift-amt
(- indent
(current-indentation))))
111 (c-shift-line-indentation shift-amt
)
112 (run-hooks 'c-special-indent-hook
)
117 (while (and (= (forward-line -
1) 0)
118 (if (looking-at "\\s *\\\\?$")
120 (setq indent
(current-indentation))
122 (setq shift-amt
(- indent
(current-indentation)))
123 (c-shift-line-indentation shift-amt
)))
124 (when (and c-fix-backslashes line-cont-backslash
)
129 (when c-auto-align-backslashes
130 ;; Realign the line continuation backslash.
131 (c-backslash-region (point) (point) nil t
))))
134 (defun c-newline-and-indent (&optional newline-arg
)
135 "Insert a newline and indent the new line.
136 This function fixes line continuation backslashes if inside a macro,
137 and takes care to set the indentation before calling
138 `indent-according-to-mode', so that lineup functions like
139 `c-lineup-dont-change' works better."
141 ;; TODO: Backslashes before eol in comments and literals aren't
143 (let ((c-macro-start (c-query-macro-start))
144 ;; Avoid calling c-backslash-region from c-indent-line if it's
145 ;; called during the newline call, which can happen due to
146 ;; c-electric-continued-statement, for example. We also don't
147 ;; want any backslash alignment from indent-according-to-mode.
148 (c-fix-backslashes nil
)
149 has-backslash insert-backslash
154 (while (and (looking-at "[ \t]*\\\\?$")
155 (= (forward-line -
1) 0)))
156 (setq col
(current-indentation)))
158 (if (and (eolp) (eq (char-before) ?
\\))
159 (setq insert-backslash t
161 (setq has-backslash
(eq (char-before (c-point 'eol
)) ?
\\))))
162 (newline newline-arg
)
167 ;; The backslash stayed on the previous line. Insert one
168 ;; before calling c-backslash-region, so that
169 ;; bs-col-after-end in it works better. Fixup the
170 ;; backslashes on the newly inserted line.
173 (c-backslash-region (point) (point) nil t
))
174 ;; The backslash moved to the new line, if there was any. Let
175 ;; c-backslash-region fix a backslash on the previous line,
176 ;; and the one that might be on the new line.
177 ;; c-auto-align-backslashes is intentionally ignored here;
178 ;; maybe the moved backslash should be left alone if it's set,
179 ;; but we fix both lines on the grounds that the old backslash
180 ;; has been moved anyway and is now in a different context.
181 (c-backslash-region start
(if has-backslash
(point) start
) nil t
)))
182 (when c-syntactic-indentation
183 ;; Reindent syntactically. The indentation done above is not
184 ;; wasted, since c-indent-line might look at the current
186 (let ((c-syntactic-context (c-save-buffer-state nil
187 (c-guess-basic-syntax))))
188 ;; We temporarily insert another line break, so that the
189 ;; lineup functions will see the line as empty. That makes
190 ;; e.g. c-lineup-cpp-define more intuitive since it then
191 ;; proceeds to the preceding line in this case.
193 (delete-horizontal-space)
194 (setq start
(- (point-max) (point)))
198 (indent-according-to-mode))
199 (goto-char (- (point-max) start
))
202 ;; Must align the backslash again after reindentation. The
203 ;; c-backslash-region call above can't be optimized to ignore
204 ;; this line, since it then won't align correctly with the
205 ;; lines below if the first line in the macro is broken.
206 (c-backslash-region (point) (point) nil t
)))))
208 (defun c-show-syntactic-information (arg)
209 "Show syntactic information for current line.
210 With universal argument, inserts the analysis as a comment on that line."
212 (let* ((c-parsing-error nil
)
213 (syntax (if (boundp 'c-syntactic-context
)
214 ;; Use `c-syntactic-context' in the same way as
215 ;; `c-indent-line', to be consistent.
217 (c-save-buffer-state nil
218 (c-guess-basic-syntax)))))
219 (if (not (consp arg
))
221 (message "Syntactic analysis: %s" syntax
)
225 (setq elem
(pop syntax
))
226 (when (setq pos
(c-langelem-pos elem
))
227 (push (c-put-overlay pos
(1+ pos
)
230 (when (setq pos
(c-langelem-2nd-pos elem
))
231 (push (c-put-overlay pos
(1+ pos
)
232 'face
'secondary-selection
)
236 (c-delete-overlay (pop ols
)))))
238 (insert-and-inherit (format "%s" syntax
))
240 (c-keep-region-active))
242 (defun c-syntactic-information-on-region (from to
)
243 "Insert a comment with the syntactic analysis on every line in the region."
247 (narrow-to-region from to
)
248 (goto-char (point-min))
250 (c-show-syntactic-information '(0))
254 ;; Minor mode functions.
255 (defun c-update-modeline ()
256 (let ((fmt (format "/%s%s%s%s"
257 (if c-electric-flag
"l" "")
258 (if (and c-electric-flag c-auto-newline
)
260 (if c-hungry-delete-key
"h" "")
262 ;; subword might not be loaded.
263 (boundp 'subword-mode
)
264 (symbol-value 'subword-mode
))
267 ;; FIXME: Derived modes might want to use something else
268 ;; than a string for `mode-name'.
269 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name
)
270 (match-string 1 mode-name
)
272 ;; (setq c-submode-indicators
273 ;; (if (> (length fmt) 1)
276 (if (> (length fmt
) 1)
277 (concat bare-mode-name fmt
)
279 (force-mode-line-update)))
281 (defun c-toggle-syntactic-indentation (&optional arg
)
282 "Toggle syntactic indentation.
283 Optional numeric ARG, if supplied, turns on syntactic indentation when
284 positive, turns it off when negative, and just toggles it when zero or
287 When syntactic indentation is turned on (the default), the indentation
288 functions and the electric keys indent according to the syntactic
289 context keys, when applicable.
291 When it's turned off, the electric keys don't reindent, the indentation
292 functions indents every new line to the same level as the previous
293 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
294 specified by `c-basic-offset'. The indentation style has no effect in
295 this mode, nor any of the indentation associated variables,
296 e.g. `c-special-indent-hook'.
298 This command sets the variable `c-syntactic-indentation'."
300 (setq c-syntactic-indentation
301 (c-calculate-state arg c-syntactic-indentation
))
302 (c-keep-region-active))
304 (defun c-toggle-auto-newline (&optional arg
)
305 "Toggle auto-newline feature.
306 Optional numeric ARG, if supplied, turns on auto-newline when
307 positive, turns it off when negative, and just toggles it when zero or
310 Turning on auto-newline automatically enables electric indentation.
312 When the auto-newline feature is enabled (indicated by \"/la\" on the
313 modeline after the mode name) newlines are automatically inserted
314 after special characters such as brace, comma, semi-colon, and colon."
317 (c-calculate-state arg
(and c-auto-newline c-electric-flag
)))
318 (if c-auto-newline
(setq c-electric-flag t
))
320 (c-keep-region-active))
322 (defalias 'c-toggle-auto-state
'c-toggle-auto-newline
)
323 (make-obsolete 'c-toggle-auto-state
'c-toggle-auto-newline
"22.1")
325 (defun c-toggle-hungry-state (&optional arg
)
326 "Toggle hungry-delete-key feature.
327 Optional numeric ARG, if supplied, turns on hungry-delete when
328 positive, turns it off when negative, and just toggles it when zero or
331 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
332 the modeline after the mode name) the delete key gobbles all preceding
333 whitespace in one fell swoop."
335 (setq c-hungry-delete-key
(c-calculate-state arg c-hungry-delete-key
))
337 (c-keep-region-active))
339 (defun c-toggle-auto-hungry-state (&optional arg
)
340 "Toggle auto-newline and hungry-delete-key features.
341 Optional numeric ARG, if supplied, turns on auto-newline and
342 hungry-delete when positive, turns them off when negative, and just
343 toggles them when zero or left out.
345 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
347 (setq c-auto-newline
(c-calculate-state arg c-auto-newline
))
348 (setq c-hungry-delete-key
(c-calculate-state arg c-hungry-delete-key
))
350 (c-keep-region-active))
352 (defun c-toggle-electric-state (&optional arg
)
353 "Toggle the electric indentation feature.
354 Optional numeric ARG, if supplied, turns on electric indentation when
355 positive, turns it off when negative, and just toggles it when zero or
358 (setq c-electric-flag
(c-calculate-state arg c-electric-flag
))
360 (c-keep-region-active))
365 (defun c-electric-backspace (arg)
366 "Delete the preceding character or whitespace.
367 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
368 line) then all preceding whitespace is consumed. If however a prefix
369 argument is supplied, or `c-hungry-delete-key' is nil, or point is
370 inside a literal then the function in the variable
371 `c-backspace-function' is called."
373 (if (c-save-buffer-state ()
374 (or (not c-hungry-delete-key
)
377 (funcall c-backspace-function
(prefix-numeric-value arg
))
378 (c-hungry-delete-backwards)))
380 (defun c-hungry-delete-backwards ()
381 "Delete the preceding character or all preceding whitespace
382 back to the previous non-whitespace character.
383 See also \\[c-hungry-delete-forward]."
385 (let ((here (point)))
387 (if (/= (point) here
)
388 (delete-region (point) here
)
389 (funcall c-backspace-function
1))))
391 (defalias 'c-hungry-backspace
'c-hungry-delete-backwards
)
393 (defun c-electric-delete-forward (arg)
394 "Delete the following character or whitespace.
395 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
396 line) then all following whitespace is consumed. If however a prefix
397 argument is supplied, or `c-hungry-delete-key' is nil, or point is
398 inside a literal then the function in the variable `c-delete-function'
401 (if (c-save-buffer-state ()
402 (or (not c-hungry-delete-key
)
405 (funcall c-delete-function
(prefix-numeric-value arg
))
406 (c-hungry-delete-forward)))
408 (defun c-hungry-delete-forward ()
409 "Delete the following character or all following whitespace
410 up to the next non-whitespace character.
411 See also \\[c-hungry-delete-backwards]."
413 (let ((here (point)))
415 (if (/= (point) here
)
416 (delete-region (point) here
)
417 (funcall c-delete-function
1))))
419 ;; This function is only used in XEmacs.
420 (defun c-electric-delete (arg)
421 "Deletes preceding or following character or whitespace.
422 This function either deletes forward as `c-electric-delete-forward' or
423 backward as `c-electric-backspace', depending on the configuration: If
424 the function `delete-forward-p' is defined and returns non-nil, it
425 deletes forward. Otherwise it deletes backward.
427 Note: This is the way in XEmacs to choose the correct action for the
428 \[delete] key, whichever key that means. Other flavors don't use this
429 function to control that."
431 (if (and (fboundp 'delete-forward-p
)
433 (c-electric-delete-forward arg
)
434 (c-electric-backspace arg
)))
436 ;; This function is only used in XEmacs.
437 (defun c-hungry-delete ()
438 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
439 The direction of deletion depends on the configuration: If the
440 function `delete-forward-p' is defined and returns non-nil, it deletes
441 forward using `c-hungry-delete-forward'. Otherwise it deletes
442 backward using `c-hungry-backspace'.
444 Note: This is the way in XEmacs to choose the correct action for the
445 \[delete] key, whichever key that means. Other flavors don't use this
446 function to control that."
448 (if (and (fboundp 'delete-forward-p
)
450 (c-hungry-delete-forward)
451 (c-hungry-delete-backwards)))
453 (defun c-electric-pound (arg)
455 If `c-electric-flag' is set, handle it specially according to the variable
456 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
457 inside a literal or a macro, nothing special happens."
459 (if (c-save-buffer-state ()
461 (not c-electric-flag
)
462 (not (memq 'alignleft c-electric-pound-behavior
))
464 (skip-chars-backward " \t")
467 (and (= (forward-line -
1) 0)
469 (eq (char-before) ?
\\))))
471 ;; do nothing special
472 (self-insert-command (prefix-numeric-value arg
))
473 ;; place the pound character at the left edge
474 (let ((pos (- (point-max) (point)))
477 (delete-horizontal-space)
478 (insert last-command-event
)
480 (goto-char (- (point-max) pos
)))
483 (defun c-point-syntax ()
484 ;; Return the syntactic context of the construct at point. (This is NOT
485 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
486 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
487 (c-save-buffer-state (;; shut this up too
488 (c-echo-syntactic-information-p nil
)
490 (c-tentative-buffer-changes
491 ;; insert a newline to isolate the construct at point for syntactic
494 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
495 ;; the syntax. (There might already be an escaped NL there.)
496 (when (or (c-at-vsemi-p (1- (point)))
500 (and (c-beginning-of-macro)
501 (progn (c-end-of-macro)
506 (let ((c-syntactic-indentation-in-macros t
)
507 (c-auto-newline-analysis t
))
508 ;; Turn on syntactic macro analysis to help with auto
510 (setq syntax
(c-guess-basic-syntax))
514 (defun c-brace-newlines (syntax)
515 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
516 ;; (not necessarily the same as the S.C. of the line it is on). Return
517 ;; NEWLINES, the list containing some combination of the symbols `before'
518 ;; and `after' saying where newlines should be inserted.
521 ;; This is the list of brace syntactic symbols that can hang.
522 ;; If any new ones are added to c-offsets-alist, they should be
523 ;; added here as well.
525 ;; The order of this list is important; if SYNTAX has several
526 ;; elements, the element that "wins" is the earliest in SYMS.
527 '(arglist-cont-nonempty ; e.g. an array literal.
528 class-open class-close defun-open defun-close
529 inline-open inline-close
530 brace-list-open brace-list-close
531 brace-list-intro brace-entry-open
532 block-open block-close
533 substatement-open statement-case-open
534 extern-lang-open extern-lang-close
535 namespace-open namespace-close
536 module-open module-close
537 composition-open composition-close
538 inexpr-class-open inexpr-class-close
539 ;; `statement-cont' is here for the case with a brace
540 ;; list opener inside a statement. C.f. CASE B.2 in
541 ;; `c-guess-continued-construct'.
544 (c-echo-syntactic-information-p nil
)
545 symb-newlines
) ; e.g. (substatement-open . (after))
548 ;; Do not try to insert newlines around a special
549 ;; (Pike-style) brace list.
550 (if (and c-special-brace-lists
552 (c-safe (if (= (char-before) ?
{)
555 (c-looking-at-special-brace-list))))
557 ;; Seek the matching entry in c-hanging-braces-alist.
560 ;; Substitute inexpr-class and class-open or
561 ;; class-close with inexpr-class-open or
562 ;; inexpr-class-close.
563 (if (assq 'inexpr-class syntax
)
564 (cond ((assq 'class-open syntax
)
565 '((inexpr-class-open)))
566 ((assq 'class-close syntax
)
567 '((inexpr-class-close)))
570 c-hanging-braces-alist
)
571 '(ignore before after
)))) ; Default, when not in c-h-b-l.
573 ;; If syntax is a function symbol, then call it using the
574 ;; defined semantics.
575 (if (and (not (consp (cdr symb-newlines
)))
576 (functionp (cdr symb-newlines
)))
577 (let ((c-syntactic-context syntax
))
578 (funcall (cdr symb-newlines
)
581 (cdr symb-newlines
))))
583 (defun c-try-one-liner ()
584 ;; Point is just after a newly inserted }. If the non-whitespace
585 ;; content of the braces is a single line of code, compact the whole
586 ;; construct to a single line, if this line isn't too long. The Right
587 ;; Thing is done with comments.
589 ;; Point will be left after the }, regardless of whether the clean-up is
590 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
593 (pos (- (point-max) (point)))
594 mbeg1 mend1 mbeg4 mend4
595 eol-col cmnt-pos cmnt-col cmnt-gap
)
600 ;; Avoid backtracking over a very large block. The one we
601 ;; deal with here can never be more than three lines.
602 (narrow-to-region (save-excursion
606 (and (c-safe (c-backward-sexp))
609 (narrow-to-region (point) (1- here
)) ; innards of {.}
611 (cc-eval-when-compile
613 "\\(" ; (match-beginning 1)
614 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
615 "\\)" ; (match-end 1)
616 "[^ \t\r\n]+\\([ \t]+[^ \t\r\n]+\\)*" ; non-WS
617 "\\(" ; (match-beginning 4)
618 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
619 "\\)\\'"))))))) ; (match-end 4) at EOB.
621 (if (c-tentative-buffer-changes
622 (setq mbeg1
(match-beginning 1) mend1
(match-end 1)
623 mbeg4
(match-beginning 4) mend4
(match-end 4))
624 (backward-char) ; back over the `}'
626 (setq cmnt-pos
(and (c-backward-single-comment)
627 (- (point) (- mend1 mbeg1
)))))
628 (delete-region mbeg4 mend4
)
629 (delete-region mbeg1 mend1
)
630 (setq eol-col
(save-excursion (end-of-line) (current-column)))
632 ;; Necessary to put the closing brace before any line
633 ;; oriented comment to keep it syntactically significant.
634 ;; This isn't necessary for block comments, but the result
635 ;; looks nicer anyway.
637 (delete-char 1) ; the `}' has blundered into a comment
639 (setq cmnt-col
(1+ (current-column)))
640 (setq cmnt-pos
(1+ cmnt-pos
)) ; we're inserting a `}'
642 (insert-char ?\
} 1) ; reinsert the `}' before the comment.
643 (setq cmnt-gap
(- cmnt-col
(current-column)))
644 (when (zerop cmnt-gap
)
645 (insert-char ?\
1) ; Put a space before a bare comment.
648 (or (null c-max-one-liner-length
)
649 (zerop c-max-one-liner-length
)
650 (<= eol-col c-max-one-liner-length
)
651 ;; Can we trim space before comment to make the line fit?
653 (< (- eol-col cmnt-gap
) c-max-one-liner-length
)
654 (progn (goto-char cmnt-pos
)
655 (backward-delete-char-untabify
656 (- eol-col c-max-one-liner-length
))
658 (goto-char (- (point-max) pos
))))))
660 (defun c-electric-brace (arg)
663 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
664 numeric ARG hasn't been supplied, the command performs several electric
667 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
668 the mode line) newlines are inserted before and after the brace as
669 directed by the settings in `c-hanging-braces-alist'.
671 \(b) Any auto-newlines are indented. The original line is also
672 reindented unless `c-syntactic-indentation' is nil.
674 \(c) If auto-newline is turned on, various newline cleanups based on the
675 settings of `c-cleanup-list' are done."
678 (let (safepos literal
679 ;; We want to inhibit blinking the paren since this would be
680 ;; most disruptive. We'll blink it ourselves later on.
681 (old-blink-paren blink-paren-function
)
682 blink-paren-function case-fold-search
)
684 (c-save-buffer-state ()
685 (setq safepos
(c-safe-position (point) (c-parse-state))
686 literal
(c-in-literal safepos
)))
688 ;; Insert the brace. Note that expand-abbrev might reindent
689 ;; the line here if there's a preceding "else" or something.
690 (self-insert-command (prefix-numeric-value arg
))
692 (when (and c-electric-flag
(not literal
) (not arg
))
693 (if (not (looking-at "[ \t]*\\\\?$"))
694 (if c-syntactic-indentation
695 (indent-according-to-mode))
697 (let ( ;; shut this up too
698 (c-echo-syntactic-information-p nil
)
700 ln-syntax br-syntax syntax
) ; Syntactic context of the original line,
701 ; of the brace itself, of the line the brace ends up on.
702 (c-save-buffer-state ((c-syntactic-indentation-in-macros t
)
703 (c-auto-newline-analysis t
))
704 (setq ln-syntax
(c-guess-basic-syntax)))
705 (if c-syntactic-indentation
706 (c-indent-line ln-syntax
))
710 (setq br-syntax
(c-point-syntax)
711 newlines
(c-brace-newlines br-syntax
))
713 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
714 (if (and (memq 'before newlines
)
715 (> (current-column) (current-indentation)))
716 (if c-syntactic-indentation
717 ;; Only a plain newline for now - it's indented
718 ;; after the cleanups when the line has its final
721 (c-newline-and-indent)))
724 ;; `syntax' is the syntactic context of the line which ends up
725 ;; with the brace on it.
726 (setq syntax
(if (memq 'before newlines
) br-syntax ln-syntax
))
728 ;; Do all appropriate clean ups
730 (pos (- (point-max) (point)))
734 ;; `}': clean up empty defun braces
735 (when (c-save-buffer-state ()
736 (and (memq 'empty-defun-braces c-cleanup-list
)
737 (eq last-command-event ?\
})
738 (c-intersect-lists '(defun-close class-close inline-close
)
743 (eq (char-before) ?\
{))
744 ;; make sure matching open brace isn't in a comment
745 (not (c-in-literal))))
746 (delete-region (point) (1- here
))
747 (setq here
(- (point-max) pos
)))
750 ;; `}': compact to a one-liner defun?
753 (and (eq last-command-event ?\
})
754 (memq 'one-liner-defun
c-cleanup-list)
755 (c-intersect-lists '(defun-close) syntax
)
757 (setq here
(- (point-max) pos
))))
759 ;; `{': clean up brace-else-brace and brace-elseif-brace
760 (when (eq last-command-event ?\
{)
762 ((and (memq 'brace-else-brace c-cleanup-list
)
765 "\\([ \t\n]\\|\\\\\n\\)*"
767 "\\([ \t\n]\\|\\\\\n\\)*"
771 (delete-region (match-beginning 0) (match-end 0))
772 (insert-and-inherit "} else {"))
773 ((and (memq 'brace-elseif-brace c-cleanup-list
)
775 (goto-char (1- here
))
779 (eq (char-before) ?\
)))
780 (zerop (c-save-buffer-state nil
(c-backward-token-2 1 t
)))
781 (eq (char-after) ?\
()
786 "\\([ \t\n]\\|\\\\\n\\)*"
788 "\\([ \t\n]\\|\\\\\n\\)+"
790 "\\([ \t\n]\\|\\\\\n\\)*"
793 ;(eq (match-end 0) tmp);
795 (delete-region mbeg mend
)
799 (goto-char (- (point-max) pos
))
801 ;; Indent the line after the cleanups since it might
802 ;; very well indent differently due to them, e.g. if
803 ;; c-indent-one-line-block is used together with the
804 ;; one-liner-defun cleanup.
805 (when c-syntactic-indentation
808 ;; does a newline go after the brace?
809 (if (memq 'after newlines
)
810 (c-newline-and-indent))
814 (and (eq last-command-event ?\
})
815 (not executing-kbd-macro
)
818 (c-save-buffer-state nil
819 (c-backward-syntactic-ws safepos
))
820 (funcall old-blink-paren
)))))
822 (defun c-electric-slash (arg)
823 "Insert a slash character.
825 If the slash is inserted immediately after the comment prefix in a c-style
826 comment, the comment might get closed by removing whitespace and possibly
827 inserting a \"*\". See the variable `c-cleanup-list'.
829 Indent the line as a comment, if:
831 1. The slash is second of a \"//\" line oriented comment introducing
832 token and we are on a comment-only-line, or
834 2. The slash is part of a \"*/\" token that closes a block oriented
837 If a numeric ARG is supplied, point is inside a literal, or
838 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
841 (let ((literal (c-save-buffer-state () (c-in-literal)))
844 (c-echo-syntactic-information-p nil
))
846 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
847 ;; `c-syntactic-indentation' set.
850 (memq 'comment-close-slash c-cleanup-list
)
851 (eq last-command-event ?
/)
852 (looking-at (concat "[ \t]*\\("
853 (regexp-quote comment-end
) "\\)?$"))
854 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
857 (narrow-to-region (point-min) (point))
858 (back-to-indentation)
859 (looking-at (concat c-current-comment-prefix
"[ \t]*$")))))
860 (delete-region (progn (forward-line 0) (point))
861 (progn (end-of-line) (point)))
862 (insert-char ?
* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
864 (setq indentp
(and (not arg
)
865 c-syntactic-indentation
867 (eq last-command-event ?
/)
868 (eq (char-before) (if literal ?
* ?
/))))
869 (self-insert-command (prefix-numeric-value arg
))
871 (indent-according-to-mode))))
873 (defun c-electric-star (arg)
874 "Insert a star character.
875 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
876 the star is the second character of a C style comment starter on a
877 comment-only-line, indent the line as a comment. If a numeric ARG is
878 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
879 this indentation is inhibited."
882 (self-insert-command (prefix-numeric-value arg
))
883 ;; if we are in a literal, or if arg is given do not reindent the
884 ;; current line, unless this star introduces a comment-only line.
885 (if (c-save-buffer-state ()
886 (and c-syntactic-indentation
889 (eq (c-in-literal) 'c
)
890 (eq (char-before) ?
*)
893 (skip-chars-backward "*")
894 (if (eq (char-before) ?
/)
896 (skip-chars-backward " \t")
898 (let (c-echo-syntactic-information-p) ; shut this up
899 (indent-according-to-mode))
902 (defun c-electric-semi&comma
(arg)
903 "Insert a comma or semicolon.
905 If `c-electric-flag' is non-nil, point isn't inside a literal and a
906 numeric ARG hasn't been supplied, the command performs several electric
909 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
910 the mode line) a newline might be inserted. See the variable
911 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
913 \(b) Any auto-newlines are indented. The original line is also
914 reindented unless `c-syntactic-indentation' is nil.
916 \(c) If auto-newline is turned on, a comma following a brace list or a
917 semicolon following a defun might be cleaned up, depending on the
918 settings of `c-cleanup-list'."
920 (let* (lim literal c-syntactic-context
923 (c-echo-syntactic-information-p nil
))
925 (c-save-buffer-state ()
926 (setq lim
(c-most-enclosing-brace (c-parse-state))
927 literal
(c-in-literal lim
)))
929 (self-insert-command (prefix-numeric-value arg
))
931 (if (and c-electric-flag
(not literal
) (not arg
))
932 ;; do all cleanups and newline insertions if c-auto-newline is on.
933 (if (or (not c-auto-newline
)
934 (not (looking-at "[ \t]*\\\\?$")))
935 (if c-syntactic-indentation
937 ;; clean ups: list-close-comma or defun-close-semi
938 (let ((pos (- (point-max) (point))))
939 (if (c-save-buffer-state ()
941 (eq last-command-event ?
,)
942 (memq 'list-close-comma c-cleanup-list
))
944 (eq last-command-event ?\
;)
945 (memq 'defun-close-semi c-cleanup-list
)))
949 (eq (char-before) ?
}))
950 ;; make sure matching open brace isn't in a comment
951 (not (c-in-literal lim
))))
952 (delete-region (point) here
))
953 (goto-char (- (point-max) pos
)))
955 (when c-syntactic-indentation
956 (setq c-syntactic-context
(c-guess-basic-syntax))
957 (c-indent-line c-syntactic-context
))
958 ;; check to see if a newline should be added
959 (let ((criteria c-hanging-semi
&comma-criteria
)
960 answer add-newline-p
)
962 (setq answer
(funcall (car criteria
)))
963 ;; only nil value means continue checking
965 (setq criteria
(cdr criteria
))
967 ;; only 'stop specifically says do not add a newline
968 (setq add-newline-p
(not (eq answer
'stop
)))
971 (c-newline-and-indent))
974 (defun c-electric-colon (arg)
977 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
978 numeric ARG hasn't been supplied, the command performs several electric
981 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
982 the mode line) newlines are inserted before and after the colon based on
983 the settings in `c-hanging-colons-alist'.
985 \(b) Any auto-newlines are indented. The original line is also
986 reindented unless `c-syntactic-indentation' is nil.
988 \(c) If auto-newline is turned on, whitespace between two colons will be
989 \"cleaned up\" leaving a scope operator, if this action is set in
993 (let* ((bod (c-point 'bod
))
994 (literal (c-save-buffer-state () (c-in-literal bod
)))
997 (c-echo-syntactic-information-p nil
))
998 (self-insert-command (prefix-numeric-value arg
))
999 ;; Any electric action?
1000 (if (and c-electric-flag
(not literal
) (not arg
))
1001 ;; Unless we're at EOL, only re-indentation happens.
1002 (if (not (looking-at "[ \t]*\\\\?$"))
1003 (if c-syntactic-indentation
1004 (indent-according-to-mode))
1006 ;; scope-operator clean-up?
1007 (let ((pos (- (point-max) (point)))
1009 (if (c-save-buffer-state () ; Why do we need this? [ACM, 2003-03-12]
1011 (memq 'scope-operator c-cleanup-list
)
1012 (eq (char-before) ?
:)
1015 (c-skip-ws-backward)
1016 (eq (char-before) ?
:))
1017 (not (c-in-literal))
1018 (not (eq (char-after (- (point) 2)) ?
:))))
1020 (delete-region (point) (1- here
))
1021 (setq is-scope-op t
)))
1022 (goto-char (- (point-max) pos
)))
1024 ;; indent the current line if it's done syntactically.
1025 (if c-syntactic-indentation
1026 ;; Cannot use the same syntax analysis as we find below,
1027 ;; since that's made with c-syntactic-indentation-in-macros
1029 (indent-according-to-mode))
1031 ;; Calculate where, if anywhere, we want newlines.
1032 (c-save-buffer-state
1033 ((c-syntactic-indentation-in-macros t
)
1034 (c-auto-newline-analysis t
)
1035 ;; Turn on syntactic macro analysis to help with auto newlines
1037 (syntax (c-guess-basic-syntax))
1039 ;; Translate substatement-label to label for this operation.
1041 (if (eq (car (car elem
)) 'substatement-label
)
1042 (setcar (car elem
) 'label
))
1043 (setq elem
(cdr elem
)))
1044 ;; some language elements can only be determined by checking
1045 ;; the following line. Let's first look for ones that can be
1046 ;; found when looking on the line with the colon
1049 (or (c-lookup-lists '(case-label label access-label
)
1050 syntax c-hanging-colons-alist
)
1051 (c-lookup-lists '(member-init-intro inher-intro
)
1055 (c-guess-basic-syntax)
1057 c-hanging-colons-alist
)))))
1058 ;; does a newline go before the colon? Watch out for already
1059 ;; non-hung colons. However, we don't unhang them because that
1060 ;; would be a cleanup (and anti-social).
1061 (if (and (memq 'before newlines
)
1064 (skip-chars-backward ": \t")
1066 (let ((pos (- (point-max) (point))))
1068 (c-newline-and-indent)
1069 (goto-char (- (point-max) pos
))))
1070 ;; does a newline go after the colon?
1071 (if (and (memq 'after
(cdr-safe newlines
))
1073 (c-newline-and-indent))
1076 (defun c-electric-lt-gt (arg)
1077 "Insert a \"<\" or \">\" character.
1078 If the current language uses angle bracket parens (e.g. template
1079 arguments in C++), try to find out if the inserted character is a
1080 paren and give it paren syntax if appropriate.
1082 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1083 line will be reindented if the inserted character is a paren or if it
1084 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1085 numeric argument is supplied, or the point is inside a literal."
1088 (let ((c-echo-syntactic-information-p nil
)
1089 final-pos close-paren-inserted found-delim case-fold-search
)
1091 (self-insert-command (prefix-numeric-value arg
))
1092 (setq final-pos
(point))
1094 ;;;; 2010-01-31: There used to be code here to put a syntax-table text
1095 ;;;; property on the new < or > and its mate (if any) when they are template
1096 ;;;; parens. This is now done in an after-change function.
1098 ;; Indent the line if appropriate.
1099 (when (and c-electric-flag c-syntactic-indentation c-recognize-
<>-arglists
)
1101 (if (eq last-command-event ?
<)
1102 ;; If a <, basically see if it's got "template" before it .....
1106 (progn (c-beginning-of-current-token) (point))))
1108 (c-backward-token-2)
1109 (looking-at c-opt-
<>-sexp-key
)))
1110 ;; ..... or is a C++ << operator.
1111 (and (c-major-mode-is 'c
++-mode
)
1113 (goto-char (1- final-pos
))
1114 (c-beginning-of-current-token)
1116 (>= (match-end 0) final-pos
)))
1118 ;; It's a >. Either a C++ >> operator. ......
1119 (or (and (c-major-mode-is 'c
++-mode
)
1121 (goto-char (1- final-pos
))
1122 (c-beginning-of-current-token)
1124 (>= (match-end 0) final-pos
))
1125 ;; ...., or search back for a < which isn't already marked as an
1126 ;; opening template delimiter.
1129 ;; Narrow to avoid `c-forward-<>-arglist' below searching past
1131 (narrow-to-region (point-min) final-pos
)
1132 (goto-char final-pos
)
1136 (c-syntactic-skip-backward "^<;}" nil t
)
1137 (eq (char-before) ?
<))
1140 (looking-at "\\s\("))))
1141 (and (eq (char-after) ?
<)
1142 (not (looking-at "\\s\("))
1143 (progn (c-backward-syntactic-ws)
1144 (c-simple-skip-symbol-backward))
1145 (or (looking-at c-opt-
<>-sexp-key
)
1146 (not (looking-at c-keywords-regexp
)))))))))
1148 (goto-char final-pos
)
1150 (indent-according-to-mode)
1151 (when (and (eq (char-before) ?
>)
1152 (not executing-kbd-macro
)
1153 blink-paren-function
)
1154 ;; Note: Most paren blink functions, such as the standard
1155 ;; `blink-matching-open', currently doesn't handle paren chars
1156 ;; marked with text properties very well. Maybe we should avoid
1157 ;; this call for the time being?
1158 (funcall blink-paren-function
)))))
1160 (defun c-electric-paren (arg)
1161 "Insert a parenthesis.
1163 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1164 line is reindented unless a numeric ARG is supplied, or the parenthesis
1165 is inserted inside a literal.
1167 Whitespace between a function name and the parenthesis may get added or
1168 removed; see the variable `c-cleanup-list'.
1170 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1171 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1173 (let ((literal (c-save-buffer-state () (c-in-literal)))
1175 (c-echo-syntactic-information-p nil
)
1177 (self-insert-command (prefix-numeric-value arg
))
1179 (if (and (not arg
) (not literal
))
1180 (let* ( ;; We want to inhibit blinking the paren since this will
1181 ;; be most disruptive. We'll blink it ourselves
1183 (old-blink-paren blink-paren-function
)
1184 blink-paren-function
)
1185 (if (and c-syntactic-indentation c-electric-flag
)
1186 (indent-according-to-mode))
1188 ;; If we're at EOL, check for new-line clean-ups.
1189 (when (and c-electric-flag c-auto-newline
1190 (looking-at "[ \t]*\\\\?$"))
1192 ;; clean up brace-elseif-brace
1194 (and (memq 'brace-elseif-brace c-cleanup-list
)
1195 (eq last-command-event ?\
()
1198 "\\([ \t\n]\\|\\\\\n\\)*"
1200 "\\([ \t\n]\\|\\\\\n\\)+"
1202 "\\([ \t\n]\\|\\\\\n\\)*"
1206 (not (c-save-buffer-state () (c-in-literal))))
1207 (delete-region (match-beginning 0) (match-end 0))
1208 (insert-and-inherit "} else if ("))
1210 ;; clean up brace-catch-brace
1212 (and (memq 'brace-catch-brace c-cleanup-list
)
1213 (eq last-command-event ?\
()
1216 "\\([ \t\n]\\|\\\\\n\\)*"
1218 "\\([ \t\n]\\|\\\\\n\\)*"
1222 (not (c-save-buffer-state () (c-in-literal))))
1223 (delete-region (match-beginning 0) (match-end 0))
1224 (insert-and-inherit "} catch (")))
1226 ;; Check for clean-ups at function calls. These two DON'T need
1227 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1228 ;; Point is currently just after the inserted paren.
1229 (let (beg (end (1- (point))))
1232 ;; space-before-funcall clean-up?
1233 ((and (memq 'space-before-funcall c-cleanup-list
)
1234 (eq last-command-event ?\
()
1237 (skip-chars-backward " \t")
1239 (and (c-save-buffer-state () (c-on-identifier))
1240 ;; Don't add a space into #define FOO()....
1241 (not (and (c-beginning-of-macro)
1242 (c-forward-over-cpp-define-id)
1243 (eq (point) beg
))))))
1245 (delete-region beg end
)
1249 ;; compact-empty-funcall clean-up?
1250 ((c-save-buffer-state ()
1251 (and (memq 'compact-empty-funcall c-cleanup-list
)
1252 (eq last-command-event ?\
))
1254 (c-safe (backward-char 2))
1255 (when (looking-at "()")
1257 (skip-chars-backward " \t")
1259 (c-on-identifier)))))
1260 (delete-region beg end
))))
1261 (and (eq last-input-event ?\
))
1262 (not executing-kbd-macro
)
1264 (funcall old-blink-paren
))))))
1266 (defun c-electric-continued-statement ()
1267 "Reindent the current line if appropriate.
1269 This function is used to reindent the line after a keyword which
1270 continues an earlier statement is typed, e.g. an \"else\" or the
1271 \"while\" in a do-while block.
1273 The line is reindented if there is nothing but whitespace before the
1274 keyword on the line, the keyword is not inserted inside a literal, and
1275 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1276 (let (;; shut this up
1277 (c-echo-syntactic-information-p nil
))
1278 (when (c-save-buffer-state ()
1279 (and c-electric-flag
1280 c-syntactic-indentation
1281 (not (eq last-command-event ?_
))
1283 (skip-syntax-backward "w")
1286 (not (c-in-literal (c-point 'bod
)))))
1287 ;; Have to temporarily insert a space so that
1288 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1289 ;; space with a nonspace to avoid messing up any whitespace
1290 ;; sensitive meddling that might be done, e.g. by
1291 ;; `c-backslash-region'.
1292 (insert-and-inherit " x")
1294 (indent-according-to-mode)
1295 (delete-char -
2)))))
1299 (declare-function subword-forward
"subword" (&optional arg
))
1300 (declare-function subword-backward
"subword" (&optional arg
))
1302 ;; "nomenclature" functions + c-scope-operator.
1303 (defun c-forward-into-nomenclature (&optional arg
)
1304 "Compatibility alias for `c-forward-subword'."
1307 (subword-forward arg
))
1308 (make-obsolete 'c-forward-into-nomenclature
'subword-forward
"23.2")
1310 (defun c-backward-into-nomenclature (&optional arg
)
1311 "Compatibility alias for `c-backward-subword'."
1314 (subword-backward arg
))
1315 (make-obsolete 'c-backward-into-nomenclature
'subword-backward
"23.2")
1317 (defun c-scope-operator ()
1318 "Insert a double colon scope operator at point.
1319 No indentation or other \"electric\" behavior is performed."
1321 (insert-and-inherit "::"))
1324 ;; Movement (etc.) by defuns.
1325 (defun c-in-function-trailer-p (&optional lim
)
1326 ;; Return non-nil if point is between the closing brace and the semicolon of
1327 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1328 ;; portion of a declaration like "struct foo {...} bar ;".
1330 ;; Return the position of the main declaration. Otherwise, return nil.
1331 ;; Point is assumed to be at the top level and outside of any macro or
1334 ;; If LIM is non-nil, it is the bound on a the backward search for the
1335 ;; beginning of the declaration.
1337 ;; This function might do hidden buffer changes.
1338 (and c-opt-block-decls-with-vars-key
1340 (c-syntactic-skip-backward "^;}" lim
)
1341 (let ((eo-block (point))
1343 (and (eq (char-before) ?\
})
1344 (eq (car (c-beginning-of-decl-1 lim
)) 'previous
)
1346 ;; Look for struct or union or ... If we find one, it might
1347 ;; be the return type of a function, or the like. Exclude
1349 (c-syntactic-re-search-forward
1350 (concat "[;=\(\[{]\\|\\("
1351 c-opt-block-decls-with-vars-key
1354 (match-beginning 1) ; Is there a "struct" etc., somewhere?
1355 (not (eq (char-before) ?_
))
1356 (c-syntactic-re-search-forward "[;=\(\[{]" eo-block t t t
)
1357 (eq (char-before) ?\
{)
1360 (defun c-where-wrt-brace-construct ()
1361 ;; Determine where we are with respect to functions (or other brace
1362 ;; constructs, included in the term "function" in the rest of this comment).
1363 ;; Point is assumed to be outside any macro or literal.
1364 ;; This is used by c-\(beginning\|end\)-of-defun.
1366 ;; Return one of these symbols:
1367 ;; at-header : we're at the start of a function's header.
1368 ;; in-header : we're inside a function's header, this extending right
1369 ;; up to the brace. This bit includes any k&r declarations.
1370 ;; in-block : we're inside a function's brace block.
1371 ;; in-trailer : we're in the area between the "}" and ";" of something
1372 ;; like "struct foo {...} bar, baz;".
1373 ;; at-function-end : we're just after the closing brace (or semicolon) that
1374 ;; terminates the function.
1375 ;; outwith-function: we're not at or in any function. Being inside a
1376 ;; non-brace construct also counts as 'outwith-function'.
1378 ;; This function might do hidden buffer changes.
1381 decl-result brace-decl-p
1383 (paren-state (c-parse-state))
1384 (least-enclosing (c-least-enclosing-brace paren-state
)))
1387 ((and least-enclosing
1388 (eq (char-after least-enclosing
) ?\
{))
1390 ((c-in-function-trailer-p)
1392 ((and (not least-enclosing
)
1394 (consp (car paren-state
))
1395 (eq start
(cdar paren-state
)))
1398 ;; Find the start of the current declaration. NOTE: If we're in the
1399 ;; variables after a "struct/eval" type block, we don't get to the
1400 ;; real declaration here - we detect and correct for this later.
1402 ;;If we're in the parameters' parens, move back out of them.
1403 (if least-enclosing
(goto-char least-enclosing
))
1404 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1405 ;; at a declaration.
1406 (if (or (and (eolp) (not (eobp))) ; EOL is matched by "\\s>"
1408 "\\([;#]\\|\\'\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s$\\|\\s<\\|\\s>\\|\\s!\\)")))
1410 (setq kluge-start
(point))
1412 (car (c-beginning-of-decl-1
1413 ;; NOTE: If we're in a K&R region, this might be the start
1414 ;; of a parameter declaration, not the actual function.
1415 (and least-enclosing
; LIMIT for c-b-of-decl-1
1416 (c-safe-position least-enclosing paren-state
)))))
1418 ;; Has the declaration we've gone back to got braces?
1421 (and (c-syntactic-re-search-forward "[;{]" nil t t
)
1422 (or (eq (char-before) ?\
{)
1423 (and c-recognize-knr-p
1424 ;; Might have stopped on the
1425 ;; ';' in a K&R argdecl. In
1426 ;; that case the declaration
1427 ;; should contain a block.
1428 (c-in-knr-argdecl))))))
1431 ((= (point) kluge-start
) ; might be BOB or unbalanced parens.
1433 ((eq decl-result
'same
)
1435 (if (eq (point) start
)
1439 ((eq decl-result
'previous
)
1440 (if (and (not brace-decl-p
)
1441 (c-in-function-trailer-p))
1445 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1448 (defun c-backward-to-nth-BOF-{ (n where
)
1449 ;; Skip to the opening brace of the Nth function before point. If
1450 ;; point is inside a function, this counts as the first. Point must be
1451 ;; outside any comment/string or macro.
1453 ;; N must be strictly positive.
1454 ;; WHERE describes the position of point, one of the symbols `at-header',
1455 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1456 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1458 ;; If we run out of functions, leave point at BOB. Return zero on success,
1459 ;; otherwise the number of {s still to go.
1461 ;; This function may do hidden buffer changes
1463 ;; What we do to go back the first defun depends on where we start.
1465 ((eq where
'in-block
)
1466 (goto-char (c-least-enclosing-brace (c-parse-state)))
1468 ((eq where
'in-header
)
1469 (c-syntactic-re-search-forward "{")
1472 ((memq where
'(at-header outwith-function at-function-end in-trailer
))
1473 (c-syntactic-skip-backward "^}")
1474 (when (eq (char-before) ?\
})
1477 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where
)))
1479 ;; Each time round the loop, go back to a "{" at the outermost level.
1480 (while (and (> n
0) (not (bobp)))
1481 (c-parse-state) ; This call speeds up the following one
1482 ; by a factor of ~6. Hmmm. 2006/4/5.
1483 (c-syntactic-skip-backward "^}")
1484 (when (eq (char-before) ?\
})
1489 (defun c-narrow-to-most-enclosing-decl-block (&optional inclusive
)
1490 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1491 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1492 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1493 ;; otherwise include the braces. If the closing brace is missing,
1494 ;; (point-max) is used instead.
1495 (let ((paren-state (c-parse-state))
1497 (setq encl-decl
(and paren-state
(c-most-enclosing-decl-block paren-state
)))
1502 (progn (goto-char encl-decl
)
1503 (c-beginning-of-decl-1)
1507 (goto-char encl-decl
)
1508 (or (c-safe (forward-list)
1514 (defun c-widen-to-enclosing-decl-scope (paren-state orig-point-min orig-point-max
)
1515 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1516 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1517 ;; braces NOT being included in the resulting region. On no account may the
1518 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1519 ;; PAREN-STATE is a list of buffer positions in the style of
1520 ;; (c-parse-state), one of which will be that of the desired opening brace,
1523 ;; Return the position of the enclosing opening brace, or nil
1524 (let (encl-decl) ; putative position of decl-scope's opening brace.
1526 (narrow-to-region orig-point-min orig-point-max
)
1527 (setq encl-decl
(and paren-state
1528 (c-most-enclosing-decl-block paren-state
))))
1532 (narrow-to-region (1+ encl-decl
)
1534 (goto-char encl-decl
)
1535 (or (c-safe (forward-list)
1539 (narrow-to-region orig-point-min orig-point-max
)
1543 (defmacro c-while-widening-to-decl-block
(condition)
1544 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1545 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1546 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1547 ;; buffer's original restriction.
1549 ;; This is a very special purpose macro, which assumes the existence of
1550 ;; several variables. It is for use only in c-beginning-of-defun and
1554 (eq c-defun-tactic
'go-outward
)
1556 (setq paren-state
(c-whack-state-after lim paren-state
))
1557 (setq lim
(c-widen-to-enclosing-decl-scope
1558 paren-state orig-point-min orig-point-max
))
1559 (setq where
'in-block
))))
1561 (defun c-beginning-of-defun (&optional arg
)
1562 "Move backward to the beginning of a defun.
1563 Every top level declaration that contains a brace paren block is
1564 considered to be a defun.
1566 With a positive argument, move backward that many defuns. A negative
1567 argument -N means move forward to the Nth following beginning. Return
1568 t unless search stops due to beginning or end of buffer.
1570 Unlike the built-in `beginning-of-defun' this tries to be smarter
1571 about finding the char with open-parenthesis syntax that starts the
1575 (or arg
(setq arg
1))
1577 (or (not (eq this-command
'c-beginning-of-defun
))
1578 (eq last-command
'c-beginning-of-defun
)
1579 (and transient-mark-mode mark-active
)
1582 (c-save-buffer-state
1583 (beginning-of-defun-function end-of-defun-function
1585 (paren-state (copy-tree (c-parse-state))) ; This must not share list
1586 ; structure with other users of c-state-cache.
1587 (orig-point-min (point-min)) (orig-point-max (point-max))
1588 lim
; Position of { which has been widened to.
1589 where pos case-fold-search
)
1592 (if (eq c-defun-tactic
'go-outward
)
1593 (setq lim
(c-widen-to-enclosing-decl-scope ; e.g. class, namespace.
1594 paren-state orig-point-min orig-point-max
)))
1596 ;; Move back out of any macro/comment/string we happen to be in.
1597 (c-beginning-of-macro)
1598 (setq pos
(c-literal-limits))
1599 (if pos
(goto-char (car pos
)))
1601 (setq where
(c-where-wrt-brace-construct))
1604 ;; Move forward to the closing brace of a function.
1606 (if (memq where
'(at-function-end outwith-function
))
1607 (setq arg
(1+ arg
)))
1609 (c-while-widening-to-decl-block
1610 (< (setq arg
(- (c-forward-to-nth-EOF-} (- arg
) where
))) 0)))
1611 ;; Move forward to the next opening brace....
1612 (when (and (= arg
0)
1614 (c-while-widening-to-decl-block
1615 (not (c-syntactic-re-search-forward "{" nil
'eob
)))
1616 (eq (char-before) ?
{)))
1618 ;; ... and backward to the function header.
1619 (c-beginning-of-decl-1)
1622 ;; Move backward to the opening brace of a function, making successively
1623 ;; larger portions of the buffer visible as necessary.
1625 (c-while-widening-to-decl-block
1626 (> (setq arg
(c-backward-to-nth-BOF-{ arg where
)) 0)))
1629 ;; Go backward to this function's header.
1630 (c-beginning-of-decl-1)
1633 ;; We're now there, modulo comments and whitespace.
1634 ;; Try to be line oriented; position point at the closest
1635 ;; preceding boi that isn't inside a comment, but if we hit
1636 ;; the previous declaration then we use the current point
1638 (while (and (/= (point) (c-point 'boi
))
1639 (c-backward-single-comment)))
1640 (if (/= (point) (c-point 'boi
))
1643 (c-keep-region-active)
1646 (defun c-forward-to-nth-EOF-} (n where
)
1647 ;; Skip to the closing brace of the Nth function after point. If
1648 ;; point is inside a function, this counts as the first. Point must be
1649 ;; outside any comment/string or macro.
1651 ;; N must be strictly positive.
1652 ;; WHERE describes the position of point, one of the symbols `at-header',
1653 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1654 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1656 ;; If we run out of functions, leave point at EOB. Return zero on success,
1657 ;; otherwise the number of }s still to go.
1659 ;; This function may do hidden buffer changes.
1662 ;; What we do to go forward over the first defun depends on where we
1663 ;; start. We go to the closing brace of that defun, even when we go
1664 ;; backwards to it (in a "struct foo {...} bar ;").
1666 ((eq where
'in-block
)
1667 (goto-char (c-least-enclosing-brace (c-parse-state)))
1670 ((eq where
'in-trailer
)
1671 (c-syntactic-skip-backward "^}")
1673 ((memq where
'(at-function-end outwith-function at-header in-header
))
1674 (when (c-syntactic-re-search-forward "{" nil
'eob
)
1678 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where
)))
1680 ;; Each time round the loop, go forward to a "}" at the outermost level.
1681 (while (and (> n
0) (not (eobp)))
1682 ;(c-parse-state) ; This call speeds up the following one by a factor
1683 ; of ~6. Hmmm. 2006/4/5.
1684 (when (c-syntactic-re-search-forward "{" nil
'eob
)
1690 (defun c-end-of-defun (&optional arg
)
1691 "Move forward to the end of a top level declaration.
1692 With argument, do it that many times. Negative argument -N means move
1693 back to Nth preceding end. Returns t unless search stops due to
1694 beginning or end of buffer.
1696 An end of a defun occurs right after the close-parenthesis that matches
1697 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1699 (or arg
(setq arg
1))
1701 (or (not (eq this-command
'c-end-of-defun
))
1702 (eq last-command
'c-end-of-defun
)
1703 (and transient-mark-mode mark-active
)
1706 (c-save-buffer-state
1707 (beginning-of-defun-function end-of-defun-function
1709 (paren-state (copy-tree (c-parse-state))) ; This must not share list
1710 ; structure with other users of c-state-cache.
1711 (orig-point-min (point-min)) (orig-point-max (point-max))
1713 where pos case-fold-search
)
1716 (if (eq c-defun-tactic
'go-outward
)
1717 (setq lim
(c-widen-to-enclosing-decl-scope ; e.g. class, namespace
1718 paren-state orig-point-min orig-point-max
)))
1720 ;; Move back out of any macro/comment/string we happen to be in.
1721 (c-beginning-of-macro)
1722 (setq pos
(c-literal-limits))
1723 (if pos
(goto-char (car pos
)))
1725 (setq where
(c-where-wrt-brace-construct))
1728 ;; Move backwards to the } of a function
1730 (if (memq where
'(at-header outwith-function
))
1731 (setq arg
(1+ arg
)))
1733 (c-while-widening-to-decl-block
1734 (< (setq arg
(- (c-backward-to-nth-BOF-{ (- arg
) where
))) 0)))
1736 (c-while-widening-to-decl-block
1737 (progn (c-syntactic-skip-backward "^}")
1738 (not (eq (char-before) ?
}))))))
1740 ;; Move forward to the } of a function
1742 (c-while-widening-to-decl-block
1743 (> (setq arg
(c-forward-to-nth-EOF-} arg where
)) 0))))
1745 ;; Do we need to move forward from the brace to the semicolon?
1747 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1748 (c-syntactic-re-search-forward ";"))
1751 ;; We're there now, modulo comments and whitespace.
1752 ;; Try to be line oriented; position point after the next
1753 ;; newline that isn't inside a comment, but if we hit the
1754 ;; next declaration then we use the current point instead.
1755 (while (and (not (bolp))
1756 (not (looking-at "\\s *$"))
1757 (c-forward-single-comment)))
1759 ((looking-at "\\s *$")
1764 (c-keep-region-active)
1767 (defun c-defun-name ()
1768 "Return the name of the current defun, or NIL if there isn't one.
1769 \"Defun\" here means a function, or other top level construct
1770 with a brace block."
1772 (c-save-buffer-state
1773 (beginning-of-defun-function end-of-defun-function
1774 where pos name-end case-fold-search
)
1779 ;; Move back out of any macro/comment/string we happen to be in.
1780 (c-beginning-of-macro)
1781 (setq pos
(c-literal-limits))
1782 (if pos
(goto-char (car pos
)))
1784 (setq where
(c-where-wrt-brace-construct))
1786 ;; Move to the beginning of the current defun, if any, if we're not
1788 (if (eq where
'outwith-function
)
1790 (unless (eq where
'at-header
)
1791 (c-backward-to-nth-BOF-{ 1 where
)
1792 (c-beginning-of-decl-1))
1794 ;; Pick out the defun name, according to the type of defun.
1796 ;; struct, union, enum, or similar:
1797 ((and (looking-at c-type-prefix-key
)
1798 (progn (c-forward-token-2 2) ; over "struct foo "
1799 (or (eq (char-after) ?\
{)
1800 (looking-at c-symbol-key
)))) ; "struct foo bar ..."
1801 (save-match-data (c-forward-token-2))
1802 (when (eq (char-after) ?\
{)
1803 (c-backward-token-2)
1804 (looking-at c-symbol-key
))
1805 (match-string-no-properties 0))
1807 ((looking-at "DEFUN\\_>")
1808 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1809 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1811 (c-forward-syntactic-ws)
1812 (when (eq (char-after) ?
\")
1814 (c-forward-token-2)) ; over the comma and following WS.
1815 (buffer-substring-no-properties
1819 (when (looking-at ":") ; CLISP: DEFUN(PACKAGE:LISP-SYMBOL,...)
1820 (skip-chars-forward "^,"))
1821 (c-backward-syntactic-ws)
1824 ((looking-at "DEF[a-zA-Z0-9_]* *( *\\([^, ]*\\) *,")
1825 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1826 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1827 (match-string-no-properties 1))
1830 ;; Normal function or initializer.
1831 (when (c-syntactic-re-search-forward "[{(]" nil t
)
1833 (c-backward-syntactic-ws)
1834 (when (eq (char-before) ?\
=) ; struct foo bar = {0, 0} ;
1835 (c-backward-token-2)
1836 (c-backward-syntactic-ws))
1837 (setq name-end
(point))
1838 (c-backward-token-2)
1839 (buffer-substring-no-properties (point) name-end
)))))))))
1841 (defun c-declaration-limits (near)
1842 ;; Return a cons of the beginning and end positions of the current
1843 ;; top level declaration or macro. If point is not inside any then
1844 ;; nil is returned, unless NEAR is non-nil in which case the closest
1845 ;; following one is chosen instead (if there is any). The end
1846 ;; position is at the next line, providing there is one before the
1849 ;; This function might do hidden buffer changes.
1852 (when (eq c-defun-tactic
'go-outward
)
1853 (c-narrow-to-most-enclosing-decl-block t
) ; e.g. class, namespace
1854 (or (save-restriction
1855 (c-narrow-to-most-enclosing-decl-block nil
)
1857 ;; Note: Some code duplication in `c-beginning-of-defun' and
1858 ;; `c-end-of-defun'.
1860 (let ((start (point))
1861 (paren-state (c-parse-state))
1864 (goto-char (c-least-enclosing-brace paren-state
))
1865 ;; If we moved to the outermost enclosing paren
1866 ;; then we can use c-safe-position to set the
1867 ;; limit. Can't do that otherwise since the
1868 ;; earlier paren pair on paren-state might very
1869 ;; well be part of the declaration we should go
1871 (setq lim
(c-safe-position (point) paren-state
))
1873 ;; At top level. Make sure we aren't inside a literal.
1874 (setq pos
(c-literal-limits
1875 (c-safe-position (point) paren-state
)))
1876 (if pos
(goto-char (car pos
))))
1878 (when (c-beginning-of-macro)
1887 (when (or (eq (car (c-beginning-of-decl-1 lim
)) 'previous
)
1889 ;; We moved back over the previous defun. Skip to the next
1890 ;; one. Not using c-forward-syntactic-ws here since we
1891 ;; should not skip a macro. We can also be directly after
1892 ;; the block in a `c-opt-block-decls-with-vars-key'
1893 ;; declaration, but then we won't move significantly far
1896 (c-forward-comments)
1898 (when (and near
(c-beginning-of-macro))
1906 (if (eobp) (throw 'exit nil
))
1908 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1909 ;; declaration that doesn't end there. We're searching back and
1910 ;; forth over the block here, which can be expensive.
1912 (if (and c-opt-block-decls-with-vars-key
1914 (c-backward-syntactic-ws)
1915 (eq (char-before) ?
}))
1916 (eq (car (c-beginning-of-decl-1))
1920 (and (> (point) pos
)
1921 (setq end-pos
(point)))))
1925 (if (and (not near
) (> (point) start
))
1928 ;; Try to be line oriented; position the limits at the
1929 ;; closest preceding boi, and after the next newline, that
1930 ;; isn't inside a comment, but if we hit a neighboring
1931 ;; declaration then we instead use the exact declaration
1932 ;; limit in that direction.
1935 (while (and (/= (point) (c-point 'boi
))
1936 (c-backward-single-comment)))
1937 (if (/= (point) (c-point 'boi
))
1945 (while (and (not (bolp))
1946 (not (looking-at "\\s *$"))
1947 (c-forward-single-comment)))
1950 ((looking-at "\\s *$")
1956 (goto-char (point-min))
1957 (c-forward-decl-or-cast-1 -
1 nil nil
)
1958 (eq (char-after) ?\
{)
1959 (cons (point-min) (point-max))))))))
1961 (defun c-mark-function ()
1962 "Put mark at end of the current top-level declaration or macro, point at beginning.
1963 If point is not inside any then the closest following one is
1964 chosen. Each successive call of this command extends the marked
1965 region by one function.
1967 A mark is left where the command started, unless the region is already active
1968 \(in Transient Mark mode).
1970 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1971 function does not require the declaration to contain a brace block."
1974 (let (decl-limits case-fold-search
)
1975 (c-save-buffer-state nil
1976 ;; We try to be line oriented, unless there are several
1977 ;; declarations on the same line.
1978 (if (looking-at c-syntactic-eol
)
1979 (c-backward-token-2 1 nil
(c-point 'bol
)))
1980 (setq decl-limits
(c-declaration-limits t
)))
1982 (if (not decl-limits
)
1983 (error "Cannot find any declaration")
1984 (let* ((extend-region-p
1985 (and (eq this-command
'c-mark-function
)
1986 (eq last-command
'c-mark-function
)))
1987 (push-mark-p (and (eq this-command
'c-mark-function
)
1988 (not extend-region-p
)
1989 (not (and transient-mark-mode mark-active
)))))
1990 (if push-mark-p
(push-mark (point)))
1993 (exchange-point-and-mark)
1994 (setq decl-limits
(c-declaration-limits t
))
1995 (when (not decl-limits
)
1996 (exchange-point-and-mark)
1997 (error "Cannot find any declaration"))
1998 (goto-char (cdr decl-limits
))
1999 (exchange-point-and-mark))
2000 (goto-char (car decl-limits
))
2001 (push-mark (cdr decl-limits
) nil t
))))))
2003 (defun c-cpp-define-name ()
2004 "Return the name of the current CPP macro, or NIL if we're not in one."
2006 (let (case-fold-search)
2008 (and c-opt-cpp-macro-define-start
2009 (c-beginning-of-macro)
2010 (looking-at c-opt-cpp-macro-define-start
)
2011 (match-string-no-properties 1)))))
2014 ;; Movement by statements.
2015 (defun c-in-comment-line-prefix-p ()
2016 ;; Point is within a comment. Is it also within a comment-prefix?
2017 ;; Space at BOL which precedes a comment-prefix counts as part of it.
2019 ;; This function might do hidden buffer changes.
2020 (let ((here (point)))
2023 (skip-chars-forward " \t")
2024 (and (looking-at c-current-comment-prefix
)
2025 (/= (match-beginning 0) (match-end 0))
2026 (< here
(match-end 0))))))
2028 (defun c-narrow-to-comment-innards (range)
2029 ;; Narrow to the "inside" of the comment (block) defined by range, as
2032 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2033 ;; present) removed. A c++-style line comment retains its opening "//" but
2034 ;; has any final NL removed. If POINT is currently outwith these innards,
2035 ;; move it to the appropriate boundary.
2037 ;; This narrowing simplifies the sentence movement functions, since it
2038 ;; eliminates awkward things at the boundaries of the comment (block).
2040 ;; This function might do hidden buffer changes.
2041 (let* ((lit-type (c-literal-type range
))
2042 (beg (if (eq lit-type
'c
) (+ (car range
) 2) (car range
)))
2043 (end (if (eq lit-type
'c
)
2044 (if (and (eq (char-before (cdr range
)) ?
/)
2045 (eq (char-before (1- (cdr range
))) ?
*))
2048 (if (eq (cdr range
) (point-max))
2050 (- (cdr range
) 1)))))
2052 (goto-char end
)) ; This would be done automatically by ...
2054 (goto-char beg
)) ; ... narrow-to-region but is not documented.
2055 (narrow-to-region beg end
)))
2057 (defun c-beginning-of-sentence-in-comment (range)
2058 ;; Move backwards to the "beginning of a sentence" within the comment
2059 ;; defined by RANGE, a cons of its starting and ending positions. If we
2060 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2061 ;; of the comment and return T.
2063 ;; The BOS is either text which follows a regexp match of sentence-end,
2064 ;; or text which is a beginning of "paragraph".
2065 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2067 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2068 ;; It is not a general function, but is intended only for calling from
2069 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2071 ;; This function might do hidden buffer changes.
2073 (let ((start-point (point)))
2075 (c-narrow-to-comment-innards range
) ; This may move point back.
2076 (let* ((here (point))
2078 (here-filler ; matches WS and comment-prefixes at point.
2079 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix
"\\)"
2080 "\\|[ \t\n\r\f]\\)*"))
2081 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
2082 (concat "^[ \t]*\\(" c-current-comment-prefix
"\\)[ \t\n\r\f]*\\="))
2083 ;; First, find the previous paragraph start, if any.
2084 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
2086 (forward-paragraph -
1) ; uses cc-mode values of
2087 ; paragraph-\(start\|separate\)
2088 (if (> (re-search-forward here-filler nil t
) here
)
2090 (when (>= (point) here
)
2091 (forward-paragraph -
2)
2092 (if (> (re-search-forward here-filler nil t
) here
)
2096 ;; Now seek successively earlier sentence ends between PAR-BEG and
2097 ;; HERE, until the "start of sentence" following it is earlier than
2098 ;; HERE, or we hit PAR-BEG. Beware of comment prefixes!
2099 (while (and (re-search-backward (c-sentence-end) par-beg
'limit
)
2101 (goto-char (match-end 0)) ; tentative beginning of sentence
2102 (or (>= (point) here
)
2103 (and (not (bolp)) ; Found a non-blank comment-prefix?
2105 (if (re-search-backward prefix-at-bol-here nil t
)
2106 (/= (match-beginning 1) (match-end 1)))))
2107 (progn ; Skip the crud to find a real b-o-s.
2108 (if (c-in-comment-line-prefix-p)
2109 (beginning-of-line))
2110 (re-search-forward here-filler
) ; always succeeds.
2111 (>= (point) here
))))
2113 (re-search-forward here-filler
)))
2115 (if (< (point) start-point
)
2117 (goto-char (car range
))
2120 (defun c-end-of-sentence-in-comment (range)
2121 ;; Move forward to the "end of a sentence" within the comment defined by
2122 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2123 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2124 ;; return NIL. Otherwise, move point to just after the end of the comment
2127 ;; The EOS is just after the non-WS part of the next match of the regexp
2128 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2129 ;; no sentence-end match following point, any WS before the end of the
2130 ;; comment will count as EOS, providing we're not already in it.
2132 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2133 ;; It is not a general function, but is intended only for calling from
2134 ;; c-move-over-sentence.
2136 ;; This function might do hidden buffer changes.
2138 (let ((start-point (point))
2139 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2142 (c-narrow-to-comment-innards range
) ; This might move point forwards.
2143 (let* ((here (point))
2144 (par-end ; EOL position of last text in current/next paragraph.
2146 ;; The cc-mode values of paragraph-\(start\|separate\), set
2147 ;; in c-setup-paragraph-variables, are used in the
2149 (forward-paragraph 1)
2150 (if (eq (preceding-char) ?
\n) (forward-char -
1))
2151 (when (<= (point) here
) ; can happen, e.g., when HERE is at EOL.
2153 (forward-paragraph 2)
2154 (if (eq (preceding-char) ?
\n) (forward-char -
1)))
2159 (concat "^[ \t]*\\(" c-current-comment-prefix
"\\)\\=")))
2160 ;; Go forward one "comment-prefix which looks like sentence-end"
2161 ;; each time round the following:
2162 (while (and (re-search-forward (c-sentence-end) par-end
'limit
)
2165 (skip-chars-backward " \t\n")
2166 (or (and (not (bolp))
2167 (re-search-backward prefix-at-bol-here nil t
)
2168 (/= (match-beginning 1) (match-end 1)))
2169 (<= (point) here
))))
2172 ;; Take special action if we're up against the end of a comment (of
2173 ;; either sort): Leave point just after the last non-ws text.
2174 (if (eq (point) (point-max))
2175 (while (or (/= (skip-chars-backward " \t\n") 0)
2176 (and (re-search-backward prefix-at-bol-here nil t
)
2177 (/= (match-beginning 1) (match-end 1))))))))
2179 (if (> (point) start-point
)
2181 (goto-char (cdr range
))
2184 (defun c-beginning-of-sentence-in-string (range)
2185 ;; Move backwards to the "beginning of a sentence" within the string defined
2186 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2187 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2188 ;; just before the start of the string and return T.
2190 ;; The BOS is either the text which follows a regexp match of sentence-end
2191 ;; or text which is a beginning of "paragraph". For the purposes of
2192 ;; determining paragraph boundaries, escaped newlines are treated as
2193 ;; ordinary newlines.
2195 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2196 ;; It is not a general function, but is intended only for calling from
2197 ;; c-move-over-sentence.
2199 ;; This function might do hidden buffer changes.
2201 (let* ((here (point)) last
2202 (end (1- (cdr range
)))
2203 (here-filler ; matches WS and escaped newlines at point.
2204 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2205 ;; Enhance paragraph-start and paragraph-separate also to recognize
2206 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2207 ;; these values should be customizable user options, or something.
2208 (paragraph-start c-string-par-start
)
2209 (paragraph-separate c-string-par-separate
)
2211 (par-beg ; beginning of current (or previous) paragraph.
2214 (narrow-to-region (1+ (car range
)) end
)
2215 (forward-paragraph -
1) ; uses above values of
2216 ; paragraph-\(start\|separate\)
2217 (if (> (re-search-forward here-filler nil t
) here
)
2219 (when (>= (point) here
)
2220 (forward-paragraph -
2)
2221 (if (> (re-search-forward here-filler nil t
) here
)
2224 ;; Now see if we can find a sentence end after PAR-BEG.
2225 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg
'limit
)
2227 (goto-char (match-end 0))
2231 here-filler end t
) ; always succeeds. Use end rather
2232 ; than here, in case point starts
2233 ; beyond the closing quote.
2234 (>= (point) here
))))
2236 (re-search-forward here-filler here t
)
2237 (if (< (point) here
)
2239 (goto-char (car range
))
2242 (defun c-end-of-sentence-in-string (range)
2243 ;; Move forward to the "end of a sentence" within the string defined by
2244 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2245 ;; return NIL. Otherwise, move point to just after the end of the string
2248 ;; The EOS is just after the non-WS part of the next match of the regexp
2249 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2250 ;; no sentence-end match following point, any WS before the end of the
2251 ;; string will count as EOS, providing we're not already in it.
2253 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2254 ;; It is not a general function, but is intended only for calling from
2255 ;; c-move-over-sentence.
2257 ;; This function might do hidden buffer changes.
2259 (let* ((here (point))
2261 ;; Enhance paragraph-start and paragraph-separate to recognize
2262 ;; blank lines terminated by escaped EOLs.
2263 (paragraph-start c-string-par-start
)
2264 (paragraph-separate c-string-par-separate
)
2266 (par-end ; EOL position of last text in current/next paragraph.
2269 (narrow-to-region (car range
) (1- (cdr range
)))
2270 ;; The above values of paragraph-\(start\|separate\) are used
2271 ;; in the following.
2272 (forward-paragraph 1)
2274 ;; (re-search-backward filler-here nil t) would find an empty
2275 ;; string. Therefore we simulate it by the following:
2276 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2277 (re-search-backward "\\\\\\($\\)\\=" nil t
)))
2278 (unless (> (point) here
)
2280 (forward-paragraph 1)
2281 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2282 (re-search-backward "\\\\\\($\\)\\=" nil t
))))
2284 ;; Try to go forward a sentence.
2285 (when (re-search-forward c-sentence-end-with-esc-eol par-end
'limit
)
2287 (while (or (/= (skip-chars-backward " \t\n") 0)
2288 (re-search-backward "\\\\\\($\\)\\=" nil t
))))
2289 ;; Did we move a sentence, or did we hit the end of the string?
2290 (if (> (point) here
)
2292 (goto-char (cdr range
))
2295 (defun c-ascertain-preceding-literal ()
2296 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2297 ;; If a literal is the next thing (aside from whitespace) to be found before
2298 ;; point, return a cons of its start.end positions (enclosing the
2299 ;; delimiters). Otherwise return NIL.
2301 ;; This function might do hidden buffer changes.
2303 (c-collect-line-comments
2304 (let ((here (point))
2306 (if (c-backward-single-comment)
2307 (cons (point) (progn (c-forward-single-comment) (point)))
2309 ;; to prevent `looking-at' seeing a " at point.
2310 (narrow-to-region (point-min) here
)
2313 ;; An EOL can act as an "open string" terminator in AWK.
2314 (looking-at c-ws
*-string-limit-regexp
)
2316 (progn (backward-char)
2317 (looking-at c-string-limit-regexp
))))
2318 (goto-char (match-end 0)) ; just after the string terminator.
2320 (c-safe (c-backward-sexp 1) ; move back over the string.
2321 (cons (point) pos
)))))))))
2323 (defun c-ascertain-following-literal ()
2324 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2325 ;; If a literal is the next thing (aside from whitespace) following point,
2326 ;; return a cons of its start.end positions (enclosing the delimiters).
2327 ;; Otherwise return NIL.
2329 ;; This function might do hidden buffer changes.
2331 (c-collect-line-comments
2334 (if (looking-at c-string-limit-regexp
) ; string-delimiter.
2335 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2338 (if (c-forward-single-comment)
2339 (cons pos
(point))))))))
2341 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2342 ;; Does point immediately follow a statement "terminator"? A virtual
2343 ;; semicolon is regarded here as such. So is an opening brace ;-)
2345 ;; This function might do hidden buffer changes.
2348 (and (looking-at "[;{}]")
2349 (not (and c-special-brace-lists
; Pike special brace lists.
2350 (eq (char-after) ?
{)
2351 (c-looking-at-special-brace-list)))))
2353 ;; The following (for macros) is not strict about exactly where we are
2354 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2355 ;; much. ACM 2004/3/29.
2358 (if (c-beginning-of-macro)
2359 (setq eom
(progn (c-end-of-macro)
2363 (c-forward-comments)
2364 (>= (point) eom
))))))
2366 (defun c-back-over-illiterals (macro-start)
2367 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2368 ;; stopping before reaching BOB or a literal or the boundary of a
2369 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2370 ;; the position of the '#' beginning the current preprocessor directive, or
2371 ;; NIL if we're not in such.
2373 ;; Return a cons (A.B), where
2374 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2375 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2376 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2377 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2379 ;; The total collection of returned values is as follows:
2380 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2381 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2382 ;; a BOS - the caller must check this.
2383 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2384 ;; moved and reached the opening # of the macro.
2385 ;; (t . macro-boundary): Every other circumstance in which we're at a
2386 ;; macro-boundary. We might be at a BOS.
2388 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2389 ;; code before encountering the literal/BOB or macro-boundary.
2391 ;; Note that this function moves within either preprocessor commands
2392 ;; (macros) or normal code, but will not cross a boundary between the two,
2393 ;; or between two distinct preprocessor commands.
2395 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2396 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2397 ;; move into parens. Also stop before `#' when it's at boi on a line.
2399 ;; This function might do hidden buffer changes.
2401 (let ((here (point))
2402 last
) ; marks the position of non-ws code, what'll be BOS if, say, a
2403 ; semicolon precedes it.
2405 (while t
;; We go back one "token" each iteration of the loop.
2408 ;; Stop at the token after a comment.
2409 ((c-backward-single-comment) ; Also functions as backwards-ws.
2411 (throw 'done
'(t . literal
)))
2413 ;; If we've gone back over a LF, we might have moved into or out of
2414 ;; a preprocessor line.
2415 ((and (save-excursion
2417 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t
))
2419 (< (point) macro-start
)
2420 (c-beginning-of-macro)))
2422 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2423 (throw 'done
(cons (or (eq (point) here
)
2427 ;; Have we found a virtual semicolon? If so, stop, unless the next
2428 ;; statement is where we started from.
2429 ((and (c-at-vsemi-p)
2431 (not (memq (char-after last
) '(?\
) ?
})))) ; we've moved back from ) or }
2433 (throw 'done
'(nil . nil
)))
2435 ;; Hit the beginning of the buffer/region?
2439 (throw 'done
'(nil . nil
)))
2441 ;; Move back a character.
2442 ((progn (backward-char) nil
))
2444 ;; Stop at "{" (unless it's a PIKE special brace list.)
2445 ((eq (char-after) ?\
{)
2446 (if (and c-special-brace-lists
2447 (c-looking-at-special-brace-list))
2448 (skip-syntax-backward "w_") ; Speedup only.
2451 (throw 'done
'(nil . nil
))))
2453 ;; Have we reached the start of a macro? This always counts as
2454 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2455 ;; here. FIXME!!! ACM 2004/3/29)
2456 ((and macro-start
(eq (point) macro-start
))
2457 (throw 'done
(cons (eq (point) here
) 'macro-boundary
)))
2459 ;; Stop at token just after "}" or ";".
2460 ((looking-at "[;}]")
2461 ;; If we've gone back over ;, {, or }, we're done.
2462 (if (or (= here last
)
2463 (memq (char-after last
) '(?\
) ?
}))) ; we've moved back from ) or }
2464 (if (and (eq (char-before) ?
}) ; If };, treat them as a unit.
2465 (eq (char-after) ?\
;))
2467 (goto-char last
) ; To the statement starting after the ; or }.
2468 (throw 'done
'(nil . nil
))))
2470 ;; Stop at the token after a string.
2471 ((looking-at c-string-limit-regexp
) ; Just gone back over a string terminator?
2473 (throw 'done
'(t . literal
)))
2475 ;; Nothing special: go back word characters.
2476 (t (skip-syntax-backward "w_")) ; Speedup only.
2479 (defun c-forward-over-illiterals (macro-end allow-early-stop
)
2480 ;; Move forwards over code, stopping before reaching EOB or a literal
2481 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2482 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2483 ;; terminates the current preprocessor directive, or NIL if we're not in
2486 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2487 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2488 ;; seems unavoidable. Depending on the context this function is called
2489 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2490 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2491 ;; semicolons, or anything else.
2493 ;; Return a cons (A.B), where
2494 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2495 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2496 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2497 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2499 ;; Point is left either after the end-of-statement, or at the last non-ws
2500 ;; code before encountering the literal, or the # of the preprocessor
2501 ;; statement, or at EOB [or just after last non-WS stuff??].
2503 ;; As a clarification of "after the end-of-statement", if a comment or
2504 ;; whitespace follows a completed AWK statement, that statement is treated
2505 ;; as ending just after the last non-ws character before the comment.
2507 ;; Note that this function moves within either preprocessor commands
2508 ;; (macros) or normal code, but not both within the same invocation.
2510 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2511 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2512 ;; stop before `{' if at top level or inside braces, though. Move by
2513 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2516 ;; This function might do hidden buffer changes.
2517 (let ((here (point))
2520 (while t
;; We go one "token" forward each time round this loop.
2523 ;; If we've moved forward to a virtual semicolon, we're done.
2524 (if (and (> last here
) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2526 (throw 'done
'(nil . nil
)))
2530 ;; Gone past the end of a macro?
2531 ((and macro-end
(> (point) macro-end
))
2533 (throw 'done
(cons (eq (point) here
) 'macro-boundary
)))
2535 ;; About to hit a comment?
2536 ((save-excursion (c-forward-single-comment))
2538 (throw 'done
'(t . literal
)))
2544 (throw 'done
'(nil . nil
)))
2546 ;; If we encounter a '{', stop just after the previous token.
2547 ((and (eq (char-after) ?
{)
2548 (not (and c-special-brace-lists
2549 (c-looking-at-special-brace-list)))
2550 (or allow-early-stop
(/= here last
))
2551 (save-excursion ; Is this a check that we're NOT at top level?
2552 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2553 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2554 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2555 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2556 (or (not (c-safe (up-list -
1) t
))
2557 (= (char-after) ?
{))))
2559 (throw 'done
'(nil . nil
)))
2561 ;; End of a PIKE special brace list? If so, step over it and continue.
2562 ((and c-special-brace-lists
2563 (eq (char-after) ?
})
2565 (and (c-safe (up-list -
1) t
)
2566 (c-looking-at-special-brace-list))))
2568 (skip-syntax-forward "w_")) ; Speedup only.
2570 ;; Have we got a '}' after having moved? If so, stop after the
2572 ((and (eq (char-after) ?
})
2575 (throw 'done
'(nil . nil
)))
2577 ;; Stop if we encounter a preprocessor line. Continue if we
2579 ((and c-opt-cpp-prefix
2581 (eq (char-after) ?
#)
2582 (= (point) (c-point 'boi
)))
2583 (if (= (point) here
) ; Not a macro, therefore naked #.
2585 (throw 'done
'(t . macro-boundary
))))
2587 ;; Stop after a ';', '}', or "};"
2588 ((looking-at ";\\|};?")
2589 (goto-char (match-end 0))
2590 (throw 'done
'(nil . nil
)))
2592 ;; Found a string (this subsumes AWK regexps)?
2593 ((looking-at c-string-limit-regexp
)
2595 (throw 'done
'(t . literal
)))
2598 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2599 (skip-syntax-forward "w_") ; Speedup only.
2600 (when (and macro-end
(> (point) macro-end
))
2602 (throw 'done
(cons (eq (point) here
) 'macro-boundary
))))
2605 (defun c-one-line-string-p (range)
2606 ;; Is the literal defined by RANGE a string contained in a single line?
2608 ;; This function might do hidden buffer changes.
2610 (goto-char (car range
))
2611 (and (looking-at c-string-limit-regexp
)
2612 (progn (skip-chars-forward "^\n" (cdr range
))
2613 (eq (point) (cdr range
))))))
2615 (defun c-beginning-of-statement (&optional count lim sentence-flag
)
2616 "Go to the beginning of the innermost C statement.
2617 With prefix arg, go back N - 1 statements. If already at the
2618 beginning of a statement then go to the beginning of the closest
2619 preceding one, moving into nested blocks if necessary (use
2620 \\[backward-sexp] to skip over a block). If within or next to a
2621 comment or multiline string, move by sentences instead of statements.
2623 When called from a program, this function takes 3 optional args: the
2624 repetition count, a buffer position limit which is the farthest back
2625 to search for the syntactic context, and a flag saying whether to do
2626 sentence motion in or near comments and multiline strings.
2628 Note that for use in programs, `c-beginning-of-statement-1' is
2629 usually better. It has much better defined semantics than this one,
2630 which is intended for interactive use, and might therefore change to
2631 be more \"DWIM:ey\"."
2632 (interactive (list (prefix-numeric-value current-prefix-arg
)
2635 (c-end-of-statement (- count
) lim sentence-flag
)
2636 (c-save-buffer-state
2637 ((count (or count
1))
2638 last
; start point for going back ONE chunk. Updated each chunk movement.
2640 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2641 res
; result from sub-function call
2642 not-bos
; "not beginning-of-statement"
2643 (range (c-collect-line-comments (c-literal-limits lim
)))) ; (start.end) of current literal or NIL
2645 ;; Go back one statement at each iteration of the following loop.
2646 (while (and (/= count
0)
2647 (or (not lim
) (> (point) lim
)))
2648 ;; Go back one "chunk" each time round the following loop, stopping
2649 ;; when we reach a statement boundary, etc.
2652 (cond ; Each arm of this cond returns NIL on reaching a desired
2653 ; statement boundary, non-NIL otherwise.
2658 (range ; point is within or approaching a literal.
2660 ;; Single line string or sentence-flag is null => skip the
2662 ((or (null sentence-flag
)
2663 (c-one-line-string-p range
))
2664 (goto-char (car range
))
2665 (setq range
(c-ascertain-preceding-literal))
2666 ;; N.B. The following is essentially testing for an AWK regexp
2668 ;; Was the previous non-ws thing an end of statement?
2671 (c-backward-comments)
2672 (c-backward-syntactic-ws))
2673 (not (or (bobp) (c-after-statement-terminator-p)))))
2675 ;; Comment inside a statement or a multi-line string.
2676 (t (when (setq res
; returns non-nil when we go out of the literal
2677 (if (eq (c-literal-type range
) 'string
)
2678 (c-beginning-of-sentence-in-string range
)
2679 (c-beginning-of-sentence-in-comment range
)))
2680 (setq range
(c-ascertain-preceding-literal)))
2683 ;; Non-literal code.
2684 (t (setq res
(c-back-over-illiterals macro-fence
))
2685 (setq not-bos
; "not reached beginning-of-statement".
2686 (or (= (point) last
)
2687 (memq (char-after) '(?\
) ?\
}))
2690 ;; We're at a tentative BOS. The next form goes
2691 ;; back over WS looking for an end of previous
2693 (not (save-excursion
2695 (c-backward-comments)
2696 (c-backward-syntactic-ws))
2697 (or (bobp) (c-after-statement-terminator-p)))))))
2698 ;; Are we about to move backwards into or out of a
2699 ;; preprocessor command? If so, locate its beginning.
2700 (when (eq (cdr res
) 'macro-boundary
)
2705 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2707 ;; Are we about to move backwards into a literal?
2708 (when (memq (cdr res
) '(macro-boundary literal
))
2709 (setq range
(c-ascertain-preceding-literal)))
2711 (setq last
(point)))
2713 (if (/= count
0) (setq count
(1- count
))))
2714 (c-keep-region-active))))
2716 (defun c-end-of-statement (&optional count lim sentence-flag
)
2717 "Go to the end of the innermost C statement.
2718 With prefix arg, go forward N - 1 statements. Move forward to the end
2719 of the next statement if already at end, and move into nested blocks
2720 \(use \\[forward-sexp] to skip over a block). If within or next to a
2721 comment or multiline string, move by sentences instead of statements.
2723 When called from a program, this function takes 3 optional args: the
2724 repetition count, a buffer position limit which is the farthest back
2725 to search for the syntactic context, and a flag saying whether to do
2726 sentence motion in or near comments and multiline strings."
2727 (interactive (list (prefix-numeric-value current-prefix-arg
)
2729 (setq count
(or count
1))
2730 (if (< count
0) (c-beginning-of-statement (- count
) lim sentence-flag
)
2732 (c-save-buffer-state
2733 (here ; start point for going forward ONE statement. Updated each statement.
2736 (and (not (eobp)) (c-beginning-of-macro)
2737 (progn (c-end-of-macro) (point)))))
2739 (range (c-collect-line-comments (c-literal-limits lim
)))) ; (start.end) of current literal or NIL
2741 ;; Go back/forward one statement at each iteration of the following loop.
2742 (while (and (/= count
0)
2743 (or (not lim
) (< (point) lim
)))
2744 (setq here
(point)) ; ONLY HERE is HERE updated
2746 ;; Go forward one "chunk" each time round the following loop, stopping
2747 ;; when we reach a statement boundary, etc.
2749 (cond ; Each arm of this cond returns NIL on reaching a desired
2750 ; statement boundary, non-NIL otherwise.
2755 (range ; point is within a literal.
2757 ;; sentence-flag is null => skip the entire literal.
2758 ;; or a Single line string.
2759 ((or (null sentence-flag
)
2760 (c-one-line-string-p range
))
2761 (goto-char (cdr range
))
2762 (setq range
(c-ascertain-following-literal))
2763 ;; Is there a virtual semicolon here (e.g. for AWK)?
2764 (not (c-at-vsemi-p)))
2766 ;; Comment or multi-line string.
2767 (t (when (setq res
; gets non-nil when we go out of the literal
2768 (if (eq (c-literal-type range
) 'string
)
2769 (c-end-of-sentence-in-string range
)
2770 (c-end-of-sentence-in-comment range
)))
2771 (setq range
(c-ascertain-following-literal)))
2772 ;; If we've just come forward out of a literal, check for
2773 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2774 ;; some other language may do in the future)
2776 (not (c-at-vsemi-p))))))
2778 ;; Non-literal code.
2779 (t (setq res
(c-forward-over-illiterals macro-fence
2781 ;; Are we about to move forward into or out of a
2782 ;; preprocessor command?
2783 (when (eq (cdr res
) 'macro-boundary
)
2790 (progn (c-skip-ws-forward)
2791 (c-beginning-of-macro))
2792 (progn (c-end-of-macro)
2795 (c-beginning-of-macro)
2796 (progn (c-end-of-macro) (point)))))))
2797 ;; Are we about to move forward into a literal?
2798 (when (memq (cdr res
) '(macro-boundary literal
))
2799 (setq range
(c-ascertain-following-literal)))
2802 (if (/= count
0) (setq count
(1- count
))))
2803 (c-keep-region-active))))
2806 ;; set up electric character functions to work with pending-del,
2807 ;; (a.k.a. delsel) mode. All symbols get the t value except
2808 ;; the functions which delete, which gets 'supersede.
2812 (put sym
'delete-selection t
) ; for delsel (Emacs)
2813 (put sym
'pending-delete t
))) ; for pending-del (XEmacs)
2818 c-electric-semi
&comma
2822 (put 'c-electric-delete
'delete-selection
'supersede
) ; delsel
2823 (put 'c-electric-delete
'pending-delete
'supersede
) ; pending-del
2824 (put 'c-electric-backspace
'delete-selection
'supersede
) ; delsel
2825 (put 'c-electric-backspace
'pending-delete
'supersede
) ; pending-del
2826 (put 'c-electric-delete-forward
'delete-selection
'supersede
) ; delsel
2827 (put 'c-electric-delete-forward
'pending-delete
'supersede
) ; pending-del
2830 ;; Inserting/indenting comments
2831 (defun c-calc-comment-indent (entry)
2832 ;; This function might do hidden buffer changes.
2834 (setq entry
(or (assq entry c-indent-comment-alist
)
2835 (assq 'other c-indent-comment-alist
)
2836 '(default .
(column . nil
)))))
2837 (let ((action (car (cdr entry
)))
2838 (value (cdr (cdr entry
)))
2839 (col (current-column)))
2840 (cond ((eq action
'space
)
2842 ((eq action
'column
)
2843 (unless value
(setq value comment-column
))
2845 ;; Do not pad with one space if we're at bol.
2847 (max (1+ col
) value
)))
2853 (let ((lim (c-literal-limits (c-point 'bol
) t
)))
2855 (goto-char (car lim
))
2856 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2857 ;; Found comment to align with.
2859 ;; Do not pad with one space if we're at bol.
2861 (max (1+ col
) (current-column))))))))
2862 ;; Recurse to handle value as a new spec.
2863 (c-calc-comment-indent (cdr entry
)))))))
2865 (defun c-comment-indent ()
2866 "Used by `indent-for-comment' to create and indent comments.
2867 See `c-indent-comment-alist' for a description."
2870 (c-save-buffer-state
2871 ((eot (let ((lim (c-literal-limits (c-point 'bol
) t
)))
2872 (or (when (consp lim
)
2873 (goto-char (car lim
))
2874 (when (looking-at "/[/*]")
2875 (skip-chars-backward " \t")
2878 (skip-chars-backward " \t")
2881 (cond ((looking-at "^/[/*]")
2883 ((progn (beginning-of-line)
2886 ((progn (back-to-indentation)
2887 (and (eq (char-after) ?
})
2888 (eq (point) (1- eot
))))
2890 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2891 (eq (match-end 0) eot
))
2896 (if (and (memq line-type
'(anchored-comment empty-line
))
2897 c-indent-comments-syntactically-p
)
2898 (let ((c-syntactic-context (c-guess-basic-syntax)))
2899 ;; BOGOSITY ALERT: if we're looking at the eol, its
2900 ;; because indent-for-comment hasn't put the comment-start
2901 ;; in the buffer yet. this will screw up the syntactic
2902 ;; analysis so we kludge in the necessary info. Another
2903 ;; kludge is that if we're at the bol, then we really want
2904 ;; to ignore any anchoring as specified by
2905 ;; c-comment-only-line-offset since it doesn't apply here.
2907 (c-add-syntax 'comment-intro
))
2908 (let ((c-comment-only-line-offset
2909 (if (consp c-comment-only-line-offset
)
2910 c-comment-only-line-offset
2911 (cons c-comment-only-line-offset
2912 c-comment-only-line-offset
))))
2913 (c-get-syntactic-indentation c-syntactic-context
)))
2915 (c-calc-comment-indent line-type
)))))
2918 ;; used by outline-minor-mode
2919 (defun c-outline-level ()
2920 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2921 ;; in otherwise-hidden text.
2923 (skip-chars-forward "\t ")
2927 ;; Movement by CPP conditionals.
2928 (defun c-up-conditional (count)
2929 "Move back to the containing preprocessor conditional, leaving mark behind.
2930 A prefix argument acts as a repeat count. With a negative argument,
2931 move forward to the end of the containing preprocessor conditional.
2933 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2934 function stops at them when going backward, but not when going
2937 (let ((new-point (c-scan-conditionals (- count
) -
1)))
2939 (goto-char new-point
))
2940 (c-keep-region-active))
2942 (defun c-up-conditional-with-else (count)
2943 "Move back to the containing preprocessor conditional, including \"#else\".
2944 Just like `c-up-conditional', except it also stops at \"#else\"
2947 (let ((new-point (c-scan-conditionals (- count
) -
1 t
)))
2949 (goto-char new-point
))
2950 (c-keep-region-active))
2952 (defun c-down-conditional (count)
2953 "Move forward into the next preprocessor conditional, leaving mark behind.
2954 A prefix argument acts as a repeat count. With a negative argument,
2955 move backward into the previous preprocessor conditional.
2957 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2958 function stops at them when going forward, but not when going
2961 (let ((new-point (c-scan-conditionals count
1)))
2963 (goto-char new-point
))
2964 (c-keep-region-active))
2966 (defun c-down-conditional-with-else (count)
2967 "Move forward into the next preprocessor conditional, including \"#else\".
2968 Just like `c-down-conditional', except it also stops at \"#else\"
2971 (let ((new-point (c-scan-conditionals count
1 t
)))
2973 (goto-char new-point
))
2974 (c-keep-region-active))
2976 (defun c-backward-conditional (count &optional target-depth with-else
)
2977 "Move back across a preprocessor conditional, leaving mark behind.
2978 A prefix argument acts as a repeat count. With a negative argument,
2979 move forward across a preprocessor conditional.
2981 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2982 and have the same meanings as in `c-scan-conditionals'. If you
2983 are calling c-forward-conditional from a program, you might want
2984 to call `c-scan-conditionals' directly instead."
2986 (let ((new-point (c-scan-conditionals (- count
) target-depth with-else
)))
2988 (goto-char new-point
))
2989 (c-keep-region-active))
2991 (defun c-forward-conditional (count &optional target-depth with-else
)
2992 "Move forward across a preprocessor conditional, leaving mark behind.
2993 A prefix argument acts as a repeat count. With a negative argument,
2994 move backward across a preprocessor conditional.
2996 If there aren't enough conditionals after \(or before) point, an
2999 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
3000 the nesting level isn't changed when tracking subconditionals.
3002 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
3003 and have the same meanings as in `c-scan-conditionals'. If you
3004 are calling c-forward-conditional from a program, you might want
3005 to call `c-scan-conditionals' directly instead."
3007 (let ((new-point (c-scan-conditionals count target-depth with-else
)))
3009 (goto-char new-point
)))
3011 (defun c-scan-conditionals (count &optional target-depth with-else
)
3012 "Scan forward across COUNT preprocessor conditionals.
3013 With a negative argument, scan backward across preprocessor
3014 conditionals. Return the end position. Point is not moved.
3016 If there aren't enough preprocessor conditionals, throw an error.
3018 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
3019 the nesting level isn't changed when tracking subconditionals.
3021 The optional argument TARGET-DEPTH specifies the wanted nesting depth
3022 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
3023 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
3026 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
3027 are treated as conditional clause limits. Normally they are ignored."
3028 (let* ((forward (> count
0))
3029 (increment (if forward -
1 1))
3030 (search-function (if forward
're-search-forward
're-search-backward
))
3031 new case-fold-search
)
3032 (unless (integerp target-depth
)
3033 (setq target-depth
(if target-depth -
1 0)))
3037 ;; subdepth is the depth in "uninteresting" subtrees,
3038 ;; i.e. those that takes us farther from the target
3039 ;; depth instead of closer.
3043 ;; Find the "next" significant line in the proper direction.
3044 (while (and (not found
)
3045 ;; Rather than searching for a # sign that
3046 ;; comes at the beginning of a line aside from
3047 ;; whitespace, search first for a string
3048 ;; starting with # sign. Then verify what
3049 ;; precedes it. This is faster on account of
3050 ;; the fastmap feature of the regexp matcher.
3051 (funcall search-function
3052 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
3055 ;; Now verify it is really a preproc line.
3056 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
3057 (let (dchange (directive (match-string 1)))
3058 (cond ((string= directive
"if")
3059 (setq dchange
(- increment
)))
3060 ((string= directive
"endif")
3061 (setq dchange increment
))
3063 ;; When we're not in an "uninteresting"
3064 ;; subtree, we might want to act on "elif"
3066 (if (cond (with-else
3067 ;; Always move toward the target depth.
3069 (if (> target-depth
0) 1 -
1)))
3070 ((string= directive
"elif")
3071 (setq dchange
(- increment
))))
3072 ;; Ignore the change if it'd take us
3073 ;; into an "uninteresting" subtree.
3074 (if (eq (> dchange
0) (<= target-depth
0))
3075 (setq dchange nil
)))))
3077 (when (or (/= subdepth
0)
3078 (eq (> dchange
0) (<= target-depth
0)))
3079 (setq subdepth
(+ subdepth dchange
)))
3080 (setq depth
(+ depth dchange
))
3081 ;; If we are trying to move across, and we find an
3082 ;; end before we find a beginning, get an error.
3083 (if (and (< depth target-depth
) (< dchange
0))
3085 "No following conditional at this level"
3086 "No previous conditional at this level"))))
3087 ;; When searching forward, start from next line so
3088 ;; that we don't find the same line again.
3089 (if forward
(forward-line 1))
3090 ;; We found something if we've arrived at the
3092 (if (and dchange
(= depth target-depth
))
3093 (setq found
(point))))
3095 (if forward
(forward-line 1)))))
3097 (error "No containing preprocessor conditional"))
3098 (goto-char (setq new found
)))
3099 (setq count
(+ count increment
))))
3100 (c-keep-region-active)
3104 ;; commands to indent lines, regions, defuns, and expressions
3105 (defun c-indent-command (&optional arg
)
3106 "Indent current line as C code, and/or insert some whitespace.
3108 If `c-tab-always-indent' is t, always just indent the current line.
3109 If nil, indent the current line only if point is at the left margin or
3110 in the line's indentation; otherwise insert some whitespace[*]. If
3111 other than nil or t, then some whitespace[*] is inserted only within
3112 literals (comments and strings), but the line is always reindented.
3114 If `c-syntactic-indentation' is t, indentation is done according to
3115 the syntactic context. A numeric argument, regardless of its value,
3116 means indent rigidly all the lines of the expression starting after
3117 point so that this line becomes properly indented. The relative
3118 indentation among the lines of the expression is preserved.
3120 If `c-syntactic-indentation' is nil, the line is just indented one
3121 step according to `c-basic-offset'. In this mode, a numeric argument
3122 indents a number of such steps, positive or negative, and an empty
3123 prefix argument is equivalent to -1.
3125 [*] The amount and kind of whitespace inserted is controlled by the
3126 variable `c-insert-tab-function', which is called to do the actual
3127 insertion of whitespace. Normally the function in this variable
3128 just inserts a tab character, or the equivalent number of spaces,
3129 depending on the variable `indent-tabs-mode'."
3132 (let ((indent-function
3133 (if c-syntactic-indentation
3134 (symbol-function 'indent-according-to-mode
)
3136 (let ((c-macro-start c-macro-start
)
3137 (steps (if (equal arg
'(4))
3139 (prefix-numeric-value arg
))))
3140 (c-shift-line-indentation (* steps c-basic-offset
))
3141 (when (and c-auto-align-backslashes
3144 (eq (char-before) ?
\\))
3145 (c-query-and-set-macro-start))
3146 ;; Realign the line continuation backslash if inside a macro.
3147 (c-backslash-region (point) (point) nil t
)))
3149 (if (and c-syntactic-indentation arg
)
3150 ;; If c-syntactic-indentation and got arg, always indent this
3151 ;; line as C and shift remaining lines of expression the same
3153 (let ((shift-amt (save-excursion
3154 (back-to-indentation)
3158 (setq shift-amt
(- (save-excursion
3159 (back-to-indentation)
3163 (if (eq c-tab-always-indent t
)
3164 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
3172 (indent-code-rigidly beg end shift-amt
"#")))
3173 ;; Else use c-tab-always-indent to determine behavior.
3175 ;; CASE 1: indent when at column zero or in line's indentation,
3176 ;; otherwise insert a tab
3177 ((not c-tab-always-indent
)
3179 (skip-chars-backward " \t")
3181 (funcall c-insert-tab-function
)
3182 (funcall indent-function
)))
3183 ;; CASE 2: just indent the line
3184 ((eq c-tab-always-indent t
)
3185 (funcall indent-function
))
3186 ;; CASE 3: if in a literal, insert a tab, but always indent the
3189 (if (c-save-buffer-state () (c-in-literal))
3190 (funcall c-insert-tab-function
))
3191 (funcall indent-function
)
3194 (defun c-indent-exp (&optional shutup-p
)
3195 "Indent each line in the balanced expression following point syntactically.
3196 If optional SHUTUP-P is non-nil, no errors are signaled if no
3197 balanced expression is found."
3199 (let ((here (point-marker))
3201 (set-marker-insertion-type here t
)
3203 (let ((start (save-restriction
3204 ;; Find the closest following open paren that
3205 ;; ends on another line.
3206 (narrow-to-region (point-min) (c-point 'eol
))
3207 (let (beg (end (point)))
3208 (while (and (setq beg
(c-down-list-forward end
))
3209 (setq end
(c-up-list-forward beg
))))
3211 (eq (char-syntax (char-before beg
)) ?\
()
3216 (error "Cannot find start of balanced expression to indent"))
3218 (setq end
(c-safe (scan-sexps (point) 1)))
3221 (error "Cannot find end of balanced expression to indent"))
3224 (c-indent-region (point) end
)))))
3226 (set-marker here nil
))))
3228 (defun c-indent-defun ()
3229 "Indent the current top-level declaration or macro syntactically.
3230 In the macro case this also has the effect of realigning any line
3231 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3233 (let ((here (point-marker)) decl-limits case-fold-search
)
3236 (c-save-buffer-state nil
3237 ;; We try to be line oriented, unless there are several
3238 ;; declarations on the same line.
3239 (if (looking-at c-syntactic-eol
)
3240 (c-backward-token-2 1 nil
(c-point 'bol
))
3241 (c-forward-token-2 0 nil
(c-point 'eol
)))
3242 (setq decl-limits
(c-declaration-limits nil
)))
3244 (c-indent-region (car decl-limits
)
3245 (cdr decl-limits
))))
3247 (set-marker here nil
))))
3249 (defun c-indent-region (start end
&optional quiet
)
3250 "Indent syntactically every line whose first char is between START
3251 and END inclusive. If the optional argument QUIET is non-nil then no
3252 syntactic errors are reported, even if `c-report-syntactic-errors' is
3256 (skip-chars-backward " \t\n\r\f\v")
3259 ;; Advance to first nonblank line.
3261 (skip-chars-forward " \t\n\r\f\v")
3262 (setq start
(point))
3264 (setq c-parsing-error
3265 (or (let ((endmark (copy-marker end
))
3266 (c-parsing-error nil
)
3267 ;; shut up any echo msgs on indiv lines
3268 (c-echo-syntactic-information-p nil
)
3269 (ml-macro-start ; Start pos of multi-line macro.
3270 (and (c-save-buffer-state ()
3271 (save-excursion (c-beginning-of-macro)))
3272 (eq (char-before (c-point 'eol
)) ?
\\)
3274 (c-fix-backslashes nil
)
3278 (c-progress-init start end
'c-indent-region
)
3280 (while (and (bolp) ;; One line each time round the loop.
3282 (< (point) endmark
))
3286 (unless (or (looking-at "\\s *$")
3287 (and ml-macro-start
(looking-at "\\s *\\\\$")))
3288 ;; Get syntax and indent.
3289 (c-save-buffer-state nil
3290 (setq syntax
(c-guess-basic-syntax)))
3291 (c-indent-line syntax t t
))
3294 ;; End of current multi-line macro?
3295 (when (and c-auto-align-backslashes
3296 (not (eq (char-before (c-point 'eol
)) ?
\\)))
3297 ;; Fixup macro backslashes.
3298 (c-backslash-region ml-macro-start
(c-point 'bonl
) nil
)
3299 (setq ml-macro-start nil
))
3300 ;; New multi-line macro?
3301 (if (and (assq 'cpp-macro syntax
)
3302 (eq (char-before (c-point 'eol
)) ?
\\))
3303 (setq ml-macro-start
(point))))
3307 (if (and ml-macro-start c-auto-align-backslashes
)
3308 (c-backslash-region ml-macro-start
(c-point 'bopl
) nil t
)))
3309 (set-marker endmark nil
)
3310 (c-progress-fini 'c-indent-region
))
3311 (c-echo-parsing-error quiet
))
3314 (defun c-fn-region-is-active-p ()
3315 ;; Function version of the macro for use in places that aren't
3316 ;; compiled, e.g. in the menus.
3317 (c-region-is-active-p))
3319 (defun c-indent-line-or-region (&optional arg region
)
3320 "Indent active region, current line, or block starting on this line.
3321 In Transient Mark mode, when the region is active, reindent the region.
3322 Otherwise, with a prefix argument, rigidly reindent the expression
3323 starting on the current line.
3324 Otherwise reindent just the current line."
3326 (list current-prefix-arg
(use-region-p)))
3328 (c-indent-region (region-beginning) (region-end))
3329 (c-indent-command arg
)))
3331 ;; for progress reporting
3332 (defvar c-progress-info nil
)
3334 (defun c-progress-init (start end context
)
3337 ((not c-progress-interval
))
3338 ;; Start the progress update messages. If this Emacs doesn't have
3339 ;; a built-in timer, just be dumb about it.
3340 ((not (fboundp 'current-time
))
3341 (message "Indenting region... (this may take a while)"))
3342 ;; If progress has already been initialized, do nothing. otherwise
3343 ;; initialize the counter with a vector of:
3344 ;; [start end lastsec context]
3346 (t (setq c-progress-info
(vector start
3350 (nth 1 (current-time))
3352 (message "Indenting region..."))
3355 (defun c-progress-update ()
3356 (if (not (and c-progress-info c-progress-interval
))
3358 (let ((now (nth 1 (current-time)))
3359 (start (aref c-progress-info
0))
3360 (end (aref c-progress-info
1))
3361 (lastsecs (aref c-progress-info
2)))
3362 ;; should we update? currently, update happens every 2 seconds,
3363 ;; what's the right value?
3364 (if (< c-progress-interval
(- now lastsecs
))
3366 (message "Indenting region... (%d%% complete)"
3367 (/ (* 100 (- (point) start
)) (- end start
)))
3368 (aset c-progress-info
2 now
)))
3371 (defun c-progress-fini (context)
3372 (if (not c-progress-interval
)
3374 (if (or (eq context
(aref c-progress-info
3))
3377 (set-marker (aref c-progress-info
1) nil
)
3378 (setq c-progress-info nil
)
3379 (message "Indenting region... done")))))
3383 ;;; This page handles insertion and removal of backslashes for C macros.
3385 (defun c-backslash-region (from to delete-flag
&optional line-mode
)
3386 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3387 With no argument, inserts backslashes and aligns existing backslashes.
3388 With an argument, deletes the backslashes. The backslash alignment is
3389 done according to the settings in `c-backslash-column',
3390 `c-backslash-max-column' and `c-auto-align-backslashes'.
3392 This function does not modify blank lines at the start of the region.
3393 If the region ends at the start of a line and the macro doesn't
3394 continue below it, the backslash (if any) at the end of the previous
3397 You can put the region around an entire macro definition and use this
3398 command to conveniently insert and align the necessary backslashes."
3399 (interactive "*r\nP")
3400 (let ((endmark (make-marker))
3401 ;; Keep the backslash trimming functions from changing the
3402 ;; whitespace around point, since in this case it's only the
3403 ;; position of point that tells the indentation of the line.
3404 (point-pos (if (save-excursion
3405 (skip-chars-backward " \t")
3406 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3409 column longest-line-col bs-col-after-end
)
3412 (if (and (not line-mode
) (bobp))
3413 ;; Nothing to do if to is at bob, since we should back up
3414 ;; and there's no line to back up to.
3416 (when (and (not line-mode
) (bolp))
3417 ;; Do not back up the to line if line-mode is set, to make
3418 ;; e.g. c-newline-and-indent consistent regardless whether
3419 ;; the (newline) call leaves point at bol or not.
3424 (set-marker endmark
(point))
3426 (c-delete-backslashes-forward endmark point-pos
))
3427 ;; Set bs-col-after-end to the column of any backslash
3428 ;; following the region, or nil if there is none.
3429 (setq bs-col-after-end
3430 (and (progn (end-of-line)
3431 (eq (char-before) ?
\\))
3432 (= (forward-line 1) 0)
3433 (progn (end-of-line)
3434 (eq (char-before) ?
\\))
3435 (1- (current-column))))
3437 ;; Back up the to line if line-mode is set, since the line
3438 ;; after the newly inserted line break should not be
3439 ;; touched in c-newline-and-indent.
3440 (setq to
(max from
(or (c-safe (c-point 'eopl
)) from
)))
3441 (unless bs-col-after-end
3442 ;; Set bs-col-after-end to non-nil in any case, since we
3443 ;; do not want to delete the backslash at the last line.
3444 (setq bs-col-after-end t
)))
3446 (not c-auto-align-backslashes
))
3448 ;; Compute the smallest column number past the ends of all
3450 (setq longest-line-col
0)
3452 (if bs-col-after-end
3453 ;; Include one more line in the max column
3454 ;; calculation, since the to line will be backslashed
3458 (while (and (>= (point) from
)
3460 (if (eq (char-before) ?
\\)
3462 (skip-chars-backward " \t")
3463 (setq longest-line-col
(max longest-line-col
3464 (1+ (current-column))))
3468 ;; Try to align with surrounding backslashes.
3471 (if (and (not (bobp))
3472 (progn (backward-char)
3473 (eq (char-before) ?
\\)))
3475 (setq column
(1- (current-column)))
3476 (if (numberp bs-col-after-end
)
3477 ;; Both a preceding and a following backslash.
3478 ;; Choose the greatest of them.
3479 (setq column
(max column bs-col-after-end
)))
3481 ;; No preceding backslash. Try to align with one
3482 ;; following the region. Disregard the backslash at the
3483 ;; to line since it's likely to be bogus (e.g. when
3484 ;; called from c-newline-and-indent).
3485 (if (numberp bs-col-after-end
)
3486 (setq column bs-col-after-end
))
3487 ;; Don't modify blank lines at start of region.
3489 (while (and (< (point) to
) (bolp) (eolp))
3491 (if (and column
(< column longest-line-col
))
3492 ;; Don't try to align with surrounding backslashes if
3493 ;; any line is too long.
3496 ;; Impose minimum limit and tab width alignment only if
3497 ;; we can't align with surrounding backslashes.
3498 (if (> (% longest-line-col tab-width
) 0)
3499 (setq longest-line-col
3500 (* (/ (+ longest-line-col tab-width -
1)
3503 (setq column
(max c-backslash-column
3505 ;; Always impose maximum limit.
3506 (setq column
(min column c-backslash-max-column
)))
3507 (if bs-col-after-end
3508 ;; Add backslashes on all lines if the macro continues
3509 ;; after the to line.
3511 (set-marker endmark to
)
3512 (c-append-backslashes-forward endmark column point-pos
))
3513 ;; Add backslashes on all lines except the last, and
3514 ;; remove any on the last line.
3519 (set-marker endmark
(1- (point)))))
3521 (c-append-backslashes-forward endmark column point-pos
)
3522 ;; The function above leaves point on the line
3523 ;; following endmark.
3524 (set-marker endmark
(point)))
3525 (set-marker endmark to
))
3526 (c-delete-backslashes-forward endmark point-pos
)))))
3527 (set-marker endmark nil
)
3528 (if (markerp point-pos
)
3529 (set-marker point-pos nil
))))
3531 (defun c-append-backslashes-forward (to-mark column point-pos
)
3532 (let ((state (parse-partial-sexp (c-point 'bol
) (point))))
3536 (<= (point) to-mark
)
3538 (let ((start (point)) (inserted nil
) end col
)
3540 (unless (eq (char-before) ?
\\)
3543 (setq state
(parse-partial-sexp
3544 start
(point) nil nil state
))
3546 (setq col
(current-column))
3548 ;; Avoid unnecessary changes of the buffer.
3549 (cond ((and (not inserted
) (nth 3 state
))
3550 ;; Don't realign backslashes in string literals
3551 ;; since that would change them.
3558 (skip-chars-backward
3559 " \t" (if (>= (point) point-pos
) point-pos
))
3563 ((and (= col column
)
3564 (memq (char-before) '(?\ ?
\t))))
3568 (or (/= (skip-chars-backward
3569 " \t" (if (>= (point) point-pos
) point-pos
))
3571 (/= (char-after) ?\
)))
3572 (delete-region (point) end
)
3573 (indent-to column
1)))
3575 (zerop (forward-line 1)))
3576 (bolp))) ; forward-line has funny behavior at eob.
3578 ;; Make sure there are backslashes with at least one space in
3582 (<= (point) to-mark
)
3584 (let ((start (point)))
3586 (setq state
(parse-partial-sexp
3587 start
(point) nil nil state
))
3589 (if (eq (char-before) ?
\\)
3590 (unless (nth 3 state
)
3592 (unless (and (memq (char-before) '(?\ ?
\t))
3593 (/= (point) point-pos
))
3596 (if (and (memq (char-before) '(?\ ?
\t))
3597 (/= (point) point-pos
))
3601 (zerop (forward-line 1)))
3602 (bolp)))))) ; forward-line has funny behavior at eob.
3604 (defun c-delete-backslashes-forward (to-mark point-pos
)
3606 (and (<= (point) to-mark
)
3609 (if (eq (char-before) ?
\\)
3612 (progn (backward-char)
3613 (skip-chars-backward " \t" (if (>= (point) point-pos
)
3616 (zerop (forward-line 1)))
3617 (bolp)))) ; forward-line has funny behavior at eob.
3621 ;;; Line breaking and paragraph filling.
3623 (defvar c-auto-fill-prefix t
)
3624 (defvar c-lit-limits nil
)
3625 (defvar c-lit-type nil
)
3627 ;; The filling code is based on a simple theory; leave the intricacies
3628 ;; of the text handling to the currently active mode for that
3629 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3630 ;; possible to make them work correctly wrt the comment and string
3631 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3632 ;; to it, there's quite a lot of special cases to handle which makes
3633 ;; the code anything but simple. The intention is that it will work
3634 ;; with any well-written text filling package that preserves a fill
3637 ;; We temporarily mask comment starters and enders as necessary for
3638 ;; the filling code to do its job on a seemingly normal text block.
3639 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3640 ;; preserve it correctly (especially important when filling C++ style
3641 ;; line comments). By default, we set up and use adaptive-fill-mode,
3642 ;; which is standard in all supported Emacs flavors.
3644 (defun c-guess-fill-prefix (lit-limits lit-type
)
3645 ;; Determine the appropriate comment fill prefix for a block or line
3646 ;; comment. Return a cons of the prefix string and the column where
3647 ;; it ends. If fill-prefix is set, it'll override. Note that this
3648 ;; function also uses the value of point in some heuristics.
3650 ;; This function might do hidden buffer changes.
3652 (let* ((here (point))
3653 (prefix-regexp (concat "[ \t]*\\("
3654 c-current-comment-prefix
3656 (comment-start-regexp (if (eq lit-type
'c
++)
3658 comment-start-skip
))
3659 prefix-line comment-prefix res comment-text-end
)
3663 (setq res
(cons fill-prefix
3664 ;; Ugly way of getting the column after the fill
3665 ;; prefix; it'd be nice with a current-column
3666 ;; that works on strings..
3667 (let ((start (point)))
3670 (insert-and-inherit "\n" fill-prefix
)
3672 (delete-region start
(point)))))))
3676 ;; Set fallback for comment-prefix if none is found.
3677 (setq comment-prefix
"// "
3678 comment-text-end
(cdr lit-limits
))
3681 (if (> (point) (car lit-limits
))
3682 ;; The current line is not the comment starter, so the
3683 ;; comment has more than one line, and it can therefore be
3684 ;; used to find the comment fill prefix.
3685 (setq prefix-line
(point))
3687 (goto-char (car lit-limits
))
3688 (if (and (= (forward-line 1) 0)
3689 (< (point) (cdr lit-limits
)))
3690 ;; The line after the comment starter is inside the
3691 ;; comment, so we can use it.
3692 (setq prefix-line
(point))
3694 ;; The comment is only one line. Take the comment prefix
3695 ;; from it and keep the indentation.
3696 (goto-char (car lit-limits
))
3697 (if (looking-at prefix-regexp
)
3698 (goto-char (match-end 0))
3700 (skip-chars-forward " \t"))
3703 (if (eq (c-point 'boi
) (car lit-limits
))
3704 ;; There is only whitespace before the comment
3705 ;; starter; take the prefix straight from this line.
3706 (setq str
(buffer-substring-no-properties
3707 (c-point 'bol
) (point))
3708 col
(current-column))
3710 ;; There is code before the comment starter, so we
3711 ;; have to temporarily insert and indent a new line to
3712 ;; get the right space/tab mix in the indentation.
3713 (let ((prefix-len (- (point) (car lit-limits
)))
3717 (goto-char (car lit-limits
))
3718 (indent-to (prog1 (current-column)
3721 (forward-char prefix-len
)
3722 (setq str
(buffer-substring-no-properties
3723 (c-point 'bol
) (point))
3724 col
(current-column)))
3725 (delete-region (car lit-limits
) tmp
))))
3728 (if (or (string-match "\\s \\'" str
) (not (eolp)))
3730 ;; The prefix ends the line with no whitespace
3731 ;; after it. Default to a single space.
3732 (cons (concat str
" ") (1+ col
))))
3736 (setq comment-text-end
3738 (goto-char (- (cdr lit-limits
) 2))
3739 (if (looking-at "\\*/") (point) (cdr lit-limits
))))
3743 (if (and (> (point) (car lit-limits
))
3744 (not (and (looking-at "[ \t]*\\*/")
3745 (eq (cdr lit-limits
) (match-end 0)))))
3746 ;; The current line is not the comment starter and
3747 ;; contains more than just the ender, so it's good enough
3748 ;; to be used for the comment fill prefix.
3749 (setq prefix-line
(point))
3750 (goto-char (car lit-limits
))
3752 (cond ((or (/= (forward-line 1) 0)
3753 (>= (point) (cdr lit-limits
))
3754 (and (looking-at "[ \t]*\\*/")
3755 (eq (cdr lit-limits
) (match-end 0)))
3756 (and (looking-at prefix-regexp
)
3757 (<= (1- (cdr lit-limits
)) (match-end 0))))
3758 ;; The comment is either one line or the next line contains
3759 ;; just the comment ender. In this case we have no
3760 ;; information about a suitable comment prefix, so we resort
3761 ;; to c-block-comment-prefix.
3762 (setq comment-prefix
(or c-block-comment-prefix
"")))
3765 ;; The point was on the comment opener line, so we might want
3766 ;; to treat this as a not yet closed comment.
3768 (if (and (match-beginning 1)
3769 (/= (match-beginning 1) (match-end 1)))
3770 ;; Above `prefix-regexp' matched a nonempty prefix on the
3771 ;; second line, so let's use it. Normally it should do
3772 ;; to set `prefix-line' and let the code below pick up
3773 ;; the whole prefix, but if there's no text after the
3774 ;; match then it will probably fall back to no prefix at
3775 ;; all if the comment isn't closed yet, so in that case
3776 ;; it's better to force use of the prefix matched now.
3777 (if (= (match-end 0) (c-point 'eol
))
3778 (setq comment-prefix
(match-string 1))
3779 (setq prefix-line
(point)))
3781 ;; There's no nonempty prefix on the line after the
3782 ;; comment opener. If the line is empty, or if the
3783 ;; text on it has less or equal indentation than the
3784 ;; comment starter we assume it's an unclosed
3785 ;; comment starter, i.e. that
3786 ;; `c-block-comment-prefix' should be used.
3787 ;; Otherwise we assume it's a closed comment where
3788 ;; the prefix really is the empty string.
3789 ;; E.g. this is an unclosed comment:
3800 ;; (Looking for the presence of the comment closer
3801 ;; rarely works since it's probably the closer of
3802 ;; some comment further down when the comment
3803 ;; really is unclosed.)
3804 (if (<= (save-excursion (back-to-indentation)
3806 (save-excursion (goto-char (car lit-limits
))
3808 (setq comment-prefix
(or c-block-comment-prefix
""))
3809 (setq prefix-line
(point)))))
3812 ;; Otherwise the line after the comment starter is good
3813 ;; enough to find the prefix in.
3814 (setq prefix-line
(point))))
3816 (when comment-prefix
3817 ;; Haven't got the comment prefix on any real line that we
3818 ;; can take it from, so we have to temporarily insert
3819 ;; `comment-prefix' on a line and indent it to find the
3820 ;; correct column and the correct mix of tabs and spaces.
3822 (let (tmp-pre tmp-post
)
3826 (goto-char (car lit-limits
))
3827 (if (looking-at comment-start-regexp
)
3828 (goto-char (min (match-end 0)
3831 (skip-chars-forward " \t"))
3833 (when (eq (char-syntax (char-before)) ?\
)
3834 ;; If there's ws on the current line, we'll use it
3835 ;; instead of what's ending comment-prefix.
3836 (setq comment-prefix
3837 (concat (substring comment-prefix
3841 (buffer-substring-no-properties
3843 (skip-chars-backward " \t")
3847 (setq tmp-pre
(point-marker))
3849 ;; We insert an extra non-whitespace character
3850 ;; before the line break and after comment-prefix in
3851 ;; case it's "" or ends with whitespace.
3852 (insert-and-inherit "x\n" comment-prefix
"x")
3853 (setq tmp-post
(point-marker))
3855 (indent-according-to-mode)
3857 (goto-char (1- tmp-post
))
3858 (cons (buffer-substring-no-properties
3859 (c-point 'bol
) (point))
3863 (delete-region tmp-pre tmp-post
)
3864 (set-marker tmp-pre nil
)
3865 (set-marker tmp-post nil
))))))))))
3867 (or res
; Found a good prefix above.
3870 ;; prefix-line is the bol of a line on which we should try
3871 ;; to find the prefix.
3872 (let* (fb-string fb-endpos
; Contains any fallback prefix found.
3875 (when (and (looking-at prefix-regexp
)
3876 (<= (match-end 0) comment-text-end
))
3877 (unless (eq (match-end 0) (c-point 'eol
))
3878 ;; The match is fine if there's text after it.
3879 (throw 'found
(cons (buffer-substring-no-properties
3880 (match-beginning 0) (match-end 0))
3881 (progn (goto-char (match-end 0))
3882 (current-column)))))
3884 ;; This match is better than nothing, so let's
3885 ;; remember it in case nothing better is found
3887 (setq fb-string
(buffer-substring-no-properties
3888 (match-beginning 0) (match-end 0))
3889 fb-endpos
(match-end 0)))
3893 ;; Search for a line which has text after the prefix
3894 ;; so that we get the proper amount of whitespace
3895 ;; after it. We start with the current line, then
3896 ;; search backwards, then forwards.
3898 (goto-char prefix-line
)
3899 (when (and (funcall test-line
)
3900 (or (/= (match-end 1) (match-end 0))
3901 ;; The whitespace is sucked up by the
3902 ;; first [ \t]* glob if the prefix is empty.
3903 (and (= (match-beginning 1) (match-end 1))
3904 (/= (match-beginning 0) (match-end 0)))))
3905 ;; If the current line doesn't have text but do
3906 ;; have whitespace after the prefix, we'll use it.
3907 (throw 'found
(cons fb-string
3908 (progn (goto-char fb-endpos
)
3909 (current-column)))))
3911 (if (eq lit-type
'c
++)
3912 ;; For line comments we can search up to and
3913 ;; including the first line.
3914 (while (and (zerop (forward-line -
1))
3915 (>= (point) (car lit-limits
)))
3916 (funcall test-line
))
3917 ;; For block comments we must stop before the
3919 (while (and (zerop (forward-line -
1))
3920 (> (point) (car lit-limits
)))
3921 (funcall test-line
)))
3923 (goto-char prefix-line
)
3924 (while (and (zerop (forward-line 1))
3925 (< (point) (cdr lit-limits
)))
3926 (funcall test-line
))
3928 (goto-char prefix-line
)
3932 ;; A good line wasn't found, but at least we have a
3933 ;; fallback that matches the comment prefix regexp.
3934 (cond ((or (string-match "\\s \\'" fb-string
)
3936 (goto-char fb-endpos
)
3938 ;; There are ws or text after the prefix, so
3940 (cons fb-string
(current-column)))
3943 ;; Check if there's any whitespace padding
3944 ;; on the comment start line that we can
3945 ;; use after the prefix.
3946 (goto-char (car lit-limits
))
3947 (if (looking-at comment-start-regexp
)
3948 (goto-char (match-end 0))
3950 (skip-chars-forward " \t"))
3952 (eq (char-syntax (char-before)) ?\
)))
3954 (setq fb-string
(buffer-substring-no-properties
3956 (skip-chars-backward " \t")
3959 (goto-char fb-endpos
)
3960 (skip-chars-backward " \t")
3962 (let ((tmp (point)))
3963 ;; Got to mess in the buffer once again to
3964 ;; ensure the column gets correct. :P
3967 (insert-and-inherit fb-string
)
3968 (cons (buffer-substring-no-properties
3972 (delete-region tmp
(point)))))
3975 ;; Last resort: Just add a single space after
3977 (cons (concat fb-string
" ")
3978 (progn (goto-char fb-endpos
)
3979 (1+ (current-column)))))))
3981 ;; The line doesn't match the comment prefix regexp.
3983 ;; We have a fallback for line comments that we must use.
3984 (cons (concat (buffer-substring-no-properties
3985 prefix-line
(c-point 'boi
))
3987 (progn (back-to-indentation)
3988 (+ (current-column) (length comment-prefix
))))
3990 ;; Assume we are dealing with a "free text" block
3991 ;; comment where the lines doesn't have any comment
3992 ;; prefix at all and we should just fill it as
3997 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun
&rest args
)
3998 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3999 ;; masked to allow adaptive filling to work correctly. That
4000 ;; includes narrowing the buffer and, if point is inside a comment,
4001 ;; masking the comment starter and ender appropriately.
4003 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
4004 ;; The position of point is then less significant when doing masking
4007 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
4008 ;; only if the point turns out to be inside a comment or a string.
4010 ;; Note that this function does not do any hidden buffer changes.
4013 ;; beg and end limit the region to narrow. end is a marker.
4015 ;; tmp-pre and tmp-post mark strings that are temporarily
4016 ;; inserted at the start and end of the region. tmp-pre is a
4017 ;; cons of the positions of the prepended string. tmp-post is
4018 ;; a marker pointing to the single character of the appended
4021 ;; If hang-ender-stuck isn't nil, the comment ender is
4022 ;; hanging. In that case it's set to the number of spaces
4023 ;; that should be between the text and the ender.
4025 ;; auto-fill-spaces is the exact sequence of whitespace between a
4026 ;; comment's last word and the comment ender, temporarily replaced
4027 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4030 (c-lit-limits c-lit-limits
)
4031 (c-lit-type c-lit-type
))
4033 ;; Restore point on undo. It's necessary since we do a lot of
4034 ;; hidden inserts and deletes below that should be as transparent
4036 (if (and buffer-undo-list
(not (eq buffer-undo-list t
)))
4037 (setq buffer-undo-list
(cons (point) buffer-undo-list
)))
4039 ;; Determine the limits and type of the containing literal (if any):
4040 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4042 (c-save-buffer-state ()
4044 ;; Widen to catch comment limits correctly.
4046 (unless c-lit-limits
4047 (setq c-lit-limits
(c-literal-limits nil fill-paragraph
)))
4048 (setq c-lit-limits
(c-collect-line-comments c-lit-limits
))
4050 (setq c-lit-type
(c-literal-type c-lit-limits
))))
4053 (unless (c-safe (backward-char)
4057 (forward-paragraph))
4058 (setq end
(point-marker)))
4060 (unless (c-safe (forward-char)
4061 (backward-paragraph)
4064 (backward-paragraph))
4065 (setq beg
(point))))
4069 ;; For each of the possible types of text (string, C comment ...)
4070 ;; determine BEG and END, the region we will narrow to. If we're in
4071 ;; a literal, constrain BEG and END to the limits of this literal.
4073 ;; For some of these text types, particularly a block comment, we
4074 ;; may need to massage whitespace near literal delimiters, so that
4075 ;; these don't get filled inappropriately.
4078 ((eq c-lit-type
'c
++) ; Line comment.
4080 ;; Limit to the comment or paragraph end, whichever
4082 (set-marker end
(min end
(cdr c-lit-limits
)))
4084 (when (<= beg
(car c-lit-limits
))
4085 ;; The region includes the comment starter, so we must
4087 (goto-char (car c-lit-limits
))
4088 (back-to-indentation)
4089 (if (eq (point) (car c-lit-limits
))
4090 ;; Include the first line in the region.
4091 (setq beg
(c-point 'bol
))
4092 ;; The first line contains code before the
4093 ;; comment. We must fake a line that doesn't.
4096 (setq apply-outside-literal t
))
4098 ((eq c-lit-type
'c
) ; Block comment.
4100 (or (> end
(cdr c-lit-limits
))
4101 (and (= end
(cdr c-lit-limits
))
4102 (eq (char-before end
) ?
/)
4103 (eq (char-before (1- end
)) ?
*)
4105 (> (- (cdr c-lit-limits
) (car c-lit-limits
)) 3)))
4106 ;; There is a comment ender, and the region includes it. If
4107 ;; it's on its own line, it stays on its own line. If it's got
4108 ;; company on the line, it keeps (at least one word of) it.
4109 ;; "=====*/" counts as a comment ender here, but "===== */"
4110 ;; doesn't and "foo*/" doesn't.
4113 (goto-char (cdr c-lit-limits
))
4115 ;; The following conjunct was added to avoid an
4116 ;; "Invalid search bound (wrong side of point)"
4117 ;; error in the subsequent re-search. Maybe
4118 ;; another fix would be needed (2007-12-08).
4119 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4120 ; 2010-10-17 Construct removed.
4121 ; (or (< (- (cdr c-lit-limits) 2) (point))
4123 (search-forward-regexp
4124 (concat "\\=[ \t]*\\(" c-current-comment-prefix
"\\)")
4125 (- (cdr c-lit-limits
) 2) t
)
4126 (not (search-forward-regexp
4128 (- (cdr c-lit-limits
) 2) 'limit
))
4129 ;; The comment ender IS on its own line. Exclude this
4130 ;; line from the filling.
4131 (set-marker end
(c-point 'bol
))));)
4133 ;; The comment ender is hanging. Replace all space between it
4134 ;; and the last word either by one or two 'x's (when
4135 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4136 ;; as the whitespace (when auto filling), and include it in
4137 ;; the region. We'll change them back to whitespace
4138 ;; afterwards. The effect of this is to glue the comment
4139 ;; ender to the last word in the comment during filling.
4140 (let* ((ender-start (save-excursion
4141 (goto-char (cdr c-lit-limits
))
4142 (skip-syntax-backward "^w ")
4144 (ender-column (save-excursion
4145 (goto-char ender-start
)
4147 (point-rel (- ender-start here
))
4148 (sentence-ends-comment
4150 (goto-char ender-start
)
4151 (and (search-backward-regexp
4152 (c-sentence-end) (c-point 'bol
) t
)
4153 (goto-char (match-end 0))
4154 (looking-at "[ \t]*")
4155 (= (match-end 0) ender-start
))))
4159 ;; Insert a CR after the "*/", adjust END
4160 (goto-char (cdr c-lit-limits
))
4161 (setq tmp-post
(point-marker))
4163 (set-marker end
(point))
4165 (forward-line -
1) ; last line of the comment
4166 (if (and (looking-at (concat "[ \t]*\\(\\("
4167 c-current-comment-prefix
4169 (eq ender-start
(match-end 0)))
4170 ;; The comment ender is prefixed by nothing but a
4171 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4172 ;; 2006/4/28). Remove it along with surrounding ws.
4173 (setq spaces
(- (match-end 1) (match-end 2)))
4174 (goto-char ender-start
))
4175 (skip-chars-backward " \t\r\n") ; Surely this can be
4176 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4178 ;; What's being tested here? 2006/4/20. FIXME!!!
4179 (if (/= (point) ender-start
)
4181 (if (<= here
(point))
4182 ;; Don't adjust point below if it's
4183 ;; before the string we replace.
4184 (setq point-rel -
1))
4185 ;; Keep one or two spaces between the
4186 ;; text and the ender, depending on how
4187 ;; many there are now.
4189 (setq spaces
(- ender-column
(current-column))))
4190 (setq auto-fill-spaces
(c-delete-and-extract-region
4191 (point) ender-start
))
4192 ;; paragraph filling condenses multiple spaces to
4193 ;; single or double spaces. auto-fill doesn't.
4198 (if (and sentence-ends-comment
4199 sentence-end-double-space
)
4202 ;; Insert the filler first to keep marks right.
4203 (insert-char ?x spaces t
)
4204 (setq hang-ender-stuck spaces
)
4206 (and (>= point-rel
0)
4207 (- (point) (min point-rel spaces
)))))
4208 (setq point-rel nil
)))
4211 ;; Point was in the middle of the string we
4212 ;; replaced above, so put it back in the same
4213 ;; relative position, counting from the end.
4214 (goto-char point-rel
)))
4217 (when (<= beg
(car c-lit-limits
))
4218 ;; The region includes the comment starter.
4220 (goto-char (car c-lit-limits
))
4221 (if (looking-at (concat "\\(" comment-start-skip
"\\)$"))
4222 ;; Begin with the next line.
4223 (setq beg
(c-point 'bonl
))
4224 ;; Fake the fill prefix in the first line.
4227 (setq apply-outside-literal t
))
4229 ((eq c-lit-type
'string
) ; String.
4231 (when (>= end
(cdr c-lit-limits
))
4232 (goto-char (1- (cdr c-lit-limits
)))
4233 (setq tmp-post
(point-marker))
4235 (set-marker end
(point)))
4236 (when (<= beg
(car c-lit-limits
))
4237 (goto-char (1+ (car c-lit-limits
)))
4238 (setq beg
(if (looking-at "\\\\$")
4239 ;; Leave the start line if it's
4240 ;; nothing but an escaped newline.
4243 (setq apply-outside-literal t
))
4245 ((eq c-lit-type
'pound
) ; Macro
4246 ;; Narrow to the macro limits if they are nearer than the
4247 ;; paragraph limits. Don't know if this is necessary but
4248 ;; do it for completeness sake (doing auto filling at all
4249 ;; inside macros is bogus to begin with since the line
4250 ;; continuation backslashes aren't handled).
4252 (c-save-buffer-state ()
4253 (c-beginning-of-macro)
4260 (set-marker end
(point))))))
4263 ;; Try to avoid comments and macros in the paragraph to
4264 ;; avoid that the adaptive fill mode gets the prefix from
4266 (c-save-buffer-state nil
4269 (c-forward-syntactic-ws end
)
4273 (c-backward-syntactic-ws beg
)
4275 (set-marker end
(point))))))
4278 ;; Temporarily insert the fill prefix after the comment
4279 ;; starter so that the first line looks like any other
4280 ;; comment line in the narrowed region.
4281 (setq fill
(c-save-buffer-state nil
4282 (c-guess-fill-prefix c-lit-limits c-lit-type
)))
4283 (unless (string-match (concat "\\`[ \t]*\\("
4284 c-current-comment-prefix
4287 ;; Oops, the prefix doesn't match the comment prefix
4288 ;; regexp. This could produce very confusing
4289 ;; results with adaptive fill packages together with
4290 ;; the insert prefix magic below, since the prefix
4291 ;; often doesn't appear at all. So let's warn about
4294 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4296 ;; Find the right spot on the line, break it, insert
4297 ;; the fill prefix and make sure we're back in the
4298 ;; same column by temporarily prefixing the first word
4299 ;; with a number of 'x'.
4301 (goto-char (car c-lit-limits
))
4302 (if (looking-at (if (eq c-lit-type
'c
++)
4303 c-current-comment-prefix
4304 comment-start-skip
))
4305 (goto-char (match-end 0))
4307 (skip-chars-forward " \t"))
4308 (while (and (< (current-column) (cdr fill
))
4311 (let ((col (current-column)))
4312 (setq beg
(1+ (point))
4313 tmp-pre
(list (point)))
4316 (insert-and-inherit "\n" (car fill
))
4317 (insert-char ?x
(- col
(current-column)) t
))
4318 (setcdr tmp-pre
(point))))))
4320 (when apply-outside-literal
4321 ;; `apply-outside-literal' is always set to t here if
4322 ;; we're inside a literal.
4326 ;; Kludge: If the function that adapts the fill prefix
4327 ;; doesn't produce the required comment starter for
4328 ;; line comments, then force it by setting fill-prefix.
4329 (when (and (eq c-lit-type
'c
++)
4330 ;; Kludge the kludge: filladapt-mode doesn't
4331 ;; have this problem, but it currently
4332 ;; doesn't override fill-context-prefix
4334 (not (and (boundp 'filladapt-mode
)
4338 (or (fill-context-prefix beg end
)
4340 (c-save-buffer-state nil
4341 (car (or fill
(c-guess-fill-prefix
4342 c-lit-limits c-lit-type
)))))))
4344 ;; Save the relative position of point if it's outside the
4345 ;; region we're going to narrow. Want to restore it in that
4346 ;; case, but otherwise it should be moved according to the
4348 (point-rel (cond ((< (point) beg
) (- (point) beg
))
4349 ((> (point) end
) (- (point) end
)))))
4351 ;; Preparations finally done! Now we can call the
4355 (narrow-to-region beg end
)
4358 ;; Restore point if it was outside the region.
4360 (goto-char (+ beg point-rel
))
4361 (goto-char (+ end point-rel
))))))))
4363 (when (consp tmp-pre
)
4364 (delete-region (car tmp-pre
) (cdr tmp-pre
)))
4368 (goto-char tmp-post
)
4370 (when hang-ender-stuck
4371 ;; Preserve point even if it's in the middle of the string
4372 ;; we replace; save-excursion doesn't work in that case.
4374 (goto-char tmp-post
)
4375 (skip-syntax-backward "^w ")
4376 (forward-char (- hang-ender-stuck
))
4377 (if (or fill-paragraph
(not auto-fill-spaces
))
4378 (insert-char ?\ hang-ender-stuck t
)
4379 (insert auto-fill-spaces
))
4380 (delete-char hang-ender-stuck
)
4382 (set-marker tmp-post nil
))
4384 (set-marker end nil
))))
4386 (defun c-fill-paragraph (&optional arg
)
4387 "Like \\[fill-paragraph] but handles C and C++ style comments.
4388 If any of the current line is a comment or within a comment, fill the
4389 comment or the paragraph of it that point is in, preserving the
4390 comment indentation or line-starting decorations (see the
4391 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4394 If point is inside multiline string literal, fill it. This currently
4395 does not respect escaped newlines, except for the special case when it
4396 is the very first thing in the string. The intended use for this rule
4397 is in situations like the following:
4399 char description[] = \"\\
4400 A very long description of something that you want to fill to make
4401 nicely formatted output.\"\;
4403 If point is in any other situation, i.e. in normal code, do nothing.
4405 Optional prefix ARG means justify paragraph as well."
4407 (let ((fill-paragraph-function
4408 ;; Avoid infinite recursion.
4409 (if (not (eq fill-paragraph-function
'c-fill-paragraph
))
4410 fill-paragraph-function
)))
4411 (c-mask-paragraph t nil
'fill-paragraph arg
))
4412 ;; Always return t. This has the effect that if filling isn't done
4413 ;; above, it isn't done at all, and it's therefore effectively
4414 ;; disabled in normal code.
4417 (defun c-do-auto-fill ()
4418 ;; Do automatic filling if not inside a context where it should be
4420 (let ((c-auto-fill-prefix
4421 ;; The decision whether the line should be broken is actually
4422 ;; done in c-indent-new-comment-line, which do-auto-fill
4423 ;; calls to break lines. We just set this special variable
4424 ;; so that we'll know when we're called from there. It's
4425 ;; also used to detect whether fill-prefix is user set or
4426 ;; generated automatically by do-auto-fill.
4428 (c-mask-paragraph nil t
'do-auto-fill
)))
4430 (defun c-indent-new-comment-line (&optional soft allow-auto-fill
)
4431 "Break line at point and indent, continuing comment or macro if within one.
4432 If inside a comment and `comment-multi-line' is non-nil, the
4433 indentation and line prefix are preserved (see the
4434 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4435 details). If inside a single line comment and `comment-multi-line' is
4436 nil, a new comment of the same type is started on the next line and
4437 indented as appropriate for comments. If inside a macro, a line
4438 continuation backslash is inserted and aligned as appropriate, and the
4439 new line is indented according to `c-syntactic-indentation'.
4441 If a fill prefix is specified, it overrides all the above."
4442 ;; allow-auto-fill is used from c-context-line-break to allow auto
4443 ;; filling to break the line more than once. Since this function is
4444 ;; used from auto-fill itself, that's normally disabled to avoid
4445 ;; unnecessary recursion.
4447 (let ((fill-prefix fill-prefix
)
4450 (delete-horizontal-space)
4452 (insert-and-inherit ?
\n)
4453 (newline (if allow-auto-fill nil
1)))))
4454 ;; Already know the literal type and limits when called from
4455 ;; c-context-line-break.
4456 (c-lit-limits c-lit-limits
)
4457 (c-lit-type c-lit-type
)
4458 (c-macro-start c-macro-start
))
4460 (c-save-buffer-state ()
4461 (when (not (eq c-auto-fill-prefix t
))
4462 ;; Called from do-auto-fill.
4463 (unless c-lit-limits
4464 (setq c-lit-limits
(c-literal-limits nil nil t
)))
4466 (setq c-lit-type
(c-literal-type c-lit-limits
)))
4467 (if (memq (cond ((c-query-and-set-macro-start) 'cpp
)
4468 ((null c-lit-type
) 'code
)
4471 (setq fill-prefix t
) ; Used as flag in the cond.
4472 (if (and (null c-auto-fill-prefix
)
4474 (<= (c-point 'bol
) (car c-lit-limits
)))
4475 ;; The adaptive fill function has generated a prefix, but
4476 ;; we're on the first line in a block comment so it'll be
4477 ;; wrong. Ignore it to guess a better one below.
4478 (setq fill-prefix nil
)
4479 (when (and (eq c-lit-type
'c
++)
4480 (not (string-match (concat "\\`[ \t]*"
4481 c-line-comment-starter
)
4482 (or fill-prefix
""))))
4483 ;; Kludge: If the function that adapted the fill prefix
4484 ;; doesn't produce the required comment starter for line
4485 ;; comments, then we ignore it.
4486 (setq fill-prefix nil
)))
4489 (cond ((eq fill-prefix t
)
4490 ;; A call from do-auto-fill which should be ignored.
4493 ;; A fill-prefix overrides anything.
4494 (funcall do-line-break
)
4495 (insert-and-inherit fill-prefix
))
4496 ((c-save-buffer-state ()
4497 (unless c-lit-limits
4498 (setq c-lit-limits
(c-literal-limits)))
4500 (setq c-lit-type
(c-literal-type c-lit-limits
)))
4501 (memq c-lit-type
'(c c
++)))
4502 ;; Some sort of comment.
4503 (if (or comment-multi-line
4505 (goto-char (car c-lit-limits
))
4507 (< (point) (cdr c-lit-limits
))))
4508 ;; Inside a comment that should be continued.
4509 (let ((fill (c-save-buffer-state nil
4510 (c-guess-fill-prefix
4512 (c-collect-line-comments c-lit-limits
))
4515 (start-col (current-column))
4517 (or (and (eq c-lit-type
'c
)
4519 (goto-char (- (cdr c-lit-limits
) 2))
4520 (if (looking-at "\\*/") (point))))
4521 (cdr c-lit-limits
))))
4522 ;; Skip forward past the fill prefix in case
4523 ;; we're standing in it.
4525 ;; FIXME: This doesn't work well in cases like
4527 ;; /* Bla bla bla bla bla
4530 ;; If point is on the 'B' then the line will be
4531 ;; broken after "Bla b".
4533 ;; If we have an empty comment, /* */, the next
4534 ;; lot of code pushes point to the */. We fix
4535 ;; this by never allowing point to end up to the
4536 ;; right of where it started.
4537 (while (and (< (current-column) (cdr fill
))
4540 (if (and (> (point) comment-text-end
)
4541 (> (c-point 'bol
) (car c-lit-limits
)))
4543 ;; The skip takes us out of the (block)
4544 ;; comment; insert the fill prefix at bol
4545 ;; instead and keep the position.
4546 (setq pos
(copy-marker pos t
))
4548 (insert-and-inherit (car fill
))
4549 (if soft
(insert-and-inherit ?
\n) (newline 1))
4551 (set-marker pos nil
))
4552 ;; Don't break in the middle of a comment starter
4554 (cond ((> (point) comment-text-end
)
4555 (goto-char comment-text-end
))
4556 ((< (point) (+ (car c-lit-limits
) 2))
4557 (goto-char (+ (car c-lit-limits
) 2))))
4558 (funcall do-line-break
)
4559 (insert-and-inherit (car fill
))
4560 (if (> (current-column) start-col
)
4561 (move-to-column start-col
)))) ; can this hit the
4563 ;; Inside a comment that should be broken.
4564 (let ((comment-start comment-start
)
4565 (comment-end comment-end
)
4567 (if (eq c-lit-type
'c
)
4568 (unless (string-match "[ \t]*/\\*" comment-start
)
4569 (setq comment-start
"/* " comment-end
" */"))
4570 (unless (string-match "[ \t]*//" comment-start
)
4571 (setq comment-start
"// " comment-end
"")))
4572 (setq col
(save-excursion
4573 (back-to-indentation)
4575 (funcall do-line-break
)
4576 (when (and comment-end
(not (equal comment-end
"")))
4578 (insert-and-inherit comment-end
)
4580 ;; c-comment-indent may look at the current
4581 ;; indentation, so let's start out with the same
4582 ;; indentation as the previous one.
4584 (insert-and-inherit comment-start
)
4585 (indent-for-comment))))
4586 ((c-query-and-set-macro-start)
4588 (unless (looking-at "[ \t]*\\\\$")
4589 ;; Do not clobber the alignment of the line continuation
4590 ;; slash; c-backslash-region might look at it.
4591 (delete-horizontal-space))
4592 ;; Got an asymmetry here: In normal code this command
4593 ;; doesn't indent the next line syntactically, and otoh a
4594 ;; normal syntactically indenting newline doesn't continue
4596 (c-newline-and-indent (if allow-auto-fill nil
1)))
4598 ;; Somewhere else in the code.
4599 (let ((col (save-excursion
4601 (while (and (looking-at "[ \t]*\\\\?$")
4602 (= (forward-line -
1) 0)))
4603 (current-indentation))))
4604 (funcall do-line-break
)
4605 (indent-to col
))))))
4607 (defalias 'c-comment-line-break-function
'c-indent-new-comment-line
)
4608 (make-obsolete 'c-comment-line-break-function
'c-indent-new-comment-line
"21.1")
4610 ;; advice for indent-new-comment-line for older Emacsen
4611 (unless (boundp 'comment-line-break-function
)
4612 (defvar c-inside-line-break-advice nil
)
4613 (defadvice indent-new-comment-line
(around c-line-break-advice
4614 activate preactivate
)
4615 "Call `c-indent-new-comment-line' if in CC Mode."
4616 (if (or c-inside-line-break-advice
4617 (not c-buffer-is-cc-mode
))
4619 (let ((c-inside-line-break-advice t
))
4620 (c-indent-new-comment-line (ad-get-arg 0))))))
4622 (defun c-context-line-break ()
4623 "Do a line break suitable to the context.
4625 When point is outside a comment or macro, insert a newline and indent
4626 according to the syntactic context, unless `c-syntactic-indentation'
4627 is nil, in which case the new line is indented as the previous
4628 non-empty line instead.
4630 When point is inside the content of a preprocessor directive, a line
4631 continuation backslash is inserted before the line break and aligned
4632 appropriately. The end of the cpp directive doesn't count as inside
4635 When point is inside a comment, continue it with the appropriate
4636 comment prefix (see the `c-comment-prefix-regexp' and
4637 `c-block-comment-prefix' variables for details). The end of a
4638 C++-style line comment doesn't count as inside it.
4640 When point is inside a string, only insert a backslash when it is also
4641 inside a preprocessor directive."
4644 (let* (c-lit-limits c-lit-type
4645 (c-macro-start c-macro-start
)
4648 (c-save-buffer-state ()
4649 (setq c-lit-limits
(c-literal-limits nil nil t
)
4650 c-lit-type
(c-literal-type c-lit-limits
))
4651 (when (eq c-lit-type
'c
++)
4652 (setq c-lit-limits
(c-collect-line-comments c-lit-limits
)))
4653 (c-query-and-set-macro-start))
4656 ((or (eq c-lit-type
'c
)
4657 (and (eq c-lit-type
'c
++) ; C++ comment, but not at the very end of it.
4659 (skip-chars-forward " \t")
4661 (1- (cdr c-lit-limits
))))
4662 (and (numberp c-macro-start
) ; Macro, but not at the very end of
4663 ; it, not in a string, and not in the
4665 (not (eq c-lit-type
'string
))
4666 (or (not (looking-at "\\s *$"))
4667 (eq (char-before) ?
\\))
4669 (goto-char c-macro-start
)
4670 (if (looking-at c-opt-cpp-start
)
4671 (goto-char (match-end 0)))
4674 (let ((comment-multi-line t
)
4676 (c-indent-new-comment-line nil t
)))
4678 ((eq c-lit-type
'string
)
4679 (if (and (numberp c-macro-start
)
4680 (not (eq (char-before) ?
\\)))
4684 (t (delete-horizontal-space)
4686 ;; c-indent-line may look at the current indentation, so let's
4687 ;; start out with the same indentation as the previous line.
4688 (let ((col (save-excursion
4691 (while (and (looking-at "[ \t]*\\\\?$")
4692 (= (forward-line -
1) 0)))
4693 (current-indentation))))
4695 (indent-according-to-mode)))))
4697 (defun c-context-open-line ()
4698 "Insert a line break suitable to the context and leave point before it.
4699 This is the `c-context-line-break' equivalent to `open-line', which is
4700 normally bound to C-o. See `c-context-line-break' for the details."
4702 (let ((here (point)))
4705 ;; Temporarily insert a non-whitespace char to keep any
4706 ;; preceding whitespace intact.
4708 (c-context-line-break))
4713 (cc-provide 'cc-cmds
)
4715 ;;; cc-cmds.el ends here
HCoop / bpt / emacs.git / blob