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