Reverse change 2010-02-04T21:15:37Z!acm@muc.de: "Change strategy for marking < and...
[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,
114f9c96 4;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
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.
653d1554 116(autoload 'subword-mode "subword"
0386b551
AM
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 381 ;; (define-key c-mode-base-map "\C-c\C-y" 'c-toggle-hungry-state) Commented out by ACM, 2005-11-22.
653d1554 382 (define-key c-mode-base-map "\C-c\C-w" '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.
0ec1d2c5 413;;
9c184ed2
AM
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
0ec1d2c5 454;; changed where an element of `found-types' might become stale. It
9c184ed2
AM
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
0ec1d2c5 458;;
9c184ed2
AM
459;; o - `c-decl-id-start' is the c-type text property value at buffer
460;; pos 96.
0ec1d2c5 461;;
9c184ed2
AM
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.
0ec1d2c5 465;;
9c184ed2
AM
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
0ec1d2c5
AM
520 ;; Initialise the cache of brace pairs, and opening braces/brackets/parens.
521 (c-state-cache-init)
522
0386b551 523 (when (or c-recognize-<>-arglists
1d1e4868
AM
524 (c-major-mode-is 'awk-mode)
525 (c-major-mode-is '(c-mode c++-mode objc-mode)))
0386b551
AM
526 ;; We'll use the syntax-table text property to change the syntax
527 ;; of some chars for this language, so do the necessary setup for
528 ;; that.
529 ;;
530 ;; Note to other package developers: It's ok to turn this on in CC
531 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
532 ;; off if CC Mode has turned it on.
533
534 ;; Emacs.
535 (when (boundp 'parse-sexp-lookup-properties)
536 (make-local-variable 'parse-sexp-lookup-properties)
537 (setq parse-sexp-lookup-properties t))
538
539 ;; Same as above for XEmacs.
540 (when (boundp 'lookup-syntax-properties)
541 (make-local-variable 'lookup-syntax-properties)
542 (setq lookup-syntax-properties t)))
d9e94c22 543
d0fcee66 544 ;; Use this in Emacs 21+ to avoid meddling with the rear-nonsticky
d9e94c22
MS
545 ;; property on each character.
546 (when (boundp 'text-property-default-nonsticky)
547 (make-local-variable 'text-property-default-nonsticky)
d0fcee66
AM
548 (mapc (lambda (tprop)
549 (unless (assq tprop text-property-default-nonsticky)
550 (setq text-property-default-nonsticky
551 (cons `(,tprop . t) text-property-default-nonsticky))))
552 '(syntax-table category c-type)))
d9e94c22
MS
553
554 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
555 ;; heuristic that open parens in column 0 are defun starters. Since
0386b551
AM
556 ;; we have c-state-cache, that heuristic isn't useful and only causes
557 ;; trouble, so turn it off.
99c8496e
AM
558;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
559;; helpful. Comment it out for now.
560;; (when (memq 'col-0-paren c-emacs-features)
561;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
562;; (setq open-paren-in-column-0-is-defun-start nil))
d9e94c22 563
d9e94c22
MS
564 (c-clear-found-types)
565
566 ;; now set the mode style based on default-style
567 (let ((style (if (stringp default-style)
568 default-style
569 (or (cdr (assq mode default-style))
570 (cdr (assq 'other default-style))
130c507e
GM
571 "gnu"))))
572 ;; Override style variables if `c-old-style-variable-behavior' is
573 ;; set. Also override if we are using global style variables,
574 ;; have already initialized a style once, and are switching to a
575 ;; different style. (It's doubtful whether this is desirable, but
576 ;; the whole situation with nonlocal style variables is a bit
577 ;; awkward. It's at least the most compatible way with the old
578 ;; style init procedure.)
579 (c-set-style style (not (or c-old-style-variable-behavior
580 (and (not c-style-variables-are-local-p)
581 c-indentation-style
582 (not (string-equal c-indentation-style
583 style)))))))
a66cd3ee
MS
584 (c-setup-paragraph-variables)
585
130c507e
GM
586 ;; we have to do something special for c-offsets-alist so that the
587 ;; buffer local value has its own alist structure.
588 (setq c-offsets-alist (copy-alist c-offsets-alist))
a66cd3ee 589
130c507e 590 ;; setup the comment indent variable in a Emacs version portable way
130c507e
GM
591 (make-local-variable 'comment-indent-function)
592 (setq comment-indent-function 'c-comment-indent)
a66cd3ee 593
cb694ab7
AM
594;; ;; Put submode indicators onto minor-mode-alist, but only once.
595;; (or (assq 'c-submode-indicators minor-mode-alist)
596;; (setq minor-mode-alist
597;; (cons '(c-submode-indicators c-submode-indicators)
598;; minor-mode-alist)))
599 (c-update-modeline)
a66cd3ee 600
d9e94c22
MS
601 ;; Install the functions that ensure that various internal caches
602 ;; don't become invalid due to buffer changes.
9c184ed2
AM
603 (make-local-hook 'before-change-functions)
604 (add-hook 'before-change-functions 'c-before-change nil t)
0386b551 605 (make-local-hook 'after-change-functions)
8714fc18 606 (add-hook 'after-change-functions 'c-after-change nil t)
7d562742 607 (set (make-local-variable 'font-lock-extend-after-change-region-function)
a0526d5e
AM
608 'c-extend-after-change-region)) ; Currently (2009-05) used by all
609 ; lanaguages with #define (C, C++,; ObjC), and 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
7af4bf3a
AM
644 (if c-get-state-before-change-function
645 (funcall c-get-state-before-change-function (point-min) (point-max)))
1d1e4868
AM
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"))
a3c11552 672 (c-set-style stile))
a36abf0e
CY
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"))
a3c11552 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
7af4bf3a 778 ;; require the use of the new function `run-mode-hooks'.
3efc2cd7
MS
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 ;;
7af4bf3a
AM
811 ;; This function is the C/C++/ObjC value of
812 ;; `c-get-state-before-change-function' and is called exclusively as a
1d1e4868
AM
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 848
0ec1d2c5 849(defun c-neutralize-syntax-in-and-mark-CPP (begg endd old-len)
a0526d5e
AM
850 ;; (i) Extend the font lock region to cover all changed preprocessor
851 ;; regions; it does this by setting the variables `c-new-BEG' and
852 ;; `c-new-END' to the new boundaries.
853 ;;
854 ;; (ii) "Neutralize" every preprocessor line wholly or partially in the
855 ;; extended changed region. "Restore" lines which were CPP lines before the
856 ;; change and are no longer so; these can be located from the Buffer local
857 ;; variables `c-old-BOM' and `c-old-EOM'.
0ec1d2c5
AM
858 ;;
859 ;; (iii) Mark every CPP construct by placing a `category' property value
860 ;; `c-cpp-delimiter' at its start and end. The marked characters are the
861 ;; opening # and usually the terminating EOL, but sometimes the character
862 ;; before a comment/string delimiter.
863 ;;
1d1e4868
AM
864 ;; That is, set syntax-table properties on characters that would otherwise
865 ;; interact syntactically with those outside the CPP line(s).
0ec1d2c5 866 ;;
1d1e4868
AM
867 ;; This function is called from an after-change function, BEGG ENDD and
868 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
869 ;; locking, hence must get called before `font-lock-after-change-function'.
870 ;;
871 ;; Point is undefined both before and after this function call, the buffer
872 ;; has been widened, and match-data saved. The return value is ignored.
873 ;;
874 ;; This function is the C/C++/ObjC value of `c-before-font-lock-function'.
875 ;;
c5fcadd1 876 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
0ec1d2c5 877 ;;
c5fcadd1 878 ;; This function might make hidden buffer changes.
0ec1d2c5 879 (c-save-buffer-state (limits)
a0526d5e
AM
880 ;; First determine the region, (c-new-BEG c-new-END), which will get font
881 ;; locked. It might need "neutralizing". This region may not start
882 ;; inside a string, comment, or macro.
c5fcadd1 883 (goto-char c-old-BOM) ; already set to old start of macro or begg.
a0526d5e 884 (setq c-new-BEG
0ec1d2c5 885 (if (setq limits (c-state-literal-at (point)))
c5fcadd1
AM
886 (cdr limits) ; go forward out of any string or comment.
887 (point)))
888
1d1e4868 889 (goto-char endd)
0ec1d2c5 890 (if (setq limits (c-state-literal-at (point)))
c5fcadd1
AM
891 (goto-char (car limits))) ; go backward out of any string or comment.
892 (if (c-beginning-of-macro)
893 (c-end-of-macro))
a0526d5e 894 (setq c-new-END (max (+ (- c-old-EOM old-len) (- endd begg))
1d1e4868 895 (point)))
c5fcadd1 896
0ec1d2c5 897 ;; Clear all old relevant properties.
a0526d5e 898 (c-clear-char-property-with-value c-new-BEG c-new-END 'syntax-table '(1))
0ec1d2c5
AM
899 (c-clear-char-property-with-value c-new-BEG c-new-END 'category 'c-cpp-delimiter)
900 ;; FIXME!!! What about the "<" and ">" category properties? 2009-11-16
1d1e4868 901
a0526d5e
AM
902 ;; Add needed properties to each CPP construct in the region.
903 (goto-char c-new-BEG)
0ec1d2c5 904 (let ((pps-position c-new-BEG) pps-state mbeg)
a0526d5e
AM
905 (while (and (< (point) c-new-END)
906 (search-forward-regexp c-anchored-cpp-prefix c-new-END t))
c5fcadd1
AM
907 ;; If we've found a "#" inside a string/comment, ignore it.
908 (setq pps-state
909 (parse-partial-sexp pps-position (point) nil nil pps-state)
910 pps-position (point))
911 (unless (or (nth 3 pps-state) ; in a string?
912 (nth 4 pps-state)) ; in a comment?
0ec1d2c5
AM
913 (goto-char (match-beginning 0))
914 (setq mbeg (point))
915 (if (> (c-syntactic-end-of-macro) mbeg)
916 (progn
917 (c-neutralize-CPP-line mbeg (point))
918 (c-set-cpp-delimiters mbeg (point))
919 ;(setq pps-position (point))
920 )
921 (forward-line)) ; no infinite loop with, e.g., "#//"
922 )))))
1d1e4868
AM
923
924(defun c-before-change (beg end)
7af4bf3a
AM
925 ;; Function to be put on `before-change-function'. Primarily, this calls
926 ;; the language dependent `c-get-state-before-change-function'. It is
1d1e4868
AM
927 ;; otherwise used only to remove stale entries from the `c-found-types'
928 ;; cache, and to record entries which a `c-after-change' function might
929 ;; confirm as stale.
0ec1d2c5 930 ;;
1d1e4868
AM
931 ;; Note that this function must be FAST rather than accurate. Note
932 ;; also that it only has any effect when font locking is enabled.
933 ;; We exploit this by checking for font-lock-*-face instead of doing
934 ;; rigourous syntactic analysis.
935
936 ;; If either change boundary is wholly inside an identifier, delete
937 ;; it/them from the cache. Don't worry about being inside a string
938 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
939 ;; isn't critical.
940 (setq c-maybe-stale-found-type nil)
941 (save-restriction
942 (save-match-data
943 (widen)
944 (save-excursion
945 ;; Are we inserting/deleting stuff in the middle of an identifier?
946 (c-unfind-enclosing-token beg)
947 (c-unfind-enclosing-token end)
948 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
949 (when (< beg end)
950 (c-unfind-coalesced-tokens beg end))
951 ;; Are we (potentially) disrupting the syntactic context which
952 ;; makes a type a type? E.g. by inserting stuff after "foo" in
953 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
954 ;;
955 ;; We search for appropriate c-type properties "near" the change.
956 ;; First, find an appropriate boundary for this property search.
957 (let (lim
958 type type-pos
959 marked-id term-pos
960 (end1
961 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
962 (previous-single-property-change end 'face))
963 end)))
964 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
965 ;; Find a limit for the search for a `c-type' property
966 (while
967 (and (/= (skip-chars-backward "^;{}") 0)
968 (> (point) (point-min))
969 (memq (c-get-char-property (1- (point)) 'face)
970 '(font-lock-comment-face font-lock-string-face))))
971 (setq lim (max (point-min) (1- (point))))
972
973 ;; Look for the latest `c-type' property before end1
974 (when (and (> end1 (point-min))
975 (setq type-pos
976 (if (get-text-property (1- end1) 'c-type)
977 end1
978 (previous-single-property-change end1 'c-type nil lim))))
979 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
980
981 (when (memq type '(c-decl-id-start c-decl-type-start))
982 ;; Get the identifier, if any, that the property is on.
983 (goto-char (1- type-pos))
984 (setq marked-id
985 (when (looking-at "\\(\\sw\\|\\s_\\)")
986 (c-beginning-of-current-token)
987 (buffer-substring-no-properties (point) type-pos)))
988
989 (goto-char end1)
990 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
991 (setq lim (point))
992 (setq term-pos
993 (or (next-single-property-change end 'c-type nil lim) lim))
994 (setq c-maybe-stale-found-type
995 (list type marked-id
996 type-pos term-pos
997 (buffer-substring-no-properties type-pos term-pos)
998 (buffer-substring-no-properties beg end)))))))
999
a0526d5e
AM
1000 ;; (c-new-BEG c-new-END) will be the region to fontify. It may become
1001 ;; larger than (beg end).
1d1e4868
AM
1002 (setq c-new-BEG beg
1003 c-new-END end)
7af4bf3a
AM
1004 (if c-get-state-before-change-function
1005 (funcall c-get-state-before-change-function beg end))
1d1e4868
AM
1006 ))))
1007
1008(defun c-after-change (beg end old-len)
1009 ;; Function put on `after-change-functions' to adjust various caches
1010 ;; etc. Prefer speed to finesse here, since there will be an order
1011 ;; of magnitude more calls to this function than any of the
1012 ;; functions that use the caches.
1013 ;;
1014 ;; Note that care must be taken so that this is called before any
1015 ;; font-lock callbacks since we might get calls to functions using
1016 ;; these caches from inside them, and we must thus be sure that this
1017 ;; has already been executed.
1018 ;;
1019 ;; This calls the language variable c-before-font-lock-function, if non nil.
1020 ;; This typically sets `syntax-table' properties.
1021
1022 (c-save-buffer-state ()
1023 ;; When `combine-after-change-calls' is used we might get calls
1024 ;; with regions outside the current narrowing. This has been
1025 ;; observed in Emacs 20.7.
1026 (save-restriction
1027 (save-match-data ; c-recognize-<>-arglists changes match-data
1028 (widen)
1029
1030 (when (> end (point-max))
1031 ;; Some emacsen might return positions past the end. This has been
1032 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1033 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1034 ;; work).
1035 (setq end (point-max))
1036 (when (> beg end)
1037 (setq beg end)))
1038
1039 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1040 (c-invalidate-sws-region-after beg end)
1041 (c-invalidate-state-cache beg)
1042 (c-invalidate-find-decl-cache beg)
1043
1044 (when c-recognize-<>-arglists
1045 (c-after-change-check-<>-operators beg end))
1046
1047 (if c-before-font-lock-function
1048 (save-excursion
1049 (funcall c-before-font-lock-function beg end old-len)))))))
1050
1051(defun c-after-font-lock-init ()
1052 ;; Put on `font-lock-mode-hook'.
1053 (remove-hook 'after-change-functions 'c-after-change t)
1054 (add-hook 'after-change-functions 'c-after-change nil t))
1055
1056(defun c-font-lock-init ()
1057 "Set up the font-lock variables for using the font-lock support in CC Mode.
1058This does not load the font-lock package. Use after
1059`c-basic-common-init' and after cc-fonts has been loaded."
1060
1061 (make-local-variable 'font-lock-defaults)
1062 (setq font-lock-defaults
1063 `(,(if (c-major-mode-is 'awk-mode)
1064 ;; awk-mode currently has only one font lock level.
1065 'awk-font-lock-keywords
1066 (mapcar 'c-mode-symbol
1067 '("font-lock-keywords" "font-lock-keywords-1"
1068 "font-lock-keywords-2" "font-lock-keywords-3")))
1069 nil nil
1070 ,c-identifier-syntax-modifications
1071 c-beginning-of-syntax
1d1e4868
AM
1072 (font-lock-mark-block-function
1073 . c-mark-function)))
1074
1075 (make-local-hook 'font-lock-mode-hook)
1076 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1077
8714fc18
AM
1078(defun c-extend-after-change-region (beg end old-len)
1079 "Extend the region to be fontified, if necessary."
1080 ;; Note: the parameters are ignored here. This somewhat indirect
1081 ;; implementation exists because it is minimally different from the
1082 ;; stand-alone CC Mode which, lacking
1083 ;; font-lock-extend-after-change-region-function, is forced to use advice
1084 ;; instead.
1085 ;;
a0526d5e
AM
1086 ;; Of the seven CC Mode languages, currently (2009-05) only C, C++, Objc
1087 ;; (the languages with #define) and AWK Mode make non-null use of this
1088 ;; function.
8714fc18 1089 (cons c-new-BEG c-new-END))
1d1e4868
AM
1090
1091\f
130c507e
GM
1092;; Support for C
1093
d9e94c22
MS
1094;;;###autoload
1095(defvar c-mode-syntax-table nil
1096 "Syntax table used in c-mode buffers.")
1097(or c-mode-syntax-table
1098 (setq c-mode-syntax-table
1099 (funcall (c-lang-const c-make-mode-syntax-table c))))
1100
130c507e
GM
1101(defvar c-mode-abbrev-table nil
1102 "Abbreviation table used in c-mode buffers.")
a66cd3ee
MS
1103(c-define-abbrev-table 'c-mode-abbrev-table
1104 '(("else" "else" c-electric-continued-statement 0)
1105 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1106
1107(defvar c-mode-map ()
1108 "Keymap used in c-mode buffers.")
1109(if c-mode-map
1110 nil
1111 (setq c-mode-map (c-make-inherited-keymap))
1112 ;; add bindings which are only useful for C
1113 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1114 )
1115
1116(easy-menu-define c-c-menu c-mode-map "C Mode Commands"
d9e94c22
MS
1117 (cons "C" (c-lang-const c-mode-menu c)))
1118
1119;; In XEmacs >= 21.5 modes should add their own entries to
1120;; `auto-mode-alist'. The comment form of autoload is used to avoid
1121;; doing this on load. That since `add-to-list' prepends the value
1122;; which could cause it to clobber user settings. Later emacsen have
1123;; an append option, but it's not safe to use.
50fdde0e 1124
38477bef
AM
1125;; The extension ".C" is associated with C++ while the lowercase
1126;; variant goes with C. On case insensitive file systems, this means
50fdde0e
MS
1127;; that ".c" files also might open C++ mode if the C++ entry comes
1128;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1129;; after ".c", and since `add-to-list' adds the entry first we have to
1130;; add the ".C" entry first.
1131;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1132;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1133;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1134
d9e94c22
MS
1135;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1136
1137;; NB: The following two associate yacc and lex files to C Mode, which
1138;; is not really suitable for those formats. Anyway, afaik there's
1139;; currently no better mode for them, and besides this is legacy.
1140;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1141;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1142
f63b48bb
DN
1143;; Preprocessed files generated by C and C++ compilers.
1144;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1145;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1146
1147
785eecbb
RS
1148;;;###autoload
1149(defun c-mode ()
1150 "Major mode for editing K&R and ANSI C code.
1151To submit a problem report, enter `\\[c-submit-bug-report]' from a
1152c-mode buffer. This automatically sets up a mail buffer with version
1153information already added. You just need to add a description of the
50fdde0e 1154problem, including a reproducible test case, and send the message.
785eecbb
RS
1155
1156To see what version of CC Mode you are running, enter `\\[c-version]'.
1157
d9e94c22
MS
1158The hook `c-mode-common-hook' is run with no args at mode
1159initialization, then `c-mode-hook'.
785eecbb
RS
1160
1161Key bindings:
1162\\{c-mode-map}"
1163 (interactive)
785eecbb 1164 (kill-all-local-variables)
d9e94c22 1165 (c-initialize-cc-mode t)
785eecbb
RS
1166 (set-syntax-table c-mode-syntax-table)
1167 (setq major-mode 'c-mode
1168 mode-name "C"
130c507e
GM
1169 local-abbrev-table c-mode-abbrev-table
1170 abbrev-mode t)
785eecbb 1171 (use-local-map c-mode-map)
28d88c16 1172 (c-init-language-vars-for 'c-mode)
a66cd3ee 1173 (c-common-init 'c-mode)
d9e94c22 1174 (easy-menu-add c-c-menu)
51f606de 1175 (cc-imenu-init cc-imenu-c-generic-expression)
3efc2cd7 1176 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
785eecbb
RS
1177 (c-update-modeline))
1178
1179\f
130c507e
GM
1180;; Support for C++
1181
d9e94c22
MS
1182;;;###autoload
1183(defvar c++-mode-syntax-table nil
1184 "Syntax table used in c++-mode buffers.")
1185(or c++-mode-syntax-table
1186 (setq c++-mode-syntax-table
1187 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1188
130c507e
GM
1189(defvar c++-mode-abbrev-table nil
1190 "Abbreviation table used in c++-mode buffers.")
a66cd3ee
MS
1191(c-define-abbrev-table 'c++-mode-abbrev-table
1192 '(("else" "else" c-electric-continued-statement 0)
1193 ("while" "while" c-electric-continued-statement 0)
1194 ("catch" "catch" c-electric-continued-statement 0)))
130c507e
GM
1195
1196(defvar c++-mode-map ()
1197 "Keymap used in c++-mode buffers.")
1198(if c++-mode-map
1199 nil
1200 (setq c++-mode-map (c-make-inherited-keymap))
1201 ;; add bindings which are only useful for C++
1202 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1203 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1204 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1205 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1206
1207(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
d9e94c22
MS
1208 (cons "C++" (c-lang-const c-mode-menu c++)))
1209
785eecbb
RS
1210;;;###autoload
1211(defun c++-mode ()
1212 "Major mode for editing C++ code.
1213To submit a problem report, enter `\\[c-submit-bug-report]' from a
1214c++-mode buffer. This automatically sets up a mail buffer with
1215version information already added. You just need to add a description
1216of the problem, including a reproducible test case, and send the
1217message.
1218
1219To see what version of CC Mode you are running, enter `\\[c-version]'.
1220
d9e94c22
MS
1221The hook `c-mode-common-hook' is run with no args at mode
1222initialization, then `c++-mode-hook'.
785eecbb
RS
1223
1224Key bindings:
1225\\{c++-mode-map}"
1226 (interactive)
785eecbb 1227 (kill-all-local-variables)
d9e94c22 1228 (c-initialize-cc-mode t)
785eecbb
RS
1229 (set-syntax-table c++-mode-syntax-table)
1230 (setq major-mode 'c++-mode
1231 mode-name "C++"
130c507e
GM
1232 local-abbrev-table c++-mode-abbrev-table
1233 abbrev-mode t)
785eecbb 1234 (use-local-map c++-mode-map)
28d88c16 1235 (c-init-language-vars-for 'c++-mode)
a66cd3ee 1236 (c-common-init 'c++-mode)
d9e94c22 1237 (easy-menu-add c-c++-menu)
51f606de 1238 (cc-imenu-init cc-imenu-c++-generic-expression)
3efc2cd7 1239 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
785eecbb
RS
1240 (c-update-modeline))
1241
1242\f
130c507e
GM
1243;; Support for Objective-C
1244
d9e94c22
MS
1245;;;###autoload
1246(defvar objc-mode-syntax-table nil
1247 "Syntax table used in objc-mode buffers.")
1248(or objc-mode-syntax-table
1249 (setq objc-mode-syntax-table
1250 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1251
130c507e
GM
1252(defvar objc-mode-abbrev-table nil
1253 "Abbreviation table used in objc-mode buffers.")
a66cd3ee
MS
1254(c-define-abbrev-table 'objc-mode-abbrev-table
1255 '(("else" "else" c-electric-continued-statement 0)
1256 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1257
1258(defvar objc-mode-map ()
1259 "Keymap used in objc-mode buffers.")
1260(if objc-mode-map
1261 nil
1262 (setq objc-mode-map (c-make-inherited-keymap))
1263 ;; add bindings which are only useful for Objective-C
1264 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1265
1266(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
d9e94c22
MS
1267 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1268
1269;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
130c507e 1270
785eecbb
RS
1271;;;###autoload
1272(defun objc-mode ()
1273 "Major mode for editing Objective C code.
1274To submit a problem report, enter `\\[c-submit-bug-report]' from an
1275objc-mode buffer. This automatically sets up a mail buffer with
1276version information already added. You just need to add a description
1277of the problem, including a reproducible test case, and send the
1278message.
1279
1280To see what version of CC Mode you are running, enter `\\[c-version]'.
1281
d9e94c22
MS
1282The hook `c-mode-common-hook' is run with no args at mode
1283initialization, then `objc-mode-hook'.
785eecbb
RS
1284
1285Key bindings:
1286\\{objc-mode-map}"
1287 (interactive)
785eecbb 1288 (kill-all-local-variables)
d9e94c22 1289 (c-initialize-cc-mode t)
785eecbb
RS
1290 (set-syntax-table objc-mode-syntax-table)
1291 (setq major-mode 'objc-mode
1292 mode-name "ObjC"
130c507e
GM
1293 local-abbrev-table objc-mode-abbrev-table
1294 abbrev-mode t)
785eecbb 1295 (use-local-map objc-mode-map)
28d88c16 1296 (c-init-language-vars-for 'objc-mode)
a66cd3ee 1297 (c-common-init 'objc-mode)
d9e94c22
MS
1298 (easy-menu-add c-objc-menu)
1299 (cc-imenu-init nil 'cc-imenu-objc-function)
3efc2cd7 1300 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
785eecbb
RS
1301 (c-update-modeline))
1302
1303\f
130c507e
GM
1304;; Support for Java
1305
d9e94c22
MS
1306;;;###autoload
1307(defvar java-mode-syntax-table nil
1308 "Syntax table used in java-mode buffers.")
1309(or java-mode-syntax-table
1310 (setq java-mode-syntax-table
1311 (funcall (c-lang-const c-make-mode-syntax-table java))))
1312
130c507e
GM
1313(defvar java-mode-abbrev-table nil
1314 "Abbreviation table used in java-mode buffers.")
a66cd3ee
MS
1315(c-define-abbrev-table 'java-mode-abbrev-table
1316 '(("else" "else" c-electric-continued-statement 0)
1317 ("while" "while" c-electric-continued-statement 0)
1318 ("catch" "catch" c-electric-continued-statement 0)
1319 ("finally" "finally" c-electric-continued-statement 0)))
130c507e
GM
1320
1321(defvar java-mode-map ()
1322 "Keymap used in java-mode buffers.")
1323(if java-mode-map
1324 nil
1325 (setq java-mode-map (c-make-inherited-keymap))
1326 ;; add bindings which are only useful for Java
1327 )
1328
d9e94c22
MS
1329;; Regexp trying to describe the beginning of a Java top-level
1330;; definition. This is not used by CC Mode, nor is it maintained
1331;; since it's practically impossible to write a regexp that reliably
1332;; matches such a construct. Other tools are necessary.
1333(defconst c-Java-defun-prompt-regexp
1334 "^[ \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-*")
1335
130c507e 1336(easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
d9e94c22
MS
1337 (cons "Java" (c-lang-const c-mode-menu java)))
1338
1339;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
130c507e 1340
785eecbb
RS
1341;;;###autoload
1342(defun java-mode ()
1343 "Major mode for editing Java code.
dc2b4c5f 1344To submit a problem report, enter `\\[c-submit-bug-report]' from a
785eecbb
RS
1345java-mode buffer. This automatically sets up a mail buffer with
1346version information already added. You just need to add a description
50fdde0e 1347of the problem, including a reproducible test case, and send the
785eecbb
RS
1348message.
1349
1350To see what version of CC Mode you are running, enter `\\[c-version]'.
1351
d9e94c22
MS
1352The hook `c-mode-common-hook' is run with no args at mode
1353initialization, then `java-mode-hook'.
785eecbb
RS
1354
1355Key bindings:
1356\\{java-mode-map}"
1357 (interactive)
785eecbb 1358 (kill-all-local-variables)
d9e94c22 1359 (c-initialize-cc-mode t)
785eecbb
RS
1360 (set-syntax-table java-mode-syntax-table)
1361 (setq major-mode 'java-mode
1362 mode-name "Java"
91b807c9 1363 local-abbrev-table java-mode-abbrev-table
a66cd3ee 1364 abbrev-mode t)
785eecbb 1365 (use-local-map java-mode-map)
28d88c16 1366 (c-init-language-vars-for 'java-mode)
a66cd3ee 1367 (c-common-init 'java-mode)
d9e94c22 1368 (easy-menu-add c-java-menu)
51f606de 1369 (cc-imenu-init cc-imenu-java-generic-expression)
3efc2cd7 1370 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
785eecbb
RS
1371 (c-update-modeline))
1372
1373\f
130c507e
GM
1374;; Support for CORBA's IDL language
1375
d9e94c22
MS
1376;;;###autoload
1377(defvar idl-mode-syntax-table nil
1378 "Syntax table used in idl-mode buffers.")
1379(or idl-mode-syntax-table
1380 (setq idl-mode-syntax-table
1381 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1382
130c507e
GM
1383(defvar idl-mode-abbrev-table nil
1384 "Abbreviation table used in idl-mode buffers.")
a66cd3ee 1385(c-define-abbrev-table 'idl-mode-abbrev-table nil)
130c507e
GM
1386
1387(defvar idl-mode-map ()
1388 "Keymap used in idl-mode buffers.")
1389(if idl-mode-map
1390 nil
1391 (setq idl-mode-map (c-make-inherited-keymap))
1392 ;; add bindings which are only useful for IDL
1393 )
1394
1395(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
d9e94c22
MS
1396 (cons "IDL" (c-lang-const c-mode-menu idl)))
1397
1398;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
130c507e 1399
aac90c52
RS
1400;;;###autoload
1401(defun idl-mode ()
d9e94c22 1402 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
aac90c52
RS
1403To submit a problem report, enter `\\[c-submit-bug-report]' from an
1404idl-mode buffer. This automatically sets up a mail buffer with
1405version information already added. You just need to add a description
1406of the problem, including a reproducible test case, and send the
1407message.
1408
1409To see what version of CC Mode you are running, enter `\\[c-version]'.
1410
d9e94c22
MS
1411The hook `c-mode-common-hook' is run with no args at mode
1412initialization, then `idl-mode-hook'.
aac90c52
RS
1413
1414Key bindings:
1415\\{idl-mode-map}"
1416 (interactive)
aac90c52 1417 (kill-all-local-variables)
d9e94c22 1418 (c-initialize-cc-mode t)
aac90c52
RS
1419 (set-syntax-table idl-mode-syntax-table)
1420 (setq major-mode 'idl-mode
1421 mode-name "IDL"
1422 local-abbrev-table idl-mode-abbrev-table)
1423 (use-local-map idl-mode-map)
28d88c16 1424 (c-init-language-vars-for 'idl-mode)
a66cd3ee 1425 (c-common-init 'idl-mode)
d9e94c22
MS
1426 (easy-menu-add c-idl-menu)
1427 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
3efc2cd7 1428 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
aac90c52
RS
1429 (c-update-modeline))
1430
1431\f
130c507e
GM
1432;; Support for Pike
1433
d9e94c22
MS
1434;;;###autoload
1435(defvar pike-mode-syntax-table nil
1436 "Syntax table used in pike-mode buffers.")
1437(or pike-mode-syntax-table
1438 (setq pike-mode-syntax-table
1439 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1440
130c507e
GM
1441(defvar pike-mode-abbrev-table nil
1442 "Abbreviation table used in pike-mode buffers.")
a66cd3ee
MS
1443(c-define-abbrev-table 'pike-mode-abbrev-table
1444 '(("else" "else" c-electric-continued-statement 0)
1445 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
1446
1447(defvar pike-mode-map ()
1448 "Keymap used in pike-mode buffers.")
1449(if pike-mode-map
1450 nil
1451 (setq pike-mode-map (c-make-inherited-keymap))
1452 ;; additional bindings
1453 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1454
1455(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
d9e94c22
MS
1456 (cons "Pike" (c-lang-const c-mode-menu pike)))
1457
50fdde0e
MS
1458;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1459;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
130c507e 1460
0ec8351b
BW
1461;;;###autoload
1462(defun pike-mode ()
1463 "Major mode for editing Pike code.
a66cd3ee
MS
1464To submit a problem report, enter `\\[c-submit-bug-report]' from a
1465pike-mode buffer. This automatically sets up a mail buffer with
0ec8351b
BW
1466version information already added. You just need to add a description
1467of the problem, including a reproducible test case, and send the
1468message.
1469
1470To see what version of CC Mode you are running, enter `\\[c-version]'.
1471
d9e94c22
MS
1472The hook `c-mode-common-hook' is run with no args at mode
1473initialization, then `pike-mode-hook'.
0ec8351b
BW
1474
1475Key bindings:
1476\\{pike-mode-map}"
1477 (interactive)
0ec8351b 1478 (kill-all-local-variables)
d9e94c22 1479 (c-initialize-cc-mode t)
0ec8351b
BW
1480 (set-syntax-table pike-mode-syntax-table)
1481 (setq major-mode 'pike-mode
1482 mode-name "Pike"
130c507e 1483 local-abbrev-table pike-mode-abbrev-table
a66cd3ee 1484 abbrev-mode t)
0ec8351b 1485 (use-local-map pike-mode-map)
28d88c16 1486 (c-init-language-vars-for 'pike-mode)
a66cd3ee 1487 (c-common-init 'pike-mode)
d9e94c22
MS
1488 (easy-menu-add c-pike-menu)
1489 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
3efc2cd7 1490 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
0ec8351b
BW
1491 (c-update-modeline))
1492
1493\f
0386b551 1494;; Support for AWK
d9e94c22 1495
50fdde0e
MS
1496;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1497;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1498;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1499;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1500;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
d9e94c22 1501
50fdde0e
MS
1502;;; Autoload directives must be on the top level, so we construct an
1503;;; autoload form instead.
791887d9 1504;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
50fdde0e 1505
0386b551
AM
1506(defvar awk-mode-abbrev-table nil
1507 "Abbreviation table used in awk-mode buffers.")
1508(c-define-abbrev-table 'awk-mode-abbrev-table
1509 '(("else" "else" c-electric-continued-statement 0)
1510 ("while" "while" c-electric-continued-statement 0)))
1511
1512(defvar awk-mode-map ()
1513 "Keymap used in awk-mode buffers.")
1514(if awk-mode-map
1515 nil
1516 (setq awk-mode-map (c-make-inherited-keymap))
1517 ;; add bindings which are only useful for awk.
1518 (define-key awk-mode-map "#" 'self-insert-command)
1519 (define-key awk-mode-map "/" 'self-insert-command)
1520 (define-key awk-mode-map "*" 'self-insert-command)
1521 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1522 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1523 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1524 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1525 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1526 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1527 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1528
1529(easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1530 (cons "AWK" (c-lang-const c-mode-menu awk)))
1531
ae500c1a
GM
1532;; (require 'cc-awk) brings these in.
1533(defvar awk-mode-syntax-table)
1534(declare-function c-awk-unstick-NL-prop "cc-awk" ())
1535
0386b551
AM
1536(defun awk-mode ()
1537 "Major mode for editing AWK code.
d9e94c22
MS
1538To submit a problem report, enter `\\[c-submit-bug-report]' from an
1539awk-mode buffer. This automatically sets up a mail buffer with version
1540information already added. You just need to add a description of the
50fdde0e 1541problem, including a reproducible test case, and send the message.
d9e94c22
MS
1542
1543To see what version of CC Mode you are running, enter `\\[c-version]'.
1544
1545The hook `c-mode-common-hook' is run with no args at mode
1546initialization, then `awk-mode-hook'.
1547
1548Key bindings:
1549\\{awk-mode-map}"
0386b551
AM
1550 (interactive)
1551 (require 'cc-awk) ; Added 2003/6/10.
1552 (kill-all-local-variables)
1553 (c-initialize-cc-mode t)
1554 (set-syntax-table awk-mode-syntax-table)
1555 (setq major-mode 'awk-mode
1556 mode-name "AWK"
1557 local-abbrev-table awk-mode-abbrev-table
1558 abbrev-mode t)
1559 (use-local-map awk-mode-map)
1560 (c-init-language-vars-for 'awk-mode)
1561 (c-common-init 'awk-mode)
0386b551 1562 (c-awk-unstick-NL-prop)
0386b551
AM
1563
1564 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1565 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1566 (defalias 'c-in-literal 'c-slow-in-literal)
1567
1568 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1569 (c-update-modeline))
d9e94c22
MS
1570
1571\f
c2efc1d0 1572;; bug reporting
785eecbb
RS
1573
1574(defconst c-mode-help-address
a66cd3ee
MS
1575 "bug-cc-mode@gnu.org"
1576 "Address(es) for CC Mode bug reports.")
785eecbb
RS
1577
1578(defun c-version ()
1579 "Echo the current version of CC Mode in the minibuffer."
1580 (interactive)
1581 (message "Using CC Mode version %s" c-version)
1582 (c-keep-region-active))
1583
130c507e
GM
1584(defvar c-prepare-bug-report-hooks nil)
1585
1586;; Dynamic variables used by reporter.
1587(defvar reporter-prompt-for-summary-p)
1588(defvar reporter-dont-compact-list)
1589
785eecbb
RS
1590(defun c-submit-bug-report ()
1591 "Submit via mail a bug report on CC Mode."
1592 (interactive)
77e31a8d 1593 (require 'reporter)
785eecbb
RS
1594 ;; load in reporter
1595 (let ((reporter-prompt-for-summary-p t)
1596 (reporter-dont-compact-list '(c-offsets-alist))
1597 (style c-indentation-style)
785eecbb
RS
1598 (c-features c-emacs-features))
1599 (and
1600 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1601 t (message "") nil)
785eecbb
RS
1602 (reporter-submit-bug-report
1603 c-mode-help-address
d9e94c22 1604 (concat "CC Mode " c-version " (" mode-name ")")
51f606de 1605 (let ((vars (append
51f606de 1606 c-style-variables
d9e94c22 1607 '(c-buffer-is-cc-mode
51f606de 1608 c-tab-always-indent
d9e94c22
MS
1609 c-syntactic-indentation
1610 c-syntactic-indentation-in-macros
1611 c-ignore-auto-fill
1612 c-auto-align-backslashes
1613 c-backspace-function
1614 c-delete-function
1615 c-electric-pound-behavior
1616 c-default-style
1617 c-enable-xemacs-performance-kludge-p
1618 c-old-style-variable-behavior
51f606de
GM
1619 defun-prompt-regexp
1620 tab-width
1621 comment-column
1622 parse-sexp-ignore-comments
d9e94c22
MS
1623 parse-sexp-lookup-properties
1624 lookup-syntax-properties
51f606de
GM
1625 ;; A brain-damaged XEmacs only variable that, if
1626 ;; set to nil can cause all kinds of chaos.
1627 signal-error-on-buffer-boundary
1628 ;; Variables that affect line breaking and comments.
d9e94c22 1629 auto-fill-mode
91b807c9 1630 auto-fill-function
51f606de
GM
1631 filladapt-mode
1632 comment-multi-line
1633 comment-start-skip
1634 fill-prefix
d9e94c22 1635 fill-column
51f606de
GM
1636 paragraph-start
1637 adaptive-fill-mode
1638 adaptive-fill-regexp)
1639 nil)))
d61ca8d5
GM
1640 (mapc (lambda (var) (unless (boundp var)
1641 (setq vars (delq var vars))))
1642 '(signal-error-on-buffer-boundary
1643 filladapt-mode
1644 defun-prompt-regexp
1645 font-lock-mode
1646 font-lock-maximum-decoration
1647 parse-sexp-lookup-properties
1648 lookup-syntax-properties))
51f606de 1649 vars)
9714ec23 1650 (lambda ()
a66cd3ee 1651 (run-hooks 'c-prepare-bug-report-hooks)
d9e94c22 1652 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
a66cd3ee 1653 style c-features)))))))
785eecbb
RS
1654
1655\f
130c507e 1656(cc-provide 'cc-mode)
ab5796a9 1657
cbee283d 1658;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
785eecbb 1659;;; cc-mode.el ends here