Spelling fixes.
[emacs.git] / lisp / progmodes / cc-cmds.el
blob1eaf8910d140b7d65b41f6355a05eb1fb64ee6fc
1 ;;; cc-cmds.el --- user level commands for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2011 Free Software Foundation, Inc.
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs
9 ;; 1987 Stewart Clamen
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
14 ;; Package: cc-mode
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 ;;; Commentary:
33 ;;; Code:
35 (eval-when-compile
36 (let ((load-path
37 (if (and (boundp 'byte-compile-dest-file)
38 (stringp byte-compile-dest-file))
39 (cons (file-name-directory byte-compile-dest-file) load-path)
40 load-path)))
41 (load "cc-bytecomp" nil t)))
43 (cc-require 'cc-defs)
44 (cc-require 'cc-vars)
45 (cc-require 'cc-engine)
47 ;; Silence the compiler.
48 (cc-bytecomp-defun delete-forward-p) ; XEmacs
49 (cc-bytecomp-defvar filladapt-mode) ; c-fill-paragraph contains a kludge
50 ; which looks at this.
52 ;; Indentation / Display syntax functions
53 (defvar c-fix-backslashes t)
55 (defun c-indent-line (&optional syntax quiet ignore-point-pos)
56 "Indent the current line according to the syntactic context,
57 if `c-syntactic-indentation' is non-nil. Optional SYNTAX is the
58 syntactic information for the current line. Be silent about syntactic
59 errors if the optional argument QUIET is non-nil, even if
60 `c-report-syntactic-errors' is non-nil. Normally the position of
61 point is used to decide where the old indentation is on a lines that
62 is otherwise empty \(ignoring any line continuation backslash), but
63 that's not done if IGNORE-POINT-POS is non-nil. Returns the amount of
64 indentation change \(in columns)."
66 (let ((line-cont-backslash (save-excursion
67 (end-of-line)
68 (eq (char-before) ?\\)))
69 (c-fix-backslashes c-fix-backslashes)
70 bs-col
71 shift-amt)
72 (when (and (not ignore-point-pos)
73 (save-excursion
74 (beginning-of-line)
75 (looking-at (if line-cont-backslash
76 ;; Don't use "\\s " - ^L doesn't count as WS
77 ;; here
78 "\\([ \t]*\\)\\\\$"
79 "\\([ \t]*\\)$")))
80 (<= (point) (match-end 1)))
81 ;; Delete all whitespace after point if there's only whitespace
82 ;; on the line, so that any code that does back-to-indentation
83 ;; or similar gets the current column in this case. If this
84 ;; removes a line continuation backslash it'll be restored
85 ;; at the end.
86 (unless c-auto-align-backslashes
87 ;; Should try to keep the backslash alignment
88 ;; in this case.
89 (save-excursion
90 (goto-char (match-end 0))
91 (setq bs-col (1- (current-column)))))
92 (delete-region (point) (match-end 0))
93 (setq c-fix-backslashes t))
94 (if c-syntactic-indentation
95 (setq c-parsing-error
96 (or (let ((c-parsing-error nil)
97 (c-syntactic-context
98 (or syntax
99 (and (boundp 'c-syntactic-context)
100 c-syntactic-context))))
101 (c-save-buffer-state (indent)
102 (unless c-syntactic-context
103 (setq c-syntactic-context (c-guess-basic-syntax)))
104 (setq indent (c-get-syntactic-indentation
105 c-syntactic-context))
106 (and (not (c-echo-parsing-error quiet))
107 c-echo-syntactic-information-p
108 (message "syntax: %s, indent: %d"
109 c-syntactic-context indent))
110 (setq shift-amt (- indent (current-indentation))))
111 (c-shift-line-indentation shift-amt)
112 (run-hooks 'c-special-indent-hook)
113 c-parsing-error)
114 c-parsing-error))
115 (let ((indent 0))
116 (save-excursion
117 (while (and (= (forward-line -1) 0)
118 (if (looking-at "\\s *\\\\?$")
120 (setq indent (current-indentation))
121 nil))))
122 (setq shift-amt (- indent (current-indentation)))
123 (c-shift-line-indentation shift-amt)))
124 (when (and c-fix-backslashes line-cont-backslash)
125 (if bs-col
126 (save-excursion
127 (indent-to bs-col)
128 (insert ?\\))
129 (when c-auto-align-backslashes
130 ;; Realign the line continuation backslash.
131 (c-backslash-region (point) (point) nil t))))
132 shift-amt))
134 (defun c-newline-and-indent (&optional newline-arg)
135 "Insert a newline and indent the new line.
136 This function fixes line continuation backslashes if inside a macro,
137 and takes care to set the indentation before calling
138 `indent-according-to-mode', so that lineup functions like
139 `c-lineup-dont-change' works better."
141 ;; TODO: Backslashes before eol in comments and literals aren't
142 ;; kept intact.
143 (let ((c-macro-start (c-query-macro-start))
144 ;; Avoid calling c-backslash-region from c-indent-line if it's
145 ;; called during the newline call, which can happen due to
146 ;; c-electric-continued-statement, for example. We also don't
147 ;; want any backslash alignment from indent-according-to-mode.
148 (c-fix-backslashes nil)
149 has-backslash insert-backslash
150 start col)
151 (save-excursion
152 (beginning-of-line)
153 (setq start (point))
154 (while (and (looking-at "[ \t]*\\\\?$")
155 (= (forward-line -1) 0)))
156 (setq col (current-indentation)))
157 (when c-macro-start
158 (if (and (eolp) (eq (char-before) ?\\))
159 (setq insert-backslash t
160 has-backslash t)
161 (setq has-backslash (eq (char-before (c-point 'eol)) ?\\))))
162 (newline newline-arg)
163 (indent-to col)
164 (when c-macro-start
165 (if insert-backslash
166 (progn
167 ;; The backslash stayed on the previous line. Insert one
168 ;; before calling c-backslash-region, so that
169 ;; bs-col-after-end in it works better. Fixup the
170 ;; backslashes on the newly inserted line.
171 (insert ?\\)
172 (backward-char)
173 (c-backslash-region (point) (point) nil t))
174 ;; The backslash moved to the new line, if there was any. Let
175 ;; c-backslash-region fix a backslash on the previous line,
176 ;; and the one that might be on the new line.
177 ;; c-auto-align-backslashes is intentionally ignored here;
178 ;; maybe the moved backslash should be left alone if it's set,
179 ;; but we fix both lines on the grounds that the old backslash
180 ;; has been moved anyway and is now in a different context.
181 (c-backslash-region start (if has-backslash (point) start) nil t)))
182 (when c-syntactic-indentation
183 ;; Reindent syntactically. The indentation done above is not
184 ;; wasted, since c-indent-line might look at the current
185 ;; indentation.
186 (let ((c-syntactic-context (c-save-buffer-state nil
187 (c-guess-basic-syntax))))
188 ;; We temporarily insert another line break, so that the
189 ;; lineup functions will see the line as empty. That makes
190 ;; e.g. c-lineup-cpp-define more intuitive since it then
191 ;; proceeds to the preceding line in this case.
192 (insert ?\n)
193 (delete-horizontal-space)
194 (setq start (- (point-max) (point)))
195 (unwind-protect
196 (progn
197 (backward-char)
198 (indent-according-to-mode))
199 (goto-char (- (point-max) start))
200 (delete-char -1)))
201 (when has-backslash
202 ;; Must align the backslash again after reindentation. The
203 ;; c-backslash-region call above can't be optimized to ignore
204 ;; this line, since it then won't align correctly with the
205 ;; lines below if the first line in the macro is broken.
206 (c-backslash-region (point) (point) nil t)))))
208 (defun c-show-syntactic-information (arg)
209 "Show syntactic information for current line.
210 With universal argument, inserts the analysis as a comment on that line."
211 (interactive "P")
212 (let* ((c-parsing-error nil)
213 (syntax (if (boundp 'c-syntactic-context)
214 ;; Use `c-syntactic-context' in the same way as
215 ;; `c-indent-line', to be consistent.
216 c-syntactic-context
217 (c-save-buffer-state nil
218 (c-guess-basic-syntax)))))
219 (if (not (consp arg))
220 (let (elem pos ols)
221 (message "Syntactic analysis: %s" syntax)
222 (unwind-protect
223 (progn
224 (while syntax
225 (setq elem (pop syntax))
226 (when (setq pos (c-langelem-pos elem))
227 (push (c-put-overlay pos (1+ pos)
228 'face 'highlight)
229 ols))
230 (when (setq pos (c-langelem-2nd-pos elem))
231 (push (c-put-overlay pos (1+ pos)
232 'face 'secondary-selection)
233 ols)))
234 (sit-for 10))
235 (while ols
236 (c-delete-overlay (pop ols)))))
237 (indent-for-comment)
238 (insert-and-inherit (format "%s" syntax))
240 (c-keep-region-active))
242 (defun c-syntactic-information-on-region (from to)
243 "Insert a comment with the syntactic analysis on every line in the region."
244 (interactive "*r")
245 (save-excursion
246 (save-restriction
247 (narrow-to-region from to)
248 (goto-char (point-min))
249 (while (not (eobp))
250 (c-show-syntactic-information '(0))
251 (forward-line)))))
254 ;; Minor mode functions.
255 (defun c-update-modeline ()
256 (let ((fmt (format "/%s%s%s%s"
257 (if c-electric-flag "l" "")
258 (if (and c-electric-flag c-auto-newline)
259 "a" "")
260 (if c-hungry-delete-key "h" "")
261 (if (and
262 ;; subword might not be loaded.
263 (boundp 'subword-mode)
264 (symbol-value 'subword-mode))
266 "")))
267 ;; FIXME: Derived modes might want to use something else
268 ;; than a string for `mode-name'.
269 (bare-mode-name (if (string-match "\\(^[^/]*\\)/" mode-name)
270 (match-string 1 mode-name)
271 mode-name)))
272 ;; (setq c-submode-indicators
273 ;; (if (> (length fmt) 1)
274 ;; fmt))
275 (setq mode-name
276 (if (> (length fmt) 1)
277 (concat bare-mode-name fmt)
278 bare-mode-name))
279 (force-mode-line-update)))
281 (defun c-toggle-syntactic-indentation (&optional arg)
282 "Toggle syntactic indentation.
283 Optional numeric ARG, if supplied, turns on syntactic indentation when
284 positive, turns it off when negative, and just toggles it when zero or
285 left out.
287 When syntactic indentation is turned on (the default), the indentation
288 functions and the electric keys indent according to the syntactic
289 context keys, when applicable.
291 When it's turned off, the electric keys don't reindent, the indentation
292 functions indents every new line to the same level as the previous
293 nonempty line, and \\[c-indent-command] adjusts the indentation in steps
294 specified by `c-basic-offset'. The indentation style has no effect in
295 this mode, nor any of the indentation associated variables,
296 e.g. `c-special-indent-hook'.
298 This 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))
304 (defun c-toggle-auto-newline (&optional arg)
305 "Toggle auto-newline feature.
306 Optional numeric ARG, if supplied, turns on auto-newline when
307 positive, turns it off when negative, and just toggles it when zero or
308 left out.
310 Turning on auto-newline automatically enables electric indentation.
312 When the auto-newline feature is enabled (indicated by \"/la\" on the
313 modeline after the mode name) newlines are automatically inserted
314 after special characters such as brace, comma, semi-colon, and colon."
315 (interactive "P")
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))
319 (c-update-modeline)
320 (c-keep-region-active))
322 (defalias 'c-toggle-auto-state 'c-toggle-auto-newline)
323 (make-obsolete 'c-toggle-auto-state 'c-toggle-auto-newline "22.1")
325 (defun c-toggle-hungry-state (&optional arg)
326 "Toggle hungry-delete-key feature.
327 Optional numeric ARG, if supplied, turns on hungry-delete when
328 positive, turns it off when negative, and just toggles it when zero or
329 left out.
331 When the hungry-delete-key feature is enabled (indicated by \"/h\" on
332 the modeline after the mode name) the delete key gobbles all preceding
333 whitespace in one fell swoop."
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))
339 (defun c-toggle-auto-hungry-state (&optional arg)
340 "Toggle auto-newline and hungry-delete-key features.
341 Optional numeric ARG, if supplied, turns on auto-newline and
342 hungry-delete when positive, turns them off when negative, and just
343 toggles them when zero or left out.
345 See `c-toggle-auto-newline' and `c-toggle-hungry-state' for details."
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))
352 (defun c-toggle-electric-state (&optional arg)
353 "Toggle the electric indentation feature.
354 Optional numeric ARG, if supplied, turns on electric indentation when
355 positive, turns it off when negative, and just toggles it when zero or
356 left 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))
363 ;; Electric keys
365 (defun c-electric-backspace (arg)
366 "Delete the preceding character or whitespace.
367 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
368 line) then all preceding whitespace is consumed. If however a prefix
369 argument is supplied, or `c-hungry-delete-key' is nil, or point is
370 inside a literal then the function in the variable
371 `c-backspace-function' is called."
372 (interactive "*P")
373 (if (c-save-buffer-state ()
374 (or (not c-hungry-delete-key)
376 (c-in-literal)))
377 (funcall c-backspace-function (prefix-numeric-value arg))
378 (c-hungry-delete-backwards)))
380 (defun c-hungry-delete-backwards ()
381 "Delete the preceding character or all preceding whitespace
382 back to the previous non-whitespace character.
383 See 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))))
391 (defalias 'c-hungry-backspace 'c-hungry-delete-backwards)
393 (defun c-electric-delete-forward (arg)
394 "Delete the following character or whitespace.
395 If `c-hungry-delete-key' is non-nil (indicated by \"/h\" on the mode
396 line) then all following whitespace is consumed. If however a prefix
397 argument is supplied, or `c-hungry-delete-key' is nil, or point is
398 inside a literal then the function in the variable `c-delete-function'
399 is called."
400 (interactive "*P")
401 (if (c-save-buffer-state ()
402 (or (not c-hungry-delete-key)
404 (c-in-literal)))
405 (funcall c-delete-function (prefix-numeric-value arg))
406 (c-hungry-delete-forward)))
408 (defun c-hungry-delete-forward ()
409 "Delete the following character or all following whitespace
410 up to the next non-whitespace character.
411 See also \\[c-hungry-delete-backwards]."
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))))
419 ;; This function is only used in XEmacs.
420 (defun c-electric-delete (arg)
421 "Deletes preceding or following character or whitespace.
422 This function either deletes forward as `c-electric-delete-forward' or
423 backward as `c-electric-backspace', depending on the configuration: If
424 the function `delete-forward-p' is defined and returns non-nil, it
425 deletes forward. Otherwise it deletes backward.
427 Note: 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
429 function to control that."
430 (interactive "*P")
431 (if (and (fboundp 'delete-forward-p)
432 (delete-forward-p))
433 (c-electric-delete-forward arg)
434 (c-electric-backspace arg)))
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.
439 The direction of deletion depends on the configuration: If the
440 function `delete-forward-p' is defined and returns non-nil, it deletes
441 forward using `c-hungry-delete-forward'. Otherwise it deletes
442 backward using `c-hungry-backspace'.
444 Note: 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
446 function to control that."
447 (interactive)
448 (if (and (fboundp 'delete-forward-p)
449 (delete-forward-p))
450 (c-hungry-delete-forward)
451 (c-hungry-delete-backwards)))
453 (defun c-electric-pound (arg)
454 "Insert a \"#\".
455 If `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
457 inside a literal or a macro, nothing special happens."
458 (interactive "*P")
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)))
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)
478 (insert last-command-event)
479 (and (not bolp)
480 (goto-char (- (point-max) pos)))
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))
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.
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
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))
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))))
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.
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))))
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.
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.
592 (let ((here (point))
593 (pos (- (point-max) (point)))
594 mbeg1 mend1 mbeg4 mend4
595 eol-col cmnt-pos cmnt-col cmnt-gap)
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.
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)))
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)))
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))))))
660 (defun c-electric-brace (arg)
661 "Insert a brace.
663 If `c-electric-flag' is non-nil, the brace is not inside a literal and a
664 numeric ARG hasn't been supplied, the command performs several electric
665 actions:
667 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
668 the mode line) newlines are inserted before and after the brace as
669 directed by the settings in `c-hanging-braces-alist'.
671 \(b) Any auto-newlines are indented. The original line is also
672 reindented unless `c-syntactic-indentation' is nil.
674 \(c) If auto-newline is turned on, various newline cleanups based on the
675 settings of `c-cleanup-list' are done."
677 (interactive "*P")
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)
684 (c-save-buffer-state ()
685 (setq safepos (c-safe-position (point) (c-parse-state))
686 literal (c-in-literal safepos)))
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))
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))
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))
708 (when c-auto-newline
709 (backward-char)
710 (setq br-syntax (c-point-syntax)
711 newlines (c-brace-newlines br-syntax))
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)
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))
728 ;; Do all appropriate clean ups
729 (let ((here (point))
730 (pos (- (point-max) (point)))
731 mbeg mend
734 ;; `}': clean up empty defun braces
735 (when (c-save-buffer-state ()
736 (and (memq 'empty-defun-braces c-cleanup-list)
737 (eq last-command-event ?\})
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)
750 ;; `}': compact to a one-liner defun?
751 (save-match-data
752 (when
753 (and (eq last-command-event ?\})
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))))
759 ;; `{': clean up brace-else-brace and brace-elseif-brace
760 (when (eq last-command-event ?\{)
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\\)*"
769 "\\=")
770 nil t))
771 (delete-region (match-beginning 0) (match-end 0))
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);
795 (delete-region mbeg mend)
796 (goto-char mbeg)
797 (insert ?\ ))))
799 (goto-char (- (point-max) pos))
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)))
808 ;; does a newline go after the brace?
809 (if (memq 'after newlines)
810 (c-newline-and-indent))
811 ))))
813 ;; blink the paren
814 (and (eq last-command-event ?\})
815 (not executing-kbd-macro)
816 old-blink-paren
817 (save-excursion
818 (c-save-buffer-state nil
819 (c-backward-syntactic-ws safepos))
820 (funcall old-blink-paren)))))
822 (defun c-electric-slash (arg)
823 "Insert a slash character.
825 If the slash is inserted immediately after the comment prefix in a c-style
826 comment, the comment might get closed by removing whitespace and possibly
827 inserting a \"*\". See the variable `c-cleanup-list'.
829 Indent the line as a comment, if:
831 1. The slash is second of a \"//\" line oriented comment introducing
832 token and we are on a comment-only-line, or
834 2. The slash is part of a \"*/\" token that closes a block oriented
835 comment.
837 If a numeric ARG is supplied, point is inside a literal, or
838 `c-syntactic-indentation' is nil or `c-electric-flag' is nil, indentation
839 is inhibited."
840 (interactive "*P")
841 (let ((literal (c-save-buffer-state () (c-in-literal)))
842 indentp
843 ;; shut this up
844 (c-echo-syntactic-information-p nil))
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)
851 (eq last-command-event ?/)
852 (looking-at (concat "[ \t]*\\("
853 (regexp-quote comment-end) "\\)?$"))
854 ; (eq c-block-comment-ender "*/") ; C-style comments ALWAYS end in */
855 (save-excursion
856 (save-restriction
857 (narrow-to-region (point-min) (point))
858 (back-to-indentation)
859 (looking-at (concat c-current-comment-prefix "[ \t]*$")))))
860 (delete-region (progn (forward-line 0) (point))
861 (progn (end-of-line) (point)))
862 (insert-char ?* 1)) ; the / comes later. ; Do I need a t (retain sticky properties) here?
864 (setq indentp (and (not arg)
865 c-syntactic-indentation
866 c-electric-flag
867 (eq last-command-event ?/)
868 (eq (char-before) (if literal ?* ?/))))
869 (self-insert-command (prefix-numeric-value arg))
870 (if indentp
871 (indent-according-to-mode))))
873 (defun c-electric-star (arg)
874 "Insert a star character.
875 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, and
876 the star is the second character of a C style comment starter on a
877 comment-only-line, indent the line as a comment. If a numeric ARG is
878 supplied, point is inside a literal, or `c-syntactic-indentation' is nil,
879 this indentation is inhibited."
881 (interactive "*P")
882 (self-insert-command (prefix-numeric-value arg))
883 ;; if we are in a literal, or if arg is given do not reindent the
884 ;; current line, unless this star introduces a comment-only line.
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))))
898 (let (c-echo-syntactic-information-p) ; shut this up
899 (indent-according-to-mode))
902 (defun c-electric-semi&comma (arg)
903 "Insert a comma or semicolon.
905 If `c-electric-flag' is non-nil, point isn't inside a literal and a
906 numeric ARG hasn't been supplied, the command performs several electric
907 actions:
909 \(a) When the auto-newline feature is turned on (indicated by \"/la\" on
910 the mode line) a newline might be inserted. See the variable
911 `c-hanging-semi&comma-criteria' for how newline insertion is determined.
913 \(b) Any auto-newlines are indented. The original line is also
914 reindented unless `c-syntactic-indentation' is nil.
916 \(c) If auto-newline is turned on, a comma following a brace list or a
917 semicolon following a defun might be cleaned up, depending on the
918 settings of `c-cleanup-list'."
919 (interactive "*P")
920 (let* (lim literal c-syntactic-context
921 (here (point))
922 ;; shut this up
923 (c-echo-syntactic-information-p nil))
925 (c-save-buffer-state ()
926 (setq lim (c-most-enclosing-brace (c-parse-state))
927 literal (c-in-literal lim)))
929 (self-insert-command (prefix-numeric-value arg))
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
941 (eq last-command-event ?,)
942 (memq 'list-close-comma c-cleanup-list))
943 (and
944 (eq last-command-event ?\;)
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)))
970 (if add-newline-p
971 (c-newline-and-indent))
972 )))))
974 (defun c-electric-colon (arg)
975 "Insert a colon.
977 If `c-electric-flag' is non-nil, the colon is not inside a literal and a
978 numeric ARG hasn't been supplied, the command performs several electric
979 actions:
981 \(a) If the auto-newline feature is turned on (indicated by \"/la\" on
982 the mode line) newlines are inserted before and after the colon based on
983 the settings in `c-hanging-colons-alist'.
985 \(b) Any auto-newlines are indented. The original line is also
986 reindented unless `c-syntactic-indentation' is nil.
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'."
992 (interactive "*P")
993 (let* ((bod (c-point 'bod))
994 (literal (c-save-buffer-state () (c-in-literal bod)))
995 newlines is-scope-op
996 ;; shut this up
997 (c-echo-syntactic-information-p nil))
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))
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)))
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))
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. Let's 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 ))))
1076 (defun c-electric-lt-gt (arg)
1077 "Insert a \"<\" or \">\" character.
1078 If the current language uses angle bracket parens (e.g. template
1079 arguments in C++), try to find out if the inserted character is a
1080 paren and give it paren syntax if appropriate.
1082 If `c-electric-flag' and `c-syntactic-indentation' are both non-nil, the
1083 line will be reindented if the inserted character is a paren or if it
1084 finishes a C++ style stream operator in C++ mode. Exceptions are when a
1085 numeric argument is supplied, or the point is inside a literal."
1087 (interactive "*P")
1088 (let ((c-echo-syntactic-information-p nil)
1089 final-pos close-paren-inserted found-delim)
1091 (self-insert-command (prefix-numeric-value arg))
1092 (setq final-pos (point))
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.
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)))
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)))))))))
1148 (goto-char final-pos)
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)))))
1160 (defun c-electric-paren (arg)
1161 "Insert a parenthesis.
1163 If `c-syntactic-indentation' and `c-electric-flag' are both non-nil, the
1164 line is reindented unless a numeric ARG is supplied, or the parenthesis
1165 is inserted inside a literal.
1167 Whitespace between a function name and the parenthesis may get added or
1168 removed; see the variable `c-cleanup-list'.
1170 Also, if `c-electric-flag' and `c-auto-newline' are both non-nil, some
1171 newline cleanups are done if appropriate; see the variable `c-cleanup-list'."
1172 (interactive "*P")
1173 (let ((literal (c-save-buffer-state () (c-in-literal)))
1174 ;; shut this up
1175 (c-echo-syntactic-information-p nil))
1176 (self-insert-command (prefix-numeric-value arg))
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))
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]*\\\\?$"))
1191 ;; clean up brace-elseif-brace
1192 (when
1193 (and (memq 'brace-elseif-brace c-cleanup-list)
1194 (eq last-command-event ?\()
1195 (re-search-backward
1196 (concat "}"
1197 "\\([ \t\n]\\|\\\\\n\\)*"
1198 "else"
1199 "\\([ \t\n]\\|\\\\\n\\)+"
1200 "if"
1201 "\\([ \t\n]\\|\\\\\n\\)*"
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 ("))
1209 ;; clean up brace-catch-brace
1210 (when
1211 (and (memq 'brace-catch-brace c-cleanup-list)
1212 (eq last-command-event ?\()
1213 (re-search-backward
1214 (concat "}"
1215 "\\([ \t\n]\\|\\\\\n\\)*"
1216 "catch"
1217 "\\([ \t\n]\\|\\\\\n\\)*"
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 (")))
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
1231 ;; space-before-funcall clean-up?
1232 ((and (memq 'space-before-funcall c-cleanup-list)
1233 (eq last-command-event ?\()
1234 (save-excursion
1235 (backward-char)
1236 (skip-chars-backward " \t")
1237 (setq beg (point))
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))))))
1243 (save-excursion
1244 (delete-region beg end)
1245 (goto-char beg)
1246 (insert ?\ )))
1248 ;; compact-empty-funcall clean-up?
1249 ((c-save-buffer-state ()
1250 (and (memq 'compact-empty-funcall c-cleanup-list)
1251 (eq last-command-event ?\))
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))))))
1265 (defun c-electric-continued-statement ()
1266 "Reindent the current line if appropriate.
1268 This function is used to reindent the line after a keyword which
1269 continues an earlier statement is typed, e.g. an \"else\" or the
1270 \"while\" in a do-while block.
1272 The line is reindented if there is nothing but whitespace before the
1273 keyword on the line, the keyword is not inserted inside a literal, and
1274 `c-electric-flag' and `c-syntactic-indentation' are both non-nil."
1275 (let (;; shut this up
1276 (c-echo-syntactic-information-p nil))
1277 (when (c-save-buffer-state ()
1278 (and c-electric-flag
1279 c-syntactic-indentation
1280 (not (eq last-command-event ?_))
1281 (= (save-excursion
1282 (skip-syntax-backward "w")
1283 (point))
1284 (c-point 'boi))
1285 (not (c-in-literal (c-point 'bod)))))
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)))))
1298 (declare-function subword-forward "subword" (&optional arg))
1299 (declare-function subword-backward "subword" (&optional arg))
1301 ;; "nomenclature" functions + c-scope-operator.
1302 (defun c-forward-into-nomenclature (&optional arg)
1303 "Compatibility alias for `c-forward-subword'."
1304 (interactive "p")
1305 (require 'subword)
1306 (subword-forward arg))
1307 (make-obsolete 'c-forward-into-nomenclature 'subword-forward "23.2")
1309 (defun c-backward-into-nomenclature (&optional arg)
1310 "Compatibility alias for `c-backward-subword'."
1311 (interactive "p")
1312 (require 'subword)
1313 (subword-backward arg))
1314 (make-obsolete 'c-backward-into-nomenclature 'subword-backward "23.2")
1316 (defun c-scope-operator ()
1317 "Insert a double colon scope operator at point.
1318 No indentation or other \"electric\" behavior is performed."
1319 (interactive "*")
1320 (insert-and-inherit "::"))
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 ;".
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.
1333 ;; If LIM is non-nil, it is the bound on a the backward search for the
1334 ;; beginning of the declaration.
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)
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)))))
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.
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'.
1377 ;; This function might do hidden buffer changes.
1378 (save-excursion
1379 (let* (kluge-start
1380 decl-result brace-decl-p
1381 (start (point))
1382 (paren-state (c-parse-state))
1383 (least-enclosing (c-least-enclosing-brace paren-state)))
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)
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.
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
1412 ;; NOTE: If we're in a K&R region, this might be the start
1413 ;; of a parameter declaration, not the actual function.
1414 (and least-enclosing ; LIMIT for c-b-of-decl-1
1415 (c-safe-position least-enclosing paren-state)))))
1417 ;; Has the declaration we've gone back to got braces?
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.
1427 (c-in-knr-argdecl))))))
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))))))))
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.
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.
1457 ;; If we run out of functions, leave point at BOB. Return zero on success,
1458 ;; otherwise the number of {s still to go.
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)))
1471 ((memq where '(at-header outwith-function at-function-end in-trailer))
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)))
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))))
1488 (defun c-narrow-to-most-enclosing-decl-block (&optional inclusive)
1489 ;; If we are inside a decl-block (in the sense of c-looking-at-decl-block),
1490 ;; i.e. something like namespace{} or extern{}, narrow to the insides of
1491 ;; that block (NOT including the enclosing braces) if INCLUSIVE is nil,
1492 ;; otherwise include the braces. If the closing brace is missing,
1493 ;; (point-max) is used instead.
1494 (let ((paren-state (c-parse-state))
1495 encl-decl)
1496 (setq encl-decl (and paren-state (c-most-enclosing-decl-block paren-state)))
1497 (if encl-decl
1498 (save-excursion
1499 (narrow-to-region
1500 (if inclusive
1501 (progn (goto-char encl-decl)
1502 (c-beginning-of-decl-1)
1503 (point))
1504 (1+ encl-decl))
1505 (progn
1506 (goto-char encl-decl)
1507 (or (c-safe (forward-list)
1508 (if inclusive
1509 (point)
1510 (1- (point))))
1511 (point-max))))))))
1513 (defun c-widen-to-enclosing-decl-scope (paren-state orig-point-min orig-point-max)
1514 ;; Narrow the buffer to the innermost declaration scope (e.g. a class, a
1515 ;; namespace or the "whole buffer") recorded in PAREN-STATE, the bounding
1516 ;; braces NOT being included in the resulting region. On no account may the
1517 ;; final region exceed that bounded by ORIG-POINT-MIN, ORIG-POINT-MAX.
1518 ;; PAREN-STATE is a list of buffer positions in the style of
1519 ;; (c-parse-state), one of which will be that of the desired opening brace,
1520 ;; if there is one.
1522 ;; Return the position of the enclosing opening brace, or nil
1523 (let (encl-decl) ; putative position of decl-scope's opening brace.
1524 (save-restriction
1525 (narrow-to-region orig-point-min orig-point-max)
1526 (setq encl-decl (and paren-state
1527 (c-most-enclosing-decl-block paren-state))))
1528 (if encl-decl
1529 (progn
1530 (widen)
1531 (narrow-to-region (1+ encl-decl)
1532 (save-excursion
1533 (goto-char encl-decl)
1534 (or (c-safe (forward-list)
1535 (1- (point)))
1536 orig-point-max)))
1537 encl-decl)
1538 (narrow-to-region orig-point-min orig-point-max)
1539 nil)))
1541 (eval-and-compile
1542 (defmacro c-while-widening-to-decl-block (condition)
1543 ;; Repeatedly evaluate CONDITION until it returns nil. After each
1544 ;; evaluation, if `c-defun-tactic' is set appropriately, widen to innards
1545 ;; of the next enclosing declaration block (e.g. namespace, class), or the
1546 ;; buffer's original restriction.
1548 ;; This is a very special purpose macro, which assumes the existence of
1549 ;; several variables. It is for use only in c-beginning-of-defun and
1550 ;; c-end-of-defun.
1551 `(while
1552 (and ,condition
1553 (eq c-defun-tactic 'go-outward)
1554 lim)
1555 (setq paren-state (c-whack-state-after lim paren-state))
1556 (setq lim (c-widen-to-enclosing-decl-scope
1557 paren-state orig-point-min orig-point-max))
1558 (setq where 'in-block))))
1560 (defun c-beginning-of-defun (&optional arg)
1561 "Move backward to the beginning of a defun.
1562 Every top level declaration that contains a brace paren block is
1563 considered to be a defun.
1565 With a positive argument, move backward that many defuns. A negative
1566 argument -N means move forward to the Nth following beginning. Return
1567 t unless search stops due to beginning or end of buffer.
1569 Unlike the built-in `beginning-of-defun' this tries to be smarter
1570 about finding the char with open-parenthesis syntax that starts the
1571 defun."
1573 (interactive "p")
1574 (or arg (setq arg 1))
1576 (or (not (eq this-command 'c-beginning-of-defun))
1577 (eq last-command 'c-beginning-of-defun)
1578 (and transient-mark-mode mark-active)
1579 (push-mark))
1581 (c-save-buffer-state
1582 (beginning-of-defun-function end-of-defun-function
1583 (start (point))
1584 (paren-state (copy-tree (c-parse-state))) ; This must not share list
1585 ; structure with other users of c-state-cache.
1586 (orig-point-min (point-min)) (orig-point-max (point-max))
1587 lim ; Position of { which has been widened to.
1588 where pos)
1590 (save-restriction
1591 (if (eq c-defun-tactic 'go-outward)
1592 (setq lim (c-widen-to-enclosing-decl-scope ; e.g. class, namespace.
1593 paren-state orig-point-min orig-point-max)))
1595 ;; Move back out of any macro/comment/string we happen to be in.
1596 (c-beginning-of-macro)
1597 (setq pos (c-literal-limits))
1598 (if pos (goto-char (car pos)))
1600 (setq where (c-where-wrt-brace-construct))
1602 (if (< arg 0)
1603 ;; Move forward to the closing brace of a function.
1604 (progn
1605 (if (memq where '(at-function-end outwith-function))
1606 (setq arg (1+ arg)))
1607 (if (< arg 0)
1608 (c-while-widening-to-decl-block
1609 (< (setq arg (- (c-forward-to-nth-EOF-} (- arg) where))) 0)))
1610 ;; Move forward to the next opening brace....
1611 (when (and (= arg 0)
1612 (progn
1613 (c-while-widening-to-decl-block
1614 (not (c-syntactic-re-search-forward "{" nil 'eob)))
1615 (eq (char-before) ?{)))
1616 (backward-char)
1617 ;; ... and backward to the function header.
1618 (c-beginning-of-decl-1)
1621 ;; Move backward to the opening brace of a function, making successively
1622 ;; larger portions of the buffer visible as necessary.
1623 (when (> arg 0)
1624 (c-while-widening-to-decl-block
1625 (> (setq arg (c-backward-to-nth-BOF-{ arg where)) 0)))
1627 (when (eq arg 0)
1628 ;; Go backward to this function's header.
1629 (c-beginning-of-decl-1)
1631 (setq pos (point))
1632 ;; We're now there, modulo comments and whitespace.
1633 ;; Try to be line oriented; position point at the closest
1634 ;; preceding boi that isn't inside a comment, but if we hit
1635 ;; the previous declaration then we use the current point
1636 ;; instead.
1637 (while (and (/= (point) (c-point 'boi))
1638 (c-backward-single-comment)))
1639 (if (/= (point) (c-point 'boi))
1640 (goto-char pos)))
1642 (c-keep-region-active)
1643 (= arg 0)))))
1645 (defun c-forward-to-nth-EOF-} (n where)
1646 ;; Skip to the closing brace of the Nth function after point. If
1647 ;; point is inside a function, this counts as the first. Point must be
1648 ;; outside any comment/string or macro.
1650 ;; N must be strictly positive.
1651 ;; WHERE describes the position of point, one of the symbols `at-header',
1652 ;; `in-header', `in-block', `in-trailer', `at-function-end',
1653 ;; `outwith-function' as returned by c-where-wrt-brace-construct.
1655 ;; If we run out of functions, leave point at EOB. Return zero on success,
1656 ;; otherwise the number of }s still to go.
1658 ;; This function may do hidden buffer changes.
1660 (cond
1661 ;; What we do to go forward over the first defun depends on where we
1662 ;; start. We go to the closing brace of that defun, even when we go
1663 ;; backwards to it (in a "struct foo {...} bar ;").
1664 ((eobp))
1665 ((eq where 'in-block)
1666 (goto-char (c-least-enclosing-brace (c-parse-state)))
1667 (forward-sexp)
1668 (setq n (1- n)))
1669 ((eq where 'in-trailer)
1670 (c-syntactic-skip-backward "^}")
1671 (setq n (1- n)))
1672 ((memq where '(at-function-end outwith-function at-header in-header))
1673 (when (c-syntactic-re-search-forward "{" nil 'eob)
1674 (backward-char)
1675 (forward-sexp)
1676 (setq n (1- n))))
1677 (t (error "c-forward-to-nth-EOF-}: `where' is %s" where)))
1679 ;; Each time round the loop, go forward to a "}" at the outermost level.
1680 (while (and (> n 0) (not (eobp)))
1681 ;(c-parse-state) ; This call speeds up the following one by a factor
1682 ; of ~6. Hmmm. 2006/4/5.
1683 (when (c-syntactic-re-search-forward "{" nil 'eob)
1684 (backward-char)
1685 (forward-sexp))
1686 (setq n (1- n)))
1689 (defun c-end-of-defun (&optional arg)
1690 "Move forward to the end of a top level declaration.
1691 With argument, do it that many times. Negative argument -N means move
1692 back to Nth preceding end. Returns t unless search stops due to
1693 beginning or end of buffer.
1695 An end of a defun occurs right after the close-parenthesis that matches
1696 the open-parenthesis that starts a defun; see `beginning-of-defun'."
1697 (interactive "p")
1698 (or arg (setq arg 1))
1700 (or (not (eq this-command 'c-end-of-defun))
1701 (eq last-command 'c-end-of-defun)
1702 (and transient-mark-mode mark-active)
1703 (push-mark))
1705 (c-save-buffer-state
1706 (beginning-of-defun-function end-of-defun-function
1707 (start (point))
1708 (paren-state (copy-tree (c-parse-state))) ; This must not share list
1709 ; structure with other users of c-state-cache.
1710 (orig-point-min (point-min)) (orig-point-max (point-max))
1712 where pos)
1713 (save-restriction
1714 (if (eq c-defun-tactic 'go-outward)
1715 (setq lim (c-widen-to-enclosing-decl-scope ; e.g. class, namespace
1716 paren-state orig-point-min orig-point-max)))
1718 ;; Move back out of any macro/comment/string we happen to be in.
1719 (c-beginning-of-macro)
1720 (setq pos (c-literal-limits))
1721 (if pos (goto-char (car pos)))
1723 (setq where (c-where-wrt-brace-construct))
1725 (if (< arg 0)
1726 ;; Move backwards to the } of a function
1727 (progn
1728 (if (memq where '(at-header outwith-function))
1729 (setq arg (1+ arg)))
1730 (if (< arg 0)
1731 (c-while-widening-to-decl-block
1732 (< (setq arg (- (c-backward-to-nth-BOF-{ (- arg) where))) 0)))
1733 (if (= arg 0)
1734 (c-while-widening-to-decl-block
1735 (progn (c-syntactic-skip-backward "^}")
1736 (not (eq (char-before) ?}))))))
1738 ;; Move forward to the } of a function
1739 (if (> arg 0)
1740 (c-while-widening-to-decl-block
1741 (> (setq arg (c-forward-to-nth-EOF-} arg where)) 0))))
1743 ;; Do we need to move forward from the brace to the semicolon?
1744 (when (eq arg 0)
1745 (if (c-in-function-trailer-p) ; after "}" of struct/enum, etc.
1746 (c-syntactic-re-search-forward ";"))
1748 (setq pos (point))
1749 ;; We're there now, modulo comments and whitespace.
1750 ;; Try to be line oriented; position point after the next
1751 ;; newline that isn't inside a comment, but if we hit the
1752 ;; next declaration then we use the current point instead.
1753 (while (and (not (bolp))
1754 (not (looking-at "\\s *$"))
1755 (c-forward-single-comment)))
1756 (cond ((bolp))
1757 ((looking-at "\\s *$")
1758 (forward-line 1))
1760 (goto-char pos))))
1762 (c-keep-region-active)
1763 (= arg 0))))
1765 (defun c-defun-name ()
1766 "Return the name of the current defun, or NIL if there isn't one.
1767 \"Defun\" here means a function, or other top level construct
1768 with a brace block."
1769 (interactive)
1770 (c-save-buffer-state
1771 (beginning-of-defun-function end-of-defun-function
1772 where pos name-end)
1774 (save-restriction
1775 (widen)
1776 (save-excursion
1777 ;; Move back out of any macro/comment/string we happen to be in.
1778 (c-beginning-of-macro)
1779 (setq pos (c-literal-limits))
1780 (if pos (goto-char (car pos)))
1782 (setq where (c-where-wrt-brace-construct))
1784 ;; Move to the beginning of the current defun, if any, if we're not
1785 ;; already there.
1786 (if (eq where 'outwith-function)
1788 (unless (eq where 'at-header)
1789 (c-backward-to-nth-BOF-{ 1 where)
1790 (c-beginning-of-decl-1))
1792 ;; Pick out the defun name, according to the type of defun.
1793 (cond
1794 ;; struct, union, enum, or similar:
1795 ((and (looking-at c-type-prefix-key)
1796 (progn (c-forward-token-2 2) ; over "struct foo "
1797 (or (eq (char-after) ?\{)
1798 (looking-at c-symbol-key)))) ; "struct foo bar ..."
1799 (save-match-data (c-forward-token-2))
1800 (when (eq (char-after) ?\{)
1801 (c-backward-token-2)
1802 (looking-at c-symbol-key))
1803 (match-string-no-properties 0))
1805 ((looking-at "DEFUN\\_>")
1806 ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
1807 ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
1808 (down-list 1)
1809 (c-forward-syntactic-ws)
1810 (when (eq (char-after) ?\")
1811 (forward-sexp 1)
1812 (c-forward-token-2)) ; over the comma and following WS.
1813 (buffer-substring-no-properties
1814 (point)
1815 (progn
1816 (c-forward-token-2)
1817 (when (looking-at ":") ; CLISP: DEFUN(PACKAGE:LISP-SYMBOL,...)
1818 (skip-chars-forward "^,"))
1819 (c-backward-syntactic-ws)
1820 (point))))
1822 ((looking-at "DEF[a-zA-Z0-9_]* *( *\\([^, ]*\\) *,")
1823 ;; DEFCHECKER(sysconf_arg,prefix=_SC,default=, ...) ==> sysconf_arg
1824 ;; DEFFLAGSET(syslog_opt_flags,LOG_PID ...) ==> syslog_opt_flags
1825 (match-string-no-properties 1))
1828 ;; Normal function or initializer.
1829 (when (c-syntactic-re-search-forward "[{(]" nil t)
1830 (backward-char)
1831 (c-backward-syntactic-ws)
1832 (when (eq (char-before) ?\=) ; struct foo bar = {0, 0} ;
1833 (c-backward-token-2)
1834 (c-backward-syntactic-ws))
1835 (setq name-end (point))
1836 (c-backward-token-2)
1837 (buffer-substring-no-properties (point) name-end)))))))))
1839 (defun c-declaration-limits (near)
1840 ;; Return a cons of the beginning and end positions of the current
1841 ;; top level declaration or macro. If point is not inside any then
1842 ;; nil is returned, unless NEAR is non-nil in which case the closest
1843 ;; following one is chosen instead (if there is any). The end
1844 ;; position is at the next line, providing there is one before the
1845 ;; declaration.
1847 ;; This function might do hidden buffer changes.
1848 (save-excursion
1849 (save-restriction
1850 (when (eq c-defun-tactic 'go-outward)
1851 (c-narrow-to-most-enclosing-decl-block t) ; e.g. class, namespace
1852 (or (save-restriction
1853 (c-narrow-to-most-enclosing-decl-block nil)
1855 ;; Note: Some code duplication in `c-beginning-of-defun' and
1856 ;; `c-end-of-defun'.
1857 (catch 'exit
1858 (let ((start (point))
1859 (paren-state (c-parse-state))
1860 lim pos end-pos)
1861 (unless (c-safe
1862 (goto-char (c-least-enclosing-brace paren-state))
1863 ;; If we moved to the outermost enclosing paren
1864 ;; then we can use c-safe-position to set the
1865 ;; limit. Can't do that otherwise since the
1866 ;; earlier paren pair on paren-state might very
1867 ;; well be part of the declaration we should go
1868 ;; to.
1869 (setq lim (c-safe-position (point) paren-state))
1871 ;; At top level. Make sure we aren't inside a literal.
1872 (setq pos (c-literal-limits
1873 (c-safe-position (point) paren-state)))
1874 (if pos (goto-char (car pos))))
1876 (when (c-beginning-of-macro)
1877 (throw 'exit
1878 (cons (point)
1879 (save-excursion
1880 (c-end-of-macro)
1881 (forward-line 1)
1882 (point)))))
1884 (setq pos (point))
1885 (when (or (eq (car (c-beginning-of-decl-1 lim)) 'previous)
1886 (= pos (point)))
1887 ;; We moved back over the previous defun. Skip to the next
1888 ;; one. Not using c-forward-syntactic-ws here since we
1889 ;; should not skip a macro. We can also be directly after
1890 ;; the block in a `c-opt-block-decls-with-vars-key'
1891 ;; declaration, but then we won't move significantly far
1892 ;; here.
1893 (goto-char pos)
1894 (c-forward-comments)
1896 (when (and near (c-beginning-of-macro))
1897 (throw 'exit
1898 (cons (point)
1899 (save-excursion
1900 (c-end-of-macro)
1901 (forward-line 1)
1902 (point))))))
1904 (if (eobp) (throw 'exit nil))
1906 ;; Check if `c-beginning-of-decl-1' put us after the block in a
1907 ;; declaration that doesn't end there. We're searching back and
1908 ;; forth over the block here, which can be expensive.
1909 (setq pos (point))
1910 (if (and c-opt-block-decls-with-vars-key
1911 (progn
1912 (c-backward-syntactic-ws)
1913 (eq (char-before) ?}))
1914 (eq (car (c-beginning-of-decl-1))
1915 'previous)
1916 (save-excursion
1917 (c-end-of-decl-1)
1918 (and (> (point) pos)
1919 (setq end-pos (point)))))
1921 (goto-char pos))
1923 (if (and (not near) (> (point) start))
1926 ;; Try to be line oriented; position the limits at the
1927 ;; closest preceding boi, and after the next newline, that
1928 ;; isn't inside a comment, but if we hit a neighboring
1929 ;; declaration then we instead use the exact declaration
1930 ;; limit in that direction.
1931 (cons (progn
1932 (setq pos (point))
1933 (while (and (/= (point) (c-point 'boi))
1934 (c-backward-single-comment)))
1935 (if (/= (point) (c-point 'boi))
1937 (point)))
1938 (progn
1939 (if end-pos
1940 (goto-char end-pos)
1941 (c-end-of-decl-1))
1942 (setq pos (point))
1943 (while (and (not (bolp))
1944 (not (looking-at "\\s *$"))
1945 (c-forward-single-comment)))
1946 (cond ((bolp)
1947 (point))
1948 ((looking-at "\\s *$")
1949 (forward-line 1)
1950 (point))
1952 pos))))))))
1953 (and (not near)
1954 (goto-char (point-min))
1955 (c-forward-decl-or-cast-1 -1 nil nil)
1956 (eq (char-after) ?\{)
1957 (cons (point-min) (point-max))))))))
1959 (defun c-mark-function ()
1960 "Put mark at end of the current top-level declaration or macro, point at beginning.
1961 If point is not inside any then the closest following one is chosen.
1963 As opposed to \\[c-beginning-of-defun] and \\[c-end-of-defun], this
1964 function does not require the declaration to contain a brace block."
1965 (interactive)
1967 (let (decl-limits)
1968 (c-save-buffer-state nil
1969 ;; We try to be line oriented, unless there are several
1970 ;; declarations on the same line.
1971 (if (looking-at c-syntactic-eol)
1972 (c-backward-token-2 1 nil (c-point 'bol)))
1973 (setq decl-limits (c-declaration-limits t)))
1975 (if (not decl-limits)
1976 (error "Cannot find any declaration")
1977 (goto-char (car decl-limits))
1978 (push-mark (cdr decl-limits) nil t))))
1980 (defun c-cpp-define-name ()
1981 "Return the name of the current CPP macro, or NIL if we're not in one."
1982 (interactive)
1983 (save-excursion
1984 (and c-opt-cpp-macro-define-start
1985 (c-beginning-of-macro)
1986 (looking-at c-opt-cpp-macro-define-start)
1987 (match-string-no-properties 1))))
1990 ;; Movement by statements.
1991 (defun c-in-comment-line-prefix-p ()
1992 ;; Point is within a comment. Is it also within a comment-prefix?
1993 ;; Space at BOL which precedes a comment-prefix counts as part of it.
1995 ;; This function might do hidden buffer changes.
1996 (let ((here (point)))
1997 (save-excursion
1998 (beginning-of-line)
1999 (skip-chars-forward " \t")
2000 (and (looking-at c-current-comment-prefix)
2001 (/= (match-beginning 0) (match-end 0))
2002 (< here (match-end 0))))))
2004 (defun c-narrow-to-comment-innards (range)
2005 ;; Narrow to the "inside" of the comment (block) defined by range, as
2006 ;; follows:
2008 ;; A c-style block comment has its opening "/*" and its closing "*/" (if
2009 ;; present) removed. A c++-style line comment retains its opening "//" but
2010 ;; has any final NL removed. If POINT is currently outwith these innards,
2011 ;; move it to the appropriate boundary.
2013 ;; This narrowing simplifies the sentence movement functions, since it
2014 ;; eliminates awkward things at the boundaries of the comment (block).
2016 ;; This function might do hidden buffer changes.
2017 (let* ((lit-type (c-literal-type range))
2018 (beg (if (eq lit-type 'c) (+ (car range) 2) (car range)))
2019 (end (if (eq lit-type 'c)
2020 (if (and (eq (char-before (cdr range)) ?/)
2021 (eq (char-before (1- (cdr range))) ?*))
2022 (- (cdr range) 2)
2023 (point-max))
2024 (if (eq (cdr range) (point-max))
2025 (point-max)
2026 (- (cdr range) 1)))))
2027 (if (> (point) end)
2028 (goto-char end)) ; This would be done automatically by ...
2029 (if (< (point) beg)
2030 (goto-char beg)) ; ... narrow-to-region but is not documented.
2031 (narrow-to-region beg end)))
2033 (defun c-beginning-of-sentence-in-comment (range)
2034 ;; Move backwards to the "beginning of a sentence" within the comment
2035 ;; defined by RANGE, a cons of its starting and ending positions. If we
2036 ;; find a BOS, return NIL. Otherwise, move point to just before the start
2037 ;; of the comment and return T.
2039 ;; The BOS is either text which follows a regexp match of sentence-end,
2040 ;; or text which is a beginning of "paragraph".
2041 ;; Comment-prefixes are treated like WS when calculating BOSes or BOPs.
2043 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2044 ;; It is not a general function, but is intended only for calling from
2045 ;; c-move-over-sentence. Not all preconditions have been explicitly stated.
2047 ;; This function might do hidden buffer changes.
2048 (save-match-data
2049 (let ((start-point (point)))
2050 (save-restriction
2051 (c-narrow-to-comment-innards range) ; This may move point back.
2052 (let* ((here (point))
2053 last
2054 (here-filler ; matches WS and comment-prefices at point.
2055 (concat "\\=\\(^[ \t]*\\(" c-current-comment-prefix "\\)"
2056 "\\|[ \t\n\r\f]\\)*"))
2057 (prefix-at-bol-here ; matches WS and prefix at BOL, just before point
2058 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)[ \t\n\r\f]*\\="))
2059 ;; First, find the previous paragraph start, if any.
2060 (par-beg ; point where non-WS/non-prefix text of paragraph starts.
2061 (save-excursion
2062 (forward-paragraph -1) ; uses cc-mode values of
2063 ; paragraph-\(start\|separate\)
2064 (if (> (re-search-forward here-filler nil t) here)
2065 (goto-char here))
2066 (when (>= (point) here)
2067 (forward-paragraph -2)
2068 (if (> (re-search-forward here-filler nil t) here)
2069 (goto-char here)))
2070 (point))))
2072 ;; Now seek successively earlier sentence ends between PAR-BEG and
2073 ;; HERE, until the "start of sentence" following it is earlier than
2074 ;; HERE, or we hit PAR-BEG. Beware of comment prefices!
2075 (while (and (re-search-backward (c-sentence-end) par-beg 'limit)
2076 (setq last (point))
2077 (goto-char (match-end 0)) ; tentative beginning of sentence
2078 (or (>= (point) here)
2079 (and (not (bolp)) ; Found a non-blank comment-prefix?
2080 (save-excursion
2081 (if (re-search-backward prefix-at-bol-here nil t)
2082 (/= (match-beginning 1) (match-end 1)))))
2083 (progn ; Skip the crud to find a real b-o-s.
2084 (if (c-in-comment-line-prefix-p)
2085 (beginning-of-line))
2086 (re-search-forward here-filler) ; always succeeds.
2087 (>= (point) here))))
2088 (goto-char last))
2089 (re-search-forward here-filler)))
2091 (if (< (point) start-point)
2093 (goto-char (car range))
2094 t))))
2096 (defun c-end-of-sentence-in-comment (range)
2097 ;; Move forward to the "end of a sentence" within the comment defined by
2098 ;; RANGE, a cons of its starting and ending positions (enclosing the opening
2099 ;; comment delimiter and the terminating */ or newline). If we find an EOS,
2100 ;; return NIL. Otherwise, move point to just after the end of the comment
2101 ;; and return T.
2103 ;; The EOS is just after the non-WS part of the next match of the regexp
2104 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2105 ;; no sentence-end match following point, any WS before the end of the
2106 ;; comment will count as EOS, providing we're not already in it.
2108 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2109 ;; It is not a general function, but is intended only for calling from
2110 ;; c-move-over-sentence.
2112 ;; This function might do hidden buffer changes.
2113 (save-match-data
2114 (let ((start-point (point))
2115 ;; (lit-type (c-literal-type range)) ; Commented out, 2005/11/23, ACM
2117 (save-restriction
2118 (c-narrow-to-comment-innards range) ; This might move point forwards.
2119 (let* ((here (point))
2120 (par-end ; EOL position of last text in current/next paragraph.
2121 (save-excursion
2122 ;; The cc-mode values of paragraph-\(start\|separate\), set
2123 ;; in c-setup-paragraph-variables, are used in the
2124 ;; following.
2125 (forward-paragraph 1)
2126 (if (eq (preceding-char) ?\n) (forward-char -1))
2127 (when (<= (point) here) ; can happen, e.g., when HERE is at EOL.
2128 (goto-char here)
2129 (forward-paragraph 2)
2130 (if (eq (preceding-char) ?\n) (forward-char -1)))
2131 (point)))
2133 last
2134 (prefix-at-bol-here
2135 (concat "^[ \t]*\\(" c-current-comment-prefix "\\)\\=")))
2136 ;; Go forward one "comment-prefix which looks like sentence-end"
2137 ;; each time round the following:
2138 (while (and (re-search-forward (c-sentence-end) par-end 'limit)
2139 (progn
2140 (setq last (point))
2141 (skip-chars-backward " \t\n")
2142 (or (and (not (bolp))
2143 (re-search-backward prefix-at-bol-here nil t)
2144 (/= (match-beginning 1) (match-end 1)))
2145 (<= (point) here))))
2146 (goto-char last))
2148 ;; Take special action if we're up against the end of a comment (of
2149 ;; either sort): Leave point just after the last non-ws text.
2150 (if (eq (point) (point-max))
2151 (while (or (/= (skip-chars-backward " \t\n") 0)
2152 (and (re-search-backward prefix-at-bol-here nil t)
2153 (/= (match-beginning 1) (match-end 1))))))))
2155 (if (> (point) start-point)
2157 (goto-char (cdr range))
2158 t))))
2160 (defun c-beginning-of-sentence-in-string (range)
2161 ;; Move backwards to the "beginning of a sentence" within the string defined
2162 ;; by RANGE, a cons of its starting and ending positions (enclosing the
2163 ;; string quotes). If we find a BOS, return NIL. Otherwise, move point to
2164 ;; just before the start of the string and return T.
2166 ;; The BOS is either the text which follows a regexp match of sentence-end
2167 ;; or text which is a beginning of "paragraph". For the purposes of
2168 ;; determining paragraph boundaries, escaped newlines are treated as
2169 ;; ordinary newlines.
2171 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2172 ;; It is not a general function, but is intended only for calling from
2173 ;; c-move-over-sentence.
2175 ;; This function might do hidden buffer changes.
2176 (save-match-data
2177 (let* ((here (point)) last
2178 (end (1- (cdr range)))
2179 (here-filler ; matches WS and escaped newlines at point.
2180 "\\=\\([ \t\n\r\f]\\|\\\\[\n\r]\\)*")
2181 ;; Enhance paragraph-start and paragraph-separate also to recognize
2182 ;; blank lines terminated by escaped EOLs. IT MAY WELL BE that
2183 ;; these values should be customizable user options, or something.
2184 (paragraph-start c-string-par-start)
2185 (paragraph-separate c-string-par-separate)
2187 (par-beg ; beginning of current (or previous) paragraph.
2188 (save-excursion
2189 (save-restriction
2190 (narrow-to-region (1+ (car range)) end)
2191 (forward-paragraph -1) ; uses above values of
2192 ; paragraph-\(start\|separate\)
2193 (if (> (re-search-forward here-filler nil t) here)
2194 (goto-char here))
2195 (when (>= (point) here)
2196 (forward-paragraph -2)
2197 (if (> (re-search-forward here-filler nil t) here)
2198 (goto-char here)))
2199 (point)))))
2200 ;; Now see if we can find a sentence end after PAR-BEG.
2201 (while (and (re-search-backward c-sentence-end-with-esc-eol par-beg 'limit)
2202 (setq last (point))
2203 (goto-char (match-end 0))
2204 (or (> (point) end)
2205 (progn
2206 (re-search-forward
2207 here-filler end t) ; always succeeds. Use end rather
2208 ; than here, in case point starts
2209 ; beyond the closing quote.
2210 (>= (point) here))))
2211 (goto-char last))
2212 (re-search-forward here-filler here t)
2213 (if (< (point) here)
2215 (goto-char (car range))
2216 t))))
2218 (defun c-end-of-sentence-in-string (range)
2219 ;; Move forward to the "end of a sentence" within the string defined by
2220 ;; RANGE, a cons of its starting and ending positions. If we find an EOS,
2221 ;; return NIL. Otherwise, move point to just after the end of the string
2222 ;; and return T.
2224 ;; The EOS is just after the non-WS part of the next match of the regexp
2225 ;; sentence-end. Typically, this is just after one of [.!?]. If there is
2226 ;; no sentence-end match following point, any WS before the end of the
2227 ;; string will count as EOS, providing we're not already in it.
2229 ;; This code was adapted from GNU Emacs's forward-sentence in paragraphs.el.
2230 ;; It is not a general function, but is intended only for calling from
2231 ;; c-move-over-sentence.
2233 ;; This function might do hidden buffer changes.
2234 (save-match-data
2235 (let* ((here (point))
2236 last
2237 ;; Enhance paragraph-start and paragraph-separate to recognize
2238 ;; blank lines terminated by escaped EOLs.
2239 (paragraph-start c-string-par-start)
2240 (paragraph-separate c-string-par-separate)
2242 (par-end ; EOL position of last text in current/next paragraph.
2243 (save-excursion
2244 (save-restriction
2245 (narrow-to-region (car range) (1- (cdr range)))
2246 ;; The above values of paragraph-\(start\|separate\) are used
2247 ;; in the following.
2248 (forward-paragraph 1)
2249 (setq last (point))
2250 ;; (re-search-backward filler-here nil t) would find an empty
2251 ;; string. Therefore we simulate it by the following:
2252 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2253 (re-search-backward "\\\\\\($\\)\\=" nil t)))
2254 (unless (> (point) here)
2255 (goto-char last)
2256 (forward-paragraph 1)
2257 (while (or (/= (skip-chars-backward " \t\n\r\f") 0)
2258 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2259 (point)))))
2260 ;; Try to go forward a sentence.
2261 (when (re-search-forward c-sentence-end-with-esc-eol par-end 'limit)
2262 (setq last (point))
2263 (while (or (/= (skip-chars-backward " \t\n") 0)
2264 (re-search-backward "\\\\\\($\\)\\=" nil t))))
2265 ;; Did we move a sentence, or did we hit the end of the string?
2266 (if (> (point) here)
2268 (goto-char (cdr range))
2269 t))))
2271 (defun c-ascertain-preceding-literal ()
2272 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2273 ;; If a literal is the next thing (aside from whitespace) to be found before
2274 ;; point, return a cons of its start.end positions (enclosing the
2275 ;; delimiters). Otherwise return NIL.
2277 ;; This function might do hidden buffer changes.
2278 (save-excursion
2279 (c-collect-line-comments
2280 (let ((here (point))
2281 pos)
2282 (if (c-backward-single-comment)
2283 (cons (point) (progn (c-forward-single-comment) (point)))
2284 (save-restriction
2285 ;; to prevent `looking-at' seeing a " at point.
2286 (narrow-to-region (point-min) here)
2287 (when
2289 ;; An EOL can act as an "open string" terminator in AWK.
2290 (looking-at c-ws*-string-limit-regexp)
2291 (and (not (bobp))
2292 (progn (backward-char)
2293 (looking-at c-string-limit-regexp))))
2294 (goto-char (match-end 0)) ; just after the string terminator.
2295 (setq pos (point))
2296 (c-safe (c-backward-sexp 1) ; move back over the string.
2297 (cons (point) pos)))))))))
2299 (defun c-ascertain-following-literal ()
2300 ;; Point is not in a literal (i.e. comment or string (include AWK regexp)).
2301 ;; If a literal is the next thing (aside from whitespace) following point,
2302 ;; return a cons of its start.end positions (enclosing the delimiters).
2303 ;; Otherwise return NIL.
2305 ;; This function might do hidden buffer changes.
2306 (save-excursion
2307 (c-collect-line-comments
2308 (let (pos)
2309 (c-skip-ws-forward)
2310 (if (looking-at c-string-limit-regexp) ; string-delimiter.
2311 (cons (point) (or (c-safe (progn (c-forward-sexp 1) (point)))
2312 (point-max)))
2313 (setq pos (point))
2314 (if (c-forward-single-comment)
2315 (cons pos (point))))))))
2317 (defun c-after-statement-terminator-p () ; Should we pass in LIM here?
2318 ;; Does point immediately follow a statement "terminator"? A virtual
2319 ;; semicolon is regarded here as such. So is a an opening brace ;-)
2321 ;; This function might do hidden buffer changes.
2322 (or (save-excursion
2323 (backward-char)
2324 (and (looking-at "[;{}]")
2325 (not (and c-special-brace-lists ; Pike special brace lists.
2326 (eq (char-after) ?{)
2327 (c-looking-at-special-brace-list)))))
2328 (c-at-vsemi-p)
2329 ;; The following (for macros) is not strict about exactly where we are
2330 ;; wrt white space at the end of the macro. Doesn't seem to matter too
2331 ;; much. ACM 2004/3/29.
2332 (let (eom)
2333 (save-excursion
2334 (if (c-beginning-of-macro)
2335 (setq eom (progn (c-end-of-macro)
2336 (point)))))
2337 (when eom
2338 (save-excursion
2339 (c-forward-comments)
2340 (>= (point) eom))))))
2342 (defun c-back-over-illiterals (macro-start)
2343 ;; Move backwards over code which isn't a literal (i.e. comment or string),
2344 ;; stopping before reaching BOB or a literal or the boundary of a
2345 ;; preprocessor statement or the "beginning of a statement". MACRO-START is
2346 ;; the position of the '#' beginning the current preprocessor directive, or
2347 ;; NIL if we're not in such.
2349 ;; Return a cons (A.B), where
2350 ;; A is NIL if we moved back to a BOS (and know it), T otherwise (we
2351 ;; didn't move, or we hit a literal, or we're not sure about BOS).
2352 ;; B is MACRO-BOUNDARY if we are about to cross the boundary out of or
2353 ;; into a macro, otherwise LITERAL if we've hit a literal, otherwise NIL
2355 ;; The total collection of returned values is as follows:
2356 ;; (nil . nil): Found a BOS whilst remaining inside the illiterals.
2357 ;; (t . literal): No BOS found: only a comment/string. We _might_ be at
2358 ;; a BOS - the caller must check this.
2359 ;; (nil . macro-boundary): only happens with non-nil macro-start. We've
2360 ;; moved and reached the opening # of the macro.
2361 ;; (t . macro-boundary): Every other circumstance in which we're at a
2362 ;; macro-boundary. We might be at a BOS.
2364 ;; Point is left either at the beginning-of-statement, or at the last non-ws
2365 ;; code before encountering the literal/BOB or macro-boundary.
2367 ;; Note that this function moves within either preprocessor commands
2368 ;; (macros) or normal code, but will not cross a boundary between the two,
2369 ;; or between two distinct preprocessor commands.
2371 ;; Stop before `{' and after `;', `{', `}' and `};' when not followed by `}'
2372 ;; or `)', but on the other side of the syntactic ws. Move by sexps and
2373 ;; move into parens. Also stop before `#' when it's at boi on a line.
2375 ;; This function might do hidden buffer changes.
2376 (save-match-data
2377 (let ((here (point))
2378 last) ; marks the position of non-ws code, what'll be BOS if, say, a
2379 ; semicolon precedes it.
2380 (catch 'done
2381 (while t ;; We go back one "token" each iteration of the loop.
2382 (setq last (point))
2383 (cond
2384 ;; Stop at the token after a comment.
2385 ((c-backward-single-comment) ; Also functions as backwards-ws.
2386 (goto-char last)
2387 (throw 'done '(t . literal)))
2389 ;; If we've gone back over a LF, we might have moved into or out of
2390 ;; a preprocessor line.
2391 ((and (save-excursion
2392 (beginning-of-line)
2393 (re-search-forward "\\(^\\|[^\\]\\)[\n\r]" last t))
2394 (if macro-start
2395 (< (point) macro-start)
2396 (c-beginning-of-macro)))
2397 (goto-char last)
2398 ;; Return a car of NIL ONLY if we've hit the opening # of a macro.
2399 (throw 'done (cons (or (eq (point) here)
2400 (not macro-start))
2401 'macro-boundary)))
2403 ;; Have we found a virtual semicolon? If so, stop, unless the next
2404 ;; statement is where we started from.
2405 ((and (c-at-vsemi-p)
2406 (< last here)
2407 (not (memq (char-after last) '(?\) ?})))) ; we've moved back from ) or }
2408 (goto-char last)
2409 (throw 'done '(nil . nil)))
2411 ;; Hit the beginning of the buffer/region?
2412 ((bobp)
2413 (if (/= here last)
2414 (goto-char last))
2415 (throw 'done '(nil . nil)))
2417 ;; Move back a character.
2418 ((progn (backward-char) nil))
2420 ;; Stop at "{" (unless it's a PIKE special brace list.)
2421 ((eq (char-after) ?\{)
2422 (if (and c-special-brace-lists
2423 (c-looking-at-special-brace-list))
2424 (skip-syntax-backward "w_") ; Speedup only.
2425 (if (/= here last)
2426 (goto-char last))
2427 (throw 'done '(nil . nil))))
2429 ;; Have we reached the start of a macro? This always counts as
2430 ;; BOS. (N.B. I don't think (eq (point) here) can ever be true
2431 ;; here. FIXME!!! ACM 2004/3/29)
2432 ((and macro-start (eq (point) macro-start))
2433 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2435 ;; Stop at token just after "}" or ";".
2436 ((looking-at "[;}]")
2437 ;; If we've gone back over ;, {, or }, we're done.
2438 (if (or (= here last)
2439 (memq (char-after last) '(?\) ?}))) ; we've moved back from ) or }
2440 (if (and (eq (char-before) ?}) ; If };, treat them as a unit.
2441 (eq (char-after) ?\;))
2442 (backward-char))
2443 (goto-char last) ; To the statement starting after the ; or }.
2444 (throw 'done '(nil . nil))))
2446 ;; Stop at the token after a string.
2447 ((looking-at c-string-limit-regexp) ; Just gone back over a string terminator?
2448 (goto-char last)
2449 (throw 'done '(t . literal)))
2451 ;; Nothing special: go back word characters.
2452 (t (skip-syntax-backward "w_")) ; Speedup only.
2453 ))))))
2455 (defun c-forward-over-illiterals (macro-end allow-early-stop)
2456 ;; Move forwards over code, stopping before reaching EOB or a literal
2457 ;; (i.e. a comment/string) or the boundary of a preprocessor statement or
2458 ;; the "end of a statement". MACRO-END is the position of the EOL/EOB which
2459 ;; terminates the current preprocessor directive, or NIL if we're not in
2460 ;; such.
2462 ;; ALLOW-EARLY-STOP is non-nil if it is permissible to return without moving
2463 ;; forward at all, should we encounter a `{'. This is an ugly kludge, but
2464 ;; seems unavoidable. Depending on the context this function is called
2465 ;; from, we _sometimes_ need to stop there. Currently (2004/4/3),
2466 ;; ALLOW-EARLY-STOP is applied only to open braces, not to virtual
2467 ;; semicolons, or anything else.
2469 ;; Return a cons (A.B), where
2470 ;; A is NIL if we moved forward to an EOS, or stay at one (when
2471 ;; ALLOW-EARLY-STOP is set), T otherwise (we hit a literal).
2472 ;; B is 'MACRO-BOUNDARY if we are about to cross the boundary out of or
2473 ;; into a macro, otherwise 'LITERAL if we've hit a literal, otherwise NIL
2475 ;; Point is left either after the end-of-statement, or at the last non-ws
2476 ;; code before encountering the literal, or the # of the preprocessor
2477 ;; statement, or at EOB [or just after last non-WS stuff??].
2479 ;; As a clarification of "after the end-of-statement", if a comment or
2480 ;; whitespace follows a completed AWK statement, that statement is treated
2481 ;; as ending just after the last non-ws character before the comment.
2483 ;; Note that this function moves within either preprocessor commands
2484 ;; (macros) or normal code, but not both within the same invocation.
2486 ;; Stop before `{', `}', and `#' when it's at boi on a line, but on the
2487 ;; other side of the syntactic ws, and after `;', `}' and `};'. Only
2488 ;; stop before `{' if at top level or inside braces, though. Move by
2489 ;; sexps and move into parens. Also stop at eol of lines with `#' at
2490 ;; the boi.
2492 ;; This function might do hidden buffer changes.
2493 (let ((here (point))
2494 last)
2495 (catch 'done
2496 (while t ;; We go one "token" forward each time round this loop.
2497 (setq last (point))
2499 ;; If we've moved forward to a virtual semicolon, we're done.
2500 (if (and (> last here) ; Should we check ALLOW-EARLY-STOP, here? 2004/4/3
2501 (c-at-vsemi-p))
2502 (throw 'done '(nil . nil)))
2504 (c-skip-ws-forward)
2505 (cond
2506 ;; Gone past the end of a macro?
2507 ((and macro-end (> (point) macro-end))
2508 (goto-char last)
2509 (throw 'done (cons (eq (point) here) 'macro-boundary)))
2511 ;; About to hit a comment?
2512 ((save-excursion (c-forward-single-comment))
2513 (goto-char last)
2514 (throw 'done '(t . literal)))
2516 ;; End of buffer?
2517 ((eobp)
2518 (if (/= here last)
2519 (goto-char last))
2520 (throw 'done '(nil . nil)))
2522 ;; If we encounter a '{', stop just after the previous token.
2523 ((and (eq (char-after) ?{)
2524 (not (and c-special-brace-lists
2525 (c-looking-at-special-brace-list)))
2526 (or allow-early-stop (/= here last))
2527 (save-excursion ; Is this a check that we're NOT at top level?
2528 ;;;; NO! This seems to check that (i) EITHER we're at the top level; OR (ii) The next enclosing
2529 ;;;; level of bracketing is a '{'. HMM. Doesn't seem to make sense.
2530 ;;;; 2003/8/8 This might have something to do with the GCC extension "Statement Expressions", e.g.
2531 ;;;; while ({stmt1 ; stmt2 ; exp ;}). This form excludes such Statement Expressions.
2532 (or (not (c-safe (up-list -1) t))
2533 (= (char-after) ?{))))
2534 (goto-char last)
2535 (throw 'done '(nil . nil)))
2537 ;; End of a PIKE special brace list? If so, step over it and continue.
2538 ((and c-special-brace-lists
2539 (eq (char-after) ?})
2540 (save-excursion
2541 (and (c-safe (up-list -1) t)
2542 (c-looking-at-special-brace-list))))
2543 (forward-char)
2544 (skip-syntax-forward "w_")) ; Speedup only.
2546 ;; Have we got a '}' after having moved? If so, stop after the
2547 ;; previous token.
2548 ((and (eq (char-after) ?})
2549 (/= here last))
2550 (goto-char last)
2551 (throw 'done '(nil . nil)))
2553 ;; Stop if we encounter a preprocessor line. Continue if we
2554 ;; hit a naked #
2555 ((and c-opt-cpp-prefix
2556 (not macro-end)
2557 (eq (char-after) ?#)
2558 (= (point) (c-point 'boi)))
2559 (if (= (point) here) ; Not a macro, therefore naked #.
2560 (forward-char)
2561 (throw 'done '(t . macro-boundary))))
2563 ;; Stop after a ';', '}', or "};"
2564 ((looking-at ";\\|};?")
2565 (goto-char (match-end 0))
2566 (throw 'done '(nil . nil)))
2568 ;; Found a string (this subsumes AWK regexps)?
2569 ((looking-at c-string-limit-regexp)
2570 (goto-char last)
2571 (throw 'done '(t . literal)))
2574 (forward-char) ; Can't fail - we checked (eobp) earlier on.
2575 (skip-syntax-forward "w_") ; Speedup only.
2576 (when (and macro-end (> (point) macro-end))
2577 (goto-char last)
2578 (throw 'done (cons (eq (point) here) 'macro-boundary))))
2579 )))))
2581 (defun c-one-line-string-p (range)
2582 ;; Is the literal defined by RANGE a string contained in a single line?
2584 ;; This function might do hidden buffer changes.
2585 (save-excursion
2586 (goto-char (car range))
2587 (and (looking-at c-string-limit-regexp)
2588 (progn (skip-chars-forward "^\n" (cdr range))
2589 (eq (point) (cdr range))))))
2591 (defun c-beginning-of-statement (&optional count lim sentence-flag)
2592 "Go to the beginning of the innermost C statement.
2593 With prefix arg, go back N - 1 statements. If already at the
2594 beginning of a statement then go to the beginning of the closest
2595 preceding one, moving into nested blocks if necessary (use
2596 \\[backward-sexp] to skip over a block). If within or next to a
2597 comment or multiline string, move by sentences instead of statements.
2599 When called from a program, this function takes 3 optional args: the
2600 repetition count, a buffer position limit which is the farthest back
2601 to search for the syntactic context, and a flag saying whether to do
2602 sentence motion in or near comments and multiline strings.
2604 Note that for use in programs, `c-beginning-of-statement-1' is
2605 usually better. It has much better defined semantics than this one,
2606 which is intended for interactive use, and might therefore change to
2607 be more \"DWIM:ey\"."
2608 (interactive (list (prefix-numeric-value current-prefix-arg)
2609 nil t))
2610 (if (< count 0)
2611 (c-end-of-statement (- count) lim sentence-flag)
2612 (c-save-buffer-state
2613 ((count (or count 1))
2614 last ; start point for going back ONE chunk. Updated each chunk movement.
2615 (macro-fence
2616 (save-excursion (and (not (bobp)) (c-beginning-of-macro) (point))))
2617 res ; result from sub-function call
2618 not-bos ; "not beginning-of-statement"
2619 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2621 ;; Go back one statement at each iteration of the following loop.
2622 (while (and (/= count 0)
2623 (or (not lim) (> (point) lim)))
2624 ;; Go back one "chunk" each time round the following loop, stopping
2625 ;; when we reach a statement boundary, etc.
2626 (setq last (point))
2627 (while
2628 (cond ; Each arm of this cond returns NIL on reaching a desired
2629 ; statement boundary, non-NIL otherwise.
2630 ((bobp)
2631 (setq count 0)
2632 nil)
2634 (range ; point is within or approaching a literal.
2635 (cond
2636 ;; Single line string or sentence-flag is null => skip the
2637 ;; entire literal.
2638 ((or (null sentence-flag)
2639 (c-one-line-string-p range))
2640 (goto-char (car range))
2641 (setq range (c-ascertain-preceding-literal))
2642 ;; N.B. The following is essentially testing for an AWK regexp
2643 ;; at BOS:
2644 ;; Was the previous non-ws thing an end of statement?
2645 (save-excursion
2646 (if macro-fence
2647 (c-backward-comments)
2648 (c-backward-syntactic-ws))
2649 (not (or (bobp) (c-after-statement-terminator-p)))))
2651 ;; Comment inside a statement or a multi-line string.
2652 (t (when (setq res ; returns non-nil when we go out of the literal
2653 (if (eq (c-literal-type range) 'string)
2654 (c-beginning-of-sentence-in-string range)
2655 (c-beginning-of-sentence-in-comment range)))
2656 (setq range (c-ascertain-preceding-literal)))
2657 res)))
2659 ;; Non-literal code.
2660 (t (setq res (c-back-over-illiterals macro-fence))
2661 (setq not-bos ; "not reached beginning-of-statement".
2662 (or (= (point) last)
2663 (memq (char-after) '(?\) ?\}))
2664 (and
2665 (car res)
2666 ;; We're at a tentative BOS. The next form goes
2667 ;; back over WS looking for an end of previous
2668 ;; statement.
2669 (not (save-excursion
2670 (if macro-fence
2671 (c-backward-comments)
2672 (c-backward-syntactic-ws))
2673 (or (bobp) (c-after-statement-terminator-p)))))))
2674 ;; Are we about to move backwards into or out of a
2675 ;; preprocessor command? If so, locate its beginning.
2676 (when (eq (cdr res) 'macro-boundary)
2677 (save-excursion
2678 (beginning-of-line)
2679 (setq macro-fence
2680 (and (not (bobp))
2681 (progn (c-skip-ws-backward) (c-beginning-of-macro))
2682 (point)))))
2683 ;; Are we about to move backwards into a literal?
2684 (when (memq (cdr res) '(macro-boundary literal))
2685 (setq range (c-ascertain-preceding-literal)))
2686 not-bos))
2687 (setq last (point)))
2689 (if (/= count 0) (setq count (1- count))))
2690 (c-keep-region-active))))
2692 (defun c-end-of-statement (&optional count lim sentence-flag)
2693 "Go to the end of the innermost C statement.
2694 With prefix arg, go forward N - 1 statements. Move forward to the end
2695 of the next statement if already at end, and move into nested blocks
2696 \(use \\[forward-sexp] to skip over a block). If within or next to a
2697 comment or multiline string, move by sentences instead of statements.
2699 When called from a program, this function takes 3 optional args: the
2700 repetition count, a buffer position limit which is the farthest back
2701 to search for the syntactic context, and a flag saying whether to do
2702 sentence motion in or near comments and multiline strings."
2703 (interactive (list (prefix-numeric-value current-prefix-arg)
2704 nil t))
2705 (setq count (or count 1))
2706 (if (< count 0) (c-beginning-of-statement (- count) lim sentence-flag)
2708 (c-save-buffer-state
2709 (here ; start point for going forward ONE statement. Updated each statement.
2710 (macro-fence
2711 (save-excursion
2712 (and (not (eobp)) (c-beginning-of-macro)
2713 (progn (c-end-of-macro) (point)))))
2715 (range (c-collect-line-comments (c-literal-limits lim)))) ; (start.end) of current literal or NIL
2717 ;; Go back/forward one statement at each iteration of the following loop.
2718 (while (and (/= count 0)
2719 (or (not lim) (< (point) lim)))
2720 (setq here (point)) ; ONLY HERE is HERE updated
2722 ;; Go forward one "chunk" each time round the following loop, stopping
2723 ;; when we reach a statement boundary, etc.
2724 (while
2725 (cond ; Each arm of this cond returns NIL on reaching a desired
2726 ; statement boundary, non-NIL otherwise.
2727 ((eobp)
2728 (setq count 0)
2729 nil)
2731 (range ; point is within a literal.
2732 (cond
2733 ;; sentence-flag is null => skip the entire literal.
2734 ;; or a Single line string.
2735 ((or (null sentence-flag)
2736 (c-one-line-string-p range))
2737 (goto-char (cdr range))
2738 (setq range (c-ascertain-following-literal))
2739 ;; Is there a virtual semicolon here (e.g. for AWK)?
2740 (not (c-at-vsemi-p)))
2742 ;; Comment or multi-line string.
2743 (t (when (setq res ; gets non-nil when we go out of the literal
2744 (if (eq (c-literal-type range) 'string)
2745 (c-end-of-sentence-in-string range)
2746 (c-end-of-sentence-in-comment range)))
2747 (setq range (c-ascertain-following-literal)))
2748 ;; If we've just come forward out of a literal, check for
2749 ;; vsemi. (N.B. AWK can't have a vsemi after a comment, but
2750 ;; some other language may do in the future)
2751 (and res
2752 (not (c-at-vsemi-p))))))
2754 ;; Non-literal code.
2755 (t (setq res (c-forward-over-illiterals macro-fence
2756 (> (point) here)))
2757 ;; Are we about to move forward into or out of a
2758 ;; preprocessor command?
2759 (when (eq (cdr res) 'macro-boundary)
2760 (setq macro-fence
2761 (save-excursion
2762 (if macro-fence
2763 (progn
2764 (end-of-line)
2765 (and (not (eobp))
2766 (progn (c-skip-ws-forward)
2767 (c-beginning-of-macro))
2768 (progn (c-end-of-macro)
2769 (point))))
2770 (and (not (eobp))
2771 (c-beginning-of-macro)
2772 (progn (c-end-of-macro) (point)))))))
2773 ;; Are we about to move forward into a literal?
2774 (when (memq (cdr res) '(macro-boundary literal))
2775 (setq range (c-ascertain-following-literal)))
2776 (car res))))
2778 (if (/= count 0) (setq count (1- count))))
2779 (c-keep-region-active))))
2782 ;; set up electric character functions to work with pending-del,
2783 ;; (a.k.a. delsel) mode. All symbols get the t value except
2784 ;; the functions which delete, which gets 'supersede.
2785 (mapc
2786 (function
2787 (lambda (sym)
2788 (put sym 'delete-selection t) ; for delsel (Emacs)
2789 (put sym 'pending-delete t))) ; for pending-del (XEmacs)
2790 '(c-electric-pound
2791 c-electric-brace
2792 c-electric-slash
2793 c-electric-star
2794 c-electric-semi&comma
2795 c-electric-lt-gt
2796 c-electric-colon
2797 c-electric-paren))
2798 (put 'c-electric-delete 'delete-selection 'supersede) ; delsel
2799 (put 'c-electric-delete 'pending-delete 'supersede) ; pending-del
2800 (put 'c-electric-backspace 'delete-selection 'supersede) ; delsel
2801 (put 'c-electric-backspace 'pending-delete 'supersede) ; pending-del
2802 (put 'c-electric-delete-forward 'delete-selection 'supersede) ; delsel
2803 (put 'c-electric-delete-forward 'pending-delete 'supersede) ; pending-del
2806 ;; Inserting/indenting comments
2807 (defun c-calc-comment-indent (entry)
2808 ;; This function might do hidden buffer changes.
2809 (if (symbolp entry)
2810 (setq entry (or (assq entry c-indent-comment-alist)
2811 (assq 'other c-indent-comment-alist)
2812 '(default . (column . nil)))))
2813 (let ((action (car (cdr entry)))
2814 (value (cdr (cdr entry)))
2815 (col (current-column)))
2816 (cond ((eq action 'space)
2817 (+ col value))
2818 ((eq action 'column)
2819 (unless value (setq value comment-column))
2820 (if (bolp)
2821 ;; Do not pad with one space if we're at bol.
2822 value
2823 (max (1+ col) value)))
2824 ((eq action 'align)
2825 (or (save-excursion
2826 (beginning-of-line)
2827 (unless (bobp)
2828 (backward-char)
2829 (let ((lim (c-literal-limits (c-point 'bol) t)))
2830 (when (consp lim)
2831 (goto-char (car lim))
2832 (when (looking-at "/[/*]") ; FIXME!!! Adapt for AWK! (ACM, 2005/11/18)
2833 ;; Found comment to align with.
2834 (if (bolp)
2835 ;; Do not pad with one space if we're at bol.
2837 (max (1+ col) (current-column))))))))
2838 ;; Recurse to handle value as a new spec.
2839 (c-calc-comment-indent (cdr entry)))))))
2841 (defun c-comment-indent ()
2842 "Used by `indent-for-comment' to create and indent comments.
2843 See `c-indent-comment-alist' for a description."
2844 (save-excursion
2845 (end-of-line)
2846 (c-save-buffer-state
2847 ((eot (let ((lim (c-literal-limits (c-point 'bol) t)))
2848 (or (when (consp lim)
2849 (goto-char (car lim))
2850 (when (looking-at "/[/*]")
2851 (skip-chars-backward " \t")
2852 (point)))
2853 (progn
2854 (skip-chars-backward " \t")
2855 (point)))))
2856 (line-type
2857 (cond ((looking-at "^/[/*]")
2858 'anchored-comment)
2859 ((progn (beginning-of-line)
2860 (eq (point) eot))
2861 'empty-line)
2862 ((progn (back-to-indentation)
2863 (and (eq (char-after) ?})
2864 (eq (point) (1- eot))))
2865 'end-block)
2866 ((and (looking-at "#[ \t]*\\(endif\\|else\\)")
2867 (eq (match-end 0) eot))
2868 'cpp-end-block)
2870 'other))))
2871 (if (and (memq line-type '(anchored-comment empty-line))
2872 c-indent-comments-syntactically-p)
2873 (let ((c-syntactic-context (c-guess-basic-syntax)))
2874 ;; BOGOSITY ALERT: if we're looking at the eol, its
2875 ;; because indent-for-comment hasn't put the comment-start
2876 ;; in the buffer yet. this will screw up the syntactic
2877 ;; analysis so we kludge in the necessary info. Another
2878 ;; kludge is that if we're at the bol, then we really want
2879 ;; to ignore any anchoring as specified by
2880 ;; c-comment-only-line-offset since it doesn't apply here.
2881 (if (eolp)
2882 (c-add-syntax 'comment-intro))
2883 (let ((c-comment-only-line-offset
2884 (if (consp c-comment-only-line-offset)
2885 c-comment-only-line-offset
2886 (cons c-comment-only-line-offset
2887 c-comment-only-line-offset))))
2888 (c-get-syntactic-indentation c-syntactic-context)))
2889 (goto-char eot)
2890 (c-calc-comment-indent line-type)))))
2893 ;; used by outline-minor-mode
2894 (defun c-outline-level ()
2895 (let (buffer-invisibility-spec);; This so that `current-column' DTRT
2896 ;; in otherwise-hidden text.
2897 (save-excursion
2898 (skip-chars-forward "\t ")
2899 (current-column))))
2902 ;; Movement by CPP conditionals.
2903 (defun c-up-conditional (count)
2904 "Move back to the containing preprocessor conditional, leaving mark behind.
2905 A prefix argument acts as a repeat count. With a negative argument,
2906 move forward to the end of the containing preprocessor conditional.
2908 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2909 function stops at them when going backward, but not when going
2910 forward."
2911 (interactive "p")
2912 (let ((new-point (c-scan-conditionals (- count) -1)))
2913 (push-mark)
2914 (goto-char new-point))
2915 (c-keep-region-active))
2917 (defun c-up-conditional-with-else (count)
2918 "Move back to the containing preprocessor conditional, including \"#else\".
2919 Just like `c-up-conditional', except it also stops at \"#else\"
2920 directives."
2921 (interactive "p")
2922 (let ((new-point (c-scan-conditionals (- count) -1 t)))
2923 (push-mark)
2924 (goto-char new-point))
2925 (c-keep-region-active))
2927 (defun c-down-conditional (count)
2928 "Move forward into the next preprocessor conditional, leaving mark behind.
2929 A prefix argument acts as a repeat count. With a negative argument,
2930 move backward into the previous preprocessor conditional.
2932 \"#elif\" is treated like \"#else\" followed by \"#if\", so the
2933 function stops at them when going forward, but not when going
2934 backward."
2935 (interactive "p")
2936 (let ((new-point (c-scan-conditionals count 1)))
2937 (push-mark)
2938 (goto-char new-point))
2939 (c-keep-region-active))
2941 (defun c-down-conditional-with-else (count)
2942 "Move forward into the next preprocessor conditional, including \"#else\".
2943 Just like `c-down-conditional', except it also stops at \"#else\"
2944 directives."
2945 (interactive "p")
2946 (let ((new-point (c-scan-conditionals count 1 t)))
2947 (push-mark)
2948 (goto-char new-point))
2949 (c-keep-region-active))
2951 (defun c-backward-conditional (count &optional target-depth with-else)
2952 "Move back across a preprocessor conditional, leaving mark behind.
2953 A prefix argument acts as a repeat count. With a negative argument,
2954 move forward across a preprocessor conditional.
2956 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2957 and have the same meanings as in `c-scan-conditionals'. If you
2958 are calling c-forward-conditional from a program, you might want
2959 to call `c-scan-conditionals' directly instead."
2960 (interactive "p")
2961 (let ((new-point (c-scan-conditionals (- count) target-depth with-else)))
2962 (push-mark)
2963 (goto-char new-point))
2964 (c-keep-region-active))
2966 (defun c-forward-conditional (count &optional target-depth with-else)
2967 "Move forward across a preprocessor conditional, leaving mark behind.
2968 A prefix argument acts as a repeat count. With a negative argument,
2969 move backward across a preprocessor conditional.
2971 If there aren't enough conditionals after \(or before) point, an
2972 error is signaled.
2974 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2975 the nesting level isn't changed when tracking subconditionals.
2977 The optional arguments TARGET-DEPTH and WITH-ELSE are historical,
2978 and have the same meanings as in `c-scan-conditionals'. If you
2979 are calling c-forward-conditional from a program, you might want
2980 to call `c-scan-conditionals' directly instead."
2981 (interactive "p")
2982 (let ((new-point (c-scan-conditionals count target-depth with-else)))
2983 (push-mark)
2984 (goto-char new-point)))
2986 (defun c-scan-conditionals (count &optional target-depth with-else)
2987 "Scan forward across COUNT preprocessor conditionals.
2988 With a negative argument, scan backward across preprocessor
2989 conditionals. Return the end position. Point is not moved.
2991 If there aren't enough preprocessor conditionals, throw an error.
2993 \"#elif\" is treated like \"#else\" followed by \"#if\", except that
2994 the nesting level isn't changed when tracking subconditionals.
2996 The optional argument TARGET-DEPTH specifies the wanted nesting depth
2997 after each scan. E.g. if TARGET-DEPTH is -1, the end position will be
2998 outside the enclosing conditional. A non-integer non-nil TARGET-DEPTH
2999 counts as -1.
3001 If the optional argument WITH-ELSE is non-nil, \"#else\" directives
3002 are treated as conditional clause limits. Normally they are ignored."
3003 (let* ((forward (> count 0))
3004 (increment (if forward -1 1))
3005 (search-function (if forward 're-search-forward 're-search-backward))
3006 new)
3007 (unless (integerp target-depth)
3008 (setq target-depth (if target-depth -1 0)))
3009 (save-excursion
3010 (while (/= count 0)
3011 (let ((depth 0)
3012 ;; subdepth is the depth in "uninteresting" subtrees,
3013 ;; i.e. those that takes us farther from the target
3014 ;; depth instead of closer.
3015 (subdepth 0)
3016 found)
3017 (save-excursion
3018 ;; Find the "next" significant line in the proper direction.
3019 (while (and (not found)
3020 ;; Rather than searching for a # sign that
3021 ;; comes at the beginning of a line aside from
3022 ;; whitespace, search first for a string
3023 ;; starting with # sign. Then verify what
3024 ;; precedes it. This is faster on account of
3025 ;; the fastmap feature of the regexp matcher.
3026 (funcall search-function
3027 "#[ \t]*\\(if\\|elif\\|endif\\|else\\)"
3028 nil t))
3029 (beginning-of-line)
3030 ;; Now verify it is really a preproc line.
3031 (if (looking-at "^[ \t]*#[ \t]*\\(if\\|elif\\|endif\\|else\\)")
3032 (let (dchange (directive (match-string 1)))
3033 (cond ((string= directive "if")
3034 (setq dchange (- increment)))
3035 ((string= directive "endif")
3036 (setq dchange increment))
3037 ((= subdepth 0)
3038 ;; When we're not in an "uninteresting"
3039 ;; subtree, we might want to act on "elif"
3040 ;; and "else" too.
3041 (if (cond (with-else
3042 ;; Always move toward the target depth.
3043 (setq dchange
3044 (if (> target-depth 0) 1 -1)))
3045 ((string= directive "elif")
3046 (setq dchange (- increment))))
3047 ;; Ignore the change if it'd take us
3048 ;; into an "uninteresting" subtree.
3049 (if (eq (> dchange 0) (<= target-depth 0))
3050 (setq dchange nil)))))
3051 (when dchange
3052 (when (or (/= subdepth 0)
3053 (eq (> dchange 0) (<= target-depth 0)))
3054 (setq subdepth (+ subdepth dchange)))
3055 (setq depth (+ depth dchange))
3056 ;; If we are trying to move across, and we find an
3057 ;; end before we find a beginning, get an error.
3058 (if (and (< depth target-depth) (< dchange 0))
3059 (error (if forward
3060 "No following conditional at this level"
3061 "No previous conditional at this level"))))
3062 ;; When searching forward, start from next line so
3063 ;; that we don't find the same line again.
3064 (if forward (forward-line 1))
3065 ;; We found something if we've arrived at the
3066 ;; target depth.
3067 (if (and dchange (= depth target-depth))
3068 (setq found (point))))
3069 ;; else
3070 (if forward (forward-line 1)))))
3071 (or found
3072 (error "No containing preprocessor conditional"))
3073 (goto-char (setq new found)))
3074 (setq count (+ count increment))))
3075 (c-keep-region-active)
3076 new))
3079 ;; commands to indent lines, regions, defuns, and expressions
3080 (defun c-indent-command (&optional arg)
3081 "Indent current line as C code, and/or insert some whitespace.
3083 If `c-tab-always-indent' is t, always just indent the current line.
3084 If nil, indent the current line only if point is at the left margin or
3085 in the line's indentation; otherwise insert some whitespace[*]. If
3086 other than nil or t, then some whitespace[*] is inserted only within
3087 literals (comments and strings), but the line is always reindented.
3089 If `c-syntactic-indentation' is t, indentation is done according to
3090 the syntactic context. A numeric argument, regardless of its value,
3091 means indent rigidly all the lines of the expression starting after
3092 point so that this line becomes properly indented. The relative
3093 indentation among the lines of the expression is preserved.
3095 If `c-syntactic-indentation' is nil, the line is just indented one
3096 step according to `c-basic-offset'. In this mode, a numeric argument
3097 indents a number of such steps, positive or negative, and an empty
3098 prefix argument is equivalent to -1.
3100 [*] The amount and kind of whitespace inserted is controlled by the
3101 variable `c-insert-tab-function', which is called to do the actual
3102 insertion of whitespace. Normally the function in this variable
3103 just inserts a tab character, or the equivalent number of spaces,
3104 depending on the variable `indent-tabs-mode'."
3106 (interactive "P")
3107 (let ((indent-function
3108 (if c-syntactic-indentation
3109 (symbol-function 'indent-according-to-mode)
3110 (lambda ()
3111 (let ((c-macro-start c-macro-start)
3112 (steps (if (equal arg '(4))
3114 (prefix-numeric-value arg))))
3115 (c-shift-line-indentation (* steps c-basic-offset))
3116 (when (and c-auto-align-backslashes
3117 (save-excursion
3118 (end-of-line)
3119 (eq (char-before) ?\\))
3120 (c-query-and-set-macro-start))
3121 ;; Realign the line continuation backslash if inside a macro.
3122 (c-backslash-region (point) (point) nil t)))
3123 ))))
3124 (if (and c-syntactic-indentation arg)
3125 ;; If c-syntactic-indentation and got arg, always indent this
3126 ;; line as C and shift remaining lines of expression the same
3127 ;; amount.
3128 (let ((shift-amt (save-excursion
3129 (back-to-indentation)
3130 (current-column)))
3131 beg end)
3132 (c-indent-line)
3133 (setq shift-amt (- (save-excursion
3134 (back-to-indentation)
3135 (current-column))
3136 shift-amt))
3137 (save-excursion
3138 (if (eq c-tab-always-indent t)
3139 (beginning-of-line)) ; FIXME!!! What is this here for? ACM 2005/10/31
3140 (setq beg (point))
3141 (c-forward-sexp 1)
3142 (setq end (point))
3143 (goto-char beg)
3144 (forward-line 1)
3145 (setq beg (point)))
3146 (if (> end beg)
3147 (indent-code-rigidly beg end shift-amt "#")))
3148 ;; Else use c-tab-always-indent to determine behavior.
3149 (cond
3150 ;; CASE 1: indent when at column zero or in line's indentation,
3151 ;; otherwise insert a tab
3152 ((not c-tab-always-indent)
3153 (if (save-excursion
3154 (skip-chars-backward " \t")
3155 (not (bolp)))
3156 (funcall c-insert-tab-function)
3157 (funcall indent-function)))
3158 ;; CASE 2: just indent the line
3159 ((eq c-tab-always-indent t)
3160 (funcall indent-function))
3161 ;; CASE 3: if in a literal, insert a tab, but always indent the
3162 ;; line
3164 (if (c-save-buffer-state () (c-in-literal))
3165 (funcall c-insert-tab-function))
3166 (funcall indent-function)
3167 )))))
3169 (defun c-indent-exp (&optional shutup-p)
3170 "Indent each line in the balanced expression following point syntactically.
3171 If optional SHUTUP-P is non-nil, no errors are signaled if no
3172 balanced expression is found."
3173 (interactive "*P")
3174 (let ((here (point-marker))
3175 end)
3176 (set-marker-insertion-type here t)
3177 (unwind-protect
3178 (let ((start (save-restriction
3179 ;; Find the closest following open paren that
3180 ;; ends on another line.
3181 (narrow-to-region (point-min) (c-point 'eol))
3182 (let (beg (end (point)))
3183 (while (and (setq beg (c-down-list-forward end))
3184 (setq end (c-up-list-forward beg))))
3185 (and beg
3186 (eq (char-syntax (char-before beg)) ?\()
3187 (1- beg))))))
3188 ;; sanity check
3189 (if (not start)
3190 (unless shutup-p
3191 (error "Cannot find start of balanced expression to indent"))
3192 (goto-char start)
3193 (setq end (c-safe (scan-sexps (point) 1)))
3194 (if (not end)
3195 (unless shutup-p
3196 (error "Cannot find end of balanced expression to indent"))
3197 (forward-line)
3198 (if (< (point) end)
3199 (c-indent-region (point) end)))))
3200 (goto-char here)
3201 (set-marker here nil))))
3203 (defun c-indent-defun ()
3204 "Indent the current top-level declaration or macro syntactically.
3205 In the macro case this also has the effect of realigning any line
3206 continuation backslashes, unless `c-auto-align-backslashes' is nil."
3207 (interactive "*")
3208 (let ((here (point-marker)) decl-limits)
3209 (unwind-protect
3210 (progn
3211 (c-save-buffer-state nil
3212 ;; We try to be line oriented, unless there are several
3213 ;; declarations on the same line.
3214 (if (looking-at c-syntactic-eol)
3215 (c-backward-token-2 1 nil (c-point 'bol))
3216 (c-forward-token-2 0 nil (c-point 'eol)))
3217 (setq decl-limits (c-declaration-limits nil)))
3218 (if decl-limits
3219 (c-indent-region (car decl-limits)
3220 (cdr decl-limits))))
3221 (goto-char here)
3222 (set-marker here nil))))
3224 (defun c-indent-region (start end &optional quiet)
3225 "Indent syntactically every line whose first char is between START
3226 and END inclusive. If the optional argument QUIET is non-nil then no
3227 syntactic errors are reported, even if `c-report-syntactic-errors' is
3228 non-nil."
3229 (save-excursion
3230 (goto-char end)
3231 (skip-chars-backward " \t\n\r\f\v")
3232 (setq end (point))
3233 (goto-char start)
3234 ;; Advance to first nonblank line.
3235 (beginning-of-line)
3236 (skip-chars-forward " \t\n\r\f\v")
3237 (setq start (point))
3238 (beginning-of-line)
3239 (setq c-parsing-error
3240 (or (let ((endmark (copy-marker end))
3241 (c-parsing-error nil)
3242 ;; shut up any echo msgs on indiv lines
3243 (c-echo-syntactic-information-p nil)
3244 (ml-macro-start ; Start pos of multi-line macro.
3245 (and (c-save-buffer-state ()
3246 (save-excursion (c-beginning-of-macro)))
3247 (eq (char-before (c-point 'eol)) ?\\)
3248 start))
3249 (c-fix-backslashes nil)
3250 syntax)
3251 (unwind-protect
3252 (progn
3253 (c-progress-init start end 'c-indent-region)
3255 (while (and (bolp) ;; One line each time round the loop.
3256 (not (eobp))
3257 (< (point) endmark))
3258 ;; update progress
3259 (c-progress-update)
3260 ;; skip empty lines
3261 (unless (or (looking-at "\\s *$")
3262 (and ml-macro-start (looking-at "\\s *\\\\$")))
3263 ;; Get syntax and indent.
3264 (c-save-buffer-state nil
3265 (setq syntax (c-guess-basic-syntax)))
3266 (c-indent-line syntax t t))
3268 (if ml-macro-start
3269 ;; End of current multi-line macro?
3270 (when (and c-auto-align-backslashes
3271 (not (eq (char-before (c-point 'eol)) ?\\)))
3272 ;; Fixup macro backslashes.
3273 (c-backslash-region ml-macro-start (c-point 'bonl) nil)
3274 (setq ml-macro-start nil))
3275 ;; New multi-line macro?
3276 (if (and (assq 'cpp-macro syntax)
3277 (eq (char-before (c-point 'eol)) ?\\))
3278 (setq ml-macro-start (point))))
3280 (forward-line))
3282 (if (and ml-macro-start c-auto-align-backslashes)
3283 (c-backslash-region ml-macro-start (c-point 'bopl) nil t)))
3284 (set-marker endmark nil)
3285 (c-progress-fini 'c-indent-region))
3286 (c-echo-parsing-error quiet))
3287 c-parsing-error))))
3289 (defun c-fn-region-is-active-p ()
3290 ;; Function version of the macro for use in places that aren't
3291 ;; compiled, e.g. in the menus.
3292 (c-region-is-active-p))
3294 (defun c-indent-line-or-region (&optional arg region)
3295 "Indent active region, current line, or block starting on this line.
3296 In Transient Mark mode, when the region is active, reindent the region.
3297 Otherwise, with a prefix argument, rigidly reindent the expression
3298 starting on the current line.
3299 Otherwise reindent just the current line."
3300 (interactive
3301 (list current-prefix-arg (use-region-p)))
3302 (if region
3303 (c-indent-region (region-beginning) (region-end))
3304 (c-indent-command arg)))
3306 ;; for progress reporting
3307 (defvar c-progress-info nil)
3309 (defun c-progress-init (start end context)
3310 (cond
3311 ;; Be silent
3312 ((not c-progress-interval))
3313 ;; Start the progress update messages. If this Emacs doesn't have
3314 ;; a built-in timer, just be dumb about it.
3315 ((not (fboundp 'current-time))
3316 (message "Indenting region... (this may take a while)"))
3317 ;; If progress has already been initialized, do nothing. otherwise
3318 ;; initialize the counter with a vector of:
3319 ;; [start end lastsec context]
3320 (c-progress-info)
3321 (t (setq c-progress-info (vector start
3322 (save-excursion
3323 (goto-char end)
3324 (point-marker))
3325 (nth 1 (current-time))
3326 context))
3327 (message "Indenting region..."))
3330 (defun c-progress-update ()
3331 (if (not (and c-progress-info c-progress-interval))
3333 (let ((now (nth 1 (current-time)))
3334 (start (aref c-progress-info 0))
3335 (end (aref c-progress-info 1))
3336 (lastsecs (aref c-progress-info 2)))
3337 ;; should we update? currently, update happens every 2 seconds,
3338 ;; what's the right value?
3339 (if (< c-progress-interval (- now lastsecs))
3340 (progn
3341 (message "Indenting region... (%d%% complete)"
3342 (/ (* 100 (- (point) start)) (- end start)))
3343 (aset c-progress-info 2 now)))
3346 (defun c-progress-fini (context)
3347 (if (not c-progress-interval)
3349 (if (or (eq context (aref c-progress-info 3))
3350 (eq context t))
3351 (progn
3352 (set-marker (aref c-progress-info 1) nil)
3353 (setq c-progress-info nil)
3354 (message "Indenting region... done")))))
3358 ;;; This page handles insertion and removal of backslashes for C macros.
3360 (defun c-backslash-region (from to delete-flag &optional line-mode)
3361 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3362 With no argument, inserts backslashes and aligns existing backslashes.
3363 With an argument, deletes the backslashes. The backslash alignment is
3364 done according to the settings in `c-backslash-column',
3365 `c-backslash-max-column' and `c-auto-align-backslashes'.
3367 This function does not modify blank lines at the start of the region.
3368 If the region ends at the start of a line and the macro doesn't
3369 continue below it, the backslash (if any) at the end of the previous
3370 line is deleted.
3372 You can put the region around an entire macro definition and use this
3373 command to conveniently insert and align the necessary backslashes."
3374 (interactive "*r\nP")
3375 (let ((endmark (make-marker))
3376 ;; Keep the backslash trimming functions from changing the
3377 ;; whitespace around point, since in this case it's only the
3378 ;; position of point that tells the indentation of the line.
3379 (point-pos (if (save-excursion
3380 (skip-chars-backward " \t")
3381 (and (bolp) (looking-at "[ \t]*\\\\?$")))
3382 (point-marker)
3383 (point-min)))
3384 column longest-line-col bs-col-after-end)
3385 (save-excursion
3386 (goto-char to)
3387 (if (and (not line-mode) (bobp))
3388 ;; Nothing to do if to is at bob, since we should back up
3389 ;; and there's no line to back up to.
3391 (when (and (not line-mode) (bolp))
3392 ;; Do not back up the to line if line-mode is set, to make
3393 ;; e.g. c-newline-and-indent consistent regardless whether
3394 ;; the (newline) call leaves point at bol or not.
3395 (backward-char)
3396 (setq to (point)))
3397 (if delete-flag
3398 (progn
3399 (set-marker endmark (point))
3400 (goto-char from)
3401 (c-delete-backslashes-forward endmark point-pos))
3402 ;; Set bs-col-after-end to the column of any backslash
3403 ;; following the region, or nil if there is none.
3404 (setq bs-col-after-end
3405 (and (progn (end-of-line)
3406 (eq (char-before) ?\\))
3407 (= (forward-line 1) 0)
3408 (progn (end-of-line)
3409 (eq (char-before) ?\\))
3410 (1- (current-column))))
3411 (when line-mode
3412 ;; Back up the to line if line-mode is set, since the line
3413 ;; after the newly inserted line break should not be
3414 ;; touched in c-newline-and-indent.
3415 (setq to (max from (or (c-safe (c-point 'eopl)) from)))
3416 (unless bs-col-after-end
3417 ;; Set bs-col-after-end to non-nil in any case, since we
3418 ;; do not want to delete the backslash at the last line.
3419 (setq bs-col-after-end t)))
3420 (if (and line-mode
3421 (not c-auto-align-backslashes))
3422 (goto-char from)
3423 ;; Compute the smallest column number past the ends of all
3424 ;; the lines.
3425 (setq longest-line-col 0)
3426 (goto-char to)
3427 (if bs-col-after-end
3428 ;; Include one more line in the max column
3429 ;; calculation, since the to line will be backslashed
3430 ;; too.
3431 (forward-line 1))
3432 (end-of-line)
3433 (while (and (>= (point) from)
3434 (progn
3435 (if (eq (char-before) ?\\)
3436 (forward-char -1))
3437 (skip-chars-backward " \t")
3438 (setq longest-line-col (max longest-line-col
3439 (1+ (current-column))))
3440 (beginning-of-line)
3441 (not (bobp))))
3442 (backward-char))
3443 ;; Try to align with surrounding backslashes.
3444 (goto-char from)
3445 (beginning-of-line)
3446 (if (and (not (bobp))
3447 (progn (backward-char)
3448 (eq (char-before) ?\\)))
3449 (progn
3450 (setq column (1- (current-column)))
3451 (if (numberp bs-col-after-end)
3452 ;; Both a preceding and a following backslash.
3453 ;; Choose the greatest of them.
3454 (setq column (max column bs-col-after-end)))
3455 (goto-char from))
3456 ;; No preceding backslash. Try to align with one
3457 ;; following the region. Disregard the backslash at the
3458 ;; to line since it's likely to be bogus (e.g. when
3459 ;; called from c-newline-and-indent).
3460 (if (numberp bs-col-after-end)
3461 (setq column bs-col-after-end))
3462 ;; Don't modify blank lines at start of region.
3463 (goto-char from)
3464 (while (and (< (point) to) (bolp) (eolp))
3465 (forward-line 1)))
3466 (if (and column (< column longest-line-col))
3467 ;; Don't try to align with surrounding backslashes if
3468 ;; any line is too long.
3469 (setq column nil))
3470 (unless column
3471 ;; Impose minimum limit and tab width alignment only if
3472 ;; we can't align with surrounding backslashes.
3473 (if (> (% longest-line-col tab-width) 0)
3474 (setq longest-line-col
3475 (* (/ (+ longest-line-col tab-width -1)
3476 tab-width)
3477 tab-width)))
3478 (setq column (max c-backslash-column
3479 longest-line-col)))
3480 ;; Always impose maximum limit.
3481 (setq column (min column c-backslash-max-column)))
3482 (if bs-col-after-end
3483 ;; Add backslashes on all lines if the macro continues
3484 ;; after the to line.
3485 (progn
3486 (set-marker endmark to)
3487 (c-append-backslashes-forward endmark column point-pos))
3488 ;; Add backslashes on all lines except the last, and
3489 ;; remove any on the last line.
3490 (if (save-excursion
3491 (goto-char to)
3492 (beginning-of-line)
3493 (if (not (bobp))
3494 (set-marker endmark (1- (point)))))
3495 (progn
3496 (c-append-backslashes-forward endmark column point-pos)
3497 ;; The function above leaves point on the line
3498 ;; following endmark.
3499 (set-marker endmark (point)))
3500 (set-marker endmark to))
3501 (c-delete-backslashes-forward endmark point-pos)))))
3502 (set-marker endmark nil)
3503 (if (markerp point-pos)
3504 (set-marker point-pos nil))))
3506 (defun c-append-backslashes-forward (to-mark column point-pos)
3507 (let ((state (parse-partial-sexp (c-point 'bol) (point))))
3508 (if column
3509 (while
3510 (and
3511 (<= (point) to-mark)
3513 (let ((start (point)) (inserted nil) end col)
3514 (end-of-line)
3515 (unless (eq (char-before) ?\\)
3516 (insert ?\\)
3517 (setq inserted t))
3518 (setq state (parse-partial-sexp
3519 start (point) nil nil state))
3520 (backward-char)
3521 (setq col (current-column))
3523 ;; Avoid unnecessary changes of the buffer.
3524 (cond ((and (not inserted) (nth 3 state))
3525 ;; Don't realign backslashes in string literals
3526 ;; since that would change them.
3529 ((< col column)
3530 (delete-region
3531 (point)
3532 (progn
3533 (skip-chars-backward
3534 " \t" (if (>= (point) point-pos) point-pos))
3535 (point)))
3536 (indent-to column))
3538 ((and (= col column)
3539 (memq (char-before) '(?\ ?\t))))
3541 ((progn
3542 (setq end (point))
3543 (or (/= (skip-chars-backward
3544 " \t" (if (>= (point) point-pos) point-pos))
3546 (/= (char-after) ?\ )))
3547 (delete-region (point) end)
3548 (indent-to column 1)))
3550 (zerop (forward-line 1)))
3551 (bolp))) ; forward-line has funny behavior at eob.
3553 ;; Make sure there are backslashes with at least one space in
3554 ;; front of them.
3555 (while
3556 (and
3557 (<= (point) to-mark)
3559 (let ((start (point)))
3560 (end-of-line)
3561 (setq state (parse-partial-sexp
3562 start (point) nil nil state))
3564 (if (eq (char-before) ?\\)
3565 (unless (nth 3 state)
3566 (backward-char)
3567 (unless (and (memq (char-before) '(?\ ?\t))
3568 (/= (point) point-pos))
3569 (insert ?\ )))
3571 (if (and (memq (char-before) '(?\ ?\t))
3572 (/= (point) point-pos))
3573 (insert ?\\)
3574 (insert ?\ ?\\)))
3576 (zerop (forward-line 1)))
3577 (bolp)))))) ; forward-line has funny behavior at eob.
3579 (defun c-delete-backslashes-forward (to-mark point-pos)
3580 (while
3581 (and (<= (point) to-mark)
3582 (progn
3583 (end-of-line)
3584 (if (eq (char-before) ?\\)
3585 (delete-region
3586 (point)
3587 (progn (backward-char)
3588 (skip-chars-backward " \t" (if (>= (point) point-pos)
3589 point-pos))
3590 (point))))
3591 (zerop (forward-line 1)))
3592 (bolp)))) ; forward-line has funny behavior at eob.
3596 ;;; Line breaking and paragraph filling.
3598 (defvar c-auto-fill-prefix t)
3599 (defvar c-lit-limits nil)
3600 (defvar c-lit-type nil)
3602 ;; The filling code is based on a simple theory; leave the intricacies
3603 ;; of the text handling to the currently active mode for that
3604 ;; (e.g. adaptive-fill-mode or filladapt-mode) and do as little as
3605 ;; possible to make them work correctly wrt the comment and string
3606 ;; separators, one-line paragraphs etc. Unfortunately, when it comes
3607 ;; to it, there's quite a lot of special cases to handle which makes
3608 ;; the code anything but simple. The intention is that it will work
3609 ;; with any well-written text filling package that preserves a fill
3610 ;; prefix.
3612 ;; We temporarily mask comment starters and enders as necessary for
3613 ;; the filling code to do its job on a seemingly normal text block.
3614 ;; We do _not_ mask the fill prefix, so it's up to the filling code to
3615 ;; preserve it correctly (especially important when filling C++ style
3616 ;; line comments). By default, we set up and use adaptive-fill-mode,
3617 ;; which is standard in all supported Emacs flavors.
3619 (defun c-guess-fill-prefix (lit-limits lit-type)
3620 ;; Determine the appropriate comment fill prefix for a block or line
3621 ;; comment. Return a cons of the prefix string and the column where
3622 ;; it ends. If fill-prefix is set, it'll override. Note that this
3623 ;; function also uses the value of point in some heuristics.
3625 ;; This function might do hidden buffer changes.
3627 (let* ((here (point))
3628 (prefix-regexp (concat "[ \t]*\\("
3629 c-current-comment-prefix
3630 "\\)[ \t]*"))
3631 (comment-start-regexp (if (eq lit-type 'c++)
3632 prefix-regexp
3633 comment-start-skip))
3634 prefix-line comment-prefix res comment-text-end)
3636 (cond
3637 (fill-prefix
3638 (setq res (cons fill-prefix
3639 ;; Ugly way of getting the column after the fill
3640 ;; prefix; it'd be nice with a current-column
3641 ;; that works on strings..
3642 (let ((start (point)))
3643 (unwind-protect
3644 (progn
3645 (insert-and-inherit "\n" fill-prefix)
3646 (current-column))
3647 (delete-region start (point)))))))
3649 ((eq lit-type 'c++)
3650 (save-excursion
3651 ;; Set fallback for comment-prefix if none is found.
3652 (setq comment-prefix "// "
3653 comment-text-end (cdr lit-limits))
3655 (beginning-of-line)
3656 (if (> (point) (car lit-limits))
3657 ;; The current line is not the comment starter, so the
3658 ;; comment has more than one line, and it can therefore be
3659 ;; used to find the comment fill prefix.
3660 (setq prefix-line (point))
3662 (goto-char (car lit-limits))
3663 (if (and (= (forward-line 1) 0)
3664 (< (point) (cdr lit-limits)))
3665 ;; The line after the comment starter is inside the
3666 ;; comment, so we can use it.
3667 (setq prefix-line (point))
3669 ;; The comment is only one line. Take the comment prefix
3670 ;; from it and keep the indentation.
3671 (goto-char (car lit-limits))
3672 (if (looking-at prefix-regexp)
3673 (goto-char (match-end 0))
3674 (forward-char 2)
3675 (skip-chars-forward " \t"))
3677 (let (str col)
3678 (if (eq (c-point 'boi) (car lit-limits))
3679 ;; There is only whitespace before the comment
3680 ;; starter; take the prefix straight from this line.
3681 (setq str (buffer-substring-no-properties
3682 (c-point 'bol) (point))
3683 col (current-column))
3685 ;; There is code before the comment starter, so we
3686 ;; have to temporarily insert and indent a new line to
3687 ;; get the right space/tab mix in the indentation.
3688 (let ((prefix-len (- (point) (car lit-limits)))
3689 tmp)
3690 (unwind-protect
3691 (progn
3692 (goto-char (car lit-limits))
3693 (indent-to (prog1 (current-column)
3694 (insert ?\n)))
3695 (setq tmp (point))
3696 (forward-char prefix-len)
3697 (setq str (buffer-substring-no-properties
3698 (c-point 'bol) (point))
3699 col (current-column)))
3700 (delete-region (car lit-limits) tmp))))
3702 (setq res
3703 (if (or (string-match "\\s \\'" str) (not (eolp)))
3704 (cons str col)
3705 ;; The prefix ends the line with no whitespace
3706 ;; after it. Default to a single space.
3707 (cons (concat str " ") (1+ col))))
3708 )))))
3711 (setq comment-text-end
3712 (save-excursion
3713 (goto-char (- (cdr lit-limits) 2))
3714 (if (looking-at "\\*/") (point) (cdr lit-limits))))
3716 (save-excursion
3717 (beginning-of-line)
3718 (if (and (> (point) (car lit-limits))
3719 (not (and (looking-at "[ \t]*\\*/")
3720 (eq (cdr lit-limits) (match-end 0)))))
3721 ;; The current line is not the comment starter and
3722 ;; contains more than just the ender, so it's good enough
3723 ;; to be used for the comment fill prefix.
3724 (setq prefix-line (point))
3725 (goto-char (car lit-limits))
3727 (cond ((or (/= (forward-line 1) 0)
3728 (>= (point) (cdr lit-limits))
3729 (and (looking-at "[ \t]*\\*/")
3730 (eq (cdr lit-limits) (match-end 0)))
3731 (and (looking-at prefix-regexp)
3732 (<= (1- (cdr lit-limits)) (match-end 0))))
3733 ;; The comment is either one line or the next line contains
3734 ;; just the comment ender. In this case we have no
3735 ;; information about a suitable comment prefix, so we resort
3736 ;; to c-block-comment-prefix.
3737 (setq comment-prefix (or c-block-comment-prefix "")))
3739 ((< here (point))
3740 ;; The point was on the comment opener line, so we might want
3741 ;; to treat this as a not yet closed comment.
3743 (if (and (match-beginning 1)
3744 (/= (match-beginning 1) (match-end 1)))
3745 ;; Above `prefix-regexp' matched a nonempty prefix on the
3746 ;; second line, so let's use it. Normally it should do
3747 ;; to set `prefix-line' and let the code below pick up
3748 ;; the whole prefix, but if there's no text after the
3749 ;; match then it will probably fall back to no prefix at
3750 ;; all if the comment isn't closed yet, so in that case
3751 ;; it's better to force use of the prefix matched now.
3752 (if (= (match-end 0) (c-point 'eol))
3753 (setq comment-prefix (match-string 1))
3754 (setq prefix-line (point)))
3756 ;; There's no nonempty prefix on the line after the
3757 ;; comment opener. If the line is empty, or if the
3758 ;; text on it has less or equal indentation than the
3759 ;; comment starter we assume it's an unclosed
3760 ;; comment starter, i.e. that
3761 ;; `c-block-comment-prefix' should be used.
3762 ;; Otherwise we assume it's a closed comment where
3763 ;; the prefix really is the empty string.
3764 ;; E.g. this is an unclosed comment:
3766 ;; /*
3767 ;; foo
3769 ;; But this is not:
3771 ;; /*
3772 ;; foo
3773 ;; */
3775 ;; (Looking for the presence of the comment closer
3776 ;; rarely works since it's probably the closer of
3777 ;; some comment further down when the comment
3778 ;; really is unclosed.)
3779 (if (<= (save-excursion (back-to-indentation)
3780 (current-column))
3781 (save-excursion (goto-char (car lit-limits))
3782 (current-column)))
3783 (setq comment-prefix (or c-block-comment-prefix ""))
3784 (setq prefix-line (point)))))
3787 ;; Otherwise the line after the comment starter is good
3788 ;; enough to find the prefix in.
3789 (setq prefix-line (point))))
3791 (when comment-prefix
3792 ;; Haven't got the comment prefix on any real line that we
3793 ;; can take it from, so we have to temporarily insert
3794 ;; `comment-prefix' on a line and indent it to find the
3795 ;; correct column and the correct mix of tabs and spaces.
3796 (setq res
3797 (let (tmp-pre tmp-post)
3798 (unwind-protect
3799 (progn
3801 (goto-char (car lit-limits))
3802 (if (looking-at comment-start-regexp)
3803 (goto-char (min (match-end 0)
3804 comment-text-end))
3805 (forward-char 2)
3806 (skip-chars-forward " \t"))
3808 (when (eq (char-syntax (char-before)) ?\ )
3809 ;; If there's ws on the current line, we'll use it
3810 ;; instead of what's ending comment-prefix.
3811 (setq comment-prefix
3812 (concat (substring comment-prefix
3813 0 (string-match
3814 "\\s *\\'"
3815 comment-prefix))
3816 (buffer-substring-no-properties
3817 (save-excursion
3818 (skip-chars-backward " \t")
3819 (point))
3820 (point)))))
3822 (setq tmp-pre (point-marker))
3824 ;; We insert an extra non-whitespace character
3825 ;; before the line break and after comment-prefix in
3826 ;; case it's "" or ends with whitespace.
3827 (insert-and-inherit "x\n" comment-prefix "x")
3828 (setq tmp-post (point-marker))
3830 (indent-according-to-mode)
3832 (goto-char (1- tmp-post))
3833 (cons (buffer-substring-no-properties
3834 (c-point 'bol) (point))
3835 (current-column)))
3837 (when tmp-post
3838 (delete-region tmp-pre tmp-post)
3839 (set-marker tmp-pre nil)
3840 (set-marker tmp-post nil))))))))))
3842 (or res ; Found a good prefix above.
3844 (save-excursion
3845 ;; prefix-line is the bol of a line on which we should try
3846 ;; to find the prefix.
3847 (let* (fb-string fb-endpos ; Contains any fallback prefix found.
3848 (test-line
3849 (lambda ()
3850 (when (and (looking-at prefix-regexp)
3851 (<= (match-end 0) comment-text-end))
3852 (unless (eq (match-end 0) (c-point 'eol))
3853 ;; The match is fine if there's text after it.
3854 (throw 'found (cons (buffer-substring-no-properties
3855 (match-beginning 0) (match-end 0))
3856 (progn (goto-char (match-end 0))
3857 (current-column)))))
3858 (unless fb-string
3859 ;; This match is better than nothing, so let's
3860 ;; remember it in case nothing better is found
3861 ;; on another line.
3862 (setq fb-string (buffer-substring-no-properties
3863 (match-beginning 0) (match-end 0))
3864 fb-endpos (match-end 0)))
3865 t))))
3867 (or (catch 'found
3868 ;; Search for a line which has text after the prefix
3869 ;; so that we get the proper amount of whitespace
3870 ;; after it. We start with the current line, then
3871 ;; search backwards, then forwards.
3873 (goto-char prefix-line)
3874 (when (and (funcall test-line)
3875 (or (/= (match-end 1) (match-end 0))
3876 ;; The whitespace is sucked up by the
3877 ;; first [ \t]* glob if the prefix is empty.
3878 (and (= (match-beginning 1) (match-end 1))
3879 (/= (match-beginning 0) (match-end 0)))))
3880 ;; If the current line doesn't have text but do
3881 ;; have whitespace after the prefix, we'll use it.
3882 (throw 'found (cons fb-string
3883 (progn (goto-char fb-endpos)
3884 (current-column)))))
3886 (if (eq lit-type 'c++)
3887 ;; For line comments we can search up to and
3888 ;; including the first line.
3889 (while (and (zerop (forward-line -1))
3890 (>= (point) (car lit-limits)))
3891 (funcall test-line))
3892 ;; For block comments we must stop before the
3893 ;; block starter.
3894 (while (and (zerop (forward-line -1))
3895 (> (point) (car lit-limits)))
3896 (funcall test-line)))
3898 (goto-char prefix-line)
3899 (while (and (zerop (forward-line 1))
3900 (< (point) (cdr lit-limits)))
3901 (funcall test-line))
3903 (goto-char prefix-line)
3904 nil)
3906 (when fb-string
3907 ;; A good line wasn't found, but at least we have a
3908 ;; fallback that matches the comment prefix regexp.
3909 (cond ((or (string-match "\\s \\'" fb-string)
3910 (progn
3911 (goto-char fb-endpos)
3912 (not (eolp))))
3913 ;; There are ws or text after the prefix, so
3914 ;; let's use it.
3915 (cons fb-string (current-column)))
3917 ((progn
3918 ;; Check if there's any whitespace padding
3919 ;; on the comment start line that we can
3920 ;; use after the prefix.
3921 (goto-char (car lit-limits))
3922 (if (looking-at comment-start-regexp)
3923 (goto-char (match-end 0))
3924 (forward-char 2)
3925 (skip-chars-forward " \t"))
3926 (or (not (eolp))
3927 (eq (char-syntax (char-before)) ?\ )))
3929 (setq fb-string (buffer-substring-no-properties
3930 (save-excursion
3931 (skip-chars-backward " \t")
3932 (point))
3933 (point)))
3934 (goto-char fb-endpos)
3935 (skip-chars-backward " \t")
3937 (let ((tmp (point)))
3938 ;; Got to mess in the buffer once again to
3939 ;; ensure the column gets correct. :P
3940 (unwind-protect
3941 (progn
3942 (insert-and-inherit fb-string)
3943 (cons (buffer-substring-no-properties
3944 (c-point 'bol)
3945 (point))
3946 (current-column)))
3947 (delete-region tmp (point)))))
3950 ;; Last resort: Just add a single space after
3951 ;; the prefix.
3952 (cons (concat fb-string " ")
3953 (progn (goto-char fb-endpos)
3954 (1+ (current-column)))))))
3956 ;; The line doesn't match the comment prefix regexp.
3957 (if comment-prefix
3958 ;; We have a fallback for line comments that we must use.
3959 (cons (concat (buffer-substring-no-properties
3960 prefix-line (c-point 'boi))
3961 comment-prefix)
3962 (progn (back-to-indentation)
3963 (+ (current-column) (length comment-prefix))))
3965 ;; Assume we are dealing with a "free text" block
3966 ;; comment where the lines doesn't have any comment
3967 ;; prefix at all and we should just fill it as
3968 ;; normal text.
3969 '("" . 0))))))
3972 (defun c-mask-paragraph (fill-paragraph apply-outside-literal fun &rest args)
3973 ;; Calls FUN with ARGS ar arguments while the current paragraph is
3974 ;; masked to allow adaptive filling to work correctly. That
3975 ;; includes narrowing the buffer and, if point is inside a comment,
3976 ;; masking the comment starter and ender appropriately.
3978 ;; FILL-PARAGRAPH is non-nil if called for whole paragraph filling.
3979 ;; The position of point is then less significant when doing masking
3980 ;; and narrowing.
3982 ;; If APPLY-OUTSIDE-LITERAL is nil then the function will be called
3983 ;; only if the point turns out to be inside a comment or a string.
3985 ;; Note that this function does not do any hidden buffer changes.
3987 (let (fill
3988 ;; beg and end limit the region to narrow. end is a marker.
3989 beg end
3990 ;; tmp-pre and tmp-post mark strings that are temporarily
3991 ;; inserted at the start and end of the region. tmp-pre is a
3992 ;; cons of the positions of the prepended string. tmp-post is
3993 ;; a marker pointing to the single character of the appended
3994 ;; string.
3995 tmp-pre tmp-post
3996 ;; If hang-ender-stuck isn't nil, the comment ender is
3997 ;; hanging. In that case it's set to the number of spaces
3998 ;; that should be between the text and the ender.
3999 hang-ender-stuck
4000 ;; auto-fill-spaces is the exact sequence of whitespace between a
4001 ;; comment's last word and the comment ender, temporarily replaced
4002 ;; with 'x's before calling FUN when FILL-PARAGRAPH is nil.
4003 auto-fill-spaces
4004 (here (point))
4005 (c-lit-limits c-lit-limits)
4006 (c-lit-type c-lit-type))
4008 ;; Restore point on undo. It's necessary since we do a lot of
4009 ;; hidden inserts and deletes below that should be as transparent
4010 ;; as possible.
4011 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
4012 (setq buffer-undo-list (cons (point) buffer-undo-list)))
4014 ;; Determine the limits and type of the containing literal (if any):
4015 ;; C-LIT-LIMITS, C-LIT-TYPE; and the limits of the current paragraph:
4016 ;; BEG and END.
4017 (c-save-buffer-state ()
4018 (save-restriction
4019 ;; Widen to catch comment limits correctly.
4020 (widen)
4021 (unless c-lit-limits
4022 (setq c-lit-limits (c-literal-limits nil fill-paragraph)))
4023 (setq c-lit-limits (c-collect-line-comments c-lit-limits))
4024 (unless c-lit-type
4025 (setq c-lit-type (c-literal-type c-lit-limits))))
4027 (save-excursion
4028 (unless (c-safe (backward-char)
4029 (forward-paragraph)
4030 (>= (point) here))
4031 (goto-char here)
4032 (forward-paragraph))
4033 (setq end (point-marker)))
4034 (save-excursion
4035 (unless (c-safe (forward-char)
4036 (backward-paragraph)
4037 (<= (point) here))
4038 (goto-char here)
4039 (backward-paragraph))
4040 (setq beg (point))))
4042 (unwind-protect
4043 (progn
4044 ;; For each of the possible types of text (string, C comment ...)
4045 ;; determine BEG and END, the region we will narrow to. If we're in
4046 ;; a literal, constrain BEG and END to the limits of this literal.
4048 ;; For some of these text types, particularly a block comment, we
4049 ;; may need to massage whitespace near literal delimiters, so that
4050 ;; these don't get filled inappropriately.
4051 (cond
4053 ((eq c-lit-type 'c++) ; Line comment.
4054 (save-excursion
4055 ;; Limit to the comment or paragraph end, whichever
4056 ;; comes first.
4057 (set-marker end (min end (cdr c-lit-limits)))
4059 (when (<= beg (car c-lit-limits))
4060 ;; The region includes the comment starter, so we must
4061 ;; check it.
4062 (goto-char (car c-lit-limits))
4063 (back-to-indentation)
4064 (if (eq (point) (car c-lit-limits))
4065 ;; Include the first line in the region.
4066 (setq beg (c-point 'bol))
4067 ;; The first line contains code before the
4068 ;; comment. We must fake a line that doesn't.
4069 (setq tmp-pre t))))
4071 (setq apply-outside-literal t))
4073 ((eq c-lit-type 'c) ; Block comment.
4074 (when
4075 (or (> end (cdr c-lit-limits))
4076 (and (= end (cdr c-lit-limits))
4077 (eq (char-before end) ?/)
4078 (eq (char-before (1- end)) ?*)
4079 ;; disallow "/*/"
4080 (> (- (cdr c-lit-limits) (car c-lit-limits)) 3)))
4081 ;; There is a comment ender, and the region includes it. If
4082 ;; it's on its own line, it stays on its own line. If it's got
4083 ;; company on the line, it keeps (at least one word of) it.
4084 ;; "=====*/" counts as a comment ender here, but "===== */"
4085 ;; doesn't and "foo*/" doesn't.
4086 (unless
4087 (save-excursion
4088 (goto-char (cdr c-lit-limits))
4089 (beginning-of-line)
4090 ;; The following conjunct was added to avoid an
4091 ;; "Invalid search bound (wrong side of point)"
4092 ;; error in the subsequent re-search. Maybe
4093 ;; another fix would be needed (2007-12-08).
4094 ; (or (<= (- (cdr c-lit-limits) 2) (point))
4095 ; 2010-10-17 Construct removed.
4096 ; (or (< (- (cdr c-lit-limits) 2) (point))
4097 (and
4098 (search-forward-regexp
4099 (concat "\\=[ \t]*\\(" c-current-comment-prefix "\\)")
4100 (- (cdr c-lit-limits) 2) t)
4101 (not (search-forward-regexp
4102 "\\(\\s \\|\\sw\\)"
4103 (- (cdr c-lit-limits) 2) 'limit))
4104 ;; The comment ender IS on its own line. Exclude this
4105 ;; line from the filling.
4106 (set-marker end (c-point 'bol))));)
4108 ;; The comment ender is hanging. Replace all space between it
4109 ;; and the last word either by one or two 'x's (when
4110 ;; FILL-PARAGRAPH is non-nil), or a row of x's the same width
4111 ;; as the whitespace (when auto filling), and include it in
4112 ;; the region. We'll change them back to whitespace
4113 ;; afterwards. The effect of this is to glue the comment
4114 ;; ender to the last word in the comment during filling.
4115 (let* ((ender-start (save-excursion
4116 (goto-char (cdr c-lit-limits))
4117 (skip-syntax-backward "^w ")
4118 (point)))
4119 (ender-column (save-excursion
4120 (goto-char ender-start)
4121 (current-column)))
4122 (point-rel (- ender-start here))
4123 (sentence-ends-comment
4124 (save-excursion
4125 (goto-char ender-start)
4126 (and (search-backward-regexp
4127 (c-sentence-end) (c-point 'bol) t)
4128 (goto-char (match-end 0))
4129 (looking-at "[ \t]*")
4130 (= (match-end 0) ender-start))))
4131 spaces)
4133 (save-excursion
4134 ;; Insert a CR after the "*/", adjust END
4135 (goto-char (cdr c-lit-limits))
4136 (setq tmp-post (point-marker))
4137 (insert ?\n)
4138 (set-marker end (point))
4140 (forward-line -1) ; last line of the comment
4141 (if (and (looking-at (concat "[ \t]*\\(\\("
4142 c-current-comment-prefix
4143 "\\)[ \t]*\\)"))
4144 (eq ender-start (match-end 0)))
4145 ;; The comment ender is prefixed by nothing but a
4146 ;; comment line prefix. IS THIS POSSIBLE? (ACM,
4147 ;; 2006/4/28). Remove it along with surrounding ws.
4148 (setq spaces (- (match-end 1) (match-end 2)))
4149 (goto-char ender-start))
4150 (skip-chars-backward " \t\r\n") ; Surely this can be
4151 ; " \t"? "*/" is NOT alone on the line (ACM, 2005/8/18)
4153 ;; What's being tested here? 2006/4/20. FIXME!!!
4154 (if (/= (point) ender-start)
4155 (progn
4156 (if (<= here (point))
4157 ;; Don't adjust point below if it's
4158 ;; before the string we replace.
4159 (setq point-rel -1))
4160 ;; Keep one or two spaces between the
4161 ;; text and the ender, depending on how
4162 ;; many there are now.
4163 (unless spaces
4164 (setq spaces (- ender-column (current-column))))
4165 (setq auto-fill-spaces (c-delete-and-extract-region
4166 (point) ender-start))
4167 ;; paragraph filling condenses multiple spaces to
4168 ;; single or double spaces. auto-fill doesn't.
4169 (if fill-paragraph
4170 (setq spaces
4171 (max
4172 (min spaces
4173 (if (and sentence-ends-comment
4174 sentence-end-double-space)
4175 2 1))
4176 1)))
4177 ;; Insert the filler first to keep marks right.
4178 (insert-char ?x spaces t)
4179 (setq hang-ender-stuck spaces)
4180 (setq point-rel
4181 (and (>= point-rel 0)
4182 (- (point) (min point-rel spaces)))))
4183 (setq point-rel nil)))
4185 (if point-rel
4186 ;; Point was in the middle of the string we
4187 ;; replaced above, so put it back in the same
4188 ;; relative position, counting from the end.
4189 (goto-char point-rel)))
4192 (when (<= beg (car c-lit-limits))
4193 ;; The region includes the comment starter.
4194 (save-excursion
4195 (goto-char (car c-lit-limits))
4196 (if (looking-at (concat "\\(" comment-start-skip "\\)$"))
4197 ;; Begin with the next line.
4198 (setq beg (c-point 'bonl))
4199 ;; Fake the fill prefix in the first line.
4200 (setq tmp-pre t))))
4202 (setq apply-outside-literal t))
4204 ((eq c-lit-type 'string) ; String.
4205 (save-excursion
4206 (when (>= end (cdr c-lit-limits))
4207 (goto-char (1- (cdr c-lit-limits)))
4208 (setq tmp-post (point-marker))
4209 (insert ?\n)
4210 (set-marker end (point)))
4211 (when (<= beg (car c-lit-limits))
4212 (goto-char (1+ (car c-lit-limits)))
4213 (setq beg (if (looking-at "\\\\$")
4214 ;; Leave the start line if it's
4215 ;; nothing but an escaped newline.
4216 (1+ (match-end 0))
4217 (point)))))
4218 (setq apply-outside-literal t))
4220 ((eq c-lit-type 'pound) ; Macro
4221 ;; Narrow to the macro limits if they are nearer than the
4222 ;; paragraph limits. Don't know if this is necessary but
4223 ;; do it for completeness sake (doing auto filling at all
4224 ;; inside macros is bogus to begin with since the line
4225 ;; continuation backslashes aren't handled).
4226 (save-excursion
4227 (c-save-buffer-state ()
4228 (c-beginning-of-macro)
4229 (beginning-of-line)
4230 (if (> (point) beg)
4231 (setq beg (point)))
4232 (c-end-of-macro)
4233 (forward-line)
4234 (if (< (point) end)
4235 (set-marker end (point))))))
4237 (t ; Other code.
4238 ;; Try to avoid comments and macros in the paragraph to
4239 ;; avoid that the adaptive fill mode gets the prefix from
4240 ;; them.
4241 (c-save-buffer-state nil
4242 (save-excursion
4243 (goto-char beg)
4244 (c-forward-syntactic-ws end)
4245 (beginning-of-line)
4246 (setq beg (point))
4247 (goto-char end)
4248 (c-backward-syntactic-ws beg)
4249 (forward-line)
4250 (set-marker end (point))))))
4252 (when tmp-pre
4253 ;; Temporarily insert the fill prefix after the comment
4254 ;; starter so that the first line looks like any other
4255 ;; comment line in the narrowed region.
4256 (setq fill (c-save-buffer-state nil
4257 (c-guess-fill-prefix c-lit-limits c-lit-type)))
4258 (unless (string-match (concat "\\`[ \t]*\\("
4259 c-current-comment-prefix
4260 "\\)[ \t]*\\'")
4261 (car fill))
4262 ;; Oops, the prefix doesn't match the comment prefix
4263 ;; regexp. This could produce very confusing
4264 ;; results with adaptive fill packages together with
4265 ;; the insert prefix magic below, since the prefix
4266 ;; often doesn't appear at all. So let's warn about
4267 ;; it.
4268 (message "\
4269 Warning: Regexp from `c-comment-prefix-regexp' doesn't match the comment prefix %S"
4270 (car fill)))
4271 ;; Find the right spot on the line, break it, insert
4272 ;; the fill prefix and make sure we're back in the
4273 ;; same column by temporarily prefixing the first word
4274 ;; with a number of 'x'.
4275 (save-excursion
4276 (goto-char (car c-lit-limits))
4277 (if (looking-at (if (eq c-lit-type 'c++)
4278 c-current-comment-prefix
4279 comment-start-skip))
4280 (goto-char (match-end 0))
4281 (forward-char 2)
4282 (skip-chars-forward " \t"))
4283 (while (and (< (current-column) (cdr fill))
4284 (not (eolp)))
4285 (forward-char 1))
4286 (let ((col (current-column)))
4287 (setq beg (1+ (point))
4288 tmp-pre (list (point)))
4289 (unwind-protect
4290 (progn
4291 (insert-and-inherit "\n" (car fill))
4292 (insert-char ?x (- col (current-column)) t))
4293 (setcdr tmp-pre (point))))))
4295 (when apply-outside-literal
4296 ;; `apply-outside-literal' is always set to t here if
4297 ;; we're inside a literal.
4299 (let ((fill-prefix
4300 (or fill-prefix
4301 ;; Kludge: If the function that adapts the fill prefix
4302 ;; doesn't produce the required comment starter for
4303 ;; line comments, then force it by setting fill-prefix.
4304 (when (and (eq c-lit-type 'c++)
4305 ;; Kludge the kludge: filladapt-mode doesn't
4306 ;; have this problem, but it currently
4307 ;; doesn't override fill-context-prefix
4308 ;; (version 2.12).
4309 (not (and (boundp 'filladapt-mode)
4310 filladapt-mode))
4311 (not (string-match
4312 "\\`[ \t]*//"
4313 (or (fill-context-prefix beg end)
4314 ""))))
4315 (c-save-buffer-state nil
4316 (car (or fill (c-guess-fill-prefix
4317 c-lit-limits c-lit-type)))))))
4319 ;; Save the relative position of point if it's outside the
4320 ;; region we're going to narrow. Want to restore it in that
4321 ;; case, but otherwise it should be moved according to the
4322 ;; called function.
4323 (point-rel (cond ((< (point) beg) (- (point) beg))
4324 ((> (point) end) (- (point) end)))))
4326 ;; Preparations finally done! Now we can call the
4327 ;; actual function.
4328 (prog1
4329 (save-restriction
4330 (narrow-to-region beg end)
4331 (apply fun args))
4332 (if point-rel
4333 ;; Restore point if it was outside the region.
4334 (if (< point-rel 0)
4335 (goto-char (+ beg point-rel))
4336 (goto-char (+ end point-rel))))))))
4338 (when (consp tmp-pre)
4339 (delete-region (car tmp-pre) (cdr tmp-pre)))
4341 (when tmp-post
4342 (save-excursion
4343 (goto-char tmp-post)
4344 (delete-char 1))
4345 (when hang-ender-stuck
4346 ;; Preserve point even if it's in the middle of the string
4347 ;; we replace; save-excursion doesn't work in that case.
4348 (setq here (point))
4349 (goto-char tmp-post)
4350 (skip-syntax-backward "^w ")
4351 (forward-char (- hang-ender-stuck))
4352 (if (or fill-paragraph (not auto-fill-spaces))
4353 (insert-char ?\ hang-ender-stuck t)
4354 (insert auto-fill-spaces))
4355 (delete-char hang-ender-stuck)
4356 (goto-char here))
4357 (set-marker tmp-post nil))
4359 (set-marker end nil))))
4361 (defun c-fill-paragraph (&optional arg)
4362 "Like \\[fill-paragraph] but handles C and C++ style comments.
4363 If any of the current line is a comment or within a comment, fill the
4364 comment or the paragraph of it that point is in, preserving the
4365 comment indentation or line-starting decorations (see the
4366 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4367 details).
4369 If point is inside multiline string literal, fill it. This currently
4370 does not respect escaped newlines, except for the special case when it
4371 is the very first thing in the string. The intended use for this rule
4372 is in situations like the following:
4374 char description[] = \"\\
4375 A very long description of something that you want to fill to make
4376 nicely formatted output.\"\;
4378 If point is in any other situation, i.e. in normal code, do nothing.
4380 Optional prefix ARG means justify paragraph as well."
4381 (interactive "*P")
4382 (let ((fill-paragraph-function
4383 ;; Avoid infinite recursion.
4384 (if (not (eq fill-paragraph-function 'c-fill-paragraph))
4385 fill-paragraph-function))
4386 (start-point (point-marker)))
4387 (c-mask-paragraph
4388 t nil (lambda () (fill-region-as-paragraph (point-min) (point-max) arg)))
4389 (goto-char start-point))
4390 ;; Always return t. This has the effect that if filling isn't done
4391 ;; above, it isn't done at all, and it's therefore effectively
4392 ;; disabled in normal code.
4395 (defun c-do-auto-fill ()
4396 ;; Do automatic filling if not inside a context where it should be
4397 ;; ignored.
4398 (let ((c-auto-fill-prefix
4399 ;; The decision whether the line should be broken is actually
4400 ;; done in c-indent-new-comment-line, which do-auto-fill
4401 ;; calls to break lines. We just set this special variable
4402 ;; so that we'll know when we're called from there. It's
4403 ;; also used to detect whether fill-prefix is user set or
4404 ;; generated automatically by do-auto-fill.
4405 fill-prefix))
4406 (c-mask-paragraph nil t 'do-auto-fill)))
4408 (defun c-indent-new-comment-line (&optional soft allow-auto-fill)
4409 "Break line at point and indent, continuing comment or macro if within one.
4410 If inside a comment and `comment-multi-line' is non-nil, the
4411 indentation and line prefix are preserved (see the
4412 `c-comment-prefix-regexp' and `c-block-comment-prefix' variables for
4413 details). If inside a single line comment and `comment-multi-line' is
4414 nil, a new comment of the same type is started on the next line and
4415 indented as appropriate for comments. If inside a macro, a line
4416 continuation backslash is inserted and aligned as appropriate, and the
4417 new line is indented according to `c-syntactic-indentation'.
4419 If a fill prefix is specified, it overrides all the above."
4420 ;; allow-auto-fill is used from c-context-line-break to allow auto
4421 ;; filling to break the line more than once. Since this function is
4422 ;; used from auto-fill itself, that's normally disabled to avoid
4423 ;; unnecessary recursion.
4424 (interactive)
4425 (let ((fill-prefix fill-prefix)
4426 (do-line-break
4427 (lambda ()
4428 (delete-horizontal-space)
4429 (if soft
4430 (insert-and-inherit ?\n)
4431 (newline (if allow-auto-fill nil 1)))))
4432 ;; Already know the literal type and limits when called from
4433 ;; c-context-line-break.
4434 (c-lit-limits c-lit-limits)
4435 (c-lit-type c-lit-type)
4436 (c-macro-start c-macro-start))
4438 (c-save-buffer-state ()
4439 (when (not (eq c-auto-fill-prefix t))
4440 ;; Called from do-auto-fill.
4441 (unless c-lit-limits
4442 (setq c-lit-limits (c-literal-limits nil nil t)))
4443 (unless c-lit-type
4444 (setq c-lit-type (c-literal-type c-lit-limits)))
4445 (if (memq (cond ((c-query-and-set-macro-start) 'cpp)
4446 ((null c-lit-type) 'code)
4447 (t c-lit-type))
4448 c-ignore-auto-fill)
4449 (setq fill-prefix t) ; Used as flag in the cond.
4450 (if (and (null c-auto-fill-prefix)
4451 (eq c-lit-type 'c)
4452 (<= (c-point 'bol) (car c-lit-limits)))
4453 ;; The adaptive fill function has generated a prefix, but
4454 ;; we're on the first line in a block comment so it'll be
4455 ;; wrong. Ignore it to guess a better one below.
4456 (setq fill-prefix nil)
4457 (when (and (eq c-lit-type 'c++)
4458 (not (string-match (concat "\\`[ \t]*"
4459 c-line-comment-starter)
4460 (or fill-prefix ""))))
4461 ;; Kludge: If the function that adapted the fill prefix
4462 ;; doesn't produce the required comment starter for line
4463 ;; comments, then we ignore it.
4464 (setq fill-prefix nil)))
4467 (cond ((eq fill-prefix t)
4468 ;; A call from do-auto-fill which should be ignored.
4470 (fill-prefix
4471 ;; A fill-prefix overrides anything.
4472 (funcall do-line-break)
4473 (insert-and-inherit fill-prefix))
4474 ((c-save-buffer-state ()
4475 (unless c-lit-limits
4476 (setq c-lit-limits (c-literal-limits)))
4477 (unless c-lit-type
4478 (setq c-lit-type (c-literal-type c-lit-limits)))
4479 (memq c-lit-type '(c c++)))
4480 ;; Some sort of comment.
4481 (if (or comment-multi-line
4482 (save-excursion
4483 (goto-char (car c-lit-limits))
4484 (end-of-line)
4485 (< (point) (cdr c-lit-limits))))
4486 ;; Inside a comment that should be continued.
4487 (let ((fill (c-save-buffer-state nil
4488 (c-guess-fill-prefix
4489 (setq c-lit-limits
4490 (c-collect-line-comments c-lit-limits))
4491 c-lit-type)))
4492 (pos (point))
4493 (start-col (current-column))
4494 (comment-text-end
4495 (or (and (eq c-lit-type 'c)
4496 (save-excursion
4497 (goto-char (- (cdr c-lit-limits) 2))
4498 (if (looking-at "\\*/") (point))))
4499 (cdr c-lit-limits))))
4500 ;; Skip forward past the fill prefix in case
4501 ;; we're standing in it.
4503 ;; FIXME: This doesn't work well in cases like
4505 ;; /* Bla bla bla bla bla
4506 ;; bla bla
4508 ;; If point is on the 'B' then the line will be
4509 ;; broken after "Bla b".
4511 ;; If we have an empty comment, /* */, the next
4512 ;; lot of code pushes point to the */. We fix
4513 ;; this by never allowing point to end up to the
4514 ;; right of where it started.
4515 (while (and (< (current-column) (cdr fill))
4516 (not (eolp)))
4517 (forward-char 1))
4518 (if (and (> (point) comment-text-end)
4519 (> (c-point 'bol) (car c-lit-limits)))
4520 (progn
4521 ;; The skip takes us out of the (block)
4522 ;; comment; insert the fill prefix at bol
4523 ;; instead and keep the position.
4524 (setq pos (copy-marker pos t))
4525 (beginning-of-line)
4526 (insert-and-inherit (car fill))
4527 (if soft (insert-and-inherit ?\n) (newline 1))
4528 (goto-char pos)
4529 (set-marker pos nil))
4530 ;; Don't break in the middle of a comment starter
4531 ;; or ender.
4532 (cond ((> (point) comment-text-end)
4533 (goto-char comment-text-end))
4534 ((< (point) (+ (car c-lit-limits) 2))
4535 (goto-char (+ (car c-lit-limits) 2))))
4536 (funcall do-line-break)
4537 (insert-and-inherit (car fill))
4538 (if (> (current-column) start-col)
4539 (move-to-column start-col)))) ; can this hit the
4540 ; middle of a TAB?
4541 ;; Inside a comment that should be broken.
4542 (let ((comment-start comment-start)
4543 (comment-end comment-end)
4544 col)
4545 (if (eq c-lit-type 'c)
4546 (unless (string-match "[ \t]*/\\*" comment-start)
4547 (setq comment-start "/* " comment-end " */"))
4548 (unless (string-match "[ \t]*//" comment-start)
4549 (setq comment-start "// " comment-end "")))
4550 (setq col (save-excursion
4551 (back-to-indentation)
4552 (current-column)))
4553 (funcall do-line-break)
4554 (when (and comment-end (not (equal comment-end "")))
4555 (forward-char -1)
4556 (insert-and-inherit comment-end)
4557 (forward-char 1))
4558 ;; c-comment-indent may look at the current
4559 ;; indentation, so let's start out with the same
4560 ;; indentation as the previous one.
4561 (indent-to col)
4562 (insert-and-inherit comment-start)
4563 (indent-for-comment))))
4564 ((c-query-and-set-macro-start)
4565 ;; In a macro.
4566 (unless (looking-at "[ \t]*\\\\$")
4567 ;; Do not clobber the alignment of the line continuation
4568 ;; slash; c-backslash-region might look at it.
4569 (delete-horizontal-space))
4570 ;; Got an asymmetry here: In normal code this command
4571 ;; doesn't indent the next line syntactically, and otoh a
4572 ;; normal syntactically indenting newline doesn't continue
4573 ;; the macro.
4574 (c-newline-and-indent (if allow-auto-fill nil 1)))
4576 ;; Somewhere else in the code.
4577 (let ((col (save-excursion
4578 (beginning-of-line)
4579 (while (and (looking-at "[ \t]*\\\\?$")
4580 (= (forward-line -1) 0)))
4581 (current-indentation))))
4582 (funcall do-line-break)
4583 (indent-to col))))))
4585 (defalias 'c-comment-line-break-function 'c-indent-new-comment-line)
4586 (make-obsolete 'c-comment-line-break-function 'c-indent-new-comment-line "21.1")
4588 ;; advice for indent-new-comment-line for older Emacsen
4589 (unless (boundp 'comment-line-break-function)
4590 (defvar c-inside-line-break-advice nil)
4591 (defadvice indent-new-comment-line (around c-line-break-advice
4592 activate preactivate)
4593 "Call `c-indent-new-comment-line' if in CC Mode."
4594 (if (or c-inside-line-break-advice
4595 (not c-buffer-is-cc-mode))
4596 ad-do-it
4597 (let ((c-inside-line-break-advice t))
4598 (c-indent-new-comment-line (ad-get-arg 0))))))
4600 (defun c-context-line-break ()
4601 "Do a line break suitable to the context.
4603 When point is outside a comment or macro, insert a newline and indent
4604 according to the syntactic context, unless `c-syntactic-indentation'
4605 is nil, in which case the new line is indented as the previous
4606 non-empty line instead.
4608 When point is inside the content of a preprocessor directive, a line
4609 continuation backslash is inserted before the line break and aligned
4610 appropriately. The end of the cpp directive doesn't count as inside
4613 When point is inside a comment, continue it with the appropriate
4614 comment prefix (see the `c-comment-prefix-regexp' and
4615 `c-block-comment-prefix' variables for details). The end of a
4616 C++-style line comment doesn't count as inside it.
4618 When point is inside a string, only insert a backslash when it is also
4619 inside a preprocessor directive."
4621 (interactive "*")
4622 (let* (c-lit-limits c-lit-type
4623 (c-macro-start c-macro-start))
4625 (c-save-buffer-state ()
4626 (setq c-lit-limits (c-literal-limits nil nil t)
4627 c-lit-type (c-literal-type c-lit-limits))
4628 (when (eq c-lit-type 'c++)
4629 (setq c-lit-limits (c-collect-line-comments c-lit-limits)))
4630 (c-query-and-set-macro-start))
4632 (cond
4633 ((or (eq c-lit-type 'c)
4634 (and (eq c-lit-type 'c++) ; C++ comment, but not at the very end of it.
4635 (< (save-excursion
4636 (skip-chars-forward " \t")
4637 (point))
4638 (1- (cdr c-lit-limits))))
4639 (and (numberp c-macro-start) ; Macro, but not at the very end of
4640 ; it, not in a string, and not in the
4641 ; cpp keyword.
4642 (not (eq c-lit-type 'string))
4643 (or (not (looking-at "\\s *$"))
4644 (eq (char-before) ?\\))
4645 (<= (save-excursion
4646 (goto-char c-macro-start)
4647 (if (looking-at c-opt-cpp-start)
4648 (goto-char (match-end 0)))
4649 (point))
4650 (point))))
4651 (let ((comment-multi-line t)
4652 (fill-prefix nil))
4653 (c-indent-new-comment-line nil t)))
4655 ((eq c-lit-type 'string)
4656 (if (and (numberp c-macro-start)
4657 (not (eq (char-before) ?\\)))
4658 (insert ?\\))
4659 (newline))
4661 (t (delete-horizontal-space)
4662 (newline)
4663 ;; c-indent-line may look at the current indentation, so let's
4664 ;; start out with the same indentation as the previous line.
4665 (let ((col (save-excursion
4666 (backward-char)
4667 (forward-line 0)
4668 (while (and (looking-at "[ \t]*\\\\?$")
4669 (= (forward-line -1) 0)))
4670 (current-indentation))))
4671 (indent-to col))
4672 (indent-according-to-mode)))))
4674 (defun c-context-open-line ()
4675 "Insert a line break suitable to the context and leave point before it.
4676 This is the `c-context-line-break' equivalent to `open-line', which is
4677 normally bound to C-o. See `c-context-line-break' for the details."
4678 (interactive "*")
4679 (let ((here (point)))
4680 (unwind-protect
4681 (progn
4682 ;; Temporarily insert a non-whitespace char to keep any
4683 ;; preceding whitespace intact.
4684 (insert ?x)
4685 (c-context-line-break))
4686 (goto-char here)
4687 (delete-char 1))))
4690 (cc-provide 'cc-cmds)
4692 ;;; cc-cmds.el ends here