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 'subword-mode
"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" '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 ;; Initialise the cache of brace pairs, and opening braces/brackets/parens.
523 (when (or c-recognize-<>-arglists
524 (c-major-mode-is 'awk-mode)
525 (c-major-mode-is '(c-mode c++-mode objc-mode)))
526 ;; We'll use the syntax-table text property to change the syntax
527 ;; of some chars for this language, so do the necessary setup for
530 ;; Note to other package developers: It's ok to turn this on in CC
531 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
532 ;; off if CC Mode has turned it on.
535 (when (boundp 'parse-sexp-lookup-properties)
536 (make-local-variable 'parse-sexp-lookup-properties)
537 (setq parse-sexp-lookup-properties t))
539 ;; Same as above for XEmacs.
540 (when (boundp 'lookup-syntax-properties)
541 (make-local-variable 'lookup-syntax-properties)
542 (setq lookup-syntax-properties t)))
544 ;; Use this in Emacs 21 to avoid meddling with the rear-nonsticky
545 ;; property on each character.
546 (when (boundp 'text-property-default-nonsticky)
547 (make-local-variable 'text-property-default-nonsticky)
548 (let ((elem (assq 'syntax-table text-property-default-nonsticky)))
551 (setq text-property-default-nonsticky
552 (cons '(syntax-table . t)
553 text-property-default-nonsticky))))
554 (setq text-property-default-nonsticky
556 text-property-default-nonsticky)))
558 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
559 ;; heuristic that open parens in column 0 are defun starters. Since
560 ;; we have c-state-cache, that heuristic isn't useful and only causes
561 ;; trouble, so turn it off.
562 ;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
563 ;; helpful. Comment it out for now.
564 ;; (when (memq 'col-0-paren c-emacs-features)
565 ;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
566 ;; (setq open-paren-in-column-0-is-defun-start nil))
568 (c-clear-found-types)
570 ;; now set the mode style based on default-style
571 (let ((style (if (stringp default-style)
573 (or (cdr (assq mode default-style))
574 (cdr (assq 'other default-style))
576 ;; Override style variables if `c-old-style-variable-behavior' is
577 ;; set. Also override if we are using global style variables,
578 ;; have already initialized a style once, and are switching to a
579 ;; different style. (It's doubtful whether this is desirable, but
580 ;; the whole situation with nonlocal style variables is a bit
581 ;; awkward. It's at least the most compatible way with the old
582 ;; style init procedure.)
583 (c-set-style style (not (or c-old-style-variable-behavior
584 (and (not c-style-variables-are-local-p)
586 (not (string-equal c-indentation-style
588 (c-setup-paragraph-variables)
590 ;; we have to do something special for c-offsets-alist so that the
591 ;; buffer local value has its own alist structure.
592 (setq c-offsets-alist (copy-alist c-offsets-alist))
594 ;; setup the comment indent variable in a Emacs version portable way
595 (make-local-variable 'comment-indent-function)
596 (setq comment-indent-function 'c-comment-indent)
598 ;; ;; Put submode indicators onto minor-mode-alist, but only once.
599 ;; (or (assq 'c-submode-indicators minor-mode-alist)
600 ;; (setq minor-mode-alist
601 ;; (cons '(c-submode-indicators c-submode-indicators)
602 ;; minor-mode-alist)))
605 ;; Install the functions that ensure that various internal caches
606 ;; don't become invalid due to buffer changes.
607 (make-local-hook 'before-change-functions)
608 (add-hook 'before-change-functions 'c-before-change nil t)
609 (make-local-hook 'after-change-functions)
610 (add-hook 'after-change-functions 'c-after-change nil t)
611 (set (make-local-variable 'font-lock-extend-after-change-region-function)
612 'c-extend-after-change-region)) ; Currently (2009-05) used by all
613 ; lanaguages with #define (C, C++,; ObjC), and by AWK.
615 (defun c-setup-doc-comment-style ()
616 "Initialize the variables that depend on the value of `c-doc-comment-style'."
617 (when (and (featurep 'font-lock)
618 (symbol-value 'font-lock-mode))
619 ;; Force font lock mode to reinitialize itself.
623 (defun c-common-init (&optional mode)
624 "Common initialization for all CC Mode modes.
625 In addition to the work done by `c-basic-common-init' and
626 `c-font-lock-init', this function sets up various other things as
627 customary in CC Mode modes but which aren't strictly necessary for CC
628 Mode to operate correctly.
630 MODE is the symbol for the mode to initialize, like 'c-mode. See
631 `c-basic-common-init' for details. It's only optional to be
632 compatible with old code; callers should always specify it."
635 ;; Called from an old third party package. The fallback is to
637 (c-init-language-vars-for 'c-mode))
639 (c-basic-common-init mode c-default-style)
641 ;; Only initialize font locking if we aren't called from an old package.
644 ;; Starting a mode is a sort of "change". So call the change functions...
648 (if c-get-state-before-change-function
649 (funcall c-get-state-before-change-function (point-min) (point-max)))
650 (if c-before-font-lock-function
651 (funcall c-before-font-lock-function (point-min) (point-max)
652 (- (point-max) (point-min))))))
654 (make-local-variable 'outline-regexp)
655 (make-local-variable 'outline-level)
656 (setq outline-regexp "[^#\n\^M]"
657 outline-level 'c-outline-level)
659 (let ((rfn (assq mode c-require-final-newline)))
661 (make-local-variable 'require-final-newline)
663 (setq require-final-newline mode-require-final-newline)))))
665 (defun c-before-hack-hook ()
666 "Set the CC Mode style and \"offsets\" when in the buffer's local variables.
667 They are set only when, respectively, the pseudo variables
668 `c-file-style' and `c-file-offsets' are present in the list.
670 This function is called from the hook `before-hack-local-variables-hook'."
671 (when c-buffer-is-cc-mode
672 (let ((stile (cdr (assq 'c-file-style file-local-variables-alist)))
673 (offsets (cdr (assq 'c-file-offsets file-local-variables-alist))))
675 (or (stringp stile) (error "c-file-style is not a string"))
676 (c-set-style stile t))
680 (let ((langelem (car langentry))
681 (offset (cdr langentry)))
682 (c-set-offset langelem offset)))
685 (defun c-remove-any-local-eval-or-mode-variables ()
686 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
687 ;; or on the first line, remove all occurrences. See
688 ;; `c-postprocess-file-styles' for justification. There is no need to save
689 ;; point here, or even bother too much about the buffer contents. However,
690 ;; DON'T mess up the kill-ring.
692 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
694 (goto-char (point-max))
695 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
696 (let (lv-point (prefix "") (suffix ""))
697 (when (let ((case-fold-search t))
698 (search-forward "Local Variables:" nil t))
699 (setq lv-point (point))
700 ;; The prefix is what comes before "local variables:" in its line.
701 ;; The suffix is what comes after "local variables:" in its line.
702 (skip-chars-forward " \t")
704 (setq suffix (buffer-substring (point)
705 (progn (end-of-line) (point)))))
706 (goto-char (match-beginning 0))
709 (buffer-substring (point)
710 (progn (beginning-of-line) (point)))))
712 (while (search-forward-regexp
714 (regexp-quote prefix)
715 "\\(mode\\|eval\\):.*"
716 (regexp-quote suffix)
720 (delete-region (point) (progn (forward-line) (point)))))
722 ;; Delete the first line, if we've got one, in case it contains a mode spec.
723 (unless (and lv-point
724 (progn (goto-char lv-point)
727 (goto-char (point-min))
729 (delete-region (point) (progn (forward-line) (point)))))))
731 (defun c-postprocess-file-styles ()
732 "Function that post processes relevant file local variables in CC Mode.
733 Currently, this function simply applies any style and offset settings
734 found in the file's Local Variable list. It first applies any style
735 setting found in `c-file-style', then it applies any offset settings
736 it finds in `c-file-offsets'.
738 Note that the style variables are always made local to the buffer."
740 ;; apply file styles and offsets
741 (when c-buffer-is-cc-mode
742 (if (or c-file-style c-file-offsets)
743 (c-make-styles-buffer-local t))
745 (or (stringp c-file-style)
746 (error "c-file-style is not a string"))
747 (c-set-style c-file-style t))
752 (let ((langelem (car langentry))
753 (offset (cdr langentry)))
754 (c-set-offset langelem offset)))
756 ;; Problem: The file local variable block might have explicitly set a
757 ;; style variable. The `c-set-style' or `mapcar' call might have
758 ;; overwritten this. So we run `hack-local-variables' again to remedy
759 ;; this. There are no guarantees this will work properly, particularly as
760 ;; we have no control over what the other hook functions on
761 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
762 ;; any `eval' or `mode' expressions before we evaluate again (see below).
765 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
766 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
767 ;; We prevent this by temporarily removing `mode' from the Local Variables
769 (if (or c-file-style c-file-offsets)
770 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
771 (c-tentative-buffer-changes
772 (c-remove-any-local-eval-or-mode-variables)
773 (hack-local-variables))
776 (if (boundp 'before-hack-local-variables-hook)
777 (add-hook 'before-hack-local-variables-hook 'c-before-hack-hook)
778 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles))
780 (defmacro c-run-mode-hooks (&rest hooks)
781 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
782 ;; require the use of the new function `run-mode-hooks'.
783 (if (cc-bytecomp-fboundp 'run-mode-hooks)
784 `(run-mode-hooks ,@hooks)
785 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
788 ;;; Change hooks, linking with Font Lock.
790 ;; Buffer local variables defining the region to be fontified by a font lock
791 ;; after-change function. They are set in c-after-change to
792 ;; after-change-function's BEG and END, and may be modified by a
793 ;; `c-before-font-lock-function'.
795 (make-variable-buffer-local 'c-new-BEG)
797 (make-variable-buffer-local 'c-new-END)
799 ;; Buffer local variables recording Beginning/End-of-Macro position before a
800 ;; change, when a macro straddles, respectively, the BEG or END (or both) of
801 ;; the change region. Otherwise these have the values BEG/END.
803 (make-variable-buffer-local 'c-old-BOM)
805 (make-variable-buffer-local 'c-old-EOM)
807 (defun c-extend-region-for-CPP (beg end)
808 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
809 ;; beginning/end of any preprocessor construct they may be in.
811 ;; Point is undefined both before and after this function call; the buffer
812 ;; has already been widened, and match-data saved. The return value is
815 ;; This function is the C/C++/ObjC value of
816 ;; `c-get-state-before-change-function' and is called exclusively as a
817 ;; before change function.
819 (c-beginning-of-macro)
820 (setq c-old-BOM (point))
823 (if (c-beginning-of-macro)
825 (setq c-old-EOM (point)))
827 (defun c-neutralize-CPP-line (beg end)
828 ;; BEG and END bound a region, typically a preprocessor line. Put a
829 ;; "punctuation" syntax-table property on syntactically obtrusive
830 ;; characters, ones which would interact syntactically with stuff outside
833 ;; These are unmatched string delimiters, or unmatched
834 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
840 (setq s (parse-partial-sexp beg end -1))
842 ((< (nth 0 s) 0) ; found an unmated ),},]
843 (c-put-char-property (1- (point)) 'syntax-table '(1))
845 ((nth 3 s) ; In a string
846 (c-put-char-property (nth 8 s) 'syntax-table '(1))
848 ((> (nth 0 s) 0) ; In a (,{,[
849 (c-put-char-property (nth 1 s) 'syntax-table '(1))
853 (defun c-neutralize-syntax-in-and-mark-CPP (begg endd old-len)
854 ;; (i) Extend the font lock region to cover all changed preprocessor
855 ;; regions; it does this by setting the variables `c-new-BEG' and
856 ;; `c-new-END' to the new boundaries.
858 ;; (ii) "Neutralize" every preprocessor line wholly or partially in the
859 ;; extended changed region. "Restore" lines which were CPP lines before the
860 ;; change and are no longer so; these can be located from the Buffer local
861 ;; variables `c-old-BOM' and `c-old-EOM'.
863 ;; (iii) Mark every CPP construct by placing a `category' property value
864 ;; `c-cpp-delimiter' at its start and end. The marked characters are the
865 ;; opening # and usually the terminating EOL, but sometimes the character
866 ;; before a comment/string delimiter.
868 ;; That is, set syntax-table properties on characters that would otherwise
869 ;; interact syntactically with those outside the CPP line(s).
871 ;; This function is called from an after-change function, BEGG ENDD and
872 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
873 ;; locking, hence must get called before `font-lock-after-change-function'.
875 ;; Point is undefined both before and after this function call, the buffer
876 ;; has been widened, and match-data saved. The return value is ignored.
878 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
880 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
882 ;; This function might make hidden buffer changes.
883 (c-save-buffer-state (limits)
884 ;; First determine the region, (c-new-BEG c-new-END), which will get font
885 ;; locked. It might need "neutralizing". This region may not start
886 ;; inside a string, comment, or macro.
887 (goto-char c-old-BOM) ; already set to old start of macro or begg.
889 (if (setq limits (c-state-literal-at (point)))
890 (cdr limits) ; go forward out of any string or comment.
894 (if (setq limits (c-state-literal-at (point)))
895 (goto-char (car limits))) ; go backward out of any string or comment.
896 (if (c-beginning-of-macro)
898 (setq c-new-END (max (+ (- c-old-EOM old-len) (- endd begg))
901 ;; Clear all old relevant properties.
902 (c-clear-char-property-with-value c-new-BEG c-new-END 'syntax-table '(1))
903 (c-clear-char-property-with-value c-new-BEG c-new-END 'category 'c-cpp-delimiter)
904 ;; FIXME!!! What about the "<" and ">" category properties? 2009-11-16
906 ;; Add needed properties to each CPP construct in the region.
907 (goto-char c-new-BEG)
908 (let ((pps-position c-new-BEG) pps-state mbeg)
909 (while (and (< (point) c-new-END)
910 (search-forward-regexp c-anchored-cpp-prefix c-new-END t))
911 ;; If we've found a "#" inside a string/comment, ignore it.
913 (parse-partial-sexp pps-position (point) nil nil pps-state)
914 pps-position (point))
915 (unless (or (nth 3 pps-state) ; in a string?
916 (nth 4 pps-state)) ; in a comment?
917 (goto-char (match-beginning 0))
919 (if (> (c-syntactic-end-of-macro) mbeg)
921 (c-neutralize-CPP-line mbeg (point))
922 (c-set-cpp-delimiters mbeg (point))
923 ;(setq pps-position (point))
925 (forward-line)) ; no infinite loop with, e.g., "#//"
928 (defun c-before-change (beg end)
929 ;; Function to be put on `before-change-function'. Primarily, this calls
930 ;; the language dependent `c-get-state-before-change-function'. It is
931 ;; otherwise used only to remove stale entries from the `c-found-types'
932 ;; cache, and to record entries which a `c-after-change' function might
935 ;; Note that this function must be FAST rather than accurate. Note
936 ;; also that it only has any effect when font locking is enabled.
937 ;; We exploit this by checking for font-lock-*-face instead of doing
938 ;; rigourous syntactic analysis.
940 ;; If either change boundary is wholly inside an identifier, delete
941 ;; it/them from the cache. Don't worry about being inside a string
942 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
944 (setq c-maybe-stale-found-type nil)
949 ;; Are we inserting/deleting stuff in the middle of an identifier?
950 (c-unfind-enclosing-token beg)
951 (c-unfind-enclosing-token end)
952 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
954 (c-unfind-coalesced-tokens beg end))
955 ;; Are we (potentially) disrupting the syntactic context which
956 ;; makes a type a type? E.g. by inserting stuff after "foo" in
957 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
959 ;; We search for appropriate c-type properties "near" the change.
960 ;; First, find an appropriate boundary for this property search.
965 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
966 (previous-single-property-change end 'face))
968 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
969 ;; Find a limit for the search for a `c-type' property
971 (and (/= (skip-chars-backward "^;{}") 0)
972 (> (point) (point-min))
973 (memq (c-get-char-property (1- (point)) 'face)
974 '(font-lock-comment-face font-lock-string-face))))
975 (setq lim (max (point-min) (1- (point))))
977 ;; Look for the latest `c-type' property before end1
978 (when (and (> end1 (point-min))
980 (if (get-text-property (1- end1) 'c-type)
982 (previous-single-property-change end1 'c-type nil lim))))
983 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
985 (when (memq type '(c-decl-id-start c-decl-type-start))
986 ;; Get the identifier, if any, that the property is on.
987 (goto-char (1- type-pos))
989 (when (looking-at "\\(\\sw\\|\\s_\\)")
990 (c-beginning-of-current-token)
991 (buffer-substring-no-properties (point) type-pos)))
994 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
997 (or (next-single-property-change end 'c-type nil lim) lim))
998 (setq c-maybe-stale-found-type
1001 (buffer-substring-no-properties type-pos term-pos)
1002 (buffer-substring-no-properties beg end)))))))
1004 ;; (c-new-BEG c-new-END) will be the region to fontify. It may become
1005 ;; larger than (beg end).
1008 (if c-get-state-before-change-function
1009 (funcall c-get-state-before-change-function beg end))
1012 (defun c-after-change (beg end old-len)
1013 ;; Function put on `after-change-functions' to adjust various caches
1014 ;; etc. Prefer speed to finesse here, since there will be an order
1015 ;; of magnitude more calls to this function than any of the
1016 ;; functions that use the caches.
1018 ;; Note that care must be taken so that this is called before any
1019 ;; font-lock callbacks since we might get calls to functions using
1020 ;; these caches from inside them, and we must thus be sure that this
1021 ;; has already been executed.
1023 ;; This calls the language variable c-before-font-lock-function, if non nil.
1024 ;; This typically sets `syntax-table' properties.
1026 (c-save-buffer-state ()
1027 ;; When `combine-after-change-calls' is used we might get calls
1028 ;; with regions outside the current narrowing. This has been
1029 ;; observed in Emacs 20.7.
1031 (save-match-data ; c-recognize-<>-arglists changes match-data
1034 (when (> end (point-max))
1035 ;; Some emacsen might return positions past the end. This has been
1036 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1037 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1039 (setq end (point-max))
1043 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1044 (c-invalidate-sws-region-after beg end)
1045 (c-invalidate-state-cache beg)
1046 (c-invalidate-find-decl-cache beg)
1048 (when c-recognize-<>-arglists
1049 (c-after-change-check-<>-operators beg end))
1051 (if c-before-font-lock-function
1053 (funcall c-before-font-lock-function beg end old-len)))))))
1055 (defun c-after-font-lock-init ()
1056 ;; Put on `font-lock-mode-hook'.
1057 (remove-hook 'after-change-functions 'c-after-change t)
1058 (add-hook 'after-change-functions 'c-after-change nil t))
1060 (defun c-font-lock-init ()
1061 "Set up the font-lock variables for using the font-lock support in CC Mode.
1062 This does not load the font-lock package. Use after
1063 `c-basic-common-init' and after cc-fonts has been loaded."
1065 (make-local-variable 'font-lock-defaults)
1066 (setq font-lock-defaults
1067 `(,(if (c-major-mode-is 'awk-mode)
1068 ;; awk-mode currently has only one font lock level.
1069 'awk-font-lock-keywords
1070 (mapcar 'c-mode-symbol
1071 '("font-lock-keywords" "font-lock-keywords-1"
1072 "font-lock-keywords-2" "font-lock-keywords-3")))
1074 ,c-identifier-syntax-modifications
1075 c-beginning-of-syntax
1076 (font-lock-mark-block-function
1077 . c-mark-function)))
1079 (make-local-hook 'font-lock-mode-hook)
1080 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1082 (defun c-extend-after-change-region (beg end old-len)
1083 "Extend the region to be fontified, if necessary."
1084 ;; Note: the parameters are ignored here. This somewhat indirect
1085 ;; implementation exists because it is minimally different from the
1086 ;; stand-alone CC Mode which, lacking
1087 ;; font-lock-extend-after-change-region-function, is forced to use advice
1090 ;; Of the seven CC Mode languages, currently (2009-05) only C, C++, Objc
1091 ;; (the languages with #define) and AWK Mode make non-null use of this
1093 (cons c-new-BEG c-new-END))
1099 (defvar c-mode-syntax-table nil
1100 "Syntax table used in c-mode buffers.")
1101 (or c-mode-syntax-table
1102 (setq c-mode-syntax-table
1103 (funcall (c-lang-const c-make-mode-syntax-table c))))
1105 (defvar c-mode-abbrev-table nil
1106 "Abbreviation table used in c-mode buffers.")
1107 (c-define-abbrev-table 'c-mode-abbrev-table
1108 '(("else" "else" c-electric-continued-statement 0)
1109 ("while" "while" c-electric-continued-statement 0)))
1111 (defvar c-mode-map ()
1112 "Keymap used in c-mode buffers.")
1115 (setq c-mode-map (c-make-inherited-keymap))
1116 ;; add bindings which are only useful for C
1117 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1120 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
1121 (cons "C" (c-lang-const c-mode-menu c)))
1123 ;; In XEmacs >= 21.5 modes should add their own entries to
1124 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
1125 ;; doing this on load. That since `add-to-list' prepends the value
1126 ;; which could cause it to clobber user settings. Later emacsen have
1127 ;; an append option, but it's not safe to use.
1129 ;; The extension ".C" is associated with C++ while the lowercase
1130 ;; variant goes with C. On case insensitive file systems, this means
1131 ;; that ".c" files also might open C++ mode if the C++ entry comes
1132 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1133 ;; after ".c", and since `add-to-list' adds the entry first we have to
1134 ;; add the ".C" entry first.
1135 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1136 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1137 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1139 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1141 ;; NB: The following two associate yacc and lex files to C Mode, which
1142 ;; is not really suitable for those formats. Anyway, afaik there's
1143 ;; currently no better mode for them, and besides this is legacy.
1144 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1145 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1147 ;; Preprocessed files generated by C and C++ compilers.
1148 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1149 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1154 "Major mode for editing K&R and ANSI C code.
1155 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1156 c-mode buffer. This automatically sets up a mail buffer with version
1157 information already added. You just need to add a description of the
1158 problem, including a reproducible test case, and send the message.
1160 To see what version of CC Mode you are running, enter `\\[c-version]'.
1162 The hook `c-mode-common-hook' is run with no args at mode
1163 initialization, then `c-mode-hook'.
1168 (kill-all-local-variables)
1169 (c-initialize-cc-mode t)
1170 (set-syntax-table c-mode-syntax-table)
1171 (setq major-mode 'c-mode
1173 local-abbrev-table c-mode-abbrev-table
1175 (use-local-map c-mode-map)
1176 (c-init-language-vars-for 'c-mode)
1177 (c-common-init 'c-mode)
1178 (easy-menu-add c-c-menu)
1179 (cc-imenu-init cc-imenu-c-generic-expression)
1180 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
1181 (c-update-modeline))
1187 (defvar c++-mode-syntax-table nil
1188 "Syntax table used in c++-mode buffers.")
1189 (or c++-mode-syntax-table
1190 (setq c++-mode-syntax-table
1191 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1193 (defvar c++-mode-abbrev-table nil
1194 "Abbreviation table used in c++-mode buffers.")
1195 (c-define-abbrev-table 'c++-mode-abbrev-table
1196 '(("else" "else" c-electric-continued-statement 0)
1197 ("while" "while" c-electric-continued-statement 0)
1198 ("catch" "catch" c-electric-continued-statement 0)))
1200 (defvar c++-mode-map ()
1201 "Keymap used in c++-mode buffers.")
1204 (setq c++-mode-map (c-make-inherited-keymap))
1205 ;; add bindings which are only useful for C++
1206 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1207 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1208 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1209 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1211 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
1212 (cons "C++" (c-lang-const c-mode-menu c++)))
1216 "Major mode for editing C++ code.
1217 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1218 c++-mode buffer. This automatically sets up a mail buffer with
1219 version information already added. You just need to add a description
1220 of the problem, including a reproducible test case, and send the
1223 To see what version of CC Mode you are running, enter `\\[c-version]'.
1225 The hook `c-mode-common-hook' is run with no args at mode
1226 initialization, then `c++-mode-hook'.
1231 (kill-all-local-variables)
1232 (c-initialize-cc-mode t)
1233 (set-syntax-table c++-mode-syntax-table)
1234 (setq major-mode 'c++-mode
1236 local-abbrev-table c++-mode-abbrev-table
1238 (use-local-map c++-mode-map)
1239 (c-init-language-vars-for 'c++-mode)
1240 (c-common-init 'c++-mode)
1241 (easy-menu-add c-c++-menu)
1242 (cc-imenu-init cc-imenu-c++-generic-expression)
1243 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
1244 (c-update-modeline))
1247 ;; Support for Objective-C
1250 (defvar objc-mode-syntax-table nil
1251 "Syntax table used in objc-mode buffers.")
1252 (or objc-mode-syntax-table
1253 (setq objc-mode-syntax-table
1254 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1256 (defvar objc-mode-abbrev-table nil
1257 "Abbreviation table used in objc-mode buffers.")
1258 (c-define-abbrev-table 'objc-mode-abbrev-table
1259 '(("else" "else" c-electric-continued-statement 0)
1260 ("while" "while" c-electric-continued-statement 0)))
1262 (defvar objc-mode-map ()
1263 "Keymap used in objc-mode buffers.")
1266 (setq objc-mode-map (c-make-inherited-keymap))
1267 ;; add bindings which are only useful for Objective-C
1268 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1270 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
1271 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1273 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
1277 "Major mode for editing Objective C code.
1278 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1279 objc-mode buffer. This automatically sets up a mail buffer with
1280 version information already added. You just need to add a description
1281 of the problem, including a reproducible test case, and send the
1284 To see what version of CC Mode you are running, enter `\\[c-version]'.
1286 The hook `c-mode-common-hook' is run with no args at mode
1287 initialization, then `objc-mode-hook'.
1292 (kill-all-local-variables)
1293 (c-initialize-cc-mode t)
1294 (set-syntax-table objc-mode-syntax-table)
1295 (setq major-mode 'objc-mode
1297 local-abbrev-table objc-mode-abbrev-table
1299 (use-local-map objc-mode-map)
1300 (c-init-language-vars-for 'objc-mode)
1301 (c-common-init 'objc-mode)
1302 (easy-menu-add c-objc-menu)
1303 (cc-imenu-init nil 'cc-imenu-objc-function)
1304 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
1305 (c-update-modeline))
1311 (defvar java-mode-syntax-table nil
1312 "Syntax table used in java-mode buffers.")
1313 (or java-mode-syntax-table
1314 (setq java-mode-syntax-table
1315 (funcall (c-lang-const c-make-mode-syntax-table java))))
1317 (defvar java-mode-abbrev-table nil
1318 "Abbreviation table used in java-mode buffers.")
1319 (c-define-abbrev-table 'java-mode-abbrev-table
1320 '(("else" "else" c-electric-continued-statement 0)
1321 ("while" "while" c-electric-continued-statement 0)
1322 ("catch" "catch" c-electric-continued-statement 0)
1323 ("finally" "finally" c-electric-continued-statement 0)))
1325 (defvar java-mode-map ()
1326 "Keymap used in java-mode buffers.")
1329 (setq java-mode-map (c-make-inherited-keymap))
1330 ;; add bindings which are only useful for Java
1333 ;; Regexp trying to describe the beginning of a Java top-level
1334 ;; definition. This is not used by CC Mode, nor is it maintained
1335 ;; since it's practically impossible to write a regexp that reliably
1336 ;; matches such a construct. Other tools are necessary.
1337 (defconst c-Java-defun-prompt-regexp
1338 "^[ \t]*\\(\\(\\(public\\|protected\\|private\\|const\\|abstract\\|synchronized\\|final\\|static\\|threadsafe\\|transient\\|native\\|volatile\\)\\s-+\\)*\\(\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]*[][_$.a-zA-Z0-9]+\\|[[a-zA-Z]\\)\\s-*\\)\\s-+\\)\\)?\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]*\\s-+\\)\\s-*\\)?\\([_a-zA-Z][^][ \t:;.,{}()\7f=]*\\|\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)\\)\\s-*\\(([^);{}]*)\\)?\\([] \t]*\\)\\(\\s-*\\<throws\\>\\s-*\\(\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)[, \t\n\r\f\v]*\\)+\\)?\\s-*")
1340 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
1341 (cons "Java" (c-lang-const c-mode-menu java)))
1343 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
1347 "Major mode for editing Java code.
1348 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1349 java-mode buffer. This automatically sets up a mail buffer with
1350 version information already added. You just need to add a description
1351 of the problem, including a reproducible test case, and send the
1354 To see what version of CC Mode you are running, enter `\\[c-version]'.
1356 The hook `c-mode-common-hook' is run with no args at mode
1357 initialization, then `java-mode-hook'.
1362 (kill-all-local-variables)
1363 (c-initialize-cc-mode t)
1364 (set-syntax-table java-mode-syntax-table)
1365 (setq major-mode 'java-mode
1367 local-abbrev-table java-mode-abbrev-table
1369 (use-local-map java-mode-map)
1370 (c-init-language-vars-for 'java-mode)
1371 (c-common-init 'java-mode)
1372 (easy-menu-add c-java-menu)
1373 (cc-imenu-init cc-imenu-java-generic-expression)
1374 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
1375 (c-update-modeline))
1378 ;; Support for CORBA's IDL language
1381 (defvar idl-mode-syntax-table nil
1382 "Syntax table used in idl-mode buffers.")
1383 (or idl-mode-syntax-table
1384 (setq idl-mode-syntax-table
1385 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1387 (defvar idl-mode-abbrev-table nil
1388 "Abbreviation table used in idl-mode buffers.")
1389 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
1391 (defvar idl-mode-map ()
1392 "Keymap used in idl-mode buffers.")
1395 (setq idl-mode-map (c-make-inherited-keymap))
1396 ;; add bindings which are only useful for IDL
1399 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
1400 (cons "IDL" (c-lang-const c-mode-menu idl)))
1402 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
1406 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
1407 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1408 idl-mode buffer. This automatically sets up a mail buffer with
1409 version information already added. You just need to add a description
1410 of the problem, including a reproducible test case, and send the
1413 To see what version of CC Mode you are running, enter `\\[c-version]'.
1415 The hook `c-mode-common-hook' is run with no args at mode
1416 initialization, then `idl-mode-hook'.
1421 (kill-all-local-variables)
1422 (c-initialize-cc-mode t)
1423 (set-syntax-table idl-mode-syntax-table)
1424 (setq major-mode 'idl-mode
1426 local-abbrev-table idl-mode-abbrev-table)
1427 (use-local-map idl-mode-map)
1428 (c-init-language-vars-for 'idl-mode)
1429 (c-common-init 'idl-mode)
1430 (easy-menu-add c-idl-menu)
1431 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
1432 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
1433 (c-update-modeline))
1439 (defvar pike-mode-syntax-table nil
1440 "Syntax table used in pike-mode buffers.")
1441 (or pike-mode-syntax-table
1442 (setq pike-mode-syntax-table
1443 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1445 (defvar pike-mode-abbrev-table nil
1446 "Abbreviation table used in pike-mode buffers.")
1447 (c-define-abbrev-table 'pike-mode-abbrev-table
1448 '(("else" "else" c-electric-continued-statement 0)
1449 ("while" "while" c-electric-continued-statement 0)))
1451 (defvar pike-mode-map ()
1452 "Keymap used in pike-mode buffers.")
1455 (setq pike-mode-map (c-make-inherited-keymap))
1456 ;; additional bindings
1457 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1459 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
1460 (cons "Pike" (c-lang-const c-mode-menu pike)))
1462 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1463 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
1467 "Major mode for editing Pike code.
1468 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1469 pike-mode buffer. This automatically sets up a mail buffer with
1470 version information already added. You just need to add a description
1471 of the problem, including a reproducible test case, and send the
1474 To see what version of CC Mode you are running, enter `\\[c-version]'.
1476 The hook `c-mode-common-hook' is run with no args at mode
1477 initialization, then `pike-mode-hook'.
1482 (kill-all-local-variables)
1483 (c-initialize-cc-mode t)
1484 (set-syntax-table pike-mode-syntax-table)
1485 (setq major-mode 'pike-mode
1487 local-abbrev-table pike-mode-abbrev-table
1489 (use-local-map pike-mode-map)
1490 (c-init-language-vars-for 'pike-mode)
1491 (c-common-init 'pike-mode)
1492 (easy-menu-add c-pike-menu)
1493 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
1494 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
1495 (c-update-modeline))
1500 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1501 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1502 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1503 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1504 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
1506 ;;; Autoload directives must be on the top level, so we construct an
1507 ;;; autoload form instead.
1508 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1510 (defvar awk-mode-abbrev-table nil
1511 "Abbreviation table used in awk-mode buffers.")
1512 (c-define-abbrev-table 'awk-mode-abbrev-table
1513 '(("else" "else" c-electric-continued-statement 0)
1514 ("while" "while" c-electric-continued-statement 0)))
1516 (defvar awk-mode-map ()
1517 "Keymap used in awk-mode buffers.")
1520 (setq awk-mode-map (c-make-inherited-keymap))
1521 ;; add bindings which are only useful for awk.
1522 (define-key awk-mode-map "#" 'self-insert-command)
1523 (define-key awk-mode-map "/" 'self-insert-command)
1524 (define-key awk-mode-map "*" 'self-insert-command)
1525 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1526 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1527 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1528 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1529 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1530 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1531 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1533 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1534 (cons "AWK" (c-lang-const c-mode-menu awk)))
1536 ;; (require 'cc-awk) brings these in.
1537 (defvar awk-mode-syntax-table)
1538 (declare-function c-awk-unstick-NL-prop "cc-awk" ())
1541 "Major mode for editing AWK code.
1542 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1543 awk-mode buffer. This automatically sets up a mail buffer with version
1544 information already added. You just need to add a description of the
1545 problem, including a reproducible test case, and send the message.
1547 To see what version of CC Mode you are running, enter `\\[c-version]'.
1549 The hook `c-mode-common-hook' is run with no args at mode
1550 initialization, then `awk-mode-hook'.
1555 (require 'cc-awk) ; Added 2003/6/10.
1556 (kill-all-local-variables)
1557 (c-initialize-cc-mode t)
1558 (set-syntax-table awk-mode-syntax-table)
1559 (setq major-mode 'awk-mode
1561 local-abbrev-table awk-mode-abbrev-table
1563 (use-local-map awk-mode-map)
1564 (c-init-language-vars-for 'awk-mode)
1565 (c-common-init 'awk-mode)
1566 (c-awk-unstick-NL-prop)
1568 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1569 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1570 (defalias 'c-in-literal 'c-slow-in-literal)
1572 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1573 (c-update-modeline))
1578 (defconst c-mode-help-address
1579 "bug-cc-mode@gnu.org"
1580 "Address(es) for CC Mode bug reports.")
1583 "Echo the current version of CC Mode in the minibuffer."
1585 (message "Using CC Mode version %s" c-version)
1586 (c-keep-region-active))
1588 (defvar c-prepare-bug-report-hooks nil)
1590 ;; Dynamic variables used by reporter.
1591 (defvar reporter-prompt-for-summary-p)
1592 (defvar reporter-dont-compact-list)
1594 (defun c-submit-bug-report ()
1595 "Submit via mail a bug report on CC Mode."
1599 (let ((reporter-prompt-for-summary-p t)
1600 (reporter-dont-compact-list '(c-offsets-alist))
1601 (style c-indentation-style)
1602 (c-features c-emacs-features))
1604 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1606 (reporter-submit-bug-report
1608 (concat "CC Mode " c-version " (" mode-name ")")
1611 '(c-buffer-is-cc-mode
1613 c-syntactic-indentation
1614 c-syntactic-indentation-in-macros
1616 c-auto-align-backslashes
1617 c-backspace-function
1619 c-electric-pound-behavior
1621 c-enable-xemacs-performance-kludge-p
1622 c-old-style-variable-behavior
1626 parse-sexp-ignore-comments
1627 parse-sexp-lookup-properties
1628 lookup-syntax-properties
1629 ;; A brain-damaged XEmacs only variable that, if
1630 ;; set to nil can cause all kinds of chaos.
1631 signal-error-on-buffer-boundary
1632 ;; Variables that affect line breaking and comments.
1642 adaptive-fill-regexp)
1644 (mapc (lambda (var) (unless (boundp var)
1645 (setq vars (delq var vars))))
1646 '(signal-error-on-buffer-boundary
1650 font-lock-maximum-decoration
1651 parse-sexp-lookup-properties
1652 lookup-syntax-properties))
1655 (run-hooks 'c-prepare-bug-report-hooks)
1656 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1657 style c-features)))))))
1660 (cc-provide 'cc-mode)
1662 ;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
1663 ;;; cc-mode.el ends here