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