Merge from emacs-24; up to 117634
[emacs.git] / lisp / progmodes / cc-langs.el
bloba8dc3b8968c3ef9eaa91373eff8851c9e059be5e
1 ;;; cc-langs.el --- language specific settings for CC Mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Authors: 2002- 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: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
14 ;; Package: cc-mode
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 ;;; Commentary:
33 ;; HACKERS NOTE: There's heavy macro magic here. If you need to make
34 ;; changes in this or other files containing `c-lang-defconst' but
35 ;; don't want to read through the longer discussion below then read
36 ;; this:
38 ;; o A change in a `c-lang-defconst' or `c-lang-defvar' will not take
39 ;; effect if the file containing the mode init function (typically
40 ;; cc-mode.el) is byte compiled.
41 ;; o To make changes show in font locking you need to reevaluate the
42 ;; `*-font-lock-keywords-*' constants, which normally is easiest to
43 ;; do with M-x eval-buffer in cc-fonts.el.
44 ;; o In either case it's necessary to reinitialize the mode to make
45 ;; the changes show in an existing buffer.
47 ;;; Introduction to the language dependent variable system:
49 ;; This file contains all the language dependent variables, except
50 ;; those specific for font locking which reside in cc-fonts.el. As
51 ;; far as possible, all the differences between the languages that CC
52 ;; Mode supports are described with these variables only, so that the
53 ;; code can be shared.
55 ;; The language constant system (see cc-defs.el) is used to specify
56 ;; various language dependent info at a high level, such as lists of
57 ;; keywords, and then from them generate - at compile time - the
58 ;; various regexps and other low-level structures actually employed in
59 ;; the code at runtime.
61 ;; This system is also designed to make it easy for developers of
62 ;; derived modes to customize the source constants for new language
63 ;; variants, without having to keep up with the exact regexps etc that
64 ;; are used in each CC Mode version. It's possible from an external
65 ;; package to add a new language by inheriting an existing one, and
66 ;; then change specific constants as necessary for the new language.
67 ;; The old values for those constants (and the values of all the other
68 ;; high-level constants) may be used to build the new ones, and those
69 ;; new values will in turn be used by the low-level definitions here
70 ;; to build the runtime constants appropriately for the new language
71 ;; in the current version of CC Mode.
73 ;; Like elsewhere in CC Mode, the existence of a doc string signifies
74 ;; that a language constant is part of the external API, and that it
75 ;; therefore can be used with a high confidence that it will continue
76 ;; to work with future versions of CC Mode. Even so, it's not
77 ;; unlikely that such constants will change meaning slightly as this
78 ;; system is refined further; a certain degree of dependence on the CC
79 ;; Mode version is unavoidable when hooking in at this level. Also
80 ;; note that there's still work to be done to actually use these
81 ;; constants everywhere inside CC Mode; there are still hardcoded
82 ;; values in many places in the code.
84 ;; Separate packages will also benefit from the compile time
85 ;; evaluation; the byte compiled file(s) for them will contain the
86 ;; compiled runtime constants ready for use by (the byte compiled) CC
87 ;; Mode, and the source definitions in this file don't have to be
88 ;; loaded then. However, if a byte compiled package is loaded that
89 ;; has been compiled with a different version of CC Mode than the one
90 ;; currently loaded, then the compiled-in values will be discarded and
91 ;; new ones will be built when the mode is initialized. That will
92 ;; automatically trig a load of the file(s) containing the source
93 ;; definitions (i.e. this file and/or cc-fonts.el) if necessary.
95 ;; A small example of a derived mode is available at
96 ;; <http://cc-mode.sourceforge.net/derived-mode-ex.el>. It also
97 ;; contains some useful hints for derived mode developers.
99 ;;; Using language variables:
101 ;; The `c-lang-defvar' forms in this file comprise the language
102 ;; variables that CC Mode uses. It does not work to use
103 ;; `c-lang-defvar' anywhere else (which isn't much of a limitation
104 ;; since these variables sole purpose is to interface with the CC Mode
105 ;; core functions). The values in these `c-lang-defvar's are not
106 ;; evaluated right away but instead collected to a single large `setq'
107 ;; that can be inserted for a particular language with the
108 ;; `c-init-language-vars' macro.
110 ;; This file is only required at compile time, or when not running
111 ;; from byte compiled files, or when the source definitions for the
112 ;; language constants are requested.
114 ;;; Code:
116 ;; For Emacs < 22.2.
117 (eval-and-compile
118 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
120 (eval-when-compile
121 (let ((load-path
122 (if (and (boundp 'byte-compile-dest-file)
123 (stringp byte-compile-dest-file))
124 (cons (file-name-directory byte-compile-dest-file) load-path)
125 load-path)))
126 (load "cc-bytecomp" nil t)))
128 (cc-require 'cc-defs)
129 (cc-require 'cc-vars)
132 ;; This file is not always loaded. See note above.
133 (cc-external-require 'cl)
136 ;;; Setup for the `c-lang-defvar' system.
138 (eval-and-compile
139 ;; These are used to collect the init forms from the subsequent
140 ;; `c-lang-defvar' and `c-lang-setvar'. They are used to build the
141 ;; lambda in `c-make-init-lang-vars-fun' below, and to build `defvar's
142 ;; and `make-variable-buffer-local's in cc-engine and
143 ;; `make-local-variable's in `c-init-language-vars-for'.
144 (defvar c-lang-variable-inits nil)
145 (defvar c-lang-variable-inits-tail nil)
146 (setq c-lang-variable-inits (list nil)
147 c-lang-variable-inits-tail c-lang-variable-inits)
148 (defvar c-emacs-variable-inits nil)
149 (defvar c-emacs-variable-inits-tail nil)
150 (setq c-emacs-variable-inits (list nil)
151 c-emacs-variable-inits-tail c-emacs-variable-inits))
153 (defmacro c-lang-defvar (var val &optional doc)
154 "Declares the buffer local variable VAR to get the value VAL. VAL is
155 evaluated and assigned at mode initialization. More precisely, VAL is
156 evaluated and bound to VAR when the result from the macro
157 `c-init-language-vars' is evaluated.
159 `c-lang-const' is typically used in VAL to get the right value for the
160 language being initialized, and such calls will be macro expanded to
161 the evaluated constant value at compile time."
163 (when (and (not doc)
164 (eq (car-safe val) 'c-lang-const)
165 (eq (nth 1 val) var)
166 (not (nth 2 val)))
167 ;; Special case: If there's no docstring and the value is a
168 ;; simple (c-lang-const foo) where foo is the same name as VAR
169 ;; then take the docstring from the language constant foo.
170 (setq doc (get (intern (symbol-name (nth 1 val)) c-lang-constants)
171 'variable-documentation)))
172 (or (stringp doc)
173 (setq doc nil))
175 (let ((elem (assq var (cdr c-lang-variable-inits))))
176 (if elem
177 (setcdr elem (list val doc))
178 (setcdr c-lang-variable-inits-tail (list (list var val doc)))
179 (setq c-lang-variable-inits-tail (cdr c-lang-variable-inits-tail))))
181 ;; Return the symbol, like the other def* forms.
182 `',var)
184 (defmacro c-lang-setvar (var val)
185 "Causes the variable VAR to be made buffer local and to get set to the
186 value VAL. VAL is evaluated and assigned at mode initialization. More
187 precisely, VAL is evaluated and bound to VAR when the result from the
188 macro `c-init-language-vars' is evaluated. VAR is typically a standard
189 Emacs variable like `comment-start'.
191 `c-lang-const' is typically used in VAL to get the right value for the
192 language being initialized, and such calls will be macro expanded to
193 the evaluated constant value at compile time."
194 (let ((elem (assq var (cdr c-emacs-variable-inits))))
195 (if elem
196 (setcdr elem (list val)) ; Maybe remove "list", sometime. 2006-07-19
197 (setcdr c-emacs-variable-inits-tail (list (list var val)))
198 (setq c-emacs-variable-inits-tail (cdr c-emacs-variable-inits-tail))))
200 ;; Return the symbol, like the other def* forms.
201 `',var)
203 (put 'c-lang-defvar 'lisp-indent-function 'defun)
204 ; (eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
206 (def-edebug-spec c-lang-defvar
207 (&define name def-form &optional stringp)) ;)
209 ;; Suppress "might not be defined at runtime" warning.
210 ;; This file is only used when compiling other cc files.
211 ;; These are defined in cl as aliases to the cl- versions.
212 ;(declare-function delete-duplicates "cl-seq" (cl-seq &rest cl-keys) t)
213 ;(declare-function mapcan "cl-extra" (cl-func cl-seq &rest cl-rest) t)
215 (eval-and-compile
216 ;; Some helper functions used when building the language constants.
218 (defun c-filter-ops (ops opgroup-filter op-filter &optional xlate)
219 ;; Extract a subset of the operators in the list OPS in a DWIM:ey
220 ;; way. The return value is a plain list of operators:
222 ;; OPS either has the structure of `c-operators', is a single
223 ;; group in `c-operators', or is a plain list of operators.
225 ;; OPGROUP-FILTER specifies how to select the operator groups. It
226 ;; can be t to choose all groups, a list of group type symbols
227 ;; (such as 'prefix) to accept, or a function which will be called
228 ;; with the group symbol for each group and should return non-nil
229 ;; if that group is to be included.
231 ;; If XLATE is given, it's a function which is called for each
232 ;; matching operator and its return value is collected instead.
233 ;; If it returns a list, the elements are spliced directly into
234 ;; the final result, which is returned as a list with duplicates
235 ;; removed using `equal'.
237 ;; `c-mode-syntax-table' for the current mode is in effect during
238 ;; the whole procedure.
239 (unless (listp (car-safe ops))
240 (setq ops (list ops)))
241 (cond ((eq opgroup-filter t)
242 (setq opgroup-filter (lambda (opgroup) t)))
243 ((not (functionp opgroup-filter))
244 (setq opgroup-filter `(lambda (opgroup)
245 (memq opgroup ',opgroup-filter)))))
246 (cond ((eq op-filter t)
247 (setq op-filter (lambda (op) t)))
248 ((stringp op-filter)
249 (setq op-filter `(lambda (op)
250 (string-match ,op-filter op)))))
251 (unless xlate
252 (setq xlate 'identity))
253 (c-with-syntax-table (c-lang-const c-mode-syntax-table)
254 (delete-duplicates
255 (mapcan (lambda (opgroup)
256 (when (if (symbolp (car opgroup))
257 (when (funcall opgroup-filter (car opgroup))
258 (setq opgroup (cdr opgroup))
261 (mapcan (lambda (op)
262 (when (funcall op-filter op)
263 (let ((res (funcall xlate op)))
264 (if (listp res) res (list res)))))
265 opgroup)))
266 ops)
267 :test 'equal))))
270 ;;; Various mode specific values that aren't language related.
272 (c-lang-defconst c-mode-menu
273 ;; The definition for the mode menu. The menu title is prepended to
274 ;; this before it's fed to `easy-menu-define'.
275 t `(["Comment Out Region" comment-region
276 (c-fn-region-is-active-p)]
277 ["Uncomment Region" (comment-region (region-beginning)
278 (region-end) '(4))
279 (c-fn-region-is-active-p)]
280 ["Indent Expression" c-indent-exp
281 (memq (char-after) '(?\( ?\[ ?\{))]
282 ["Indent Line or Region" c-indent-line-or-region t]
283 ["Fill Comment Paragraph" c-fill-paragraph t]
284 "----"
285 ["Backward Statement" c-beginning-of-statement t]
286 ["Forward Statement" c-end-of-statement t]
287 ,@(when (c-lang-const c-opt-cpp-prefix)
288 ;; Only applicable if there's a cpp preprocessor.
289 `(["Up Conditional" c-up-conditional t]
290 ["Backward Conditional" c-backward-conditional t]
291 ["Forward Conditional" c-forward-conditional t]
292 "----"
293 ["Macro Expand Region" c-macro-expand
294 (c-fn-region-is-active-p)]
295 ["Backslashify" c-backslash-region
296 (c-fn-region-is-active-p)]))
297 "----"
298 ("Style..."
299 ["Set Style..." c-set-style t]
300 ["Show Current Style Name" (message
301 "Style Name: %s"
302 c-indentation-style)
304 ["Guess Style from this Buffer" c-guess-buffer-no-install t]
305 ["Install the Last Guessed Style..." c-guess-install
306 (and c-guess-guessed-offsets-alist
307 c-guess-guessed-basic-offset) ]
308 ["View the Last Guessed Style" c-guess-view
309 (and c-guess-guessed-offsets-alist
310 c-guess-guessed-basic-offset) ])
311 "----"
312 ("Toggle..."
313 ["Syntactic indentation" c-toggle-syntactic-indentation
314 :style toggle :selected c-syntactic-indentation]
315 ["Electric mode" c-toggle-electric-state
316 :style toggle :selected c-electric-flag]
317 ["Auto newline" c-toggle-auto-newline
318 :style toggle :selected c-auto-newline]
319 ["Hungry delete" c-toggle-hungry-state
320 :style toggle :selected c-hungry-delete-key]
321 ["Subword mode" subword-mode
322 :style toggle :selected (and (boundp 'subword-mode)
323 subword-mode)])))
326 ;;; Syntax tables.
328 (defun c-populate-syntax-table (table)
329 "Populate the given syntax table as necessary for a C-like language.
330 This includes setting ' and \" as string delimiters, and setting up
331 the comment syntax to handle both line style \"//\" and block style
332 \"/*\" \"*/\" comments."
334 (modify-syntax-entry ?_ "_" table)
335 (modify-syntax-entry ?\\ "\\" table)
336 (modify-syntax-entry ?+ "." table)
337 (modify-syntax-entry ?- "." table)
338 (modify-syntax-entry ?= "." table)
339 (modify-syntax-entry ?% "." table)
340 (modify-syntax-entry ?< "." table)
341 (modify-syntax-entry ?> "." table)
342 (modify-syntax-entry ?& "." table)
343 (modify-syntax-entry ?| "." table)
344 (modify-syntax-entry ?\' "\"" table)
345 (modify-syntax-entry ?\240 "." table)
347 ;; Set up block and line oriented comments. The new C
348 ;; standard mandates both comment styles even in C, so since
349 ;; all languages now require dual comments, we make this the
350 ;; default.
351 (cond
352 ;; XEmacs
353 ((memq '8-bit c-emacs-features)
354 (modify-syntax-entry ?/ ". 1456" table)
355 (modify-syntax-entry ?* ". 23" table))
356 ;; Emacs
357 ((memq '1-bit c-emacs-features)
358 (modify-syntax-entry ?/ ". 124b" table)
359 (modify-syntax-entry ?* ". 23" table))
360 ;; incompatible
361 (t (error "CC Mode is incompatible with this version of Emacs")))
363 (modify-syntax-entry ?\n "> b" table)
364 ;; Give CR the same syntax as newline, for selective-display
365 (modify-syntax-entry ?\^m "> b" table))
367 (c-lang-defconst c-make-mode-syntax-table
368 "Functions that generates the mode specific syntax tables.
369 The syntax tables aren't stored directly since they're quite large."
370 t `(lambda ()
371 (let ((table (make-syntax-table)))
372 (c-populate-syntax-table table)
373 ;; Mode specific syntaxes.
374 ,(cond ((or (c-major-mode-is 'objc-mode) (c-major-mode-is 'java-mode))
375 ;; Let '@' be part of symbols in ObjC to cope with
376 ;; its compiler directives as single keyword tokens.
377 ;; This is then necessary since it's assumed that
378 ;; every keyword is a single symbol.
379 `(modify-syntax-entry ?@ "_" table))
380 ((c-major-mode-is 'pike-mode)
381 `(modify-syntax-entry ?@ "." table)))
382 table)))
384 (c-lang-defconst c-mode-syntax-table
385 ;; The syntax tables in evaluated form. Only used temporarily when
386 ;; the constants in this file are evaluated.
387 t (funcall (c-lang-const c-make-mode-syntax-table)))
389 (c-lang-defconst c++-make-template-syntax-table
390 ;; A variant of `c++-mode-syntax-table' that defines `<' and `>' as
391 ;; parenthesis characters. Used temporarily when template argument
392 ;; lists are parsed. Note that this encourages incorrect parsing of
393 ;; templates since they might contain normal operators that uses the
394 ;; '<' and '>' characters. Therefore this syntax table might go
395 ;; away when CC Mode handles templates correctly everywhere. WHILE
396 ;; THIS SYNTAX TABLE IS CURRENT, `c-parse-state' MUST _NOT_ BE
397 ;; CALLED!!!
398 t nil
399 (java c++) `(lambda ()
400 (let ((table (funcall ,(c-lang-const c-make-mode-syntax-table))))
401 (modify-syntax-entry ?< "(>" table)
402 (modify-syntax-entry ?> ")<" table)
403 table)))
404 (c-lang-defvar c++-template-syntax-table
405 (and (c-lang-const c++-make-template-syntax-table)
406 (funcall (c-lang-const c++-make-template-syntax-table))))
408 (c-lang-defconst c-make-no-parens-syntax-table
409 ;; A variant of the standard syntax table which is used to find matching
410 ;; "<"s and ">"s which have been marked as parens using syntax table
411 ;; properties. The other paren characters (e.g. "{", ")" "]") are given a
412 ;; non-paren syntax here. so that the list commands will work on "< ... >"
413 ;; even when there's unbalanced other parens inside them.
415 ;; This variable is nil for languages which don't have template stuff.
416 t (if (c-lang-const c-recognize-<>-arglists)
417 `(lambda ()
418 ;(if (c-lang-const c-recognize-<>-arglists)
419 (let ((table (funcall ,(c-lang-const c-make-mode-syntax-table))))
420 (modify-syntax-entry ?\( "." table)
421 (modify-syntax-entry ?\) "." table)
422 (modify-syntax-entry ?\[ "." table)
423 (modify-syntax-entry ?\] "." table)
424 (modify-syntax-entry ?\{ "." table)
425 (modify-syntax-entry ?\} "." table)
426 table))))
427 (c-lang-defvar c-no-parens-syntax-table
428 (and (c-lang-const c-make-no-parens-syntax-table)
429 (funcall (c-lang-const c-make-no-parens-syntax-table))))
431 (c-lang-defconst c-identifier-syntax-modifications
432 "A list that describes the modifications that should be done to the
433 mode syntax table to get a syntax table that matches all identifiers
434 and keywords as words.
436 The list is just like the one used in `font-lock-defaults': Each
437 element is a cons where the car is the character to modify and the cdr
438 the new syntax, as accepted by `modify-syntax-entry'."
439 ;; The $ character is not allowed in most languages (one exception
440 ;; is Java which allows it for legacy reasons) but we still classify
441 ;; it as an identifier character since it's often used in various
442 ;; machine generated identifiers.
443 t '((?_ . "w") (?$ . "w"))
444 (objc java) (append '((?@ . "w"))
445 (c-lang-const c-identifier-syntax-modifications))
446 awk '((?_ . "w")))
447 (c-lang-defvar c-identifier-syntax-modifications
448 (c-lang-const c-identifier-syntax-modifications))
450 (c-lang-defvar c-identifier-syntax-table
451 (let ((table (copy-syntax-table (c-mode-var "mode-syntax-table")))
452 (mods c-identifier-syntax-modifications)
453 mod)
454 (while mods
455 (setq mod (car mods)
456 mods (cdr mods))
457 (modify-syntax-entry (car mod) (cdr mod) table))
458 table)
459 "Syntax table built on the mode syntax table but additionally
460 classifies symbol constituents like '_' and '$' as word constituents,
461 so that all identifiers are recognized as words.")
463 (c-lang-defconst c-get-state-before-change-functions
464 ;; For documentation see the following c-lang-defvar of the same name.
465 ;; The value here may be a list of functions or a single function.
466 t nil
467 c++ '(c-extend-region-for-CPP
468 c-before-change-check-<>-operators
469 c-invalidate-macro-cache)
470 (c objc) '(c-extend-region-for-CPP c-invalidate-macro-cache)
471 ;; java 'c-before-change-check-<>-operators
472 awk 'c-awk-record-region-clear-NL)
473 (c-lang-defvar c-get-state-before-change-functions
474 (let ((fs (c-lang-const c-get-state-before-change-functions)))
475 (if (listp fs)
477 (list fs)))
478 "If non-nil, a list of functions called from c-before-change-hook.
479 Typically these will record enough state to allow
480 `c-before-font-lock-function' to extend the region to fontify,
481 and may do such things as removing text-properties which must be
482 recalculated.
484 These functions will be run in the order given. Each of them
485 takes 2 parameters, the BEG and END supplied to every
486 before-change function; on entry, the buffer will have been
487 widened and match-data will have been saved; point is undefined
488 on both entry and exit; the return value is ignored.
490 The functions are called even when font locking isn't enabled.
492 When the mode is initialized, the functions are called with
493 parameters \(point-min) and \(point-max).")
495 (c-lang-defconst c-before-font-lock-functions
496 ;; For documentation see the following c-lang-defvar of the same name.
497 ;; The value here may be a list of functions or a single function.
498 t 'c-change-set-fl-decl-start
499 (c c++ objc) '(c-neutralize-syntax-in-and-mark-CPP
500 c-change-set-fl-decl-start)
501 awk 'c-awk-extend-and-syntax-tablify-region)
502 (c-lang-defvar c-before-font-lock-functions
503 (let ((fs (c-lang-const c-before-font-lock-functions)))
504 (if (listp fs)
506 (list fs)))
507 "If non-nil, a list of functions called just before font locking.
508 Typically they will extend the region about to be fontified \(see
509 below) and will set `syntax-table' text properties on the region.
511 These functions will be run in the order given. Each of them
512 takes 3 parameters, the BEG, END, and OLD-LEN supplied to every
513 after-change function; point is undefined on both entry and exit;
514 on entry, the buffer will have been widened and match-data will
515 have been saved; the return value is ignored.
517 The functions may extend the region to be fontified by setting the
518 buffer local variables c-new-BEG and c-new-END.
520 The functions are called even when font locking is disabled.
522 When the mode is initialized, these functions are called with
523 parameters \(point-min), \(point-max) and <buffer size>.")
525 (c-lang-defconst c-before-context-fontification-functions
526 awk nil
527 t 'c-context-set-fl-decl-start)
528 ;; For documentation see the following c-lang-defvar of the same name.
529 ;; The value here may be a list of functions or a single function.
530 (c-lang-defvar c-before-context-fontification-functions
531 (let ((fs (c-lang-const c-before-context-fontification-functions)))
532 (if (listp fs)
534 (list fs)))
535 "If non-nil, a list of functions called just before context (or
536 other non-change) fontification is done. Typically they will
537 extend the region.
539 These functions will be run in the order given. Each of them
540 takes 2 parameters, the BEG and END of the region to be
541 fontified. Point is undefined on both entry and exit. On entry,
542 the buffer will have been widened and match-data will have been
543 saved; the return value is a cons of the adjusted
544 region, (NEW-BEG . NEW-END).")
547 ;;; Syntactic analysis ("virtual semicolons") for line-oriented languages (AWK).
548 (c-lang-defconst c-at-vsemi-p-fn
549 "Contains a function \"Is there a virtual semicolon at POS or point?\".
550 Such a function takes one optional parameter, a buffer position (defaults to
551 point), and returns nil or t. This variable contains nil for languages which
552 don't have EOL terminated statements. "
553 t nil
554 (c c++ objc) 'c-at-macro-vsemi-p
555 awk 'c-awk-at-vsemi-p)
556 (c-lang-defvar c-at-vsemi-p-fn (c-lang-const c-at-vsemi-p-fn))
558 (c-lang-defconst c-vsemi-status-unknown-p-fn
559 "Contains a function \"are we unsure whether there is a virtual semicolon on this line?\".
560 The (admittedly kludgy) purpose of such a function is to prevent an infinite
561 recursion in c-beginning-of-statement-1 when point starts at a `while' token.
562 The function MUST NOT UNDER ANY CIRCUMSTANCES call c-beginning-of-statement-1,
563 even indirectly. This variable contains nil for languages which don't have
564 EOL terminated statements."
565 t nil
566 (c c++ objc) 'c-macro-vsemi-status-unknown-p
567 awk 'c-awk-vsemi-status-unknown-p)
568 (c-lang-defvar c-vsemi-status-unknown-p-fn
569 (c-lang-const c-vsemi-status-unknown-p-fn))
572 ;;; Lexer-level syntax (identifiers, tokens etc).
574 (c-lang-defconst c-has-bitfields
575 "Whether the language has bitfield declarations."
576 t nil
577 (c c++ objc) t)
578 (c-lang-defvar c-has-bitfields (c-lang-const c-has-bitfields))
580 (c-lang-defconst c-symbol-start
581 "Regexp that matches the start of a symbol, i.e. any identifier or
582 keyword. It's unspecified how far it matches. Does not contain a \\|
583 operator at the top level."
584 t (concat "[" c-alpha "_]")
585 java (concat "[" c-alpha "_@]")
586 objc (concat "[" c-alpha "_@]")
587 pike (concat "[" c-alpha "_`]"))
588 (c-lang-defvar c-symbol-start (c-lang-const c-symbol-start))
590 (c-lang-defconst c-symbol-chars
591 "Set of characters that can be part of a symbol.
592 This is of the form that fits inside [ ] in a regexp."
593 ;; Pike note: With the backquote identifiers this would include most
594 ;; operator chars too, but they are handled with other means instead.
595 t (concat c-alnum "_$")
596 objc (concat c-alnum "_$@"))
597 (c-lang-defvar c-symbol-chars (c-lang-const c-symbol-chars))
599 (c-lang-defconst c-symbol-key
600 "Regexp matching identifiers and keywords (with submatch 0). Assumed
601 to match if `c-symbol-start' matches on the same position."
602 t (concat (c-lang-const c-symbol-start)
603 "[" (c-lang-const c-symbol-chars) "]*")
604 pike (concat
605 ;; Use the value from C here since the operator backquote is
606 ;; covered by the other alternative.
607 (c-lang-const c-symbol-key c)
608 "\\|"
609 (c-make-keywords-re nil
610 (c-lang-const c-overloadable-operators))))
611 (c-lang-defvar c-symbol-key (c-lang-const c-symbol-key))
613 (c-lang-defconst c-symbol-key-depth
614 ;; Number of regexp grouping parens in `c-symbol-key'.
615 t (regexp-opt-depth (c-lang-const c-symbol-key)))
617 (c-lang-defconst c-nonsymbol-chars
618 "This is the set of chars that can't be part of a symbol, i.e. the
619 negation of `c-symbol-chars'."
620 t (concat "^" (c-lang-const c-symbol-chars)))
621 (c-lang-defvar c-nonsymbol-chars (c-lang-const c-nonsymbol-chars))
623 (c-lang-defconst c-nonsymbol-key
624 "Regexp that matches any character that can't be part of a symbol.
625 It's usually appended to other regexps to avoid matching a prefix.
626 It's assumed to not contain any submatchers."
627 ;; The same thing regarding Unicode identifiers applies here as to
628 ;; `c-symbol-key'.
629 t (concat "[" (c-lang-const c-nonsymbol-chars) "]"))
631 (c-lang-defconst c-identifier-ops
632 "The operators that make up fully qualified identifiers. nil in
633 languages that don't have such things. See `c-operators' for a
634 description of the format. Binary operators can concatenate symbols,
635 e.g. \"::\" in \"A::B::C\". Prefix operators can precede identifiers,
636 e.g. \"~\" in \"~A::B\". Other types of operators aren't supported.
638 This value is by default merged into `c-operators'."
639 t nil
640 c++ '((prefix "~" "??-" "compl")
641 (right-assoc "::")
642 (prefix "::"))
643 ;; Java has "." to concatenate identifiers but it's also used for
644 ;; normal indexing. There's special code in the Java font lock
645 ;; rules to fontify qualified identifiers based on the standard
646 ;; naming conventions. We still define "." here to make
647 ;; `c-forward-name' move over as long names as possible which is
648 ;; necessary to e.g. handle throws clauses correctly.
649 java '((left-assoc "."))
650 idl '((left-assoc "::")
651 (prefix "::"))
652 pike '((left-assoc "::")
653 (prefix "::")
654 (left-assoc ".")))
656 (c-lang-defconst c-opt-identifier-concat-key
657 ;; Appendable adorned regexp matching the operators that join
658 ;; symbols to fully qualified identifiers, or nil in languages that
659 ;; don't have such things.
661 ;; This was a docstring constant in 5.30. It still works but is now
662 ;; considered internal - change `c-identifier-ops' instead.
663 t (let ((ops (c-filter-ops (c-lang-const c-identifier-ops)
664 '(left-assoc right-assoc)
665 t)))
666 (when ops
667 (c-make-keywords-re 'appendable ops))))
668 (c-lang-defvar c-opt-identifier-concat-key
669 (c-lang-const c-opt-identifier-concat-key)
670 'dont-doc)
672 (c-lang-defconst c-opt-identifier-concat-key-depth
673 ;; Number of regexp grouping parens in `c-opt-identifier-concat-key'.
674 t (regexp-opt-depth (c-lang-const c-opt-identifier-concat-key)))
676 (c-lang-defconst c-opt-identifier-prefix-key
677 ;; Appendable adorned regexp matching operators that might precede
678 ;; an identifier and that are part of the identifier in that case.
679 ;; nil in languages without such things.
680 t (let ((ops (c-filter-ops (c-lang-const c-identifier-ops)
681 '(prefix)
682 t)))
683 (when ops
684 (c-make-keywords-re 'appendable ops))))
686 (c-lang-defconst c-after-id-concat-ops
687 "Operators that can occur after a binary operator on `c-identifier-ops'
688 in identifiers. nil in languages that don't have such things.
690 Operators here should also have appropriate entries in `c-operators' -
691 it's not taken care of by default."
692 t nil
693 ;; '~' for destructors in C++, '*' for member pointers.
694 c++ '("~" "*")
695 ;; In Java we recognize '*' to deal with "foo.bar.*" that can occur
696 ;; in import declarations. (This will also match bogus things like
697 ;; "foo.*bar" but we don't bother.)
698 java '("*"))
700 (c-lang-defconst c-opt-after-id-concat-key
701 ;; Regexp that must match the token after
702 ;; `c-opt-identifier-concat-key' for it to be considered an
703 ;; identifier concatenation operator (which e.g. causes the
704 ;; preceding identifier to be fontified as a reference). Assumed to
705 ;; be a string if `c-opt-identifier-concat-key' is.
707 ;; This was a docstring constant in 5.30. It still works but is now
708 ;; considered internal - change `c-after-id-concat-ops' instead.
709 t (concat (c-lang-const c-symbol-start)
710 (if (c-lang-const c-after-id-concat-ops)
711 (concat "\\|" (c-make-keywords-re 'appendable
712 (c-lang-const c-after-id-concat-ops)))
713 "")))
715 (c-lang-defconst c-identifier-start
716 "Regexp that matches the start of an (optionally qualified) identifier.
717 It should also match all keywords. It's unspecified how far it
718 matches."
719 t (concat (c-lang-const c-symbol-start)
720 (if (c-lang-const c-opt-identifier-prefix-key)
721 (concat "\\|"
722 (c-lang-const c-opt-identifier-prefix-key))
723 "")))
724 (c-lang-defvar c-identifier-start (c-lang-const c-identifier-start))
726 (c-lang-defconst c-identifier-key
727 "Regexp matching a fully qualified identifier, like \"A::B::c\" in
728 C++. It does not recognize the full range of syntactic whitespace
729 between the tokens; `c-forward-name' has to be used for that. It
730 should also not match identifiers containing parenthesis groupings,
731 e.g. identifiers with template arguments such as \"A<X,Y>\" in C++."
732 ;; This regexp is more complex than strictly necessary to ensure
733 ;; that it can be matched with a minimum of backtracking.
734 t (concat (if (c-lang-const c-opt-identifier-prefix-key)
735 (concat
736 "\\("
737 (c-lang-const c-opt-identifier-prefix-key)
738 (c-lang-const c-simple-ws) "*"
739 "\\)?")
741 "\\(" (c-lang-const c-symbol-key) "\\)"
742 (if (c-lang-const c-opt-identifier-concat-key)
743 (concat
744 "\\("
745 (c-lang-const c-simple-ws) "*"
746 (c-lang-const c-opt-identifier-concat-key)
747 (c-lang-const c-simple-ws) "*"
748 (if (c-lang-const c-after-id-concat-ops)
749 (concat
750 "\\("
751 (c-make-keywords-re 'appendable
752 (c-lang-const c-after-id-concat-ops))
753 (concat
754 ;; For flexibility, consider the symbol match
755 ;; optional if we've hit a
756 ;; `c-after-id-concat-ops' operator. This is
757 ;; also necessary to handle the "*" that can
758 ;; end import declaration identifiers in Java.
759 "\\("
760 (c-lang-const c-simple-ws) "*"
761 "\\(" (c-lang-const c-symbol-key) "\\)"
762 "\\)?")
763 "\\|"
764 "\\(" (c-lang-const c-symbol-key) "\\)"
765 "\\)")
766 (concat "\\(" (c-lang-const c-symbol-key) "\\)"))
767 "\\)*")
768 "")))
769 (c-lang-defvar c-identifier-key (c-lang-const c-identifier-key))
771 (c-lang-defconst c-identifier-last-sym-match
772 ;; This was a docstring constant in 5.30 but it's no longer used.
773 ;; It's only kept to avoid breaking third party code.
775 ;; Used to identify the submatch in `c-identifier-key' that
776 ;; surrounds the last symbol in the qualified identifier. It's a
777 ;; list of submatch numbers, of which the first that has a match is
778 ;; taken. It's assumed that at least one does when the regexp has
779 ;; matched.
780 t nil)
782 (c-lang-defconst c-string-escaped-newlines
783 "Set if the language support backslash escaped newlines inside string
784 literals."
785 t nil
786 (c c++ objc pike) t)
787 (c-lang-defvar c-string-escaped-newlines
788 (c-lang-const c-string-escaped-newlines))
790 (c-lang-defconst c-multiline-string-start-char
791 "Set if the language supports multiline string literals without escaped
792 newlines. If t, all string literals are multiline. If a character,
793 only literals where the open quote is immediately preceded by that
794 literal are multiline."
795 t nil
796 pike ?#)
797 (c-lang-defvar c-multiline-string-start-char
798 (c-lang-const c-multiline-string-start-char))
800 (c-lang-defconst c-opt-cpp-symbol
801 "The symbol which starts preprocessor constructs when in the margin."
802 t "#"
803 (java awk) nil)
804 (c-lang-defvar c-opt-cpp-symbol (c-lang-const c-opt-cpp-symbol))
806 (c-lang-defconst c-opt-cpp-prefix
807 "Regexp matching the prefix of a cpp directive in the languages that
808 normally use that macro preprocessor. Tested at bol or at boi.
809 Assumed to not contain any submatches or \\| operators."
810 ;; TODO (ACM, 2005-04-01). Amend the following to recognize escaped NLs;
811 ;; amend all uses of c-opt-cpp-prefix which count regexp-depth.
812 t "\\s *#\\s *"
813 (java awk) nil)
814 (c-lang-defvar c-opt-cpp-prefix (c-lang-const c-opt-cpp-prefix))
816 (c-lang-defconst c-anchored-cpp-prefix
817 "Regexp matching the prefix of a cpp directive anchored to BOL,
818 in the languages that have a macro preprocessor."
819 t "^\\s *\\(#\\)\\s *"
820 (java awk) nil)
821 (c-lang-defvar c-anchored-cpp-prefix (c-lang-const c-anchored-cpp-prefix))
823 (c-lang-defconst c-opt-cpp-start
824 "Regexp matching the prefix of a cpp directive including the directive
825 name, or nil in languages without preprocessor support. The first
826 submatch surrounds the directive name."
827 t (if (c-lang-const c-opt-cpp-prefix)
828 (concat (c-lang-const c-opt-cpp-prefix)
829 "\\([" c-alnum "]+\\)"))
830 ;; Pike, being a scripting language, recognizes hash-bangs too.
831 pike (concat (c-lang-const c-opt-cpp-prefix)
832 "\\([" c-alnum "]+\\|!\\)"))
833 (c-lang-defvar c-opt-cpp-start (c-lang-const c-opt-cpp-start))
835 (c-lang-defconst c-cpp-message-directives
836 "List of cpp directives (without the prefix) that are followed by a
837 string message."
838 t (if (c-lang-const c-opt-cpp-prefix)
839 '("error"))
840 (c c++ objc pike) '("error" "warning"))
842 (c-lang-defconst c-cpp-include-directives
843 "List of cpp directives (without the prefix) that are followed by a
844 file name in angle brackets or quotes."
845 t (if (c-lang-const c-opt-cpp-prefix)
846 '("include"))
847 objc '("include" "import"))
849 (c-lang-defconst c-opt-cpp-macro-define
850 "Cpp directive (without the prefix) that is followed by a macro
851 definition, or nil if the language doesn't have any."
852 t (if (c-lang-const c-opt-cpp-prefix)
853 "define"))
854 (c-lang-defvar c-opt-cpp-macro-define
855 (c-lang-const c-opt-cpp-macro-define))
857 (c-lang-defconst c-opt-cpp-macro-define-start
858 ;; Regexp matching everything up to the macro body of a cpp define, or the
859 ;; end of the logical line if there is none. Submatch 1 is the name of the
860 ;; macro. Set if c-opt-cpp-macro-define is.
861 t (if (c-lang-const c-opt-cpp-macro-define)
862 (concat (c-lang-const c-opt-cpp-prefix)
863 (c-lang-const c-opt-cpp-macro-define)
864 "[ \t]+\\(\\(\\sw\\|_\\)+\\)\\(\([^\)]*\)\\)?"
865 ;; ^ ^ #defined name
866 "\\([ \t]\\|\\\\\n\\)*")))
867 (c-lang-defvar c-opt-cpp-macro-define-start
868 (c-lang-const c-opt-cpp-macro-define-start))
870 (c-lang-defconst c-opt-cpp-macro-define-id
871 ;; Regexp matching everything up to the end of the identifier defined
872 ;; by a cpp define.
873 t (if (c-lang-const c-opt-cpp-macro-define)
874 (concat (c-lang-const c-opt-cpp-prefix) ; #
875 (c-lang-const c-opt-cpp-macro-define) ; define
876 "[ \t]+\\(\\sw\\|_\\)+")))
877 (c-lang-defvar c-opt-cpp-macro-define-id
878 (c-lang-const c-opt-cpp-macro-define-id))
880 (c-lang-defconst c-cpp-expr-directives
881 "List of cpp directives (without the prefix) that are followed by an
882 expression."
883 t (if (c-lang-const c-opt-cpp-prefix)
884 '("if" "elif")))
886 (c-lang-defconst c-cpp-expr-intro-re
887 "Regexp which matches the start of a CPP directive which contains an
888 expression, or nil if there aren't any in the language."
889 t (if (c-lang-const c-cpp-expr-directives)
890 (concat
891 (c-lang-const c-opt-cpp-prefix)
892 (c-make-keywords-re t (c-lang-const c-cpp-expr-directives)))))
893 (c-lang-defvar c-cpp-expr-intro-re
894 (c-lang-const c-cpp-expr-intro-re))
896 (c-lang-defconst c-cpp-expr-functions
897 "List of functions in cpp expressions."
898 t (if (c-lang-const c-opt-cpp-prefix)
899 '("defined"))
900 pike '("defined" "efun" "constant"))
902 (c-lang-defconst c-assignment-operators
903 "List of all assignment operators."
904 t '("=" "*=" "/=" "%=" "+=" "-=" ">>=" "<<=" "&=" "^=" "|=")
905 java (append (c-lang-const c-assignment-operators)
906 '(">>>="))
907 c++ (append (c-lang-const c-assignment-operators)
908 '("and_eq" "or_eq" "xor_eq" "??!=" "??'="))
909 idl nil)
911 (c-lang-defconst c-operators
912 "List describing all operators, along with their precedence and
913 associativity. The order in the list corresponds to the precedence of
914 the operators: The operators in each element are a group with the same
915 precedence, and the group has higher precedence than the groups in all
916 following elements. The car of each element describes the type of the
917 operator group, and the cdr is a list of the operator tokens in it.
918 The operator group types are:
920 'prefix Unary prefix operators.
921 'postfix Unary postfix operators.
922 'postfix-if-paren
923 Unary postfix operators if and only if the chars have
924 parenthesis syntax.
925 'left-assoc Binary left associative operators (i.e. a+b+c means (a+b)+c).
926 'right-assoc Binary right associative operators (i.e. a=b=c means a=(b=c)).
927 'right-assoc-sequence
928 Right associative operator that constitutes of a
929 sequence of tokens that separate expressions. All the
930 tokens in the group are in this case taken as
931 describing the sequence in one such operator, and the
932 order between them is therefore significant.
934 Operators containing a character with paren syntax are taken to match
935 with a corresponding open/close paren somewhere else. A postfix
936 operator with close paren syntax is taken to end a postfix expression
937 started somewhere earlier, rather than start a new one at point. Vice
938 versa for prefix operators with open paren syntax.
940 Note that operators like \".\" and \"->\" which in language references
941 often are described as postfix operators are considered binary here,
942 since CC Mode treats every identifier as an expression."
944 ;; There's currently no code in CC Mode that exploits all the info
945 ;; in this variable; precedence, associativity etc are present as a
946 ;; preparation for future work.
948 ;; FIXME!!! C++11's "auto" operators "=" and "->" need to go in here
949 ;; somewhere. 2012-03-24.
951 t `(;; Preprocessor.
952 ,@(when (c-lang-const c-opt-cpp-prefix)
953 `((prefix "#"
954 ,@(when (c-major-mode-is '(c-mode c++-mode))
955 '("%:" "??=")))
956 (left-assoc "##"
957 ,@(when (c-major-mode-is '(c-mode c++-mode))
958 '("%:%:" "??=??=")))))
960 ;; Primary.
961 ,@(c-lang-const c-identifier-ops)
962 ,@(cond ((or (c-major-mode-is 'c++-mode) (c-major-mode-is 'java-mode))
963 `((postfix-if-paren "<" ">"))) ; Templates.
964 ((c-major-mode-is 'pike-mode)
965 `((prefix "global" "predef")))
966 ((c-major-mode-is 'java-mode)
967 `((prefix "super"))))
969 ;; Postfix.
970 ,@(when (c-major-mode-is 'c++-mode)
971 ;; The following need special treatment.
972 `((prefix "dynamic_cast" "static_cast"
973 "reinterpret_cast" "const_cast" "typeid")))
974 (left-assoc "."
975 ,@(unless (c-major-mode-is 'java-mode)
976 '("->")))
977 (postfix "++" "--" "[" "]" "(" ")"
978 ,@(when (c-major-mode-is '(c-mode c++-mode))
979 '("<:" ":>" "??(" "??)")))
981 ;; Unary.
982 (prefix "++" "--" "+" "-" "!" "~"
983 ,@(when (c-major-mode-is 'c++-mode) '("not" "compl"))
984 ,@(when (c-major-mode-is '(c-mode c++-mode))
985 '("*" "&" "sizeof" "??-"))
986 ,@(when (c-major-mode-is 'objc-mode)
987 '("@selector" "@protocol" "@encode"))
988 ;; The following need special treatment.
989 ,@(cond ((c-major-mode-is 'c++-mode)
990 '("new" "delete"))
991 ((c-major-mode-is 'java-mode)
992 '("new"))
993 ((c-major-mode-is 'pike-mode)
994 '("class" "lambda" "catch" "throw" "gauge")))
995 "(" ")" ; Cast.
996 ,@(when (c-major-mode-is 'pike-mode)
997 '("[" "]"))) ; Type cast.
999 ;; Member selection.
1000 ,@(when (c-major-mode-is 'c++-mode)
1001 `((left-assoc ".*" "->*")))
1003 ;; Multiplicative.
1004 (left-assoc "*" "/" "%")
1006 ;; Additive.
1007 (left-assoc "+" "-")
1009 ;; Shift.
1010 (left-assoc "<<" ">>"
1011 ,@(when (c-major-mode-is 'java-mode)
1012 '(">>>")))
1014 ;; Relational.
1015 (left-assoc "<" ">" "<=" ">="
1016 ,@(when (c-major-mode-is 'java-mode)
1017 '("instanceof")))
1019 ;; Equality.
1020 (left-assoc "==" "!="
1021 ,@(when (c-major-mode-is 'c++-mode) '("not_eq")))
1023 ;; Bitwise and.
1024 (left-assoc "&"
1025 ,@(when (c-major-mode-is 'c++-mode) '("bitand")))
1027 ;; Bitwise exclusive or.
1028 (left-assoc "^"
1029 ,@(when (c-major-mode-is '(c-mode c++-mode))
1030 '("??'"))
1031 ,@(when (c-major-mode-is 'c++-mode) '("xor")))
1033 ;; Bitwise or.
1034 (left-assoc "|"
1035 ,@(when (c-major-mode-is '(c-mode c++-mode))
1036 '("??!"))
1037 ,@(when (c-major-mode-is 'c++-mode) '("bitor")))
1039 ;; Logical and.
1040 (left-assoc "&&"
1041 ,@(when (c-major-mode-is 'c++-mode) '("and")))
1043 ;; Logical or.
1044 (left-assoc "||"
1045 ,@(when (c-major-mode-is '(c-mode c++-mode))
1046 '("??!??!"))
1047 ,@(when (c-major-mode-is 'c++-mode) '("or")))
1049 ;; Conditional.
1050 (right-assoc-sequence "?" ":")
1052 ;; Assignment.
1053 (right-assoc ,@(c-lang-const c-assignment-operators))
1055 ;; Exception.
1056 ,@(when (c-major-mode-is 'c++-mode)
1057 '((prefix "throw")))
1059 ;; Sequence.
1060 (left-assoc ","))
1062 ;; IDL got its own definition since it has a much smaller operator
1063 ;; set than the other languages.
1064 idl `(;; Preprocessor.
1065 (prefix "#")
1066 (left-assoc "##")
1067 ;; Primary.
1068 ,@(c-lang-const c-identifier-ops)
1069 ;; Unary.
1070 (prefix "+" "-" "~")
1071 ;; Multiplicative.
1072 (left-assoc "*" "/" "%")
1073 ;; Additive.
1074 (left-assoc "+" "-")
1075 ;; Shift.
1076 (left-assoc "<<" ">>")
1077 ;; And.
1078 (left-assoc "&")
1079 ;; Xor.
1080 (left-assoc "^")
1081 ;; Or.
1082 (left-assoc "|")))
1084 (c-lang-defconst c-operator-list
1085 ;; The operators as a flat list (without duplicates).
1086 t (c-filter-ops (c-lang-const c-operators) t t))
1088 (c-lang-defconst c-overloadable-operators
1089 "List of the operators that are overloadable, in their \"identifier
1090 form\". See also `c-op-identifier-prefix'."
1091 t nil
1092 c++ '("new" "delete" ;; Can be followed by "[]" but we ignore that.
1093 "+" "-" "*" "/" "%"
1094 "^" "??'" "xor" "&" "bitand" "|" "??!" "bitor" "~" "??-" "compl"
1095 "!" "=" "<" ">" "+=" "-=" "*=" "/=" "%=" "^="
1096 "??'=" "xor_eq" "&=" "and_eq" "|=" "??!=" "or_eq"
1097 "<<" ">>" ">>=" "<<=" "==" "!=" "not_eq" "<=" ">="
1098 "&&" "and" "||" "??!??!" "or" "++" "--" "," "->*" "->"
1099 "()" "[]" "<::>" "??(??)")
1100 ;; These work like identifiers in Pike.
1101 pike '("`+" "`-" "`&" "`|" "`^" "`<<" "`>>" "`*" "`/" "`%" "`~"
1102 "`==" "`<" "`>" "`!" "`[]" "`[]=" "`->" "`->=" "`()" "``+"
1103 "``-" "``&" "``|" "``^" "``<<" "``>>" "``*" "``/" "``%"
1104 "`+="))
1106 (c-lang-defconst c-overloadable-operators-regexp
1107 ;; Regexp tested after an "operator" token in C++.
1108 t nil
1109 c++ (c-make-keywords-re nil (c-lang-const c-overloadable-operators)))
1110 (c-lang-defvar c-overloadable-operators-regexp
1111 (c-lang-const c-overloadable-operators-regexp))
1113 (c-lang-defconst c-opt-op-identifier-prefix
1114 "Regexp matching the token before the ones in
1115 `c-overloadable-operators' when operators are specified in their
1116 \"identifier form\". This typically matches \"operator\" in C++ where
1117 operator functions are specified as e.g. \"operator +\". It's nil in
1118 languages without operator functions or where the complete operator
1119 identifier is listed in `c-overloadable-operators'.
1121 This regexp is assumed to not match any non-operator identifier."
1122 t nil
1123 c++ (c-make-keywords-re t '("operator")))
1124 (c-lang-defvar c-opt-op-identifier-prefix
1125 (c-lang-const c-opt-op-identifier-prefix))
1127 ;; Note: the following alias is an old name which was a mis-spelling. It has
1128 ;; been corrected above and throughout cc-engine.el. It will be removed at
1129 ;; some release very shortly in the future. ACM, 2006-04-14.
1130 (defvaralias 'c-opt-op-identitier-prefix 'c-opt-op-identifier-prefix)
1131 (make-obsolete-variable 'c-opt-op-identitier-prefix 'c-opt-op-identifier-prefix
1132 "CC Mode 5.31.4, 2006-04-14")
1134 (c-lang-defconst c-other-op-syntax-tokens
1135 "List of the tokens made up of characters in the punctuation or
1136 parenthesis syntax classes that have uses other than as expression
1137 operators."
1138 t '("{" "}" "(" ")" "[" "]" ";" ":" "," "=" "/*" "*/" "//")
1139 (c c++ pike) (append '("#" "##" ; Used by cpp.
1140 "::" "...")
1141 (c-lang-const c-other-op-syntax-tokens))
1142 (c c++) (append '("*") (c-lang-const c-other-op-syntax-tokens))
1143 c++ (append '("&" "<%" "%>" "<:" ":>" "%:" "%:%:")
1144 (c-lang-const c-other-op-syntax-tokens))
1145 objc (append '("#" "##" ; Used by cpp.
1146 "+" "-") (c-lang-const c-other-op-syntax-tokens))
1147 idl (append '("#" "##") ; Used by cpp.
1148 (c-lang-const c-other-op-syntax-tokens))
1149 pike (append '("..")
1150 (c-lang-const c-other-op-syntax-tokens)
1151 (c-lang-const c-overloadable-operators))
1152 awk '("{" "}" "(" ")" "[" "]" ";" "," "=" "/"))
1154 (c-lang-defconst c-all-op-syntax-tokens
1155 ;; List of all tokens in the punctuation and parenthesis syntax
1156 ;; classes.
1157 t (delete-duplicates (append (c-lang-const c-other-op-syntax-tokens)
1158 (c-lang-const c-operator-list))
1159 :test 'string-equal))
1161 (c-lang-defconst c-nonsymbol-token-char-list
1162 ;; List containing all chars not in the word, symbol or
1163 ;; syntactically irrelevant syntax classes, i.e. all punctuation,
1164 ;; parenthesis and string delimiter chars.
1165 t (c-with-syntax-table (c-lang-const c-mode-syntax-table)
1166 ;; Only go through the chars in the printable ASCII range. No
1167 ;; language so far has 8-bit or widestring operators.
1168 (let (list (char 32))
1169 (while (< char 127)
1170 (or (memq (char-syntax char) '(?w ?_ ?< ?> ?\ ))
1171 (setq list (cons (c-int-to-char char) list)))
1172 (setq char (1+ char)))
1173 list)))
1175 (c-lang-defconst c-nonsymbol-token-regexp
1176 ;; Regexp matching all tokens in the punctuation and parenthesis
1177 ;; syntax classes. Note that this also matches ".", which can start
1178 ;; a float.
1179 t (c-make-keywords-re nil
1180 (c-filter-ops (c-lang-const c-all-op-syntax-tokens)
1182 "\\`\\(\\s.\\|\\s\(\\|\\s\)\\)+\\'")))
1183 (c-lang-defvar c-nonsymbol-token-regexp
1184 (c-lang-const c-nonsymbol-token-regexp))
1186 (c-lang-defconst c-assignment-op-regexp
1187 ;; Regexp matching all assignment operators and only them. The
1188 ;; beginning of the first submatch is used to detect the end of the
1189 ;; token, along with the end of the whole match.
1190 t (if (c-lang-const c-assignment-operators)
1191 (concat
1192 ;; Need special case for "=" since it's a prefix of "==".
1193 "=\\([^=]\\|$\\)"
1194 "\\|"
1195 (c-make-keywords-re nil
1196 (set-difference (c-lang-const c-assignment-operators)
1197 '("=")
1198 :test 'string-equal)))
1199 "\\<\\>"))
1200 (c-lang-defvar c-assignment-op-regexp
1201 (c-lang-const c-assignment-op-regexp))
1203 (c-lang-defconst c-<>-multichar-token-regexp
1204 ;; Regexp matching all tokens containing "<" or ">" which are longer
1205 ;; than one char.
1206 t (c-make-keywords-re nil
1207 (c-filter-ops (c-lang-const c-all-op-syntax-tokens)
1209 ".[<>]\\|[<>].")))
1210 (c-lang-defvar c-<>-multichar-token-regexp
1211 (c-lang-const c-<>-multichar-token-regexp))
1213 (c-lang-defconst c-<-op-cont-regexp
1214 ;; Regexp matching the second and subsequent characters of all
1215 ;; multicharacter tokens that begin with "<".
1216 t (c-make-keywords-re nil
1217 (c-filter-ops (c-lang-const c-all-op-syntax-tokens)
1219 "\\`<."
1220 (lambda (op) (substring op 1)))))
1222 (c-lang-defvar c-<-op-cont-regexp (c-lang-const c-<-op-cont-regexp))
1224 (c-lang-defconst c->-op-cont-tokens
1225 ;; A list of second and subsequent characters of all multicharacter tokens
1226 ;; that begin with ">".
1227 t (c-filter-ops (c-lang-const c-all-op-syntax-tokens)
1229 "\\`>."
1230 (lambda (op) (substring op 1)))
1231 java (c-filter-ops (c-lang-const c-all-op-syntax-tokens)
1233 "\\`>[^>]\\|\\`>>[^>]"
1234 (lambda (op) (substring op 1))))
1236 (c-lang-defconst c->-op-cont-regexp
1237 ;; Regexp matching the second and subsequent characters of all
1238 ;; multicharacter tokens that begin with ">".
1239 t (c-make-keywords-re nil (c-lang-const c->-op-cont-tokens)))
1241 (c-lang-defvar c->-op-cont-regexp (c-lang-const c->-op-cont-regexp))
1243 (c-lang-defconst c->-op-without->-cont-regexp
1244 ;; Regexp matching the second and subsequent characters of all
1245 ;; multicharacter tokens that begin with ">" except for those beginning with
1246 ;; ">>".
1247 t (c-make-keywords-re nil
1248 (set-difference
1249 (c-lang-const c->-op-cont-tokens)
1250 (c-filter-ops (c-lang-const c-all-op-syntax-tokens)
1252 "\\`>>"
1253 (lambda (op) (substring op 1)))
1254 :test 'string-equal)))
1256 (c-lang-defvar c->-op-without->-cont-regexp
1257 (c-lang-const c->-op-without->-cont-regexp))
1259 (c-lang-defconst c-stmt-delim-chars
1260 ;; The characters that should be considered to bound statements. To
1261 ;; optimize `c-crosses-statement-barrier-p' somewhat, it's assumed to
1262 ;; begin with "^" to negate the set. If ? : operators should be
1263 ;; detected then the string must end with "?:".
1264 t "^;{}?:")
1265 (c-lang-defvar c-stmt-delim-chars (c-lang-const c-stmt-delim-chars))
1267 (c-lang-defconst c-stmt-delim-chars-with-comma
1268 ;; Variant of `c-stmt-delim-chars' that additionally contains ','.
1269 t "^;,{}?:")
1270 (c-lang-defvar c-stmt-delim-chars-with-comma
1271 (c-lang-const c-stmt-delim-chars-with-comma))
1273 (c-lang-defconst c-auto-ops
1274 ;; Ops which signal C++11's new auto uses.
1275 t nil
1276 c++ '("=" "->"))
1277 (c-lang-defconst c-auto-ops-re
1278 t (c-make-keywords-re nil (c-lang-const c-auto-ops)))
1279 (c-lang-defvar c-auto-ops-re (c-lang-const c-auto-ops-re))
1281 (c-lang-defconst c-haskell-op
1282 ;; Op used in the new C++11 auto function definition, indicating type.
1283 t nil
1284 c++ '("->"))
1285 (c-lang-defconst c-haskell-op-re
1286 t (c-make-keywords-re nil (c-lang-const c-haskell-op)))
1287 (c-lang-defvar c-haskell-op-re (c-lang-const c-haskell-op-re))
1289 ;;; Syntactic whitespace.
1291 (c-lang-defconst c-simple-ws
1292 "Regexp matching an ordinary whitespace character.
1293 Does not contain a \\| operator at the top level."
1294 ;; "\\s " is not enough since it doesn't match line breaks.
1295 t "\\(\\s \\|[\n\r]\\)")
1297 (c-lang-defconst c-simple-ws-depth
1298 ;; Number of regexp grouping parens in `c-simple-ws'.
1299 t (regexp-opt-depth (c-lang-const c-simple-ws)))
1301 (c-lang-defconst c-line-comment-starter
1302 "String that starts line comments, or nil if such don't exist.
1303 Line comments are always terminated by newlines. At least one of
1304 `c-block-comment-starter' and this one is assumed to be set.
1306 Note that it's currently not enough to set this to support a new
1307 comment style. Other stuff like the syntax table must also be set up
1308 properly."
1309 t "//"
1310 awk "#")
1311 (c-lang-defvar c-line-comment-starter (c-lang-const c-line-comment-starter))
1313 (c-lang-defconst c-block-comment-starter
1314 "String that starts block comments, or nil if such don't exist.
1315 Block comments are ended by `c-block-comment-ender', which is assumed
1316 to be set if this is. At least one of `c-line-comment-starter' and
1317 this one is assumed to be set.
1319 Note that it's currently not enough to set this to support a new
1320 comment style. Other stuff like the syntax table must also be set up
1321 properly."
1322 t "/*"
1323 awk nil)
1325 (c-lang-defconst c-block-comment-ender
1326 "String that ends block comments, or nil if such don't exist.
1328 Note that it's currently not enough to set this to support a new
1329 comment style. Other stuff like the syntax table must also be set up
1330 properly."
1331 t "*/"
1332 awk nil)
1334 (c-lang-defconst c-comment-start-regexp
1335 ;; Regexp to match the start of any type of comment.
1336 t (let ((re (c-make-keywords-re nil
1337 (list (c-lang-const c-line-comment-starter)
1338 (c-lang-const c-block-comment-starter)))))
1339 (if (memq 'gen-comment-delim c-emacs-features)
1340 (concat re "\\|\\s!")
1341 re)))
1342 (c-lang-defvar c-comment-start-regexp (c-lang-const c-comment-start-regexp))
1344 (c-lang-defconst c-block-comment-start-regexp
1345 ;; Regexp which matches the start of a block comment (if such exists in the
1346 ;; language)
1347 t (if (c-lang-const c-block-comment-starter)
1348 (regexp-quote (c-lang-const c-block-comment-starter))
1349 "\\<\\>"))
1350 (c-lang-defvar c-block-comment-start-regexp
1351 (c-lang-const c-block-comment-start-regexp))
1353 (c-lang-defconst c-line-comment-start-regexp
1354 ;; Regexp which matches the start of a line comment (if such exists in the
1355 ;; language; it does in all 7 CC Mode languages).
1356 t (if (c-lang-const c-line-comment-starter)
1357 (regexp-quote (c-lang-const c-line-comment-starter))
1358 "\\<\\>"))
1359 (c-lang-defvar c-line-comment-start-regexp
1360 (c-lang-const c-line-comment-start-regexp))
1362 (c-lang-defconst c-literal-start-regexp
1363 ;; Regexp to match the start of comments and string literals.
1364 t (concat (c-lang-const c-comment-start-regexp)
1365 "\\|"
1366 (if (memq 'gen-string-delim c-emacs-features)
1367 "\"|"
1368 "\"")))
1369 (c-lang-defvar c-literal-start-regexp (c-lang-const c-literal-start-regexp))
1371 (c-lang-defconst c-doc-comment-start-regexp
1372 "Regexp to match the start of documentation comments."
1373 t "\\<\\>"
1374 ;; From font-lock.el: `doxygen' uses /*! while others use /**.
1375 (c c++ objc) "/\\*[*!]"
1376 java "/\\*\\*"
1377 pike "/[/*]!")
1378 (c-lang-defvar c-doc-comment-start-regexp
1379 (c-lang-const c-doc-comment-start-regexp))
1381 (c-lang-defconst comment-start
1382 "String that starts comments inserted with M-; etc.
1383 `comment-start' is initialized from this."
1384 ;; Default: Prefer line comments to block comments, and pad with a space.
1385 t (concat (or (c-lang-const c-line-comment-starter)
1386 (c-lang-const c-block-comment-starter))
1387 " ")
1388 ;; In C we still default to the block comment style since line
1389 ;; comments aren't entirely portable.
1390 c "/* ")
1391 (c-lang-setvar comment-start (c-lang-const comment-start))
1393 (c-lang-defconst comment-end
1394 "String that ends comments inserted with M-; etc.
1395 `comment-end' is initialized from this."
1396 ;; Default: Use block comment style if comment-start uses block
1397 ;; comments, and pad with a space in that case.
1398 t (if (string-match (concat "\\`\\("
1399 (c-lang-const c-block-comment-start-regexp)
1400 "\\)")
1401 (c-lang-const comment-start))
1402 (concat " " (c-lang-const c-block-comment-ender))
1403 ""))
1404 (c-lang-setvar comment-end (c-lang-const comment-end))
1406 (c-lang-defconst comment-start-skip
1407 "Regexp to match the start of a comment plus everything up to its body.
1408 `comment-start-skip' is initialized from this."
1409 ;; Default: Allow the last char of the comment starter(s) to be
1410 ;; repeated, then allow any amount of horizontal whitespace.
1411 t (concat "\\("
1412 (c-concat-separated
1413 (mapcar (lambda (cs)
1414 (when cs
1415 (concat (regexp-quote cs) "+")))
1416 (list (c-lang-const c-line-comment-starter)
1417 (c-lang-const c-block-comment-starter)))
1418 "\\|")
1419 "\\)\\s *"))
1420 (c-lang-setvar comment-start-skip (c-lang-const comment-start-skip))
1422 (c-lang-defconst c-syntactic-ws-start
1423 ;; Regexp matching any sequence that can start syntactic whitespace.
1424 ;; The only uncertain case is '#' when there are cpp directives.
1425 t (concat "\\s \\|"
1426 (c-make-keywords-re nil
1427 (append (list (c-lang-const c-line-comment-starter)
1428 (c-lang-const c-block-comment-starter)
1429 (when (c-lang-const c-opt-cpp-prefix)
1430 "#"))
1431 '("\n" "\r")))
1432 "\\|\\\\[\n\r]"
1433 (when (memq 'gen-comment-delim c-emacs-features)
1434 "\\|\\s!")))
1435 (c-lang-defvar c-syntactic-ws-start (c-lang-const c-syntactic-ws-start))
1437 (c-lang-defconst c-syntactic-ws-end
1438 ;; Regexp matching any single character that might end syntactic whitespace.
1439 t (concat "\\s \\|"
1440 (c-make-keywords-re nil
1441 (append (when (c-lang-const c-block-comment-ender)
1442 (list
1443 (string
1444 (elt (c-lang-const c-block-comment-ender)
1445 (1- (length
1446 (c-lang-const c-block-comment-ender)))))))
1447 '("\n" "\r")))
1448 (when (memq 'gen-comment-delim c-emacs-features)
1449 "\\|\\s!")))
1450 (c-lang-defvar c-syntactic-ws-end (c-lang-const c-syntactic-ws-end))
1452 (c-lang-defconst c-unterminated-block-comment-regexp
1453 ;; Regexp matching an unterminated block comment that doesn't
1454 ;; contain line breaks, or nil in languages without block comments.
1455 ;; Does not contain a \| operator at the top level.
1456 t (when (c-lang-const c-block-comment-starter)
1457 (concat
1458 (regexp-quote (c-lang-const c-block-comment-starter))
1459 ;; It's messy to cook together a regexp that matches anything
1460 ;; but c-block-comment-ender.
1461 (let ((end (c-lang-const c-block-comment-ender)))
1462 (cond ((= (length end) 1)
1463 (concat "[^" end "\n\r]*"))
1464 ((= (length end) 2)
1465 (concat "[^" (substring end 0 1) "\n\r]*"
1466 "\\("
1467 (regexp-quote (substring end 0 1)) "+"
1468 "[^"
1469 ;; The quoting rules inside char classes are silly. :P
1470 (cond ((= (elt end 0) (elt end 1))
1471 (concat (substring end 0 1) "\n\r"))
1472 ((= (elt end 1) ?\])
1473 (concat (substring end 1 2) "\n\r"
1474 (substring end 0 1)))
1476 (concat (substring end 0 1) "\n\r"
1477 (substring end 1 2))))
1479 "[^" (substring end 0 1) "\n\r]*"
1480 "\\)*"))
1482 (error "Can't handle a block comment ender of length %s"
1483 (length end))))))))
1485 (c-lang-defconst c-block-comment-regexp
1486 ;; Regexp matching a block comment that doesn't contain line breaks,
1487 ;; or nil in languages without block comments. The reason we don't
1488 ;; allow line breaks is to avoid going very far and risk running out
1489 ;; of regexp stack; this regexp is intended to handle only short
1490 ;; comments that might be put in the middle of limited constructs
1491 ;; like declarations. Does not contain a \| operator at the top
1492 ;; level.
1493 t (when (c-lang-const c-unterminated-block-comment-regexp)
1494 (concat
1495 (c-lang-const c-unterminated-block-comment-regexp)
1496 (let ((end (c-lang-const c-block-comment-ender)))
1497 (cond ((= (length end) 1)
1498 (regexp-quote end))
1499 ((= (length end) 2)
1500 (concat (regexp-quote (substring end 0 1)) "+"
1501 (regexp-quote (substring end 1 2))))
1503 (error "Can't handle a block comment ender of length %s"
1504 (length end))))))))
1506 (c-lang-defconst c-nonwhite-syntactic-ws
1507 ;; Regexp matching a piece of syntactic whitespace that isn't a
1508 ;; sequence of simple whitespace characters. As opposed to
1509 ;; `c-(forward|backward)-syntactic-ws', this doesn't regard cpp
1510 ;; directives as syntactic whitespace.
1511 t (c-concat-separated
1512 (list (when (c-lang-const c-line-comment-starter)
1513 (concat (regexp-quote (c-lang-const c-line-comment-starter))
1514 "[^\n\r]*[\n\r]"))
1515 (c-lang-const c-block-comment-regexp)
1516 "\\\\[\n\r]"
1517 (when (memq 'gen-comment-delim c-emacs-features)
1518 "\\s!\\S!*\\s!"))
1519 "\\|"))
1521 (c-lang-defconst c-syntactic-ws
1522 ;; Regexp matching syntactic whitespace, including possibly the
1523 ;; empty string. As opposed to `c-(forward|backward)-syntactic-ws',
1524 ;; this doesn't regard cpp directives as syntactic whitespace. Does
1525 ;; not contain a \| operator at the top level.
1526 t (concat (c-lang-const c-simple-ws) "*"
1527 "\\("
1528 (concat "\\(" (c-lang-const c-nonwhite-syntactic-ws) "\\)"
1529 (c-lang-const c-simple-ws) "*")
1530 "\\)*"))
1532 (c-lang-defconst c-syntactic-ws-depth
1533 ;; Number of regexp grouping parens in `c-syntactic-ws'.
1534 t (regexp-opt-depth (c-lang-const c-syntactic-ws)))
1536 (c-lang-defconst c-nonempty-syntactic-ws
1537 ;; Regexp matching syntactic whitespace, which is at least one
1538 ;; character long. As opposed to `c-(forward|backward)-syntactic-ws',
1539 ;; this doesn't regard cpp directives as syntactic whitespace. Does
1540 ;; not contain a \| operator at the top level.
1541 t (concat "\\("
1542 (c-lang-const c-simple-ws)
1543 "\\|"
1544 (c-lang-const c-nonwhite-syntactic-ws)
1545 "\\)+"))
1547 (c-lang-defconst c-nonempty-syntactic-ws-depth
1548 ;; Number of regexp grouping parens in `c-nonempty-syntactic-ws'.
1549 t (regexp-opt-depth (c-lang-const c-nonempty-syntactic-ws)))
1551 (c-lang-defconst c-single-line-syntactic-ws
1552 ;; Regexp matching syntactic whitespace without any line breaks. As
1553 ;; opposed to `c-(forward|backward)-syntactic-ws', this doesn't
1554 ;; regard cpp directives as syntactic whitespace. Does not contain
1555 ;; a \| operator at the top level.
1556 t (if (c-lang-const c-block-comment-regexp)
1557 (concat "\\s *\\("
1558 (c-lang-const c-block-comment-regexp)
1559 "\\s *\\)*")
1560 "\\s *"))
1562 (c-lang-defconst c-single-line-syntactic-ws-depth
1563 ;; Number of regexp grouping parens in `c-single-line-syntactic-ws'.
1564 t (regexp-opt-depth (c-lang-const c-single-line-syntactic-ws)))
1566 (c-lang-defconst c-syntactic-eol
1567 ;; Regexp that matches when there is no syntactically significant
1568 ;; text before eol. Macros are regarded as syntactically
1569 ;; significant text here.
1570 t (concat (c-lang-const c-single-line-syntactic-ws)
1571 ;; Match eol (possibly inside a block comment or preceded
1572 ;; by a line continuation backslash), or the beginning of a
1573 ;; line comment. Note: This has to be modified for awk
1574 ;; where line comments start with '#'.
1575 "\\("
1576 (c-concat-separated
1577 (list (when (c-lang-const c-line-comment-starter)
1578 (regexp-quote (c-lang-const c-line-comment-starter)))
1579 (when (c-lang-const c-unterminated-block-comment-regexp)
1580 (concat (c-lang-const c-unterminated-block-comment-regexp)
1581 "$"))
1582 "\\\\$"
1583 "$")
1584 "\\|")
1585 "\\)"))
1586 (c-lang-defvar c-syntactic-eol (c-lang-const c-syntactic-eol))
1589 ;;; Defun handling.
1591 ;; The Emacs variables beginning-of-defun-function and end-of-defun-function
1592 ;; will be set so that commands like `mark-defun' and `narrow-to-defun' work
1593 ;; right. In older Emacsen, the key sequences C-M-a and C-M-e are, however,
1594 ;; bound directly to the CC Mode functions, allowing optimization for large n.
1595 ;; From Emacs 23, this isn't necessary any more, since n is passed to the two
1596 ;; functions.
1597 (c-lang-defconst beginning-of-defun-function
1598 "Function to which beginning-of-defun-function will be set."
1599 t 'c-beginning-of-defun
1600 awk 'c-awk-beginning-of-defun)
1601 (c-lang-setvar beginning-of-defun-function
1602 (c-lang-const beginning-of-defun-function))
1604 (c-lang-defconst end-of-defun-function
1605 "Function to which end-of-defun-function will be set."
1606 t 'c-end-of-defun
1607 awk 'c-awk-end-of-defun)
1608 (c-lang-setvar end-of-defun-function (c-lang-const end-of-defun-function))
1610 ;;; In-comment text handling.
1612 (c-lang-defconst c-paragraph-start
1613 "Regexp to append to `paragraph-start'."
1614 t "$"
1615 java "\\(@[a-zA-Z]+\\>\\|$\\)" ; For Javadoc.
1616 pike "\\(@[a-zA-Z_-]+\\>\\([^{]\\|$\\)\\|$\\)") ; For Pike refdoc.
1617 (c-lang-defvar c-paragraph-start (c-lang-const c-paragraph-start))
1619 (c-lang-defconst c-paragraph-separate
1620 "Regexp to append to `paragraph-separate'."
1621 t "$"
1622 pike (c-lang-const c-paragraph-start))
1623 (c-lang-defvar c-paragraph-separate (c-lang-const c-paragraph-separate))
1626 ;;; Keyword lists.
1628 ;; Note: All and only all language constants containing keyword lists
1629 ;; should end with "-kwds"; they're automatically collected into the
1630 ;; `c-kwds-lang-consts' list below and used to build `c-keywords' etc.
1632 (c-lang-defconst c-primitive-type-kwds
1633 "Primitive type keywords. As opposed to the other keyword lists, the
1634 keywords listed here are fontified with the type face instead of the
1635 keyword face.
1637 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1638 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1639 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1640 will be handled.
1642 Do not try to modify this list for end user customizations; the
1643 `*-font-lock-extra-types' variable, where `*' is the mode prefix, is
1644 the appropriate place for that."
1645 t '("char" "double" "float" "int" "long" "short" "signed"
1646 "unsigned" "void")
1647 c (append
1648 '("_Bool" "_Complex" "_Imaginary") ; Conditionally defined in C99.
1649 (c-lang-const c-primitive-type-kwds))
1650 c++ (append
1651 '("bool" "wchar_t")
1652 (c-lang-const c-primitive-type-kwds))
1653 ;; Objective-C extends C, but probably not the new stuff in C99.
1654 objc (append
1655 '("id" "Class" "SEL" "IMP" "BOOL")
1656 (c-lang-const c-primitive-type-kwds))
1657 java '("boolean" "byte" "char" "double" "float" "int" "long" "short" "void")
1658 idl '("Object" "ValueBase" "any" "boolean" "char" "double" "fixed" "float"
1659 "long" "octet" "sequence" "short" "string" "void" "wchar" "wstring"
1660 ;; In CORBA PSDL:
1661 "ref"
1662 ;; The following can't really end a type, but we have to specify them
1663 ;; here due to the assumption in `c-primitive-type-prefix-kwds'. It
1664 ;; doesn't matter that much.
1665 "unsigned" "strong")
1666 pike '(;; this_program isn't really a keyword, but it's practically
1667 ;; used as a builtin type.
1668 "array" "float" "function" "int" "mapping" "mixed" "multiset"
1669 "object" "program" "string" "this_program" "void"))
1671 (c-lang-defconst c-primitive-type-key
1672 ;; An adorned regexp that matches `c-primitive-type-kwds'.
1673 t (c-make-keywords-re t (c-lang-const c-primitive-type-kwds)))
1674 (c-lang-defvar c-primitive-type-key (c-lang-const c-primitive-type-key))
1676 (c-lang-defconst c-primitive-type-prefix-kwds
1677 "Keywords that might act as prefixes for primitive types. Assumed to
1678 be a subset of `c-primitive-type-kwds'."
1679 t nil
1680 (c c++) '("long" "short" "signed" "unsigned")
1681 idl '("long" "unsigned"
1682 ;; In CORBA PSDL:
1683 "strong"))
1685 (c-lang-defconst c-typedef-kwds
1686 "Prefix keyword\(s\) like \"typedef\" which make a type declaration out
1687 of a variable declaration."
1688 t '("typedef")
1689 (awk idl java) nil)
1691 (c-lang-defconst c-typedef-key
1692 ;; Adorned regexp matching `c-typedef-kwds'.
1693 t (c-make-keywords-re t (c-lang-const c-typedef-kwds)))
1694 (c-lang-defvar c-typedef-key (c-lang-const c-typedef-key))
1696 (c-lang-defconst c-typeof-kwds
1697 "Keywords followed by a parenthesized expression, which stands for
1698 the type of that expression."
1699 t nil
1700 c '("typeof") ; longstanding GNU C(++) extension.
1701 c++ '("decltype" "typeof"))
1703 (c-lang-defconst c-typeof-key
1704 ;; Adorned regexp matching `c-typeof-kwds'.
1705 t (c-make-keywords-re t (c-lang-const c-typeof-kwds)))
1706 (c-lang-defvar c-typeof-key (c-lang-const c-typeof-key))
1708 (c-lang-defconst c-type-prefix-kwds
1709 "Keywords where the following name - if any - is a type name, and
1710 where the keyword together with the symbol works as a type in
1711 declarations.
1713 Note that an alternative if the second part doesn't hold is
1714 `c-type-list-kwds'. Keywords on this list are typically also present
1715 on one of the `*-decl-kwds' lists."
1716 t nil
1717 c '("struct" "union" "enum")
1718 c++ (append '("class" "typename")
1719 (c-lang-const c-type-prefix-kwds c)))
1721 (c-lang-defconst c-type-prefix-key
1722 ;; Adorned regexp matching `c-type-prefix-kwds'.
1723 t (c-make-keywords-re t (c-lang-const c-type-prefix-kwds)))
1724 (c-lang-defvar c-type-prefix-key (c-lang-const c-type-prefix-key))
1726 (c-lang-defconst c-type-modifier-kwds
1727 "Type modifier keywords. These can occur almost anywhere in types
1728 but they don't build a type of themselves. Unlike the keywords on
1729 `c-primitive-type-kwds', they are fontified with the keyword face and
1730 not the type face."
1731 t nil
1732 c '("const" "restrict" "volatile")
1733 c++ '("const" "volatile" "throw")
1734 objc '("const" "volatile"))
1736 (c-lang-defconst c-opt-type-modifier-key
1737 ;; Adorned regexp matching `c-type-modifier-kwds', or nil in
1738 ;; languages without such keywords.
1739 t (and (c-lang-const c-type-modifier-kwds)
1740 (c-make-keywords-re t (c-lang-const c-type-modifier-kwds))))
1741 (c-lang-defvar c-opt-type-modifier-key (c-lang-const c-opt-type-modifier-key))
1743 (c-lang-defconst c-opt-type-component-key
1744 ;; An adorned regexp that matches `c-primitive-type-prefix-kwds' and
1745 ;; `c-type-modifier-kwds', or nil in languages without any of them.
1746 t (and (or (c-lang-const c-primitive-type-prefix-kwds)
1747 (c-lang-const c-type-modifier-kwds))
1748 (c-make-keywords-re t
1749 (append (c-lang-const c-primitive-type-prefix-kwds)
1750 (c-lang-const c-type-modifier-kwds)))))
1751 (c-lang-defvar c-opt-type-component-key
1752 (c-lang-const c-opt-type-component-key))
1754 (c-lang-defconst c-type-start-kwds
1755 ;; All keywords that can start a type (i.e. are either a type prefix
1756 ;; or a complete type).
1757 t (delete-duplicates (append (c-lang-const c-primitive-type-kwds)
1758 (c-lang-const c-type-prefix-kwds)
1759 (c-lang-const c-type-modifier-kwds))
1760 :test 'string-equal))
1762 (c-lang-defconst c-class-decl-kwds
1763 "Keywords introducing declarations where the following block (if any)
1764 contains another declaration level that should be considered a class.
1766 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1767 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1768 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1769 will be handled.
1771 Note that presence on this list does not automatically treat the
1772 following identifier as a type; the keyword must also be present on
1773 `c-type-prefix-kwds' or `c-type-list-kwds' to accomplish that."
1774 t nil
1775 c '("struct" "union")
1776 c++ '("class" "struct" "union")
1777 objc '("struct" "union"
1778 "@interface" "@implementation" "@protocol")
1779 java '("class" "@interface" "interface")
1780 idl '("component" "eventtype" "exception" "home" "interface" "struct"
1781 "union" "valuetype"
1782 ;; In CORBA PSDL:
1783 "storagehome" "storagetype"
1784 ;; In CORBA CIDL:
1785 "catalog" "executor" "manages" "segment")
1786 pike '("class"))
1788 (c-lang-defconst c-class-key
1789 ;; Regexp matching the start of a class.
1790 t (c-make-keywords-re t (c-lang-const c-class-decl-kwds)))
1791 (c-lang-defvar c-class-key (c-lang-const c-class-key))
1793 (c-lang-defconst c-brace-list-decl-kwds
1794 "Keywords introducing declarations where the following block (if
1795 any) is a brace list.
1797 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1798 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1799 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1800 will be handled."
1801 t '("enum")
1802 (awk) nil)
1804 (c-lang-defconst c-brace-list-key
1805 ;; Regexp matching the start of declarations where the following
1806 ;; block is a brace list.
1807 t (c-make-keywords-re t (c-lang-const c-brace-list-decl-kwds)))
1808 (c-lang-defvar c-brace-list-key (c-lang-const c-brace-list-key))
1810 (c-lang-defconst c-other-block-decl-kwds
1811 "Keywords where the following block (if any) contains another
1812 declaration level that should not be considered a class. For every
1813 keyword here, CC Mode will add a set of special syntactic symbols for
1814 those blocks. E.g. if the keyword is \"foo\" then there will be
1815 `foo-open', `foo-close', and `infoo' symbols.
1817 The intention is that this category should be used for block
1818 constructs that aren't related to object orientation concepts like
1819 classes (which thus also include e.g. interfaces, templates,
1820 contracts, structs, etc). The more pragmatic distinction is that
1821 while most want some indentation inside classes, it's fairly common
1822 that they don't want it in some of these constructs, so it should be
1823 simple to configure that differently from classes. See also
1824 `c-class-decl-kwds'.
1826 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1827 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1828 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1829 will be handled."
1830 t nil
1831 (c objc) '("extern")
1832 c++ '("namespace" "extern")
1833 idl '("module"
1834 ;; In CORBA CIDL:
1835 "composition"))
1837 (c-lang-defconst c-other-decl-block-key
1838 ;; Regexp matching the start of blocks besides classes that contain
1839 ;; another declaration level.
1840 t (c-make-keywords-re t (c-lang-const c-other-block-decl-kwds)))
1841 (c-lang-defvar c-other-decl-block-key (c-lang-const c-other-decl-block-key))
1843 (c-lang-defvar c-other-decl-block-key-in-symbols-alist
1844 (mapcar
1845 (lambda (elt)
1846 (cons elt
1847 (if (string= elt "extern")
1848 'inextern-lang
1849 (intern (concat "in" elt)))))
1850 (c-lang-const c-other-block-decl-kwds))
1851 "Alist associating keywords in c-other-decl-block-decl-kwds with
1852 their matching \"in\" syntactic symbols.")
1854 (c-lang-defconst c-typedef-decl-kwds
1855 "Keywords introducing declarations where the identifier(s) being
1856 declared are types.
1858 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1859 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1860 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1861 will be handled."
1862 ;; Default to `c-class-decl-kwds' and `c-brace-list-decl-kwds'
1863 ;; (since e.g. "Foo" is a type that's being defined in "class Foo
1864 ;; {...}").
1865 t (append (c-lang-const c-class-decl-kwds)
1866 (c-lang-const c-brace-list-decl-kwds))
1867 ;; Languages that have a "typedef" construct.
1868 (c c++ objc idl pike) (append (c-lang-const c-typedef-decl-kwds)
1869 '("typedef"))
1870 ;; Unlike most other languages, exception names are not handled as
1871 ;; types in IDL since they only can occur in "raises" specs.
1872 idl (delete "exception" (append (c-lang-const c-typedef-decl-kwds) nil)))
1874 (c-lang-defconst c-typedef-decl-key
1875 t (c-make-keywords-re t (c-lang-const c-typedef-decl-kwds)))
1876 (c-lang-defvar c-typedef-decl-key (c-lang-const c-typedef-decl-key))
1878 (c-lang-defconst c-typeless-decl-kwds
1879 "Keywords introducing declarations where the \(first) identifier
1880 \(declarator) follows directly after the keyword, without any type.
1882 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1883 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1884 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1885 will be handled."
1886 ;; Default to `c-class-decl-kwds' and `c-brace-list-decl-kwds'
1887 ;; (since e.g. "Foo" is the identifier being defined in "class Foo
1888 ;; {...}").
1889 t (append (c-lang-const c-class-decl-kwds)
1890 (c-lang-const c-brace-list-decl-kwds))
1891 c++ (append (c-lang-const c-typeless-decl-kwds) '("auto")) ; C++11.
1892 ;; Note: "manages" for CORBA CIDL clashes with its presence on
1893 ;; `c-type-list-kwds' for IDL.
1894 idl (append (c-lang-const c-typeless-decl-kwds)
1895 '("factory" "finder" "native"
1896 ;; In CORBA PSDL:
1897 "key" "stores"
1898 ;; In CORBA CIDL:
1899 "facet"))
1900 pike (append (c-lang-const c-class-decl-kwds)
1901 '("constant")))
1903 (c-lang-defconst c-modifier-kwds
1904 "Keywords that can prefix normal declarations of identifiers
1905 \(and typically act as flags). Things like argument declarations
1906 inside function headers are also considered declarations in this
1907 sense.
1909 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1910 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1911 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1912 will be handled."
1913 t nil
1914 (c c++) '("auto" "extern" "inline" "register" "static")
1915 c++ (append '("explicit" "friend" "mutable" "template" "using" "virtual")
1916 (c-lang-const c-modifier-kwds))
1917 objc '("auto" "bycopy" "byref" "extern" "in" "inout" "oneway" "out" "static")
1918 ;; FIXME: Some of those below ought to be on `c-other-decl-kwds' instead.
1919 idl '("abstract" "attribute" "const" "consumes" "custom" "emits" "import"
1920 "in" "inout" "local" "multiple" "oneway" "out" "private" "provides"
1921 "public" "publishes" "readonly" "typeid" "typeprefix" "uses"
1922 ;; In CORBA PSDL:
1923 "primary" "state"
1924 ;; In CORBA CIDL:
1925 "bindsTo" "delegatesTo" "implements" "proxy" "storedOn")
1926 ;; Note: "const" is not used in Java, but it's still a reserved keyword.
1927 java '("abstract" "const" "final" "native" "private" "protected" "public"
1928 "static" "strictfp" "synchronized" "transient" "volatile")
1929 pike '("final" "inline" "local" "nomask" "optional" "private" "protected"
1930 "public" "static" "variant"))
1932 (c-lang-defconst c-other-decl-kwds
1933 "Keywords that can start or prefix any declaration level construct,
1934 besides those on `c-class-decl-kwds', `c-brace-list-decl-kwds',
1935 `c-other-block-decl-kwds', `c-typedef-decl-kwds',
1936 `c-typeless-decl-kwds' and `c-modifier-kwds'.
1938 If any of these also are on `c-type-list-kwds', `c-ref-list-kwds',
1939 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1940 `c-<>-type-kwds', or `c-<>-arglist-kwds' then the associated clauses
1941 will be handled."
1942 t nil
1943 objc '("@class" "@end" "@defs")
1944 java '("import" "package")
1945 pike '("import" "inherit"))
1947 (c-lang-defconst c-decl-start-kwds
1948 "Keywords that always start declarations, wherever they occur.
1949 This can be used for declarations that aren't recognized by the normal
1950 combination of `c-decl-prefix-re' and `c-decl-start-re'."
1951 t nil
1952 ;; Classes can be declared anywhere in a Pike expression.
1953 pike '("class"))
1955 (c-lang-defconst c-decl-hangon-kwds
1956 "Keywords that can occur anywhere in a declaration level construct.
1957 This is used for self-contained things that can be tacked on anywhere
1958 on a declaration and that should be ignored to be able to recognize it
1959 correctly. Typical cases are compiler extensions like
1960 \"__attribute__\" or \"__declspec\":
1962 __declspec(noreturn) void foo();
1963 class __declspec(dllexport) classname {...};
1964 void foo() __attribute__((noreturn));
1966 Note that unrecognized plain symbols are skipped anyway if they occur
1967 before the type, so such things are not necessary to mention here.
1968 Mentioning them here is necessary only if they can occur in other
1969 places, or if they are followed by a construct that must be skipped
1970 over \(like the parens in the \"__attribute__\" and \"__declspec\"
1971 examples above). In the last case, they alse need to be present on
1972 one of `c-type-list-kwds', `c-ref-list-kwds',
1973 `c-colon-type-list-kwds', `c-paren-nontype-kwds', `c-paren-type-kwds',
1974 `c-<>-type-kwds', or `c-<>-arglist-kwds'."
1975 ;; NB: These are currently not recognized in all parts of a
1976 ;; declaration. Specifically, they aren't recognized in the middle
1977 ;; of multi-token types, inside declarators, and between the
1978 ;; identifier and the arglist paren of a function declaration.
1980 ;; FIXME: This ought to be user customizable since compiler stuff
1981 ;; like this usually is wrapped in project specific macros. (It'd
1982 ;; of course be even better if we could cope without knowing this.)
1983 t nil
1984 (c c++) '(;; GCC extension.
1985 "__attribute__"
1986 ;; MSVC extension.
1987 "__declspec"))
1989 (c-lang-defconst c-decl-hangon-key
1990 ;; Adorned regexp matching `c-decl-hangon-kwds'.
1991 t (c-make-keywords-re t (c-lang-const c-decl-hangon-kwds)))
1992 (c-lang-defvar c-decl-hangon-key (c-lang-const c-decl-hangon-key))
1994 (c-lang-defconst c-prefix-spec-kwds
1995 ;; All keywords that can occur in the preamble of a declaration.
1996 ;; They typically occur before the type, but they are also matched
1997 ;; after presumptive types since we often can't be sure that
1998 ;; something is a type or just some sort of macro in front of the
1999 ;; declaration. They might be ambiguous with types or type
2000 ;; prefixes.
2001 t (delete-duplicates (append (c-lang-const c-class-decl-kwds)
2002 (c-lang-const c-brace-list-decl-kwds)
2003 (c-lang-const c-other-block-decl-kwds)
2004 (c-lang-const c-typedef-decl-kwds)
2005 (c-lang-const c-typeless-decl-kwds)
2006 (c-lang-const c-modifier-kwds)
2007 (c-lang-const c-other-decl-kwds)
2008 (c-lang-const c-decl-start-kwds)
2009 (c-lang-const c-decl-hangon-kwds))
2010 :test 'string-equal))
2012 (c-lang-defconst c-prefix-spec-kwds-re
2013 ;; Adorned regexp of `c-prefix-spec-kwds'.
2014 t (c-make-keywords-re t (c-lang-const c-prefix-spec-kwds)))
2016 (c-lang-defvar c-prefix-spec-kwds-re (c-lang-const c-prefix-spec-kwds-re))
2018 (c-lang-defconst c-specifier-key
2019 ;; Adorned regexp of the keywords in `c-prefix-spec-kwds' that aren't
2020 ;; ambiguous with types or type prefixes. These are the keywords (like
2021 ;; extern, namespace, but NOT template) that can modify a declaration.
2022 t (c-make-keywords-re t
2023 (set-difference (c-lang-const c-prefix-spec-kwds)
2024 (append (c-lang-const c-type-start-kwds)
2025 (c-lang-const c-<>-arglist-kwds))
2026 :test 'string-equal)))
2027 (c-lang-defvar c-specifier-key (c-lang-const c-specifier-key))
2029 (c-lang-defconst c-postfix-spec-kwds
2030 ;; Keywords that can occur after argument list of a function header
2031 ;; declaration, i.e. in the "K&R region".
2032 t (append (c-lang-const c-postfix-decl-spec-kwds)
2033 (c-lang-const c-decl-hangon-kwds)))
2035 (c-lang-defconst c-not-decl-init-keywords
2036 ;; Adorned regexp matching all keywords that can't appear at the
2037 ;; start of a declaration.
2038 t (c-make-keywords-re t
2039 (set-difference (c-lang-const c-keywords)
2040 (append (c-lang-const c-type-start-kwds)
2041 (c-lang-const c-prefix-spec-kwds)
2042 (c-lang-const c-typeof-kwds))
2043 :test 'string-equal)))
2044 (c-lang-defvar c-not-decl-init-keywords
2045 (c-lang-const c-not-decl-init-keywords))
2047 (c-lang-defconst c-not-primitive-type-keywords
2048 "List of all keywords apart from primitive types (like \"int\")."
2049 t (set-difference (c-lang-const c-keywords)
2050 (c-lang-const c-primitive-type-kwds)
2051 :test 'string-equal)
2052 ;; The "more" for C++ is the QT keyword (as in "more slots:").
2053 ;; This variable is intended for use in c-beginning-of-statement-1.
2054 c++ (append (c-lang-const c-not-primitive-type-keywords) '("more")))
2056 (c-lang-defconst c-not-primitive-type-keywords-regexp
2057 t (c-make-keywords-re t
2058 (c-lang-const c-not-primitive-type-keywords)))
2059 (c-lang-defvar c-not-primitive-type-keywords-regexp
2060 (c-lang-const c-not-primitive-type-keywords-regexp))
2062 (c-lang-defconst c-protection-kwds
2063 "Access protection label keywords in classes."
2064 t nil
2065 c++ '("private" "protected" "public")
2066 objc '("@private" "@protected" "@public"))
2068 (c-lang-defconst c-block-decls-with-vars
2069 "Keywords introducing declarations that can contain a block which
2070 might be followed by variable declarations, e.g. like \"foo\" in
2071 \"class Foo { ... } foo;\". So if there is a block in a declaration
2072 like that, it ends with the following ';' and not right away.
2074 The keywords on list are assumed to also be present on one of the
2075 `*-decl-kwds' lists."
2076 t nil
2077 (c objc) '("struct" "union" "enum" "typedef")
2078 c++ '("class" "struct" "union" "enum" "typedef"))
2080 (c-lang-defconst c-opt-block-decls-with-vars-key
2081 ;; Regexp matching the `c-block-decls-with-vars' keywords, or nil in
2082 ;; languages without such constructs.
2083 t (and (c-lang-const c-block-decls-with-vars)
2084 (c-make-keywords-re t (c-lang-const c-block-decls-with-vars))))
2085 (c-lang-defvar c-opt-block-decls-with-vars-key
2086 (c-lang-const c-opt-block-decls-with-vars-key))
2088 (c-lang-defconst c-postfix-decl-spec-kwds
2089 "Keywords introducing extra declaration specifiers in the region
2090 between the header and the body \(i.e. the \"K&R-region\") in
2091 declarations."
2092 t nil
2093 java '("extends" "implements" "throws")
2094 idl '("context" "getraises" "manages" "primarykey" "raises" "setraises"
2095 "supports"
2096 ;; In CORBA PSDL:
2097 "as" "const" "implements" "of" "ref"))
2099 (c-lang-defconst c-postfix-decl-spec-key
2100 ;; Regexp matching the keywords in `c-postfix-decl-spec-kwds'.
2101 t (c-make-keywords-re t (c-lang-const c-postfix-decl-spec-kwds)))
2102 (c-lang-defvar c-postfix-decl-spec-key
2103 (c-lang-const c-postfix-decl-spec-key))
2105 (c-lang-defconst c-nonsymbol-sexp-kwds
2106 "Keywords that may be followed by a nonsymbol sexp before whatever
2107 construct it's part of continues."
2108 t nil
2109 (c c++ objc) '("extern"))
2111 (c-lang-defconst c-type-list-kwds
2112 "Keywords that may be followed by a comma separated list of type
2113 identifiers, where each optionally can be prefixed by keywords. (Can
2114 also be used for the special case when the list can contain only one
2115 element.)
2117 Assumed to be mutually exclusive with `c-ref-list-kwds'. There's no
2118 reason to put keywords on this list if they are on `c-type-prefix-kwds'.
2119 There's also no reason to add keywords that prefixes a normal
2120 declaration consisting of a type followed by a declarator (list), so
2121 the keywords on `c-modifier-kwds' should normally not be listed here
2122 either.
2124 Note: Use `c-typeless-decl-kwds' for keywords followed by a function
2125 or variable identifier (that's being defined)."
2126 t nil
2127 c++ '("operator")
2128 objc '("@class")
2129 java '("import" "new" "extends" "super" "implements" "throws")
2130 idl '("manages" "native" "primarykey" "supports"
2131 ;; In CORBA PSDL:
2132 "as" "implements" "of" "scope")
2133 pike '("inherit"))
2135 (c-lang-defconst c-ref-list-kwds
2136 "Keywords that may be followed by a comma separated list of
2137 reference (i.e. namespace/scope/module) identifiers, where each
2138 optionally can be prefixed by keywords. (Can also be used for the
2139 special case when the list can contain only one element.) Assumed to
2140 be mutually exclusive with `c-type-list-kwds'.
2142 Note: Use `c-typeless-decl-kwds' for keywords followed by a function
2143 or variable identifier (that's being defined)."
2144 t nil
2145 c++ '("namespace")
2146 java '("package")
2147 idl '("import" "module"
2148 ;; In CORBA CIDL:
2149 "composition")
2150 pike '("import"))
2152 (c-lang-defconst c-colon-type-list-kwds
2153 "Keywords that may be followed (not necessarily directly) by a colon
2154 and then a comma separated list of type identifiers, where each
2155 optionally can be prefixed by keywords. (Can also be used for the
2156 special case when the list can contain only one element.)"
2157 t nil
2158 c++ '("class" "struct")
2159 idl '("component" "eventtype" "home" "interface" "valuetype"
2160 ;; In CORBA PSDL:
2161 "storagehome" "storagetype"))
2163 (c-lang-defconst c-colon-type-list-re
2164 "Regexp matched after the keywords in `c-colon-type-list-kwds' to skip
2165 forward to the colon. The end of the match is assumed to be directly
2166 after the colon, so the regexp should end with \":\". Must be a
2167 regexp if `c-colon-type-list-kwds' isn't nil."
2168 t (if (c-lang-const c-colon-type-list-kwds)
2169 ;; Disallow various common punctuation chars that can't come
2170 ;; before the ":" that starts the inherit list after "class"
2171 ;; or "struct" in C++. (Also used as default for other
2172 ;; languages.)
2173 "[^\]\[{}();,/#=:]*:"))
2174 (c-lang-defvar c-colon-type-list-re (c-lang-const c-colon-type-list-re))
2176 (c-lang-defconst c-paren-nontype-kwds
2177 "Keywords that may be followed by a parenthesis expression that doesn't
2178 contain type identifiers."
2179 t nil
2180 (c c++) '(;; GCC extension.
2181 "__attribute__"
2182 ;; MSVC extension.
2183 "__declspec"))
2185 (c-lang-defconst c-paren-type-kwds
2186 "Keywords that may be followed by a parenthesis expression containing
2187 type identifiers separated by arbitrary tokens."
2188 t nil
2189 c++ '("throw")
2190 objc '("@defs")
2191 idl '("switch")
2192 pike '("array" "function" "int" "mapping" "multiset" "object" "program"))
2194 (c-lang-defconst c-paren-any-kwds
2195 t (delete-duplicates (append (c-lang-const c-paren-nontype-kwds)
2196 (c-lang-const c-paren-type-kwds))
2197 :test 'string-equal))
2199 (c-lang-defconst c-<>-type-kwds
2200 "Keywords that may be followed by an angle bracket expression
2201 containing type identifiers separated by \",\". The difference from
2202 `c-<>-arglist-kwds' is that unknown names are taken to be types and
2203 not other identifiers. `c-recognize-<>-arglists' is assumed to be set
2204 if this isn't nil."
2205 t nil
2206 objc '("id")
2207 idl '("sequence"
2208 ;; In CORBA PSDL:
2209 "ref"))
2211 (c-lang-defconst c-<>-arglist-kwds
2212 "Keywords that can be followed by a C++ style template arglist; see
2213 `c-recognize-<>-arglists' for details. That language constant is
2214 assumed to be set if this isn't nil."
2215 t nil
2216 c++ '("template")
2217 idl '("fixed" "string" "wstring"))
2219 (c-lang-defconst c-<>-sexp-kwds
2220 ;; All keywords that can be followed by an angle bracket sexp.
2221 t (delete-duplicates (append (c-lang-const c-<>-type-kwds)
2222 (c-lang-const c-<>-arglist-kwds))
2223 :test 'string-equal))
2225 (c-lang-defconst c-opt-<>-sexp-key
2226 ;; Adorned regexp matching keywords that can be followed by an angle
2227 ;; bracket sexp. Always set when `c-recognize-<>-arglists' is.
2228 t (c-make-keywords-re t (c-lang-const c-<>-sexp-kwds)))
2229 (c-lang-defvar c-opt-<>-sexp-key (c-lang-const c-opt-<>-sexp-key))
2231 (c-lang-defconst c-brace-id-list-kwds
2232 "Keywords that may be followed by a brace block containing a comma
2233 separated list of identifier definitions, i.e. like the list of
2234 identifiers that follows the type in a normal declaration."
2235 t (c-lang-const c-brace-list-decl-kwds))
2237 (c-lang-defconst c-block-stmt-1-kwds
2238 "Statement keywords followed directly by a substatement."
2239 t '("do" "else")
2240 c++ '("do" "else" "try")
2241 objc '("do" "else" "@finally" "@try")
2242 java '("do" "else" "finally" "try")
2243 idl nil)
2245 (c-lang-defconst c-block-stmt-1-key
2246 ;; Regexp matching the start of any statement followed directly by a
2247 ;; substatement (doesn't match a bare block, however).
2248 t (c-make-keywords-re t (c-lang-const c-block-stmt-1-kwds)))
2249 (c-lang-defvar c-block-stmt-1-key (c-lang-const c-block-stmt-1-key))
2251 (c-lang-defconst c-block-stmt-1-2-kwds
2252 "Statement keywords optionally followed by a paren sexp.
2253 Keywords here should also be in `c-block-stmt-1-kwds'."
2254 t nil
2255 java '("try"))
2257 (c-lang-defconst c-block-stmt-1-2-key
2258 ;; Regexp matching the start of a statement which may be followed by a
2259 ;; paren sexp and will then be followed by a substatement.
2260 t (c-make-keywords-re t (c-lang-const c-block-stmt-1-2-kwds)))
2261 (c-lang-defvar c-block-stmt-1-2-key (c-lang-const c-block-stmt-1-2-key))
2263 (c-lang-defconst c-block-stmt-2-kwds
2264 "Statement keywords followed by a paren sexp and then by a substatement."
2265 t '("for" "if" "switch" "while")
2266 c++ '("for" "if" "switch" "while" "catch")
2267 objc '("for" "if" "switch" "while" "@catch" "@synchronized")
2268 java '("for" "if" "switch" "while" "catch" "synchronized")
2269 idl nil
2270 pike '("for" "if" "switch" "while" "foreach")
2271 awk '("for" "if" "while"))
2273 (c-lang-defconst c-block-stmt-2-key
2274 ;; Regexp matching the start of any statement followed by a paren sexp
2275 ;; and then by a substatement.
2276 t (c-make-keywords-re t (c-lang-const c-block-stmt-2-kwds)))
2277 (c-lang-defvar c-block-stmt-2-key (c-lang-const c-block-stmt-2-key))
2279 (c-lang-defconst c-block-stmt-kwds
2280 ;; Union of `c-block-stmt-1-kwds' and `c-block-stmt-2-kwds'.
2281 t (delete-duplicates (append (c-lang-const c-block-stmt-1-kwds)
2282 (c-lang-const c-block-stmt-2-kwds))
2283 :test 'string-equal))
2285 (c-lang-defconst c-opt-block-stmt-key
2286 ;; Regexp matching the start of any statement that has a
2287 ;; substatement (except a bare block). Nil in languages that
2288 ;; don't have such constructs.
2289 t (if (or (c-lang-const c-block-stmt-1-kwds)
2290 (c-lang-const c-block-stmt-2-kwds))
2291 (c-make-keywords-re t
2292 (append (c-lang-const c-block-stmt-1-kwds)
2293 (c-lang-const c-block-stmt-2-kwds)))))
2294 (c-lang-defvar c-opt-block-stmt-key (c-lang-const c-opt-block-stmt-key))
2296 (c-lang-defconst c-simple-stmt-kwds
2297 "Statement keywords followed by an expression or nothing."
2298 t '("break" "continue" "goto" "return")
2299 objc '("break" "continue" "goto" "return" "@throw")
2300 ;; Note: `goto' is not valid in Java, but the keyword is still reserved.
2301 java '("break" "continue" "goto" "return" "throw")
2302 idl nil
2303 pike '("break" "continue" "return")
2304 awk '(;; Not sure about "delete", "exit", "getline", etc. ; ACM 2002/5/30
2305 "break" "continue" "return" "delete" "exit" "getline" "next"
2306 "nextfile" "print" "printf"))
2308 (c-lang-defconst c-simple-stmt-key
2309 ;; Adorned regexp matching `c-simple-stmt-kwds'.
2310 t (c-make-keywords-re t (c-lang-const c-simple-stmt-kwds)))
2311 (c-lang-defvar c-simple-stmt-key (c-lang-const c-simple-stmt-key))
2313 (c-lang-defconst c-paren-stmt-kwds
2314 "Statement keywords followed by a parenthesis expression that
2315 nevertheless contains a list separated with ';' and not ','."
2316 t '("for")
2317 idl nil)
2319 (c-lang-defconst c-paren-stmt-key
2320 ;; Adorned regexp matching `c-paren-stmt-kwds'.
2321 t (c-make-keywords-re t (c-lang-const c-paren-stmt-kwds)))
2322 (c-lang-defvar c-paren-stmt-key (c-lang-const c-paren-stmt-key))
2324 (c-lang-defconst c-asm-stmt-kwds
2325 "Statement keywords followed by an assembler expression."
2326 t nil
2327 (c c++) '("asm" "__asm__")) ;; Not standard, but common.
2329 (c-lang-defconst c-opt-asm-stmt-key
2330 ;; Regexp matching the start of an assembler statement. Nil in
2331 ;; languages that don't support that.
2332 t (if (c-lang-const c-asm-stmt-kwds)
2333 (c-make-keywords-re t (c-lang-const c-asm-stmt-kwds))))
2334 (c-lang-defvar c-opt-asm-stmt-key (c-lang-const c-opt-asm-stmt-key))
2336 (c-lang-defconst c-case-kwds
2337 "The keyword\(s) which introduce a \"case\" like construct.
2338 This construct is \"<keyword> <expression> :\"."
2339 t '("case")
2340 awk nil)
2342 (c-lang-defconst c-case-kwds-regexp
2343 ;; Adorned regexp matching any "case"-like keyword.
2344 t (c-make-keywords-re t (c-lang-const c-case-kwds)))
2345 (c-lang-defvar c-case-kwds-regexp (c-lang-const c-case-kwds-regexp))
2347 (c-lang-defconst c-label-kwds
2348 "Keywords introducing colon terminated labels in blocks."
2349 t '("case" "default"))
2351 (c-lang-defconst c-label-kwds-regexp
2352 ;; Adorned regexp matching any keyword that introduces a label.
2353 t (c-make-keywords-re t (c-lang-const c-label-kwds)))
2354 (c-lang-defvar c-label-kwds-regexp (c-lang-const c-label-kwds-regexp))
2356 (c-lang-defconst c-before-label-kwds
2357 "Keywords that might be followed by a label identifier."
2358 t '("goto")
2359 (java pike) (append '("break" "continue")
2360 (c-lang-const c-before-label-kwds))
2361 idl nil
2362 awk nil)
2364 (c-lang-defconst c-constant-kwds
2365 "Keywords for constants."
2366 t nil
2367 (c c++) '("NULL" ;; Not a keyword, but practically works as one.
2368 "false" "true") ; Defined in C99.
2369 objc '("nil" "Nil" "YES" "NO" "NS_DURING" "NS_HANDLER" "NS_ENDHANDLER")
2370 idl '("TRUE" "FALSE")
2371 java '("true" "false" "null") ; technically "literals", not keywords
2372 pike '("UNDEFINED")) ;; Not a keyword, but practically works as one.
2374 (c-lang-defconst c-primary-expr-kwds
2375 "Keywords besides constants and operators that start primary expressions."
2376 t nil
2377 c++ '("operator" "this")
2378 objc '("super" "self")
2379 java '("this")
2380 pike '("this")) ;; Not really a keyword, but practically works as one.
2382 (c-lang-defconst c-expr-kwds
2383 ;; Keywords that can occur anywhere in expressions. Built from
2384 ;; `c-primary-expr-kwds' and all keyword operators in `c-operators'.
2385 t (delete-duplicates
2386 (append (c-lang-const c-primary-expr-kwds)
2387 (c-filter-ops (c-lang-const c-operator-list)
2389 "\\`\\(\\w\\|\\s_\\)+\\'"))
2390 :test 'string-equal))
2392 (c-lang-defconst c-lambda-kwds
2393 "Keywords that start lambda constructs, i.e. function definitions in
2394 expressions."
2395 t nil
2396 pike '("lambda"))
2398 (c-lang-defconst c-inexpr-block-kwds
2399 "Keywords that start constructs followed by statement blocks which can
2400 be used in expressions \(the gcc extension for this in C and C++ is
2401 handled separately by `c-recognize-paren-inexpr-blocks')."
2402 t nil
2403 pike '("catch" "gauge"))
2405 (c-lang-defconst c-inexpr-class-kwds
2406 "Keywords that can start classes inside expressions."
2407 t nil
2408 java '("new")
2409 pike '("class"))
2411 (c-lang-defconst c-inexpr-brace-list-kwds
2412 "Keywords that can start brace list blocks inside expressions.
2413 Note that Java specific rules are currently applied to tell this from
2414 `c-inexpr-class-kwds'."
2415 t nil
2416 java '("new"))
2418 (c-lang-defconst c-opt-inexpr-brace-list-key
2419 ;; Regexp matching the start of a brace list in an expression, or
2420 ;; nil in languages that don't have such things. This should not
2421 ;; match brace lists recognized through `c-special-brace-lists'.
2422 t (and (c-lang-const c-inexpr-brace-list-kwds)
2423 (c-make-keywords-re t (c-lang-const c-inexpr-brace-list-kwds))))
2424 (c-lang-defvar c-opt-inexpr-brace-list-key
2425 (c-lang-const c-opt-inexpr-brace-list-key))
2427 (c-lang-defconst c-decl-block-key
2428 ;; Regexp matching keywords in any construct that contain another
2429 ;; declaration level, i.e. that isn't followed by a function block
2430 ;; or brace list. When the first submatch matches, it's an
2431 ;; unambiguous construct, otherwise it's an ambiguous match that
2432 ;; might also be the return type of a function declaration.
2433 t (let* ((decl-kwds (append (c-lang-const c-class-decl-kwds)
2434 (c-lang-const c-other-block-decl-kwds)
2435 (c-lang-const c-inexpr-class-kwds)))
2436 (unambiguous (set-difference decl-kwds
2437 (c-lang-const c-type-start-kwds)
2438 :test 'string-equal))
2439 (ambiguous (intersection decl-kwds
2440 (c-lang-const c-type-start-kwds)
2441 :test 'string-equal)))
2442 (if ambiguous
2443 (concat (c-make-keywords-re t unambiguous)
2444 "\\|"
2445 (c-make-keywords-re t ambiguous))
2446 (c-make-keywords-re t unambiguous))))
2447 (c-lang-defvar c-decl-block-key (c-lang-const c-decl-block-key))
2449 (c-lang-defconst c-bitfield-kwds
2450 "Keywords that can introduce bitfields."
2451 t nil
2452 (c c++ objc) '("char" "int" "long" "signed" "unsigned"))
2454 (c-lang-defconst c-opt-bitfield-key
2455 ;; Regexp matching the start of a bitfield (not uniquely), or nil in
2456 ;; languages without bitfield support.
2457 t nil
2458 (c c++) (c-make-keywords-re t (c-lang-const c-bitfield-kwds)))
2459 (c-lang-defvar c-opt-bitfield-key (c-lang-const c-opt-bitfield-key))
2461 (c-lang-defconst c-other-kwds
2462 "Keywords not accounted for by any other `*-kwds' language constant."
2463 t nil
2464 idl '("truncatable"
2465 ;; In CORBA CIDL: (These are declaration keywords that never
2466 ;; can start a declaration.)
2467 "entity" "process" "service" "session" "storage"))
2470 ;;; Constants built from keywords.
2472 ;; Note: No `*-kwds' language constants may be defined below this point.
2474 (eval-and-compile
2475 (defconst c-kwds-lang-consts
2476 ;; List of all the language constants that contain keyword lists.
2477 (let (list)
2478 (mapatoms (lambda (sym)
2479 (when (and (boundp sym)
2480 (string-match "-kwds\\'" (symbol-name sym)))
2481 ;; Make the list of globally interned symbols
2482 ;; instead of ones interned in `c-lang-constants'.
2483 (setq list (cons (intern (symbol-name sym)) list))))
2484 c-lang-constants)
2485 list)))
2487 (c-lang-defconst c-keywords
2488 ;; All keywords as a list.
2489 t (delete-duplicates
2490 (c-lang-defconst-eval-immediately
2491 `(append ,@(mapcar (lambda (kwds-lang-const)
2492 `(c-lang-const ,kwds-lang-const))
2493 c-kwds-lang-consts)
2494 nil))
2495 :test 'string-equal))
2497 (c-lang-defconst c-keywords-regexp
2498 ;; All keywords as an adorned regexp.
2499 t (c-make-keywords-re t (c-lang-const c-keywords)))
2500 (c-lang-defvar c-keywords-regexp (c-lang-const c-keywords-regexp))
2502 (c-lang-defconst c-keyword-member-alist
2503 ;; An alist with all the keywords in the cars. The cdr for each
2504 ;; keyword is a list of the symbols for the `*-kwds' lists that
2505 ;; contains it.
2506 t (let ((kwd-list-alist
2507 (c-lang-defconst-eval-immediately
2508 `(list ,@(mapcar (lambda (kwds-lang-const)
2509 `(cons ',kwds-lang-const
2510 (c-lang-const ,kwds-lang-const)))
2511 c-kwds-lang-consts))))
2512 lang-const kwd-list kwd
2513 result-alist elem)
2514 (while kwd-list-alist
2515 (setq lang-const (caar kwd-list-alist)
2516 kwd-list (cdar kwd-list-alist)
2517 kwd-list-alist (cdr kwd-list-alist))
2518 (while kwd-list
2519 (setq kwd (car kwd-list)
2520 kwd-list (cdr kwd-list))
2521 (unless (setq elem (assoc kwd result-alist))
2522 (setq result-alist (cons (setq elem (list kwd)) result-alist)))
2523 (unless (memq lang-const (cdr elem))
2524 (setcdr elem (cons lang-const (cdr elem))))))
2525 result-alist))
2527 (c-lang-defvar c-keywords-obarray
2528 ;; An obarray containing all keywords as symbols. The property list
2529 ;; of each symbol has a non-nil entry for the specific `*-kwds'
2530 ;; lists it's a member of.
2532 ;; E.g. to see whether the string str contains a keyword on
2533 ;; `c-class-decl-kwds', one can do like this:
2534 ;; (get (intern-soft str c-keyword-obarray) 'c-class-decl-kwds)
2535 ;; Which preferably is written using the associated functions in
2536 ;; cc-engine:
2537 ;; (c-keyword-member (c-keyword-sym str) 'c-class-decl-kwds)
2539 ;; The obarray is not stored directly as a language constant since
2540 ;; the printed representation for obarrays used in .elc files isn't
2541 ;; complete.
2543 (let* ((alist (c-lang-const c-keyword-member-alist))
2544 kwd lang-const-list
2545 (obarray (make-vector (* (length alist) 2) 0)))
2546 (while alist
2547 (setq kwd (caar alist)
2548 lang-const-list (cdar alist)
2549 alist (cdr alist))
2550 (setplist (intern kwd obarray)
2551 ;; Emacs has an odd bug that causes `mapcan' to fail
2552 ;; with unintelligible errors. (XEmacs works.)
2553 ;;(mapcan (lambda (lang-const)
2554 ;; (list lang-const t))
2555 ;; lang-const-list)
2556 (apply 'nconc (mapcar (lambda (lang-const)
2557 (list lang-const t))
2558 lang-const-list))))
2559 obarray))
2561 (c-lang-defconst c-regular-keywords-regexp
2562 ;; Adorned regexp matching all keywords that should be fontified
2563 ;; with the keywords face. I.e. that aren't types or constants.
2564 t (c-make-keywords-re t
2565 (set-difference (c-lang-const c-keywords)
2566 (append (c-lang-const c-primitive-type-kwds)
2567 (c-lang-const c-constant-kwds))
2568 :test 'string-equal)))
2569 (c-lang-defvar c-regular-keywords-regexp
2570 (c-lang-const c-regular-keywords-regexp))
2572 (c-lang-defconst c-primary-expr-regexp
2573 ;; Regexp matching the start of any primary expression, i.e. any
2574 ;; literal, symbol, prefix operator, and '('. It doesn't need to
2575 ;; exclude keywords; they are excluded afterwards unless the second
2576 ;; submatch matches. If the first but not the second submatch
2577 ;; matches then it is an ambiguous primary expression; it could also
2578 ;; be a match of e.g. an infix operator. (The case with ambiguous
2579 ;; keyword operators isn't handled.)
2581 t (let* ((prefix-ops
2582 (c-filter-ops (c-lang-const c-operators)
2583 '(prefix)
2584 (lambda (op)
2585 ;; Filter out the special case prefix
2586 ;; operators that are close parens.
2587 (not (string-match "\\s)" op)))))
2589 (nonkeyword-prefix-ops
2590 (c-filter-ops prefix-ops
2592 "\\`\\(\\s.\\|\\s(\\|\\s)\\)+\\'"))
2594 (in-or-postfix-ops
2595 (c-filter-ops (c-lang-const c-operators)
2596 '(postfix
2597 postfix-if-paren
2598 left-assoc
2599 right-assoc
2600 right-assoc-sequence)
2603 (unambiguous-prefix-ops (set-difference nonkeyword-prefix-ops
2604 in-or-postfix-ops
2605 :test 'string-equal))
2606 (ambiguous-prefix-ops (intersection nonkeyword-prefix-ops
2607 in-or-postfix-ops
2608 :test 'string-equal)))
2610 (concat
2611 "\\("
2612 ;; Take out all symbol class operators from `prefix-ops' and make the
2613 ;; first submatch from them together with `c-primary-expr-kwds'.
2614 (c-make-keywords-re t
2615 (append (c-lang-const c-primary-expr-kwds)
2616 (set-difference prefix-ops nonkeyword-prefix-ops
2617 :test 'string-equal)))
2619 "\\|"
2620 ;; Match all ambiguous operators.
2621 (c-make-keywords-re nil
2622 (intersection nonkeyword-prefix-ops in-or-postfix-ops
2623 :test 'string-equal))
2624 "\\)"
2626 "\\|"
2627 ;; Now match all other symbols.
2628 (c-lang-const c-symbol-start)
2630 "\\|"
2631 ;; The chars that can start integer and floating point
2632 ;; constants.
2633 "\\.?[0-9]"
2635 "\\|"
2636 ;; The unambiguous operators from `prefix-ops'.
2637 (c-make-keywords-re nil
2638 (set-difference nonkeyword-prefix-ops in-or-postfix-ops
2639 :test 'string-equal))
2641 "\\|"
2642 ;; Match string and character literals.
2643 "\\s\""
2644 (if (memq 'gen-string-delim c-emacs-features)
2645 "\\|\\s|"
2646 ""))))
2647 (c-lang-defvar c-primary-expr-regexp (c-lang-const c-primary-expr-regexp))
2650 ;;; Additional constants for parser-level constructs.
2652 (c-lang-defconst c-decl-start-colon-kwd-re
2653 "Regexp matching a keyword that is followed by a colon, where
2654 the whole construct can precede a declaration.
2655 E.g. \"public:\" in C++."
2656 t "\\<\\>"
2657 c++ (c-make-keywords-re t (c-lang-const c-protection-kwds)))
2658 (c-lang-defvar c-decl-start-colon-kwd-re
2659 (c-lang-const c-decl-start-colon-kwd-re))
2661 (c-lang-defconst c-decl-prefix-re
2662 "Regexp matching something that might precede a declaration, cast or
2663 label, such as the last token of a preceding statement or declaration.
2664 This is used in the common situation where a declaration or cast
2665 doesn't start with any specific token that can be searched for.
2667 The regexp should not match bob; that is done implicitly. It can't
2668 require a match longer than one token. The end of the token is taken
2669 to be at the end of the first submatch, which is assumed to always
2670 match. It's undefined whether identifier syntax (see
2671 `c-identifier-syntax-table') is in effect or not. This regexp is
2672 assumed to be a superset of `c-label-prefix-re' if
2673 `c-recognize-colon-labels' is set.
2675 Besides this, `c-decl-start-kwds' is used to find declarations.
2677 Note: This variable together with `c-decl-start-re' and
2678 `c-decl-start-kwds' is only used to detect \"likely\"
2679 declaration/cast/label starts. I.e. they might produce more matches
2680 but should not miss anything (or else it's necessary to use text
2681 properties - see the next note). Wherever they match, the following
2682 construct is analyzed to see if it indeed is a declaration, cast or
2683 label. That analysis is not cheap, so it's important that not too
2684 many false matches are triggered.
2686 Note: If a declaration/cast/label start can't be detected with this
2687 variable, it's necessary to use the `c-type' text property with the
2688 value `c-decl-end' on the last char of the last token preceding the
2689 declaration. See the comment blurb at the start of cc-engine.el for
2690 more info."
2692 ;; We match a sequence of characters to skip over things like \"};\"
2693 ;; more quickly. We match ")" in C for K&R region declarations, and
2694 ;; in all languages except Java for when a cpp macro definition
2695 ;; begins with a declaration.
2696 t "\\([\{\}\(\);,]+\\)"
2697 java "\\([\{\}\(;,<]+\\)"
2698 ;; Match "<" in C++ to get the first argument in a template arglist.
2699 ;; In that case there's an additional check in `c-find-decl-spots'
2700 ;; that it got open paren syntax. Match ":" to aid in picking up
2701 ;; "public:", etc. This involves additional checks in
2702 ;; `c-find-decl-prefix-search' to prevent a match of identifiers
2703 ;; or labels.
2704 c++ "\\([\{\}\(\);:,<]+\\)"
2705 ;; Additionally match the protection directives in Objective-C.
2706 ;; Note that this doesn't cope with the longer directives, which we
2707 ;; would have to match from start to end since they don't end with
2708 ;; any easily recognized characters.
2709 objc (concat "\\([\{\}\(\);,]+\\|"
2710 (c-make-keywords-re nil (c-lang-const c-protection-kwds))
2711 "\\)")
2712 ;; Pike is like C but we also match "[" for multiple value
2713 ;; assignments and type casts.
2714 pike "\\([\{\}\(\)\[;,]+\\)")
2715 (c-lang-defvar c-decl-prefix-re (c-lang-const c-decl-prefix-re)
2716 'dont-doc)
2718 (c-lang-defconst c-decl-start-re
2719 "Regexp matching the start of any declaration, cast or label.
2720 It's used on the token after the one `c-decl-prefix-re' matched. This
2721 regexp should not try to match those constructs accurately as it's
2722 only used as a sieve to avoid spending more time checking other
2723 constructs."
2724 t (c-lang-const c-identifier-start))
2725 (c-lang-defvar c-decl-start-re (c-lang-const c-decl-start-re))
2727 (c-lang-defconst c-decl-prefix-or-start-re
2728 ;; Regexp matching something that might precede or start a
2729 ;; declaration, cast or label.
2731 ;; If the first submatch matches, it's taken to match the end of a
2732 ;; token that might precede such a construct, e.g. ';', '}' or '{'.
2733 ;; It's built from `c-decl-prefix-re'.
2735 ;; If the first submatch did not match, the match of the whole
2736 ;; regexp is taken to be at the first token in the declaration.
2737 ;; `c-decl-start-re' is not checked in this case.
2739 ;; Design note: The reason the same regexp is used to match both
2740 ;; tokens that precede declarations and start them is to avoid an
2741 ;; extra regexp search from the previous declaration spot in
2742 ;; `c-find-decl-spots'. Users of `c-find-decl-spots' also count on
2743 ;; that it finds all declaration/cast/label starts in approximately
2744 ;; linear order, so we can't do the searches in two separate passes.
2745 t (if (c-lang-const c-decl-start-kwds)
2746 (concat (c-lang-const c-decl-prefix-re)
2747 "\\|"
2748 (c-make-keywords-re t (c-lang-const c-decl-start-kwds)))
2749 (c-lang-const c-decl-prefix-re)))
2750 (c-lang-defvar c-decl-prefix-or-start-re
2751 (c-lang-const c-decl-prefix-or-start-re)
2752 'dont-doc)
2754 (c-lang-defconst c-cast-parens
2755 ;; List containing the paren characters that can open a cast, or nil in
2756 ;; languages without casts.
2757 t (c-filter-ops (c-lang-const c-operators)
2758 '(prefix)
2759 "\\`\\s\(\\'"
2760 (lambda (op) (elt op 0))))
2761 (c-lang-defvar c-cast-parens (c-lang-const c-cast-parens))
2763 (c-lang-defconst c-block-prefix-disallowed-chars
2764 "List of syntactically relevant characters that never can occur before
2765 the open brace in any construct that contains a brace block, e.g. in
2766 the \"class Foo: public Bar\" part of:
2768 class Foo: public Bar {int x();} a, *b;
2770 If parens can occur, the chars inside those aren't filtered with this
2771 list.
2773 '<' and '>' should be disallowed even if angle bracket arglists can
2774 occur. That since the search function needs to stop at them anyway to
2775 ensure they are given paren syntax.
2777 This is used to skip backward from the open brace to find the region
2778 in which to look for a construct like \"class\", \"enum\",
2779 \"namespace\" or whatever. That skipping should be as tight as
2780 possible for good performance."
2782 ;; Default to all chars that only occurs in nonsymbol tokens outside
2783 ;; identifiers.
2784 t (set-difference
2785 (c-lang-const c-nonsymbol-token-char-list)
2786 (c-filter-ops (append (c-lang-const c-identifier-ops)
2787 (list (cons nil
2788 (c-lang-const c-after-id-concat-ops))))
2791 (lambda (op)
2792 (let ((pos 0) res)
2793 (while (string-match "\\(\\s.\\|\\s(\\|\\s)\\)"
2794 op pos)
2795 (setq res (cons (aref op (match-beginning 1)) res)
2796 pos (match-end 0)))
2797 res))))
2799 ;; Allow cpp operations (where applicable).
2800 t (if (c-lang-const c-opt-cpp-prefix)
2801 (set-difference (c-lang-const c-block-prefix-disallowed-chars)
2802 '(?#))
2803 (c-lang-const c-block-prefix-disallowed-chars))
2805 ;; Allow ':' for inherit list starters.
2806 (c++ objc idl) (set-difference (c-lang-const c-block-prefix-disallowed-chars)
2807 '(?:))
2809 ;; Allow ',' for multiple inherits.
2810 (c++ java) (set-difference (c-lang-const c-block-prefix-disallowed-chars)
2811 '(?,))
2813 ;; Allow parentheses for anonymous inner classes in Java and class
2814 ;; initializer lists in Pike.
2815 (java pike) (set-difference (c-lang-const c-block-prefix-disallowed-chars)
2816 '(?\( ?\)))
2818 ;; Allow '"' for extern clauses (e.g. extern "C" {...}).
2819 (c c++ objc) (set-difference (c-lang-const c-block-prefix-disallowed-chars)
2820 '(?\" ?')))
2822 (c-lang-defconst c-block-prefix-charset
2823 ;; `c-block-prefix-disallowed-chars' as an inverted charset suitable
2824 ;; for `c-syntactic-skip-backward'.
2825 t (c-make-bare-char-alt (c-lang-const c-block-prefix-disallowed-chars) t))
2826 (c-lang-defvar c-block-prefix-charset (c-lang-const c-block-prefix-charset))
2828 (c-lang-defconst c-type-decl-prefix-key
2829 "Regexp matching any declarator operator that might precede the
2830 identifier in a declaration, e.g. the \"*\" in \"char *argv\". This
2831 regexp should match \"(\" if parentheses are valid in declarators.
2832 The end of the first submatch is taken as the end of the operator.
2833 Identifier syntax is in effect when this is matched \(see
2834 `c-identifier-syntax-table')."
2835 t (if (c-lang-const c-type-modifier-kwds)
2836 (concat (regexp-opt (c-lang-const c-type-modifier-kwds) t) "\\>")
2837 ;; Default to a regexp that never matches.
2838 "\\<\\>")
2839 ;; Check that there's no "=" afterwards to avoid matching tokens
2840 ;; like "*=".
2841 (c objc) (concat "\\("
2842 "[*\(]"
2843 "\\|"
2844 (c-lang-const c-type-decl-prefix-key)
2845 "\\)"
2846 "\\([^=]\\|$\\)")
2847 c++ (concat "\\("
2848 "[*\(&]"
2849 "\\|"
2850 (c-lang-const c-type-decl-prefix-key)
2851 "\\|"
2852 (concat "\\(" ; 3
2853 ;; If this matches there's special treatment in
2854 ;; `c-font-lock-declarators' and
2855 ;; `c-font-lock-declarations' that check for a
2856 ;; complete name followed by ":: *".
2857 (c-lang-const c-identifier-start)
2858 "\\)")
2859 "\\)"
2860 "\\([^=]\\|$\\)")
2861 pike "\\(\\*\\)\\([^=]\\|$\\)")
2862 (c-lang-defvar c-type-decl-prefix-key (c-lang-const c-type-decl-prefix-key)
2863 'dont-doc)
2865 (c-lang-defconst c-type-decl-suffix-key
2866 "Regexp matching the declarator operators that might follow after the
2867 identifier in a declaration, e.g. the \"[\" in \"char argv[]\". This
2868 regexp should match \")\" if parentheses are valid in declarators. If
2869 it matches an open paren of some kind, the type declaration check
2870 continues at the corresponding close paren, otherwise the end of the
2871 first submatch is taken as the end of the operator. Identifier syntax
2872 is in effect when this is matched (see `c-identifier-syntax-table')."
2873 ;; Default to a regexp that matches `c-type-modifier-kwds' and a
2874 ;; function argument list parenthesis.
2875 t (if (c-lang-const c-type-modifier-kwds)
2876 (concat "\\(\(\\|"
2877 (regexp-opt (c-lang-const c-type-modifier-kwds) t) "\\>"
2878 "\\)")
2879 "\\(\(\\)")
2880 (c c++ objc) (concat
2881 "\\("
2882 "[\)\[\(]"
2883 (if (c-lang-const c-type-modifier-kwds)
2884 (concat
2885 "\\|"
2886 ;; "throw" in `c-type-modifier-kwds' is followed
2887 ;; by a parenthesis list, but no extra measures
2888 ;; are necessary to handle that.
2889 (regexp-opt (c-lang-const c-type-modifier-kwds) t)
2890 "\\>")
2892 "\\)")
2893 java "\\([\[\(\)]\\)"
2894 idl "\\([\[\(]\\)")
2895 (c-lang-defvar c-type-decl-suffix-key (c-lang-const c-type-decl-suffix-key)
2896 'dont-doc)
2898 (c-lang-defconst c-after-suffixed-type-decl-key
2899 "This regexp is matched after a declarator expression where
2900 `c-type-decl-suffix-key' has matched. If it matches then the
2901 construct is taken as a declaration. It's typically used to match the
2902 beginning of a function body or whatever might occur after the
2903 function header in a function declaration or definition. It's
2904 undefined whether identifier syntax (see `c-identifier-syntax-table')
2905 is in effect or not.
2907 Note that it's used in cases like after \"foo (bar)\" so it should
2908 only match when it's certain that it's a declaration, e.g., \"{\" but
2909 not \",\" or \";\"."
2910 t "{"
2911 ;; If K&R style declarations should be recognized then one could
2912 ;; consider to match the start of any symbol since we want to match
2913 ;; the start of the first declaration in the "K&R region". That
2914 ;; could however produce false matches on code like "FOO(bar) x"
2915 ;; where FOO is a cpp macro, so it's better to leave it out and rely
2916 ;; on the other heuristics in that case.
2917 t (if (c-lang-const c-postfix-spec-kwds)
2918 ;; Add on the keywords in `c-postfix-spec-kwds'.
2919 (concat (c-lang-const c-after-suffixed-type-decl-key)
2920 "\\|"
2921 (c-make-keywords-re t (c-lang-const c-postfix-spec-kwds)))
2922 (c-lang-const c-after-suffixed-type-decl-key))
2923 ;; Also match the colon that starts a base class initializer list in
2924 ;; C++. That can be confused with a function call before the colon
2925 ;; in a ? : operator, but we count on that `c-decl-prefix-re' won't
2926 ;; match before such a thing (as a declaration-level construct;
2927 ;; matches inside arglist contexts are already excluded).
2928 c++ "[{:]")
2929 (c-lang-defvar c-after-suffixed-type-decl-key
2930 (c-lang-const c-after-suffixed-type-decl-key)
2931 'dont-doc)
2933 (c-lang-defconst c-after-suffixed-type-maybe-decl-key
2934 ;; Regexp that in addition to `c-after-suffixed-type-decl-key'
2935 ;; matches ";" and ",".
2936 t (concat "\\(" (c-lang-const c-after-suffixed-type-decl-key) "\\)"
2937 "\\|[;,]"))
2938 (c-lang-defvar c-after-suffixed-type-maybe-decl-key
2939 (c-lang-const c-after-suffixed-type-maybe-decl-key))
2941 (c-lang-defconst c-opt-type-concat-key
2942 "Regexp matching operators that concatenate types, e.g. the \"|\" in
2943 \"int|string\" in Pike. The end of the first submatch is taken as the
2944 end of the operator. nil in languages without such operators. It's
2945 undefined whether identifier syntax (see `c-identifier-syntax-table')
2946 is in effect or not."
2947 t nil
2948 pike "\\([|.&]\\)\\($\\|[^|.&]\\)")
2949 (c-lang-defvar c-opt-type-concat-key (c-lang-const c-opt-type-concat-key)
2950 'dont-doc)
2952 (c-lang-defconst c-opt-type-suffix-key
2953 "Regexp matching operators that might follow after a type, or nil in
2954 languages that don't have such operators. The end of the first
2955 submatch is taken as the end of the operator. This should not match
2956 things like C++ template arglists if `c-recognize-<>-arglists' is set.
2957 It's undefined whether identifier syntax (see `c-identifier-syntax-table')
2958 is in effect or not."
2959 t nil
2960 (c c++ objc pike) "\\(\\.\\.\\.\\)"
2961 java (concat "\\(\\[" (c-lang-const c-simple-ws) "*\\]\\|\\.\\.\\.\\)"))
2962 (c-lang-defvar c-opt-type-suffix-key (c-lang-const c-opt-type-suffix-key))
2964 (c-lang-defvar c-known-type-key
2965 ;; Regexp matching the known type identifiers. This is initialized
2966 ;; from the type keywords and `*-font-lock-extra-types'. The first
2967 ;; submatch is the one that matches the type. Note that this regexp
2968 ;; assumes that symbol constituents like '_' and '$' have word
2969 ;; syntax.
2970 (let* ((extra-types
2971 (when (boundp (c-mode-symbol "font-lock-extra-types"))
2972 (c-mode-var "font-lock-extra-types")))
2973 (regexp-strings
2974 (apply 'nconc
2975 (mapcar (lambda (re)
2976 (when (string-match "[][.*+?^$\\]" re)
2977 (list re)))
2978 extra-types)))
2979 (plain-strings
2980 (apply 'nconc
2981 (mapcar (lambda (re)
2982 (unless (string-match "[][.*+?^$\\]" re)
2983 (list re)))
2984 extra-types))))
2985 (concat "\\<\\("
2986 (c-concat-separated
2987 (append (list (c-make-keywords-re nil
2988 (append (c-lang-const c-primitive-type-kwds)
2989 plain-strings)))
2990 regexp-strings)
2991 "\\|")
2992 "\\)\\>")))
2994 (c-lang-defconst c-special-brace-lists
2995 "List of open- and close-chars that makes up a pike-style brace list,
2996 i.e. for a ([ ]) list there should be a cons (?\\[ . ?\\]) in this
2997 list."
2998 t nil
2999 pike '((?{ . ?}) (?\[ . ?\]) (?< . ?>)))
3000 (c-lang-defvar c-special-brace-lists (c-lang-const c-special-brace-lists))
3002 (c-lang-defconst c-recognize-knr-p
3003 "Non-nil means K&R style argument declarations are valid."
3004 t nil
3005 c t)
3006 (c-lang-defvar c-recognize-knr-p (c-lang-const c-recognize-knr-p))
3008 (c-lang-defconst c-recognize-typeless-decls
3009 "Non-nil means function declarations without return type should be
3010 recognized. That can introduce an ambiguity with parenthesized macro
3011 calls before a brace block. This setting does not affect declarations
3012 that are preceded by a declaration starting keyword, so
3013 e.g. `c-typeless-decl-kwds' may still be used when it's set to nil."
3014 t nil
3015 (c c++ objc java) t)
3016 (c-lang-defvar c-recognize-typeless-decls
3017 (c-lang-const c-recognize-typeless-decls))
3019 (c-lang-defconst c-recognize-<>-arglists
3020 "Non-nil means C++ style template arglists should be handled. More
3021 specifically, this means a comma separated list of types or
3022 expressions surrounded by \"<\" and \">\". It's always preceded by an
3023 identifier or one of the keywords on `c-<>-type-kwds' or
3024 `c-<>-arglist-kwds'. If there's an identifier before then the whole
3025 expression is considered to be a type."
3026 t (or (consp (c-lang-const c-<>-type-kwds))
3027 (consp (c-lang-const c-<>-arglist-kwds)))
3028 java t) ; 2008-10-19. This is crude. The syntax for java
3029 ; generics is not yet coded in CC Mode.
3030 (c-lang-defvar c-recognize-<>-arglists (c-lang-const c-recognize-<>-arglists))
3032 (c-lang-defconst c-enums-contain-decls
3033 "Non-nil means that an enum structure can contain declarations."
3034 t nil
3035 java t)
3036 (c-lang-defvar c-enums-contain-decls (c-lang-const c-enums-contain-decls))
3038 (c-lang-defconst c-recognize-paren-inits
3039 "Non-nil means that parenthesis style initializers exist,
3040 i.e. constructs like
3042 Foo bar (gnu);
3044 in addition to the more classic
3046 Foo bar = gnu;"
3047 t nil
3048 c++ t)
3049 (c-lang-defvar c-recognize-paren-inits (c-lang-const c-recognize-paren-inits))
3051 (c-lang-defconst c-recognize-paren-inexpr-blocks
3052 "Non-nil to recognize gcc style in-expression blocks,
3053 i.e. compound statements surrounded by parentheses inside expressions."
3054 t nil
3055 (c c++) t)
3056 (c-lang-defvar c-recognize-paren-inexpr-blocks
3057 (c-lang-const c-recognize-paren-inexpr-blocks))
3059 (c-lang-defconst c-opt-<>-arglist-start
3060 ;; Regexp matching the start of angle bracket arglists in languages
3061 ;; where `c-recognize-<>-arglists' is set. Does not exclude
3062 ;; keywords outside `c-<>-arglist-kwds'. The first submatch is
3063 ;; assumed to surround the preceding symbol. The whole match is
3064 ;; assumed to end directly after the opening "<".
3065 t (if (c-lang-const c-recognize-<>-arglists)
3066 (concat "\\("
3067 (c-lang-const c-symbol-key)
3068 "\\)"
3069 (c-lang-const c-syntactic-ws)
3070 "<")))
3071 (c-lang-defvar c-opt-<>-arglist-start (c-lang-const c-opt-<>-arglist-start))
3073 (c-lang-defconst c-opt-<>-arglist-start-in-paren
3074 ;; Regexp that in addition to `c-opt-<>-arglist-start' matches close
3075 ;; parens. The first submatch is assumed to surround
3076 ;; `c-opt-<>-arglist-start'.
3077 t (if (c-lang-const c-opt-<>-arglist-start)
3078 (concat "\\("
3079 (c-lang-const c-opt-<>-arglist-start)
3080 "\\)\\|\\s\)")))
3081 (c-lang-defvar c-opt-<>-arglist-start-in-paren
3082 (c-lang-const c-opt-<>-arglist-start-in-paren))
3084 (c-lang-defconst c-opt-postfix-decl-spec-key
3085 ;; Regexp matching the beginning of a declaration specifier in the
3086 ;; region between the header and the body of a declaration.
3088 ;; TODO: This is currently not used uniformly; c++-mode and
3089 ;; java-mode each have their own ways of using it.
3090 t nil
3091 c++ (concat ":?"
3092 (c-lang-const c-simple-ws) "*"
3093 "\\(virtual" (c-lang-const c-simple-ws) "+\\)?\\("
3094 (c-make-keywords-re nil (c-lang-const c-protection-kwds))
3095 "\\)" (c-lang-const c-simple-ws) "+"
3096 "\\(" (c-lang-const c-symbol-key) "\\)")
3097 java (c-make-keywords-re t (c-lang-const c-postfix-spec-kwds)))
3098 (c-lang-defvar c-opt-postfix-decl-spec-key
3099 (c-lang-const c-opt-postfix-decl-spec-key))
3101 (c-lang-defconst c-recognize-colon-labels
3102 "Non-nil if generic labels ending with \":\" should be recognized.
3103 That includes labels in code and access keys in classes. This does
3104 not apply to labels recognized by `c-label-kwds' and
3105 `c-opt-extra-label-key'."
3106 t nil
3107 (c c++ objc java pike) t)
3108 (c-lang-defvar c-recognize-colon-labels
3109 (c-lang-const c-recognize-colon-labels))
3111 (c-lang-defconst c-label-prefix-re
3112 "Regexp like `c-decl-prefix-re' that matches any token that can precede
3113 a generic colon label. Not used if `c-recognize-colon-labels' is
3114 nil."
3115 t "\\([{};]+\\)")
3116 (c-lang-defvar c-label-prefix-re
3117 (c-lang-const c-label-prefix-re))
3119 (c-lang-defconst c-nonlabel-token-key
3120 "Regexp matching things that can't occur in generic colon labels,
3121 neither in a statement nor in a declaration context. The regexp is
3122 tested at the beginning of every sexp in a suspected label,
3123 i.e. before \":\". Only used if `c-recognize-colon-labels' is set."
3124 t (concat
3125 ;; All keywords except `c-label-kwds' and `c-protection-kwds'.
3126 (c-make-keywords-re t
3127 (set-difference (c-lang-const c-keywords)
3128 (append (c-lang-const c-label-kwds)
3129 (c-lang-const c-protection-kwds))
3130 :test 'string-equal)))
3131 ;; Don't allow string literals, except in AWK. Character constants are OK.
3132 (c objc java pike idl) (concat "\"\\|"
3133 (c-lang-const c-nonlabel-token-key))
3134 ;; Also check for open parens in C++, to catch member init lists in
3135 ;; constructors. We normally allow it so that macros with arguments
3136 ;; work in labels.
3137 c++ (concat "\\s\(\\|\"\\|" (c-lang-const c-nonlabel-token-key)))
3138 (c-lang-defvar c-nonlabel-token-key (c-lang-const c-nonlabel-token-key))
3140 (c-lang-defconst c-nonlabel-token-2-key
3141 "Regexp matching things that can't occur two symbols before a colon in
3142 a label construct. This catches C++'s inheritance construct \"class foo
3143 : bar\". Only used if `c-recognize-colon-labels' is set."
3144 t "\\<\\>" ; matches nothing
3145 c++ (c-make-keywords-re t '("class")))
3146 (c-lang-defvar c-nonlabel-token-2-key (c-lang-const c-nonlabel-token-2-key))
3148 (c-lang-defconst c-opt-extra-label-key
3149 "Optional regexp matching labels.
3150 Normally, labels are detected according to `c-nonlabel-token-key',
3151 `c-decl-prefix-re' and `c-nonlabel-decl-prefix-re'. This regexp can
3152 be used if there are additional labels that aren't recognized that
3153 way."
3154 t nil
3155 objc (c-make-keywords-re t (c-lang-const c-protection-kwds)))
3156 (c-lang-defvar c-opt-extra-label-key (c-lang-const c-opt-extra-label-key))
3158 (c-lang-defconst c-opt-friend-key
3159 ;; Regexp describing friend declarations classes, or nil in
3160 ;; languages that don't have such things.
3162 ;; TODO: Ought to use `c-prefix-spec-kwds-re' or similar, and the
3163 ;; template skipping isn't done properly. This will disappear soon.
3164 t nil
3165 c++ (concat "friend" (c-lang-const c-simple-ws) "+"
3166 "\\|"
3167 (concat "template"
3168 (c-lang-const c-simple-ws) "*"
3169 "<.+>"
3170 (c-lang-const c-simple-ws) "*"
3171 "friend"
3172 (c-lang-const c-simple-ws) "+")))
3173 (c-lang-defvar c-opt-friend-key (c-lang-const c-opt-friend-key))
3175 (c-lang-defconst c-opt-method-key
3176 ;; Special regexp to match the start of Objective-C methods. The
3177 ;; first submatch is assumed to end after the + or - key.
3178 t nil
3179 objc (concat
3180 ;; TODO: Ought to use a better method than anchoring on bol.
3181 "^\\s *"
3182 "\\([+-]\\)"
3183 (c-lang-const c-simple-ws) "*"
3184 (concat "\\(" ; Return type.
3185 "([^\)]*)"
3186 (c-lang-const c-simple-ws) "*"
3187 "\\)?")
3188 "\\(" (c-lang-const c-symbol-key) "\\)"))
3189 (c-lang-defvar c-opt-method-key (c-lang-const c-opt-method-key))
3191 (c-lang-defconst c-type-decl-end-used
3192 ;; Must be set in buffers where the `c-type' text property might be
3193 ;; used with the value `c-decl-end'.
3195 ;; `c-decl-end' is used to mark the ends of labels and access keys
3196 ;; to make interactive refontification work better.
3197 t (or (c-lang-const c-recognize-colon-labels)
3198 (and (c-lang-const c-label-kwds) t))
3199 ;; `c-decl-end' is used to mark the end of the @-style directives in
3200 ;; Objective-C.
3201 objc t)
3202 (c-lang-defvar c-type-decl-end-used (c-lang-const c-type-decl-end-used))
3205 ;;; Wrap up the `c-lang-defvar' system.
3207 ;; Compile in the list of language variables that has been collected
3208 ;; with the `c-lang-defvar' and `c-lang-setvar' macros. Note that the
3209 ;; first element of each is nil.
3210 (defconst c-lang-variable-inits (cc-eval-when-compile c-lang-variable-inits))
3211 (defconst c-emacs-variable-inits (cc-eval-when-compile c-emacs-variable-inits))
3213 ;; Make the `c-lang-setvar' variables buffer local in the current buffer.
3214 ;; These are typically standard emacs variables such as `comment-start'.
3215 (defmacro c-make-emacs-variables-local ()
3216 `(progn
3217 ,@(mapcar (lambda (init)
3218 `(make-local-variable ',(car init)))
3219 (cdr c-emacs-variable-inits))))
3221 (defun c-make-init-lang-vars-fun (mode)
3222 "Create a function that initializes all the language dependent variables
3223 for the given mode.
3225 This function should be evaluated at compile time, so that the
3226 function it returns is byte compiled with all the evaluated results
3227 from the language constants. Use the `c-init-language-vars' macro to
3228 accomplish that conveniently."
3230 (if (and (not load-in-progress)
3231 (boundp 'byte-compile-dest-file)
3232 (stringp byte-compile-dest-file))
3234 ;; No need to byte compile this lambda since the byte compiler is
3235 ;; smart enough to detect the `funcall' construct in the
3236 ;; `c-init-language-vars' macro below and compile it all straight
3237 ;; into the function that contains `c-init-language-vars'.
3238 `(lambda ()
3240 ;; This let sets up the context for `c-mode-var' and similar
3241 ;; that could be in the result from `c--macroexpand-all'.
3242 (let ((c-buffer-is-cc-mode ',mode)
3243 current-var source-eval)
3244 (c-make-emacs-variables-local)
3245 (condition-case err
3247 (if (eq c-version-sym ',c-version-sym)
3248 (setq ,@(let ((c-buffer-is-cc-mode mode)
3249 (c-lang-const-expansion 'immediate))
3250 ;; `c-lang-const' will expand to the evaluated
3251 ;; constant immediately in `c--macroexpand-all'
3252 ;; below.
3253 (mapcan
3254 (lambda (init)
3255 `(current-var ',(car init)
3256 ,(car init) ,(c--macroexpand-all
3257 (elt init 1))))
3258 ;; Note: The following `append' copies the
3259 ;; first argument. That list is small, so
3260 ;; this doesn't matter too much.
3261 (append (cdr c-emacs-variable-inits)
3262 (cdr c-lang-variable-inits)))))
3264 ;; This diagnostic message isn't useful for end
3265 ;; users, so it's disabled.
3266 ;;(unless (get ',mode 'c-has-warned-lang-consts)
3267 ;; (message ,(concat "%s compiled with CC Mode %s "
3268 ;; "but loaded with %s - evaluating "
3269 ;; "language constants from source")
3270 ;; ',mode ,c-version c-version)
3271 ;; (put ',mode 'c-has-warned-lang-consts t))
3273 (setq source-eval t)
3274 (let ((init ',(append (cdr c-emacs-variable-inits)
3275 (cdr c-lang-variable-inits))))
3276 (while init
3277 (setq current-var (caar init))
3278 (set (caar init) (eval (cadar init)))
3279 (setq init (cdr init)))))
3281 (error
3282 (if current-var
3283 (message "Eval error in the `c-lang-defvar' or `c-lang-setvar' for `%s'%s: %S"
3284 current-var
3285 (if source-eval
3286 (format "\
3287 (fallback source eval - %s compiled with CC Mode %s but loaded with %s)"
3288 ',mode ,c-version c-version)
3290 err)
3291 (signal (car err) (cdr err)))))))
3293 ;; Being evaluated from source. Always use the dynamic method to
3294 ;; work well when `c-lang-defvar's in this file are reevaluated
3295 ;; interactively.
3296 `(lambda ()
3297 (require 'cc-langs)
3298 (let ((c-buffer-is-cc-mode ',mode)
3299 (init (append (cdr c-emacs-variable-inits)
3300 (cdr c-lang-variable-inits)))
3301 current-var)
3302 (c-make-emacs-variables-local)
3303 (condition-case err
3305 (while init
3306 (setq current-var (caar init))
3307 (set (caar init) (eval (cadar init)))
3308 (setq init (cdr init)))
3310 (error
3311 (if current-var
3312 (message
3313 "Eval error in the `c-lang-defvar' or `c-lang-setver' for `%s' (source eval): %S"
3314 current-var err)
3315 (signal (car err) (cdr err)))))))
3318 (defmacro c-init-language-vars (mode)
3319 "Initialize all the language dependent variables for the given mode.
3320 This macro is expanded at compile time to a form tailored for the mode
3321 in question, so MODE must be a constant. Therefore MODE is not
3322 evaluated and should not be quoted."
3323 `(funcall ,(c-make-init-lang-vars-fun mode)))
3326 (cc-provide 'cc-langs)
3328 ;;; cc-langs.el ends here