(help-xref-go-back): Don't try to set position.
[emacs.git] / lisp / progmodes / cplus-md.el
blob52228bca82e3e6e482256cb15d9a87b8e961506c
1 ;;; cplus-md.el --- old C++ code editing mode for Emacs
3 ;; Copyright (C) 1985, 1992, 1994, 1995 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: c
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; 1987 Dave Detlefs <dld@cs.cmu.edu>
28 ;; and Stewart Clamen <clamen@cs.cmu.edu>.
29 ;; Done by fairly faithful modification of:
31 ;;; Change Log:
33 ;; Feb, 1990 (Dave Detlefs, dld@cs.cmu.edu)
34 ;; Fixed electric-c++-terminator to handle double colons, at the
35 ;; request of John Hagerman.
36 ;;
37 ;; Jan, 1990 (Doug Lea, dl@oswego.edu)
38 ;; Replaced c++-comment-region and c++-uncomment-region with
39 ;; versions from Igor Metz that avoid potential infinite loops.
41 ;; Oct, 1989 (Dave Detlefs, dld@cs.cmu.edu)
42 ;; Added contribution from Igor Metz <metz@iam.unibe.ch>:
43 ;; functions c++-comment-region and c++-uncomment-region and
44 ;; corresponding key-binding.
45 ;; Also fixed bug in indentation of second line after an empty
46 ;; arglist with empty-arglist non-null.
47 ;;
48 ;; Sept, 1989 (Glen Ditchfield, gjditchfield@violet.uwaterloo.ca):
49 ;; Textual changes to more closely imitate Emacs 18.55's c-mode.
50 ;; Fixed handling of "default:", where ":" was the last character in the
51 ;; buffer. Fixed indentation of comments starting in column 0, and when
52 ;; previous line contained more than one comment start string. Fixed
53 ;; handling of "friend".
55 ;; Aug 7, 1989; John Hagerman (hagerman@ece.cmu.edu):
56 ;; Changed calculate-c++-indent to handle member initializations
57 ;; more flexibly. Two new variables are used to control behavior:
58 ;; c++-member-init-indent and c++-continued-member-init-offset.
59 ;; Note the assumption that member initializations and argument
60 ;; declarations are not mixed in one function definition.
62 ;; June 1989 (Dave Detlefs, dld@cs.cmu.edu)
63 ;; Fixed calculate-c++-indent to handle continued lines ending in
64 ;; {'s. (I wasn't following C-mode closely enough, or C-mode
65 ;; changed.) Made ' a quote character, at the behest of someone
66 ;; whose mail I apparently deleted (if they send me mail I'll credit
67 ;; them here in a future revision.)
68 ;; Dan Weinreb (dlw@odi.com) pointed out that 'c++-mode successively
69 ;; bound c++-indent-exp and c++-indent-defun to ESC-^q. ESC-^q is
70 ;; now bound to c++-indent-exp, while, c++-indent-defun is invoked
71 ;; with ESC-^x.
73 ;; February 1989 (Dave Detlefs, dld@cs.cmu.edu)
74 ;; Fixed some errors in c++-indent-defun, as pointed out by Sam
75 ;; Haradhvala (odi!sam@talcott.harvard.edu).
76 ;; October 1988 (Dave Detlefs, dld@cs.cmu.edu)
77 ;; It turns out I had only *thought* I had made
78 ;; beginning(end)-of-defun work. It should work better now -- you
79 ;; can either attempt to match defun headers "strongly," using a
80 ;; very complicated regexp, or "weakly," using a simple one. This
81 ;; is settable by a variable; the default is the cheaper weak
82 ;; method. (Stewart Clamen was intimately involved in this, too.)
84 ;; I made "'" *not* be a string delimiter, because that was causing
85 ;; comments containing contractions to ("// don't") to mess up paren
86 ;; balancing.
88 ;; I also incorporated another slight indentation fix from Glen
89 ;; Ditchfield.
91 ;; We hope this is will make into version 19 of gnu-emacs.
93 ;; September 1988: incorporated changes from Fred Calm at Schlumberger.
94 ;; Also, made beginning(end)-of-defun, indent-defun work.
96 ;; August 1987: incorporated changes done by Glen Ditchfield of Waterloo.
98 ;;; Code:
100 (defgroup old-c++ nil
101 "Old C++ code editing mode for Emacs."
102 ;; This group should have no parent.
103 ;; We don't want it to be loaded except on explicit request.
104 :prefix "c-")
106 (defvar c++-mode-abbrev-table nil
107 "Abbrev table used in C++ mode.")
108 (define-abbrev-table 'c++-mode-abbrev-table ())
110 (defvar c++-mode-map ()
111 "Keymap used in C++ mode.")
112 (if c++-mode-map
114 (setq c++-mode-map (make-sparse-keymap))
115 (define-key c++-mode-map "\C-j" 'reindent-then-newline-and-indent)
116 (define-key c++-mode-map "{" 'electric-c++-brace)
117 (define-key c++-mode-map "}" 'electric-c++-brace)
118 (define-key c++-mode-map ";" 'electric-c++-semi)
119 (define-key c++-mode-map "\e\C-h" 'mark-c-function)
120 (define-key c++-mode-map "\e\C-q" 'indent-c++-exp)
121 (define-key c++-mode-map "\177" 'backward-delete-char-untabify)
122 (define-key c++-mode-map "\t" 'c++-indent-command)
123 ;; (define-key c++-mode-map "\C-c\C-i" 'c++-insert-header)
124 (define-key c++-mode-map "\C-c\C-\\" 'c-backslash-region))
125 ;; (define-key c++-mode-map "\e\C-a" 'c++-beginning-of-defun)
126 ;; (define-key c++-mode-map "\e\C-e" 'c++-end-of-defun)
127 ;; (define-key c++-mode-map "\e\C-x" 'c++-indent-defun))
129 (defvar c++-mode-syntax-table nil
130 "Syntax table used in C++ mode.")
132 (if c++-mode-syntax-table
134 (setq c++-mode-syntax-table (make-syntax-table))
135 (modify-syntax-entry ?\\ "\\" c++-mode-syntax-table)
136 (modify-syntax-entry ?/ ". 14" c++-mode-syntax-table)
137 (modify-syntax-entry ?* ". 23" c++-mode-syntax-table)
138 (modify-syntax-entry ?+ "." c++-mode-syntax-table)
139 (modify-syntax-entry ?- "." c++-mode-syntax-table)
140 (modify-syntax-entry ?= "." c++-mode-syntax-table)
141 (modify-syntax-entry ?% "." c++-mode-syntax-table)
142 (modify-syntax-entry ?< "." c++-mode-syntax-table)
143 (modify-syntax-entry ?> "." c++-mode-syntax-table)
144 (modify-syntax-entry ?& "." c++-mode-syntax-table)
145 (modify-syntax-entry ?| "." c++-mode-syntax-table)
146 (modify-syntax-entry ?\' "\"" c++-mode-syntax-table)
147 (modify-syntax-entry ?* ". 23b" c++-mode-syntax-table)
148 (modify-syntax-entry ?/ ". 124" c++-mode-syntax-table)
149 (modify-syntax-entry ?\n ">" c++-mode-syntax-table)
150 (modify-syntax-entry ?\^m ">" c++-mode-syntax-table))
152 (defcustom c++-continued-member-init-offset nil
153 "*Extra indent for continuation lines of member inits;
154 nil means to align with previous initializations rather than
155 with the colon on the first line."
156 :type '(choice (const nil) integer)
157 :group 'old-c++)
158 (defcustom c++-member-init-indent 0
159 "*Indentation level of member initializations in function declarations."
160 :type 'integer
161 :group 'old-c++)
162 (defcustom c++-friend-offset -4
163 "*Offset of C++ friend declarations relative to member declarations."
164 :type 'integer
165 :group 'old-c++)
166 (defcustom c++-electric-colon t
167 "*If t, colon is an electric terminator."
168 :type 'boolean
169 :group 'old-c++)
170 (defcustom c++-empty-arglist-indent nil
171 "*Indicates how far to indent an line following an empty argument
172 list. Nil indicates to just after the paren."
173 :type '(choice (const nil) integer)
174 :group 'old-c++)
176 (defvar c++-imenu-generic-expression
178 ((nil
180 (concat
181 "^" ; beginning of line is required
182 "\\(template[ \t]*<[^>]+>[ \t]*\\)?" ; there may be a "template <...>"
183 "\\([a-zA-Z0-9_:]+[ \t]+\\)?" ; type specs; there can be no
184 "\\([a-zA-Z0-9_:]+[ \t]+\\)?" ; more than 3 tokens, right?
186 "\\(" ; last type spec including */&
187 "[a-zA-Z0-9_:]+"
188 "\\([ \t]*[*&]+[ \t]*\\|[ \t]+\\)" ; either pointer/ref sign or whitespace
189 "\\)?" ; if there is a last type spec
190 "\\(" ; name; take that into the imenu entry
191 "[a-zA-Z0-9_:~]+" ; member function, ctor or dtor...
192 ; (may not contain * because then
193 ; "a::operator char*" would become "char*"!)
194 "\\|"
195 "\\([a-zA-Z0-9_:~]*::\\)?operator"
196 "[^a-zA-Z1-9_][^(]*" ; ...or operator
197 " \\)"
198 "[ \t]*([^)]*)[ \t\n]*[^ ;]" ; require something other than a ; after
199 ; the (...) to avoid prototypes. Can't
200 ; catch cases with () inside the parentheses
201 ; surrounding the parameters
202 ; (like "int foo(int a=bar()) {...}"
204 )) 6)
205 ("Class"
206 (, (concat
207 "^" ; beginning of line is required
208 "\\(template[ \t]*<[^>]+>[ \t]*\\)?" ; there may be a "template <...>"
209 "class[ \t]+"
210 "\\([a-zA-Z0-9_]+\\)" ; this is the string we want to get
211 "[ \t]*[:{]"
212 )) 2)
213 ;; Example of generic expression for finding prototypes, structs, unions, enums.
214 ;; Uncomment if you want to find these too. It will be a bit slower gathering
215 ;; the indexes.
216 ; ("Prototypes"
217 ; (,
218 ; (concat
219 ; "^" ; beginning of line is required
220 ; "\\(template[ \t]*<[^>]+>[ \t]*\\)?" ; there may be a "template <...>"
221 ; "\\([a-zA-Z0-9_:]+[ \t]+\\)?" ; type specs; there can be no
222 ; "\\([a-zA-Z0-9_:]+[ \t]+\\)?" ; more than 3 tokens, right?
224 ; "\\(" ; last type spec including */&
225 ; "[a-zA-Z0-9_:]+"
226 ; "\\([ \t]*[*&]+[ \t]*\\|[ \t]+\\)" ; either pointer/ref sign or whitespace
227 ; "\\)?" ; if there is a last type spec
228 ; "\\(" ; name; take that into the imenu entry
229 ; "[a-zA-Z0-9_:~]+" ; member function, ctor or dtor...
230 ; ; (may not contain * because then
231 ; ; "a::operator char*" would become "char*"!)
232 ; "\\|"
233 ; "\\([a-zA-Z0-9_:~]*::\\)?operator"
234 ; "[^a-zA-Z1-9_][^(]*" ; ...or operator
235 ; " \\)"
236 ; "[ \t]*([^)]*)[ \t\n]*;" ; require ';' after
237 ; ; the (...) Can't
238 ; ; catch cases with () inside the parentheses
239 ; ; surrounding the parameters
240 ; ; (like "int foo(int a=bar());"
241 ; )) 6)
242 ; ("Struct"
243 ; (, (concat
244 ; "^" ; beginning of line is required
245 ; "\\(static[ \t]+\\)?" ; there may be static or const.
246 ; "\\(const[ \t]+\\)?"
247 ; "struct[ \t]+"
248 ; "\\([a-zA-Z0-9_]+\\)" ; this is the string we want to get
249 ; "[ \t]*[{]"
250 ; )) 3)
251 ; ("Enum"
252 ; (, (concat
253 ; "^" ; beginning of line is required
254 ; "\\(static[ \t]+\\)?" ; there may be static or const.
255 ; "\\(const[ \t]+\\)?"
256 ; "enum[ \t]+"
257 ; "\\([a-zA-Z0-9_]+\\)" ; this is the string we want to get
258 ; "[ \t]*[{]"
259 ; )) 3)
260 ; ("Union"
261 ; (, (concat
262 ; "^" ; beginning of line is required
263 ; "\\(static[ \t]+\\)?" ; there may be static or const.
264 ; "\\(const[ \t]+\\)?"
265 ; "union[ \t]+"
266 ; "\\([a-zA-Z0-9_]+\\)" ; this is the string we want to get
267 ; "[ \t]*[{]"
268 ; )) 3)
270 "Imenu generic expression for C++ mode. See `imenu-generic-expression'.")
272 (defun c++-mode ()
273 "Major mode for editing C++ code. Very much like editing C code.
274 Expression and list commands understand all C++ brackets.
275 Tab at left margin indents for C++ code
276 Comments are delimited with /* ... */ {or with // ... <newline>}
277 Paragraphs are separated by blank lines only.
278 Delete converts tabs to spaces as it moves back.
279 \\{c++-mode-map}
280 Variables controlling indentation style:
281 c-tab-always-indent
282 Non-nil means TAB in C mode should always reindent the current line,
283 regardless of where in the line point is when the TAB command is used.
284 Default is t.
285 c-auto-newline
286 Non-nil means automatically newline before and after braces,
287 and after colons and semicolons, inserted in C code.
288 c-indent-level
289 Indentation of C statements within surrounding block.
290 The surrounding block's indentation is the indentation
291 of the line on which the open-brace appears.
292 c-continued-statement-offset
293 Extra indentation given to a substatement, such as the
294 then-clause of an if or body of a while.
295 c-continued-brace-offset
296 Extra indentation given to a brace that starts a substatement.
297 This is in addition to c-continued-statement-offset.
298 c-brace-offset
299 Extra indentation for line if it starts with an open brace.
300 c-brace-imaginary-offset
301 An open brace following other text is treated as if it were
302 this far to the right of the start of its line.
303 c-argdecl-indent
304 Indentation level of declarations of C function arguments.
305 c-label-offset
306 Extra indentation for line that is a label, or case or ``default:'', or
307 ``public:'' or ``private:'', or ``protected:''.
308 c++-electric-colon
309 If non-nil at invocation of c++-mode (t is the default) colon electrically
310 indents.
311 c++-empty-arglist-indent
312 If non-nil, a function declaration or invocation which ends a line with a
313 left paren is indented this many extra spaces, instead of flush with the
314 left paren.
315 c++-friend-offset
316 Offset of C++ friend declarations relative to member declarations.
317 c++-member-init-indent
318 Indentation level of member initializations in function declarations,
319 if they are on a separate line beginning with a colon.
320 c++-continued-member-init-offset
321 Extra indentation for continuation lines of member initializations; NIL
322 means to align with previous initializations rather than with the colon.
324 Settings for K&R, BSD, and Stroustrup indentation styles are
325 c-indent-level 5 8 4
326 c-continued-statement-offset 5 8 4
327 c-continued-brace-offset 0
328 c-brace-offset -5 -8 0
329 c-brace-imaginary-offset 0
330 c-argdecl-indent 0 8 4
331 c-label-offset -5 -8 -4
332 c++-empty-arglist-indent 4
333 c++-friend-offset 0
335 Turning on C++ mode calls the value of the variable `c++-mode-hook' with
336 no args if that value is non-nil."
337 (interactive)
338 (kill-all-local-variables)
339 ;; This code depends on the old C mode.
340 (require 'c-mode)
341 (use-local-map c++-mode-map)
342 (set-syntax-table c++-mode-syntax-table)
343 (setq major-mode 'c++-mode
344 mode-name "C++"
345 comment-column 32
346 local-abbrev-table c++-mode-abbrev-table)
347 (set (make-local-variable 'indent-line-function) 'c++-indent-line)
348 (set (make-local-variable 'comment-start) "// ")
349 (set (make-local-variable 'comment-end) "")
350 (set (make-local-variable 'comment-start-skip) "/\\*+ *\\|// *")
351 (set (make-local-variable 'comment-indent-function) 'c++-comment-indent)
352 (set (make-local-variable 'paragraph-start) (concat "$\\|" page-delimiter))
353 (set (make-local-variable 'paragraph-separate) paragraph-start)
354 (set (make-local-variable 'paragraph-ignore-fill-prefix) t)
355 (set (make-local-variable 'require-final-newline) t)
356 (set (make-local-variable 'parse-sexp-ignore-comments) t)
357 (make-local-variable 'imenu-generic-expression)
358 (setq imenu-generic-expression c++-imenu-generic-expression)
359 (setq imenu-case-fold-search nil)
360 (run-hooks 'c++-mode-hook)
361 (if c++-electric-colon
362 (define-key c++-mode-map ":" 'electric-c++-terminator)))
364 ;; This is used by indent-for-comment
365 ;; to decide how much to indent a comment in C++ code
366 ;; based on its context.
367 (defun c++-comment-indent ()
368 (if (looking-at "^\\(/\\*\\|//\\)")
369 0 ; Existing comment at bol stays there.
370 (save-excursion
371 (skip-chars-backward " \t")
372 (max
373 ;; Leave at least one space on non-empty lines.
374 (if (zerop (current-column)) 0 (1+ (current-column)))
375 (let ((cur-pt (point)))
376 (beginning-of-line 0)
377 ;; If previous line had a comment, use its indentation.
378 (if (re-search-forward comment-start-skip cur-pt t)
379 (progn
380 (goto-char (match-beginning 0))
381 (current-column))
382 comment-column)))))) ; otherwise indent at comment column.
384 (defun electric-c++-brace (arg)
385 "Insert character and correct line's indentation."
386 (interactive "P")
387 (let (insertpos)
388 (if (and (not arg)
389 (eolp)
390 (or (save-excursion
391 (skip-chars-backward " \t")
392 (bolp))
393 (if c-auto-newline (progn (c++-indent-line) (newline) t))))
394 (progn
395 (insert last-command-char)
396 (c++-indent-line)
397 (if c-auto-newline
398 (progn
399 (newline)
400 ;; (newline) may have done auto-fill
401 (setq insertpos (- (point) 2))
402 (c++-indent-line)))
403 (save-excursion
404 (if insertpos (goto-char (1+ insertpos)))
405 (delete-char -1))))
406 (if insertpos
407 (save-excursion
408 (goto-char insertpos)
409 (self-insert-command (prefix-numeric-value arg)))
410 (self-insert-command (prefix-numeric-value arg)))))
412 (defun electric-c++-semi (arg)
413 "Insert character and correct line's indentation."
414 (interactive "P")
415 (if c-auto-newline
416 (electric-c++-terminator arg)
417 (self-insert-command (prefix-numeric-value arg))))
419 (defun electric-c++-terminator (arg)
420 "Insert character and correct line's indentation."
421 (interactive "P")
422 (let (insertpos (end (point)))
423 (if (and (not arg) (eolp)
424 (not (save-excursion
425 (beginning-of-line)
426 (skip-chars-forward " \t")
427 (or (= (following-char) ?#)
428 ;; Colon is special only after a label, or
429 ;; case, or another colon.
430 ;; So quickly rule out most other uses of colon
431 ;; and do no indentation for them.
432 (and (eq last-command-char ?:)
433 (or (not (or (looking-at "case[ \t]")
434 (save-excursion
435 (forward-word 1)
436 (skip-chars-forward " \t")
437 (>= (point) end))))
438 ;; Do re-indent double colons
439 (save-excursion
440 (end-of-line 1)
441 (looking-at ":"))))
442 (progn
443 (beginning-of-defun)
444 (let ((pps (parse-partial-sexp (point) end)))
445 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
446 (progn
447 (insert last-command-char)
448 (c++-indent-line)
449 (and c-auto-newline
450 (not (c-inside-parens-p))
451 (progn
452 ;; the new marker object, used to be just an integer
453 (setq insertpos (make-marker))
454 ;; changed setq to set-marker
455 (set-marker insertpos (1- (point)))
456 ;; do this before the newline, since in auto fill can break
457 (newline)
458 (c-indent-line)))
459 (save-excursion
460 (if insertpos (goto-char (1+ insertpos)))
461 (delete-char -1))))
462 (if insertpos
463 (save-excursion
464 (goto-char insertpos)
465 (self-insert-command (prefix-numeric-value arg)))
466 (self-insert-command (prefix-numeric-value arg)))))
468 (defun c++-indent-command (&optional whole-exp)
469 "Indent current line as C++ code, or in some cases insert a tab character.
470 If `c-tab-always-indent' is non-nil (the default), always indent current
471 line. Otherwise, indent the current line only if point is at the left
472 margin or in the line's indentation; otherwise insert a tab.
474 A numeric argument, regardless of its value, means indent rigidly all means
475 indent rigidly all the lines of the expression starting after point so that
476 this line becomes properly indented. The relative indentation among the
477 lines of the expression are preserved."
478 (interactive "P")
479 (if whole-exp
480 ;; If arg, always indent this line as C
481 ;; and shift remaining lines of expression the same amount.
482 (let ((shift-amt (c++-indent-line))
483 beg end)
484 (save-excursion
485 (if c-tab-always-indent
486 (beginning-of-line))
487 (setq beg (point))
488 (forward-sexp 1)
489 (setq end (point))
490 (goto-char beg)
491 (forward-line 1)
492 (setq beg (point)))
493 (if (> end beg)
494 (indent-code-rigidly beg end shift-amt "#")))
495 (if (and (not c-tab-always-indent)
496 (save-excursion
497 (skip-chars-backward " \t")
498 (not (bolp))))
499 (insert-tab)
500 (c++-indent-line))))
502 (defun c++-indent-line ()
503 "Indent current line as C++ code.
504 Return the amount the indentation changed by."
505 (let ((indent (calculate-c++-indent nil))
506 beg shift-amt
507 (case-fold-search nil)
508 (pos (- (point-max) (point))))
509 (beginning-of-line)
510 (setq beg (point))
511 (cond ((eq indent nil)
512 (setq indent (current-indentation)))
513 ((eq indent t)
514 (setq indent (calculate-c-indent-within-comment)))
515 ((looking-at "[ \t]*#")
516 (setq indent 0))
518 (skip-chars-forward " \t")
519 (if (listp indent) (setq indent (car indent)))
520 (cond ((looking-at "\\(default\\|public\\|private\\|protected\\):")
521 (setq indent (+ indent c-label-offset)))
522 ((or (looking-at "case\\b")
523 (and (looking-at "[A-Za-z]")
524 (save-excursion
525 (forward-sexp 1)
526 (looking-at ":[^:]"))))
527 (setq indent (max 1 (+ indent c-label-offset))))
528 ((and (looking-at "else\\b")
529 (not (looking-at "else\\s_")))
530 (setq indent (save-excursion
531 (c-backward-to-start-of-if)
532 (current-indentation))))
533 ((looking-at "friend\[ \t]")
534 (setq indent (+ indent c++-friend-offset)))
535 ((= (following-char) ?})
536 (setq indent (- indent c-indent-level)))
537 ((= (following-char) ?{)
538 (setq indent (+ indent c-brace-offset))))))
539 (skip-chars-forward " \t")
540 (setq shift-amt (- indent (current-column)))
541 (if (zerop shift-amt)
542 (if (> (- (point-max) pos) (point))
543 (goto-char (- (point-max) pos)))
544 (delete-region beg (point))
545 (indent-to indent)
546 ;; If initial point was within line's indentation,
547 ;; position after the indentation. Else stay at same point in text.
548 (if (> (- (point-max) pos) (point))
549 (goto-char (- (point-max) pos))))
550 shift-amt))
552 (defun calculate-c++-indent (&optional parse-start)
553 "Return appropriate indentation for current line as C++ code.
554 In usual case returns an integer: the column to indent to.
555 Returns nil if line starts inside a string, t if in a comment."
556 (save-excursion
557 (beginning-of-line)
558 (let ((indent-point (point))
559 (case-fold-search nil)
560 state
561 containing-sexp)
562 (if parse-start
563 (goto-char parse-start)
564 (beginning-of-defun))
565 (while (< (point) indent-point)
566 (setq parse-start (point))
567 (setq state (parse-partial-sexp (point) indent-point 0))
568 (setq containing-sexp (car (cdr state))))
569 (cond ((or (nth 3 state) (nth 4 state))
570 ;; return nil or t if should not change this line
571 (nth 4 state))
572 ((null containing-sexp)
573 ;; Line is at top level. May be data or function definition, or
574 ;; may be function argument declaration or member initialization.
575 ;; Indent like the previous top level line unless
576 ;; (1) the previous line ends in a closeparen without semicolon,
577 ;; in which case this line is the first argument declaration or
578 ;; member initialization, or
579 ;; (2) the previous line begins with a colon,
580 ;; in which case this is the second line of member inits.
581 ;; It is assumed that arg decls and member inits are not mixed.
582 (goto-char indent-point)
583 (skip-chars-forward " \t")
584 (if (= (following-char) ?{)
585 0 ; Unless it starts a function body
586 (c++-backward-to-noncomment (or parse-start (point-min)))
587 (if (= (preceding-char) ?\))
588 (progn ; first arg decl or member init
589 (goto-char indent-point)
590 (skip-chars-forward " \t")
591 (if (= (following-char) ?:)
592 c++-member-init-indent
593 c-argdecl-indent))
594 (if (= (preceding-char) ?\;)
595 (backward-char 1))
596 (if (= (preceding-char) ?})
598 (if (= (preceding-char) ?\))
599 (forward-list -1))
600 (beginning-of-line) ; continued arg decls or member inits
601 (skip-chars-forward " \t")
602 (if (= (following-char) ?:)
603 (if c++-continued-member-init-offset
604 (+ (current-indentation)
605 c++-continued-member-init-offset)
606 (progn
607 (forward-char 1)
608 (skip-chars-forward " \t")
609 (current-column)))
610 (current-indentation)))
612 ((/= (char-after containing-sexp) ?{)
613 ;; line is expression, not statement:
614 ;; indent to just after the surrounding open -- unless
615 ;; empty arg list, in which case we do what
616 ;; c++-empty-arglist-indent says to do.
617 (if (and c++-empty-arglist-indent
618 (or (null (nth 2 state)) ;; indicates empty arg
619 ;; list.
620 ;; Use a heuristic: if the first
621 ;; non-whitespace following left paren on
622 ;; same line is not a comment,
623 ;; is not an empty arglist.
624 (save-excursion
625 (goto-char (1+ containing-sexp))
626 (not
627 (looking-at "\\( \\|\t\\)*[^/\n]")))))
628 (progn
629 (goto-char containing-sexp)
630 (beginning-of-line)
631 (skip-chars-forward " \t")
632 (goto-char (min (+ (point) c++-empty-arglist-indent)
633 (1+ containing-sexp)))
634 (current-column))
635 ;; In C-mode, we would always indent to one after the
636 ;; left paren. Here, though, we may have an
637 ;; empty-arglist, so we'll indent to the min of that
638 ;; and the beginning of the first argument.
639 (goto-char (1+ containing-sexp))
640 (current-column)))
642 ;; Statement. Find previous non-comment character.
643 (goto-char indent-point)
644 (c++-backward-to-noncomment containing-sexp)
645 (if (and (not (memq (preceding-char) '(0 ?\, ?\; ?\} ?\{)))
646 ;; But don't treat a line with a close-brace
647 ;; as a continuation. It is probably the
648 ;; end of an enum type declaration.
649 (save-excursion
650 (goto-char indent-point)
651 (skip-chars-forward " \t")
652 (not (= (following-char) ?}))))
653 ;; This line is continuation of preceding line's statement;
654 ;; indent c-continued-statement-offset more than the
655 ;; previous line of the statement.
656 (progn
657 (c-backward-to-start-of-continued-exp containing-sexp)
658 (+ c-continued-statement-offset (current-column)
659 (if (save-excursion (goto-char indent-point)
660 (skip-chars-forward " \t")
661 (eq (following-char) ?{))
662 c-continued-brace-offset 0)))
663 ;; This line starts a new statement.
664 ;; Position following last unclosed open.
665 (goto-char containing-sexp)
666 ;; Is line first statement after an open-brace?
668 ;; If no, find that first statement and indent like it.
669 (save-excursion
670 (forward-char 1)
671 (let ((colon-line-end 0))
672 (while (progn (skip-chars-forward " \t\n")
673 (looking-at
674 (concat
675 "#\\|/\\*\\|//"
676 "\\|case[ \t]"
677 "\\|[a-zA-Z0-9_$]*:[^:]"
678 "\\|friend[ \t]")))
679 ;; Skip over comments and labels following openbrace.
680 (cond ((= (following-char) ?\#)
681 (forward-line 1))
682 ((looking-at "/\\*")
683 (search-forward "*/" nil 'move))
684 ((looking-at "//\\|friend[ \t]")
685 (forward-line 1))
687 (save-excursion (end-of-line)
688 (setq colon-line-end (point)))
689 (search-forward ":"))))
690 ;; The first following code counts
691 ;; if it is before the line we want to indent.
692 (and (< (point) indent-point)
694 (if (> colon-line-end (point))
695 (- (current-indentation) c-label-offset)
696 (current-column))
697 ;; If prev stmt starts with open-brace, that
698 ;; open brace was offset by c-brace-offset.
699 ;; Compensate to get the column where
700 ;; an ordinary statement would start.
701 (if (= (following-char) ?\{) c-brace-offset 0)))))
702 ;; If no previous statement,
703 ;; indent it relative to line brace is on.
704 ;; For open brace in column zero, don't let statement
705 ;; start there too. If c-indent-offset is zero,
706 ;; use c-brace-offset + c-continued-statement-offset instead.
707 ;; For open-braces not the first thing in a line,
708 ;; add in c-brace-imaginary-offset.
709 (+ (if (and (bolp) (zerop c-indent-level))
710 (+ c-brace-offset c-continued-statement-offset)
711 c-indent-level)
712 ;; Move back over whitespace before the openbrace.
713 ;; If openbrace is not first nonwhite thing on the line,
714 ;; add the c-brace-imaginary-offset.
715 (progn (skip-chars-backward " \t")
716 (if (bolp) 0 c-brace-imaginary-offset))
717 ;; If the openbrace is preceded by a parenthesized exp,
718 ;; move to the beginning of that;
719 ;; possibly a different line
720 (progn
721 (if (eq (preceding-char) ?\))
722 (forward-sexp -1))
723 ;; Get initial indentation of the line we are on.
724 (current-indentation))))))))))
726 (defun c++-backward-to-noncomment (lim)
727 (let (opoint stop)
728 (while (not stop)
729 (skip-chars-backward " \t\n\r\f" lim)
730 (setq opoint (point))
731 (cond ((and (>= (point) (+ 2 lim))
732 (save-excursion
733 (forward-char -2)
734 (looking-at "\\*/")))
735 (search-backward "/*" lim 'move))
736 ((and
737 (search-backward "//" (max (c++-point-bol) lim) 'move)
738 (not (c++-within-string-p (point) opoint))))
739 ;; No comment to be found.
740 ;; If there's a # command on this line,
741 ;; move back to it.
742 (t (beginning-of-line)
743 (skip-chars-forward " \t")
744 ;; But don't get fooled if we are already before the #.
745 (if (and (looking-at "#") (< (point) opoint))
746 (setq stop (<= (point) lim))
747 (setq stop t)
748 (goto-char opoint)))))))
750 (defun indent-c++-exp ()
751 "Indent each line of the C++ grouping following point."
752 (interactive)
753 (let ((indent-stack (list nil))
754 (contain-stack (list (point)))
755 (case-fold-search nil)
756 restart outer-loop-done inner-loop-done state ostate
757 this-indent last-sexp last-depth
758 at-else at-brace
759 (opoint (point))
760 (next-depth 0))
761 (save-excursion
762 (forward-sexp 1))
763 (save-excursion
764 (setq outer-loop-done nil)
765 (while (and (not (eobp)) (not outer-loop-done))
766 (setq last-depth next-depth)
767 ;; Compute how depth changes over this line
768 ;; plus enough other lines to get to one that
769 ;; does not end inside a comment or string.
770 ;; Meanwhile, do appropriate indentation on comment lines.
771 (setq inner-loop-done nil)
772 (while (and (not inner-loop-done)
773 (not (and (eobp) (setq outer-loop-done t))))
774 (setq ostate state)
775 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
776 nil nil state))
777 (setq next-depth (car state))
778 (if (and (car (cdr (cdr state)))
779 (>= (car (cdr (cdr state))) 0))
780 (setq last-sexp (car (cdr (cdr state)))))
781 (if (or (nth 4 ostate))
782 (c++-indent-line))
783 (if (or (nth 3 state))
784 (forward-line 1)
785 (setq inner-loop-done t)))
786 (if (<= next-depth 0)
787 (setq outer-loop-done t))
788 (if outer-loop-done
790 ;; If this line had ..))) (((.. in it, pop out of the levels
791 ;; that ended anywhere in this line, even if the final depth
792 ;; doesn't indicate that they ended.
793 (while (> last-depth (nth 6 state))
794 (setq indent-stack (cdr indent-stack)
795 contain-stack (cdr contain-stack)
796 last-depth (1- last-depth)))
797 (if (/= last-depth next-depth)
798 (setq last-sexp nil))
799 ;; Add levels for any parens that were started in this line.
800 (while (< last-depth next-depth)
801 (setq indent-stack (cons nil indent-stack)
802 contain-stack (cons nil contain-stack)
803 last-depth (1+ last-depth)))
804 (if (null (car contain-stack))
805 (setcar contain-stack (or (car (cdr state))
806 (save-excursion (forward-sexp -1)
807 (point)))))
808 (forward-line 1)
809 (skip-chars-forward " \t")
810 (if (eolp)
812 (if (and (car indent-stack)
813 (>= (car indent-stack) 0))
814 ;; Line is on an existing nesting level.
815 ;; Lines inside parens are handled specially.
817 ;; Just started a new nesting level.
818 ;; Compute the standard indent for this level.
819 (let (val)
820 (if (= (char-after (car contain-stack)) ?{)
821 (save-excursion
822 (goto-char (car contain-stack))
823 (setq val (calculate-c-indent-after-brace)))
824 (setq val (calculate-c++-indent
825 (if (car indent-stack)
826 (- (car indent-stack))))))
827 (setcar indent-stack val)))
828 ;; Adjust line indentation according to its predecessor.
829 (if (/= (char-after (car contain-stack)) ?\{)
830 (setq this-indent (car indent-stack))
831 ;; Line is at statement level.
832 ;; Is it a new statement? Is it an else?
833 ;; Find last non-comment character before this line
834 (save-excursion
835 (setq at-else (looking-at "else\\W"))
836 (setq at-brace (= (following-char) ?\{))
837 (c++-backward-to-noncomment opoint)
838 (if (not (memq (preceding-char) '(nil ?\, ?\; ?\} ?: ?\{)))
839 ;; Preceding line did not end in comma or semi;
840 ;; indent this line c-continued-statement-offset
841 ;; more than previous.
842 (progn
843 (c-backward-to-start-of-continued-exp
844 (car contain-stack))
845 (setq this-indent
846 (+ c-continued-statement-offset
847 (current-column)
848 (if at-brace c-continued-brace-offset 0))))
849 ;; Preceding line ended in comma or semi;
850 ;; use the standard indent for this level.
851 (if at-else
852 (progn (c-backward-to-start-of-if opoint)
853 (setq this-indent (current-indentation)))
854 (setq this-indent (car indent-stack))))))
855 ;; Adjust line indentation according to its contents
856 (if (looking-at "\\(public\\|private\\|protected\\):")
857 (setq this-indent (- this-indent c-indent-level))
858 (if (or (looking-at "case[ \t]")
859 (and (looking-at "[A-Za-z]")
860 (save-excursion
861 (forward-sexp 1)
862 (looking-at ":[^:]"))))
863 (setq this-indent (max 1 (+ this-indent c-label-offset)))))
864 (if (looking-at "friend[ \t]")
865 (setq this-indent (+ this-indent c++-friend-offset)))
866 (if (= (following-char) ?\})
867 (setq this-indent (- this-indent c-indent-level)))
868 (if (= (following-char) ?\{)
869 (setq this-indent (+ this-indent c-brace-offset)))
870 ;; Put chosen indentation into effect.
871 (or (= (current-column) this-indent)
872 (= (following-char) ?\#)
873 (progn
874 (delete-region (point) (progn (beginning-of-line) (point)))
875 (indent-to this-indent)))
876 ;; Indent any comment following the text.
877 (or (looking-at comment-start-skip)
878 (if (re-search-forward comment-start-skip
879 (save-excursion (end-of-line)
880 (point)) t)
881 (progn
882 (indent-for-comment)
883 (beginning-of-line))))))))))
885 (defun fill-c++-comment ()
886 "Fill a comment contained in consecutive lines containing point.
887 The fill lines remain a comment."
888 (interactive)
889 (save-excursion
890 (let ((save fill-prefix))
891 (beginning-of-line 1)
892 (save-excursion
893 (re-search-forward comment-start-skip
894 (save-excursion (end-of-line) (point))
896 (goto-char (match-end 0))
897 (set-fill-prefix))
898 (while (looking-at fill-prefix)
899 (previous-line 1))
900 (next-line 1)
901 (insert-string "\n")
902 (fill-paragraph nil)
903 (delete-char -1)
904 (setq fill-prefix save))))
906 (defun c++-point-bol ()
907 "Returns the value of the point at the beginning of the current line."
908 (save-excursion
909 (beginning-of-line)
910 (point)))
912 ;; (defun c++-insert-header ()
913 ;; "Insert header denoting C++ code at top of buffer."
914 ;; (interactive)
915 ;; (save-excursion
916 ;; (goto-char (point-min))
917 ;; (insert "// "
918 ;; "This may look like C code, but it is really "
919 ;; "-*- C++ -*-"
920 ;; "\n\n")))
922 (defun c++-within-string-p (point1 point2)
923 "Returns true if number of double quotes between two points is odd."
924 (let ((s (buffer-substring point1 point2)))
925 (not (zerop (% (c++-count-char-in-string ?\" s) 2)))))
927 (defun c++-count-char-in-string (c s)
928 (let ((count 0)
929 (pos 0))
930 (while (< pos (length s))
931 (setq count (+ count (if (\= (aref s pos) c) 1 0)))
932 (setq pos (1+ pos)))
933 count))
935 ;; rms: This page is creeping featurism, and not worth having.
937 ;;; Below are two regular expressions that attempt to match defuns
938 ;;; "strongly" and "weakly." The strong one almost reconstructs the
939 ;;; grammar of C++; the weak one just figures anything id or curly on
940 ;;; the left begins a defun. The constant "c++-match-header-strongly"
941 ;;; determines which to use; the default is the weak one.
943 ;; (defvar c++-match-header-strongly nil
944 ;; "*If nil, use `c++-defun-header-weak' to identify beginning of definitions.
945 ;; If non-nil, use `c++-defun-header-strong'.")
947 ;; (defvar c++-defun-header-strong-struct-equivs "\\(class\\|struct\\|enum\\)"
948 ;; "Regexp to match names of structure declaration blocks in C++.")
950 ;; (defconst c++-defun-header-strong
951 ;; (let*
952 ;; (; valid identifiers
953 ;; ;; There's a real weirdness here -- if I switch the below
954 ;; (id "\\(\\w\\|_\\)+")
955 ;; ;; to be
956 ;; ;; (id "\\(_\\|\\w\\)+")
957 ;; ;; things no longer work right. Try it and see!
959 ;; ; overloadable operators
960 ;; (op-sym1
961 ;; "[-+*/%^&|~!=<>]\\|[-+*/%^&|<>=!]=\\|<<=?\\|>>=?")
962 ;; (op-sym2
963 ;; "&&\\|||\\|\\+\\+\\|--\\|()\\|\\[\\]")
964 ;; (op-sym (concat "\\(" op-sym1 "\\|" op-sym2 "\\)"))
965 ;; ; whitespace
966 ;; (middle "[^\\*]*\\(\\*+[^/\\*][^\\*]*\\)*")
967 ;; (c-comment (concat "/\\*" middle "\\*+/"))
968 ;; (wh (concat "\\(\\s \\|\n\\|//.*$\\|" c-comment "\\)"))
969 ;; (wh-opt (concat wh "*"))
970 ;; (wh-nec (concat wh "+"))
971 ;; (oper (concat "\\(" "operator" "\\("
972 ;; wh-opt op-sym "\\|" wh-nec id "\\)" "\\)"))
973 ;; (dcl-list "([^():]*)")
974 ;; (func-name (concat "\\(" oper "\\|" id "::" id "\\|" id "\\)"))
975 ;; (inits
976 ;; (concat "\\(:"
977 ;; "\\(" wh-opt id "(.*\\()" wh-opt "," "\\)\\)*"
978 ;; wh-opt id "(.*)" wh-opt "{"
979 ;; "\\|" wh-opt "{\\)"))
980 ;; (type-name (concat
981 ;; "\\(" c++-defun-header-strong-struct-equivs wh-nec "\\)?"
982 ;; id))
983 ;; (type (concat "\\(const" wh-nec "\\)?"
984 ;; "\\(" type-name "\\|" type-name wh-opt "\\*+" "\\|"
985 ;; type-name wh-opt "&" "\\)"))
986 ;; (modifier "\\(inline\\|virtual\\|overload\\|auto\\|static\\)")
987 ;; (modifiers (concat "\\(" modifier wh-nec "\\)*"))
988 ;; (func-header
989 ;; ;; type arg-dcl
990 ;; (concat modifiers type wh-nec func-name wh-opt dcl-list wh-opt inits))
991 ;; (inherit (concat "\\(:" wh-opt "\\(public\\|private\\)?"
992 ;; wh-nec id "\\)"))
993 ;; (cs-header (concat
994 ;; c++-defun-header-strong-struct-equivs
995 ;; wh-nec id wh-opt inherit "?" wh-opt "{")))
996 ;; (concat "^\\(" func-header "\\|" cs-header "\\)"))
997 ;; "Strongly-defined regexp to match beginning of structure or function def.")
1000 ;; ;; This part has to do with recognizing defuns.
1002 ;; ;; The weak convention we will use is that a defun begins any time
1003 ;; ;; there is a left curly brace, or some identifier on the left margin,
1004 ;; ;; followed by a left curly somewhere on the line. (This will also
1005 ;; ;; incorrectly match some continued strings, but this is after all
1006 ;; ;; just a weak heuristic.) Suggestions for improvement (short of the
1007 ;; ;; strong scheme shown above) are welcomed.
1009 ;; (defconst c++-defun-header-weak "^{\\|^[_a-zA-Z].*{"
1010 ;; "Weakly-defined regexp to match beginning of structure or function def.")
1012 ;; (defun c++-beginning-of-defun (arg)
1013 ;; (interactive "p")
1014 ;; (let ((c++-defun-header (if c++-match-header-strongly
1015 ;; c++-defun-header-strong
1016 ;; c++-defun-header-weak)))
1017 ;; (cond ((or (= arg 0) (and (> arg 0) (bobp))) nil)
1018 ;; ((and (not (looking-at c++-defun-header))
1019 ;; (let ((curr-pos (point))
1020 ;; (open-pos (if (search-forward "{" nil 'move)
1021 ;; (point)))
1022 ;; (beg-pos
1023 ;; (if (re-search-backward c++-defun-header nil 'move)
1024 ;; (match-beginning 0))))
1025 ;; (if (and open-pos beg-pos
1026 ;; (< beg-pos curr-pos)
1027 ;; (> open-pos curr-pos))
1028 ;; (progn
1029 ;; (goto-char beg-pos)
1030 ;; (if (= arg 1) t nil));; Are we done?
1031 ;; (goto-char curr-pos)
1032 ;; nil))))
1033 ;; (t
1034 ;; (if (and (looking-at c++-defun-header) (not (bobp)))
1035 ;; (forward-char (if (< arg 0) 1 -1)))
1036 ;; (and (re-search-backward c++-defun-header nil 'move (or arg 1))
1037 ;; (goto-char (match-beginning 0)))))))
1040 ;; (defun c++-end-of-defun (arg)
1041 ;; (interactive "p")
1042 ;; (let ((c++-defun-header (if c++-match-header-strongly
1043 ;; c++-defun-header-strong
1044 ;; c++-defun-header-weak)))
1045 ;; (if (and (eobp) (> arg 0))
1046 ;; nil
1047 ;; (if (and (> arg 0) (looking-at c++-defun-header)) (forward-char 1))
1048 ;; (let ((pos (point)))
1049 ;; (c++-beginning-of-defun
1050 ;; (if (< arg 0)
1051 ;; (- (- arg (if (eobp) 0 1)))
1052 ;; arg))
1053 ;; (if (and (< arg 0) (bobp))
1054 ;; t
1055 ;; (if (re-search-forward c++-defun-header nil 'move)
1056 ;; (progn (forward-char -1)
1057 ;; (forward-sexp)
1058 ;; (beginning-of-line 2)))
1059 ;; (if (and (= pos (point))
1060 ;; (re-search-forward c++-defun-header nil 'move))
1061 ;; (c++-end-of-defun 1))))
1062 ;; t)))
1064 ;; (defun c++-indent-defun ()
1065 ;; "Indents the current function definition, struct or class declaration."
1066 ;; (interactive)
1067 ;; (let ((restore (point)))
1068 ;; (c++-end-of-defun 1)
1069 ;; (beginning-of-line 1)
1070 ;; (let ((end (point)))
1071 ;; (c++-beginning-of-defun 1)
1072 ;; (while (<= (point) end)
1073 ;; (c++-indent-line)
1074 ;; (next-line 1)
1075 ;; (beginning-of-line 1)))
1076 ;; (goto-char restore)))
1078 (provide 'cplus-md)
1080 ;;; cplus-md.el ends here