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