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