* ftfont.c (ftfont_match): Initialize entity variable.
[emacs.git] / lisp / progmodes / cc-mode.el
blob044d8542bfe70e87fa6ddb61c92ab283eb16f355
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
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
10 ;; 1987 Dave Detlefs and Stewart Clamen
11 ;; 1985 Richard M. Stallman
12 ;; Maintainer: bug-cc-mode@gnu.org
13 ;; Created: a long, long, time ago. adapted from the original c-mode.el
14 ;; Keywords: c languages oop
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 ;;; Commentary:
33 ;; 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
51 ;; cplus-md1.el..
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
71 ;; visiting
73 ;; http://lists.sourceforge.net/mailman/listinfo/cc-mode-announce
75 ;;; Code:
77 ;; For Emacs < 22.2.
78 (eval-and-compile
79 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
81 (eval-when-compile
82 (let ((load-path
83 (if (and (boundp 'byte-compile-dest-file)
84 (stringp byte-compile-dest-file))
85 (cons (file-name-directory byte-compile-dest-file) load-path)
86 load-path)))
87 (load "cc-bytecomp" nil t)))
89 (cc-require 'cc-defs)
90 (cc-require-when-compile 'cc-langs)
91 (cc-require 'cc-vars)
92 (cc-require 'cc-engine)
93 (cc-require 'cc-styles)
94 (cc-require 'cc-cmds)
95 (cc-require 'cc-align)
96 (cc-require 'cc-menus)
98 ;; Silence the compiler.
99 (cc-bytecomp-defvar adaptive-fill-first-line-regexp) ; Emacs
100 (cc-bytecomp-defun set-keymap-parents) ; XEmacs
101 (cc-bytecomp-defun run-mode-hooks) ; Emacs 21.1
102 (cc-bytecomp-obsolete-fun make-local-hook) ; Marked obsolete in Emacs 21.1.
104 ;; We set these variables during mode init, yet we don't require
105 ;; font-lock.
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 'c-subword-mode "cc-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
132 ;; use:
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))))
174 ;;;###autoload
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)
186 c-initialization-ok)
187 (unless (get 'c-initialize-cc-mode initprop)
188 (unwind-protect
189 (progn
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)))
206 ;;; Common routines.
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.
216 (cond
217 ;; Emacs
218 ((cc-bytecomp-fboundp 'set-keymap-parent)
219 (set-keymap-parent map c-mode-base-map))
220 ;; XEmacs
221 ((cc-bytecomp-fboundp 'set-keymap-parents)
222 (set-keymap-parents map c-mode-base-map))
223 ;; incompatible
224 (t (error "CC Mode is incompatible with this version of Emacs")))
225 map))
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)))))
234 (while defs
235 (condition-case nil
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
246 (progn
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)))
256 (if c-mode-base-map
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
269 'c-end-of-statement
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
276 ;; here?
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
338 ;; as appropriate.
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" 'c-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
390 instead of \"C\".
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
414 ;; more.
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
419 ;; id, else nil.
420 (save-excursion
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))
427 t))))
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
433 ;; be present.
434 (or (c-partial-ws-p beg end)
435 (save-excursion
436 (progn
437 (goto-char beg)
438 (or (eq beg (point-min))
439 (c-skip-ws-backward (1- beg))
440 (/= (point) beg)
441 (= (c-backward-token-2) 1)
442 (c-unfind-type (buffer-substring-no-properties
443 (point) beg)))
444 (goto-char end)
445 (or (eq end (point-max))
446 (c-skip-ws-forward (1+ end))
447 (/= (point) end)
448 (progn (forward-char) (c-end-of-current-token) nil)
449 (c-unfind-type (buffer-substring-no-properties
450 end (point))))))))
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
459 ;; pos 96.
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 'parse-sexp-ignore-comments)
491 (make-local-variable 'indent-line-function)
492 (make-local-variable 'indent-region-function)
493 (make-local-variable 'normal-auto-fill-function)
494 (make-local-variable 'comment-start)
495 (make-local-variable 'comment-end)
496 (make-local-variable 'comment-start-skip)
497 (make-local-variable 'comment-multi-line)
498 (make-local-variable 'comment-line-break-function)
499 (make-local-variable 'paragraph-start)
500 (make-local-variable 'paragraph-separate)
501 (make-local-variable 'paragraph-ignore-fill-prefix)
502 (make-local-variable 'adaptive-fill-mode)
503 (make-local-variable 'adaptive-fill-regexp)
505 ;; now set their values
506 (setq parse-sexp-ignore-comments t
507 indent-line-function 'c-indent-line
508 indent-region-function 'c-indent-region
509 normal-auto-fill-function 'c-do-auto-fill
510 comment-multi-line t
511 comment-line-break-function 'c-indent-new-comment-line)
513 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
514 ;; direct call to `fill-paragraph' behaves better. This still
515 ;; doesn't work with filladapt but it's better than nothing.
516 (make-local-variable 'fill-paragraph-function)
517 (setq fill-paragraph-function 'c-fill-paragraph)
519 (when (or c-recognize-<>-arglists
520 (c-major-mode-is 'awk-mode)
521 (c-major-mode-is '(c-mode c++-mode objc-mode)))
522 ;; We'll use the syntax-table text property to change the syntax
523 ;; of some chars for this language, so do the necessary setup for
524 ;; that.
526 ;; Note to other package developers: It's ok to turn this on in CC
527 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
528 ;; off if CC Mode has turned it on.
530 ;; Emacs.
531 (when (boundp 'parse-sexp-lookup-properties)
532 (make-local-variable 'parse-sexp-lookup-properties)
533 (setq parse-sexp-lookup-properties t))
535 ;; Same as above for XEmacs.
536 (when (boundp 'lookup-syntax-properties)
537 (make-local-variable 'lookup-syntax-properties)
538 (setq lookup-syntax-properties t)))
540 ;; Use this in Emacs 21 to avoid meddling with the rear-nonsticky
541 ;; property on each character.
542 (when (boundp 'text-property-default-nonsticky)
543 (make-local-variable 'text-property-default-nonsticky)
544 (let ((elem (assq 'syntax-table text-property-default-nonsticky)))
545 (if elem
546 (setcdr elem t)
547 (setq text-property-default-nonsticky
548 (cons '(syntax-table . t)
549 text-property-default-nonsticky))))
550 (setq text-property-default-nonsticky
551 (cons '(c-type . t)
552 text-property-default-nonsticky)))
554 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
555 ;; heuristic that open parens in column 0 are defun starters. Since
556 ;; we have c-state-cache, that heuristic isn't useful and only causes
557 ;; trouble, so turn it off.
558 ;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
559 ;; helpful. Comment it out for now.
560 ;; (when (memq 'col-0-paren c-emacs-features)
561 ;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
562 ;; (setq open-paren-in-column-0-is-defun-start nil))
564 (c-clear-found-types)
566 ;; now set the mode style based on default-style
567 (let ((style (if (stringp default-style)
568 default-style
569 (or (cdr (assq mode default-style))
570 (cdr (assq 'other default-style))
571 "gnu"))))
572 ;; Override style variables if `c-old-style-variable-behavior' is
573 ;; set. Also override if we are using global style variables,
574 ;; have already initialized a style once, and are switching to a
575 ;; different style. (It's doubtful whether this is desirable, but
576 ;; the whole situation with nonlocal style variables is a bit
577 ;; awkward. It's at least the most compatible way with the old
578 ;; style init procedure.)
579 (c-set-style style (not (or c-old-style-variable-behavior
580 (and (not c-style-variables-are-local-p)
581 c-indentation-style
582 (not (string-equal c-indentation-style
583 style)))))))
584 (c-setup-paragraph-variables)
586 ;; we have to do something special for c-offsets-alist so that the
587 ;; buffer local value has its own alist structure.
588 (setq c-offsets-alist (copy-alist c-offsets-alist))
590 ;; setup the comment indent variable in a Emacs version portable way
591 (make-local-variable 'comment-indent-function)
592 (setq comment-indent-function 'c-comment-indent)
594 ;; ;; Put submode indicators onto minor-mode-alist, but only once.
595 ;; (or (assq 'c-submode-indicators minor-mode-alist)
596 ;; (setq minor-mode-alist
597 ;; (cons '(c-submode-indicators c-submode-indicators)
598 ;; minor-mode-alist)))
599 (c-update-modeline)
601 ;; Install the functions that ensure that various internal caches
602 ;; don't become invalid due to buffer changes.
603 (make-local-hook 'before-change-functions)
604 (add-hook 'before-change-functions 'c-before-change nil t)
605 (make-local-hook 'after-change-functions)
606 (add-hook 'after-change-functions 'c-after-change nil t)
607 (set (make-local-variable 'font-lock-extend-after-change-region-function)
608 'c-extend-after-change-region)) ; Currently (2008-04), only used by AWK.
610 (defun c-setup-doc-comment-style ()
611 "Initialize the variables that depend on the value of `c-doc-comment-style'."
612 (when (and (featurep 'font-lock)
613 (symbol-value 'font-lock-mode))
614 ;; Force font lock mode to reinitialize itself.
615 (font-lock-mode 0)
616 (font-lock-mode 1)))
618 (defun c-common-init (&optional mode)
619 "Common initialization for all CC Mode modes.
620 In addition to the work done by `c-basic-common-init' and
621 `c-font-lock-init', this function sets up various other things as
622 customary in CC Mode modes but which aren't strictly necessary for CC
623 Mode to operate correctly.
625 MODE is the symbol for the mode to initialize, like 'c-mode. See
626 `c-basic-common-init' for details. It's only optional to be
627 compatible with old code; callers should always specify it."
629 (unless mode
630 ;; Called from an old third party package. The fallback is to
631 ;; initialize for C.
632 (c-init-language-vars-for 'c-mode))
634 (c-basic-common-init mode c-default-style)
635 (when mode
636 ;; Only initialize font locking if we aren't called from an old package.
637 (c-font-lock-init))
639 ;; Starting a mode is a sort of "change". So call the change functions...
640 (save-restriction
641 (widen)
642 (save-excursion
643 (if c-get-state-before-change-function
644 (funcall c-get-state-before-change-function (point-min) (point-max)))
645 (if c-before-font-lock-function
646 (funcall c-before-font-lock-function (point-min) (point-max)
647 (- (point-max) (point-min))))))
649 (make-local-variable 'outline-regexp)
650 (make-local-variable 'outline-level)
651 (setq outline-regexp "[^#\n\^M]"
652 outline-level 'c-outline-level)
654 (let ((rfn (assq mode c-require-final-newline)))
655 (when rfn
656 (make-local-variable 'require-final-newline)
657 (and (cdr rfn)
658 (setq require-final-newline mode-require-final-newline)))))
660 (defun c-before-hack-hook ()
661 "Set the CC Mode style and \"offsets\" when in the buffer's local variables.
662 They are set only when, respectively, the pseudo variables
663 `c-file-style' and `c-file-offsets' are present in the list.
665 This function is called from the hook `before-hack-local-variables-hook'."
666 (when c-buffer-is-cc-mode
667 (let ((stile (cdr (assq 'c-file-style file-local-variables-alist)))
668 (offsets (cdr (assq 'c-file-offsets file-local-variables-alist))))
669 (when stile
670 (or (stringp stile) (error "c-file-style is not a string"))
671 (c-set-style stile))
672 (when offsets
673 (mapc
674 (lambda (langentry)
675 (let ((langelem (car langentry))
676 (offset (cdr langentry)))
677 (c-set-offset langelem offset)))
678 offsets)))))
680 (defun c-remove-any-local-eval-or-mode-variables ()
681 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
682 ;; or on the first line, remove all occurrences. See
683 ;; `c-postprocess-file-styles' for justification. There is no need to save
684 ;; point here, or even bother too much about the buffer contents. However,
685 ;; DON'T mess up the kill-ring.
687 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
688 ;; in files.el.
689 (goto-char (point-max))
690 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
691 (let (lv-point (prefix "") (suffix ""))
692 (when (let ((case-fold-search t))
693 (search-forward "Local Variables:" nil t))
694 (setq lv-point (point))
695 ;; The prefix is what comes before "local variables:" in its line.
696 ;; The suffix is what comes after "local variables:" in its line.
697 (skip-chars-forward " \t")
698 (or (eolp)
699 (setq suffix (buffer-substring (point)
700 (progn (end-of-line) (point)))))
701 (goto-char (match-beginning 0))
702 (or (bolp)
703 (setq prefix
704 (buffer-substring (point)
705 (progn (beginning-of-line) (point)))))
707 (while (search-forward-regexp
708 (concat "^[ \t]*"
709 (regexp-quote prefix)
710 "\\(mode\\|eval\\):.*"
711 (regexp-quote suffix)
712 "$")
713 nil t)
714 (forward-line 0)
715 (delete-region (point) (progn (forward-line) (point)))))
717 ;; Delete the first line, if we've got one, in case it contains a mode spec.
718 (unless (and lv-point
719 (progn (goto-char lv-point)
720 (forward-line 0)
721 (bobp)))
722 (goto-char (point-min))
723 (unless (eobp)
724 (delete-region (point) (progn (forward-line) (point)))))))
726 (defun c-postprocess-file-styles ()
727 "Function that post processes relevant file local variables in CC Mode.
728 Currently, this function simply applies any style and offset settings
729 found in the file's Local Variable list. It first applies any style
730 setting found in `c-file-style', then it applies any offset settings
731 it finds in `c-file-offsets'.
733 Note that the style variables are always made local to the buffer."
735 ;; apply file styles and offsets
736 (when c-buffer-is-cc-mode
737 (if (or c-file-style c-file-offsets)
738 (c-make-styles-buffer-local t))
739 (when c-file-style
740 (or (stringp c-file-style)
741 (error "c-file-style is not a string"))
742 (c-set-style c-file-style))
744 (and c-file-offsets
745 (mapc
746 (lambda (langentry)
747 (let ((langelem (car langentry))
748 (offset (cdr langentry)))
749 (c-set-offset langelem offset)))
750 c-file-offsets))
751 ;; Problem: The file local variable block might have explicitly set a
752 ;; style variable. The `c-set-style' or `mapcar' call might have
753 ;; overwritten this. So we run `hack-local-variables' again to remedy
754 ;; this. There are no guarantees this will work properly, particularly as
755 ;; we have no control over what the other hook functions on
756 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
757 ;; any `eval' or `mode' expressions before we evaluate again (see below).
758 ;; ACM, 2005/11/2.
760 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
761 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
762 ;; We prevent this by temporarily removing `mode' from the Local Variables
763 ;; section.
764 (if (or c-file-style c-file-offsets)
765 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
766 (c-tentative-buffer-changes
767 (c-remove-any-local-eval-or-mode-variables)
768 (hack-local-variables))
769 nil))))
771 (if (boundp 'before-hack-local-variables-hook)
772 (add-hook 'before-hack-local-variables-hook 'c-before-hack-hook)
773 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles))
775 (defmacro c-run-mode-hooks (&rest hooks)
776 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
777 ;; require the use of the new function `run-mode-hooks'.
778 (if (cc-bytecomp-fboundp 'run-mode-hooks)
779 `(run-mode-hooks ,@hooks)
780 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
783 ;;; Change hooks, linking with Font Lock.
785 ;; Buffer local variables defining the region to be fontified by a font lock
786 ;; after-change function. They are set in c-after-change to
787 ;; after-change-function's BEG and END, and may be modified by a
788 ;; `c-before-font-lock-function'.
789 (defvar c-new-BEG 0)
790 (make-variable-buffer-local 'c-new-BEG)
791 (defvar c-new-END 0)
792 (make-variable-buffer-local 'c-new-END)
794 ;; Buffer local variables recording Beginning/End-of-Macro position before a
795 ;; change, when a macro straddles, respectively, the BEG or END (or both) of
796 ;; the change region. Otherwise these have the values BEG/END.
797 (defvar c-old-BOM 0)
798 (make-variable-buffer-local 'c-old-BOM)
799 (defvar c-old-EOM 0)
800 (make-variable-buffer-local 'c-old-EOM)
802 (defun c-extend-region-for-CPP (beg end)
803 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
804 ;; beginning/end of any preprocessor construct they may be in.
806 ;; Point is undefined both before and after this function call; the buffer
807 ;; has already been widened, and match-data saved. The return value is
808 ;; meaningless.
810 ;; This function is the C/C++/ObjC value of
811 ;; `c-get-state-before-change-function' and is called exclusively as a
812 ;; before change function.
813 (goto-char beg)
814 (c-beginning-of-macro)
815 (setq c-old-BOM (point))
817 (goto-char end)
818 (if (c-beginning-of-macro)
819 (c-end-of-macro))
820 (setq c-old-EOM (point)))
822 (defun c-neutralize-CPP-line (beg end)
823 ;; BEG and END bound a region, typically a preprocessor line. Put a
824 ;; "punctuation" syntax-table property on syntactically obtrusive
825 ;; characters, ones which would interact syntactically with stuff outside
826 ;; this region.
828 ;; These are unmatched string delimiters, or unmatched
829 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
830 ;; obtrusive.
831 (save-excursion
832 (let (s)
833 (while
834 (progn
835 (setq s (parse-partial-sexp beg end -1))
836 (cond
837 ((< (nth 0 s) 0) ; found an unmated ),},]
838 (c-put-char-property (1- (point)) 'syntax-table '(1))
840 ((nth 3 s) ; In a string
841 (c-put-char-property (nth 8 s) 'syntax-table '(1))
843 ((> (nth 0 s) 0) ; In a (,{,[
844 (c-put-char-property (nth 1 s) 'syntax-table '(1))
846 (t nil)))))))
848 (defun c-neutralize-syntax-in-CPP (begg endd old-len)
849 ;; "Neutralize" every preprocessor line wholly or partially in the changed
850 ;; region. "Restore" lines which were CPP lines before the change and are
851 ;; no longer so; these can be located from the Buffer local variables
852 ;; c-old-[EB]OM.
854 ;; That is, set syntax-table properties on characters that would otherwise
855 ;; interact syntactically with those outside the CPP line(s).
857 ;; This function is called from an after-change function, BEGG ENDD and
858 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
859 ;; locking, hence must get called before `font-lock-after-change-function'.
861 ;; Point is undefined both before and after this function call, the buffer
862 ;; has been widened, and match-data saved. The return value is ignored.
864 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
866 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
868 ;; This function might make hidden buffer changes.
869 (c-save-buffer-state (limits mbeg+1 beg end)
870 ;; First determine the region, (beg end), which may need "neutralizing".
871 ;; This may not start inside a string, comment, or macro.
872 (goto-char c-old-BOM) ; already set to old start of macro or begg.
873 (setq beg
874 (if (setq limits (c-literal-limits))
875 (cdr limits) ; go forward out of any string or comment.
876 (point)))
878 (goto-char endd)
879 (if (setq limits (c-literal-limits))
880 (goto-char (car limits))) ; go backward out of any string or comment.
881 (if (c-beginning-of-macro)
882 (c-end-of-macro))
883 (setq end (max (+ (- c-old-EOM old-len) (- endd begg))
884 (point)))
886 ;; Clear all old punctuation properties
887 (c-clear-char-property-with-value beg end 'syntax-table '(1))
889 (goto-char beg)
890 (let ((pps-position beg) pps-state)
891 (while (and (< (point) end)
892 (search-forward-regexp c-anchored-cpp-prefix end t))
893 ;; If we've found a "#" inside a string/comment, ignore it.
894 (setq pps-state
895 (parse-partial-sexp pps-position (point) nil nil pps-state)
896 pps-position (point))
897 (unless (or (nth 3 pps-state) ; in a string?
898 (nth 4 pps-state)) ; in a comment?
899 (setq mbeg+1 (point))
900 (c-end-of-macro) ; Do we need to go forward 1 char here? No!
901 (c-neutralize-CPP-line mbeg+1 (point))
902 (setq pps-position (point))))))) ; no need to update pps-state.
904 (defun c-before-change (beg end)
905 ;; Function to be put on `before-change-function'. Primarily, this calls
906 ;; the language dependent `c-get-state-before-change-function'. It is
907 ;; otherwise used only to remove stale entries from the `c-found-types'
908 ;; cache, and to record entries which a `c-after-change' function might
909 ;; confirm as stale.
911 ;; Note that this function must be FAST rather than accurate. Note
912 ;; also that it only has any effect when font locking is enabled.
913 ;; We exploit this by checking for font-lock-*-face instead of doing
914 ;; rigourous syntactic analysis.
916 ;; If either change boundary is wholly inside an identifier, delete
917 ;; it/them from the cache. Don't worry about being inside a string
918 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
919 ;; isn't critical.
920 (setq c-maybe-stale-found-type nil)
921 (save-restriction
922 (save-match-data
923 (widen)
924 (save-excursion
925 ;; Are we inserting/deleting stuff in the middle of an identifier?
926 (c-unfind-enclosing-token beg)
927 (c-unfind-enclosing-token end)
928 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
929 (when (< beg end)
930 (c-unfind-coalesced-tokens beg end))
931 ;; Are we (potentially) disrupting the syntactic context which
932 ;; makes a type a type? E.g. by inserting stuff after "foo" in
933 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
935 ;; We search for appropriate c-type properties "near" the change.
936 ;; First, find an appropriate boundary for this property search.
937 (let (lim
938 type type-pos
939 marked-id term-pos
940 (end1
941 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
942 (previous-single-property-change end 'face))
943 end)))
944 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
945 ;; Find a limit for the search for a `c-type' property
946 (while
947 (and (/= (skip-chars-backward "^;{}") 0)
948 (> (point) (point-min))
949 (memq (c-get-char-property (1- (point)) 'face)
950 '(font-lock-comment-face font-lock-string-face))))
951 (setq lim (max (point-min) (1- (point))))
953 ;; Look for the latest `c-type' property before end1
954 (when (and (> end1 (point-min))
955 (setq type-pos
956 (if (get-text-property (1- end1) 'c-type)
957 end1
958 (previous-single-property-change end1 'c-type nil lim))))
959 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
961 (when (memq type '(c-decl-id-start c-decl-type-start))
962 ;; Get the identifier, if any, that the property is on.
963 (goto-char (1- type-pos))
964 (setq marked-id
965 (when (looking-at "\\(\\sw\\|\\s_\\)")
966 (c-beginning-of-current-token)
967 (buffer-substring-no-properties (point) type-pos)))
969 (goto-char end1)
970 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
971 (setq lim (point))
972 (setq term-pos
973 (or (next-single-property-change end 'c-type nil lim) lim))
974 (setq c-maybe-stale-found-type
975 (list type marked-id
976 type-pos term-pos
977 (buffer-substring-no-properties type-pos term-pos)
978 (buffer-substring-no-properties beg end)))))))
980 (setq c-new-BEG beg
981 c-new-END end)
982 (if c-get-state-before-change-function
983 (funcall c-get-state-before-change-function beg end))
984 ))))
986 (defun c-after-change (beg end old-len)
987 ;; Function put on `after-change-functions' to adjust various caches
988 ;; etc. Prefer speed to finesse here, since there will be an order
989 ;; of magnitude more calls to this function than any of the
990 ;; functions that use the caches.
992 ;; Note that care must be taken so that this is called before any
993 ;; font-lock callbacks since we might get calls to functions using
994 ;; these caches from inside them, and we must thus be sure that this
995 ;; has already been executed.
997 ;; This calls the language variable c-before-font-lock-function, if non nil.
998 ;; This typically sets `syntax-table' properties.
1000 (c-save-buffer-state ()
1001 ;; When `combine-after-change-calls' is used we might get calls
1002 ;; with regions outside the current narrowing. This has been
1003 ;; observed in Emacs 20.7.
1004 (save-restriction
1005 (save-match-data ; c-recognize-<>-arglists changes match-data
1006 (widen)
1008 (when (> end (point-max))
1009 ;; Some emacsen might return positions past the end. This has been
1010 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1011 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1012 ;; work).
1013 (setq end (point-max))
1014 (when (> beg end)
1015 (setq beg end)))
1017 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1018 (c-invalidate-sws-region-after beg end)
1019 (c-invalidate-state-cache beg)
1020 (c-invalidate-find-decl-cache beg)
1022 (when c-recognize-<>-arglists
1023 (c-after-change-check-<>-operators beg end))
1025 (if c-before-font-lock-function
1026 (save-excursion
1027 (funcall c-before-font-lock-function beg end old-len)))))))
1029 (defun c-after-font-lock-init ()
1030 ;; Put on `font-lock-mode-hook'.
1031 (remove-hook 'after-change-functions 'c-after-change t)
1032 (add-hook 'after-change-functions 'c-after-change nil t))
1034 (defun c-font-lock-init ()
1035 "Set up the font-lock variables for using the font-lock support in CC Mode.
1036 This does not load the font-lock package. Use after
1037 `c-basic-common-init' and after cc-fonts has been loaded."
1039 (make-local-variable 'font-lock-defaults)
1040 (setq font-lock-defaults
1041 `(,(if (c-major-mode-is 'awk-mode)
1042 ;; awk-mode currently has only one font lock level.
1043 'awk-font-lock-keywords
1044 (mapcar 'c-mode-symbol
1045 '("font-lock-keywords" "font-lock-keywords-1"
1046 "font-lock-keywords-2" "font-lock-keywords-3")))
1047 nil nil
1048 ,c-identifier-syntax-modifications
1049 c-beginning-of-syntax
1050 (font-lock-lines-before . 1)
1051 (font-lock-mark-block-function
1052 . c-mark-function)))
1054 (make-local-hook 'font-lock-mode-hook)
1055 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1057 (defun c-extend-after-change-region (beg end old-len)
1058 "Extend the region to be fontified, if necessary."
1059 ;; Note: the parameters are ignored here. This somewhat indirect
1060 ;; implementation exists because it is minimally different from the
1061 ;; stand-alone CC Mode which, lacking
1062 ;; font-lock-extend-after-change-region-function, is forced to use advice
1063 ;; instead.
1065 ;; Of the seven CC Mode languages, currently (2008-04) only AWK Mode makes
1066 ;; non-null use of this function.
1067 (cons c-new-BEG c-new-END))
1070 ;; Support for C
1072 ;;;###autoload
1073 (defvar c-mode-syntax-table nil
1074 "Syntax table used in c-mode buffers.")
1075 (or c-mode-syntax-table
1076 (setq c-mode-syntax-table
1077 (funcall (c-lang-const c-make-mode-syntax-table c))))
1079 (defvar c-mode-abbrev-table nil
1080 "Abbreviation table used in c-mode buffers.")
1081 (c-define-abbrev-table 'c-mode-abbrev-table
1082 '(("else" "else" c-electric-continued-statement 0)
1083 ("while" "while" c-electric-continued-statement 0)))
1085 (defvar c-mode-map ()
1086 "Keymap used in c-mode buffers.")
1087 (if c-mode-map
1089 (setq c-mode-map (c-make-inherited-keymap))
1090 ;; add bindings which are only useful for C
1091 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1094 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
1095 (cons "C" (c-lang-const c-mode-menu c)))
1097 ;; In XEmacs >= 21.5 modes should add their own entries to
1098 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
1099 ;; doing this on load. That since `add-to-list' prepends the value
1100 ;; which could cause it to clobber user settings. Later emacsen have
1101 ;; an append option, but it's not safe to use.
1103 ;; The the extension ".C" is associated to C++ while the lowercase
1104 ;; variant goes to C. On case insensitive file systems, this means
1105 ;; that ".c" files also might open C++ mode if the C++ entry comes
1106 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1107 ;; after ".c", and since `add-to-list' adds the entry first we have to
1108 ;; add the ".C" entry first.
1109 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1110 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1111 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1113 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1115 ;; NB: The following two associate yacc and lex files to C Mode, which
1116 ;; is not really suitable for those formats. Anyway, afaik there's
1117 ;; currently no better mode for them, and besides this is legacy.
1118 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1119 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1121 ;; Preprocessed files generated by C and C++ compilers.
1122 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1123 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1126 ;;;###autoload
1127 (defun c-mode ()
1128 "Major mode for editing K&R and ANSI C code.
1129 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1130 c-mode buffer. This automatically sets up a mail buffer with version
1131 information already added. You just need to add a description of the
1132 problem, including a reproducible test case, and send the message.
1134 To see what version of CC Mode you are running, enter `\\[c-version]'.
1136 The hook `c-mode-common-hook' is run with no args at mode
1137 initialization, then `c-mode-hook'.
1139 Key bindings:
1140 \\{c-mode-map}"
1141 (interactive)
1142 (kill-all-local-variables)
1143 (c-initialize-cc-mode t)
1144 (set-syntax-table c-mode-syntax-table)
1145 (setq major-mode 'c-mode
1146 mode-name "C"
1147 local-abbrev-table c-mode-abbrev-table
1148 abbrev-mode t)
1149 (use-local-map c-mode-map)
1150 (c-init-language-vars-for 'c-mode)
1151 (c-common-init 'c-mode)
1152 (easy-menu-add c-c-menu)
1153 (cc-imenu-init cc-imenu-c-generic-expression)
1154 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
1155 (c-update-modeline))
1158 ;; Support for C++
1160 ;;;###autoload
1161 (defvar c++-mode-syntax-table nil
1162 "Syntax table used in c++-mode buffers.")
1163 (or c++-mode-syntax-table
1164 (setq c++-mode-syntax-table
1165 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1167 (defvar c++-mode-abbrev-table nil
1168 "Abbreviation table used in c++-mode buffers.")
1169 (c-define-abbrev-table 'c++-mode-abbrev-table
1170 '(("else" "else" c-electric-continued-statement 0)
1171 ("while" "while" c-electric-continued-statement 0)
1172 ("catch" "catch" c-electric-continued-statement 0)))
1174 (defvar c++-mode-map ()
1175 "Keymap used in c++-mode buffers.")
1176 (if c++-mode-map
1178 (setq c++-mode-map (c-make-inherited-keymap))
1179 ;; add bindings which are only useful for C++
1180 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1181 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1182 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1183 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1185 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
1186 (cons "C++" (c-lang-const c-mode-menu c++)))
1188 ;;;###autoload
1189 (defun c++-mode ()
1190 "Major mode for editing C++ code.
1191 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1192 c++-mode buffer. This automatically sets up a mail buffer with
1193 version information already added. You just need to add a description
1194 of the problem, including a reproducible test case, and send the
1195 message.
1197 To see what version of CC Mode you are running, enter `\\[c-version]'.
1199 The hook `c-mode-common-hook' is run with no args at mode
1200 initialization, then `c++-mode-hook'.
1202 Key bindings:
1203 \\{c++-mode-map}"
1204 (interactive)
1205 (kill-all-local-variables)
1206 (c-initialize-cc-mode t)
1207 (set-syntax-table c++-mode-syntax-table)
1208 (setq major-mode 'c++-mode
1209 mode-name "C++"
1210 local-abbrev-table c++-mode-abbrev-table
1211 abbrev-mode t)
1212 (use-local-map c++-mode-map)
1213 (c-init-language-vars-for 'c++-mode)
1214 (c-common-init 'c++-mode)
1215 (easy-menu-add c-c++-menu)
1216 (cc-imenu-init cc-imenu-c++-generic-expression)
1217 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
1218 (c-update-modeline))
1221 ;; Support for Objective-C
1223 ;;;###autoload
1224 (defvar objc-mode-syntax-table nil
1225 "Syntax table used in objc-mode buffers.")
1226 (or objc-mode-syntax-table
1227 (setq objc-mode-syntax-table
1228 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1230 (defvar objc-mode-abbrev-table nil
1231 "Abbreviation table used in objc-mode buffers.")
1232 (c-define-abbrev-table 'objc-mode-abbrev-table
1233 '(("else" "else" c-electric-continued-statement 0)
1234 ("while" "while" c-electric-continued-statement 0)))
1236 (defvar objc-mode-map ()
1237 "Keymap used in objc-mode buffers.")
1238 (if objc-mode-map
1240 (setq objc-mode-map (c-make-inherited-keymap))
1241 ;; add bindings which are only useful for Objective-C
1242 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1244 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
1245 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1247 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
1249 ;;;###autoload
1250 (defun objc-mode ()
1251 "Major mode for editing Objective C code.
1252 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1253 objc-mode buffer. This automatically sets up a mail buffer with
1254 version information already added. You just need to add a description
1255 of the problem, including a reproducible test case, and send the
1256 message.
1258 To see what version of CC Mode you are running, enter `\\[c-version]'.
1260 The hook `c-mode-common-hook' is run with no args at mode
1261 initialization, then `objc-mode-hook'.
1263 Key bindings:
1264 \\{objc-mode-map}"
1265 (interactive)
1266 (kill-all-local-variables)
1267 (c-initialize-cc-mode t)
1268 (set-syntax-table objc-mode-syntax-table)
1269 (setq major-mode 'objc-mode
1270 mode-name "ObjC"
1271 local-abbrev-table objc-mode-abbrev-table
1272 abbrev-mode t)
1273 (use-local-map objc-mode-map)
1274 (c-init-language-vars-for 'objc-mode)
1275 (c-common-init 'objc-mode)
1276 (easy-menu-add c-objc-menu)
1277 (cc-imenu-init nil 'cc-imenu-objc-function)
1278 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
1279 (c-update-modeline))
1282 ;; Support for Java
1284 ;;;###autoload
1285 (defvar java-mode-syntax-table nil
1286 "Syntax table used in java-mode buffers.")
1287 (or java-mode-syntax-table
1288 (setq java-mode-syntax-table
1289 (funcall (c-lang-const c-make-mode-syntax-table java))))
1291 (defvar java-mode-abbrev-table nil
1292 "Abbreviation table used in java-mode buffers.")
1293 (c-define-abbrev-table 'java-mode-abbrev-table
1294 '(("else" "else" c-electric-continued-statement 0)
1295 ("while" "while" c-electric-continued-statement 0)
1296 ("catch" "catch" c-electric-continued-statement 0)
1297 ("finally" "finally" c-electric-continued-statement 0)))
1299 (defvar java-mode-map ()
1300 "Keymap used in java-mode buffers.")
1301 (if java-mode-map
1303 (setq java-mode-map (c-make-inherited-keymap))
1304 ;; add bindings which are only useful for Java
1307 ;; Regexp trying to describe the beginning of a Java top-level
1308 ;; definition. This is not used by CC Mode, nor is it maintained
1309 ;; since it's practically impossible to write a regexp that reliably
1310 ;; matches such a construct. Other tools are necessary.
1311 (defconst c-Java-defun-prompt-regexp
1312 "^[ \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:;.,{}()\x7f=]*\\|\\([_$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-*")
1314 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
1315 (cons "Java" (c-lang-const c-mode-menu java)))
1317 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
1319 ;;;###autoload
1320 (defun java-mode ()
1321 "Major mode for editing Java code.
1322 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1323 java-mode buffer. This automatically sets up a mail buffer with
1324 version information already added. You just need to add a description
1325 of the problem, including a reproducible test case, and send the
1326 message.
1328 To see what version of CC Mode you are running, enter `\\[c-version]'.
1330 The hook `c-mode-common-hook' is run with no args at mode
1331 initialization, then `java-mode-hook'.
1333 Key bindings:
1334 \\{java-mode-map}"
1335 (interactive)
1336 (kill-all-local-variables)
1337 (c-initialize-cc-mode t)
1338 (set-syntax-table java-mode-syntax-table)
1339 (setq major-mode 'java-mode
1340 mode-name "Java"
1341 local-abbrev-table java-mode-abbrev-table
1342 abbrev-mode t)
1343 (use-local-map java-mode-map)
1344 (c-init-language-vars-for 'java-mode)
1345 (c-common-init 'java-mode)
1346 (easy-menu-add c-java-menu)
1347 (cc-imenu-init cc-imenu-java-generic-expression)
1348 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
1349 (c-update-modeline))
1352 ;; Support for CORBA's IDL language
1354 ;;;###autoload
1355 (defvar idl-mode-syntax-table nil
1356 "Syntax table used in idl-mode buffers.")
1357 (or idl-mode-syntax-table
1358 (setq idl-mode-syntax-table
1359 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1361 (defvar idl-mode-abbrev-table nil
1362 "Abbreviation table used in idl-mode buffers.")
1363 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
1365 (defvar idl-mode-map ()
1366 "Keymap used in idl-mode buffers.")
1367 (if idl-mode-map
1369 (setq idl-mode-map (c-make-inherited-keymap))
1370 ;; add bindings which are only useful for IDL
1373 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
1374 (cons "IDL" (c-lang-const c-mode-menu idl)))
1376 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
1378 ;;;###autoload
1379 (defun idl-mode ()
1380 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
1381 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1382 idl-mode buffer. This automatically sets up a mail buffer with
1383 version information already added. You just need to add a description
1384 of the problem, including a reproducible test case, and send the
1385 message.
1387 To see what version of CC Mode you are running, enter `\\[c-version]'.
1389 The hook `c-mode-common-hook' is run with no args at mode
1390 initialization, then `idl-mode-hook'.
1392 Key bindings:
1393 \\{idl-mode-map}"
1394 (interactive)
1395 (kill-all-local-variables)
1396 (c-initialize-cc-mode t)
1397 (set-syntax-table idl-mode-syntax-table)
1398 (setq major-mode 'idl-mode
1399 mode-name "IDL"
1400 local-abbrev-table idl-mode-abbrev-table)
1401 (use-local-map idl-mode-map)
1402 (c-init-language-vars-for 'idl-mode)
1403 (c-common-init 'idl-mode)
1404 (easy-menu-add c-idl-menu)
1405 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
1406 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
1407 (c-update-modeline))
1410 ;; Support for Pike
1412 ;;;###autoload
1413 (defvar pike-mode-syntax-table nil
1414 "Syntax table used in pike-mode buffers.")
1415 (or pike-mode-syntax-table
1416 (setq pike-mode-syntax-table
1417 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1419 (defvar pike-mode-abbrev-table nil
1420 "Abbreviation table used in pike-mode buffers.")
1421 (c-define-abbrev-table 'pike-mode-abbrev-table
1422 '(("else" "else" c-electric-continued-statement 0)
1423 ("while" "while" c-electric-continued-statement 0)))
1425 (defvar pike-mode-map ()
1426 "Keymap used in pike-mode buffers.")
1427 (if pike-mode-map
1429 (setq pike-mode-map (c-make-inherited-keymap))
1430 ;; additional bindings
1431 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1433 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
1434 (cons "Pike" (c-lang-const c-mode-menu pike)))
1436 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1437 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
1439 ;;;###autoload
1440 (defun pike-mode ()
1441 "Major mode for editing Pike code.
1442 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1443 pike-mode buffer. This automatically sets up a mail buffer with
1444 version information already added. You just need to add a description
1445 of the problem, including a reproducible test case, and send the
1446 message.
1448 To see what version of CC Mode you are running, enter `\\[c-version]'.
1450 The hook `c-mode-common-hook' is run with no args at mode
1451 initialization, then `pike-mode-hook'.
1453 Key bindings:
1454 \\{pike-mode-map}"
1455 (interactive)
1456 (kill-all-local-variables)
1457 (c-initialize-cc-mode t)
1458 (set-syntax-table pike-mode-syntax-table)
1459 (setq major-mode 'pike-mode
1460 mode-name "Pike"
1461 local-abbrev-table pike-mode-abbrev-table
1462 abbrev-mode t)
1463 (use-local-map pike-mode-map)
1464 (c-init-language-vars-for 'pike-mode)
1465 (c-common-init 'pike-mode)
1466 (easy-menu-add c-pike-menu)
1467 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
1468 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
1469 (c-update-modeline))
1472 ;; Support for AWK
1474 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1475 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1476 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1477 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1478 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
1480 ;;; Autoload directives must be on the top level, so we construct an
1481 ;;; autoload form instead.
1482 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1484 (defvar awk-mode-abbrev-table nil
1485 "Abbreviation table used in awk-mode buffers.")
1486 (c-define-abbrev-table 'awk-mode-abbrev-table
1487 '(("else" "else" c-electric-continued-statement 0)
1488 ("while" "while" c-electric-continued-statement 0)))
1490 (defvar awk-mode-map ()
1491 "Keymap used in awk-mode buffers.")
1492 (if awk-mode-map
1494 (setq awk-mode-map (c-make-inherited-keymap))
1495 ;; add bindings which are only useful for awk.
1496 (define-key awk-mode-map "#" 'self-insert-command)
1497 (define-key awk-mode-map "/" 'self-insert-command)
1498 (define-key awk-mode-map "*" 'self-insert-command)
1499 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1500 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1501 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1502 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1503 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1504 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1505 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1507 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1508 (cons "AWK" (c-lang-const c-mode-menu awk)))
1510 ;; (require 'cc-awk) brings these in.
1511 (defvar awk-mode-syntax-table)
1512 (declare-function c-awk-unstick-NL-prop "cc-awk" ())
1514 (defun awk-mode ()
1515 "Major mode for editing AWK code.
1516 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1517 awk-mode buffer. This automatically sets up a mail buffer with version
1518 information already added. You just need to add a description of the
1519 problem, including a reproducible test case, and send the message.
1521 To see what version of CC Mode you are running, enter `\\[c-version]'.
1523 The hook `c-mode-common-hook' is run with no args at mode
1524 initialization, then `awk-mode-hook'.
1526 Key bindings:
1527 \\{awk-mode-map}"
1528 (interactive)
1529 (require 'cc-awk) ; Added 2003/6/10.
1530 (kill-all-local-variables)
1531 (c-initialize-cc-mode t)
1532 (set-syntax-table awk-mode-syntax-table)
1533 (setq major-mode 'awk-mode
1534 mode-name "AWK"
1535 local-abbrev-table awk-mode-abbrev-table
1536 abbrev-mode t)
1537 (use-local-map awk-mode-map)
1538 (c-init-language-vars-for 'awk-mode)
1539 (c-common-init 'awk-mode)
1540 (c-awk-unstick-NL-prop)
1542 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1543 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1544 (defalias 'c-in-literal 'c-slow-in-literal)
1546 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1547 (c-update-modeline))
1550 ;; bug reporting
1552 (defconst c-mode-help-address
1553 "bug-cc-mode@gnu.org"
1554 "Address(es) for CC Mode bug reports.")
1556 (defun c-version ()
1557 "Echo the current version of CC Mode in the minibuffer."
1558 (interactive)
1559 (message "Using CC Mode version %s" c-version)
1560 (c-keep-region-active))
1562 (defvar c-prepare-bug-report-hooks nil)
1564 ;; Dynamic variables used by reporter.
1565 (defvar reporter-prompt-for-summary-p)
1566 (defvar reporter-dont-compact-list)
1568 (defun c-submit-bug-report ()
1569 "Submit via mail a bug report on CC Mode."
1570 (interactive)
1571 (require 'reporter)
1572 ;; load in reporter
1573 (let ((reporter-prompt-for-summary-p t)
1574 (reporter-dont-compact-list '(c-offsets-alist))
1575 (style c-indentation-style)
1576 (c-features c-emacs-features))
1577 (and
1578 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1579 t (message "") nil)
1580 (reporter-submit-bug-report
1581 c-mode-help-address
1582 (concat "CC Mode " c-version " (" mode-name ")")
1583 (let ((vars (append
1584 c-style-variables
1585 '(c-buffer-is-cc-mode
1586 c-tab-always-indent
1587 c-syntactic-indentation
1588 c-syntactic-indentation-in-macros
1589 c-ignore-auto-fill
1590 c-auto-align-backslashes
1591 c-backspace-function
1592 c-delete-function
1593 c-electric-pound-behavior
1594 c-default-style
1595 c-enable-xemacs-performance-kludge-p
1596 c-old-style-variable-behavior
1597 defun-prompt-regexp
1598 tab-width
1599 comment-column
1600 parse-sexp-ignore-comments
1601 parse-sexp-lookup-properties
1602 lookup-syntax-properties
1603 ;; A brain-damaged XEmacs only variable that, if
1604 ;; set to nil can cause all kinds of chaos.
1605 signal-error-on-buffer-boundary
1606 ;; Variables that affect line breaking and comments.
1607 auto-fill-mode
1608 auto-fill-function
1609 filladapt-mode
1610 comment-multi-line
1611 comment-start-skip
1612 fill-prefix
1613 fill-column
1614 paragraph-start
1615 adaptive-fill-mode
1616 adaptive-fill-regexp)
1617 nil)))
1618 (mapc (lambda (var) (unless (boundp var)
1619 (setq vars (delq var vars))))
1620 '(signal-error-on-buffer-boundary
1621 filladapt-mode
1622 defun-prompt-regexp
1623 font-lock-mode
1624 font-lock-maximum-decoration
1625 parse-sexp-lookup-properties
1626 lookup-syntax-properties))
1627 vars)
1628 (lambda ()
1629 (run-hooks 'c-prepare-bug-report-hooks)
1630 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1631 style c-features)))))))
1634 (cc-provide 'cc-mode)
1636 ;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
1637 ;;; cc-mode.el ends here