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