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