1 ;;; cc-mode.el --- major mode for editing C and similar languages
3 ;; Copyright (C) 1985,1987,1992-2003 Free Software Foundation, Inc.
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs and Stewart Clamen
9 ;; 1985 Richard M. Stallman
10 ;; Maintainer: bug-cc-mode@gnu.org
11 ;; Created: a long, long, time ago. adapted from the original c-mode.el
12 ;; Keywords: c languages oop
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software; you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation; either version 2, or (at your option)
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs; see the file COPYING. If not, write to
28 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
29 ;; Boston, MA 02111-1307, USA.
33 ;; NOTE: Read the commentary below for the right way to submit bug reports!
34 ;; NOTE: See the accompanying texinfo manual for details on using this mode!
35 ;; Note: The version string is in cc-defs.
37 ;; This package provides GNU Emacs major modes for editing C, C++,
38 ;; Objective-C, Java, CORBA's IDL, Pike and AWK code. As of the
39 ;; latest Emacs and XEmacs releases, it is the default package for
40 ;; editing these languages. This package is called "CC Mode", and
41 ;; should be spelled exactly this way.
43 ;; CC Mode supports K&R and ANSI C, ANSI C++, Objective-C, Java,
44 ;; CORBA's IDL, Pike and AWK with a consistent indentation model
45 ;; across all modes. This indentation model is intuitive and very
46 ;; flexible, so that almost any desired style of indentation can be
47 ;; supported. Installation, usage, and programming details are
48 ;; contained in an accompanying texinfo manual.
50 ;; CC Mode's immediate ancestors were, c++-mode.el, cplus-md.el, and
53 ;; To submit bug reports, type "C-c C-b". These will be sent to
54 ;; bug-gnu-emacs@gnu.org (mirrored as the Usenet newsgroup
55 ;; gnu.emacs.bug) as well as bug-cc-mode@gnu.org, which directly
56 ;; contacts the CC Mode maintainers. Questions can sent to
57 ;; help-gnu-emacs@gnu.org (mirrored as gnu.emacs.help) and/or
58 ;; bug-cc-mode@gnu.org. Please do not send bugs or questions to our
59 ;; personal accounts; we reserve the right to ignore such email!
61 ;; Many, many thanks go out to all the folks on the beta test list.
62 ;; Without their patience, testing, insight, code contributions, and
63 ;; encouragement CC Mode would be a far inferior package.
65 ;; You can get the latest version of CC Mode, including PostScript
66 ;; documentation and separate individual files from:
68 ;; http://cc-mode.sourceforge.net/
70 ;; You can join a moderated CC Mode announcement-only mailing list by
73 ;; http://lists.sourceforge.net/mailman/listinfo/cc-mode-announce
79 (if (and (boundp 'byte-compile-dest-file)
80 (stringp byte-compile-dest-file))
81 (cons (file-name-directory byte-compile-dest-file) load-path)
83 (load "cc-bytecomp" nil t)))
86 (cc-require-when-compile 'cc-langs)
88 (cc-require 'cc-engine)
89 (cc-require 'cc-styles)
91 (cc-require 'cc-align)
92 (cc-require 'cc-menus)
94 ;; SILENCE the compiler.
95 (cc-bytecomp-defvar comment-line-break-function) ; (X)Emacs 20+
96 (cc-bytecomp-defvar adaptive-fill-first-line-regexp) ; Emacs 20+
97 (cc-bytecomp-defun set-keymap-parents) ; XEmacs
99 ;; We set these variables during mode init, yet we don't require
101 (cc-bytecomp-defvar font-lock-defaults)
102 (cc-bytecomp-defvar font-lock-syntactic-keywords)
104 ;; Menu support for both XEmacs and Emacs. If you don't have easymenu
105 ;; with your version of Emacs, you are incompatible!
106 (cc-external-require 'easymenu)
108 ;; Load cc-fonts first after font-lock is loaded, since it isn't
109 ;; necessary until font locking is requested.
110 (eval-after-load "font-lock"
111 '(require 'cc-fonts))
113 ;; cc-langs isn't loaded when we're byte compiled, so add autoload
114 ;; directives for the interface functions.
115 (autoload 'c-make-init-lang-vars-fun "cc-langs")
116 (autoload 'c-init-language-vars "cc-langs" nil nil 'macro)
119 ;; Other modes and packages which depend on CC Mode should do the
120 ;; following to make sure everything is loaded and available for their
123 ;; (require 'cc-mode)
125 ;; And in the major mode function:
127 ;; (c-initialize-cc-mode t)
128 ;; (c-init-language-vars some-mode)
129 ;; (c-common-init 'some-mode) ; Or perhaps (c-basic-common-init 'some-mode)
131 ;; If you're not writing a derived mode using the language variable
132 ;; system, then some-mode is one of the language modes directly
133 ;; supported by CC Mode. You can then use (c-init-language-vars-for
134 ;; 'some-mode) instead of `c-init-language-vars'.
135 ;; `c-init-language-vars-for' is a function that avoids the rather
136 ;; large expansion of `c-init-language-vars'.
138 ;; If you use `c-basic-common-init' then you might want to call
139 ;; `c-font-lock-init' too to set up CC Mode's font lock support.
141 ;; See cc-langs.el for further info. A small example of a derived mode
142 ;; is also available at <http://cc-mode.sourceforge.net/
143 ;; derived-mode-ex.el>.
145 (defun c-leave-cc-mode-mode ()
146 (setq c-buffer-is-cc-mode nil))
148 (defun c-init-language-vars-for (mode)
149 "Initialize the language variables for one of the language modes
150 directly supported by CC Mode. This can be used instead of the
151 `c-init-language-vars' macro if the language you want to use is one of
152 those, rather than a derived language defined through the language
153 variable system (see \"cc-langs.el\")."
154 ;; This function does not do any hidden buffer changes.
155 (cond ((eq mode 'c-mode) (c-init-language-vars c-mode))
156 ((eq mode 'c++-mode) (c-init-language-vars c++-mode))
157 ((eq mode 'objc-mode) (c-init-language-vars objc-mode))
158 ((eq mode 'java-mode) (c-init-language-vars java-mode))
159 ((eq mode 'idl-mode) (c-init-language-vars idl-mode))
160 ((eq mode 'pike-mode) (c-init-language-vars pike-mode))
161 ((eq mode 'awk-mode) (c-init-language-vars awk-mode))
162 (t (error "Unsupported mode %s" mode))))
165 (defun c-initialize-cc-mode (&optional new-style-init)
166 "Initialize CC Mode for use in the current buffer.
167 If the optional NEW-STYLE-INIT is nil or left out then all necessary
168 initialization to run CC Mode for the C language is done. Otherwise
169 only some basic setup is done, and a call to `c-init-language-vars' or
170 `c-init-language-vars-for' is necessary too (which gives more
171 control). See \"cc-mode.el\" for more info."
173 ;; This function does not do any hidden buffer changes.
175 (setq c-buffer-is-cc-mode t)
177 (let ((initprop 'cc-mode-is-initialized)
179 (unless (get 'c-initialize-cc-mode initprop)
182 (put 'c-initialize-cc-mode initprop t)
183 (c-initialize-builtin-style)
184 (run-hooks 'c-initialization-hook)
185 ;; Fix obsolete variables.
186 (if (boundp 'c-comment-continuation-stars)
187 (setq c-block-comment-prefix c-comment-continuation-stars))
188 (add-hook 'change-major-mode-hook 'c-leave-cc-mode-mode)
189 (setq c-initialization-ok t))
190 ;; Will try initialization hooks again if they failed.
191 (put 'c-initialize-cc-mode initprop c-initialization-ok))))
193 (unless new-style-init
194 (c-init-language-vars-for 'c-mode)))
199 (defvar c-mode-base-map ()
200 "Keymap shared by all CC Mode related modes.")
202 (defun c-make-inherited-keymap ()
203 (let ((map (make-sparse-keymap)))
206 ((fboundp 'set-keymap-parents)
207 (set-keymap-parents map c-mode-base-map))
209 ((fboundp 'set-keymap-parent)
210 (set-keymap-parent map c-mode-base-map))
212 (t (error "CC Mode is incompatible with this version of Emacs")))
215 (defun c-define-abbrev-table (name defs)
216 ;; Compatibility wrapper for `define-abbrev' which passes a non-nil
217 ;; sixth argument for SYSTEM-FLAG in emacsen that support it
218 ;; (currently only Emacs 21.2).
219 (let ((table (or (symbol-value name)
220 (progn (define-abbrev-table name nil)
221 (symbol-value name)))))
224 (apply 'define-abbrev table (append (car defs) '(t)))
225 (wrong-number-of-arguments
226 (apply 'define-abbrev table (car defs))))
227 (setq defs (cdr defs)))))
228 (put 'c-define-abbrev-table 'lisp-indent-function 1)
232 ;; TBD: should we even worry about naming this keymap. My vote: no,
233 ;; because Emacs and XEmacs do it differently.
234 (setq c-mode-base-map (make-sparse-keymap))
235 ;; put standard keybindings into MAP
236 ;; the following mappings correspond more or less directly to BOCM
237 (define-key c-mode-base-map "{" 'c-electric-brace)
238 (define-key c-mode-base-map "}" 'c-electric-brace)
239 (define-key c-mode-base-map ";" 'c-electric-semi&comma)
240 (define-key c-mode-base-map "#" 'c-electric-pound)
241 (define-key c-mode-base-map ":" 'c-electric-colon)
242 (define-key c-mode-base-map "(" 'c-electric-paren)
243 (define-key c-mode-base-map ")" 'c-electric-paren)
244 ;; Separate M-BS from C-M-h. The former should remain
245 ;; backward-kill-word.
246 (define-key c-mode-base-map [(control meta h)] 'c-mark-function)
247 (define-key c-mode-base-map "\e\C-q" 'c-indent-exp)
248 (substitute-key-definition 'backward-sentence
249 'c-beginning-of-statement
250 c-mode-base-map global-map)
251 (substitute-key-definition 'forward-sentence
253 c-mode-base-map global-map)
254 (substitute-key-definition 'indent-new-comment-line
255 'c-indent-new-comment-line
256 c-mode-base-map global-map)
257 (when (fboundp 'comment-indent-new-line)
258 ;; indent-new-comment-line has changed name to
259 ;; comment-indent-new-line in Emacs 21.
260 (substitute-key-definition 'comment-indent-new-line
261 'c-indent-new-comment-line
262 c-mode-base-map global-map))
263 ;; RMS says don't make these the default.
264 ;; (define-key c-mode-base-map "\e\C-a" 'c-beginning-of-defun)
265 ;; (define-key c-mode-base-map "\e\C-e" 'c-end-of-defun)
266 (define-key c-mode-base-map "\C-c\C-n" 'c-forward-conditional)
267 (define-key c-mode-base-map "\C-c\C-p" 'c-backward-conditional)
268 (define-key c-mode-base-map "\C-c\C-u" 'c-up-conditional)
269 (substitute-key-definition 'indent-for-tab-command
271 c-mode-base-map global-map)
273 ;; It doesn't suffice to put `c-fill-paragraph' on
274 ;; `fill-paragraph-function' since `c-fill-paragraph' must be called
275 ;; before any fill prefix adaption is done. E.g. `filladapt-mode'
276 ;; replaces `fill-paragraph' and does the adaption before calling
277 ;; `fill-paragraph-function', and we have to mask comments etc
278 ;; before that. Also, `c-fill-paragraph' chains on to
279 ;; `fill-paragraph' and the value on `fill-parapgraph-function' to
280 ;; do the actual filling work.
281 (substitute-key-definition 'fill-paragraph 'c-fill-paragraph
282 c-mode-base-map global-map)
283 ;; In XEmacs the default fill function is called
284 ;; fill-paragraph-or-region.
285 (substitute-key-definition 'fill-paragraph-or-region 'c-fill-paragraph
286 c-mode-base-map global-map)
288 ;; Bind the electric deletion functions to C-d and DEL. Emacs 21
289 ;; automatically maps the [delete] and [backspace] keys to these two
290 ;; depending on window system and user preferences. (In earlier
291 ;; versions it's possible to do the same by using `function-key-map'.)
292 (define-key c-mode-base-map "\C-d" 'c-electric-delete-forward)
293 (define-key c-mode-base-map "\177" 'c-electric-backspace)
294 (when (boundp 'delete-key-deletes-forward)
295 ;; In XEmacs 20 and later we fix the forward and backward deletion
296 ;; behavior by binding the keysyms for the [delete] and
297 ;; [backspace] keys directly, and use `delete-forward-p' or
298 ;; `delete-key-deletes-forward' to decide what [delete] should do.
299 (define-key c-mode-base-map [delete] 'c-electric-delete)
300 (define-key c-mode-base-map [backspace] 'c-electric-backspace))
301 (define-key c-mode-base-map "," 'c-electric-semi&comma)
302 (define-key c-mode-base-map "*" 'c-electric-star)
303 (define-key c-mode-base-map "/" 'c-electric-slash)
304 (define-key c-mode-base-map "\C-c\C-q" 'c-indent-defun)
305 (define-key c-mode-base-map "\C-c\C-\\" 'c-backslash-region)
306 (define-key c-mode-base-map "\C-c\C-a" 'c-toggle-auto-state)
307 (define-key c-mode-base-map "\C-c\C-b" 'c-submit-bug-report)
308 (define-key c-mode-base-map "\C-c\C-c" 'comment-region)
309 (define-key c-mode-base-map "\C-c\C-d" 'c-toggle-hungry-state)
310 (define-key c-mode-base-map "\C-c\C-o" 'c-set-offset)
311 (define-key c-mode-base-map "\C-c\C-s" 'c-show-syntactic-information)
312 (define-key c-mode-base-map "\C-c\C-t" 'c-toggle-auto-hungry-state)
313 (define-key c-mode-base-map "\C-c." 'c-set-style)
314 ;; conflicts with OOBR
315 ;;(define-key c-mode-base-map "\C-c\C-v" 'c-version)
318 ;; We don't require the outline package, but we configure it a bit anyway.
319 (cc-bytecomp-defvar outline-level)
321 (defun c-mode-menu (modestr)
322 "Return a menu spec suitable for `easy-menu-define' that is exactly
323 like the C mode menu except that the menu bar item name is MODESTR
326 This function is provided for compatibility only; derived modes should
327 preferably use the `c-mode-menu' language constant directly."
328 (cons modestr (c-lang-const c-mode-menu c)))
330 ;; Ugly hack to pull in the definition of `c-populate-syntax-table'
331 ;; from cc-langs to make it available at runtime. It's either this or
332 ;; moving the definition for it to cc-defs, but that would mean to
333 ;; break up the syntax table setup over two files.
334 (defalias 'c-populate-syntax-table
335 (cc-eval-when-compile
336 (let ((f (symbol-function 'c-populate-syntax-table)))
337 (if (byte-code-function-p f) f (byte-compile f)))))
339 (defun c-after-change (beg end len)
340 ;; Function put on `after-change-functions' to adjust various
341 ;; caches. Prefer speed to finesse here, since there will be an
342 ;; order of magnitude more calls to this function than any of the
343 ;; functions that use the caches.
345 ;; Note that care must be taken so that this is called before any
346 ;; font-lock callbacks since we might get calls to functions using
347 ;; these caches from inside them, and we must thus be sure that this
348 ;; has already been executed.
350 ;; This function does not do any hidden buffer changes.
352 (c-save-buffer-state ()
353 (when (> end (point-max))
354 ;; Some emacsen might return positions past the end. This has been
355 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
356 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
358 (setq end (point-max))
362 (c-invalidate-sws-region-after beg end)
363 (c-invalidate-state-cache beg)
364 (c-invalidate-find-decl-cache beg)))
366 (defun c-basic-common-init (mode default-style)
367 "Do the necessary initialization for the syntax handling routines
368 and the line breaking/filling code. Intended to be used by other
369 packages that embed CC Mode.
371 MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode.
372 DEFAULT-STYLE tells which indentation style to install. It has the
373 same format as `c-default-style'.
375 Note that `c-init-language-vars' must be called before this function.
376 This function cannot do that since `c-init-language-vars' is a macro
377 that requires a literal mode spec at compile time."
379 ;; This function does not do any hidden buffer changes.
381 (setq c-buffer-is-cc-mode mode)
383 ;; these variables should always be buffer local; they do not affect
384 ;; indentation style.
385 (make-local-variable 'parse-sexp-ignore-comments)
386 (make-local-variable 'indent-line-function)
387 (make-local-variable 'indent-region-function)
388 (make-local-variable 'normal-auto-fill-function)
389 (make-local-variable 'comment-start)
390 (make-local-variable 'comment-end)
391 (make-local-variable 'comment-start-skip)
392 (make-local-variable 'comment-multi-line)
393 (make-local-variable 'paragraph-start)
394 (make-local-variable 'paragraph-separate)
395 (make-local-variable 'paragraph-ignore-fill-prefix)
396 (make-local-variable 'adaptive-fill-mode)
397 (make-local-variable 'adaptive-fill-regexp)
399 ;; now set their values
400 (setq parse-sexp-ignore-comments t
401 indent-line-function 'c-indent-line
402 indent-region-function 'c-indent-region
403 normal-auto-fill-function 'c-do-auto-fill
404 comment-multi-line t)
406 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
407 ;; direct call to `fill-paragraph' behaves better. This still
408 ;; doesn't work with filladapt but it's better than nothing.
409 (make-local-variable 'fill-paragraph-function)
410 (setq fill-paragraph-function 'c-fill-paragraph)
412 ;; (X)Emacs 20 and later.
413 (when (boundp 'comment-line-break-function)
414 (make-local-variable 'comment-line-break-function)
415 (setq comment-line-break-function
416 'c-indent-new-comment-line))
418 ;; Emacs 20 and later.
419 (when (boundp 'parse-sexp-lookup-properties)
420 (make-local-variable 'parse-sexp-lookup-properties)
421 (setq parse-sexp-lookup-properties t))
423 ;; Same as above for XEmacs 21 (although currently undocumented).
424 (when (boundp 'lookup-syntax-properties)
425 (make-local-variable 'lookup-syntax-properties)
426 (setq lookup-syntax-properties t))
428 ;; Use this in Emacs 21 to avoid meddling with the rear-nonsticky
429 ;; property on each character.
430 (when (boundp 'text-property-default-nonsticky)
431 (make-local-variable 'text-property-default-nonsticky)
432 (let ((elem (assq 'syntax-table text-property-default-nonsticky)))
435 (setq text-property-default-nonsticky
436 (cons '(syntax-table . t)
437 text-property-default-nonsticky))))
438 (setq text-property-default-nonsticky
440 text-property-default-nonsticky)))
442 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
443 ;; heuristic that open parens in column 0 are defun starters. Since
444 ;; we have c-state-cache that isn't useful and only causes trouble
446 (when (memq 'col-0-paren c-emacs-features)
447 (make-local-variable 'open-paren-in-column-0-is-defun-start)
448 (setq open-paren-in-column-0-is-defun-start nil))
450 ;; The `c-type' text property with `c-decl-end' is used to mark the
451 ;; ends of access keys to make interactive refontification work
453 (when c-opt-access-key
454 (setq c-type-decl-end-used t))
456 (c-clear-found-types)
458 ;; now set the mode style based on default-style
459 (let ((style (if (stringp default-style)
461 (or (cdr (assq mode default-style))
462 (cdr (assq 'other default-style))
464 ;; Override style variables if `c-old-style-variable-behavior' is
465 ;; set. Also override if we are using global style variables,
466 ;; have already initialized a style once, and are switching to a
467 ;; different style. (It's doubtful whether this is desirable, but
468 ;; the whole situation with nonlocal style variables is a bit
469 ;; awkward. It's at least the most compatible way with the old
470 ;; style init procedure.)
471 (c-set-style style (not (or c-old-style-variable-behavior
472 (and (not c-style-variables-are-local-p)
474 (not (string-equal c-indentation-style
476 (c-setup-paragraph-variables)
478 ;; we have to do something special for c-offsets-alist so that the
479 ;; buffer local value has its own alist structure.
480 (setq c-offsets-alist (copy-alist c-offsets-alist))
482 ;; setup the comment indent variable in a Emacs version portable way
483 (make-local-variable 'comment-indent-function)
484 (setq comment-indent-function 'c-comment-indent)
486 ;; put auto-hungry designators onto minor-mode-alist, but only once
487 (or (assq 'c-auto-hungry-string minor-mode-alist)
488 (setq minor-mode-alist
489 (cons '(c-auto-hungry-string c-auto-hungry-string)
492 ;; Install the functions that ensure that various internal caches
493 ;; don't become invalid due to buffer changes.
494 (add-hook 'after-change-functions 'c-after-change nil t))
496 (defun c-after-font-lock-init ()
497 ;; Put on `font-lock-mode-hook'.
498 (remove-hook 'after-change-functions 'c-after-change t)
499 (add-hook 'after-change-functions 'c-after-change nil t))
501 (defun c-font-lock-init ()
502 "Set up the font-lock variables for using the font-lock support in CC Mode.
503 This does not load the font-lock package. Use after
504 `c-basic-common-init' and after cc-fonts has been loaded."
506 (make-local-variable 'font-lock-defaults)
507 (setq font-lock-defaults
508 `(,(if (c-mode-is-new-awk-p)
509 ;; awk-mode currently has only one font lock level.
510 'awk-font-lock-keywords
511 (mapcar 'c-mode-symbol
512 '("font-lock-keywords" "font-lock-keywords-1"
513 "font-lock-keywords-2" "font-lock-keywords-3")))
515 ,c-identifier-syntax-modifications
516 c-beginning-of-syntax
517 (font-lock-mark-block-function
519 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
521 (defun c-setup-doc-comment-style ()
522 "Initialize the variables that depend on the value of `c-doc-comment-style'."
523 (when (and (featurep 'font-lock)
524 (symbol-value 'font-lock-mode))
525 ;; Force font lock mode to reinitialize itself.
529 (defun c-common-init (&optional mode)
530 "Common initialization for all CC Mode modes.
531 In addition to the work done by `c-basic-common-init' and
532 `c-font-lock-init', this function sets up various other things as
533 customary in CC Mode modes but which aren't strictly necessary for CC
534 Mode to operate correctly.
536 MODE is the symbol for the mode to initialize, like 'c-mode. See
537 `c-basic-common-init' for details. It's only optional to be
538 compatible with old code; callers should always specify it.
540 This function does not do any hidden buffer changes."
543 ;; Called from an old third party package. The fallback is to
545 (c-init-language-vars-for 'c-mode))
547 (c-basic-common-init mode c-default-style)
549 ;; Only initialize font locking if we aren't called from an old package.
552 (make-local-variable 'outline-regexp)
553 (make-local-variable 'outline-level)
554 (setq outline-regexp "[^#\n\^M]"
555 outline-level 'c-outline-level)
557 (let ((rfn (assq mode c-require-final-newline)))
559 (make-local-variable 'require-final-newline)
560 (setq require-final-newline (cdr rfn)))))
562 (defun c-postprocess-file-styles ()
563 "Function that post processes relevant file local variables in CC Mode.
564 Currently, this function simply applies any style and offset settings
565 found in the file's Local Variable list. It first applies any style
566 setting found in `c-file-style', then it applies any offset settings
567 it finds in `c-file-offsets'.
569 Note that the style variables are always made local to the buffer."
571 ;; This function does not do any hidden buffer changes.
573 ;; apply file styles and offsets
574 (when c-buffer-is-cc-mode
575 (if (or c-file-style c-file-offsets)
576 (c-make-styles-buffer-local t))
578 (c-set-style c-file-style))
582 (let ((langelem (car langentry))
583 (offset (cdr langentry)))
584 (c-set-offset langelem offset)))
587 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles)
593 (defvar c-mode-syntax-table nil
594 "Syntax table used in c-mode buffers.")
595 (or c-mode-syntax-table
596 (setq c-mode-syntax-table
597 (funcall (c-lang-const c-make-mode-syntax-table c))))
599 (defvar c-mode-abbrev-table nil
600 "Abbreviation table used in c-mode buffers.")
601 (c-define-abbrev-table 'c-mode-abbrev-table
602 '(("else" "else" c-electric-continued-statement 0)
603 ("while" "while" c-electric-continued-statement 0)))
605 (defvar c-mode-map ()
606 "Keymap used in c-mode buffers.")
609 (setq c-mode-map (c-make-inherited-keymap))
610 ;; add bindings which are only useful for C
611 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
614 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
615 (cons "C" (c-lang-const c-mode-menu c)))
617 ;; In XEmacs >= 21.5 modes should add their own entries to
618 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
619 ;; doing this on load. That since `add-to-list' prepends the value
620 ;; which could cause it to clobber user settings. Later emacsen have
621 ;; an append option, but it's not safe to use.
623 ;; The the extension ".C" is associated to C++ while the lowercase
624 ;; variant goes to C. On case insensitive file systems, this means
625 ;; that ".c" files also might open C++ mode if the C++ entry comes
626 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
627 ;; after ".c", and since `add-to-list' adds the entry first we have to
628 ;; add the ".C" entry first.
629 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
630 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
631 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
633 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
635 ;; NB: The following two associate yacc and lex files to C Mode, which
636 ;; is not really suitable for those formats. Anyway, afaik there's
637 ;; currently no better mode for them, and besides this is legacy.
638 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
639 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
643 "Major mode for editing K&R and ANSI C code.
644 To submit a problem report, enter `\\[c-submit-bug-report]' from a
645 c-mode buffer. This automatically sets up a mail buffer with version
646 information already added. You just need to add a description of the
647 problem, including a reproducible test case, and send the message.
649 To see what version of CC Mode you are running, enter `\\[c-version]'.
651 The hook `c-mode-common-hook' is run with no args at mode
652 initialization, then `c-mode-hook'.
657 (kill-all-local-variables)
658 (c-initialize-cc-mode t)
659 (set-syntax-table c-mode-syntax-table)
660 (setq major-mode 'c-mode
662 local-abbrev-table c-mode-abbrev-table
664 (use-local-map c-mode-map)
665 (c-init-language-vars-for 'c-mode)
666 (c-common-init 'c-mode)
667 (easy-menu-add c-c-menu)
668 (cc-imenu-init cc-imenu-c-generic-expression)
669 (run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
676 (defvar c++-mode-syntax-table nil
677 "Syntax table used in c++-mode buffers.")
678 (or c++-mode-syntax-table
679 (setq c++-mode-syntax-table
680 (funcall (c-lang-const c-make-mode-syntax-table c++))))
682 (defvar c++-mode-abbrev-table nil
683 "Abbreviation table used in c++-mode buffers.")
684 (c-define-abbrev-table 'c++-mode-abbrev-table
685 '(("else" "else" c-electric-continued-statement 0)
686 ("while" "while" c-electric-continued-statement 0)
687 ("catch" "catch" c-electric-continued-statement 0)))
689 (defvar c++-mode-map ()
690 "Keymap used in c++-mode buffers.")
693 (setq c++-mode-map (c-make-inherited-keymap))
694 ;; add bindings which are only useful for C++
695 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
696 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
697 (define-key c++-mode-map "<" 'c-electric-lt-gt)
698 (define-key c++-mode-map ">" 'c-electric-lt-gt))
700 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
701 (cons "C++" (c-lang-const c-mode-menu c++)))
705 "Major mode for editing C++ code.
706 To submit a problem report, enter `\\[c-submit-bug-report]' from a
707 c++-mode buffer. This automatically sets up a mail buffer with
708 version information already added. You just need to add a description
709 of the problem, including a reproducible test case, and send the
712 To see what version of CC Mode you are running, enter `\\[c-version]'.
714 The hook `c-mode-common-hook' is run with no args at mode
715 initialization, then `c++-mode-hook'.
720 (kill-all-local-variables)
721 (c-initialize-cc-mode t)
722 (set-syntax-table c++-mode-syntax-table)
723 (setq major-mode 'c++-mode
725 local-abbrev-table c++-mode-abbrev-table
727 (use-local-map c++-mode-map)
728 (c-init-language-vars-for 'c++-mode)
729 (c-common-init 'c++-mode)
730 (easy-menu-add c-c++-menu)
731 (cc-imenu-init cc-imenu-c++-generic-expression)
732 (run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
736 ;; Support for Objective-C
739 (defvar objc-mode-syntax-table nil
740 "Syntax table used in objc-mode buffers.")
741 (or objc-mode-syntax-table
742 (setq objc-mode-syntax-table
743 (funcall (c-lang-const c-make-mode-syntax-table objc))))
745 (defvar objc-mode-abbrev-table nil
746 "Abbreviation table used in objc-mode buffers.")
747 (c-define-abbrev-table 'objc-mode-abbrev-table
748 '(("else" "else" c-electric-continued-statement 0)
749 ("while" "while" c-electric-continued-statement 0)))
751 (defvar objc-mode-map ()
752 "Keymap used in objc-mode buffers.")
755 (setq objc-mode-map (c-make-inherited-keymap))
756 ;; add bindings which are only useful for Objective-C
757 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
759 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
760 (cons "ObjC" (c-lang-const c-mode-menu objc)))
762 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
766 "Major mode for editing Objective C code.
767 To submit a problem report, enter `\\[c-submit-bug-report]' from an
768 objc-mode buffer. This automatically sets up a mail buffer with
769 version information already added. You just need to add a description
770 of the problem, including a reproducible test case, and send the
773 To see what version of CC Mode you are running, enter `\\[c-version]'.
775 The hook `c-mode-common-hook' is run with no args at mode
776 initialization, then `objc-mode-hook'.
781 (kill-all-local-variables)
782 (c-initialize-cc-mode t)
783 (set-syntax-table objc-mode-syntax-table)
784 (setq major-mode 'objc-mode
786 local-abbrev-table objc-mode-abbrev-table
788 ;; The `c-type' text property with `c-decl-end' is used to mark the
789 ;; end of the @-style directives.
790 (setq c-type-decl-end-used t)
791 (use-local-map objc-mode-map)
792 (c-init-language-vars-for 'objc-mode)
793 (c-common-init 'objc-mode)
794 (easy-menu-add c-objc-menu)
795 (cc-imenu-init nil 'cc-imenu-objc-function)
796 (run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
803 (defvar java-mode-syntax-table nil
804 "Syntax table used in java-mode buffers.")
805 (or java-mode-syntax-table
806 (setq java-mode-syntax-table
807 (funcall (c-lang-const c-make-mode-syntax-table java))))
809 (defvar java-mode-abbrev-table nil
810 "Abbreviation table used in java-mode buffers.")
811 (c-define-abbrev-table 'java-mode-abbrev-table
812 '(("else" "else" c-electric-continued-statement 0)
813 ("while" "while" c-electric-continued-statement 0)
814 ("catch" "catch" c-electric-continued-statement 0)
815 ("finally" "finally" c-electric-continued-statement 0)))
817 (defvar java-mode-map ()
818 "Keymap used in java-mode buffers.")
821 (setq java-mode-map (c-make-inherited-keymap))
822 ;; add bindings which are only useful for Java
825 ;; Regexp trying to describe the beginning of a Java top-level
826 ;; definition. This is not used by CC Mode, nor is it maintained
827 ;; since it's practically impossible to write a regexp that reliably
828 ;; matches such a construct. Other tools are necessary.
829 (defconst c-Java-defun-prompt-regexp
830 "^[ \t]*\\(\\(\\(public\\|protected\\|private\\|const\\|abstract\\|synchronized\\|final\\|static\\|threadsafe\\|transient\\|native\\|volatile\\)\\s-+\\)*\\(\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]*[][_$.a-zA-Z0-9]+\\|[[a-zA-Z]\\)\\s-*\\)\\s-+\\)\\)?\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]*\\s-+\\)\\s-*\\)?\\([_a-zA-Z][^][ \t:;.,{}()
\7f=]*\\|\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)\\)\\s-*\\(([^);{}]*)\\)?\\([] \t]*\\)\\(\\s-*\\<throws\\>\\s-*\\(\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)[, \t\n\r\f\v]*\\)+\\)?\\s-*")
832 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
833 (cons "Java" (c-lang-const c-mode-menu java)))
835 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
839 "Major mode for editing Java code.
840 To submit a problem report, enter `\\[c-submit-bug-report]' from a
841 java-mode buffer. This automatically sets up a mail buffer with
842 version information already added. You just need to add a description
843 of the problem, including a reproducible test case, and send the
846 To see what version of CC Mode you are running, enter `\\[c-version]'.
848 The hook `c-mode-common-hook' is run with no args at mode
849 initialization, then `java-mode-hook'.
854 (kill-all-local-variables)
855 (c-initialize-cc-mode t)
856 (set-syntax-table java-mode-syntax-table)
857 (setq major-mode 'java-mode
859 local-abbrev-table java-mode-abbrev-table
861 (use-local-map java-mode-map)
862 (c-init-language-vars-for 'java-mode)
863 (c-common-init 'java-mode)
864 (easy-menu-add c-java-menu)
865 (cc-imenu-init cc-imenu-java-generic-expression)
866 (run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
870 ;; Support for CORBA's IDL language
873 (defvar idl-mode-syntax-table nil
874 "Syntax table used in idl-mode buffers.")
875 (or idl-mode-syntax-table
876 (setq idl-mode-syntax-table
877 (funcall (c-lang-const c-make-mode-syntax-table idl))))
879 (defvar idl-mode-abbrev-table nil
880 "Abbreviation table used in idl-mode buffers.")
881 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
883 (defvar idl-mode-map ()
884 "Keymap used in idl-mode buffers.")
887 (setq idl-mode-map (c-make-inherited-keymap))
888 ;; add bindings which are only useful for IDL
891 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
892 (cons "IDL" (c-lang-const c-mode-menu idl)))
894 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
898 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
899 To submit a problem report, enter `\\[c-submit-bug-report]' from an
900 idl-mode buffer. This automatically sets up a mail buffer with
901 version information already added. You just need to add a description
902 of the problem, including a reproducible test case, and send the
905 To see what version of CC Mode you are running, enter `\\[c-version]'.
907 The hook `c-mode-common-hook' is run with no args at mode
908 initialization, then `idl-mode-hook'.
913 (kill-all-local-variables)
914 (c-initialize-cc-mode t)
915 (set-syntax-table idl-mode-syntax-table)
916 (setq major-mode 'idl-mode
918 local-abbrev-table idl-mode-abbrev-table)
919 (use-local-map idl-mode-map)
920 (c-init-language-vars-for 'idl-mode)
921 (c-common-init 'idl-mode)
922 (easy-menu-add c-idl-menu)
923 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
924 (run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
931 (defvar pike-mode-syntax-table nil
932 "Syntax table used in pike-mode buffers.")
933 (or pike-mode-syntax-table
934 (setq pike-mode-syntax-table
935 (funcall (c-lang-const c-make-mode-syntax-table pike))))
937 (defvar pike-mode-abbrev-table nil
938 "Abbreviation table used in pike-mode buffers.")
939 (c-define-abbrev-table 'pike-mode-abbrev-table
940 '(("else" "else" c-electric-continued-statement 0)
941 ("while" "while" c-electric-continued-statement 0)))
943 (defvar pike-mode-map ()
944 "Keymap used in pike-mode buffers.")
947 (setq pike-mode-map (c-make-inherited-keymap))
948 ;; additional bindings
949 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
951 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
952 (cons "Pike" (c-lang-const c-mode-menu pike)))
954 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
955 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
959 "Major mode for editing Pike code.
960 To submit a problem report, enter `\\[c-submit-bug-report]' from a
961 pike-mode buffer. This automatically sets up a mail buffer with
962 version information already added. You just need to add a description
963 of the problem, including a reproducible test case, and send the
966 To see what version of CC Mode you are running, enter `\\[c-version]'.
968 The hook `c-mode-common-hook' is run with no args at mode
969 initialization, then `pike-mode-hook'.
974 (kill-all-local-variables)
975 (c-initialize-cc-mode t)
976 (set-syntax-table pike-mode-syntax-table)
977 (setq major-mode 'pike-mode
979 local-abbrev-table pike-mode-abbrev-table
981 (use-local-map pike-mode-map)
982 (c-init-language-vars-for 'pike-mode)
983 (c-common-init 'pike-mode)
984 (easy-menu-add c-pike-menu)
985 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
986 (run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
990 ;; Support for awk. This is purposely disabled for older (X)Emacsen which
991 ;; don't support syntax-table properties.
993 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
994 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
995 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
996 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
997 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
999 ;;; Autoload directives must be on the top level, so we construct an
1000 ;;; autoload form instead.
1001 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1003 (if (not (memq 'syntax-properties c-emacs-features))
1004 (autoload 'awk-mode "awk-mode" "Major mode for editing AWK code." t)
1006 (defvar awk-mode-abbrev-table nil
1007 "Abbreviation table used in awk-mode buffers.")
1008 (c-define-abbrev-table 'awk-mode-abbrev-table
1009 '(("else" "else" c-electric-continued-statement 0)
1010 ("while" "while" c-electric-continued-statement 0)))
1012 (defvar awk-mode-map ()
1013 "Keymap used in awk-mode buffers.")
1016 (setq awk-mode-map (c-make-inherited-keymap))
1017 ;; add bindings which are only useful for awk.
1018 (define-key awk-mode-map "#" 'self-insert-command)
1019 (define-key awk-mode-map "/" 'self-insert-command)
1020 (define-key awk-mode-map "*" 'self-insert-command)
1021 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1022 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1023 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1024 (define-key awk-mode-map "\M-a" 'undefined) ; c-awk-beginning-of-statement isn't yet implemented.
1025 (define-key awk-mode-map "\M-e" 'undefined) ; c-awk-end-of-statement isn't yet implemented.
1026 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1027 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1029 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1030 (cons "AWK" (c-lang-const c-mode-menu awk)))
1033 "Major mode for editing AWK code.
1034 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1035 awk-mode buffer. This automatically sets up a mail buffer with version
1036 information already added. You just need to add a description of the
1037 problem, including a reproducible test case, and send the message.
1039 To see what version of CC Mode you are running, enter `\\[c-version]'.
1041 The hook `c-mode-common-hook' is run with no args at mode
1042 initialization, then `awk-mode-hook'.
1047 (require 'cc-awk) ; Added 2003/6/10.
1048 (kill-all-local-variables)
1049 (c-initialize-cc-mode t)
1050 (set-syntax-table awk-mode-syntax-table)
1051 (setq major-mode 'awk-mode
1053 local-abbrev-table awk-mode-abbrev-table
1055 (use-local-map awk-mode-map)
1056 (c-init-language-vars-for 'awk-mode)
1057 (c-common-init 'awk-mode)
1058 ;; The rest of CC Mode does not (yet) use `font-lock-syntactic-keywords',
1059 ;; so it's not set by `c-font-lock-init'.
1060 (make-local-variable 'font-lock-syntactic-keywords)
1061 (setq font-lock-syntactic-keywords
1062 '((c-awk-set-syntax-table-properties
1063 0 (0) ; Everything on this line is a dummy.
1065 (c-awk-unstick-NL-prop)
1066 (add-hook 'before-change-functions 'c-awk-before-change nil t)
1067 (add-hook 'after-change-functions 'c-awk-after-change nil t)
1068 (c-save-buffer-state nil
1071 (c-awk-clear-NL-props (point-min) (point-max))
1072 (c-awk-after-change (point-min) (point-max) 0))) ; Set syntax-table props.
1074 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1075 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1076 (defalias 'c-in-literal 'c-slow-in-literal)
1078 (run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1079 (c-update-modeline))
1080 ) ;; closes the (if (not (memq 'syntax-properties c-emacs-features))
1085 (defconst c-mode-help-address
1086 "bug-cc-mode@gnu.org"
1087 "Address(es) for CC Mode bug reports.")
1090 "Echo the current version of CC Mode in the minibuffer."
1092 (message "Using CC Mode version %s" c-version)
1093 (c-keep-region-active))
1095 (defvar c-prepare-bug-report-hooks nil)
1097 ;; Dynamic variables used by reporter.
1098 (defvar reporter-prompt-for-summary-p)
1099 (defvar reporter-dont-compact-list)
1101 (defun c-submit-bug-report ()
1102 "Submit via mail a bug report on CC Mode."
1106 (let ((reporter-prompt-for-summary-p t)
1107 (reporter-dont-compact-list '(c-offsets-alist))
1108 (style c-indentation-style)
1109 (c-features c-emacs-features))
1111 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1113 (reporter-submit-bug-report
1115 (concat "CC Mode " c-version " (" mode-name ")")
1118 '(c-buffer-is-cc-mode
1120 c-syntactic-indentation
1121 c-syntactic-indentation-in-macros
1123 c-auto-align-backslashes
1124 c-backspace-function
1126 c-electric-pound-behavior
1128 c-enable-xemacs-performance-kludge-p
1129 c-old-style-variable-behavior
1133 parse-sexp-ignore-comments
1134 parse-sexp-lookup-properties
1135 lookup-syntax-properties
1136 ;; A brain-damaged XEmacs only variable that, if
1137 ;; set to nil can cause all kinds of chaos.
1138 signal-error-on-buffer-boundary
1139 ;; Variables that affect line breaking and comments.
1149 adaptive-fill-regexp)
1151 (mapcar (lambda (var) (unless (boundp var)
1152 (setq vars (delq var vars))))
1153 '(signal-error-on-buffer-boundary
1157 font-lock-maximum-decoration
1158 parse-sexp-lookup-properties
1159 lookup-syntax-properties))
1162 (run-hooks 'c-prepare-bug-report-hooks)
1163 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1164 style c-features)))))))
1167 (cc-provide 'cc-mode)
1169 ;;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
1170 ;;; cc-mode.el ends here