* progmodes/cc-mode.el (c-postprocess-file-styles): Throw an error
[emacs.git] / lisp / progmodes / cc-mode.el
blobd2abb3732fb249dc3170084e3cd6ef52b910a7a4
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 c-comment-continuation-stars))
194 (add-hook 'change-major-mode-hook 'c-leave-cc-mode-mode)
195 (setq c-initialization-ok t))
196 ;; Will try initialization hooks again if they failed.
197 (put 'c-initialize-cc-mode initprop c-initialization-ok))))
199 (unless new-style-init
200 (c-init-language-vars-for 'c-mode)))
203 ;;; Common routines.
205 (defvar c-mode-base-map ()
206 "Keymap shared by all CC Mode related modes.")
208 (defun c-make-inherited-keymap ()
209 (let ((map (make-sparse-keymap)))
210 ;; Necessary to use `cc-bytecomp-fboundp' below since this
211 ;; function is called from top-level forms that are evaluated
212 ;; while cc-bytecomp is active when one does M-x eval-buffer.
213 (cond
214 ;; XEmacs
215 ((cc-bytecomp-fboundp 'set-keymap-parents)
216 (set-keymap-parents map c-mode-base-map))
217 ;; Emacs
218 ((cc-bytecomp-fboundp 'set-keymap-parent)
219 (set-keymap-parent map c-mode-base-map))
220 ;; incompatible
221 (t (error "CC Mode is incompatible with this version of Emacs")))
222 map))
224 (defun c-define-abbrev-table (name defs)
225 ;; Compatibility wrapper for `define-abbrev' which passes a non-nil
226 ;; sixth argument for SYSTEM-FLAG in emacsen that support it
227 ;; (currently only Emacs >= 21.2).
228 (let ((table (or (symbol-value name)
229 (progn (define-abbrev-table name nil)
230 (symbol-value name)))))
231 (while defs
232 (condition-case nil
233 (apply 'define-abbrev table (append (car defs) '(t)))
234 (wrong-number-of-arguments
235 (apply 'define-abbrev table (car defs))))
236 (setq defs (cdr defs)))))
237 (put 'c-define-abbrev-table 'lisp-indent-function 1)
239 (defun c-bind-special-erase-keys ()
240 ;; Only used in Emacs to bind C-c C-<delete> and C-c C-<backspace>
241 ;; to the proper keys depending on `normal-erase-is-backspace'.
242 (if normal-erase-is-backspace
243 (progn
244 (define-key c-mode-base-map (kbd "C-c C-<delete>")
245 'c-hungry-delete-forward)
246 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
247 'c-hungry-delete-backwards))
248 (define-key c-mode-base-map (kbd "C-c C-<delete>")
249 'c-hungry-delete-backwards)
250 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
251 'c-hungry-delete-forward)))
253 (if c-mode-base-map
256 (setq c-mode-base-map (make-sparse-keymap))
258 ;; Separate M-BS from C-M-h. The former should remain
259 ;; backward-kill-word.
260 (define-key c-mode-base-map [(control meta h)] 'c-mark-function)
261 (define-key c-mode-base-map "\e\C-q" 'c-indent-exp)
262 (substitute-key-definition 'backward-sentence
263 'c-beginning-of-statement
264 c-mode-base-map global-map)
265 (substitute-key-definition 'forward-sentence
266 'c-end-of-statement
267 c-mode-base-map global-map)
268 (substitute-key-definition 'indent-new-comment-line
269 'c-indent-new-comment-line
270 c-mode-base-map global-map)
271 (substitute-key-definition 'indent-for-tab-command
272 'c-indent-command
273 c-mode-base-map global-map)
274 (when (fboundp 'comment-indent-new-line)
275 ;; indent-new-comment-line has changed name to
276 ;; comment-indent-new-line in Emacs 21.
277 (substitute-key-definition 'comment-indent-new-line
278 'c-indent-new-comment-line
279 c-mode-base-map global-map))
281 ;; RMS says don't make these the default.
282 ;; (April 2006): RMS has now approved these commands as defaults.
283 (define-key c-mode-base-map "\e\C-a" 'c-beginning-of-defun)
284 (define-key c-mode-base-map "\e\C-e" 'c-end-of-defun)
286 (define-key c-mode-base-map "\C-c\C-n" 'c-forward-conditional)
287 (define-key c-mode-base-map "\C-c\C-p" 'c-backward-conditional)
288 (define-key c-mode-base-map "\C-c\C-u" 'c-up-conditional)
290 ;; It doesn't suffice to put `c-fill-paragraph' on
291 ;; `fill-paragraph-function' since `c-fill-paragraph' must be called
292 ;; before any fill prefix adaption is done. E.g. `filladapt-mode'
293 ;; replaces `fill-paragraph' and does the adaption before calling
294 ;; `fill-paragraph-function', and we have to mask comments etc
295 ;; before that. Also, `c-fill-paragraph' chains on to
296 ;; `fill-paragraph' and the value on `fill-parapgraph-function' to
297 ;; do the actual filling work.
298 (substitute-key-definition 'fill-paragraph 'c-fill-paragraph
299 c-mode-base-map global-map)
300 ;; In XEmacs the default fill function is called
301 ;; fill-paragraph-or-region.
302 (substitute-key-definition 'fill-paragraph-or-region 'c-fill-paragraph
303 c-mode-base-map global-map)
305 ;; We bind the forward deletion key and (implicitly) C-d to
306 ;; `c-electric-delete-forward', and the backward deletion key to
307 ;; `c-electric-backspace'. The hungry variants are bound to the
308 ;; same keys but prefixed with C-c. This implies that C-c C-d is
309 ;; `c-hungry-delete-forward'. For consistency, we bind not only C-c
310 ;; <backspace> to `c-hungry-delete-backwards' but also
311 ;; C-c C-<backspace>, so that the Ctrl key can be held down during
312 ;; the whole sequence regardless of the direction. This in turn
313 ;; implies that we bind C-c C-<delete> to `c-hungry-delete-forward',
314 ;; for the same reason.
316 ;; Bind the electric deletion functions to C-d and DEL. Emacs 21
317 ;; automatically maps the [delete] and [backspace] keys to these two
318 ;; depending on window system and user preferences. (In earlier
319 ;; versions it's possible to do the same by using `function-key-map'.)
320 (define-key c-mode-base-map "\C-d" 'c-electric-delete-forward)
321 (define-key c-mode-base-map "\177" 'c-electric-backspace)
322 (define-key c-mode-base-map "\C-c\C-d" 'c-hungry-delete-forward)
323 (define-key c-mode-base-map [?\C-c ?\d] 'c-hungry-delete-backwards)
324 (define-key c-mode-base-map [?\C-c ?\C-\d] 'c-hungry-delete-backwards)
325 (define-key c-mode-base-map [?\C-c deletechar] 'c-hungry-delete-forward) ; C-c <delete> on a tty.
326 (define-key c-mode-base-map [?\C-c (control deletechar)] ; C-c C-<delete> on a tty.
327 'c-hungry-delete-forward)
328 (when (boundp 'normal-erase-is-backspace)
329 ;; The automatic C-d and DEL mapping functionality doesn't extend
330 ;; to special combinations like C-c C-<delete>, so we have to hook
331 ;; into the `normal-erase-is-backspace' system to bind it directly
332 ;; as appropriate.
333 (add-hook 'normal-erase-is-backspace-hook 'c-bind-special-erase-keys)
334 (c-bind-special-erase-keys))
336 (when (fboundp 'delete-forward-p)
337 ;; In XEmacs we fix the forward and backward deletion behavior by
338 ;; binding the keysyms for the [delete] and [backspace] keys
339 ;; directly, and use `delete-forward-p' to decide what [delete]
340 ;; should do. That's done in the XEmacs specific
341 ;; `c-electric-delete' and `c-hungry-delete' functions.
342 (define-key c-mode-base-map [delete] 'c-electric-delete)
343 (define-key c-mode-base-map [backspace] 'c-electric-backspace)
344 (define-key c-mode-base-map (kbd "C-c <delete>") 'c-hungry-delete)
345 (define-key c-mode-base-map (kbd "C-c C-<delete>") 'c-hungry-delete)
346 (define-key c-mode-base-map (kbd "C-c <backspace>")
347 'c-hungry-delete-backwards)
348 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
349 'c-hungry-delete-backwards))
351 (define-key c-mode-base-map "#" 'c-electric-pound)
352 (define-key c-mode-base-map "{" 'c-electric-brace)
353 (define-key c-mode-base-map "}" 'c-electric-brace)
354 (define-key c-mode-base-map "/" 'c-electric-slash)
355 (define-key c-mode-base-map "*" 'c-electric-star)
356 (define-key c-mode-base-map ";" 'c-electric-semi&comma)
357 (define-key c-mode-base-map "," 'c-electric-semi&comma)
358 (define-key c-mode-base-map ":" 'c-electric-colon)
359 (define-key c-mode-base-map "(" 'c-electric-paren)
360 (define-key c-mode-base-map ")" 'c-electric-paren)
362 (define-key c-mode-base-map "\C-c\C-\\" 'c-backslash-region)
363 (define-key c-mode-base-map "\C-c\C-a" 'c-toggle-auto-newline)
364 (define-key c-mode-base-map "\C-c\C-b" 'c-submit-bug-report)
365 (define-key c-mode-base-map "\C-c\C-c" 'comment-region)
366 (define-key c-mode-base-map "\C-c\C-l" 'c-toggle-electric-state)
367 (define-key c-mode-base-map "\C-c\C-o" 'c-set-offset)
368 (define-key c-mode-base-map "\C-c\C-q" 'c-indent-defun)
369 (define-key c-mode-base-map "\C-c\C-s" 'c-show-syntactic-information)
370 ;; (define-key c-mode-base-map "\C-c\C-t" 'c-toggle-auto-hungry-state) Commented out by ACM, 2005-03-05.
371 (define-key c-mode-base-map "\C-c." 'c-set-style)
372 ;; conflicts with OOBR
373 ;;(define-key c-mode-base-map "\C-c\C-v" 'c-version)
374 ;; (define-key c-mode-base-map "\C-c\C-y" 'c-toggle-hungry-state) Commented out by ACM, 2005-11-22.
375 (define-key c-mode-base-map "\C-c\C-w" 'c-subword-mode)
378 ;; We don't require the outline package, but we configure it a bit anyway.
379 (cc-bytecomp-defvar outline-level)
381 (defun c-mode-menu (modestr)
382 "Return a menu spec suitable for `easy-menu-define' that is exactly
383 like the C mode menu except that the menu bar item name is MODESTR
384 instead of \"C\".
386 This function is provided for compatibility only; derived modes should
387 preferably use the `c-mode-menu' language constant directly."
388 (cons modestr (c-lang-const c-mode-menu c)))
390 ;; Ugly hack to pull in the definition of `c-populate-syntax-table'
391 ;; from cc-langs to make it available at runtime. It's either this or
392 ;; moving the definition for it to cc-defs, but that would mean to
393 ;; break up the syntax table setup over two files.
394 (defalias 'c-populate-syntax-table
395 (cc-eval-when-compile
396 (let ((f (symbol-function 'c-populate-syntax-table)))
397 (if (byte-code-function-p f) f (byte-compile f)))))
399 ;; CAUTION: Try to avoid installing things on
400 ;; `before-change-functions'. The macro `combine-after-change-calls'
401 ;; is used and it doesn't work if there are things on that hook. That
402 ;; can cause font lock functions to run in inconvenient places during
403 ;; temporary changes in some font lock support modes, causing extra
404 ;; unnecessary work and font lock glitches due to interactions between
405 ;; various text properties.
407 ;; (2007-02-12): The macro `combine-after-change-calls' ISN'T used any
408 ;; more.
410 (defun c-unfind-enclosing-token (pos)
411 ;; If POS is wholly inside a token, remove that id from
412 ;; `c-found-types', should it be present. Return t if we were in an
413 ;; id, else nil.
414 (save-excursion
415 (let ((tok-beg (progn (goto-char pos)
416 (and (c-beginning-of-current-token) (point))))
417 (tok-end (progn (goto-char pos)
418 (and (c-end-of-current-token) (point)))))
419 (when (and tok-beg tok-end)
420 (c-unfind-type (buffer-substring-no-properties tok-beg tok-end))
421 t))))
423 (defun c-unfind-coalesced-tokens (beg end)
424 ;; unless the non-empty region (beg end) is entirely WS and there's at
425 ;; least one character of WS just before or after this region, remove
426 ;; the tokens which touch the region from `c-found-types' should they
427 ;; be present.
428 (or (c-partial-ws-p beg end)
429 (save-excursion
430 (progn
431 (goto-char beg)
432 (or (eq beg (point-min))
433 (c-skip-ws-backward (1- beg))
434 (/= (point) beg)
435 (= (c-backward-token-2) 1)
436 (c-unfind-type (buffer-substring-no-properties
437 (point) beg)))
438 (goto-char end)
439 (or (eq end (point-max))
440 (c-skip-ws-forward (1+ end))
441 (/= (point) end)
442 (progn (forward-char) (c-end-of-current-token) nil)
443 (c-unfind-type (buffer-substring-no-properties
444 end (point))))))))
446 ;; c-maybe-stale-found-type records a place near the region being
447 ;; changed where an element of `found-types' might become stale. It
448 ;; is set in c-before-change and is either nil, or has the form:
450 ;; (c-decl-id-start "foo" 97 107 " (* ooka) " "o"), where
452 ;; o - `c-decl-id-start' is the c-type text property value at buffer
453 ;; pos 96.
455 ;; o - 97 107 is the region potentially containing the stale type -
456 ;; this is delimited by a non-nil c-type text property at 96 and
457 ;; either another one or a ";", "{", or "}" at 107.
459 ;; o - " (* ooka) " is the (before change) buffer portion containing
460 ;; the suspect type (here "ooka").
462 ;; o - "o" is the buffer contents which is about to be deleted. This
463 ;; would be the empty string for an insertion.
464 (defvar c-maybe-stale-found-type nil)
465 (make-variable-buffer-local 'c-maybe-stale-found-type)
467 (defun c-basic-common-init (mode default-style)
468 "Do the necessary initialization for the syntax handling routines
469 and the line breaking/filling code. Intended to be used by other
470 packages that embed CC Mode.
472 MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode.
473 DEFAULT-STYLE tells which indentation style to install. It has the
474 same format as `c-default-style'.
476 Note that `c-init-language-vars' must be called before this function.
477 This function cannot do that since `c-init-language-vars' is a macro
478 that requires a literal mode spec at compile time."
480 (setq c-buffer-is-cc-mode mode)
482 ;; these variables should always be buffer local; they do not affect
483 ;; indentation style.
484 (make-local-variable 'parse-sexp-ignore-comments)
485 (make-local-variable 'indent-line-function)
486 (make-local-variable 'indent-region-function)
487 (make-local-variable 'normal-auto-fill-function)
488 (make-local-variable 'comment-start)
489 (make-local-variable 'comment-end)
490 (make-local-variable 'comment-start-skip)
491 (make-local-variable 'comment-multi-line)
492 (make-local-variable 'comment-line-break-function)
493 (make-local-variable 'paragraph-start)
494 (make-local-variable 'paragraph-separate)
495 (make-local-variable 'paragraph-ignore-fill-prefix)
496 (make-local-variable 'adaptive-fill-mode)
497 (make-local-variable 'adaptive-fill-regexp)
499 ;; now set their values
500 (setq parse-sexp-ignore-comments t
501 indent-line-function 'c-indent-line
502 indent-region-function 'c-indent-region
503 normal-auto-fill-function 'c-do-auto-fill
504 comment-multi-line t
505 comment-line-break-function 'c-indent-new-comment-line)
507 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
508 ;; direct call to `fill-paragraph' behaves better. This still
509 ;; doesn't work with filladapt but it's better than nothing.
510 (make-local-variable 'fill-paragraph-function)
511 (setq fill-paragraph-function 'c-fill-paragraph)
513 (when (or c-recognize-<>-arglists
514 (c-major-mode-is 'awk-mode)
515 (c-major-mode-is '(c-mode c++-mode objc-mode)))
516 ;; We'll use the syntax-table text property to change the syntax
517 ;; of some chars for this language, so do the necessary setup for
518 ;; that.
520 ;; Note to other package developers: It's ok to turn this on in CC
521 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
522 ;; off if CC Mode has turned it on.
524 ;; Emacs.
525 (when (boundp 'parse-sexp-lookup-properties)
526 (make-local-variable 'parse-sexp-lookup-properties)
527 (setq parse-sexp-lookup-properties t))
529 ;; Same as above for XEmacs.
530 (when (boundp 'lookup-syntax-properties)
531 (make-local-variable 'lookup-syntax-properties)
532 (setq lookup-syntax-properties t)))
534 ;; Use this in Emacs 21 to avoid meddling with the rear-nonsticky
535 ;; property on each character.
536 (when (boundp 'text-property-default-nonsticky)
537 (make-local-variable 'text-property-default-nonsticky)
538 (let ((elem (assq 'syntax-table text-property-default-nonsticky)))
539 (if elem
540 (setcdr elem t)
541 (setq text-property-default-nonsticky
542 (cons '(syntax-table . t)
543 text-property-default-nonsticky))))
544 (setq text-property-default-nonsticky
545 (cons '(c-type . t)
546 text-property-default-nonsticky)))
548 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
549 ;; heuristic that open parens in column 0 are defun starters. Since
550 ;; we have c-state-cache, that heuristic isn't useful and only causes
551 ;; trouble, so turn it off.
552 ;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
553 ;; helpful. Comment it out for now.
554 ;; (when (memq 'col-0-paren c-emacs-features)
555 ;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
556 ;; (setq open-paren-in-column-0-is-defun-start nil))
558 (c-clear-found-types)
560 ;; now set the mode style based on default-style
561 (let ((style (if (stringp default-style)
562 default-style
563 (or (cdr (assq mode default-style))
564 (cdr (assq 'other default-style))
565 "gnu"))))
566 ;; Override style variables if `c-old-style-variable-behavior' is
567 ;; set. Also override if we are using global style variables,
568 ;; have already initialized a style once, and are switching to a
569 ;; different style. (It's doubtful whether this is desirable, but
570 ;; the whole situation with nonlocal style variables is a bit
571 ;; awkward. It's at least the most compatible way with the old
572 ;; style init procedure.)
573 (c-set-style style (not (or c-old-style-variable-behavior
574 (and (not c-style-variables-are-local-p)
575 c-indentation-style
576 (not (string-equal c-indentation-style
577 style)))))))
578 (c-setup-paragraph-variables)
580 ;; we have to do something special for c-offsets-alist so that the
581 ;; buffer local value has its own alist structure.
582 (setq c-offsets-alist (copy-alist c-offsets-alist))
584 ;; setup the comment indent variable in a Emacs version portable way
585 (make-local-variable 'comment-indent-function)
586 (setq comment-indent-function 'c-comment-indent)
588 ;; ;; Put submode indicators onto minor-mode-alist, but only once.
589 ;; (or (assq 'c-submode-indicators minor-mode-alist)
590 ;; (setq minor-mode-alist
591 ;; (cons '(c-submode-indicators c-submode-indicators)
592 ;; minor-mode-alist)))
593 (c-update-modeline)
595 ;; Install the functions that ensure that various internal caches
596 ;; don't become invalid due to buffer changes.
597 (make-local-hook 'before-change-functions)
598 (add-hook 'before-change-functions 'c-before-change nil t)
599 (make-local-hook 'after-change-functions)
600 (add-hook 'after-change-functions 'c-after-change nil t)
601 (set (make-local-variable 'font-lock-extend-after-change-region-function)
602 'c-extend-after-change-region)) ; Currently (2008-04), only used by AWK.
604 (defun c-setup-doc-comment-style ()
605 "Initialize the variables that depend on the value of `c-doc-comment-style'."
606 (when (and (featurep 'font-lock)
607 (symbol-value 'font-lock-mode))
608 ;; Force font lock mode to reinitialize itself.
609 (font-lock-mode 0)
610 (font-lock-mode 1)))
612 (defun c-common-init (&optional mode)
613 "Common initialization for all CC Mode modes.
614 In addition to the work done by `c-basic-common-init' and
615 `c-font-lock-init', this function sets up various other things as
616 customary in CC Mode modes but which aren't strictly necessary for CC
617 Mode to operate correctly.
619 MODE is the symbol for the mode to initialize, like 'c-mode. See
620 `c-basic-common-init' for details. It's only optional to be
621 compatible with old code; callers should always specify it."
623 (unless mode
624 ;; Called from an old third party package. The fallback is to
625 ;; initialize for C.
626 (c-init-language-vars-for 'c-mode))
628 (c-basic-common-init mode c-default-style)
629 (when mode
630 ;; Only initialize font locking if we aren't called from an old package.
631 (c-font-lock-init))
633 ;; Starting a mode is a sort of "change". So call the change functions...
634 (save-restriction
635 (widen)
636 (save-excursion
637 (if c-get-state-before-change-function
638 (funcall c-get-state-before-change-function (point-min) (point-max)))
639 (if c-before-font-lock-function
640 (funcall c-before-font-lock-function (point-min) (point-max)
641 (- (point-max) (point-min))))))
643 (make-local-variable 'outline-regexp)
644 (make-local-variable 'outline-level)
645 (setq outline-regexp "[^#\n\^M]"
646 outline-level 'c-outline-level)
648 (let ((rfn (assq mode c-require-final-newline)))
649 (when rfn
650 (make-local-variable 'require-final-newline)
651 (and (cdr rfn)
652 (setq require-final-newline mode-require-final-newline)))))
654 (defun c-remove-any-local-eval-or-mode-variables ()
655 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
656 ;; or on the first line, remove all occurrences. See
657 ;; `c-postprocess-file-styles' for justification. There is no need to save
658 ;; point here, or even bother too much about the buffer contents. However,
659 ;; DON'T mess up the kill-ring.
661 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
662 ;; in files.el.
663 (goto-char (point-max))
664 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
665 (let (lv-point (prefix "") (suffix ""))
666 (when (let ((case-fold-search t))
667 (search-forward "Local Variables:" nil t))
668 (setq lv-point (point))
669 ;; The prefix is what comes before "local variables:" in its line.
670 ;; The suffix is what comes after "local variables:" in its line.
671 (skip-chars-forward " \t")
672 (or (eolp)
673 (setq suffix (buffer-substring (point)
674 (progn (end-of-line) (point)))))
675 (goto-char (match-beginning 0))
676 (or (bolp)
677 (setq prefix
678 (buffer-substring (point)
679 (progn (beginning-of-line) (point)))))
681 (while (search-forward-regexp
682 (concat "^[ \t]*"
683 (regexp-quote prefix)
684 "\\(mode\\|eval\\):.*"
685 (regexp-quote suffix)
686 "$")
687 nil t)
688 (forward-line 0)
689 (delete-region (point) (progn (forward-line) (point)))))
691 ;; Delete the first line, if we've got one, in case it contains a mode spec.
692 (unless (and lv-point
693 (progn (goto-char lv-point)
694 (forward-line 0)
695 (bobp)))
696 (goto-char (point-min))
697 (unless (eobp)
698 (delete-region (point) (progn (forward-line) (point)))))))
700 (defun c-postprocess-file-styles ()
701 "Function that post processes relevant file local variables in CC Mode.
702 Currently, this function simply applies any style and offset settings
703 found in the file's Local Variable list. It first applies any style
704 setting found in `c-file-style', then it applies any offset settings
705 it finds in `c-file-offsets'.
707 Note that the style variables are always made local to the buffer."
709 ;; apply file styles and offsets
710 (when c-buffer-is-cc-mode
711 (if (or c-file-style c-file-offsets)
712 (c-make-styles-buffer-local t))
713 (when c-file-style
714 (or (stringp c-file-style)
715 (error "c-file-style is not a string"))
716 (c-set-style c-file-style))
718 (and c-file-offsets
719 (mapcar
720 (lambda (langentry)
721 (let ((langelem (car langentry))
722 (offset (cdr langentry)))
723 (c-set-offset langelem offset)))
724 c-file-offsets))
725 ;; Problem: The file local variable block might have explicitly set a
726 ;; style variable. The `c-set-style' or `mapcar' call might have
727 ;; overwritten this. So we run `hack-local-variables' again to remedy
728 ;; this. There are no guarantees this will work properly, particularly as
729 ;; we have no control over what the other hook functions on
730 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
731 ;; any `eval' or `mode' expressions before we evaluate again (see below).
732 ;; ACM, 2005/11/2.
734 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
735 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
736 ;; We prevent this by temporarily removing `mode' from the Local Variables
737 ;; section.
738 (if (or c-file-style c-file-offsets)
739 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
740 (c-tentative-buffer-changes
741 (c-remove-any-local-eval-or-mode-variables)
742 (hack-local-variables))
743 nil))))
745 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles)
747 (defmacro c-run-mode-hooks (&rest hooks)
748 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
749 ;; require the use of the new function `run-mode-hooks'.
750 (if (cc-bytecomp-fboundp 'run-mode-hooks)
751 `(run-mode-hooks ,@hooks)
752 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
755 ;;; Change hooks, linking with Font Lock.
757 ;; Buffer local variables defining the region to be fontified by a font lock
758 ;; after-change function. They are set in c-after-change to
759 ;; after-change-function's BEG and END, and may be modified by a
760 ;; `c-before-font-lock-function'.
761 (defvar c-new-BEG 0)
762 (make-variable-buffer-local 'c-new-BEG)
763 (defvar c-new-END 0)
764 (make-variable-buffer-local 'c-new-END)
766 ;; Buffer local variables recording Beginning/End-of-Macro position before a
767 ;; change, when a macro straddles, respectively, the BEG or END (or both) of
768 ;; the change region. Otherwise these have the values BEG/END.
769 (defvar c-old-BOM 0)
770 (make-variable-buffer-local 'c-old-BOM)
771 (defvar c-old-EOM 0)
772 (make-variable-buffer-local 'c-old-EOM)
774 (defun c-extend-region-for-CPP (beg end)
775 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
776 ;; beginning/end of any preprocessor construct they may be in.
778 ;; Point is undefined both before and after this function call; the buffer
779 ;; has already been widened, and match-data saved. The return value is
780 ;; meaningless.
782 ;; This function is the C/C++/ObjC value of
783 ;; `c-get-state-before-change-function' and is called exclusively as a
784 ;; before change function.
785 (goto-char beg)
786 (c-beginning-of-macro)
787 (setq c-old-BOM (point))
789 (goto-char end)
790 (if (c-beginning-of-macro)
791 (c-end-of-macro))
792 (setq c-old-EOM (point)))
794 (defun c-neutralize-CPP-line (beg end)
795 ;; BEG and END bound a region, typically a preprocessor line. Put a
796 ;; "punctuation" syntax-table property on syntactically obtrusive
797 ;; characters, ones which would interact syntactically with stuff outside
798 ;; this region.
800 ;; These are unmatched string delimiters, or unmatched
801 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
802 ;; obtrusive.
803 (save-excursion
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 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
840 ;; This function might make hidden buffer changes.
841 (c-save-buffer-state (limits mbeg+1 beg end)
842 ;; First determine the region, (beg end), which may need "neutralizing".
843 ;; This may not start inside a string, comment, or macro.
844 (goto-char c-old-BOM) ; already set to old start of macro or begg.
845 (setq beg
846 (if (setq limits (c-literal-limits))
847 (cdr limits) ; go forward out of any string or comment.
848 (point)))
850 (goto-char endd)
851 (if (setq limits (c-literal-limits))
852 (goto-char (car limits))) ; go backward out of any string or comment.
853 (if (c-beginning-of-macro)
854 (c-end-of-macro))
855 (setq end (max (+ (- c-old-EOM old-len) (- endd begg))
856 (point)))
858 ;; Clear all old punctuation properties
859 (c-clear-char-property-with-value beg end 'syntax-table '(1))
861 (goto-char beg)
862 (let ((pps-position beg) pps-state)
863 (while (and (< (point) end)
864 (search-forward-regexp c-anchored-cpp-prefix end t))
865 ;; If we've found a "#" inside a string/comment, ignore it.
866 (setq pps-state
867 (parse-partial-sexp pps-position (point) nil nil pps-state)
868 pps-position (point))
869 (unless (or (nth 3 pps-state) ; in a string?
870 (nth 4 pps-state)) ; in a comment?
871 (setq mbeg+1 (point))
872 (c-end-of-macro) ; Do we need to go forward 1 char here? No!
873 (c-neutralize-CPP-line mbeg+1 (point))
874 (setq pps-position (point))))))) ; no need to update pps-state.
876 (defun c-before-change (beg end)
877 ;; Function to be put on `before-change-function'. Primarily, this calls
878 ;; the language dependent `c-get-state-before-change-function'. It is
879 ;; otherwise used only to remove stale entries from the `c-found-types'
880 ;; cache, and to record entries which a `c-after-change' function might
881 ;; confirm as stale.
883 ;; Note that this function must be FAST rather than accurate. Note
884 ;; also that it only has any effect when font locking is enabled.
885 ;; We exploit this by checking for font-lock-*-face instead of doing
886 ;; rigourous syntactic analysis.
888 ;; If either change boundary is wholly inside an identifier, delete
889 ;; it/them from the cache. Don't worry about being inside a string
890 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
891 ;; isn't critical.
892 (setq c-maybe-stale-found-type nil)
893 (save-restriction
894 (save-match-data
895 (widen)
896 (save-excursion
897 ;; Are we inserting/deleting stuff in the middle of an identifier?
898 (c-unfind-enclosing-token beg)
899 (c-unfind-enclosing-token end)
900 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
901 (when (< beg end)
902 (c-unfind-coalesced-tokens beg end))
903 ;; Are we (potentially) disrupting the syntactic context which
904 ;; makes a type a type? E.g. by inserting stuff after "foo" in
905 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
907 ;; We search for appropriate c-type properties "near" the change.
908 ;; First, find an appropriate boundary for this property search.
909 (let (lim
910 type type-pos
911 marked-id term-pos
912 (end1
913 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
914 (previous-single-property-change end 'face))
915 end)))
916 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
917 ;; Find a limit for the search for a `c-type' property
918 (while
919 (and (/= (skip-chars-backward "^;{}") 0)
920 (> (point) (point-min))
921 (memq (c-get-char-property (1- (point)) 'face)
922 '(font-lock-comment-face font-lock-string-face))))
923 (setq lim (max (point-min) (1- (point))))
925 ;; Look for the latest `c-type' property before end1
926 (when (and (> end1 (point-min))
927 (setq type-pos
928 (if (get-text-property (1- end1) 'c-type)
929 end1
930 (previous-single-property-change end1 'c-type nil lim))))
931 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
933 (when (memq type '(c-decl-id-start c-decl-type-start))
934 ;; Get the identifier, if any, that the property is on.
935 (goto-char (1- type-pos))
936 (setq marked-id
937 (when (looking-at "\\(\\sw\\|\\s_\\)")
938 (c-beginning-of-current-token)
939 (buffer-substring-no-properties (point) type-pos)))
941 (goto-char end1)
942 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
943 (setq lim (point))
944 (setq term-pos
945 (or (next-single-property-change end 'c-type nil lim) lim))
946 (setq c-maybe-stale-found-type
947 (list type marked-id
948 type-pos term-pos
949 (buffer-substring-no-properties type-pos term-pos)
950 (buffer-substring-no-properties beg end)))))))
952 (setq c-new-BEG beg
953 c-new-END end)
954 (if c-get-state-before-change-function
955 (funcall c-get-state-before-change-function beg end))
956 ))))
958 (defun c-after-change (beg end old-len)
959 ;; Function put on `after-change-functions' to adjust various caches
960 ;; etc. Prefer speed to finesse here, since there will be an order
961 ;; of magnitude more calls to this function than any of the
962 ;; functions that use the caches.
964 ;; Note that care must be taken so that this is called before any
965 ;; font-lock callbacks since we might get calls to functions using
966 ;; these caches from inside them, and we must thus be sure that this
967 ;; has already been executed.
969 ;; This calls the language variable c-before-font-lock-function, if non nil.
970 ;; This typically sets `syntax-table' properties.
972 (c-save-buffer-state ()
973 ;; When `combine-after-change-calls' is used we might get calls
974 ;; with regions outside the current narrowing. This has been
975 ;; observed in Emacs 20.7.
976 (save-restriction
977 (save-match-data ; c-recognize-<>-arglists changes match-data
978 (widen)
980 (when (> end (point-max))
981 ;; Some emacsen might return positions past the end. This has been
982 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
983 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
984 ;; work).
985 (setq end (point-max))
986 (when (> beg end)
987 (setq beg end)))
989 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
990 (c-invalidate-sws-region-after beg end)
991 (c-invalidate-state-cache beg)
992 (c-invalidate-find-decl-cache beg)
994 (when c-recognize-<>-arglists
995 (c-after-change-check-<>-operators beg end))
997 (if c-before-font-lock-function
998 (save-excursion
999 (funcall c-before-font-lock-function beg end old-len)))))))
1001 (defun c-after-font-lock-init ()
1002 ;; Put on `font-lock-mode-hook'.
1003 (remove-hook 'after-change-functions 'c-after-change t)
1004 (add-hook 'after-change-functions 'c-after-change nil t))
1006 (defun c-font-lock-init ()
1007 "Set up the font-lock variables for using the font-lock support in CC Mode.
1008 This does not load the font-lock package. Use after
1009 `c-basic-common-init' and after cc-fonts has been loaded."
1011 (make-local-variable 'font-lock-defaults)
1012 (setq font-lock-defaults
1013 `(,(if (c-major-mode-is 'awk-mode)
1014 ;; awk-mode currently has only one font lock level.
1015 'awk-font-lock-keywords
1016 (mapcar 'c-mode-symbol
1017 '("font-lock-keywords" "font-lock-keywords-1"
1018 "font-lock-keywords-2" "font-lock-keywords-3")))
1019 nil nil
1020 ,c-identifier-syntax-modifications
1021 c-beginning-of-syntax
1022 (font-lock-lines-before . 1)
1023 (font-lock-mark-block-function
1024 . c-mark-function)))
1026 (make-local-hook 'font-lock-mode-hook)
1027 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1029 (defun c-extend-after-change-region (beg end old-len)
1030 "Extend the region to be fontified, if necessary."
1031 ;; Note: the parameters are ignored here. This somewhat indirect
1032 ;; implementation exists because it is minimally different from the
1033 ;; stand-alone CC Mode which, lacking
1034 ;; font-lock-extend-after-change-region-function, is forced to use advice
1035 ;; instead.
1037 ;; Of the seven CC Mode languages, currently (2008-04) only AWK Mode makes
1038 ;; non-null use of this function.
1039 (cons c-new-BEG c-new-END))
1042 ;; Support for C
1044 ;;;###autoload
1045 (defvar c-mode-syntax-table nil
1046 "Syntax table used in c-mode buffers.")
1047 (or c-mode-syntax-table
1048 (setq c-mode-syntax-table
1049 (funcall (c-lang-const c-make-mode-syntax-table c))))
1051 (defvar c-mode-abbrev-table nil
1052 "Abbreviation table used in c-mode buffers.")
1053 (c-define-abbrev-table 'c-mode-abbrev-table
1054 '(("else" "else" c-electric-continued-statement 0)
1055 ("while" "while" c-electric-continued-statement 0)))
1057 (defvar c-mode-map ()
1058 "Keymap used in c-mode buffers.")
1059 (if c-mode-map
1061 (setq c-mode-map (c-make-inherited-keymap))
1062 ;; add bindings which are only useful for C
1063 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1066 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
1067 (cons "C" (c-lang-const c-mode-menu c)))
1069 ;; In XEmacs >= 21.5 modes should add their own entries to
1070 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
1071 ;; doing this on load. That since `add-to-list' prepends the value
1072 ;; which could cause it to clobber user settings. Later emacsen have
1073 ;; an append option, but it's not safe to use.
1075 ;; The the extension ".C" is associated to C++ while the lowercase
1076 ;; variant goes to C. On case insensitive file systems, this means
1077 ;; that ".c" files also might open C++ mode if the C++ entry comes
1078 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1079 ;; after ".c", and since `add-to-list' adds the entry first we have to
1080 ;; add the ".C" entry first.
1081 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1082 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1083 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1085 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1087 ;; NB: The following two associate yacc and lex files to C Mode, which
1088 ;; is not really suitable for those formats. Anyway, afaik there's
1089 ;; currently no better mode for them, and besides this is legacy.
1090 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1091 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1093 ;;;###autoload
1094 (defun c-mode ()
1095 "Major mode for editing K&R and ANSI C code.
1096 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1097 c-mode buffer. This automatically sets up a mail buffer with version
1098 information already added. You just need to add a description of the
1099 problem, including a reproducible test case, and send the message.
1101 To see what version of CC Mode you are running, enter `\\[c-version]'.
1103 The hook `c-mode-common-hook' is run with no args at mode
1104 initialization, then `c-mode-hook'.
1106 Key bindings:
1107 \\{c-mode-map}"
1108 (interactive)
1109 (kill-all-local-variables)
1110 (c-initialize-cc-mode t)
1111 (set-syntax-table c-mode-syntax-table)
1112 (setq major-mode 'c-mode
1113 mode-name "C"
1114 local-abbrev-table c-mode-abbrev-table
1115 abbrev-mode t)
1116 (use-local-map c-mode-map)
1117 (c-init-language-vars-for 'c-mode)
1118 (c-common-init 'c-mode)
1119 (easy-menu-add c-c-menu)
1120 (cc-imenu-init cc-imenu-c-generic-expression)
1121 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
1122 (c-update-modeline))
1125 ;; Support for C++
1127 ;;;###autoload
1128 (defvar c++-mode-syntax-table nil
1129 "Syntax table used in c++-mode buffers.")
1130 (or c++-mode-syntax-table
1131 (setq c++-mode-syntax-table
1132 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1134 (defvar c++-mode-abbrev-table nil
1135 "Abbreviation table used in c++-mode buffers.")
1136 (c-define-abbrev-table 'c++-mode-abbrev-table
1137 '(("else" "else" c-electric-continued-statement 0)
1138 ("while" "while" c-electric-continued-statement 0)
1139 ("catch" "catch" c-electric-continued-statement 0)))
1141 (defvar c++-mode-map ()
1142 "Keymap used in c++-mode buffers.")
1143 (if c++-mode-map
1145 (setq c++-mode-map (c-make-inherited-keymap))
1146 ;; add bindings which are only useful for C++
1147 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1148 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1149 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1150 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1152 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
1153 (cons "C++" (c-lang-const c-mode-menu c++)))
1155 ;;;###autoload
1156 (defun c++-mode ()
1157 "Major mode for editing C++ code.
1158 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1159 c++-mode buffer. This automatically sets up a mail buffer with
1160 version information already added. You just need to add a description
1161 of the problem, including a reproducible test case, and send the
1162 message.
1164 To see what version of CC Mode you are running, enter `\\[c-version]'.
1166 The hook `c-mode-common-hook' is run with no args at mode
1167 initialization, then `c++-mode-hook'.
1169 Key bindings:
1170 \\{c++-mode-map}"
1171 (interactive)
1172 (kill-all-local-variables)
1173 (c-initialize-cc-mode t)
1174 (set-syntax-table c++-mode-syntax-table)
1175 (setq major-mode 'c++-mode
1176 mode-name "C++"
1177 local-abbrev-table c++-mode-abbrev-table
1178 abbrev-mode t)
1179 (use-local-map c++-mode-map)
1180 (c-init-language-vars-for 'c++-mode)
1181 (c-common-init 'c++-mode)
1182 (easy-menu-add c-c++-menu)
1183 (cc-imenu-init cc-imenu-c++-generic-expression)
1184 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
1185 (c-update-modeline))
1188 ;; Support for Objective-C
1190 ;;;###autoload
1191 (defvar objc-mode-syntax-table nil
1192 "Syntax table used in objc-mode buffers.")
1193 (or objc-mode-syntax-table
1194 (setq objc-mode-syntax-table
1195 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1197 (defvar objc-mode-abbrev-table nil
1198 "Abbreviation table used in objc-mode buffers.")
1199 (c-define-abbrev-table 'objc-mode-abbrev-table
1200 '(("else" "else" c-electric-continued-statement 0)
1201 ("while" "while" c-electric-continued-statement 0)))
1203 (defvar objc-mode-map ()
1204 "Keymap used in objc-mode buffers.")
1205 (if objc-mode-map
1207 (setq objc-mode-map (c-make-inherited-keymap))
1208 ;; add bindings which are only useful for Objective-C
1209 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1211 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
1212 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1214 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
1216 ;;;###autoload
1217 (defun objc-mode ()
1218 "Major mode for editing Objective C code.
1219 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1220 objc-mode buffer. This automatically sets up a mail buffer with
1221 version information already added. You just need to add a description
1222 of the problem, including a reproducible test case, and send the
1223 message.
1225 To see what version of CC Mode you are running, enter `\\[c-version]'.
1227 The hook `c-mode-common-hook' is run with no args at mode
1228 initialization, then `objc-mode-hook'.
1230 Key bindings:
1231 \\{objc-mode-map}"
1232 (interactive)
1233 (kill-all-local-variables)
1234 (c-initialize-cc-mode t)
1235 (set-syntax-table objc-mode-syntax-table)
1236 (setq major-mode 'objc-mode
1237 mode-name "ObjC"
1238 local-abbrev-table objc-mode-abbrev-table
1239 abbrev-mode t)
1240 (use-local-map objc-mode-map)
1241 (c-init-language-vars-for 'objc-mode)
1242 (c-common-init 'objc-mode)
1243 (easy-menu-add c-objc-menu)
1244 (cc-imenu-init nil 'cc-imenu-objc-function)
1245 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
1246 (c-update-modeline))
1249 ;; Support for Java
1251 ;;;###autoload
1252 (defvar java-mode-syntax-table nil
1253 "Syntax table used in java-mode buffers.")
1254 (or java-mode-syntax-table
1255 (setq java-mode-syntax-table
1256 (funcall (c-lang-const c-make-mode-syntax-table java))))
1258 (defvar java-mode-abbrev-table nil
1259 "Abbreviation table used in java-mode buffers.")
1260 (c-define-abbrev-table 'java-mode-abbrev-table
1261 '(("else" "else" c-electric-continued-statement 0)
1262 ("while" "while" c-electric-continued-statement 0)
1263 ("catch" "catch" c-electric-continued-statement 0)
1264 ("finally" "finally" c-electric-continued-statement 0)))
1266 (defvar java-mode-map ()
1267 "Keymap used in java-mode buffers.")
1268 (if java-mode-map
1270 (setq java-mode-map (c-make-inherited-keymap))
1271 ;; add bindings which are only useful for Java
1274 ;; Regexp trying to describe the beginning of a Java top-level
1275 ;; definition. This is not used by CC Mode, nor is it maintained
1276 ;; since it's practically impossible to write a regexp that reliably
1277 ;; matches such a construct. Other tools are necessary.
1278 (defconst c-Java-defun-prompt-regexp
1279 "^[ \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-*")
1281 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
1282 (cons "Java" (c-lang-const c-mode-menu java)))
1284 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
1286 ;;;###autoload
1287 (defun java-mode ()
1288 "Major mode for editing Java code.
1289 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1290 java-mode buffer. This automatically sets up a mail buffer with
1291 version information already added. You just need to add a description
1292 of the problem, including a reproducible test case, and send the
1293 message.
1295 To see what version of CC Mode you are running, enter `\\[c-version]'.
1297 The hook `c-mode-common-hook' is run with no args at mode
1298 initialization, then `java-mode-hook'.
1300 Key bindings:
1301 \\{java-mode-map}"
1302 (interactive)
1303 (kill-all-local-variables)
1304 (c-initialize-cc-mode t)
1305 (set-syntax-table java-mode-syntax-table)
1306 (setq major-mode 'java-mode
1307 mode-name "Java"
1308 local-abbrev-table java-mode-abbrev-table
1309 abbrev-mode t)
1310 (use-local-map java-mode-map)
1311 (c-init-language-vars-for 'java-mode)
1312 (c-common-init 'java-mode)
1313 (easy-menu-add c-java-menu)
1314 (cc-imenu-init cc-imenu-java-generic-expression)
1315 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
1316 (c-update-modeline))
1319 ;; Support for CORBA's IDL language
1321 ;;;###autoload
1322 (defvar idl-mode-syntax-table nil
1323 "Syntax table used in idl-mode buffers.")
1324 (or idl-mode-syntax-table
1325 (setq idl-mode-syntax-table
1326 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1328 (defvar idl-mode-abbrev-table nil
1329 "Abbreviation table used in idl-mode buffers.")
1330 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
1332 (defvar idl-mode-map ()
1333 "Keymap used in idl-mode buffers.")
1334 (if idl-mode-map
1336 (setq idl-mode-map (c-make-inherited-keymap))
1337 ;; add bindings which are only useful for IDL
1340 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
1341 (cons "IDL" (c-lang-const c-mode-menu idl)))
1343 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
1345 ;;;###autoload
1346 (defun idl-mode ()
1347 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
1348 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1349 idl-mode buffer. This automatically sets up a mail buffer with
1350 version information already added. You just need to add a description
1351 of the problem, including a reproducible test case, and send the
1352 message.
1354 To see what version of CC Mode you are running, enter `\\[c-version]'.
1356 The hook `c-mode-common-hook' is run with no args at mode
1357 initialization, then `idl-mode-hook'.
1359 Key bindings:
1360 \\{idl-mode-map}"
1361 (interactive)
1362 (kill-all-local-variables)
1363 (c-initialize-cc-mode t)
1364 (set-syntax-table idl-mode-syntax-table)
1365 (setq major-mode 'idl-mode
1366 mode-name "IDL"
1367 local-abbrev-table idl-mode-abbrev-table)
1368 (use-local-map idl-mode-map)
1369 (c-init-language-vars-for 'idl-mode)
1370 (c-common-init 'idl-mode)
1371 (easy-menu-add c-idl-menu)
1372 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
1373 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
1374 (c-update-modeline))
1377 ;; Support for Pike
1379 ;;;###autoload
1380 (defvar pike-mode-syntax-table nil
1381 "Syntax table used in pike-mode buffers.")
1382 (or pike-mode-syntax-table
1383 (setq pike-mode-syntax-table
1384 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1386 (defvar pike-mode-abbrev-table nil
1387 "Abbreviation table used in pike-mode buffers.")
1388 (c-define-abbrev-table 'pike-mode-abbrev-table
1389 '(("else" "else" c-electric-continued-statement 0)
1390 ("while" "while" c-electric-continued-statement 0)))
1392 (defvar pike-mode-map ()
1393 "Keymap used in pike-mode buffers.")
1394 (if pike-mode-map
1396 (setq pike-mode-map (c-make-inherited-keymap))
1397 ;; additional bindings
1398 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1400 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
1401 (cons "Pike" (c-lang-const c-mode-menu pike)))
1403 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1404 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
1406 ;;;###autoload
1407 (defun pike-mode ()
1408 "Major mode for editing Pike code.
1409 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1410 pike-mode buffer. This automatically sets up a mail buffer with
1411 version information already added. You just need to add a description
1412 of the problem, including a reproducible test case, and send the
1413 message.
1415 To see what version of CC Mode you are running, enter `\\[c-version]'.
1417 The hook `c-mode-common-hook' is run with no args at mode
1418 initialization, then `pike-mode-hook'.
1420 Key bindings:
1421 \\{pike-mode-map}"
1422 (interactive)
1423 (kill-all-local-variables)
1424 (c-initialize-cc-mode t)
1425 (set-syntax-table pike-mode-syntax-table)
1426 (setq major-mode 'pike-mode
1427 mode-name "Pike"
1428 local-abbrev-table pike-mode-abbrev-table
1429 abbrev-mode t)
1430 (use-local-map pike-mode-map)
1431 (c-init-language-vars-for 'pike-mode)
1432 (c-common-init 'pike-mode)
1433 (easy-menu-add c-pike-menu)
1434 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
1435 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
1436 (c-update-modeline))
1439 ;; Support for AWK
1441 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1442 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1443 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1444 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1445 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
1447 ;;; Autoload directives must be on the top level, so we construct an
1448 ;;; autoload form instead.
1449 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1451 (defvar awk-mode-abbrev-table nil
1452 "Abbreviation table used in awk-mode buffers.")
1453 (c-define-abbrev-table 'awk-mode-abbrev-table
1454 '(("else" "else" c-electric-continued-statement 0)
1455 ("while" "while" c-electric-continued-statement 0)))
1457 (defvar awk-mode-map ()
1458 "Keymap used in awk-mode buffers.")
1459 (if awk-mode-map
1461 (setq awk-mode-map (c-make-inherited-keymap))
1462 ;; add bindings which are only useful for awk.
1463 (define-key awk-mode-map "#" 'self-insert-command)
1464 (define-key awk-mode-map "/" 'self-insert-command)
1465 (define-key awk-mode-map "*" 'self-insert-command)
1466 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1467 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1468 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1469 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1470 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1471 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1472 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1474 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1475 (cons "AWK" (c-lang-const c-mode-menu awk)))
1477 (defun awk-mode ()
1478 "Major mode for editing AWK code.
1479 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1480 awk-mode buffer. This automatically sets up a mail buffer with version
1481 information already added. You just need to add a description of the
1482 problem, including a reproducible test case, and send the message.
1484 To see what version of CC Mode you are running, enter `\\[c-version]'.
1486 The hook `c-mode-common-hook' is run with no args at mode
1487 initialization, then `awk-mode-hook'.
1489 Key bindings:
1490 \\{awk-mode-map}"
1491 (interactive)
1492 (require 'cc-awk) ; Added 2003/6/10.
1493 (kill-all-local-variables)
1494 (c-initialize-cc-mode t)
1495 (set-syntax-table awk-mode-syntax-table)
1496 (setq major-mode 'awk-mode
1497 mode-name "AWK"
1498 local-abbrev-table awk-mode-abbrev-table
1499 abbrev-mode t)
1500 (use-local-map awk-mode-map)
1501 (c-init-language-vars-for 'awk-mode)
1502 (c-common-init 'awk-mode)
1503 (c-awk-unstick-NL-prop)
1505 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1506 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1507 (defalias 'c-in-literal 'c-slow-in-literal)
1509 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1510 (c-update-modeline))
1513 ;; bug reporting
1515 (defconst c-mode-help-address
1516 "bug-cc-mode@gnu.org"
1517 "Address(es) for CC Mode bug reports.")
1519 (defun c-version ()
1520 "Echo the current version of CC Mode in the minibuffer."
1521 (interactive)
1522 (message "Using CC Mode version %s" c-version)
1523 (c-keep-region-active))
1525 (defvar c-prepare-bug-report-hooks nil)
1527 ;; Dynamic variables used by reporter.
1528 (defvar reporter-prompt-for-summary-p)
1529 (defvar reporter-dont-compact-list)
1531 (defun c-submit-bug-report ()
1532 "Submit via mail a bug report on CC Mode."
1533 (interactive)
1534 (require 'reporter)
1535 ;; load in reporter
1536 (let ((reporter-prompt-for-summary-p t)
1537 (reporter-dont-compact-list '(c-offsets-alist))
1538 (style c-indentation-style)
1539 (c-features c-emacs-features))
1540 (and
1541 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1542 t (message "") nil)
1543 (reporter-submit-bug-report
1544 c-mode-help-address
1545 (concat "CC Mode " c-version " (" mode-name ")")
1546 (let ((vars (append
1547 c-style-variables
1548 '(c-buffer-is-cc-mode
1549 c-tab-always-indent
1550 c-syntactic-indentation
1551 c-syntactic-indentation-in-macros
1552 c-ignore-auto-fill
1553 c-auto-align-backslashes
1554 c-backspace-function
1555 c-delete-function
1556 c-electric-pound-behavior
1557 c-default-style
1558 c-enable-xemacs-performance-kludge-p
1559 c-old-style-variable-behavior
1560 defun-prompt-regexp
1561 tab-width
1562 comment-column
1563 parse-sexp-ignore-comments
1564 parse-sexp-lookup-properties
1565 lookup-syntax-properties
1566 ;; A brain-damaged XEmacs only variable that, if
1567 ;; set to nil can cause all kinds of chaos.
1568 signal-error-on-buffer-boundary
1569 ;; Variables that affect line breaking and comments.
1570 auto-fill-mode
1571 auto-fill-function
1572 filladapt-mode
1573 comment-multi-line
1574 comment-start-skip
1575 fill-prefix
1576 fill-column
1577 paragraph-start
1578 adaptive-fill-mode
1579 adaptive-fill-regexp)
1580 nil)))
1581 (mapcar (lambda (var) (unless (boundp var)
1582 (setq vars (delq var vars))))
1583 '(signal-error-on-buffer-boundary
1584 filladapt-mode
1585 defun-prompt-regexp
1586 font-lock-mode
1587 font-lock-maximum-decoration
1588 parse-sexp-lookup-properties
1589 lookup-syntax-properties))
1590 vars)
1591 (lambda ()
1592 (run-hooks 'c-prepare-bug-report-hooks)
1593 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1594 style c-features)))))))
1597 (cc-provide 'cc-mode)
1599 ;;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
1600 ;;; cc-mode.el ends here