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 ;; 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 oop
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
103 (cc-bytecomp-obsolete-fun make-local-hook
) ; Marked obsolete in Emacs 21.1.
105 ;; We set these variables during mode init, yet we don't require
107 (cc-bytecomp-defvar font-lock-defaults
)
108 (cc-bytecomp-defvar font-lock-syntactic-keywords
)
110 ;; Menu support for both XEmacs and Emacs. If you don't have easymenu
111 ;; with your version of Emacs, you are incompatible!
112 (cc-external-require 'easymenu
)
114 ;; Autoload directive for emacsen that doesn't have an older CC Mode
115 ;; version in the dist.
116 (autoload 'c-subword-mode
"cc-subword"
117 "Mode enabling subword movement and editing keys." t
)
119 ;; Load cc-fonts first after font-lock is loaded, since it isn't
120 ;; necessary until font locking is requested.
121 ; (eval-after-load "font-lock" ; 2006-07-09: font-lock is now preloaded.
123 (require 'cc-fonts
) ;)
125 ;; cc-langs isn't loaded when we're byte compiled, so add autoload
126 ;; directives for the interface functions.
127 (autoload 'c-make-init-lang-vars-fun
"cc-langs")
128 (autoload 'c-init-language-vars
"cc-langs" nil nil
'macro
)
131 ;; Other modes and packages which depend on CC Mode should do the
132 ;; following to make sure everything is loaded and available for their
135 ;; (require 'cc-mode)
137 ;; And in the major mode function:
139 ;; (c-initialize-cc-mode t)
140 ;; (c-init-language-vars some-mode)
141 ;; (c-common-init 'some-mode) ; Or perhaps (c-basic-common-init 'some-mode)
143 ;; If you're not writing a derived mode using the language variable
144 ;; system, then some-mode is one of the language modes directly
145 ;; supported by CC Mode. You can then use (c-init-language-vars-for
146 ;; 'some-mode) instead of `c-init-language-vars'.
147 ;; `c-init-language-vars-for' is a function that avoids the rather
148 ;; large expansion of `c-init-language-vars'.
150 ;; If you use `c-basic-common-init' then you might want to call
151 ;; `c-font-lock-init' too to set up CC Mode's font lock support.
153 ;; See cc-langs.el for further info. A small example of a derived mode
154 ;; is also available at <http://cc-mode.sourceforge.net/
155 ;; derived-mode-ex.el>.
157 (defun c-leave-cc-mode-mode ()
158 (setq c-buffer-is-cc-mode nil
))
160 (defun c-init-language-vars-for (mode)
161 "Initialize the language variables for one of the language modes
162 directly supported by CC Mode. This can be used instead of the
163 `c-init-language-vars' macro if the language you want to use is one of
164 those, rather than a derived language defined through the language
165 variable system (see \"cc-langs.el\")."
166 (cond ((eq mode
'c-mode
) (c-init-language-vars c-mode
))
167 ((eq mode
'c
++-mode
) (c-init-language-vars c
++-mode
))
168 ((eq mode
'objc-mode
) (c-init-language-vars objc-mode
))
169 ((eq mode
'java-mode
) (c-init-language-vars java-mode
))
170 ((eq mode
'idl-mode
) (c-init-language-vars idl-mode
))
171 ((eq mode
'pike-mode
) (c-init-language-vars pike-mode
))
172 ((eq mode
'awk-mode
) (c-init-language-vars awk-mode
))
173 (t (error "Unsupported mode %s" mode
))))
176 (defun c-initialize-cc-mode (&optional new-style-init
)
177 "Initialize CC Mode for use in the current buffer.
178 If the optional NEW-STYLE-INIT is nil or left out then all necessary
179 initialization to run CC Mode for the C language is done. Otherwise
180 only some basic setup is done, and a call to `c-init-language-vars' or
181 `c-init-language-vars-for' is necessary too (which gives more
182 control). See \"cc-mode.el\" for more info."
184 (setq c-buffer-is-cc-mode t
)
186 (let ((initprop 'cc-mode-is-initialized
)
188 (unless (get 'c-initialize-cc-mode initprop
)
191 (put 'c-initialize-cc-mode initprop t
)
192 (c-initialize-builtin-style)
193 (run-hooks 'c-initialization-hook
)
194 ;; Fix obsolete variables.
195 (if (boundp 'c-comment-continuation-stars
)
196 (setq c-block-comment-prefix
197 (symbol-value 'c-comment-continuation-stars
)))
198 (add-hook 'change-major-mode-hook
'c-leave-cc-mode-mode
)
199 (setq c-initialization-ok t
))
200 ;; Will try initialization hooks again if they failed.
201 (put 'c-initialize-cc-mode initprop c-initialization-ok
))))
203 (unless new-style-init
204 (c-init-language-vars-for 'c-mode
)))
209 (defvar c-mode-base-map
()
210 "Keymap shared by all CC Mode related modes.")
212 (defun c-make-inherited-keymap ()
213 (let ((map (make-sparse-keymap)))
214 ;; Necessary to use `cc-bytecomp-fboundp' below since this
215 ;; function is called from top-level forms that are evaluated
216 ;; while cc-bytecomp is active when one does M-x eval-buffer.
219 ((cc-bytecomp-fboundp 'set-keymap-parent
)
220 (set-keymap-parent map c-mode-base-map
))
222 ((cc-bytecomp-fboundp 'set-keymap-parents
)
223 (set-keymap-parents map c-mode-base-map
))
225 (t (error "CC Mode is incompatible with this version of Emacs")))
228 (defun c-define-abbrev-table (name defs
)
229 ;; Compatibility wrapper for `define-abbrev' which passes a non-nil
230 ;; sixth argument for SYSTEM-FLAG in emacsen that support it
231 ;; (currently only Emacs >= 21.2).
232 (let ((table (or (symbol-value name
)
233 (progn (define-abbrev-table name nil
)
234 (symbol-value name
)))))
237 (apply 'define-abbrev table
(append (car defs
) '(t)))
238 (wrong-number-of-arguments
239 (apply 'define-abbrev table
(car defs
))))
240 (setq defs
(cdr defs
)))))
241 (put 'c-define-abbrev-table
'lisp-indent-function
1)
243 (defun c-bind-special-erase-keys ()
244 ;; Only used in Emacs to bind C-c C-<delete> and C-c C-<backspace>
245 ;; to the proper keys depending on `normal-erase-is-backspace'.
246 (if normal-erase-is-backspace
248 (define-key c-mode-base-map
(kbd "C-c C-<delete>")
249 'c-hungry-delete-forward
)
250 (define-key c-mode-base-map
(kbd "C-c C-<backspace>")
251 'c-hungry-delete-backwards
))
252 (define-key c-mode-base-map
(kbd "C-c C-<delete>")
253 'c-hungry-delete-backwards
)
254 (define-key c-mode-base-map
(kbd "C-c C-<backspace>")
255 'c-hungry-delete-forward
)))
260 (setq c-mode-base-map
(make-sparse-keymap))
262 ;; Separate M-BS from C-M-h. The former should remain
263 ;; backward-kill-word.
264 (define-key c-mode-base-map
[(control meta h
)] 'c-mark-function
)
265 (define-key c-mode-base-map
"\e\C-q" 'c-indent-exp
)
266 (substitute-key-definition 'backward-sentence
267 'c-beginning-of-statement
268 c-mode-base-map global-map
)
269 (substitute-key-definition 'forward-sentence
271 c-mode-base-map global-map
)
272 (substitute-key-definition 'indent-new-comment-line
273 'c-indent-new-comment-line
274 c-mode-base-map global-map
)
275 (substitute-key-definition 'indent-for-tab-command
276 ;; XXX Is this the right thing to do
278 'c-indent-line-or-region
279 c-mode-base-map global-map
)
280 (when (fboundp 'comment-indent-new-line
)
281 ;; indent-new-comment-line has changed name to
282 ;; comment-indent-new-line in Emacs 21.
283 (substitute-key-definition 'comment-indent-new-line
284 'c-indent-new-comment-line
285 c-mode-base-map global-map
))
287 ;; RMS says don't make these the default.
288 ;; (April 2006): RMS has now approved these commands as defaults.
289 (unless (memq 'argumentative-bod-function c-emacs-features
)
290 (define-key c-mode-base-map
"\e\C-a" 'c-beginning-of-defun
)
291 (define-key c-mode-base-map
"\e\C-e" 'c-end-of-defun
))
293 (define-key c-mode-base-map
"\C-c\C-n" 'c-forward-conditional
)
294 (define-key c-mode-base-map
"\C-c\C-p" 'c-backward-conditional
)
295 (define-key c-mode-base-map
"\C-c\C-u" 'c-up-conditional
)
297 ;; It doesn't suffice to put `c-fill-paragraph' on
298 ;; `fill-paragraph-function' since `c-fill-paragraph' must be called
299 ;; before any fill prefix adaption is done. E.g. `filladapt-mode'
300 ;; replaces `fill-paragraph' and does the adaption before calling
301 ;; `fill-paragraph-function', and we have to mask comments etc
302 ;; before that. Also, `c-fill-paragraph' chains on to
303 ;; `fill-paragraph' and the value on `fill-parapgraph-function' to
304 ;; do the actual filling work.
305 (substitute-key-definition 'fill-paragraph
'c-fill-paragraph
306 c-mode-base-map global-map
)
307 ;; In XEmacs the default fill function is called
308 ;; fill-paragraph-or-region.
309 (substitute-key-definition 'fill-paragraph-or-region
'c-fill-paragraph
310 c-mode-base-map global-map
)
312 ;; We bind the forward deletion key and (implicitly) C-d to
313 ;; `c-electric-delete-forward', and the backward deletion key to
314 ;; `c-electric-backspace'. The hungry variants are bound to the
315 ;; same keys but prefixed with C-c. This implies that C-c C-d is
316 ;; `c-hungry-delete-forward'. For consistency, we bind not only C-c
317 ;; <backspace> to `c-hungry-delete-backwards' but also
318 ;; C-c C-<backspace>, so that the Ctrl key can be held down during
319 ;; the whole sequence regardless of the direction. This in turn
320 ;; implies that we bind C-c C-<delete> to `c-hungry-delete-forward',
321 ;; for the same reason.
323 ;; Bind the electric deletion functions to C-d and DEL. Emacs 21
324 ;; automatically maps the [delete] and [backspace] keys to these two
325 ;; depending on window system and user preferences. (In earlier
326 ;; versions it's possible to do the same by using `function-key-map'.)
327 (define-key c-mode-base-map
"\C-d" 'c-electric-delete-forward
)
328 (define-key c-mode-base-map
"\177" 'c-electric-backspace
)
329 (define-key c-mode-base-map
"\C-c\C-d" 'c-hungry-delete-forward
)
330 (define-key c-mode-base-map
[?\C-c ?\d
] 'c-hungry-delete-backwards
)
331 (define-key c-mode-base-map
[?\C-c ?\C-\d
] 'c-hungry-delete-backwards
)
332 (define-key c-mode-base-map
[?\C-c deletechar
] 'c-hungry-delete-forward
) ; C-c <delete> on a tty.
333 (define-key c-mode-base-map
[?\C-c
(control deletechar
)] ; C-c C-<delete> on a tty.
334 'c-hungry-delete-forward
)
335 (when (boundp 'normal-erase-is-backspace
)
336 ;; The automatic C-d and DEL mapping functionality doesn't extend
337 ;; to special combinations like C-c C-<delete>, so we have to hook
338 ;; into the `normal-erase-is-backspace' system to bind it directly
340 (add-hook 'normal-erase-is-backspace-hook
'c-bind-special-erase-keys
)
341 (c-bind-special-erase-keys))
343 (when (fboundp 'delete-forward-p
)
344 ;; In XEmacs we fix the forward and backward deletion behavior by
345 ;; binding the keysyms for the [delete] and [backspace] keys
346 ;; directly, and use `delete-forward-p' to decide what [delete]
347 ;; should do. That's done in the XEmacs specific
348 ;; `c-electric-delete' and `c-hungry-delete' functions.
349 (define-key c-mode-base-map
[delete] 'c-electric-delete)
350 (define-key c-mode-base-map [backspace] 'c-electric-backspace)
351 (define-key c-mode-base-map (kbd "C-c <delete>") 'c-hungry-delete)
352 (define-key c-mode-base-map (kbd "C-c C-<delete>") 'c-hungry-delete)
353 (define-key c-mode-base-map (kbd "C-c <backspace>")
354 'c-hungry-delete-backwards)
355 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
356 'c-hungry-delete-backwards))
358 (define-key c-mode-base-map "#" 'c-electric-pound)
359 (define-key c-mode-base-map "{" 'c-electric-brace)
360 (define-key c-mode-base-map "}" 'c-electric-brace)
361 (define-key c-mode-base-map "/" 'c-electric-slash)
362 (define-key c-mode-base-map "*" 'c-electric-star)
363 (define-key c-mode-base-map ";" 'c-electric-semi&comma)
364 (define-key c-mode-base-map "," 'c-electric-semi&comma)
365 (define-key c-mode-base-map ":" 'c-electric-colon)
366 (define-key c-mode-base-map "(" 'c-electric-paren)
367 (define-key c-mode-base-map ")" 'c-electric-paren)
369 (define-key c-mode-base-map "\C-c\C-\\" 'c-backslash-region)
370 (define-key c-mode-base-map "\C-c\C-a" 'c-toggle-auto-newline)
371 (define-key c-mode-base-map "\C-c\C-b" 'c-submit-bug-report)
372 (define-key c-mode-base-map "\C-c\C-c" 'comment-region)
373 (define-key c-mode-base-map "\C-c\C-l" 'c-toggle-electric-state)
374 (define-key c-mode-base-map "\C-c\C-o" 'c-set-offset)
375 (define-key c-mode-base-map "\C-c\C-q" 'c-indent-defun)
376 (define-key c-mode-base-map "\C-c\C-s" 'c-show-syntactic-information)
377 ;; (define-key c-mode-base-map "\C-c\C-t" 'c-toggle-auto-hungry-state) Commented out by ACM, 2005-03-05.
378 (define-key c-mode-base-map "\C-c." 'c-set-style)
379 ;; conflicts with OOBR
380 ;;(define-key c-mode-base-map "\C-c\C-v" 'c-version)
381 ;; (define-key c-mode-base-map "\C-c\C-y" 'c-toggle-hungry-state) Commented out by ACM, 2005-11-22.
382 (define-key c-mode-base-map "\C-c\C-w" 'c-subword-mode)
385 ;; We don't require the outline package, but we configure it a bit anyway.
386 (cc-bytecomp-defvar outline-level)
388 (defun c-mode-menu (modestr)
389 "Return a menu spec suitable for `easy-menu-define' that is exactly
390 like the C mode menu except that the menu bar item name is MODESTR
393 This function is provided for compatibility only; derived modes should
394 preferably use the `c-mode-menu' language constant directly."
395 (cons modestr (c-lang-const c-mode-menu c)))
397 ;; Ugly hack to pull in the definition of `c-populate-syntax-table'
398 ;; from cc-langs to make it available at runtime. It's either this or
399 ;; moving the definition for it to cc-defs, but that would mean to
400 ;; break up the syntax table setup over two files.
401 (defalias 'c-populate-syntax-table
402 (cc-eval-when-compile
403 (let ((f (symbol-function 'c-populate-syntax-table)))
404 (if (byte-code-function-p f) f (byte-compile f)))))
406 ;; CAUTION: Try to avoid installing things on
407 ;; `before-change-functions'. The macro `combine-after-change-calls'
408 ;; is used and it doesn't work if there are things on that hook. That
409 ;; can cause font lock functions to run in inconvenient places during
410 ;; temporary changes in some font lock support modes, causing extra
411 ;; unnecessary work and font lock glitches due to interactions between
412 ;; various text properties.
414 ;; (2007-02-12): The macro `combine-after-change-calls' ISN'T used any
417 (defun c-unfind-enclosing-token (pos)
418 ;; If POS is wholly inside a token, remove that id from
419 ;; `c-found-types', should it be present. Return t if we were in an
422 (let ((tok-beg (progn (goto-char pos)
423 (and (c-beginning-of-current-token) (point))))
424 (tok-end (progn (goto-char pos)
425 (and (c-end-of-current-token) (point)))))
426 (when (and tok-beg tok-end)
427 (c-unfind-type (buffer-substring-no-properties tok-beg tok-end))
430 (defun c-unfind-coalesced-tokens (beg end)
431 ;; unless the non-empty region (beg end) is entirely WS and there's at
432 ;; least one character of WS just before or after this region, remove
433 ;; the tokens which touch the region from `c-found-types' should they
435 (or (c-partial-ws-p beg end)
439 (or (eq beg (point-min))
440 (c-skip-ws-backward (1- beg))
442 (= (c-backward-token-2) 1)
443 (c-unfind-type (buffer-substring-no-properties
446 (or (eq end (point-max))
447 (c-skip-ws-forward (1+ end))
449 (progn (forward-char) (c-end-of-current-token) nil)
450 (c-unfind-type (buffer-substring-no-properties
453 ;; c-maybe-stale-found-type records a place near the region being
454 ;; changed where an element of `found-types' might become stale. It
455 ;; is set in c-before-change and is either nil, or has the form:
457 ;; (c-decl-id-start "foo" 97 107 " (* ooka) " "o"), where
459 ;; o - `c-decl-id-start' is the c-type text property value at buffer
462 ;; o - 97 107 is the region potentially containing the stale type -
463 ;; this is delimited by a non-nil c-type text property at 96 and
464 ;; either another one or a ";", "{", or "}" at 107.
466 ;; o - " (* ooka) " is the (before change) buffer portion containing
467 ;; the suspect type (here "ooka").
469 ;; o - "o" is the buffer contents which is about to be deleted. This
470 ;; would be the empty string for an insertion.
471 (defvar c-maybe-stale-found-type nil)
472 (make-variable-buffer-local 'c-maybe-stale-found-type)
474 (defun c-basic-common-init (mode default-style)
475 "Do the necessary initialization for the syntax handling routines
476 and the line breaking/filling code. Intended to be used by other
477 packages that embed CC Mode.
479 MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode.
480 DEFAULT-STYLE tells which indentation style to install. It has the
481 same format as `c-default-style'.
483 Note that `c-init-language-vars' must be called before this function.
484 This function cannot do that since `c-init-language-vars' is a macro
485 that requires a literal mode spec at compile time."
487 (setq c-buffer-is-cc-mode mode)
489 ;; these variables should always be buffer local; they do not affect
490 ;; indentation style.
491 (make-local-variable 'parse-sexp-ignore-comments)
492 (make-local-variable 'indent-line-function)
493 (make-local-variable 'indent-region-function)
494 (make-local-variable 'normal-auto-fill-function)
495 (make-local-variable 'comment-start)
496 (make-local-variable 'comment-end)
497 (make-local-variable 'comment-start-skip)
498 (make-local-variable 'comment-multi-line)
499 (make-local-variable 'comment-line-break-function)
500 (make-local-variable 'paragraph-start)
501 (make-local-variable 'paragraph-separate)
502 (make-local-variable 'paragraph-ignore-fill-prefix)
503 (make-local-variable 'adaptive-fill-mode)
504 (make-local-variable 'adaptive-fill-regexp)
506 ;; now set their values
507 (setq parse-sexp-ignore-comments t
508 indent-line-function 'c-indent-line
509 indent-region-function 'c-indent-region
510 normal-auto-fill-function 'c-do-auto-fill
512 comment-line-break-function 'c-indent-new-comment-line)
514 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
515 ;; direct call to `fill-paragraph' behaves better. This still
516 ;; doesn't work with filladapt but it's better than nothing.
517 (make-local-variable 'fill-paragraph-function)
518 (setq fill-paragraph-function 'c-fill-paragraph)
520 (when (or c-recognize-<>-arglists
521 (c-major-mode-is 'awk-mode)
522 (c-major-mode-is '(c-mode c++-mode objc-mode)))
523 ;; We'll use the syntax-table text property to change the syntax
524 ;; of some chars for this language, so do the necessary setup for
527 ;; Note to other package developers: It's ok to turn this on in CC
528 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
529 ;; off if CC Mode has turned it on.
532 (when (boundp 'parse-sexp-lookup-properties)
533 (make-local-variable 'parse-sexp-lookup-properties)
534 (setq parse-sexp-lookup-properties t))
536 ;; Same as above for XEmacs.
537 (when (boundp 'lookup-syntax-properties)
538 (make-local-variable 'lookup-syntax-properties)
539 (setq lookup-syntax-properties t)))
541 ;; Use this in Emacs 21 to avoid meddling with the rear-nonsticky
542 ;; property on each character.
543 (when (boundp 'text-property-default-nonsticky)
544 (make-local-variable 'text-property-default-nonsticky)
545 (let ((elem (assq 'syntax-table text-property-default-nonsticky)))
548 (setq text-property-default-nonsticky
549 (cons '(syntax-table . t)
550 text-property-default-nonsticky))))
551 (setq text-property-default-nonsticky
553 text-property-default-nonsticky)))
555 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
556 ;; heuristic that open parens in column 0 are defun starters. Since
557 ;; we have c-state-cache, that heuristic isn't useful and only causes
558 ;; trouble, so turn it off.
559 ;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
560 ;; helpful. Comment it out for now.
561 ;; (when (memq 'col-0-paren c-emacs-features)
562 ;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
563 ;; (setq open-paren-in-column-0-is-defun-start nil))
565 (c-clear-found-types)
567 ;; now set the mode style based on default-style
568 (let ((style (if (stringp default-style)
570 (or (cdr (assq mode default-style))
571 (cdr (assq 'other default-style))
573 ;; Override style variables if `c-old-style-variable-behavior' is
574 ;; set. Also override if we are using global style variables,
575 ;; have already initialized a style once, and are switching to a
576 ;; different style. (It's doubtful whether this is desirable, but
577 ;; the whole situation with nonlocal style variables is a bit
578 ;; awkward. It's at least the most compatible way with the old
579 ;; style init procedure.)
580 (c-set-style style (not (or c-old-style-variable-behavior
581 (and (not c-style-variables-are-local-p)
583 (not (string-equal c-indentation-style
585 (c-setup-paragraph-variables)
587 ;; we have to do something special for c-offsets-alist so that the
588 ;; buffer local value has its own alist structure.
589 (setq c-offsets-alist (copy-alist c-offsets-alist))
591 ;; setup the comment indent variable in a Emacs version portable way
592 (make-local-variable 'comment-indent-function)
593 (setq comment-indent-function 'c-comment-indent)
595 ;; ;; Put submode indicators onto minor-mode-alist, but only once.
596 ;; (or (assq 'c-submode-indicators minor-mode-alist)
597 ;; (setq minor-mode-alist
598 ;; (cons '(c-submode-indicators c-submode-indicators)
599 ;; minor-mode-alist)))
602 ;; Install the functions that ensure that various internal caches
603 ;; don't become invalid due to buffer changes.
604 (make-local-hook 'before-change-functions)
605 (add-hook 'before-change-functions 'c-before-change nil t)
606 (make-local-hook 'after-change-functions)
607 (add-hook 'after-change-functions 'c-after-change nil t)
608 (set (make-local-variable 'font-lock-extend-after-change-region-function)
609 'c-extend-after-change-region)) ; Currently (2008-04), only used by AWK.
611 (defun c-setup-doc-comment-style ()
612 "Initialize the variables that depend on the value of `c-doc-comment-style'."
613 (when (and (featurep 'font-lock)
614 (symbol-value 'font-lock-mode))
615 ;; Force font lock mode to reinitialize itself.
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...
644 (if c-get-state-before-change-function
645 (funcall c-get-state-before-change-function (point-min) (point-max)))
646 (if c-before-font-lock-function
647 (funcall c-before-font-lock-function (point-min) (point-max)
648 (- (point-max) (point-min))))))
650 (make-local-variable 'outline-regexp)
651 (make-local-variable 'outline-level)
652 (setq outline-regexp "[^#\n\^M]"
653 outline-level 'c-outline-level)
655 (let ((rfn (assq mode c-require-final-newline)))
657 (make-local-variable 'require-final-newline)
659 (setq require-final-newline mode-require-final-newline)))))
661 (defun c-before-hack-hook ()
662 "Set the CC Mode style and \"offsets\" when in the buffer's local variables.
663 They are set only when, respectively, the pseudo variables
664 `c-file-style' and `c-file-offsets' are present in the list.
666 This function is called from the hook `before-hack-local-variables-hook'."
667 (when c-buffer-is-cc-mode
668 (let ((stile (cdr (assq 'c-file-style file-local-variables-alist)))
669 (offsets (cdr (assq 'c-file-offsets file-local-variables-alist))))
671 (or (stringp stile) (error "c-file-style is not a string"))
676 (let ((langelem (car langentry))
677 (offset (cdr langentry)))
678 (c-set-offset langelem offset)))
681 (defun c-remove-any-local-eval-or-mode-variables ()
682 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
683 ;; or on the first line, remove all occurrences. See
684 ;; `c-postprocess-file-styles' for justification. There is no need to save
685 ;; point here, or even bother too much about the buffer contents. However,
686 ;; DON'T mess up the kill-ring.
688 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
690 (goto-char (point-max))
691 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
692 (let (lv-point (prefix "") (suffix ""))
693 (when (let ((case-fold-search t))
694 (search-forward "Local Variables:" nil t))
695 (setq lv-point (point))
696 ;; The prefix is what comes before "local variables:" in its line.
697 ;; The suffix is what comes after "local variables:" in its line.
698 (skip-chars-forward " \t")
700 (setq suffix (buffer-substring (point)
701 (progn (end-of-line) (point)))))
702 (goto-char (match-beginning 0))
705 (buffer-substring (point)
706 (progn (beginning-of-line) (point)))))
708 (while (search-forward-regexp
710 (regexp-quote prefix)
711 "\\(mode\\|eval\\):.*"
712 (regexp-quote suffix)
716 (delete-region (point) (progn (forward-line) (point)))))
718 ;; Delete the first line, if we've got one, in case it contains a mode spec.
719 (unless (and lv-point
720 (progn (goto-char lv-point)
723 (goto-char (point-min))
725 (delete-region (point) (progn (forward-line) (point)))))))
727 (defun c-postprocess-file-styles ()
728 "Function that post processes relevant file local variables in CC Mode.
729 Currently, this function simply applies any style and offset settings
730 found in the file's Local Variable list. It first applies any style
731 setting found in `c-file-style', then it applies any offset settings
732 it finds in `c-file-offsets'.
734 Note that the style variables are always made local to the buffer."
736 ;; apply file styles and offsets
737 (when c-buffer-is-cc-mode
738 (if (or c-file-style c-file-offsets)
739 (c-make-styles-buffer-local t))
741 (or (stringp c-file-style)
742 (error "c-file-style is not a string"))
743 (c-set-style c-file-style))
748 (let ((langelem (car langentry))
749 (offset (cdr langentry)))
750 (c-set-offset langelem offset)))
752 ;; Problem: The file local variable block might have explicitly set a
753 ;; style variable. The `c-set-style' or `mapcar' call might have
754 ;; overwritten this. So we run `hack-local-variables' again to remedy
755 ;; this. There are no guarantees this will work properly, particularly as
756 ;; we have no control over what the other hook functions on
757 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
758 ;; any `eval' or `mode' expressions before we evaluate again (see below).
761 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
762 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
763 ;; We prevent this by temporarily removing `mode' from the Local Variables
765 (if (or c-file-style c-file-offsets)
766 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
767 (c-tentative-buffer-changes
768 (c-remove-any-local-eval-or-mode-variables)
769 (hack-local-variables))
772 (if (boundp 'before-hack-local-variables-hook)
773 (add-hook 'before-hack-local-variables-hook 'c-before-hack-hook)
774 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles))
776 (defmacro c-run-mode-hooks (&rest hooks)
777 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
778 ;; require the use of the new function `run-mode-hooks'.
779 (if (cc-bytecomp-fboundp 'run-mode-hooks)
780 `(run-mode-hooks ,@hooks)
781 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
784 ;;; Change hooks, linking with Font Lock.
786 ;; Buffer local variables defining the region to be fontified by a font lock
787 ;; after-change function. They are set in c-after-change to
788 ;; after-change-function's BEG and END, and may be modified by a
789 ;; `c-before-font-lock-function'.
791 (make-variable-buffer-local 'c-new-BEG)
793 (make-variable-buffer-local 'c-new-END)
795 ;; Buffer local variables recording Beginning/End-of-Macro position before a
796 ;; change, when a macro straddles, respectively, the BEG or END (or both) of
797 ;; the change region. Otherwise these have the values BEG/END.
799 (make-variable-buffer-local 'c-old-BOM)
801 (make-variable-buffer-local 'c-old-EOM)
803 (defun c-extend-region-for-CPP (beg end)
804 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
805 ;; beginning/end of any preprocessor construct they may be in.
807 ;; Point is undefined both before and after this function call; the buffer
808 ;; has already been widened, and match-data saved. The return value is
811 ;; This function is the C/C++/ObjC value of
812 ;; `c-get-state-before-change-function' and is called exclusively as a
813 ;; before change function.
815 (c-beginning-of-macro)
816 (setq c-old-BOM (point))
819 (if (c-beginning-of-macro)
821 (setq c-old-EOM (point)))
823 (defun c-neutralize-CPP-line (beg end)
824 ;; BEG and END bound a region, typically a preprocessor line. Put a
825 ;; "punctuation" syntax-table property on syntactically obtrusive
826 ;; characters, ones which would interact syntactically with stuff outside
829 ;; These are unmatched string delimiters, or unmatched
830 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
836 (setq s (parse-partial-sexp beg end -1))
838 ((< (nth 0 s) 0) ; found an unmated ),},]
839 (c-put-char-property (1- (point)) 'syntax-table '(1))
841 ((nth 3 s) ; In a string
842 (c-put-char-property (nth 8 s) 'syntax-table '(1))
844 ((> (nth 0 s) 0) ; In a (,{,[
845 (c-put-char-property (nth 1 s) 'syntax-table '(1))
849 (defun c-neutralize-syntax-in-CPP (begg endd old-len)
850 ;; "Neutralize" every preprocessor line wholly or partially in the changed
851 ;; region. "Restore" lines which were CPP lines before the change and are
852 ;; no longer so; these can be located from the Buffer local variables
855 ;; That is, set syntax-table properties on characters that would otherwise
856 ;; interact syntactically with those outside the CPP line(s).
858 ;; This function is called from an after-change function, BEGG ENDD and
859 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
860 ;; locking, hence must get called before `font-lock-after-change-function'.
862 ;; Point is undefined both before and after this function call, the buffer
863 ;; has been widened, and match-data saved. The return value is ignored.
865 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
867 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
869 ;; This function might make hidden buffer changes.
870 (c-save-buffer-state (limits mbeg+1 beg end)
871 ;; First determine the region, (beg end), which may need "neutralizing".
872 ;; This may not start inside a string, comment, or macro.
873 (goto-char c-old-BOM) ; already set to old start of macro or begg.
875 (if (setq limits (c-literal-limits))
876 (cdr limits) ; go forward out of any string or comment.
880 (if (setq limits (c-literal-limits))
881 (goto-char (car limits))) ; go backward out of any string or comment.
882 (if (c-beginning-of-macro)
884 (setq end (max (+ (- c-old-EOM old-len) (- endd begg))
887 ;; Clear all old punctuation properties
888 (c-clear-char-property-with-value beg end 'syntax-table '(1))
891 (let ((pps-position beg) pps-state)
892 (while (and (< (point) end)
893 (search-forward-regexp c-anchored-cpp-prefix end t))
894 ;; If we've found a "#" inside a string/comment, ignore it.
896 (parse-partial-sexp pps-position (point) nil nil pps-state)
897 pps-position (point))
898 (unless (or (nth 3 pps-state) ; in a string?
899 (nth 4 pps-state)) ; in a comment?
900 (setq mbeg+1 (point))
901 (c-end-of-macro) ; Do we need to go forward 1 char here? No!
902 (c-neutralize-CPP-line mbeg+1 (point))
903 (setq pps-position (point))))))) ; no need to update pps-state.
905 (defun c-before-change (beg end)
906 ;; Function to be put on `before-change-function'. Primarily, this calls
907 ;; the language dependent `c-get-state-before-change-function'. It is
908 ;; otherwise used only to remove stale entries from the `c-found-types'
909 ;; cache, and to record entries which a `c-after-change' function might
912 ;; Note that this function must be FAST rather than accurate. Note
913 ;; also that it only has any effect when font locking is enabled.
914 ;; We exploit this by checking for font-lock-*-face instead of doing
915 ;; rigourous syntactic analysis.
917 ;; If either change boundary is wholly inside an identifier, delete
918 ;; it/them from the cache. Don't worry about being inside a string
919 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
921 (setq c-maybe-stale-found-type nil)
926 ;; Are we inserting/deleting stuff in the middle of an identifier?
927 (c-unfind-enclosing-token beg)
928 (c-unfind-enclosing-token end)
929 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
931 (c-unfind-coalesced-tokens beg end))
932 ;; Are we (potentially) disrupting the syntactic context which
933 ;; makes a type a type? E.g. by inserting stuff after "foo" in
934 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
936 ;; We search for appropriate c-type properties "near" the change.
937 ;; First, find an appropriate boundary for this property search.
942 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
943 (previous-single-property-change end 'face))
945 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
946 ;; Find a limit for the search for a `c-type' property
948 (and (/= (skip-chars-backward "^;{}") 0)
949 (> (point) (point-min))
950 (memq (c-get-char-property (1- (point)) 'face)
951 '(font-lock-comment-face font-lock-string-face))))
952 (setq lim (max (point-min) (1- (point))))
954 ;; Look for the latest `c-type' property before end1
955 (when (and (> end1 (point-min))
957 (if (get-text-property (1- end1) 'c-type)
959 (previous-single-property-change end1 'c-type nil lim))))
960 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
962 (when (memq type '(c-decl-id-start c-decl-type-start))
963 ;; Get the identifier, if any, that the property is on.
964 (goto-char (1- type-pos))
966 (when (looking-at "\\(\\sw\\|\\s_\\)")
967 (c-beginning-of-current-token)
968 (buffer-substring-no-properties (point) type-pos)))
971 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
974 (or (next-single-property-change end 'c-type nil lim) lim))
975 (setq c-maybe-stale-found-type
978 (buffer-substring-no-properties type-pos term-pos)
979 (buffer-substring-no-properties beg end)))))))
983 (if c-get-state-before-change-function
984 (funcall c-get-state-before-change-function beg end))
987 (defun c-after-change (beg end old-len)
988 ;; Function put on `after-change-functions' to adjust various caches
989 ;; etc. Prefer speed to finesse here, since there will be an order
990 ;; of magnitude more calls to this function than any of the
991 ;; functions that use the caches.
993 ;; Note that care must be taken so that this is called before any
994 ;; font-lock callbacks since we might get calls to functions using
995 ;; these caches from inside them, and we must thus be sure that this
996 ;; has already been executed.
998 ;; This calls the language variable c-before-font-lock-function, if non nil.
999 ;; This typically sets `syntax-table' properties.
1001 (c-save-buffer-state ()
1002 ;; When `combine-after-change-calls' is used we might get calls
1003 ;; with regions outside the current narrowing. This has been
1004 ;; observed in Emacs 20.7.
1006 (save-match-data ; c-recognize-<>-arglists changes match-data
1009 (when (> end (point-max))
1010 ;; Some emacsen might return positions past the end. This has been
1011 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1012 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1014 (setq end (point-max))
1018 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1019 (c-invalidate-sws-region-after beg end)
1020 (c-invalidate-state-cache beg)
1021 (c-invalidate-find-decl-cache beg)
1023 (when c-recognize-<>-arglists
1024 (c-after-change-check-<>-operators beg end))
1026 (if c-before-font-lock-function
1028 (funcall c-before-font-lock-function beg end old-len)))))))
1030 (defun c-after-font-lock-init ()
1031 ;; Put on `font-lock-mode-hook'.
1032 (remove-hook 'after-change-functions 'c-after-change t)
1033 (add-hook 'after-change-functions 'c-after-change nil t))
1035 (defun c-font-lock-init ()
1036 "Set up the font-lock variables for using the font-lock support in CC Mode.
1037 This does not load the font-lock package. Use after
1038 `c-basic-common-init' and after cc-fonts has been loaded."
1040 (make-local-variable 'font-lock-defaults)
1041 (setq font-lock-defaults
1042 `(,(if (c-major-mode-is 'awk-mode)
1043 ;; awk-mode currently has only one font lock level.
1044 'awk-font-lock-keywords
1045 (mapcar 'c-mode-symbol
1046 '("font-lock-keywords" "font-lock-keywords-1"
1047 "font-lock-keywords-2" "font-lock-keywords-3")))
1049 ,c-identifier-syntax-modifications
1050 c-beginning-of-syntax
1051 (font-lock-lines-before . 1)
1052 (font-lock-mark-block-function
1053 . c-mark-function)))
1055 (make-local-hook 'font-lock-mode-hook)
1056 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1058 (defun c-extend-after-change-region (beg end old-len)
1059 "Extend the region to be fontified, if necessary."
1060 ;; Note: the parameters are ignored here. This somewhat indirect
1061 ;; implementation exists because it is minimally different from the
1062 ;; stand-alone CC Mode which, lacking
1063 ;; font-lock-extend-after-change-region-function, is forced to use advice
1066 ;; Of the seven CC Mode languages, currently (2008-04) only AWK Mode makes
1067 ;; non-null use of this function.
1068 (cons c-new-BEG c-new-END))
1074 (defvar c-mode-syntax-table nil
1075 "Syntax table used in c-mode buffers.")
1076 (or c-mode-syntax-table
1077 (setq c-mode-syntax-table
1078 (funcall (c-lang-const c-make-mode-syntax-table c))))
1080 (defvar c-mode-abbrev-table nil
1081 "Abbreviation table used in c-mode buffers.")
1082 (c-define-abbrev-table 'c-mode-abbrev-table
1083 '(("else" "else" c-electric-continued-statement 0)
1084 ("while" "while" c-electric-continued-statement 0)))
1086 (defvar c-mode-map ()
1087 "Keymap used in c-mode buffers.")
1090 (setq c-mode-map (c-make-inherited-keymap))
1091 ;; add bindings which are only useful for C
1092 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1095 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
1096 (cons "C" (c-lang-const c-mode-menu c)))
1098 ;; In XEmacs >= 21.5 modes should add their own entries to
1099 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
1100 ;; doing this on load. That since `add-to-list' prepends the value
1101 ;; which could cause it to clobber user settings. Later emacsen have
1102 ;; an append option, but it's not safe to use.
1104 ;; The the extension ".C" is associated to C++ while the lowercase
1105 ;; variant goes to C. On case insensitive file systems, this means
1106 ;; that ".c" files also might open C++ mode if the C++ entry comes
1107 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1108 ;; after ".c", and since `add-to-list' adds the entry first we have to
1109 ;; add the ".C" entry first.
1110 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1111 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1112 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1114 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1116 ;; NB: The following two associate yacc and lex files to C Mode, which
1117 ;; is not really suitable for those formats. Anyway, afaik there's
1118 ;; currently no better mode for them, and besides this is legacy.
1119 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1120 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1122 ;; Preprocessed files generated by C and C++ compilers.
1123 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1124 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1129 "Major mode for editing K&R and ANSI C code.
1130 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1131 c-mode buffer. This automatically sets up a mail buffer with version
1132 information already added. You just need to add a description of the
1133 problem, including a reproducible test case, and send the message.
1135 To see what version of CC Mode you are running, enter `\\[c-version]'.
1137 The hook `c-mode-common-hook' is run with no args at mode
1138 initialization, then `c-mode-hook'.
1143 (kill-all-local-variables)
1144 (c-initialize-cc-mode t)
1145 (set-syntax-table c-mode-syntax-table)
1146 (setq major-mode 'c-mode
1148 local-abbrev-table c-mode-abbrev-table
1150 (use-local-map c-mode-map)
1151 (c-init-language-vars-for 'c-mode)
1152 (c-common-init 'c-mode)
1153 (easy-menu-add c-c-menu)
1154 (cc-imenu-init cc-imenu-c-generic-expression)
1155 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
1156 (c-update-modeline))
1162 (defvar c++-mode-syntax-table nil
1163 "Syntax table used in c++-mode buffers.")
1164 (or c++-mode-syntax-table
1165 (setq c++-mode-syntax-table
1166 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1168 (defvar c++-mode-abbrev-table nil
1169 "Abbreviation table used in c++-mode buffers.")
1170 (c-define-abbrev-table 'c++-mode-abbrev-table
1171 '(("else" "else" c-electric-continued-statement 0)
1172 ("while" "while" c-electric-continued-statement 0)
1173 ("catch" "catch" c-electric-continued-statement 0)))
1175 (defvar c++-mode-map ()
1176 "Keymap used in c++-mode buffers.")
1179 (setq c++-mode-map (c-make-inherited-keymap))
1180 ;; add bindings which are only useful for C++
1181 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1182 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1183 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1184 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1186 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
1187 (cons "C++" (c-lang-const c-mode-menu c++)))
1191 "Major mode for editing C++ code.
1192 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1193 c++-mode buffer. This automatically sets up a mail buffer with
1194 version information already added. You just need to add a description
1195 of the problem, including a reproducible test case, and send the
1198 To see what version of CC Mode you are running, enter `\\[c-version]'.
1200 The hook `c-mode-common-hook' is run with no args at mode
1201 initialization, then `c++-mode-hook'.
1206 (kill-all-local-variables)
1207 (c-initialize-cc-mode t)
1208 (set-syntax-table c++-mode-syntax-table)
1209 (setq major-mode 'c++-mode
1211 local-abbrev-table c++-mode-abbrev-table
1213 (use-local-map c++-mode-map)
1214 (c-init-language-vars-for 'c++-mode)
1215 (c-common-init 'c++-mode)
1216 (easy-menu-add c-c++-menu)
1217 (cc-imenu-init cc-imenu-c++-generic-expression)
1218 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
1219 (c-update-modeline))
1222 ;; Support for Objective-C
1225 (defvar objc-mode-syntax-table nil
1226 "Syntax table used in objc-mode buffers.")
1227 (or objc-mode-syntax-table
1228 (setq objc-mode-syntax-table
1229 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1231 (defvar objc-mode-abbrev-table nil
1232 "Abbreviation table used in objc-mode buffers.")
1233 (c-define-abbrev-table 'objc-mode-abbrev-table
1234 '(("else" "else" c-electric-continued-statement 0)
1235 ("while" "while" c-electric-continued-statement 0)))
1237 (defvar objc-mode-map ()
1238 "Keymap used in objc-mode buffers.")
1241 (setq objc-mode-map (c-make-inherited-keymap))
1242 ;; add bindings which are only useful for Objective-C
1243 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1245 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
1246 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1248 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
1252 "Major mode for editing Objective C code.
1253 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1254 objc-mode buffer. This automatically sets up a mail buffer with
1255 version information already added. You just need to add a description
1256 of the problem, including a reproducible test case, and send the
1259 To see what version of CC Mode you are running, enter `\\[c-version]'.
1261 The hook `c-mode-common-hook' is run with no args at mode
1262 initialization, then `objc-mode-hook'.
1267 (kill-all-local-variables)
1268 (c-initialize-cc-mode t)
1269 (set-syntax-table objc-mode-syntax-table)
1270 (setq major-mode 'objc-mode
1272 local-abbrev-table objc-mode-abbrev-table
1274 (use-local-map objc-mode-map)
1275 (c-init-language-vars-for 'objc-mode)
1276 (c-common-init 'objc-mode)
1277 (easy-menu-add c-objc-menu)
1278 (cc-imenu-init nil 'cc-imenu-objc-function)
1279 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
1280 (c-update-modeline))
1286 (defvar java-mode-syntax-table nil
1287 "Syntax table used in java-mode buffers.")
1288 (or java-mode-syntax-table
1289 (setq java-mode-syntax-table
1290 (funcall (c-lang-const c-make-mode-syntax-table java))))
1292 (defvar java-mode-abbrev-table nil
1293 "Abbreviation table used in java-mode buffers.")
1294 (c-define-abbrev-table 'java-mode-abbrev-table
1295 '(("else" "else" c-electric-continued-statement 0)
1296 ("while" "while" c-electric-continued-statement 0)
1297 ("catch" "catch" c-electric-continued-statement 0)
1298 ("finally" "finally" c-electric-continued-statement 0)))
1300 (defvar java-mode-map ()
1301 "Keymap used in java-mode buffers.")
1304 (setq java-mode-map (c-make-inherited-keymap))
1305 ;; add bindings which are only useful for Java
1308 ;; Regexp trying to describe the beginning of a Java top-level
1309 ;; definition. This is not used by CC Mode, nor is it maintained
1310 ;; since it's practically impossible to write a regexp that reliably
1311 ;; matches such a construct. Other tools are necessary.
1312 (defconst c-Java-defun-prompt-regexp
1313 "^[ \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-*")
1315 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
1316 (cons "Java" (c-lang-const c-mode-menu java)))
1318 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
1322 "Major mode for editing Java code.
1323 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1324 java-mode buffer. This automatically sets up a mail buffer with
1325 version information already added. You just need to add a description
1326 of the problem, including a reproducible test case, and send the
1329 To see what version of CC Mode you are running, enter `\\[c-version]'.
1331 The hook `c-mode-common-hook' is run with no args at mode
1332 initialization, then `java-mode-hook'.
1337 (kill-all-local-variables)
1338 (c-initialize-cc-mode t)
1339 (set-syntax-table java-mode-syntax-table)
1340 (setq major-mode 'java-mode
1342 local-abbrev-table java-mode-abbrev-table
1344 (use-local-map java-mode-map)
1345 (c-init-language-vars-for 'java-mode)
1346 (c-common-init 'java-mode)
1347 (easy-menu-add c-java-menu)
1348 (cc-imenu-init cc-imenu-java-generic-expression)
1349 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
1350 (c-update-modeline))
1353 ;; Support for CORBA's IDL language
1356 (defvar idl-mode-syntax-table nil
1357 "Syntax table used in idl-mode buffers.")
1358 (or idl-mode-syntax-table
1359 (setq idl-mode-syntax-table
1360 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1362 (defvar idl-mode-abbrev-table nil
1363 "Abbreviation table used in idl-mode buffers.")
1364 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
1366 (defvar idl-mode-map ()
1367 "Keymap used in idl-mode buffers.")
1370 (setq idl-mode-map (c-make-inherited-keymap))
1371 ;; add bindings which are only useful for IDL
1374 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
1375 (cons "IDL" (c-lang-const c-mode-menu idl)))
1377 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
1381 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
1382 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1383 idl-mode buffer. This automatically sets up a mail buffer with
1384 version information already added. You just need to add a description
1385 of the problem, including a reproducible test case, and send the
1388 To see what version of CC Mode you are running, enter `\\[c-version]'.
1390 The hook `c-mode-common-hook' is run with no args at mode
1391 initialization, then `idl-mode-hook'.
1396 (kill-all-local-variables)
1397 (c-initialize-cc-mode t)
1398 (set-syntax-table idl-mode-syntax-table)
1399 (setq major-mode 'idl-mode
1401 local-abbrev-table idl-mode-abbrev-table)
1402 (use-local-map idl-mode-map)
1403 (c-init-language-vars-for 'idl-mode)
1404 (c-common-init 'idl-mode)
1405 (easy-menu-add c-idl-menu)
1406 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
1407 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
1408 (c-update-modeline))
1414 (defvar pike-mode-syntax-table nil
1415 "Syntax table used in pike-mode buffers.")
1416 (or pike-mode-syntax-table
1417 (setq pike-mode-syntax-table
1418 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1420 (defvar pike-mode-abbrev-table nil
1421 "Abbreviation table used in pike-mode buffers.")
1422 (c-define-abbrev-table 'pike-mode-abbrev-table
1423 '(("else" "else" c-electric-continued-statement 0)
1424 ("while" "while" c-electric-continued-statement 0)))
1426 (defvar pike-mode-map ()
1427 "Keymap used in pike-mode buffers.")
1430 (setq pike-mode-map (c-make-inherited-keymap))
1431 ;; additional bindings
1432 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1434 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
1435 (cons "Pike" (c-lang-const c-mode-menu pike)))
1437 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1438 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
1442 "Major mode for editing Pike code.
1443 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1444 pike-mode buffer. This automatically sets up a mail buffer with
1445 version information already added. You just need to add a description
1446 of the problem, including a reproducible test case, and send the
1449 To see what version of CC Mode you are running, enter `\\[c-version]'.
1451 The hook `c-mode-common-hook' is run with no args at mode
1452 initialization, then `pike-mode-hook'.
1457 (kill-all-local-variables)
1458 (c-initialize-cc-mode t)
1459 (set-syntax-table pike-mode-syntax-table)
1460 (setq major-mode 'pike-mode
1462 local-abbrev-table pike-mode-abbrev-table
1464 (use-local-map pike-mode-map)
1465 (c-init-language-vars-for 'pike-mode)
1466 (c-common-init 'pike-mode)
1467 (easy-menu-add c-pike-menu)
1468 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
1469 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
1470 (c-update-modeline))
1475 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1476 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1477 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1478 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1479 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
1481 ;;; Autoload directives must be on the top level, so we construct an
1482 ;;; autoload form instead.
1483 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1485 (defvar awk-mode-abbrev-table nil
1486 "Abbreviation table used in awk-mode buffers.")
1487 (c-define-abbrev-table 'awk-mode-abbrev-table
1488 '(("else" "else" c-electric-continued-statement 0)
1489 ("while" "while" c-electric-continued-statement 0)))
1491 (defvar awk-mode-map ()
1492 "Keymap used in awk-mode buffers.")
1495 (setq awk-mode-map (c-make-inherited-keymap))
1496 ;; add bindings which are only useful for awk.
1497 (define-key awk-mode-map "#" 'self-insert-command)
1498 (define-key awk-mode-map "/" 'self-insert-command)
1499 (define-key awk-mode-map "*" 'self-insert-command)
1500 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1501 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1502 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1503 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1504 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1505 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1506 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1508 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1509 (cons "AWK" (c-lang-const c-mode-menu awk)))
1511 ;; (require 'cc-awk) brings these in.
1512 (defvar awk-mode-syntax-table)
1513 (declare-function c-awk-unstick-NL-prop "cc-awk" ())
1516 "Major mode for editing AWK code.
1517 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1518 awk-mode buffer. This automatically sets up a mail buffer with version
1519 information already added. You just need to add a description of the
1520 problem, including a reproducible test case, and send the message.
1522 To see what version of CC Mode you are running, enter `\\[c-version]'.
1524 The hook `c-mode-common-hook' is run with no args at mode
1525 initialization, then `awk-mode-hook'.
1530 (require 'cc-awk) ; Added 2003/6/10.
1531 (kill-all-local-variables)
1532 (c-initialize-cc-mode t)
1533 (set-syntax-table awk-mode-syntax-table)
1534 (setq major-mode 'awk-mode
1536 local-abbrev-table awk-mode-abbrev-table
1538 (use-local-map awk-mode-map)
1539 (c-init-language-vars-for 'awk-mode)
1540 (c-common-init 'awk-mode)
1541 (c-awk-unstick-NL-prop)
1543 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1544 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1545 (defalias 'c-in-literal 'c-slow-in-literal)
1547 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1548 (c-update-modeline))
1553 (defconst c-mode-help-address
1554 "bug-cc-mode@gnu.org"
1555 "Address(es) for CC Mode bug reports.")
1558 "Echo the current version of CC Mode in the minibuffer."
1560 (message "Using CC Mode version %s" c-version)
1561 (c-keep-region-active))
1563 (defvar c-prepare-bug-report-hooks nil)
1565 ;; Dynamic variables used by reporter.
1566 (defvar reporter-prompt-for-summary-p)
1567 (defvar reporter-dont-compact-list)
1569 (defun c-submit-bug-report ()
1570 "Submit via mail a bug report on CC Mode."
1574 (let ((reporter-prompt-for-summary-p t)
1575 (reporter-dont-compact-list '(c-offsets-alist))
1576 (style c-indentation-style)
1577 (c-features c-emacs-features))
1579 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1581 (reporter-submit-bug-report
1583 (concat "CC Mode " c-version " (" mode-name ")")
1586 '(c-buffer-is-cc-mode
1588 c-syntactic-indentation
1589 c-syntactic-indentation-in-macros
1591 c-auto-align-backslashes
1592 c-backspace-function
1594 c-electric-pound-behavior
1596 c-enable-xemacs-performance-kludge-p
1597 c-old-style-variable-behavior
1601 parse-sexp-ignore-comments
1602 parse-sexp-lookup-properties
1603 lookup-syntax-properties
1604 ;; A brain-damaged XEmacs only variable that, if
1605 ;; set to nil can cause all kinds of chaos.
1606 signal-error-on-buffer-boundary
1607 ;; Variables that affect line breaking and comments.
1617 adaptive-fill-regexp)
1619 (mapc (lambda (var) (unless (boundp var)
1620 (setq vars (delq var vars))))
1621 '(signal-error-on-buffer-boundary
1625 font-lock-maximum-decoration
1626 parse-sexp-lookup-properties
1627 lookup-syntax-properties))
1630 (run-hooks 'c-prepare-bug-report-hooks)
1631 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1632 style c-features)))))))
1635 (cc-provide 'cc-mode)
1637 ;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
1638 ;;; cc-mode.el ends here