Make vc-toggle-read-only an alias for toggle-read-only.
[bpt/emacs.git] / lisp / progmodes / cc-mode.el
CommitLineData
d9e94c22 1;;; cc-mode.el --- major mode for editing C and similar languages
785eecbb 2
73b0cd50 3;; Copyright (C) 1985, 1987, 1992-2011 Free Software Foundation, Inc.
785eecbb 4
d9e94c22
MS
5;; Authors: 2003- Alan Mackenzie
6;; 1998- Martin Stjernholm
7;; 1992-1999 Barry A. Warsaw
5858f68c
GM
8;; 1987 Dave Detlefs
9;; 1987 Stewart Clamen
785eecbb 10;; 1985 Richard M. Stallman
0ec8351b 11;; Maintainer: bug-cc-mode@gnu.org
785eecbb 12;; Created: a long, long, time ago. adapted from the original c-mode.el
bd78fa1d 13;; Keywords: c languages
785eecbb 14
785eecbb
RS
15;; This file is part of GNU Emacs.
16
b1fc2b50 17;; GNU Emacs is free software: you can redistribute it and/or modify
785eecbb 18;; it under the terms of the GNU General Public License as published by
b1fc2b50
GM
19;; the Free Software Foundation, either version 3 of the License, or
20;; (at your option) any later version.
785eecbb
RS
21
22;; GNU Emacs is distributed in the hope that it will be useful,
23;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25;; GNU General Public License for more details.
26
27;; You should have received a copy of the GNU General Public License
b1fc2b50 28;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
785eecbb 29
d9e94c22 30;;; Commentary:
130c507e
GM
31
32;; NOTE: Read the commentary below for the right way to submit bug reports!
33;; NOTE: See the accompanying texinfo manual for details on using this mode!
d9e94c22 34;; Note: The version string is in cc-defs.
785eecbb
RS
35
36;; This package provides GNU Emacs major modes for editing C, C++,
d9e94c22
MS
37;; Objective-C, Java, CORBA's IDL, Pike and AWK code. As of the
38;; latest Emacs and XEmacs releases, it is the default package for
39;; editing these languages. This package is called "CC Mode", and
40;; should be spelled exactly this way.
0ec8351b
BW
41
42;; CC Mode supports K&R and ANSI C, ANSI C++, Objective-C, Java,
d9e94c22
MS
43;; CORBA's IDL, Pike and AWK with a consistent indentation model
44;; across all modes. This indentation model is intuitive and very
45;; flexible, so that almost any desired style of indentation can be
46;; supported. Installation, usage, and programming details are
47;; contained in an accompanying texinfo manual.
785eecbb
RS
48
49;; CC Mode's immediate ancestors were, c++-mode.el, cplus-md.el, and
50;; cplus-md1.el..
51
785eecbb 52;; To submit bug reports, type "C-c C-b". These will be sent to
0ec8351b
BW
53;; bug-gnu-emacs@gnu.org (mirrored as the Usenet newsgroup
54;; gnu.emacs.bug) as well as bug-cc-mode@gnu.org, which directly
55;; contacts the CC Mode maintainers. Questions can sent to
56;; help-gnu-emacs@gnu.org (mirrored as gnu.emacs.help) and/or
130c507e
GM
57;; bug-cc-mode@gnu.org. Please do not send bugs or questions to our
58;; personal accounts; we reserve the right to ignore such email!
785eecbb 59
785eecbb
RS
60;; Many, many thanks go out to all the folks on the beta test list.
61;; Without their patience, testing, insight, code contributions, and
62;; encouragement CC Mode would be a far inferior package.
63
64;; You can get the latest version of CC Mode, including PostScript
65;; documentation and separate individual files from:
66;;
91b807c9 67;; http://cc-mode.sourceforge.net/
0ec8351b
BW
68;;
69;; You can join a moderated CC Mode announcement-only mailing list by
70;; visiting
785eecbb 71;;
91b807c9 72;; http://lists.sourceforge.net/mailman/listinfo/cc-mode-announce
785eecbb
RS
73
74;;; Code:
75
ae500c1a
GM
76;; For Emacs < 22.2.
77(eval-and-compile
78 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
79
51f606de
GM
80(eval-when-compile
81 (let ((load-path
130c507e
GM
82 (if (and (boundp 'byte-compile-dest-file)
83 (stringp byte-compile-dest-file))
84 (cons (file-name-directory byte-compile-dest-file) load-path)
51f606de 85 load-path)))
d9e94c22 86 (load "cc-bytecomp" nil t)))
130c507e
GM
87
88(cc-require 'cc-defs)
d9e94c22 89(cc-require-when-compile 'cc-langs)
130c507e 90(cc-require 'cc-vars)
130c507e 91(cc-require 'cc-engine)
d9e94c22 92(cc-require 'cc-styles)
130c507e
GM
93(cc-require 'cc-cmds)
94(cc-require 'cc-align)
d9e94c22 95(cc-require 'cc-menus)
b14c0c55 96(cc-require 'cc-guess)
130c507e 97
3efc2cd7 98;; Silence the compiler.
0386b551 99(cc-bytecomp-defvar adaptive-fill-first-line-regexp) ; Emacs
130c507e 100(cc-bytecomp-defun set-keymap-parents) ; XEmacs
0386b551 101(cc-bytecomp-defun run-mode-hooks) ; Emacs 21.1
130c507e 102
d9e94c22
MS
103;; We set these variables during mode init, yet we don't require
104;; font-lock.
105(cc-bytecomp-defvar font-lock-defaults)
106(cc-bytecomp-defvar font-lock-syntactic-keywords)
107
130c507e
GM
108;; Menu support for both XEmacs and Emacs. If you don't have easymenu
109;; with your version of Emacs, you are incompatible!
d9e94c22
MS
110(cc-external-require 'easymenu)
111
0386b551
AM
112;; Autoload directive for emacsen that doesn't have an older CC Mode
113;; version in the dist.
653d1554 114(autoload 'subword-mode "subword"
0386b551
AM
115 "Mode enabling subword movement and editing keys." t)
116
d9e94c22
MS
117;; Load cc-fonts first after font-lock is loaded, since it isn't
118;; necessary until font locking is requested.
3c0ab532
AM
119; (eval-after-load "font-lock" ; 2006-07-09: font-lock is now preloaded.
120; '
121(require 'cc-fonts) ;)
d9e94c22 122
785eecbb 123\f
1dad6919
RS
124;; Other modes and packages which depend on CC Mode should do the
125;; following to make sure everything is loaded and available for their
126;; use:
127;;
128;; (require 'cc-mode)
a66cd3ee
MS
129;;
130;; And in the major mode function:
131;;
d9e94c22
MS
132;; (c-initialize-cc-mode t)
133;; (c-init-language-vars some-mode)
134;; (c-common-init 'some-mode) ; Or perhaps (c-basic-common-init 'some-mode)
135;;
28d88c16
MS
136;; If you're not writing a derived mode using the language variable
137;; system, then some-mode is one of the language modes directly
138;; supported by CC Mode. You can then use (c-init-language-vars-for
139;; 'some-mode) instead of `c-init-language-vars'.
140;; `c-init-language-vars-for' is a function that avoids the rather
141;; large expansion of `c-init-language-vars'.
142;;
143;; If you use `c-basic-common-init' then you might want to call
144;; `c-font-lock-init' too to set up CC Mode's font lock support.
145;;
d9e94c22
MS
146;; See cc-langs.el for further info. A small example of a derived mode
147;; is also available at <http://cc-mode.sourceforge.net/
148;; derived-mode-ex.el>.
1dad6919 149
a66cd3ee
MS
150(defun c-leave-cc-mode-mode ()
151 (setq c-buffer-is-cc-mode nil))
152
28d88c16
MS
153(defun c-init-language-vars-for (mode)
154 "Initialize the language variables for one of the language modes
155directly supported by CC Mode. This can be used instead of the
156`c-init-language-vars' macro if the language you want to use is one of
157those, rather than a derived language defined through the language
158variable system (see \"cc-langs.el\")."
28d88c16
MS
159 (cond ((eq mode 'c-mode) (c-init-language-vars c-mode))
160 ((eq mode 'c++-mode) (c-init-language-vars c++-mode))
161 ((eq mode 'objc-mode) (c-init-language-vars objc-mode))
162 ((eq mode 'java-mode) (c-init-language-vars java-mode))
163 ((eq mode 'idl-mode) (c-init-language-vars idl-mode))
164 ((eq mode 'pike-mode) (c-init-language-vars pike-mode))
165 ((eq mode 'awk-mode) (c-init-language-vars awk-mode))
166 (t (error "Unsupported mode %s" mode))))
167
aac90c52 168;;;###autoload
d9e94c22
MS
169(defun c-initialize-cc-mode (&optional new-style-init)
170 "Initialize CC Mode for use in the current buffer.
171If the optional NEW-STYLE-INIT is nil or left out then all necessary
172initialization to run CC Mode for the C language is done. Otherwise
28d88c16
MS
173only some basic setup is done, and a call to `c-init-language-vars' or
174`c-init-language-vars-for' is necessary too (which gives more
175control). See \"cc-mode.el\" for more info."
d9e94c22 176
611c76a7 177 (setq c-buffer-is-cc-mode t)
d9e94c22 178
0ec8351b
BW
179 (let ((initprop 'cc-mode-is-initialized)
180 c-initialization-ok)
181 (unless (get 'c-initialize-cc-mode initprop)
0ec8351b
BW
182 (unwind-protect
183 (progn
51f606de
GM
184 (put 'c-initialize-cc-mode initprop t)
185 (c-initialize-builtin-style)
0ec8351b 186 (run-hooks 'c-initialization-hook)
51f606de
GM
187 ;; Fix obsolete variables.
188 (if (boundp 'c-comment-continuation-stars)
d2f79585
TTN
189 (setq c-block-comment-prefix
190 (symbol-value 'c-comment-continuation-stars)))
a66cd3ee 191 (add-hook 'change-major-mode-hook 'c-leave-cc-mode-mode)
0ec8351b
BW
192 (setq c-initialization-ok t))
193 ;; Will try initialization hooks again if they failed.
d9e94c22
MS
194 (put 'c-initialize-cc-mode initprop c-initialization-ok))))
195
196 (unless new-style-init
28d88c16 197 (c-init-language-vars-for 'c-mode)))
1dad6919
RS
198
199\f
d9e94c22
MS
200;;; Common routines.
201
130c507e
GM
202(defvar c-mode-base-map ()
203 "Keymap shared by all CC Mode related modes.")
204
205(defun c-make-inherited-keymap ()
206 (let ((map (make-sparse-keymap)))
3efc2cd7
MS
207 ;; Necessary to use `cc-bytecomp-fboundp' below since this
208 ;; function is called from top-level forms that are evaluated
209 ;; while cc-bytecomp is active when one does M-x eval-buffer.
130c507e 210 (cond
d9e94c22 211 ;; Emacs
3efc2cd7 212 ((cc-bytecomp-fboundp 'set-keymap-parent)
130c507e 213 (set-keymap-parent map c-mode-base-map))
b705155a
SM
214 ;; XEmacs
215 ((cc-bytecomp-fboundp 'set-keymap-parents)
216 (set-keymap-parents map c-mode-base-map))
130c507e
GM
217 ;; incompatible
218 (t (error "CC Mode is incompatible with this version of Emacs")))
219 map))
220
a66cd3ee
MS
221(defun c-define-abbrev-table (name defs)
222 ;; Compatibility wrapper for `define-abbrev' which passes a non-nil
223 ;; sixth argument for SYSTEM-FLAG in emacsen that support it
0386b551 224 ;; (currently only Emacs >= 21.2).
d9e94c22
MS
225 (let ((table (or (symbol-value name)
226 (progn (define-abbrev-table name nil)
227 (symbol-value name)))))
a66cd3ee
MS
228 (while defs
229 (condition-case nil
230 (apply 'define-abbrev table (append (car defs) '(t)))
231 (wrong-number-of-arguments
232 (apply 'define-abbrev table (car defs))))
233 (setq defs (cdr defs)))))
d9e94c22 234(put 'c-define-abbrev-table 'lisp-indent-function 1)
a66cd3ee 235
0386b551
AM
236(defun c-bind-special-erase-keys ()
237 ;; Only used in Emacs to bind C-c C-<delete> and C-c C-<backspace>
238 ;; to the proper keys depending on `normal-erase-is-backspace'.
239 (if normal-erase-is-backspace
240 (progn
241 (define-key c-mode-base-map (kbd "C-c C-<delete>")
242 'c-hungry-delete-forward)
243 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
cb694ab7 244 'c-hungry-delete-backwards))
0386b551 245 (define-key c-mode-base-map (kbd "C-c C-<delete>")
cb694ab7 246 'c-hungry-delete-backwards)
0386b551
AM
247 (define-key c-mode-base-map (kbd "C-c C-<backspace>")
248 'c-hungry-delete-forward)))
249
130c507e
GM
250(if c-mode-base-map
251 nil
0386b551 252
130c507e 253 (setq c-mode-base-map (make-sparse-keymap))
0386b551 254
130c507e
GM
255 ;; Separate M-BS from C-M-h. The former should remain
256 ;; backward-kill-word.
257 (define-key c-mode-base-map [(control meta h)] 'c-mark-function)
258 (define-key c-mode-base-map "\e\C-q" 'c-indent-exp)
259 (substitute-key-definition 'backward-sentence
260 'c-beginning-of-statement
261 c-mode-base-map global-map)
262 (substitute-key-definition 'forward-sentence
263 'c-end-of-statement
264 c-mode-base-map global-map)
265 (substitute-key-definition 'indent-new-comment-line
266 'c-indent-new-comment-line
267 c-mode-base-map global-map)
0386b551 268 (substitute-key-definition 'indent-for-tab-command
17ee4625
DN
269 ;; XXX Is this the right thing to do
270 ;; here?
271 'c-indent-line-or-region
0386b551 272 c-mode-base-map global-map)
a66cd3ee
MS
273 (when (fboundp 'comment-indent-new-line)
274 ;; indent-new-comment-line has changed name to
275 ;; comment-indent-new-line in Emacs 21.
276 (substitute-key-definition 'comment-indent-new-line
277 'c-indent-new-comment-line
278 c-mode-base-map global-map))
0386b551 279
130c507e 280 ;; RMS says don't make these the default.
51c9af45 281 ;; (April 2006): RMS has now approved these commands as defaults.
13ac2398
AM
282 (unless (memq 'argumentative-bod-function c-emacs-features)
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))
0386b551 285
130c507e
GM
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)
d9e94c22
MS
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.
130c507e
GM
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)
d9e94c22 304
0386b551
AM
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
cb694ab7
AM
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.
0386b551 315
6d28be1d
EZ
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)
0386b551 322 (define-key c-mode-base-map "\C-c\C-d" 'c-hungry-delete-forward)
cb694ab7
AM
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)
0386b551
AM
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.
6d28be1d 342 (define-key c-mode-base-map [delete] 'c-electric-delete)
0386b551
AM
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)
cb694ab7
AM
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))
0386b551
AM
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)
130c507e 354 (define-key c-mode-base-map "/" 'c-electric-slash)
0386b551
AM
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
130c507e 362 (define-key c-mode-base-map "\C-c\C-\\" 'c-backslash-region)
0386b551 363 (define-key c-mode-base-map "\C-c\C-a" 'c-toggle-auto-newline)
130c507e
GM
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)
0386b551 366 (define-key c-mode-base-map "\C-c\C-l" 'c-toggle-electric-state)
130c507e 367 (define-key c-mode-base-map "\C-c\C-o" 'c-set-offset)
0386b551 368 (define-key c-mode-base-map "\C-c\C-q" 'c-indent-defun)
130c507e 369 (define-key c-mode-base-map "\C-c\C-s" 'c-show-syntactic-information)
0386b551 370 ;; (define-key c-mode-base-map "\C-c\C-t" 'c-toggle-auto-hungry-state) Commented out by ACM, 2005-03-05.
130c507e
GM
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)
0386b551 374 ;; (define-key c-mode-base-map "\C-c\C-y" 'c-toggle-hungry-state) Commented out by ACM, 2005-11-22.
653d1554 375 (define-key c-mode-base-map "\C-c\C-w" 'subword-mode)
130c507e
GM
376 )
377
130c507e
GM
378;; We don't require the outline package, but we configure it a bit anyway.
379(cc-bytecomp-defvar outline-level)
380
d9e94c22
MS
381(defun c-mode-menu (modestr)
382 "Return a menu spec suitable for `easy-menu-define' that is exactly
383like the C mode menu except that the menu bar item name is MODESTR
384instead of \"C\".
385
386This function is provided for compatibility only; derived modes should
387preferably 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
0386b551
AM
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.
0ec1d2c5 406;;
9c184ed2
AM
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
0ec1d2c5 447;; changed where an element of `found-types' might become stale. It
9c184ed2
AM
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
0ec1d2c5 451;;
9c184ed2
AM
452;; o - `c-decl-id-start' is the c-type text property value at buffer
453;; pos 96.
0ec1d2c5 454;;
9c184ed2
AM
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.
0ec1d2c5 458;;
9c184ed2
AM
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
d9e94c22
MS
467(defun c-basic-common-init (mode default-style)
468 "Do the necessary initialization for the syntax handling routines
469and the line breaking/filling code. Intended to be used by other
470packages that embed CC Mode.
471
472MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode.
473DEFAULT-STYLE tells which indentation style to install. It has the
474same format as `c-default-style'.
475
476Note that `c-init-language-vars' must be called before this function.
477This function cannot do that since `c-init-language-vars' is a macro
478that requires a literal mode spec at compile time."
d9e94c22 479
a66cd3ee
MS
480 (setq c-buffer-is-cc-mode mode)
481
130c507e
GM
482 ;; these variables should always be buffer local; they do not affect
483 ;; indentation style.
130c507e
GM
484 (make-local-variable 'comment-start)
485 (make-local-variable 'comment-end)
130c507e 486 (make-local-variable 'comment-start-skip)
175069ef 487
0386b551
AM
488 (make-local-variable 'paragraph-start)
489 (make-local-variable 'paragraph-separate)
490 (make-local-variable 'paragraph-ignore-fill-prefix)
491 (make-local-variable 'adaptive-fill-mode)
492 (make-local-variable 'adaptive-fill-regexp)
a66cd3ee 493
130c507e 494 ;; now set their values
175069ef
SM
495 (set (make-local-variable 'parse-sexp-ignore-comments) t)
496 (set (make-local-variable 'indent-line-function) 'c-indent-line)
497 (set (make-local-variable 'indent-region-function) 'c-indent-region)
498 (set (make-local-variable 'normal-auto-fill-function) 'c-do-auto-fill)
499 (set (make-local-variable 'comment-multi-line) t)
500 (set (make-local-variable 'comment-line-break-function)
501 'c-indent-new-comment-line)
a66cd3ee 502
fd8771f5
MS
503 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
504 ;; direct call to `fill-paragraph' behaves better. This still
505 ;; doesn't work with filladapt but it's better than nothing.
175069ef 506 (set (make-local-variable 'fill-paragraph-function) 'c-fill-paragraph)
fd8771f5 507
0ec1d2c5
AM
508 ;; Initialise the cache of brace pairs, and opening braces/brackets/parens.
509 (c-state-cache-init)
510
0386b551 511 (when (or c-recognize-<>-arglists
1d1e4868 512 (c-major-mode-is 'awk-mode)
452ea855 513 (c-major-mode-is '(java-mode c-mode c++-mode objc-mode)))
0386b551
AM
514 ;; We'll use the syntax-table text property to change the syntax
515 ;; of some chars for this language, so do the necessary setup for
516 ;; that.
517 ;;
518 ;; Note to other package developers: It's ok to turn this on in CC
519 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
520 ;; off if CC Mode has turned it on.
521
522 ;; Emacs.
523 (when (boundp 'parse-sexp-lookup-properties)
175069ef 524 (set (make-local-variable 'parse-sexp-lookup-properties) t))
0386b551
AM
525
526 ;; Same as above for XEmacs.
527 (when (boundp 'lookup-syntax-properties)
175069ef 528 (set (make-local-variable 'lookup-syntax-properties) t)))
d9e94c22 529
d0fcee66 530 ;; Use this in Emacs 21+ to avoid meddling with the rear-nonsticky
d9e94c22
MS
531 ;; property on each character.
532 (when (boundp 'text-property-default-nonsticky)
d0fcee66
AM
533 (mapc (lambda (tprop)
534 (unless (assq tprop text-property-default-nonsticky)
175069ef
SM
535 (set (make-local-variable 'text-property-default-nonsticky)
536 (cons `(,tprop . t) text-property-default-nonsticky))))
d0fcee66 537 '(syntax-table category c-type)))
d9e94c22
MS
538
539 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
540 ;; heuristic that open parens in column 0 are defun starters. Since
0386b551
AM
541 ;; we have c-state-cache, that heuristic isn't useful and only causes
542 ;; trouble, so turn it off.
99c8496e
AM
543;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
544;; helpful. Comment it out for now.
545;; (when (memq 'col-0-paren c-emacs-features)
546;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
547;; (setq open-paren-in-column-0-is-defun-start nil))
d9e94c22 548
d9e94c22
MS
549 (c-clear-found-types)
550
551 ;; now set the mode style based on default-style
b14c0c55 552 (let ((style (cc-choose-style-for-mode mode default-style)))
130c507e
GM
553 ;; Override style variables if `c-old-style-variable-behavior' is
554 ;; set. Also override if we are using global style variables,
555 ;; have already initialized a style once, and are switching to a
556 ;; different style. (It's doubtful whether this is desirable, but
557 ;; the whole situation with nonlocal style variables is a bit
558 ;; awkward. It's at least the most compatible way with the old
559 ;; style init procedure.)
560 (c-set-style style (not (or c-old-style-variable-behavior
561 (and (not c-style-variables-are-local-p)
562 c-indentation-style
563 (not (string-equal c-indentation-style
564 style)))))))
a66cd3ee
MS
565 (c-setup-paragraph-variables)
566
130c507e
GM
567 ;; we have to do something special for c-offsets-alist so that the
568 ;; buffer local value has its own alist structure.
569 (setq c-offsets-alist (copy-alist c-offsets-alist))
a66cd3ee 570
130c507e 571 ;; setup the comment indent variable in a Emacs version portable way
175069ef 572 (set (make-local-variable 'comment-indent-function) 'c-comment-indent)
a66cd3ee 573
cb694ab7
AM
574;; ;; Put submode indicators onto minor-mode-alist, but only once.
575;; (or (assq 'c-submode-indicators minor-mode-alist)
576;; (setq minor-mode-alist
577;; (cons '(c-submode-indicators c-submode-indicators)
578;; minor-mode-alist)))
579 (c-update-modeline)
a66cd3ee 580
d9e94c22
MS
581 ;; Install the functions that ensure that various internal caches
582 ;; don't become invalid due to buffer changes.
922ad43e
GM
583 (when (featurep 'xemacs)
584 (make-local-hook 'before-change-functions)
585 (make-local-hook 'after-change-functions))
9c184ed2 586 (add-hook 'before-change-functions 'c-before-change nil t)
8714fc18 587 (add-hook 'after-change-functions 'c-after-change nil t)
7d562742 588 (set (make-local-variable 'font-lock-extend-after-change-region-function)
a0526d5e
AM
589 'c-extend-after-change-region)) ; Currently (2009-05) used by all
590 ; lanaguages with #define (C, C++,; ObjC), and by AWK.
d9e94c22 591
d9e94c22
MS
592(defun c-setup-doc-comment-style ()
593 "Initialize the variables that depend on the value of `c-doc-comment-style'."
594 (when (and (featurep 'font-lock)
595 (symbol-value 'font-lock-mode))
596 ;; Force font lock mode to reinitialize itself.
597 (font-lock-mode 0)
598 (font-lock-mode 1)))
599
f3b554af
GM
600;; Buffer local variables defining the region to be fontified by a font lock
601;; after-change function. They are set in c-after-change to
602;; after-change-function's BEG and END, and may be modified by a
603;; `c-before-font-lock-function'.
604(defvar c-new-BEG 0)
605(make-variable-buffer-local 'c-new-BEG)
606(defvar c-new-END 0)
607(make-variable-buffer-local 'c-new-END)
608
d9e94c22
MS
609(defun c-common-init (&optional mode)
610 "Common initialization for all CC Mode modes.
611In addition to the work done by `c-basic-common-init' and
612`c-font-lock-init', this function sets up various other things as
613customary in CC Mode modes but which aren't strictly necessary for CC
614Mode to operate correctly.
615
616MODE is the symbol for the mode to initialize, like 'c-mode. See
617`c-basic-common-init' for details. It's only optional to be
0386b551 618compatible with old code; callers should always specify it."
d9e94c22
MS
619
620 (unless mode
621 ;; Called from an old third party package. The fallback is to
622 ;; initialize for C.
28d88c16 623 (c-init-language-vars-for 'c-mode))
d9e94c22
MS
624
625 (c-basic-common-init mode c-default-style)
626 (when mode
627 ;; Only initialize font locking if we aren't called from an old package.
628 (c-font-lock-init))
629
1d1e4868
AM
630 ;; Starting a mode is a sort of "change". So call the change functions...
631 (save-restriction
632 (widen)
43a91810
AM
633 (setq c-new-BEG (point-min))
634 (setq c-new-END (point-max))
1d1e4868 635 (save-excursion
dd969a56 636 (if c-get-state-before-change-functions
8a249abc
AM
637 (mapc (lambda (fn)
638 (funcall fn (point-min) (point-max)))
639 c-get-state-before-change-functions))
1d1e4868
AM
640 (if c-before-font-lock-function
641 (funcall c-before-font-lock-function (point-min) (point-max)
642 (- (point-max) (point-min))))))
643
175069ef
SM
644 (set (make-local-variable 'outline-regexp) "[^#\n\^M]")
645 (set (make-local-variable 'outline-level) 'c-outline-level)
d9e94c22
MS
646
647 (let ((rfn (assq mode c-require-final-newline)))
648 (when rfn
1750e02f 649 (and (cdr rfn)
175069ef
SM
650 (set (make-local-variable 'require-final-newline)
651 mode-require-final-newline)))))
130c507e 652
00af0b67
AM
653(defun c-count-cfss (lv-alist)
654 ;; LV-ALIST is an alist like `file-local-variables-alist'. Count how many
655 ;; elements with the key `c-file-style' there are in it.
656 (let ((elt-ptr lv-alist) elt (cownt 0))
657 (while elt-ptr
658 (setq elt (car elt-ptr)
659 elt-ptr (cdr elt-ptr))
660 (when (eq (car elt) 'c-file-style)
661 (setq cownt (1+ cownt))))
662 cownt))
663
a36abf0e
CY
664(defun c-before-hack-hook ()
665 "Set the CC Mode style and \"offsets\" when in the buffer's local variables.
666They are set only when, respectively, the pseudo variables
667`c-file-style' and `c-file-offsets' are present in the list.
668
669This function is called from the hook `before-hack-local-variables-hook'."
670 (when c-buffer-is-cc-mode
05c123e6
AM
671 (let ((mode-cons (assq 'mode file-local-variables-alist))
672 (stile (cdr (assq 'c-file-style file-local-variables-alist)))
a36abf0e 673 (offsets (cdr (assq 'c-file-offsets file-local-variables-alist))))
05c123e6
AM
674 (when mode-cons
675 (hack-one-local-variable (car mode-cons) (cdr mode-cons))
676 (setq file-local-variables-alist
677 (delq mode-cons file-local-variables-alist)))
a36abf0e
CY
678 (when stile
679 (or (stringp stile) (error "c-file-style is not a string"))
00af0b67
AM
680 (if (boundp 'dir-local-variables-alist)
681 ;; Determine whether `c-file-style' was set in the file's local
682 ;; variables or in a .dir-locals.el (a directory setting).
683 (let ((cfs-in-file-and-dir-count
684 (c-count-cfss file-local-variables-alist))
685 (cfs-in-dir-count (c-count-cfss dir-local-variables-alist)))
686 (c-set-style stile
b14c0c55
AM
687 (and (= cfs-in-file-and-dir-count cfs-in-dir-count)
688 'keep-defaults)))
00af0b67 689 (c-set-style stile)))
a36abf0e
CY
690 (when offsets
691 (mapc
692 (lambda (langentry)
693 (let ((langelem (car langentry))
694 (offset (cdr langentry)))
695 (c-set-offset langelem offset)))
696 offsets)))))
697
cb694ab7
AM
698(defun c-remove-any-local-eval-or-mode-variables ()
699 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
700 ;; or on the first line, remove all occurrences. See
701 ;; `c-postprocess-file-styles' for justification. There is no need to save
5c4c911a
AM
702 ;; point here, or even bother too much about the buffer contents. However,
703 ;; DON'T mess up the kill-ring.
cb694ab7
AM
704 ;;
705 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
706 ;; in files.el.
707 (goto-char (point-max))
708 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
709 (let (lv-point (prefix "") (suffix ""))
710 (when (let ((case-fold-search t))
711 (search-forward "Local Variables:" nil t))
712 (setq lv-point (point))
713 ;; The prefix is what comes before "local variables:" in its line.
714 ;; The suffix is what comes after "local variables:" in its line.
715 (skip-chars-forward " \t")
716 (or (eolp)
717 (setq suffix (buffer-substring (point)
718 (progn (end-of-line) (point)))))
719 (goto-char (match-beginning 0))
720 (or (bolp)
721 (setq prefix
722 (buffer-substring (point)
723 (progn (beginning-of-line) (point)))))
724
725 (while (search-forward-regexp
726 (concat "^[ \t]*"
727 (regexp-quote prefix)
728 "\\(mode\\|eval\\):.*"
729 (regexp-quote suffix)
730 "$")
731 nil t)
5c4c911a
AM
732 (forward-line 0)
733 (delete-region (point) (progn (forward-line) (point)))))
cb694ab7
AM
734
735 ;; Delete the first line, if we've got one, in case it contains a mode spec.
736 (unless (and lv-point
737 (progn (goto-char lv-point)
738 (forward-line 0)
739 (bobp)))
740 (goto-char (point-min))
5c4c911a
AM
741 (unless (eobp)
742 (delete-region (point) (progn (forward-line) (point)))))))
cb694ab7 743
130c507e 744(defun c-postprocess-file-styles ()
d9e94c22 745 "Function that post processes relevant file local variables in CC Mode.
130c507e
GM
746Currently, this function simply applies any style and offset settings
747found in the file's Local Variable list. It first applies any style
748setting found in `c-file-style', then it applies any offset settings
749it finds in `c-file-offsets'.
750
751Note that the style variables are always made local to the buffer."
d9e94c22 752
130c507e 753 ;; apply file styles and offsets
09f90d2c
RS
754 (when c-buffer-is-cc-mode
755 (if (or c-file-style c-file-offsets)
756 (c-make-styles-buffer-local t))
c5fcadd1
AM
757 (when c-file-style
758 (or (stringp c-file-style)
759 (error "c-file-style is not a string"))
a3c11552 760 (c-set-style c-file-style))
b9a6ed29 761
09f90d2c 762 (and c-file-offsets
d61ca8d5 763 (mapc
09f90d2c
RS
764 (lambda (langentry)
765 (let ((langelem (car langentry))
766 (offset (cdr langentry)))
767 (c-set-offset langelem offset)))
0386b551
AM
768 c-file-offsets))
769 ;; Problem: The file local variable block might have explicitly set a
770 ;; style variable. The `c-set-style' or `mapcar' call might have
771 ;; overwritten this. So we run `hack-local-variables' again to remedy
772 ;; this. There are no guarantees this will work properly, particularly as
773 ;; we have no control over what the other hook functions on
cb694ab7
AM
774 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
775 ;; any `eval' or `mode' expressions before we evaluate again (see below).
776 ;; ACM, 2005/11/2.
777 ;;
778 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
779 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
780 ;; We prevent this by temporarily removing `mode' from the Local Variables
781 ;; section.
0386b551 782 (if (or c-file-style c-file-offsets)
51c9af45
AM
783 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
784 (c-tentative-buffer-changes
cb694ab7
AM
785 (c-remove-any-local-eval-or-mode-variables)
786 (hack-local-variables))
787 nil))))
130c507e 788
a36abf0e
CY
789(if (boundp 'before-hack-local-variables-hook)
790 (add-hook 'before-hack-local-variables-hook 'c-before-hack-hook)
791 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles))
130c507e 792
3efc2cd7
MS
793(defmacro c-run-mode-hooks (&rest hooks)
794 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
dd969a56 795 ;; requires the use of the new function `run-mode-hooks'.
3efc2cd7
MS
796 (if (cc-bytecomp-fboundp 'run-mode-hooks)
797 `(run-mode-hooks ,@hooks)
798 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
799
130c507e 800\f
1d1e4868
AM
801;;; Change hooks, linking with Font Lock.
802
1d1e4868
AM
803;; Buffer local variables recording Beginning/End-of-Macro position before a
804;; change, when a macro straddles, respectively, the BEG or END (or both) of
805;; the change region. Otherwise these have the values BEG/END.
806(defvar c-old-BOM 0)
807(make-variable-buffer-local 'c-old-BOM)
808(defvar c-old-EOM 0)
809(make-variable-buffer-local 'c-old-EOM)
810
811(defun c-extend-region-for-CPP (beg end)
f8016ed6
AM
812 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
813 ;; beginning/end of any preprocessor construct they may be in.
1d1e4868
AM
814 ;;
815 ;; Point is undefined both before and after this function call; the buffer
816 ;; has already been widened, and match-data saved. The return value is
817 ;; meaningless.
818 ;;
dd969a56
AM
819 ;; This function is in the C/C++/ObjC values of
820 ;; `c-get-state-before-change-functions' and is called exclusively as a
1d1e4868
AM
821 ;; before change function.
822 (goto-char beg)
823 (c-beginning-of-macro)
824 (setq c-old-BOM (point))
825
826 (goto-char end)
3d14bb73
AM
827 (when (c-beginning-of-macro)
828 (c-end-of-macro)
829 (or (eobp) (forward-char))) ; Over the terminating NL which may be marked
830 ; with a c-cpp-delimiter category property
f8016ed6 831 (setq c-old-EOM (point)))
1d1e4868
AM
832
833(defun c-neutralize-CPP-line (beg end)
c5fcadd1
AM
834 ;; BEG and END bound a region, typically a preprocessor line. Put a
835 ;; "punctuation" syntax-table property on syntactically obtrusive
836 ;; characters, ones which would interact syntactically with stuff outside
837 ;; this region.
1d1e4868
AM
838 ;;
839 ;; These are unmatched string delimiters, or unmatched
840 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
841 ;; obtrusive.
c5fcadd1
AM
842 (save-excursion
843 (let (s)
844 (while
845 (progn
846 (setq s (parse-partial-sexp beg end -1))
847 (cond
848 ((< (nth 0 s) 0) ; found an unmated ),},]
849 (c-put-char-property (1- (point)) 'syntax-table '(1))
850 t)
851 ((nth 3 s) ; In a string
852 (c-put-char-property (nth 8 s) 'syntax-table '(1))
853 t)
854 ((> (nth 0 s) 0) ; In a (,{,[
855 (c-put-char-property (nth 1 s) 'syntax-table '(1))
856 t)
857 (t nil)))))))
1d1e4868 858
0ec1d2c5 859(defun c-neutralize-syntax-in-and-mark-CPP (begg endd old-len)
a0526d5e
AM
860 ;; (i) Extend the font lock region to cover all changed preprocessor
861 ;; regions; it does this by setting the variables `c-new-BEG' and
862 ;; `c-new-END' to the new boundaries.
863 ;;
864 ;; (ii) "Neutralize" every preprocessor line wholly or partially in the
865 ;; extended changed region. "Restore" lines which were CPP lines before the
866 ;; change and are no longer so; these can be located from the Buffer local
867 ;; variables `c-old-BOM' and `c-old-EOM'.
0ec1d2c5
AM
868 ;;
869 ;; (iii) Mark every CPP construct by placing a `category' property value
870 ;; `c-cpp-delimiter' at its start and end. The marked characters are the
871 ;; opening # and usually the terminating EOL, but sometimes the character
872 ;; before a comment/string delimiter.
873 ;;
1d1e4868
AM
874 ;; That is, set syntax-table properties on characters that would otherwise
875 ;; interact syntactically with those outside the CPP line(s).
0ec1d2c5 876 ;;
1d1e4868
AM
877 ;; This function is called from an after-change function, BEGG ENDD and
878 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
879 ;; locking, hence must get called before `font-lock-after-change-function'.
880 ;;
881 ;; Point is undefined both before and after this function call, the buffer
882 ;; has been widened, and match-data saved. The return value is ignored.
883 ;;
884 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
885 ;;
c5fcadd1 886 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
0ec1d2c5 887 ;;
c5fcadd1 888 ;; This function might make hidden buffer changes.
0ec1d2c5 889 (c-save-buffer-state (limits)
a0526d5e
AM
890 ;; First determine the region, (c-new-BEG c-new-END), which will get font
891 ;; locked. It might need "neutralizing". This region may not start
892 ;; inside a string, comment, or macro.
c5fcadd1 893 (goto-char c-old-BOM) ; already set to old start of macro or begg.
a0526d5e 894 (setq c-new-BEG
43a91810
AM
895 (min c-new-BEG
896 (if (setq limits (c-state-literal-at (point)))
897 (cdr limits) ; go forward out of any string or comment.
898 (point))))
c5fcadd1 899
1d1e4868 900 (goto-char endd)
0ec1d2c5 901 (if (setq limits (c-state-literal-at (point)))
c5fcadd1
AM
902 (goto-char (car limits))) ; go backward out of any string or comment.
903 (if (c-beginning-of-macro)
904 (c-end-of-macro))
43a91810
AM
905 (setq c-new-END (max c-new-END
906 (+ (- c-old-EOM old-len) (- endd begg))
907 (point)))
c5fcadd1 908
0ec1d2c5 909 ;; Clear all old relevant properties.
a0526d5e 910 (c-clear-char-property-with-value c-new-BEG c-new-END 'syntax-table '(1))
0ec1d2c5
AM
911 (c-clear-char-property-with-value c-new-BEG c-new-END 'category 'c-cpp-delimiter)
912 ;; FIXME!!! What about the "<" and ">" category properties? 2009-11-16
1d1e4868 913
a0526d5e
AM
914 ;; Add needed properties to each CPP construct in the region.
915 (goto-char c-new-BEG)
0ec1d2c5 916 (let ((pps-position c-new-BEG) pps-state mbeg)
a0526d5e
AM
917 (while (and (< (point) c-new-END)
918 (search-forward-regexp c-anchored-cpp-prefix c-new-END t))
c5fcadd1
AM
919 ;; If we've found a "#" inside a string/comment, ignore it.
920 (setq pps-state
921 (parse-partial-sexp pps-position (point) nil nil pps-state)
922 pps-position (point))
923 (unless (or (nth 3 pps-state) ; in a string?
924 (nth 4 pps-state)) ; in a comment?
0ec1d2c5
AM
925 (goto-char (match-beginning 0))
926 (setq mbeg (point))
927 (if (> (c-syntactic-end-of-macro) mbeg)
928 (progn
929 (c-neutralize-CPP-line mbeg (point))
930 (c-set-cpp-delimiters mbeg (point))
931 ;(setq pps-position (point))
932 )
933 (forward-line)) ; no infinite loop with, e.g., "#//"
934 )))))
1d1e4868
AM
935
936(defun c-before-change (beg end)
dd969a56
AM
937 ;; Function to be put on `before-change-functions'. Primarily, this calls
938 ;; the language dependent `c-get-state-before-change-functions'. It is
1d1e4868
AM
939 ;; otherwise used only to remove stale entries from the `c-found-types'
940 ;; cache, and to record entries which a `c-after-change' function might
941 ;; confirm as stale.
0ec1d2c5 942 ;;
1d1e4868
AM
943 ;; Note that this function must be FAST rather than accurate. Note
944 ;; also that it only has any effect when font locking is enabled.
945 ;; We exploit this by checking for font-lock-*-face instead of doing
946 ;; rigourous syntactic analysis.
947
948 ;; If either change boundary is wholly inside an identifier, delete
949 ;; it/them from the cache. Don't worry about being inside a string
950 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
951 ;; isn't critical.
952 (setq c-maybe-stale-found-type nil)
953 (save-restriction
954 (save-match-data
955 (widen)
956 (save-excursion
957 ;; Are we inserting/deleting stuff in the middle of an identifier?
958 (c-unfind-enclosing-token beg)
959 (c-unfind-enclosing-token end)
960 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
961 (when (< beg end)
962 (c-unfind-coalesced-tokens beg end))
963 ;; Are we (potentially) disrupting the syntactic context which
964 ;; makes a type a type? E.g. by inserting stuff after "foo" in
965 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
966 ;;
967 ;; We search for appropriate c-type properties "near" the change.
968 ;; First, find an appropriate boundary for this property search.
969 (let (lim
970 type type-pos
971 marked-id term-pos
972 (end1
973 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
974 (previous-single-property-change end 'face))
975 end)))
976 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
977 ;; Find a limit for the search for a `c-type' property
978 (while
979 (and (/= (skip-chars-backward "^;{}") 0)
980 (> (point) (point-min))
981 (memq (c-get-char-property (1- (point)) 'face)
982 '(font-lock-comment-face font-lock-string-face))))
983 (setq lim (max (point-min) (1- (point))))
984
985 ;; Look for the latest `c-type' property before end1
986 (when (and (> end1 (point-min))
987 (setq type-pos
988 (if (get-text-property (1- end1) 'c-type)
989 end1
990 (previous-single-property-change end1 'c-type nil lim))))
991 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
992
993 (when (memq type '(c-decl-id-start c-decl-type-start))
994 ;; Get the identifier, if any, that the property is on.
995 (goto-char (1- type-pos))
996 (setq marked-id
997 (when (looking-at "\\(\\sw\\|\\s_\\)")
998 (c-beginning-of-current-token)
999 (buffer-substring-no-properties (point) type-pos)))
1000
1001 (goto-char end1)
1002 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
1003 (setq lim (point))
1004 (setq term-pos
1005 (or (next-single-property-change end 'c-type nil lim) lim))
1006 (setq c-maybe-stale-found-type
1007 (list type marked-id
1008 type-pos term-pos
1009 (buffer-substring-no-properties type-pos term-pos)
1010 (buffer-substring-no-properties beg end)))))))
1011
dd969a56
AM
1012 (if c-get-state-before-change-functions
1013 (mapc (lambda (fn)
1014 (funcall fn beg end))
1015 c-get-state-before-change-functions))
1d1e4868
AM
1016 ))))
1017
1018(defun c-after-change (beg end old-len)
1019 ;; Function put on `after-change-functions' to adjust various caches
1020 ;; etc. Prefer speed to finesse here, since there will be an order
1021 ;; of magnitude more calls to this function than any of the
1022 ;; functions that use the caches.
1023 ;;
1024 ;; Note that care must be taken so that this is called before any
1025 ;; font-lock callbacks since we might get calls to functions using
1026 ;; these caches from inside them, and we must thus be sure that this
1027 ;; has already been executed.
1028 ;;
1029 ;; This calls the language variable c-before-font-lock-function, if non nil.
1030 ;; This typically sets `syntax-table' properties.
1031
1032 (c-save-buffer-state ()
1033 ;; When `combine-after-change-calls' is used we might get calls
1034 ;; with regions outside the current narrowing. This has been
1035 ;; observed in Emacs 20.7.
1036 (save-restriction
1037 (save-match-data ; c-recognize-<>-arglists changes match-data
1038 (widen)
1039
1040 (when (> end (point-max))
1041 ;; Some emacsen might return positions past the end. This has been
1042 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1043 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1044 ;; work).
1045 (setq end (point-max))
1046 (when (> beg end)
1047 (setq beg end)))
1048
8a249abc
AM
1049 ;; C-y is capable of spuriously converting category properties
1050 ;; c-</>-as-paren-syntax into hard syntax-table properties. Remove
1051 ;; these when it happens.
1052 (c-clear-char-property-with-value beg end 'syntax-table
1053 c-<-as-paren-syntax)
1054 (c-clear-char-property-with-value beg end 'syntax-table
1055 c->-as-paren-syntax)
1056
1d1e4868
AM
1057 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1058 (c-invalidate-sws-region-after beg end)
1059 (c-invalidate-state-cache beg)
1060 (c-invalidate-find-decl-cache beg)
1061
1062 (when c-recognize-<>-arglists
1063 (c-after-change-check-<>-operators beg end))
1064
ba7fdf30
AM
1065 ;; (c-new-BEG c-new-END) will be the region to fontify. It may become
1066 ;; larger than (beg end).
1067 (setq c-new-BEG beg
1068 c-new-END end)
1d1e4868
AM
1069 (if c-before-font-lock-function
1070 (save-excursion
1071 (funcall c-before-font-lock-function beg end old-len)))))))
1072
1073(defun c-after-font-lock-init ()
1074 ;; Put on `font-lock-mode-hook'.
1075 (remove-hook 'after-change-functions 'c-after-change t)
1076 (add-hook 'after-change-functions 'c-after-change nil t))
1077
1078(defun c-font-lock-init ()
1079 "Set up the font-lock variables for using the font-lock support in CC Mode.
1080This does not load the font-lock package. Use after
1081`c-basic-common-init' and after cc-fonts has been loaded."
1082
175069ef 1083 (set (make-local-variable 'font-lock-defaults)
1d1e4868
AM
1084 `(,(if (c-major-mode-is 'awk-mode)
1085 ;; awk-mode currently has only one font lock level.
1086 'awk-font-lock-keywords
1087 (mapcar 'c-mode-symbol
1088 '("font-lock-keywords" "font-lock-keywords-1"
1089 "font-lock-keywords-2" "font-lock-keywords-3")))
1090 nil nil
1091 ,c-identifier-syntax-modifications
1092 c-beginning-of-syntax
1d1e4868
AM
1093 (font-lock-mark-block-function
1094 . c-mark-function)))
922ad43e
GM
1095 (if (featurep 'xemacs)
1096 (make-local-hook 'font-lock-mode-hook))
1d1e4868
AM
1097 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1098
8714fc18
AM
1099(defun c-extend-after-change-region (beg end old-len)
1100 "Extend the region to be fontified, if necessary."
1101 ;; Note: the parameters are ignored here. This somewhat indirect
1102 ;; implementation exists because it is minimally different from the
1103 ;; stand-alone CC Mode which, lacking
1104 ;; font-lock-extend-after-change-region-function, is forced to use advice
1105 ;; instead.
1106 ;;
a0526d5e
AM
1107 ;; Of the seven CC Mode languages, currently (2009-05) only C, C++, Objc
1108 ;; (the languages with #define) and AWK Mode make non-null use of this
1109 ;; function.
8714fc18 1110 (cons c-new-BEG c-new-END))
1d1e4868
AM
1111
1112\f
130c507e
GM
1113;; Support for C
1114
d9e94c22
MS
1115;;;###autoload
1116(defvar c-mode-syntax-table nil
1117 "Syntax table used in c-mode buffers.")
1118(or c-mode-syntax-table
1119 (setq c-mode-syntax-table
1120 (funcall (c-lang-const c-make-mode-syntax-table c))))
1121
130c507e
GM
1122(defvar c-mode-abbrev-table nil
1123 "Abbreviation table used in c-mode buffers.")
a66cd3ee
MS
1124(c-define-abbrev-table 'c-mode-abbrev-table
1125 '(("else" "else" c-electric-continued-statement 0)
1126 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1127
1128(defvar c-mode-map ()
1129 "Keymap used in c-mode buffers.")
1130(if c-mode-map
1131 nil
1132 (setq c-mode-map (c-make-inherited-keymap))
1133 ;; add bindings which are only useful for C
1134 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1135 )
1136
1137(easy-menu-define c-c-menu c-mode-map "C Mode Commands"
d9e94c22
MS
1138 (cons "C" (c-lang-const c-mode-menu c)))
1139
1140;; In XEmacs >= 21.5 modes should add their own entries to
1141;; `auto-mode-alist'. The comment form of autoload is used to avoid
1142;; doing this on load. That since `add-to-list' prepends the value
1143;; which could cause it to clobber user settings. Later emacsen have
1144;; an append option, but it's not safe to use.
50fdde0e 1145
38477bef
AM
1146;; The extension ".C" is associated with C++ while the lowercase
1147;; variant goes with C. On case insensitive file systems, this means
50fdde0e
MS
1148;; that ".c" files also might open C++ mode if the C++ entry comes
1149;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1150;; after ".c", and since `add-to-list' adds the entry first we have to
1151;; add the ".C" entry first.
1152;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1153;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1154;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1155
d9e94c22
MS
1156;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1157
1158;; NB: The following two associate yacc and lex files to C Mode, which
1159;; is not really suitable for those formats. Anyway, afaik there's
1160;; currently no better mode for them, and besides this is legacy.
1161;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1162;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1163
f63b48bb
DN
1164;; Preprocessed files generated by C and C++ compilers.
1165;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1166;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1167
1168
785eecbb 1169;;;###autoload
d43eaf2c 1170(define-derived-mode c-mode prog-mode "C"
785eecbb
RS
1171 "Major mode for editing K&R and ANSI C code.
1172To submit a problem report, enter `\\[c-submit-bug-report]' from a
1173c-mode buffer. This automatically sets up a mail buffer with version
1174information already added. You just need to add a description of the
50fdde0e 1175problem, including a reproducible test case, and send the message.
785eecbb
RS
1176
1177To see what version of CC Mode you are running, enter `\\[c-version]'.
1178
d9e94c22
MS
1179The hook `c-mode-common-hook' is run with no args at mode
1180initialization, then `c-mode-hook'.
785eecbb
RS
1181
1182Key bindings:
1183\\{c-mode-map}"
d9e94c22 1184 (c-initialize-cc-mode t)
785eecbb 1185 (set-syntax-table c-mode-syntax-table)
d43eaf2c 1186 (setq local-abbrev-table c-mode-abbrev-table
130c507e 1187 abbrev-mode t)
785eecbb 1188 (use-local-map c-mode-map)
28d88c16 1189 (c-init-language-vars-for 'c-mode)
a66cd3ee 1190 (c-common-init 'c-mode)
d9e94c22 1191 (easy-menu-add c-c-menu)
51f606de 1192 (cc-imenu-init cc-imenu-c-generic-expression)
3efc2cd7 1193 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
785eecbb
RS
1194 (c-update-modeline))
1195
1196\f
130c507e
GM
1197;; Support for C++
1198
d9e94c22
MS
1199;;;###autoload
1200(defvar c++-mode-syntax-table nil
1201 "Syntax table used in c++-mode buffers.")
1202(or c++-mode-syntax-table
1203 (setq c++-mode-syntax-table
1204 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1205
130c507e
GM
1206(defvar c++-mode-abbrev-table nil
1207 "Abbreviation table used in c++-mode buffers.")
a66cd3ee
MS
1208(c-define-abbrev-table 'c++-mode-abbrev-table
1209 '(("else" "else" c-electric-continued-statement 0)
1210 ("while" "while" c-electric-continued-statement 0)
1211 ("catch" "catch" c-electric-continued-statement 0)))
130c507e
GM
1212
1213(defvar c++-mode-map ()
1214 "Keymap used in c++-mode buffers.")
1215(if c++-mode-map
1216 nil
1217 (setq c++-mode-map (c-make-inherited-keymap))
1218 ;; add bindings which are only useful for C++
1219 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1220 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1221 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1222 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1223
1224(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
d9e94c22
MS
1225 (cons "C++" (c-lang-const c-mode-menu c++)))
1226
785eecbb 1227;;;###autoload
d43eaf2c 1228(define-derived-mode c++-mode prog-mode "C++"
785eecbb
RS
1229 "Major mode for editing C++ code.
1230To submit a problem report, enter `\\[c-submit-bug-report]' from a
1231c++-mode buffer. This automatically sets up a mail buffer with
1232version information already added. You just need to add a description
1233of the problem, including a reproducible test case, and send the
1234message.
1235
1236To see what version of CC Mode you are running, enter `\\[c-version]'.
1237
d9e94c22
MS
1238The hook `c-mode-common-hook' is run with no args at mode
1239initialization, then `c++-mode-hook'.
785eecbb
RS
1240
1241Key bindings:
1242\\{c++-mode-map}"
d9e94c22 1243 (c-initialize-cc-mode t)
785eecbb 1244 (set-syntax-table c++-mode-syntax-table)
d43eaf2c 1245 (setq local-abbrev-table c++-mode-abbrev-table
130c507e 1246 abbrev-mode t)
785eecbb 1247 (use-local-map c++-mode-map)
28d88c16 1248 (c-init-language-vars-for 'c++-mode)
a66cd3ee 1249 (c-common-init 'c++-mode)
d9e94c22 1250 (easy-menu-add c-c++-menu)
51f606de 1251 (cc-imenu-init cc-imenu-c++-generic-expression)
3efc2cd7 1252 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
785eecbb
RS
1253 (c-update-modeline))
1254
1255\f
130c507e
GM
1256;; Support for Objective-C
1257
d9e94c22
MS
1258;;;###autoload
1259(defvar objc-mode-syntax-table nil
1260 "Syntax table used in objc-mode buffers.")
1261(or objc-mode-syntax-table
1262 (setq objc-mode-syntax-table
1263 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1264
130c507e
GM
1265(defvar objc-mode-abbrev-table nil
1266 "Abbreviation table used in objc-mode buffers.")
a66cd3ee
MS
1267(c-define-abbrev-table 'objc-mode-abbrev-table
1268 '(("else" "else" c-electric-continued-statement 0)
1269 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1270
1271(defvar objc-mode-map ()
1272 "Keymap used in objc-mode buffers.")
1273(if objc-mode-map
1274 nil
1275 (setq objc-mode-map (c-make-inherited-keymap))
1276 ;; add bindings which are only useful for Objective-C
1277 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1278
1279(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
d9e94c22
MS
1280 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1281
1282;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
130c507e 1283
785eecbb 1284;;;###autoload
d43eaf2c 1285(define-derived-mode objc-mode prog-mode "ObjC"
785eecbb
RS
1286 "Major mode for editing Objective C code.
1287To submit a problem report, enter `\\[c-submit-bug-report]' from an
1288objc-mode buffer. This automatically sets up a mail buffer with
1289version information already added. You just need to add a description
1290of the problem, including a reproducible test case, and send the
1291message.
1292
1293To see what version of CC Mode you are running, enter `\\[c-version]'.
1294
d9e94c22
MS
1295The hook `c-mode-common-hook' is run with no args at mode
1296initialization, then `objc-mode-hook'.
785eecbb
RS
1297
1298Key bindings:
1299\\{objc-mode-map}"
d9e94c22 1300 (c-initialize-cc-mode t)
785eecbb 1301 (set-syntax-table objc-mode-syntax-table)
d43eaf2c 1302 (setq local-abbrev-table objc-mode-abbrev-table
130c507e 1303 abbrev-mode t)
785eecbb 1304 (use-local-map objc-mode-map)
28d88c16 1305 (c-init-language-vars-for 'objc-mode)
a66cd3ee 1306 (c-common-init 'objc-mode)
d9e94c22
MS
1307 (easy-menu-add c-objc-menu)
1308 (cc-imenu-init nil 'cc-imenu-objc-function)
3efc2cd7 1309 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
785eecbb
RS
1310 (c-update-modeline))
1311
1312\f
130c507e
GM
1313;; Support for Java
1314
d9e94c22
MS
1315;;;###autoload
1316(defvar java-mode-syntax-table nil
1317 "Syntax table used in java-mode buffers.")
1318(or java-mode-syntax-table
1319 (setq java-mode-syntax-table
1320 (funcall (c-lang-const c-make-mode-syntax-table java))))
1321
130c507e
GM
1322(defvar java-mode-abbrev-table nil
1323 "Abbreviation table used in java-mode buffers.")
a66cd3ee
MS
1324(c-define-abbrev-table 'java-mode-abbrev-table
1325 '(("else" "else" c-electric-continued-statement 0)
1326 ("while" "while" c-electric-continued-statement 0)
1327 ("catch" "catch" c-electric-continued-statement 0)
1328 ("finally" "finally" c-electric-continued-statement 0)))
130c507e
GM
1329
1330(defvar java-mode-map ()
1331 "Keymap used in java-mode buffers.")
1332(if java-mode-map
1333 nil
1334 (setq java-mode-map (c-make-inherited-keymap))
1335 ;; add bindings which are only useful for Java
1336 )
1337
d9e94c22
MS
1338;; Regexp trying to describe the beginning of a Java top-level
1339;; definition. This is not used by CC Mode, nor is it maintained
1340;; since it's practically impossible to write a regexp that reliably
1341;; matches such a construct. Other tools are necessary.
1342(defconst c-Java-defun-prompt-regexp
1343 "^[ \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-*")
1344
130c507e 1345(easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
d9e94c22
MS
1346 (cons "Java" (c-lang-const c-mode-menu java)))
1347
1348;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
130c507e 1349
785eecbb 1350;;;###autoload
d43eaf2c 1351(define-derived-mode java-mode prog-mode "Java"
785eecbb 1352 "Major mode for editing Java code.
dc2b4c5f 1353To submit a problem report, enter `\\[c-submit-bug-report]' from a
785eecbb
RS
1354java-mode buffer. This automatically sets up a mail buffer with
1355version information already added. You just need to add a description
50fdde0e 1356of the problem, including a reproducible test case, and send the
785eecbb
RS
1357message.
1358
1359To see what version of CC Mode you are running, enter `\\[c-version]'.
1360
d9e94c22
MS
1361The hook `c-mode-common-hook' is run with no args at mode
1362initialization, then `java-mode-hook'.
785eecbb
RS
1363
1364Key bindings:
1365\\{java-mode-map}"
d9e94c22 1366 (c-initialize-cc-mode t)
785eecbb 1367 (set-syntax-table java-mode-syntax-table)
d43eaf2c 1368 (setq local-abbrev-table java-mode-abbrev-table
a66cd3ee 1369 abbrev-mode t)
785eecbb 1370 (use-local-map java-mode-map)
28d88c16 1371 (c-init-language-vars-for 'java-mode)
a66cd3ee 1372 (c-common-init 'java-mode)
d9e94c22 1373 (easy-menu-add c-java-menu)
51f606de 1374 (cc-imenu-init cc-imenu-java-generic-expression)
3efc2cd7 1375 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
785eecbb
RS
1376 (c-update-modeline))
1377
1378\f
130c507e
GM
1379;; Support for CORBA's IDL language
1380
d9e94c22
MS
1381;;;###autoload
1382(defvar idl-mode-syntax-table nil
1383 "Syntax table used in idl-mode buffers.")
1384(or idl-mode-syntax-table
1385 (setq idl-mode-syntax-table
1386 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1387
130c507e
GM
1388(defvar idl-mode-abbrev-table nil
1389 "Abbreviation table used in idl-mode buffers.")
a66cd3ee 1390(c-define-abbrev-table 'idl-mode-abbrev-table nil)
130c507e
GM
1391
1392(defvar idl-mode-map ()
1393 "Keymap used in idl-mode buffers.")
1394(if idl-mode-map
1395 nil
1396 (setq idl-mode-map (c-make-inherited-keymap))
1397 ;; add bindings which are only useful for IDL
1398 )
1399
1400(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
d9e94c22
MS
1401 (cons "IDL" (c-lang-const c-mode-menu idl)))
1402
1403;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
130c507e 1404
aac90c52 1405;;;###autoload
d43eaf2c 1406(define-derived-mode idl-mode prog-mode "IDL"
d9e94c22 1407 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
aac90c52
RS
1408To submit a problem report, enter `\\[c-submit-bug-report]' from an
1409idl-mode buffer. This automatically sets up a mail buffer with
1410version information already added. You just need to add a description
1411of the problem, including a reproducible test case, and send the
1412message.
1413
1414To see what version of CC Mode you are running, enter `\\[c-version]'.
1415
d9e94c22
MS
1416The hook `c-mode-common-hook' is run with no args at mode
1417initialization, then `idl-mode-hook'.
aac90c52
RS
1418
1419Key bindings:
1420\\{idl-mode-map}"
d9e94c22 1421 (c-initialize-cc-mode t)
aac90c52 1422 (set-syntax-table idl-mode-syntax-table)
d43eaf2c 1423 (setq local-abbrev-table idl-mode-abbrev-table)
aac90c52 1424 (use-local-map idl-mode-map)
28d88c16 1425 (c-init-language-vars-for 'idl-mode)
a66cd3ee 1426 (c-common-init 'idl-mode)
d9e94c22
MS
1427 (easy-menu-add c-idl-menu)
1428 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
3efc2cd7 1429 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
aac90c52
RS
1430 (c-update-modeline))
1431
1432\f
130c507e
GM
1433;; Support for Pike
1434
d9e94c22
MS
1435;;;###autoload
1436(defvar pike-mode-syntax-table nil
1437 "Syntax table used in pike-mode buffers.")
1438(or pike-mode-syntax-table
1439 (setq pike-mode-syntax-table
1440 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1441
130c507e
GM
1442(defvar pike-mode-abbrev-table nil
1443 "Abbreviation table used in pike-mode buffers.")
a66cd3ee
MS
1444(c-define-abbrev-table 'pike-mode-abbrev-table
1445 '(("else" "else" c-electric-continued-statement 0)
1446 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1447
1448(defvar pike-mode-map ()
1449 "Keymap used in pike-mode buffers.")
1450(if pike-mode-map
1451 nil
1452 (setq pike-mode-map (c-make-inherited-keymap))
1453 ;; additional bindings
1454 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1455
1456(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
d9e94c22
MS
1457 (cons "Pike" (c-lang-const c-mode-menu pike)))
1458
50fdde0e
MS
1459;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1460;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
130c507e 1461
0ec8351b 1462;;;###autoload
d43eaf2c 1463(define-derived-mode pike-mode prog-mode "Pike"
0ec8351b 1464 "Major mode for editing Pike code.
a66cd3ee
MS
1465To submit a problem report, enter `\\[c-submit-bug-report]' from a
1466pike-mode buffer. This automatically sets up a mail buffer with
0ec8351b
BW
1467version information already added. You just need to add a description
1468of the problem, including a reproducible test case, and send the
1469message.
1470
1471To see what version of CC Mode you are running, enter `\\[c-version]'.
1472
d9e94c22
MS
1473The hook `c-mode-common-hook' is run with no args at mode
1474initialization, then `pike-mode-hook'.
0ec8351b
BW
1475
1476Key bindings:
1477\\{pike-mode-map}"
d9e94c22 1478 (c-initialize-cc-mode t)
0ec8351b 1479 (set-syntax-table pike-mode-syntax-table)
d43eaf2c 1480 (setq local-abbrev-table pike-mode-abbrev-table
a66cd3ee 1481 abbrev-mode t)
0ec8351b 1482 (use-local-map pike-mode-map)
28d88c16 1483 (c-init-language-vars-for 'pike-mode)
a66cd3ee 1484 (c-common-init 'pike-mode)
d9e94c22
MS
1485 (easy-menu-add c-pike-menu)
1486 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
3efc2cd7 1487 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
0ec8351b
BW
1488 (c-update-modeline))
1489
1490\f
0386b551 1491;; Support for AWK
d9e94c22 1492
50fdde0e
MS
1493;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1494;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1495;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1496;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1497;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
d9e94c22 1498
50fdde0e
MS
1499;;; Autoload directives must be on the top level, so we construct an
1500;;; autoload form instead.
791887d9 1501;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
50fdde0e 1502
0386b551
AM
1503(defvar awk-mode-abbrev-table nil
1504 "Abbreviation table used in awk-mode buffers.")
1505(c-define-abbrev-table 'awk-mode-abbrev-table
1506 '(("else" "else" c-electric-continued-statement 0)
1507 ("while" "while" c-electric-continued-statement 0)))
1508
1509(defvar awk-mode-map ()
1510 "Keymap used in awk-mode buffers.")
1511(if awk-mode-map
1512 nil
1513 (setq awk-mode-map (c-make-inherited-keymap))
1514 ;; add bindings which are only useful for awk.
1515 (define-key awk-mode-map "#" 'self-insert-command)
1516 (define-key awk-mode-map "/" 'self-insert-command)
1517 (define-key awk-mode-map "*" 'self-insert-command)
1518 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1519 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1520 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1521 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1522 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1523 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1524 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1525
1526(easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1527 (cons "AWK" (c-lang-const c-mode-menu awk)))
1528
ae500c1a
GM
1529;; (require 'cc-awk) brings these in.
1530(defvar awk-mode-syntax-table)
1531(declare-function c-awk-unstick-NL-prop "cc-awk" ())
1532
d43eaf2c
CY
1533;;;###autoload
1534(define-derived-mode awk-mode prog-mode "AWK"
0386b551 1535 "Major mode for editing AWK code.
d9e94c22
MS
1536To submit a problem report, enter `\\[c-submit-bug-report]' from an
1537awk-mode buffer. This automatically sets up a mail buffer with version
1538information already added. You just need to add a description of the
50fdde0e 1539problem, including a reproducible test case, and send the message.
d9e94c22
MS
1540
1541To see what version of CC Mode you are running, enter `\\[c-version]'.
1542
1543The hook `c-mode-common-hook' is run with no args at mode
1544initialization, then `awk-mode-hook'.
1545
1546Key bindings:
1547\\{awk-mode-map}"
0a6b9622
AM
1548 ;; We need the next line to stop the macro defining
1549 ;; `awk-mode-syntax-table'. This would mask the real table which is
1550 ;; declared in cc-awk.el and hasn't yet been loaded.
1551 :syntax-table nil
0386b551 1552 (require 'cc-awk) ; Added 2003/6/10.
0386b551
AM
1553 (c-initialize-cc-mode t)
1554 (set-syntax-table awk-mode-syntax-table)
d43eaf2c 1555 (setq local-abbrev-table awk-mode-abbrev-table
0386b551
AM
1556 abbrev-mode t)
1557 (use-local-map awk-mode-map)
1558 (c-init-language-vars-for 'awk-mode)
1559 (c-common-init 'awk-mode)
0386b551 1560 (c-awk-unstick-NL-prop)
0386b551
AM
1561
1562 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1563 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1564 (defalias 'c-in-literal 'c-slow-in-literal)
1565
1566 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1567 (c-update-modeline))
d9e94c22
MS
1568
1569\f
c2efc1d0 1570;; bug reporting
785eecbb
RS
1571
1572(defconst c-mode-help-address
a66cd3ee
MS
1573 "bug-cc-mode@gnu.org"
1574 "Address(es) for CC Mode bug reports.")
785eecbb
RS
1575
1576(defun c-version ()
1577 "Echo the current version of CC Mode in the minibuffer."
1578 (interactive)
1579 (message "Using CC Mode version %s" c-version)
1580 (c-keep-region-active))
1581
130c507e
GM
1582(defvar c-prepare-bug-report-hooks nil)
1583
1584;; Dynamic variables used by reporter.
1585(defvar reporter-prompt-for-summary-p)
1586(defvar reporter-dont-compact-list)
1587
785eecbb
RS
1588(defun c-submit-bug-report ()
1589 "Submit via mail a bug report on CC Mode."
1590 (interactive)
77e31a8d 1591 (require 'reporter)
785eecbb
RS
1592 ;; load in reporter
1593 (let ((reporter-prompt-for-summary-p t)
1594 (reporter-dont-compact-list '(c-offsets-alist))
1595 (style c-indentation-style)
785eecbb
RS
1596 (c-features c-emacs-features))
1597 (and
1598 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1599 t (message "") nil)
785eecbb
RS
1600 (reporter-submit-bug-report
1601 c-mode-help-address
d9e94c22 1602 (concat "CC Mode " c-version " (" mode-name ")")
51f606de 1603 (let ((vars (append
51f606de 1604 c-style-variables
d9e94c22 1605 '(c-buffer-is-cc-mode
51f606de 1606 c-tab-always-indent
d9e94c22
MS
1607 c-syntactic-indentation
1608 c-syntactic-indentation-in-macros
1609 c-ignore-auto-fill
1610 c-auto-align-backslashes
1611 c-backspace-function
1612 c-delete-function
1613 c-electric-pound-behavior
1614 c-default-style
1615 c-enable-xemacs-performance-kludge-p
1616 c-old-style-variable-behavior
51f606de
GM
1617 defun-prompt-regexp
1618 tab-width
1619 comment-column
1620 parse-sexp-ignore-comments
d9e94c22
MS
1621 parse-sexp-lookup-properties
1622 lookup-syntax-properties
51f606de
GM
1623 ;; A brain-damaged XEmacs only variable that, if
1624 ;; set to nil can cause all kinds of chaos.
1625 signal-error-on-buffer-boundary
1626 ;; Variables that affect line breaking and comments.
d9e94c22 1627 auto-fill-mode
91b807c9 1628 auto-fill-function
51f606de
GM
1629 filladapt-mode
1630 comment-multi-line
1631 comment-start-skip
1632 fill-prefix
d9e94c22 1633 fill-column
51f606de
GM
1634 paragraph-start
1635 adaptive-fill-mode
1636 adaptive-fill-regexp)
1637 nil)))
d61ca8d5 1638 (mapc (lambda (var) (unless (boundp var)
175069ef 1639 (setq vars (delq var vars))))
d61ca8d5
GM
1640 '(signal-error-on-buffer-boundary
1641 filladapt-mode
1642 defun-prompt-regexp
1643 font-lock-mode
1644 font-lock-maximum-decoration
1645 parse-sexp-lookup-properties
1646 lookup-syntax-properties))
51f606de 1647 vars)
9714ec23 1648 (lambda ()
a66cd3ee 1649 (run-hooks 'c-prepare-bug-report-hooks)
d9e94c22 1650 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
a66cd3ee 1651 style c-features)))))))
785eecbb
RS
1652
1653\f
130c507e 1654(cc-provide 'cc-mode)
ab5796a9 1655
785eecbb 1656;;; cc-mode.el ends here