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