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