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