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