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