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