| blob | 2d4cc9827147b2acf8529f7132e48cf67de82295 |
1 ;;; cc-defs.el --- compile time definitions for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2003- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
10 ;; 1987 Dave Detlefs and Stewart Clamen
11 ;; 1985 Richard M. Stallman
12 ;; Maintainer: bug-cc-mode@gnu.org
13 ;; Created: 22-Apr-1997 (split from cc-mode.el)
14 ;; Version: See cc-mode.el
15 ;; Keywords: c languages oop
17 ;; This file is part of GNU Emacs.
19 ;; GNU Emacs is free software; you can redistribute it and/or modify
20 ;; it under the terms of the GNU General Public License as published by
21 ;; the Free Software Foundation; either version 3, or (at your option)
22 ;; any later version.
24 ;; GNU Emacs is distributed in the hope that it will be useful,
25 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
26 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 ;; GNU General Public License for more details.
29 ;; You should have received a copy of the GNU General Public License
30 ;; along with this program; see the file COPYING. If not, write to
31 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
32 ;; Boston, MA 02110-1301, USA.
34 ;;; Commentary:
36 ;; This file contains macros, defsubsts, and various other things that
37 ;; must be loaded early both during compilation and at runtime.
39 ;;; Code:
46 load-path)))
52 ;; Silence the compiler.
66 \f
67 ;; cc-fix.el contains compatibility macros that should be used if
68 ;; needed.
74 ; (eval-after-load "font-lock" ; 2006-07-09. font-lock is now preloaded
75 ; '
77 ; to make the call to f-l-c-k throw an error.
84 ;; The above takes care of the delayed loading, but this is necessary
85 ;; to ensure correct byte compilation.
93 font-lock-keywords)))
96 \f
97 ;;; Variables also used at compile time.
103 ;; A little more compact and faster in comparisons.
106 "Non-nil for all buffers with a major mode derived from CC Mode.
107 Otherwise, this variable is nil. I.e. this variable is non-nil for
108 `c-mode', `c++-mode', `objc-mode', `java-mode', `idl-mode',
109 `pike-mode', `awk-mode', and any other non-CC Mode mode that calls
110 `c-initialize-cc-mode'. The value is the mode symbol itself
111 \(i.e. `c-mode' etc) of the original CC Mode mode, or just t if it's
115 ;; Have to make `c-buffer-is-cc-mode' permanently local so that it
116 ;; survives the initialization of the derived mode.
119 \f
120 ;; The following is used below during compilation.
125 "Like `progn', but evaluates the body at compile time.
126 The result of the body appears to the compiler as a quoted constant.
128 This variant works around bugs in `eval-when-compile' in various
129 \(X)Emacs versions. See cc-defs.el for details."
132 ;; XEmacs 21.4.6 has a bug in `eval-when-compile' in that it
133 ;; evaluates its body at macro expansion time if it's nested
134 ;; inside another `eval-when-compile'. So we use a dynamically
135 ;; bound variable to avoid nesting them.
139 ;; In all (X)Emacsen so far, `eval-when-compile' byte compiles
140 ;; its contents before evaluating it. That can cause forms to
141 ;; be compiled in situations they aren't intended to be
142 ;; compiled.
143 ;;
144 ;; Example: It's not possible to defsubst a primitive, e.g. the
145 ;; following will produce an error (in any emacs flavor), since
146 ;; `nthcdr' is a primitive function that's handled specially by
147 ;; the byte compiler and thus can't be redefined:
148 ;;
149 ;; (defsubst nthcdr (val) val)
150 ;;
151 ;; `defsubst', like `defmacro', needs to be evaluated at
152 ;; compile time, so this will produce an error during byte
153 ;; compilation.
154 ;;
155 ;; CC Mode occasionally needs to do things like this for
156 ;; cross-emacs compatibility. It therefore uses the following
157 ;; to conditionally do a `defsubst':
158 ;;
159 ;; (eval-when-compile
160 ;; (if (not (fboundp 'foo))
161 ;; (defsubst foo ...)))
162 ;;
163 ;; But `eval-when-compile' byte compiles its contents and
164 ;; _then_ evaluates it (in all current emacs versions, up to
165 ;; and including Emacs 20.6 and XEmacs 21.1 as of this
166 ;; writing). So this will still produce an error, since the
167 ;; byte compiler will get to the defsubst anyway. That's
168 ;; arguably a bug because the point with `eval-when-compile' is
169 ;; that it should evaluate rather than compile its contents.
170 ;;
171 ;; We get around it by expanding the body to a quoted
172 ;; constant that we eval. That otoh introduce a problem in
173 ;; that a returned lambda expression doesn't get byte
174 ;; compiled (even if `function' is used).
179 \f
180 ;;; Macros.
183 "Return the value of certain commonly referenced POSITIONs relative to POINT.
184 The current point is used if POINT isn't specified. POSITION can be
185 one of the following symbols:
187 `bol' -- beginning of line
188 `eol' -- end of line
189 `bod' -- beginning of defun
190 `eod' -- end of defun
191 `boi' -- beginning of indentation
192 `ionl' -- indentation of next line
193 `iopl' -- indentation of previous line
194 `bonl' -- beginning of next line
195 `eonl' -- end of next line
196 `bopl' -- beginning of previous line
197 `eopl' -- end of previous line
198 `bosws' -- beginning of syntactic whitespace
199 `eosws' -- end of syntactic whitespace
201 If the referenced position doesn't exist, the closest accessible point
202 to it is returned. This function does not modify the point or the mark."
304 ;; The bulk of this should perhaps be in a function to avoid large
305 ;; expansions, but this case is not used anywhere in CC Mode (and
306 ;; probably not anywhere else either) so we only have it to be on
307 ;; the safe side.
338 ;; Return t when the region is active. The determination of region
339 ;; activeness is different in both Emacs and XEmacs.
341 ;; Emacs.
342 'mark-active
343 ;; XEmacs.
347 ;; Activate the region if ACTIVE is non-nil, deactivate it
348 ;; otherwise. Covers the differences between Emacs and XEmacs.
350 ;; XEmacs.
354 ;; Emacs.
358 "Delete the text between START and END and return it."
360 ;; Emacs 21.1 and later
362 ;; XEmacs and Emacs 20.x
368 ;; safely execute BODY, return nil if an error occurred
375 ;; In GNU Emacs, a character is an integer. In XEmacs, a character is a
376 ;; type distinct from an integer. Sometimes we need to convert integers to
377 ;; characters. `c-int-to-char' makes this conversion, if necessary.
380 integer))
383 ;; Get the regular expression `sentence-end'.
385 ;; Emacs 22:
387 ;; Emacs <22 + XEmacs
391 ;; Get the default value of the variable sentence end.
393 ;; Emacs 22:
395 ;; Emacs <22 + XEmacs
398 ;; The following is essentially `save-buffer-state' from lazy-lock.el.
399 ;; It ought to be a standard macro.
401 "Bind variables according to VARLIST (in `let*' style) and eval BODY,
402 then restore the buffer state under the assumption that no significant
403 modification has been made in BODY. A change is considered
404 significant if it affects the buffer text in any way that isn't
405 completely restored again. Changes in text properties like `face' or
406 `syntax-table' are considered insignificant. This macro allows text
407 properties to be changed, even in a read-only buffer.
409 This macro should be placed around all calculations which set
411 known to be writeable. That way, these text properties remain set
412 even if the user undoes the command which set them.
415 changes \(like adding a newline to calculate a text-property then
416 deleting it again\), so that the user never sees them on his
417 `buffer-undo-list'. See also `c-tentative-buffer-changes'.
419 However, any user-visible changes to the buffer \(like auto-newlines\)
420 must not be within a `c-save-buffer-state', since the user then
421 wouldn't be able to undo them.
423 The return value is the value of the last form in BODY."
426 before-change-functions after-change-functions
427 deactivate-mark
428 buffer-file-name buffer-file-truename ; Prevent primitives checking
429 ; for file modification
439 "Eval BODY and optionally restore the buffer contents to the state it
440 was in before BODY. Any changes are kept if the last form in BODY
441 returns non-nil. Otherwise it's undone using the undo facility, and
442 various other buffer state that might be affected by the changes is
443 restored. That includes the current buffer, point, mark, mark
444 activation \(similar to `save-excursion'), and the modified state.
445 The state is also restored if BODY exits nonlocally.
447 If BODY makes a change that unconditionally is undone then wrap this
448 macro inside `c-save-buffer-state'. That way the change can be done
449 even when the buffer is read-only, and without interference from
450 various buffer change hooks."
452 -tnt-chng-state)
454 ;; Insert an undo boundary for use with `undo-more'. We
455 ;; don't use `undo-boundary' since it doesn't insert one
456 ;; unconditionally.
464 ;; Used internally in `c-tentative-buffer-changes'.
467 ;; No need to use markers for the point and mark; if the
468 ;; undo got out of synch we're hosed anyway.
475 ;; Used internally in `c-tentative-buffer-changes'.
479 ;; No change was done afterall.
483 ;; Find and remove the undo boundary.
489 ;; `primitive-undo' will remove the boundary.
494 saved-undo-list))))
506 "Forward skip over syntactic whitespace.
507 Syntactic whitespace is defined as whitespace characters, comments,
508 and preprocessor directives. However if point starts inside a comment
509 or preprocessor directive, the content of it is not treated as
510 whitespace.
512 LIMIT sets an upper limit of the forward movement, if specified. If
513 LIMIT or the end of the buffer is reached inside a comment or
514 preprocessor directive, the point will be left there.
516 Note that this function might do hidden buffer changes. See the
517 comment at the start of cc-engine.el for more info."
525 "Backward skip over syntactic whitespace.
526 Syntactic whitespace is defined as whitespace characters, comments,
527 and preprocessor directives. However if point starts inside a comment
528 or preprocessor directive, the content of it is not treated as
529 whitespace.
531 LIMIT sets a lower limit of the backward movement, if specified. If
532 LIMIT is reached inside a line comment or preprocessor directive then
533 the point is moved into it past the whitespace at the end.
535 Note that this function might do hidden buffer changes. See the
536 comment at the start of cc-engine.el for more info."
544 "Move forward across COUNT balanced expressions.
545 A negative COUNT means move backward. Signal an error if the move
546 fails for any reason.
548 This is like `forward-sexp' except that it isn't interactive and does
549 not do any user friendly adjustments of the point and that it isn't
550 susceptible to user configurations such as disabling of signals in
551 certain situations."
556 "See `c-forward-sexp' and reverse directions."
561 "Like `scan-lists' but returns nil instead of signalling errors
562 for unbalanced parens.
564 A limit for the search may be given. FROM is assumed to be on the
565 right side of it."
579 res)))
581 \f
582 ;; Wrappers for common scan-lists cases, mainly because it's almost
583 ;; impossible to get a feel for how that function works.
586 "Move backward across one balanced group of parentheses.
588 Return POINT when we succeed, NIL when we fail. In the latter case, leave
589 point unmoved."
592 endpos)))
595 "Move backward across one balanced group of parentheses.
597 Return POINT when we succeed, NIL when we fail. In the latter case, leave
598 point unmoved."
601 endpos)))
604 "Return the first position after the list sexp containing POS,
605 or nil if no such position exists. The point is used if POS is left out.
607 A limit for the search may be given. The start position is assumed to
608 be before it."
612 "Return the position of the start of the list sexp containing POS,
613 or nil if no such position exists. The point is used if POS is left out.
615 A limit for the search may be given. The start position is assumed to
616 be after it."
620 "Return the first position inside the first list sexp after POS,
621 or nil if no such position exists. The point is used if POS is left out.
623 A limit for the search may be given. The start position is assumed to
624 be before it."
628 "Return the last position inside the last list sexp before POS,
629 or nil if no such position exists. The point is used if POS is left out.
631 A limit for the search may be given. The start position is assumed to
632 be after it."
636 "Move the point to the first position after the list sexp containing POS,
637 or containing the point if POS is left out. Return t if such a
638 position exists, otherwise nil is returned and the point isn't moved.
640 A limit for the search may be given. The start position is assumed to
641 be before it."
647 res)))
650 "Move the point to the position of the start of the list sexp containing POS,
651 or containing the point if POS is left out. Return t if such a
652 position exists, otherwise nil is returned and the point isn't moved.
654 A limit for the search may be given. The start position is assumed to
655 be after it."
661 res)))
664 "Move the point to the first position inside the first list sexp after POS,
665 or before the point if POS is left out. Return t if such a position
666 exists, otherwise nil is returned and the point isn't moved.
668 A limit for the search may be given. The start position is assumed to
669 be before it."
675 res)))
678 "Move the point to the last position inside the last list sexp before POS,
679 or before the point if POS is left out. Return t if such a position
680 exists, otherwise nil is returned and the point isn't moved.
682 A limit for the search may be given. The start position is assumed to
683 be after it."
689 res)))
691 \f
693 ;; Wrapper around beginning-of-defun.
694 ;;
695 ;; NOTE: This function should contain the only explicit use of
696 ;; beginning-of-defun in CC Mode. Eventually something better than
697 ;; b-o-d will be available and this should be the only place the
698 ;; code needs to change. Everything else should use
699 ;; (c-beginning-of-defun-1)
700 ;;
701 ;; This is really a bit too large to be a macro but that isn't a
702 ;; problem as long as it only is used in one place in
703 ;; `c-parse-state'.
707 c-enable-xemacs-performance-kludge-p)
709 ;; XEmacs only. This can improve the performance of
710 ;; c-parse-state to between 3 and 60 times faster when
711 ;; braces are hung. It can also degrade performance by
712 ;; about as much when braces are not hung.
714 pos)
724 ;; unbalanced parenthesis, while illegal C code,
725 ;; shouldn't cause an infloop! See unbal.c
727 ;; Punt!
734 ))
736 ;; Emacs, which doesn't have buffer-syntactic-context-depth
739 ;; if defun-prompt-regexp is non-nil, b-o-d won't leave us at the
740 ;; open brace.
745 \f
746 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
747 ;; V i r t u a l S e m i c o l o n s
748 ;;
749 ;; In most CC Mode languages, statements are terminated explicitly by
750 ;; semicolons or closing braces. In some of the CC modes (currently only AWK
751 ;; Mode (April 2004)), statements are (or can be) terminated by EOLs. Such a
752 ;; statement is said to be terminated by a "virtual semicolon" (VS). A
753 ;; statement terminated by an actual semicolon or brace is never considered to
754 ;; have a VS.
755 ;;
756 ;; The indentation engine (or whatever) tests for a VS at a specific position
757 ;; by invoking the macro `c-at-vsemi-p', which in its turn calls the mode
758 ;; specific function (if any) which is the value of the language variable
759 ;; `c-at-vsemi-p-fn'. The actual details of what constitutes a VS in a
760 ;; language are thus encapsulated in code specific to that language
761 ;; (e.g. cc-awk.el). `c-at-vsemi-p' returns non-nil if point (or the optional
762 ;; parameter POS) is at a VS, nil otherwise.
763 ;;
764 ;; The language specific function might well do extensive analysis of the
765 ;; source text, and may use a cacheing scheme to speed up repeated calls.
766 ;;
767 ;; The "virtual semicolon" lies just after the last non-ws token on the line.
768 ;; Like POINT, it is considered to lie between two characters. For example,
769 ;; at the place shown in the following AWK source line:
770 ;;
771 ;; kbyte = 1024 # 1000 if you're not picky
772 ;; ^
773 ;; |
774 ;; Virtual Semicolon
775 ;;
776 ;; In addition to `c-at-vsemi-p-fn', a mode may need to supply a function for
777 ;; `c-vsemi-status-unknown-p-fn'. The macro `c-vsemi-status-unknown-p' is a
778 ;; rather recondite kludge. It exists because the function
779 ;; `c-beginning-of-statement-1' sometimes tests for VSs as an optimisation,
780 ;; but `c-at-vsemi-p' might well need to call `c-beginning-of-statement-1' in
781 ;; its calculations, thus potentially leading to infinite recursion.
782 ;;
783 ;; The macro `c-vsemi-status-unknown-p' resolves this problem; it may return
784 ;; non-nil at any time; returning nil is a guarantee that an immediate
785 ;; invocation of `c-at-vsemi-p' at point will NOT call
786 ;; `c-beginning-of-statement-1'. `c-vsemi-status-unknown-p' may not itself
787 ;; call `c-beginning-of-statement-1'.
788 ;;
789 ;; The macro `c-vsemi-status-unknown-p' will typically check the cacheing
790 ;; scheme used by the `c-at-vsemi-p-fn', hence the name - the status is
791 ;; "unknown" if there is no cache entry current for the line.
792 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
795 ;; Is there a virtual semicolon (not a real one or a }) at POS (defaults to
796 ;; point)? Always returns nil for languages which don't have Virtual
797 ;; semicolons.
798 ;; This macro might do hidden buffer changes.
803 ;; Return NIL only if it can be guaranteed that an immediate
804 ;; (c-at-vsemi-p) will NOT call c-beginning-of-statement-1. Otherwise,
805 ;; return non-nil. (See comments above). The function invoked by this
806 ;; macro MUST NOT UNDER ANY CIRCUMSTANCES itself call
807 ;; c-beginning-of-statement-1.
808 ;; Languages which don't have EOL terminated statements always return NIL
809 ;; (they _know_ there's no vsemi ;-).
812 \f
814 ;; Formats an error message for the echo area and dings, i.e. like
815 ;; `error' but doesn't abort.
821 ;; Temporarily switches to the specified syntax table in a failsafe
822 ;; way to execute code.
832 "Skip over any whitespace following point.
833 This function skips over horizontal and vertical whitespace and line
834 continuations."
838 ;; skip-syntax-* doesn't count \n as whitespace..
853 "Skip over any whitespace preceding point.
854 This function skips over horizontal and vertical whitespace and line
855 continuations."
859 ;; skip-syntax-* doesn't count \n as whitespace..
875 "Return non-nil if the current CC Mode major mode is MODE.
876 MODE is either a mode symbol or a list of mode symbols."
879 ;; Inside a `c-lang-defconst'.
893 \f
894 ;; Macros/functions to handle so-called "char properties", which are
895 ;; properties set on a single character and that never spread to any
896 ;; other characters.
899 ;; Constant used at compile time to decide whether or not to use
900 ;; XEmacs extents. Check all the extent functions we'll use since
901 ;; some packages might add compatibility aliases for some of them in
902 ;; Emacs.
911 ;; `c-put-char-property' is complex enough in XEmacs and Emacs < 21 to
912 ;; make it a function.
916 ;; XEmacs.
926 end-open t)))))))))
929 ;; In Emacs < 21 we have to mess with the `rear-nonsticky' property.
936 'rear-nonsticky
941 ;; Put the given property with the given value on the character at
942 ;; POS and make it front and rear nonsticky, or start and end open
943 ;; in XEmacs vocabulary. If the character already has the given
944 ;; property then the value is replaced, and the behavior is
945 ;; undefined if that property has been put by some other function.
946 ;; PROPERTY is assumed to be constant.
947 ;;
948 ;; If there's a `text-property-default-nonsticky' variable (Emacs
949 ;; 21) then it's assumed that the property is present on it.
950 ;;
951 ;; This macro does a hidden buffer change.
955 ;; XEmacs and Emacs < 21.
957 ;; In Emacs 21 we got the `rear-nonsticky' property covered
958 ;; by `text-property-default-nonsticky'.
963 ;; Get the value of the given property on the character at POS if
964 ;; it's been put there by `c-put-char-property'. PROPERTY is
965 ;; assumed to be constant.
968 ;; XEmacs.
971 ;; Emacs.
974 ;; `c-clear-char-property' is complex enough in Emacs < 21 to make it
975 ;; a function, since we have to mess with the `rear-nonsticky' property.
985 'rear-nonsticky
991 ;; Remove the given property on the character at POS if it's been put
992 ;; there by `c-put-char-property'. PROPERTY is assumed to be
993 ;; constant.
994 ;;
995 ;; This macro does a hidden buffer change.
998 ;; XEmacs.
1002 ;; In Emacs 21 we got the `rear-nonsticky' property covered
1003 ;; by `text-property-default-nonsticky'.
1008 ;; Emacs < 21.
1012 ;; Remove all the occurences of the given property in the given
1013 ;; region that has been put with `c-put-char-property'. PROPERTY is
1014 ;; assumed to be constant.
1015 ;;
1016 ;; Note that this function does not clean up the property from the
1017 ;; lists of the `rear-nonsticky' properties in the region, if such
1018 ;; are used. Thus it should not be used for common properties like
1019 ;; `syntax-table'.
1020 ;;
1021 ;; This macro does hidden buffer changes.
1024 ;; XEmacs.
1028 ;; Emacs.
1031 \f
1032 ;; Macros to put overlays (Emacs) or extents (XEmacs) on buffer text.
1033 ;; For our purposes, these are characterized by being possible to
1034 ;; remove again without affecting the other text properties in the
1035 ;; buffer that got overridden when they were put.
1038 ;; Put an overlay/extent covering the given range in the current
1039 ;; buffer. It's currently undefined whether it's front/end sticky
1040 ;; or not. The overlay/extent object is returned.
1042 ;; Emacs.
1045 ol)
1046 ;; XEmacs.
1049 ext)))
1052 ;; Deletes an overlay/extent object previously retrieved using
1053 ;; `c-put-overlay'.
1055 ;; Emacs.
1057 ;; XEmacs.
1060 \f
1061 ;; Make edebug understand the macros.
1062 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1063 ; '(progn
1092 \f
1093 ;;; Functions.
1095 ;; Note: All these after the macros, to be on safe side in avoiding
1096 ;; bugs where macros are defined too late. These bugs often only show
1097 ;; when the files are compiled in a certain order within the same
1098 ;; session.
1101 ;; Replacement for end-of-defun that use c-beginning-of-defun-1.
1103 ;; Skip forward into the next defun block. Don't bother to avoid
1104 ;; comments, literals etc, since beginning-of-defun doesn't do that
1105 ;; anyway.
1116 ;; Mark the "<" character at POS as an sexp list opener using the
1117 ;; syntax-table property.
1118 ;;
1119 ;; This function does a hidden buffer change.
1125 ;; Mark the ">" character at POS as an sexp list closer using the
1126 ;; syntax-table property.
1127 ;;
1128 ;; This function does a hidden buffer change.
1132 ;; return the element of ALIST that matches the first element found
1133 ;; in LIST. Uses assq.
1138 match))
1141 ;; first, find the first entry from LIST that is present in ALIST1,
1142 ;; then find the entry in ALIST2 for that entry.
1146 "Return the syntactic symbol in LANGELEM.
1150 form as used in `c-syntactic-element'."
1154 "Return the anchor position in LANGELEM, or nil if there is none.
1158 form as used in `c-syntactic-element'."
1164 "Return the column of the anchor position in LANGELEM.
1165 Also move the point to that position unless PRESERVE-POINT is non-nil.
1169 form as used in `c-syntactic-element'."
1181 "Return the secondary position in LANGELEM, or nil if there is none.
1184 in `c-syntactic-element'. It may also be a cons cell as passed in the
1185 first argument to lineup functions, but then the returned value always
1186 will be nil."
1190 ;; Do whatever is necessary to keep the region active in XEmacs.
1191 ;; This is not needed for Emacs.
1205 the corresponding symbol."
1211 c-buffer-is-cc-mode))
1216 the value of the variable with that name."
1220 "Return non-nil if position POS in the current buffer has any of the
1221 faces in the list FACES."
1228 pos-faces)
1232 ;; Return t if FACENAME is the name of a face. This method is
1233 ;; necessary since facep in XEmacs only returns t for the actual
1234 ;; face objects (while it's only their names that are used just
1235 ;; about anywhere else) without providing a predicate that tests
1236 ;; face names.
1240 "Like `concat' on LIST, but separate each element with SEPARATOR.
1241 Notably, null elements in LIST are ignored."
1245 "Make a regexp that matches all the strings the list.
1246 Duplicates and nil elements in the list are removed. The resulting
1247 regexp may contain zero or more submatch expressions.
1249 If ADORN is t there will be at least one submatch and the first
1250 surrounds the matched alternative, and the regexp will also not match
1251 a prefix of any identifier. Adorned regexps cannot be appended. The
1252 language variable `c-nonsymbol-key' is used to make the adornment.
1254 A value 'appendable for ADORN is like above, but all alternatives in
1256 instead, so that the regexp remains appendable. Note that this
1257 variant doesn't always guarantee that an identifier prefix isn't
1258 matched since the symbol constituent '_' is normally considered a
1261 The optional MODE specifies the language to get `c-nonsymbol-key' from
1262 when it's needed. The default is the current language taken from
1263 `c-buffer-is-cc-mode'."
1274 ;; This is kludgy but it works: Search for a string that
1275 ;; doesn't occur in any word in LIST. Append it to all
1276 ;; the alternatives where we want to add \>. Run through
1277 ;; `regexp-opt' and then replace it with \>.
1281 pos list)
1285 nil)
1286 t))
1288 found))
1302 ;; Emacs 20 and XEmacs (all versions so far) has a buggy
1303 ;; regexp-opt that doesn't always cope with strings containing
1304 ;; newlines. This kludge doesn't handle shy parens correctly
1305 ;; so we can't advice regexp-opt directly with it.
1329 ;; Add our own grouping parenthesis around re instead of
1330 ;; passing adorn to `regexp-opt', since in XEmacs it makes the
1331 ;; top level grouping "shy".
1340 re)))
1342 ;; Produce a regexp that matches nothing.
1350 "Make a character alternative string from the list of characters CHARS.
1351 The returned string is of the type that can be used with
1352 `skip-chars-forward' and `skip-chars-backward'. If INVERTED is
1353 non-nil, a caret is prepended to invert the set."
1354 ;; This function ought to be in the elisp core somewhere.
1360 ;; Quoting necessary (this method only works in the skip
1361 ;; functions).
1364 ;; Check for range.
1372 str))
1374 ;; Leftovers from (X)Emacs 19 compatibility.
1378 \f
1379 ;; Figure out what features this Emacs has
1387 ;; I've no idea what this actually is, but it's legacy. /mast
1390 ;; XEmacs uses 8-bit modify-syntax-entry flags.
1391 ;; Emacs uses a 1-bit flag. We will have to set up our
1392 ;; syntax tables differently to handle this.
1394 entry)
1397 ;; Emacs
1400 ;; In Emacs, table entries are cons cells
1402 ;; XEmacs
1405 ;; incompatible
1410 list)))
1413 parse-sexp-lookup-properties
1414 parse-sexp-ignore-comments
1415 lookup-syntax-properties)
1420 ;; For some reason we have to set some of these after the
1421 ;; buffer has been made current. (Specifically,
1422 ;; `parse-sexp-ignore-comments' in Emacs 21.)
1424 parse-sexp-ignore-comments t
1425 lookup-syntax-properties t)
1427 ;; Find out if the `syntax-table' text property works.
1438 "CC Mode is incompatible with this version of Emacs - "
1439 "support for the `syntax-table' text property "
1442 ;; Find out if generic comment delimiters work.
1448 ;; Find out if generic string delimiters work.
1454 ;; See if POSIX char classes work.
1456 ;; All versions of Emacs 21 so far haven't fixed
1457 ;; char classes in `skip-chars-forward' and
1458 ;; `skip-chars-backward'.
1467 ;; See if `open-paren-in-column-0-is-defun-start' exists and
1468 ;; isn't buggy (Emacs >= 21.4).
1476 ;; XEmacs. Afaik this is currently an Emacs-only
1477 ;; feature, but it's good to be prepared.
1481 ;; Emacs
1494 ;; See if `parse-partial-sexp' returns the eighth element.
1499 "CC Mode is incompatible with this version of Emacs - "
1502 ;;(message "c-emacs-features: %S" list)
1503 list)
1504 "A list of certain features in the (X)Emacs you are using.
1505 There are many flavors of Emacs out there, each with different
1506 features supporting those needed by CC Mode. The following values
1507 might be present:
1509 '8-bit 8 bit syntax entry flags (XEmacs style).
1510 '1-bit 1 bit syntax entry flags (Emacs style).
1511 'syntax-properties It works to override the syntax for specific characters
1512 in the buffer with the 'syntax-table property. It's
1513 always set - CC Mode no longer works in emacsen without
1514 this feature.
1515 'gen-comment-delim Generic comment delimiters work
1516 (i.e. the syntax class `!').
1517 'gen-string-delim Generic string delimiters work
1518 (i.e. the syntax class `|').
1519 'pps-extended-state `parse-partial-sexp' returns a list with at least 10
1520 elements, i.e. it contains the position of the start of
1521 the last comment or string. It's always set - CC Mode
1522 no longer works in emacsen without this feature.
1523 'posix-char-classes The regexp engine understands POSIX character classes.
1524 'col-0-paren It's possible to turn off the ad-hoc rule that a paren
1525 in column zero is the start of a defun.
1526 'infodock This is Infodock (based on XEmacs).
1530 \f
1531 ;;; Some helper constants.
1533 ;; If the regexp engine supports POSIX char classes then we can use
1534 ;; them to handle extended charsets correctly.
1548 \f
1549 ;;; System for handling language dependent constants.
1551 ;; This is used to set various language dependent data in a flexible
1552 ;; way: Language constants can be built from the values of other
1553 ;; language constants, also those for other languages. They can also
1554 ;; process the values of other language constants uniformly across all
1555 ;; the languages. E.g. one language constant can list all the type
1556 ;; keywords in each language, and another can build a regexp for each
1557 ;; language from those lists without code duplication.
1558 ;;
1559 ;; Language constants are defined with `c-lang-defconst', and their
1560 ;; value forms (referred to as source definitions) are evaluated only
1561 ;; on demand when requested for a particular language with
1562 ;; `c-lang-const'. It's therefore possible to refer to the values of
1563 ;; constants defined later in the file, or in another file, just as
1564 ;; long as all the relevant `c-lang-defconst' have been loaded when
1565 ;; `c-lang-const' is actually evaluated from somewhere else.
1566 ;;
1567 ;; `c-lang-const' forms are also evaluated at compile time and
1568 ;; replaced with the values they produce. Thus there's no overhead
1569 ;; for this system when compiled code is used - only the values
1570 ;; actually used in the code are present, and the file(s) containing
1571 ;; the `c-lang-defconst' forms don't need to be loaded at all then.
1572 ;; There are however safeguards to make sure that they can be loaded
1573 ;; to get the source definitions for the values if there's a mismatch
1574 ;; in compiled versions, or if `c-lang-const' is used uncompiled.
1575 ;;
1576 ;; Note that the source definitions in a `c-lang-defconst' form are
1577 ;; compiled into the .elc file where it stands; there's no need to
1578 ;; load the source file to get it.
1579 ;;
1580 ;; See cc-langs.el for more details about how this system is deployed
1581 ;; in CC Mode, and how the associated language variable system
1582 ;; (`c-lang-defvar') works. That file also contains a lot of
1583 ;; examples.
1586 "Declare a new language in the language dependent variable system.
1587 This is intended to be used by modes that inherit CC Mode to add new
1588 languages. It should be used at the top level before any calls to
1589 `c-lang-defconst'. MODE is the mode name symbol for the new language,
1590 and BASE-MODE is the mode name symbol for the language in CC Mode that
1591 is to be the template for the new mode.
1593 The exact effect of BASE-MODE is to make all language constants that
1594 haven't got a setting in the new language fall back to their values in
1595 BASE-MODE. It does not have any effect outside the language constant
1596 system."
1605 ;; This obarray is a cache to keep track of the language constants
1606 ;; defined by `c-lang-defconst' and the evaluated values returned by
1607 ;; `c-lang-const'. It's mostly used at compile time but it's not
1608 ;; stored in compiled files.
1609 ;;
1610 ;; The obarray contains all the language constants as symbols. The
1611 ;; value cells hold the evaluated values as alists where each car is
1612 ;; the mode name symbol and the corresponding cdr is the evaluated
1613 ;; value in that mode. The property lists hold the source definitions
1614 ;; and other miscellaneous data. The obarray might also contain
1615 ;; various other symbols, but those don't have any variable bindings.
1620 ;; Return the base name of the current file.
1623 ;; Being loaded.
1624 load-file-name)
1627 ;; Being compiled.
1628 byte-compile-dest-file)
1630 ;; Being evaluated interactively.
1637 "Can be used inside a VAL in `c-lang-defconst' to evaluate FORM
1638 immediately, i.e. at the same time as the `c-lang-defconst' form
1639 itself is evaluated."
1640 ;; Evaluate at macro expansion time, i.e. in the
1641 ;; `cl-macroexpand-all' inside `c-lang-defconst'.
1645 "Set the language specific values of the language constant NAME.
1646 The second argument can optionally be a docstring. The rest of the
1647 arguments are one or more repetitions of LANG VAL where LANG specifies
1648 the language(s) that VAL applies to. LANG is the name of the
1650 of such language names, or `t' for all languages. VAL is a form to
1651 evaluate to get the value.
1653 If LANG isn't `t' or one of the core languages in CC Mode, it must
1654 have been declared with `c-add-language'.
1656 Neither NAME, LANG nor VAL are evaluated directly - they should not be
1657 quoted. `c-lang-defconst-eval-immediately' can however be used inside
1658 VAL to evaluate parts of it directly.
1660 When VAL is evaluated for some language, that language is temporarily
1661 made current so that `c-lang-const' without an explicit language can
1662 be used inside VAL to refer to the value of a language constant in the
1663 same language. That is particularly useful if LANG is `t'.
1665 VAL is not evaluated right away but rather when the value is requested
1666 with `c-lang-const'. Thus it's possible to use `c-lang-const' inside
1667 VAL to refer to language constants that haven't been defined yet.
1668 However, if the definition of a language constant is in another file
1669 then that file must be loaded \(at compile time) before it's safe to
1670 reference the constant.
1672 The assignments in ARGS are processed in sequence like `setq', so
1673 \(c-lang-const NAME) may be used inside a VAL to refer to the last
1674 assigned value to this language constant, or a value that it has
1675 gotten in another earlier loaded file.
1677 To work well with repeated loads and interactive reevaluation, only
1678 one `c-lang-defconst' for each NAME is permitted per file. If there
1679 already is one it will be completely replaced; the value in the
1680 earlier definition will not affect `c-lang-const' on the same
1681 constant. A file is identified by its base name."
1684 ;; Make `c-lang-const' expand to a straightforward call to
1685 ;; `c-get-lang-constant' in `cl-macroexpand-all' below.
1686 ;;
1687 ;; (The default behavior, i.e. to expand to a call inside
1688 ;; `eval-when-compile' should be equivalent, since that macro
1689 ;; should only expand to its content if it's used inside a
1690 ;; form that's already evaluated at compile time. It's
1691 ;; however necessary to use our cover macro
1692 ;; `cc-eval-when-compile' due to bugs in `eval-when-compile',
1693 ;; and it expands to a bulkier form that in this case only is
1694 ;; unnecessary garbage that we don't want to store in the
1695 ;; language constant source definitions.)
1698 bindings
1699 pre-files)
1705 ;; The docstring is hardly used anywhere since there's no normal
1706 ;; symbol to attach it to. It's primarily for getting the right
1707 ;; format in the source.
1714 ;; Rework ARGS to an association list to make it easier to handle.
1715 ;; It's reversed at the same time to make it easier to implement
1716 ;; the demand-driven (i.e. reversed) evaluation in `c-lang-const'.
1733 val)
1740 ;; Emacs has a weird bug where it seems to fail to read
1741 ;; backquote lists from byte compiled files correctly (,@
1742 ;; forms, to be specific), so make sure the bindings in the
1743 ;; expansion below don't contain any backquote stuff.
1744 ;; (XEmacs handles it correctly and doesn't need this for that
1745 ;; reason, but we also use this expansion handle
1746 ;; `c-lang-defconst-eval-immediately' and to register
1747 ;; dependencies on the `c-lang-const's in VAL.)
1753 ;; Compile in the other files that have provided source
1754 ;; definitions for this symbol, to make sure the order in the
1755 ;; `source' property is correct even when files are loaded out of
1756 ;; order.
1758 ;; Reverse to get the right load order.
1766 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1767 ; '
1772 ;; Used by `c-lang-defconst'.
1781 ;;(when (cdr-safe elem)
1782 ;; (message "Language constant %s redefined in %S" name file))
1784 ;; Note that the order in the source alist is relevant. Like how
1785 ;; `c-lang-defconst' reverses the bindings, this reverses the
1786 ;; order between files so that the last to evaluate comes first.
1796 ;; Bind the symbol as a variable, or clear any earlier evaluated
1797 ;; value it has.
1800 ;; Clear the evaluated values that depend on this source.
1803 ptr)
1816 name))
1819 "Get the mode specific value of the language constant NAME in language LANG.
1820 LANG is the name of the language, i.e. the mode name without the
1822 `c-lang-defvar', LANG may be left out to refer to the current
1823 language. NAME and LANG are not evaluated so they should not be
1824 quoted."
1832 mode source-files args)
1838 "Unknown language %S since it got no `c-mode-prefix' property"
1842 ;; No need to find out the source file(s) when we evaluate
1843 ;; immediately since all the info is already there in the
1844 ;; `source' property.
1849 ;; Get the source file(s) that must be loaded to get the value
1850 ;; of the constant. If the symbol isn't defined yet we assume
1851 ;; that its definition will come later in this file, and thus
1852 ;; are no file dependencies needed.
1854 ;; Reverse to get the right load order.
1858 nil ; Exclude our own file.
1862 ;; Make some effort to do a compact call to
1863 ;; `c-get-lang-constant' since it will be compiled in.
1867 args)))
1872 load-in-progress
1875 ;; Either a straight call is requested in the context, or
1876 ;; we're in an "uncontrolled" context and got no language,
1877 ;; or we're not being byte compiled so the compile time
1878 ;; stuff below is unnecessary.
1881 ;; Being compiled. If the loading and compiling version is
1882 ;; the same we use a value that is evaluated at compile time,
1883 ;; otherwise it's evaluated at runtime.
1892 ;; Used by `c-lang-const'.
1900 elem
1904 ;; Record the dependencies between this symbol and the one we're
1905 ;; being evaluated in.
1910 ;; Make sure the source files have entries on the `source'
1911 ;; property so that loading will take place when necessary.
1916 ;; Might pull in more definitions which affect the value. The
1917 ;; clearing of dependent values etc is done when the
1918 ;; definition is encountered during the load; this is just to
1919 ;; jump past the check for a cached value below.
1927 ;; Check if an evaluation of this symbol is already underway.
1928 ;; In that case we just continue with the "assignment" before
1929 ;; the one currently being evaluated, thereby creating the
1930 ;; illusion if a `setq'-like sequence of assignments.
1935 ;; Append `c-lang-constants-under-evaluation' even if an
1936 ;; earlier entry is found. It's only necessary to get
1937 ;; the recording of dependencies above correct.
1941 value
1942 ;; Make sure the recursion limits aren't very low
1943 ;; since the `c-lang-const' dependencies can go deep.
1950 ;; First try the original mode but don't accept an
1951 ;; entry matching all languages since the fallback
1952 ;; mode might have an explicit entry before that.
1955 c-lang-constants)
1956 ;; Try again with the fallback mode from the
1957 ;; original position. Note that
1958 ;; `c-buffer-is-cc-mode' still is the real mode if
1959 ;; language parameterization takes place.
1962 fallback t name))
1963 c-lang-constants)))
1964 ;; A simple lookup with no fallback mode.
1967 c-lang-constants))
1969 "`%s' got no (prior) value in %s (might be a cyclic reference)"
1970 name mode))
1975 ;; Print a message to aid in locating the error. We don't
1976 ;; print the error itself since that will be done later by
1977 ;; some caller higher up.
1979 sym mode)
1984 value))))
1987 ;; Find the first assignment entry that applies to MODE at or after
1988 ;; SOURCE-POS. If MATCH-ANY-LANG is non-nil, entries with `t' as
1989 ;; the language list are considered to match, otherwise they don't.
1990 ;; On return SOURCE-POS is updated to point to the next assignment
1991 ;; after the returned one. If no assignment is found,
1992 ;; `c-lang-constants' is returned as a magic value.
1993 ;;
1994 ;; SOURCE-POS is a vector that points out a specific assignment in
1995 ;; the double alist that's used in the `source' property. The first
1996 ;; element is the position in the top alist which is indexed with
1997 ;; the source files, and the second element is the position in the
1998 ;; nested bindings alist.
1999 ;;
2000 ;; NAME is only used for error messages.
2005 assignment)
2008 t
2009 ;; Handled the last assignment from one file, begin on the
2010 ;; next. Due to the check in `c-lang-defconst', we know
2011 ;; there's at least one.
2016 ;; The file containing the source definitions has not
2017 ;; been loaded.
2020 ;;(message (concat "Loading %s to get the source "
2021 ;; "value for language constant %s")
2022 ;; file name)
2026 ;; The load didn't fill in the source for the
2027 ;; constant as expected. The situation is
2028 ;; probably that a derived mode was written for
2029 ;; and compiled with another version of CC Mode,
2030 ;; and the requested constant isn't in the
2031 ;; currently loaded one. Put in a dummy
2032 ;; assignment that matches no language.
2037 t))
2045 match-any-lang)
2048 c-lang-constants)))
2051 ;; `c-major-mode-is' expands to a call to this function inside
2052 ;; `c-lang-defconst'. Here we also match the mode(s) against any
2053 ;; fallback modes for the one in `c-buffer-is-cc-mode', so that
2054 ;; e.g. (c-major-mode-is 'c++-mode) is true in a derived language
2055 ;; that has c++-mode as base mode.
2062 nil)
2064 match))
2066 \f
2069 ;;; arch-tag: 3bb2629d-dd84-4ff0-ad39-584be0fe3cda
2070 ;;; cc-defs.el ends here