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