| blob | 64e57017174b570f7615d4badd5016a83b4d3691 |
1 ;;; cc-defs.el --- compile time definitions for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2016 Free Software Foundation, Inc.
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs
9 ;; 1987 Stewart Clamen
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 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 ;; This file contains macros, defsubsts, and various other things that
34 ;; must be loaded early both during compilation and at runtime.
36 ;;; Code:
43 load-path)))
50 ;; XEmacs
53 ;; Emacs >= 24.3
56 ;; Emacs <= 24.2
57 nil))))
60 ; was (cc-external-require 'cl). ACM 2005/11/29.
61 ; Changed from (eval-when-compile (require 'cl)) back to
62 ; cc-external-require, 2015-08-12.
65 ;; Silence the compiler.
75 \f
76 ;; cc-fix.el contains compatibility macros that should be used if
77 ;; needed.
81 ;; XEmacs 21.4 doesn't have `delete-dups'.
92 font-lock-keywords))))
94 \f
95 ;;; Variables also used at compile time.
101 ;; A little more compact and faster in comparisons.
104 "Non-nil for all buffers with a major mode derived from CC Mode.
105 Otherwise, this variable is nil. I.e. this variable is non-nil for
106 `c-mode', `c++-mode', `objc-mode', `java-mode', `idl-mode',
107 `pike-mode', `awk-mode', and any other non-CC Mode mode that calls
108 `c-initialize-cc-mode'. The value is the mode symbol itself
109 \(i.e. `c-mode' etc) of the original CC Mode mode, or just t if it's
113 ;; Have to make `c-buffer-is-cc-mode' permanently local so that it
114 ;; survives the initialization of the derived mode.
117 \f
118 ;; The following is used below during compilation.
123 "Like `progn', but evaluates the body at compile time.
124 The result of the body appears to the compiler as a quoted constant.
126 This variant works around bugs in `eval-when-compile' in various
127 \(X)Emacs versions. See cc-defs.el for details."
130 ;; XEmacs 21.4.6 has a bug in `eval-when-compile' in that it
131 ;; evaluates its body at macro expansion time if it's nested
132 ;; inside another `eval-when-compile'. So we use a dynamically
133 ;; bound variable to avoid nesting them.
137 ;; In all (X)Emacsen so far, `eval-when-compile' byte compiles
138 ;; its contents before evaluating it. That can cause forms to
139 ;; be compiled in situations they aren't intended to be
140 ;; compiled.
141 ;;
142 ;; Example: It's not possible to defsubst a primitive, e.g. the
143 ;; following will produce an error (in any emacs flavor), since
144 ;; `nthcdr' is a primitive function that's handled specially by
145 ;; the byte compiler and thus can't be redefined:
146 ;;
147 ;; (defsubst nthcdr (val) val)
148 ;;
149 ;; `defsubst', like `defmacro', needs to be evaluated at
150 ;; compile time, so this will produce an error during byte
151 ;; compilation.
152 ;;
153 ;; CC Mode occasionally needs to do things like this for
154 ;; cross-emacs compatibility. It therefore uses the following
155 ;; to conditionally do a `defsubst':
156 ;;
157 ;; (eval-when-compile
158 ;; (if (not (fboundp 'foo))
159 ;; (defsubst foo ...)))
160 ;;
161 ;; But `eval-when-compile' byte compiles its contents and
162 ;; _then_ evaluates it (in all current emacs versions, up to
163 ;; and including Emacs 20.6 and XEmacs 21.1 as of this
164 ;; writing). So this will still produce an error, since the
165 ;; byte compiler will get to the defsubst anyway. That's
166 ;; arguably a bug because the point with `eval-when-compile' is
167 ;; that it should evaluate rather than compile its contents.
168 ;;
169 ;; We get around it by expanding the body to a quoted
170 ;; constant that we eval. That otoh introduce a problem in
171 ;; that a returned lambda expression doesn't get byte
172 ;; compiled (even if `function' is used).
177 \f
178 ;;; Macros.
180 ;; CC Mode equivalent of `mapcan' which bridges the difference
181 ;; between the host [X]Emacsen."
182 ;; The motivation for this macro is to avoid the irritating message
183 ;; "function `mapcan' from cl package called at runtime" produced by Emacs.
190 ;; Emacs <= 24.2. It would be nice to be able to distinguish between
191 ;; compile-time and run-time use here.
195 ;; Macro to smooth out the renaming of `set-difference' in Emacs 24.3.
201 ;; Macro to smooth out the renaming of `intersection' in Emacs 24.3.
208 ;; Macro to smooth out the renaming of `cl-macroexpand-all' in Emacs 24.3.
214 ;; Macro to smooth out the renaming of `delete-duplicates' in Emacs 24.3.
220 "Return the value of certain commonly referenced POSITIONs relative to POINT.
221 The current point is used if POINT isn't specified. POSITION can be
222 one of the following symbols:
224 `bol' -- beginning of line
225 `eol' -- end of line
226 `bod' -- beginning of defun
227 `eod' -- end of defun
228 `boi' -- beginning of indentation
229 `ionl' -- indentation of next line
230 `iopl' -- indentation of previous line
231 `bonl' -- beginning of next line
232 `eonl' -- end of next line
233 `bopl' -- beginning of previous line
234 `eopl' -- end of previous line
235 `bosws' -- beginning of syntactic whitespace
236 `eosws' -- end of syntactic whitespace
238 If the referenced position doesn't exist, the closest accessible point
239 to it is returned. This function does not modify the point or the mark."
341 ;; The bulk of this should perhaps be in a function to avoid large
342 ;; expansions, but this case is not used anywhere in CC Mode (and
343 ;; probably not anywhere else either) so we only have it to be on
344 ;; the safe side.
375 ;; Constant to decide at compilation time whether to use category
376 ;; properties. Currently (2010-03) they're available only on GNU Emacs.
394 ;; See the doc string for either of the defuns expanded to.
397 ;; XEmacs >= 2005-01-25
399 ;; Emacs and earlier XEmacs
403 ;; Return t when the region is active. The determination of region
404 ;; activeness is different in both Emacs and XEmacs.
406 ;; XEmacs.
408 ;; Old Emacs.
412 ;; Activate the region if ACTIVE is non-nil, deactivate it
413 ;; otherwise. Covers the differences between Emacs and XEmacs.
415 ;; XEmacs.
419 ;; Emacs.
423 "Delete the text between START and END and return it."
425 ;; Emacs 21.1 and later
427 ;; XEmacs and Emacs 20.x
433 ;; safely execute BODY, return nil if an error occurred
440 ;; In Emacs, a character is an integer. In XEmacs, a character is a
441 ;; type distinct from an integer. Sometimes we need to convert integers to
442 ;; characters. `c-int-to-char' makes this conversion, if necessary.
445 integer))
448 ;; The last character just typed. Note that `last-command-event' exists in
449 ;; both Emacs and XEmacs, but with confusingly different meanings.
451 'last-command-char
455 ;; Get the regular expression `sentence-end'.
457 ;; Emacs 22:
459 ;; Emacs <22 + XEmacs
463 ;; Get the default value of the variable sentence end.
465 ;; Emacs 22:
467 ;; Emacs <22 + XEmacs
470 ;; The following is essentially `save-buffer-state' from lazy-lock.el.
471 ;; It ought to be a standard macro.
473 "Bind variables according to VARLIST (in `let*' style) and eval BODY,
474 then restore the buffer state under the assumption that no significant
475 modification has been made in BODY. A change is considered
476 significant if it affects the buffer text in any way that isn't
477 completely restored again. Changes in text properties like `face' or
478 `syntax-table' are considered insignificant. This macro allows text
479 properties to be changed, even in a read-only buffer.
481 This macro should be placed around all calculations which set
483 known to be writable. That way, these text properties remain set
484 even if the user undoes the command which set them.
487 changes \(like adding a newline to calculate a text-property then
488 deleting it again), so that the user never sees them on his
489 `buffer-undo-list'. See also `c-tentative-buffer-changes'.
491 However, any user-visible changes to the buffer \(like auto-newlines)
492 must not be within a `c-save-buffer-state', since the user then
493 wouldn't be able to undo them.
495 The return value is the value of the last form in BODY."
501 before-change-functions after-change-functions
502 deactivate-mark
503 buffer-file-name buffer-file-truename ; Prevent primitives checking
504 ; for file modification
513 "Eval BODY and optionally restore the buffer contents to the state it
514 was in before BODY. Any changes are kept if the last form in BODY
515 returns non-nil. Otherwise it's undone using the undo facility, and
516 various other buffer state that might be affected by the changes is
517 restored. That includes the current buffer, point, mark, mark
518 activation \(similar to `save-excursion'), and the modified state.
519 The state is also restored if BODY exits nonlocally.
521 If BODY makes a change that unconditionally is undone then wrap this
522 macro inside `c-save-buffer-state'. That way the change can be done
523 even when the buffer is read-only, and without interference from
524 various buffer change hooks."
526 -tnt-chng-state)
528 ;; Insert an undo boundary for use with `undo-more'. We
529 ;; don't use `undo-boundary' since it doesn't insert one
530 ;; unconditionally.
538 ;; Used internally in `c-tentative-buffer-changes'.
541 ;; No need to use markers for the point and mark; if the
542 ;; undo got out of synch we're hosed anyway.
549 ;; Used internally in `c-tentative-buffer-changes'.
553 ;; No change was done after all.
557 ;; Find and remove the undo boundary.
563 ;; `primitive-undo' will remove the boundary.
568 saved-undo-list))))
580 "Forward skip over syntactic whitespace.
581 Syntactic whitespace is defined as whitespace characters, comments,
582 and preprocessor directives. However if point starts inside a comment
583 or preprocessor directive, the content of it is not treated as
584 whitespace.
586 LIMIT sets an upper limit of the forward movement, if specified. If
587 LIMIT or the end of the buffer is reached inside a comment or
588 preprocessor directive, the point will be left there.
590 Note that this function might do hidden buffer changes. See the
591 comment at the start of cc-engine.el for more info."
599 "Backward skip over syntactic whitespace.
600 Syntactic whitespace is defined as whitespace characters, comments,
601 and preprocessor directives. However if point starts inside a comment
602 or preprocessor directive, the content of it is not treated as
603 whitespace.
605 LIMIT sets a lower limit of the backward movement, if specified. If
606 LIMIT is reached inside a line comment or preprocessor directive then
607 the point is moved into it past the whitespace at the end.
609 Note that this function might do hidden buffer changes. See the
610 comment at the start of cc-engine.el for more info."
618 "Move forward across COUNT balanced expressions.
619 A negative COUNT means move backward. Signal an error if the move
620 fails for any reason.
622 This is like `forward-sexp' except that it isn't interactive and does
623 not do any user friendly adjustments of the point and that it isn't
624 susceptible to user configurations such as disabling of signals in
625 certain situations."
630 "See `c-forward-sexp' and reverse directions."
635 "Like `scan-lists' but returns nil instead of signaling errors
636 for unbalanced parens.
638 A limit for the search may be given. FROM is assumed to be on the
639 right side of it."
653 res)))
655 \f
656 ;; Wrappers for common scan-lists cases, mainly because it's almost
657 ;; impossible to get a feel for how that function works.
660 "Move forward across one balanced group of parentheses starting at POS or
661 point. Return POINT when we succeed, NIL when we fail. In the latter case,
662 leave point unmoved.
664 A LIMIT for the search may be given. The start position is assumed to be
665 before it."
672 res)))
675 "Move backward across one balanced group of parentheses starting at POS or
676 point. Return POINT when we succeed, NIL when we fail. In the latter case,
677 leave point unmoved.
679 A LIMIT for the search may be given. The start position is assumed to be
680 after it."
687 res)))
690 "Return the first position after the list sexp containing POS,
691 or nil if no such position exists. The point is used if POS is left out.
693 A limit for the search may be given. The start position is assumed to
694 be before it."
698 "Return the position of the start of the list sexp containing POS,
699 or nil if no such position exists. The point is used if POS is left out.
701 A limit for the search may be given. The start position is assumed to
702 be after it."
706 "Return the first position inside the first list sexp after POS,
707 or nil if no such position exists. The point is used if POS is left out.
709 A limit for the search may be given. The start position is assumed to
710 be before it."
714 "Return the last position inside the last list sexp before POS,
715 or nil if no such position exists. The point is used if POS is left out.
717 A limit for the search may be given. The start position is assumed to
718 be after it."
722 "Move the point to the first position after the list sexp containing POS,
723 or containing the point if POS is left out. Return t if such a
724 position exists, otherwise nil is returned and the point isn't moved.
726 A limit for the search may be given. The start position is assumed to
727 be before it."
733 res)))
736 "Move the point to the position of the start of the list sexp containing POS,
737 or containing the point if POS is left out. Return t if such a
738 position exists, otherwise nil is returned and the point isn't moved.
740 A limit for the search may be given. The start position is assumed to
741 be after it."
747 res)))
750 "Move the point to the first position inside the first list sexp after POS,
751 or before the point if POS is left out. Return t if such a position
752 exists, otherwise nil is returned and the point isn't moved.
754 A limit for the search may be given. The start position is assumed to
755 be before it."
761 res)))
764 "Move the point to the last position inside the last list sexp before POS,
765 or before the point if POS is left out. Return t if such a position
766 exists, otherwise nil is returned and the point isn't moved.
768 A limit for the search may be given. The start position is assumed to
769 be after it."
775 res)))
777 \f
779 ;; Wrapper around beginning-of-defun.
780 ;;
781 ;; NOTE: This function should contain the only explicit use of
782 ;; beginning-of-defun in CC Mode. Eventually something better than
783 ;; b-o-d will be available and this should be the only place the
784 ;; code needs to change. Everything else should use
785 ;; (c-beginning-of-defun-1)
786 ;;
787 ;; This is really a bit too large to be a macro but that isn't a
788 ;; problem as long as it only is used in one place in
789 ;; `c-parse-state'.
793 c-enable-xemacs-performance-kludge-p)
795 ;; XEmacs only. This can improve the performance of
796 ;; c-parse-state to between 3 and 60 times faster when
797 ;; braces are hung. It can also degrade performance by
798 ;; about as much when braces are not hung.
800 pos)
810 ;; unbalanced parenthesis, while invalid C code,
811 ;; shouldn't cause an infloop! See unbal.c
813 ;; Punt!
820 ))
822 ;; Emacs, which doesn't have buffer-syntactic-context-depth
825 ;; if defun-prompt-regexp is non-nil, b-o-d won't leave us at the
826 ;; open brace.
831 \f
832 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
833 ;; V i r t u a l S e m i c o l o n s
834 ;;
835 ;; In most CC Mode languages, statements are terminated explicitly by
836 ;; semicolons or closing braces. In some of the CC modes (currently AWK Mode
837 ;; and certain user-specified #define macros in C, C++, etc. (November 2008)),
838 ;; statements are (or can be) terminated by EOLs. Such a statement is said to
839 ;; be terminated by a "virtual semicolon" (VS). A statement terminated by an
840 ;; actual semicolon or brace is never considered to have a VS.
841 ;;
842 ;; The indentation engine (or whatever) tests for a VS at a specific position
843 ;; by invoking the macro `c-at-vsemi-p', which in its turn calls the mode
844 ;; specific function (if any) which is the value of the language variable
845 ;; `c-at-vsemi-p-fn'. This function should only use "low-level" features of
846 ;; CC Mode, i.e. features which won't trigger infinite recursion. ;-) The
847 ;; actual details of what constitutes a VS in a language are thus encapsulated
848 ;; in code specific to that language (e.g. cc-awk.el). `c-at-vsemi-p' returns
849 ;; non-nil if point (or the optional parameter POS) is at a VS, nil otherwise.
850 ;;
851 ;; The language specific function might well do extensive analysis of the
852 ;; source text, and may use a caching scheme to speed up repeated calls.
853 ;;
854 ;; The "virtual semicolon" lies just after the last non-ws token on the line.
855 ;; Like POINT, it is considered to lie between two characters. For example,
856 ;; at the place shown in the following AWK source line:
857 ;;
858 ;; kbyte = 1024 # 1000 if you're not picky
859 ;; ^
860 ;; |
861 ;; Virtual Semicolon
862 ;;
863 ;; In addition to `c-at-vsemi-p-fn', a mode may need to supply a function for
864 ;; `c-vsemi-status-unknown-p-fn'. The macro `c-vsemi-status-unknown-p' is a
865 ;; rather recondite kludge. It exists because the function
866 ;; `c-beginning-of-statement-1' sometimes tests for VSs as an optimization,
867 ;; but `c-at-vsemi-p' might well need to call `c-beginning-of-statement-1' in
868 ;; its calculations, thus potentially leading to infinite recursion.
869 ;;
870 ;; The macro `c-vsemi-status-unknown-p' resolves this problem; it may return
871 ;; non-nil at any time; returning nil is a guarantee that an immediate
872 ;; invocation of `c-at-vsemi-p' at point will NOT call
873 ;; `c-beginning-of-statement-1'. `c-vsemi-status-unknown-p' may not itself
874 ;; call `c-beginning-of-statement-1'.
875 ;;
876 ;; The macro `c-vsemi-status-unknown-p' will typically check the caching
877 ;; scheme used by the `c-at-vsemi-p-fn', hence the name - the status is
878 ;; "unknown" if there is no cache entry current for the line.
879 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
882 ;; Is there a virtual semicolon (not a real one or a }) at POS (defaults to
883 ;; point)? Always returns nil for languages which don't have Virtual
884 ;; semicolons.
885 ;; This macro might do hidden buffer changes.
890 ;; Return NIL only if it can be guaranteed that an immediate
891 ;; (c-at-vsemi-p) will NOT call c-beginning-of-statement-1. Otherwise,
892 ;; return non-nil. (See comments above). The function invoked by this
893 ;; macro MUST NOT UNDER ANY CIRCUMSTANCES itself call
894 ;; c-beginning-of-statement-1.
895 ;; Languages which don't have EOL terminated statements always return NIL
896 ;; (they _know_ there's no vsemi ;-).
899 \f
901 ;; Formats an error message for the echo area and dings, i.e. like
902 ;; `error' but doesn't abort.
908 ;; Temporarily switches to the specified syntax table in a failsafe
909 ;; way to execute code.
910 ;; Maintainers' note: If TABLE is `c++-template-syntax-table', DON'T call
911 ;; any forms inside this that call `c-parse-state'. !!!!
921 "Skip over any whitespace following point.
922 This function skips over horizontal and vertical whitespace and line
923 continuations."
927 ;; skip-syntax-* doesn't count \n as whitespace..
942 "Skip over any whitespace preceding point.
943 This function skips over horizontal and vertical whitespace and line
944 continuations."
948 ;; skip-syntax-* doesn't count \n as whitespace..
964 "Return non-nil if the current CC Mode major mode is MODE.
965 MODE is either a mode symbol or a list of mode symbols."
968 ;; Inside a `c-lang-defconst'.
982 \f
983 ;; Macros/functions to handle so-called "char properties", which are
984 ;; properties set on a single character and that never spread to any
985 ;; other characters.
988 ;; Constant used at compile time to decide whether or not to use
989 ;; XEmacs extents. Check all the extent functions we'll use since
990 ;; some packages might add compatibility aliases for some of them in
991 ;; Emacs.
1006 ;; `c-put-char-property' is complex enough in XEmacs and Emacs < 21 to
1007 ;; make it a function.
1011 ;; XEmacs.
1021 end-open t)))))))))
1024 ;; In Emacs < 21 we have to mess with the `rear-nonsticky' property.
1031 'rear-nonsticky
1033 ;; This won't be used for anything.
1038 ;; Put the given property with the given value on the character at
1039 ;; POS and make it front and rear nonsticky, or start and end open
1040 ;; in XEmacs vocabulary. If the character already has the given
1041 ;; property then the value is replaced, and the behavior is
1042 ;; undefined if that property has been put by some other function.
1043 ;; PROPERTY is assumed to be constant.
1044 ;;
1045 ;; If there's a `text-property-default-nonsticky' variable (Emacs
1046 ;; 21) then it's assumed that the property is present on it.
1047 ;;
1048 ;; This macro does a hidden buffer change.
1052 ;; XEmacs and Emacs < 21.
1054 ;; In Emacs 21 we got the `rear-nonsticky' property covered
1055 ;; by `text-property-default-nonsticky'.
1060 ;; Get the value of the given property on the character at POS if
1061 ;; it's been put there by `c-put-char-property'. PROPERTY is
1062 ;; assumed to be constant.
1065 ;; XEmacs.
1068 ;; Emacs.
1071 ;; `c-clear-char-property' is complex enough in Emacs < 21 to make it
1072 ;; a function, since we have to mess with the `rear-nonsticky' property.
1082 'rear-nonsticky
1088 ;; Remove the given property on the character at POS if it's been put
1089 ;; there by `c-put-char-property'. PROPERTY is assumed to be
1090 ;; constant.
1091 ;;
1092 ;; This macro does a hidden buffer change.
1095 ;; XEmacs.
1099 ;; In Emacs 21 we got the `rear-nonsticky' property covered
1100 ;; by `text-property-default-nonsticky'.
1105 ;; Emacs < 21.
1109 ;; Remove all the occurrences of the given property in the given
1110 ;; region that has been put with `c-put-char-property'. PROPERTY is
1111 ;; assumed to be constant.
1112 ;;
1113 ;; Note that this function does not clean up the property from the
1114 ;; lists of the `rear-nonsticky' properties in the region, if such
1115 ;; are used. Thus it should not be used for common properties like
1116 ;; `syntax-table'.
1117 ;;
1118 ;; This macro does hidden buffer changes.
1121 ;; XEmacs.
1125 ;; Emacs.
1129 "Search forward for a text-property PROPERTY having value VALUE.
1130 LIMIT bounds the search. The comparison is done with `equal'.
1132 Leave point just after the character, and set the match data on
1133 this character, and return point. If VALUE isn't found, Return
1134 nil; point is then left undefined."
1148 "Search backward for a text-property PROPERTY having value VALUE.
1149 LIMIT bounds the search. The comparison is done with `equal'.
1151 Leave point just before the character, set the match data on this
1152 character, and return point. If VALUE isn't found, Return nil;
1153 point is then left undefined."
1161 ;; XEmacs > 2005-01-25.
1162 'previous-single-char-property-change
1163 ;; Emacs and earlier XEmacs.
1172 "Remove all text-properties PROPERTY from the region (FROM, TO)
1173 which have the value VALUE, as tested by `equal'. These
1174 properties are assumed to be over individual characters, having
1175 been put there by c-put-char-property. POINT remains unchanged."
1187 ;; Do we have to do anything with stickiness here?
1191 "Remove all text-properties PROPERTY from the region [FROM, TO)
1192 which have the value VALUE, as tested by `equal'. These
1193 properties are assumed to be over individual characters, having
1194 been put there by c-put-char-property. POINT remains unchanged."
1196 ;; XEmacs
1202 ;; GNU Emacs
1204 \f
1205 ;; Macros to put overlays (Emacs) or extents (XEmacs) on buffer text.
1206 ;; For our purposes, these are characterized by being possible to
1207 ;; remove again without affecting the other text properties in the
1208 ;; buffer that got overridden when they were put.
1211 ;; Put an overlay/extent covering the given range in the current
1212 ;; buffer. It's currently undefined whether it's front/end sticky
1213 ;; or not. The overlay/extent object is returned.
1215 ;; Emacs.
1218 ol)
1219 ;; XEmacs.
1222 ext)))
1225 ;; Deletes an overlay/extent object previously retrieved using
1226 ;; `c-put-overlay'.
1228 ;; Emacs.
1230 ;; XEmacs.
1233 \f
1234 ;; Make edebug understand the macros.
1235 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1236 ; '(progn
1266 \f
1267 ;;; Functions.
1269 ;; Note: All these after the macros, to be on safe side in avoiding
1270 ;; bugs where macros are defined too late. These bugs often only show
1271 ;; when the files are compiled in a certain order within the same
1272 ;; session.
1275 ;; Replacement for end-of-defun that use c-beginning-of-defun-1.
1277 ;; Skip forward into the next defun block. Don't bother to avoid
1278 ;; comments, literals etc, since beginning-of-defun doesn't do that
1279 ;; anyway.
1288 ;; Mark the "<" character at POS as a template opener using the
1289 ;; `syntax-table' property either directly (XEmacs) or via a `category'
1290 ;; property (GNU Emacs).
1291 ;;
1292 ;; This function does a hidden buffer change. Note that we use
1293 ;; indirection through the `category' text property. This allows us to
1294 ;; toggle the property in all template brackets simultaneously and
1295 ;; cheaply. We use this, for instance, in `c-parse-state'.
1302 ;; Mark the ">" character at POS as an sexp list closer using the
1303 ;; `syntax-table' property either directly (XEmacs) or via a `category'
1304 ;; property (GNU Emacs).
1305 ;;
1306 ;; This function does a hidden buffer change. Note that we use
1307 ;; indirection through the `category' text property. This allows us to
1308 ;; toggle the property in all template brackets simultaneously and
1309 ;; cheaply. We use this, for instance, in `c-parse-state'.
1315 ;; Unmark the "<" or "<" character at POS as an sexp list opener using the
1316 ;; `syntax-table' property either directly or indirectly through a
1317 ;; `category' text property.
1318 ;;
1319 ;; This function does a hidden buffer change. Note that we try to use
1320 ;; indirection through the `category' text property. This allows us to
1321 ;; toggle the property in all template brackets simultaneously and
1322 ;; cheaply. We use this, for instance, in `c-parse-state'.
1326 ;; Suppress the syntactic effect of all marked < and > as parens. Note
1327 ;; that this effect is NOT buffer local. You should probably not use
1328 ;; this directly, but only through the macro
1329 ;; `c-with-<->-as-parens-suppressed'
1334 ;; Restore the syntactic effect of all marked <s and >s as parens. This
1335 ;; has no effect on unmarked <s and >s
1340 ;; Like progn, except that the paren property is suppressed on all
1341 ;; template brackets whilst they are running. This macro does a hidden
1342 ;; buffer change.
1349 ;;;;;;;;;;;;;;;
1352 ;; This is the value of the `category' text property placed on every #
1353 ;; which introduces a CPP construct and every EOL (or EOB, or character
1354 ;; preceding //, etc.) which terminates it. We can instantly "comment
1355 ;; out" all CPP constructs by giving `c-cpp-delimiter' a syntax-table
1356 ;; property '(14) (generic comment delimiter).
1358 ;; This macro does a hidden buffer change.
1364 ;; This macro does a hidden buffer change.
1371 ;; Render all preprocessor constructs syntactically commented out.
1374 ;; Restore the syntactic visibility of preprocessor constructs.
1378 ;; Execute FORMS... whilst the syntactic effect of all characters in
1379 ;; all CPP regions is suppressed. In particular, this is to suppress
1380 ;; the syntactic significance of parens/braces/brackets to functions
1381 ;; such as `scan-lists' and `parse-partial-sexp'.
1390 ;; Execute FORMS... whilst the syntactic effect of all characters in
1391 ;; every CPP region APART FROM THE ONE BETWEEN BEG and END is
1392 ;; suppressed.
1405 ;; Bind the state cache to itself and execute the FORMS. Return the result
1406 ;; of the last FORM executed. It is assumed that no buffer changes will
1407 ;; happen in FORMS, and no hidden buffer changes which could affect the
1408 ;; parsing will be made by FORMS.
1411 ;(c-state-nonlit-pos-cache (copy-tree c-state-nonlit-pos-cache))
1412 ;(c-state-nonlit-pos-cache-limit c-state-nonlit-pos-cache-limit)
1413 ;(c-state-semi-nonlit-pos-cache (copy-tree c-state-semi-nonlit-pos-cache))
1414 ;(c-state-semi-nonlit-pos-cache-limit c-state-semi-nonlit-pos-cache)
1422 c-state-old-cpp-beg-marker))
1424 c-state-old-cpp-beg-marker
1425 c-state-old-cpp-beg))
1428 c-state-old-cpp-end-marker))
1430 c-state-old-cpp-end-marker
1431 c-state-old-cpp-end))
1440 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1441 ;; The following macros are to be used only in `c-parse-state' and its
1442 ;; subroutines. Their main purpose is to simplify the handling of C++/Java
1443 ;; template delimiters and CPP macros. In GNU Emacs, this is done slickly by
1444 ;; the judicious use of 'category properties. These don't exist in XEmacs.
1445 ;;
1446 ;; Note: in the following macros, there is no special handling for parentheses
1447 ;; inside CPP constructs. That is because CPPs are always syntactically
1448 ;; balanced, thanks to `c-neutralize-CPP-line' in cc-mode.el.
1450 ;; Do a (scan-lists FROM 1 1). Any finishing position which either (i) is
1451 ;; determined by and angle bracket; or (ii) is inside a macro whose start
1452 ;; isn't POINT-MACRO-START doesn't count as a finishing position.
1457 pos))
1460 ;; Do a (scan-lists FROM 1 -1). Any finishing position which either (i) is
1461 ;; determined by an angle bracket; or (ii) is inside a macro whose start
1462 ;; isn't POINT-MACRO-START doesn't count as a finishing position.
1468 pos))
1471 ;; Do a (scan-lists FROM -1 1). Any finishing position which either (i) is
1472 ;; determined by and angle bracket; or (ii) is inside a macro whose start
1473 ;; isn't POINT-MACRO-START doesn't count as a finishing position.
1478 pos))
1481 ;; Do a (scan-lists FROM -1 -1). Any finishing position which either (i) is
1482 ;; determined by and angle bracket; or (ii) is inside a macro whose start
1483 ;; isn't POINT-MACRO-START doesn't count as a finishing position.
1489 pos))
1507 oldstate)
1508 ;; Do a parse-partial-sexp using the supplied arguments, disregarding
1509 ;; template/generic delimiters < > and disregarding macros other than the
1510 ;; one at POINT-MACRO-START.
1511 ;;
1512 ;; NOTE that STOPBEFORE must be nil. TARGETDEPTH should be one less than
1513 ;; the depth in OLDSTATE. This function is thus a SPECIAL PURPOSE variation
1514 ;; on parse-partial-sexp, designed for calling from
1515 ;; `c-remove-stale-state-cache'.
1516 ;;
1517 ;; Any finishing position which is determined by an angle bracket delimiter
1518 ;; doesn't count as a finishing position.
1519 ;;
1520 ;; Note there is no special handling of CPP constructs here, since these are
1521 ;; always syntactically balanced (thanks to `c-neutralize-CPP-line').
1526 ;; We must have hit targetdepth.
1535 state))
1538 oldstate)
1544 \f
1548 "Are we looking at a character which isn't alphanumeric or space?"
1557 \f
1559 ;; return the element of ALIST that matches the first element found
1560 ;; in LIST. Uses assq.
1565 match))
1568 ;; first, find the first entry from LIST that is present in ALIST1,
1569 ;; then find the entry in ALIST2 for that entry.
1573 "Return the syntactic symbol in LANGELEM.
1577 form as used in `c-syntactic-element'."
1581 "Return the anchor position in LANGELEM, or nil if there is none.
1585 form as used in `c-syntactic-element'."
1591 "Return the column of the anchor position in LANGELEM.
1592 Also move the point to that position unless PRESERVE-POINT is non-nil.
1596 form as used in `c-syntactic-element'."
1608 "Return the secondary position in LANGELEM, or nil if there is none.
1611 in `c-syntactic-element'. It may also be a cons cell as passed in the
1612 first argument to lineup functions, but then the returned value always
1613 will be nil."
1617 ;; Do whatever is necessary to keep the region active in XEmacs.
1618 ;; This is not needed for Emacs.
1632 the corresponding symbol."
1638 c-buffer-is-cc-mode))
1643 the value of the variable with that name."
1647 "Return non-nil if position POS in the current buffer has any of the
1648 faces in the list FACES."
1655 pos-faces)
1659 ;; Return t if FACENAME is the name of a face. This method is
1660 ;; necessary since facep in XEmacs only returns t for the actual
1661 ;; face objects (while it's only their names that are used just
1662 ;; about anywhere else) without providing a predicate that tests
1663 ;; face names.
1667 "Like `concat' on LIST, but separate each element with SEPARATOR.
1668 Notably, null elements in LIST are ignored."
1672 "Make a regexp that matches all the strings the list.
1673 Duplicates and nil elements in the list are removed. The
1674 resulting regexp may contain zero or more submatch expressions.
1676 If ADORN is t there will be at least one submatch and the first
1677 surrounds the matched alternative, and the regexp will also not match
1678 a prefix of any identifier. Adorned regexps cannot be appended. The
1679 language variable `c-nonsymbol-key' is used to make the adornment.
1681 A value `appendable' for ADORN is like above, but all alternatives in
1683 instead, so that the regexp remains appendable. Note that this
1684 variant doesn't always guarantee that an identifier prefix isn't
1685 matched since the symbol constituent `_' is normally considered a
1688 The optional MODE specifies the language to get `c-nonsymbol-key' from
1689 when it's needed. The default is the current language taken from
1690 `c-buffer-is-cc-mode'."
1697 ;; This is kludgy but it works: Search for a string that
1698 ;; doesn't occur in any word in LIST. Append it to all
1699 ;; the alternatives where we want to add \>. Run through
1700 ;; `regexp-opt' and then replace it with \>.
1704 pos list)
1708 nil)
1709 t))
1711 found))
1725 ;; Emacs 20 and XEmacs (all versions so far) has a buggy
1726 ;; regexp-opt that doesn't always cope with strings containing
1727 ;; newlines. This kludge doesn't handle shy parens correctly
1728 ;; so we can't advice regexp-opt directly with it.
1752 ;; Add our own grouping parenthesis around re instead of
1753 ;; passing adorn to `regexp-opt', since in XEmacs it makes the
1754 ;; top level grouping "shy".
1763 re)))
1765 ;; Produce a regexp that matches nothing.
1773 "Make a character alternative string from the list of characters CHARS.
1774 The returned string is of the type that can be used with
1775 `skip-chars-forward' and `skip-chars-backward'. If INVERTED is
1776 non-nil, a caret is prepended to invert the set."
1777 ;; This function ought to be in the elisp core somewhere.
1783 ;; Quoting necessary (this method only works in the skip
1784 ;; functions).
1787 ;; Check for range.
1795 str))
1797 ;; Leftovers from (X)Emacs 19 compatibility.
1801 \f
1802 ;; Figure out what features this Emacs has
1812 ;; I've no idea what this actually is, but it's legacy. /mast
1815 ;; XEmacs uses 8-bit modify-syntax-entry flags.
1816 ;; Emacs uses a 1-bit flag. We will have to set up our
1817 ;; syntax tables differently to handle this.
1819 entry)
1822 ;; Emacs
1825 ;; In Emacs, table entries are cons cells
1827 ;; XEmacs
1830 ;; incompatible
1835 list)))
1837 ;; Check whether beginning/end-of-defun call
1838 ;; beginning/end-of-defun-function nicely, passing through the
1839 ;; argument and respecting the return code.
1859 ;; Record whether the `category' text property works.
1863 parse-sexp-lookup-properties
1864 parse-sexp-ignore-comments
1869 ;; For some reason we have to set some of these after the
1870 ;; buffer has been made current. (Specifically,
1871 ;; `parse-sexp-ignore-comments' in Emacs 21.)
1873 parse-sexp-ignore-comments t
1874 lookup-syntax-properties t)
1876 ;; Find out if the `syntax-table' text property works.
1887 "CC Mode is incompatible with this version of Emacs - "
1888 "support for the `syntax-table' text property "
1891 ;; Find out if "\\s!" (generic comment delimiters) work.
1897 ;; Find out if "\\s|" (generic string delimiters) work.
1903 ;; See if POSIX char classes work.
1905 ;; All versions of Emacs 21 so far haven't fixed
1906 ;; char classes in `skip-chars-forward' and
1907 ;; `skip-chars-backward'.
1916 ;; See if `open-paren-in-column-0-is-defun-start' exists and
1917 ;; isn't buggy (Emacs >= 21.4).
1925 ;; XEmacs. Afaik this is currently an Emacs-only
1926 ;; feature, but it's good to be prepared.
1930 ;; Emacs
1943 ;; See if `parse-partial-sexp' returns the eighth element.
1949 "CC Mode is incompatible with this version of Emacs - "
1952 ;;(message "c-emacs-features: %S" list)
1953 list)
1954 "A list of certain features in the (X)Emacs you are using.
1955 There are many flavors of Emacs out there, each with different
1956 features supporting those needed by CC Mode. The following values
1957 might be present:
1959 `8-bit' 8 bit syntax entry flags (XEmacs style).
1960 `1-bit' 1 bit syntax entry flags (Emacs style).
1961 `argumentative-bod-function' beginning-of-defun and end-of-defun pass
1962 ARG through to beginning/end-of-defun-function.
1963 `syntax-properties' It works to override the syntax for specific characters
1964 in the buffer with the `syntax-table' property. It's
1965 always set - CC Mode no longer works in emacsen without
1966 this feature.
1967 `category-properties' Syntax routines can add a level of indirection to text
1968 properties using the `category' property.
1969 `gen-comment-delim' Generic comment delimiters work
1970 (i.e. the syntax class `!').
1971 `gen-string-delim' Generic string delimiters work
1972 (i.e. the syntax class `|').
1973 `pps-extended-state' `parse-partial-sexp' returns a list with at least 10
1974 elements, i.e. it contains the position of the start of
1975 the last comment or string. It's always set - CC Mode
1976 no longer works in emacsen without this feature.
1977 `posix-char-classes' The regexp engine understands POSIX character classes.
1978 `col-0-paren' It's possible to turn off the ad-hoc rule that a paren
1979 in column zero is the start of a defun.
1980 `infodock' This is Infodock (based on XEmacs).
1984 \f
1985 ;;; Some helper constants.
1987 ;; If the regexp engine supports POSIX char classes then we can use
1988 ;; them to handle extended charsets correctly.
2002 \f
2003 ;;; System for handling language dependent constants.
2005 ;; This is used to set various language dependent data in a flexible
2006 ;; way: Language constants can be built from the values of other
2007 ;; language constants, also those for other languages. They can also
2008 ;; process the values of other language constants uniformly across all
2009 ;; the languages. E.g. one language constant can list all the type
2010 ;; keywords in each language, and another can build a regexp for each
2011 ;; language from those lists without code duplication.
2012 ;;
2013 ;; Language constants are defined with `c-lang-defconst', and their
2014 ;; value forms (referred to as source definitions) are evaluated only
2015 ;; on demand when requested for a particular language with
2016 ;; `c-lang-const'. It's therefore possible to refer to the values of
2017 ;; constants defined later in the file, or in another file, just as
2018 ;; long as all the relevant `c-lang-defconst' have been loaded when
2019 ;; `c-lang-const' is actually evaluated from somewhere else.
2020 ;;
2021 ;; `c-lang-const' forms are also evaluated at compile time and
2022 ;; replaced with the values they produce. Thus there's no overhead
2023 ;; for this system when compiled code is used - only the values
2024 ;; actually used in the code are present, and the file(s) containing
2025 ;; the `c-lang-defconst' forms don't need to be loaded at all then.
2026 ;; There are however safeguards to make sure that they can be loaded
2027 ;; to get the source definitions for the values if there's a mismatch
2028 ;; in compiled versions, or if `c-lang-const' is used uncompiled.
2029 ;;
2030 ;; Note that the source definitions in a `c-lang-defconst' form are
2031 ;; compiled into the .elc file where it stands; there's no need to
2032 ;; load the source file to get it.
2033 ;;
2034 ;; See cc-langs.el for more details about how this system is deployed
2035 ;; in CC Mode, and how the associated language variable system
2036 ;; (`c-lang-defvar') works. That file also contains a lot of
2037 ;; examples.
2040 "Declare a new language in the language dependent variable system.
2041 This is intended to be used by modes that inherit CC Mode to add new
2042 languages. It should be used at the top level before any calls to
2043 `c-lang-defconst'. MODE is the mode name symbol for the new language,
2044 and BASE-MODE is the mode name symbol for the language in CC Mode that
2045 is to be the template for the new mode.
2047 The exact effect of BASE-MODE is to make all language constants that
2048 haven't got a setting in the new language fall back to their values in
2049 BASE-MODE. It does not have any effect outside the language constant
2050 system."
2059 ;; Obarray used as a cache to keep track of the language constants.
2060 ;; The constants stored are those defined by `c-lang-defconst' and the values
2061 ;; computed by `c-lang-const'. It's mostly used at compile time but it's not
2062 ;; stored in compiled files.
2064 ;; The obarray contains all the language constants as symbols. The
2065 ;; value cells hold the evaluated values as alists where each car is
2066 ;; the mode name symbol and the corresponding cdr is the evaluated
2067 ;; value in that mode. The property lists hold the source definitions
2068 ;; and other miscellaneous data. The obarray might also contain
2069 ;; various other symbols, but those don't have any variable bindings.
2073 ;; Ugly hack to pull in the definition of `cc-bytecomp-compiling-or-loading'
2074 ;; from cc-bytecomp to make it available at loadtime. This is the same
2075 ;; mechanism used in cc-mode.el for `c-populate-syntax-table'.
2082 ;; Return the base name of the current file.
2094 "Can be used inside a VAL in `c-lang-defconst' to evaluate FORM
2095 immediately, i.e. at the same time as the `c-lang-defconst' form
2096 itself is evaluated."
2097 ;; Evaluate at macro expansion time, i.e. in the
2098 ;; `c--macroexpand-all' inside `c-lang-defconst'.
2102 "Set the language specific values of the language constant NAME.
2103 The second argument can optionally be a docstring. The rest of the
2104 arguments are one or more repetitions of LANG VAL where LANG specifies
2105 the language(s) that VAL applies to. LANG is the name of the
2107 of such language names, or t for all languages. VAL is a form to
2108 evaluate to get the value.
2110 If LANG isn't t or one of the core languages in CC Mode, it must
2111 have been declared with `c-add-language'.
2113 Neither NAME, LANG nor VAL are evaluated directly - they should not be
2114 quoted. `c-lang-defconst-eval-immediately' can however be used inside
2115 VAL to evaluate parts of it directly.
2117 When VAL is evaluated for some language, that language is temporarily
2118 made current so that `c-lang-const' without an explicit language can
2119 be used inside VAL to refer to the value of a language constant in the
2120 same language. That is particularly useful if LANG is t.
2122 VAL is not evaluated right away but rather when the value is requested
2123 with `c-lang-const'. Thus it's possible to use `c-lang-const' inside
2124 VAL to refer to language constants that haven't been defined yet.
2125 However, if the definition of a language constant is in another file
2126 then that file must be loaded \(at compile time) before it's safe to
2127 reference the constant.
2129 The assignments in ARGS are processed in sequence like `setq', so
2130 \(c-lang-const NAME) may be used inside a VAL to refer to the last
2131 assigned value to this language constant, or a value that it has
2132 gotten in another earlier loaded file.
2134 To work well with repeated loads and interactive reevaluation, only
2135 one `c-lang-defconst' for each NAME is permitted per file. If there
2136 already is one it will be completely replaced; the value in the
2137 earlier definition will not affect `c-lang-const' on the same
2138 constant. A file is identified by its base name."
2141 ;; Make `c-lang-const' expand to a straightforward call to
2142 ;; `c-get-lang-constant' in `c--macroexpand-all' below.
2143 ;;
2144 ;; (The default behavior, i.e. to expand to a call inside
2145 ;; `eval-when-compile' should be equivalent, since that macro
2146 ;; should only expand to its content if it's used inside a
2147 ;; form that's already evaluated at compile time. It's
2148 ;; however necessary to use our cover macro
2149 ;; `cc-eval-when-compile' due to bugs in `eval-when-compile',
2150 ;; and it expands to a bulkier form that in this case only is
2151 ;; unnecessary garbage that we don't want to store in the
2152 ;; language constant source definitions.)
2158 bindings
2159 pre-files)
2165 ;; The docstring is hardly used anywhere since there's no normal
2166 ;; symbol to attach it to. It's primarily for getting the right
2167 ;; format in the source.
2174 ;; Rework ARGS to an association list to make it easier to handle.
2175 ;; It's reversed at the same time to make it easier to implement
2176 ;; the demand-driven (i.e. reversed) evaluation in `c-lang-const'.
2193 val)
2200 ;; Emacs has a weird bug where it seems to fail to read
2201 ;; backquote lists from byte compiled files correctly (,@
2202 ;; forms, to be specific), so make sure the bindings in the
2203 ;; expansion below don't contain any backquote stuff.
2204 ;; (XEmacs handles it correctly and doesn't need this for that
2205 ;; reason, but we also use this expansion handle
2206 ;; `c-lang-defconst-eval-immediately' and to register
2207 ;; dependencies on the `c-lang-const's in VAL.)
2213 ;; Compile in the other files that have provided source
2214 ;; definitions for this symbol, to make sure the order in the
2215 ;; `source' property is correct even when files are loaded out of
2216 ;; order.
2219 ;; This can happen when the source file (e.g. cc-langs.el) is first
2220 ;; loaded as source, setting a 'source property entry, and then itself
2221 ;; being compiled.
2223 ;; Reverse to get the right load order.
2231 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
2232 ; '
2237 ;; Used by `c-lang-defconst'.
2246 ;;(when (cdr-safe elem)
2247 ;; (message "Language constant %s redefined in %S" name file))
2249 ;; Note that the order in the source alist is relevant. Like how
2250 ;; `c-lang-defconst' reverses the bindings, this reverses the
2251 ;; order between files so that the last to evaluate comes first.
2261 ;; Bind the symbol as a variable, or clear any earlier evaluated
2262 ;; value it has.
2265 ;; Clear the evaluated values that depend on this source.
2268 ptr)
2281 name))
2284 "Get the mode specific value of the language constant NAME in language LANG.
2285 LANG is the name of the language, i.e. the mode name without the
2287 `c-lang-defvar', LANG may be left out to refer to the current
2288 language. NAME and LANG are not evaluated so they should not be
2289 quoted."
2301 lang))
2304 ;; No need to find out the source file(s) when we evaluate
2305 ;; immediately since all the info is already there in the
2306 ;; `source' property.
2312 ;; Get the source file(s) that must be loaded to get the value
2313 ;; of the constant. If the symbol isn't defined yet we assume
2314 ;; that its definition will come later in this file, and thus
2315 ;; are no file dependencies needed.
2317 ;; Reverse to get the right load order.
2320 nil ; Exclude our own file.
2324 ;; Make some effort to do a compact call to
2325 ;; `c-get-lang-constant' since it will be compiled in.
2335 ;; Either a straight call is requested in the context, or
2336 ;; we're in an "uncontrolled" context and got no language,
2337 ;; or we're not being byte compiled so the compile time
2338 ;; stuff below is unnecessary.
2341 ;; Being compiled. If the loading and compiling version is
2342 ;; the same we use a value that is evaluated at compile time,
2343 ;; otherwise it's evaluated at runtime.
2350 "Alist of constants in the process of being evaluated.
2351 The `cdr' of each entry indicates how far we've looked in the list
2352 of definitions, so that the def for var FOO in c-mode can be defined in
2353 terms of the def for that same var FOO (which will then rely on the
2359 ;; Used by `c-lang-const'.
2367 elem
2371 ;; Record the dependencies between this symbol and the one we're
2372 ;; being evaluated in.
2377 ;; Make sure the source files have entries on the `source'
2378 ;; property so that loading will take place when necessary.
2383 ;; Might pull in more definitions which affect the value. The
2384 ;; clearing of dependent values etc is done when the
2385 ;; definition is encountered during the load; this is just to
2386 ;; jump past the check for a cached value below.
2394 ;; Check if an evaluation of this symbol is already underway.
2395 ;; In that case we just continue with the "assignment" before
2396 ;; the one currently being evaluated, thereby creating the
2397 ;; illusion if a `setq'-like sequence of assignments.
2402 ;; Append `c-lang-constants-under-evaluation' even if an
2403 ;; earlier entry is found. It's only necessary to get
2404 ;; the recording of dependencies above correct.
2408 value
2409 ;; Make sure the recursion limits aren't very low
2410 ;; since the `c-lang-const' dependencies can go deep.
2417 ;; First try the original mode but don't accept an
2418 ;; entry matching all languages since the fallback
2419 ;; mode might have an explicit entry before that.
2422 c-lang--novalue)
2423 ;; Try again with the fallback mode from the
2424 ;; original position. Note that
2425 ;; `c-buffer-is-cc-mode' still is the real mode if
2426 ;; language parameterization takes place.
2429 fallback t name))
2430 c-lang--novalue)))
2431 ;; A simple lookup with no fallback mode.
2434 c-lang--novalue))
2436 "`%s' got no (prior) value in %S (might be a cyclic reference)"
2437 name mode))
2442 ;; Print a message to aid in locating the error. We don't
2443 ;; print the error itself since that will be done later by
2444 ;; some caller higher up.
2446 sym mode)
2451 value))))
2454 ;; Find the first assignment entry that applies to MODE at or after
2455 ;; SOURCE-POS. If MATCH-ANY-LANG is non-nil, entries with t as
2456 ;; the language list are considered to match, otherwise they don't.
2457 ;; On return SOURCE-POS is updated to point to the next assignment
2458 ;; after the returned one. If no assignment is found,
2459 ;; `c-lang--novalue' is returned as a magic value.
2460 ;;
2461 ;; SOURCE-POS is a vector that points out a specific assignment in
2462 ;; the double alist that's used in the `source' property. The first
2463 ;; element is the position in the top alist which is indexed with
2464 ;; the source files, and the second element is the position in the
2465 ;; nested bindings alist.
2466 ;;
2467 ;; NAME is only used for error messages.
2472 assignment)
2475 t
2476 ;; Handled the last assignment from one file, begin on the
2477 ;; next. Due to the check in `c-lang-defconst', we know
2478 ;; there's at least one.
2483 ;; The file containing the source definitions has not
2484 ;; been loaded.
2487 ;;(message (concat "Loading %s to get the source "
2488 ;; "value for language constant %s")
2489 ;; file name)
2493 ;; The load didn't fill in the source for the
2494 ;; constant as expected. The situation is
2495 ;; probably that a derived mode was written for
2496 ;; and compiled with another version of CC Mode,
2497 ;; and the requested constant isn't in the
2498 ;; currently loaded one. Put in a dummy
2499 ;; assignment that matches no language.
2504 t))
2512 match-any-lang)
2515 c-lang--novalue)))
2518 ;; `c-major-mode-is' expands to a call to this function inside
2519 ;; `c-lang-defconst'. Here we also match the mode(s) against any
2520 ;; fallback modes for the one in `c-buffer-is-cc-mode', so that
2521 ;; e.g. (c-major-mode-is 'c++-mode) is true in a derived language
2522 ;; that has c++-mode as base mode.
2529 nil)
2531 match))
2533 \f
2536 ;; Local Variables:
2537 ;; indent-tabs-mode: t
2538 ;; tab-width: 8
2539 ;; End:
2540 ;;; cc-defs.el ends here