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