*** 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)
8714fc18 609 'c-extend-after-change-region)) ; Currently (2008-04), only used by AWK.
d9e94c22 610
d9e94c22
MS
611(defun c-setup-doc-comment-style ()
612 "Initialize the variables that depend on the value of `c-doc-comment-style'."
613 (when (and (featurep 'font-lock)
614 (symbol-value 'font-lock-mode))
615 ;; Force font lock mode to reinitialize itself.
616 (font-lock-mode 0)
617 (font-lock-mode 1)))
618
619(defun c-common-init (&optional mode)
620 "Common initialization for all CC Mode modes.
621In addition to the work done by `c-basic-common-init' and
622`c-font-lock-init', this function sets up various other things as
623customary in CC Mode modes but which aren't strictly necessary for CC
624Mode to operate correctly.
625
626MODE is the symbol for the mode to initialize, like 'c-mode. See
627`c-basic-common-init' for details. It's only optional to be
0386b551 628compatible with old code; callers should always specify it."
d9e94c22
MS
629
630 (unless mode
631 ;; Called from an old third party package. The fallback is to
632 ;; initialize for C.
28d88c16 633 (c-init-language-vars-for 'c-mode))
d9e94c22
MS
634
635 (c-basic-common-init mode c-default-style)
636 (when mode
637 ;; Only initialize font locking if we aren't called from an old package.
638 (c-font-lock-init))
639
1d1e4868
AM
640 ;; Starting a mode is a sort of "change". So call the change functions...
641 (save-restriction
642 (widen)
643 (save-excursion
644 (if c-get-state-before-change-function
645 (funcall c-get-state-before-change-function (point-min) (point-max)))
646 (if c-before-font-lock-function
647 (funcall c-before-font-lock-function (point-min) (point-max)
648 (- (point-max) (point-min))))))
649
d9e94c22
MS
650 (make-local-variable 'outline-regexp)
651 (make-local-variable 'outline-level)
652 (setq outline-regexp "[^#\n\^M]"
653 outline-level 'c-outline-level)
654
655 (let ((rfn (assq mode c-require-final-newline)))
656 (when rfn
657 (make-local-variable 'require-final-newline)
1750e02f
RS
658 (and (cdr rfn)
659 (setq require-final-newline mode-require-final-newline)))))
130c507e 660
a36abf0e
CY
661(defun c-before-hack-hook ()
662 "Set the CC Mode style and \"offsets\" when in the buffer's local variables.
663They are set only when, respectively, the pseudo variables
664`c-file-style' and `c-file-offsets' are present in the list.
665
666This function is called from the hook `before-hack-local-variables-hook'."
667 (when c-buffer-is-cc-mode
668 (let ((stile (cdr (assq 'c-file-style file-local-variables-alist)))
669 (offsets (cdr (assq 'c-file-offsets file-local-variables-alist))))
670 (when stile
671 (or (stringp stile) (error "c-file-style is not a string"))
672 (c-set-style stile))
673 (when offsets
674 (mapc
675 (lambda (langentry)
676 (let ((langelem (car langentry))
677 (offset (cdr langentry)))
678 (c-set-offset langelem offset)))
679 offsets)))))
680
cb694ab7
AM
681(defun c-remove-any-local-eval-or-mode-variables ()
682 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
683 ;; or on the first line, remove all occurrences. See
684 ;; `c-postprocess-file-styles' for justification. There is no need to save
5c4c911a
AM
685 ;; point here, or even bother too much about the buffer contents. However,
686 ;; DON'T mess up the kill-ring.
cb694ab7
AM
687 ;;
688 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
689 ;; in files.el.
690 (goto-char (point-max))
691 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
692 (let (lv-point (prefix "") (suffix ""))
693 (when (let ((case-fold-search t))
694 (search-forward "Local Variables:" nil t))
695 (setq lv-point (point))
696 ;; The prefix is what comes before "local variables:" in its line.
697 ;; The suffix is what comes after "local variables:" in its line.
698 (skip-chars-forward " \t")
699 (or (eolp)
700 (setq suffix (buffer-substring (point)
701 (progn (end-of-line) (point)))))
702 (goto-char (match-beginning 0))
703 (or (bolp)
704 (setq prefix
705 (buffer-substring (point)
706 (progn (beginning-of-line) (point)))))
707
708 (while (search-forward-regexp
709 (concat "^[ \t]*"
710 (regexp-quote prefix)
711 "\\(mode\\|eval\\):.*"
712 (regexp-quote suffix)
713 "$")
714 nil t)
5c4c911a
AM
715 (forward-line 0)
716 (delete-region (point) (progn (forward-line) (point)))))
cb694ab7
AM
717
718 ;; Delete the first line, if we've got one, in case it contains a mode spec.
719 (unless (and lv-point
720 (progn (goto-char lv-point)
721 (forward-line 0)
722 (bobp)))
723 (goto-char (point-min))
5c4c911a
AM
724 (unless (eobp)
725 (delete-region (point) (progn (forward-line) (point)))))))
cb694ab7 726
130c507e 727(defun c-postprocess-file-styles ()
d9e94c22 728 "Function that post processes relevant file local variables in CC Mode.
130c507e
GM
729Currently, this function simply applies any style and offset settings
730found in the file's Local Variable list. It first applies any style
731setting found in `c-file-style', then it applies any offset settings
732it finds in `c-file-offsets'.
733
734Note that the style variables are always made local to the buffer."
d9e94c22 735
130c507e 736 ;; apply file styles and offsets
09f90d2c
RS
737 (when c-buffer-is-cc-mode
738 (if (or c-file-style c-file-offsets)
739 (c-make-styles-buffer-local t))
c5fcadd1
AM
740 (when c-file-style
741 (or (stringp c-file-style)
742 (error "c-file-style is not a string"))
743 (c-set-style c-file-style))
b9a6ed29 744
09f90d2c 745 (and c-file-offsets
d61ca8d5 746 (mapc
09f90d2c
RS
747 (lambda (langentry)
748 (let ((langelem (car langentry))
749 (offset (cdr langentry)))
750 (c-set-offset langelem offset)))
0386b551
AM
751 c-file-offsets))
752 ;; Problem: The file local variable block might have explicitly set a
753 ;; style variable. The `c-set-style' or `mapcar' call might have
754 ;; overwritten this. So we run `hack-local-variables' again to remedy
755 ;; this. There are no guarantees this will work properly, particularly as
756 ;; we have no control over what the other hook functions on
cb694ab7
AM
757 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
758 ;; any `eval' or `mode' expressions before we evaluate again (see below).
759 ;; ACM, 2005/11/2.
760 ;;
761 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
762 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
763 ;; We prevent this by temporarily removing `mode' from the Local Variables
764 ;; section.
0386b551 765 (if (or c-file-style c-file-offsets)
51c9af45
AM
766 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
767 (c-tentative-buffer-changes
cb694ab7
AM
768 (c-remove-any-local-eval-or-mode-variables)
769 (hack-local-variables))
770 nil))))
130c507e 771
a36abf0e
CY
772(if (boundp 'before-hack-local-variables-hook)
773 (add-hook 'before-hack-local-variables-hook 'c-before-hack-hook)
774 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles))
130c507e 775
3efc2cd7
MS
776(defmacro c-run-mode-hooks (&rest hooks)
777 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
778 ;; require the use of the new function `run-mode-hooks'.
779 (if (cc-bytecomp-fboundp 'run-mode-hooks)
780 `(run-mode-hooks ,@hooks)
781 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
782
130c507e 783\f
1d1e4868
AM
784;;; Change hooks, linking with Font Lock.
785
786;; Buffer local variables defining the region to be fontified by a font lock
787;; after-change function. They are set in c-after-change to
788;; after-change-function's BEG and END, and may be modified by a
789;; `c-before-font-lock-function'.
790(defvar c-new-BEG 0)
791(make-variable-buffer-local 'c-new-BEG)
792(defvar c-new-END 0)
793(make-variable-buffer-local 'c-new-END)
794
795;; Buffer local variables recording Beginning/End-of-Macro position before a
796;; change, when a macro straddles, respectively, the BEG or END (or both) of
797;; the change region. Otherwise these have the values BEG/END.
798(defvar c-old-BOM 0)
799(make-variable-buffer-local 'c-old-BOM)
800(defvar c-old-EOM 0)
801(make-variable-buffer-local 'c-old-EOM)
802
803(defun c-extend-region-for-CPP (beg end)
f8016ed6
AM
804 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
805 ;; beginning/end of any preprocessor construct they may be in.
1d1e4868
AM
806 ;;
807 ;; Point is undefined both before and after this function call; the buffer
808 ;; has already been widened, and match-data saved. The return value is
809 ;; meaningless.
810 ;;
811 ;; This function is the C/C++/ObjC value of
812 ;; `c-get-state-before-change-function' and is called exclusively as a
813 ;; before change function.
814 (goto-char beg)
815 (c-beginning-of-macro)
816 (setq c-old-BOM (point))
817
818 (goto-char end)
f8016ed6
AM
819 (if (c-beginning-of-macro)
820 (c-end-of-macro))
821 (setq c-old-EOM (point)))
1d1e4868
AM
822
823(defun c-neutralize-CPP-line (beg end)
c5fcadd1
AM
824 ;; BEG and END bound a region, typically a preprocessor line. Put a
825 ;; "punctuation" syntax-table property on syntactically obtrusive
826 ;; characters, ones which would interact syntactically with stuff outside
827 ;; this region.
1d1e4868
AM
828 ;;
829 ;; These are unmatched string delimiters, or unmatched
830 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
831 ;; obtrusive.
c5fcadd1
AM
832 (save-excursion
833 (let (s)
834 (while
835 (progn
836 (setq s (parse-partial-sexp beg end -1))
837 (cond
838 ((< (nth 0 s) 0) ; found an unmated ),},]
839 (c-put-char-property (1- (point)) 'syntax-table '(1))
840 t)
841 ((nth 3 s) ; In a string
842 (c-put-char-property (nth 8 s) 'syntax-table '(1))
843 t)
844 ((> (nth 0 s) 0) ; In a (,{,[
845 (c-put-char-property (nth 1 s) 'syntax-table '(1))
846 t)
847 (t nil)))))))
1d1e4868
AM
848
849(defun c-neutralize-syntax-in-CPP (begg endd old-len)
850 ;; "Neutralize" every preprocessor line wholly or partially in the changed
851 ;; region. "Restore" lines which were CPP lines before the change and are
852 ;; no longer so; these can be located from the Buffer local variables
853 ;; c-old-[EB]OM.
854 ;;
855 ;; That is, set syntax-table properties on characters that would otherwise
856 ;; interact syntactically with those outside the CPP line(s).
857 ;;
858 ;; This function is called from an after-change function, BEGG ENDD and
859 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
860 ;; locking, hence must get called before `font-lock-after-change-function'.
861 ;;
862 ;; Point is undefined both before and after this function call, the buffer
863 ;; has been widened, and match-data saved. The return value is ignored.
864 ;;
865 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
866 ;;
c5fcadd1
AM
867 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
868 ;;
869 ;; This function might make hidden buffer changes.
f18ea992 870 (c-save-buffer-state (limits mbeg+1 beg end)
c5fcadd1
AM
871 ;; First determine the region, (beg end), which may need "neutralizing".
872 ;; This may not start inside a string, comment, or macro.
873 (goto-char c-old-BOM) ; already set to old start of macro or begg.
874 (setq beg
875 (if (setq limits (c-literal-limits))
876 (cdr limits) ; go forward out of any string or comment.
877 (point)))
878
1d1e4868 879 (goto-char endd)
c5fcadd1
AM
880 (if (setq limits (c-literal-limits))
881 (goto-char (car limits))) ; go backward out of any string or comment.
882 (if (c-beginning-of-macro)
883 (c-end-of-macro))
1d1e4868
AM
884 (setq end (max (+ (- c-old-EOM old-len) (- endd begg))
885 (point)))
c5fcadd1 886
1d1e4868
AM
887 ;; Clear all old punctuation properties
888 (c-clear-char-property-with-value beg end 'syntax-table '(1))
889
890 (goto-char beg)
c5fcadd1
AM
891 (let ((pps-position beg) pps-state)
892 (while (and (< (point) end)
893 (search-forward-regexp c-anchored-cpp-prefix end t))
894 ;; If we've found a "#" inside a string/comment, ignore it.
895 (setq pps-state
896 (parse-partial-sexp pps-position (point) nil nil pps-state)
897 pps-position (point))
898 (unless (or (nth 3 pps-state) ; in a string?
899 (nth 4 pps-state)) ; in a comment?
900 (setq mbeg+1 (point))
901 (c-end-of-macro) ; Do we need to go forward 1 char here? No!
902 (c-neutralize-CPP-line mbeg+1 (point))
903 (setq pps-position (point))))))) ; no need to update pps-state.
1d1e4868
AM
904
905(defun c-before-change (beg end)
906 ;; Function to be put on `before-change-function'. Primarily, this calls
907 ;; the language dependent `c-get-state-before-change-function'. It is
908 ;; otherwise used only to remove stale entries from the `c-found-types'
909 ;; cache, and to record entries which a `c-after-change' function might
910 ;; confirm as stale.
911 ;;
912 ;; Note that this function must be FAST rather than accurate. Note
913 ;; also that it only has any effect when font locking is enabled.
914 ;; We exploit this by checking for font-lock-*-face instead of doing
915 ;; rigourous syntactic analysis.
916
917 ;; If either change boundary is wholly inside an identifier, delete
918 ;; it/them from the cache. Don't worry about being inside a string
919 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
920 ;; isn't critical.
921 (setq c-maybe-stale-found-type nil)
922 (save-restriction
923 (save-match-data
924 (widen)
925 (save-excursion
926 ;; Are we inserting/deleting stuff in the middle of an identifier?
927 (c-unfind-enclosing-token beg)
928 (c-unfind-enclosing-token end)
929 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
930 (when (< beg end)
931 (c-unfind-coalesced-tokens beg end))
932 ;; Are we (potentially) disrupting the syntactic context which
933 ;; makes a type a type? E.g. by inserting stuff after "foo" in
934 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
935 ;;
936 ;; We search for appropriate c-type properties "near" the change.
937 ;; First, find an appropriate boundary for this property search.
938 (let (lim
939 type type-pos
940 marked-id term-pos
941 (end1
942 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
943 (previous-single-property-change end 'face))
944 end)))
945 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
946 ;; Find a limit for the search for a `c-type' property
947 (while
948 (and (/= (skip-chars-backward "^;{}") 0)
949 (> (point) (point-min))
950 (memq (c-get-char-property (1- (point)) 'face)
951 '(font-lock-comment-face font-lock-string-face))))
952 (setq lim (max (point-min) (1- (point))))
953
954 ;; Look for the latest `c-type' property before end1
955 (when (and (> end1 (point-min))
956 (setq type-pos
957 (if (get-text-property (1- end1) 'c-type)
958 end1
959 (previous-single-property-change end1 'c-type nil lim))))
960 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
961
962 (when (memq type '(c-decl-id-start c-decl-type-start))
963 ;; Get the identifier, if any, that the property is on.
964 (goto-char (1- type-pos))
965 (setq marked-id
966 (when (looking-at "\\(\\sw\\|\\s_\\)")
967 (c-beginning-of-current-token)
968 (buffer-substring-no-properties (point) type-pos)))
969
970 (goto-char end1)
971 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
972 (setq lim (point))
973 (setq term-pos
974 (or (next-single-property-change end 'c-type nil lim) lim))
975 (setq c-maybe-stale-found-type
976 (list type marked-id
977 type-pos term-pos
978 (buffer-substring-no-properties type-pos term-pos)
979 (buffer-substring-no-properties beg end)))))))
980
981 (setq c-new-BEG beg
982 c-new-END end)
983 (if c-get-state-before-change-function
984 (funcall c-get-state-before-change-function beg end))
985 ))))
986
987(defun c-after-change (beg end old-len)
988 ;; Function put on `after-change-functions' to adjust various caches
989 ;; etc. Prefer speed to finesse here, since there will be an order
990 ;; of magnitude more calls to this function than any of the
991 ;; functions that use the caches.
992 ;;
993 ;; Note that care must be taken so that this is called before any
994 ;; font-lock callbacks since we might get calls to functions using
995 ;; these caches from inside them, and we must thus be sure that this
996 ;; has already been executed.
997 ;;
998 ;; This calls the language variable c-before-font-lock-function, if non nil.
999 ;; This typically sets `syntax-table' properties.
1000
1001 (c-save-buffer-state ()
1002 ;; When `combine-after-change-calls' is used we might get calls
1003 ;; with regions outside the current narrowing. This has been
1004 ;; observed in Emacs 20.7.
1005 (save-restriction
1006 (save-match-data ; c-recognize-<>-arglists changes match-data
1007 (widen)
1008
1009 (when (> end (point-max))
1010 ;; Some emacsen might return positions past the end. This has been
1011 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1012 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1013 ;; work).
1014 (setq end (point-max))
1015 (when (> beg end)
1016 (setq beg end)))
1017
1018 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1019 (c-invalidate-sws-region-after beg end)
1020 (c-invalidate-state-cache beg)
1021 (c-invalidate-find-decl-cache beg)
1022
1023 (when c-recognize-<>-arglists
1024 (c-after-change-check-<>-operators beg end))
1025
1026 (if c-before-font-lock-function
1027 (save-excursion
1028 (funcall c-before-font-lock-function beg end old-len)))))))
1029
1030(defun c-after-font-lock-init ()
1031 ;; Put on `font-lock-mode-hook'.
1032 (remove-hook 'after-change-functions 'c-after-change t)
1033 (add-hook 'after-change-functions 'c-after-change nil t))
1034
1035(defun c-font-lock-init ()
1036 "Set up the font-lock variables for using the font-lock support in CC Mode.
1037This does not load the font-lock package. Use after
1038`c-basic-common-init' and after cc-fonts has been loaded."
1039
1040 (make-local-variable 'font-lock-defaults)
1041 (setq font-lock-defaults
1042 `(,(if (c-major-mode-is 'awk-mode)
1043 ;; awk-mode currently has only one font lock level.
1044 'awk-font-lock-keywords
1045 (mapcar 'c-mode-symbol
1046 '("font-lock-keywords" "font-lock-keywords-1"
1047 "font-lock-keywords-2" "font-lock-keywords-3")))
1048 nil nil
1049 ,c-identifier-syntax-modifications
1050 c-beginning-of-syntax
1051 (font-lock-lines-before . 1)
1052 (font-lock-mark-block-function
1053 . c-mark-function)))
1054
1055 (make-local-hook 'font-lock-mode-hook)
1056 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1057
8714fc18
AM
1058(defun c-extend-after-change-region (beg end old-len)
1059 "Extend the region to be fontified, if necessary."
1060 ;; Note: the parameters are ignored here. This somewhat indirect
1061 ;; implementation exists because it is minimally different from the
1062 ;; stand-alone CC Mode which, lacking
1063 ;; font-lock-extend-after-change-region-function, is forced to use advice
1064 ;; instead.
1065 ;;
1066 ;; Of the seven CC Mode languages, currently (2008-04) only AWK Mode makes
1067 ;; non-null use of this function.
1068 (cons c-new-BEG c-new-END))
1d1e4868
AM
1069
1070\f
130c507e
GM
1071;; Support for C
1072
d9e94c22
MS
1073;;;###autoload
1074(defvar c-mode-syntax-table nil
1075 "Syntax table used in c-mode buffers.")
1076(or c-mode-syntax-table
1077 (setq c-mode-syntax-table
1078 (funcall (c-lang-const c-make-mode-syntax-table c))))
1079
130c507e
GM
1080(defvar c-mode-abbrev-table nil
1081 "Abbreviation table used in c-mode buffers.")
a66cd3ee
MS
1082(c-define-abbrev-table 'c-mode-abbrev-table
1083 '(("else" "else" c-electric-continued-statement 0)
1084 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1085
1086(defvar c-mode-map ()
1087 "Keymap used in c-mode buffers.")
1088(if c-mode-map
1089 nil
1090 (setq c-mode-map (c-make-inherited-keymap))
1091 ;; add bindings which are only useful for C
1092 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1093 )
1094
1095(easy-menu-define c-c-menu c-mode-map "C Mode Commands"
d9e94c22
MS
1096 (cons "C" (c-lang-const c-mode-menu c)))
1097
1098;; In XEmacs >= 21.5 modes should add their own entries to
1099;; `auto-mode-alist'. The comment form of autoload is used to avoid
1100;; doing this on load. That since `add-to-list' prepends the value
1101;; which could cause it to clobber user settings. Later emacsen have
1102;; an append option, but it's not safe to use.
50fdde0e
MS
1103
1104;; The the extension ".C" is associated to C++ while the lowercase
1105;; variant goes to C. On case insensitive file systems, this means
1106;; that ".c" files also might open C++ mode if the C++ entry comes
1107;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1108;; after ".c", and since `add-to-list' adds the entry first we have to
1109;; add the ".C" entry first.
1110;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1111;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1112;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1113
d9e94c22
MS
1114;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1115
1116;; NB: The following two associate yacc and lex files to C Mode, which
1117;; is not really suitable for those formats. Anyway, afaik there's
1118;; currently no better mode for them, and besides this is legacy.
1119;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1120;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1121
f63b48bb
DN
1122;; Preprocessed files generated by C and C++ compilers.
1123;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1124;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1125
1126
785eecbb
RS
1127;;;###autoload
1128(defun c-mode ()
1129 "Major mode for editing K&R and ANSI C code.
1130To submit a problem report, enter `\\[c-submit-bug-report]' from a
1131c-mode buffer. This automatically sets up a mail buffer with version
1132information already added. You just need to add a description of the
50fdde0e 1133problem, including a reproducible test case, and send the message.
785eecbb
RS
1134
1135To see what version of CC Mode you are running, enter `\\[c-version]'.
1136
d9e94c22
MS
1137The hook `c-mode-common-hook' is run with no args at mode
1138initialization, then `c-mode-hook'.
785eecbb
RS
1139
1140Key bindings:
1141\\{c-mode-map}"
1142 (interactive)
785eecbb 1143 (kill-all-local-variables)
d9e94c22 1144 (c-initialize-cc-mode t)
785eecbb
RS
1145 (set-syntax-table c-mode-syntax-table)
1146 (setq major-mode 'c-mode
1147 mode-name "C"
130c507e
GM
1148 local-abbrev-table c-mode-abbrev-table
1149 abbrev-mode t)
785eecbb 1150 (use-local-map c-mode-map)
28d88c16 1151 (c-init-language-vars-for 'c-mode)
a66cd3ee 1152 (c-common-init 'c-mode)
d9e94c22 1153 (easy-menu-add c-c-menu)
51f606de 1154 (cc-imenu-init cc-imenu-c-generic-expression)
3efc2cd7 1155 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
785eecbb
RS
1156 (c-update-modeline))
1157
1158\f
130c507e
GM
1159;; Support for C++
1160
d9e94c22
MS
1161;;;###autoload
1162(defvar c++-mode-syntax-table nil
1163 "Syntax table used in c++-mode buffers.")
1164(or c++-mode-syntax-table
1165 (setq c++-mode-syntax-table
1166 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1167
130c507e
GM
1168(defvar c++-mode-abbrev-table nil
1169 "Abbreviation table used in c++-mode buffers.")
a66cd3ee
MS
1170(c-define-abbrev-table 'c++-mode-abbrev-table
1171 '(("else" "else" c-electric-continued-statement 0)
1172 ("while" "while" c-electric-continued-statement 0)
1173 ("catch" "catch" c-electric-continued-statement 0)))
130c507e
GM
1174
1175(defvar c++-mode-map ()
1176 "Keymap used in c++-mode buffers.")
1177(if c++-mode-map
1178 nil
1179 (setq c++-mode-map (c-make-inherited-keymap))
1180 ;; add bindings which are only useful for C++
1181 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1182 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1183 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1184 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1185
1186(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
d9e94c22
MS
1187 (cons "C++" (c-lang-const c-mode-menu c++)))
1188
785eecbb
RS
1189;;;###autoload
1190(defun c++-mode ()
1191 "Major mode for editing C++ code.
1192To submit a problem report, enter `\\[c-submit-bug-report]' from a
1193c++-mode buffer. This automatically sets up a mail buffer with
1194version information already added. You just need to add a description
1195of the problem, including a reproducible test case, and send the
1196message.
1197
1198To see what version of CC Mode you are running, enter `\\[c-version]'.
1199
d9e94c22
MS
1200The hook `c-mode-common-hook' is run with no args at mode
1201initialization, then `c++-mode-hook'.
785eecbb
RS
1202
1203Key bindings:
1204\\{c++-mode-map}"
1205 (interactive)
785eecbb 1206 (kill-all-local-variables)
d9e94c22 1207 (c-initialize-cc-mode t)
785eecbb
RS
1208 (set-syntax-table c++-mode-syntax-table)
1209 (setq major-mode 'c++-mode
1210 mode-name "C++"
130c507e
GM
1211 local-abbrev-table c++-mode-abbrev-table
1212 abbrev-mode t)
785eecbb 1213 (use-local-map c++-mode-map)
28d88c16 1214 (c-init-language-vars-for 'c++-mode)
a66cd3ee 1215 (c-common-init 'c++-mode)
d9e94c22 1216 (easy-menu-add c-c++-menu)
51f606de 1217 (cc-imenu-init cc-imenu-c++-generic-expression)
3efc2cd7 1218 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
785eecbb
RS
1219 (c-update-modeline))
1220
1221\f
130c507e
GM
1222;; Support for Objective-C
1223
d9e94c22
MS
1224;;;###autoload
1225(defvar objc-mode-syntax-table nil
1226 "Syntax table used in objc-mode buffers.")
1227(or objc-mode-syntax-table
1228 (setq objc-mode-syntax-table
1229 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1230
130c507e
GM
1231(defvar objc-mode-abbrev-table nil
1232 "Abbreviation table used in objc-mode buffers.")
a66cd3ee
MS
1233(c-define-abbrev-table 'objc-mode-abbrev-table
1234 '(("else" "else" c-electric-continued-statement 0)
1235 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1236
1237(defvar objc-mode-map ()
1238 "Keymap used in objc-mode buffers.")
1239(if objc-mode-map
1240 nil
1241 (setq objc-mode-map (c-make-inherited-keymap))
1242 ;; add bindings which are only useful for Objective-C
1243 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1244
1245(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
d9e94c22
MS
1246 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1247
1248;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
130c507e 1249
785eecbb
RS
1250;;;###autoload
1251(defun objc-mode ()
1252 "Major mode for editing Objective C code.
1253To submit a problem report, enter `\\[c-submit-bug-report]' from an
1254objc-mode buffer. This automatically sets up a mail buffer with
1255version information already added. You just need to add a description
1256of the problem, including a reproducible test case, and send the
1257message.
1258
1259To see what version of CC Mode you are running, enter `\\[c-version]'.
1260
d9e94c22
MS
1261The hook `c-mode-common-hook' is run with no args at mode
1262initialization, then `objc-mode-hook'.
785eecbb
RS
1263
1264Key bindings:
1265\\{objc-mode-map}"
1266 (interactive)
785eecbb 1267 (kill-all-local-variables)
d9e94c22 1268 (c-initialize-cc-mode t)
785eecbb
RS
1269 (set-syntax-table objc-mode-syntax-table)
1270 (setq major-mode 'objc-mode
1271 mode-name "ObjC"
130c507e
GM
1272 local-abbrev-table objc-mode-abbrev-table
1273 abbrev-mode t)
785eecbb 1274 (use-local-map objc-mode-map)
28d88c16 1275 (c-init-language-vars-for 'objc-mode)
a66cd3ee 1276 (c-common-init 'objc-mode)
d9e94c22
MS
1277 (easy-menu-add c-objc-menu)
1278 (cc-imenu-init nil 'cc-imenu-objc-function)
3efc2cd7 1279 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
785eecbb
RS
1280 (c-update-modeline))
1281
1282\f
130c507e
GM
1283;; Support for Java
1284
d9e94c22
MS
1285;;;###autoload
1286(defvar java-mode-syntax-table nil
1287 "Syntax table used in java-mode buffers.")
1288(or java-mode-syntax-table
1289 (setq java-mode-syntax-table
1290 (funcall (c-lang-const c-make-mode-syntax-table java))))
1291
130c507e
GM
1292(defvar java-mode-abbrev-table nil
1293 "Abbreviation table used in java-mode buffers.")
a66cd3ee
MS
1294(c-define-abbrev-table 'java-mode-abbrev-table
1295 '(("else" "else" c-electric-continued-statement 0)
1296 ("while" "while" c-electric-continued-statement 0)
1297 ("catch" "catch" c-electric-continued-statement 0)
1298 ("finally" "finally" c-electric-continued-statement 0)))
130c507e
GM
1299
1300(defvar java-mode-map ()
1301 "Keymap used in java-mode buffers.")
1302(if java-mode-map
1303 nil
1304 (setq java-mode-map (c-make-inherited-keymap))
1305 ;; add bindings which are only useful for Java
1306 )
1307
d9e94c22
MS
1308;; Regexp trying to describe the beginning of a Java top-level
1309;; definition. This is not used by CC Mode, nor is it maintained
1310;; since it's practically impossible to write a regexp that reliably
1311;; matches such a construct. Other tools are necessary.
1312(defconst c-Java-defun-prompt-regexp
1313 "^[ \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-*")
1314
130c507e 1315(easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
d9e94c22
MS
1316 (cons "Java" (c-lang-const c-mode-menu java)))
1317
1318;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
130c507e 1319
785eecbb
RS
1320;;;###autoload
1321(defun java-mode ()
1322 "Major mode for editing Java code.
dc2b4c5f 1323To submit a problem report, enter `\\[c-submit-bug-report]' from a
785eecbb
RS
1324java-mode buffer. This automatically sets up a mail buffer with
1325version information already added. You just need to add a description
50fdde0e 1326of the problem, including a reproducible test case, and send the
785eecbb
RS
1327message.
1328
1329To see what version of CC Mode you are running, enter `\\[c-version]'.
1330
d9e94c22
MS
1331The hook `c-mode-common-hook' is run with no args at mode
1332initialization, then `java-mode-hook'.
785eecbb
RS
1333
1334Key bindings:
1335\\{java-mode-map}"
1336 (interactive)
785eecbb 1337 (kill-all-local-variables)
d9e94c22 1338 (c-initialize-cc-mode t)
785eecbb
RS
1339 (set-syntax-table java-mode-syntax-table)
1340 (setq major-mode 'java-mode
1341 mode-name "Java"
91b807c9 1342 local-abbrev-table java-mode-abbrev-table
a66cd3ee 1343 abbrev-mode t)
785eecbb 1344 (use-local-map java-mode-map)
28d88c16 1345 (c-init-language-vars-for 'java-mode)
a66cd3ee 1346 (c-common-init 'java-mode)
d9e94c22 1347 (easy-menu-add c-java-menu)
51f606de 1348 (cc-imenu-init cc-imenu-java-generic-expression)
3efc2cd7 1349 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
785eecbb
RS
1350 (c-update-modeline))
1351
1352\f
130c507e
GM
1353;; Support for CORBA's IDL language
1354
d9e94c22
MS
1355;;;###autoload
1356(defvar idl-mode-syntax-table nil
1357 "Syntax table used in idl-mode buffers.")
1358(or idl-mode-syntax-table
1359 (setq idl-mode-syntax-table
1360 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1361
130c507e
GM
1362(defvar idl-mode-abbrev-table nil
1363 "Abbreviation table used in idl-mode buffers.")
a66cd3ee 1364(c-define-abbrev-table 'idl-mode-abbrev-table nil)
130c507e
GM
1365
1366(defvar idl-mode-map ()
1367 "Keymap used in idl-mode buffers.")
1368(if idl-mode-map
1369 nil
1370 (setq idl-mode-map (c-make-inherited-keymap))
1371 ;; add bindings which are only useful for IDL
1372 )
1373
1374(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
d9e94c22
MS
1375 (cons "IDL" (c-lang-const c-mode-menu idl)))
1376
1377;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
130c507e 1378
aac90c52
RS
1379;;;###autoload
1380(defun idl-mode ()
d9e94c22 1381 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
aac90c52
RS
1382To submit a problem report, enter `\\[c-submit-bug-report]' from an
1383idl-mode buffer. This automatically sets up a mail buffer with
1384version information already added. You just need to add a description
1385of the problem, including a reproducible test case, and send the
1386message.
1387
1388To see what version of CC Mode you are running, enter `\\[c-version]'.
1389
d9e94c22
MS
1390The hook `c-mode-common-hook' is run with no args at mode
1391initialization, then `idl-mode-hook'.
aac90c52
RS
1392
1393Key bindings:
1394\\{idl-mode-map}"
1395 (interactive)
aac90c52 1396 (kill-all-local-variables)
d9e94c22 1397 (c-initialize-cc-mode t)
aac90c52
RS
1398 (set-syntax-table idl-mode-syntax-table)
1399 (setq major-mode 'idl-mode
1400 mode-name "IDL"
1401 local-abbrev-table idl-mode-abbrev-table)
1402 (use-local-map idl-mode-map)
28d88c16 1403 (c-init-language-vars-for 'idl-mode)
a66cd3ee 1404 (c-common-init 'idl-mode)
d9e94c22
MS
1405 (easy-menu-add c-idl-menu)
1406 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
3efc2cd7 1407 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
aac90c52
RS
1408 (c-update-modeline))
1409
1410\f
130c507e
GM
1411;; Support for Pike
1412
d9e94c22
MS
1413;;;###autoload
1414(defvar pike-mode-syntax-table nil
1415 "Syntax table used in pike-mode buffers.")
1416(or pike-mode-syntax-table
1417 (setq pike-mode-syntax-table
1418 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1419
130c507e
GM
1420(defvar pike-mode-abbrev-table nil
1421 "Abbreviation table used in pike-mode buffers.")
a66cd3ee
MS
1422(c-define-abbrev-table 'pike-mode-abbrev-table
1423 '(("else" "else" c-electric-continued-statement 0)
1424 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1425
1426(defvar pike-mode-map ()
1427 "Keymap used in pike-mode buffers.")
1428(if pike-mode-map
1429 nil
1430 (setq pike-mode-map (c-make-inherited-keymap))
1431 ;; additional bindings
1432 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1433
1434(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
d9e94c22
MS
1435 (cons "Pike" (c-lang-const c-mode-menu pike)))
1436
50fdde0e
MS
1437;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1438;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
130c507e 1439
0ec8351b
BW
1440;;;###autoload
1441(defun pike-mode ()
1442 "Major mode for editing Pike code.
a66cd3ee
MS
1443To submit a problem report, enter `\\[c-submit-bug-report]' from a
1444pike-mode buffer. This automatically sets up a mail buffer with
0ec8351b
BW
1445version information already added. You just need to add a description
1446of the problem, including a reproducible test case, and send the
1447message.
1448
1449To see what version of CC Mode you are running, enter `\\[c-version]'.
1450
d9e94c22
MS
1451The hook `c-mode-common-hook' is run with no args at mode
1452initialization, then `pike-mode-hook'.
0ec8351b
BW
1453
1454Key bindings:
1455\\{pike-mode-map}"
1456 (interactive)
0ec8351b 1457 (kill-all-local-variables)
d9e94c22 1458 (c-initialize-cc-mode t)
0ec8351b
BW
1459 (set-syntax-table pike-mode-syntax-table)
1460 (setq major-mode 'pike-mode
1461 mode-name "Pike"
130c507e 1462 local-abbrev-table pike-mode-abbrev-table
a66cd3ee 1463 abbrev-mode t)
0ec8351b 1464 (use-local-map pike-mode-map)
28d88c16 1465 (c-init-language-vars-for 'pike-mode)
a66cd3ee 1466 (c-common-init 'pike-mode)
d9e94c22
MS
1467 (easy-menu-add c-pike-menu)
1468 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
3efc2cd7 1469 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
0ec8351b
BW
1470 (c-update-modeline))
1471
1472\f
0386b551 1473;; Support for AWK
d9e94c22 1474
50fdde0e
MS
1475;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1476;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1477;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1478;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1479;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
d9e94c22 1480
50fdde0e
MS
1481;;; Autoload directives must be on the top level, so we construct an
1482;;; autoload form instead.
791887d9 1483;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
50fdde0e 1484
0386b551
AM
1485(defvar awk-mode-abbrev-table nil
1486 "Abbreviation table used in awk-mode buffers.")
1487(c-define-abbrev-table 'awk-mode-abbrev-table
1488 '(("else" "else" c-electric-continued-statement 0)
1489 ("while" "while" c-electric-continued-statement 0)))
1490
1491(defvar awk-mode-map ()
1492 "Keymap used in awk-mode buffers.")
1493(if awk-mode-map
1494 nil
1495 (setq awk-mode-map (c-make-inherited-keymap))
1496 ;; add bindings which are only useful for awk.
1497 (define-key awk-mode-map "#" 'self-insert-command)
1498 (define-key awk-mode-map "/" 'self-insert-command)
1499 (define-key awk-mode-map "*" 'self-insert-command)
1500 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1501 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1502 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1503 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1504 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1505 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1506 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1507
1508(easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1509 (cons "AWK" (c-lang-const c-mode-menu awk)))
1510
ae500c1a
GM
1511;; (require 'cc-awk) brings these in.
1512(defvar awk-mode-syntax-table)
1513(declare-function c-awk-unstick-NL-prop "cc-awk" ())
1514
0386b551
AM
1515(defun awk-mode ()
1516 "Major mode for editing AWK code.
d9e94c22
MS
1517To submit a problem report, enter `\\[c-submit-bug-report]' from an
1518awk-mode buffer. This automatically sets up a mail buffer with version
1519information already added. You just need to add a description of the
50fdde0e 1520problem, including a reproducible test case, and send the message.
d9e94c22
MS
1521
1522To see what version of CC Mode you are running, enter `\\[c-version]'.
1523
1524The hook `c-mode-common-hook' is run with no args at mode
1525initialization, then `awk-mode-hook'.
1526
1527Key bindings:
1528\\{awk-mode-map}"
0386b551
AM
1529 (interactive)
1530 (require 'cc-awk) ; Added 2003/6/10.
1531 (kill-all-local-variables)
1532 (c-initialize-cc-mode t)
1533 (set-syntax-table awk-mode-syntax-table)
1534 (setq major-mode 'awk-mode
1535 mode-name "AWK"
1536 local-abbrev-table awk-mode-abbrev-table
1537 abbrev-mode t)
1538 (use-local-map awk-mode-map)
1539 (c-init-language-vars-for 'awk-mode)
1540 (c-common-init 'awk-mode)
0386b551 1541 (c-awk-unstick-NL-prop)
0386b551
AM
1542
1543 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1544 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1545 (defalias 'c-in-literal 'c-slow-in-literal)
1546
1547 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1548 (c-update-modeline))
d9e94c22
MS
1549
1550\f
c2efc1d0 1551;; bug reporting
785eecbb
RS
1552
1553(defconst c-mode-help-address
a66cd3ee
MS
1554 "bug-cc-mode@gnu.org"
1555 "Address(es) for CC Mode bug reports.")
785eecbb
RS
1556
1557(defun c-version ()
1558 "Echo the current version of CC Mode in the minibuffer."
1559 (interactive)
1560 (message "Using CC Mode version %s" c-version)
1561 (c-keep-region-active))
1562
130c507e
GM
1563(defvar c-prepare-bug-report-hooks nil)
1564
1565;; Dynamic variables used by reporter.
1566(defvar reporter-prompt-for-summary-p)
1567(defvar reporter-dont-compact-list)
1568
785eecbb
RS
1569(defun c-submit-bug-report ()
1570 "Submit via mail a bug report on CC Mode."
1571 (interactive)
77e31a8d 1572 (require 'reporter)
785eecbb
RS
1573 ;; load in reporter
1574 (let ((reporter-prompt-for-summary-p t)
1575 (reporter-dont-compact-list '(c-offsets-alist))
1576 (style c-indentation-style)
785eecbb
RS
1577 (c-features c-emacs-features))
1578 (and
1579 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1580 t (message "") nil)
785eecbb
RS
1581 (reporter-submit-bug-report
1582 c-mode-help-address
d9e94c22 1583 (concat "CC Mode " c-version " (" mode-name ")")
51f606de 1584 (let ((vars (append
51f606de 1585 c-style-variables
d9e94c22 1586 '(c-buffer-is-cc-mode
51f606de 1587 c-tab-always-indent
d9e94c22
MS
1588 c-syntactic-indentation
1589 c-syntactic-indentation-in-macros
1590 c-ignore-auto-fill
1591 c-auto-align-backslashes
1592 c-backspace-function
1593 c-delete-function
1594 c-electric-pound-behavior
1595 c-default-style
1596 c-enable-xemacs-performance-kludge-p
1597 c-old-style-variable-behavior
51f606de
GM
1598 defun-prompt-regexp
1599 tab-width
1600 comment-column
1601 parse-sexp-ignore-comments
d9e94c22
MS
1602 parse-sexp-lookup-properties
1603 lookup-syntax-properties
51f606de
GM
1604 ;; A brain-damaged XEmacs only variable that, if
1605 ;; set to nil can cause all kinds of chaos.
1606 signal-error-on-buffer-boundary
1607 ;; Variables that affect line breaking and comments.
d9e94c22 1608 auto-fill-mode
91b807c9 1609 auto-fill-function
51f606de
GM
1610 filladapt-mode
1611 comment-multi-line
1612 comment-start-skip
1613 fill-prefix
d9e94c22 1614 fill-column
51f606de
GM
1615 paragraph-start
1616 adaptive-fill-mode
1617 adaptive-fill-regexp)
1618 nil)))
d61ca8d5
GM
1619 (mapc (lambda (var) (unless (boundp var)
1620 (setq vars (delq var vars))))
1621 '(signal-error-on-buffer-boundary
1622 filladapt-mode
1623 defun-prompt-regexp
1624 font-lock-mode
1625 font-lock-maximum-decoration
1626 parse-sexp-lookup-properties
1627 lookup-syntax-properties))
51f606de 1628 vars)
9714ec23 1629 (lambda ()
a66cd3ee 1630 (run-hooks 'c-prepare-bug-report-hooks)
d9e94c22 1631 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
a66cd3ee 1632 style c-features)))))))
785eecbb
RS
1633
1634\f
130c507e 1635(cc-provide 'cc-mode)
ab5796a9 1636
cbee283d 1637;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
785eecbb 1638;;; cc-mode.el ends here