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