| blob | 48236c2dca2e8a90069324f501d6859b8b7dcfcc |
1 ;;; cc-defs.el --- compile time definitions for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2013 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)))
49 ;; Silence the compiler.
63 \f
64 ;; cc-fix.el contains compatibility macros that should be used if
65 ;; needed.
71 ; (eval-after-load "font-lock" ; 2006-07-09. font-lock is now preloaded
72 ; '
74 ; to make the call to f-l-c-k throw an error.
81 ;; The above takes care of the delayed loading, but this is necessary
82 ;; to ensure correct byte compilation.
90 font-lock-keywords)))
93 \f
94 ;;; Variables also used at compile time.
100 ;; A little more compact and faster in comparisons.
103 "Non-nil for all buffers with a major mode derived from CC Mode.
104 Otherwise, this variable is nil. I.e. this variable is non-nil for
105 `c-mode', `c++-mode', `objc-mode', `java-mode', `idl-mode',
106 `pike-mode', `awk-mode', and any other non-CC Mode mode that calls
107 `c-initialize-cc-mode'. The value is the mode symbol itself
108 \(i.e. `c-mode' etc) of the original CC Mode mode, or just t if it's
112 ;; Have to make `c-buffer-is-cc-mode' permanently local so that it
113 ;; survives the initialization of the derived mode.
116 \f
117 ;; The following is used below during compilation.
122 "Like `progn', but evaluates the body at compile time.
123 The result of the body appears to the compiler as a quoted constant.
125 This variant works around bugs in `eval-when-compile' in various
126 \(X)Emacs versions. See cc-defs.el for details."
129 ;; XEmacs 21.4.6 has a bug in `eval-when-compile' in that it
130 ;; evaluates its body at macro expansion time if it's nested
131 ;; inside another `eval-when-compile'. So we use a dynamically
132 ;; bound variable to avoid nesting them.
136 ;; In all (X)Emacsen so far, `eval-when-compile' byte compiles
137 ;; its contents before evaluating it. That can cause forms to
138 ;; be compiled in situations they aren't intended to be
139 ;; compiled.
140 ;;
141 ;; Example: It's not possible to defsubst a primitive, e.g. the
142 ;; following will produce an error (in any emacs flavor), since
143 ;; `nthcdr' is a primitive function that's handled specially by
144 ;; the byte compiler and thus can't be redefined:
145 ;;
146 ;; (defsubst nthcdr (val) val)
147 ;;
148 ;; `defsubst', like `defmacro', needs to be evaluated at
149 ;; compile time, so this will produce an error during byte
150 ;; compilation.
151 ;;
152 ;; CC Mode occasionally needs to do things like this for
153 ;; cross-emacs compatibility. It therefore uses the following
154 ;; to conditionally do a `defsubst':
155 ;;
156 ;; (eval-when-compile
157 ;; (if (not (fboundp 'foo))
158 ;; (defsubst foo ...)))
159 ;;
160 ;; But `eval-when-compile' byte compiles its contents and
161 ;; _then_ evaluates it (in all current emacs versions, up to
162 ;; and including Emacs 20.6 and XEmacs 21.1 as of this
163 ;; writing). So this will still produce an error, since the
164 ;; byte compiler will get to the defsubst anyway. That's
165 ;; arguably a bug because the point with `eval-when-compile' is
166 ;; that it should evaluate rather than compile its contents.
167 ;;
168 ;; We get around it by expanding the body to a quoted
169 ;; constant that we eval. That otoh introduce a problem in
170 ;; that a returned lambda expression doesn't get byte
171 ;; compiled (even if `function' is used).
176 \f
177 ;;; Macros.
180 "Return the value of certain commonly referenced POSITIONs relative to POINT.
181 The current point is used if POINT isn't specified. POSITION can be
182 one of the following symbols:
184 `bol' -- beginning of line
185 `eol' -- end of line
186 `bod' -- beginning of defun
187 `eod' -- end of defun
188 `boi' -- beginning of indentation
189 `ionl' -- indentation of next line
190 `iopl' -- indentation of previous line
191 `bonl' -- beginning of next line
192 `eonl' -- end of next line
193 `bopl' -- beginning of previous line
194 `eopl' -- end of previous line
195 `bosws' -- beginning of syntactic whitespace
196 `eosws' -- end of syntactic whitespace
198 If the referenced position doesn't exist, the closest accessible point
199 to it is returned. This function does not modify the point or the mark."
301 ;; The bulk of this should perhaps be in a function to avoid large
302 ;; expansions, but this case is not used anywhere in CC Mode (and
303 ;; probably not anywhere else either) so we only have it to be on
304 ;; the safe side.
335 ;; Return t when the region is active. The determination of region
336 ;; activeness is different in both Emacs and XEmacs.
338 ;; Emacs.
339 'mark-active
340 ;; XEmacs.
344 ;; Activate the region if ACTIVE is non-nil, deactivate it
345 ;; otherwise. Covers the differences between Emacs and XEmacs.
347 ;; XEmacs.
351 ;; Emacs.
355 "Delete the text between START and END and return it."
357 ;; Emacs 21.1 and later
359 ;; XEmacs and Emacs 20.x
365 ;; safely execute BODY, return nil if an error occurred
372 ;; In Emacs, a character is an integer. In XEmacs, a character is a
373 ;; type distinct from an integer. Sometimes we need to convert integers to
374 ;; characters. `c-int-to-char' makes this conversion, if necessary.
377 integer))
380 ;; The last character just typed. Note that `last-command-event' exists in
381 ;; both Emacs and XEmacs, but with confusingly different meanings.
383 'last-command-char
387 ;; Get the regular expression `sentence-end'.
389 ;; Emacs 22:
391 ;; Emacs <22 + XEmacs
395 ;; Get the default value of the variable sentence end.
397 ;; Emacs 22:
399 ;; Emacs <22 + XEmacs
402 ;; The following is essentially `save-buffer-state' from lazy-lock.el.
403 ;; It ought to be a standard macro.
405 "Bind variables according to VARLIST (in `let*' style) and eval BODY,
406 then restore the buffer state under the assumption that no significant
407 modification has been made in BODY. A change is considered
408 significant if it affects the buffer text in any way that isn't
409 completely restored again. Changes in text properties like `face' or
410 `syntax-table' are considered insignificant. This macro allows text
411 properties to be changed, even in a read-only buffer.
413 This macro should be placed around all calculations which set
415 known to be writable. That way, these text properties remain set
416 even if the user undoes the command which set them.
419 changes \(like adding a newline to calculate a text-property then
420 deleting it again\), so that the user never sees them on his
421 `buffer-undo-list'. See also `c-tentative-buffer-changes'.
423 However, any user-visible changes to the buffer \(like auto-newlines\)
424 must not be within a `c-save-buffer-state', since the user then
425 wouldn't be able to undo them.
427 The return value is the value of the last form in BODY."
430 before-change-functions after-change-functions
431 deactivate-mark
432 buffer-file-name buffer-file-truename ; Prevent primitives checking
433 ; for file modification
443 "Eval BODY and optionally restore the buffer contents to the state it
444 was in before BODY. Any changes are kept if the last form in BODY
445 returns non-nil. Otherwise it's undone using the undo facility, and
446 various other buffer state that might be affected by the changes is
447 restored. That includes the current buffer, point, mark, mark
448 activation \(similar to `save-excursion'), and the modified state.
449 The state is also restored if BODY exits nonlocally.
451 If BODY makes a change that unconditionally is undone then wrap this
452 macro inside `c-save-buffer-state'. That way the change can be done
453 even when the buffer is read-only, and without interference from
454 various buffer change hooks."
456 -tnt-chng-state)
458 ;; Insert an undo boundary for use with `undo-more'. We
459 ;; don't use `undo-boundary' since it doesn't insert one
460 ;; unconditionally.
468 ;; Used internally in `c-tentative-buffer-changes'.
471 ;; No need to use markers for the point and mark; if the
472 ;; undo got out of synch we're hosed anyway.
479 ;; Used internally in `c-tentative-buffer-changes'.
483 ;; No change was done after all.
487 ;; Find and remove the undo boundary.
493 ;; `primitive-undo' will remove the boundary.
498 saved-undo-list))))
510 "Forward skip over syntactic whitespace.
511 Syntactic whitespace is defined as whitespace characters, comments,
512 and preprocessor directives. However if point starts inside a comment
513 or preprocessor directive, the content of it is not treated as
514 whitespace.
516 LIMIT sets an upper limit of the forward movement, if specified. If
517 LIMIT or the end of the buffer is reached inside a comment or
518 preprocessor directive, the point will be left there.
520 Note that this function might do hidden buffer changes. See the
521 comment at the start of cc-engine.el for more info."
529 "Backward skip over syntactic whitespace.
530 Syntactic whitespace is defined as whitespace characters, comments,
531 and preprocessor directives. However if point starts inside a comment
532 or preprocessor directive, the content of it is not treated as
533 whitespace.
535 LIMIT sets a lower limit of the backward movement, if specified. If
536 LIMIT is reached inside a line comment or preprocessor directive then
537 the point is moved into it past the whitespace at the end.
539 Note that this function might do hidden buffer changes. See the
540 comment at the start of cc-engine.el for more info."
548 "Move forward across COUNT balanced expressions.
549 A negative COUNT means move backward. Signal an error if the move
550 fails for any reason.
552 This is like `forward-sexp' except that it isn't interactive and does
553 not do any user friendly adjustments of the point and that it isn't
554 susceptible to user configurations such as disabling of signals in
555 certain situations."
560 "See `c-forward-sexp' and reverse directions."
565 "Like `scan-lists' but returns nil instead of signaling errors
566 for unbalanced parens.
568 A limit for the search may be given. FROM is assumed to be on the
569 right side of it."
583 res)))
585 \f
586 ;; Wrappers for common scan-lists cases, mainly because it's almost
587 ;; impossible to get a feel for how that function works.
590 "Move backward across one balanced group of parentheses.
592 Return POINT when we succeed, NIL when we fail. In the latter case, leave
593 point unmoved."
596 endpos)))
599 "Move backward across one balanced group of parentheses.
601 Return POINT when we succeed, NIL when we fail. In the latter case, leave
602 point unmoved."
605 endpos)))
608 "Return the first position after the list sexp containing POS,
609 or nil if no such position exists. The point is used if POS is left out.
611 A limit for the search may be given. The start position is assumed to
612 be before it."
616 "Return the position of the start of the list sexp containing POS,
617 or nil if no such position exists. The point is used if POS is left out.
619 A limit for the search may be given. The start position is assumed to
620 be after it."
624 "Return the first position inside the first list sexp after POS,
625 or nil if no such position exists. The point is used if POS is left out.
627 A limit for the search may be given. The start position is assumed to
628 be before it."
632 "Return the last position inside the last list sexp before POS,
633 or nil if no such position exists. The point is used if POS is left out.
635 A limit for the search may be given. The start position is assumed to
636 be after it."
640 "Move the point to the first position after the list sexp containing POS,
641 or containing the point if POS is left out. Return t if such a
642 position exists, otherwise nil is returned and the point isn't moved.
644 A limit for the search may be given. The start position is assumed to
645 be before it."
651 res)))
654 "Move the point to the position of the start of the list sexp containing POS,
655 or containing the point if POS is left out. Return t if such a
656 position exists, otherwise nil is returned and the point isn't moved.
658 A limit for the search may be given. The start position is assumed to
659 be after it."
665 res)))
668 "Move the point to the first position inside the first list sexp after POS,
669 or before the point if POS is left out. Return t if such a position
670 exists, otherwise nil is returned and the point isn't moved.
672 A limit for the search may be given. The start position is assumed to
673 be before it."
679 res)))
682 "Move the point to the last position inside the last list sexp before POS,
683 or before the point if POS is left out. Return t if such a position
684 exists, otherwise nil is returned and the point isn't moved.
686 A limit for the search may be given. The start position is assumed to
687 be after it."
693 res)))
695 \f
697 ;; Wrapper around beginning-of-defun.
698 ;;
699 ;; NOTE: This function should contain the only explicit use of
700 ;; beginning-of-defun in CC Mode. Eventually something better than
701 ;; b-o-d will be available and this should be the only place the
702 ;; code needs to change. Everything else should use
703 ;; (c-beginning-of-defun-1)
704 ;;
705 ;; This is really a bit too large to be a macro but that isn't a
706 ;; problem as long as it only is used in one place in
707 ;; `c-parse-state'.
711 c-enable-xemacs-performance-kludge-p)
713 ;; XEmacs only. This can improve the performance of
714 ;; c-parse-state to between 3 and 60 times faster when
715 ;; braces are hung. It can also degrade performance by
716 ;; about as much when braces are not hung.
718 pos)
728 ;; unbalanced parenthesis, while invalid C code,
729 ;; shouldn't cause an infloop! See unbal.c
731 ;; Punt!
738 ))
740 ;; Emacs, which doesn't have buffer-syntactic-context-depth
743 ;; if defun-prompt-regexp is non-nil, b-o-d won't leave us at the
744 ;; open brace.
749 \f
750 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
751 ;; V i r t u a l S e m i c o l o n s
752 ;;
753 ;; In most CC Mode languages, statements are terminated explicitly by
754 ;; semicolons or closing braces. In some of the CC modes (currently AWK Mode
755 ;; and certain user-specified #define macros in C, C++, etc. (November 2008)),
756 ;; statements are (or can be) terminated by EOLs. Such a statement is said to
757 ;; be terminated by a "virtual semicolon" (VS). A statement terminated by an
758 ;; actual semicolon or brace is never considered to have a VS.
759 ;;
760 ;; The indentation engine (or whatever) tests for a VS at a specific position
761 ;; by invoking the macro `c-at-vsemi-p', which in its turn calls the mode
762 ;; specific function (if any) which is the value of the language variable
763 ;; `c-at-vsemi-p-fn'. This function should only use "low-level" features of
764 ;; CC Mode, i.e. features which won't trigger infinite recursion. ;-) The
765 ;; actual details of what constitutes a VS in a language are thus encapsulated
766 ;; in code specific to that language (e.g. cc-awk.el). `c-at-vsemi-p' returns
767 ;; non-nil if point (or the optional parameter POS) is at a VS, nil otherwise.
768 ;;
769 ;; The language specific function might well do extensive analysis of the
770 ;; source text, and may use a caching scheme to speed up repeated calls.
771 ;;
772 ;; The "virtual semicolon" lies just after the last non-ws token on the line.
773 ;; Like POINT, it is considered to lie between two characters. For example,
774 ;; at the place shown in the following AWK source line:
775 ;;
776 ;; kbyte = 1024 # 1000 if you're not picky
777 ;; ^
778 ;; |
779 ;; Virtual Semicolon
780 ;;
781 ;; In addition to `c-at-vsemi-p-fn', a mode may need to supply a function for
782 ;; `c-vsemi-status-unknown-p-fn'. The macro `c-vsemi-status-unknown-p' is a
783 ;; rather recondite kludge. It exists because the function
784 ;; `c-beginning-of-statement-1' sometimes tests for VSs as an optimization,
785 ;; but `c-at-vsemi-p' might well need to call `c-beginning-of-statement-1' in
786 ;; its calculations, thus potentially leading to infinite recursion.
787 ;;
788 ;; The macro `c-vsemi-status-unknown-p' resolves this problem; it may return
789 ;; non-nil at any time; returning nil is a guarantee that an immediate
790 ;; invocation of `c-at-vsemi-p' at point will NOT call
791 ;; `c-beginning-of-statement-1'. `c-vsemi-status-unknown-p' may not itself
792 ;; call `c-beginning-of-statement-1'.
793 ;;
794 ;; The macro `c-vsemi-status-unknown-p' will typically check the caching
795 ;; scheme used by the `c-at-vsemi-p-fn', hence the name - the status is
796 ;; "unknown" if there is no cache entry current for the line.
797 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
800 ;; Is there a virtual semicolon (not a real one or a }) at POS (defaults to
801 ;; point)? Always returns nil for languages which don't have Virtual
802 ;; semicolons.
803 ;; This macro might do hidden buffer changes.
808 ;; Return NIL only if it can be guaranteed that an immediate
809 ;; (c-at-vsemi-p) will NOT call c-beginning-of-statement-1. Otherwise,
810 ;; return non-nil. (See comments above). The function invoked by this
811 ;; macro MUST NOT UNDER ANY CIRCUMSTANCES itself call
812 ;; c-beginning-of-statement-1.
813 ;; Languages which don't have EOL terminated statements always return NIL
814 ;; (they _know_ there's no vsemi ;-).
817 \f
819 ;; Formats an error message for the echo area and dings, i.e. like
820 ;; `error' but doesn't abort.
826 ;; Temporarily switches to the specified syntax table in a failsafe
827 ;; way to execute code.
837 "Skip over any whitespace following point.
838 This function skips over horizontal and vertical whitespace and line
839 continuations."
843 ;; skip-syntax-* doesn't count \n as whitespace..
858 "Skip over any whitespace preceding point.
859 This function skips over horizontal and vertical whitespace and line
860 continuations."
864 ;; skip-syntax-* doesn't count \n as whitespace..
880 "Return non-nil if the current CC Mode major mode is MODE.
881 MODE is either a mode symbol or a list of mode symbols."
884 ;; Inside a `c-lang-defconst'.
898 \f
899 ;; Macros/functions to handle so-called "char properties", which are
900 ;; properties set on a single character and that never spread to any
901 ;; other characters.
904 ;; Constant used at compile time to decide whether or not to use
905 ;; XEmacs extents. Check all the extent functions we'll use since
906 ;; some packages might add compatibility aliases for some of them in
907 ;; Emacs.
916 ;; `c-put-char-property' is complex enough in XEmacs and Emacs < 21 to
917 ;; make it a function.
921 ;; XEmacs.
931 end-open t)))))))))
934 ;; In Emacs < 21 we have to mess with the `rear-nonsticky' property.
941 'rear-nonsticky
943 ;; This won't be used for anything.
948 ;; Put the given property with the given value on the character at
949 ;; POS and make it front and rear nonsticky, or start and end open
950 ;; in XEmacs vocabulary. If the character already has the given
951 ;; property then the value is replaced, and the behavior is
952 ;; undefined if that property has been put by some other function.
953 ;; PROPERTY is assumed to be constant.
954 ;;
955 ;; If there's a `text-property-default-nonsticky' variable (Emacs
956 ;; 21) then it's assumed that the property is present on it.
957 ;;
958 ;; This macro does a hidden buffer change.
962 ;; XEmacs and Emacs < 21.
964 ;; In Emacs 21 we got the `rear-nonsticky' property covered
965 ;; by `text-property-default-nonsticky'.
970 ;; Get the value of the given property on the character at POS if
971 ;; it's been put there by `c-put-char-property'. PROPERTY is
972 ;; assumed to be constant.
975 ;; XEmacs.
978 ;; Emacs.
981 ;; `c-clear-char-property' is complex enough in Emacs < 21 to make it
982 ;; a function, since we have to mess with the `rear-nonsticky' property.
992 'rear-nonsticky
998 ;; Remove the given property on the character at POS if it's been put
999 ;; there by `c-put-char-property'. PROPERTY is assumed to be
1000 ;; constant.
1001 ;;
1002 ;; This macro does a hidden buffer change.
1005 ;; XEmacs.
1009 ;; In Emacs 21 we got the `rear-nonsticky' property covered
1010 ;; by `text-property-default-nonsticky'.
1015 ;; Emacs < 21.
1019 ;; Remove all the occurrences of the given property in the given
1020 ;; region that has been put with `c-put-char-property'. PROPERTY is
1021 ;; assumed to be constant.
1022 ;;
1023 ;; Note that this function does not clean up the property from the
1024 ;; lists of the `rear-nonsticky' properties in the region, if such
1025 ;; are used. Thus it should not be used for common properties like
1026 ;; `syntax-table'.
1027 ;;
1028 ;; This macro does hidden buffer changes.
1031 ;; XEmacs.
1035 ;; Emacs.
1039 "Search forward for a text-property PROPERTY having value VALUE.
1040 LIMIT bounds the search. The comparison is done with `equal'.
1042 Leave point just after the character, and set the match data on
1043 this character, and return point. If VALUE isn't found, Return
1044 nil; point is then left undefined."
1058 "Search backward for a text-property PROPERTY having value VALUE.
1059 LIMIT bounds the search. The comparison is done with `equal'.
1061 Leave point just before the character, set the match data on this
1062 character, and return point. If VALUE isn't found, Return nil;
1063 point is then left undefined."
1077 "Remove all text-properties PROPERTY from the region (FROM, TO)
1078 which have the value VALUE, as tested by `equal'. These
1079 properties are assumed to be over individual characters, having
1080 been put there by c-put-char-property. POINT remains unchanged."
1092 ;; Do we have to do anything with stickiness here?
1096 "Remove all text-properties PROPERTY from the region [FROM, TO)
1097 which have the value VALUE, as tested by `equal'. These
1098 properties are assumed to be over individual characters, having
1099 been put there by c-put-char-property. POINT remains unchanged."
1101 ;; XEmacs
1107 ;; Gnu Emacs
1109 \f
1110 ;; Macros to put overlays (Emacs) or extents (XEmacs) on buffer text.
1111 ;; For our purposes, these are characterized by being possible to
1112 ;; remove again without affecting the other text properties in the
1113 ;; buffer that got overridden when they were put.
1116 ;; Put an overlay/extent covering the given range in the current
1117 ;; buffer. It's currently undefined whether it's front/end sticky
1118 ;; or not. The overlay/extent object is returned.
1120 ;; Emacs.
1123 ol)
1124 ;; XEmacs.
1127 ext)))
1130 ;; Deletes an overlay/extent object previously retrieved using
1131 ;; `c-put-overlay'.
1133 ;; Emacs.
1135 ;; XEmacs.
1138 \f
1139 ;; Make edebug understand the macros.
1140 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1141 ; '(progn
1170 \f
1171 ;;; Functions.
1173 ;; Note: All these after the macros, to be on safe side in avoiding
1174 ;; bugs where macros are defined too late. These bugs often only show
1175 ;; when the files are compiled in a certain order within the same
1176 ;; session.
1179 ;; Replacement for end-of-defun that use c-beginning-of-defun-1.
1181 ;; Skip forward into the next defun block. Don't bother to avoid
1182 ;; comments, literals etc, since beginning-of-defun doesn't do that
1183 ;; anyway.
1195 ;; Mark the "<" character at POS as a template opener using the
1196 ;; `syntax-table' property via the `category' property.
1197 ;;
1198 ;; This function does a hidden buffer change. Note that we use
1199 ;; indirection through the `category' text property. This allows us to
1200 ;; toggle the property in all template brackets simultaneously and
1201 ;; cheaply. We use this, for instance, in `c-parse-state'.
1208 ;; Mark the ">" character at POS as an sexp list closer using the
1209 ;; syntax-table property.
1210 ;;
1211 ;; This function does a hidden buffer change. Note that we use
1212 ;; indirection through the `category' text property. This allows us to
1213 ;; toggle the property in all template brackets simultaneously and
1214 ;; cheaply. We use this, for instance, in `c-parse-state'.
1218 ;; Unmark the "<" or "<" character at POS as an sexp list opener using
1219 ;; the syntax-table property indirectly through the `category' text
1220 ;; property.
1221 ;;
1222 ;; This function does a hidden buffer change. Note that we use
1223 ;; indirection through the `category' text property. This allows us to
1224 ;; toggle the property in all template brackets simultaneously and
1225 ;; cheaply. We use this, for instance, in `c-parse-state'.
1229 ;; Suppress the syntactic effect of all marked < and > as parens. Note
1230 ;; that this effect is NOT buffer local. You should probably not use
1231 ;; this directly, but only through the macro
1232 ;; `c-with-<->-as-parens-suppressed'
1237 ;; Restore the syntactic effect of all marked <s and >s as parens. This
1238 ;; has no effect on unmarked <s and >s
1243 ;; Like progn, except that the paren property is suppressed on all
1244 ;; template brackets whilst they are running. This macro does a hidden
1245 ;; buffer change.
1252 ;;;;;;;;;;;;;;;
1255 ;; This is the value of the `category' text property placed on every #
1256 ;; which introduces a CPP construct and every EOL (or EOB, or character
1257 ;; preceding //, etc.) which terminates it. We can instantly "comment
1258 ;; out" all CPP constructs by giving `c-cpp-delimiter' a syntax-table
1259 ;; property '(14) (generic comment delimiter).
1261 ;; This macro does a hidden buffer change.
1267 ;; This macro does a hidden buffer change.
1274 ;; Render all preprocessor constructs syntactically commented out.
1277 ;; Restore the syntactic visibility of preprocessor constructs.
1281 ;; Execute FORMS... whilst the syntactic effect of all characters in
1282 ;; all CPP regions is suppressed. In particular, this is to suppress
1283 ;; the syntactic significance of parens/braces/brackets to functions
1284 ;; such as `scan-lists' and `parse-partial-sexp'.
1293 ;; Execute FORMS... whilst the syntactic effect of all characters in
1294 ;; every CPP region APART FROM THE ONE BETWEEN BEG and END is
1295 ;; suppressed.
1302 \f
1304 ;; return the element of ALIST that matches the first element found
1305 ;; in LIST. Uses assq.
1310 match))
1313 ;; first, find the first entry from LIST that is present in ALIST1,
1314 ;; then find the entry in ALIST2 for that entry.
1318 "Return the syntactic symbol in LANGELEM.
1322 form as used in `c-syntactic-element'."
1326 "Return the anchor position in LANGELEM, or nil if there is none.
1330 form as used in `c-syntactic-element'."
1336 "Return the column of the anchor position in LANGELEM.
1337 Also move the point to that position unless PRESERVE-POINT is non-nil.
1341 form as used in `c-syntactic-element'."
1353 "Return the secondary position in LANGELEM, or nil if there is none.
1356 in `c-syntactic-element'. It may also be a cons cell as passed in the
1357 first argument to lineup functions, but then the returned value always
1358 will be nil."
1362 ;; Do whatever is necessary to keep the region active in XEmacs.
1363 ;; This is not needed for Emacs.
1377 the corresponding symbol."
1383 c-buffer-is-cc-mode))
1388 the value of the variable with that name."
1392 "Return non-nil if position POS in the current buffer has any of the
1393 faces in the list FACES."
1400 pos-faces)
1404 ;; Return t if FACENAME is the name of a face. This method is
1405 ;; necessary since facep in XEmacs only returns t for the actual
1406 ;; face objects (while it's only their names that are used just
1407 ;; about anywhere else) without providing a predicate that tests
1408 ;; face names.
1412 "Like `concat' on LIST, but separate each element with SEPARATOR.
1413 Notably, null elements in LIST are ignored."
1417 "Make a regexp that matches all the strings the list.
1418 Duplicates and nil elements in the list are removed. The resulting
1419 regexp may contain zero or more submatch expressions.
1421 If ADORN is t there will be at least one submatch and the first
1422 surrounds the matched alternative, and the regexp will also not match
1423 a prefix of any identifier. Adorned regexps cannot be appended. The
1424 language variable `c-nonsymbol-key' is used to make the adornment.
1426 A value 'appendable for ADORN is like above, but all alternatives in
1428 instead, so that the regexp remains appendable. Note that this
1429 variant doesn't always guarantee that an identifier prefix isn't
1430 matched since the symbol constituent '_' is normally considered a
1433 The optional MODE specifies the language to get `c-nonsymbol-key' from
1434 when it's needed. The default is the current language taken from
1435 `c-buffer-is-cc-mode'."
1446 ;; This is kludgy but it works: Search for a string that
1447 ;; doesn't occur in any word in LIST. Append it to all
1448 ;; the alternatives where we want to add \>. Run through
1449 ;; `regexp-opt' and then replace it with \>.
1453 pos list)
1457 nil)
1458 t))
1460 found))
1474 ;; Emacs 20 and XEmacs (all versions so far) has a buggy
1475 ;; regexp-opt that doesn't always cope with strings containing
1476 ;; newlines. This kludge doesn't handle shy parens correctly
1477 ;; so we can't advice regexp-opt directly with it.
1501 ;; Add our own grouping parenthesis around re instead of
1502 ;; passing adorn to `regexp-opt', since in XEmacs it makes the
1503 ;; top level grouping "shy".
1512 re)))
1514 ;; Produce a regexp that matches nothing.
1522 "Make a character alternative string from the list of characters CHARS.
1523 The returned string is of the type that can be used with
1524 `skip-chars-forward' and `skip-chars-backward'. If INVERTED is
1525 non-nil, a caret is prepended to invert the set."
1526 ;; This function ought to be in the elisp core somewhere.
1532 ;; Quoting necessary (this method only works in the skip
1533 ;; functions).
1536 ;; Check for range.
1544 str))
1546 ;; Leftovers from (X)Emacs 19 compatibility.
1550 \f
1551 ;; Figure out what features this Emacs has
1559 ;; I've no idea what this actually is, but it's legacy. /mast
1562 ;; XEmacs uses 8-bit modify-syntax-entry flags.
1563 ;; Emacs uses a 1-bit flag. We will have to set up our
1564 ;; syntax tables differently to handle this.
1566 entry)
1569 ;; Emacs
1572 ;; In Emacs, table entries are cons cells
1574 ;; XEmacs
1577 ;; incompatible
1582 list)))
1584 ;; Check whether beginning/end-of-defun call
1585 ;; beginning/end-of-defun-function nicely, passing through the
1586 ;; argument and respecting the return code.
1607 parse-sexp-lookup-properties
1608 parse-sexp-ignore-comments
1609 lookup-syntax-properties)
1613 ;; For some reason we have to set some of these after the
1614 ;; buffer has been made current. (Specifically,
1615 ;; `parse-sexp-ignore-comments' in Emacs 21.)
1617 parse-sexp-ignore-comments t
1618 lookup-syntax-properties t)
1620 ;; Find out if the `syntax-table' text property works.
1631 "CC Mode is incompatible with this version of Emacs - "
1632 "support for the `syntax-table' text property "
1635 ;; Find out if generic comment delimiters work.
1641 ;; Find out if generic string delimiters work.
1647 ;; See if POSIX char classes work.
1649 ;; All versions of Emacs 21 so far haven't fixed
1650 ;; char classes in `skip-chars-forward' and
1651 ;; `skip-chars-backward'.
1660 ;; See if `open-paren-in-column-0-is-defun-start' exists and
1661 ;; isn't buggy (Emacs >= 21.4).
1669 ;; XEmacs. Afaik this is currently an Emacs-only
1670 ;; feature, but it's good to be prepared.
1674 ;; Emacs
1687 ;; See if `parse-partial-sexp' returns the eighth element.
1692 "CC Mode is incompatible with this version of Emacs - "
1695 ;;(message "c-emacs-features: %S" list)
1696 list)
1697 "A list of certain features in the (X)Emacs you are using.
1698 There are many flavors of Emacs out there, each with different
1699 features supporting those needed by CC Mode. The following values
1700 might be present:
1702 '8-bit 8 bit syntax entry flags (XEmacs style).
1703 '1-bit 1 bit syntax entry flags (Emacs style).
1704 'argumentative-bod-function beginning-of-defun passes ARG through
1705 to a non-null beginning-of-defun-function. It is assumed
1706 the end-of-defun does the same thing.
1707 'syntax-properties It works to override the syntax for specific characters
1708 in the buffer with the 'syntax-table property. It's
1709 always set - CC Mode no longer works in emacsen without
1710 this feature.
1711 'gen-comment-delim Generic comment delimiters work
1712 (i.e. the syntax class `!').
1713 'gen-string-delim Generic string delimiters work
1714 (i.e. the syntax class `|').
1715 'pps-extended-state `parse-partial-sexp' returns a list with at least 10
1716 elements, i.e. it contains the position of the start of
1717 the last comment or string. It's always set - CC Mode
1718 no longer works in emacsen without this feature.
1719 'posix-char-classes The regexp engine understands POSIX character classes.
1720 'col-0-paren It's possible to turn off the ad-hoc rule that a paren
1721 in column zero is the start of a defun.
1722 'infodock This is Infodock (based on XEmacs).
1726 \f
1727 ;;; Some helper constants.
1729 ;; If the regexp engine supports POSIX char classes then we can use
1730 ;; them to handle extended charsets correctly.
1744 \f
1745 ;;; System for handling language dependent constants.
1747 ;; This is used to set various language dependent data in a flexible
1748 ;; way: Language constants can be built from the values of other
1749 ;; language constants, also those for other languages. They can also
1750 ;; process the values of other language constants uniformly across all
1751 ;; the languages. E.g. one language constant can list all the type
1752 ;; keywords in each language, and another can build a regexp for each
1753 ;; language from those lists without code duplication.
1754 ;;
1755 ;; Language constants are defined with `c-lang-defconst', and their
1756 ;; value forms (referred to as source definitions) are evaluated only
1757 ;; on demand when requested for a particular language with
1758 ;; `c-lang-const'. It's therefore possible to refer to the values of
1759 ;; constants defined later in the file, or in another file, just as
1760 ;; long as all the relevant `c-lang-defconst' have been loaded when
1761 ;; `c-lang-const' is actually evaluated from somewhere else.
1762 ;;
1763 ;; `c-lang-const' forms are also evaluated at compile time and
1764 ;; replaced with the values they produce. Thus there's no overhead
1765 ;; for this system when compiled code is used - only the values
1766 ;; actually used in the code are present, and the file(s) containing
1767 ;; the `c-lang-defconst' forms don't need to be loaded at all then.
1768 ;; There are however safeguards to make sure that they can be loaded
1769 ;; to get the source definitions for the values if there's a mismatch
1770 ;; in compiled versions, or if `c-lang-const' is used uncompiled.
1771 ;;
1772 ;; Note that the source definitions in a `c-lang-defconst' form are
1773 ;; compiled into the .elc file where it stands; there's no need to
1774 ;; load the source file to get it.
1775 ;;
1776 ;; See cc-langs.el for more details about how this system is deployed
1777 ;; in CC Mode, and how the associated language variable system
1778 ;; (`c-lang-defvar') works. That file also contains a lot of
1779 ;; examples.
1782 "Declare a new language in the language dependent variable system.
1783 This is intended to be used by modes that inherit CC Mode to add new
1784 languages. It should be used at the top level before any calls to
1785 `c-lang-defconst'. MODE is the mode name symbol for the new language,
1786 and BASE-MODE is the mode name symbol for the language in CC Mode that
1787 is to be the template for the new mode.
1789 The exact effect of BASE-MODE is to make all language constants that
1790 haven't got a setting in the new language fall back to their values in
1791 BASE-MODE. It does not have any effect outside the language constant
1792 system."
1801 ;; This obarray is a cache to keep track of the language constants
1802 ;; defined by `c-lang-defconst' and the evaluated values returned by
1803 ;; `c-lang-const'. It's mostly used at compile time but it's not
1804 ;; stored in compiled files.
1805 ;;
1806 ;; The obarray contains all the language constants as symbols. The
1807 ;; value cells hold the evaluated values as alists where each car is
1808 ;; the mode name symbol and the corresponding cdr is the evaluated
1809 ;; value in that mode. The property lists hold the source definitions
1810 ;; and other miscellaneous data. The obarray might also contain
1811 ;; various other symbols, but those don't have any variable bindings.
1816 ;; Return the base name of the current file.
1819 ;; Being loaded.
1820 load-file-name)
1823 ;; Being compiled.
1824 byte-compile-dest-file)
1826 ;; Being evaluated interactively.
1831 "Can be used inside a VAL in `c-lang-defconst' to evaluate FORM
1832 immediately, i.e. at the same time as the `c-lang-defconst' form
1833 itself is evaluated."
1834 ;; Evaluate at macro expansion time, i.e. in the
1835 ;; `cl-macroexpand-all' inside `c-lang-defconst'.
1838 ;; Only used at compile time - suppress "might not be defined at runtime".
1842 "Set the language specific values of the language constant NAME.
1843 The second argument can optionally be a docstring. The rest of the
1844 arguments are one or more repetitions of LANG VAL where LANG specifies
1845 the language(s) that VAL applies to. LANG is the name of the
1847 of such language names, or `t' for all languages. VAL is a form to
1848 evaluate to get the value.
1850 If LANG isn't `t' or one of the core languages in CC Mode, it must
1851 have been declared with `c-add-language'.
1853 Neither NAME, LANG nor VAL are evaluated directly - they should not be
1854 quoted. `c-lang-defconst-eval-immediately' can however be used inside
1855 VAL to evaluate parts of it directly.
1857 When VAL is evaluated for some language, that language is temporarily
1858 made current so that `c-lang-const' without an explicit language can
1859 be used inside VAL to refer to the value of a language constant in the
1860 same language. That is particularly useful if LANG is `t'.
1862 VAL is not evaluated right away but rather when the value is requested
1863 with `c-lang-const'. Thus it's possible to use `c-lang-const' inside
1864 VAL to refer to language constants that haven't been defined yet.
1865 However, if the definition of a language constant is in another file
1866 then that file must be loaded \(at compile time) before it's safe to
1867 reference the constant.
1869 The assignments in ARGS are processed in sequence like `setq', so
1870 \(c-lang-const NAME) may be used inside a VAL to refer to the last
1871 assigned value to this language constant, or a value that it has
1872 gotten in another earlier loaded file.
1874 To work well with repeated loads and interactive reevaluation, only
1875 one `c-lang-defconst' for each NAME is permitted per file. If there
1876 already is one it will be completely replaced; the value in the
1877 earlier definition will not affect `c-lang-const' on the same
1878 constant. A file is identified by its base name."
1881 ;; Make `c-lang-const' expand to a straightforward call to
1882 ;; `c-get-lang-constant' in `cl-macroexpand-all' below.
1883 ;;
1884 ;; (The default behavior, i.e. to expand to a call inside
1885 ;; `eval-when-compile' should be equivalent, since that macro
1886 ;; should only expand to its content if it's used inside a
1887 ;; form that's already evaluated at compile time. It's
1888 ;; however necessary to use our cover macro
1889 ;; `cc-eval-when-compile' due to bugs in `eval-when-compile',
1890 ;; and it expands to a bulkier form that in this case only is
1891 ;; unnecessary garbage that we don't want to store in the
1892 ;; language constant source definitions.)
1895 bindings
1896 pre-files)
1902 ;; The docstring is hardly used anywhere since there's no normal
1903 ;; symbol to attach it to. It's primarily for getting the right
1904 ;; format in the source.
1911 ;; Rework ARGS to an association list to make it easier to handle.
1912 ;; It's reversed at the same time to make it easier to implement
1913 ;; the demand-driven (i.e. reversed) evaluation in `c-lang-const'.
1930 val)
1937 ;; Emacs has a weird bug where it seems to fail to read
1938 ;; backquote lists from byte compiled files correctly (,@
1939 ;; forms, to be specific), so make sure the bindings in the
1940 ;; expansion below don't contain any backquote stuff.
1941 ;; (XEmacs handles it correctly and doesn't need this for that
1942 ;; reason, but we also use this expansion handle
1943 ;; `c-lang-defconst-eval-immediately' and to register
1944 ;; dependencies on the `c-lang-const's in VAL.)
1950 ;; Compile in the other files that have provided source
1951 ;; definitions for this symbol, to make sure the order in the
1952 ;; `source' property is correct even when files are loaded out of
1953 ;; order.
1955 ;; Reverse to get the right load order.
1963 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1964 ; '
1969 ;; Used by `c-lang-defconst'.
1978 ;;(when (cdr-safe elem)
1979 ;; (message "Language constant %s redefined in %S" name file))
1981 ;; Note that the order in the source alist is relevant. Like how
1982 ;; `c-lang-defconst' reverses the bindings, this reverses the
1983 ;; order between files so that the last to evaluate comes first.
1993 ;; Bind the symbol as a variable, or clear any earlier evaluated
1994 ;; value it has.
1997 ;; Clear the evaluated values that depend on this source.
2000 ptr)
2013 name))
2016 "Get the mode specific value of the language constant NAME in language LANG.
2017 LANG is the name of the language, i.e. the mode name without the
2019 `c-lang-defvar', LANG may be left out to refer to the current
2020 language. NAME and LANG are not evaluated so they should not be
2021 quoted."
2029 mode source-files args)
2035 "Unknown language %S since it got no `c-mode-prefix' property"
2039 ;; No need to find out the source file(s) when we evaluate
2040 ;; immediately since all the info is already there in the
2041 ;; `source' property.
2046 ;; Get the source file(s) that must be loaded to get the value
2047 ;; of the constant. If the symbol isn't defined yet we assume
2048 ;; that its definition will come later in this file, and thus
2049 ;; are no file dependencies needed.
2051 ;; Reverse to get the right load order.
2055 nil ; Exclude our own file.
2059 ;; Make some effort to do a compact call to
2060 ;; `c-get-lang-constant' since it will be compiled in.
2064 args)))
2069 load-in-progress
2072 ;; Either a straight call is requested in the context, or
2073 ;; we're in an "uncontrolled" context and got no language,
2074 ;; or we're not being byte compiled so the compile time
2075 ;; stuff below is unnecessary.
2078 ;; Being compiled. If the loading and compiling version is
2079 ;; the same we use a value that is evaluated at compile time,
2080 ;; otherwise it's evaluated at runtime.
2089 ;; Used by `c-lang-const'.
2097 elem
2101 ;; Record the dependencies between this symbol and the one we're
2102 ;; being evaluated in.
2107 ;; Make sure the source files have entries on the `source'
2108 ;; property so that loading will take place when necessary.
2113 ;; Might pull in more definitions which affect the value. The
2114 ;; clearing of dependent values etc is done when the
2115 ;; definition is encountered during the load; this is just to
2116 ;; jump past the check for a cached value below.
2124 ;; Check if an evaluation of this symbol is already underway.
2125 ;; In that case we just continue with the "assignment" before
2126 ;; the one currently being evaluated, thereby creating the
2127 ;; illusion if a `setq'-like sequence of assignments.
2132 ;; Append `c-lang-constants-under-evaluation' even if an
2133 ;; earlier entry is found. It's only necessary to get
2134 ;; the recording of dependencies above correct.
2138 value
2139 ;; Make sure the recursion limits aren't very low
2140 ;; since the `c-lang-const' dependencies can go deep.
2147 ;; First try the original mode but don't accept an
2148 ;; entry matching all languages since the fallback
2149 ;; mode might have an explicit entry before that.
2152 c-lang-constants)
2153 ;; Try again with the fallback mode from the
2154 ;; original position. Note that
2155 ;; `c-buffer-is-cc-mode' still is the real mode if
2156 ;; language parameterization takes place.
2159 fallback t name))
2160 c-lang-constants)))
2161 ;; A simple lookup with no fallback mode.
2164 c-lang-constants))
2166 "`%s' got no (prior) value in %s (might be a cyclic reference)"
2167 name mode))
2172 ;; Print a message to aid in locating the error. We don't
2173 ;; print the error itself since that will be done later by
2174 ;; some caller higher up.
2176 sym mode)
2181 value))))
2184 ;; Find the first assignment entry that applies to MODE at or after
2185 ;; SOURCE-POS. If MATCH-ANY-LANG is non-nil, entries with `t' as
2186 ;; the language list are considered to match, otherwise they don't.
2187 ;; On return SOURCE-POS is updated to point to the next assignment
2188 ;; after the returned one. If no assignment is found,
2189 ;; `c-lang-constants' is returned as a magic value.
2190 ;;
2191 ;; SOURCE-POS is a vector that points out a specific assignment in
2192 ;; the double alist that's used in the `source' property. The first
2193 ;; element is the position in the top alist which is indexed with
2194 ;; the source files, and the second element is the position in the
2195 ;; nested bindings alist.
2196 ;;
2197 ;; NAME is only used for error messages.
2202 assignment)
2205 t
2206 ;; Handled the last assignment from one file, begin on the
2207 ;; next. Due to the check in `c-lang-defconst', we know
2208 ;; there's at least one.
2213 ;; The file containing the source definitions has not
2214 ;; been loaded.
2217 ;;(message (concat "Loading %s to get the source "
2218 ;; "value for language constant %s")
2219 ;; file name)
2223 ;; The load didn't fill in the source for the
2224 ;; constant as expected. The situation is
2225 ;; probably that a derived mode was written for
2226 ;; and compiled with another version of CC Mode,
2227 ;; and the requested constant isn't in the
2228 ;; currently loaded one. Put in a dummy
2229 ;; assignment that matches no language.
2234 t))
2242 match-any-lang)
2245 c-lang-constants)))
2248 ;; `c-major-mode-is' expands to a call to this function inside
2249 ;; `c-lang-defconst'. Here we also match the mode(s) against any
2250 ;; fallback modes for the one in `c-buffer-is-cc-mode', so that
2251 ;; e.g. (c-major-mode-is 'c++-mode) is true in a derived language
2252 ;; that has c++-mode as base mode.
2259 nil)
2261 match))
2263 \f
2266 ;;; cc-defs.el ends here