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