* progmodes/cc-cmds.el (c-beginning-of-defun, c-end-of-defun):
[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
38d93f03
AM
1504 (or (not (eq this-command 'c-beginning-of-defun))
1505 (eq last-command 'c-beginning-of-defun)
1506 (and transient-mark-mode mark-active)
1507 (push-mark))
1508
51c9af45 1509 (c-save-buffer-state
28abe5e2
AM
1510 (beginning-of-defun-function end-of-defun-function
1511 (start (point))
51c9af45 1512 where paren-state pos)
a66cd3ee 1513
51c9af45
AM
1514 ;; Move back out of any macro/comment/string we happen to be in.
1515 (c-beginning-of-macro)
1516 (setq pos (c-literal-limits))
1517 (if pos (goto-char (car pos)))
1518
1519 (setq where (c-where-wrt-brace-construct))
1520
1521 (if (< arg 0)
1522 ;; Move forward to the closing brace of a function.
1523 (progn
15279e74 1524 (if (memq where '(at-function-end outwith-function))
51c9af45
AM
1525 (setq arg (1+ arg)))
1526 (if (< arg 0)
1527 (setq arg (c-forward-to-nth-EOF-} (- arg) where)))
1528 ;; Move forward to the next opening brace....
1529 (when (and (= arg 0)
f7510c40 1530 (c-syntactic-re-search-forward "{" nil 'eob))
51c9af45
AM
1531 (backward-char)
1532 ;; ... and backward to the function header.
1533 (c-beginning-of-decl-1)
1534 t))
1535
1536 ;; Move backward to the opening brace of a function.
1537 (when (and (> arg 0)
1538 (eq (setq arg (c-backward-to-nth-BOF-{ arg where)) 0))
1539
1540 ;; Go backward to this function's header.
1541 (c-beginning-of-decl-1)
1542
1543 (setq pos (point))
1544 ;; We're now there, modulo comments and whitespace.
1545 ;; Try to be line oriented; position point at the closest
1546 ;; preceding boi that isn't inside a comment, but if we hit
1547 ;; the previous declaration then we use the current point
1548 ;; instead.
1549 (while (and (/= (point) (c-point 'boi))
1550 (c-backward-single-comment)))
1551 (if (/= (point) (c-point 'boi))
1552 (goto-char pos)))
1553
1554 (c-keep-region-active)
1555 (= arg 0))))
1556
1557(defun c-forward-to-nth-EOF-} (n where)
1558 ;; Skip to the closing brace of the Nth function after point. If
1559 ;; point is inside a function, this counts as the first. Point must be
1560 ;; outside any comment/string or macro.
1561 ;;
1562 ;; N must be strictly positive.
1563 ;; WHERE describes the position of point, one of the symbols `at-header',
1564 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1565 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1566 ;;
1567 ;; If we run out of functions, leave point at EOB. Return zero on success,
1568 ;; otherwise the number of }s still to go.
1569 ;;
1570 ;; This function may do hidden buffer changes.
1571
1572 (cond
1573 ;; What we do to go forward over the first defun depends on where we
1574 ;; start. We go to the closing brace of that defun, even when we go
1575 ;; backwards to it (in a "struct foo {...} bar ;").
1576 ((eobp))
1577 ((eq where 'in-block)
1578 (goto-char (c-least-enclosing-brace (c-parse-state)))
1579 (forward-sexp)
1580 (setq n (1- n)))
1581 ((eq where 'in-trailer)
1582 (c-syntactic-skip-backward "^}")
1583 (setq n (1- n)))
15279e74
AM
1584 ((memq where '(at-function-end outwith-function at-header in-header))
1585 (when (c-syntactic-re-search-forward "{" nil 'eob)
1586 (backward-char)
1587 (forward-sexp)
1588 (setq n (1- n))))
51c9af45
AM
1589 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1590
1591 ;; Each time round the loop, go forward to a "}" at the outermost level.
1592 (while (and (> n 0) (not (eobp)))
1593 ;(c-parse-state) ; This call speeds up the following one by a factor
1594 ; of ~6. Hmmm. 2006/4/5.
1595 (when (c-syntactic-re-search-forward "{" nil 'eob)
1596 (backward-char)
1597 (forward-sexp))
1598 (setq n (1- n)))
1599 n)
28c236de
RS
1600
1601(defun c-end-of-defun (&optional arg)
a66cd3ee
MS
1602 "Move forward to the end of a top level declaration.
1603With argument, do it that many times. Negative argument -N means move
1604back to Nth preceding end. Returns t unless search stops due to
1605beginning or end of buffer.
28c236de
RS
1606
1607An end of a defun occurs right after the close-parenthesis that matches
1608the open-parenthesis that starts a defun; see `beginning-of-defun'."
1609 (interactive "p")
a66cd3ee
MS
1610 (or arg (setq arg 1))
1611
38d93f03
AM
1612 (or (not (eq this-command 'c-end-of-defun))
1613 (eq last-command 'c-end-of-defun)
1614 (and transient-mark-mode mark-active)
1615 (push-mark))
1616
51c9af45 1617 (c-save-buffer-state
28abe5e2
AM
1618 (beginning-of-defun-function end-of-defun-function
1619 (start (point))
51c9af45
AM
1620 where paren-state pos)
1621
1622 ;; Move back out of any macro/comment/string we happen to be in.
1623 (c-beginning-of-macro)
1624 (setq pos (c-literal-limits))
1625 (if pos (goto-char (car pos)))
1626
1627 (setq where (c-where-wrt-brace-construct))
1628
1629 (if (< arg 0)
1630 ;; Move backwards to the } of a function
1631 (progn
15279e74 1632 (if (memq where '(at-header outwith-function))
51c9af45
AM
1633 (setq arg (1+ arg)))
1634 (if (< arg 0)
1635 (setq arg (c-backward-to-nth-BOF-{ (- arg) where)))
de5c0bc1
AM
1636 (if (= arg 0)
1637 (c-syntactic-skip-backward "^}")))
51c9af45
AM
1638
1639 ;; Move forward to the } of a function
1640 (if (> arg 0)
1641 (setq arg (c-forward-to-nth-EOF-} arg where))))
1642
1643 ;; Do we need to move forward from the brace to the semicolon?
1644 (when (eq arg 0)
1645 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1646 (c-syntactic-re-search-forward ";"))
1647
1648 (setq pos (point))
1649 ;; We're there now, modulo comments and whitespace.
1650 ;; Try to be line oriented; position point after the next
1651 ;; newline that isn't inside a comment, but if we hit the
1652 ;; next declaration then we use the current point instead.
1653 (while (and (not (bolp))
1654 (not (looking-at "\\s *$"))
1655 (c-forward-single-comment)))
1656 (cond ((bolp))
1657 ((looking-at "\\s *$")
1658 (forward-line 1))
1659 (t
1660 (goto-char pos))))
a66cd3ee 1661
51f606de
GM
1662 (c-keep-region-active)
1663 (= arg 0)))
28c236de 1664
fa7056bc
AM
1665(defun c-defun-name ()
1666 "Return the name of the current defun, or NIL if there isn't one.
1667\"Defun\" here means a function, or other top level construct
1668with a brace block."
1669 (interactive)
1670 (c-save-buffer-state
1671 (beginning-of-defun-function end-of-defun-function
1672 where pos name-end)
3f71582d 1673
649504a1
AM
1674 (save-restriction
1675 (widen)
1676 (save-excursion
1677 ;; Move back out of any macro/comment/string we happen to be in.
1678 (c-beginning-of-macro)
1679 (setq pos (c-literal-limits))
1680 (if pos (goto-char (car pos)))
1681
1682 (setq where (c-where-wrt-brace-construct))
1683
1684 ;; Move to the beginning of the current defun, if any, if we're not
1685 ;; already there.
1686 (if (eq where 'outwith-function)
1687 nil
1688 (unless (eq where 'at-header)
1689 (c-backward-to-nth-BOF-{ 1 where)
1690 (c-beginning-of-decl-1))
1691
1692 ;; Pick out the defun name, according to the type of defun.
1693 (cond
1694 ;; struct, union, enum, or similar:
1695 ((and (looking-at c-type-prefix-key)
1696 (progn (c-forward-token-2 2) ; over "struct foo "
1697 (or (eq (char-after) ?\{)
1698 (looking-at c-symbol-key)))) ; "struct foo bar ..."
1699 (save-match-data (c-forward-token-2))
1700 (when (eq (char-after) ?\{)
1701 (c-backward-token-2)
1702 (looking-at c-symbol-key))
1703 (match-string-no-properties 0))
1704
1705 ((looking-at "DEFUN\\_>")
1706 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1707 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1708 (down-list 1)
1709 (c-forward-syntactic-ws)
1710 (when (eq (char-after) ?\")
1711 (forward-sexp 1)
1712 (c-forward-token-2)) ; over the comma and following WS.
1713 (buffer-substring-no-properties
1714 (point)
1715 (progn
1716 (c-forward-token-2)
1717 (when (looking-at ":") ; CLISP: DEFUN(PACKAGE:LISP-SYMBOL,...)
1718 (skip-chars-forward "^,"))
1719 (c-backward-syntactic-ws)
1720 (point))))
1721
1722 ((looking-at "DEF[a-zA-Z0-9_]* *( *\\([^, ]*\\) *,")
1723 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1724 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1725 (match-string-no-properties 1))
1726
1727 (t
1728 ;; Normal function or initializer.
1729 (when (c-syntactic-re-search-forward "[{(]" nil t)
1730 (backward-char)
1731 (c-backward-syntactic-ws)
1732 (when (eq (char-before) ?\=) ; struct foo bar = {0, 0} ;
1733 (c-backward-token-2)
1734 (c-backward-syntactic-ws))
1735 (setq name-end (point))
fa7056bc 1736 (c-backward-token-2)
649504a1 1737 (buffer-substring-no-properties (point) name-end)))))))))
fa7056bc 1738
a66cd3ee
MS
1739(defun c-declaration-limits (near)
1740 ;; Return a cons of the beginning and end positions of the current
1741 ;; top level declaration or macro. If point is not inside any then
1742 ;; nil is returned, unless NEAR is non-nil in which case the closest
1743 ;; following one is chosen instead (if there is any). The end
1744 ;; position is at the next line, providing there is one before the
1745 ;; declaration.
0386b551
AM
1746 ;;
1747 ;; This function might do hidden buffer changes.
a66cd3ee
MS
1748 (save-excursion
1749
1750 ;; Note: Some code duplication in `c-beginning-of-defun' and
1751 ;; `c-end-of-defun'.
1752 (catch 'exit
1753 (let ((start (point))
1754 (paren-state (c-parse-state))
1755 lim pos end-pos)
1756 (unless (c-safe
1757 (goto-char (c-least-enclosing-brace paren-state))
1758 ;; If we moved to the outermost enclosing paren then we
1759 ;; can use c-safe-position to set the limit. Can't do
1760 ;; that otherwise since the earlier paren pair on
1761 ;; paren-state might very well be part of the
1762 ;; declaration we should go to.
1763 (setq lim (c-safe-position (point) paren-state))
1764 t)
1765 ;; At top level. Make sure we aren't inside a literal.
1766 (setq pos (c-literal-limits
1767 (c-safe-position (point) paren-state)))
1768 (if pos (goto-char (car pos))))
1769
1770 (when (c-beginning-of-macro)
1771 (throw 'exit
1772 (cons (point)
1773 (save-excursion
1774 (c-end-of-macro)
1775 (forward-line 1)
1776 (point)))))
1777
1778 (setq pos (point))
1779 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1780 (= pos (point)))
1781 ;; We moved back over the previous defun. Skip to the next
1782 ;; one. Not using c-forward-syntactic-ws here since we
1783 ;; should not skip a macro. We can also be directly after
1784 ;; the block in a `c-opt-block-decls-with-vars-key'
1785 ;; declaration, but then we won't move significantly far
1786 ;; here.
1787 (goto-char pos)
d9e94c22 1788 (c-forward-comments)
a66cd3ee
MS
1789
1790 (when (and near (c-beginning-of-macro))
1791 (throw 'exit
1792 (cons (point)
1793 (save-excursion
1794 (c-end-of-macro)
1795 (forward-line 1)
1796 (point))))))
1797
1798 (if (eobp) (throw 'exit nil))
1799
1800 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1801 ;; declaration that doesn't end there. We're searching back and
1802 ;; forth over the block here, which can be expensive.
1803 (setq pos (point))
1804 (if (and c-opt-block-decls-with-vars-key
1805 (progn
1806 (c-backward-syntactic-ws)
1807 (eq (char-before) ?}))
1808 (eq (car (c-beginning-of-decl-1))
1809 'previous)
1810 (save-excursion
1811 (c-end-of-decl-1)
1812 (and (> (point) pos)
1813 (setq end-pos (point)))))
1814 nil
1815 (goto-char pos))
1816
1817 (if (and (not near) (> (point) start))
1818 nil
1819
1820 ;; Try to be line oriented; position the limits at the
1821 ;; closest preceding boi, and after the next newline, that
1822 ;; isn't inside a comment, but if we hit a neighboring
1823 ;; declaration then we instead use the exact declaration
1824 ;; limit in that direction.
1825 (cons (progn
1826 (setq pos (point))
1827 (while (and (/= (point) (c-point 'boi))
d9e94c22 1828 (c-backward-single-comment)))
a66cd3ee
MS
1829 (if (/= (point) (c-point 'boi))
1830 pos
1831 (point)))
1832 (progn
1833 (if end-pos
1834 (goto-char end-pos)
1835 (c-end-of-decl-1))
1836 (setq pos (point))
1837 (while (and (not (bolp))
1838 (not (looking-at "\\s *$"))
d9e94c22 1839 (c-forward-single-comment)))
a66cd3ee
MS
1840 (cond ((bolp)
1841 (point))
1842 ((looking-at "\\s *$")
1843 (forward-line 1)
1844 (point))
1845 (t
1846 pos)))))
1847 ))))
1848
1849(defun c-mark-function ()
1850 "Put mark at end of the current top-level declaration or macro, point at beginning.
1851If point is not inside any then the closest following one is chosen.
1852
1853As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1854function does not require the declaration to contain a brace block."
1855 (interactive)
1856
d9e94c22
MS
1857 (let (decl-limits)
1858 (c-save-buffer-state nil
1859 ;; We try to be line oriented, unless there are several
1860 ;; declarations on the same line.
1861 (if (looking-at c-syntactic-eol)
1862 (c-backward-token-2 1 nil (c-point 'bol)))
1863 (setq decl-limits (c-declaration-limits t)))
a66cd3ee 1864
a66cd3ee
MS
1865 (if (not decl-limits)
1866 (error "Cannot find any declaration")
1867 (goto-char (car decl-limits))
1868 (push-mark (cdr decl-limits) nil t))))
1869
fa7056bc
AM
1870(defun c-cpp-define-name ()
1871 "Return the name of the current CPP macro, or NIL if we're not in one."
1872 (interactive)
1873 (save-excursion
1874 (and c-opt-cpp-macro-define-start
1875 (c-beginning-of-macro)
1876 (looking-at c-opt-cpp-macro-define-start)
1877 (match-string-no-properties 1))))
1878
785eecbb 1879\f
51c9af45 1880;; Movement by statements.
0386b551
AM
1881(defun c-in-comment-line-prefix-p ()
1882 ;; Point is within a comment. Is it also within a comment-prefix?
1883 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1884 ;;
1885 ;; This function might do hidden buffer changes.
1886 (let ((here (point)))
1887 (save-excursion
1888 (beginning-of-line)
1889 (skip-chars-forward " \t")
1890 (and (looking-at c-current-comment-prefix)
1891 (/= (match-beginning 0) (match-end 0))
1892 (< here (match-end 0))))))
1893
1894(defun c-narrow-to-comment-innards (range)
1895 ;; Narrow to the "inside" of the comment (block) defined by range, as
1896 ;; follows:
17264191 1897 ;;
0386b551
AM
1898 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
1899 ;; present) removed. A c++-style line comment retains its opening "//" but
1900 ;; has any final NL removed. If POINT is currently outwith these innards,
1901 ;; move it to the appropriate boundary.
17264191 1902 ;;
0386b551
AM
1903 ;; This narrowing simplifies the sentence movement functions, since it
1904 ;; eliminates awkward things at the boundaries of the comment (block).
1905 ;;
1906 ;; This function might do hidden buffer changes.
1907 (let* ((lit-type (c-literal-type range))
1908 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
1909 (end (if (eq lit-type 'c)
1910 (if (and (eq (char-before (cdr range)) ?/)
1911 (eq (char-before (1- (cdr range))) ?*))
1912 (- (cdr range) 2)
1913 (point-max))
1914 (if (eq (cdr range) (point-max))
1915 (point-max)
1916 (- (cdr range) 1)))))
1917 (if (> (point) end)
1918 (goto-char end)) ; This would be done automatically by ...
1919 (if (< (point) beg)
1920 (goto-char beg)) ; ... narrow-to-region but is not documented.
1921 (narrow-to-region beg end)))
1922
1923(defun c-beginning-of-sentence-in-comment (range)
1924 ;; Move backwards to the "beginning of a sentence" within the comment
1925 ;; defined by RANGE, a cons of its starting and ending positions. If we
1926 ;; find a BOS, return NIL. Otherwise, move point to just before the start
1927 ;; of the comment and return T.
1928 ;;
1929 ;; The BOS is either text which follows a regexp match of sentence-end,
17264191 1930 ;; or text which is a beginning of "paragraph".
0386b551
AM
1931 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
1932 ;;
1933 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1934 ;; It is not a general function, but is intended only for calling from
1935 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
1936 ;;
1937 ;; This function might do hidden buffer changes.
1938 (save-match-data
1939 (let ((start-point (point)))
1940 (save-restriction
1941 (c-narrow-to-comment-innards range) ; This may move point back.
1942 (let* ((here (point))
1943 last
1944 (here-filler ; matches WS and comment-prefices at point.
1945 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
1946 "\\|[ \t\n\r\f]\\)*"))
1947 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
1948 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
1949 ;; First, find the previous paragraph start, if any.
1950 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
1951 (save-excursion
1952 (forward-paragraph -1) ; uses cc-mode values of
1953 ; paragraph-\(start\|separate\)
1954 (if (> (re-search-forward here-filler nil t) here)
1955 (goto-char here))
1956 (when (>= (point) here)
1957 (forward-paragraph -2)
1958 (if (> (re-search-forward here-filler nil t) here)
1959 (goto-char here)))
1960 (point))))
1961
1962 ;; Now seek successively earlier sentence ends between PAR-BEG and
1963 ;; HERE, until the "start of sentence" following it is earlier than
1964 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
1965 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
1966 (setq last (point))
1967 (goto-char (match-end 0)) ; tentative beginning of sentence
1968 (or (>= (point) here)
1969 (and (not (bolp)) ; Found a non-blank comment-prefix?
1970 (save-excursion
1971 (if (re-search-backward prefix-at-bol-here nil t)
1972 (/= (match-beginning 1) (match-end 1)))))
1973 (progn ; Skip the crud to find a real b-o-s.
1974 (if (c-in-comment-line-prefix-p)
1975 (beginning-of-line))
1976 (re-search-forward here-filler) ; always succeeds.
1977 (>= (point) here))))
1978 (goto-char last))
1979 (re-search-forward here-filler)))
1980
1981 (if (< (point) start-point)
1982 nil
1983 (goto-char (car range))
1984 t))))
1985
1986(defun c-end-of-sentence-in-comment (range)
1987 ;; Move forward to the "end of a sentence" within the comment defined by
1988 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
1989 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
1990 ;; return NIL. Otherwise, move point to just after the end of the comment
1991 ;; and return T.
1992 ;;
1993 ;; The EOS is just after the non-WS part of the next match of the regexp
1994 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
1995 ;; no sentence-end match following point, any WS before the end of the
1996 ;; comment will count as EOS, providing we're not already in it.
1997 ;;
1998 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
1999 ;; It is not a general function, but is intended only for calling from
2000 ;; c-move-over-sentence.
2001 ;;
2002 ;; This function might do hidden buffer changes.
2003 (save-match-data
2004 (let ((start-point (point))
2005 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2006 )
2007 (save-restriction
2008 (c-narrow-to-comment-innards range) ; This might move point forwards.
2009 (let* ((here (point))
2010 (par-end ; EOL position of last text in current/next paragraph.
2011 (save-excursion
2012 ;; The cc-mode values of paragraph-\(start\|separate\), set
2013 ;; in c-setup-paragraph-variables, are used in the
2014 ;; following.
2015 (forward-paragraph 1)
2016 (if (eq (preceding-char) ?\n) (forward-char -1))
2017 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
2018 (goto-char here)
2019 (forward-paragraph 2)
2020 (if (eq (preceding-char) ?\n) (forward-char -1)))
2021 (point)))
2022
2023 last
2024 (prefix-at-bol-here
2025 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
2026 ;; Go forward one "comment-prefix which looks like sentence-end"
2027 ;; each time round the following:
2028 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
2029 (progn
2030 (setq last (point))
2031 (skip-chars-backward " \t\n")
2032 (or (and (not (bolp))
2033 (re-search-backward prefix-at-bol-here nil t)
2034 (/= (match-beginning 1) (match-end 1)))
2035 (<= (point) here))))
2036 (goto-char last))
2037
2038 ;; Take special action if we're up against the end of a comment (of
2039 ;; either sort): Leave point just after the last non-ws text.
2040 (if (eq (point) (point-max))
2041 (while (or (/= (skip-chars-backward " \t\n") 0)
2042 (and (re-search-backward prefix-at-bol-here nil t)
2043 (/= (match-beginning 1) (match-end 1))))))))
2044
2045 (if (> (point) start-point)
2046 nil
2047 (goto-char (cdr range))
2048 t))))
2049
2050(defun c-beginning-of-sentence-in-string (range)
2051 ;; Move backwards to the "beginning of a sentence" within the string defined
2052 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2053 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2054 ;; just before the start of the string and return T.
2055 ;;
2056 ;; The BOS is either the text which follows a regexp match of sentence-end
2057 ;; or text which is a beginning of "paragraph". For the purposes of
2058 ;; determining paragraph boundaries, escaped newlines are treated as
2059 ;; ordinary newlines.
2060 ;;
2061 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2062 ;; It is not a general function, but is intended only for calling from
2063 ;; c-move-over-sentence.
2064 ;;
2065 ;; This function might do hidden buffer changes.
2066 (save-match-data
2067 (let* ((here (point)) last
2068 (end (1- (cdr range)))
2069 (here-filler ; matches WS and escaped newlines at point.
2070 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2071 ;; Enhance paragraph-start and paragraph-separate also to recognise
2072 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2073 ;; these values should be customizable user options, or something.
2074 (paragraph-start c-string-par-start)
2075 (paragraph-separate c-string-par-separate)
2076
2077 (par-beg ; beginning of current (or previous) paragraph.
2078 (save-excursion
2079 (save-restriction
2080 (narrow-to-region (1+ (car range)) end)
2081 (forward-paragraph -1) ; uses above values of
2082 ; paragraph-\(start\|separate\)
2083 (if (> (re-search-forward here-filler nil t) here)
2084 (goto-char here))
2085 (when (>= (point) here)
2086 (forward-paragraph -2)
2087 (if (> (re-search-forward here-filler nil t) here)
2088 (goto-char here)))
2089 (point)))))
2090 ;; Now see if we can find a sentence end after PAR-BEG.
2091 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2092 (setq last (point))
2093 (goto-char (match-end 0))
2094 (or (> (point) end)
2095 (progn
2096 (re-search-forward
2097 here-filler end t) ; always succeeds. Use end rather
2098 ; than here, in case point starts
2099 ; beyond the closing quote.
2100 (>= (point) here))))
2101 (goto-char last))
2102 (re-search-forward here-filler here t)
2103 (if (< (point) here)
2104 nil
2105 (goto-char (car range))
2106 t))))
2107
2108(defun c-end-of-sentence-in-string (range)
2109 ;; Move forward to the "end of a sentence" within the string defined by
2110 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2111 ;; return NIL. Otherwise, move point to just after the end of the string
2112 ;; and return T.
2113 ;;
2114 ;; The EOS is just after the non-WS part of the next match of the regexp
2115 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2116 ;; no sentence-end match following point, any WS before the end of the
2117 ;; string will count as EOS, providing we're not already in it.
2118 ;;
2119 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2120 ;; It is not a general function, but is intended only for calling from
2121 ;; c-move-over-sentence.
2122 ;;
2123 ;; This function might do hidden buffer changes.
2124 (save-match-data
2125 (let* ((here (point))
2126 last
2127 ;; Enhance paragraph-start and paragraph-separate to recognise
2128 ;; blank lines terminated by escaped EOLs.
2129 (paragraph-start c-string-par-start)
2130 (paragraph-separate c-string-par-separate)
2131
2132 (par-end ; EOL position of last text in current/next paragraph.
2133 (save-excursion
2134 (save-restriction
2135 (narrow-to-region (car range) (1- (cdr range)))
2136 ;; The above values of paragraph-\(start\|separate\) are used
2137 ;; in the following.
2138 (forward-paragraph 1)
2139 (setq last (point))
2140 ;; (re-search-backward filler-here nil t) would find an empty
2141 ;; string. Therefore we simulate it by the following:
2142 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2143 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2144 (unless (> (point) here)
2145 (goto-char last)
2146 (forward-paragraph 1)
2147 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2148 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2149 (point)))))
2150 ;; Try to go forward a sentence.
2151 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2152 (setq last (point))
2153 (while (or (/= (skip-chars-backward " \t\n") 0)
2154 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2155 ;; Did we move a sentence, or did we hit the end of the string?
2156 (if (> (point) here)
2157 nil
2158 (goto-char (cdr range))
2159 t))))
2160
2161(defun c-ascertain-preceding-literal ()
2162 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2163 ;; If a literal is the next thing (aside from whitespace) to be found before
2164 ;; point, return a cons of its start.end positions (enclosing the
2165 ;; delimiters). Otherwise return NIL.
2166 ;;
2167 ;; This function might do hidden buffer changes.
2168 (save-excursion
2169 (c-collect-line-comments
2170 (let ((here (point))
2171 pos)
2172 (if (c-backward-single-comment)
2173 (cons (point) (progn (c-forward-single-comment) (point)))
2174 (save-restriction
2175 ;; to prevent `looking-at' seeing a " at point.
2176 (narrow-to-region (point-min) here)
2177 (when
2178 (or
2179 ;; An EOL can act as an "open string" terminator in AWK.
2180 (looking-at c-ws*-string-limit-regexp)
2181 (and (not (bobp))
2182 (progn (backward-char)
2183 (looking-at c-string-limit-regexp))))
2184 (goto-char (match-end 0)) ; just after the string terminator.
2185 (setq pos (point))
2186 (c-safe (c-backward-sexp 1) ; move back over the string.
2187 (cons (point) pos)))))))))
2188
2189(defun c-ascertain-following-literal ()
2190 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2191 ;; If a literal is the next thing (aside from whitespace) following point,
2192 ;; return a cons of its start.end positions (enclosing the delimiters).
2193 ;; Otherwise return NIL.
2194 ;;
2195 ;; This function might do hidden buffer changes.
2196 (save-excursion
2197 (c-collect-line-comments
2198 (let (pos)
2199 (c-skip-ws-forward)
2200 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2201 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2202 (point-max)))
2203 (setq pos (point))
2204 (if (c-forward-single-comment)
2205 (cons pos (point))))))))
2206
2207(defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2208 ;; Does point immediately follow a statement "terminator"? A virtual
2209 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2210 ;;
2211 ;; This function might do hidden buffer changes.
2212 (or (save-excursion
2213 (backward-char)
2214 (and (looking-at "[;{}]")
2215 (not (and c-special-brace-lists ; Pike special brace lists.
2216 (eq (char-after) ?{)
2217 (c-looking-at-special-brace-list)))))
2218 (c-at-vsemi-p)
2219 ;; The following (for macros) is not strict about exactly where we are
2220 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2221 ;; much. ACM 2004/3/29.
2222 (let (eom)
2223 (save-excursion
2224 (if (c-beginning-of-macro)
2225 (setq eom (progn (c-end-of-macro)
2226 (point)))))
2227 (when eom
2228 (save-excursion
2229 (c-forward-comments)
2230 (>= (point) eom))))))
2231
2232(defun c-back-over-illiterals (macro-start)
2233 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2234 ;; stopping before reaching BOB or a literal or the boundary of a
2235 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2236 ;; the position of the '#' beginning the current preprocessor directive, or
2237 ;; NIL if we're not in such.
2238 ;;
2239 ;; Return a cons (A.B), where
2240 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2241 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2242 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2243 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2244 ;;
2245 ;; The total collection of returned values is as follows:
2246 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2247 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2248 ;; a BOS - the caller must check this.
2249 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2250 ;; moved and reached the opening # of the macro.
2251 ;; (t . macro-boundary): Every other circumstance in which we're at a
2252 ;; macro-boundary. We might be at a BOS.
2253 ;;
2254 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2255 ;; code before encountering the literal/BOB or macro-boundary.
2256 ;;
2257 ;; Note that this function moves within either preprocessor commands
2258 ;; (macros) or normal code, but will not cross a boundary between the two,
2259 ;; or between two distinct preprocessor commands.
2260 ;;
2261 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2262 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2263 ;; move into parens. Also stop before `#' when it's at boi on a line.
2264 ;;
2265 ;; This function might do hidden buffer changes.
2266 (save-match-data
2267 (let ((here (point))
2268 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2269 ; semicolon precedes it.
2270 (catch 'done
2271 (while t ;; We go back one "token" each iteration of the loop.
2272 (setq last (point))
2273 (cond
2274 ;; Stop at the token after a comment.
2275 ((c-backward-single-comment) ; Also functions as backwards-ws.
2276 (goto-char last)
2277 (throw 'done '(t . literal)))
2278
2279 ;; If we've gone back over a LF, we might have moved into or out of
2280 ;; a preprocessor line.
2281 ((and (save-excursion
2282 (beginning-of-line)
2283 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2284 (if macro-start
2285 (< (point) macro-start)
2286 (c-beginning-of-macro)))
2287 (goto-char last)
2288 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2289 (throw 'done (cons (or (eq (point) here)
2290 (not macro-start))
2291 'macro-boundary)))
2292
2293 ;; Have we found a virtual semicolon? If so, stop, unless the next
2294 ;; statement is where we started from.
2295 ((and (c-at-vsemi-p)
2296 (< last here)
2297 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2298 (goto-char last)
2299 (throw 'done '(nil . nil)))
2300
2301 ;; Hit the beginning of the buffer/region?
2302 ((bobp)
2303 (if (/= here last)
2304 (goto-char last))
2305 (throw 'done '(nil . nil)))
2306
2307 ;; Move back a character.
2308 ((progn (backward-char) nil))
2309
2310 ;; Stop at "{" (unless it's a PIKE special brace list.)
2311 ((eq (char-after) ?\{)
2312 (if (and c-special-brace-lists
2313 (c-looking-at-special-brace-list))
2314 (skip-syntax-backward "w_") ; Speedup only.
2315 (if (/= here last)
2316 (goto-char last))
2317 (throw 'done '(nil . nil))))
2318
2319 ;; Have we reached the start of a macro? This always counts as
2320 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2321 ;; here. FIXME!!! ACM 2004/3/29)
2322 ((and macro-start (eq (point) macro-start))
2323 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2324
2325 ;; Stop at token just after "}" or ";".
2326 ((looking-at "[;}]")
2327 ;; If we've gone back over ;, {, or }, we're done.
2328 (if (or (= here last)
2329 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2330 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2331 (eq (char-after) ?\;))
2332 (backward-char))
2333 (goto-char last) ; To the statement starting after the ; or }.
2334 (throw 'done '(nil . nil))))
2335
2336 ;; Stop at the token after a string.
2337 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2338 (goto-char last)
2339 (throw 'done '(t . literal)))
17264191 2340
0386b551
AM
2341 ;; Nothing special: go back word characters.
2342 (t (skip-syntax-backward "w_")) ; Speedup only.
2343 ))))))
2344
2345(defun c-forward-over-illiterals (macro-end allow-early-stop)
2346 ;; Move forwards over code, stopping before reaching EOB or a literal
2347 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2348 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2349 ;; terminates the current preprocessor directive, or NIL if we're not in
2350 ;; such.
2351 ;;
2352 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2353 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2354 ;; seems unavoidable. Depending on the context this function is called
2355 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2356 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2357 ;; semicolons, or anything else.
2358 ;;
2359 ;; Return a cons (A.B), where
2360 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2361 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2362 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2363 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2364 ;;
2365 ;; Point is left either after the end-of-statement, or at the last non-ws
2366 ;; code before encountering the literal, or the # of the preprocessor
2367 ;; statement, or at EOB [or just after last non-WS stuff??].
2368 ;;
2369 ;; As a clarification of "after the end-of-statement", if a comment or
2370 ;; whitespace follows a completed AWK statement, that statement is treated
2371 ;; as ending just after the last non-ws character before the comment.
17264191 2372 ;;
0386b551
AM
2373 ;; Note that this function moves within either preprocessor commands
2374 ;; (macros) or normal code, but not both within the same invocation.
2375 ;;
2376 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2377 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2378 ;; stop before `{' if at top level or inside braces, though. Move by
2379 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2380 ;; the boi.
2381 ;;
2382 ;; This function might do hidden buffer changes.
2383 (let ((here (point))
2384 last)
2385 (catch 'done
2386 (while t ;; We go one "token" forward each time round this loop.
2387 (setq last (point))
2388
2389 ;; If we've moved forward to a virtual semicolon, we're done.
2390 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2391 (c-at-vsemi-p))
2392 (throw 'done '(nil . nil)))
2393
2394 (c-skip-ws-forward)
2395 (cond
2396 ;; Gone past the end of a macro?
2397 ((and macro-end (> (point) macro-end))
2398 (goto-char last)
2399 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2400
2401 ;; About to hit a comment?
2402 ((save-excursion (c-forward-single-comment))
2403 (goto-char last)
2404 (throw 'done '(t . literal)))
2405
2406 ;; End of buffer?
2407 ((eobp)
2408 (if (/= here last)
2409 (goto-char last))
2410 (throw 'done '(nil . nil)))
2411
2412 ;; If we encounter a '{', stop just after the previous token.
2413 ((and (eq (char-after) ?{)
2414 (not (and c-special-brace-lists
2415 (c-looking-at-special-brace-list)))
2416 (or allow-early-stop (/= here last))
2417 (save-excursion ; Is this a check that we're NOT at top level?
2418;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2419;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2420;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2421;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2422 (or (not (c-safe (up-list -1) t))
2423 (= (char-after) ?{))))
2424 (goto-char last)
2425 (throw 'done '(nil . nil)))
2426
2427 ;; End of a PIKE special brace list? If so, step over it and continue.
2428 ((and c-special-brace-lists
2429 (eq (char-after) ?})
2430 (save-excursion
2431 (and (c-safe (up-list -1) t)
2432 (c-looking-at-special-brace-list))))
2433 (forward-char)
2434 (skip-syntax-forward "w_")) ; Speedup only.
2435
2436 ;; Have we got a '}' after having moved? If so, stop after the
2437 ;; previous token.
2438 ((and (eq (char-after) ?})
2439 (/= here last))
2440 (goto-char last)
2441 (throw 'done '(nil . nil)))
2442
2443 ;; Stop if we encounter a preprocessor line.
2444 ((and (not macro-end)
2445 (eq (char-after) ?#)
2446 (= (point) (c-point 'boi)))
2447 (goto-char last)
2448 ;(throw 'done (cons (eq (point) here) 'macro-boundary))) ; Changed 2003/3/26
2449 (throw 'done '(t . macro-boundary)))
2450
2451 ;; Stop after a ';', '}', or "};"
2452 ((looking-at ";\\|};?")
2453 (goto-char (match-end 0))
2454 (throw 'done '(nil . nil)))
2455
2456 ;; Found a string (this subsumes AWK regexps)?
2457 ((looking-at c-string-limit-regexp)
2458 (goto-char last)
2459 (throw 'done '(t . literal)))
2460
2461 (t
2462 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2463 (skip-syntax-forward "w_") ; Speedup only.
2464 (when (and macro-end (> (point) macro-end))
2465 (goto-char last)
2466 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2467 )))))
2468
2469(defun c-one-line-string-p (range)
2470 ;; Is the literal defined by RANGE a string contained in a single line?
2471 ;;
2472 ;; This function might do hidden buffer changes.
2473 (save-excursion
2474 (goto-char (car range))
2475 (and (looking-at c-string-limit-regexp)
2476 (progn (skip-chars-forward "^\n" (cdr range))
2477 (eq (point) (cdr range))))))
2478
785eecbb
RS
2479(defun c-beginning-of-statement (&optional count lim sentence-flag)
2480 "Go to the beginning of the innermost C statement.
2481With prefix arg, go back N - 1 statements. If already at the
28c236de
RS
2482beginning of a statement then go to the beginning of the closest
2483preceding one, moving into nested blocks if necessary (use
130c507e
GM
2484\\[backward-sexp] to skip over a block). If within or next to a
2485comment or multiline string, move by sentences instead of statements.
785eecbb
RS
2486
2487When called from a program, this function takes 3 optional args: the
2488repetition count, a buffer position limit which is the farthest back
130c507e 2489to search for the syntactic context, and a flag saying whether to do
a66cd3ee
MS
2490sentence motion in or near comments and multiline strings.
2491
0386b551
AM
2492Note that for use in programs, `c-beginning-of-statement-1' is
2493usually better. It has much better defined semantics than this one,
2494which is intended for interactive use, and might therefore change to
2495be more \"DWIM:ey\"."
785eecbb
RS
2496 (interactive (list (prefix-numeric-value current-prefix-arg)
2497 nil t))
0386b551
AM
2498 (if (< count 0)
2499 (c-end-of-statement (- count) lim sentence-flag)
2500 (c-save-buffer-state
2501 ((count (or count 1))
2502 last ; start point for going back ONE chunk. Updated each chunk movement.
2503 (macro-fence
2504 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2505 res ; result from sub-function call
2506 not-bos ; "not beginning-of-statement"
2507 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2508
2509 ;; Go back one statement at each iteration of the following loop.
2510 (while (and (/= count 0)
2511 (or (not lim) (> (point) lim)))
2512 ;; Go back one "chunk" each time round the following loop, stopping
2513 ;; when we reach a statement boundary, etc.
2514 (setq last (point))
2515 (while
2516 (cond ; Each arm of this cond returns NIL on reaching a desired
2517 ; statement boundary, non-NIL otherwise.
2518 ((bobp)
2519 (setq count 0)
2520 nil)
2521
2522 (range ; point is within or approaching a literal.
2523 (cond
2524 ;; Single line string or sentence-flag is null => skip the
2525 ;; entire literal.
2526 ((or (null sentence-flag)
2527 (c-one-line-string-p range))
2528 (goto-char (car range))
2529 (setq range (c-ascertain-preceding-literal))
2530 ;; N.B. The following is essentially testing for an AWK regexp
2531 ;; at BOS:
2532 ;; Was the previous non-ws thing an end of statement?
2533 (save-excursion
2534 (if macro-fence
2535 (c-backward-comments)
2536 (c-backward-syntactic-ws))
2537 (not (or (bobp) (c-after-statement-terminator-p)))))
2538
2539 ;; Comment inside a statement or a multi-line string.
2540 (t (when (setq res ; returns non-nil when we go out of the literal
2541 (if (eq (c-literal-type range) 'string)
2542 (c-beginning-of-sentence-in-string range)
2543 (c-beginning-of-sentence-in-comment range)))
2544 (setq range (c-ascertain-preceding-literal)))
2545 res)))
2546
2547 ;; Non-literal code.
2548 (t (setq res (c-back-over-illiterals macro-fence))
2549 (setq not-bos ; "not reached beginning-of-statement".
2550 (or (= (point) last)
2551 (memq (char-after) '(?\) ?\}))
2552 (and
2553 (car res)
2554 ;; We're at a tentative BOS. The next form goes
2555 ;; back over WS looking for an end of previous
2556 ;; statement.
2557 (not (save-excursion
2558 (if macro-fence
2559 (c-backward-comments)
2560 (c-backward-syntactic-ws))
2561 (or (bobp) (c-after-statement-terminator-p)))))))
2562 ;; Are we about to move backwards into or out of a
2563 ;; preprocessor command? If so, locate it's beginning.
2564 (when (eq (cdr res) 'macro-boundary)
2565 (save-excursion
2566 (beginning-of-line)
2567 (setq macro-fence
2568 (and (not (bobp))
2569 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2570 (point)))))
2571 ;; Are we about to move backwards into a literal?
2572 (when (memq (cdr res) '(macro-boundary literal))
2573 (setq range (c-ascertain-preceding-literal)))
2574 not-bos))
2575 (setq last (point)))
2576
2577 (if (/= count 0) (setq count (1- count))))
2578 (c-keep-region-active))))
785eecbb
RS
2579
2580(defun c-end-of-statement (&optional count lim sentence-flag)
2581 "Go to the end of the innermost C statement.
28c236de
RS
2582With prefix arg, go forward N - 1 statements. Move forward to the end
2583of the next statement if already at end, and move into nested blocks
130c507e
GM
2584\(use \\[forward-sexp] to skip over a block). If within or next to a
2585comment or multiline string, move by sentences instead of statements.
785eecbb
RS
2586
2587When called from a program, this function takes 3 optional args: the
2588repetition count, a buffer position limit which is the farthest back
130c507e
GM
2589to search for the syntactic context, and a flag saying whether to do
2590sentence motion in or near comments and multiline strings."
785eecbb
RS
2591 (interactive (list (prefix-numeric-value current-prefix-arg)
2592 nil t))
0386b551
AM
2593 (setq count (or count 1))
2594 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2595
2596 (c-save-buffer-state
2597 (here ; start point for going forward ONE statement. Updated each statement.
2598 (macro-fence
2599 (save-excursion
2600 (and (not (eobp)) (c-beginning-of-macro)
2601 (progn (c-end-of-macro) (point)))))
2602 res
2603 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2604
2605 ;; Go back/forward one statement at each iteration of the following loop.
2606 (while (and (/= count 0)
2607 (or (not lim) (< (point) lim)))
2608 (setq here (point)) ; ONLY HERE is HERE updated
2609
2610 ;; Go forward one "chunk" each time round the following loop, stopping
2611 ;; when we reach a statement boundary, etc.
2612 (while
2613 (cond ; Each arm of this cond returns NIL on reaching a desired
2614 ; statement boundary, non-NIL otherwise.
2615 ((eobp)
2616 (setq count 0)
2617 nil)
2618
2619 (range ; point is within a literal.
2620 (cond
2621 ;; sentence-flag is null => skip the entire literal.
2622 ;; or a Single line string.
2623 ((or (null sentence-flag)
2624 (c-one-line-string-p range))
2625 (goto-char (cdr range))
2626 (setq range (c-ascertain-following-literal))
2627 ;; Is there a virtual semicolon here (e.g. for AWK)?
2628 (not (c-at-vsemi-p)))
2629
2630 ;; Comment or multi-line string.
2631 (t (when (setq res ; gets non-nil when we go out of the literal
2632 (if (eq (c-literal-type range) 'string)
2633 (c-end-of-sentence-in-string range)
2634 (c-end-of-sentence-in-comment range)))
2635 (setq range (c-ascertain-following-literal)))
2636 ;; If we've just come forward out of a literal, check for
2637 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2638 ;; some other language may do in the future)
2639 (and res
2640 (not (c-at-vsemi-p))))))
2641
2642 ;; Non-literal code.
2643 (t (setq res (c-forward-over-illiterals macro-fence
2644 (> (point) here)))
2645 ;; Are we about to move forward into or out of a
2646 ;; preprocessor command?
2647 (when (eq (cdr res) 'macro-boundary)
2648 (save-excursion
2649 (end-of-line)
2650 (setq macro-fence
2651 (and (not (eobp))
2652 (progn (c-skip-ws-forward)
2653 (c-beginning-of-macro))
2654 (progn (c-end-of-macro)
2655 (point))))))
2656 ;; Are we about to move forward into a literal?
2657 (when (memq (cdr res) '(macro-boundary literal))
2658 (setq range (c-ascertain-following-literal)))
2659 (car res))))
2660
2661 (if (/= count 0) (setq count (1- count))))
2662 (c-keep-region-active))))
17264191 2663
785eecbb
RS
2664\f
2665;; set up electric character functions to work with pending-del,
2666;; (a.k.a. delsel) mode. All symbols get the t value except
c93a62d8 2667;; the functions which delete, which gets 'supersede.
6b7513e3 2668(mapc
785eecbb
RS
2669 (function
2670 (lambda (sym)
2671 (put sym 'delete-selection t) ; for delsel (Emacs)
2672 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2673 '(c-electric-pound
2674 c-electric-brace
2675 c-electric-slash
2676 c-electric-star
2677 c-electric-semi&comma
2678 c-electric-lt-gt
0ec8351b
BW
2679 c-electric-colon
2680 c-electric-paren))
c93a62d8
RS
2681(put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2682(put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2683(put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2684(put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
7443aaa6
SM
2685(put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2686(put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
785eecbb
RS
2687
2688\f
51c9af45 2689;; Inserting/indenting comments
a66cd3ee 2690(defun c-calc-comment-indent (entry)
0386b551 2691 ;; This function might do hidden buffer changes.
a66cd3ee
MS
2692 (if (symbolp entry)
2693 (setq entry (or (assq entry c-indent-comment-alist)
2694 (assq 'other c-indent-comment-alist)
2695 '(default . (column . nil)))))
2696 (let ((action (car (cdr entry)))
2697 (value (cdr (cdr entry)))
2698 (col (current-column)))
2699 (cond ((eq action 'space)
2700 (+ col value))
2701 ((eq action 'column)
2702 (unless value (setq value comment-column))
2703 (if (bolp)
2704 ;; Do not pad with one space if we're at bol.
2705 value
2706 (max (1+ col) value)))
2707 ((eq action 'align)
2708 (or (save-excursion
2709 (beginning-of-line)
2710 (unless (bobp)
2711 (backward-char)
2712 (let ((lim (c-literal-limits (c-point 'bol) t)))
2713 (when (consp lim)
2714 (goto-char (car lim))
0386b551 2715 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
a66cd3ee
MS
2716 ;; Found comment to align with.
2717 (if (bolp)
2718 ;; Do not pad with one space if we're at bol.
2719 0
2720 (max (1+ col) (current-column))))))))
2721 ;; Recurse to handle value as a new spec.
2722 (c-calc-comment-indent (cdr entry)))))))
2723
785eecbb 2724(defun c-comment-indent ()
a66cd3ee
MS
2725 "Used by `indent-for-comment' to create and indent comments.
2726See `c-indent-comment-alist' for a description."
2727 (save-excursion
2728 (end-of-line)
d9e94c22
MS
2729 (c-save-buffer-state
2730 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
a66cd3ee
MS
2731 (or (when (consp lim)
2732 (goto-char (car lim))
2733 (when (looking-at "/[/*]")
2734 (skip-chars-backward " \t")
2735 (point)))
2736 (progn
2737 (skip-chars-backward " \t")
2738 (point)))))
2739 (line-type
2740 (cond ((looking-at "^/[/*]")
2741 'anchored-comment)
2742 ((progn (beginning-of-line)
2743 (eq (point) eot))
2744 'empty-line)
2745 ((progn (back-to-indentation)
2746 (and (eq (char-after) ?})
2747 (eq (point) (1- eot))))
2748 'end-block)
2749 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2750 (eq (match-end 0) eot))
2751 'cpp-end-block)
2752 (t
2753 'other))))
2754 (if (and (memq line-type '(anchored-comment empty-line))
2755 c-indent-comments-syntactically-p)
d9e94c22 2756 (let ((c-syntactic-context (c-guess-basic-syntax)))
785eecbb
RS
2757 ;; BOGOSITY ALERT: if we're looking at the eol, its
2758 ;; because indent-for-comment hasn't put the comment-start
2759 ;; in the buffer yet. this will screw up the syntactic
2760 ;; analysis so we kludge in the necessary info. Another
2761 ;; kludge is that if we're at the bol, then we really want
2762 ;; to ignore any anchoring as specified by
2763 ;; c-comment-only-line-offset since it doesn't apply here.
a66cd3ee 2764 (if (eolp)
785eecbb
RS
2765 (c-add-syntax 'comment-intro))
2766 (let ((c-comment-only-line-offset
2767 (if (consp c-comment-only-line-offset)
2768 c-comment-only-line-offset
2769 (cons c-comment-only-line-offset
2770 c-comment-only-line-offset))))
d9e94c22 2771 (c-get-syntactic-indentation c-syntactic-context)))
a66cd3ee
MS
2772 (goto-char eot)
2773 (c-calc-comment-indent line-type)))))
785eecbb 2774
fd3b1ef6 2775\f
785eecbb
RS
2776;; used by outline-minor-mode
2777(defun c-outline-level ()
a66cd3ee
MS
2778 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2779 ;; in otherwise-hidden text.
de28797f
SM
2780 (save-excursion
2781 (skip-chars-forward "\t ")
2782 (current-column))))
785eecbb
RS
2783
2784\f
51c9af45 2785;; Movement by CPP conditionals.
785eecbb
RS
2786(defun c-up-conditional (count)
2787 "Move back to the containing preprocessor conditional, leaving mark behind.
2788A prefix argument acts as a repeat count. With a negative argument,
2789move forward to the end of the containing preprocessor conditional.
51f606de 2790
0386b551
AM
2791\"#elif\" is treated like \"#else\" followed by \"#if\", so the
2792function stops at them when going backward, but not when going
2793forward."
51f606de 2794 (interactive "p")
0a218d34
AM
2795 (let ((new-point (c-scan-conditionals (- count) -1)))
2796 (push-mark)
2797 (goto-char new-point))
51f606de 2798 (c-keep-region-active))
17264191 2799
51f606de 2800(defun c-up-conditional-with-else (count)
0386b551
AM
2801 "Move back to the containing preprocessor conditional, including \"#else\".
2802Just like `c-up-conditional', except it also stops at \"#else\"
51f606de
GM
2803directives."
2804 (interactive "p")
0a218d34
AM
2805 (let ((new-point (c-scan-conditionals (- count) -1 t)))
2806 (push-mark)
2807 (goto-char new-point))
51f606de
GM
2808 (c-keep-region-active))
2809
2810(defun c-down-conditional (count)
2811 "Move forward into the next preprocessor conditional, leaving mark behind.
2812A prefix argument acts as a repeat count. With a negative argument,
2813move backward into the previous preprocessor conditional.
2814
0386b551
AM
2815\"#elif\" is treated like \"#else\" followed by \"#if\", so the
2816function stops at them when going forward, but not when going
2817backward."
785eecbb 2818 (interactive "p")
0a218d34
AM
2819 (let ((new-point (c-scan-conditionals count 1)))
2820 (push-mark)
2821 (goto-char new-point))
785eecbb
RS
2822 (c-keep-region-active))
2823
51f606de 2824(defun c-down-conditional-with-else (count)
0386b551
AM
2825 "Move forward into the next preprocessor conditional, including \"#else\".
2826Just like `c-down-conditional', except it also stops at \"#else\"
51f606de
GM
2827directives."
2828 (interactive "p")
0a218d34
AM
2829 (let ((new-point (c-scan-conditionals count 1 t)))
2830 (push-mark)
2831 (goto-char new-point))
51f606de
GM
2832 (c-keep-region-active))
2833
2834(defun c-backward-conditional (count &optional target-depth with-else)
785eecbb
RS
2835 "Move back across a preprocessor conditional, leaving mark behind.
2836A prefix argument acts as a repeat count. With a negative argument,
0a218d34
AM
2837move forward across a preprocessor conditional.
2838
2839The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2840and have the same meanings as in `c-scan-conditionals'. If you
2841are calling c-forward-conditional from a program, you might want
2842to call `c-scan-conditionals' directly instead."
785eecbb 2843 (interactive "p")
0a218d34
AM
2844 (let ((new-point (c-scan-conditionals (- count) target-depth with-else)))
2845 (push-mark)
2846 (goto-char new-point))
785eecbb
RS
2847 (c-keep-region-active))
2848
51f606de 2849(defun c-forward-conditional (count &optional target-depth with-else)
785eecbb
RS
2850 "Move forward across a preprocessor conditional, leaving mark behind.
2851A prefix argument acts as a repeat count. With a negative argument,
51f606de
GM
2852move backward across a preprocessor conditional.
2853
0a218d34
AM
2854If there aren't enough conditionals after \(or before) point, an
2855error is signalled.
2856
2857\"#elif\" is treated like \"#else\" followed by \"#if\", except that
2858the nesting level isn't changed when tracking subconditionals.
2859
2860The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2861and have the same meanings as in `c-scan-conditionals'. If you
2862are calling c-forward-conditional from a program, you might want
2863to call `c-scan-conditionals' directly instead."
2864 (interactive "p")
2865 (let ((new-point (c-scan-conditionals count target-depth with-else)))
2866 (push-mark)
2867 (goto-char new-point)))
2868
2869(defun c-scan-conditionals (count &optional target-depth with-else)
2870 "Scan forward across COUNT preprocessor conditionals.
2871With a negative argument, scan backward across preprocessor
2872conditionals. Return the end position. Point is not moved.
2873
2874If there aren't enough preprocessor conditionals, throw an error.
2875
0386b551
AM
2876\"#elif\" is treated like \"#else\" followed by \"#if\", except that
2877the nesting level isn't changed when tracking subconditionals.
51f606de
GM
2878
2879The optional argument TARGET-DEPTH specifies the wanted nesting depth
0a218d34
AM
2880after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
2881outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
51f606de
GM
2882counts as -1.
2883
0386b551
AM
2884If the optional argument WITH-ELSE is non-nil, \"#else\" directives
2885are treated as conditional clause limits. Normally they are ignored."
785eecbb
RS
2886 (let* ((forward (> count 0))
2887 (increment (if forward -1 1))
2888 (search-function (if forward 're-search-forward 're-search-backward))
0a218d34 2889 new)
51f606de
GM
2890 (unless (integerp target-depth)
2891 (setq target-depth (if target-depth -1 0)))
785eecbb
RS
2892 (save-excursion
2893 (while (/= count 0)
51f606de
GM
2894 (let ((depth 0)
2895 ;; subdepth is the depth in "uninteresting" subtrees,
2896 ;; i.e. those that takes us farther from the target
2897 ;; depth instead of closer.
2898 (subdepth 0)
2899 found)
785eecbb
RS
2900 (save-excursion
2901 ;; Find the "next" significant line in the proper direction.
2902 (while (and (not found)
2903 ;; Rather than searching for a # sign that
2904 ;; comes at the beginning of a line aside from
2905 ;; whitespace, search first for a string
2906 ;; starting with # sign. Then verify what
2907 ;; precedes it. This is faster on account of
2908 ;; the fastmap feature of the regexp matcher.
2909 (funcall search-function
51f606de 2910 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
785eecbb
RS
2911 nil t))
2912 (beginning-of-line)
2913 ;; Now verify it is really a preproc line.
51f606de
GM
2914 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
2915 (let (dchange (directive (match-string 1)))
2916 (cond ((string= directive "if")
2917 (setq dchange (- increment)))
2918 ((string= directive "endif")
2919 (setq dchange increment))
2920 ((= subdepth 0)
2921 ;; When we're not in an "uninteresting"
2922 ;; subtree, we might want to act on "elif"
2923 ;; and "else" too.
2924 (if (cond (with-else
2925 ;; Always move toward the target depth.
2926 (setq dchange
2927 (if (> target-depth 0) 1 -1)))
2928 ((string= directive "elif")
2929 (setq dchange (- increment))))
2930 ;; Ignore the change if it'd take us
2931 ;; into an "uninteresting" subtree.
2932 (if (eq (> dchange 0) (<= target-depth 0))
2933 (setq dchange nil)))))
2934 (when dchange
2935 (when (or (/= subdepth 0)
2936 (eq (> dchange 0) (<= target-depth 0)))
2937 (setq subdepth (+ subdepth dchange)))
2938 (setq depth (+ depth dchange))
2939 ;; If we are trying to move across, and we find an
2940 ;; end before we find a beginning, get an error.
2941 (if (and (< depth target-depth) (< dchange 0))
2942 (error (if forward
2943 "No following conditional at this level"
2944 "No previous conditional at this level"))))
785eecbb
RS
2945 ;; When searching forward, start from next line so
2946 ;; that we don't find the same line again.
2947 (if forward (forward-line 1))
51f606de
GM
2948 ;; We found something if we've arrived at the
2949 ;; target depth.
2950 (if (and dchange (= depth target-depth))
785eecbb
RS
2951 (setq found (point))))
2952 ;; else
51f606de 2953 (if forward (forward-line 1)))))
785eecbb
RS
2954 (or found
2955 (error "No containing preprocessor conditional"))
2956 (goto-char (setq new found)))
2957 (setq count (+ count increment))))
0a218d34
AM
2958 (c-keep-region-active)
2959 new))
785eecbb
RS
2960
2961\f
2962;; commands to indent lines, regions, defuns, and expressions
b8ded794 2963(defun c-indent-command (&optional arg)
785eecbb
RS
2964 "Indent current line as C code, and/or insert some whitespace.
2965
2966If `c-tab-always-indent' is t, always just indent the current line.
2967If nil, indent the current line only if point is at the left margin or
2968in the line's indentation; otherwise insert some whitespace[*]. If
2969other than nil or t, then some whitespace[*] is inserted only within
2a15eb73 2970literals (comments and strings), but the line is always reindented.
785eecbb 2971
b8ded794 2972If `c-syntactic-indentation' is t, indentation is done according to
a66cd3ee
MS
2973the syntactic context. A numeric argument, regardless of its value,
2974means indent rigidly all the lines of the expression starting after
2975point so that this line becomes properly indented. The relative
2976indentation among the lines of the expression is preserved.
2977
2978If `c-syntactic-indentation' is nil, the line is just indented one
b8ded794
GM
2979step according to `c-basic-offset'. In this mode, a numeric argument
2980indents a number of such steps, positive or negative, and an empty
2981prefix argument is equivalent to -1.
2982
785eecbb
RS
2983 [*] The amount and kind of whitespace inserted is controlled by the
2984 variable `c-insert-tab-function', which is called to do the actual
2985 insertion of whitespace. Normally the function in this variable
2986 just inserts a tab character, or the equivalent number of spaces,
2987 depending on the variable `indent-tabs-mode'."
2988
0386b551 2989 (interactive "P")
a66cd3ee 2990 (let ((indent-function
b8ded794 2991 (if c-syntactic-indentation
130c507e 2992 (symbol-function 'indent-according-to-mode)
b8ded794 2993 (lambda ()
a66cd3ee 2994 (let ((c-macro-start c-macro-start)
0386b551
AM
2995 (steps (if (equal arg '(4))
2996 -1
2997 (prefix-numeric-value arg))))
a66cd3ee
MS
2998 (c-shift-line-indentation (* steps c-basic-offset))
2999 (when (and c-auto-align-backslashes
3000 (save-excursion
3001 (end-of-line)
3002 (eq (char-before) ?\\))
3003 (c-query-and-set-macro-start))
3004 ;; Realign the line continuation backslash if inside a macro.
3005 (c-backslash-region (point) (point) nil t)))
b8ded794 3006 ))))
0386b551 3007 (if (and c-syntactic-indentation arg)
b8ded794
GM
3008 ;; If c-syntactic-indentation and got arg, always indent this
3009 ;; line as C and shift remaining lines of expression the same
3010 ;; amount.
130c507e
GM
3011 (let ((shift-amt (save-excursion
3012 (back-to-indentation)
3013 (current-column)))
785eecbb 3014 beg end)
130c507e
GM
3015 (c-indent-line)
3016 (setq shift-amt (- (save-excursion
3017 (back-to-indentation)
3018 (current-column))
3019 shift-amt))
785eecbb
RS
3020 (save-excursion
3021 (if (eq c-tab-always-indent t)
0386b551 3022 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
785eecbb 3023 (setq beg (point))
0ec8351b 3024 (c-forward-sexp 1)
785eecbb
RS
3025 (setq end (point))
3026 (goto-char beg)
3027 (forward-line 1)
3028 (setq beg (point)))
3029 (if (> end beg)
130c507e 3030 (indent-code-rigidly beg end shift-amt "#")))
b8ded794 3031 ;; Else use c-tab-always-indent to determine behavior.
785eecbb 3032 (cond
0386b551 3033 ;; CASE 1: indent when at column zero or in line's indentation,
785eecbb
RS
3034 ;; otherwise insert a tab
3035 ((not c-tab-always-indent)
3036 (if (save-excursion
3037 (skip-chars-backward " \t")
3038 (not (bolp)))
3039 (funcall c-insert-tab-function)
b8ded794 3040 (funcall indent-function)))
785eecbb
RS
3041 ;; CASE 2: just indent the line
3042 ((eq c-tab-always-indent t)
b8ded794 3043 (funcall indent-function))
785eecbb
RS
3044 ;; CASE 3: if in a literal, insert a tab, but always indent the
3045 ;; line
3046 (t
0386b551 3047 (if (c-save-buffer-state () (c-in-literal))
785eecbb 3048 (funcall c-insert-tab-function))
b8ded794 3049 (funcall indent-function)
785eecbb
RS
3050 )))))
3051
3052(defun c-indent-exp (&optional shutup-p)
130c507e 3053 "Indent each line in the balanced expression following point syntactically.
17264191 3054If optional SHUTUP-P is non-nil, no errors are signaled if no
130c507e 3055balanced expression is found."
28c236de 3056 (interactive "*P")
51f606de 3057 (let ((here (point-marker))
130c507e 3058 end)
51f606de 3059 (set-marker-insertion-type here t)
785eecbb 3060 (unwind-protect
a66cd3ee
MS
3061 (let ((start (save-restriction
3062 ;; Find the closest following open paren that
3063 ;; ends on another line.
3064 (narrow-to-region (point-min) (c-point 'eol))
3065 (let (beg (end (point)))
3066 (while (and (setq beg (c-down-list-forward end))
3067 (setq end (c-up-list-forward beg))))
3068 (and beg
3069 (eq (char-syntax (char-before beg)) ?\()
3070 (1- beg))))))
785eecbb 3071 ;; sanity check
130c507e
GM
3072 (if (not start)
3073 (unless shutup-p
3074 (error "Cannot find start of balanced expression to indent"))
19da29f9 3075 (goto-char start)
a66cd3ee 3076 (setq end (c-safe (scan-sexps (point) 1)))
130c507e
GM
3077 (if (not end)
3078 (unless shutup-p
3079 (error "Cannot find end of balanced expression to indent"))
a66cd3ee
MS
3080 (forward-line)
3081 (if (< (point) end)
3082 (c-indent-region (point) end)))))
51f606de
GM
3083 (goto-char here)
3084 (set-marker here nil))))
785eecbb
RS
3085
3086(defun c-indent-defun ()
a66cd3ee
MS
3087 "Indent the current top-level declaration or macro syntactically.
3088In the macro case this also has the effect of realigning any line
3089continuation backslashes, unless `c-auto-align-backslashes' is nil."
28c236de 3090 (interactive "*")
a66cd3ee 3091 (let ((here (point-marker)) decl-limits)
785eecbb 3092 (unwind-protect
d9e94c22
MS
3093 (progn
3094 (c-save-buffer-state nil
3095 ;; We try to be line oriented, unless there are several
3096 ;; declarations on the same line.
3097 (if (looking-at c-syntactic-eol)
3098 (c-backward-token-2 1 nil (c-point 'bol))
3099 (c-forward-token-2 0 nil (c-point 'eol)))
3100 (setq decl-limits (c-declaration-limits nil)))
3101 (if decl-limits
3102 (c-indent-region (car decl-limits)
3103 (cdr decl-limits))))
785eecbb
RS
3104 (goto-char here)
3105 (set-marker here nil))))
3106
130c507e 3107(defun c-indent-region (start end &optional quiet)
a66cd3ee
MS
3108 "Indent syntactically every line whose first char is between START
3109and END inclusive. If the optional argument QUIET is non-nil then no
3110syntactic errors are reported, even if `c-report-syntactic-errors' is
3111non-nil."
785eecbb 3112 (save-excursion
a66cd3ee 3113 (goto-char end)
d9e94c22 3114 (skip-chars-backward " \t\n\r\f\v")
a66cd3ee 3115 (setq end (point))
785eecbb
RS
3116 (goto-char start)
3117 ;; Advance to first nonblank line.
a66cd3ee 3118 (beginning-of-line)
d9e94c22 3119 (skip-chars-forward " \t\n\r\f\v")
a66cd3ee 3120 (setq start (point))
785eecbb 3121 (beginning-of-line)
130c507e
GM
3122 (setq c-parsing-error
3123 (or (let ((endmark (copy-marker end))
3124 (c-parsing-error nil)
3125 ;; shut up any echo msgs on indiv lines
a66cd3ee 3126 (c-echo-syntactic-information-p nil)
9644a7da 3127 (ml-macro-start ; Start pos of multi-line macro.
24f15006
AM
3128 (and (c-save-buffer-state ()
3129 (save-excursion (c-beginning-of-macro)))
9644a7da 3130 (eq (char-before (c-point 'eol)) ?\\)
24f15006 3131 start))
a66cd3ee
MS
3132 (c-fix-backslashes nil)
3133 syntax)
130c507e
GM
3134 (unwind-protect
3135 (progn
3136 (c-progress-init start end 'c-indent-region)
24f15006
AM
3137
3138 (while (and (bolp) ;; One line each time round the loop.
130c507e
GM
3139 (not (eobp))
3140 (< (point) endmark))
3141 ;; update progress
3142 (c-progress-update)
a66cd3ee 3143 ;; skip empty lines
24f15006 3144 (unless (or (looking-at "\\s *$")
9644a7da 3145 (and ml-macro-start (looking-at "\\s *\\\\$")))
24f15006
AM
3146 ;; Get syntax and indent.
3147 (c-save-buffer-state nil
3148 (setq syntax (c-guess-basic-syntax)))
3149 (c-indent-line syntax t t))
3150
9644a7da
AM
3151 (if ml-macro-start
3152 ;; End of current multi-line macro?
3153 (when (and c-auto-align-backslashes
3154 (not (eq (char-before (c-point 'eol)) ?\\)))
3155 ;; Fixup macro backslashes.
3156 (c-backslash-region ml-macro-start (c-point 'bonl) nil)
3157 (setq ml-macro-start nil))
3158 ;; New multi-line macro?
3159 (if (and (assq 'cpp-macro syntax)
3160 (eq (char-before (c-point 'eol)) ?\\))
3161 (setq ml-macro-start (point))))
3162
24f15006
AM
3163 (forward-line))
3164
9644a7da
AM
3165 (if (and ml-macro-start c-auto-align-backslashes)
3166 (c-backslash-region ml-macro-start (c-point 'bopl) nil t)))
130c507e
GM
3167 (set-marker endmark nil)
3168 (c-progress-fini 'c-indent-region))
3169 (c-echo-parsing-error quiet))
3170 c-parsing-error))))
785eecbb 3171
130c507e
GM
3172(defun c-fn-region-is-active-p ()
3173 ;; Function version of the macro for use in places that aren't
3174 ;; compiled, e.g. in the menus.
3175 (c-region-is-active-p))
3176
c02a1ee9
RS
3177(defun c-indent-line-or-region (&optional arg region)
3178 "Indent active region, current line, or block starting on this line.
3179In Transient Mark mode, when the region is active, reindent the region.
21d46113 3180Otherwise, with a prefix argument, rigidly reindent the expression
c02a1ee9
RS
3181starting on the current line.
3182Otherwise reindent just the current line."
3183 (interactive
3184 (list current-prefix-arg (use-region-p)))
3185 (if region
0ec8351b 3186 (c-indent-region (region-beginning) (region-end))
c02a1ee9 3187 (c-indent-command arg)))
785eecbb
RS
3188\f
3189;; for progress reporting
3190(defvar c-progress-info nil)
3191
3192(defun c-progress-init (start end context)
a7c7b186
KH
3193 (cond
3194 ;; Be silent
3195 ((not c-progress-interval))
3196 ;; Start the progress update messages. If this Emacs doesn't have
3197 ;; a built-in timer, just be dumb about it.
3198 ((not (fboundp 'current-time))
130c507e 3199 (message "Indenting region... (this may take a while)"))
a7c7b186
KH
3200 ;; If progress has already been initialized, do nothing. otherwise
3201 ;; initialize the counter with a vector of:
3202 ;; [start end lastsec context]
3203 (c-progress-info)
3204 (t (setq c-progress-info (vector start
785eecbb
RS
3205 (save-excursion
3206 (goto-char end)
3207 (point-marker))
3208 (nth 1 (current-time))
3209 context))
130c507e 3210 (message "Indenting region..."))
a7c7b186 3211 ))
785eecbb
RS
3212
3213(defun c-progress-update ()
785eecbb
RS
3214 (if (not (and c-progress-info c-progress-interval))
3215 nil
3216 (let ((now (nth 1 (current-time)))
3217 (start (aref c-progress-info 0))
3218 (end (aref c-progress-info 1))
3219 (lastsecs (aref c-progress-info 2)))
3220 ;; should we update? currently, update happens every 2 seconds,
3221 ;; what's the right value?
3222 (if (< c-progress-interval (- now lastsecs))
3223 (progn
130c507e 3224 (message "Indenting region... (%d%% complete)"
785eecbb
RS
3225 (/ (* 100 (- (point) start)) (- end start)))
3226 (aset c-progress-info 2 now)))
3227 )))
3228
3229(defun c-progress-fini (context)
a7c7b186
KH
3230 (if (not c-progress-interval)
3231 nil
3232 (if (or (eq context (aref c-progress-info 3))
3233 (eq context t))
3234 (progn
3235 (set-marker (aref c-progress-info 1) nil)
3236 (setq c-progress-info nil)
130c507e 3237 (message "Indenting region... done")))))
785eecbb
RS
3238
3239
3240\f
3241;;; This page handles insertion and removal of backslashes for C macros.
3242
a66cd3ee 3243(defun c-backslash-region (from to delete-flag &optional line-mode)
785eecbb
RS
3244 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3245With no argument, inserts backslashes and aligns existing backslashes.
a66cd3ee
MS
3246With an argument, deletes the backslashes. The backslash alignment is
3247done according to the settings in `c-backslash-column',
3248`c-backslash-max-column' and `c-auto-align-backslashes'.
785eecbb
RS
3249
3250This function does not modify blank lines at the start of the region.
a66cd3ee
MS
3251If the region ends at the start of a line and the macro doesn't
3252continue below it, the backslash (if any) at the end of the previous
3253line is deleted.
0ec8351b 3254
785eecbb
RS
3255You can put the region around an entire macro definition and use this
3256command to conveniently insert and align the necessary backslashes."
28c236de 3257 (interactive "*r\nP")
a66cd3ee
MS
3258 (let ((endmark (make-marker))
3259 ;; Keep the backslash trimming functions from changing the
3260 ;; whitespace around point, since in this case it's only the
3261 ;; position of point that tells the indentation of the line.
3262 (point-pos (if (save-excursion
3263 (skip-chars-backward " \t")
3264 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3265 (point-marker)
3266 (point-min)))
3267 column longest-line-col bs-col-after-end)
3268 (save-excursion
3269 (goto-char to)
3270 (if (and (not line-mode) (bobp))
3271 ;; Nothing to do if to is at bob, since we should back up
3272 ;; and there's no line to back up to.
3273 nil
3274 (when (and (not line-mode) (bolp))
3275 ;; Do not back up the to line if line-mode is set, to make
3276 ;; e.g. c-newline-and-indent consistent regardless whether
3277 ;; the (newline) call leaves point at bol or not.
3278 (backward-char)
3279 (setq to (point)))
3280 (if delete-flag
3281 (progn
3282 (set-marker endmark (point))
3283 (goto-char from)
3284 (c-delete-backslashes-forward endmark point-pos))
3285 ;; Set bs-col-after-end to the column of any backslash
3286 ;; following the region, or nil if there is none.
3287 (setq bs-col-after-end
3288 (and (progn (end-of-line)
3289 (eq (char-before) ?\\))
3290 (= (forward-line 1) 0)
3291 (progn (end-of-line)
3292 (eq (char-before) ?\\))
3293 (1- (current-column))))
3294 (when line-mode
3295 ;; Back up the to line if line-mode is set, since the line
3296 ;; after the newly inserted line break should not be
3297 ;; touched in c-newline-and-indent.
3298 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3299 (unless bs-col-after-end
3300 ;; Set bs-col-after-end to non-nil in any case, since we
3301 ;; do not want to delete the backslash at the last line.
3302 (setq bs-col-after-end t)))
3303 (if (and line-mode
3304 (not c-auto-align-backslashes))
3305 (goto-char from)
3306 ;; Compute the smallest column number past the ends of all
3307 ;; the lines.
3308 (setq longest-line-col 0)
3309 (goto-char to)
3310 (if bs-col-after-end
3311 ;; Include one more line in the max column
3312 ;; calculation, since the to line will be backslashed
3313 ;; too.
3314 (forward-line 1))
3315 (end-of-line)
3316 (while (and (>= (point) from)
3317 (progn
3318 (if (eq (char-before) ?\\)
3319 (forward-char -1))
3320 (skip-chars-backward " \t")
3321 (setq longest-line-col (max longest-line-col
3322 (1+ (current-column))))
3323 (beginning-of-line)
3324 (not (bobp))))
3325 (backward-char))
3326 ;; Try to align with surrounding backslashes.
3327 (goto-char from)
3328 (beginning-of-line)
3329 (if (and (not (bobp))
3330 (progn (backward-char)
3331 (eq (char-before) ?\\)))
3332 (progn
3333 (setq column (1- (current-column)))
3334 (if (numberp bs-col-after-end)
3335 ;; Both a preceding and a following backslash.
3336 ;; Choose the greatest of them.
3337 (setq column (max column bs-col-after-end)))
3338 (goto-char from))
3339 ;; No preceding backslash. Try to align with one
3340 ;; following the region. Disregard the backslash at the
3341 ;; to line since it's likely to be bogus (e.g. when
3342 ;; called from c-newline-and-indent).
3343 (if (numberp bs-col-after-end)
3344 (setq column bs-col-after-end))
3345 ;; Don't modify blank lines at start of region.
3346 (goto-char from)
3347 (while (and (< (point) to) (bolp) (eolp))
3348 (forward-line 1)))
3349 (if (and column (< column longest-line-col))
3350 ;; Don't try to align with surrounding backslashes if
3351 ;; any line is too long.
3352 (setq column nil))
3353 (unless column
3354 ;; Impose minimum limit and tab width alignment only if
3355 ;; we can't align with surrounding backslashes.
3356 (if (> (% longest-line-col tab-width) 0)
3357 (setq longest-line-col
3358 (* (/ (+ longest-line-col tab-width -1)
3359 tab-width)
3360 tab-width)))
3361 (setq column (max c-backslash-column
3362 longest-line-col)))
3363 ;; Always impose maximum limit.
3364 (setq column (min column c-backslash-max-column)))
3365 (if bs-col-after-end
3366 ;; Add backslashes on all lines if the macro continues
3367 ;; after the to line.
3368 (progn
3369 (set-marker endmark to)
3370 (c-append-backslashes-forward endmark column point-pos))
3371 ;; Add backslashes on all lines except the last, and
3372 ;; remove any on the last line.
3373 (if (save-excursion
3374 (goto-char to)
3375 (beginning-of-line)
3376 (if (not (bobp))
3377 (set-marker endmark (1- (point)))))
3378 (progn
3379 (c-append-backslashes-forward endmark column point-pos)
3380 ;; The function above leaves point on the line
3381 ;; following endmark.
3382 (set-marker endmark (point)))
3383 (set-marker endmark to))
3384 (c-delete-backslashes-forward endmark point-pos)))))
3385 (set-marker endmark nil)
3386 (if (markerp point-pos)
3387 (set-marker point-pos nil))))
3388
3389(defun c-append-backslashes-forward (to-mark column point-pos)
3390 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3391 (if column
3392 (while
3393 (and
3394 (<= (point) to-mark)
3395
3396 (let ((start (point)) (inserted nil) end col)
3397 (end-of-line)
3398 (unless (eq (char-before) ?\\)
3399 (insert ?\\)
3400 (setq inserted t))
3401 (setq state (parse-partial-sexp
3402 start (point) nil nil state))
3403 (backward-char)
3404 (setq col (current-column))
3405
3406 ;; Avoid unnecessary changes of the buffer.
3407 (cond ((and (not inserted) (nth 3 state))
3408 ;; Don't realign backslashes in string literals
3409 ;; since that would change them.
3410 )
3411
3412 ((< col column)
3413 (delete-region
3414 (point)
3415 (progn
3416 (skip-chars-backward
3417 " \t" (if (>= (point) point-pos) point-pos))
3418 (point)))
3419 (indent-to column))
3420
3421 ((and (= col column)
3422 (memq (char-before) '(?\ ?\t))))
3423
3424 ((progn
3425 (setq end (point))
3426 (or (/= (skip-chars-backward
3427 " \t" (if (>= (point) point-pos) point-pos))
3428 -1)
3429 (/= (char-after) ?\ )))
3430 (delete-region (point) end)
3431 (indent-to column 1)))
3432
3efc2cd7
MS
3433 (zerop (forward-line 1)))
3434 (bolp))) ; forward-line has funny behavior at eob.
a66cd3ee
MS
3435
3436 ;; Make sure there are backslashes with at least one space in
3437 ;; front of them.
3438 (while
3439 (and
3440 (<= (point) to-mark)
3441
3442 (let ((start (point)))
3443 (end-of-line)
3444 (setq state (parse-partial-sexp
3445 start (point) nil nil state))
3446
3447 (if (eq (char-before) ?\\)
3448 (unless (nth 3 state)
3449 (backward-char)
3450 (unless (and (memq (char-before) '(?\ ?\t))
3451 (/= (point) point-pos))
3452 (insert ?\ )))
3453
3454 (if (and (memq (char-before) '(?\ ?\t))
3455 (/= (point) point-pos))
3456 (insert ?\\)
3457 (insert ?\ ?\\)))
3458
3efc2cd7
MS
3459 (zerop (forward-line 1)))
3460 (bolp)))))) ; forward-line has funny behavior at eob.
a66cd3ee
MS
3461
3462(defun c-delete-backslashes-forward (to-mark point-pos)
3463 (while
3464 (and (<= (point) to-mark)
3465 (progn
3466 (end-of-line)
3467 (if (eq (char-before) ?\\)
3468 (delete-region
3469 (point)
3470 (progn (backward-char)
3471 (skip-chars-backward " \t" (if (>= (point) point-pos)
3472 point-pos))
3473 (point))))
3efc2cd7
MS
3474 (zerop (forward-line 1)))
3475 (bolp)))) ; forward-line has funny behavior at eob.
785eecbb 3476
51f606de 3477
785eecbb 3478\f
51f606de
GM
3479;;; Line breaking and paragraph filling.
3480
130c507e
GM
3481(defvar c-auto-fill-prefix t)
3482(defvar c-lit-limits nil)
3483(defvar c-lit-type nil)
3484
51f606de
GM
3485;; The filling code is based on a simple theory; leave the intricacies
3486;; of the text handling to the currently active mode for that
3487;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3488;; possible to make them work correctly wrt the comment and string
3489;; separators, one-line paragraphs etc. Unfortunately, when it comes
3490;; to it, there's quite a lot of special cases to handle which makes
3491;; the code anything but simple. The intention is that it will work
3492;; with any well-written text filling package that preserves a fill
3493;; prefix.
3494;;
3495;; We temporarily mask comment starters and enders as necessary for
3496;; the filling code to do its job on a seemingly normal text block.
3497;; We do _not_ mask the fill prefix, so it's up to the filling code to
3498;; preserve it correctly (especially important when filling C++ style
3499;; line comments). By default, we set up and use adaptive-fill-mode,
3500;; which is standard in all supported Emacs flavors.
3501
3502(defun c-guess-fill-prefix (lit-limits lit-type)
3503 ;; Determine the appropriate comment fill prefix for a block or line
3504 ;; comment. Return a cons of the prefix string and the column where
3505 ;; it ends. If fill-prefix is set, it'll override. Note that this
3506 ;; function also uses the value of point in some heuristics.
0386b551
AM
3507 ;;
3508 ;; This function might do hidden buffer changes.
d9e94c22 3509
51f606de
GM
3510 (let* ((here (point))
3511 (prefix-regexp (concat "[ \t]*\\("
130c507e 3512 c-current-comment-prefix
51f606de
GM
3513 "\\)[ \t]*"))
3514 (comment-start-regexp (if (eq lit-type 'c++)
3515 prefix-regexp
3516 comment-start-skip))
130c507e 3517 prefix-line comment-prefix res comment-text-end)
d9e94c22 3518
51f606de
GM
3519 (cond
3520 (fill-prefix
3521 (setq res (cons fill-prefix
3522 ;; Ugly way of getting the column after the fill
3523 ;; prefix; it'd be nice with a current-column
3524 ;; that works on strings..
d9e94c22 3525 (let ((start (point)))
51f606de
GM
3526 (unwind-protect
3527 (progn
a66cd3ee 3528 (insert-and-inherit "\n" fill-prefix)
51f606de 3529 (current-column))
d9e94c22
MS
3530 (delete-region start (point)))))))
3531
51f606de
GM
3532 ((eq lit-type 'c++)
3533 (save-excursion
3534 ;; Set fallback for comment-prefix if none is found.
130c507e
GM
3535 (setq comment-prefix "// "
3536 comment-text-end (cdr lit-limits))
d9e94c22 3537
51f606de
GM
3538 (beginning-of-line)
3539 (if (> (point) (car lit-limits))
3540 ;; The current line is not the comment starter, so the
3541 ;; comment has more than one line, and it can therefore be
3542 ;; used to find the comment fill prefix.
3543 (setq prefix-line (point))
d9e94c22 3544
51f606de
GM
3545 (goto-char (car lit-limits))
3546 (if (and (= (forward-line 1) 0)
3547 (< (point) (cdr lit-limits)))
3548 ;; The line after the comment starter is inside the
3549 ;; comment, so we can use it.
3550 (setq prefix-line (point))
d9e94c22 3551
51f606de
GM
3552 ;; The comment is only one line. Take the comment prefix
3553 ;; from it and keep the indentation.
3554 (goto-char (car lit-limits))
3555 (if (looking-at prefix-regexp)
3556 (goto-char (match-end 0))
3557 (forward-char 2)
3558 (skip-chars-forward " \t"))
d9e94c22 3559
a66cd3ee
MS
3560 (let (str col)
3561 (if (eq (c-point 'boi) (car lit-limits))
3562 ;; There is only whitespace before the comment
3563 ;; starter; take the prefix straight from this line.
3564 (setq str (buffer-substring-no-properties
51f606de 3565 (c-point 'bol) (point))
a66cd3ee 3566 col (current-column))
d9e94c22 3567
a66cd3ee
MS
3568 ;; There is code before the comment starter, so we
3569 ;; have to temporarily insert and indent a new line to
3570 ;; get the right space/tab mix in the indentation.
d9e94c22 3571 (let ((prefix-len (- (point) (car lit-limits)))
a66cd3ee
MS
3572 tmp)
3573 (unwind-protect
3574 (progn
3575 (goto-char (car lit-limits))
3576 (indent-to (prog1 (current-column)
3577 (insert ?\n)))
3578 (setq tmp (point))
3579 (forward-char prefix-len)
3580 (setq str (buffer-substring-no-properties
51f606de 3581 (c-point 'bol) (point))
a66cd3ee 3582 col (current-column)))
d9e94c22
MS
3583 (delete-region (car lit-limits) tmp))))
3584
a66cd3ee
MS
3585 (setq res
3586 (if (or (string-match "\\s \\'" str) (not (eolp)))
3587 (cons str col)
3588 ;; The prefix ends the line with no whitespace
3589 ;; after it. Default to a single space.
3590 (cons (concat str " ") (1+ col))))
3591 )))))
d9e94c22 3592
51f606de 3593 (t
a66cd3ee
MS
3594 (setq comment-text-end
3595 (save-excursion
3596 (goto-char (- (cdr lit-limits) 2))
3597 (if (looking-at "\\*/") (point) (cdr lit-limits))))
d9e94c22 3598
51f606de
GM
3599 (save-excursion
3600 (beginning-of-line)
3601 (if (and (> (point) (car lit-limits))
3602 (not (and (looking-at "[ \t]*\\*/")
3603 (eq (cdr lit-limits) (match-end 0)))))
3604 ;; The current line is not the comment starter and
3605 ;; contains more than just the ender, so it's good enough
3606 ;; to be used for the comment fill prefix.
3607 (setq prefix-line (point))
3608 (goto-char (car lit-limits))
d9e94c22
MS
3609
3610 (cond ((or (/= (forward-line 1) 0)
3611 (>= (point) (cdr lit-limits))
3612 (and (looking-at "[ \t]*\\*/")
3613 (eq (cdr lit-limits) (match-end 0)))
3614 (and (looking-at prefix-regexp)
3615 (<= (1- (cdr lit-limits)) (match-end 0))))
3616 ;; The comment is either one line or the next line contains
3617 ;; just the comment ender. In this case we have no
3618 ;; information about a suitable comment prefix, so we resort
3619 ;; to c-block-comment-prefix.
3620 (setq comment-prefix (or c-block-comment-prefix "")))
3621
3622 ((< here (point))
3623 ;; The point was on the comment opener line, so we might want
3624 ;; to treat this as a not yet closed comment.
3625
3626 (if (and (match-beginning 1)
3627 (/= (match-beginning 1) (match-end 1)))
3628 ;; Above `prefix-regexp' matched a nonempty prefix on the
3629 ;; second line, so let's use it. Normally it should do
3630 ;; to set `prefix-line' and let the code below pick up
3631 ;; the whole prefix, but if there's no text after the
3632 ;; match then it will probably fall back to no prefix at
3633 ;; all if the comment isn't closed yet, so in that case
3634 ;; it's better to force use of the prefix matched now.
3635 (if (= (match-end 0) (c-point 'eol))
3636 (setq comment-prefix (match-string 1))
3637 (setq prefix-line (point)))
3638
3639 ;; There's no nonempty prefix on the line after the
3640 ;; comment opener. If the line is empty, or if the
d858963e 3641 ;; text on it has less or equal indentation than the
d9e94c22
MS
3642 ;; comment starter we assume it's an unclosed
3643 ;; comment starter, i.e. that
3644 ;; `c-block-comment-prefix' should be used.
3645 ;; Otherwise we assume it's a closed comment where
3646 ;; the prefix really is the empty string.
3647 ;; E.g. this is an unclosed comment:
3648 ;;
3649 ;; /*
3650 ;; foo
3651 ;;
3652 ;; But this is not:
3653 ;;
3654 ;; /*
3655 ;; foo
3656 ;; */
3657 ;;
3658 ;; (Looking for the presence of the comment closer
3659 ;; rarely works since it's probably the closer of
3660 ;; some comment further down when the comment
3661 ;; really is unclosed.)
3662 (if (<= (save-excursion (back-to-indentation)
3663 (current-column))
3664 (save-excursion (goto-char (car lit-limits))
3665 (current-column)))
3666 (setq comment-prefix (or c-block-comment-prefix ""))
3667 (setq prefix-line (point)))))
3668
3669 (t
3670 ;; Otherwise the line after the comment starter is good
3671 ;; enough to find the prefix in.
3672 (setq prefix-line (point))))
3673
3674 (when comment-prefix
3675 ;; Haven't got the comment prefix on any real line that we
3676 ;; can take it from, so we have to temporarily insert
3677 ;; `comment-prefix' on a line and indent it to find the
3678 ;; correct column and the correct mix of tabs and spaces.
3679 (setq res
3680 (let (tmp-pre tmp-post)
3681 (unwind-protect
3682 (progn
3683
3684 (goto-char (car lit-limits))
3685 (if (looking-at comment-start-regexp)
3686 (goto-char (min (match-end 0)
3687 comment-text-end))
3688 (forward-char 2)
3689 (skip-chars-forward " \t"))
3690
3691 (when (eq (char-syntax (char-before)) ?\ )
3692 ;; If there's ws on the current line, we'll use it
3693 ;; instead of what's ending comment-prefix.
3694 (setq comment-prefix
3695 (concat (substring comment-prefix
3696 0 (string-match
3697 "\\s *\\'"
3698 comment-prefix))
3699 (buffer-substring-no-properties
3700 (save-excursion
3701 (skip-chars-backward " \t")
3702 (point))
3703 (point)))))
3704
3705 (setq tmp-pre (point-marker))
3706
3707 ;; We insert an extra non-whitespace character
3708 ;; before the line break and after comment-prefix in
3709 ;; case it's "" or ends with whitespace.
3710 (insert-and-inherit "x\n" comment-prefix "x")
3711 (setq tmp-post (point-marker))
3712
3713 (indent-according-to-mode)
3714
3715 (goto-char (1- tmp-post))
3716 (cons (buffer-substring-no-properties
3717 (c-point 'bol) (point))
3718 (current-column)))
3719
3720 (when tmp-post
3721 (delete-region tmp-pre tmp-post)
3722 (set-marker tmp-pre nil)
3723 (set-marker tmp-post nil))))))))))
3724
3725 (or res ; Found a good prefix above.
3726
51f606de
GM
3727 (save-excursion
3728 ;; prefix-line is the bol of a line on which we should try
3729 ;; to find the prefix.
3730 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3731 (test-line
3732 (lambda ()
3733 (when (and (looking-at prefix-regexp)
130c507e
GM
3734 (<= (match-end 0) comment-text-end))
3735 (unless (eq (match-end 0) (c-point 'eol))
3736 ;; The match is fine if there's text after it.
3737 (throw 'found (cons (buffer-substring-no-properties
3738 (match-beginning 0) (match-end 0))
3739 (progn (goto-char (match-end 0))
3740 (current-column)))))
51f606de 3741 (unless fb-string
130c507e
GM
3742 ;; This match is better than nothing, so let's
3743 ;; remember it in case nothing better is found
3744 ;; on another line.
51f606de
GM
3745 (setq fb-string (buffer-substring-no-properties
3746 (match-beginning 0) (match-end 0))
3747 fb-endpos (match-end 0)))
51f606de 3748 t))))
d9e94c22 3749
130c507e 3750 (or (catch 'found
51f606de
GM
3751 ;; Search for a line which has text after the prefix
3752 ;; so that we get the proper amount of whitespace
3753 ;; after it. We start with the current line, then
3754 ;; search backwards, then forwards.
d9e94c22 3755
51f606de
GM
3756 (goto-char prefix-line)
3757 (when (and (funcall test-line)
130c507e
GM
3758 (or (/= (match-end 1) (match-end 0))
3759 ;; The whitespace is sucked up by the
3760 ;; first [ \t]* glob if the prefix is empty.
3761 (and (= (match-beginning 1) (match-end 1))
3762 (/= (match-beginning 0) (match-end 0)))))
51f606de
GM
3763 ;; If the current line doesn't have text but do
3764 ;; have whitespace after the prefix, we'll use it.
130c507e
GM
3765 (throw 'found (cons fb-string
3766 (progn (goto-char fb-endpos)
3767 (current-column)))))
d9e94c22 3768
130c507e
GM
3769 (if (eq lit-type 'c++)
3770 ;; For line comments we can search up to and
3771 ;; including the first line.
3772 (while (and (zerop (forward-line -1))
3773 (>= (point) (car lit-limits)))
3774 (funcall test-line))
3775 ;; For block comments we must stop before the
3776 ;; block starter.
3777 (while (and (zerop (forward-line -1))
3778 (> (point) (car lit-limits)))
3779 (funcall test-line)))
d9e94c22 3780
51f606de
GM
3781 (goto-char prefix-line)
3782 (while (and (zerop (forward-line 1))
3783 (< (point) (cdr lit-limits)))
3784 (funcall test-line))
d9e94c22 3785
130c507e 3786 (goto-char prefix-line)
51f606de 3787 nil)
d9e94c22 3788
130c507e 3789 (when fb-string
51f606de
GM
3790 ;; A good line wasn't found, but at least we have a
3791 ;; fallback that matches the comment prefix regexp.
a66cd3ee
MS
3792 (cond ((or (string-match "\\s \\'" fb-string)
3793 (progn
3794 (goto-char fb-endpos)
3795 (not (eolp))))
3796 ;; There are ws or text after the prefix, so
3797 ;; let's use it.
3798 (cons fb-string (current-column)))
d9e94c22 3799
51f606de
GM
3800 ((progn
3801 ;; Check if there's any whitespace padding
3802 ;; on the comment start line that we can
3803 ;; use after the prefix.
3804 (goto-char (car lit-limits))
3805 (if (looking-at comment-start-regexp)
3806 (goto-char (match-end 0))
3807 (forward-char 2)
3808 (skip-chars-forward " \t"))
a66cd3ee
MS
3809 (or (not (eolp))
3810 (eq (char-syntax (char-before)) ?\ )))
d9e94c22 3811
51f606de
GM
3812 (setq fb-string (buffer-substring-no-properties
3813 (save-excursion
3814 (skip-chars-backward " \t")
3815 (point))
3816 (point)))
3817 (goto-char fb-endpos)
3818 (skip-chars-backward " \t")
d9e94c22
MS
3819
3820 (let ((tmp (point)))
51f606de
GM
3821 ;; Got to mess in the buffer once again to
3822 ;; ensure the column gets correct. :P
3823 (unwind-protect
3824 (progn
a66cd3ee 3825 (insert-and-inherit fb-string)
51f606de
GM
3826 (cons (buffer-substring-no-properties
3827 (c-point 'bol)
3828 (point))
3829 (current-column)))
d9e94c22
MS
3830 (delete-region tmp (point)))))
3831
51f606de
GM
3832 (t
3833 ;; Last resort: Just add a single space after
3834 ;; the prefix.
3835 (cons (concat fb-string " ")
3836 (progn (goto-char fb-endpos)
130c507e 3837 (1+ (current-column)))))))
d9e94c22 3838
51f606de
GM
3839 ;; The line doesn't match the comment prefix regexp.
3840 (if comment-prefix
3841 ;; We have a fallback for line comments that we must use.
3842 (cons (concat (buffer-substring-no-properties
3843 prefix-line (c-point 'boi))
3844 comment-prefix)
3845 (progn (back-to-indentation)
3846 (+ (current-column) (length comment-prefix))))
d9e94c22 3847
51f606de
GM
3848 ;; Assume we are dealing with a "free text" block
3849 ;; comment where the lines doesn't have any comment
3850 ;; prefix at all and we should just fill it as
3851 ;; normal text.
130c507e 3852 '("" . 0))))))
51f606de
GM
3853 ))
3854
d9e94c22
MS
3855(defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
3856 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3857 ;; masked to allow adaptive filling to work correctly. That
3858 ;; includes narrowing the buffer and, if point is inside a comment,
3859 ;; masking the comment starter and ender appropriately.
3860 ;;
3861 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3862 ;; The position of point is then less significant when doing masking
3863 ;; and narrowing.
3864 ;;
3865 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3866 ;; only if the point turns out to be inside a comment or a string.
07cc1196 3867 ;;
0386b551 3868 ;; Note that this function does not do any hidden buffer changes.
d9e94c22 3869
a66cd3ee 3870 (let (fill
e6a24f43 3871 ;; beg and end limit the region to narrow. end is a marker.
51f606de 3872 beg end
130c507e 3873 ;; tmp-pre and tmp-post mark strings that are temporarily
51f606de
GM
3874 ;; inserted at the start and end of the region. tmp-pre is a
3875 ;; cons of the positions of the prepended string. tmp-post is
3876 ;; a marker pointing to the single character of the appended
3877 ;; string.
3878 tmp-pre tmp-post
130c507e
GM
3879 ;; If hang-ender-stuck isn't nil, the comment ender is
3880 ;; hanging. In that case it's set to the number of spaces
3881 ;; that should be between the text and the ender.
3882 hang-ender-stuck
0386b551
AM
3883 ;; auto-fill-spaces is the exact sequence of whitespace between a
3884 ;; comment's last word and the comment ender, temporarily replaced
17264191 3885 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
0386b551 3886 auto-fill-spaces
a66cd3ee
MS
3887 (here (point))
3888 (c-lit-limits c-lit-limits)
3889 (c-lit-type c-lit-type))
d9e94c22 3890
51f606de
GM
3891 ;; Restore point on undo. It's necessary since we do a lot of
3892 ;; hidden inserts and deletes below that should be as transparent
3893 ;; as possible.
51c9af45 3894 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
51f606de 3895 (setq buffer-undo-list (cons (point) buffer-undo-list)))
d9e94c22 3896
51c9af45
AM
3897 ;; Determine the limits and type of the containing literal (if any):
3898 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
3899 ;; BEG and END.
0386b551
AM
3900 (c-save-buffer-state ()
3901 (save-restriction
3902 ;; Widen to catch comment limits correctly.
3903 (widen)
3904 (unless c-lit-limits
3905 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
3906 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
3907 (unless c-lit-type
3908 (setq c-lit-type (c-literal-type c-lit-limits))))
d9e94c22 3909
0386b551
AM
3910 (save-excursion
3911 (unless (c-safe (backward-char)
3912 (forward-paragraph)
3913 (>= (point) here))
3914 (goto-char here)
3915 (forward-paragraph))
3916 (setq end (point-marker)))
3917 (save-excursion
3918 (unless (c-safe (forward-char)
3919 (backward-paragraph)
3920 (<= (point) here))
3921 (goto-char here)
3922 (backward-paragraph))
3923 (setq beg (point))))
d9e94c22 3924
130c507e
GM
3925 (unwind-protect
3926 (progn
51c9af45
AM
3927 ;; For each of the possible types of text (string, C comment ...)
3928 ;; determine BEG and END, the region we will narrow to. If we're in
3929 ;; a literal, constrain BEG and END to the limits of this literal.
3930 ;;
3931 ;; For some of these text types, particularly a block comment, we
3932 ;; may need to massage whitespace near literal delimiters, so that
3933 ;; these don't get filled inappropriately.
130c507e 3934 (cond
d9e94c22 3935
a66cd3ee 3936 ((eq c-lit-type 'c++) ; Line comment.
130c507e 3937 (save-excursion
a66cd3ee 3938 ;; Limit to the comment or paragraph end, whichever
130c507e 3939 ;; comes first.
a66cd3ee 3940 (set-marker end (min end (cdr c-lit-limits)))
d9e94c22 3941
a66cd3ee
MS
3942 (when (<= beg (car c-lit-limits))
3943 ;; The region includes the comment starter, so we must
3944 ;; check it.
3945 (goto-char (car c-lit-limits))
130c507e 3946 (back-to-indentation)
a66cd3ee
MS
3947 (if (eq (point) (car c-lit-limits))
3948 ;; Include the first line in the region.
130c507e
GM
3949 (setq beg (c-point 'bol))
3950 ;; The first line contains code before the
3951 ;; comment. We must fake a line that doesn't.
d9e94c22
MS
3952 (setq tmp-pre t))))
3953
3954 (setq apply-outside-literal t))
3955
a66cd3ee 3956 ((eq c-lit-type 'c) ; Block comment.
fd85cfb7
AM
3957 (when
3958 (or (> end (cdr c-lit-limits))
3959 (and (= end (cdr c-lit-limits))
3960 (eq (char-before end) ?/)
3961 (eq (char-before (1- end)) ?*)
3962 ;; disallow "/*/"
3963 (> (- (cdr c-lit-limits) (car c-lit-limits)) 3)))
e6a24f43
AM
3964 ;; There is a comment ender, and the region includes it. If
3965 ;; it's on its own line, it stays on its own line. If it's got
3966 ;; company on the line, it keeps (at least one word of) it.
3967 ;; "=====*/" counts as a comment ender here, but "===== */"
3968 ;; doesn't and "foo*/" doesn't.
51c9af45
AM
3969 (unless
3970 (save-excursion
3971 (goto-char (cdr c-lit-limits))
3972 (beginning-of-line)
dc56b2ba
MR
3973 ;; The following conjunct was added to avoid an
3974 ;; "Invalid search bound (wrong side of point)"
3975 ;; error in the subsequent re-search. Maybe
3976 ;; another fix would be needed (2007-12-08).
3977 (and (> (- (cdr c-lit-limits) 2) (point))
3978 (search-forward-regexp
51c9af45
AM
3979 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
3980 (- (cdr c-lit-limits) 2) t)
3981 (not (search-forward-regexp
3982 "\\(\\s \\|\\sw\\)"
3983 (- (cdr c-lit-limits) 2) 'limit))
3984 ;; The comment ender IS on its own line. Exclude
3985 ;; this line from the filling.
3986 (set-marker end (c-point 'bol))))
3987
3988 ;; The comment ender is hanging. Replace all space between it
3989 ;; and the last word either by one or two 'x's (when
0386b551
AM
3990 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
3991 ;; as the whitespace (when auto filling), and include it in
3992 ;; the region. We'll change them back to whitespace
3993 ;; afterwards. The effect of this is to glue the comment
3994 ;; ender to the last word in the comment during filling.
3995 (let* ((ender-start (save-excursion
3996 (goto-char (cdr c-lit-limits))
3997 (skip-syntax-backward "^w ")
3998 (point)))
3999 (ender-column (save-excursion
4000 (goto-char ender-start)
4001 (current-column)))
4002 (point-rel (- ender-start here))
4003 spaces)
4004
4005 (save-excursion
51c9af45 4006 ;; Insert a CR after the "*/", adjust END
0386b551
AM
4007 (goto-char (cdr c-lit-limits))
4008 (setq tmp-post (point-marker))
4009 (insert ?\n)
4010 (set-marker end (point))
51c9af45 4011
0386b551
AM
4012 (forward-line -1) ; last line of the comment
4013 (if (and (looking-at (concat "[ \t]*\\(\\("
4014 c-current-comment-prefix
4015 "\\)[ \t]*\\)"))
4016 (eq ender-start (match-end 0)))
51c9af45
AM
4017 ;; The comment ender is prefixed by nothing but a
4018 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4019 ;; 2006/4/28). Remove it along with surrounding ws.
0386b551
AM
4020 (setq spaces (- (match-end 1) (match-end 2)))
4021 (goto-char ender-start))
4022 (skip-chars-backward " \t\r\n") ; Surely this can be
4023 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4024
51c9af45 4025 ;; What's being tested here? 2006/4/20. FIXME!!!
0386b551
AM
4026 (if (/= (point) ender-start)
4027 (progn
4028 (if (<= here (point))
4029 ;; Don't adjust point below if it's
4030 ;; before the string we replace.
4031 (setq point-rel -1))
4032 ;; Keep one or two spaces between the
4033 ;; text and the ender, depending on how
4034 ;; many there are now.
4035 (unless spaces
4036 (setq spaces (- ender-column (current-column))))
4037 (setq auto-fill-spaces (c-delete-and-extract-region
4038 (point) ender-start))
4039 ;; paragraph filling condenses multiple spaces to
4040 ;; single or double spaces. auto-fill doesn't.
4041 (if fill-paragraph
d9e94c22
MS
4042 (setq spaces
4043 (max
4044 (min spaces
4045 (if sentence-end-double-space 2 1))
0386b551
AM
4046 1)))
4047 ;; Insert the filler first to keep marks right.
4048 (insert-char ?x spaces t)
4049 (setq hang-ender-stuck spaces)
4050 (setq point-rel
4051 (and (>= point-rel 0)
4052 (- (point) (min point-rel spaces)))))
4053 (setq point-rel nil)))
4054
4055 (if point-rel
4056 ;; Point was in the middle of the string we
4057 ;; replaced above, so put it back in the same
4058 ;; relative position, counting from the end.
4059 (goto-char point-rel)))
4060 ))
d9e94c22 4061
a66cd3ee
MS
4062 (when (<= beg (car c-lit-limits))
4063 ;; The region includes the comment starter.
51f606de 4064 (save-excursion
a66cd3ee 4065 (goto-char (car c-lit-limits))
07cc1196
MS
4066 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
4067 ;; Begin with the next line.
4068 (setq beg (c-point 'bonl))
4069 ;; Fake the fill prefix in the first line.
d9e94c22
MS
4070 (setq tmp-pre t))))
4071
4072 (setq apply-outside-literal t))
4073
a66cd3ee 4074 ((eq c-lit-type 'string) ; String.
130c507e 4075 (save-excursion
a66cd3ee
MS
4076 (when (>= end (cdr c-lit-limits))
4077 (goto-char (1- (cdr c-lit-limits)))
130c507e
GM
4078 (setq tmp-post (point-marker))
4079 (insert ?\n)
4080 (set-marker end (point)))
a66cd3ee
MS
4081 (when (<= beg (car c-lit-limits))
4082 (goto-char (1+ (car c-lit-limits)))
130c507e
GM
4083 (setq beg (if (looking-at "\\\\$")
4084 ;; Leave the start line if it's
4085 ;; nothing but an escaped newline.
4086 (1+ (match-end 0))
d9e94c22
MS
4087 (point)))))
4088 (setq apply-outside-literal t))
4089
4090 ((eq c-lit-type 'pound) ; Macro
4091 ;; Narrow to the macro limits if they are nearer than the
4092 ;; paragraph limits. Don't know if this is necessary but
4093 ;; do it for completeness sake (doing auto filling at all
4094 ;; inside macros is bogus to begin with since the line
4095 ;; continuation backslashes aren't handled).
4096 (save-excursion
0386b551
AM
4097 (c-save-buffer-state ()
4098 (c-beginning-of-macro)
4099 (beginning-of-line)
4100 (if (> (point) beg)
4101 (setq beg (point)))
4102 (c-end-of-macro)
4103 (forward-line)
4104 (if (< (point) end)
4105 (set-marker end (point))))))
d9e94c22
MS
4106
4107 (t ; Other code.
4108 ;; Try to avoid comments and macros in the paragraph to
4109 ;; avoid that the adaptive fill mode gets the prefix from
4110 ;; them.
4111 (c-save-buffer-state nil
4112 (save-excursion
4113 (goto-char beg)
4114 (c-forward-syntactic-ws end)
4115 (beginning-of-line)
4116 (setq beg (point))
4117 (goto-char end)
4118 (c-backward-syntactic-ws beg)
4119 (forward-line)
4120 (set-marker end (point))))))
4121
130c507e
GM
4122 (when tmp-pre
4123 ;; Temporarily insert the fill prefix after the comment
4124 ;; starter so that the first line looks like any other
4125 ;; comment line in the narrowed region.
d9e94c22
MS
4126 (setq fill (c-save-buffer-state nil
4127 (c-guess-fill-prefix c-lit-limits c-lit-type)))
130c507e
GM
4128 (unless (string-match (concat "\\`[ \t]*\\("
4129 c-current-comment-prefix
4130 "\\)[ \t]*\\'")
4131 (car fill))
4132 ;; Oops, the prefix doesn't match the comment prefix
4133 ;; regexp. This could produce very confusing
4134 ;; results with adaptive fill packages together with
4135 ;; the insert prefix magic below, since the prefix
4136 ;; often doesn't appear at all. So let's warn about
4137 ;; it.
4138 (message "\
4139Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4140 (car fill)))
4141 ;; Find the right spot on the line, break it, insert
4142 ;; the fill prefix and make sure we're back in the
4143 ;; same column by temporarily prefixing the first word
4144 ;; with a number of 'x'.
4145 (save-excursion
a66cd3ee
MS
4146 (goto-char (car c-lit-limits))
4147 (if (looking-at (if (eq c-lit-type 'c++)
fdea67e7 4148 c-current-comment-prefix
130c507e
GM
4149 comment-start-skip))
4150 (goto-char (match-end 0))
4151 (forward-char 2)
4152 (skip-chars-forward " \t"))
467690bb
MS
4153 (while (and (< (current-column) (cdr fill))
4154 (not (eolp)))
4155 (forward-char 1))
130c507e
GM
4156 (let ((col (current-column)))
4157 (setq beg (1+ (point))
4158 tmp-pre (list (point)))
4159 (unwind-protect
4160 (progn
a66cd3ee
MS
4161 (insert-and-inherit "\n" (car fill))
4162 (insert-char ?x (- col (current-column)) t))
130c507e 4163 (setcdr tmp-pre (point))))))
d9e94c22
MS
4164
4165 (when apply-outside-literal
4166 ;; `apply-outside-literal' is always set to t here if
4167 ;; we're inside a literal.
4168
4169 (let ((fill-prefix
4170 (or fill-prefix
4171 ;; Kludge: If the function that adapts the fill prefix
4172 ;; doesn't produce the required comment starter for
4173 ;; line comments, then force it by setting fill-prefix.
4174 (when (and (eq c-lit-type 'c++)
4175 ;; Kludge the kludge: filladapt-mode doesn't
4176 ;; have this problem, but it currently
4177 ;; doesn't override fill-context-prefix
4178 ;; (version 2.12).
4179 (not (and (boundp 'filladapt-mode)
4180 filladapt-mode))
4181 (not (string-match
4182 "\\`[ \t]*//"
4183 (or (fill-context-prefix beg end)
4184 ""))))
4185 (c-save-buffer-state nil
a66cd3ee 4186 (car (or fill (c-guess-fill-prefix
d9e94c22
MS
4187 c-lit-limits c-lit-type)))))))
4188
4189 ;; Save the relative position of point if it's outside the
4190 ;; region we're going to narrow. Want to restore it in that
4191 ;; case, but otherwise it should be moved according to the
4192 ;; called function.
4193 (point-rel (cond ((< (point) beg) (- (point) beg))
4194 ((> (point) end) (- (point) end)))))
4195
4196 ;; Preparations finally done! Now we can call the
4197 ;; actual function.
4198 (prog1
4199 (save-restriction
4200 (narrow-to-region beg end)
4201 (apply fun args))
4202 (if point-rel
4203 ;; Restore point if it was outside the region.
4204 (if (< point-rel 0)
4205 (goto-char (+ beg point-rel))
4206 (goto-char (+ end point-rel))))))))
4207
130c507e
GM
4208 (when (consp tmp-pre)
4209 (delete-region (car tmp-pre) (cdr tmp-pre)))
d9e94c22 4210
130c507e
GM
4211 (when tmp-post
4212 (save-excursion
4213 (goto-char tmp-post)
4214 (delete-char 1))
4215 (when hang-ender-stuck
4216 ;; Preserve point even if it's in the middle of the string
4217 ;; we replace; save-excursion doesn't work in that case.
4218 (setq here (point))
4219 (goto-char tmp-post)
4220 (skip-syntax-backward "^w ")
4221 (forward-char (- hang-ender-stuck))
0386b551
AM
4222 (if (or fill-paragraph (not auto-fill-spaces))
4223 (insert-char ?\ hang-ender-stuck t)
2b78d42c 4224 (insert auto-fill-spaces))
130c507e
GM
4225 (delete-char hang-ender-stuck)
4226 (goto-char here))
4227 (set-marker tmp-post nil))
d9e94c22 4228
a66cd3ee
MS
4229 (set-marker end nil))))
4230
4231(defun c-fill-paragraph (&optional arg)
4232 "Like \\[fill-paragraph] but handles C and C++ style comments.
4233If any of the current line is a comment or within a comment, fill the
4234comment or the paragraph of it that point is in, preserving the
4235comment indentation or line-starting decorations (see the
4236`c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4237details).
4238
4239If point is inside multiline string literal, fill it. This currently
4240does not respect escaped newlines, except for the special case when it
4241is the very first thing in the string. The intended use for this rule
4242is in situations like the following:
4243
4244char description[] = \"\\
4245A very long description of something that you want to fill to make
4246nicely formatted output.\"\;
4247
4248If point is in any other situation, i.e. in normal code, do nothing.
4249
4250Optional prefix ARG means justify paragraph as well."
4251 (interactive "*P")
4252 (let ((fill-paragraph-function
4253 ;; Avoid infinite recursion.
4254 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4255 fill-paragraph-function)))
d9e94c22 4256 (c-mask-paragraph t nil 'fill-paragraph arg))
51f606de
GM
4257 ;; Always return t. This has the effect that if filling isn't done
4258 ;; above, it isn't done at all, and it's therefore effectively
4259 ;; disabled in normal code.
4260 t)
4261
4262(defun c-do-auto-fill ()
4263 ;; Do automatic filling if not inside a context where it should be
4264 ;; ignored.
4265 (let ((c-auto-fill-prefix
4266 ;; The decision whether the line should be broken is actually
4267 ;; done in c-indent-new-comment-line, which do-auto-fill
4268 ;; calls to break lines. We just set this special variable
4269 ;; so that we'll know when we're called from there. It's
4270 ;; also used to detect whether fill-prefix is user set or
4271 ;; generated automatically by do-auto-fill.
4272 fill-prefix))
d9e94c22 4273 (c-mask-paragraph nil t 'do-auto-fill)))
51f606de 4274
a66cd3ee
MS
4275(defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4276 "Break line at point and indent, continuing comment or macro if within one.
51f606de
GM
4277If inside a comment and `comment-multi-line' is non-nil, the
4278indentation and line prefix are preserved (see the
4279`c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
b8ded794
GM
4280details). If inside a single line comment and `comment-multi-line' is
4281nil, a new comment of the same type is started on the next line and
a66cd3ee
MS
4282indented as appropriate for comments. If inside a macro, a line
4283continuation backslash is inserted and aligned as appropriate, and the
4284new line is indented according to `c-syntactic-indentation'.
51f606de
GM
4285
4286If a fill prefix is specified, it overrides all the above."
a66cd3ee
MS
4287 ;; allow-auto-fill is used from c-context-line-break to allow auto
4288 ;; filling to break the line more than once. Since this function is
4289 ;; used from auto-fill itself, that's normally disabled to avoid
4290 ;; unnecessary recursion.
51f606de
GM
4291 (interactive)
4292 (let ((fill-prefix fill-prefix)
4293 (do-line-break
4294 (lambda ()
a66cd3ee
MS
4295 (delete-horizontal-space)
4296 (if soft
4297 (insert-and-inherit ?\n)
4298 (newline (if allow-auto-fill nil 1)))))
51f606de
GM
4299 ;; Already know the literal type and limits when called from
4300 ;; c-context-line-break.
130c507e 4301 (c-lit-limits c-lit-limits)
a66cd3ee
MS
4302 (c-lit-type c-lit-type)
4303 (c-macro-start c-macro-start))
0386b551
AM
4304
4305 (c-save-buffer-state ()
4306 (when (not (eq c-auto-fill-prefix t))
4307 ;; Called from do-auto-fill.
4308 (unless c-lit-limits
4309 (setq c-lit-limits (c-literal-limits nil nil t)))
4310 (unless c-lit-type
4311 (setq c-lit-type (c-literal-type c-lit-limits)))
4312 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4313 ((null c-lit-type) 'code)
4314 (t c-lit-type))
4315 c-ignore-auto-fill)
4316 (setq fill-prefix t) ; Used as flag in the cond.
4317 (if (and (null c-auto-fill-prefix)
4318 (eq c-lit-type 'c)
4319 (<= (c-point 'bol) (car c-lit-limits)))
4320 ;; The adaptive fill function has generated a prefix, but
4321 ;; we're on the first line in a block comment so it'll be
4322 ;; wrong. Ignore it to guess a better one below.
4323 (setq fill-prefix nil)
4324 (when (and (eq c-lit-type 'c++)
4325 (not (string-match (concat "\\`[ \t]*"
4326 c-line-comment-starter)
4327 (or fill-prefix ""))))
4328 ;; Kludge: If the function that adapted the fill prefix
4329 ;; doesn't produce the required comment starter for line
4330 ;; comments, then we ignore it.
4331 (setq fill-prefix nil)))
4332 )))
4333
51f606de
GM
4334 (cond ((eq fill-prefix t)
4335 ;; A call from do-auto-fill which should be ignored.
4336 )
4337 (fill-prefix
4338 ;; A fill-prefix overrides anything.
4339 (funcall do-line-break)
4340 (insert-and-inherit fill-prefix))
0386b551 4341 ((c-save-buffer-state ()
51f606de 4342 (unless c-lit-limits
a66cd3ee 4343 (setq c-lit-limits (c-literal-limits)))
51f606de
GM
4344 (unless c-lit-type
4345 (setq c-lit-type (c-literal-type c-lit-limits)))
4346 (memq c-lit-type '(c c++)))
a66cd3ee 4347 ;; Some sort of comment.
b8ded794
GM
4348 (if (or comment-multi-line
4349 (save-excursion
4350 (goto-char (car c-lit-limits))
4351 (end-of-line)
4352 (< (point) (cdr c-lit-limits))))
51f606de 4353 ;; Inside a comment that should be continued.
d9e94c22
MS
4354 (let ((fill (c-save-buffer-state nil
4355 (c-guess-fill-prefix
4356 (setq c-lit-limits
4357 (c-collect-line-comments c-lit-limits))
4358 c-lit-type)))
a66cd3ee 4359 (pos (point))
94dd9d6d 4360 (start-col (current-column))
a66cd3ee
MS
4361 (comment-text-end
4362 (or (and (eq c-lit-type 'c)
4363 (save-excursion
4364 (goto-char (- (cdr c-lit-limits) 2))
4365 (if (looking-at "\\*/") (point))))
4366 (cdr c-lit-limits))))
4367 ;; Skip forward past the fill prefix in case
4368 ;; we're standing in it.
4369 ;;
4370 ;; FIXME: This doesn't work well in cases like
4371 ;;
4372 ;; /* Bla bla bla bla bla
4373 ;; bla bla
4374 ;;
4375 ;; If point is on the 'B' then the line will be
4376 ;; broken after "Bla b".
94dd9d6d
AM
4377 ;;
4378 ;; If we have an empty comment, /* */, the next
4379 ;; lot of code pushes point to the */. We fix
4380 ;; this by never allowing point to end up to the
4381 ;; right of where it started.
a66cd3ee
MS
4382 (while (and (< (current-column) (cdr fill))
4383 (not (eolp)))
4384 (forward-char 1))
4385 (if (and (> (point) comment-text-end)
4386 (> (c-point 'bol) (car c-lit-limits)))
51f606de 4387 (progn
a66cd3ee
MS
4388 ;; The skip takes us out of the (block)
4389 ;; comment; insert the fill prefix at bol
4390 ;; instead and keep the position.
4391 (setq pos (copy-marker pos t))
4392 (beginning-of-line)
4393 (insert-and-inherit (car fill))
4394 (if soft (insert-and-inherit ?\n) (newline 1))
4395 (goto-char pos)
4396 (set-marker pos nil))
4397 ;; Don't break in the middle of a comment starter
4398 ;; or ender.
4399 (cond ((> (point) comment-text-end)
4400 (goto-char comment-text-end))
4401 ((< (point) (+ (car c-lit-limits) 2))
4402 (goto-char (+ (car c-lit-limits) 2))))
51f606de 4403 (funcall do-line-break)
94dd9d6d
AM
4404 (insert-and-inherit (car fill))
4405 (if (> (current-column) start-col)
4406 (move-to-column start-col)))) ; can this hit the
4407 ; middle of a TAB?
51f606de
GM
4408 ;; Inside a comment that should be broken.
4409 (let ((comment-start comment-start)
4410 (comment-end comment-end)
4411 col)
4412 (if (eq c-lit-type 'c)
4413 (unless (string-match "[ \t]*/\\*" comment-start)
4414 (setq comment-start "/* " comment-end " */"))
4415 (unless (string-match "[ \t]*//" comment-start)
4416 (setq comment-start "// " comment-end "")))
4417 (setq col (save-excursion
4418 (back-to-indentation)
4419 (current-column)))
4420 (funcall do-line-break)
4421 (when (and comment-end (not (equal comment-end "")))
4422 (forward-char -1)
4423 (insert-and-inherit comment-end)
4424 (forward-char 1))
4425 ;; c-comment-indent may look at the current
4426 ;; indentation, so let's start out with the same
4427 ;; indentation as the previous one.
4428 (indent-to col)
4429 (insert-and-inherit comment-start)
4430 (indent-for-comment))))
a66cd3ee
MS
4431 ((c-query-and-set-macro-start)
4432 ;; In a macro.
4433 (unless (looking-at "[ \t]*\\\\$")
4434 ;; Do not clobber the alignment of the line continuation
4435 ;; slash; c-backslash-region might look at it.
4436 (delete-horizontal-space))
4437 ;; Got an asymmetry here: In normal code this command
4438 ;; doesn't indent the next line syntactically, and otoh a
4439 ;; normal syntactically indenting newline doesn't continue
4440 ;; the macro.
4441 (c-newline-and-indent (if allow-auto-fill nil 1)))
51f606de
GM
4442 (t
4443 ;; Somewhere else in the code.
4444 (let ((col (save-excursion
a66cd3ee
MS
4445 (beginning-of-line)
4446 (while (and (looking-at "[ \t]*\\\\?$")
4447 (= (forward-line -1) 0)))
4448 (current-indentation))))
51f606de
GM
4449 (funcall do-line-break)
4450 (indent-to col))))))
4451
4452(defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
efbc652a 4453(make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line "21.1")
51f606de
GM
4454
4455;; advice for indent-new-comment-line for older Emacsen
4456(unless (boundp 'comment-line-break-function)
130c507e 4457 (defvar c-inside-line-break-advice nil)
51f606de
GM
4458 (defadvice indent-new-comment-line (around c-line-break-advice
4459 activate preactivate)
4460 "Call `c-indent-new-comment-line' if in CC Mode."
130c507e 4461 (if (or c-inside-line-break-advice
51f606de
GM
4462 (not c-buffer-is-cc-mode))
4463 ad-do-it
130c507e 4464 (let ((c-inside-line-break-advice t))
51f606de
GM
4465 (c-indent-new-comment-line (ad-get-arg 0))))))
4466
4467(defun c-context-line-break ()
4468 "Do a line break suitable to the context.
4469
a66cd3ee
MS
4470When point is outside a comment or macro, insert a newline and indent
4471according to the syntactic context, unless `c-syntactic-indentation'
4472is nil, in which case the new line is indented as the previous
4473non-empty line instead.
4474
4475When point is inside the content of a preprocessor directive, a line
4476continuation backslash is inserted before the line break and aligned
4477appropriately. The end of the cpp directive doesn't count as inside
4478it.
51f606de
GM
4479
4480When point is inside a comment, continue it with the appropriate
4481comment prefix (see the `c-comment-prefix-regexp' and
4482`c-block-comment-prefix' variables for details). The end of a
51c9af45
AM
4483C++-style line comment doesn't count as inside it.
4484
4485When point is inside a string, only insert a backslash when it is also
4486inside a preprocessor directive."
0386b551 4487
51f606de 4488 (interactive "*")
0386b551 4489 (let* (c-lit-limits c-lit-type
a66cd3ee 4490 (c-macro-start c-macro-start))
0386b551 4491
51c9af45
AM
4492 (c-save-buffer-state ()
4493 (setq c-lit-limits (c-literal-limits nil nil t)
4494 c-lit-type (c-literal-type c-lit-limits))
4495 (when (eq c-lit-type 'c++)
4496 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4497 (c-query-and-set-macro-start))
0386b551 4498
51c9af45
AM
4499 (cond
4500 ((or (eq c-lit-type 'c)
4501 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4502 (< (save-excursion
4503 (skip-chars-forward " \t")
4504 (point))
4505 (1- (cdr c-lit-limits))))
4506 (and (numberp c-macro-start) ; Macro, but not at the very end of
4507 ; it, not in a string, and not in the
4508 ; cpp keyword.
4509 (not (eq c-lit-type 'string))
4510 (or (not (looking-at "\\s *$"))
4511 (eq (char-before) ?\\))
4512 (<= (save-excursion
4513 (goto-char c-macro-start)
4514 (if (looking-at c-opt-cpp-start)
4515 (goto-char (match-end 0)))
4516 (point))
4517 (point))))
4518 (let ((comment-multi-line t)
4519 (fill-prefix nil))
4520 (c-indent-new-comment-line nil t)))
4521
4522 ((eq c-lit-type 'string)
4523 (if (and (numberp c-macro-start)
4524 (not (eq (char-before) ?\\)))
4525 (insert ?\\))
4526 (newline))
4527
4528 (t (delete-horizontal-space)
4529 (newline)
51f606de
GM
4530 ;; c-indent-line may look at the current indentation, so let's
4531 ;; start out with the same indentation as the previous line.
51c9af45
AM
4532 (let ((col (save-excursion
4533 (backward-char)
4534 (forward-line 0)
4535 (while (and (looking-at "[ \t]*\\\\?$")
4536 (= (forward-line -1) 0)))
4537 (current-indentation))))
4538 (indent-to col))
4539 (indent-according-to-mode)))))
785eecbb 4540
a66cd3ee
MS
4541(defun c-context-open-line ()
4542 "Insert a line break suitable to the context and leave point before it.
4543This is the `c-context-line-break' equivalent to `open-line', which is
4544normally bound to C-o. See `c-context-line-break' for the details."
4545 (interactive "*")
4546 (let ((here (point)))
4547 (unwind-protect
4548 (progn
4549 ;; Temporarily insert a non-whitespace char to keep any
4550 ;; preceding whitespace intact.
4551 (insert ?x)
4552 (c-context-line-break))
4553 (goto-char here)
4554 (delete-char 1))))
4555
785eecbb 4556\f
130c507e 4557(cc-provide 'cc-cmds)
3afbc435 4558
cbee283d 4559;; arch-tag: bf0611dc-d1f4-449e-9e45-4ec7c6936677
785eecbb 4560;;; cc-cmds.el ends here