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