Merge from gnus--rel--5.10
[emacs.git] / lisp / progmodes / cc-cmds.el
blob48fa7d99f5a792b66720d6671a2c921a1efdafa5
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
10 ;; 1987 Dave Detlefs and Stewart Clamen
11 ;; 1985 Richard M. Stallman
12 ;; Maintainer: bug-cc-mode@gnu.org
13 ;; Created: 22-Apr-1997 (split from cc-mode.el)
14 ;; Version: See cc-mode.el
15 ;; Keywords: c languages oop
17 ;; This file is part of GNU Emacs.
19 ;; GNU Emacs is free software; you can redistribute it and/or modify
20 ;; it under the terms of the GNU General Public License as published by
21 ;; the Free Software Foundation; either version 3, or (at your option)
22 ;; any later version.
24 ;; GNU Emacs is distributed in the hope that it will be useful,
25 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
26 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 ;; GNU General Public License for more details.
29 ;; You should have received a copy of the GNU General Public License
30 ;; along with this program; see the file COPYING. If not, write to
31 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
32 ;; Boston, MA 02110-1301, USA.
34 ;;; Commentary:
36 ;;; Code:
38 (eval-when-compile
39 (let ((load-path
40 (if (and (boundp 'byte-compile-dest-file)
41 (stringp byte-compile-dest-file))
42 (cons (file-name-directory byte-compile-dest-file) load-path)
43 load-path)))
44 (load "cc-bytecomp" nil t)))
46 (cc-require 'cc-defs)
47 (cc-require 'cc-vars)
48 (cc-require 'cc-engine)
50 ;; Silence the compiler.
51 (cc-bytecomp-defun delete-forward-p) ; XEmacs
52 (cc-bytecomp-defvar filladapt-mode) ; c-fill-paragraph contains a kludge
53 ; which looks at this.
54 (cc-bytecomp-defun c-forward-subword)
55 (cc-bytecomp-defun c-backward-subword)
57 ;; Indentation / Display syntax functions
58 (defvar c-fix-backslashes t)
60 (defun c-indent-line (&optional syntax quiet ignore-point-pos)
61 "Indent the current line according to the syntactic context,
62 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
63 syntactic information for the current line. Be silent about syntactic
64 errors if the optional argument QUIET is non-nil, even if
65 `c-report-syntactic-errors' is non-nil. Normally the position of
66 point is used to decide where the old indentation is on a lines that
67 is otherwise empty \(ignoring any line continuation backslash), but
68 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
69 indentation change \(in columns)."
71 (let ((line-cont-backslash (save-excursion
72 (end-of-line)
73 (eq (char-before) ?\\)))
74 (c-fix-backslashes c-fix-backslashes)
75 bs-col
76 shift-amt)
77 (when (and (not ignore-point-pos)
78 (save-excursion
79 (beginning-of-line)
80 (looking-at (if line-cont-backslash
81 ;; Don't use "\\s " - ^L doesn't count as WS
82 ;; here
83 "\\([ \t]*\\)\\\\$"
84 "\\([ \t]*\\)$")))
85 (<= (point) (match-end 1)))
86 ;; Delete all whitespace after point if there's only whitespace
87 ;; on the line, so that any code that does back-to-indentation
88 ;; or similar gets the current column in this case. If this
89 ;; removes a line continuation backslash it'll be restored
90 ;; at the end.
91 (unless c-auto-align-backslashes
92 ;; Should try to keep the backslash alignment
93 ;; in this case.
94 (save-excursion
95 (goto-char (match-end 0))
96 (setq bs-col (1- (current-column)))))
97 (delete-region (point) (match-end 0))
98 (setq c-fix-backslashes t))
99 (if c-syntactic-indentation
100 (setq c-parsing-error
101 (or (let ((c-parsing-error nil)
102 (c-syntactic-context
103 (or syntax
104 (and (boundp 'c-syntactic-context)
105 c-syntactic-context))))
106 (c-save-buffer-state (indent)
107 (unless c-syntactic-context
108 (setq c-syntactic-context (c-guess-basic-syntax)))
109 (setq indent (c-get-syntactic-indentation
110 c-syntactic-context))
111 (and (not (c-echo-parsing-error quiet))
112 c-echo-syntactic-information-p
113 (message "syntax: %s, indent: %d"
114 c-syntactic-context indent))
115 (setq shift-amt (- indent (current-indentation))))
116 (c-shift-line-indentation shift-amt)
117 (run-hooks 'c-special-indent-hook)
118 c-parsing-error)
119 c-parsing-error))
120 (let ((indent 0))
121 (save-excursion
122 (while (and (= (forward-line -1) 0)
123 (if (looking-at "\\s *\\\\?$")
125 (setq indent (current-indentation))
126 nil))))
127 (setq shift-amt (- indent (current-indentation)))
128 (c-shift-line-indentation shift-amt)))
129 (when (and c-fix-backslashes line-cont-backslash)
130 (if bs-col
131 (save-excursion
132 (indent-to bs-col)
133 (insert ?\\))
134 (when c-auto-align-backslashes
135 ;; Realign the line continuation backslash.
136 (c-backslash-region (point) (point) nil t))))
137 shift-amt))
139 (defun c-newline-and-indent (&optional newline-arg)
140 "Insert a newline and indent the new line.
141 This function fixes line continuation backslashes if inside a macro,
142 and takes care to set the indentation before calling
143 `indent-according-to-mode', so that lineup functions like
144 `c-lineup-dont-change' works better."
146 ;; TODO: Backslashes before eol in comments and literals aren't
147 ;; kept intact.
148 (let ((c-macro-start (c-query-macro-start))
149 ;; Avoid calling c-backslash-region from c-indent-line if it's
150 ;; called during the newline call, which can happen due to
151 ;; c-electric-continued-statement, for example. We also don't
152 ;; want any backslash alignment from indent-according-to-mode.
153 (c-fix-backslashes nil)
154 has-backslash insert-backslash
155 start col)
156 (save-excursion
157 (beginning-of-line)
158 (setq start (point))
159 (while (and (looking-at "[ \t]*\\\\?$")
160 (= (forward-line -1) 0)))
161 (setq col (current-indentation)))
162 (when c-macro-start
163 (if (and (eolp) (eq (char-before) ?\\))
164 (setq insert-backslash t
165 has-backslash t)
166 (setq has-backslash (eq (char-before (c-point 'eol)) ?\\))))
167 (newline newline-arg)
168 (indent-to col)
169 (when c-macro-start
170 (if insert-backslash
171 (progn
172 ;; The backslash stayed on the previous line. Insert one
173 ;; before calling c-backslash-region, so that
174 ;; bs-col-after-end in it works better. Fixup the
175 ;; backslashes on the newly inserted line.
176 (insert ?\\)
177 (backward-char)
178 (c-backslash-region (point) (point) nil t))
179 ;; The backslash moved to the new line, if there was any. Let
180 ;; c-backslash-region fix a backslash on the previous line,
181 ;; and the one that might be on the new line.
182 ;; c-auto-align-backslashes is intentionally ignored here;
183 ;; maybe the moved backslash should be left alone if it's set,
184 ;; but we fix both lines on the grounds that the old backslash
185 ;; has been moved anyway and is now in a different context.
186 (c-backslash-region start (if has-backslash (point) start) nil t)))
187 (when c-syntactic-indentation
188 ;; Reindent syntactically. The indentation done above is not
189 ;; wasted, since c-indent-line might look at the current
190 ;; indentation.
191 (let ((c-syntactic-context (c-save-buffer-state nil
192 (c-guess-basic-syntax))))
193 ;; We temporarily insert another line break, so that the
194 ;; lineup functions will see the line as empty. That makes
195 ;; e.g. c-lineup-cpp-define more intuitive since it then
196 ;; proceeds to the preceding line in this case.
197 (insert ?\n)
198 (delete-horizontal-space)
199 (setq start (- (point-max) (point)))
200 (unwind-protect
201 (progn
202 (backward-char)
203 (indent-according-to-mode))
204 (goto-char (- (point-max) start))
205 (delete-char -1)))
206 (when has-backslash
207 ;; Must align the backslash again after reindentation. The
208 ;; c-backslash-region call above can't be optimized to ignore
209 ;; this line, since it then won't align correctly with the
210 ;; lines below if the first line in the macro is broken.
211 (c-backslash-region (point) (point) nil t)))))
213 (defun c-show-syntactic-information (arg)
214 "Show syntactic information for current line.
215 With universal argument, inserts the analysis as a comment on that line."
216 (interactive "P")
217 (let* ((c-parsing-error nil)
218 (syntax (if (boundp 'c-syntactic-context)
219 ;; Use `c-syntactic-context' in the same way as
220 ;; `c-indent-line', to be consistent.
221 c-syntactic-context
222 (c-save-buffer-state nil
223 (c-guess-basic-syntax)))))
224 (if (not (consp arg))
225 (let (elem pos ols)
226 (message "Syntactic analysis: %s" syntax)
227 (unwind-protect
228 (progn
229 (while syntax
230 (setq elem (pop syntax))
231 (when (setq pos (c-langelem-pos elem))
232 (push (c-put-overlay pos (1+ pos)
233 'face 'highlight)
234 ols))
235 (when (setq pos (c-langelem-2nd-pos elem))
236 (push (c-put-overlay pos (1+ pos)
237 'face 'secondary-selection)
238 ols)))
239 (sit-for 10))
240 (while ols
241 (c-delete-overlay (pop ols)))))
242 (indent-for-comment)
243 (insert-and-inherit (format "%s" syntax))
245 (c-keep-region-active))
247 (defun c-syntactic-information-on-region (from to)
248 "Insert a comment with the syntactic analysis on every line in the region."
249 (interactive "*r")
250 (save-excursion
251 (save-restriction
252 (narrow-to-region from to)
253 (goto-char (point-min))
254 (while (not (eobp))
255 (c-show-syntactic-information '(0))
256 (forward-line)))))
259 ;; Minor mode functions.
260 (defun c-update-modeline ()
261 (let ((fmt (format "/%s%s%s%s"
262 (if c-electric-flag "l" "")
263 (if (and c-electric-flag c-auto-newline)
264 "a" "")
265 (if c-hungry-delete-key "h" "")
266 (if (and
267 ;; cc-subword might not be loaded.
268 (boundp 'c-subword-mode)
269 (symbol-value 'c-subword-mode))
271 "")))
272 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name)
273 (substring mode-name (match-beginning 1) (match-end 1))
274 mode-name)))
275 ;; (setq c-submode-indicators
276 ;; (if (> (length fmt) 1)
277 ;; fmt))
278 (setq mode-name
279 (if (> (length fmt) 1)
280 (concat bare-mode-name fmt)
281 bare-mode-name))
282 (force-mode-line-update)))
284 (defun c-toggle-syntactic-indentation (&optional arg)
285 "Toggle syntactic indentation.
286 Optional numeric ARG, if supplied, turns on syntactic indentation when
287 positive, turns it off when negative, and just toggles it when zero or
288 left out.
290 When syntactic indentation is turned on (the default), the indentation
291 functions and the electric keys indent according to the syntactic
292 context keys, when applicable.
294 When it's turned off, the electric keys don't reindent, the indentation
295 functions indents every new line to the same level as the previous
296 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
297 specified by `c-basic-offset'. The indentation style has no effect in
298 this mode, nor any of the indentation associated variables,
299 e.g. `c-special-indent-hook'.
301 This command sets the variable `c-syntactic-indentation'."
302 (interactive "P")
303 (setq c-syntactic-indentation
304 (c-calculate-state arg c-syntactic-indentation))
305 (c-keep-region-active))
307 (defun c-toggle-auto-newline (&optional arg)
308 "Toggle auto-newline feature.
309 Optional numeric ARG, if supplied, turns on auto-newline when
310 positive, turns it off when negative, and just toggles it when zero or
311 left out.
313 Turning on auto-newline automatically enables electric indentation.
315 When the auto-newline feature is enabled (indicated by \"/la\" on the
316 modeline after the mode name) newlines are automatically inserted
317 after special characters such as brace, comma, semi-colon, and colon."
318 (interactive "P")
319 (setq c-auto-newline
320 (c-calculate-state arg (and c-auto-newline c-electric-flag)))
321 (if c-auto-newline (setq c-electric-flag t))
322 (c-update-modeline)
323 (c-keep-region-active))
325 (defalias 'c-toggle-auto-state 'c-toggle-auto-newline)
326 (make-obsolete 'c-toggle-auto-state 'c-toggle-auto-newline)
328 (defun c-toggle-hungry-state (&optional arg)
329 "Toggle hungry-delete-key feature.
330 Optional numeric ARG, if supplied, turns on hungry-delete when
331 positive, turns it off when negative, and just toggles it when zero or
332 left out.
334 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
335 the modeline after the mode name) the delete key gobbles all preceding
336 whitespace in one fell swoop."
337 (interactive "P")
338 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
339 (c-update-modeline)
340 (c-keep-region-active))
342 (defun c-toggle-auto-hungry-state (&optional arg)
343 "Toggle auto-newline and hungry-delete-key features.
344 Optional numeric ARG, if supplied, turns on auto-newline and
345 hungry-delete when positive, turns them off when negative, and just
346 toggles them when zero or left out.
348 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
349 (interactive "P")
350 (setq c-auto-newline (c-calculate-state arg c-auto-newline))
351 (setq c-hungry-delete-key (c-calculate-state arg c-hungry-delete-key))
352 (c-update-modeline)
353 (c-keep-region-active))
355 (defun c-toggle-electric-state (&optional arg)
356 "Toggle the electric indentation feature.
357 Optional numeric ARG, if supplied, turns on electric indentation when
358 positive, turns it off when negative, and just toggles it when zero or
359 left out."
360 (interactive "P")
361 (setq c-electric-flag (c-calculate-state arg c-electric-flag))
362 (c-update-modeline)
363 (c-keep-region-active))
366 ;; Electric keys
368 (defun c-electric-backspace (arg)
369 "Delete the preceding character or whitespace.
370 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
371 line) then all preceding whitespace is consumed. If however a prefix
372 argument is supplied, or `c-hungry-delete-key' is nil, or point is
373 inside a literal then the function in the variable
374 `c-backspace-function' is called."
375 (interactive "*P")
376 (if (c-save-buffer-state ()
377 (or (not c-hungry-delete-key)
379 (c-in-literal)))
380 (funcall c-backspace-function (prefix-numeric-value arg))
381 (c-hungry-delete-backwards)))
383 (defun c-hungry-delete-backwards ()
384 "Delete the preceding character or all preceding whitespace
385 back to the previous non-whitespace character.
386 See also \\[c-hungry-delete-forward]."
387 (interactive)
388 (let ((here (point)))
389 (c-skip-ws-backward)
390 (if (/= (point) here)
391 (delete-region (point) here)
392 (funcall c-backspace-function 1))))
394 (defalias 'c-hungry-backspace 'c-hungry-delete-backwards)
396 (defun c-electric-delete-forward (arg)
397 "Delete the following character or whitespace.
398 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
399 line) then all following whitespace is consumed. If however a prefix
400 argument is supplied, or `c-hungry-delete-key' is nil, or point is
401 inside a literal then the function in the variable `c-delete-function'
402 is called."
403 (interactive "*P")
404 (if (c-save-buffer-state ()
405 (or (not c-hungry-delete-key)
407 (c-in-literal)))
408 (funcall c-delete-function (prefix-numeric-value arg))
409 (c-hungry-delete-forward)))
411 (defun c-hungry-delete-forward ()
412 "Delete the following character or all following whitespace
413 up to the next non-whitespace character.
414 See also \\[c-hungry-delete-backwards]."
415 (interactive)
416 (let ((here (point)))
417 (c-skip-ws-forward)
418 (if (/= (point) here)
419 (delete-region (point) here)
420 (funcall c-delete-function 1))))
422 ;; This function is only used in XEmacs.
423 (defun c-electric-delete (arg)
424 "Deletes preceding or following character or whitespace.
425 This function either deletes forward as `c-electric-delete-forward' or
426 backward as `c-electric-backspace', depending on the configuration: If
427 the function `delete-forward-p' is defined and returns non-nil, it
428 deletes forward. Otherwise it deletes backward.
430 Note: This is the way in XEmacs to choose the correct action for the
431 \[delete] key, whichever key that means. Other flavors don't use this
432 function to control that."
433 (interactive "*P")
434 (if (and (fboundp 'delete-forward-p)
435 (delete-forward-p))
436 (c-electric-delete-forward arg)
437 (c-electric-backspace arg)))
439 ;; This function is only used in XEmacs.
440 (defun c-hungry-delete ()
441 "Delete a non-whitespace char, or all whitespace up to the next non-whitespace char.
442 The direction of deletion depends on the configuration: If the
443 function `delete-forward-p' is defined and returns non-nil, it deletes
444 forward using `c-hungry-delete-forward'. Otherwise it deletes
445 backward using `c-hungry-backspace'.
447 Note: This is the way in XEmacs to choose the correct action for the
448 \[delete] key, whichever key that means. Other flavors don't use this
449 function to control that."
450 (interactive)
451 (if (and (fboundp 'delete-forward-p)
452 (delete-forward-p))
453 (c-hungry-delete-forward)
454 (c-hungry-delete-backwards)))
456 (defun c-electric-pound (arg)
457 "Insert a \"#\".
458 If `c-electric-flag' is set, handle it specially according to the variable
459 `c-electric-pound-behavior'. If a numeric ARG is supplied, or if point is
460 inside a literal or a macro, nothing special happens."
461 (interactive "*P")
462 (if (c-save-buffer-state ()
463 (or arg
464 (not c-electric-flag)
465 (not (memq 'alignleft c-electric-pound-behavior))
466 (save-excursion
467 (skip-chars-backward " \t")
468 (not (bolp)))
469 (save-excursion
470 (and (= (forward-line -1) 0)
471 (progn (end-of-line)
472 (eq (char-before) ?\\))))
473 (c-in-literal)))
474 ;; do nothing special
475 (self-insert-command (prefix-numeric-value arg))
476 ;; place the pound character at the left edge
477 (let ((pos (- (point-max) (point)))
478 (bolp (bolp)))
479 (beginning-of-line)
480 (delete-horizontal-space)
481 (insert last-command-char)
482 (and (not bolp)
483 (goto-char (- (point-max) pos)))
486 (defun c-point-syntax ()
487 ;; Return the syntactic context of the construct at point. (This is NOT
488 ;; nec. the same as the s.c. of the line point is on). N.B. This won't work
489 ;; between the `#' of a cpp thing and what follows (see c-opt-cpp-prefix).
490 (c-save-buffer-state (;; shut this up too
491 (c-echo-syntactic-information-p nil)
492 syntax)
493 (c-tentative-buffer-changes
494 ;; insert a newline to isolate the construct at point for syntactic
495 ;; analysis.
496 (insert-char ?\n 1)
497 ;; In AWK (etc.) or in a macro, make sure this CR hasn't changed
498 ;; the syntax. (There might already be an escaped NL there.)
499 (when (or (c-at-vsemi-p (1- (point)))
500 (let ((pt (point)))
501 (save-excursion
502 (backward-char)
503 (and (c-beginning-of-macro)
504 (progn (c-end-of-macro)
505 (< (point) pt))))))
506 (backward-char)
507 (insert-char ?\\ 1)
508 (forward-char))
509 (let ((c-syntactic-indentation-in-macros t)
510 (c-auto-newline-analysis t))
511 ;; Turn on syntactic macro analysis to help with auto
512 ;; newlines only.
513 (setq syntax (c-guess-basic-syntax))
514 nil))
515 syntax))
517 (defun c-brace-newlines (syntax)
518 ;; A brace stands at point. SYNTAX is the syntactic context of this brace
519 ;; (not necessarily the same as the S.C. of the line it is on). Return
520 ;; NEWLINES, the list containing some combination of the symbols `before'
521 ;; and `after' saying where newlines should be inserted.
522 (c-save-buffer-state
523 ((syms
524 ;; This is the list of brace syntactic symbols that can hang.
525 ;; If any new ones are added to c-offsets-alist, they should be
526 ;; added here as well.
527 '(class-open class-close defun-open defun-close
528 inline-open inline-close
529 brace-list-open brace-list-close
530 brace-list-intro brace-entry-open
531 block-open block-close
532 substatement-open statement-case-open
533 extern-lang-open extern-lang-close
534 namespace-open namespace-close
535 module-open module-close
536 composition-open composition-close
537 inexpr-class-open inexpr-class-close
538 ;; `statement-cont' is here for the case with a brace
539 ;; list opener inside a statement. C.f. CASE B.2 in
540 ;; `c-guess-continued-construct'.
541 statement-cont))
542 ;; shut this up too
543 (c-echo-syntactic-information-p nil)
544 symb-newlines) ; e.g. (substatement-open . (after))
546 (setq symb-newlines
547 ;; Do not try to insert newlines around a special
548 ;; (Pike-style) brace list.
549 (if (and c-special-brace-lists
550 (save-excursion
551 (c-safe (if (= (char-before) ?{)
552 (forward-char -1)
553 (c-forward-sexp -1))
554 (c-looking-at-special-brace-list))))
556 ;; Seek the matching entry in c-hanging-braces-alist.
557 (or (c-lookup-lists
558 syms
559 ;; Substitute inexpr-class and class-open or
560 ;; class-close with inexpr-class-open or
561 ;; inexpr-class-close.
562 (if (assq 'inexpr-class syntax)
563 (cond ((assq 'class-open syntax)
564 '((inexpr-class-open)))
565 ((assq 'class-close syntax)
566 '((inexpr-class-close)))
567 (t syntax))
568 syntax)
569 c-hanging-braces-alist)
570 '(ignore before after)))) ; Default, when not in c-h-b-l.
572 ;; If syntax is a function symbol, then call it using the
573 ;; defined semantics.
574 (if (and (not (consp (cdr symb-newlines)))
575 (functionp (cdr symb-newlines)))
576 (let ((c-syntactic-context syntax))
577 (funcall (cdr symb-newlines)
578 (car symb-newlines)
579 (point)))
580 (cdr symb-newlines))))
582 (defun c-try-one-liner ()
583 ;; Point is just after a newly inserted }. If the non-whitespace
584 ;; content of the braces is a single line of code, compact the whole
585 ;; construct to a single line, if this line isn't too long. The Right
586 ;; Thing is done with comments.
588 ;; Point will be left after the }, regardless of whether the clean-up is
589 ;; done. Return NON-NIL if the clean-up happened, NIL if it didn't.
591 (let ((here (point))
592 (pos (- (point-max) (point)))
593 mbeg1 mend1 mbeg4 mend4
594 eol-col cmnt-pos cmnt-col cmnt-gap)
596 (when
597 (save-excursion
598 (save-restriction
599 ;; Avoid backtracking over a very large block. The one we
600 ;; deal with here can never be more than three lines.
601 (narrow-to-region (save-excursion
602 (forward-line -2)
603 (point))
604 (point))
605 (and (c-safe (c-backward-sexp))
606 (progn
607 (forward-char)
608 (narrow-to-region (point) (1- here)) ; innards of {.}
609 (looking-at
610 (cc-eval-when-compile
611 (concat
612 "\\(" ; (match-beginning 1)
613 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
614 "\\)" ; (match-end 1)
615 "[^ \t\r\n]+\\([ \t]+[^ \t\r\n]+\\)*" ; non-WS
616 "\\(" ; (match-beginning 4)
617 "[ \t]*\\([\r\n][ \t]*\\)?" ; WS with opt. NL
618 "\\)\\'"))))))) ; (match-end 4) at EOB.
620 (if (c-tentative-buffer-changes
621 (setq mbeg1 (match-beginning 1) mend1 (match-end 1)
622 mbeg4 (match-beginning 4) mend4 (match-end 4))
623 (backward-char) ; back over the `}'
624 (save-excursion
625 (setq cmnt-pos (and (c-backward-single-comment)
626 (- (point) (- mend1 mbeg1)))))
627 (delete-region mbeg4 mend4)
628 (delete-region mbeg1 mend1)
629 (setq eol-col (save-excursion (end-of-line) (current-column)))
631 ;; Necessary to put the closing brace before any line
632 ;; oriented comment to keep it syntactically significant.
633 ;; This isn't necessary for block comments, but the result
634 ;; looks nicer anyway.
635 (when cmnt-pos
636 (delete-char 1) ; the `}' has blundered into a comment
637 (goto-char cmnt-pos)
638 (setq cmnt-col (1+ (current-column)))
639 (setq cmnt-pos (1+ cmnt-pos)) ; we're inserting a `}'
640 (c-skip-ws-backward)
641 (insert-char ?\} 1) ; reinsert the `}' before the comment.
642 (setq cmnt-gap (- cmnt-col (current-column)))
643 (when (zerop cmnt-gap)
644 (insert-char ?\ 1) ; Put a space before a bare comment.
645 (setq cmnt-gap 1)))
647 (or (null c-max-one-liner-length)
648 (zerop c-max-one-liner-length)
649 (<= eol-col c-max-one-liner-length)
650 ;; Can we trim space before comment to make the line fit?
651 (and cmnt-gap
652 (< (- eol-col cmnt-gap) c-max-one-liner-length)
653 (progn (goto-char cmnt-pos)
654 (backward-delete-char-untabify
655 (- eol-col c-max-one-liner-length))
656 t))))
657 (goto-char (- (point-max) pos))))))
659 (defun c-electric-brace (arg)
660 "Insert a brace.
662 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
663 numeric ARG hasn't been supplied, the command performs several electric
664 actions:
666 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
667 the mode line) newlines are inserted before and after the brace as
668 directed by the settings in `c-hanging-braces-alist'.
670 \(b) Any auto-newlines are indented. The original line is also
671 reindented unless `c-syntactic-indentation' is nil.
673 \(c) If auto-newline is turned on, various newline cleanups based on the
674 settings of `c-cleanup-list' are done."
676 (interactive "*P")
677 (let (safepos literal
678 ;; We want to inhibit blinking the paren since this would be
679 ;; most disruptive. We'll blink it ourselves later on.
680 (old-blink-paren blink-paren-function)
681 blink-paren-function)
683 (c-save-buffer-state ()
684 (setq safepos (c-safe-position (point) (c-parse-state))
685 literal (c-in-literal safepos)))
687 ;; Insert the brace. Note that expand-abbrev might reindent
688 ;; the line here if there's a preceding "else" or something.
689 (self-insert-command (prefix-numeric-value arg))
691 (when (and c-electric-flag (not literal) (not arg))
692 (if (not (looking-at "[ \t]*\\\\?$"))
693 (if c-syntactic-indentation
694 (indent-according-to-mode))
696 (let ( ;; shut this up too
697 (c-echo-syntactic-information-p nil)
698 newlines
699 ln-syntax br-syntax syntax) ; Syntactic context of the original line,
700 ; of the brace itself, of the line the brace ends up on.
701 (c-save-buffer-state ((c-syntactic-indentation-in-macros t)
702 (c-auto-newline-analysis t))
703 (setq ln-syntax (c-guess-basic-syntax)))
704 (if c-syntactic-indentation
705 (c-indent-line ln-syntax))
707 (when c-auto-newline
708 (backward-char)
709 (setq br-syntax (c-point-syntax)
710 newlines (c-brace-newlines br-syntax))
712 ;; Insert the BEFORE newline, if wanted, and reindent the newline.
713 (if (and (memq 'before newlines)
714 (> (current-column) (current-indentation)))
715 (if c-syntactic-indentation
716 ;; Only a plain newline for now - it's indented
717 ;; after the cleanups when the line has its final
718 ;; appearance.
719 (newline)
720 (c-newline-and-indent)))
721 (forward-char)
723 ;; `syntax' is the syntactic context of the line which ends up
724 ;; with the brace on it.
725 (setq syntax (if (memq 'before newlines) br-syntax ln-syntax))
727 ;; Do all appropriate clean ups
728 (let ((here (point))
729 (pos (- (point-max) (point)))
730 mbeg mend
733 ;; `}': clean up empty defun braces
734 (when (c-save-buffer-state ()
735 (and (memq 'empty-defun-braces c-cleanup-list)
736 (eq last-command-char ?\})
737 (c-intersect-lists '(defun-close class-close inline-close)
738 syntax)
739 (progn
740 (forward-char -1)
741 (c-skip-ws-backward)
742 (eq (char-before) ?\{))
743 ;; make sure matching open brace isn't in a comment
744 (not (c-in-literal))))
745 (delete-region (point) (1- here))
746 (setq here (- (point-max) pos)))
747 (goto-char here)
749 ;; `}': compact to a one-liner defun?
750 (save-match-data
751 (when
752 (and (eq last-command-char ?\})
753 (memq 'one-liner-defun c-cleanup-list)
754 (c-intersect-lists '(defun-close) syntax)
755 (c-try-one-liner))
756 (setq here (- (point-max) pos))))
758 ;; `{': clean up brace-else-brace and brace-elseif-brace
759 (when (eq last-command-char ?\{)
760 (cond
761 ((and (memq 'brace-else-brace c-cleanup-list)
762 (re-search-backward
763 (concat "}"
764 "\\([ \t\n]\\|\\\\\n\\)*"
765 "else"
766 "\\([ \t\n]\\|\\\\\n\\)*"
768 "\\=")
769 nil t))
770 (delete-region (match-beginning 0) (match-end 0))
771 (insert-and-inherit "} else {"))
772 ((and (memq 'brace-elseif-brace c-cleanup-list)
773 (progn
774 (goto-char (1- here))
775 (setq mend (point))
776 (c-skip-ws-backward)
777 (setq mbeg (point))
778 (eq (char-before) ?\)))
779 (zerop (c-save-buffer-state nil (c-backward-token-2 1 t)))
780 (eq (char-after) ?\()
781 ; (progn
782 ; (setq tmp (point))
783 (re-search-backward
784 (concat "}"
785 "\\([ \t\n]\\|\\\\\n\\)*"
786 "else"
787 "\\([ \t\n]\\|\\\\\n\\)+"
788 "if"
789 "\\([ \t\n]\\|\\\\\n\\)*"
790 "\\=")
791 nil t);)
792 ;(eq (match-end 0) tmp);
794 (delete-region mbeg mend)
795 (goto-char mbeg)
796 (insert ?\ ))))
798 (goto-char (- (point-max) pos))
800 ;; Indent the line after the cleanups since it might
801 ;; very well indent differently due to them, e.g. if
802 ;; c-indent-one-line-block is used together with the
803 ;; one-liner-defun cleanup.
804 (when c-syntactic-indentation
805 (c-indent-line)))
807 ;; does a newline go after the brace?
808 (if (memq 'after newlines)
809 (c-newline-and-indent))
810 ))))
812 ;; blink the paren
813 (and (eq last-command-char ?\})
814 (not executing-kbd-macro)
815 old-blink-paren
816 (save-excursion
817 (c-save-buffer-state nil
818 (c-backward-syntactic-ws safepos))
819 (funcall old-blink-paren)))))
821 (defun c-electric-slash (arg)
822 "Insert a slash character.
824 If the slash is inserted immediately after the comment prefix in a c-style
825 comment, the comment might get closed by removing whitespace and possibly
826 inserting a \"*\". See the variable `c-cleanup-list'.
828 Indent the line as a comment, if:
830 1. The slash is second of a \"//\" line oriented comment introducing
831 token and we are on a comment-only-line, or
833 2. The slash is part of a \"*/\" token that closes a block oriented
834 comment.
836 If a numeric ARG is supplied, point is inside a literal, or
837 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
838 is inhibited."
839 (interactive "*P")
840 (let ((literal (c-save-buffer-state () (c-in-literal)))
841 indentp
842 ;; shut this up
843 (c-echo-syntactic-information-p nil))
845 ;; comment-close-slash cleanup? This DOESN'T need `c-electric-flag' or
846 ;; `c-syntactic-indentation' set.
847 (when (and (not arg)
848 (eq literal 'c)
849 (memq 'comment-close-slash c-cleanup-list)
850 (eq last-command-char ?/)
851 (looking-at (concat "[ \t]*\\("
852 (regexp-quote comment-end) "\\)?$"))
853 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
854 (save-excursion
855 (save-restriction
856 (narrow-to-region (point-min) (point))
857 (back-to-indentation)
858 (looking-at (concat c-current-comment-prefix "[ \t]*$")))))
859 (delete-region (progn (forward-line 0) (point))
860 (progn (end-of-line) (point)))
861 (insert-char ?* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
863 (setq indentp (and (not arg)
864 c-syntactic-indentation
865 c-electric-flag
866 (eq last-command-char ?/)
867 (eq (char-before) (if literal ?* ?/))))
868 (self-insert-command (prefix-numeric-value arg))
869 (if indentp
870 (indent-according-to-mode))))
872 (defun c-electric-star (arg)
873 "Insert a star character.
874 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
875 the star is the second character of a C style comment starter on a
876 comment-only-line, indent the line as a comment. If a numeric ARG is
877 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
878 this indentation is inhibited."
880 (interactive "*P")
881 (self-insert-command (prefix-numeric-value arg))
882 ;; if we are in a literal, or if arg is given do not reindent the
883 ;; current line, unless this star introduces a comment-only line.
884 (if (c-save-buffer-state ()
885 (and c-syntactic-indentation
886 c-electric-flag
887 (not arg)
888 (eq (c-in-literal) 'c)
889 (eq (char-before) ?*)
890 (save-excursion
891 (forward-char -1)
892 (skip-chars-backward "*")
893 (if (eq (char-before) ?/)
894 (forward-char -1))
895 (skip-chars-backward " \t")
896 (bolp))))
897 (let (c-echo-syntactic-information-p) ; shut this up
898 (indent-according-to-mode))
901 (defun c-electric-semi&comma (arg)
902 "Insert a comma or semicolon.
904 If `c-electric-flag' is non-nil, point isn't inside a literal and a
905 numeric ARG hasn't been supplied, the command performs several electric
906 actions:
908 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
909 the mode line) a newline might be inserted. See the variable
910 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
912 \(b) Any auto-newlines are indented. The original line is also
913 reindented unless `c-syntactic-indentation' is nil.
915 \(c) If auto-newline is turned on, a comma following a brace list or a
916 semicolon following a defun might be cleaned up, depending on the
917 settings of `c-cleanup-list'."
918 (interactive "*P")
919 (let* (lim literal c-syntactic-context
920 (here (point))
921 ;; shut this up
922 (c-echo-syntactic-information-p nil))
924 (c-save-buffer-state ()
925 (setq lim (c-most-enclosing-brace (c-parse-state))
926 literal (c-in-literal lim)))
928 (self-insert-command (prefix-numeric-value arg))
930 (if (and c-electric-flag (not literal) (not arg))
931 ;; do all cleanups and newline insertions if c-auto-newline is on.
932 (if (or (not c-auto-newline)
933 (not (looking-at "[ \t]*\\\\?$")))
934 (if c-syntactic-indentation
935 (c-indent-line))
936 ;; clean ups: list-close-comma or defun-close-semi
937 (let ((pos (- (point-max) (point))))
938 (if (c-save-buffer-state ()
939 (and (or (and
940 (eq last-command-char ?,)
941 (memq 'list-close-comma c-cleanup-list))
942 (and
943 (eq last-command-char ?\;)
944 (memq 'defun-close-semi c-cleanup-list)))
945 (progn
946 (forward-char -1)
947 (c-skip-ws-backward)
948 (eq (char-before) ?}))
949 ;; make sure matching open brace isn't in a comment
950 (not (c-in-literal lim))))
951 (delete-region (point) here))
952 (goto-char (- (point-max) pos)))
953 ;; reindent line
954 (when c-syntactic-indentation
955 (setq c-syntactic-context (c-guess-basic-syntax))
956 (c-indent-line c-syntactic-context))
957 ;; check to see if a newline should be added
958 (let ((criteria c-hanging-semi&comma-criteria)
959 answer add-newline-p)
960 (while criteria
961 (setq answer (funcall (car criteria)))
962 ;; only nil value means continue checking
963 (if (not answer)
964 (setq criteria (cdr criteria))
965 (setq criteria nil)
966 ;; only 'stop specifically says do not add a newline
967 (setq add-newline-p (not (eq answer 'stop)))
969 (if add-newline-p
970 (c-newline-and-indent))
971 )))))
973 (defun c-electric-colon (arg)
974 "Insert a colon.
976 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
977 numeric ARG hasn't been supplied, the command performs several electric
978 actions:
980 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
981 the mode line) newlines are inserted before and after the colon based on
982 the settings in `c-hanging-colons-alist'.
984 \(b) Any auto-newlines are indented. The original line is also
985 reindented unless `c-syntactic-indentation' is nil.
987 \(c) If auto-newline is turned on, whitespace between two colons will be
988 \"cleaned up\" leaving a scope operator, if this action is set in
989 `c-cleanup-list'."
991 (interactive "*P")
992 (let* ((bod (c-point 'bod))
993 (literal (c-save-buffer-state () (c-in-literal bod)))
994 newlines is-scope-op
995 ;; shut this up
996 (c-echo-syntactic-information-p nil))
997 (self-insert-command (prefix-numeric-value arg))
998 ;; Any electric action?
999 (if (and c-electric-flag (not literal) (not arg))
1000 ;; Unless we're at EOL, only re-indentation happens.
1001 (if (not (looking-at "[ \t]*\\\\?$"))
1002 (if c-syntactic-indentation
1003 (indent-according-to-mode))
1005 ;; scope-operator clean-up?
1006 (let ((pos (- (point-max) (point)))
1007 (here (point)))
1008 (if (c-save-buffer-state () ; Why do we need this? [ACM, 2003-03-12]
1009 (and c-auto-newline
1010 (memq 'scope-operator c-cleanup-list)
1011 (eq (char-before) ?:)
1012 (progn
1013 (forward-char -1)
1014 (c-skip-ws-backward)
1015 (eq (char-before) ?:))
1016 (not (c-in-literal))
1017 (not (eq (char-after (- (point) 2)) ?:))))
1018 (progn
1019 (delete-region (point) (1- here))
1020 (setq is-scope-op t)))
1021 (goto-char (- (point-max) pos)))
1023 ;; indent the current line if it's done syntactically.
1024 (if c-syntactic-indentation
1025 ;; Cannot use the same syntax analysis as we find below,
1026 ;; since that's made with c-syntactic-indentation-in-macros
1027 ;; always set to t.
1028 (indent-according-to-mode))
1030 ;; Calculate where, if anywhere, we want newlines.
1031 (c-save-buffer-state
1032 ((c-syntactic-indentation-in-macros t)
1033 (c-auto-newline-analysis t)
1034 ;; Turn on syntactic macro analysis to help with auto newlines
1035 ;; only.
1036 (syntax (c-guess-basic-syntax))
1037 (elem syntax))
1038 ;; Translate substatement-label to label for this operation.
1039 (while elem
1040 (if (eq (car (car elem)) 'substatement-label)
1041 (setcar (car elem) 'label))
1042 (setq elem (cdr elem)))
1043 ;; some language elements can only be determined by checking
1044 ;; the following line. Lets first look for ones that can be
1045 ;; found when looking on the line with the colon
1046 (setq newlines
1047 (and c-auto-newline
1048 (or (c-lookup-lists '(case-label label access-label)
1049 syntax c-hanging-colons-alist)
1050 (c-lookup-lists '(member-init-intro inher-intro)
1051 (progn
1052 (insert ?\n)
1053 (unwind-protect
1054 (c-guess-basic-syntax)
1055 (delete-char -1)))
1056 c-hanging-colons-alist)))))
1057 ;; does a newline go before the colon? Watch out for already
1058 ;; non-hung colons. However, we don't unhang them because that
1059 ;; would be a cleanup (and anti-social).
1060 (if (and (memq 'before newlines)
1061 (not is-scope-op)
1062 (save-excursion
1063 (skip-chars-backward ": \t")
1064 (not (bolp))))
1065 (let ((pos (- (point-max) (point))))
1066 (forward-char -1)
1067 (c-newline-and-indent)
1068 (goto-char (- (point-max) pos))))
1069 ;; does a newline go after the colon?
1070 (if (and (memq 'after (cdr-safe newlines))
1071 (not is-scope-op))
1072 (c-newline-and-indent))
1073 ))))
1075 (defun c-electric-lt-gt (arg)
1076 "Insert a \"<\" or \">\" character.
1077 If the current language uses angle bracket parens (e.g. template
1078 arguments in C++), try to find out if the inserted character is a
1079 paren and give it paren syntax if appropriate.
1081 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1082 line will be reindented if the inserted character is a paren or if it
1083 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1084 numeric argument is supplied, or the point is inside a literal."
1086 (interactive "*P")
1087 (let ((c-echo-syntactic-information-p nil)
1088 final-pos close-paren-inserted)
1090 (self-insert-command (prefix-numeric-value arg))
1091 (setq final-pos (point))
1093 (c-save-buffer-state (c-parse-and-markup-<>-arglists
1094 c-restricted-<>-arglists
1095 <-pos)
1097 (when c-recognize-<>-arglists
1098 (if (eq last-command-char ?<)
1099 (when (and (progn
1100 (backward-char)
1101 (= (point)
1102 (progn
1103 (c-beginning-of-current-token)
1104 (point))))
1105 (progn
1106 (c-backward-token-2)
1107 (looking-at c-opt-<>-sexp-key)))
1108 (c-mark-<-as-paren (1- final-pos)))
1110 ;; It's a ">". Check if there's an earlier "<" which either has
1111 ;; open paren syntax already or that can be recognized as an arglist
1112 ;; together with this ">". Note that this won't work in cases like
1113 ;; "template <x, a < b, y>" but they ought to be rare.
1115 (save-restriction
1116 ;; Narrow to avoid that `c-forward-<>-arglist' below searches past
1117 ;; our position.
1118 (narrow-to-region (point-min) final-pos)
1120 (while (and
1121 (progn
1122 (goto-char final-pos)
1123 (c-syntactic-skip-backward "^<;}" nil t)
1124 (eq (char-before) ?<))
1125 (progn
1126 (backward-char)
1127 ;; If the "<" already got open paren syntax we know we
1128 ;; have the matching closer. Handle it and exit the
1129 ;; loop.
1130 (if (looking-at "\\s\(")
1131 (progn
1132 (c-mark->-as-paren (1- final-pos))
1133 (setq close-paren-inserted t)
1134 nil)
1137 (progn
1138 (setq <-pos (point))
1139 (c-backward-syntactic-ws)
1140 (c-simple-skip-symbol-backward))
1141 (or (looking-at c-opt-<>-sexp-key)
1142 (not (looking-at c-keywords-regexp)))
1144 (let ((c-parse-and-markup-<>-arglists t)
1145 c-restricted-<>-arglists
1146 (containing-sexp
1147 (c-most-enclosing-brace (c-parse-state))))
1148 (when (and containing-sexp
1149 (progn (goto-char containing-sexp)
1150 (eq (char-after) ?\())
1151 (not (eq (get-text-property (point) 'c-type)
1152 'c-decl-arg-start)))
1153 (setq c-restricted-<>-arglists t))
1154 (goto-char <-pos)
1155 (c-forward-<>-arglist nil))
1157 ;; Loop here if the "<" we found above belongs to a nested
1158 ;; angle bracket sexp. When we start over we'll find the
1159 ;; previous or surrounding sexp.
1160 (if (< (point) final-pos)
1162 (setq close-paren-inserted t)
1163 nil)))))))
1164 (goto-char final-pos)
1166 ;; Indent the line if appropriate.
1167 (when (and c-electric-flag c-syntactic-indentation)
1168 (backward-char)
1169 (when (prog1 (or (looking-at "\\s\(\\|\\s\)")
1170 (and (c-major-mode-is 'c++-mode)
1171 (progn
1172 (c-beginning-of-current-token)
1173 (looking-at "<<\\|>>"))
1174 (= (match-end 0) final-pos)))
1175 (goto-char final-pos))
1176 (indent-according-to-mode)))
1178 (when (and close-paren-inserted
1179 (not executing-kbd-macro)
1180 blink-paren-function)
1181 ;; Note: Most paren blink functions, such as the standard
1182 ;; `blink-matching-open', currently doesn't handle paren chars
1183 ;; marked with text properties very well. Maybe we should avoid
1184 ;; this call for the time being?
1185 (funcall blink-paren-function))))
1187 (defun c-electric-paren (arg)
1188 "Insert a parenthesis.
1190 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1191 line is reindented unless a numeric ARG is supplied, or the parenthesis
1192 is inserted inside a literal.
1194 Whitespace between a function name and the parenthesis may get added or
1195 removed; see the variable `c-cleanup-list'.
1197 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1198 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1199 (interactive "*P")
1200 (let ((literal (c-save-buffer-state () (c-in-literal)))
1201 ;; shut this up
1202 (c-echo-syntactic-information-p nil))
1203 (self-insert-command (prefix-numeric-value arg))
1205 (if (and (not arg) (not literal))
1206 (let* ( ;; We want to inhibit blinking the paren since this will
1207 ;; be most disruptive. We'll blink it ourselves
1208 ;; afterwards.
1209 (old-blink-paren blink-paren-function)
1210 blink-paren-function)
1211 (if (and c-syntactic-indentation c-electric-flag)
1212 (indent-according-to-mode))
1214 ;; If we're at EOL, check for new-line clean-ups.
1215 (when (and c-electric-flag c-auto-newline
1216 (looking-at "[ \t]*\\\\?$"))
1218 ;; clean up brace-elseif-brace
1219 (when
1220 (and (memq 'brace-elseif-brace c-cleanup-list)
1221 (eq last-command-char ?\()
1222 (re-search-backward
1223 (concat "}"
1224 "\\([ \t\n]\\|\\\\\n\\)*"
1225 "else"
1226 "\\([ \t\n]\\|\\\\\n\\)+"
1227 "if"
1228 "\\([ \t\n]\\|\\\\\n\\)*"
1230 "\\=")
1231 nil t)
1232 (not (c-save-buffer-state () (c-in-literal))))
1233 (delete-region (match-beginning 0) (match-end 0))
1234 (insert-and-inherit "} else if ("))
1236 ;; clean up brace-catch-brace
1237 (when
1238 (and (memq 'brace-catch-brace c-cleanup-list)
1239 (eq last-command-char ?\()
1240 (re-search-backward
1241 (concat "}"
1242 "\\([ \t\n]\\|\\\\\n\\)*"
1243 "catch"
1244 "\\([ \t\n]\\|\\\\\n\\)*"
1246 "\\=")
1247 nil t)
1248 (not (c-save-buffer-state () (c-in-literal))))
1249 (delete-region (match-beginning 0) (match-end 0))
1250 (insert-and-inherit "} catch (")))
1252 ;; Check for clean-ups at function calls. These two DON'T need
1253 ;; `c-electric-flag' or `c-syntactic-indentation' set.
1254 ;; Point is currently just after the inserted paren.
1255 (let (beg (end (1- (point))))
1256 (cond
1258 ;; space-before-funcall clean-up?
1259 ((and (memq 'space-before-funcall c-cleanup-list)
1260 (eq last-command-char ?\()
1261 (save-excursion
1262 (backward-char)
1263 (skip-chars-backward " \t")
1264 (setq beg (point))
1265 (and (c-save-buffer-state () (c-on-identifier))
1266 ;; Don't add a space into #define FOO()....
1267 (not (and (c-beginning-of-macro)
1268 (c-forward-over-cpp-define-id)
1269 (eq (point) beg))))))
1270 (save-excursion
1271 (delete-region beg end)
1272 (goto-char beg)
1273 (insert ?\ )))
1275 ;; compact-empty-funcall clean-up?
1276 ((c-save-buffer-state ()
1277 (and (memq 'compact-empty-funcall c-cleanup-list)
1278 (eq last-command-char ?\))
1279 (save-excursion
1280 (c-safe (backward-char 2))
1281 (when (looking-at "()")
1282 (setq end (point))
1283 (skip-chars-backward " \t")
1284 (setq beg (point))
1285 (c-on-identifier)))))
1286 (delete-region beg end))))
1287 (and (eq last-input-event ?\))
1288 (not executing-kbd-macro)
1289 old-blink-paren
1290 (funcall old-blink-paren))))))
1292 (defun c-electric-continued-statement ()
1293 "Reindent the current line if appropriate.
1295 This function is used to reindent the line after a keyword which
1296 continues an earlier statement is typed, e.g. an \"else\" or the
1297 \"while\" in a do-while block.
1299 The line is reindented if there is nothing but whitespace before the
1300 keyword on the line, the keyword is not inserted inside a literal, and
1301 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1302 (let (;; shut this up
1303 (c-echo-syntactic-information-p nil))
1304 (when (c-save-buffer-state ()
1305 (and c-electric-flag
1306 c-syntactic-indentation
1307 (not (eq last-command-char ?_))
1308 (= (save-excursion
1309 (skip-syntax-backward "w")
1310 (point))
1311 (c-point 'boi))
1312 (not (c-in-literal (c-point 'bod)))))
1313 ;; Have to temporarily insert a space so that
1314 ;; c-guess-basic-syntax recognizes the keyword. Follow the
1315 ;; space with a nonspace to avoid messing up any whitespace
1316 ;; sensitive meddling that might be done, e.g. by
1317 ;; `c-backslash-region'.
1318 (insert-and-inherit " x")
1319 (unwind-protect
1320 (indent-according-to-mode)
1321 (delete-char -2)))))
1324 ;; "nomenclature" functions + c-scope-operator.
1325 (defun c-forward-into-nomenclature (&optional arg)
1326 "Compatibility alias for `c-forward-subword'."
1327 (interactive "p")
1328 (require 'cc-subword)
1329 (c-forward-subword arg))
1330 (make-obsolete 'c-forward-into-nomenclature 'c-forward-subword)
1332 (defun c-backward-into-nomenclature (&optional arg)
1333 "Compatibility alias for `c-backward-subword'."
1334 (interactive "p")
1335 (require 'cc-subword)
1336 (c-backward-subword arg))
1337 (make-obsolete 'c-backward-into-nomenclature 'c-backward-subword)
1339 (defun c-scope-operator ()
1340 "Insert a double colon scope operator at point.
1341 No indentation or other \"electric\" behavior is performed."
1342 (interactive "*")
1343 (insert-and-inherit "::"))
1346 ;; Movement (etc.) by defuns.
1347 (defun c-in-function-trailer-p (&optional lim)
1348 ;; Return non-nil if point is between the closing brace and the semicolon of
1349 ;; a brace construct which needs a semicolon, e.g. within the "variables"
1350 ;; portion of a declaration like "struct foo {...} bar ;".
1352 ;; Return the position of the main declaration. Otherwise, return nil.
1353 ;; Point is assumed to be at the top level and outside of any macro or
1354 ;; literal.
1356 ;; If LIM is non-nil, it is the bound on a the backward search for the
1357 ;; beginning of the declaration.
1359 ;; This function might do hidden buffer changes.
1360 (and c-opt-block-decls-with-vars-key
1361 (save-excursion
1362 (c-syntactic-skip-backward "^;}" lim)
1363 (let ((eo-block (point))
1364 bod)
1365 (and (eq (char-before) ?\})
1366 (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1367 (setq bod (point))
1368 ;; Look for struct or union or ... If we find one, it might
1369 ;; be the return type of a function, or the like. Exclude
1370 ;; this case.
1371 (c-syntactic-re-search-forward
1372 (concat "[;=\(\[{]\\|\\("
1373 c-opt-block-decls-with-vars-key
1374 "\\)")
1375 eo-block t t t)
1376 (match-beginning 1) ; Is there a "struct" etc., somewhere?
1377 (not (eq (char-before) ?_))
1378 (c-syntactic-re-search-forward "[;=\(\[{]" eo-block t t t)
1379 (eq (char-before) ?\{)
1380 bod)))))
1382 (defun c-where-wrt-brace-construct ()
1383 ;; Determine where we are with respect to functions (or other brace
1384 ;; constructs, included in the term "function" in the rest of this comment).
1385 ;; Point is assumed to be outside any macro or literal.
1386 ;; This is used by c-\(begining\|end\)-of-defun.
1388 ;; Return one of these symbols:
1389 ;; at-header : we're at the start of a function's header.
1390 ;; in-header : we're inside a function's header, this extending right
1391 ;; up to the brace. This bit includes any k&r declarations.
1392 ;; in-block : we're inside a function's brace block.
1393 ;; in-trailer : we're in the area between the "}" and ";" of something
1394 ;; like "struct foo {...} bar, baz;".
1395 ;; at-function-end : we're just after the closing brace (or semicolon) that
1396 ;; terminates the function.
1397 ;; outwith-function: we're not at or in any function. Being inside a
1398 ;; non-brace construct also counts as 'outwith-function'.
1400 ;; This function might do hidden buffer changes.
1401 (save-excursion
1402 (let* (kluge-start
1403 decl-result brace-decl-p
1404 (start (point))
1405 (paren-state (c-parse-state))
1406 (least-enclosing (c-least-enclosing-brace paren-state)))
1408 (cond
1409 ((and least-enclosing
1410 (eq (char-after least-enclosing) ?\{))
1411 'in-block)
1412 ((c-in-function-trailer-p)
1413 'in-trailer)
1414 ((and (not least-enclosing)
1415 (consp paren-state)
1416 (consp (car paren-state))
1417 (eq start (cdar paren-state)))
1418 'at-function-end)
1420 ;; Find the start of the current declaration. NOTE: If we're in the
1421 ;; variables after a "struct/eval" type block, we don't get to the
1422 ;; real declaration here - we detect and correct for this later.
1424 ;;If we're in the parameters' parens, move back out of them.
1425 (if least-enclosing (goto-char least-enclosing))
1426 ;; Kluge so that c-beginning-of-decl-1 won't go back if we're already
1427 ;; at a declaration.
1428 (if (or (and (eolp) (not (eobp))) ; EOL is matched by "\\s>"
1429 (not (looking-at
1430 "\\([;#]\\|\\'\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s$\\|\\s<\\|\\s>\\|\\s!\\)")))
1431 (forward-char))
1432 (setq kluge-start (point))
1433 (setq decl-result
1434 (car (c-beginning-of-decl-1
1435 ;; NOTE: If we're in a K&R region, this might be the start
1436 ;; of a parameter declaration, not the actual function.
1437 (and least-enclosing ; LIMIT for c-b-of-decl-1
1438 (c-safe-position least-enclosing paren-state)))))
1440 ;; Has the declaration we've gone back to got braces?
1441 (setq brace-decl-p
1442 (save-excursion
1443 (and (c-syntactic-re-search-forward "[;{]" nil t t)
1444 (or (eq (char-before) ?\{)
1445 (and c-recognize-knr-p
1446 ;; Might have stopped on the
1447 ;; ';' in a K&R argdecl. In
1448 ;; that case the declaration
1449 ;; should contain a block.
1450 (c-in-knr-argdecl))))))
1452 (cond
1453 ((= (point) kluge-start) ; might be BOB or unbalanced parens.
1454 'outwith-function)
1455 ((eq decl-result 'same)
1456 (if brace-decl-p
1457 (if (eq (point) start)
1458 'at-header
1459 'in-header)
1460 'outwith-function))
1461 ((eq decl-result 'previous)
1462 (if (and (not brace-decl-p)
1463 (c-in-function-trailer-p))
1464 'at-function-end
1465 'outwith-function))
1466 (t (error
1467 "c-where-wrt-brace-construct: c-beginning-of-decl-1 returned %s"
1468 decl-result))))))))
1470 (defun c-backward-to-nth-BOF-{ (n where)
1471 ;; Skip to the opening brace of the Nth function before point. If
1472 ;; point is inside a function, this counts as the first. Point must be
1473 ;; outside any comment/string or macro.
1475 ;; N must be strictly positive.
1476 ;; WHERE describes the position of point, one of the symbols `at-header',
1477 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1478 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1480 ;; If we run out of functions, leave point at BOB. Return zero on success,
1481 ;; otherwise the number of {s still to go.
1483 ;; This function may do hidden buffer changes
1484 (cond
1485 ;; What we do to go back the first defun depends on where we start.
1486 ((bobp))
1487 ((eq where 'in-block)
1488 (goto-char (c-least-enclosing-brace (c-parse-state)))
1489 (setq n (1- n)))
1490 ((eq where 'in-header)
1491 (c-syntactic-re-search-forward "{")
1492 (backward-char)
1493 (setq n (1- n)))
1494 ((memq where '(at-header outwith-function at-function-end in-trailer))
1495 (c-syntactic-skip-backward "^}")
1496 (when (eq (char-before) ?\})
1497 (backward-sexp)
1498 (setq n (1- n))))
1499 (t (error "Unknown `where' %s in c-backward-to-nth-EOF-{" where)))
1501 ;; Each time round the loop, go back to a "{" at the outermost level.
1502 (while (and (> n 0) (not (bobp)))
1503 (c-parse-state) ; This call speeds up the following one
1504 ; by a factor of ~6. Hmmm. 2006/4/5.
1505 (c-syntactic-skip-backward "^}")
1506 (when (eq (char-before) ?\})
1507 (backward-sexp)
1508 (setq n (1- n))))
1511 (defun c-beginning-of-defun (&optional arg)
1512 "Move backward to the beginning of a defun.
1513 Every top level declaration that contains a brace paren block is
1514 considered to be a defun.
1516 With a positive argument, move backward that many defuns. A negative
1517 argument -N means move forward to the Nth following beginning. Return
1518 t unless search stops due to beginning or end of buffer.
1520 Unlike the built-in `beginning-of-defun' this tries to be smarter
1521 about finding the char with open-parenthesis syntax that starts the
1522 defun."
1524 (interactive "p")
1525 (or arg (setq arg 1))
1527 (c-save-buffer-state
1528 (beginning-of-defun-function end-of-defun-function
1529 (start (point))
1530 where paren-state pos)
1532 ;; Move back out of any macro/comment/string we happen to be in.
1533 (c-beginning-of-macro)
1534 (setq pos (c-literal-limits))
1535 (if pos (goto-char (car pos)))
1537 (setq where (c-where-wrt-brace-construct))
1539 (if (< arg 0)
1540 ;; Move forward to the closing brace of a function.
1541 (progn
1542 (if (memq where '(at-function-end outwith-function))
1543 (setq arg (1+ arg)))
1544 (if (< arg 0)
1545 (setq arg (c-forward-to-nth-EOF-} (- arg) where)))
1546 ;; Move forward to the next opening brace....
1547 (when (and (= arg 0)
1548 (c-syntactic-re-search-forward "{" nil 'eob))
1549 (backward-char)
1550 ;; ... and backward to the function header.
1551 (c-beginning-of-decl-1)
1554 ;; Move backward to the opening brace of a function.
1555 (when (and (> arg 0)
1556 (eq (setq arg (c-backward-to-nth-BOF-{ arg where)) 0))
1558 ;; Go backward to this function's header.
1559 (c-beginning-of-decl-1)
1561 (setq pos (point))
1562 ;; We're now there, modulo comments and whitespace.
1563 ;; Try to be line oriented; position point at the closest
1564 ;; preceding boi that isn't inside a comment, but if we hit
1565 ;; the previous declaration then we use the current point
1566 ;; instead.
1567 (while (and (/= (point) (c-point 'boi))
1568 (c-backward-single-comment)))
1569 (if (/= (point) (c-point 'boi))
1570 (goto-char pos)))
1572 (c-keep-region-active)
1573 (= arg 0))))
1575 (defun c-forward-to-nth-EOF-} (n where)
1576 ;; Skip to the closing brace of the Nth function after point. If
1577 ;; point is inside a function, this counts as the first. Point must be
1578 ;; outside any comment/string or macro.
1580 ;; N must be strictly positive.
1581 ;; WHERE describes the position of point, one of the symbols `at-header',
1582 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1583 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1585 ;; If we run out of functions, leave point at EOB. Return zero on success,
1586 ;; otherwise the number of }s still to go.
1588 ;; This function may do hidden buffer changes.
1590 (cond
1591 ;; What we do to go forward over the first defun depends on where we
1592 ;; start. We go to the closing brace of that defun, even when we go
1593 ;; backwards to it (in a "struct foo {...} bar ;").
1594 ((eobp))
1595 ((eq where 'in-block)
1596 (goto-char (c-least-enclosing-brace (c-parse-state)))
1597 (forward-sexp)
1598 (setq n (1- n)))
1599 ((eq where 'in-trailer)
1600 (c-syntactic-skip-backward "^}")
1601 (setq n (1- n)))
1602 ((memq where '(at-function-end outwith-function at-header in-header))
1603 (when (c-syntactic-re-search-forward "{" nil 'eob)
1604 (backward-char)
1605 (forward-sexp)
1606 (setq n (1- n))))
1607 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1609 ;; Each time round the loop, go forward to a "}" at the outermost level.
1610 (while (and (> n 0) (not (eobp)))
1611 ;(c-parse-state) ; This call speeds up the following one by a factor
1612 ; of ~6. Hmmm. 2006/4/5.
1613 (when (c-syntactic-re-search-forward "{" nil 'eob)
1614 (backward-char)
1615 (forward-sexp))
1616 (setq n (1- n)))
1619 (defun c-end-of-defun (&optional arg)
1620 "Move forward to the end of a top level declaration.
1621 With argument, do it that many times. Negative argument -N means move
1622 back to Nth preceding end. Returns t unless search stops due to
1623 beginning or end of buffer.
1625 An end of a defun occurs right after the close-parenthesis that matches
1626 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1627 (interactive "p")
1628 (or arg (setq arg 1))
1630 (c-save-buffer-state
1631 (beginning-of-defun-function end-of-defun-function
1632 (start (point))
1633 where paren-state pos)
1635 ;; Move back out of any macro/comment/string we happen to be in.
1636 (c-beginning-of-macro)
1637 (setq pos (c-literal-limits))
1638 (if pos (goto-char (car pos)))
1640 (setq where (c-where-wrt-brace-construct))
1642 (if (< arg 0)
1643 ;; Move backwards to the } of a function
1644 (progn
1645 (if (memq where '(at-header outwith-function))
1646 (setq arg (1+ arg)))
1647 (if (< arg 0)
1648 (setq arg (c-backward-to-nth-BOF-{ (- arg) where)))
1649 (if (= arg 0)
1650 (c-syntactic-skip-backward "^}")))
1652 ;; Move forward to the } of a function
1653 (if (> arg 0)
1654 (setq arg (c-forward-to-nth-EOF-} arg where))))
1656 ;; Do we need to move forward from the brace to the semicolon?
1657 (when (eq arg 0)
1658 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1659 (c-syntactic-re-search-forward ";"))
1661 (setq pos (point))
1662 ;; We're there now, modulo comments and whitespace.
1663 ;; Try to be line oriented; position point after the next
1664 ;; newline that isn't inside a comment, but if we hit the
1665 ;; next declaration then we use the current point instead.
1666 (while (and (not (bolp))
1667 (not (looking-at "\\s *$"))
1668 (c-forward-single-comment)))
1669 (cond ((bolp))
1670 ((looking-at "\\s *$")
1671 (forward-line 1))
1673 (goto-char pos))))
1675 (c-keep-region-active)
1676 (= arg 0)))
1678 (defun c-declaration-limits (near)
1679 ;; Return a cons of the beginning and end positions of the current
1680 ;; top level declaration or macro. If point is not inside any then
1681 ;; nil is returned, unless NEAR is non-nil in which case the closest
1682 ;; following one is chosen instead (if there is any). The end
1683 ;; position is at the next line, providing there is one before the
1684 ;; declaration.
1686 ;; This function might do hidden buffer changes.
1687 (save-excursion
1689 ;; Note: Some code duplication in `c-beginning-of-defun' and
1690 ;; `c-end-of-defun'.
1691 (catch 'exit
1692 (let ((start (point))
1693 (paren-state (c-parse-state))
1694 lim pos end-pos)
1695 (unless (c-safe
1696 (goto-char (c-least-enclosing-brace paren-state))
1697 ;; If we moved to the outermost enclosing paren then we
1698 ;; can use c-safe-position to set the limit. Can't do
1699 ;; that otherwise since the earlier paren pair on
1700 ;; paren-state might very well be part of the
1701 ;; declaration we should go to.
1702 (setq lim (c-safe-position (point) paren-state))
1704 ;; At top level. Make sure we aren't inside a literal.
1705 (setq pos (c-literal-limits
1706 (c-safe-position (point) paren-state)))
1707 (if pos (goto-char (car pos))))
1709 (when (c-beginning-of-macro)
1710 (throw 'exit
1711 (cons (point)
1712 (save-excursion
1713 (c-end-of-macro)
1714 (forward-line 1)
1715 (point)))))
1717 (setq pos (point))
1718 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1719 (= pos (point)))
1720 ;; We moved back over the previous defun. Skip to the next
1721 ;; one. Not using c-forward-syntactic-ws here since we
1722 ;; should not skip a macro. We can also be directly after
1723 ;; the block in a `c-opt-block-decls-with-vars-key'
1724 ;; declaration, but then we won't move significantly far
1725 ;; here.
1726 (goto-char pos)
1727 (c-forward-comments)
1729 (when (and near (c-beginning-of-macro))
1730 (throw 'exit
1731 (cons (point)
1732 (save-excursion
1733 (c-end-of-macro)
1734 (forward-line 1)
1735 (point))))))
1737 (if (eobp) (throw 'exit nil))
1739 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1740 ;; declaration that doesn't end there. We're searching back and
1741 ;; forth over the block here, which can be expensive.
1742 (setq pos (point))
1743 (if (and c-opt-block-decls-with-vars-key
1744 (progn
1745 (c-backward-syntactic-ws)
1746 (eq (char-before) ?}))
1747 (eq (car (c-beginning-of-decl-1))
1748 'previous)
1749 (save-excursion
1750 (c-end-of-decl-1)
1751 (and (> (point) pos)
1752 (setq end-pos (point)))))
1754 (goto-char pos))
1756 (if (and (not near) (> (point) start))
1759 ;; Try to be line oriented; position the limits at the
1760 ;; closest preceding boi, and after the next newline, that
1761 ;; isn't inside a comment, but if we hit a neighboring
1762 ;; declaration then we instead use the exact declaration
1763 ;; limit in that direction.
1764 (cons (progn
1765 (setq pos (point))
1766 (while (and (/= (point) (c-point 'boi))
1767 (c-backward-single-comment)))
1768 (if (/= (point) (c-point 'boi))
1770 (point)))
1771 (progn
1772 (if end-pos
1773 (goto-char end-pos)
1774 (c-end-of-decl-1))
1775 (setq pos (point))
1776 (while (and (not (bolp))
1777 (not (looking-at "\\s *$"))
1778 (c-forward-single-comment)))
1779 (cond ((bolp)
1780 (point))
1781 ((looking-at "\\s *$")
1782 (forward-line 1)
1783 (point))
1785 pos)))))
1786 ))))
1788 (defun c-mark-function ()
1789 "Put mark at end of the current top-level declaration or macro, point at beginning.
1790 If point is not inside any then the closest following one is chosen.
1792 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1793 function does not require the declaration to contain a brace block."
1794 (interactive)
1796 (let (decl-limits)
1797 (c-save-buffer-state nil
1798 ;; We try to be line oriented, unless there are several
1799 ;; declarations on the same line.
1800 (if (looking-at c-syntactic-eol)
1801 (c-backward-token-2 1 nil (c-point 'bol)))
1802 (setq decl-limits (c-declaration-limits t)))
1804 (if (not decl-limits)
1805 (error "Cannot find any declaration")
1806 (goto-char (car decl-limits))
1807 (push-mark (cdr decl-limits) nil t))))
1810 ;; Movement by statements.
1811 (defun c-in-comment-line-prefix-p ()
1812 ;; Point is within a comment. Is it also within a comment-prefix?
1813 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1815 ;; This function might do hidden buffer changes.
1816 (let ((here (point)))
1817 (save-excursion
1818 (beginning-of-line)
1819 (skip-chars-forward " \t")
1820 (and (looking-at c-current-comment-prefix)
1821 (/= (match-beginning 0) (match-end 0))
1822 (< here (match-end 0))))))
1824 (defun c-narrow-to-comment-innards (range)
1825 ;; Narrow to the "inside" of the comment (block) defined by range, as
1826 ;; follows:
1828 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
1829 ;; present) removed. A c++-style line comment retains its opening "//" but
1830 ;; has any final NL removed. If POINT is currently outwith these innards,
1831 ;; move it to the appropriate boundary.
1833 ;; This narrowing simplifies the sentence movement functions, since it
1834 ;; eliminates awkward things at the boundaries of the comment (block).
1836 ;; This function might do hidden buffer changes.
1837 (let* ((lit-type (c-literal-type range))
1838 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
1839 (end (if (eq lit-type 'c)
1840 (if (and (eq (char-before (cdr range)) ?/)
1841 (eq (char-before (1- (cdr range))) ?*))
1842 (- (cdr range) 2)
1843 (point-max))
1844 (if (eq (cdr range) (point-max))
1845 (point-max)
1846 (- (cdr range) 1)))))
1847 (if (> (point) end)
1848 (goto-char end)) ; This would be done automatically by ...
1849 (if (< (point) beg)
1850 (goto-char beg)) ; ... narrow-to-region but is not documented.
1851 (narrow-to-region beg end)))
1853 (defun c-beginning-of-sentence-in-comment (range)
1854 ;; Move backwards to the "beginning of a sentence" within the comment
1855 ;; defined by RANGE, a cons of its starting and ending positions. If we
1856 ;; find a BOS, return NIL. Otherwise, move point to just before the start
1857 ;; of the comment and return T.
1859 ;; The BOS is either text which follows a regexp match of sentence-end,
1860 ;; or text which is a beginning of "paragraph".
1861 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
1863 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1864 ;; It is not a general function, but is intended only for calling from
1865 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
1867 ;; This function might do hidden buffer changes.
1868 (save-match-data
1869 (let ((start-point (point)))
1870 (save-restriction
1871 (c-narrow-to-comment-innards range) ; This may move point back.
1872 (let* ((here (point))
1873 last
1874 (here-filler ; matches WS and comment-prefices at point.
1875 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
1876 "\\|[ \t\n\r\f]\\)*"))
1877 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
1878 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
1879 ;; First, find the previous paragraph start, if any.
1880 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
1881 (save-excursion
1882 (forward-paragraph -1) ; uses cc-mode values of
1883 ; paragraph-\(start\|separate\)
1884 (if (> (re-search-forward here-filler nil t) here)
1885 (goto-char here))
1886 (when (>= (point) here)
1887 (forward-paragraph -2)
1888 (if (> (re-search-forward here-filler nil t) here)
1889 (goto-char here)))
1890 (point))))
1892 ;; Now seek successively earlier sentence ends between PAR-BEG and
1893 ;; HERE, until the "start of sentence" following it is earlier than
1894 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
1895 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
1896 (setq last (point))
1897 (goto-char (match-end 0)) ; tentative beginning of sentence
1898 (or (>= (point) here)
1899 (and (not (bolp)) ; Found a non-blank comment-prefix?
1900 (save-excursion
1901 (if (re-search-backward prefix-at-bol-here nil t)
1902 (/= (match-beginning 1) (match-end 1)))))
1903 (progn ; Skip the crud to find a real b-o-s.
1904 (if (c-in-comment-line-prefix-p)
1905 (beginning-of-line))
1906 (re-search-forward here-filler) ; always succeeds.
1907 (>= (point) here))))
1908 (goto-char last))
1909 (re-search-forward here-filler)))
1911 (if (< (point) start-point)
1913 (goto-char (car range))
1914 t))))
1916 (defun c-end-of-sentence-in-comment (range)
1917 ;; Move forward to the "end of a sentence" within the comment defined by
1918 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
1919 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
1920 ;; return NIL. Otherwise, move point to just after the end of the comment
1921 ;; and return T.
1923 ;; The EOS is just after the non-WS part of the next match of the regexp
1924 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
1925 ;; no sentence-end match following point, any WS before the end of the
1926 ;; comment will count as EOS, providing we're not already in it.
1928 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1929 ;; It is not a general function, but is intended only for calling from
1930 ;; c-move-over-sentence.
1932 ;; This function might do hidden buffer changes.
1933 (save-match-data
1934 (let ((start-point (point))
1935 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
1937 (save-restriction
1938 (c-narrow-to-comment-innards range) ; This might move point forwards.
1939 (let* ((here (point))
1940 (par-end ; EOL position of last text in current/next paragraph.
1941 (save-excursion
1942 ;; The cc-mode values of paragraph-\(start\|separate\), set
1943 ;; in c-setup-paragraph-variables, are used in the
1944 ;; following.
1945 (forward-paragraph 1)
1946 (if (eq (preceding-char) ?\n) (forward-char -1))
1947 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
1948 (goto-char here)
1949 (forward-paragraph 2)
1950 (if (eq (preceding-char) ?\n) (forward-char -1)))
1951 (point)))
1953 last
1954 (prefix-at-bol-here
1955 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
1956 ;; Go forward one "comment-prefix which looks like sentence-end"
1957 ;; each time round the following:
1958 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
1959 (progn
1960 (setq last (point))
1961 (skip-chars-backward " \t\n")
1962 (or (and (not (bolp))
1963 (re-search-backward prefix-at-bol-here nil t)
1964 (/= (match-beginning 1) (match-end 1)))
1965 (<= (point) here))))
1966 (goto-char last))
1968 ;; Take special action if we're up against the end of a comment (of
1969 ;; either sort): Leave point just after the last non-ws text.
1970 (if (eq (point) (point-max))
1971 (while (or (/= (skip-chars-backward " \t\n") 0)
1972 (and (re-search-backward prefix-at-bol-here nil t)
1973 (/= (match-beginning 1) (match-end 1))))))))
1975 (if (> (point) start-point)
1977 (goto-char (cdr range))
1978 t))))
1980 (defun c-beginning-of-sentence-in-string (range)
1981 ;; Move backwards to the "beginning of a sentence" within the string defined
1982 ;; by RANGE, a cons of its starting and ending positions (enclosing the
1983 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
1984 ;; just before the start of the string and return T.
1986 ;; The BOS is either the text which follows a regexp match of sentence-end
1987 ;; or text which is a beginning of "paragraph". For the purposes of
1988 ;; determining paragraph boundaries, escaped newlines are treated as
1989 ;; ordinary newlines.
1991 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1992 ;; It is not a general function, but is intended only for calling from
1993 ;; c-move-over-sentence.
1995 ;; This function might do hidden buffer changes.
1996 (save-match-data
1997 (let* ((here (point)) last
1998 (end (1- (cdr range)))
1999 (here-filler ; matches WS and escaped newlines at point.
2000 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2001 ;; Enhance paragraph-start and paragraph-separate also to recognise
2002 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2003 ;; these values should be customizable user options, or something.
2004 (paragraph-start c-string-par-start)
2005 (paragraph-separate c-string-par-separate)
2007 (par-beg ; beginning of current (or previous) paragraph.
2008 (save-excursion
2009 (save-restriction
2010 (narrow-to-region (1+ (car range)) end)
2011 (forward-paragraph -1) ; uses above values of
2012 ; paragraph-\(start\|separate\)
2013 (if (> (re-search-forward here-filler nil t) here)
2014 (goto-char here))
2015 (when (>= (point) here)
2016 (forward-paragraph -2)
2017 (if (> (re-search-forward here-filler nil t) here)
2018 (goto-char here)))
2019 (point)))))
2020 ;; Now see if we can find a sentence end after PAR-BEG.
2021 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2022 (setq last (point))
2023 (goto-char (match-end 0))
2024 (or (> (point) end)
2025 (progn
2026 (re-search-forward
2027 here-filler end t) ; always succeeds. Use end rather
2028 ; than here, in case point starts
2029 ; beyond the closing quote.
2030 (>= (point) here))))
2031 (goto-char last))
2032 (re-search-forward here-filler here t)
2033 (if (< (point) here)
2035 (goto-char (car range))
2036 t))))
2038 (defun c-end-of-sentence-in-string (range)
2039 ;; Move forward to the "end of a sentence" within the string defined by
2040 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2041 ;; return NIL. Otherwise, move point to just after the end of the string
2042 ;; and return T.
2044 ;; The EOS is just after the non-WS part of the next match of the regexp
2045 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2046 ;; no sentence-end match following point, any WS before the end of the
2047 ;; string will count as EOS, providing we're not already in it.
2049 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2050 ;; It is not a general function, but is intended only for calling from
2051 ;; c-move-over-sentence.
2053 ;; This function might do hidden buffer changes.
2054 (save-match-data
2055 (let* ((here (point))
2056 last
2057 ;; Enhance paragraph-start and paragraph-separate to recognise
2058 ;; blank lines terminated by escaped EOLs.
2059 (paragraph-start c-string-par-start)
2060 (paragraph-separate c-string-par-separate)
2062 (par-end ; EOL position of last text in current/next paragraph.
2063 (save-excursion
2064 (save-restriction
2065 (narrow-to-region (car range) (1- (cdr range)))
2066 ;; The above values of paragraph-\(start\|separate\) are used
2067 ;; in the following.
2068 (forward-paragraph 1)
2069 (setq last (point))
2070 ;; (re-search-backward filler-here nil t) would find an empty
2071 ;; string. Therefore we simulate it by the following:
2072 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2073 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2074 (unless (> (point) here)
2075 (goto-char last)
2076 (forward-paragraph 1)
2077 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2078 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2079 (point)))))
2080 ;; Try to go forward a sentence.
2081 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2082 (setq last (point))
2083 (while (or (/= (skip-chars-backward " \t\n") 0)
2084 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2085 ;; Did we move a sentence, or did we hit the end of the string?
2086 (if (> (point) here)
2088 (goto-char (cdr range))
2089 t))))
2091 (defun c-ascertain-preceding-literal ()
2092 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2093 ;; If a literal is the next thing (aside from whitespace) to be found before
2094 ;; point, return a cons of its start.end positions (enclosing the
2095 ;; delimiters). Otherwise return NIL.
2097 ;; This function might do hidden buffer changes.
2098 (save-excursion
2099 (c-collect-line-comments
2100 (let ((here (point))
2101 pos)
2102 (if (c-backward-single-comment)
2103 (cons (point) (progn (c-forward-single-comment) (point)))
2104 (save-restriction
2105 ;; to prevent `looking-at' seeing a " at point.
2106 (narrow-to-region (point-min) here)
2107 (when
2109 ;; An EOL can act as an "open string" terminator in AWK.
2110 (looking-at c-ws*-string-limit-regexp)
2111 (and (not (bobp))
2112 (progn (backward-char)
2113 (looking-at c-string-limit-regexp))))
2114 (goto-char (match-end 0)) ; just after the string terminator.
2115 (setq pos (point))
2116 (c-safe (c-backward-sexp 1) ; move back over the string.
2117 (cons (point) pos)))))))))
2119 (defun c-ascertain-following-literal ()
2120 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2121 ;; If a literal is the next thing (aside from whitespace) following point,
2122 ;; return a cons of its start.end positions (enclosing the delimiters).
2123 ;; Otherwise return NIL.
2125 ;; This function might do hidden buffer changes.
2126 (save-excursion
2127 (c-collect-line-comments
2128 (let (pos)
2129 (c-skip-ws-forward)
2130 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2131 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2132 (point-max)))
2133 (setq pos (point))
2134 (if (c-forward-single-comment)
2135 (cons pos (point))))))))
2137 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2138 ;; Does point immediately follow a statement "terminator"? A virtual
2139 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2141 ;; This function might do hidden buffer changes.
2142 (or (save-excursion
2143 (backward-char)
2144 (and (looking-at "[;{}]")
2145 (not (and c-special-brace-lists ; Pike special brace lists.
2146 (eq (char-after) ?{)
2147 (c-looking-at-special-brace-list)))))
2148 (c-at-vsemi-p)
2149 ;; The following (for macros) is not strict about exactly where we are
2150 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2151 ;; much. ACM 2004/3/29.
2152 (let (eom)
2153 (save-excursion
2154 (if (c-beginning-of-macro)
2155 (setq eom (progn (c-end-of-macro)
2156 (point)))))
2157 (when eom
2158 (save-excursion
2159 (c-forward-comments)
2160 (>= (point) eom))))))
2162 (defun c-back-over-illiterals (macro-start)
2163 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2164 ;; stopping before reaching BOB or a literal or the boundary of a
2165 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2166 ;; the position of the '#' beginning the current preprocessor directive, or
2167 ;; NIL if we're not in such.
2169 ;; Return a cons (A.B), where
2170 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2171 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2172 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2173 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2175 ;; The total collection of returned values is as follows:
2176 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2177 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2178 ;; a BOS - the caller must check this.
2179 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2180 ;; moved and reached the opening # of the macro.
2181 ;; (t . macro-boundary): Every other circumstance in which we're at a
2182 ;; macro-boundary. We might be at a BOS.
2184 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2185 ;; code before encountering the literal/BOB or macro-boundary.
2187 ;; Note that this function moves within either preprocessor commands
2188 ;; (macros) or normal code, but will not cross a boundary between the two,
2189 ;; or between two distinct preprocessor commands.
2191 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2192 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2193 ;; move into parens. Also stop before `#' when it's at boi on a line.
2195 ;; This function might do hidden buffer changes.
2196 (save-match-data
2197 (let ((here (point))
2198 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2199 ; semicolon precedes it.
2200 (catch 'done
2201 (while t ;; We go back one "token" each iteration of the loop.
2202 (setq last (point))
2203 (cond
2204 ;; Stop at the token after a comment.
2205 ((c-backward-single-comment) ; Also functions as backwards-ws.
2206 (goto-char last)
2207 (throw 'done '(t . literal)))
2209 ;; If we've gone back over a LF, we might have moved into or out of
2210 ;; a preprocessor line.
2211 ((and (save-excursion
2212 (beginning-of-line)
2213 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2214 (if macro-start
2215 (< (point) macro-start)
2216 (c-beginning-of-macro)))
2217 (goto-char last)
2218 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2219 (throw 'done (cons (or (eq (point) here)
2220 (not macro-start))
2221 'macro-boundary)))
2223 ;; Have we found a virtual semicolon? If so, stop, unless the next
2224 ;; statement is where we started from.
2225 ((and (c-at-vsemi-p)
2226 (< last here)
2227 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2228 (goto-char last)
2229 (throw 'done '(nil . nil)))
2231 ;; Hit the beginning of the buffer/region?
2232 ((bobp)
2233 (if (/= here last)
2234 (goto-char last))
2235 (throw 'done '(nil . nil)))
2237 ;; Move back a character.
2238 ((progn (backward-char) nil))
2240 ;; Stop at "{" (unless it's a PIKE special brace list.)
2241 ((eq (char-after) ?\{)
2242 (if (and c-special-brace-lists
2243 (c-looking-at-special-brace-list))
2244 (skip-syntax-backward "w_") ; Speedup only.
2245 (if (/= here last)
2246 (goto-char last))
2247 (throw 'done '(nil . nil))))
2249 ;; Have we reached the start of a macro? This always counts as
2250 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2251 ;; here. FIXME!!! ACM 2004/3/29)
2252 ((and macro-start (eq (point) macro-start))
2253 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2255 ;; Stop at token just after "}" or ";".
2256 ((looking-at "[;}]")
2257 ;; If we've gone back over ;, {, or }, we're done.
2258 (if (or (= here last)
2259 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2260 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2261 (eq (char-after) ?\;))
2262 (backward-char))
2263 (goto-char last) ; To the statement starting after the ; or }.
2264 (throw 'done '(nil . nil))))
2266 ;; Stop at the token after a string.
2267 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2268 (goto-char last)
2269 (throw 'done '(t . literal)))
2271 ;; Nothing special: go back word characters.
2272 (t (skip-syntax-backward "w_")) ; Speedup only.
2273 ))))))
2275 (defun c-forward-over-illiterals (macro-end allow-early-stop)
2276 ;; Move forwards over code, stopping before reaching EOB or a literal
2277 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2278 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2279 ;; terminates the current preprocessor directive, or NIL if we're not in
2280 ;; such.
2282 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2283 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2284 ;; seems unavoidable. Depending on the context this function is called
2285 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2286 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2287 ;; semicolons, or anything else.
2289 ;; Return a cons (A.B), where
2290 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2291 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2292 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2293 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2295 ;; Point is left either after the end-of-statement, or at the last non-ws
2296 ;; code before encountering the literal, or the # of the preprocessor
2297 ;; statement, or at EOB [or just after last non-WS stuff??].
2299 ;; As a clarification of "after the end-of-statement", if a comment or
2300 ;; whitespace follows a completed AWK statement, that statement is treated
2301 ;; as ending just after the last non-ws character before the comment.
2303 ;; Note that this function moves within either preprocessor commands
2304 ;; (macros) or normal code, but not both within the same invocation.
2306 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2307 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2308 ;; stop before `{' if at top level or inside braces, though. Move by
2309 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2310 ;; the boi.
2312 ;; This function might do hidden buffer changes.
2313 (let ((here (point))
2314 last)
2315 (catch 'done
2316 (while t ;; We go one "token" forward each time round this loop.
2317 (setq last (point))
2319 ;; If we've moved forward to a virtual semicolon, we're done.
2320 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2321 (c-at-vsemi-p))
2322 (throw 'done '(nil . nil)))
2324 (c-skip-ws-forward)
2325 (cond
2326 ;; Gone past the end of a macro?
2327 ((and macro-end (> (point) macro-end))
2328 (goto-char last)
2329 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2331 ;; About to hit a comment?
2332 ((save-excursion (c-forward-single-comment))
2333 (goto-char last)
2334 (throw 'done '(t . literal)))
2336 ;; End of buffer?
2337 ((eobp)
2338 (if (/= here last)
2339 (goto-char last))
2340 (throw 'done '(nil . nil)))
2342 ;; If we encounter a '{', stop just after the previous token.
2343 ((and (eq (char-after) ?{)
2344 (not (and c-special-brace-lists
2345 (c-looking-at-special-brace-list)))
2346 (or allow-early-stop (/= here last))
2347 (save-excursion ; Is this a check that we're NOT at top level?
2348 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2349 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2350 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2351 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2352 (or (not (c-safe (up-list -1) t))
2353 (= (char-after) ?{))))
2354 (goto-char last)
2355 (throw 'done '(nil . nil)))
2357 ;; End of a PIKE special brace list? If so, step over it and continue.
2358 ((and c-special-brace-lists
2359 (eq (char-after) ?})
2360 (save-excursion
2361 (and (c-safe (up-list -1) t)
2362 (c-looking-at-special-brace-list))))
2363 (forward-char)
2364 (skip-syntax-forward "w_")) ; Speedup only.
2366 ;; Have we got a '}' after having moved? If so, stop after the
2367 ;; previous token.
2368 ((and (eq (char-after) ?})
2369 (/= here last))
2370 (goto-char last)
2371 (throw 'done '(nil . nil)))
2373 ;; Stop if we encounter a preprocessor line.
2374 ((and (not macro-end)
2375 (eq (char-after) ?#)
2376 (= (point) (c-point 'boi)))
2377 (goto-char last)
2378 ;(throw 'done (cons (eq (point) here) 'macro-boundary))) ; Changed 2003/3/26
2379 (throw 'done '(t . macro-boundary)))
2381 ;; Stop after a ';', '}', or "};"
2382 ((looking-at ";\\|};?")
2383 (goto-char (match-end 0))
2384 (throw 'done '(nil . nil)))
2386 ;; Found a string (this subsumes AWK regexps)?
2387 ((looking-at c-string-limit-regexp)
2388 (goto-char last)
2389 (throw 'done '(t . literal)))
2392 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2393 (skip-syntax-forward "w_") ; Speedup only.
2394 (when (and macro-end (> (point) macro-end))
2395 (goto-char last)
2396 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2397 )))))
2399 (defun c-one-line-string-p (range)
2400 ;; Is the literal defined by RANGE a string contained in a single line?
2402 ;; This function might do hidden buffer changes.
2403 (save-excursion
2404 (goto-char (car range))
2405 (and (looking-at c-string-limit-regexp)
2406 (progn (skip-chars-forward "^\n" (cdr range))
2407 (eq (point) (cdr range))))))
2409 (defun c-beginning-of-statement (&optional count lim sentence-flag)
2410 "Go to the beginning of the innermost C statement.
2411 With prefix arg, go back N - 1 statements. If already at the
2412 beginning of a statement then go to the beginning of the closest
2413 preceding one, moving into nested blocks if necessary (use
2414 \\[backward-sexp] to skip over a block). If within or next to a
2415 comment or multiline string, move by sentences instead of statements.
2417 When called from a program, this function takes 3 optional args: the
2418 repetition count, a buffer position limit which is the farthest back
2419 to search for the syntactic context, and a flag saying whether to do
2420 sentence motion in or near comments and multiline strings.
2422 Note that for use in programs, `c-beginning-of-statement-1' is
2423 usually better. It has much better defined semantics than this one,
2424 which is intended for interactive use, and might therefore change to
2425 be more \"DWIM:ey\"."
2426 (interactive (list (prefix-numeric-value current-prefix-arg)
2427 nil t))
2428 (if (< count 0)
2429 (c-end-of-statement (- count) lim sentence-flag)
2430 (c-save-buffer-state
2431 ((count (or count 1))
2432 last ; start point for going back ONE chunk. Updated each chunk movement.
2433 (macro-fence
2434 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2435 res ; result from sub-function call
2436 not-bos ; "not beginning-of-statement"
2437 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2439 ;; Go back one statement at each iteration of the following loop.
2440 (while (and (/= count 0)
2441 (or (not lim) (> (point) lim)))
2442 ;; Go back one "chunk" each time round the following loop, stopping
2443 ;; when we reach a statement boundary, etc.
2444 (setq last (point))
2445 (while
2446 (cond ; Each arm of this cond returns NIL on reaching a desired
2447 ; statement boundary, non-NIL otherwise.
2448 ((bobp)
2449 (setq count 0)
2450 nil)
2452 (range ; point is within or approaching a literal.
2453 (cond
2454 ;; Single line string or sentence-flag is null => skip the
2455 ;; entire literal.
2456 ((or (null sentence-flag)
2457 (c-one-line-string-p range))
2458 (goto-char (car range))
2459 (setq range (c-ascertain-preceding-literal))
2460 ;; N.B. The following is essentially testing for an AWK regexp
2461 ;; at BOS:
2462 ;; Was the previous non-ws thing an end of statement?
2463 (save-excursion
2464 (if macro-fence
2465 (c-backward-comments)
2466 (c-backward-syntactic-ws))
2467 (not (or (bobp) (c-after-statement-terminator-p)))))
2469 ;; Comment inside a statement or a multi-line string.
2470 (t (when (setq res ; returns non-nil when we go out of the literal
2471 (if (eq (c-literal-type range) 'string)
2472 (c-beginning-of-sentence-in-string range)
2473 (c-beginning-of-sentence-in-comment range)))
2474 (setq range (c-ascertain-preceding-literal)))
2475 res)))
2477 ;; Non-literal code.
2478 (t (setq res (c-back-over-illiterals macro-fence))
2479 (setq not-bos ; "not reached beginning-of-statement".
2480 (or (= (point) last)
2481 (memq (char-after) '(?\) ?\}))
2482 (and
2483 (car res)
2484 ;; We're at a tentative BOS. The next form goes
2485 ;; back over WS looking for an end of previous
2486 ;; statement.
2487 (not (save-excursion
2488 (if macro-fence
2489 (c-backward-comments)
2490 (c-backward-syntactic-ws))
2491 (or (bobp) (c-after-statement-terminator-p)))))))
2492 ;; Are we about to move backwards into or out of a
2493 ;; preprocessor command? If so, locate it's beginning.
2494 (when (eq (cdr res) 'macro-boundary)
2495 (save-excursion
2496 (beginning-of-line)
2497 (setq macro-fence
2498 (and (not (bobp))
2499 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2500 (point)))))
2501 ;; Are we about to move backwards into a literal?
2502 (when (memq (cdr res) '(macro-boundary literal))
2503 (setq range (c-ascertain-preceding-literal)))
2504 not-bos))
2505 (setq last (point)))
2507 (if (/= count 0) (setq count (1- count))))
2508 (c-keep-region-active))))
2510 (defun c-end-of-statement (&optional count lim sentence-flag)
2511 "Go to the end of the innermost C statement.
2512 With prefix arg, go forward N - 1 statements. Move forward to the end
2513 of the next statement if already at end, and move into nested blocks
2514 \(use \\[forward-sexp] to skip over a block). If within or next to a
2515 comment or multiline string, move by sentences instead of statements.
2517 When called from a program, this function takes 3 optional args: the
2518 repetition count, a buffer position limit which is the farthest back
2519 to search for the syntactic context, and a flag saying whether to do
2520 sentence motion in or near comments and multiline strings."
2521 (interactive (list (prefix-numeric-value current-prefix-arg)
2522 nil t))
2523 (setq count (or count 1))
2524 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2526 (c-save-buffer-state
2527 (here ; start point for going forward ONE statement. Updated each statement.
2528 (macro-fence
2529 (save-excursion
2530 (and (not (eobp)) (c-beginning-of-macro)
2531 (progn (c-end-of-macro) (point)))))
2533 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2535 ;; Go back/forward one statement at each iteration of the following loop.
2536 (while (and (/= count 0)
2537 (or (not lim) (< (point) lim)))
2538 (setq here (point)) ; ONLY HERE is HERE updated
2540 ;; Go forward one "chunk" each time round the following loop, stopping
2541 ;; when we reach a statement boundary, etc.
2542 (while
2543 (cond ; Each arm of this cond returns NIL on reaching a desired
2544 ; statement boundary, non-NIL otherwise.
2545 ((eobp)
2546 (setq count 0)
2547 nil)
2549 (range ; point is within a literal.
2550 (cond
2551 ;; sentence-flag is null => skip the entire literal.
2552 ;; or a Single line string.
2553 ((or (null sentence-flag)
2554 (c-one-line-string-p range))
2555 (goto-char (cdr range))
2556 (setq range (c-ascertain-following-literal))
2557 ;; Is there a virtual semicolon here (e.g. for AWK)?
2558 (not (c-at-vsemi-p)))
2560 ;; Comment or multi-line string.
2561 (t (when (setq res ; gets non-nil when we go out of the literal
2562 (if (eq (c-literal-type range) 'string)
2563 (c-end-of-sentence-in-string range)
2564 (c-end-of-sentence-in-comment range)))
2565 (setq range (c-ascertain-following-literal)))
2566 ;; If we've just come forward out of a literal, check for
2567 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2568 ;; some other language may do in the future)
2569 (and res
2570 (not (c-at-vsemi-p))))))
2572 ;; Non-literal code.
2573 (t (setq res (c-forward-over-illiterals macro-fence
2574 (> (point) here)))
2575 ;; Are we about to move forward into or out of a
2576 ;; preprocessor command?
2577 (when (eq (cdr res) 'macro-boundary)
2578 (save-excursion
2579 (end-of-line)
2580 (setq macro-fence
2581 (and (not (eobp))
2582 (progn (c-skip-ws-forward)
2583 (c-beginning-of-macro))
2584 (progn (c-end-of-macro)
2585 (point))))))
2586 ;; Are we about to move forward into a literal?
2587 (when (memq (cdr res) '(macro-boundary literal))
2588 (setq range (c-ascertain-following-literal)))
2589 (car res))))
2591 (if (/= count 0) (setq count (1- count))))
2592 (c-keep-region-active))))
2595 ;; set up electric character functions to work with pending-del,
2596 ;; (a.k.a. delsel) mode. All symbols get the t value except
2597 ;; the functions which delete, which gets 'supersede.
2598 (mapcar
2599 (function
2600 (lambda (sym)
2601 (put sym 'delete-selection t) ; for delsel (Emacs)
2602 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2603 '(c-electric-pound
2604 c-electric-brace
2605 c-electric-slash
2606 c-electric-star
2607 c-electric-semi&comma
2608 c-electric-lt-gt
2609 c-electric-colon
2610 c-electric-paren))
2611 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2612 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2613 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2614 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
2615 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2616 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
2619 ;; Inserting/indenting comments
2620 (defun c-calc-comment-indent (entry)
2621 ;; This function might do hidden buffer changes.
2622 (if (symbolp entry)
2623 (setq entry (or (assq entry c-indent-comment-alist)
2624 (assq 'other c-indent-comment-alist)
2625 '(default . (column . nil)))))
2626 (let ((action (car (cdr entry)))
2627 (value (cdr (cdr entry)))
2628 (col (current-column)))
2629 (cond ((eq action 'space)
2630 (+ col value))
2631 ((eq action 'column)
2632 (unless value (setq value comment-column))
2633 (if (bolp)
2634 ;; Do not pad with one space if we're at bol.
2635 value
2636 (max (1+ col) value)))
2637 ((eq action 'align)
2638 (or (save-excursion
2639 (beginning-of-line)
2640 (unless (bobp)
2641 (backward-char)
2642 (let ((lim (c-literal-limits (c-point 'bol) t)))
2643 (when (consp lim)
2644 (goto-char (car lim))
2645 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2646 ;; Found comment to align with.
2647 (if (bolp)
2648 ;; Do not pad with one space if we're at bol.
2650 (max (1+ col) (current-column))))))))
2651 ;; Recurse to handle value as a new spec.
2652 (c-calc-comment-indent (cdr entry)))))))
2654 (defun c-comment-indent ()
2655 "Used by `indent-for-comment' to create and indent comments.
2656 See `c-indent-comment-alist' for a description."
2657 (save-excursion
2658 (end-of-line)
2659 (c-save-buffer-state
2660 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
2661 (or (when (consp lim)
2662 (goto-char (car lim))
2663 (when (looking-at "/[/*]")
2664 (skip-chars-backward " \t")
2665 (point)))
2666 (progn
2667 (skip-chars-backward " \t")
2668 (point)))))
2669 (line-type
2670 (cond ((looking-at "^/[/*]")
2671 'anchored-comment)
2672 ((progn (beginning-of-line)
2673 (eq (point) eot))
2674 'empty-line)
2675 ((progn (back-to-indentation)
2676 (and (eq (char-after) ?})
2677 (eq (point) (1- eot))))
2678 'end-block)
2679 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2680 (eq (match-end 0) eot))
2681 'cpp-end-block)
2683 'other))))
2684 (if (and (memq line-type '(anchored-comment empty-line))
2685 c-indent-comments-syntactically-p)
2686 (let ((c-syntactic-context (c-guess-basic-syntax)))
2687 ;; BOGOSITY ALERT: if we're looking at the eol, its
2688 ;; because indent-for-comment hasn't put the comment-start
2689 ;; in the buffer yet. this will screw up the syntactic
2690 ;; analysis so we kludge in the necessary info. Another
2691 ;; kludge is that if we're at the bol, then we really want
2692 ;; to ignore any anchoring as specified by
2693 ;; c-comment-only-line-offset since it doesn't apply here.
2694 (if (eolp)
2695 (c-add-syntax 'comment-intro))
2696 (let ((c-comment-only-line-offset
2697 (if (consp c-comment-only-line-offset)
2698 c-comment-only-line-offset
2699 (cons c-comment-only-line-offset
2700 c-comment-only-line-offset))))
2701 (c-get-syntactic-indentation c-syntactic-context)))
2702 (goto-char eot)
2703 (c-calc-comment-indent line-type)))))
2706 ;; used by outline-minor-mode
2707 (defun c-outline-level ()
2708 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2709 ;; in otherwise-hidden text.
2710 (save-excursion
2711 (skip-chars-forward "\t ")
2712 (current-column))))
2715 ;; Movement by CPP conditionals.
2716 (defun c-up-conditional (count)
2717 "Move back to the containing preprocessor conditional, leaving mark behind.
2718 A prefix argument acts as a repeat count. With a negative argument,
2719 move forward to the end of the containing preprocessor conditional.
2721 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2722 function stops at them when going backward, but not when going
2723 forward."
2724 (interactive "p")
2725 (c-forward-conditional (- count) -1)
2726 (c-keep-region-active))
2728 (defun c-up-conditional-with-else (count)
2729 "Move back to the containing preprocessor conditional, including \"#else\".
2730 Just like `c-up-conditional', except it also stops at \"#else\"
2731 directives."
2732 (interactive "p")
2733 (c-forward-conditional (- count) -1 t)
2734 (c-keep-region-active))
2736 (defun c-down-conditional (count)
2737 "Move forward into the next preprocessor conditional, leaving mark behind.
2738 A prefix argument acts as a repeat count. With a negative argument,
2739 move backward into the previous preprocessor conditional.
2741 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2742 function stops at them when going forward, but not when going
2743 backward."
2744 (interactive "p")
2745 (c-forward-conditional count 1)
2746 (c-keep-region-active))
2748 (defun c-down-conditional-with-else (count)
2749 "Move forward into the next preprocessor conditional, including \"#else\".
2750 Just like `c-down-conditional', except it also stops at \"#else\"
2751 directives."
2752 (interactive "p")
2753 (c-forward-conditional count 1 t)
2754 (c-keep-region-active))
2756 (defun c-backward-conditional (count &optional target-depth with-else)
2757 "Move back across a preprocessor conditional, leaving mark behind.
2758 A prefix argument acts as a repeat count. With a negative argument,
2759 move forward across a preprocessor conditional."
2760 (interactive "p")
2761 (c-forward-conditional (- count) target-depth with-else)
2762 (c-keep-region-active))
2764 (defun c-forward-conditional (count &optional target-depth with-else)
2765 "Move forward across a preprocessor conditional, leaving mark behind.
2766 A prefix argument acts as a repeat count. With a negative argument,
2767 move backward across a preprocessor conditional.
2769 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2770 the nesting level isn't changed when tracking subconditionals.
2772 The optional argument TARGET-DEPTH specifies the wanted nesting depth
2773 after each scan. I.e. if TARGET-DEPTH is -1, the function will move
2774 out of the enclosing conditional. A non-integer non-nil TARGET-DEPTH
2775 counts as -1.
2777 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
2778 are treated as conditional clause limits. Normally they are ignored."
2779 (interactive "p")
2780 (let* ((forward (> count 0))
2781 (increment (if forward -1 1))
2782 (search-function (if forward 're-search-forward 're-search-backward))
2783 (new))
2784 (unless (integerp target-depth)
2785 (setq target-depth (if target-depth -1 0)))
2786 (save-excursion
2787 (while (/= count 0)
2788 (let ((depth 0)
2789 ;; subdepth is the depth in "uninteresting" subtrees,
2790 ;; i.e. those that takes us farther from the target
2791 ;; depth instead of closer.
2792 (subdepth 0)
2793 found)
2794 (save-excursion
2795 ;; Find the "next" significant line in the proper direction.
2796 (while (and (not found)
2797 ;; Rather than searching for a # sign that
2798 ;; comes at the beginning of a line aside from
2799 ;; whitespace, search first for a string
2800 ;; starting with # sign. Then verify what
2801 ;; precedes it. This is faster on account of
2802 ;; the fastmap feature of the regexp matcher.
2803 (funcall search-function
2804 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
2805 nil t))
2806 (beginning-of-line)
2807 ;; Now verify it is really a preproc line.
2808 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
2809 (let (dchange (directive (match-string 1)))
2810 (cond ((string= directive "if")
2811 (setq dchange (- increment)))
2812 ((string= directive "endif")
2813 (setq dchange increment))
2814 ((= subdepth 0)
2815 ;; When we're not in an "uninteresting"
2816 ;; subtree, we might want to act on "elif"
2817 ;; and "else" too.
2818 (if (cond (with-else
2819 ;; Always move toward the target depth.
2820 (setq dchange
2821 (if (> target-depth 0) 1 -1)))
2822 ((string= directive "elif")
2823 (setq dchange (- increment))))
2824 ;; Ignore the change if it'd take us
2825 ;; into an "uninteresting" subtree.
2826 (if (eq (> dchange 0) (<= target-depth 0))
2827 (setq dchange nil)))))
2828 (when dchange
2829 (when (or (/= subdepth 0)
2830 (eq (> dchange 0) (<= target-depth 0)))
2831 (setq subdepth (+ subdepth dchange)))
2832 (setq depth (+ depth dchange))
2833 ;; If we are trying to move across, and we find an
2834 ;; end before we find a beginning, get an error.
2835 (if (and (< depth target-depth) (< dchange 0))
2836 (error (if forward
2837 "No following conditional at this level"
2838 "No previous conditional at this level"))))
2839 ;; When searching forward, start from next line so
2840 ;; that we don't find the same line again.
2841 (if forward (forward-line 1))
2842 ;; We found something if we've arrived at the
2843 ;; target depth.
2844 (if (and dchange (= depth target-depth))
2845 (setq found (point))))
2846 ;; else
2847 (if forward (forward-line 1)))))
2848 (or found
2849 (error "No containing preprocessor conditional"))
2850 (goto-char (setq new found)))
2851 (setq count (+ count increment))))
2852 (push-mark)
2853 (goto-char new))
2854 (c-keep-region-active))
2857 ;; commands to indent lines, regions, defuns, and expressions
2858 (defun c-indent-command (&optional arg)
2859 "Indent current line as C code, and/or insert some whitespace.
2861 If `c-tab-always-indent' is t, always just indent the current line.
2862 If nil, indent the current line only if point is at the left margin or
2863 in the line's indentation; otherwise insert some whitespace[*]. If
2864 other than nil or t, then some whitespace[*] is inserted only within
2865 literals (comments and strings), but the line is always reindented.
2867 If `c-syntactic-indentation' is t, indentation is done according to
2868 the syntactic context. A numeric argument, regardless of its value,
2869 means indent rigidly all the lines of the expression starting after
2870 point so that this line becomes properly indented. The relative
2871 indentation among the lines of the expression is preserved.
2873 If `c-syntactic-indentation' is nil, the line is just indented one
2874 step according to `c-basic-offset'. In this mode, a numeric argument
2875 indents a number of such steps, positive or negative, and an empty
2876 prefix argument is equivalent to -1.
2878 [*] The amount and kind of whitespace inserted is controlled by the
2879 variable `c-insert-tab-function', which is called to do the actual
2880 insertion of whitespace. Normally the function in this variable
2881 just inserts a tab character, or the equivalent number of spaces,
2882 depending on the variable `indent-tabs-mode'."
2884 (interactive "P")
2885 (let ((indent-function
2886 (if c-syntactic-indentation
2887 (symbol-function 'indent-according-to-mode)
2888 (lambda ()
2889 (let ((c-macro-start c-macro-start)
2890 (steps (if (equal arg '(4))
2892 (prefix-numeric-value arg))))
2893 (c-shift-line-indentation (* steps c-basic-offset))
2894 (when (and c-auto-align-backslashes
2895 (save-excursion
2896 (end-of-line)
2897 (eq (char-before) ?\\))
2898 (c-query-and-set-macro-start))
2899 ;; Realign the line continuation backslash if inside a macro.
2900 (c-backslash-region (point) (point) nil t)))
2901 ))))
2902 (if (and c-syntactic-indentation arg)
2903 ;; If c-syntactic-indentation and got arg, always indent this
2904 ;; line as C and shift remaining lines of expression the same
2905 ;; amount.
2906 (let ((shift-amt (save-excursion
2907 (back-to-indentation)
2908 (current-column)))
2909 beg end)
2910 (c-indent-line)
2911 (setq shift-amt (- (save-excursion
2912 (back-to-indentation)
2913 (current-column))
2914 shift-amt))
2915 (save-excursion
2916 (if (eq c-tab-always-indent t)
2917 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
2918 (setq beg (point))
2919 (c-forward-sexp 1)
2920 (setq end (point))
2921 (goto-char beg)
2922 (forward-line 1)
2923 (setq beg (point)))
2924 (if (> end beg)
2925 (indent-code-rigidly beg end shift-amt "#")))
2926 ;; Else use c-tab-always-indent to determine behavior.
2927 (cond
2928 ;; CASE 1: indent when at column zero or in line's indentation,
2929 ;; otherwise insert a tab
2930 ((not c-tab-always-indent)
2931 (if (save-excursion
2932 (skip-chars-backward " \t")
2933 (not (bolp)))
2934 (funcall c-insert-tab-function)
2935 (funcall indent-function)))
2936 ;; CASE 2: just indent the line
2937 ((eq c-tab-always-indent t)
2938 (funcall indent-function))
2939 ;; CASE 3: if in a literal, insert a tab, but always indent the
2940 ;; line
2942 (if (c-save-buffer-state () (c-in-literal))
2943 (funcall c-insert-tab-function))
2944 (funcall indent-function)
2945 )))))
2947 (defun c-indent-exp (&optional shutup-p)
2948 "Indent each line in the balanced expression following point syntactically.
2949 If optional SHUTUP-P is non-nil, no errors are signaled if no
2950 balanced expression is found."
2951 (interactive "*P")
2952 (let ((here (point-marker))
2953 end)
2954 (set-marker-insertion-type here t)
2955 (unwind-protect
2956 (let ((start (save-restriction
2957 ;; Find the closest following open paren that
2958 ;; ends on another line.
2959 (narrow-to-region (point-min) (c-point 'eol))
2960 (let (beg (end (point)))
2961 (while (and (setq beg (c-down-list-forward end))
2962 (setq end (c-up-list-forward beg))))
2963 (and beg
2964 (eq (char-syntax (char-before beg)) ?\()
2965 (1- beg))))))
2966 ;; sanity check
2967 (if (not start)
2968 (unless shutup-p
2969 (error "Cannot find start of balanced expression to indent"))
2970 (goto-char start)
2971 (setq end (c-safe (scan-sexps (point) 1)))
2972 (if (not end)
2973 (unless shutup-p
2974 (error "Cannot find end of balanced expression to indent"))
2975 (forward-line)
2976 (if (< (point) end)
2977 (c-indent-region (point) end)))))
2978 (goto-char here)
2979 (set-marker here nil))))
2981 (defun c-indent-defun ()
2982 "Indent the current top-level declaration or macro syntactically.
2983 In the macro case this also has the effect of realigning any line
2984 continuation backslashes, unless `c-auto-align-backslashes' is nil."
2985 (interactive "*")
2986 (let ((here (point-marker)) decl-limits)
2987 (unwind-protect
2988 (progn
2989 (c-save-buffer-state nil
2990 ;; We try to be line oriented, unless there are several
2991 ;; declarations on the same line.
2992 (if (looking-at c-syntactic-eol)
2993 (c-backward-token-2 1 nil (c-point 'bol))
2994 (c-forward-token-2 0 nil (c-point 'eol)))
2995 (setq decl-limits (c-declaration-limits nil)))
2996 (if decl-limits
2997 (c-indent-region (car decl-limits)
2998 (cdr decl-limits))))
2999 (goto-char here)
3000 (set-marker here nil))))
3002 (defun c-indent-region (start end &optional quiet)
3003 "Indent syntactically every line whose first char is between START
3004 and END inclusive. If the optional argument QUIET is non-nil then no
3005 syntactic errors are reported, even if `c-report-syntactic-errors' is
3006 non-nil."
3007 (save-excursion
3008 (goto-char end)
3009 (skip-chars-backward " \t\n\r\f\v")
3010 (setq end (point))
3011 (goto-char start)
3012 ;; Advance to first nonblank line.
3013 (beginning-of-line)
3014 (skip-chars-forward " \t\n\r\f\v")
3015 (setq start (point))
3016 (beginning-of-line)
3017 (setq c-parsing-error
3018 (or (let ((endmark (copy-marker end))
3019 (c-parsing-error nil)
3020 ;; shut up any echo msgs on indiv lines
3021 (c-echo-syntactic-information-p nil)
3022 (in-macro (and c-auto-align-backslashes
3023 (c-save-buffer-state ()
3024 (save-excursion (c-beginning-of-macro)))
3025 start))
3026 (c-fix-backslashes nil)
3027 syntax)
3028 (unwind-protect
3029 (progn
3030 (c-progress-init start end 'c-indent-region)
3031 (while (and (bolp)
3032 (not (eobp))
3033 (< (point) endmark))
3034 ;; update progress
3035 (c-progress-update)
3036 ;; skip empty lines
3037 (skip-chars-forward " \t\n")
3038 (beginning-of-line)
3039 ;; Get syntax and indent.
3040 (c-save-buffer-state nil
3041 (setq syntax (c-guess-basic-syntax)))
3042 (if (and c-auto-align-backslashes
3043 (assq 'cpp-macro syntax))
3044 ;; Record macro start.
3045 (setq in-macro (point)))
3046 (if in-macro
3047 (if (looking-at "\\s *\\\\$")
3048 (forward-line)
3049 (c-indent-line syntax t t)
3050 (if (progn (end-of-line)
3051 (not (eq (char-before) ?\\)))
3052 (progn
3053 ;; Fixup macro backslashes.
3054 (forward-line)
3055 (c-backslash-region in-macro (point) nil)
3056 (setq in-macro nil))
3057 (forward-line)))
3058 (c-indent-line syntax t t)
3059 (forward-line)))
3060 (if in-macro
3061 (c-backslash-region in-macro (c-point 'bopl) nil t)))
3062 (set-marker endmark nil)
3063 (c-progress-fini 'c-indent-region))
3064 (c-echo-parsing-error quiet))
3065 c-parsing-error))))
3067 (defun c-fn-region-is-active-p ()
3068 ;; Function version of the macro for use in places that aren't
3069 ;; compiled, e.g. in the menus.
3070 (c-region-is-active-p))
3072 (defun c-indent-line-or-region ()
3073 "When the region is active, indent it syntactically. Otherwise
3074 indent the current line syntactically."
3075 ;; Emacs has a variable called mark-active, XEmacs uses region-active-p
3076 (interactive)
3077 (if (c-region-is-active-p)
3078 (c-indent-region (region-beginning) (region-end))
3079 (c-indent-line)))
3082 ;; for progress reporting
3083 (defvar c-progress-info nil)
3085 (defun c-progress-init (start end context)
3086 (cond
3087 ;; Be silent
3088 ((not c-progress-interval))
3089 ;; Start the progress update messages. If this Emacs doesn't have
3090 ;; a built-in timer, just be dumb about it.
3091 ((not (fboundp 'current-time))
3092 (message "Indenting region... (this may take a while)"))
3093 ;; If progress has already been initialized, do nothing. otherwise
3094 ;; initialize the counter with a vector of:
3095 ;; [start end lastsec context]
3096 (c-progress-info)
3097 (t (setq c-progress-info (vector start
3098 (save-excursion
3099 (goto-char end)
3100 (point-marker))
3101 (nth 1 (current-time))
3102 context))
3103 (message "Indenting region..."))
3106 (defun c-progress-update ()
3107 (if (not (and c-progress-info c-progress-interval))
3109 (let ((now (nth 1 (current-time)))
3110 (start (aref c-progress-info 0))
3111 (end (aref c-progress-info 1))
3112 (lastsecs (aref c-progress-info 2)))
3113 ;; should we update? currently, update happens every 2 seconds,
3114 ;; what's the right value?
3115 (if (< c-progress-interval (- now lastsecs))
3116 (progn
3117 (message "Indenting region... (%d%% complete)"
3118 (/ (* 100 (- (point) start)) (- end start)))
3119 (aset c-progress-info 2 now)))
3122 (defun c-progress-fini (context)
3123 (if (not c-progress-interval)
3125 (if (or (eq context (aref c-progress-info 3))
3126 (eq context t))
3127 (progn
3128 (set-marker (aref c-progress-info 1) nil)
3129 (setq c-progress-info nil)
3130 (message "Indenting region... done")))))
3134 ;;; This page handles insertion and removal of backslashes for C macros.
3136 (defun c-backslash-region (from to delete-flag &optional line-mode)
3137 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3138 With no argument, inserts backslashes and aligns existing backslashes.
3139 With an argument, deletes the backslashes. The backslash alignment is
3140 done according to the settings in `c-backslash-column',
3141 `c-backslash-max-column' and `c-auto-align-backslashes'.
3143 This function does not modify blank lines at the start of the region.
3144 If the region ends at the start of a line and the macro doesn't
3145 continue below it, the backslash (if any) at the end of the previous
3146 line is deleted.
3148 You can put the region around an entire macro definition and use this
3149 command to conveniently insert and align the necessary backslashes."
3150 (interactive "*r\nP")
3151 (let ((endmark (make-marker))
3152 ;; Keep the backslash trimming functions from changing the
3153 ;; whitespace around point, since in this case it's only the
3154 ;; position of point that tells the indentation of the line.
3155 (point-pos (if (save-excursion
3156 (skip-chars-backward " \t")
3157 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3158 (point-marker)
3159 (point-min)))
3160 column longest-line-col bs-col-after-end)
3161 (save-excursion
3162 (goto-char to)
3163 (if (and (not line-mode) (bobp))
3164 ;; Nothing to do if to is at bob, since we should back up
3165 ;; and there's no line to back up to.
3167 (when (and (not line-mode) (bolp))
3168 ;; Do not back up the to line if line-mode is set, to make
3169 ;; e.g. c-newline-and-indent consistent regardless whether
3170 ;; the (newline) call leaves point at bol or not.
3171 (backward-char)
3172 (setq to (point)))
3173 (if delete-flag
3174 (progn
3175 (set-marker endmark (point))
3176 (goto-char from)
3177 (c-delete-backslashes-forward endmark point-pos))
3178 ;; Set bs-col-after-end to the column of any backslash
3179 ;; following the region, or nil if there is none.
3180 (setq bs-col-after-end
3181 (and (progn (end-of-line)
3182 (eq (char-before) ?\\))
3183 (= (forward-line 1) 0)
3184 (progn (end-of-line)
3185 (eq (char-before) ?\\))
3186 (1- (current-column))))
3187 (when line-mode
3188 ;; Back up the to line if line-mode is set, since the line
3189 ;; after the newly inserted line break should not be
3190 ;; touched in c-newline-and-indent.
3191 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3192 (unless bs-col-after-end
3193 ;; Set bs-col-after-end to non-nil in any case, since we
3194 ;; do not want to delete the backslash at the last line.
3195 (setq bs-col-after-end t)))
3196 (if (and line-mode
3197 (not c-auto-align-backslashes))
3198 (goto-char from)
3199 ;; Compute the smallest column number past the ends of all
3200 ;; the lines.
3201 (setq longest-line-col 0)
3202 (goto-char to)
3203 (if bs-col-after-end
3204 ;; Include one more line in the max column
3205 ;; calculation, since the to line will be backslashed
3206 ;; too.
3207 (forward-line 1))
3208 (end-of-line)
3209 (while (and (>= (point) from)
3210 (progn
3211 (if (eq (char-before) ?\\)
3212 (forward-char -1))
3213 (skip-chars-backward " \t")
3214 (setq longest-line-col (max longest-line-col
3215 (1+ (current-column))))
3216 (beginning-of-line)
3217 (not (bobp))))
3218 (backward-char))
3219 ;; Try to align with surrounding backslashes.
3220 (goto-char from)
3221 (beginning-of-line)
3222 (if (and (not (bobp))
3223 (progn (backward-char)
3224 (eq (char-before) ?\\)))
3225 (progn
3226 (setq column (1- (current-column)))
3227 (if (numberp bs-col-after-end)
3228 ;; Both a preceding and a following backslash.
3229 ;; Choose the greatest of them.
3230 (setq column (max column bs-col-after-end)))
3231 (goto-char from))
3232 ;; No preceding backslash. Try to align with one
3233 ;; following the region. Disregard the backslash at the
3234 ;; to line since it's likely to be bogus (e.g. when
3235 ;; called from c-newline-and-indent).
3236 (if (numberp bs-col-after-end)
3237 (setq column bs-col-after-end))
3238 ;; Don't modify blank lines at start of region.
3239 (goto-char from)
3240 (while (and (< (point) to) (bolp) (eolp))
3241 (forward-line 1)))
3242 (if (and column (< column longest-line-col))
3243 ;; Don't try to align with surrounding backslashes if
3244 ;; any line is too long.
3245 (setq column nil))
3246 (unless column
3247 ;; Impose minimum limit and tab width alignment only if
3248 ;; we can't align with surrounding backslashes.
3249 (if (> (% longest-line-col tab-width) 0)
3250 (setq longest-line-col
3251 (* (/ (+ longest-line-col tab-width -1)
3252 tab-width)
3253 tab-width)))
3254 (setq column (max c-backslash-column
3255 longest-line-col)))
3256 ;; Always impose maximum limit.
3257 (setq column (min column c-backslash-max-column)))
3258 (if bs-col-after-end
3259 ;; Add backslashes on all lines if the macro continues
3260 ;; after the to line.
3261 (progn
3262 (set-marker endmark to)
3263 (c-append-backslashes-forward endmark column point-pos))
3264 ;; Add backslashes on all lines except the last, and
3265 ;; remove any on the last line.
3266 (if (save-excursion
3267 (goto-char to)
3268 (beginning-of-line)
3269 (if (not (bobp))
3270 (set-marker endmark (1- (point)))))
3271 (progn
3272 (c-append-backslashes-forward endmark column point-pos)
3273 ;; The function above leaves point on the line
3274 ;; following endmark.
3275 (set-marker endmark (point)))
3276 (set-marker endmark to))
3277 (c-delete-backslashes-forward endmark point-pos)))))
3278 (set-marker endmark nil)
3279 (if (markerp point-pos)
3280 (set-marker point-pos nil))))
3282 (defun c-append-backslashes-forward (to-mark column point-pos)
3283 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3284 (if column
3285 (while
3286 (and
3287 (<= (point) to-mark)
3289 (let ((start (point)) (inserted nil) end col)
3290 (end-of-line)
3291 (unless (eq (char-before) ?\\)
3292 (insert ?\\)
3293 (setq inserted t))
3294 (setq state (parse-partial-sexp
3295 start (point) nil nil state))
3296 (backward-char)
3297 (setq col (current-column))
3299 ;; Avoid unnecessary changes of the buffer.
3300 (cond ((and (not inserted) (nth 3 state))
3301 ;; Don't realign backslashes in string literals
3302 ;; since that would change them.
3305 ((< col column)
3306 (delete-region
3307 (point)
3308 (progn
3309 (skip-chars-backward
3310 " \t" (if (>= (point) point-pos) point-pos))
3311 (point)))
3312 (indent-to column))
3314 ((and (= col column)
3315 (memq (char-before) '(?\ ?\t))))
3317 ((progn
3318 (setq end (point))
3319 (or (/= (skip-chars-backward
3320 " \t" (if (>= (point) point-pos) point-pos))
3322 (/= (char-after) ?\ )))
3323 (delete-region (point) end)
3324 (indent-to column 1)))
3326 (zerop (forward-line 1)))
3327 (bolp))) ; forward-line has funny behavior at eob.
3329 ;; Make sure there are backslashes with at least one space in
3330 ;; front of them.
3331 (while
3332 (and
3333 (<= (point) to-mark)
3335 (let ((start (point)))
3336 (end-of-line)
3337 (setq state (parse-partial-sexp
3338 start (point) nil nil state))
3340 (if (eq (char-before) ?\\)
3341 (unless (nth 3 state)
3342 (backward-char)
3343 (unless (and (memq (char-before) '(?\ ?\t))
3344 (/= (point) point-pos))
3345 (insert ?\ )))
3347 (if (and (memq (char-before) '(?\ ?\t))
3348 (/= (point) point-pos))
3349 (insert ?\\)
3350 (insert ?\ ?\\)))
3352 (zerop (forward-line 1)))
3353 (bolp)))))) ; forward-line has funny behavior at eob.
3355 (defun c-delete-backslashes-forward (to-mark point-pos)
3356 (while
3357 (and (<= (point) to-mark)
3358 (progn
3359 (end-of-line)
3360 (if (eq (char-before) ?\\)
3361 (delete-region
3362 (point)
3363 (progn (backward-char)
3364 (skip-chars-backward " \t" (if (>= (point) point-pos)
3365 point-pos))
3366 (point))))
3367 (zerop (forward-line 1)))
3368 (bolp)))) ; forward-line has funny behavior at eob.
3372 ;;; Line breaking and paragraph filling.
3374 (defvar c-auto-fill-prefix t)
3375 (defvar c-lit-limits nil)
3376 (defvar c-lit-type nil)
3378 ;; The filling code is based on a simple theory; leave the intricacies
3379 ;; of the text handling to the currently active mode for that
3380 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3381 ;; possible to make them work correctly wrt the comment and string
3382 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3383 ;; to it, there's quite a lot of special cases to handle which makes
3384 ;; the code anything but simple. The intention is that it will work
3385 ;; with any well-written text filling package that preserves a fill
3386 ;; prefix.
3388 ;; We temporarily mask comment starters and enders as necessary for
3389 ;; the filling code to do its job on a seemingly normal text block.
3390 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3391 ;; preserve it correctly (especially important when filling C++ style
3392 ;; line comments). By default, we set up and use adaptive-fill-mode,
3393 ;; which is standard in all supported Emacs flavors.
3395 (defun c-guess-fill-prefix (lit-limits lit-type)
3396 ;; Determine the appropriate comment fill prefix for a block or line
3397 ;; comment. Return a cons of the prefix string and the column where
3398 ;; it ends. If fill-prefix is set, it'll override. Note that this
3399 ;; function also uses the value of point in some heuristics.
3401 ;; This function might do hidden buffer changes.
3403 (let* ((here (point))
3404 (prefix-regexp (concat "[ \t]*\\("
3405 c-current-comment-prefix
3406 "\\)[ \t]*"))
3407 (comment-start-regexp (if (eq lit-type 'c++)
3408 prefix-regexp
3409 comment-start-skip))
3410 prefix-line comment-prefix res comment-text-end)
3412 (cond
3413 (fill-prefix
3414 (setq res (cons fill-prefix
3415 ;; Ugly way of getting the column after the fill
3416 ;; prefix; it'd be nice with a current-column
3417 ;; that works on strings..
3418 (let ((start (point)))
3419 (unwind-protect
3420 (progn
3421 (insert-and-inherit "\n" fill-prefix)
3422 (current-column))
3423 (delete-region start (point)))))))
3425 ((eq lit-type 'c++)
3426 (save-excursion
3427 ;; Set fallback for comment-prefix if none is found.
3428 (setq comment-prefix "// "
3429 comment-text-end (cdr lit-limits))
3431 (beginning-of-line)
3432 (if (> (point) (car lit-limits))
3433 ;; The current line is not the comment starter, so the
3434 ;; comment has more than one line, and it can therefore be
3435 ;; used to find the comment fill prefix.
3436 (setq prefix-line (point))
3438 (goto-char (car lit-limits))
3439 (if (and (= (forward-line 1) 0)
3440 (< (point) (cdr lit-limits)))
3441 ;; The line after the comment starter is inside the
3442 ;; comment, so we can use it.
3443 (setq prefix-line (point))
3445 ;; The comment is only one line. Take the comment prefix
3446 ;; from it and keep the indentation.
3447 (goto-char (car lit-limits))
3448 (if (looking-at prefix-regexp)
3449 (goto-char (match-end 0))
3450 (forward-char 2)
3451 (skip-chars-forward " \t"))
3453 (let (str col)
3454 (if (eq (c-point 'boi) (car lit-limits))
3455 ;; There is only whitespace before the comment
3456 ;; starter; take the prefix straight from this line.
3457 (setq str (buffer-substring-no-properties
3458 (c-point 'bol) (point))
3459 col (current-column))
3461 ;; There is code before the comment starter, so we
3462 ;; have to temporarily insert and indent a new line to
3463 ;; get the right space/tab mix in the indentation.
3464 (let ((prefix-len (- (point) (car lit-limits)))
3465 tmp)
3466 (unwind-protect
3467 (progn
3468 (goto-char (car lit-limits))
3469 (indent-to (prog1 (current-column)
3470 (insert ?\n)))
3471 (setq tmp (point))
3472 (forward-char prefix-len)
3473 (setq str (buffer-substring-no-properties
3474 (c-point 'bol) (point))
3475 col (current-column)))
3476 (delete-region (car lit-limits) tmp))))
3478 (setq res
3479 (if (or (string-match "\\s \\'" str) (not (eolp)))
3480 (cons str col)
3481 ;; The prefix ends the line with no whitespace
3482 ;; after it. Default to a single space.
3483 (cons (concat str " ") (1+ col))))
3484 )))))
3487 (setq comment-text-end
3488 (save-excursion
3489 (goto-char (- (cdr lit-limits) 2))
3490 (if (looking-at "\\*/") (point) (cdr lit-limits))))
3492 (save-excursion
3493 (beginning-of-line)
3494 (if (and (> (point) (car lit-limits))
3495 (not (and (looking-at "[ \t]*\\*/")
3496 (eq (cdr lit-limits) (match-end 0)))))
3497 ;; The current line is not the comment starter and
3498 ;; contains more than just the ender, so it's good enough
3499 ;; to be used for the comment fill prefix.
3500 (setq prefix-line (point))
3501 (goto-char (car lit-limits))
3503 (cond ((or (/= (forward-line 1) 0)
3504 (>= (point) (cdr lit-limits))
3505 (and (looking-at "[ \t]*\\*/")
3506 (eq (cdr lit-limits) (match-end 0)))
3507 (and (looking-at prefix-regexp)
3508 (<= (1- (cdr lit-limits)) (match-end 0))))
3509 ;; The comment is either one line or the next line contains
3510 ;; just the comment ender. In this case we have no
3511 ;; information about a suitable comment prefix, so we resort
3512 ;; to c-block-comment-prefix.
3513 (setq comment-prefix (or c-block-comment-prefix "")))
3515 ((< here (point))
3516 ;; The point was on the comment opener line, so we might want
3517 ;; to treat this as a not yet closed comment.
3519 (if (and (match-beginning 1)
3520 (/= (match-beginning 1) (match-end 1)))
3521 ;; Above `prefix-regexp' matched a nonempty prefix on the
3522 ;; second line, so let's use it. Normally it should do
3523 ;; to set `prefix-line' and let the code below pick up
3524 ;; the whole prefix, but if there's no text after the
3525 ;; match then it will probably fall back to no prefix at
3526 ;; all if the comment isn't closed yet, so in that case
3527 ;; it's better to force use of the prefix matched now.
3528 (if (= (match-end 0) (c-point 'eol))
3529 (setq comment-prefix (match-string 1))
3530 (setq prefix-line (point)))
3532 ;; There's no nonempty prefix on the line after the
3533 ;; comment opener. If the line is empty, or if the
3534 ;; text on it has less or equal indentation than the
3535 ;; comment starter we assume it's an unclosed
3536 ;; comment starter, i.e. that
3537 ;; `c-block-comment-prefix' should be used.
3538 ;; Otherwise we assume it's a closed comment where
3539 ;; the prefix really is the empty string.
3540 ;; E.g. this is an unclosed comment:
3542 ;; /*
3543 ;; foo
3545 ;; But this is not:
3547 ;; /*
3548 ;; foo
3549 ;; */
3551 ;; (Looking for the presence of the comment closer
3552 ;; rarely works since it's probably the closer of
3553 ;; some comment further down when the comment
3554 ;; really is unclosed.)
3555 (if (<= (save-excursion (back-to-indentation)
3556 (current-column))
3557 (save-excursion (goto-char (car lit-limits))
3558 (current-column)))
3559 (setq comment-prefix (or c-block-comment-prefix ""))
3560 (setq prefix-line (point)))))
3563 ;; Otherwise the line after the comment starter is good
3564 ;; enough to find the prefix in.
3565 (setq prefix-line (point))))
3567 (when comment-prefix
3568 ;; Haven't got the comment prefix on any real line that we
3569 ;; can take it from, so we have to temporarily insert
3570 ;; `comment-prefix' on a line and indent it to find the
3571 ;; correct column and the correct mix of tabs and spaces.
3572 (setq res
3573 (let (tmp-pre tmp-post)
3574 (unwind-protect
3575 (progn
3577 (goto-char (car lit-limits))
3578 (if (looking-at comment-start-regexp)
3579 (goto-char (min (match-end 0)
3580 comment-text-end))
3581 (forward-char 2)
3582 (skip-chars-forward " \t"))
3584 (when (eq (char-syntax (char-before)) ?\ )
3585 ;; If there's ws on the current line, we'll use it
3586 ;; instead of what's ending comment-prefix.
3587 (setq comment-prefix
3588 (concat (substring comment-prefix
3589 0 (string-match
3590 "\\s *\\'"
3591 comment-prefix))
3592 (buffer-substring-no-properties
3593 (save-excursion
3594 (skip-chars-backward " \t")
3595 (point))
3596 (point)))))
3598 (setq tmp-pre (point-marker))
3600 ;; We insert an extra non-whitespace character
3601 ;; before the line break and after comment-prefix in
3602 ;; case it's "" or ends with whitespace.
3603 (insert-and-inherit "x\n" comment-prefix "x")
3604 (setq tmp-post (point-marker))
3606 (indent-according-to-mode)
3608 (goto-char (1- tmp-post))
3609 (cons (buffer-substring-no-properties
3610 (c-point 'bol) (point))
3611 (current-column)))
3613 (when tmp-post
3614 (delete-region tmp-pre tmp-post)
3615 (set-marker tmp-pre nil)
3616 (set-marker tmp-post nil))))))))))
3618 (or res ; Found a good prefix above.
3620 (save-excursion
3621 ;; prefix-line is the bol of a line on which we should try
3622 ;; to find the prefix.
3623 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3624 (test-line
3625 (lambda ()
3626 (when (and (looking-at prefix-regexp)
3627 (<= (match-end 0) comment-text-end))
3628 (unless (eq (match-end 0) (c-point 'eol))
3629 ;; The match is fine if there's text after it.
3630 (throw 'found (cons (buffer-substring-no-properties
3631 (match-beginning 0) (match-end 0))
3632 (progn (goto-char (match-end 0))
3633 (current-column)))))
3634 (unless fb-string
3635 ;; This match is better than nothing, so let's
3636 ;; remember it in case nothing better is found
3637 ;; on another line.
3638 (setq fb-string (buffer-substring-no-properties
3639 (match-beginning 0) (match-end 0))
3640 fb-endpos (match-end 0)))
3641 t))))
3643 (or (catch 'found
3644 ;; Search for a line which has text after the prefix
3645 ;; so that we get the proper amount of whitespace
3646 ;; after it. We start with the current line, then
3647 ;; search backwards, then forwards.
3649 (goto-char prefix-line)
3650 (when (and (funcall test-line)
3651 (or (/= (match-end 1) (match-end 0))
3652 ;; The whitespace is sucked up by the
3653 ;; first [ \t]* glob if the prefix is empty.
3654 (and (= (match-beginning 1) (match-end 1))
3655 (/= (match-beginning 0) (match-end 0)))))
3656 ;; If the current line doesn't have text but do
3657 ;; have whitespace after the prefix, we'll use it.
3658 (throw 'found (cons fb-string
3659 (progn (goto-char fb-endpos)
3660 (current-column)))))
3662 (if (eq lit-type 'c++)
3663 ;; For line comments we can search up to and
3664 ;; including the first line.
3665 (while (and (zerop (forward-line -1))
3666 (>= (point) (car lit-limits)))
3667 (funcall test-line))
3668 ;; For block comments we must stop before the
3669 ;; block starter.
3670 (while (and (zerop (forward-line -1))
3671 (> (point) (car lit-limits)))
3672 (funcall test-line)))
3674 (goto-char prefix-line)
3675 (while (and (zerop (forward-line 1))
3676 (< (point) (cdr lit-limits)))
3677 (funcall test-line))
3679 (goto-char prefix-line)
3680 nil)
3682 (when fb-string
3683 ;; A good line wasn't found, but at least we have a
3684 ;; fallback that matches the comment prefix regexp.
3685 (cond ((or (string-match "\\s \\'" fb-string)
3686 (progn
3687 (goto-char fb-endpos)
3688 (not (eolp))))
3689 ;; There are ws or text after the prefix, so
3690 ;; let's use it.
3691 (cons fb-string (current-column)))
3693 ((progn
3694 ;; Check if there's any whitespace padding
3695 ;; on the comment start line that we can
3696 ;; use after the prefix.
3697 (goto-char (car lit-limits))
3698 (if (looking-at comment-start-regexp)
3699 (goto-char (match-end 0))
3700 (forward-char 2)
3701 (skip-chars-forward " \t"))
3702 (or (not (eolp))
3703 (eq (char-syntax (char-before)) ?\ )))
3705 (setq fb-string (buffer-substring-no-properties
3706 (save-excursion
3707 (skip-chars-backward " \t")
3708 (point))
3709 (point)))
3710 (goto-char fb-endpos)
3711 (skip-chars-backward " \t")
3713 (let ((tmp (point)))
3714 ;; Got to mess in the buffer once again to
3715 ;; ensure the column gets correct. :P
3716 (unwind-protect
3717 (progn
3718 (insert-and-inherit fb-string)
3719 (cons (buffer-substring-no-properties
3720 (c-point 'bol)
3721 (point))
3722 (current-column)))
3723 (delete-region tmp (point)))))
3726 ;; Last resort: Just add a single space after
3727 ;; the prefix.
3728 (cons (concat fb-string " ")
3729 (progn (goto-char fb-endpos)
3730 (1+ (current-column)))))))
3732 ;; The line doesn't match the comment prefix regexp.
3733 (if comment-prefix
3734 ;; We have a fallback for line comments that we must use.
3735 (cons (concat (buffer-substring-no-properties
3736 prefix-line (c-point 'boi))
3737 comment-prefix)
3738 (progn (back-to-indentation)
3739 (+ (current-column) (length comment-prefix))))
3741 ;; Assume we are dealing with a "free text" block
3742 ;; comment where the lines doesn't have any comment
3743 ;; prefix at all and we should just fill it as
3744 ;; normal text.
3745 '("" . 0))))))
3748 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
3749 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3750 ;; masked to allow adaptive filling to work correctly. That
3751 ;; includes narrowing the buffer and, if point is inside a comment,
3752 ;; masking the comment starter and ender appropriately.
3754 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3755 ;; The position of point is then less significant when doing masking
3756 ;; and narrowing.
3758 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3759 ;; only if the point turns out to be inside a comment or a string.
3761 ;; Note that this function does not do any hidden buffer changes.
3763 (let (fill
3764 ;; beg and end limit the region to narrow. end is a marker.
3765 beg end
3766 ;; tmp-pre and tmp-post mark strings that are temporarily
3767 ;; inserted at the start and end of the region. tmp-pre is a
3768 ;; cons of the positions of the prepended string. tmp-post is
3769 ;; a marker pointing to the single character of the appended
3770 ;; string.
3771 tmp-pre tmp-post
3772 ;; If hang-ender-stuck isn't nil, the comment ender is
3773 ;; hanging. In that case it's set to the number of spaces
3774 ;; that should be between the text and the ender.
3775 hang-ender-stuck
3776 ;; auto-fill-spaces is the exact sequence of whitespace between a
3777 ;; comment's last word and the comment ender, temporarily replaced
3778 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
3779 auto-fill-spaces
3780 (here (point))
3781 (c-lit-limits c-lit-limits)
3782 (c-lit-type c-lit-type))
3784 ;; Restore point on undo. It's necessary since we do a lot of
3785 ;; hidden inserts and deletes below that should be as transparent
3786 ;; as possible.
3787 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
3788 (setq buffer-undo-list (cons (point) buffer-undo-list)))
3790 ;; Determine the limits and type of the containing literal (if any):
3791 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
3792 ;; BEG and END.
3793 (c-save-buffer-state ()
3794 (save-restriction
3795 ;; Widen to catch comment limits correctly.
3796 (widen)
3797 (unless c-lit-limits
3798 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
3799 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
3800 (unless c-lit-type
3801 (setq c-lit-type (c-literal-type c-lit-limits))))
3803 (save-excursion
3804 (unless (c-safe (backward-char)
3805 (forward-paragraph)
3806 (>= (point) here))
3807 (goto-char here)
3808 (forward-paragraph))
3809 (setq end (point-marker)))
3810 (save-excursion
3811 (unless (c-safe (forward-char)
3812 (backward-paragraph)
3813 (<= (point) here))
3814 (goto-char here)
3815 (backward-paragraph))
3816 (setq beg (point))))
3818 (unwind-protect
3819 (progn
3820 ;; For each of the possible types of text (string, C comment ...)
3821 ;; determine BEG and END, the region we will narrow to. If we're in
3822 ;; a literal, constrain BEG and END to the limits of this literal.
3824 ;; For some of these text types, particularly a block comment, we
3825 ;; may need to massage whitespace near literal delimiters, so that
3826 ;; these don't get filled inappropriately.
3827 (cond
3829 ((eq c-lit-type 'c++) ; Line comment.
3830 (save-excursion
3831 ;; Limit to the comment or paragraph end, whichever
3832 ;; comes first.
3833 (set-marker end (min end (cdr c-lit-limits)))
3835 (when (<= beg (car c-lit-limits))
3836 ;; The region includes the comment starter, so we must
3837 ;; check it.
3838 (goto-char (car c-lit-limits))
3839 (back-to-indentation)
3840 (if (eq (point) (car c-lit-limits))
3841 ;; Include the first line in the region.
3842 (setq beg (c-point 'bol))
3843 ;; The first line contains code before the
3844 ;; comment. We must fake a line that doesn't.
3845 (setq tmp-pre t))))
3847 (setq apply-outside-literal t))
3849 ((eq c-lit-type 'c) ; Block comment.
3850 (when
3851 (or (> end (cdr c-lit-limits))
3852 (and (= end (cdr c-lit-limits))
3853 (eq (char-before end) ?/)
3854 (eq (char-before (1- end)) ?*)
3855 ;; disallow "/*/"
3856 (> (- (cdr c-lit-limits) (car c-lit-limits)) 3)))
3857 ;; There is a comment ender, and the region includes it. If
3858 ;; it's on its own line, it stays on its own line. If it's got
3859 ;; company on the line, it keeps (at least one word of) it.
3860 ;; "=====*/" counts as a comment ender here, but "===== */"
3861 ;; doesn't and "foo*/" doesn't.
3862 (unless
3863 (save-excursion
3864 (goto-char (cdr c-lit-limits))
3865 (beginning-of-line)
3866 (and (search-forward-regexp
3867 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
3868 (- (cdr c-lit-limits) 2) t)
3869 (not (search-forward-regexp
3870 "\\(\\s \\|\\sw\\)"
3871 (- (cdr c-lit-limits) 2) 'limit))
3872 ;; The comment ender IS on its own line. Exclude
3873 ;; this line from the filling.
3874 (set-marker end (c-point 'bol))))
3876 ;; The comment ender is hanging. Replace all space between it
3877 ;; and the last word either by one or two 'x's (when
3878 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
3879 ;; as the whitespace (when auto filling), and include it in
3880 ;; the region. We'll change them back to whitespace
3881 ;; afterwards. The effect of this is to glue the comment
3882 ;; ender to the last word in the comment during filling.
3883 (let* ((ender-start (save-excursion
3884 (goto-char (cdr c-lit-limits))
3885 (skip-syntax-backward "^w ")
3886 (point)))
3887 (ender-column (save-excursion
3888 (goto-char ender-start)
3889 (current-column)))
3890 (point-rel (- ender-start here))
3891 spaces)
3893 (save-excursion
3894 ;; Insert a CR after the "*/", adjust END
3895 (goto-char (cdr c-lit-limits))
3896 (setq tmp-post (point-marker))
3897 (insert ?\n)
3898 (set-marker end (point))
3900 (forward-line -1) ; last line of the comment
3901 (if (and (looking-at (concat "[ \t]*\\(\\("
3902 c-current-comment-prefix
3903 "\\)[ \t]*\\)"))
3904 (eq ender-start (match-end 0)))
3905 ;; The comment ender is prefixed by nothing but a
3906 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
3907 ;; 2006/4/28). Remove it along with surrounding ws.
3908 (setq spaces (- (match-end 1) (match-end 2)))
3909 (goto-char ender-start))
3910 (skip-chars-backward " \t\r\n") ; Surely this can be
3911 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
3913 ;; What's being tested here? 2006/4/20. FIXME!!!
3914 (if (/= (point) ender-start)
3915 (progn
3916 (if (<= here (point))
3917 ;; Don't adjust point below if it's
3918 ;; before the string we replace.
3919 (setq point-rel -1))
3920 ;; Keep one or two spaces between the
3921 ;; text and the ender, depending on how
3922 ;; many there are now.
3923 (unless spaces
3924 (setq spaces (- ender-column (current-column))))
3925 (setq auto-fill-spaces (c-delete-and-extract-region
3926 (point) ender-start))
3927 ;; paragraph filling condenses multiple spaces to
3928 ;; single or double spaces. auto-fill doesn't.
3929 (if fill-paragraph
3930 (setq spaces
3931 (max
3932 (min spaces
3933 (if sentence-end-double-space 2 1))
3934 1)))
3935 ;; Insert the filler first to keep marks right.
3936 (insert-char ?x spaces t)
3937 (setq hang-ender-stuck spaces)
3938 (setq point-rel
3939 (and (>= point-rel 0)
3940 (- (point) (min point-rel spaces)))))
3941 (setq point-rel nil)))
3943 (if point-rel
3944 ;; Point was in the middle of the string we
3945 ;; replaced above, so put it back in the same
3946 ;; relative position, counting from the end.
3947 (goto-char point-rel)))
3950 (when (<= beg (car c-lit-limits))
3951 ;; The region includes the comment starter.
3952 (save-excursion
3953 (goto-char (car c-lit-limits))
3954 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
3955 ;; Begin with the next line.
3956 (setq beg (c-point 'bonl))
3957 ;; Fake the fill prefix in the first line.
3958 (setq tmp-pre t))))
3960 (setq apply-outside-literal t))
3962 ((eq c-lit-type 'string) ; String.
3963 (save-excursion
3964 (when (>= end (cdr c-lit-limits))
3965 (goto-char (1- (cdr c-lit-limits)))
3966 (setq tmp-post (point-marker))
3967 (insert ?\n)
3968 (set-marker end (point)))
3969 (when (<= beg (car c-lit-limits))
3970 (goto-char (1+ (car c-lit-limits)))
3971 (setq beg (if (looking-at "\\\\$")
3972 ;; Leave the start line if it's
3973 ;; nothing but an escaped newline.
3974 (1+ (match-end 0))
3975 (point)))))
3976 (setq apply-outside-literal t))
3978 ((eq c-lit-type 'pound) ; Macro
3979 ;; Narrow to the macro limits if they are nearer than the
3980 ;; paragraph limits. Don't know if this is necessary but
3981 ;; do it for completeness sake (doing auto filling at all
3982 ;; inside macros is bogus to begin with since the line
3983 ;; continuation backslashes aren't handled).
3984 (save-excursion
3985 (c-save-buffer-state ()
3986 (c-beginning-of-macro)
3987 (beginning-of-line)
3988 (if (> (point) beg)
3989 (setq beg (point)))
3990 (c-end-of-macro)
3991 (forward-line)
3992 (if (< (point) end)
3993 (set-marker end (point))))))
3995 (t ; Other code.
3996 ;; Try to avoid comments and macros in the paragraph to
3997 ;; avoid that the adaptive fill mode gets the prefix from
3998 ;; them.
3999 (c-save-buffer-state nil
4000 (save-excursion
4001 (goto-char beg)
4002 (c-forward-syntactic-ws end)
4003 (beginning-of-line)
4004 (setq beg (point))
4005 (goto-char end)
4006 (c-backward-syntactic-ws beg)
4007 (forward-line)
4008 (set-marker end (point))))))
4010 (when tmp-pre
4011 ;; Temporarily insert the fill prefix after the comment
4012 ;; starter so that the first line looks like any other
4013 ;; comment line in the narrowed region.
4014 (setq fill (c-save-buffer-state nil
4015 (c-guess-fill-prefix c-lit-limits c-lit-type)))
4016 (unless (string-match (concat "\\`[ \t]*\\("
4017 c-current-comment-prefix
4018 "\\)[ \t]*\\'")
4019 (car fill))
4020 ;; Oops, the prefix doesn't match the comment prefix
4021 ;; regexp. This could produce very confusing
4022 ;; results with adaptive fill packages together with
4023 ;; the insert prefix magic below, since the prefix
4024 ;; often doesn't appear at all. So let's warn about
4025 ;; it.
4026 (message "\
4027 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4028 (car fill)))
4029 ;; Find the right spot on the line, break it, insert
4030 ;; the fill prefix and make sure we're back in the
4031 ;; same column by temporarily prefixing the first word
4032 ;; with a number of 'x'.
4033 (save-excursion
4034 (goto-char (car c-lit-limits))
4035 (if (looking-at (if (eq c-lit-type 'c++)
4036 c-current-comment-prefix
4037 comment-start-skip))
4038 (goto-char (match-end 0))
4039 (forward-char 2)
4040 (skip-chars-forward " \t"))
4041 (while (and (< (current-column) (cdr fill))
4042 (not (eolp)))
4043 (forward-char 1))
4044 (let ((col (current-column)))
4045 (setq beg (1+ (point))
4046 tmp-pre (list (point)))
4047 (unwind-protect
4048 (progn
4049 (insert-and-inherit "\n" (car fill))
4050 (insert-char ?x (- col (current-column)) t))
4051 (setcdr tmp-pre (point))))))
4053 (when apply-outside-literal
4054 ;; `apply-outside-literal' is always set to t here if
4055 ;; we're inside a literal.
4057 (let ((fill-prefix
4058 (or fill-prefix
4059 ;; Kludge: If the function that adapts the fill prefix
4060 ;; doesn't produce the required comment starter for
4061 ;; line comments, then force it by setting fill-prefix.
4062 (when (and (eq c-lit-type 'c++)
4063 ;; Kludge the kludge: filladapt-mode doesn't
4064 ;; have this problem, but it currently
4065 ;; doesn't override fill-context-prefix
4066 ;; (version 2.12).
4067 (not (and (boundp 'filladapt-mode)
4068 filladapt-mode))
4069 (not (string-match
4070 "\\`[ \t]*//"
4071 (or (fill-context-prefix beg end)
4072 ""))))
4073 (c-save-buffer-state nil
4074 (car (or fill (c-guess-fill-prefix
4075 c-lit-limits c-lit-type)))))))
4077 ;; Save the relative position of point if it's outside the
4078 ;; region we're going to narrow. Want to restore it in that
4079 ;; case, but otherwise it should be moved according to the
4080 ;; called function.
4081 (point-rel (cond ((< (point) beg) (- (point) beg))
4082 ((> (point) end) (- (point) end)))))
4084 ;; Preparations finally done! Now we can call the
4085 ;; actual function.
4086 (prog1
4087 (save-restriction
4088 (narrow-to-region beg end)
4089 (apply fun args))
4090 (if point-rel
4091 ;; Restore point if it was outside the region.
4092 (if (< point-rel 0)
4093 (goto-char (+ beg point-rel))
4094 (goto-char (+ end point-rel))))))))
4096 (when (consp tmp-pre)
4097 (delete-region (car tmp-pre) (cdr tmp-pre)))
4099 (when tmp-post
4100 (save-excursion
4101 (goto-char tmp-post)
4102 (delete-char 1))
4103 (when hang-ender-stuck
4104 ;; Preserve point even if it's in the middle of the string
4105 ;; we replace; save-excursion doesn't work in that case.
4106 (setq here (point))
4107 (goto-char tmp-post)
4108 (skip-syntax-backward "^w ")
4109 (forward-char (- hang-ender-stuck))
4110 (if (or fill-paragraph (not auto-fill-spaces))
4111 (insert-char ?\ hang-ender-stuck t)
4112 (insert auto-fill-spaces)
4113 (setq here (- here (- hang-ender-stuck (length auto-fill-spaces)))))
4114 (delete-char hang-ender-stuck)
4115 (goto-char here))
4116 (set-marker tmp-post nil))
4118 (set-marker end nil))))
4120 (defun c-fill-paragraph (&optional arg)
4121 "Like \\[fill-paragraph] but handles C and C++ style comments.
4122 If any of the current line is a comment or within a comment, fill the
4123 comment or the paragraph of it that point is in, preserving the
4124 comment indentation or line-starting decorations (see the
4125 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4126 details).
4128 If point is inside multiline string literal, fill it. This currently
4129 does not respect escaped newlines, except for the special case when it
4130 is the very first thing in the string. The intended use for this rule
4131 is in situations like the following:
4133 char description[] = \"\\
4134 A very long description of something that you want to fill to make
4135 nicely formatted output.\"\;
4137 If point is in any other situation, i.e. in normal code, do nothing.
4139 Optional prefix ARG means justify paragraph as well."
4140 (interactive "*P")
4141 (let ((fill-paragraph-function
4142 ;; Avoid infinite recursion.
4143 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4144 fill-paragraph-function)))
4145 (c-mask-paragraph t nil 'fill-paragraph arg))
4146 ;; Always return t. This has the effect that if filling isn't done
4147 ;; above, it isn't done at all, and it's therefore effectively
4148 ;; disabled in normal code.
4151 (defun c-do-auto-fill ()
4152 ;; Do automatic filling if not inside a context where it should be
4153 ;; ignored.
4154 (let ((c-auto-fill-prefix
4155 ;; The decision whether the line should be broken is actually
4156 ;; done in c-indent-new-comment-line, which do-auto-fill
4157 ;; calls to break lines. We just set this special variable
4158 ;; so that we'll know when we're called from there. It's
4159 ;; also used to detect whether fill-prefix is user set or
4160 ;; generated automatically by do-auto-fill.
4161 fill-prefix))
4162 (c-mask-paragraph nil t 'do-auto-fill)))
4164 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4165 "Break line at point and indent, continuing comment or macro if within one.
4166 If inside a comment and `comment-multi-line' is non-nil, the
4167 indentation and line prefix are preserved (see the
4168 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4169 details). If inside a single line comment and `comment-multi-line' is
4170 nil, a new comment of the same type is started on the next line and
4171 indented as appropriate for comments. If inside a macro, a line
4172 continuation backslash is inserted and aligned as appropriate, and the
4173 new line is indented according to `c-syntactic-indentation'.
4175 If a fill prefix is specified, it overrides all the above."
4176 ;; allow-auto-fill is used from c-context-line-break to allow auto
4177 ;; filling to break the line more than once. Since this function is
4178 ;; used from auto-fill itself, that's normally disabled to avoid
4179 ;; unnecessary recursion.
4180 (interactive)
4181 (let ((fill-prefix fill-prefix)
4182 (do-line-break
4183 (lambda ()
4184 (delete-horizontal-space)
4185 (if soft
4186 (insert-and-inherit ?\n)
4187 (newline (if allow-auto-fill nil 1)))))
4188 ;; Already know the literal type and limits when called from
4189 ;; c-context-line-break.
4190 (c-lit-limits c-lit-limits)
4191 (c-lit-type c-lit-type)
4192 (c-macro-start c-macro-start))
4194 (c-save-buffer-state ()
4195 (when (not (eq c-auto-fill-prefix t))
4196 ;; Called from do-auto-fill.
4197 (unless c-lit-limits
4198 (setq c-lit-limits (c-literal-limits nil nil t)))
4199 (unless c-lit-type
4200 (setq c-lit-type (c-literal-type c-lit-limits)))
4201 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4202 ((null c-lit-type) 'code)
4203 (t c-lit-type))
4204 c-ignore-auto-fill)
4205 (setq fill-prefix t) ; Used as flag in the cond.
4206 (if (and (null c-auto-fill-prefix)
4207 (eq c-lit-type 'c)
4208 (<= (c-point 'bol) (car c-lit-limits)))
4209 ;; The adaptive fill function has generated a prefix, but
4210 ;; we're on the first line in a block comment so it'll be
4211 ;; wrong. Ignore it to guess a better one below.
4212 (setq fill-prefix nil)
4213 (when (and (eq c-lit-type 'c++)
4214 (not (string-match (concat "\\`[ \t]*"
4215 c-line-comment-starter)
4216 (or fill-prefix ""))))
4217 ;; Kludge: If the function that adapted the fill prefix
4218 ;; doesn't produce the required comment starter for line
4219 ;; comments, then we ignore it.
4220 (setq fill-prefix nil)))
4223 (cond ((eq fill-prefix t)
4224 ;; A call from do-auto-fill which should be ignored.
4226 (fill-prefix
4227 ;; A fill-prefix overrides anything.
4228 (funcall do-line-break)
4229 (insert-and-inherit fill-prefix))
4230 ((c-save-buffer-state ()
4231 (unless c-lit-limits
4232 (setq c-lit-limits (c-literal-limits)))
4233 (unless c-lit-type
4234 (setq c-lit-type (c-literal-type c-lit-limits)))
4235 (memq c-lit-type '(c c++)))
4236 ;; Some sort of comment.
4237 (if (or comment-multi-line
4238 (save-excursion
4239 (goto-char (car c-lit-limits))
4240 (end-of-line)
4241 (< (point) (cdr c-lit-limits))))
4242 ;; Inside a comment that should be continued.
4243 (let ((fill (c-save-buffer-state nil
4244 (c-guess-fill-prefix
4245 (setq c-lit-limits
4246 (c-collect-line-comments c-lit-limits))
4247 c-lit-type)))
4248 (pos (point))
4249 (start-col (current-column))
4250 (comment-text-end
4251 (or (and (eq c-lit-type 'c)
4252 (save-excursion
4253 (goto-char (- (cdr c-lit-limits) 2))
4254 (if (looking-at "\\*/") (point))))
4255 (cdr c-lit-limits))))
4256 ;; Skip forward past the fill prefix in case
4257 ;; we're standing in it.
4259 ;; FIXME: This doesn't work well in cases like
4261 ;; /* Bla bla bla bla bla
4262 ;; bla bla
4264 ;; If point is on the 'B' then the line will be
4265 ;; broken after "Bla b".
4267 ;; If we have an empty comment, /* */, the next
4268 ;; lot of code pushes point to the */. We fix
4269 ;; this by never allowing point to end up to the
4270 ;; right of where it started.
4271 (while (and (< (current-column) (cdr fill))
4272 (not (eolp)))
4273 (forward-char 1))
4274 (if (and (> (point) comment-text-end)
4275 (> (c-point 'bol) (car c-lit-limits)))
4276 (progn
4277 ;; The skip takes us out of the (block)
4278 ;; comment; insert the fill prefix at bol
4279 ;; instead and keep the position.
4280 (setq pos (copy-marker pos t))
4281 (beginning-of-line)
4282 (insert-and-inherit (car fill))
4283 (if soft (insert-and-inherit ?\n) (newline 1))
4284 (goto-char pos)
4285 (set-marker pos nil))
4286 ;; Don't break in the middle of a comment starter
4287 ;; or ender.
4288 (cond ((> (point) comment-text-end)
4289 (goto-char comment-text-end))
4290 ((< (point) (+ (car c-lit-limits) 2))
4291 (goto-char (+ (car c-lit-limits) 2))))
4292 (funcall do-line-break)
4293 (insert-and-inherit (car fill))
4294 (if (> (current-column) start-col)
4295 (move-to-column start-col)))) ; can this hit the
4296 ; middle of a TAB?
4297 ;; Inside a comment that should be broken.
4298 (let ((comment-start comment-start)
4299 (comment-end comment-end)
4300 col)
4301 (if (eq c-lit-type 'c)
4302 (unless (string-match "[ \t]*/\\*" comment-start)
4303 (setq comment-start "/* " comment-end " */"))
4304 (unless (string-match "[ \t]*//" comment-start)
4305 (setq comment-start "// " comment-end "")))
4306 (setq col (save-excursion
4307 (back-to-indentation)
4308 (current-column)))
4309 (funcall do-line-break)
4310 (when (and comment-end (not (equal comment-end "")))
4311 (forward-char -1)
4312 (insert-and-inherit comment-end)
4313 (forward-char 1))
4314 ;; c-comment-indent may look at the current
4315 ;; indentation, so let's start out with the same
4316 ;; indentation as the previous one.
4317 (indent-to col)
4318 (insert-and-inherit comment-start)
4319 (indent-for-comment))))
4320 ((c-query-and-set-macro-start)
4321 ;; In a macro.
4322 (unless (looking-at "[ \t]*\\\\$")
4323 ;; Do not clobber the alignment of the line continuation
4324 ;; slash; c-backslash-region might look at it.
4325 (delete-horizontal-space))
4326 ;; Got an asymmetry here: In normal code this command
4327 ;; doesn't indent the next line syntactically, and otoh a
4328 ;; normal syntactically indenting newline doesn't continue
4329 ;; the macro.
4330 (c-newline-and-indent (if allow-auto-fill nil 1)))
4332 ;; Somewhere else in the code.
4333 (let ((col (save-excursion
4334 (beginning-of-line)
4335 (while (and (looking-at "[ \t]*\\\\?$")
4336 (= (forward-line -1) 0)))
4337 (current-indentation))))
4338 (funcall do-line-break)
4339 (indent-to col))))))
4341 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
4342 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line)
4344 ;; advice for indent-new-comment-line for older Emacsen
4345 (unless (boundp 'comment-line-break-function)
4346 (defvar c-inside-line-break-advice nil)
4347 (defadvice indent-new-comment-line (around c-line-break-advice
4348 activate preactivate)
4349 "Call `c-indent-new-comment-line' if in CC Mode."
4350 (if (or c-inside-line-break-advice
4351 (not c-buffer-is-cc-mode))
4352 ad-do-it
4353 (let ((c-inside-line-break-advice t))
4354 (c-indent-new-comment-line (ad-get-arg 0))))))
4356 (defun c-context-line-break ()
4357 "Do a line break suitable to the context.
4359 When point is outside a comment or macro, insert a newline and indent
4360 according to the syntactic context, unless `c-syntactic-indentation'
4361 is nil, in which case the new line is indented as the previous
4362 non-empty line instead.
4364 When point is inside the content of a preprocessor directive, a line
4365 continuation backslash is inserted before the line break and aligned
4366 appropriately. The end of the cpp directive doesn't count as inside
4369 When point is inside a comment, continue it with the appropriate
4370 comment prefix (see the `c-comment-prefix-regexp' and
4371 `c-block-comment-prefix' variables for details). The end of a
4372 C++-style line comment doesn't count as inside it.
4374 When point is inside a string, only insert a backslash when it is also
4375 inside a preprocessor directive."
4377 (interactive "*")
4378 (let* (c-lit-limits c-lit-type
4379 (c-macro-start c-macro-start))
4381 (c-save-buffer-state ()
4382 (setq c-lit-limits (c-literal-limits nil nil t)
4383 c-lit-type (c-literal-type c-lit-limits))
4384 (when (eq c-lit-type 'c++)
4385 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4386 (c-query-and-set-macro-start))
4388 (cond
4389 ((or (eq c-lit-type 'c)
4390 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4391 (< (save-excursion
4392 (skip-chars-forward " \t")
4393 (point))
4394 (1- (cdr c-lit-limits))))
4395 (and (numberp c-macro-start) ; Macro, but not at the very end of
4396 ; it, not in a string, and not in the
4397 ; cpp keyword.
4398 (not (eq c-lit-type 'string))
4399 (or (not (looking-at "\\s *$"))
4400 (eq (char-before) ?\\))
4401 (<= (save-excursion
4402 (goto-char c-macro-start)
4403 (if (looking-at c-opt-cpp-start)
4404 (goto-char (match-end 0)))
4405 (point))
4406 (point))))
4407 (let ((comment-multi-line t)
4408 (fill-prefix nil))
4409 (c-indent-new-comment-line nil t)))
4411 ((eq c-lit-type 'string)
4412 (if (and (numberp c-macro-start)
4413 (not (eq (char-before) ?\\)))
4414 (insert ?\\))
4415 (newline))
4417 (t (delete-horizontal-space)
4418 (newline)
4419 ;; c-indent-line may look at the current indentation, so let's
4420 ;; start out with the same indentation as the previous line.
4421 (let ((col (save-excursion
4422 (backward-char)
4423 (forward-line 0)
4424 (while (and (looking-at "[ \t]*\\\\?$")
4425 (= (forward-line -1) 0)))
4426 (current-indentation))))
4427 (indent-to col))
4428 (indent-according-to-mode)))))
4430 (defun c-context-open-line ()
4431 "Insert a line break suitable to the context and leave point before it.
4432 This is the `c-context-line-break' equivalent to `open-line', which is
4433 normally bound to C-o. See `c-context-line-break' for the details."
4434 (interactive "*")
4435 (let ((here (point)))
4436 (unwind-protect
4437 (progn
4438 ;; Temporarily insert a non-whitespace char to keep any
4439 ;; preceding whitespace intact.
4440 (insert ?x)
4441 (c-context-line-break))
4442 (goto-char here)
4443 (delete-char 1))))
4446 (cc-provide 'cc-cmds)
4448 ;;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
4449 ;;; cc-cmds.el ends here