1 ;;; cc-mode.el --- major mode for editing C and similar languages
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
5 ;; 2010 Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
11 ;; 1987 Stewart Clamen
12 ;; 1985 Richard M. Stallman
13 ;; Maintainer: bug-cc-mode@gnu.org
14 ;; Created: a long, long, time ago. adapted from the original c-mode.el
15 ;; Keywords: c languages
17 ;; This file is part of GNU Emacs.
19 ;; GNU Emacs is free software: you can redistribute it and/or modify
20 ;; it under the terms of the GNU General Public License as published by
21 ;; the Free Software Foundation, either version 3 of the License, or
22 ;; (at your option) any later version.
24 ;; GNU Emacs is distributed in the hope that it will be useful,
25 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
26 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 ;; GNU General Public License for more details.
29 ;; You should have received a copy of the GNU General Public License
30 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
34 ;; NOTE: Read the commentary below for the right way to submit bug reports!
35 ;; NOTE: See the accompanying texinfo manual for details on using this mode!
36 ;; Note: The version string is in cc-defs.
38 ;; This package provides GNU Emacs major modes for editing C, C++,
39 ;; Objective-C, Java, CORBA's IDL, Pike and AWK code. As of the
40 ;; latest Emacs and XEmacs releases, it is the default package for
41 ;; editing these languages. This package is called "CC Mode", and
42 ;; should be spelled exactly this way.
44 ;; CC Mode supports K&R and ANSI C, ANSI C++, Objective-C, Java,
45 ;; CORBA's IDL, Pike and AWK with a consistent indentation model
46 ;; across all modes. This indentation model is intuitive and very
47 ;; flexible, so that almost any desired style of indentation can be
48 ;; supported. Installation, usage, and programming details are
49 ;; contained in an accompanying texinfo manual.
51 ;; CC Mode's immediate ancestors were, c++-mode.el, cplus-md.el, and
54 ;; To submit bug reports, type "C-c C-b". These will be sent to
55 ;; bug-gnu-emacs@gnu.org (mirrored as the Usenet newsgroup
56 ;; gnu.emacs.bug) as well as bug-cc-mode@gnu.org, which directly
57 ;; contacts the CC Mode maintainers. Questions can sent to
58 ;; help-gnu-emacs@gnu.org (mirrored as gnu.emacs.help) and/or
59 ;; bug-cc-mode@gnu.org. Please do not send bugs or questions to our
60 ;; personal accounts; we reserve the right to ignore such email!
62 ;; Many, many thanks go out to all the folks on the beta test list.
63 ;; Without their patience, testing, insight, code contributions, and
64 ;; encouragement CC Mode would be a far inferior package.
66 ;; You can get the latest version of CC Mode, including PostScript
67 ;; documentation and separate individual files from:
69 ;; http://cc-mode.sourceforge.net/
71 ;; You can join a moderated CC Mode announcement-only mailing list by
74 ;; http://lists.sourceforge.net/mailman/listinfo/cc-mode-announce
80 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
84 (if (and (boundp 'byte-compile-dest-file)
85 (stringp byte-compile-dest-file))
86 (cons (file-name-directory byte-compile-dest-file) load-path)
88 (load "cc-bytecomp" nil t)))
91 (cc-require-when-compile 'cc-langs)
93 (cc-require 'cc-engine)
94 (cc-require 'cc-styles)
96 (cc-require 'cc-align)
97 (cc-require 'cc-menus)
99 ;; Silence the compiler.
100 (cc-bytecomp-defvar adaptive-fill-first-line-regexp) ; Emacs
101 (cc-bytecomp-defun set-keymap-parents) ; XEmacs
102 (cc-bytecomp-defun run-mode-hooks) ; Emacs 21.1
104 ;; We set these variables during mode init, yet we don't require
106 (cc-bytecomp-defvar font-lock-defaults)
107 (cc-bytecomp-defvar font-lock-syntactic-keywords)
109 ;; Menu support for both XEmacs and Emacs. If you don't have easymenu
110 ;; with your version of Emacs, you are incompatible!
111 (cc-external-require 'easymenu)
113 ;; Autoload directive for emacsen that doesn't have an older CC Mode
114 ;; version in the dist.
115 (autoload 'subword-mode "subword"
116 "Mode enabling subword movement and editing keys." t)
118 ;; Load cc-fonts first after font-lock is loaded, since it isn't
119 ;; necessary until font locking is requested.
120 ; (eval-after-load "font-lock" ; 2006-07-09: font-lock is now preloaded.
122 (require 'cc-fonts) ;)
124 ;; cc-langs isn't loaded when we're byte compiled, so add autoload
125 ;; directives for the interface functions.
126 (autoload 'c-make-init-lang-vars-fun "cc-langs")
127 (autoload 'c-init-language-vars "cc-langs" nil nil 'macro)
130 ;; Other modes and packages which depend on CC Mode should do the
131 ;; following to make sure everything is loaded and available for their
134 ;; (require 'cc-mode)
136 ;; And in the major mode function:
138 ;; (c-initialize-cc-mode t)
139 ;; (c-init-language-vars some-mode)
140 ;; (c-common-init 'some-mode) ; Or perhaps (c-basic-common-init 'some-mode)
142 ;; If you're not writing a derived mode using the language variable
143 ;; system, then some-mode is one of the language modes directly
144 ;; supported by CC Mode. You can then use (c-init-language-vars-for
145 ;; 'some-mode) instead of `c-init-language-vars'.
146 ;; `c-init-language-vars-for' is a function that avoids the rather
147 ;; large expansion of `c-init-language-vars'.
149 ;; If you use `c-basic-common-init' then you might want to call
150 ;; `c-font-lock-init' too to set up CC Mode's font lock support.
152 ;; See cc-langs.el for further info. A small example of a derived mode
153 ;; is also available at <http://cc-mode.sourceforge.net/
154 ;; derived-mode-ex.el>.
156 (defun c-leave-cc-mode-mode ()
157 (setq c-buffer-is-cc-mode nil))
159 (defun c-init-language-vars-for (mode)
160 "Initialize the language variables for one of the language modes
161 directly supported by CC Mode. This can be used instead of the
162 `c-init-language-vars' macro if the language you want to use is one of
163 those, rather than a derived language defined through the language
164 variable system (see \"cc-langs.el\")."
165 (cond ((eq mode 'c-mode) (c-init-language-vars c-mode))
166 ((eq mode 'c++-mode) (c-init-language-vars c++-mode))
167 ((eq mode 'objc-mode) (c-init-language-vars objc-mode))
168 ((eq mode 'java-mode) (c-init-language-vars java-mode))
169 ((eq mode 'idl-mode) (c-init-language-vars idl-mode))
170 ((eq mode 'pike-mode) (c-init-language-vars pike-mode))
171 ((eq mode 'awk-mode) (c-init-language-vars awk-mode))
172 (t (error "Unsupported mode %s" mode))))
175 (defun c-initialize-cc-mode (&optional new-style-init)
176 "Initialize CC Mode for use in the current buffer.
177 If the optional NEW-STYLE-INIT is nil or left out then all necessary
178 initialization to run CC Mode for the C language is done. Otherwise
179 only some basic setup is done, and a call to `c-init-language-vars' or
180 `c-init-language-vars-for' is necessary too (which gives more
181 control). See \"cc-mode.el\" for more info."
183 (setq c-buffer-is-cc-mode t)
185 (let ((initprop 'cc-mode-is-initialized)
187 (unless (get 'c-initialize-cc-mode initprop)
190 (put 'c-initialize-cc-mode initprop t)
191 (c-initialize-builtin-style)
192 (run-hooks 'c-initialization-hook)
193 ;; Fix obsolete variables.
194 (if (boundp 'c-comment-continuation-stars)
195 (setq c-block-comment-prefix
196 (symbol-value 'c-comment-continuation-stars)))
197 (add-hook 'change-major-mode-hook 'c-leave-cc-mode-mode)
198 (setq c-initialization-ok t))
199 ;; Will try initialization hooks again if they failed.
200 (put 'c-initialize-cc-mode initprop c-initialization-ok))))
202 (unless new-style-init
203 (c-init-language-vars-for 'c-mode)))
208 (defvar c-mode-base-map ()
209 "Keymap shared by all CC Mode related modes.")
211 (defun c-make-inherited-keymap ()
212 (let ((map (make-sparse-keymap)))
213 ;; Necessary to use `cc-bytecomp-fboundp' below since this
214 ;; function is called from top-level forms that are evaluated
215 ;; while cc-bytecomp is active when one does M-x eval-buffer.
218 ((cc-bytecomp-fboundp 'set-keymap-parent)
219 (set-keymap-parent map c-mode-base-map))
221 ((cc-bytecomp-fboundp 'set-keymap-parents)
222 (set-keymap-parents map c-mode-base-map))
224 (t (error "CC Mode is incompatible with this version of Emacs")))
227 (defun c-define-abbrev-table (name defs)
228 ;; Compatibility wrapper for `define-abbrev' which passes a non-nil
229 ;; sixth argument for SYSTEM-FLAG in emacsen that support it
230 ;; (currently only Emacs >= 21.2).
231 (let ((table (or (symbol-value name)
232 (progn (define-abbrev-table name nil)
233 (symbol-value name)))))
236 (apply 'define-abbrev table (append (car defs) '(t)))
237 (wrong-number-of-arguments
238 (apply 'define-abbrev table (car defs))))
239 (setq defs (cdr defs)))))
240 (put 'c-define-abbrev-table 'lisp-indent-function 1)
242 (defun c-bind-special-erase-keys ()
243 ;; Only used in Emacs to bind C-c C-<delete> and C-c C-<backspace>
244 ;; to the proper keys depending on `normal-erase-is-backspace'.
245 (if normal-erase-is-backspace
247 (define-key c-mode-base-map (kbd "C-c C-<delete>")
248 'c-hungry-delete-forward)
249 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
250 'c-hungry-delete-backwards))
251 (define-key c-mode-base-map (kbd "C-c C-<delete>")
252 'c-hungry-delete-backwards)
253 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
254 'c-hungry-delete-forward)))
259 (setq c-mode-base-map (make-sparse-keymap))
261 ;; Separate M-BS from C-M-h. The former should remain
262 ;; backward-kill-word.
263 (define-key c-mode-base-map [(control meta h)] 'c-mark-function)
264 (define-key c-mode-base-map "\e\C-q" 'c-indent-exp)
265 (substitute-key-definition 'backward-sentence
266 'c-beginning-of-statement
267 c-mode-base-map global-map)
268 (substitute-key-definition 'forward-sentence
270 c-mode-base-map global-map)
271 (substitute-key-definition 'indent-new-comment-line
272 'c-indent-new-comment-line
273 c-mode-base-map global-map)
274 (substitute-key-definition 'indent-for-tab-command
275 ;; XXX Is this the right thing to do
277 'c-indent-line-or-region
278 c-mode-base-map global-map)
279 (when (fboundp 'comment-indent-new-line)
280 ;; indent-new-comment-line has changed name to
281 ;; comment-indent-new-line in Emacs 21.
282 (substitute-key-definition 'comment-indent-new-line
283 'c-indent-new-comment-line
284 c-mode-base-map global-map))
286 ;; RMS says don't make these the default.
287 ;; (April 2006): RMS has now approved these commands as defaults.
288 (unless (memq 'argumentative-bod-function c-emacs-features)
289 (define-key c-mode-base-map "\e\C-a" 'c-beginning-of-defun)
290 (define-key c-mode-base-map "\e\C-e" 'c-end-of-defun))
292 (define-key c-mode-base-map "\C-c\C-n" 'c-forward-conditional)
293 (define-key c-mode-base-map "\C-c\C-p" 'c-backward-conditional)
294 (define-key c-mode-base-map "\C-c\C-u" 'c-up-conditional)
296 ;; It doesn't suffice to put `c-fill-paragraph' on
297 ;; `fill-paragraph-function' since `c-fill-paragraph' must be called
298 ;; before any fill prefix adaption is done. E.g. `filladapt-mode'
299 ;; replaces `fill-paragraph' and does the adaption before calling
300 ;; `fill-paragraph-function', and we have to mask comments etc
301 ;; before that. Also, `c-fill-paragraph' chains on to
302 ;; `fill-paragraph' and the value on `fill-parapgraph-function' to
303 ;; do the actual filling work.
304 (substitute-key-definition 'fill-paragraph 'c-fill-paragraph
305 c-mode-base-map global-map)
306 ;; In XEmacs the default fill function is called
307 ;; fill-paragraph-or-region.
308 (substitute-key-definition 'fill-paragraph-or-region 'c-fill-paragraph
309 c-mode-base-map global-map)
311 ;; We bind the forward deletion key and (implicitly) C-d to
312 ;; `c-electric-delete-forward', and the backward deletion key to
313 ;; `c-electric-backspace'. The hungry variants are bound to the
314 ;; same keys but prefixed with C-c. This implies that C-c C-d is
315 ;; `c-hungry-delete-forward'. For consistency, we bind not only C-c
316 ;; <backspace> to `c-hungry-delete-backwards' but also
317 ;; C-c C-<backspace>, so that the Ctrl key can be held down during
318 ;; the whole sequence regardless of the direction. This in turn
319 ;; implies that we bind C-c C-<delete> to `c-hungry-delete-forward',
320 ;; for the same reason.
322 ;; Bind the electric deletion functions to C-d and DEL. Emacs 21
323 ;; automatically maps the [delete] and [backspace] keys to these two
324 ;; depending on window system and user preferences. (In earlier
325 ;; versions it's possible to do the same by using `function-key-map'.)
326 (define-key c-mode-base-map "\C-d" 'c-electric-delete-forward)
327 (define-key c-mode-base-map "\177" 'c-electric-backspace)
328 (define-key c-mode-base-map "\C-c\C-d" 'c-hungry-delete-forward)
329 (define-key c-mode-base-map [?\C-c ?\d] 'c-hungry-delete-backwards)
330 (define-key c-mode-base-map [?\C-c ?\C-\d] 'c-hungry-delete-backwards)
331 (define-key c-mode-base-map [?\C-c deletechar] 'c-hungry-delete-forward) ; C-c <delete> on a tty.
332 (define-key c-mode-base-map [?\C-c (control deletechar)] ; C-c C-<delete> on a tty.
333 'c-hungry-delete-forward)
334 (when (boundp 'normal-erase-is-backspace)
335 ;; The automatic C-d and DEL mapping functionality doesn't extend
336 ;; to special combinations like C-c C-<delete>, so we have to hook
337 ;; into the `normal-erase-is-backspace' system to bind it directly
339 (add-hook 'normal-erase-is-backspace-hook 'c-bind-special-erase-keys)
340 (c-bind-special-erase-keys))
342 (when (fboundp 'delete-forward-p)
343 ;; In XEmacs we fix the forward and backward deletion behavior by
344 ;; binding the keysyms for the [delete] and [backspace] keys
345 ;; directly, and use `delete-forward-p' to decide what [delete]
346 ;; should do. That's done in the XEmacs specific
347 ;; `c-electric-delete' and `c-hungry-delete' functions.
348 (define-key c-mode-base-map [delete] 'c-electric-delete)
349 (define-key c-mode-base-map [backspace] 'c-electric-backspace)
350 (define-key c-mode-base-map (kbd "C-c <delete>") 'c-hungry-delete)
351 (define-key c-mode-base-map (kbd "C-c C-<delete>") 'c-hungry-delete)
352 (define-key c-mode-base-map (kbd "C-c <backspace>")
353 'c-hungry-delete-backwards)
354 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
355 'c-hungry-delete-backwards))
357 (define-key c-mode-base-map "#" 'c-electric-pound)
358 (define-key c-mode-base-map "{" 'c-electric-brace)
359 (define-key c-mode-base-map "}" 'c-electric-brace)
360 (define-key c-mode-base-map "/" 'c-electric-slash)
361 (define-key c-mode-base-map "*" 'c-electric-star)
362 (define-key c-mode-base-map ";" 'c-electric-semi&comma)
363 (define-key c-mode-base-map "," 'c-electric-semi&comma)
364 (define-key c-mode-base-map ":" 'c-electric-colon)
365 (define-key c-mode-base-map "(" 'c-electric-paren)
366 (define-key c-mode-base-map ")" 'c-electric-paren)
368 (define-key c-mode-base-map "\C-c\C-\\" 'c-backslash-region)
369 (define-key c-mode-base-map "\C-c\C-a" 'c-toggle-auto-newline)
370 (define-key c-mode-base-map "\C-c\C-b" 'c-submit-bug-report)
371 (define-key c-mode-base-map "\C-c\C-c" 'comment-region)
372 (define-key c-mode-base-map "\C-c\C-l" 'c-toggle-electric-state)
373 (define-key c-mode-base-map "\C-c\C-o" 'c-set-offset)
374 (define-key c-mode-base-map "\C-c\C-q" 'c-indent-defun)
375 (define-key c-mode-base-map "\C-c\C-s" 'c-show-syntactic-information)
376 ;; (define-key c-mode-base-map "\C-c\C-t" 'c-toggle-auto-hungry-state) Commented out by ACM, 2005-03-05.
377 (define-key c-mode-base-map "\C-c." 'c-set-style)
378 ;; conflicts with OOBR
379 ;;(define-key c-mode-base-map "\C-c\C-v" 'c-version)
380 ;; (define-key c-mode-base-map "\C-c\C-y" 'c-toggle-hungry-state) Commented out by ACM, 2005-11-22.
381 (define-key c-mode-base-map "\C-c\C-w" 'subword-mode)
384 ;; We don't require the outline package, but we configure it a bit anyway.
385 (cc-bytecomp-defvar outline-level)
387 (defun c-mode-menu (modestr)
388 "Return a menu spec suitable for `easy-menu-define' that is exactly
389 like the C mode menu except that the menu bar item name is MODESTR
392 This function is provided for compatibility only; derived modes should
393 preferably use the `c-mode-menu' language constant directly."
394 (cons modestr (c-lang-const c-mode-menu c)))
396 ;; Ugly hack to pull in the definition of `c-populate-syntax-table'
397 ;; from cc-langs to make it available at runtime. It's either this or
398 ;; moving the definition for it to cc-defs, but that would mean to
399 ;; break up the syntax table setup over two files.
400 (defalias 'c-populate-syntax-table
401 (cc-eval-when-compile
402 (let ((f (symbol-function 'c-populate-syntax-table)))
403 (if (byte-code-function-p f) f (byte-compile f)))))
405 ;; CAUTION: Try to avoid installing things on
406 ;; `before-change-functions'. The macro `combine-after-change-calls'
407 ;; is used and it doesn't work if there are things on that hook. That
408 ;; can cause font lock functions to run in inconvenient places during
409 ;; temporary changes in some font lock support modes, causing extra
410 ;; unnecessary work and font lock glitches due to interactions between
411 ;; various text properties.
413 ;; (2007-02-12): The macro `combine-after-change-calls' ISN'T used any
416 (defun c-unfind-enclosing-token (pos)
417 ;; If POS is wholly inside a token, remove that id from
418 ;; `c-found-types', should it be present. Return t if we were in an
421 (let ((tok-beg (progn (goto-char pos)
422 (and (c-beginning-of-current-token) (point))))
423 (tok-end (progn (goto-char pos)
424 (and (c-end-of-current-token) (point)))))
425 (when (and tok-beg tok-end)
426 (c-unfind-type (buffer-substring-no-properties tok-beg tok-end))
429 (defun c-unfind-coalesced-tokens (beg end)
430 ;; unless the non-empty region (beg end) is entirely WS and there's at
431 ;; least one character of WS just before or after this region, remove
432 ;; the tokens which touch the region from `c-found-types' should they
434 (or (c-partial-ws-p beg end)
438 (or (eq beg (point-min))
439 (c-skip-ws-backward (1- beg))
441 (= (c-backward-token-2) 1)
442 (c-unfind-type (buffer-substring-no-properties
445 (or (eq end (point-max))
446 (c-skip-ws-forward (1+ end))
448 (progn (forward-char) (c-end-of-current-token) nil)
449 (c-unfind-type (buffer-substring-no-properties
452 ;; c-maybe-stale-found-type records a place near the region being
453 ;; changed where an element of `found-types' might become stale. It
454 ;; is set in c-before-change and is either nil, or has the form:
456 ;; (c-decl-id-start "foo" 97 107 " (* ooka) " "o"), where
458 ;; o - `c-decl-id-start' is the c-type text property value at buffer
461 ;; o - 97 107 is the region potentially containing the stale type -
462 ;; this is delimited by a non-nil c-type text property at 96 and
463 ;; either another one or a ";", "{", or "}" at 107.
465 ;; o - " (* ooka) " is the (before change) buffer portion containing
466 ;; the suspect type (here "ooka").
468 ;; o - "o" is the buffer contents which is about to be deleted. This
469 ;; would be the empty string for an insertion.
470 (defvar c-maybe-stale-found-type nil)
471 (make-variable-buffer-local 'c-maybe-stale-found-type)
473 (defun c-basic-common-init (mode default-style)
474 "Do the necessary initialization for the syntax handling routines
475 and the line breaking/filling code. Intended to be used by other
476 packages that embed CC Mode.
478 MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode.
479 DEFAULT-STYLE tells which indentation style to install. It has the
480 same format as `c-default-style'.
482 Note that `c-init-language-vars' must be called before this function.
483 This function cannot do that since `c-init-language-vars' is a macro
484 that requires a literal mode spec at compile time."
486 (setq c-buffer-is-cc-mode mode)
488 ;; these variables should always be buffer local; they do not affect
489 ;; indentation style.
490 (make-local-variable 'comment-start)
491 (make-local-variable 'comment-end)
492 (make-local-variable 'comment-start-skip)
494 (make-local-variable 'paragraph-start)
495 (make-local-variable 'paragraph-separate)
496 (make-local-variable 'paragraph-ignore-fill-prefix)
497 (make-local-variable 'adaptive-fill-mode)
498 (make-local-variable 'adaptive-fill-regexp)
500 ;; now set their values
501 (set (make-local-variable 'parse-sexp-ignore-comments) t)
502 (set (make-local-variable 'indent-line-function) 'c-indent-line)
503 (set (make-local-variable 'indent-region-function) 'c-indent-region)
504 (set (make-local-variable 'normal-auto-fill-function) 'c-do-auto-fill)
505 (set (make-local-variable 'comment-multi-line) t)
506 (set (make-local-variable 'comment-line-break-function)
507 'c-indent-new-comment-line)
509 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
510 ;; direct call to `fill-paragraph' behaves better. This still
511 ;; doesn't work with filladapt but it's better than nothing.
512 (set (make-local-variable 'fill-paragraph-function) 'c-fill-paragraph)
514 ;; Initialise the cache of brace pairs, and opening braces/brackets/parens.
517 (when (or c-recognize-<>-arglists
518 (c-major-mode-is 'awk-mode)
519 (c-major-mode-is '(java-mode c-mode c++-mode objc-mode)))
520 ;; We'll use the syntax-table text property to change the syntax
521 ;; of some chars for this language, so do the necessary setup for
524 ;; Note to other package developers: It's ok to turn this on in CC
525 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
526 ;; off if CC Mode has turned it on.
529 (when (boundp 'parse-sexp-lookup-properties)
530 (set (make-local-variable 'parse-sexp-lookup-properties) t))
532 ;; Same as above for XEmacs.
533 (when (boundp 'lookup-syntax-properties)
534 (set (make-local-variable 'lookup-syntax-properties) t)))
536 ;; Use this in Emacs 21+ to avoid meddling with the rear-nonsticky
537 ;; property on each character.
538 (when (boundp 'text-property-default-nonsticky)
539 (mapc (lambda (tprop)
540 (unless (assq tprop text-property-default-nonsticky)
541 (set (make-local-variable 'text-property-default-nonsticky)
542 (cons `(,tprop . t) text-property-default-nonsticky))))
543 '(syntax-table category c-type)))
545 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
546 ;; heuristic that open parens in column 0 are defun starters. Since
547 ;; we have c-state-cache, that heuristic isn't useful and only causes
548 ;; trouble, so turn it off.
549 ;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
550 ;; helpful. Comment it out for now.
551 ;; (when (memq 'col-0-paren c-emacs-features)
552 ;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
553 ;; (setq open-paren-in-column-0-is-defun-start nil))
555 (c-clear-found-types)
557 ;; now set the mode style based on default-style
558 (let ((style (if (stringp default-style)
560 (or (cdr (assq mode default-style))
561 (cdr (assq 'other default-style))
563 ;; Override style variables if `c-old-style-variable-behavior' is
564 ;; set. Also override if we are using global style variables,
565 ;; have already initialized a style once, and are switching to a
566 ;; different style. (It's doubtful whether this is desirable, but
567 ;; the whole situation with nonlocal style variables is a bit
568 ;; awkward. It's at least the most compatible way with the old
569 ;; style init procedure.)
570 (c-set-style style (not (or c-old-style-variable-behavior
571 (and (not c-style-variables-are-local-p)
573 (not (string-equal c-indentation-style
575 (c-setup-paragraph-variables)
577 ;; we have to do something special for c-offsets-alist so that the
578 ;; buffer local value has its own alist structure.
579 (setq c-offsets-alist (copy-alist c-offsets-alist))
581 ;; setup the comment indent variable in a Emacs version portable way
582 (set (make-local-variable 'comment-indent-function) 'c-comment-indent)
584 ;; ;; Put submode indicators onto minor-mode-alist, but only once.
585 ;; (or (assq 'c-submode-indicators minor-mode-alist)
586 ;; (setq minor-mode-alist
587 ;; (cons '(c-submode-indicators c-submode-indicators)
588 ;; minor-mode-alist)))
591 ;; Install the functions that ensure that various internal caches
592 ;; don't become invalid due to buffer changes.
593 (when (featurep 'xemacs)
594 (make-local-hook 'before-change-functions)
595 (make-local-hook 'after-change-functions))
596 (add-hook 'before-change-functions 'c-before-change nil t)
597 (add-hook 'after-change-functions 'c-after-change nil t)
598 (set (make-local-variable 'font-lock-extend-after-change-region-function)
599 'c-extend-after-change-region)) ; Currently (2009-05) used by all
600 ; lanaguages with #define (C, C++,; ObjC), and by AWK.
602 (defun c-setup-doc-comment-style ()
603 "Initialize the variables that depend on the value of `c-doc-comment-style'."
604 (when (and (featurep 'font-lock)
605 (symbol-value 'font-lock-mode))
606 ;; Force font lock mode to reinitialize itself.
610 ;; Buffer local variables defining the region to be fontified by a font lock
611 ;; after-change function. They are set in c-after-change to
612 ;; after-change-function's BEG and END, and may be modified by a
613 ;; `c-before-font-lock-function'.
615 (make-variable-buffer-local 'c-new-BEG)
617 (make-variable-buffer-local 'c-new-END)
619 (defun c-common-init (&optional mode)
620 "Common initialization for all CC Mode modes.
621 In addition to the work done by `c-basic-common-init' and
622 `c-font-lock-init', this function sets up various other things as
623 customary in CC Mode modes but which aren't strictly necessary for CC
624 Mode to operate correctly.
626 MODE is the symbol for the mode to initialize, like 'c-mode. See
627 `c-basic-common-init' for details. It's only optional to be
628 compatible with old code; callers should always specify it."
631 ;; Called from an old third party package. The fallback is to
633 (c-init-language-vars-for 'c-mode))
635 (c-basic-common-init mode c-default-style)
637 ;; Only initialize font locking if we aren't called from an old package.
640 ;; Starting a mode is a sort of "change". So call the change functions...
643 (setq c-new-BEG (point-min))
644 (setq c-new-END (point-max))
646 (if c-get-state-before-change-functions
648 (funcall fn (point-min) (point-max)))
649 c-get-state-before-change-functions))
650 (if c-before-font-lock-function
651 (funcall c-before-font-lock-function (point-min) (point-max)
652 (- (point-max) (point-min))))))
654 (set (make-local-variable 'outline-regexp) "[^#\n\^M]")
655 (set (make-local-variable 'outline-level) 'c-outline-level)
657 (let ((rfn (assq mode c-require-final-newline)))
660 (set (make-local-variable 'require-final-newline)
661 mode-require-final-newline)))))
663 (defun c-count-cfss (lv-alist)
664 ;; LV-ALIST is an alist like `file-local-variables-alist'. Count how many
665 ;; elements with the key `c-file-style' there are in it.
666 (let ((elt-ptr lv-alist) elt (cownt 0))
668 (setq elt (car elt-ptr)
669 elt-ptr (cdr elt-ptr))
670 (when (eq (car elt) 'c-file-style)
671 (setq cownt (1+ cownt))))
674 (defun c-before-hack-hook ()
675 "Set the CC Mode style and \"offsets\" when in the buffer's local variables.
676 They are set only when, respectively, the pseudo variables
677 `c-file-style' and `c-file-offsets' are present in the list.
679 This function is called from the hook `before-hack-local-variables-hook'."
680 (when c-buffer-is-cc-mode
681 (let ((mode-cons (assq 'mode file-local-variables-alist))
682 (stile (cdr (assq 'c-file-style file-local-variables-alist)))
683 (offsets (cdr (assq 'c-file-offsets file-local-variables-alist))))
685 (hack-one-local-variable (car mode-cons) (cdr mode-cons))
686 (setq file-local-variables-alist
687 (delq mode-cons file-local-variables-alist)))
689 (or (stringp stile) (error "c-file-style is not a string"))
690 (if (boundp 'dir-local-variables-alist)
691 ;; Determine whether `c-file-style' was set in the file's local
692 ;; variables or in a .dir-locals.el (a directory setting).
693 (let ((cfs-in-file-and-dir-count
694 (c-count-cfss file-local-variables-alist))
695 (cfs-in-dir-count (c-count-cfss dir-local-variables-alist)))
697 (= cfs-in-file-and-dir-count cfs-in-dir-count)))
698 (c-set-style stile)))
702 (let ((langelem (car langentry))
703 (offset (cdr langentry)))
704 (c-set-offset langelem offset)))
707 (defun c-remove-any-local-eval-or-mode-variables ()
708 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
709 ;; or on the first line, remove all occurrences. See
710 ;; `c-postprocess-file-styles' for justification. There is no need to save
711 ;; point here, or even bother too much about the buffer contents. However,
712 ;; DON'T mess up the kill-ring.
714 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
716 (goto-char (point-max))
717 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
718 (let (lv-point (prefix "") (suffix ""))
719 (when (let ((case-fold-search t))
720 (search-forward "Local Variables:" nil t))
721 (setq lv-point (point))
722 ;; The prefix is what comes before "local variables:" in its line.
723 ;; The suffix is what comes after "local variables:" in its line.
724 (skip-chars-forward " \t")
726 (setq suffix (buffer-substring (point)
727 (progn (end-of-line) (point)))))
728 (goto-char (match-beginning 0))
731 (buffer-substring (point)
732 (progn (beginning-of-line) (point)))))
734 (while (search-forward-regexp
736 (regexp-quote prefix)
737 "\\(mode\\|eval\\):.*"
738 (regexp-quote suffix)
742 (delete-region (point) (progn (forward-line) (point)))))
744 ;; Delete the first line, if we've got one, in case it contains a mode spec.
745 (unless (and lv-point
746 (progn (goto-char lv-point)
749 (goto-char (point-min))
751 (delete-region (point) (progn (forward-line) (point)))))))
753 (defun c-postprocess-file-styles ()
754 "Function that post processes relevant file local variables in CC Mode.
755 Currently, this function simply applies any style and offset settings
756 found in the file's Local Variable list. It first applies any style
757 setting found in `c-file-style', then it applies any offset settings
758 it finds in `c-file-offsets'.
760 Note that the style variables are always made local to the buffer."
762 ;; apply file styles and offsets
763 (when c-buffer-is-cc-mode
764 (if (or c-file-style c-file-offsets)
765 (c-make-styles-buffer-local t))
767 (or (stringp c-file-style)
768 (error "c-file-style is not a string"))
769 (c-set-style c-file-style))
774 (let ((langelem (car langentry))
775 (offset (cdr langentry)))
776 (c-set-offset langelem offset)))
778 ;; Problem: The file local variable block might have explicitly set a
779 ;; style variable. The `c-set-style' or `mapcar' call might have
780 ;; overwritten this. So we run `hack-local-variables' again to remedy
781 ;; this. There are no guarantees this will work properly, particularly as
782 ;; we have no control over what the other hook functions on
783 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
784 ;; any `eval' or `mode' expressions before we evaluate again (see below).
787 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
788 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
789 ;; We prevent this by temporarily removing `mode' from the Local Variables
791 (if (or c-file-style c-file-offsets)
792 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
793 (c-tentative-buffer-changes
794 (c-remove-any-local-eval-or-mode-variables)
795 (hack-local-variables))
798 (if (boundp 'before-hack-local-variables-hook)
799 (add-hook 'before-hack-local-variables-hook 'c-before-hack-hook)
800 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles))
802 (defmacro c-run-mode-hooks (&rest hooks)
803 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
804 ;; requires the use of the new function `run-mode-hooks'.
805 (if (cc-bytecomp-fboundp 'run-mode-hooks)
806 `(run-mode-hooks ,@hooks)
807 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
810 ;;; Change hooks, linking with Font Lock.
812 ;; Buffer local variables recording Beginning/End-of-Macro position before a
813 ;; change, when a macro straddles, respectively, the BEG or END (or both) of
814 ;; the change region. Otherwise these have the values BEG/END.
816 (make-variable-buffer-local 'c-old-BOM)
818 (make-variable-buffer-local 'c-old-EOM)
820 (defun c-extend-region-for-CPP (beg end)
821 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
822 ;; beginning/end of any preprocessor construct they may be in.
824 ;; Point is undefined both before and after this function call; the buffer
825 ;; has already been widened, and match-data saved. The return value is
828 ;; This function is in the C/C++/ObjC values of
829 ;; `c-get-state-before-change-functions' and is called exclusively as a
830 ;; before change function.
832 (c-beginning-of-macro)
833 (setq c-old-BOM (point))
836 (when (c-beginning-of-macro)
838 (or (eobp) (forward-char))) ; Over the terminating NL which may be marked
839 ; with a c-cpp-delimiter category property
840 (setq c-old-EOM (point)))
842 (defun c-neutralize-CPP-line (beg end)
843 ;; BEG and END bound a region, typically a preprocessor line. Put a
844 ;; "punctuation" syntax-table property on syntactically obtrusive
845 ;; characters, ones which would interact syntactically with stuff outside
848 ;; These are unmatched string delimiters, or unmatched
849 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
855 (setq s (parse-partial-sexp beg end -1))
857 ((< (nth 0 s) 0) ; found an unmated ),},]
858 (c-put-char-property (1- (point)) 'syntax-table '(1))
860 ((nth 3 s) ; In a string
861 (c-put-char-property (nth 8 s) 'syntax-table '(1))
863 ((> (nth 0 s) 0) ; In a (,{,[
864 (c-put-char-property (nth 1 s) 'syntax-table '(1))
868 (defun c-neutralize-syntax-in-and-mark-CPP (begg endd old-len)
869 ;; (i) Extend the font lock region to cover all changed preprocessor
870 ;; regions; it does this by setting the variables `c-new-BEG' and
871 ;; `c-new-END' to the new boundaries.
873 ;; (ii) "Neutralize" every preprocessor line wholly or partially in the
874 ;; extended changed region. "Restore" lines which were CPP lines before the
875 ;; change and are no longer so; these can be located from the Buffer local
876 ;; variables `c-old-BOM' and `c-old-EOM'.
878 ;; (iii) Mark every CPP construct by placing a `category' property value
879 ;; `c-cpp-delimiter' at its start and end. The marked characters are the
880 ;; opening # and usually the terminating EOL, but sometimes the character
881 ;; before a comment/string delimiter.
883 ;; That is, set syntax-table properties on characters that would otherwise
884 ;; interact syntactically with those outside the CPP line(s).
886 ;; This function is called from an after-change function, BEGG ENDD and
887 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
888 ;; locking, hence must get called before `font-lock-after-change-function'.
890 ;; Point is undefined both before and after this function call, the buffer
891 ;; has been widened, and match-data saved. The return value is ignored.
893 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
895 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
897 ;; This function might make hidden buffer changes.
898 (c-save-buffer-state (limits)
899 ;; First determine the region, (c-new-BEG c-new-END), which will get font
900 ;; locked. It might need "neutralizing". This region may not start
901 ;; inside a string, comment, or macro.
902 (goto-char c-old-BOM) ; already set to old start of macro or begg.
905 (if (setq limits (c-state-literal-at (point)))
906 (cdr limits) ; go forward out of any string or comment.
910 (if (setq limits (c-state-literal-at (point)))
911 (goto-char (car limits))) ; go backward out of any string or comment.
912 (if (c-beginning-of-macro)
914 (setq c-new-END (max c-new-END
915 (+ (- c-old-EOM old-len) (- endd begg))
918 ;; Clear all old relevant properties.
919 (c-clear-char-property-with-value c-new-BEG c-new-END 'syntax-table '(1))
920 (c-clear-char-property-with-value c-new-BEG c-new-END 'category 'c-cpp-delimiter)
921 ;; FIXME!!! What about the "<" and ">" category properties? 2009-11-16
923 ;; Add needed properties to each CPP construct in the region.
924 (goto-char c-new-BEG)
925 (let ((pps-position c-new-BEG) pps-state mbeg)
926 (while (and (< (point) c-new-END)
927 (search-forward-regexp c-anchored-cpp-prefix c-new-END t))
928 ;; If we've found a "#" inside a string/comment, ignore it.
930 (parse-partial-sexp pps-position (point) nil nil pps-state)
931 pps-position (point))
932 (unless (or (nth 3 pps-state) ; in a string?
933 (nth 4 pps-state)) ; in a comment?
934 (goto-char (match-beginning 0))
936 (if (> (c-syntactic-end-of-macro) mbeg)
938 (c-neutralize-CPP-line mbeg (point))
939 (c-set-cpp-delimiters mbeg (point))
940 ;(setq pps-position (point))
942 (forward-line)) ; no infinite loop with, e.g., "#//"
945 (defun c-before-change (beg end)
946 ;; Function to be put on `before-change-functions'. Primarily, this calls
947 ;; the language dependent `c-get-state-before-change-functions'. It is
948 ;; otherwise used only to remove stale entries from the `c-found-types'
949 ;; cache, and to record entries which a `c-after-change' function might
952 ;; Note that this function must be FAST rather than accurate. Note
953 ;; also that it only has any effect when font locking is enabled.
954 ;; We exploit this by checking for font-lock-*-face instead of doing
955 ;; rigourous syntactic analysis.
957 ;; If either change boundary is wholly inside an identifier, delete
958 ;; it/them from the cache. Don't worry about being inside a string
959 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
961 (setq c-maybe-stale-found-type nil)
966 ;; Are we inserting/deleting stuff in the middle of an identifier?
967 (c-unfind-enclosing-token beg)
968 (c-unfind-enclosing-token end)
969 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
971 (c-unfind-coalesced-tokens beg end))
972 ;; Are we (potentially) disrupting the syntactic context which
973 ;; makes a type a type? E.g. by inserting stuff after "foo" in
974 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
976 ;; We search for appropriate c-type properties "near" the change.
977 ;; First, find an appropriate boundary for this property search.
982 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
983 (previous-single-property-change end 'face))
985 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
986 ;; Find a limit for the search for a `c-type' property
988 (and (/= (skip-chars-backward "^;{}") 0)
989 (> (point) (point-min))
990 (memq (c-get-char-property (1- (point)) 'face)
991 '(font-lock-comment-face font-lock-string-face))))
992 (setq lim (max (point-min) (1- (point))))
994 ;; Look for the latest `c-type' property before end1
995 (when (and (> end1 (point-min))
997 (if (get-text-property (1- end1) 'c-type)
999 (previous-single-property-change end1 'c-type nil lim))))
1000 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
1002 (when (memq type '(c-decl-id-start c-decl-type-start))
1003 ;; Get the identifier, if any, that the property is on.
1004 (goto-char (1- type-pos))
1006 (when (looking-at "\\(\\sw\\|\\s_\\)")
1007 (c-beginning-of-current-token)
1008 (buffer-substring-no-properties (point) type-pos)))
1011 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
1014 (or (next-single-property-change end 'c-type nil lim) lim))
1015 (setq c-maybe-stale-found-type
1016 (list type marked-id
1018 (buffer-substring-no-properties type-pos term-pos)
1019 (buffer-substring-no-properties beg end)))))))
1021 (if c-get-state-before-change-functions
1023 (funcall fn beg end))
1024 c-get-state-before-change-functions))
1027 (defun c-after-change (beg end old-len)
1028 ;; Function put on `after-change-functions' to adjust various caches
1029 ;; etc. Prefer speed to finesse here, since there will be an order
1030 ;; of magnitude more calls to this function than any of the
1031 ;; functions that use the caches.
1033 ;; Note that care must be taken so that this is called before any
1034 ;; font-lock callbacks since we might get calls to functions using
1035 ;; these caches from inside them, and we must thus be sure that this
1036 ;; has already been executed.
1038 ;; This calls the language variable c-before-font-lock-function, if non nil.
1039 ;; This typically sets `syntax-table' properties.
1041 (c-save-buffer-state ()
1042 ;; When `combine-after-change-calls' is used we might get calls
1043 ;; with regions outside the current narrowing. This has been
1044 ;; observed in Emacs 20.7.
1046 (save-match-data ; c-recognize-<>-arglists changes match-data
1049 (when (> end (point-max))
1050 ;; Some emacsen might return positions past the end. This has been
1051 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1052 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1054 (setq end (point-max))
1058 ;; C-y is capable of spuriously converting category properties
1059 ;; c-</>-as-paren-syntax into hard syntax-table properties. Remove
1060 ;; these when it happens.
1061 (c-clear-char-property-with-value beg end 'syntax-table
1062 c-<-as-paren-syntax)
1063 (c-clear-char-property-with-value beg end 'syntax-table
1064 c->-as-paren-syntax)
1066 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1067 (c-invalidate-sws-region-after beg end)
1068 (c-invalidate-state-cache beg)
1069 (c-invalidate-find-decl-cache beg)
1071 (when c-recognize-<>-arglists
1072 (c-after-change-check-<>-operators beg end))
1074 ;; (c-new-BEG c-new-END) will be the region to fontify. It may become
1075 ;; larger than (beg end).
1078 (if c-before-font-lock-function
1080 (funcall c-before-font-lock-function beg end old-len)))))))
1082 (defun c-after-font-lock-init ()
1083 ;; Put on `font-lock-mode-hook'.
1084 (remove-hook 'after-change-functions 'c-after-change t)
1085 (add-hook 'after-change-functions 'c-after-change nil t))
1087 (defun c-font-lock-init ()
1088 "Set up the font-lock variables for using the font-lock support in CC Mode.
1089 This does not load the font-lock package. Use after
1090 `c-basic-common-init' and after cc-fonts has been loaded."
1092 (set (make-local-variable 'font-lock-defaults)
1093 `(,(if (c-major-mode-is 'awk-mode)
1094 ;; awk-mode currently has only one font lock level.
1095 'awk-font-lock-keywords
1096 (mapcar 'c-mode-symbol
1097 '("font-lock-keywords" "font-lock-keywords-1"
1098 "font-lock-keywords-2" "font-lock-keywords-3")))
1100 ,c-identifier-syntax-modifications
1101 c-beginning-of-syntax
1102 (font-lock-mark-block-function
1103 . c-mark-function)))
1104 (if (featurep 'xemacs)
1105 (make-local-hook 'font-lock-mode-hook))
1106 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1108 (defun c-extend-after-change-region (beg end old-len)
1109 "Extend the region to be fontified, if necessary."
1110 ;; Note: the parameters are ignored here. This somewhat indirect
1111 ;; implementation exists because it is minimally different from the
1112 ;; stand-alone CC Mode which, lacking
1113 ;; font-lock-extend-after-change-region-function, is forced to use advice
1116 ;; Of the seven CC Mode languages, currently (2009-05) only C, C++, Objc
1117 ;; (the languages with #define) and AWK Mode make non-null use of this
1119 (cons c-new-BEG c-new-END))
1125 (defvar c-mode-syntax-table nil
1126 "Syntax table used in c-mode buffers.")
1127 (or c-mode-syntax-table
1128 (setq c-mode-syntax-table
1129 (funcall (c-lang-const c-make-mode-syntax-table c))))
1131 (defvar c-mode-abbrev-table nil
1132 "Abbreviation table used in c-mode buffers.")
1133 (c-define-abbrev-table 'c-mode-abbrev-table
1134 '(("else" "else" c-electric-continued-statement 0)
1135 ("while" "while" c-electric-continued-statement 0)))
1137 (defvar c-mode-map ()
1138 "Keymap used in c-mode buffers.")
1141 (setq c-mode-map (c-make-inherited-keymap))
1142 ;; add bindings which are only useful for C
1143 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1146 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
1147 (cons "C" (c-lang-const c-mode-menu c)))
1149 ;; In XEmacs >= 21.5 modes should add their own entries to
1150 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
1151 ;; doing this on load. That since `add-to-list' prepends the value
1152 ;; which could cause it to clobber user settings. Later emacsen have
1153 ;; an append option, but it's not safe to use.
1155 ;; The extension ".C" is associated with C++ while the lowercase
1156 ;; variant goes with C. On case insensitive file systems, this means
1157 ;; that ".c" files also might open C++ mode if the C++ entry comes
1158 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1159 ;; after ".c", and since `add-to-list' adds the entry first we have to
1160 ;; add the ".C" entry first.
1161 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1162 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1163 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1165 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1167 ;; NB: The following two associate yacc and lex files to C Mode, which
1168 ;; is not really suitable for those formats. Anyway, afaik there's
1169 ;; currently no better mode for them, and besides this is legacy.
1170 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1171 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1173 ;; Preprocessed files generated by C and C++ compilers.
1174 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1175 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1180 "Major mode for editing K&R and ANSI C code.
1181 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1182 c-mode buffer. This automatically sets up a mail buffer with version
1183 information already added. You just need to add a description of the
1184 problem, including a reproducible test case, and send the message.
1186 To see what version of CC Mode you are running, enter `\\[c-version]'.
1188 The hook `c-mode-common-hook' is run with no args at mode
1189 initialization, then `c-mode-hook'.
1194 (kill-all-local-variables)
1195 (c-initialize-cc-mode t)
1196 (set-syntax-table c-mode-syntax-table)
1197 (setq major-mode 'c-mode ; FIXME: Use define-derived-mode.
1199 local-abbrev-table c-mode-abbrev-table
1201 (use-local-map c-mode-map)
1202 (c-init-language-vars-for 'c-mode)
1203 (c-common-init 'c-mode)
1204 (easy-menu-add c-c-menu)
1205 (cc-imenu-init cc-imenu-c-generic-expression)
1206 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
1207 (c-update-modeline))
1213 (defvar c++-mode-syntax-table nil
1214 "Syntax table used in c++-mode buffers.")
1215 (or c++-mode-syntax-table
1216 (setq c++-mode-syntax-table
1217 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1219 (defvar c++-mode-abbrev-table nil
1220 "Abbreviation table used in c++-mode buffers.")
1221 (c-define-abbrev-table 'c++-mode-abbrev-table
1222 '(("else" "else" c-electric-continued-statement 0)
1223 ("while" "while" c-electric-continued-statement 0)
1224 ("catch" "catch" c-electric-continued-statement 0)))
1226 (defvar c++-mode-map ()
1227 "Keymap used in c++-mode buffers.")
1230 (setq c++-mode-map (c-make-inherited-keymap))
1231 ;; add bindings which are only useful for C++
1232 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1233 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1234 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1235 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1237 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
1238 (cons "C++" (c-lang-const c-mode-menu c++)))
1242 "Major mode for editing C++ code.
1243 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1244 c++-mode buffer. This automatically sets up a mail buffer with
1245 version information already added. You just need to add a description
1246 of the problem, including a reproducible test case, and send the
1249 To see what version of CC Mode you are running, enter `\\[c-version]'.
1251 The hook `c-mode-common-hook' is run with no args at mode
1252 initialization, then `c++-mode-hook'.
1257 (kill-all-local-variables)
1258 (c-initialize-cc-mode t)
1259 (set-syntax-table c++-mode-syntax-table)
1260 (setq major-mode 'c++-mode ; FIXME: Use define-derived-mode.
1262 local-abbrev-table c++-mode-abbrev-table
1264 (use-local-map c++-mode-map)
1265 (c-init-language-vars-for 'c++-mode)
1266 (c-common-init 'c++-mode)
1267 (easy-menu-add c-c++-menu)
1268 (cc-imenu-init cc-imenu-c++-generic-expression)
1269 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
1270 (c-update-modeline))
1273 ;; Support for Objective-C
1276 (defvar objc-mode-syntax-table nil
1277 "Syntax table used in objc-mode buffers.")
1278 (or objc-mode-syntax-table
1279 (setq objc-mode-syntax-table
1280 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1282 (defvar objc-mode-abbrev-table nil
1283 "Abbreviation table used in objc-mode buffers.")
1284 (c-define-abbrev-table 'objc-mode-abbrev-table
1285 '(("else" "else" c-electric-continued-statement 0)
1286 ("while" "while" c-electric-continued-statement 0)))
1288 (defvar objc-mode-map ()
1289 "Keymap used in objc-mode buffers.")
1292 (setq objc-mode-map (c-make-inherited-keymap))
1293 ;; add bindings which are only useful for Objective-C
1294 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1296 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
1297 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1299 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
1303 "Major mode for editing Objective C code.
1304 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1305 objc-mode buffer. This automatically sets up a mail buffer with
1306 version information already added. You just need to add a description
1307 of the problem, including a reproducible test case, and send the
1310 To see what version of CC Mode you are running, enter `\\[c-version]'.
1312 The hook `c-mode-common-hook' is run with no args at mode
1313 initialization, then `objc-mode-hook'.
1318 (kill-all-local-variables)
1319 (c-initialize-cc-mode t)
1320 (set-syntax-table objc-mode-syntax-table)
1321 (setq major-mode 'objc-mode ; FIXME: Use define-derived-mode.
1323 local-abbrev-table objc-mode-abbrev-table
1325 (use-local-map objc-mode-map)
1326 (c-init-language-vars-for 'objc-mode)
1327 (c-common-init 'objc-mode)
1328 (easy-menu-add c-objc-menu)
1329 (cc-imenu-init nil 'cc-imenu-objc-function)
1330 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
1331 (c-update-modeline))
1337 (defvar java-mode-syntax-table nil
1338 "Syntax table used in java-mode buffers.")
1339 (or java-mode-syntax-table
1340 (setq java-mode-syntax-table
1341 (funcall (c-lang-const c-make-mode-syntax-table java))))
1343 (defvar java-mode-abbrev-table nil
1344 "Abbreviation table used in java-mode buffers.")
1345 (c-define-abbrev-table 'java-mode-abbrev-table
1346 '(("else" "else" c-electric-continued-statement 0)
1347 ("while" "while" c-electric-continued-statement 0)
1348 ("catch" "catch" c-electric-continued-statement 0)
1349 ("finally" "finally" c-electric-continued-statement 0)))
1351 (defvar java-mode-map ()
1352 "Keymap used in java-mode buffers.")
1355 (setq java-mode-map (c-make-inherited-keymap))
1356 ;; add bindings which are only useful for Java
1359 ;; Regexp trying to describe the beginning of a Java top-level
1360 ;; definition. This is not used by CC Mode, nor is it maintained
1361 ;; since it's practically impossible to write a regexp that reliably
1362 ;; matches such a construct. Other tools are necessary.
1363 (defconst c-Java-defun-prompt-regexp
1364 "^[ \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-*")
1366 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
1367 (cons "Java" (c-lang-const c-mode-menu java)))
1369 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
1373 "Major mode for editing Java code.
1374 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1375 java-mode buffer. This automatically sets up a mail buffer with
1376 version information already added. You just need to add a description
1377 of the problem, including a reproducible test case, and send the
1380 To see what version of CC Mode you are running, enter `\\[c-version]'.
1382 The hook `c-mode-common-hook' is run with no args at mode
1383 initialization, then `java-mode-hook'.
1388 (kill-all-local-variables)
1389 (c-initialize-cc-mode t)
1390 (set-syntax-table java-mode-syntax-table)
1391 (setq major-mode 'java-mode ; FIXME: Use define-derived-mode.
1393 local-abbrev-table java-mode-abbrev-table
1395 (use-local-map java-mode-map)
1396 (c-init-language-vars-for 'java-mode)
1397 (c-common-init 'java-mode)
1398 (easy-menu-add c-java-menu)
1399 (cc-imenu-init cc-imenu-java-generic-expression)
1400 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
1401 (c-update-modeline))
1404 ;; Support for CORBA's IDL language
1407 (defvar idl-mode-syntax-table nil
1408 "Syntax table used in idl-mode buffers.")
1409 (or idl-mode-syntax-table
1410 (setq idl-mode-syntax-table
1411 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1413 (defvar idl-mode-abbrev-table nil
1414 "Abbreviation table used in idl-mode buffers.")
1415 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
1417 (defvar idl-mode-map ()
1418 "Keymap used in idl-mode buffers.")
1421 (setq idl-mode-map (c-make-inherited-keymap))
1422 ;; add bindings which are only useful for IDL
1425 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
1426 (cons "IDL" (c-lang-const c-mode-menu idl)))
1428 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
1432 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
1433 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1434 idl-mode buffer. This automatically sets up a mail buffer with
1435 version information already added. You just need to add a description
1436 of the problem, including a reproducible test case, and send the
1439 To see what version of CC Mode you are running, enter `\\[c-version]'.
1441 The hook `c-mode-common-hook' is run with no args at mode
1442 initialization, then `idl-mode-hook'.
1447 (kill-all-local-variables)
1448 (c-initialize-cc-mode t)
1449 (set-syntax-table idl-mode-syntax-table)
1450 (setq major-mode 'idl-mode ; FIXME: Use define-derived-mode.
1452 local-abbrev-table idl-mode-abbrev-table)
1453 (use-local-map idl-mode-map)
1454 (c-init-language-vars-for 'idl-mode)
1455 (c-common-init 'idl-mode)
1456 (easy-menu-add c-idl-menu)
1457 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
1458 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
1459 (c-update-modeline))
1465 (defvar pike-mode-syntax-table nil
1466 "Syntax table used in pike-mode buffers.")
1467 (or pike-mode-syntax-table
1468 (setq pike-mode-syntax-table
1469 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1471 (defvar pike-mode-abbrev-table nil
1472 "Abbreviation table used in pike-mode buffers.")
1473 (c-define-abbrev-table 'pike-mode-abbrev-table
1474 '(("else" "else" c-electric-continued-statement 0)
1475 ("while" "while" c-electric-continued-statement 0)))
1477 (defvar pike-mode-map ()
1478 "Keymap used in pike-mode buffers.")
1481 (setq pike-mode-map (c-make-inherited-keymap))
1482 ;; additional bindings
1483 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1485 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
1486 (cons "Pike" (c-lang-const c-mode-menu pike)))
1488 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1489 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
1493 "Major mode for editing Pike code.
1494 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1495 pike-mode buffer. This automatically sets up a mail buffer with
1496 version information already added. You just need to add a description
1497 of the problem, including a reproducible test case, and send the
1500 To see what version of CC Mode you are running, enter `\\[c-version]'.
1502 The hook `c-mode-common-hook' is run with no args at mode
1503 initialization, then `pike-mode-hook'.
1508 (kill-all-local-variables)
1509 (c-initialize-cc-mode t)
1510 (set-syntax-table pike-mode-syntax-table)
1511 (setq major-mode 'pike-mode ; FIXME: Use define-derived-mode.
1513 local-abbrev-table pike-mode-abbrev-table
1515 (use-local-map pike-mode-map)
1516 (c-init-language-vars-for 'pike-mode)
1517 (c-common-init 'pike-mode)
1518 (easy-menu-add c-pike-menu)
1519 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
1520 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
1521 (c-update-modeline))
1526 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1527 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1528 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1529 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1530 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
1532 ;;; Autoload directives must be on the top level, so we construct an
1533 ;;; autoload form instead.
1534 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1536 (defvar awk-mode-abbrev-table nil
1537 "Abbreviation table used in awk-mode buffers.")
1538 (c-define-abbrev-table 'awk-mode-abbrev-table
1539 '(("else" "else" c-electric-continued-statement 0)
1540 ("while" "while" c-electric-continued-statement 0)))
1542 (defvar awk-mode-map ()
1543 "Keymap used in awk-mode buffers.")
1546 (setq awk-mode-map (c-make-inherited-keymap))
1547 ;; add bindings which are only useful for awk.
1548 (define-key awk-mode-map "#" 'self-insert-command)
1549 (define-key awk-mode-map "/" 'self-insert-command)
1550 (define-key awk-mode-map "*" 'self-insert-command)
1551 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1552 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1553 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1554 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1555 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1556 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1557 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1559 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1560 (cons "AWK" (c-lang-const c-mode-menu awk)))
1562 ;; (require 'cc-awk) brings these in.
1563 (defvar awk-mode-syntax-table)
1564 (declare-function c-awk-unstick-NL-prop "cc-awk" ())
1567 "Major mode for editing AWK code.
1568 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1569 awk-mode buffer. This automatically sets up a mail buffer with version
1570 information already added. You just need to add a description of the
1571 problem, including a reproducible test case, and send the message.
1573 To see what version of CC Mode you are running, enter `\\[c-version]'.
1575 The hook `c-mode-common-hook' is run with no args at mode
1576 initialization, then `awk-mode-hook'.
1581 (require 'cc-awk) ; Added 2003/6/10.
1582 (kill-all-local-variables)
1583 (c-initialize-cc-mode t)
1584 (set-syntax-table awk-mode-syntax-table)
1585 (setq major-mode 'awk-mode ; FIXME: Use define-derived-mode.
1587 local-abbrev-table awk-mode-abbrev-table
1589 (use-local-map awk-mode-map)
1590 (c-init-language-vars-for 'awk-mode)
1591 (c-common-init 'awk-mode)
1592 (c-awk-unstick-NL-prop)
1594 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1595 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1596 (defalias 'c-in-literal 'c-slow-in-literal)
1598 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1599 (c-update-modeline))
1604 (defconst c-mode-help-address
1605 "bug-cc-mode@gnu.org"
1606 "Address(es) for CC Mode bug reports.")
1609 "Echo the current version of CC Mode in the minibuffer."
1611 (message "Using CC Mode version %s" c-version)
1612 (c-keep-region-active))
1614 (defvar c-prepare-bug-report-hooks nil)
1616 ;; Dynamic variables used by reporter.
1617 (defvar reporter-prompt-for-summary-p)
1618 (defvar reporter-dont-compact-list)
1620 (defun c-submit-bug-report ()
1621 "Submit via mail a bug report on CC Mode."
1625 (let ((reporter-prompt-for-summary-p t)
1626 (reporter-dont-compact-list '(c-offsets-alist))
1627 (style c-indentation-style)
1628 (c-features c-emacs-features))
1630 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1632 (reporter-submit-bug-report
1634 (concat "CC Mode " c-version " (" mode-name ")")
1637 '(c-buffer-is-cc-mode
1639 c-syntactic-indentation
1640 c-syntactic-indentation-in-macros
1642 c-auto-align-backslashes
1643 c-backspace-function
1645 c-electric-pound-behavior
1647 c-enable-xemacs-performance-kludge-p
1648 c-old-style-variable-behavior
1652 parse-sexp-ignore-comments
1653 parse-sexp-lookup-properties
1654 lookup-syntax-properties
1655 ;; A brain-damaged XEmacs only variable that, if
1656 ;; set to nil can cause all kinds of chaos.
1657 signal-error-on-buffer-boundary
1658 ;; Variables that affect line breaking and comments.
1668 adaptive-fill-regexp)
1670 (mapc (lambda (var) (unless (boundp var)
1671 (setq vars (delq var vars))))
1672 '(signal-error-on-buffer-boundary
1676 font-lock-maximum-decoration
1677 parse-sexp-lookup-properties
1678 lookup-syntax-properties))
1681 (run-hooks 'c-prepare-bug-report-hooks)
1682 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1683 style c-features)))))))
1686 (cc-provide 'cc-mode)
1688 ;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
1689 ;;; cc-mode.el ends here