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