Spelling fixes.
[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-2011 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
494 ;; now set their values
495 (set (make-local-variable 'parse-sexp-ignore-comments) t)
496 (set (make-local-variable 'indent-line-function) 'c-indent-line)
497 (set (make-local-variable 'indent-region-function) 'c-indent-region)
498 (set (make-local-variable 'normal-auto-fill-function) 'c-do-auto-fill)
499 (set (make-local-variable 'comment-multi-line) t)
500 (set (make-local-variable 'comment-line-break-function)
501 'c-indent-new-comment-line)
502
503 ;; Install `c-fill-paragraph' on `fill-paragraph-function' so that a
504 ;; direct call to `fill-paragraph' behaves better. This still
505 ;; doesn't work with filladapt but it's better than nothing.
506 (set (make-local-variable 'fill-paragraph-function) 'c-fill-paragraph)
507
508 ;; Initialize the cache of brace pairs, and opening braces/brackets/parens.
509 (c-state-cache-init)
510
511 (when (or c-recognize-<>-arglists
512 (c-major-mode-is 'awk-mode)
513 (c-major-mode-is '(java-mode c-mode c++-mode objc-mode)))
514 ;; We'll use the syntax-table text property to change the syntax
515 ;; of some chars for this language, so do the necessary setup for
516 ;; that.
517 ;;
518 ;; Note to other package developers: It's ok to turn this on in CC
519 ;; Mode buffers when CC Mode doesn't, but it's not ok to turn it
520 ;; off if CC Mode has turned it on.
521
522 ;; Emacs.
523 (when (boundp 'parse-sexp-lookup-properties)
524 (set (make-local-variable 'parse-sexp-lookup-properties) t))
525
526 ;; Same as above for XEmacs.
527 (when (boundp 'lookup-syntax-properties)
528 (set (make-local-variable 'lookup-syntax-properties) t)))
529
530 ;; Use this in Emacs 21+ to avoid meddling with the rear-nonsticky
531 ;; property on each character.
532 (when (boundp 'text-property-default-nonsticky)
533 (mapc (lambda (tprop)
534 (unless (assq tprop text-property-default-nonsticky)
535 (set (make-local-variable 'text-property-default-nonsticky)
536 (cons `(,tprop . t) text-property-default-nonsticky))))
537 '(syntax-table category c-type)))
538
539 ;; In Emacs 21 and later it's possible to turn off the ad-hoc
540 ;; heuristic that open parens in column 0 are defun starters. Since
541 ;; we have c-state-cache, that heuristic isn't useful and only causes
542 ;; trouble, so turn it off.
543 ;; 2006/12/17: This facility is somewhat confused, and doesn't really seem
544 ;; helpful. Comment it out for now.
545 ;; (when (memq 'col-0-paren c-emacs-features)
546 ;; (make-local-variable 'open-paren-in-column-0-is-defun-start)
547 ;; (setq open-paren-in-column-0-is-defun-start nil))
548
549 (c-clear-found-types)
550
551 ;; now set the mode style based on default-style
552 (let ((style (cc-choose-style-for-mode mode default-style)))
553 ;; Override style variables if `c-old-style-variable-behavior' is
554 ;; set. Also override if we are using global style variables,
555 ;; have already initialized a style once, and are switching to a
556 ;; different style. (It's doubtful whether this is desirable, but
557 ;; the whole situation with nonlocal style variables is a bit
558 ;; awkward. It's at least the most compatible way with the old
559 ;; style init procedure.)
560 (c-set-style style (not (or c-old-style-variable-behavior
561 (and (not c-style-variables-are-local-p)
562 c-indentation-style
563 (not (string-equal c-indentation-style
564 style)))))))
565 (c-setup-paragraph-variables)
566
567 ;; we have to do something special for c-offsets-alist so that the
568 ;; buffer local value has its own alist structure.
569 (setq c-offsets-alist (copy-alist c-offsets-alist))
570
571 ;; setup the comment indent variable in a Emacs version portable way
572 (set (make-local-variable 'comment-indent-function) 'c-comment-indent)
573
574 ;; ;; Put submode indicators onto minor-mode-alist, but only once.
575 ;; (or (assq 'c-submode-indicators minor-mode-alist)
576 ;; (setq minor-mode-alist
577 ;; (cons '(c-submode-indicators c-submode-indicators)
578 ;; minor-mode-alist)))
579 (c-update-modeline)
580
581 ;; Install the functions that ensure that various internal caches
582 ;; don't become invalid due to buffer changes.
583 (when (featurep 'xemacs)
584 (make-local-hook 'before-change-functions)
585 (make-local-hook 'after-change-functions))
586 (add-hook 'before-change-functions 'c-before-change nil t)
587 (add-hook 'after-change-functions 'c-after-change nil t)
588 (set (make-local-variable 'font-lock-extend-after-change-region-function)
589 'c-extend-after-change-region)) ; Currently (2009-05) used by all
590 ; languages with #define (C, C++,; ObjC), and by AWK.
591
592 (defun c-setup-doc-comment-style ()
593 "Initialize the variables that depend on the value of `c-doc-comment-style'."
594 (when (and (featurep 'font-lock)
595 (symbol-value 'font-lock-mode))
596 ;; Force font lock mode to reinitialize itself.
597 (font-lock-mode 0)
598 (font-lock-mode 1)))
599
600 ;; Buffer local variables defining the region to be fontified by a font lock
601 ;; after-change function. They are set in c-after-change to
602 ;; after-change-functions' BEG and END, and may be modified by functions in
603 ;; `c-before-font-lock-functions'.
604 (defvar c-new-BEG 0)
605 (make-variable-buffer-local 'c-new-BEG)
606 (defvar c-new-END 0)
607 (make-variable-buffer-local 'c-new-END)
608
609 (defun c-common-init (&optional mode)
610 "Common initialization for all CC Mode modes.
611 In addition to the work done by `c-basic-common-init' and
612 `c-font-lock-init', this function sets up various other things as
613 customary in CC Mode modes but which aren't strictly necessary for CC
614 Mode to operate correctly.
615
616 MODE is the symbol for the mode to initialize, like 'c-mode. See
617 `c-basic-common-init' for details. It's only optional to be
618 compatible with old code; callers should always specify it."
619
620 (unless mode
621 ;; Called from an old third party package. The fallback is to
622 ;; initialize for C.
623 (c-init-language-vars-for 'c-mode))
624
625 (c-basic-common-init mode c-default-style)
626 (when mode
627 ;; Only initialize font locking if we aren't called from an old package.
628 (c-font-lock-init))
629
630 ;; Starting a mode is a sort of "change". So call the change functions...
631 (save-restriction
632 (widen)
633 (setq c-new-BEG (point-min))
634 (setq c-new-END (point-max))
635 (save-excursion
636 (mapc (lambda (fn)
637 (funcall fn (point-min) (point-max)))
638 c-get-state-before-change-functions)
639 (mapc (lambda (fn)
640 (funcall fn (point-min) (point-max)
641 (- (point-max) (point-min))))
642 c-before-font-lock-functions)))
643
644 (set (make-local-variable 'outline-regexp) "[^#\n\^M]")
645 (set (make-local-variable 'outline-level) 'c-outline-level)
646
647 (let ((rfn (assq mode c-require-final-newline)))
648 (when rfn
649 (and (cdr rfn)
650 (set (make-local-variable 'require-final-newline)
651 mode-require-final-newline)))))
652
653 (defun c-count-cfss (lv-alist)
654 ;; LV-ALIST is an alist like `file-local-variables-alist'. Count how many
655 ;; elements with the key `c-file-style' there are in it.
656 (let ((elt-ptr lv-alist) elt (cownt 0))
657 (while elt-ptr
658 (setq elt (car elt-ptr)
659 elt-ptr (cdr elt-ptr))
660 (when (eq (car elt) 'c-file-style)
661 (setq cownt (1+ cownt))))
662 cownt))
663
664 (defun c-before-hack-hook ()
665 "Set the CC Mode style and \"offsets\" when in the buffer's local variables.
666 They are set only when, respectively, the pseudo variables
667 `c-file-style' and `c-file-offsets' are present in the list.
668
669 This function is called from the hook `before-hack-local-variables-hook'."
670 (when c-buffer-is-cc-mode
671 (let ((mode-cons (assq 'mode file-local-variables-alist))
672 (stile (cdr (assq 'c-file-style file-local-variables-alist)))
673 (offsets (cdr (assq 'c-file-offsets file-local-variables-alist))))
674 (when mode-cons
675 (hack-one-local-variable (car mode-cons) (cdr mode-cons))
676 (setq file-local-variables-alist
677 (delq mode-cons file-local-variables-alist)))
678 (when stile
679 (or (stringp stile) (error "c-file-style is not a string"))
680 (if (boundp 'dir-local-variables-alist)
681 ;; Determine whether `c-file-style' was set in the file's local
682 ;; variables or in a .dir-locals.el (a directory setting).
683 (let ((cfs-in-file-and-dir-count
684 (c-count-cfss file-local-variables-alist))
685 (cfs-in-dir-count (c-count-cfss dir-local-variables-alist)))
686 (c-set-style stile
687 (and (= cfs-in-file-and-dir-count cfs-in-dir-count)
688 'keep-defaults)))
689 (c-set-style stile)))
690 (when offsets
691 (mapc
692 (lambda (langentry)
693 (let ((langelem (car langentry))
694 (offset (cdr langentry)))
695 (c-set-offset langelem offset)))
696 offsets)))))
697
698 (defun c-remove-any-local-eval-or-mode-variables ()
699 ;; If the buffer specifies `mode' or `eval' in its File Local Variable list
700 ;; or on the first line, remove all occurrences. See
701 ;; `c-postprocess-file-styles' for justification. There is no need to save
702 ;; point here, or even bother too much about the buffer contents. However,
703 ;; DON'T mess up the kill-ring.
704 ;;
705 ;; Most of the code here is derived from Emacs 21.3's `hack-local-variables'
706 ;; in files.el.
707 (goto-char (point-max))
708 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
709 (let (lv-point (prefix "") (suffix ""))
710 (when (let ((case-fold-search t))
711 (search-forward "Local Variables:" nil t))
712 (setq lv-point (point))
713 ;; The prefix is what comes before "local variables:" in its line.
714 ;; The suffix is what comes after "local variables:" in its line.
715 (skip-chars-forward " \t")
716 (or (eolp)
717 (setq suffix (buffer-substring (point)
718 (progn (end-of-line) (point)))))
719 (goto-char (match-beginning 0))
720 (or (bolp)
721 (setq prefix
722 (buffer-substring (point)
723 (progn (beginning-of-line) (point)))))
724
725 (while (search-forward-regexp
726 (concat "^[ \t]*"
727 (regexp-quote prefix)
728 "\\(mode\\|eval\\):.*"
729 (regexp-quote suffix)
730 "$")
731 nil t)
732 (forward-line 0)
733 (delete-region (point) (progn (forward-line) (point)))))
734
735 ;; Delete the first line, if we've got one, in case it contains a mode spec.
736 (unless (and lv-point
737 (progn (goto-char lv-point)
738 (forward-line 0)
739 (bobp)))
740 (goto-char (point-min))
741 (unless (eobp)
742 (delete-region (point) (progn (forward-line) (point)))))))
743
744 (defun c-postprocess-file-styles ()
745 "Function that post processes relevant file local variables in CC Mode.
746 Currently, this function simply applies any style and offset settings
747 found in the file's Local Variable list. It first applies any style
748 setting found in `c-file-style', then it applies any offset settings
749 it finds in `c-file-offsets'.
750
751 Note that the style variables are always made local to the buffer."
752
753 ;; apply file styles and offsets
754 (when c-buffer-is-cc-mode
755 (if (or c-file-style c-file-offsets)
756 (c-make-styles-buffer-local t))
757 (when c-file-style
758 (or (stringp c-file-style)
759 (error "c-file-style is not a string"))
760 (c-set-style c-file-style))
761
762 (and c-file-offsets
763 (mapc
764 (lambda (langentry)
765 (let ((langelem (car langentry))
766 (offset (cdr langentry)))
767 (c-set-offset langelem offset)))
768 c-file-offsets))
769 ;; Problem: The file local variable block might have explicitly set a
770 ;; style variable. The `c-set-style' or `mapcar' call might have
771 ;; overwritten this. So we run `hack-local-variables' again to remedy
772 ;; this. There are no guarantees this will work properly, particularly as
773 ;; we have no control over what the other hook functions on
774 ;; `hack-local-variables-hook' would have done. We now (2006/2/1) remove
775 ;; any `eval' or `mode' expressions before we evaluate again (see below).
776 ;; ACM, 2005/11/2.
777 ;;
778 ;; Problem (bug reported by Gustav Broberg): if one of the variables is
779 ;; `mode', this will invoke c-mode (etc.) again, setting up the style etc.
780 ;; We prevent this by temporarily removing `mode' from the Local Variables
781 ;; section.
782 (if (or c-file-style c-file-offsets)
783 (let ((hack-local-variables-hook nil) (inhibit-read-only t))
784 (c-tentative-buffer-changes
785 (c-remove-any-local-eval-or-mode-variables)
786 (hack-local-variables))
787 nil))))
788
789 (if (boundp 'before-hack-local-variables-hook)
790 (add-hook 'before-hack-local-variables-hook 'c-before-hack-hook)
791 (add-hook 'hack-local-variables-hook 'c-postprocess-file-styles))
792
793 (defmacro c-run-mode-hooks (&rest hooks)
794 ;; Emacs 21.1 has introduced a system with delayed mode hooks that
795 ;; requires the use of the new function `run-mode-hooks'.
796 (if (cc-bytecomp-fboundp 'run-mode-hooks)
797 `(run-mode-hooks ,@hooks)
798 `(progn ,@(mapcar (lambda (hook) `(run-hooks ,hook)) hooks))))
799
800 \f
801 ;;; Change hooks, linking with Font Lock.
802
803 ;; Buffer local variables recording Beginning/End-of-Macro position before a
804 ;; change, when a macro straddles, respectively, the BEG or END (or both) of
805 ;; the change region. Otherwise these have the values BEG/END.
806 (defvar c-old-BOM 0)
807 (make-variable-buffer-local 'c-old-BOM)
808 (defvar c-old-EOM 0)
809 (make-variable-buffer-local 'c-old-EOM)
810
811 (defun c-extend-region-for-CPP (beg end)
812 ;; Set c-old-BOM or c-old-EOM respectively to BEG, END, each extended to the
813 ;; beginning/end of any preprocessor construct they may be in.
814 ;;
815 ;; Point is undefined both before and after this function call; the buffer
816 ;; has already been widened, and match-data saved. The return value is
817 ;; meaningless.
818 ;;
819 ;; This function is in the C/C++/ObjC values of
820 ;; `c-get-state-before-change-functions' and is called exclusively as a
821 ;; before change function.
822 (goto-char beg)
823 (c-beginning-of-macro)
824 (setq c-old-BOM (point))
825
826 (goto-char end)
827 (when (c-beginning-of-macro)
828 (c-end-of-macro)
829 (or (eobp) (forward-char))) ; Over the terminating NL which may be marked
830 ; with a c-cpp-delimiter category property
831 (setq c-old-EOM (point)))
832
833 (defun c-extend-font-lock-region-for-macros (begg endd &optional old-len)
834 ;; Extend the region (BEGG ENDD) to cover all (possibly changed)
835 ;; preprocessor macros; return the cons (new-BEG . new-END). OLD-LEN should
836 ;; be either the old length parameter when called from an
837 ;; after-change-function, or nil otherwise. This defun uses the variables
838 ;; c-old-BOM, c-new-BOM.
839 ;;
840 ;; Point is undefined on both entry and exit to this function. The buffer
841 ;; will have been widened on entry.
842 (let (limits new-beg new-end)
843 (goto-char c-old-BOM) ; already set to old start of macro or begg.
844 (setq new-beg
845 (min begg
846 (if (setq limits (c-state-literal-at (point)))
847 (cdr limits) ; go forward out of any string or comment.
848 (point))))
849
850 (goto-char endd)
851 (if (setq limits (c-state-literal-at (point)))
852 (goto-char (car limits))) ; go backward out of any string or comment.
853 (if (c-beginning-of-macro)
854 (c-end-of-macro))
855 (setq new-end (max endd
856 (if old-len
857 (+ (- c-old-EOM old-len) (- endd begg))
858 c-old-EOM)
859 (point)))
860 (cons new-beg new-end)))
861
862 (defun c-neutralize-CPP-line (beg end)
863 ;; BEG and END bound a region, typically a preprocessor line. Put a
864 ;; "punctuation" syntax-table property on syntactically obtrusive
865 ;; characters, ones which would interact syntactically with stuff outside
866 ;; this region.
867 ;;
868 ;; These are unmatched string delimiters, or unmatched
869 ;; parens/brackets/braces. An unclosed comment is regarded as valid, NOT
870 ;; obtrusive.
871 (save-excursion
872 (let (s)
873 (while
874 (progn
875 (setq s (parse-partial-sexp beg end -1))
876 (cond
877 ((< (nth 0 s) 0) ; found an unmated ),},]
878 (c-put-char-property (1- (point)) 'syntax-table '(1))
879 t)
880 ((nth 3 s) ; In a string
881 (c-put-char-property (nth 8 s) 'syntax-table '(1))
882 t)
883 ((> (nth 0 s) 0) ; In a (,{,[
884 (c-put-char-property (nth 1 s) 'syntax-table '(1))
885 t)
886 (t nil)))))))
887
888 (defun c-neutralize-syntax-in-and-mark-CPP (begg endd old-len)
889 ;; (i) Extend the font lock region to cover all changed preprocessor
890 ;; regions; it does this by setting the variables `c-new-BEG' and
891 ;; `c-new-END' to the new boundaries.
892 ;;
893 ;; (ii) "Neutralize" every preprocessor line wholly or partially in the
894 ;; extended changed region. "Restore" lines which were CPP lines before the
895 ;; change and are no longer so; these can be located from the Buffer local
896 ;; variables `c-old-BOM' and `c-old-EOM'.
897 ;;
898 ;; (iii) Mark every CPP construct by placing a `category' property value
899 ;; `c-cpp-delimiter' at its start and end. The marked characters are the
900 ;; opening # and usually the terminating EOL, but sometimes the character
901 ;; before a comment/string delimiter.
902 ;;
903 ;; That is, set syntax-table properties on characters that would otherwise
904 ;; interact syntactically with those outside the CPP line(s).
905 ;;
906 ;; This function is called from an after-change function, BEGG ENDD and
907 ;; OLD-LEN being the standard parameters. It prepares the buffer for font
908 ;; locking, hence must get called before `font-lock-after-change-function'.
909 ;;
910 ;; Point is undefined both before and after this function call, the buffer
911 ;; has been widened, and match-data saved. The return value is ignored.
912 ;;
913 ;; This function is in the C/C++/ObjC value of `c-before-font-lock-functions'.
914 ;;
915 ;; Note: SPEED _MATTERS_ IN THIS FUNCTION!!!
916 ;;
917 ;; This function might make hidden buffer changes.
918 (c-save-buffer-state (new-bounds)
919 ;; First determine the region, (c-new-BEG c-new-END), which will get font
920 ;; locked. It might need "neutralizing". This region may not start
921 ;; inside a string, comment, or macro.
922 (setq new-bounds (c-extend-font-lock-region-for-macros
923 c-new-BEG c-new-END old-len))
924 (setq c-new-BEG (car new-bounds)
925 c-new-END (cdr new-bounds))
926 ;; Clear all old relevant properties.
927 (c-clear-char-property-with-value c-new-BEG c-new-END 'syntax-table '(1))
928 (c-clear-char-property-with-value c-new-BEG c-new-END 'category 'c-cpp-delimiter)
929 ;; FIXME!!! What about the "<" and ">" category properties? 2009-11-16
930
931 ;; Add needed properties to each CPP construct in the region.
932 (goto-char c-new-BEG)
933 (let ((pps-position c-new-BEG) pps-state mbeg)
934 (while (and (< (point) c-new-END)
935 (search-forward-regexp c-anchored-cpp-prefix c-new-END t))
936 ;; If we've found a "#" inside a string/comment, ignore it.
937 (setq pps-state
938 (parse-partial-sexp pps-position (point) nil nil pps-state)
939 pps-position (point))
940 (unless (or (nth 3 pps-state) ; in a string?
941 (nth 4 pps-state)) ; in a comment?
942 (goto-char (match-beginning 0))
943 (setq mbeg (point))
944 (if (> (c-syntactic-end-of-macro) mbeg)
945 (progn
946 (c-neutralize-CPP-line mbeg (point))
947 (c-set-cpp-delimiters mbeg (point))
948 ;(setq pps-position (point))
949 )
950 (forward-line)) ; no infinite loop with, e.g., "#//"
951 )))))
952
953 (defun c-before-change (beg end)
954 ;; Function to be put on `before-change-functions'. Primarily, this calls
955 ;; the language dependent `c-get-state-before-change-functions'. It is
956 ;; otherwise used only to remove stale entries from the `c-found-types'
957 ;; cache, and to record entries which a `c-after-change' function might
958 ;; confirm as stale.
959 ;;
960 ;; Note that this function must be FAST rather than accurate. Note
961 ;; also that it only has any effect when font locking is enabled.
962 ;; We exploit this by checking for font-lock-*-face instead of doing
963 ;; rigorous syntactic analysis.
964
965 ;; If either change boundary is wholly inside an identifier, delete
966 ;; it/them from the cache. Don't worry about being inside a string
967 ;; or a comment - "wrongly" removing a symbol from `c-found-types'
968 ;; isn't critical.
969 (setq c-maybe-stale-found-type nil)
970 (save-restriction
971 (save-match-data
972 (widen)
973 (save-excursion
974 ;; Are we inserting/deleting stuff in the middle of an identifier?
975 (c-unfind-enclosing-token beg)
976 (c-unfind-enclosing-token end)
977 ;; Are we coalescing two tokens together, e.g. "fo o" -> "foo"?
978 (when (< beg end)
979 (c-unfind-coalesced-tokens beg end))
980 ;; Are we (potentially) disrupting the syntactic context which
981 ;; makes a type a type? E.g. by inserting stuff after "foo" in
982 ;; "foo bar;", or before "foo" in "typedef foo *bar;"?
983 ;;
984 ;; We search for appropriate c-type properties "near" the change.
985 ;; First, find an appropriate boundary for this property search.
986 (let (lim
987 type type-pos
988 marked-id term-pos
989 (end1
990 (or (and (eq (get-text-property end 'face) 'font-lock-comment-face)
991 (previous-single-property-change end 'face))
992 end)))
993 (when (>= end1 beg) ; Don't hassle about changes entirely in comments.
994 ;; Find a limit for the search for a `c-type' property
995 (while
996 (and (/= (skip-chars-backward "^;{}") 0)
997 (> (point) (point-min))
998 (memq (c-get-char-property (1- (point)) 'face)
999 '(font-lock-comment-face font-lock-string-face))))
1000 (setq lim (max (point-min) (1- (point))))
1001
1002 ;; Look for the latest `c-type' property before end1
1003 (when (and (> end1 (point-min))
1004 (setq type-pos
1005 (if (get-text-property (1- end1) 'c-type)
1006 end1
1007 (previous-single-property-change end1 'c-type nil lim))))
1008 (setq type (get-text-property (max (1- type-pos) lim) 'c-type))
1009
1010 (when (memq type '(c-decl-id-start c-decl-type-start))
1011 ;; Get the identifier, if any, that the property is on.
1012 (goto-char (1- type-pos))
1013 (setq marked-id
1014 (when (looking-at "\\(\\sw\\|\\s_\\)")
1015 (c-beginning-of-current-token)
1016 (buffer-substring-no-properties (point) type-pos)))
1017
1018 (goto-char end1)
1019 (skip-chars-forward "^;{}") ; FIXME!!! loop for comment, maybe
1020 (setq lim (point))
1021 (setq term-pos
1022 (or (next-single-property-change end 'c-type nil lim) lim))
1023 (setq c-maybe-stale-found-type
1024 (list type marked-id
1025 type-pos term-pos
1026 (buffer-substring-no-properties type-pos term-pos)
1027 (buffer-substring-no-properties beg end)))))))
1028
1029 (if c-get-state-before-change-functions
1030 (mapc (lambda (fn)
1031 (funcall fn beg end))
1032 c-get-state-before-change-functions))
1033 ))))
1034
1035 (defvar c-in-after-change-fontification nil)
1036 (make-variable-buffer-local 'c-in-after-change-fontification)
1037 ;; A flag to prevent region expanding stuff being done twice for after-change
1038 ;; fontification.
1039
1040 (defun c-after-change (beg end old-len)
1041 ;; Function put on `after-change-functions' to adjust various caches
1042 ;; etc. Prefer speed to finesse here, since there will be an order
1043 ;; of magnitude more calls to this function than any of the
1044 ;; functions that use the caches.
1045 ;;
1046 ;; Note that care must be taken so that this is called before any
1047 ;; font-lock callbacks since we might get calls to functions using
1048 ;; these caches from inside them, and we must thus be sure that this
1049 ;; has already been executed.
1050 ;;
1051 ;; This calls the language variable c-before-font-lock-functions, if non nil.
1052 ;; This typically sets `syntax-table' properties.
1053
1054 (c-save-buffer-state ()
1055 ;; When `combine-after-change-calls' is used we might get calls
1056 ;; with regions outside the current narrowing. This has been
1057 ;; observed in Emacs 20.7.
1058 (save-restriction
1059 (save-match-data ; c-recognize-<>-arglists changes match-data
1060 (widen)
1061
1062 (when (> end (point-max))
1063 ;; Some emacsen might return positions past the end. This has been
1064 ;; observed in Emacs 20.7 when rereading a buffer changed on disk
1065 ;; (haven't been able to minimize it, but Emacs 21.3 appears to
1066 ;; work).
1067 (setq end (point-max))
1068 (when (> beg end)
1069 (setq beg end)))
1070
1071 ;; C-y is capable of spuriously converting category properties
1072 ;; c-</>-as-paren-syntax into hard syntax-table properties. Remove
1073 ;; these when it happens.
1074 (c-clear-char-property-with-value beg end 'syntax-table
1075 c-<-as-paren-syntax)
1076 (c-clear-char-property-with-value beg end 'syntax-table
1077 c->-as-paren-syntax)
1078
1079 (c-trim-found-types beg end old-len) ; maybe we don't need all of these.
1080 (c-invalidate-sws-region-after beg end)
1081 (c-invalidate-state-cache beg)
1082 (c-invalidate-find-decl-cache beg)
1083
1084 (when c-recognize-<>-arglists
1085 (c-after-change-check-<>-operators beg end))
1086
1087 ;; (c-new-BEG c-new-END) will be the region to fontify. It may become
1088 ;; larger than (beg end).
1089 (setq c-new-BEG beg
1090 c-new-END end)
1091 (setq c-in-after-change-fontification t)
1092 (save-excursion
1093 (mapc (lambda (fn)
1094 (funcall fn beg end old-len))
1095 c-before-font-lock-functions))))))
1096
1097 (defun c-set-fl-decl-start (pos)
1098 ;; If the beginning of the line containing POS is in the middle of a "local"
1099 ;; declaration (i.e. one which does not start outside of braces enclosing
1100 ;; POS, such as a struct), return the beginning of that declaration.
1101 ;; Otherwise return POS. Note that declarations, in this sense, can be
1102 ;; nested.
1103 ;;
1104 ;; This function is called indirectly from font locking stuff - either from
1105 ;; c-after-change (to prepare for after-change font-locking) or from font
1106 ;; lock context (etc.) fontification.
1107 (let ((lit-limits (c-literal-limits))
1108 (new-pos pos)
1109 bod-lim bo-decl)
1110 (goto-char (c-point 'bol new-pos))
1111 (when lit-limits ; Comment or string.
1112 (goto-char (car lit-limits)))
1113 (setq bod-lim (max (- (point) 500) (point-min)))
1114
1115 (while
1116 ;; Go to a less nested declaration each time round this loop.
1117 (and
1118 (eq (car (c-beginning-of-decl-1 bod-lim)) 'same)
1119 (progn (setq bo-decl (point))
1120 ;; Are we looking at a keyword such as "template" or
1121 ;; "typedef" which can decorate a type, or the type itself?
1122 (when (or (looking-at c-prefix-spec-kwds-re)
1123 (c-forward-type t))
1124 ;; We've found another candidate position.
1125 (setq new-pos (min new-pos bo-decl))
1126 (goto-char bo-decl))
1127 t)
1128 ;; Try and go out a level to search again.
1129 (progn
1130 (c-backward-syntactic-ws bod-lim)
1131 (or (memq (char-before) '(?\( ?\[))
1132 (and (eq (char-before) ?\<)
1133 (eq (c-get-char-property
1134 (1- (point)) 'syntax-table)
1135 c-<-as-paren-syntax))))
1136 (not (bobp)))
1137 (backward-char))
1138 new-pos)) ; back over (, [, <.
1139
1140 (defun c-change-set-fl-decl-start (beg end old-len)
1141 ;; Set c-new-BEG to the beginning of a "local" declaration if it('s BOL) is
1142 ;; inside one. This is called from an after-change-function, but the
1143 ;; parameters BEG END and OLD-LEN are ignored. See `c-set-fl-decl-start'
1144 ;; for the detailed functionality.
1145 (if font-lock-mode
1146 (setq c-new-BEG (c-set-fl-decl-start c-new-BEG))))
1147
1148 (defun c-context-set-fl-decl-start (beg end)
1149 ;; Return a cons (NEW-BEG . END), where NEW-BEG is the beginning of a
1150 ;; "local" declaration (BOL at) NEW is inside or BEG. See
1151 ;; `c-set-fl-decl-start' for the detailed functionality.
1152 (cons (c-set-fl-decl-start beg) end))
1153
1154 (defvar c-standard-font-lock-fontify-region-function nil
1155 "Standard value of `font-lock-fontify-region-function'")
1156
1157 (defun c-font-lock-fontify-region (beg end &optional verbose)
1158 ;; Effectively advice around `font-lock-fontify-region' which extends the
1159 ;; region (BEG END), for example, to avoid context fontification chopping
1160 ;; off the start of the context. Do not do anything if it's already been
1161 ;; done (i.e. from and after-change fontification. An example (C++) where
1162 ;; this used to happen is this:
1163 ;;
1164 ;; template <typename T>
1165 ;;
1166 ;;
1167 ;; void myfunc(T* p) {}
1168 ;;
1169 ;; Type a space in the first blank line, and the fontification of the next
1170 ;; line was fouled up by context fontification.
1171 (let ((new-beg beg) (new-end end) new-region)
1172 (if c-in-after-change-fontification
1173 (setq c-in-after-change-fontification nil)
1174 (save-restriction
1175 (widen)
1176 (save-excursion
1177 (mapc (lambda (fn)
1178 (setq new-region (funcall fn new-beg new-end))
1179 (setq new-beg (car new-region) new-end (cdr new-region)))
1180 c-before-context-fontification-functions))))
1181 (funcall c-standard-font-lock-fontify-region-function
1182 new-beg new-end verbose)))
1183
1184 (defun c-after-font-lock-init ()
1185 ;; Put on `font-lock-mode-hook'. This function ensures our after-change
1186 ;; function will get executed before the font-lock one. Amongst other
1187 ;; things.
1188 (remove-hook 'after-change-functions 'c-after-change t)
1189 (add-hook 'after-change-functions 'c-after-change nil t)
1190 (setq c-standard-font-lock-fontify-region-function
1191 (default-value 'font-lock-fontify-region-function)))
1192
1193 (defun c-font-lock-init ()
1194 "Set up the font-lock variables for using the font-lock support in CC Mode.
1195 This does not load the font-lock package. Use after
1196 `c-basic-common-init' and after cc-fonts has been loaded.
1197 This function is called from `c-common-init', once per mode initialization."
1198
1199 (set (make-local-variable 'font-lock-defaults)
1200 `(,(if (c-major-mode-is 'awk-mode)
1201 ;; awk-mode currently has only one font lock level.
1202 'awk-font-lock-keywords
1203 (mapcar 'c-mode-symbol
1204 '("font-lock-keywords" "font-lock-keywords-1"
1205 "font-lock-keywords-2" "font-lock-keywords-3")))
1206 nil nil
1207 ,c-identifier-syntax-modifications
1208 c-beginning-of-syntax
1209 (font-lock-mark-block-function
1210 . c-mark-function)))
1211
1212 (make-local-variable 'font-lock-fontify-region-function)
1213 (setq font-lock-fontify-region-function 'c-font-lock-fontify-region)
1214
1215 (if (featurep 'xemacs)
1216 (make-local-hook 'font-lock-mode-hook))
1217 (add-hook 'font-lock-mode-hook 'c-after-font-lock-init nil t))
1218
1219 (defun c-extend-after-change-region (beg end old-len)
1220 "Extend the region to be fontified, if necessary."
1221 ;; Note: the parameters are ignored here. This somewhat indirect
1222 ;; implementation exists because it is minimally different from the
1223 ;; stand-alone CC Mode which, lacking
1224 ;; font-lock-extend-after-change-region-function, is forced to use advice
1225 ;; instead.
1226 ;;
1227 ;; Of the seven CC Mode languages, currently (2009-05) only C, C++, Objc
1228 ;; (the languages with #define) and AWK Mode make non-null use of this
1229 ;; function.
1230 (cons c-new-BEG c-new-END))
1231
1232 \f
1233 ;; Support for C
1234
1235 ;;;###autoload
1236 (defvar c-mode-syntax-table nil
1237 "Syntax table used in c-mode buffers.")
1238 (or c-mode-syntax-table
1239 (setq c-mode-syntax-table
1240 (funcall (c-lang-const c-make-mode-syntax-table c))))
1241
1242 (defvar c-mode-abbrev-table nil
1243 "Abbreviation table used in c-mode buffers.")
1244 (c-define-abbrev-table 'c-mode-abbrev-table
1245 '(("else" "else" c-electric-continued-statement 0)
1246 ("while" "while" c-electric-continued-statement 0)))
1247
1248 (defvar c-mode-map ()
1249 "Keymap used in c-mode buffers.")
1250 (if c-mode-map
1251 nil
1252 (setq c-mode-map (c-make-inherited-keymap))
1253 ;; add bindings which are only useful for C
1254 (define-key c-mode-map "\C-c\C-e" 'c-macro-expand)
1255 )
1256
1257 (easy-menu-define c-c-menu c-mode-map "C Mode Commands"
1258 (cons "C" (c-lang-const c-mode-menu c)))
1259
1260 ;; In XEmacs >= 21.5 modes should add their own entries to
1261 ;; `auto-mode-alist'. The comment form of autoload is used to avoid
1262 ;; doing this on load. That since `add-to-list' prepends the value
1263 ;; which could cause it to clobber user settings. Later emacsen have
1264 ;; an append option, but it's not safe to use.
1265
1266 ;; The extension ".C" is associated with C++ while the lowercase
1267 ;; variant goes with C. On case insensitive file systems, this means
1268 ;; that ".c" files also might open C++ mode if the C++ entry comes
1269 ;; first on `auto-mode-alist'. Thus we try to ensure that ".C" comes
1270 ;; after ".c", and since `add-to-list' adds the entry first we have to
1271 ;; add the ".C" entry first.
1272 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(cc\\|hh\\)\\'" . c++-mode))
1273 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode))
1274 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(CC?\\|HH?\\)\\'" . c++-mode))
1275
1276 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[ch]\\'" . c-mode))
1277
1278 ;; NB: The following two associate yacc and lex files to C Mode, which
1279 ;; is not really suitable for those formats. Anyway, afaik there's
1280 ;; currently no better mode for them, and besides this is legacy.
1281 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.y\\(acc\\)?\\'" . c-mode))
1282 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.lex\\'" . c-mode))
1283
1284 ;; Preprocessed files generated by C and C++ compilers.
1285 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.i\\'" . c-mode))
1286 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.ii\\'" . c++-mode))
1287
1288
1289 ;;;###autoload
1290 (define-derived-mode c-mode prog-mode "C"
1291 "Major mode for editing K&R and ANSI C code.
1292 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1293 c-mode buffer. This automatically sets up a mail buffer with version
1294 information already added. You just need to add a description of the
1295 problem, including a reproducible test case, and send the message.
1296
1297 To see what version of CC Mode you are running, enter `\\[c-version]'.
1298
1299 The hook `c-mode-common-hook' is run with no args at mode
1300 initialization, then `c-mode-hook'.
1301
1302 Key bindings:
1303 \\{c-mode-map}"
1304 (c-initialize-cc-mode t)
1305 (set-syntax-table c-mode-syntax-table)
1306 (setq local-abbrev-table c-mode-abbrev-table
1307 abbrev-mode t)
1308 (use-local-map c-mode-map)
1309 (c-init-language-vars-for 'c-mode)
1310 (c-make-macro-with-semi-re) ; matches macro names whose expansion ends with ;
1311 (c-common-init 'c-mode)
1312 (easy-menu-add c-c-menu)
1313 (cc-imenu-init cc-imenu-c-generic-expression)
1314 (c-run-mode-hooks 'c-mode-common-hook 'c-mode-hook)
1315 (c-update-modeline))
1316
1317 \f
1318 ;; Support for C++
1319
1320 ;;;###autoload
1321 (defvar c++-mode-syntax-table nil
1322 "Syntax table used in c++-mode buffers.")
1323 (or c++-mode-syntax-table
1324 (setq c++-mode-syntax-table
1325 (funcall (c-lang-const c-make-mode-syntax-table c++))))
1326
1327 (defvar c++-mode-abbrev-table nil
1328 "Abbreviation table used in c++-mode buffers.")
1329 (c-define-abbrev-table 'c++-mode-abbrev-table
1330 '(("else" "else" c-electric-continued-statement 0)
1331 ("while" "while" c-electric-continued-statement 0)
1332 ("catch" "catch" c-electric-continued-statement 0)))
1333
1334 (defvar c++-mode-map ()
1335 "Keymap used in c++-mode buffers.")
1336 (if c++-mode-map
1337 nil
1338 (setq c++-mode-map (c-make-inherited-keymap))
1339 ;; add bindings which are only useful for C++
1340 (define-key c++-mode-map "\C-c\C-e" 'c-macro-expand)
1341 (define-key c++-mode-map "\C-c:" 'c-scope-operator)
1342 (define-key c++-mode-map "<" 'c-electric-lt-gt)
1343 (define-key c++-mode-map ">" 'c-electric-lt-gt))
1344
1345 (easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands"
1346 (cons "C++" (c-lang-const c-mode-menu c++)))
1347
1348 ;;;###autoload
1349 (define-derived-mode c++-mode prog-mode "C++"
1350 "Major mode for editing C++ code.
1351 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1352 c++-mode buffer. This automatically sets up a mail buffer with
1353 version information already added. You just need to add a description
1354 of the problem, including a reproducible test case, and send the
1355 message.
1356
1357 To see what version of CC Mode you are running, enter `\\[c-version]'.
1358
1359 The hook `c-mode-common-hook' is run with no args at mode
1360 initialization, then `c++-mode-hook'.
1361
1362 Key bindings:
1363 \\{c++-mode-map}"
1364 (c-initialize-cc-mode t)
1365 (set-syntax-table c++-mode-syntax-table)
1366 (setq local-abbrev-table c++-mode-abbrev-table
1367 abbrev-mode t)
1368 (use-local-map c++-mode-map)
1369 (c-init-language-vars-for 'c++-mode)
1370 (c-make-macro-with-semi-re) ; matches macro names whose expansion ends with ;
1371 (c-common-init 'c++-mode)
1372 (easy-menu-add c-c++-menu)
1373 (cc-imenu-init cc-imenu-c++-generic-expression)
1374 (c-run-mode-hooks 'c-mode-common-hook 'c++-mode-hook)
1375 (c-update-modeline))
1376
1377 \f
1378 ;; Support for Objective-C
1379
1380 ;;;###autoload
1381 (defvar objc-mode-syntax-table nil
1382 "Syntax table used in objc-mode buffers.")
1383 (or objc-mode-syntax-table
1384 (setq objc-mode-syntax-table
1385 (funcall (c-lang-const c-make-mode-syntax-table objc))))
1386
1387 (defvar objc-mode-abbrev-table nil
1388 "Abbreviation table used in objc-mode buffers.")
1389 (c-define-abbrev-table 'objc-mode-abbrev-table
1390 '(("else" "else" c-electric-continued-statement 0)
1391 ("while" "while" c-electric-continued-statement 0)))
1392
1393 (defvar objc-mode-map ()
1394 "Keymap used in objc-mode buffers.")
1395 (if objc-mode-map
1396 nil
1397 (setq objc-mode-map (c-make-inherited-keymap))
1398 ;; add bindings which are only useful for Objective-C
1399 (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand))
1400
1401 (easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands"
1402 (cons "ObjC" (c-lang-const c-mode-menu objc)))
1403
1404 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode))
1405
1406 ;;;###autoload
1407 (define-derived-mode objc-mode prog-mode "ObjC"
1408 "Major mode for editing Objective C code.
1409 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1410 objc-mode buffer. This automatically sets up a mail buffer with
1411 version information already added. You just need to add a description
1412 of the problem, including a reproducible test case, and send the
1413 message.
1414
1415 To see what version of CC Mode you are running, enter `\\[c-version]'.
1416
1417 The hook `c-mode-common-hook' is run with no args at mode
1418 initialization, then `objc-mode-hook'.
1419
1420 Key bindings:
1421 \\{objc-mode-map}"
1422 (c-initialize-cc-mode t)
1423 (set-syntax-table objc-mode-syntax-table)
1424 (setq local-abbrev-table objc-mode-abbrev-table
1425 abbrev-mode t)
1426 (use-local-map objc-mode-map)
1427 (c-init-language-vars-for 'objc-mode)
1428 (c-make-macro-with-semi-re) ; matches macro names whose expansion ends with ;
1429 (c-common-init 'objc-mode)
1430 (easy-menu-add c-objc-menu)
1431 (cc-imenu-init nil 'cc-imenu-objc-function)
1432 (c-run-mode-hooks 'c-mode-common-hook 'objc-mode-hook)
1433 (c-update-modeline))
1434
1435 \f
1436 ;; Support for Java
1437
1438 ;;;###autoload
1439 (defvar java-mode-syntax-table nil
1440 "Syntax table used in java-mode buffers.")
1441 (or java-mode-syntax-table
1442 (setq java-mode-syntax-table
1443 (funcall (c-lang-const c-make-mode-syntax-table java))))
1444
1445 (defvar java-mode-abbrev-table nil
1446 "Abbreviation table used in java-mode buffers.")
1447 (c-define-abbrev-table 'java-mode-abbrev-table
1448 '(("else" "else" c-electric-continued-statement 0)
1449 ("while" "while" c-electric-continued-statement 0)
1450 ("catch" "catch" c-electric-continued-statement 0)
1451 ("finally" "finally" c-electric-continued-statement 0)))
1452
1453 (defvar java-mode-map ()
1454 "Keymap used in java-mode buffers.")
1455 (if java-mode-map
1456 nil
1457 (setq java-mode-map (c-make-inherited-keymap))
1458 ;; add bindings which are only useful for Java
1459 )
1460
1461 ;; Regexp trying to describe the beginning of a Java top-level
1462 ;; definition. This is not used by CC Mode, nor is it maintained
1463 ;; since it's practically impossible to write a regexp that reliably
1464 ;; matches such a construct. Other tools are necessary.
1465 (defconst c-Java-defun-prompt-regexp
1466 "^[ \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-*")
1467
1468 (easy-menu-define c-java-menu java-mode-map "Java Mode Commands"
1469 (cons "Java" (c-lang-const c-mode-menu java)))
1470
1471 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode))
1472
1473 ;;;###autoload
1474 (define-derived-mode java-mode prog-mode "Java"
1475 "Major mode for editing Java code.
1476 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1477 java-mode buffer. This automatically sets up a mail buffer with
1478 version information already added. You just need to add a description
1479 of the problem, including a reproducible test case, and send the
1480 message.
1481
1482 To see what version of CC Mode you are running, enter `\\[c-version]'.
1483
1484 The hook `c-mode-common-hook' is run with no args at mode
1485 initialization, then `java-mode-hook'.
1486
1487 Key bindings:
1488 \\{java-mode-map}"
1489 (c-initialize-cc-mode t)
1490 (set-syntax-table java-mode-syntax-table)
1491 (setq local-abbrev-table java-mode-abbrev-table
1492 abbrev-mode t)
1493 (use-local-map java-mode-map)
1494 (c-init-language-vars-for 'java-mode)
1495 (c-common-init 'java-mode)
1496 (easy-menu-add c-java-menu)
1497 (cc-imenu-init cc-imenu-java-generic-expression)
1498 (c-run-mode-hooks 'c-mode-common-hook 'java-mode-hook)
1499 (c-update-modeline))
1500
1501 \f
1502 ;; Support for CORBA's IDL language
1503
1504 ;;;###autoload
1505 (defvar idl-mode-syntax-table nil
1506 "Syntax table used in idl-mode buffers.")
1507 (or idl-mode-syntax-table
1508 (setq idl-mode-syntax-table
1509 (funcall (c-lang-const c-make-mode-syntax-table idl))))
1510
1511 (defvar idl-mode-abbrev-table nil
1512 "Abbreviation table used in idl-mode buffers.")
1513 (c-define-abbrev-table 'idl-mode-abbrev-table nil)
1514
1515 (defvar idl-mode-map ()
1516 "Keymap used in idl-mode buffers.")
1517 (if idl-mode-map
1518 nil
1519 (setq idl-mode-map (c-make-inherited-keymap))
1520 ;; add bindings which are only useful for IDL
1521 )
1522
1523 (easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands"
1524 (cons "IDL" (c-lang-const c-mode-menu idl)))
1525
1526 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode))
1527
1528 ;;;###autoload
1529 (define-derived-mode idl-mode prog-mode "IDL"
1530 "Major mode for editing CORBA's IDL, PSDL and CIDL code.
1531 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1532 idl-mode buffer. This automatically sets up a mail buffer with
1533 version information already added. You just need to add a description
1534 of the problem, including a reproducible test case, and send the
1535 message.
1536
1537 To see what version of CC Mode you are running, enter `\\[c-version]'.
1538
1539 The hook `c-mode-common-hook' is run with no args at mode
1540 initialization, then `idl-mode-hook'.
1541
1542 Key bindings:
1543 \\{idl-mode-map}"
1544 (c-initialize-cc-mode t)
1545 (set-syntax-table idl-mode-syntax-table)
1546 (setq local-abbrev-table idl-mode-abbrev-table)
1547 (use-local-map idl-mode-map)
1548 (c-init-language-vars-for 'idl-mode)
1549 (c-common-init 'idl-mode)
1550 (easy-menu-add c-idl-menu)
1551 ;;(cc-imenu-init cc-imenu-idl-generic-expression) ;TODO
1552 (c-run-mode-hooks 'c-mode-common-hook 'idl-mode-hook)
1553 (c-update-modeline))
1554
1555 \f
1556 ;; Support for Pike
1557
1558 ;;;###autoload
1559 (defvar pike-mode-syntax-table nil
1560 "Syntax table used in pike-mode buffers.")
1561 (or pike-mode-syntax-table
1562 (setq pike-mode-syntax-table
1563 (funcall (c-lang-const c-make-mode-syntax-table pike))))
1564
1565 (defvar pike-mode-abbrev-table nil
1566 "Abbreviation table used in pike-mode buffers.")
1567 (c-define-abbrev-table 'pike-mode-abbrev-table
1568 '(("else" "else" c-electric-continued-statement 0)
1569 ("while" "while" c-electric-continued-statement 0)))
1570
1571 (defvar pike-mode-map ()
1572 "Keymap used in pike-mode buffers.")
1573 (if pike-mode-map
1574 nil
1575 (setq pike-mode-map (c-make-inherited-keymap))
1576 ;; additional bindings
1577 (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand))
1578
1579 (easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands"
1580 (cons "Pike" (c-lang-const c-mode-menu pike)))
1581
1582 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(.in\\)?\\)\\'" . pike-mode))
1583 ;;;###autoload (add-to-list 'interpreter-mode-alist '("pike" . pike-mode))
1584
1585 ;;;###autoload
1586 (define-derived-mode pike-mode prog-mode "Pike"
1587 "Major mode for editing Pike code.
1588 To submit a problem report, enter `\\[c-submit-bug-report]' from a
1589 pike-mode buffer. This automatically sets up a mail buffer with
1590 version information already added. You just need to add a description
1591 of the problem, including a reproducible test case, and send the
1592 message.
1593
1594 To see what version of CC Mode you are running, enter `\\[c-version]'.
1595
1596 The hook `c-mode-common-hook' is run with no args at mode
1597 initialization, then `pike-mode-hook'.
1598
1599 Key bindings:
1600 \\{pike-mode-map}"
1601 (c-initialize-cc-mode t)
1602 (set-syntax-table pike-mode-syntax-table)
1603 (setq local-abbrev-table pike-mode-abbrev-table
1604 abbrev-mode t)
1605 (use-local-map pike-mode-map)
1606 (c-init-language-vars-for 'pike-mode)
1607 (c-common-init 'pike-mode)
1608 (easy-menu-add c-pike-menu)
1609 ;;(cc-imenu-init cc-imenu-pike-generic-expression) ;TODO
1610 (c-run-mode-hooks 'c-mode-common-hook 'pike-mode-hook)
1611 (c-update-modeline))
1612
1613 \f
1614 ;; Support for AWK
1615
1616 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.awk\\'" . awk-mode))
1617 ;;;###autoload (add-to-list 'interpreter-mode-alist '("awk" . awk-mode))
1618 ;;;###autoload (add-to-list 'interpreter-mode-alist '("mawk" . awk-mode))
1619 ;;;###autoload (add-to-list 'interpreter-mode-alist '("nawk" . awk-mode))
1620 ;;;###autoload (add-to-list 'interpreter-mode-alist '("gawk" . awk-mode))
1621
1622 ;;; Autoload directives must be on the top level, so we construct an
1623 ;;; autoload form instead.
1624 ;;;###autoload (autoload 'awk-mode "cc-mode" "Major mode for editing AWK code." t)
1625
1626 (defvar awk-mode-abbrev-table nil
1627 "Abbreviation table used in awk-mode buffers.")
1628 (c-define-abbrev-table 'awk-mode-abbrev-table
1629 '(("else" "else" c-electric-continued-statement 0)
1630 ("while" "while" c-electric-continued-statement 0)))
1631
1632 (defvar awk-mode-map ()
1633 "Keymap used in awk-mode buffers.")
1634 (if awk-mode-map
1635 nil
1636 (setq awk-mode-map (c-make-inherited-keymap))
1637 ;; add bindings which are only useful for awk.
1638 (define-key awk-mode-map "#" 'self-insert-command)
1639 (define-key awk-mode-map "/" 'self-insert-command)
1640 (define-key awk-mode-map "*" 'self-insert-command)
1641 (define-key awk-mode-map "\C-c\C-n" 'undefined) ; #if doesn't exist in awk.
1642 (define-key awk-mode-map "\C-c\C-p" 'undefined)
1643 (define-key awk-mode-map "\C-c\C-u" 'undefined)
1644 (define-key awk-mode-map "\M-a" 'c-beginning-of-statement) ; 2003/10/7
1645 (define-key awk-mode-map "\M-e" 'c-end-of-statement) ; 2003/10/7
1646 (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun)
1647 (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun))
1648
1649 (easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands"
1650 (cons "AWK" (c-lang-const c-mode-menu awk)))
1651
1652 ;; (require 'cc-awk) brings these in.
1653 (defvar awk-mode-syntax-table)
1654 (declare-function c-awk-unstick-NL-prop "cc-awk" ())
1655
1656 ;;;###autoload
1657 (define-derived-mode awk-mode prog-mode "AWK"
1658 "Major mode for editing AWK code.
1659 To submit a problem report, enter `\\[c-submit-bug-report]' from an
1660 awk-mode buffer. This automatically sets up a mail buffer with version
1661 information already added. You just need to add a description of the
1662 problem, including a reproducible test case, and send the message.
1663
1664 To see what version of CC Mode you are running, enter `\\[c-version]'.
1665
1666 The hook `c-mode-common-hook' is run with no args at mode
1667 initialization, then `awk-mode-hook'.
1668
1669 Key bindings:
1670 \\{awk-mode-map}"
1671 ;; We need the next line to stop the macro defining
1672 ;; `awk-mode-syntax-table'. This would mask the real table which is
1673 ;; declared in cc-awk.el and hasn't yet been loaded.
1674 :syntax-table nil
1675 (require 'cc-awk) ; Added 2003/6/10.
1676 (c-initialize-cc-mode t)
1677 (set-syntax-table awk-mode-syntax-table)
1678 (setq local-abbrev-table awk-mode-abbrev-table
1679 abbrev-mode t)
1680 (use-local-map awk-mode-map)
1681 (c-init-language-vars-for 'awk-mode)
1682 (c-common-init 'awk-mode)
1683 (c-awk-unstick-NL-prop)
1684
1685 (c-run-mode-hooks 'c-mode-common-hook 'awk-mode-hook)
1686 (c-update-modeline))
1687
1688 \f
1689 ;; bug reporting
1690
1691 (defconst c-mode-help-address
1692 "bug-cc-mode@gnu.org"
1693 "Address(es) for CC Mode bug reports.")
1694
1695 (defun c-version ()
1696 "Echo the current version of CC Mode in the minibuffer."
1697 (interactive)
1698 (message "Using CC Mode version %s" c-version)
1699 (c-keep-region-active))
1700
1701 (defvar c-prepare-bug-report-hooks nil)
1702
1703 ;; Dynamic variables used by reporter.
1704 (defvar reporter-prompt-for-summary-p)
1705 (defvar reporter-dont-compact-list)
1706
1707 (defun c-submit-bug-report ()
1708 "Submit via mail a bug report on CC Mode."
1709 (interactive)
1710 (require 'reporter)
1711 ;; load in reporter
1712 (let ((reporter-prompt-for-summary-p t)
1713 (reporter-dont-compact-list '(c-offsets-alist))
1714 (style c-indentation-style)
1715 (c-features c-emacs-features))
1716 (and
1717 (if (y-or-n-p "Do you want to submit a report on CC Mode? ")
1718 t (message "") nil)
1719 (reporter-submit-bug-report
1720 c-mode-help-address
1721 (concat "CC Mode " c-version " (" mode-name ")")
1722 (let ((vars (append
1723 c-style-variables
1724 '(c-buffer-is-cc-mode
1725 c-tab-always-indent
1726 c-syntactic-indentation
1727 c-syntactic-indentation-in-macros
1728 c-ignore-auto-fill
1729 c-auto-align-backslashes
1730 c-backspace-function
1731 c-delete-function
1732 c-electric-pound-behavior
1733 c-default-style
1734 c-enable-xemacs-performance-kludge-p
1735 c-old-style-variable-behavior
1736 defun-prompt-regexp
1737 tab-width
1738 comment-column
1739 parse-sexp-ignore-comments
1740 parse-sexp-lookup-properties
1741 lookup-syntax-properties
1742 ;; A brain-damaged XEmacs only variable that, if
1743 ;; set to nil can cause all kinds of chaos.
1744 signal-error-on-buffer-boundary
1745 ;; Variables that affect line breaking and comments.
1746 auto-fill-mode
1747 auto-fill-function
1748 filladapt-mode
1749 comment-multi-line
1750 comment-start-skip
1751 fill-prefix
1752 fill-column
1753 paragraph-start
1754 adaptive-fill-mode
1755 adaptive-fill-regexp)
1756 nil)))
1757 (mapc (lambda (var) (unless (boundp var)
1758 (setq vars (delq var vars))))
1759 '(signal-error-on-buffer-boundary
1760 filladapt-mode
1761 defun-prompt-regexp
1762 font-lock-mode
1763 font-lock-maximum-decoration
1764 parse-sexp-lookup-properties
1765 lookup-syntax-properties))
1766 vars)
1767 (lambda ()
1768 (run-hooks 'c-prepare-bug-report-hooks)
1769 (insert (format "Buffer Style: %s\nc-emacs-features: %s\n"
1770 style c-features)))))))
1771
1772 \f
1773 (cc-provide 'cc-mode)
1774
1775 ;;; cc-mode.el ends here