Merge from emacs--rel--22
[emacs.git] / lisp / progmodes / cc-mode.el
blob2d8e66ab3fc266760400d64cd10699f8264266b9
1 ;;; cc-mode.el --- major mode for editing C and similar languages
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
10 ;; 1987 Dave Detlefs and Stewart Clamen
11 ;; 1985 Richard M. Stallman
12 ;; Maintainer: bug-cc-mode@gnu.org
13 ;; Created: a long, long, time ago. adapted from the original c-mode.el
14 ;; Keywords: c languages oop
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software; you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation; either version 3, or (at your option)
21 ;; any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with this program; see the file COPYING. If not, write to
30 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
31 ;; Boston, MA 02110-1301, USA.
33 ;;; Commentary:
35 ;; NOTE: Read the commentary below for the right way to submit bug reports!
36 ;; NOTE: See the accompanying texinfo manual for details on using this mode!
37 ;; Note: The version string is in cc-defs.
39 ;; This package provides GNU Emacs major modes for editing C, C++,
40 ;; Objective-C, Java, CORBA's IDL, Pike and AWK code. As of the
41 ;; latest Emacs and XEmacs releases, it is the default package for
42 ;; editing these languages. This package is called "CC Mode", and
43 ;; should be spelled exactly this way.
45 ;; CC Mode supports K&R and ANSI C, ANSI C++, Objective-C, Java,
46 ;; CORBA's IDL, Pike and AWK with a consistent indentation model
47 ;; across all modes. This indentation model is intuitive and very
48 ;; flexible, so that almost any desired style of indentation can be
49 ;; supported. Installation, usage, and programming details are
50 ;; contained in an accompanying texinfo manual.
52 ;; CC Mode's immediate ancestors were, c++-mode.el, cplus-md.el, and
53 ;; cplus-md1.el..
55 ;; To submit bug reports, type "C-c C-b". These will be sent to
56 ;; bug-gnu-emacs@gnu.org (mirrored as the Usenet newsgroup
57 ;; gnu.emacs.bug) as well as bug-cc-mode@gnu.org, which directly
58 ;; contacts the CC Mode maintainers. Questions can sent to
59 ;; help-gnu-emacs@gnu.org (mirrored as gnu.emacs.help) and/or
60 ;; bug-cc-mode@gnu.org. Please do not send bugs or questions to our
61 ;; personal accounts; we reserve the right to ignore such email!
63 ;; Many, many thanks go out to all the folks on the beta test list.
64 ;; Without their patience, testing, insight, code contributions, and
65 ;; encouragement CC Mode would be a far inferior package.
67 ;; You can get the latest version of CC Mode, including PostScript
68 ;; documentation and separate individual files from:
70 ;; http://cc-mode.sourceforge.net/
72 ;; You can join a moderated CC Mode announcement-only mailing list by
73 ;; visiting
75 ;; http://lists.sourceforge.net/mailman/listinfo/cc-mode-announce
77 ;;; Code:
79 (eval-when-compile
80 (let ((load-path
81 (if (and (boundp 'byte-compile-dest-file)
82 (stringp byte-compile-dest-file))
83 (cons (file-name-directory byte-compile-dest-file) load-path)
84 load-path)))
85 (load "cc-bytecomp" nil t)))
87 (cc-require 'cc-defs)
88 (cc-require-when-compile 'cc-langs)
89 (cc-require 'cc-vars)
90 (cc-require 'cc-engine)
91 (cc-require 'cc-styles)
92 (cc-require 'cc-cmds)
93 (cc-require 'cc-align)
94 (cc-require 'cc-menus)
96 ;; Silence the compiler.
97 (cc-bytecomp-defvar adaptive-fill-first-line-regexp) ; Emacs
98 (cc-bytecomp-defun set-keymap-parents) ; XEmacs
99 (cc-bytecomp-defun run-mode-hooks) ; Emacs 21.1
100 (cc-bytecomp-obsolete-fun make-local-hook) ; Marked obsolete in Emacs 21.1.
102 ;; We set these variables during mode init, yet we don't require
103 ;; font-lock.
104 (cc-bytecomp-defvar font-lock-defaults)
105 (cc-bytecomp-defvar font-lock-syntactic-keywords)
107 ;; Menu support for both XEmacs and Emacs. If you don't have easymenu
108 ;; with your version of Emacs, you are incompatible!
109 (cc-external-require 'easymenu)
111 ;; Autoload directive for emacsen that doesn't have an older CC Mode
112 ;; version in the dist.
113 (autoload 'c-subword-mode "cc-subword"
114 "Mode enabling subword movement and editing keys." t)
116 ;; Load cc-fonts first after font-lock is loaded, since it isn't
117 ;; necessary until font locking is requested.
118 ; (eval-after-load "font-lock" ; 2006-07-09: font-lock is now preloaded.
120 (require 'cc-fonts) ;)
122 ;; cc-langs isn't loaded when we're byte compiled, so add autoload
123 ;; directives for the interface functions.
124 (autoload 'c-make-init-lang-vars-fun "cc-langs")
125 (autoload 'c-init-language-vars "cc-langs" nil nil 'macro)
128 ;; Other modes and packages which depend on CC Mode should do the
129 ;; following to make sure everything is loaded and available for their
130 ;; use:
132 ;; (require 'cc-mode)
134 ;; And in the major mode function:
136 ;; (c-initialize-cc-mode t)
137 ;; (c-init-language-vars some-mode)
138 ;; (c-common-init 'some-mode) ; Or perhaps (c-basic-common-init 'some-mode)
140 ;; If you're not writing a derived mode using the language variable
141 ;; system, then some-mode is one of the language modes directly
142 ;; supported by CC Mode. You can then use (c-init-language-vars-for
143 ;; 'some-mode) instead of `c-init-language-vars'.
144 ;; `c-init-language-vars-for' is a function that avoids the rather
145 ;; large expansion of `c-init-language-vars'.
147 ;; If you use `c-basic-common-init' then you might want to call
148 ;; `c-font-lock-init' too to set up CC Mode's font lock support.
150 ;; See cc-langs.el for further info. A small example of a derived mode
151 ;; is also available at <http://cc-mode.sourceforge.net/
152 ;; derived-mode-ex.el>.
154 (defun c-leave-cc-mode-mode ()
155 (setq c-buffer-is-cc-mode nil))
157 (defun c-init-language-vars-for (mode)
158 "Initialize the language variables for one of the language modes
159 directly supported by CC Mode. This can be used instead of the
160 `c-init-language-vars' macro if the language you want to use is one of
161 those, rather than a derived language defined through the language
162 variable system (see \"cc-langs.el\")."
163 (cond ((eq mode 'c-mode) (c-init-language-vars c-mode))
164 ((eq mode 'c++-mode) (c-init-language-vars c++-mode))
165 ((eq mode 'objc-mode) (c-init-language-vars objc-mode))
166 ((eq mode 'java-mode) (c-init-language-vars java-mode))
167 ((eq mode 'idl-mode) (c-init-language-vars idl-mode))
168 ((eq mode 'pike-mode) (c-init-language-vars pike-mode))
169 ((eq mode 'awk-mode) (c-init-language-vars awk-mode))
170 (t (error "Unsupported mode %s" mode))))
172 ;;;###autoload
173 (defun c-initialize-cc-mode (&optional new-style-init)
174 "Initialize CC Mode for use in the current buffer.
175 If the optional NEW-STYLE-INIT is nil or left out then all necessary
176 initialization to run CC Mode for the C language is done. Otherwise
177 only some basic setup is done, and a call to `c-init-language-vars' or
178 `c-init-language-vars-for' is necessary too (which gives more
179 control). See \"cc-mode.el\" for more info."
181 (setq c-buffer-is-cc-mode t)
183 (let ((initprop 'cc-mode-is-initialized)
184 c-initialization-ok)
185 (unless (get 'c-initialize-cc-mode initprop)
186 (unwind-protect
187 (progn
188 (put 'c-initialize-cc-mode initprop t)
189 (c-initialize-builtin-style)
190 (run-hooks 'c-initialization-hook)
191 ;; Fix obsolete variables.
192 (if (boundp 'c-comment-continuation-stars)
193 (setq c-block-comment-prefix
194 (symbol-value 'c-comment-continuation-stars)))
195 (add-hook 'change-major-mode-hook 'c-leave-cc-mode-mode)
196 (setq c-initialization-ok t))
197 ;; Will try initialization hooks again if they failed.
198 (put 'c-initialize-cc-mode initprop c-initialization-ok))))
200 (unless new-style-init
201 (c-init-language-vars-for 'c-mode)))
204 ;;; Common routines.
206 (defvar c-mode-base-map ()
207 "Keymap shared by all CC Mode related modes.")
209 (defun c-make-inherited-keymap ()
210 (let ((map (make-sparse-keymap)))
211 ;; Necessary to use `cc-bytecomp-fboundp' below since this
212 ;; function is called from top-level forms that are evaluated
213 ;; while cc-bytecomp is active when one does M-x eval-buffer.
214 (cond
215 ;; XEmacs
216 ((cc-bytecomp-fboundp 'set-keymap-parents)
217 (set-keymap-parents map c-mode-base-map))
218 ;; Emacs
219 ((cc-bytecomp-fboundp 'set-keymap-parent)
220 (set-keymap-parent map c-mode-base-map))
221 ;; incompatible
222 (t (error "CC Mode is incompatible with this version of Emacs")))
223 map))
225 (defun c-define-abbrev-table (name defs)
226 ;; Compatibility wrapper for `define-abbrev' which passes a non-nil
227 ;; sixth argument for SYSTEM-FLAG in emacsen that support it
228 ;; (currently only Emacs >= 21.2).
229 (let ((table (or (symbol-value name)
230 (progn (define-abbrev-table name nil)
231 (symbol-value name)))))
232 (while defs
233 (condition-case nil
234 (apply 'define-abbrev table (append (car defs) '(t)))
235 (wrong-number-of-arguments
236 (apply 'define-abbrev table (car defs))))
237 (setq defs (cdr defs)))))
238 (put 'c-define-abbrev-table 'lisp-indent-function 1)
240 (defun c-bind-special-erase-keys ()
241 ;; Only used in Emacs to bind C-c C-<delete> and C-c C-<backspace>
242 ;; to the proper keys depending on `normal-erase-is-backspace'.
243 (if normal-erase-is-backspace
244 (progn
245 (define-key c-mode-base-map (kbd "C-c C-<delete>")
246 'c-hungry-delete-forward)
247 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
248 'c-hungry-delete-backwards))
249 (define-key c-mode-base-map (kbd "C-c C-<delete>")
250 'c-hungry-delete-backwards)
251 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
252 'c-hungry-delete-forward)))
254 (if c-mode-base-map
257 (setq c-mode-base-map (make-sparse-keymap))
259 ;; Separate M-BS from C-M-h. The former should remain
260 ;; backward-kill-word.
261 (define-key c-mode-base-map [(control meta h)] 'c-mark-function)
262 (define-key c-mode-base-map "\e\C-q" 'c-indent-exp)
263 (substitute-key-definition 'backward-sentence
264 'c-beginning-of-statement
265 c-mode-base-map global-map)
266 (substitute-key-definition 'forward-sentence
267 'c-end-of-statement
268 c-mode-base-map global-map)
269 (substitute-key-definition 'indent-new-comment-line
270 'c-indent-new-comment-line
271 c-mode-base-map global-map)
272 (substitute-key-definition 'indent-for-tab-command
273 ;; XXX Is this the right thing to do
274 ;; here?
275 'c-indent-line-or-region
276 c-mode-base-map global-map)
277 (when (fboundp 'comment-indent-new-line)
278 ;; indent-new-comment-line has changed name to
279 ;; comment-indent-new-line in Emacs 21.
280 (substitute-key-definition 'comment-indent-new-line
281 'c-indent-new-comment-line
282 c-mode-base-map global-map))
284 ;; RMS says don't make these the default.
285 ;; (April 2006): RMS has now approved these commands as defaults.
286 (define-key c-mode-base-map "\e\C-a" 'c-beginning-of-defun)
287 (define-key c-mode-base-map "\e\C-e" 'c-end-of-defun)
289 (define-key c-mode-base-map "\C-c\C-n" 'c-forward-conditional)
290 (define-key c-mode-base-map "\C-c\C-p" 'c-backward-conditional)
291 (define-key c-mode-base-map "\C-c\C-u" 'c-up-conditional)
293 ;; It doesn't suffice to put `c-fill-paragraph' on
294 ;; `fill-paragraph-function' since `c-fill-paragraph' must be called
295 ;; before any fill prefix adaption is done. E.g. `filladapt-mode'
296 ;; replaces `fill-paragraph' and does the adaption before calling
297 ;; `fill-paragraph-function', and we have to mask comments etc
298 ;; before that. Also, `c-fill-paragraph' chains on to
299 ;; `fill-paragraph' and the value on `fill-parapgraph-function' to
300 ;; do the actual filling work.
301 (substitute-key-definition 'fill-paragraph 'c-fill-paragraph
302 c-mode-base-map global-map)
303 ;; In XEmacs the default fill function is called
304 ;; fill-paragraph-or-region.
305 (substitute-key-definition 'fill-paragraph-or-region 'c-fill-paragraph
306 c-mode-base-map global-map)
308 ;; We bind the forward deletion key and (implicitly) C-d to
309 ;; `c-electric-delete-forward', and the backward deletion key to
310 ;; `c-electric-backspace'. The hungry variants are bound to the
311 ;; same keys but prefixed with C-c. This implies that C-c C-d is
312 ;; `c-hungry-delete-forward'. For consistency, we bind not only C-c
313 ;; <backspace> to `c-hungry-delete-backwards' but also
314 ;; C-c C-<backspace>, so that the Ctrl key can be held down during
315 ;; the whole sequence regardless of the direction. This in turn
316 ;; implies that we bind C-c C-<delete> to `c-hungry-delete-forward',
317 ;; for the same reason.
319 ;; Bind the electric deletion functions to C-d and DEL. Emacs 21
320 ;; automatically maps the [delete] and [backspace] keys to these two
321 ;; depending on window system and user preferences. (In earlier
322 ;; versions it's possible to do the same by using `function-key-map'.)
323 (define-key c-mode-base-map "\C-d" 'c-electric-delete-forward)
324 (define-key c-mode-base-map "\177" 'c-electric-backspace)
325 (define-key c-mode-base-map "\C-c\C-d" 'c-hungry-delete-forward)
326 (define-key c-mode-base-map [?\C-c ?\d] 'c-hungry-delete-backwards)
327 (define-key c-mode-base-map [?\C-c ?\C-\d] 'c-hungry-delete-backwards)
328 (define-key c-mode-base-map [?\C-c deletechar] 'c-hungry-delete-forward) ; C-c <delete> on a tty.
329 (define-key c-mode-base-map [?\C-c (control deletechar)] ; C-c C-<delete> on a tty.
330 'c-hungry-delete-forward)
331 (when (boundp 'normal-erase-is-backspace)
332 ;; The automatic C-d and DEL mapping functionality doesn't extend
333 ;; to special combinations like C-c C-<delete>, so we have to hook
334 ;; into the `normal-erase-is-backspace' system to bind it directly
335 ;; as appropriate.
336 (add-hook 'normal-erase-is-backspace-hook 'c-bind-special-erase-keys)
337 (c-bind-special-erase-keys))
339 (when (fboundp 'delete-forward-p)
340 ;; In XEmacs we fix the forward and backward deletion behavior by
341 ;; binding the keysyms for the [delete] and [backspace] keys
342 ;; directly, and use `delete-forward-p' to decide what [delete]
343 ;; should do. That's done in the XEmacs specific
344 ;; `c-electric-delete' and `c-hungry-delete' functions.
345 (define-key c-mode-base-map [delete] 'c-electric-delete)
346 (define-key c-mode-base-map [backspace] 'c-electric-backspace)
347 (define-key c-mode-base-map (kbd "C-c <delete>") 'c-hungry-delete)
348 (define-key c-mode-base-map (kbd "C-c C-<delete>") 'c-hungry-delete)
349 (define-key c-mode-base-map (kbd "C-c <backspace>")
350 'c-hungry-delete-backwards)
351 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
352 'c-hungry-delete-backwards))
354 (define-key c-mode-base-map "#" 'c-electric-pound)
355 (define-key c-mode-base-map "{" 'c-electric-brace)
356 (define-key c-mode-base-map "}" 'c-electric-brace)
357 (define-key c-mode-base-map "/" 'c-electric-slash)
358 (define-key c-mode-base-map "*" 'c-electric-star)
359 (define-key c-mode-base-map ";" 'c-electric-semi&comma)
360 (define-key c-mode-base-map "," 'c-electric-semi&comma)
361 (define-key c-mode-base-map ":" 'c-electric-colon)
362 (define-key c-mode-base-map "(" 'c-electric-paren)
363 (define-key c-mode-base-map ")" 'c-electric-paren)
365 (define-key c-mode-base-map "\C-c\C-\\" 'c-backslash-region)
366 (define-key c-mode-base-map "\C-c\C-a" 'c-toggle-auto-newline)
367 (define-key c-mode-base-map "\C-c\C-b" 'c-submit-bug-report)
368 (define-key c-mode-base-map "\C-c\C-c" 'comment-region)
369 (define-key c-mode-base-map "\C-c\C-l" 'c-toggle-electric-state)
370 (define-key c-mode-base-map "\C-c\C-o" 'c-set-offset)
371 (define-key c-mode-base-map "\C-c\C-q" 'c-indent-defun)
372 (define-key c-mode-base-map "\C-c\C-s" 'c-show-syntactic-information)
373 ;; (define-key c-mode-base-map "\C-c\C-t" 'c-toggle-auto-hungry-state) Commented out by ACM, 2005-03-05.
374 (define-key c-mode-base-map "\C-c." 'c-set-style)
375 ;; conflicts with OOBR
376 ;;(define-key c-mode-base-map "\C-c\C-v" 'c-version)
377 ;; (define-key c-mode-base-map "\C-c\C-y" 'c-toggle-hungry-state) Commented out by ACM, 2005-11-22.
378 (define-key c-mode-base-map "\C-c\C-w" 'c-subword-mode)
381 ;; We don't require the outline package, but we configure it a bit anyway.
382 (cc-bytecomp-defvar outline-level)
384 (defun c-mode-menu (modestr)
385 "Return a menu spec suitable for `easy-menu-define' that is exactly
386 like the C mode menu except that the menu bar item name is MODESTR
387 instead of \"C\".
389 This function is provided for compatibility only; derived modes should
390 preferably use the `c-mode-menu' language constant directly."
391 (cons modestr (c-lang-const c-mode-menu c)))
393 ;; Ugly hack to pull in the definition of `c-populate-syntax-table'
394 ;; from cc-langs to make it available at runtime. It's either this or
395 ;; moving the definition for it to cc-defs, but that would mean to
396 ;; break up the syntax table setup over two files.
397 (defalias 'c-populate-syntax-table
398 (cc-eval-when-compile
399 (let ((f (symbol-function 'c-populate-syntax-table)))
400 (if (byte-code-function-p f) f (byte-compile f)))))
402 ;; CAUTION: Try to avoid installing things on
403 ;; `before-change-functions'. The macro `combine-after-change-calls'
404 ;; is used and it doesn't work if there are things on that hook. That
405 ;; can cause font lock functions to run in inconvenient places during
406 ;; temporary changes in some font lock support modes, causing extra
407 ;; unnecessary work and font lock glitches due to interactions between
408 ;; various text properties.
410 ;; (2007-02-12): The macro `combine-after-change-calls' ISN'T used any
411 ;; more.
413 (defun c-unfind-enclosing-token (pos)
414 ;; If POS is wholly inside a token, remove that id from
415 ;; `c-found-types', should it be present. Return t if we were in an
416 ;; id, else nil.
417 (save-excursion
418 (let ((tok-beg (progn (goto-char pos)
419 (and (c-beginning-of-current-token) (point))))
420 (tok-end (progn (goto-char pos)
421 (and (c-end-of-current-token) (point)))))
422 (when (and tok-beg tok-end)
423 (c-unfind-type (buffer-substring-no-properties tok-beg tok-end))
424 t))))
426 (defun c-unfind-coalesced-tokens (beg end)
427 ;; unless the non-empty region (beg end) is entirely WS and there's at
428 ;; least one character of WS just before or after this region, remove
429 ;; the tokens which touch the region from `c-found-types' should they
430 ;; be present.
431 (or (c-partial-ws-p beg end)
432 (save-excursion
433 (progn
434 (goto-char beg)
435 (or (eq beg (point-min))
436 (c-skip-ws-backward (1- beg))
437 (/= (point) beg)
438 (= (c-backward-token-2) 1)
439 (c-unfind-type (buffer-substring-no-properties
440 (point) beg)))
441 (goto-char end)
442 (or (eq end (point-max))
443 (c-skip-ws-forward (1+ end))
444 (/= (point) end)
445 (progn (forward-char) (c-end-of-current-token) nil)
446 (c-unfind-type (buffer-substring-no-properties
447 end (point))))))))
449 ;; c-maybe-stale-found-type records a place near the region being
450 ;; changed where an element of `found-types' might become stale. It
451 ;; is set in c-before-change and is either nil, or has the form:
453 ;; (c-decl-id-start "foo" 97 107 " (* ooka) " "o"), where
455 ;; o - `c-decl-id-start' is the c-type text property value at buffer
456 ;; pos 96.
458 ;; o - 97 107 is the region potentially containing the stale type -
459 ;; this is delimited by a non-nil c-type text property at 96 and
460 ;; either another one or a ";", "{", or "}" at 107.
462 ;; o - " (* ooka) " is the (before change) buffer portion containing
463 ;; the suspect type (here "ooka").
465 ;; o - "o" is the buffer contents which is about to be deleted. This
466 ;; would be the empty string for an insertion.
467 (defvar c-maybe-stale-found-type nil)
468 (make-variable-buffer-local 'c-maybe-stale-found-type)
470 (defun c-basic-common-init (mode default-style)
471 "Do the necessary initialization for the syntax handling routines
472 and the line breaking/filling code. Intended to be used by other
473 packages that embed CC Mode.
475 MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode.
476 DEFAULT-STYLE tells which indentation style to install. It has the
477 same format as `c-default-style'.
479 Note that `c-init-language-vars' must be called before this function.
480 This function cannot do that since `c-init-language-vars' is a macro
481 that requires a literal mode spec at compile time."
483 (setq c-buffer-is-cc-mode mode)
485 ;; these variables should always be buffer local; they do not affect
486 ;; indentation style.
487 (make-local-variable 'parse-sexp-ignore-comments)
488 (make-local-variable 'indent-line-function)
489 (make-local-variable 'indent-region-function)
490 (make-local-variable 'normal-auto-fill-function)
491 (make-local-variable 'comment-start)
492 (make-local-variable 'comment-end)
493 (make-local-variable 'comment-start-skip)
494 (make-local-variable 'comment-multi-line)
495 (make-local-variable 'comment-line-break-function)
496 (make-local-variable 'paragraph-start)
497 (make-local-variable 'paragraph-separate)
498 (make-local-variable 'paragraph-ignore-fill-prefix)
499 (make-local-variable 'adaptive-fill-mode)
500 (make-local-variable 'adaptive-fill-regexp)
502 ;; now set their values
503 (setq parse-sexp-ignore-comments t
504 indent-line-function 'c-indent-line
505 indent-region-function 'c-indent-region
506 normal-auto-fill-function 'c-do-auto-fill
507 comment-multi-line t
508 comment-line-break-function 'c-indent-new-comment-line)
510 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
511 ;; direct call to `fill-paragraph' behaves better. This still
512 ;; doesn't work with filladapt but it's better than nothing.
513 (make-local-variable 'fill-paragraph-function)
514 (setq fill-paragraph-function 'c-fill-paragraph)
516 (when (or c-recognize-<>-arglists
517 (c-major-mode-is 'awk-mode)
518 (c-major-mode-is '(c-mode c++-mode objc-mode)))
519 ;; We'll use the syntax-table text property to change the syntax
520 ;; of some chars for this language, so do the necessary setup for
521 ;; that.
523 ;; Note to other package developers: It's ok to turn this on in CC
524 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
525 ;; off if CC Mode has turned it on.
527 ;; Emacs.
528 (when (boundp 'parse-sexp-lookup-properties)
529 (make-local-variable 'parse-sexp-lookup-properties)
530 (setq parse-sexp-lookup-properties t))
532 ;; Same as above for XEmacs.
533 (when (boundp 'lookup-syntax-properties)
534 (make-local-variable 'lookup-syntax-properties)
535 (setq lookup-syntax-properties t)))
537 ;; Use this in Emacs 21 to avoid meddling with the rear-nonsticky
538 ;; property on each character.
539 (when (boundp 'text-property-default-nonsticky)
540 (make-local-variable 'text-property-default-nonsticky)
541 (let ((elem (assq 'syntax-table text-property-default-nonsticky)))
542 (if elem
543 (setcdr elem t)
544 (setq text-property-default-nonsticky
545 (cons '(syntax-table . t)
546 text-property-default-nonsticky))))
547 (setq text-property-default-nonsticky
548 (cons '(c-type . t)
549 text-property-default-nonsticky)))
551 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
552 ;; heuristic that open parens in column 0 are defun starters. Since
553 ;; we have c-state-cache, that heuristic isn't useful and only causes
554 ;; trouble, so turn it off.
555 ;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
556 ;; helpful. Comment it out for now.
557 ;; (when (memq 'col-0-paren c-emacs-features)
558 ;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
559 ;; (setq open-paren-in-column-0-is-defun-start nil))
561 (c-clear-found-types)
563 ;; now set the mode style based on default-style
564 (let ((style (if (stringp default-style)
565 default-style
566 (or (cdr (assq mode default-style))
567 (cdr (assq 'other default-style))
568 "gnu"))))
569 ;; Override style variables if `c-old-style-variable-behavior' is
570 ;; set. Also override if we are using global style variables,
571 ;; have already initialized a style once, and are switching to a
572 ;; different style. (It's doubtful whether this is desirable, but
573 ;; the whole situation with nonlocal style variables is a bit
574 ;; awkward. It's at least the most compatible way with the old
575 ;; style init procedure.)
576 (c-set-style style (not (or c-old-style-variable-behavior
577 (and (not c-style-variables-are-local-p)
578 c-indentation-style
579 (not (string-equal c-indentation-style
580 style)))))))
581 (c-setup-paragraph-variables)
583 ;; we have to do something special for c-offsets-alist so that the
584 ;; buffer local value has its own alist structure.
585 (setq c-offsets-alist (copy-alist c-offsets-alist))
587 ;; setup the comment indent variable in a Emacs version portable way
588 (make-local-variable 'comment-indent-function)
589 (setq comment-indent-function 'c-comment-indent)
591 ;; ;; Put submode indicators onto minor-mode-alist, but only once.
592 ;; (or (assq 'c-submode-indicators minor-mode-alist)
593 ;; (setq minor-mode-alist
594 ;; (cons '(c-submode-indicators c-submode-indicators)
595 ;; minor-mode-alist)))
596 (c-update-modeline)
598 ;; Install the functions that ensure that various internal caches
599 ;; don't become invalid due to buffer changes.
600 (make-local-hook 'before-change-functions)
601 (add-hook 'before-change-functions 'c-before-change nil t)
602 (make-local-hook 'after-change-functions)
603 (add-hook 'after-change-functions 'c-after-change nil t))
605 (defun c-setup-doc-comment-style ()
606 "Initialize the variables that depend on the value of `c-doc-comment-style'."
607 (when (and (featurep 'font-lock)
608 (symbol-value 'font-lock-mode))
609 ;; Force font lock mode to reinitialize itself.
610 (font-lock-mode 0)
611 (font-lock-mode 1)))
613 (defun c-common-init (&optional mode)
614 "Common initialization for all CC Mode modes.
615 In addition to the work done by `c-basic-common-init' and
616 `c-font-lock-init', this function sets up various other things as
617 customary in CC Mode modes but which aren't strictly necessary for CC
618 Mode to operate correctly.
620 MODE is the symbol for the mode to initialize, like 'c-mode. See
621 `c-basic-common-init' for details. It's only optional to be
622 compatible with old code; callers should always specify it."
624 (unless mode
625 ;; Called from an old third party package. The fallback is to
626 ;; initialize for C.
627 (c-init-language-vars-for 'c-mode))
629 (c-basic-common-init mode c-default-style)
630 (when mode
631 ;; Only initialize font locking if we aren't called from an old package.
632 (c-font-lock-init))
634 ;; Starting a mode is a sort of "change". So call the change functions...
635 (save-restriction
636 (widen)
637 (save-excursion
638 (if c-get-state-before-change-function
639 (funcall c-get-state-before-change-function (point-min) (point-max)))
640 (if c-before-font-lock-function
641 (funcall c-before-font-lock-function (point-min) (point-max)
642 (- (point-max) (point-min))))))
644 (make-local-variable 'outline-regexp)
645 (make-local-variable 'outline-level)
646 (setq outline-regexp "[^#\n\^M]"
647 outline-level 'c-outline-level)
649 (let ((rfn (assq mode c-require-final-newline)))
650 (when rfn
651 (make-local-variable 'require-final-newline)
652 (and (cdr rfn)
653 (setq require-final-newline mode-require-final-newline)))))
655 (defun c-remove-any-local-eval-or-mode-variables ()
656 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
657 ;; or on the first line, remove all occurrences. See
658 ;; `c-postprocess-file-styles' for justification. There is no need to save
659 ;; point here, or even bother too much about the buffer contents. However,
660 ;; DON'T mess up the kill-ring.
662 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
663 ;; in files.el.
664 (goto-char (point-max))
665 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
666 (let (lv-point (prefix "") (suffix ""))
667 (when (let ((case-fold-search t))
668 (search-forward "Local Variables:" nil t))
669 (setq lv-point (point))
670 ;; The prefix is what comes before "local variables:" in its line.
671 ;; The suffix is what comes after "local variables:" in its line.
672 (skip-chars-forward " \t")
673 (or (eolp)
674 (setq suffix (buffer-substring (point)
675 (progn (end-of-line) (point)))))
676 (goto-char (match-beginning 0))
677 (or (bolp)
678 (setq prefix
679 (buffer-substring (point)
680 (progn (beginning-of-line) (point)))))
682 (while (search-forward-regexp
683 (concat "^[ \t]*"
684 (regexp-quote prefix)
685 "\\(mode\\|eval\\):.*"
686 (regexp-quote suffix)
687 "$")
688 nil t)
689 (forward-line 0)
690 (delete-region (point) (progn (forward-line) (point)))))
692 ;; Delete the first line, if we've got one, in case it contains a mode spec.
693 (unless (and lv-point
694 (progn (goto-char lv-point)
695 (forward-line 0)
696 (bobp)))
697 (goto-char (point-min))
698 (unless (eobp)
699 (delete-region (point) (progn (forward-line) (point)))))))
701 (defun c-postprocess-file-styles ()
702 "Function that post processes relevant file local variables in CC Mode.
703 Currently, this function simply applies any style and offset settings
704 found in the file's Local Variable list. It first applies any style
705 setting found in `c-file-style', then it applies any offset settings
706 it finds in `c-file-offsets'.
708 Note that the style variables are always made local to the buffer."
710 ;; apply file styles and offsets
711 (when c-buffer-is-cc-mode
712 (if (or c-file-style c-file-offsets)
713 (c-make-styles-buffer-local t))
714 (and c-file-style
715 (c-set-style c-file-style))
716 (and c-file-offsets
717 (mapc
718 (lambda (langentry)
719 (let ((langelem (car langentry))
720 (offset (cdr langentry)))
721 (c-set-offset langelem offset)))
722 c-file-offsets))
723 ;; Problem: The file local variable block might have explicitly set a
724 ;; style variable. The `c-set-style' or `mapcar' call might have
725 ;; overwritten this. So we run `hack-local-variables' again to remedy
726 ;; this. There are no guarantees this will work properly, particularly as
727 ;; we have no control over what the other hook functions on
728 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
729 ;; any `eval' or `mode' expressions before we evaluate again (see below).
730 ;; ACM, 2005/11/2.
732 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
733 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
734 ;; We prevent this by temporarily removing `mode' from the Local Variables
735 ;; section.
736 (if (or c-file-style c-file-offsets)
737 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
738 (c-tentative-buffer-changes
739 (c-remove-any-local-eval-or-mode-variables)
740 (hack-local-variables))
741 nil))))
743 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles)
745 (defmacro c-run-mode-hooks (&rest hooks)
746 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
747 ;; require the use of the new function `run-mode-hooks'.
748 (if (cc-bytecomp-fboundp 'run-mode-hooks)
749 `(run-mode-hooks ,@hooks)
750 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
753 ;;; Change hooks, linking with Font Lock.
755 ;; Buffer local variables defining the region to be fontified by a font lock
756 ;; after-change function. They are set in c-after-change to
757 ;; after-change-function's BEG and END, and may be modified by a
758 ;; `c-before-font-lock-function'.
759 (defvar c-new-BEG 0)
760 (make-variable-buffer-local 'c-new-BEG)
761 (defvar c-new-END 0)
762 (make-variable-buffer-local 'c-new-END)
764 ;; Buffer local variables recording Beginning/End-of-Macro position before a
765 ;; change, when a macro straddles, respectively, the BEG or END (or both) of
766 ;; the change region. Otherwise these have the values BEG/END.
767 (defvar c-old-BOM 0)
768 (make-variable-buffer-local 'c-old-BOM)
769 (defvar c-old-EOM 0)
770 (make-variable-buffer-local 'c-old-EOM)
772 (defun c-extend-region-for-CPP (beg end)
773 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
774 ;; beginning/end of any preprocessor construct they may be in.
776 ;; Point is undefined both before and after this function call; the buffer
777 ;; has already been widened, and match-data saved. The return value is
778 ;; meaningless.
780 ;; This function is the C/C++/ObjC value of
781 ;; `c-get-state-before-change-function' and is called exclusively as a
782 ;; before change function.
783 (goto-char beg)
784 (c-beginning-of-macro)
785 (setq c-old-BOM (point))
787 (goto-char end)
788 (if (c-beginning-of-macro)
789 (c-end-of-macro))
790 (setq c-old-EOM (point)))
792 (defun c-neutralize-CPP-line (beg end)
793 ;; BEG and END bound a preprocessor line. Put a "punctuation" syntax-table
794 ;; property on syntactically obtrusive characters, ones which would interact
795 ;; syntactically with stuff outside the CPP line.
797 ;; These are unmatched string delimiters, or unmatched
798 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
799 ;; obtrusive.
800 (let (s)
801 (while
802 (progn
803 (setq s (parse-partial-sexp beg end -1))
804 (cond
805 ((< (nth 0 s) 0) ; found an unmated ),},]
806 (c-put-char-property (1- (point)) 'syntax-table '(1))
808 ((nth 3 s) ; In a string
809 (c-put-char-property (nth 8 s) 'syntax-table '(1))
811 ((> (nth 0 s) 0) ; In a (,{,[
812 (c-put-char-property (nth 1 s) 'syntax-table '(1))
814 (t nil))))))
816 (defun c-neutralize-syntax-in-CPP (begg endd old-len)
817 ;; "Neutralize" every preprocessor line wholly or partially in the changed
818 ;; region. "Restore" lines which were CPP lines before the change and are
819 ;; no longer so; these can be located from the Buffer local variables
820 ;; c-old-[EB]OM.
822 ;; That is, set syntax-table properties on characters that would otherwise
823 ;; interact syntactically with those outside the CPP line(s).
825 ;; This function is called from an after-change function, BEGG ENDD and
826 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
827 ;; locking, hence must get called before `font-lock-after-change-function'.
829 ;; Point is undefined both before and after this function call, the buffer
830 ;; has been widened, and match-data saved. The return value is ignored.
832 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
834 ;; This function might do invisible changes.
835 (c-save-buffer-state (limits mbeg beg end)
836 ;; First calculate the region, possibly to be extended.
837 (setq beg (min begg c-old-BOM))
838 (goto-char endd)
839 (when (c-beginning-of-macro)
840 (c-end-of-macro))
841 (setq end (max (+ (- c-old-EOM old-len) (- endd begg))
842 (point)))
843 ;; Clear all old punctuation properties
844 (c-clear-char-property-with-value beg end 'syntax-table '(1))
846 (goto-char beg)
847 ;; If we're inside a string/comment, go to its end.
848 (if (setq limits (c-literal-limits))
849 (goto-char (cdr limits)))
851 (while (search-forward-regexp c-anchored-cpp-prefix end t)
852 (when (c-beginning-of-macro) ; Guard against being in a string/comment.
853 (setq mbeg (point))
854 (c-end-of-macro) ; Do we need to go forward 1 char here? No!
855 (c-neutralize-CPP-line mbeg (point)))))) ; We might still be in a comment - this is OK.
857 (defun c-before-change (beg end)
858 ;; Function to be put on `before-change-function'. Primarily, this calls
859 ;; the language dependent `c-get-state-before-change-function'. It is
860 ;; otherwise used only to remove stale entries from the `c-found-types'
861 ;; cache, and to record entries which a `c-after-change' function might
862 ;; confirm as stale.
864 ;; Note that this function must be FAST rather than accurate. Note
865 ;; also that it only has any effect when font locking is enabled.
866 ;; We exploit this by checking for font-lock-*-face instead of doing
867 ;; rigourous syntactic analysis.
869 ;; If either change boundary is wholly inside an identifier, delete
870 ;; it/them from the cache. Don't worry about being inside a string
871 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
872 ;; isn't critical.
873 (setq c-maybe-stale-found-type nil)
874 (save-restriction
875 (save-match-data
876 (widen)
877 (save-excursion
878 ;; Are we inserting/deleting stuff in the middle of an identifier?
879 (c-unfind-enclosing-token beg)
880 (c-unfind-enclosing-token end)
881 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
882 (when (< beg end)
883 (c-unfind-coalesced-tokens beg end))
884 ;; Are we (potentially) disrupting the syntactic context which
885 ;; makes a type a type? E.g. by inserting stuff after "foo" in
886 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
888 ;; We search for appropriate c-type properties "near" the change.
889 ;; First, find an appropriate boundary for this property search.
890 (let (lim
891 type type-pos
892 marked-id term-pos
893 (end1
894 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
895 (previous-single-property-change end 'face))
896 end)))
897 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
898 ;; Find a limit for the search for a `c-type' property
899 (while
900 (and (/= (skip-chars-backward "^;{}") 0)
901 (> (point) (point-min))
902 (memq (c-get-char-property (1- (point)) 'face)
903 '(font-lock-comment-face font-lock-string-face))))
904 (setq lim (max (point-min) (1- (point))))
906 ;; Look for the latest `c-type' property before end1
907 (when (and (> end1 (point-min))
908 (setq type-pos
909 (if (get-text-property (1- end1) 'c-type)
910 end1
911 (previous-single-property-change end1 'c-type nil lim))))
912 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
914 (when (memq type '(c-decl-id-start c-decl-type-start))
915 ;; Get the identifier, if any, that the property is on.
916 (goto-char (1- type-pos))
917 (setq marked-id
918 (when (looking-at "\\(\\sw\\|\\s_\\)")
919 (c-beginning-of-current-token)
920 (buffer-substring-no-properties (point) type-pos)))
922 (goto-char end1)
923 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
924 (setq lim (point))
925 (setq term-pos
926 (or (next-single-property-change end 'c-type nil lim) lim))
927 (setq c-maybe-stale-found-type
928 (list type marked-id
929 type-pos term-pos
930 (buffer-substring-no-properties type-pos term-pos)
931 (buffer-substring-no-properties beg end)))))))
933 (setq c-new-BEG beg
934 c-new-END end)
935 (if c-get-state-before-change-function
936 (funcall c-get-state-before-change-function beg end))
937 ))))
939 (defun c-after-change (beg end old-len)
940 ;; Function put on `after-change-functions' to adjust various caches
941 ;; etc. Prefer speed to finesse here, since there will be an order
942 ;; of magnitude more calls to this function than any of the
943 ;; functions that use the caches.
945 ;; Note that care must be taken so that this is called before any
946 ;; font-lock callbacks since we might get calls to functions using
947 ;; these caches from inside them, and we must thus be sure that this
948 ;; has already been executed.
950 ;; This calls the language variable c-before-font-lock-function, if non nil.
951 ;; This typically sets `syntax-table' properties.
953 (c-save-buffer-state ()
954 ;; When `combine-after-change-calls' is used we might get calls
955 ;; with regions outside the current narrowing. This has been
956 ;; observed in Emacs 20.7.
957 (save-restriction
958 (save-match-data ; c-recognize-<>-arglists changes match-data
959 (widen)
961 (when (> end (point-max))
962 ;; Some emacsen might return positions past the end. This has been
963 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
964 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
965 ;; work).
966 (setq end (point-max))
967 (when (> beg end)
968 (setq beg end)))
970 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
971 (c-invalidate-sws-region-after beg end)
972 (c-invalidate-state-cache beg)
973 (c-invalidate-find-decl-cache beg)
975 (when c-recognize-<>-arglists
976 (c-after-change-check-<>-operators beg end))
978 (if c-before-font-lock-function
979 (save-excursion
980 (funcall c-before-font-lock-function beg end old-len)))))))
982 (defun c-after-font-lock-init ()
983 ;; Put on `font-lock-mode-hook'.
984 (remove-hook 'after-change-functions 'c-after-change t)
985 (add-hook 'after-change-functions 'c-after-change nil t))
987 (defun c-font-lock-init ()
988 "Set up the font-lock variables for using the font-lock support in CC Mode.
989 This does not load the font-lock package. Use after
990 `c-basic-common-init' and after cc-fonts has been loaded."
992 (make-local-variable 'font-lock-defaults)
993 (setq font-lock-defaults
994 `(,(if (c-major-mode-is 'awk-mode)
995 ;; awk-mode currently has only one font lock level.
996 'awk-font-lock-keywords
997 (mapcar 'c-mode-symbol
998 '("font-lock-keywords" "font-lock-keywords-1"
999 "font-lock-keywords-2" "font-lock-keywords-3")))
1000 nil nil
1001 ,c-identifier-syntax-modifications
1002 c-beginning-of-syntax
1003 (font-lock-lines-before . 1)
1004 (font-lock-mark-block-function
1005 . c-mark-function)))
1007 (make-local-hook 'font-lock-mode-hook)
1008 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1010 (defmacro c-advise-fl-for-region (function)
1011 `(defadvice ,function (before get-awk-region activate)
1012 ;; When font-locking an AWK Mode buffer, make sure that any string/regexp is
1013 ;; completely font-locked.
1014 (when (eq major-mode 'awk-mode)
1015 (save-excursion
1016 (ad-set-arg 1 c-new-END) ; end
1017 (ad-set-arg 0 c-new-BEG))))) ; beg
1019 (c-advise-fl-for-region font-lock-after-change-function)
1020 (c-advise-fl-for-region jit-lock-after-change)
1021 (c-advise-fl-for-region lazy-lock-defer-rest-after-change)
1022 (c-advise-fl-for-region lazy-lock-defer-line-after-change)
1025 ;; Support for C
1027 ;;;###autoload
1028 (defvar c-mode-syntax-table nil
1029 "Syntax table used in c-mode buffers.")
1030 (or c-mode-syntax-table
1031 (setq c-mode-syntax-table
1032 (funcall (c-lang-const c-make-mode-syntax-table c))))
1034 (defvar c-mode-abbrev-table nil
1035 "Abbreviation table used in c-mode buffers.")
1036 (c-define-abbrev-table 'c-mode-abbrev-table
1037 '(("else" "else" c-electric-continued-statement 0)
1038 ("while" "while" c-electric-continued-statement 0)))
1040 (defvar c-mode-map ()
1041 "Keymap used in c-mode buffers.")
1042 (if c-mode-map
1044 (setq c-mode-map (c-make-inherited-keymap))
1045 ;; add bindings which are only useful for C
1046 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1049 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
1050 (cons "C" (c-lang-const c-mode-menu c)))
1052 ;; In XEmacs >= 21.5 modes should add their own entries to
1053 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
1054 ;; doing this on load. That since `add-to-list' prepends the value
1055 ;; which could cause it to clobber user settings. Later emacsen have
1056 ;; an append option, but it's not safe to use.
1058 ;; The the extension ".C" is associated to C++ while the lowercase
1059 ;; variant goes to C. On case insensitive file systems, this means
1060 ;; that ".c" files also might open C++ mode if the C++ entry comes
1061 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1062 ;; after ".c", and since `add-to-list' adds the entry first we have to
1063 ;; add the ".C" entry first.
1064 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1065 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1066 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1068 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1070 ;; NB: The following two associate yacc and lex files to C Mode, which
1071 ;; is not really suitable for those formats. Anyway, afaik there's
1072 ;; currently no better mode for them, and besides this is legacy.
1073 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1074 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1076 ;;;###autoload
1077 (defun c-mode ()
1078 "Major mode for editing K&R and ANSI C code.
1079 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1080 c-mode buffer. This automatically sets up a mail buffer with version
1081 information already added. You just need to add a description of the
1082 problem, including a reproducible test case, and send the message.
1084 To see what version of CC Mode you are running, enter `\\[c-version]'.
1086 The hook `c-mode-common-hook' is run with no args at mode
1087 initialization, then `c-mode-hook'.
1089 Key bindings:
1090 \\{c-mode-map}"
1091 (interactive)
1092 (kill-all-local-variables)
1093 (c-initialize-cc-mode t)
1094 (set-syntax-table c-mode-syntax-table)
1095 (setq major-mode 'c-mode
1096 mode-name "C"
1097 local-abbrev-table c-mode-abbrev-table
1098 abbrev-mode t)
1099 (use-local-map c-mode-map)
1100 (c-init-language-vars-for 'c-mode)
1101 (c-common-init 'c-mode)
1102 (easy-menu-add c-c-menu)
1103 (cc-imenu-init cc-imenu-c-generic-expression)
1104 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
1105 (c-update-modeline))
1108 ;; Support for C++
1110 ;;;###autoload
1111 (defvar c++-mode-syntax-table nil
1112 "Syntax table used in c++-mode buffers.")
1113 (or c++-mode-syntax-table
1114 (setq c++-mode-syntax-table
1115 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1117 (defvar c++-mode-abbrev-table nil
1118 "Abbreviation table used in c++-mode buffers.")
1119 (c-define-abbrev-table 'c++-mode-abbrev-table
1120 '(("else" "else" c-electric-continued-statement 0)
1121 ("while" "while" c-electric-continued-statement 0)
1122 ("catch" "catch" c-electric-continued-statement 0)))
1124 (defvar c++-mode-map ()
1125 "Keymap used in c++-mode buffers.")
1126 (if c++-mode-map
1128 (setq c++-mode-map (c-make-inherited-keymap))
1129 ;; add bindings which are only useful for C++
1130 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1131 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1132 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1133 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1135 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
1136 (cons "C++" (c-lang-const c-mode-menu c++)))
1138 ;;;###autoload
1139 (defun c++-mode ()
1140 "Major mode for editing C++ code.
1141 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1142 c++-mode buffer. This automatically sets up a mail buffer with
1143 version information already added. You just need to add a description
1144 of the problem, including a reproducible test case, and send the
1145 message.
1147 To see what version of CC Mode you are running, enter `\\[c-version]'.
1149 The hook `c-mode-common-hook' is run with no args at mode
1150 initialization, then `c++-mode-hook'.
1152 Key bindings:
1153 \\{c++-mode-map}"
1154 (interactive)
1155 (kill-all-local-variables)
1156 (c-initialize-cc-mode t)
1157 (set-syntax-table c++-mode-syntax-table)
1158 (setq major-mode 'c++-mode
1159 mode-name "C++"
1160 local-abbrev-table c++-mode-abbrev-table
1161 abbrev-mode t)
1162 (use-local-map c++-mode-map)
1163 (c-init-language-vars-for 'c++-mode)
1164 (c-common-init 'c++-mode)
1165 (easy-menu-add c-c++-menu)
1166 (cc-imenu-init cc-imenu-c++-generic-expression)
1167 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
1168 (c-update-modeline))
1171 ;; Support for Objective-C
1173 ;;;###autoload
1174 (defvar objc-mode-syntax-table nil
1175 "Syntax table used in objc-mode buffers.")
1176 (or objc-mode-syntax-table
1177 (setq objc-mode-syntax-table
1178 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1180 (defvar objc-mode-abbrev-table nil
1181 "Abbreviation table used in objc-mode buffers.")
1182 (c-define-abbrev-table 'objc-mode-abbrev-table
1183 '(("else" "else" c-electric-continued-statement 0)
1184 ("while" "while" c-electric-continued-statement 0)))
1186 (defvar objc-mode-map ()
1187 "Keymap used in objc-mode buffers.")
1188 (if objc-mode-map
1190 (setq objc-mode-map (c-make-inherited-keymap))
1191 ;; add bindings which are only useful for Objective-C
1192 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1194 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
1195 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1197 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
1199 ;;;###autoload
1200 (defun objc-mode ()
1201 "Major mode for editing Objective C code.
1202 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1203 objc-mode buffer. This automatically sets up a mail buffer with
1204 version information already added. You just need to add a description
1205 of the problem, including a reproducible test case, and send the
1206 message.
1208 To see what version of CC Mode you are running, enter `\\[c-version]'.
1210 The hook `c-mode-common-hook' is run with no args at mode
1211 initialization, then `objc-mode-hook'.
1213 Key bindings:
1214 \\{objc-mode-map}"
1215 (interactive)
1216 (kill-all-local-variables)
1217 (c-initialize-cc-mode t)
1218 (set-syntax-table objc-mode-syntax-table)
1219 (setq major-mode 'objc-mode
1220 mode-name "ObjC"
1221 local-abbrev-table objc-mode-abbrev-table
1222 abbrev-mode t)
1223 (use-local-map objc-mode-map)
1224 (c-init-language-vars-for 'objc-mode)
1225 (c-common-init 'objc-mode)
1226 (easy-menu-add c-objc-menu)
1227 (cc-imenu-init nil 'cc-imenu-objc-function)
1228 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
1229 (c-update-modeline))
1232 ;; Support for Java
1234 ;;;###autoload
1235 (defvar java-mode-syntax-table nil
1236 "Syntax table used in java-mode buffers.")
1237 (or java-mode-syntax-table
1238 (setq java-mode-syntax-table
1239 (funcall (c-lang-const c-make-mode-syntax-table java))))
1241 (defvar java-mode-abbrev-table nil
1242 "Abbreviation table used in java-mode buffers.")
1243 (c-define-abbrev-table 'java-mode-abbrev-table
1244 '(("else" "else" c-electric-continued-statement 0)
1245 ("while" "while" c-electric-continued-statement 0)
1246 ("catch" "catch" c-electric-continued-statement 0)
1247 ("finally" "finally" c-electric-continued-statement 0)))
1249 (defvar java-mode-map ()
1250 "Keymap used in java-mode buffers.")
1251 (if java-mode-map
1253 (setq java-mode-map (c-make-inherited-keymap))
1254 ;; add bindings which are only useful for Java
1257 ;; Regexp trying to describe the beginning of a Java top-level
1258 ;; definition. This is not used by CC Mode, nor is it maintained
1259 ;; since it's practically impossible to write a regexp that reliably
1260 ;; matches such a construct. Other tools are necessary.
1261 (defconst c-Java-defun-prompt-regexp
1262 "^[ \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-*")
1264 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
1265 (cons "Java" (c-lang-const c-mode-menu java)))
1267 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
1269 ;;;###autoload
1270 (defun java-mode ()
1271 "Major mode for editing Java code.
1272 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1273 java-mode buffer. This automatically sets up a mail buffer with
1274 version information already added. You just need to add a description
1275 of the problem, including a reproducible test case, and send the
1276 message.
1278 To see what version of CC Mode you are running, enter `\\[c-version]'.
1280 The hook `c-mode-common-hook' is run with no args at mode
1281 initialization, then `java-mode-hook'.
1283 Key bindings:
1284 \\{java-mode-map}"
1285 (interactive)
1286 (kill-all-local-variables)
1287 (c-initialize-cc-mode t)
1288 (set-syntax-table java-mode-syntax-table)
1289 (setq major-mode 'java-mode
1290 mode-name "Java"
1291 local-abbrev-table java-mode-abbrev-table
1292 abbrev-mode t)
1293 (use-local-map java-mode-map)
1294 (c-init-language-vars-for 'java-mode)
1295 (c-common-init 'java-mode)
1296 (easy-menu-add c-java-menu)
1297 (cc-imenu-init cc-imenu-java-generic-expression)
1298 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
1299 (c-update-modeline))
1302 ;; Support for CORBA's IDL language
1304 ;;;###autoload
1305 (defvar idl-mode-syntax-table nil
1306 "Syntax table used in idl-mode buffers.")
1307 (or idl-mode-syntax-table
1308 (setq idl-mode-syntax-table
1309 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1311 (defvar idl-mode-abbrev-table nil
1312 "Abbreviation table used in idl-mode buffers.")
1313 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
1315 (defvar idl-mode-map ()
1316 "Keymap used in idl-mode buffers.")
1317 (if idl-mode-map
1319 (setq idl-mode-map (c-make-inherited-keymap))
1320 ;; add bindings which are only useful for IDL
1323 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
1324 (cons "IDL" (c-lang-const c-mode-menu idl)))
1326 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
1328 ;;;###autoload
1329 (defun idl-mode ()
1330 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
1331 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1332 idl-mode buffer. This automatically sets up a mail buffer with
1333 version information already added. You just need to add a description
1334 of the problem, including a reproducible test case, and send the
1335 message.
1337 To see what version of CC Mode you are running, enter `\\[c-version]'.
1339 The hook `c-mode-common-hook' is run with no args at mode
1340 initialization, then `idl-mode-hook'.
1342 Key bindings:
1343 \\{idl-mode-map}"
1344 (interactive)
1345 (kill-all-local-variables)
1346 (c-initialize-cc-mode t)
1347 (set-syntax-table idl-mode-syntax-table)
1348 (setq major-mode 'idl-mode
1349 mode-name "IDL"
1350 local-abbrev-table idl-mode-abbrev-table)
1351 (use-local-map idl-mode-map)
1352 (c-init-language-vars-for 'idl-mode)
1353 (c-common-init 'idl-mode)
1354 (easy-menu-add c-idl-menu)
1355 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
1356 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
1357 (c-update-modeline))
1360 ;; Support for Pike
1362 ;;;###autoload
1363 (defvar pike-mode-syntax-table nil
1364 "Syntax table used in pike-mode buffers.")
1365 (or pike-mode-syntax-table
1366 (setq pike-mode-syntax-table
1367 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1369 (defvar pike-mode-abbrev-table nil
1370 "Abbreviation table used in pike-mode buffers.")
1371 (c-define-abbrev-table 'pike-mode-abbrev-table
1372 '(("else" "else" c-electric-continued-statement 0)
1373 ("while" "while" c-electric-continued-statement 0)))
1375 (defvar pike-mode-map ()
1376 "Keymap used in pike-mode buffers.")
1377 (if pike-mode-map
1379 (setq pike-mode-map (c-make-inherited-keymap))
1380 ;; additional bindings
1381 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1383 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
1384 (cons "Pike" (c-lang-const c-mode-menu pike)))
1386 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1387 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
1389 ;;;###autoload
1390 (defun pike-mode ()
1391 "Major mode for editing Pike code.
1392 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1393 pike-mode buffer. This automatically sets up a mail buffer with
1394 version information already added. You just need to add a description
1395 of the problem, including a reproducible test case, and send the
1396 message.
1398 To see what version of CC Mode you are running, enter `\\[c-version]'.
1400 The hook `c-mode-common-hook' is run with no args at mode
1401 initialization, then `pike-mode-hook'.
1403 Key bindings:
1404 \\{pike-mode-map}"
1405 (interactive)
1406 (kill-all-local-variables)
1407 (c-initialize-cc-mode t)
1408 (set-syntax-table pike-mode-syntax-table)
1409 (setq major-mode 'pike-mode
1410 mode-name "Pike"
1411 local-abbrev-table pike-mode-abbrev-table
1412 abbrev-mode t)
1413 (use-local-map pike-mode-map)
1414 (c-init-language-vars-for 'pike-mode)
1415 (c-common-init 'pike-mode)
1416 (easy-menu-add c-pike-menu)
1417 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
1418 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
1419 (c-update-modeline))
1422 ;; Support for AWK
1424 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1425 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1426 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1427 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1428 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
1430 ;;; Autoload directives must be on the top level, so we construct an
1431 ;;; autoload form instead.
1432 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1434 (defvar awk-mode-abbrev-table nil
1435 "Abbreviation table used in awk-mode buffers.")
1436 (c-define-abbrev-table 'awk-mode-abbrev-table
1437 '(("else" "else" c-electric-continued-statement 0)
1438 ("while" "while" c-electric-continued-statement 0)))
1440 (defvar awk-mode-map ()
1441 "Keymap used in awk-mode buffers.")
1442 (if awk-mode-map
1444 (setq awk-mode-map (c-make-inherited-keymap))
1445 ;; add bindings which are only useful for awk.
1446 (define-key awk-mode-map "#" 'self-insert-command)
1447 (define-key awk-mode-map "/" 'self-insert-command)
1448 (define-key awk-mode-map "*" 'self-insert-command)
1449 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1450 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1451 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1452 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1453 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1454 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1455 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1457 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1458 (cons "AWK" (c-lang-const c-mode-menu awk)))
1460 (defun awk-mode ()
1461 "Major mode for editing AWK code.
1462 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1463 awk-mode buffer. This automatically sets up a mail buffer with version
1464 information already added. You just need to add a description of the
1465 problem, including a reproducible test case, and send the message.
1467 To see what version of CC Mode you are running, enter `\\[c-version]'.
1469 The hook `c-mode-common-hook' is run with no args at mode
1470 initialization, then `awk-mode-hook'.
1472 Key bindings:
1473 \\{awk-mode-map}"
1474 (interactive)
1475 (require 'cc-awk) ; Added 2003/6/10.
1476 (kill-all-local-variables)
1477 (c-initialize-cc-mode t)
1478 (set-syntax-table awk-mode-syntax-table)
1479 (setq major-mode 'awk-mode
1480 mode-name "AWK"
1481 local-abbrev-table awk-mode-abbrev-table
1482 abbrev-mode t)
1483 (use-local-map awk-mode-map)
1484 (c-init-language-vars-for 'awk-mode)
1485 (c-common-init 'awk-mode)
1486 (c-awk-unstick-NL-prop)
1488 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1489 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1490 (defalias 'c-in-literal 'c-slow-in-literal)
1492 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1493 (c-update-modeline))
1496 ;; bug reporting
1498 (defconst c-mode-help-address
1499 "bug-cc-mode@gnu.org"
1500 "Address(es) for CC Mode bug reports.")
1502 (defun c-version ()
1503 "Echo the current version of CC Mode in the minibuffer."
1504 (interactive)
1505 (message "Using CC Mode version %s" c-version)
1506 (c-keep-region-active))
1508 (defvar c-prepare-bug-report-hooks nil)
1510 ;; Dynamic variables used by reporter.
1511 (defvar reporter-prompt-for-summary-p)
1512 (defvar reporter-dont-compact-list)
1514 (defun c-submit-bug-report ()
1515 "Submit via mail a bug report on CC Mode."
1516 (interactive)
1517 (require 'reporter)
1518 ;; load in reporter
1519 (let ((reporter-prompt-for-summary-p t)
1520 (reporter-dont-compact-list '(c-offsets-alist))
1521 (style c-indentation-style)
1522 (c-features c-emacs-features))
1523 (and
1524 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1525 t (message "") nil)
1526 (reporter-submit-bug-report
1527 c-mode-help-address
1528 (concat "CC Mode " c-version " (" mode-name ")")
1529 (let ((vars (append
1530 c-style-variables
1531 '(c-buffer-is-cc-mode
1532 c-tab-always-indent
1533 c-syntactic-indentation
1534 c-syntactic-indentation-in-macros
1535 c-ignore-auto-fill
1536 c-auto-align-backslashes
1537 c-backspace-function
1538 c-delete-function
1539 c-electric-pound-behavior
1540 c-default-style
1541 c-enable-xemacs-performance-kludge-p
1542 c-old-style-variable-behavior
1543 defun-prompt-regexp
1544 tab-width
1545 comment-column
1546 parse-sexp-ignore-comments
1547 parse-sexp-lookup-properties
1548 lookup-syntax-properties
1549 ;; A brain-damaged XEmacs only variable that, if
1550 ;; set to nil can cause all kinds of chaos.
1551 signal-error-on-buffer-boundary
1552 ;; Variables that affect line breaking and comments.
1553 auto-fill-mode
1554 auto-fill-function
1555 filladapt-mode
1556 comment-multi-line
1557 comment-start-skip
1558 fill-prefix
1559 fill-column
1560 paragraph-start
1561 adaptive-fill-mode
1562 adaptive-fill-regexp)
1563 nil)))
1564 (mapc (lambda (var) (unless (boundp var)
1565 (setq vars (delq var vars))))
1566 '(signal-error-on-buffer-boundary
1567 filladapt-mode
1568 defun-prompt-regexp
1569 font-lock-mode
1570 font-lock-maximum-decoration
1571 parse-sexp-lookup-properties
1572 lookup-syntax-properties))
1573 vars)
1574 (lambda ()
1575 (run-hooks 'c-prepare-bug-report-hooks)
1576 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1577 style c-features)))))))
1580 (cc-provide 'cc-mode)
1582 ;;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
1583 ;;; cc-mode.el ends here