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