Sync to HEAD
[bpt/emacs.git] / lisp / progmodes / cc-mode.el
CommitLineData
d9e94c22 1;;; cc-mode.el --- major mode for editing C and similar languages
785eecbb 2
d9e94c22 3;; Copyright (C) 1985,1987,1992-2003 Free Software Foundation, Inc.
785eecbb 4
d9e94c22
MS
5;; Authors: 2003- Alan Mackenzie
6;; 1998- Martin Stjernholm
7;; 1992-1999 Barry A. Warsaw
785eecbb
RS
8;; 1987 Dave Detlefs and Stewart Clamen
9;; 1985 Richard M. Stallman
0ec8351b 10;; Maintainer: bug-cc-mode@gnu.org
785eecbb 11;; Created: a long, long, time ago. adapted from the original c-mode.el
785eecbb
RS
12;; Keywords: c languages oop
13
785eecbb
RS
14;; This file is part of GNU Emacs.
15
16;; GNU Emacs is free software; you can redistribute it and/or modify
17;; it under the terms of the GNU General Public License as published by
18;; the Free Software Foundation; either version 2, or (at your option)
19;; any later version.
20
21;; GNU Emacs is distributed in the hope that it will be useful,
22;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24;; GNU General Public License for more details.
25
26;; You should have received a copy of the GNU General Public License
a66cd3ee 27;; along with GNU Emacs; see the file COPYING. If not, write to
130c507e 28;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
785eecbb
RS
29;; Boston, MA 02111-1307, USA.
30
d9e94c22 31;;; Commentary:
130c507e
GM
32
33;; NOTE: Read the commentary below for the right way to submit bug reports!
34;; NOTE: See the accompanying texinfo manual for details on using this mode!
d9e94c22 35;; Note: The version string is in cc-defs.
785eecbb
RS
36
37;; This package provides GNU Emacs major modes for editing C, C++,
d9e94c22
MS
38;; Objective-C, Java, CORBA's IDL, Pike and AWK code. As of the
39;; latest Emacs and XEmacs releases, it is the default package for
40;; editing these languages. This package is called "CC Mode", and
41;; should be spelled exactly this way.
0ec8351b
BW
42
43;; CC Mode supports K&R and ANSI C, ANSI C++, Objective-C, Java,
d9e94c22
MS
44;; CORBA's IDL, Pike and AWK with a consistent indentation model
45;; across all modes. This indentation model is intuitive and very
46;; flexible, so that almost any desired style of indentation can be
47;; supported. Installation, usage, and programming details are
48;; contained in an accompanying texinfo manual.
785eecbb
RS
49
50;; CC Mode's immediate ancestors were, c++-mode.el, cplus-md.el, and
51;; cplus-md1.el..
52
785eecbb 53;; To submit bug reports, type "C-c C-b". These will be sent to
0ec8351b
BW
54;; bug-gnu-emacs@gnu.org (mirrored as the Usenet newsgroup
55;; gnu.emacs.bug) as well as bug-cc-mode@gnu.org, which directly
56;; contacts the CC Mode maintainers. Questions can sent to
57;; help-gnu-emacs@gnu.org (mirrored as gnu.emacs.help) and/or
130c507e
GM
58;; bug-cc-mode@gnu.org. Please do not send bugs or questions to our
59;; personal accounts; we reserve the right to ignore such email!
785eecbb 60
785eecbb
RS
61;; Many, many thanks go out to all the folks on the beta test list.
62;; Without their patience, testing, insight, code contributions, and
63;; encouragement CC Mode would be a far inferior package.
64
65;; You can get the latest version of CC Mode, including PostScript
66;; documentation and separate individual files from:
67;;
91b807c9 68;; http://cc-mode.sourceforge.net/
0ec8351b
BW
69;;
70;; You can join a moderated CC Mode announcement-only mailing list by
71;; visiting
785eecbb 72;;
91b807c9 73;; http://lists.sourceforge.net/mailman/listinfo/cc-mode-announce
785eecbb
RS
74
75;;; Code:
76
51f606de
GM
77(eval-when-compile
78 (let ((load-path
130c507e
GM
79 (if (and (boundp 'byte-compile-dest-file)
80 (stringp byte-compile-dest-file))
81 (cons (file-name-directory byte-compile-dest-file) load-path)
51f606de 82 load-path)))
d9e94c22 83 (load "cc-bytecomp" nil t)))
130c507e
GM
84
85(cc-require 'cc-defs)
d9e94c22 86(cc-require-when-compile 'cc-langs)
130c507e 87(cc-require 'cc-vars)
130c507e 88(cc-require 'cc-engine)
d9e94c22 89(cc-require 'cc-styles)
130c507e
GM
90(cc-require 'cc-cmds)
91(cc-require 'cc-align)
d9e94c22 92(cc-require 'cc-menus)
130c507e 93
d9e94c22 94;; SILENCE the compiler.
130c507e
GM
95(cc-bytecomp-defvar comment-line-break-function) ; (X)Emacs 20+
96(cc-bytecomp-defvar adaptive-fill-first-line-regexp) ; Emacs 20+
97(cc-bytecomp-defun set-keymap-parents) ; XEmacs
98
d9e94c22
MS
99;; We set these variables during mode init, yet we don't require
100;; font-lock.
101(cc-bytecomp-defvar font-lock-defaults)
102(cc-bytecomp-defvar font-lock-syntactic-keywords)
103
130c507e
GM
104;; Menu support for both XEmacs and Emacs. If you don't have easymenu
105;; with your version of Emacs, you are incompatible!
d9e94c22
MS
106(cc-external-require 'easymenu)
107
108;; Load cc-fonts first after font-lock is loaded, since it isn't
109;; necessary until font locking is requested.
110(eval-after-load "font-lock"
111 '(require 'cc-fonts))
112
113;; cc-langs isn't loaded when we're byte compiled, so add autoload
114;; directives for the interface functions.
115(autoload 'c-make-init-lang-vars-fun "cc-langs")
116(autoload 'c-init-language-vars "cc-langs" nil nil 'macro)
785eecbb
RS
117
118\f
1dad6919
RS
119;; Other modes and packages which depend on CC Mode should do the
120;; following to make sure everything is loaded and available for their
121;; use:
122;;
123;; (require 'cc-mode)
a66cd3ee
MS
124;;
125;; And in the major mode function:
126;;
d9e94c22
MS
127;; (c-initialize-cc-mode t)
128;; (c-init-language-vars some-mode)
129;; (c-common-init 'some-mode) ; Or perhaps (c-basic-common-init 'some-mode)
130;;
28d88c16
MS
131;; If you're not writing a derived mode using the language variable
132;; system, then some-mode is one of the language modes directly
133;; supported by CC Mode. You can then use (c-init-language-vars-for
134;; 'some-mode) instead of `c-init-language-vars'.
135;; `c-init-language-vars-for' is a function that avoids the rather
136;; large expansion of `c-init-language-vars'.
137;;
138;; If you use `c-basic-common-init' then you might want to call
139;; `c-font-lock-init' too to set up CC Mode's font lock support.
140;;
d9e94c22
MS
141;; See cc-langs.el for further info. A small example of a derived mode
142;; is also available at <http://cc-mode.sourceforge.net/
143;; derived-mode-ex.el>.
1dad6919 144
a66cd3ee
MS
145(defun c-leave-cc-mode-mode ()
146 (setq c-buffer-is-cc-mode nil))
147
28d88c16
MS
148(defun c-init-language-vars-for (mode)
149 "Initialize the language variables for one of the language modes
150directly supported by CC Mode. This can be used instead of the
151`c-init-language-vars' macro if the language you want to use is one of
152those, rather than a derived language defined through the language
153variable system (see \"cc-langs.el\")."
154 ;; This function does not do any hidden buffer changes.
155 (cond ((eq mode 'c-mode) (c-init-language-vars c-mode))
156 ((eq mode 'c++-mode) (c-init-language-vars c++-mode))
157 ((eq mode 'objc-mode) (c-init-language-vars objc-mode))
158 ((eq mode 'java-mode) (c-init-language-vars java-mode))
159 ((eq mode 'idl-mode) (c-init-language-vars idl-mode))
160 ((eq mode 'pike-mode) (c-init-language-vars pike-mode))
161 ((eq mode 'awk-mode) (c-init-language-vars awk-mode))
162 (t (error "Unsupported mode %s" mode))))
163
aac90c52 164;;;###autoload
d9e94c22
MS
165(defun c-initialize-cc-mode (&optional new-style-init)
166 "Initialize CC Mode for use in the current buffer.
167If the optional NEW-STYLE-INIT is nil or left out then all necessary
168initialization to run CC Mode for the C language is done. Otherwise
28d88c16
MS
169only some basic setup is done, and a call to `c-init-language-vars' or
170`c-init-language-vars-for' is necessary too (which gives more
171control). See \"cc-mode.el\" for more info."
d9e94c22
MS
172 ;;
173 ;; This function does not do any hidden buffer changes.
174
611c76a7 175 (setq c-buffer-is-cc-mode t)
d9e94c22 176
0ec8351b
BW
177 (let ((initprop 'cc-mode-is-initialized)
178 c-initialization-ok)
179 (unless (get 'c-initialize-cc-mode initprop)
0ec8351b
BW
180 (unwind-protect
181 (progn
51f606de
GM
182 (put 'c-initialize-cc-mode initprop t)
183 (c-initialize-builtin-style)
0ec8351b 184 (run-hooks 'c-initialization-hook)
51f606de
GM
185 ;; Fix obsolete variables.
186 (if (boundp 'c-comment-continuation-stars)
187 (setq c-block-comment-prefix c-comment-continuation-stars))
a66cd3ee 188 (add-hook 'change-major-mode-hook 'c-leave-cc-mode-mode)
0ec8351b
BW
189 (setq c-initialization-ok t))
190 ;; Will try initialization hooks again if they failed.
d9e94c22
MS
191 (put 'c-initialize-cc-mode initprop c-initialization-ok))))
192
193 (unless new-style-init
28d88c16 194 (c-init-language-vars-for 'c-mode)))
1dad6919
RS
195
196\f
d9e94c22
MS
197;;; Common routines.
198
130c507e
GM
199(defvar c-mode-base-map ()
200 "Keymap shared by all CC Mode related modes.")
201
202(defun c-make-inherited-keymap ()
203 (let ((map (make-sparse-keymap)))
204 (cond
d9e94c22 205 ;; XEmacs
130c507e
GM
206 ((fboundp 'set-keymap-parents)
207 (set-keymap-parents map c-mode-base-map))
d9e94c22 208 ;; Emacs
130c507e
GM
209 ((fboundp 'set-keymap-parent)
210 (set-keymap-parent map c-mode-base-map))
211 ;; incompatible
212 (t (error "CC Mode is incompatible with this version of Emacs")))
213 map))
214
a66cd3ee
MS
215(defun c-define-abbrev-table (name defs)
216 ;; Compatibility wrapper for `define-abbrev' which passes a non-nil
217 ;; sixth argument for SYSTEM-FLAG in emacsen that support it
218 ;; (currently only Emacs 21.2).
d9e94c22
MS
219 (let ((table (or (symbol-value name)
220 (progn (define-abbrev-table name nil)
221 (symbol-value name)))))
a66cd3ee
MS
222 (while defs
223 (condition-case nil
224 (apply 'define-abbrev table (append (car defs) '(t)))
225 (wrong-number-of-arguments
226 (apply 'define-abbrev table (car defs))))
227 (setq defs (cdr defs)))))
d9e94c22 228(put 'c-define-abbrev-table 'lisp-indent-function 1)
a66cd3ee 229
130c507e
GM
230(if c-mode-base-map
231 nil
232 ;; TBD: should we even worry about naming this keymap. My vote: no,
233 ;; because Emacs and XEmacs do it differently.
234 (setq c-mode-base-map (make-sparse-keymap))
235 ;; put standard keybindings into MAP
236 ;; the following mappings correspond more or less directly to BOCM
237 (define-key c-mode-base-map "{" 'c-electric-brace)
238 (define-key c-mode-base-map "}" 'c-electric-brace)
239 (define-key c-mode-base-map ";" 'c-electric-semi&comma)
240 (define-key c-mode-base-map "#" 'c-electric-pound)
241 (define-key c-mode-base-map ":" 'c-electric-colon)
242 (define-key c-mode-base-map "(" 'c-electric-paren)
243 (define-key c-mode-base-map ")" 'c-electric-paren)
244 ;; Separate M-BS from C-M-h. The former should remain
245 ;; backward-kill-word.
246 (define-key c-mode-base-map [(control meta h)] 'c-mark-function)
247 (define-key c-mode-base-map "\e\C-q" 'c-indent-exp)
248 (substitute-key-definition 'backward-sentence
249 'c-beginning-of-statement
250 c-mode-base-map global-map)
251 (substitute-key-definition 'forward-sentence
252 'c-end-of-statement
253 c-mode-base-map global-map)
254 (substitute-key-definition 'indent-new-comment-line
255 'c-indent-new-comment-line
256 c-mode-base-map global-map)
a66cd3ee
MS
257 (when (fboundp 'comment-indent-new-line)
258 ;; indent-new-comment-line has changed name to
259 ;; comment-indent-new-line in Emacs 21.
260 (substitute-key-definition 'comment-indent-new-line
261 'c-indent-new-comment-line
262 c-mode-base-map global-map))
130c507e
GM
263 ;; RMS says don't make these the default.
264;; (define-key c-mode-base-map "\e\C-a" 'c-beginning-of-defun)
265;; (define-key c-mode-base-map "\e\C-e" 'c-end-of-defun)
266 (define-key c-mode-base-map "\C-c\C-n" 'c-forward-conditional)
267 (define-key c-mode-base-map "\C-c\C-p" 'c-backward-conditional)
268 (define-key c-mode-base-map "\C-c\C-u" 'c-up-conditional)
269 (substitute-key-definition 'indent-for-tab-command
270 'c-indent-command
271 c-mode-base-map global-map)
d9e94c22
MS
272
273 ;; It doesn't suffice to put `c-fill-paragraph' on
274 ;; `fill-paragraph-function' since `c-fill-paragraph' must be called
275 ;; before any fill prefix adaption is done. E.g. `filladapt-mode'
276 ;; replaces `fill-paragraph' and does the adaption before calling
277 ;; `fill-paragraph-function', and we have to mask comments etc
278 ;; before that. Also, `c-fill-paragraph' chains on to
279 ;; `fill-paragraph' and the value on `fill-parapgraph-function' to
280 ;; do the actual filling work.
130c507e
GM
281 (substitute-key-definition 'fill-paragraph 'c-fill-paragraph
282 c-mode-base-map global-map)
283 ;; In XEmacs the default fill function is called
284 ;; fill-paragraph-or-region.
285 (substitute-key-definition 'fill-paragraph-or-region 'c-fill-paragraph
286 c-mode-base-map global-map)
d9e94c22 287
6d28be1d
EZ
288 ;; Bind the electric deletion functions to C-d and DEL. Emacs 21
289 ;; automatically maps the [delete] and [backspace] keys to these two
290 ;; depending on window system and user preferences. (In earlier
291 ;; versions it's possible to do the same by using `function-key-map'.)
292 (define-key c-mode-base-map "\C-d" 'c-electric-delete-forward)
293 (define-key c-mode-base-map "\177" 'c-electric-backspace)
294 (when (boundp 'delete-key-deletes-forward)
295 ;; In XEmacs 20 and later we fix the forward and backward deletion
296 ;; behavior by binding the keysyms for the [delete] and
297 ;; [backspace] keys directly, and use `delete-forward-p' or
298 ;; `delete-key-deletes-forward' to decide what [delete] should do.
299 (define-key c-mode-base-map [delete] 'c-electric-delete)
300 (define-key c-mode-base-map [backspace] 'c-electric-backspace))
130c507e
GM
301 (define-key c-mode-base-map "," 'c-electric-semi&comma)
302 (define-key c-mode-base-map "*" 'c-electric-star)
303 (define-key c-mode-base-map "/" 'c-electric-slash)
304 (define-key c-mode-base-map "\C-c\C-q" 'c-indent-defun)
305 (define-key c-mode-base-map "\C-c\C-\\" 'c-backslash-region)
130c507e
GM
306 (define-key c-mode-base-map "\C-c\C-a" 'c-toggle-auto-state)
307 (define-key c-mode-base-map "\C-c\C-b" 'c-submit-bug-report)
308 (define-key c-mode-base-map "\C-c\C-c" 'comment-region)
309 (define-key c-mode-base-map "\C-c\C-d" 'c-toggle-hungry-state)
310 (define-key c-mode-base-map "\C-c\C-o" 'c-set-offset)
311 (define-key c-mode-base-map "\C-c\C-s" 'c-show-syntactic-information)
312 (define-key c-mode-base-map "\C-c\C-t" 'c-toggle-auto-hungry-state)
313 (define-key c-mode-base-map "\C-c." 'c-set-style)
314 ;; conflicts with OOBR
315 ;;(define-key c-mode-base-map "\C-c\C-v" 'c-version)
316 )
317
130c507e
GM
318;; We don't require the outline package, but we configure it a bit anyway.
319(cc-bytecomp-defvar outline-level)
320
d9e94c22
MS
321(defun c-mode-menu (modestr)
322 "Return a menu spec suitable for `easy-menu-define' that is exactly
323like the C mode menu except that the menu bar item name is MODESTR
324instead of \"C\".
325
326This function is provided for compatibility only; derived modes should
327preferably use the `c-mode-menu' language constant directly."
328 (cons modestr (c-lang-const c-mode-menu c)))
329
330;; Ugly hack to pull in the definition of `c-populate-syntax-table'
331;; from cc-langs to make it available at runtime. It's either this or
332;; moving the definition for it to cc-defs, but that would mean to
333;; break up the syntax table setup over two files.
334(defalias 'c-populate-syntax-table
335 (cc-eval-when-compile
336 (let ((f (symbol-function 'c-populate-syntax-table)))
337 (if (byte-code-function-p f) f (byte-compile f)))))
338
339(defun c-after-change (beg end len)
340 ;; Function put on `after-change-functions' to adjust various
341 ;; caches. Prefer speed to finesse here, since there will be an
342 ;; order of magnitude more calls to this function than any of the
343 ;; functions that use the caches.
344 ;;
345 ;; Note that care must be taken so that this is called before any
346 ;; font-lock callbacks since we might get calls to functions using
347 ;; these caches from inside them, and we must thus be sure that this
348 ;; has already been executed.
349 ;;
350 ;; This function does not do any hidden buffer changes.
351
352 (c-save-buffer-state ()
353 (when (> end (point-max))
354 ;; Some emacsen might return positions past the end. This has been
355 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
356 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
357 ;; work).
358 (setq end (point-max))
359 (when (> beg end)
360 (setq beg end)))
361
362 (c-invalidate-sws-region-after beg end)
363 (c-invalidate-state-cache beg)
364 (c-invalidate-find-decl-cache beg)))
365
366(defun c-basic-common-init (mode default-style)
367 "Do the necessary initialization for the syntax handling routines
368and the line breaking/filling code. Intended to be used by other
369packages that embed CC Mode.
370
371MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode.
372DEFAULT-STYLE tells which indentation style to install. It has the
373same format as `c-default-style'.
374
375Note that `c-init-language-vars' must be called before this function.
376This function cannot do that since `c-init-language-vars' is a macro
377that requires a literal mode spec at compile time."
378 ;;
379 ;; This function does not do any hidden buffer changes.
380
a66cd3ee
MS
381 (setq c-buffer-is-cc-mode mode)
382
130c507e
GM
383 ;; these variables should always be buffer local; they do not affect
384 ;; indentation style.
130c507e
GM
385 (make-local-variable 'parse-sexp-ignore-comments)
386 (make-local-variable 'indent-line-function)
387 (make-local-variable 'indent-region-function)
130c507e
GM
388 (make-local-variable 'normal-auto-fill-function)
389 (make-local-variable 'comment-start)
390 (make-local-variable 'comment-end)
130c507e
GM
391 (make-local-variable 'comment-start-skip)
392 (make-local-variable 'comment-multi-line)
393 (make-local-variable 'paragraph-start)
394 (make-local-variable 'paragraph-separate)
395 (make-local-variable 'paragraph-ignore-fill-prefix)
396 (make-local-variable 'adaptive-fill-mode)
397 (make-local-variable 'adaptive-fill-regexp)
a66cd3ee 398
130c507e 399 ;; now set their values
e2c21e66 400 (setq parse-sexp-ignore-comments t
130c507e
GM
401 indent-line-function 'c-indent-line
402 indent-region-function 'c-indent-region
130c507e 403 normal-auto-fill-function 'c-do-auto-fill
130c507e 404 comment-multi-line t)
a66cd3ee 405
fd8771f5
MS
406 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
407 ;; direct call to `fill-paragraph' behaves better. This still
408 ;; doesn't work with filladapt but it's better than nothing.
409 (make-local-variable 'fill-paragraph-function)
410 (setq fill-paragraph-function 'c-fill-paragraph)
411
d9e94c22
MS
412 ;; (X)Emacs 20 and later.
413 (when (boundp 'comment-line-break-function)
414 (make-local-variable 'comment-line-break-function)
415 (setq comment-line-break-function
416 'c-indent-new-comment-line))
417
418 ;; Emacs 20 and later.
419 (when (boundp 'parse-sexp-lookup-properties)
420 (make-local-variable 'parse-sexp-lookup-properties)
421 (setq parse-sexp-lookup-properties t))
422
423 ;; Same as above for XEmacs 21 (although currently undocumented).
424 (when (boundp 'lookup-syntax-properties)
425 (make-local-variable 'lookup-syntax-properties)
426 (setq lookup-syntax-properties t))
427
428 ;; Use this in Emacs 21 to avoid meddling with the rear-nonsticky
429 ;; property on each character.
430 (when (boundp 'text-property-default-nonsticky)
431 (make-local-variable 'text-property-default-nonsticky)
432 (let ((elem (assq 'syntax-table text-property-default-nonsticky)))
433 (if elem
434 (setcdr elem t)
435 (setq text-property-default-nonsticky
436 (cons '(syntax-table . t)
437 text-property-default-nonsticky))))
438 (setq text-property-default-nonsticky
439 (cons '(c-type . t)
440 text-property-default-nonsticky)))
441
442 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
443 ;; heuristic that open parens in column 0 are defun starters. Since
444 ;; we have c-state-cache that isn't useful and only causes trouble
445 ;; so turn it off.
446 (when (memq 'col-0-paren c-emacs-features)
447 (make-local-variable 'open-paren-in-column-0-is-defun-start)
448 (setq open-paren-in-column-0-is-defun-start nil))
449
450 ;; The `c-type' text property with `c-decl-end' is used to mark the
451 ;; ends of access keys to make interactive refontification work
452 ;; better.
453 (when c-opt-access-key
454 (setq c-type-decl-end-used t))
455
456 (c-clear-found-types)
457
458 ;; now set the mode style based on default-style
459 (let ((style (if (stringp default-style)
460 default-style
461 (or (cdr (assq mode default-style))
462 (cdr (assq 'other default-style))
130c507e
GM
463 "gnu"))))
464 ;; Override style variables if `c-old-style-variable-behavior' is
465 ;; set. Also override if we are using global style variables,
466 ;; have already initialized a style once, and are switching to a
467 ;; different style. (It's doubtful whether this is desirable, but
468 ;; the whole situation with nonlocal style variables is a bit
469 ;; awkward. It's at least the most compatible way with the old
470 ;; style init procedure.)
471 (c-set-style style (not (or c-old-style-variable-behavior
472 (and (not c-style-variables-are-local-p)
473 c-indentation-style
474 (not (string-equal c-indentation-style
475 style)))))))
a66cd3ee
MS
476 (c-setup-paragraph-variables)
477
130c507e
GM
478 ;; we have to do something special for c-offsets-alist so that the
479 ;; buffer local value has its own alist structure.
480 (setq c-offsets-alist (copy-alist c-offsets-alist))
a66cd3ee 481
130c507e 482 ;; setup the comment indent variable in a Emacs version portable way
130c507e
GM
483 (make-local-variable 'comment-indent-function)
484 (setq comment-indent-function 'c-comment-indent)
a66cd3ee 485
130c507e
GM
486 ;; put auto-hungry designators onto minor-mode-alist, but only once
487 (or (assq 'c-auto-hungry-string minor-mode-alist)
488 (setq minor-mode-alist
489 (cons '(c-auto-hungry-string c-auto-hungry-string)
490 minor-mode-alist)))
a66cd3ee 491
d9e94c22
MS
492 ;; Install the functions that ensure that various internal caches
493 ;; don't become invalid due to buffer changes.
494 (make-local-hook 'after-change-functions)
495 (add-hook 'after-change-functions 'c-after-change nil t))
496
497(defun c-after-font-lock-init ()
498 ;; Put on `font-lock-mode-hook'.
499 (remove-hook 'after-change-functions 'c-after-change t)
500 (add-hook 'after-change-functions 'c-after-change nil t))
501
502(defun c-font-lock-init ()
503 "Set up the font-lock variables for using the font-lock support in CC Mode.
504This does not load the font-lock package. Use after
505`c-basic-common-init' and after cc-fonts has been loaded."
506
507 (make-local-variable 'font-lock-defaults)
508 (setq font-lock-defaults
509 `(,(if (c-mode-is-new-awk-p)
510 ;; awk-mode currently has only one font lock level.
511 'awk-font-lock-keywords
512 (mapcar 'c-mode-symbol
513 '("font-lock-keywords" "font-lock-keywords-1"
514 "font-lock-keywords-2" "font-lock-keywords-3")))
515 nil nil
516 ,c-identifier-syntax-modifications
517 c-beginning-of-syntax
518 (font-lock-mark-block-function
519 . c-mark-function)))
520
521 (make-local-hook 'font-lock-mode-hook)
522 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
523
524(defun c-setup-doc-comment-style ()
525 "Initialize the variables that depend on the value of `c-doc-comment-style'."
526 (when (and (featurep 'font-lock)
527 (symbol-value 'font-lock-mode))
528 ;; Force font lock mode to reinitialize itself.
529 (font-lock-mode 0)
530 (font-lock-mode 1)))
531
532(defun c-common-init (&optional mode)
533 "Common initialization for all CC Mode modes.
534In addition to the work done by `c-basic-common-init' and
535`c-font-lock-init', this function sets up various other things as
536customary in CC Mode modes but which aren't strictly necessary for CC
537Mode to operate correctly.
538
539MODE is the symbol for the mode to initialize, like 'c-mode. See
540`c-basic-common-init' for details. It's only optional to be
541compatible with old code; callers should always specify it.
542
543This function does not do any hidden buffer changes."
544
545 (unless mode
546 ;; Called from an old third party package. The fallback is to
547 ;; initialize for C.
28d88c16 548 (c-init-language-vars-for 'c-mode))
d9e94c22
MS
549
550 (c-basic-common-init mode c-default-style)
551 (when mode
552 ;; Only initialize font locking if we aren't called from an old package.
553 (c-font-lock-init))
554
555 (make-local-variable 'outline-regexp)
556 (make-local-variable 'outline-level)
557 (setq outline-regexp "[^#\n\^M]"
558 outline-level 'c-outline-level)
559
560 (let ((rfn (assq mode c-require-final-newline)))
561 (when rfn
562 (make-local-variable 'require-final-newline)
563 (setq require-final-newline (cdr rfn)))))
130c507e
GM
564
565(defun c-postprocess-file-styles ()
d9e94c22 566 "Function that post processes relevant file local variables in CC Mode.
130c507e
GM
567Currently, this function simply applies any style and offset settings
568found in the file's Local Variable list. It first applies any style
569setting found in `c-file-style', then it applies any offset settings
570it finds in `c-file-offsets'.
571
572Note that the style variables are always made local to the buffer."
d9e94c22
MS
573 ;;
574 ;; This function does not do any hidden buffer changes.
575
130c507e 576 ;; apply file styles and offsets
09f90d2c
RS
577 (when c-buffer-is-cc-mode
578 (if (or c-file-style c-file-offsets)
579 (c-make-styles-buffer-local t))
580 (and c-file-style
581 (c-set-style c-file-style))
582 (and c-file-offsets
583 (mapcar
584 (lambda (langentry)
585 (let ((langelem (car langentry))
586 (offset (cdr langentry)))
587 (c-set-offset langelem offset)))
588 c-file-offsets))))
130c507e
GM
589
590(add-hook 'hack-local-variables-hook 'c-postprocess-file-styles)
591
592\f
593;; Support for C
594
d9e94c22
MS
595;;;###autoload
596(defvar c-mode-syntax-table nil
597 "Syntax table used in c-mode buffers.")
598(or c-mode-syntax-table
599 (setq c-mode-syntax-table
600 (funcall (c-lang-const c-make-mode-syntax-table c))))
601
130c507e
GM
602(defvar c-mode-abbrev-table nil
603 "Abbreviation table used in c-mode buffers.")
a66cd3ee
MS
604(c-define-abbrev-table 'c-mode-abbrev-table
605 '(("else" "else" c-electric-continued-statement 0)
606 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
607
608(defvar c-mode-map ()
609 "Keymap used in c-mode buffers.")
610(if c-mode-map
611 nil
612 (setq c-mode-map (c-make-inherited-keymap))
613 ;; add bindings which are only useful for C
614 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
615 )
616
617(easy-menu-define c-c-menu c-mode-map "C Mode Commands"
d9e94c22
MS
618 (cons "C" (c-lang-const c-mode-menu c)))
619
620;; In XEmacs >= 21.5 modes should add their own entries to
621;; `auto-mode-alist'. The comment form of autoload is used to avoid
622;; doing this on load. That since `add-to-list' prepends the value
623;; which could cause it to clobber user settings. Later emacsen have
624;; an append option, but it's not safe to use.
50fdde0e
MS
625
626;; The the extension ".C" is associated to C++ while the lowercase
627;; variant goes to C. On case insensitive file systems, this means
628;; that ".c" files also might open C++ mode if the C++ entry comes
629;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
630;; after ".c", and since `add-to-list' adds the entry first we have to
631;; add the ".C" entry first.
632;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
633;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
634;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
635
d9e94c22
MS
636;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
637
638;; NB: The following two associate yacc and lex files to C Mode, which
639;; is not really suitable for those formats. Anyway, afaik there's
640;; currently no better mode for them, and besides this is legacy.
641;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
642;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
643
785eecbb
RS
644;;;###autoload
645(defun c-mode ()
646 "Major mode for editing K&R and ANSI C code.
647To submit a problem report, enter `\\[c-submit-bug-report]' from a
648c-mode buffer. This automatically sets up a mail buffer with version
649information already added. You just need to add a description of the
50fdde0e 650problem, including a reproducible test case, and send the message.
785eecbb
RS
651
652To see what version of CC Mode you are running, enter `\\[c-version]'.
653
d9e94c22
MS
654The hook `c-mode-common-hook' is run with no args at mode
655initialization, then `c-mode-hook'.
785eecbb
RS
656
657Key bindings:
658\\{c-mode-map}"
659 (interactive)
785eecbb 660 (kill-all-local-variables)
d9e94c22 661 (c-initialize-cc-mode t)
785eecbb
RS
662 (set-syntax-table c-mode-syntax-table)
663 (setq major-mode 'c-mode
664 mode-name "C"
130c507e
GM
665 local-abbrev-table c-mode-abbrev-table
666 abbrev-mode t)
785eecbb 667 (use-local-map c-mode-map)
28d88c16 668 (c-init-language-vars-for 'c-mode)
a66cd3ee 669 (c-common-init 'c-mode)
d9e94c22 670 (easy-menu-add c-c-menu)
51f606de 671 (cc-imenu-init cc-imenu-c-generic-expression)
785eecbb
RS
672 (run-hooks 'c-mode-common-hook)
673 (run-hooks 'c-mode-hook)
674 (c-update-modeline))
675
676\f
130c507e
GM
677;; Support for C++
678
d9e94c22
MS
679;;;###autoload
680(defvar c++-mode-syntax-table nil
681 "Syntax table used in c++-mode buffers.")
682(or c++-mode-syntax-table
683 (setq c++-mode-syntax-table
684 (funcall (c-lang-const c-make-mode-syntax-table c++))))
685
130c507e
GM
686(defvar c++-mode-abbrev-table nil
687 "Abbreviation table used in c++-mode buffers.")
a66cd3ee
MS
688(c-define-abbrev-table 'c++-mode-abbrev-table
689 '(("else" "else" c-electric-continued-statement 0)
690 ("while" "while" c-electric-continued-statement 0)
691 ("catch" "catch" c-electric-continued-statement 0)))
130c507e
GM
692
693(defvar c++-mode-map ()
694 "Keymap used in c++-mode buffers.")
695(if c++-mode-map
696 nil
697 (setq c++-mode-map (c-make-inherited-keymap))
698 ;; add bindings which are only useful for C++
699 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
700 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
701 (define-key c++-mode-map "<" 'c-electric-lt-gt)
702 (define-key c++-mode-map ">" 'c-electric-lt-gt))
703
704(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
d9e94c22
MS
705 (cons "C++" (c-lang-const c-mode-menu c++)))
706
785eecbb
RS
707;;;###autoload
708(defun c++-mode ()
709 "Major mode for editing C++ code.
710To submit a problem report, enter `\\[c-submit-bug-report]' from a
711c++-mode buffer. This automatically sets up a mail buffer with
712version information already added. You just need to add a description
713of the problem, including a reproducible test case, and send the
714message.
715
716To see what version of CC Mode you are running, enter `\\[c-version]'.
717
d9e94c22
MS
718The hook `c-mode-common-hook' is run with no args at mode
719initialization, then `c++-mode-hook'.
785eecbb
RS
720
721Key bindings:
722\\{c++-mode-map}"
723 (interactive)
785eecbb 724 (kill-all-local-variables)
d9e94c22 725 (c-initialize-cc-mode t)
785eecbb
RS
726 (set-syntax-table c++-mode-syntax-table)
727 (setq major-mode 'c++-mode
728 mode-name "C++"
130c507e
GM
729 local-abbrev-table c++-mode-abbrev-table
730 abbrev-mode t)
785eecbb 731 (use-local-map c++-mode-map)
28d88c16 732 (c-init-language-vars-for 'c++-mode)
a66cd3ee 733 (c-common-init 'c++-mode)
d9e94c22 734 (easy-menu-add c-c++-menu)
51f606de 735 (cc-imenu-init cc-imenu-c++-generic-expression)
785eecbb
RS
736 (run-hooks 'c-mode-common-hook)
737 (run-hooks 'c++-mode-hook)
738 (c-update-modeline))
739
740\f
130c507e
GM
741;; Support for Objective-C
742
d9e94c22
MS
743;;;###autoload
744(defvar objc-mode-syntax-table nil
745 "Syntax table used in objc-mode buffers.")
746(or objc-mode-syntax-table
747 (setq objc-mode-syntax-table
748 (funcall (c-lang-const c-make-mode-syntax-table objc))))
749
130c507e
GM
750(defvar objc-mode-abbrev-table nil
751 "Abbreviation table used in objc-mode buffers.")
a66cd3ee
MS
752(c-define-abbrev-table 'objc-mode-abbrev-table
753 '(("else" "else" c-electric-continued-statement 0)
754 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
755
756(defvar objc-mode-map ()
757 "Keymap used in objc-mode buffers.")
758(if objc-mode-map
759 nil
760 (setq objc-mode-map (c-make-inherited-keymap))
761 ;; add bindings which are only useful for Objective-C
762 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
763
764(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
d9e94c22
MS
765 (cons "ObjC" (c-lang-const c-mode-menu objc)))
766
767;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
130c507e 768
785eecbb
RS
769;;;###autoload
770(defun objc-mode ()
771 "Major mode for editing Objective C code.
772To submit a problem report, enter `\\[c-submit-bug-report]' from an
773objc-mode buffer. This automatically sets up a mail buffer with
774version information already added. You just need to add a description
775of the problem, including a reproducible test case, and send the
776message.
777
778To see what version of CC Mode you are running, enter `\\[c-version]'.
779
d9e94c22
MS
780The hook `c-mode-common-hook' is run with no args at mode
781initialization, then `objc-mode-hook'.
785eecbb
RS
782
783Key bindings:
784\\{objc-mode-map}"
785 (interactive)
785eecbb 786 (kill-all-local-variables)
d9e94c22 787 (c-initialize-cc-mode t)
785eecbb
RS
788 (set-syntax-table objc-mode-syntax-table)
789 (setq major-mode 'objc-mode
790 mode-name "ObjC"
130c507e
GM
791 local-abbrev-table objc-mode-abbrev-table
792 abbrev-mode t)
d9e94c22
MS
793 ;; The `c-type' text property with `c-decl-end' is used to mark the
794 ;; end of the @-style directives.
795 (setq c-type-decl-end-used t)
785eecbb 796 (use-local-map objc-mode-map)
28d88c16 797 (c-init-language-vars-for 'objc-mode)
a66cd3ee 798 (c-common-init 'objc-mode)
d9e94c22
MS
799 (easy-menu-add c-objc-menu)
800 (cc-imenu-init nil 'cc-imenu-objc-function)
785eecbb
RS
801 (run-hooks 'c-mode-common-hook)
802 (run-hooks 'objc-mode-hook)
803 (c-update-modeline))
804
805\f
130c507e
GM
806;; Support for Java
807
d9e94c22
MS
808;;;###autoload
809(defvar java-mode-syntax-table nil
810 "Syntax table used in java-mode buffers.")
811(or java-mode-syntax-table
812 (setq java-mode-syntax-table
813 (funcall (c-lang-const c-make-mode-syntax-table java))))
814
130c507e
GM
815(defvar java-mode-abbrev-table nil
816 "Abbreviation table used in java-mode buffers.")
a66cd3ee
MS
817(c-define-abbrev-table 'java-mode-abbrev-table
818 '(("else" "else" c-electric-continued-statement 0)
819 ("while" "while" c-electric-continued-statement 0)
820 ("catch" "catch" c-electric-continued-statement 0)
821 ("finally" "finally" c-electric-continued-statement 0)))
130c507e
GM
822
823(defvar java-mode-map ()
824 "Keymap used in java-mode buffers.")
825(if java-mode-map
826 nil
827 (setq java-mode-map (c-make-inherited-keymap))
828 ;; add bindings which are only useful for Java
829 )
830
d9e94c22
MS
831;; Regexp trying to describe the beginning of a Java top-level
832;; definition. This is not used by CC Mode, nor is it maintained
833;; since it's practically impossible to write a regexp that reliably
834;; matches such a construct. Other tools are necessary.
835(defconst c-Java-defun-prompt-regexp
836 "^[ \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-*")
837
130c507e 838(easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
d9e94c22
MS
839 (cons "Java" (c-lang-const c-mode-menu java)))
840
841;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
130c507e 842
785eecbb
RS
843;;;###autoload
844(defun java-mode ()
845 "Major mode for editing Java code.
dc2b4c5f 846To submit a problem report, enter `\\[c-submit-bug-report]' from a
785eecbb
RS
847java-mode buffer. This automatically sets up a mail buffer with
848version information already added. You just need to add a description
50fdde0e 849of the problem, including a reproducible test case, and send the
785eecbb
RS
850message.
851
852To see what version of CC Mode you are running, enter `\\[c-version]'.
853
d9e94c22
MS
854The hook `c-mode-common-hook' is run with no args at mode
855initialization, then `java-mode-hook'.
785eecbb
RS
856
857Key bindings:
858\\{java-mode-map}"
859 (interactive)
785eecbb 860 (kill-all-local-variables)
d9e94c22 861 (c-initialize-cc-mode t)
785eecbb
RS
862 (set-syntax-table java-mode-syntax-table)
863 (setq major-mode 'java-mode
864 mode-name "Java"
91b807c9 865 local-abbrev-table java-mode-abbrev-table
a66cd3ee 866 abbrev-mode t)
785eecbb 867 (use-local-map java-mode-map)
28d88c16 868 (c-init-language-vars-for 'java-mode)
a66cd3ee 869 (c-common-init 'java-mode)
d9e94c22 870 (easy-menu-add c-java-menu)
51f606de 871 (cc-imenu-init cc-imenu-java-generic-expression)
785eecbb
RS
872 (run-hooks 'c-mode-common-hook)
873 (run-hooks 'java-mode-hook)
874 (c-update-modeline))
875
876\f
130c507e
GM
877;; Support for CORBA's IDL language
878
d9e94c22
MS
879;;;###autoload
880(defvar idl-mode-syntax-table nil
881 "Syntax table used in idl-mode buffers.")
882(or idl-mode-syntax-table
883 (setq idl-mode-syntax-table
884 (funcall (c-lang-const c-make-mode-syntax-table idl))))
885
130c507e
GM
886(defvar idl-mode-abbrev-table nil
887 "Abbreviation table used in idl-mode buffers.")
a66cd3ee 888(c-define-abbrev-table 'idl-mode-abbrev-table nil)
130c507e
GM
889
890(defvar idl-mode-map ()
891 "Keymap used in idl-mode buffers.")
892(if idl-mode-map
893 nil
894 (setq idl-mode-map (c-make-inherited-keymap))
895 ;; add bindings which are only useful for IDL
896 )
897
898(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
d9e94c22
MS
899 (cons "IDL" (c-lang-const c-mode-menu idl)))
900
901;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
130c507e 902
aac90c52
RS
903;;;###autoload
904(defun idl-mode ()
d9e94c22 905 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
aac90c52
RS
906To submit a problem report, enter `\\[c-submit-bug-report]' from an
907idl-mode buffer. This automatically sets up a mail buffer with
908version information already added. You just need to add a description
909of the problem, including a reproducible test case, and send the
910message.
911
912To see what version of CC Mode you are running, enter `\\[c-version]'.
913
d9e94c22
MS
914The hook `c-mode-common-hook' is run with no args at mode
915initialization, then `idl-mode-hook'.
aac90c52
RS
916
917Key bindings:
918\\{idl-mode-map}"
919 (interactive)
aac90c52 920 (kill-all-local-variables)
d9e94c22 921 (c-initialize-cc-mode t)
aac90c52
RS
922 (set-syntax-table idl-mode-syntax-table)
923 (setq major-mode 'idl-mode
924 mode-name "IDL"
925 local-abbrev-table idl-mode-abbrev-table)
926 (use-local-map idl-mode-map)
28d88c16 927 (c-init-language-vars-for 'idl-mode)
a66cd3ee 928 (c-common-init 'idl-mode)
d9e94c22
MS
929 (easy-menu-add c-idl-menu)
930 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
aac90c52
RS
931 (run-hooks 'c-mode-common-hook)
932 (run-hooks 'idl-mode-hook)
933 (c-update-modeline))
934
935\f
130c507e
GM
936;; Support for Pike
937
d9e94c22
MS
938;;;###autoload
939(defvar pike-mode-syntax-table nil
940 "Syntax table used in pike-mode buffers.")
941(or pike-mode-syntax-table
942 (setq pike-mode-syntax-table
943 (funcall (c-lang-const c-make-mode-syntax-table pike))))
944
130c507e
GM
945(defvar pike-mode-abbrev-table nil
946 "Abbreviation table used in pike-mode buffers.")
a66cd3ee
MS
947(c-define-abbrev-table 'pike-mode-abbrev-table
948 '(("else" "else" c-electric-continued-statement 0)
949 ("while" "while" c-electric-continued-statement 0)))
130c507e
GM
950
951(defvar pike-mode-map ()
952 "Keymap used in pike-mode buffers.")
953(if pike-mode-map
954 nil
955 (setq pike-mode-map (c-make-inherited-keymap))
956 ;; additional bindings
957 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
958
959(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
d9e94c22
MS
960 (cons "Pike" (c-lang-const c-mode-menu pike)))
961
50fdde0e
MS
962;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
963;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
130c507e 964
0ec8351b
BW
965;;;###autoload
966(defun pike-mode ()
967 "Major mode for editing Pike code.
a66cd3ee
MS
968To submit a problem report, enter `\\[c-submit-bug-report]' from a
969pike-mode buffer. This automatically sets up a mail buffer with
0ec8351b
BW
970version information already added. You just need to add a description
971of the problem, including a reproducible test case, and send the
972message.
973
974To see what version of CC Mode you are running, enter `\\[c-version]'.
975
d9e94c22
MS
976The hook `c-mode-common-hook' is run with no args at mode
977initialization, then `pike-mode-hook'.
0ec8351b
BW
978
979Key bindings:
980\\{pike-mode-map}"
981 (interactive)
0ec8351b 982 (kill-all-local-variables)
d9e94c22 983 (c-initialize-cc-mode t)
0ec8351b
BW
984 (set-syntax-table pike-mode-syntax-table)
985 (setq major-mode 'pike-mode
986 mode-name "Pike"
130c507e 987 local-abbrev-table pike-mode-abbrev-table
a66cd3ee 988 abbrev-mode t)
0ec8351b 989 (use-local-map pike-mode-map)
28d88c16 990 (c-init-language-vars-for 'pike-mode)
a66cd3ee 991 (c-common-init 'pike-mode)
d9e94c22
MS
992 (easy-menu-add c-pike-menu)
993 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
0ec8351b
BW
994 (run-hooks 'c-mode-common-hook)
995 (run-hooks 'pike-mode-hook)
996 (c-update-modeline))
997
998\f
d9e94c22
MS
999;; Support for awk. This is purposely disabled for older (X)Emacsen which
1000;; don't support syntax-table properties.
1001
50fdde0e
MS
1002;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1003;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1004;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1005;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1006;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
d9e94c22 1007
50fdde0e
MS
1008;;; Autoload directives must be on the top level, so we construct an
1009;;; autoload form instead.
1010;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code.")
1011
1012(if (not (memq 'syntax-properties c-emacs-features))
1013 (autoload 'awk-mode "awk-mode" "Major mode for editing AWK code." t)
d9e94c22 1014
d9e94c22
MS
1015 (defvar awk-mode-abbrev-table nil
1016 "Abbreviation table used in awk-mode buffers.")
1017 (c-define-abbrev-table 'awk-mode-abbrev-table
1018 '(("else" "else" c-electric-continued-statement 0)
1019 ("while" "while" c-electric-continued-statement 0)))
1020
1021 (defvar awk-mode-map ()
1022 "Keymap used in awk-mode buffers.")
1023 (if awk-mode-map
1024 nil
1025 (setq awk-mode-map (c-make-inherited-keymap))
1026 ;; add bindings which are only useful for awk.
1027 (define-key awk-mode-map "#" 'self-insert-command)
1028 (define-key awk-mode-map "/" 'self-insert-command)
1029 (define-key awk-mode-map "*" 'self-insert-command)
1030 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1031 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1032 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1033 (define-key awk-mode-map "\M-a" 'undefined) ; c-awk-beginning-of-statement isn't yet implemented.
1034 (define-key awk-mode-map "\M-e" 'undefined) ; c-awk-end-of-statement isn't yet implemented.
1035 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1036 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1037
1038 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1039 (cons "AWK" (c-lang-const c-mode-menu awk)))
1040
d9e94c22
MS
1041 (defun awk-mode ()
1042 "Major mode for editing AWK code.
1043To submit a problem report, enter `\\[c-submit-bug-report]' from an
1044awk-mode buffer. This automatically sets up a mail buffer with version
1045information already added. You just need to add a description of the
50fdde0e 1046problem, including a reproducible test case, and send the message.
d9e94c22
MS
1047
1048To see what version of CC Mode you are running, enter `\\[c-version]'.
1049
1050The hook `c-mode-common-hook' is run with no args at mode
1051initialization, then `awk-mode-hook'.
1052
1053Key bindings:
1054\\{awk-mode-map}"
1055 (interactive)
1056 (require 'cc-awk) ; Added 2003/6/10.
1057 (kill-all-local-variables)
1058 (c-initialize-cc-mode t)
1059 (set-syntax-table awk-mode-syntax-table)
1060 (setq major-mode 'awk-mode
1061 mode-name "AWK"
1062 local-abbrev-table awk-mode-abbrev-table
1063 abbrev-mode t)
1064 (use-local-map awk-mode-map)
28d88c16 1065 (c-init-language-vars-for 'awk-mode)
d9e94c22
MS
1066 (c-common-init 'awk-mode)
1067 ;; The rest of CC Mode does not (yet) use `font-lock-syntactic-keywords',
1068 ;; so it's not set by `c-font-lock-init'.
1069 (make-local-variable 'font-lock-syntactic-keywords)
1070 (setq font-lock-syntactic-keywords
1071 '((c-awk-set-syntax-table-properties
1072 0 (0) ; Everything on this line is a dummy.
1073 nil t)))
1074 (c-awk-unstick-NL-prop)
1075 (add-hook 'before-change-functions 'c-awk-before-change nil t)
1076 (add-hook 'after-change-functions 'c-awk-after-change nil t)
1077 (c-save-buffer-state nil
1078 (save-restriction
1079 (widen)
1080 (c-awk-clear-NL-props (point-min) (point-max))
1081 (c-awk-after-change (point-min) (point-max) 0))) ; Set syntax-table props.
1082
1083 ;; Prevent Xemacs's buffer-syntactic-context being used. See the comment
1084 ;; in cc-engine.el, just before (defun c-fast-in-literal ...
1085 (defalias 'c-in-literal 'c-slow-in-literal)
1086
1087 (run-hooks 'c-mode-common-hook)
1088 (run-hooks 'awk-mode-hook)
1089 (c-update-modeline))
1090) ;; closes the (if (not (memq 'syntax-properties c-emacs-features))
1091
1092\f
c2efc1d0 1093;; bug reporting
785eecbb
RS
1094
1095(defconst c-mode-help-address
a66cd3ee
MS
1096 "bug-cc-mode@gnu.org"
1097 "Address(es) for CC Mode bug reports.")
785eecbb
RS
1098
1099(defun c-version ()
1100 "Echo the current version of CC Mode in the minibuffer."
1101 (interactive)
1102 (message "Using CC Mode version %s" c-version)
1103 (c-keep-region-active))
1104
130c507e
GM
1105(defvar c-prepare-bug-report-hooks nil)
1106
1107;; Dynamic variables used by reporter.
1108(defvar reporter-prompt-for-summary-p)
1109(defvar reporter-dont-compact-list)
1110
785eecbb
RS
1111(defun c-submit-bug-report ()
1112 "Submit via mail a bug report on CC Mode."
1113 (interactive)
77e31a8d 1114 (require 'reporter)
785eecbb
RS
1115 ;; load in reporter
1116 (let ((reporter-prompt-for-summary-p t)
1117 (reporter-dont-compact-list '(c-offsets-alist))
1118 (style c-indentation-style)
785eecbb
RS
1119 (c-features c-emacs-features))
1120 (and
1121 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1122 t (message "") nil)
785eecbb
RS
1123 (reporter-submit-bug-report
1124 c-mode-help-address
d9e94c22 1125 (concat "CC Mode " c-version " (" mode-name ")")
51f606de 1126 (let ((vars (append
51f606de 1127 c-style-variables
d9e94c22 1128 '(c-buffer-is-cc-mode
51f606de 1129 c-tab-always-indent
d9e94c22
MS
1130 c-syntactic-indentation
1131 c-syntactic-indentation-in-macros
1132 c-ignore-auto-fill
1133 c-auto-align-backslashes
1134 c-backspace-function
1135 c-delete-function
1136 c-electric-pound-behavior
1137 c-default-style
1138 c-enable-xemacs-performance-kludge-p
1139 c-old-style-variable-behavior
51f606de
GM
1140 defun-prompt-regexp
1141 tab-width
1142 comment-column
1143 parse-sexp-ignore-comments
d9e94c22
MS
1144 parse-sexp-lookup-properties
1145 lookup-syntax-properties
51f606de
GM
1146 ;; A brain-damaged XEmacs only variable that, if
1147 ;; set to nil can cause all kinds of chaos.
1148 signal-error-on-buffer-boundary
1149 ;; Variables that affect line breaking and comments.
d9e94c22 1150 auto-fill-mode
91b807c9 1151 auto-fill-function
51f606de
GM
1152 filladapt-mode
1153 comment-multi-line
1154 comment-start-skip
1155 fill-prefix
d9e94c22 1156 fill-column
51f606de
GM
1157 paragraph-start
1158 adaptive-fill-mode
1159 adaptive-fill-regexp)
1160 nil)))
d9e94c22
MS
1161 (mapcar (lambda (var) (unless (boundp var)
1162 (setq vars (delq var vars))))
91b807c9
GM
1163 '(signal-error-on-buffer-boundary
1164 filladapt-mode
d9e94c22
MS
1165 defun-prompt-regexp
1166 font-lock-mode
1167 font-lock-maximum-decoration
1168 parse-sexp-lookup-properties
1169 lookup-syntax-properties))
51f606de 1170 vars)
9714ec23 1171 (lambda ()
a66cd3ee 1172 (run-hooks 'c-prepare-bug-report-hooks)
d9e94c22 1173 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
a66cd3ee 1174 style c-features)))))))
785eecbb
RS
1175
1176\f
130c507e 1177(cc-provide 'cc-mode)
6b61353c
KH
1178
1179;;; arch-tag: 7825e5c4-fd09-439f-a04d-4c13208ba3d7
785eecbb 1180;;; cc-mode.el ends here