| blob | e6b691149dd95a645f8dd1e97b9994559ba32865 |
1 ;;; cc-defs.el --- compile time definitions for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2014 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.
59 \f
60 ;; cc-fix.el contains compatibility macros that should be used if
61 ;; needed.
67 ; (eval-after-load "font-lock" ; 2006-07-09. font-lock is now preloaded
68 ; '
70 ; to make the call to f-l-c-k throw an error.
77 ;; The above takes care of the delayed loading, but this is necessary
78 ;; to ensure correct byte compilation.
86 font-lock-keywords)))
89 \f
90 ;;; Variables also used at compile time.
96 ;; A little more compact and faster in comparisons.
99 "Non-nil for all buffers with a major mode derived from CC Mode.
100 Otherwise, this variable is nil. I.e. this variable is non-nil for
101 `c-mode', `c++-mode', `objc-mode', `java-mode', `idl-mode',
102 `pike-mode', `awk-mode', and any other non-CC Mode mode that calls
103 `c-initialize-cc-mode'. The value is the mode symbol itself
104 \(i.e. `c-mode' etc) of the original CC Mode mode, or just t if it's
108 ;; Have to make `c-buffer-is-cc-mode' permanently local so that it
109 ;; survives the initialization of the derived mode.
112 \f
113 ;; The following is used below during compilation.
118 "Like `progn', but evaluates the body at compile time.
119 The result of the body appears to the compiler as a quoted constant.
121 This variant works around bugs in `eval-when-compile' in various
122 \(X)Emacs versions. See cc-defs.el for details."
125 ;; XEmacs 21.4.6 has a bug in `eval-when-compile' in that it
126 ;; evaluates its body at macro expansion time if it's nested
127 ;; inside another `eval-when-compile'. So we use a dynamically
128 ;; bound variable to avoid nesting them.
132 ;; In all (X)Emacsen so far, `eval-when-compile' byte compiles
133 ;; its contents before evaluating it. That can cause forms to
134 ;; be compiled in situations they aren't intended to be
135 ;; compiled.
136 ;;
137 ;; Example: It's not possible to defsubst a primitive, e.g. the
138 ;; following will produce an error (in any emacs flavor), since
139 ;; `nthcdr' is a primitive function that's handled specially by
140 ;; the byte compiler and thus can't be redefined:
141 ;;
142 ;; (defsubst nthcdr (val) val)
143 ;;
144 ;; `defsubst', like `defmacro', needs to be evaluated at
145 ;; compile time, so this will produce an error during byte
146 ;; compilation.
147 ;;
148 ;; CC Mode occasionally needs to do things like this for
149 ;; cross-emacs compatibility. It therefore uses the following
150 ;; to conditionally do a `defsubst':
151 ;;
152 ;; (eval-when-compile
153 ;; (if (not (fboundp 'foo))
154 ;; (defsubst foo ...)))
155 ;;
156 ;; But `eval-when-compile' byte compiles its contents and
157 ;; _then_ evaluates it (in all current emacs versions, up to
158 ;; and including Emacs 20.6 and XEmacs 21.1 as of this
159 ;; writing). So this will still produce an error, since the
160 ;; byte compiler will get to the defsubst anyway. That's
161 ;; arguably a bug because the point with `eval-when-compile' is
162 ;; that it should evaluate rather than compile its contents.
163 ;;
164 ;; We get around it by expanding the body to a quoted
165 ;; constant that we eval. That otoh introduce a problem in
166 ;; that a returned lambda expression doesn't get byte
167 ;; compiled (even if `function' is used).
172 \f
173 ;;; Macros.
176 "Return the value of certain commonly referenced POSITIONs relative to POINT.
177 The current point is used if POINT isn't specified. POSITION can be
178 one of the following symbols:
180 `bol' -- beginning of line
181 `eol' -- end of line
182 `bod' -- beginning of defun
183 `eod' -- end of defun
184 `boi' -- beginning of indentation
185 `ionl' -- indentation of next line
186 `iopl' -- indentation of previous line
187 `bonl' -- beginning of next line
188 `eonl' -- end of next line
189 `bopl' -- beginning of previous line
190 `eopl' -- end of previous line
191 `bosws' -- beginning of syntactic whitespace
192 `eosws' -- end of syntactic whitespace
194 If the referenced position doesn't exist, the closest accessible point
195 to it is returned. This function does not modify the point or the mark."
297 ;; The bulk of this should perhaps be in a function to avoid large
298 ;; expansions, but this case is not used anywhere in CC Mode (and
299 ;; probably not anywhere else either) so we only have it to be on
300 ;; the safe side.
331 ;; Return t when the region is active. The determination of region
332 ;; activeness is different in both Emacs and XEmacs.
333 ;; FIXME? Emacs has region-active-p since 23.1, so maybe this test
334 ;; should be updated.
336 ;; Emacs.
337 'mark-active
338 ;; XEmacs.
342 ;; Activate the region if ACTIVE is non-nil, deactivate it
343 ;; otherwise. Covers the differences between Emacs and XEmacs.
345 ;; XEmacs.
349 ;; Emacs.
353 "Delete the text between START and END and return it."
355 ;; Emacs 21.1 and later
357 ;; XEmacs and Emacs 20.x
363 ;; safely execute BODY, return nil if an error occurred
370 ;; In Emacs, a character is an integer. In XEmacs, a character is a
371 ;; type distinct from an integer. Sometimes we need to convert integers to
372 ;; characters. `c-int-to-char' makes this conversion, if necessary.
375 integer))
378 ;; The last character just typed. Note that `last-command-event' exists in
379 ;; both Emacs and XEmacs, but with confusingly different meanings.
381 'last-command-char
385 ;; Get the regular expression `sentence-end'.
387 ;; Emacs 22:
389 ;; Emacs <22 + XEmacs
393 ;; Get the default value of the variable sentence end.
395 ;; Emacs 22:
397 ;; Emacs <22 + XEmacs
400 ;; The following is essentially `save-buffer-state' from lazy-lock.el.
401 ;; It ought to be a standard macro.
403 "Bind variables according to VARLIST (in `let*' style) and eval BODY,
404 then restore the buffer state under the assumption that no significant
405 modification has been made in BODY. A change is considered
406 significant if it affects the buffer text in any way that isn't
407 completely restored again. Changes in text properties like `face' or
408 `syntax-table' are considered insignificant. This macro allows text
409 properties to be changed, even in a read-only buffer.
411 This macro should be placed around all calculations which set
413 known to be writable. That way, these text properties remain set
414 even if the user undoes the command which set them.
417 changes \(like adding a newline to calculate a text-property then
418 deleting it again\), so that the user never sees them on his
419 `buffer-undo-list'. See also `c-tentative-buffer-changes'.
421 However, any user-visible changes to the buffer \(like auto-newlines\)
422 must not be within a `c-save-buffer-state', since the user then
423 wouldn't be able to undo them.
425 The return value is the value of the last form in BODY."
428 before-change-functions after-change-functions
429 deactivate-mark
430 buffer-file-name buffer-file-truename ; Prevent primitives checking
431 ; for file modification
441 "Eval BODY and optionally restore the buffer contents to the state it
442 was in before BODY. Any changes are kept if the last form in BODY
443 returns non-nil. Otherwise it's undone using the undo facility, and
444 various other buffer state that might be affected by the changes is
445 restored. That includes the current buffer, point, mark, mark
446 activation \(similar to `save-excursion'), and the modified state.
447 The state is also restored if BODY exits nonlocally.
449 If BODY makes a change that unconditionally is undone then wrap this
450 macro inside `c-save-buffer-state'. That way the change can be done
451 even when the buffer is read-only, and without interference from
452 various buffer change hooks."
454 -tnt-chng-state)
456 ;; Insert an undo boundary for use with `undo-more'. We
457 ;; don't use `undo-boundary' since it doesn't insert one
458 ;; unconditionally.
466 ;; Used internally in `c-tentative-buffer-changes'.
469 ;; No need to use markers for the point and mark; if the
470 ;; undo got out of synch we're hosed anyway.
477 ;; Used internally in `c-tentative-buffer-changes'.
481 ;; No change was done after all.
485 ;; Find and remove the undo boundary.
491 ;; `primitive-undo' will remove the boundary.
496 saved-undo-list))))
508 "Forward skip over syntactic whitespace.
509 Syntactic whitespace is defined as whitespace characters, comments,
510 and preprocessor directives. However if point starts inside a comment
511 or preprocessor directive, the content of it is not treated as
512 whitespace.
514 LIMIT sets an upper limit of the forward movement, if specified. If
515 LIMIT or the end of the buffer is reached inside a comment or
516 preprocessor directive, the point will be left there.
518 Note that this function might do hidden buffer changes. See the
519 comment at the start of cc-engine.el for more info."
527 "Backward skip over syntactic whitespace.
528 Syntactic whitespace is defined as whitespace characters, comments,
529 and preprocessor directives. However if point starts inside a comment
530 or preprocessor directive, the content of it is not treated as
531 whitespace.
533 LIMIT sets a lower limit of the backward movement, if specified. If
534 LIMIT is reached inside a line comment or preprocessor directive then
535 the point is moved into it past the whitespace at the end.
537 Note that this function might do hidden buffer changes. See the
538 comment at the start of cc-engine.el for more info."
546 "Move forward across COUNT balanced expressions.
547 A negative COUNT means move backward. Signal an error if the move
548 fails for any reason.
550 This is like `forward-sexp' except that it isn't interactive and does
551 not do any user friendly adjustments of the point and that it isn't
552 susceptible to user configurations such as disabling of signals in
553 certain situations."
558 "See `c-forward-sexp' and reverse directions."
563 "Like `scan-lists' but returns nil instead of signaling errors
564 for unbalanced parens.
566 A limit for the search may be given. FROM is assumed to be on the
567 right side of it."
581 res)))
583 \f
584 ;; Wrappers for common scan-lists cases, mainly because it's almost
585 ;; impossible to get a feel for how that function works.
588 "Move backward across one balanced group of parentheses.
590 Return POINT when we succeed, NIL when we fail. In the latter case, leave
591 point unmoved."
594 endpos)))
597 "Move backward across one balanced group of parentheses.
599 Return POINT when we succeed, NIL when we fail. In the latter case, leave
600 point unmoved."
603 endpos)))
606 "Return the first position after the list sexp containing POS,
607 or nil if no such position exists. The point is used if POS is left out.
609 A limit for the search may be given. The start position is assumed to
610 be before it."
614 "Return the position of the start of the list sexp containing POS,
615 or nil if no such position exists. The point is used if POS is left out.
617 A limit for the search may be given. The start position is assumed to
618 be after it."
622 "Return the first position inside the first list sexp after POS,
623 or nil if no such position exists. The point is used if POS is left out.
625 A limit for the search may be given. The start position is assumed to
626 be before it."
630 "Return the last position inside the last list sexp before POS,
631 or nil if no such position exists. The point is used if POS is left out.
633 A limit for the search may be given. The start position is assumed to
634 be after it."
638 "Move the point to the first position after the list sexp containing POS,
639 or containing the point if POS is left out. Return t if such a
640 position exists, otherwise nil is returned and the point isn't moved.
642 A limit for the search may be given. The start position is assumed to
643 be before it."
649 res)))
652 "Move the point to the position of the start of the list sexp containing POS,
653 or containing the point if POS is left out. Return t if such a
654 position exists, otherwise nil is returned and the point isn't moved.
656 A limit for the search may be given. The start position is assumed to
657 be after it."
663 res)))
666 "Move the point to the first position inside the first list sexp after POS,
667 or before the point if POS is left out. Return t if such a position
668 exists, otherwise nil is returned and the point isn't moved.
670 A limit for the search may be given. The start position is assumed to
671 be before it."
677 res)))
680 "Move the point to the last position inside the last list sexp before POS,
681 or before the point if POS is left out. Return t if such a position
682 exists, otherwise nil is returned and the point isn't moved.
684 A limit for the search may be given. The start position is assumed to
685 be after it."
691 res)))
693 \f
695 ;; Wrapper around beginning-of-defun.
696 ;;
697 ;; NOTE: This function should contain the only explicit use of
698 ;; beginning-of-defun in CC Mode. Eventually something better than
699 ;; b-o-d will be available and this should be the only place the
700 ;; code needs to change. Everything else should use
701 ;; (c-beginning-of-defun-1)
702 ;;
703 ;; This is really a bit too large to be a macro but that isn't a
704 ;; problem as long as it only is used in one place in
705 ;; `c-parse-state'.
709 c-enable-xemacs-performance-kludge-p)
711 ;; XEmacs only. This can improve the performance of
712 ;; c-parse-state to between 3 and 60 times faster when
713 ;; braces are hung. It can also degrade performance by
714 ;; about as much when braces are not hung.
716 pos)
726 ;; unbalanced parenthesis, while invalid C code,
727 ;; shouldn't cause an infloop! See unbal.c
729 ;; Punt!
736 ))
738 ;; Emacs, which doesn't have buffer-syntactic-context-depth
741 ;; if defun-prompt-regexp is non-nil, b-o-d won't leave us at the
742 ;; open brace.
747 \f
748 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
749 ;; V i r t u a l S e m i c o l o n s
750 ;;
751 ;; In most CC Mode languages, statements are terminated explicitly by
752 ;; semicolons or closing braces. In some of the CC modes (currently AWK Mode
753 ;; and certain user-specified #define macros in C, C++, etc. (November 2008)),
754 ;; statements are (or can be) terminated by EOLs. Such a statement is said to
755 ;; be terminated by a "virtual semicolon" (VS). A statement terminated by an
756 ;; actual semicolon or brace is never considered to have a VS.
757 ;;
758 ;; The indentation engine (or whatever) tests for a VS at a specific position
759 ;; by invoking the macro `c-at-vsemi-p', which in its turn calls the mode
760 ;; specific function (if any) which is the value of the language variable
761 ;; `c-at-vsemi-p-fn'. This function should only use "low-level" features of
762 ;; CC Mode, i.e. features which won't trigger infinite recursion. ;-) The
763 ;; actual details of what constitutes a VS in a language are thus encapsulated
764 ;; in code specific to that language (e.g. cc-awk.el). `c-at-vsemi-p' returns
765 ;; non-nil if point (or the optional parameter POS) is at a VS, nil otherwise.
766 ;;
767 ;; The language specific function might well do extensive analysis of the
768 ;; source text, and may use a caching scheme to speed up repeated calls.
769 ;;
770 ;; The "virtual semicolon" lies just after the last non-ws token on the line.
771 ;; Like POINT, it is considered to lie between two characters. For example,
772 ;; at the place shown in the following AWK source line:
773 ;;
774 ;; kbyte = 1024 # 1000 if you're not picky
775 ;; ^
776 ;; |
777 ;; Virtual Semicolon
778 ;;
779 ;; In addition to `c-at-vsemi-p-fn', a mode may need to supply a function for
780 ;; `c-vsemi-status-unknown-p-fn'. The macro `c-vsemi-status-unknown-p' is a
781 ;; rather recondite kludge. It exists because the function
782 ;; `c-beginning-of-statement-1' sometimes tests for VSs as an optimization,
783 ;; but `c-at-vsemi-p' might well need to call `c-beginning-of-statement-1' in
784 ;; its calculations, thus potentially leading to infinite recursion.
785 ;;
786 ;; The macro `c-vsemi-status-unknown-p' resolves this problem; it may return
787 ;; non-nil at any time; returning nil is a guarantee that an immediate
788 ;; invocation of `c-at-vsemi-p' at point will NOT call
789 ;; `c-beginning-of-statement-1'. `c-vsemi-status-unknown-p' may not itself
790 ;; call `c-beginning-of-statement-1'.
791 ;;
792 ;; The macro `c-vsemi-status-unknown-p' will typically check the caching
793 ;; scheme used by the `c-at-vsemi-p-fn', hence the name - the status is
794 ;; "unknown" if there is no cache entry current for the line.
795 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
798 ;; Is there a virtual semicolon (not a real one or a }) at POS (defaults to
799 ;; point)? Always returns nil for languages which don't have Virtual
800 ;; semicolons.
801 ;; This macro might do hidden buffer changes.
806 ;; Return NIL only if it can be guaranteed that an immediate
807 ;; (c-at-vsemi-p) will NOT call c-beginning-of-statement-1. Otherwise,
808 ;; return non-nil. (See comments above). The function invoked by this
809 ;; macro MUST NOT UNDER ANY CIRCUMSTANCES itself call
810 ;; c-beginning-of-statement-1.
811 ;; Languages which don't have EOL terminated statements always return NIL
812 ;; (they _know_ there's no vsemi ;-).
815 \f
817 ;; Formats an error message for the echo area and dings, i.e. like
818 ;; `error' but doesn't abort.
824 ;; Temporarily switches to the specified syntax table in a failsafe
825 ;; way to execute code.
835 "Skip over any whitespace following point.
836 This function skips over horizontal and vertical whitespace and line
837 continuations."
841 ;; skip-syntax-* doesn't count \n as whitespace..
856 "Skip over any whitespace preceding point.
857 This function skips over horizontal and vertical whitespace and line
858 continuations."
862 ;; skip-syntax-* doesn't count \n as whitespace..
878 "Return non-nil if the current CC Mode major mode is MODE.
879 MODE is either a mode symbol or a list of mode symbols."
882 ;; Inside a `c-lang-defconst'.
896 \f
897 ;; Macros/functions to handle so-called "char properties", which are
898 ;; properties set on a single character and that never spread to any
899 ;; other characters.
902 ;; Constant used at compile time to decide whether or not to use
903 ;; XEmacs extents. Check all the extent functions we'll use since
904 ;; some packages might add compatibility aliases for some of them in
905 ;; Emacs.
914 ;; `c-put-char-property' is complex enough in XEmacs and Emacs < 21 to
915 ;; make it a function.
919 ;; XEmacs.
929 end-open t)))))))))
932 ;; In Emacs < 21 we have to mess with the `rear-nonsticky' property.
939 'rear-nonsticky
941 ;; This won't be used for anything.
946 ;; Put the given property with the given value on the character at
947 ;; POS and make it front and rear nonsticky, or start and end open
948 ;; in XEmacs vocabulary. If the character already has the given
949 ;; property then the value is replaced, and the behavior is
950 ;; undefined if that property has been put by some other function.
951 ;; PROPERTY is assumed to be constant.
952 ;;
953 ;; If there's a `text-property-default-nonsticky' variable (Emacs
954 ;; 21) then it's assumed that the property is present on it.
955 ;;
956 ;; This macro does a hidden buffer change.
960 ;; XEmacs and Emacs < 21.
962 ;; In Emacs 21 we got the `rear-nonsticky' property covered
963 ;; by `text-property-default-nonsticky'.
968 ;; Get the value of the given property on the character at POS if
969 ;; it's been put there by `c-put-char-property'. PROPERTY is
970 ;; assumed to be constant.
973 ;; XEmacs.
976 ;; Emacs.
979 ;; `c-clear-char-property' is complex enough in Emacs < 21 to make it
980 ;; a function, since we have to mess with the `rear-nonsticky' property.
990 'rear-nonsticky
996 ;; Remove the given property on the character at POS if it's been put
997 ;; there by `c-put-char-property'. PROPERTY is assumed to be
998 ;; constant.
999 ;;
1000 ;; This macro does a hidden buffer change.
1003 ;; XEmacs.
1007 ;; In Emacs 21 we got the `rear-nonsticky' property covered
1008 ;; by `text-property-default-nonsticky'.
1013 ;; Emacs < 21.
1017 ;; Remove all the occurrences of the given property in the given
1018 ;; region that has been put with `c-put-char-property'. PROPERTY is
1019 ;; assumed to be constant.
1020 ;;
1021 ;; Note that this function does not clean up the property from the
1022 ;; lists of the `rear-nonsticky' properties in the region, if such
1023 ;; are used. Thus it should not be used for common properties like
1024 ;; `syntax-table'.
1025 ;;
1026 ;; This macro does hidden buffer changes.
1029 ;; XEmacs.
1033 ;; Emacs.
1037 "Search forward for a text-property PROPERTY having value VALUE.
1038 LIMIT bounds the search. The comparison is done with `equal'.
1040 Leave point just after the character, and set the match data on
1041 this character, and return point. If VALUE isn't found, Return
1042 nil; point is then left undefined."
1056 "Search backward for a text-property PROPERTY having value VALUE.
1057 LIMIT bounds the search. The comparison is done with `equal'.
1059 Leave point just before the character, set the match data on this
1060 character, and return point. If VALUE isn't found, Return nil;
1061 point is then left undefined."
1075 "Remove all text-properties PROPERTY from the region (FROM, TO)
1076 which have the value VALUE, as tested by `equal'. These
1077 properties are assumed to be over individual characters, having
1078 been put there by c-put-char-property. POINT remains unchanged."
1090 ;; Do we have to do anything with stickiness here?
1094 "Remove all text-properties PROPERTY from the region [FROM, TO)
1095 which have the value VALUE, as tested by `equal'. These
1096 properties are assumed to be over individual characters, having
1097 been put there by c-put-char-property. POINT remains unchanged."
1099 ;; XEmacs
1105 ;; Gnu Emacs
1107 \f
1108 ;; Macros to put overlays (Emacs) or extents (XEmacs) on buffer text.
1109 ;; For our purposes, these are characterized by being possible to
1110 ;; remove again without affecting the other text properties in the
1111 ;; buffer that got overridden when they were put.
1114 ;; Put an overlay/extent covering the given range in the current
1115 ;; buffer. It's currently undefined whether it's front/end sticky
1116 ;; or not. The overlay/extent object is returned.
1118 ;; Emacs.
1121 ol)
1122 ;; XEmacs.
1125 ext)))
1128 ;; Deletes an overlay/extent object previously retrieved using
1129 ;; `c-put-overlay'.
1131 ;; Emacs.
1133 ;; XEmacs.
1136 \f
1137 ;; Make edebug understand the macros.
1138 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1139 ; '(progn
1168 \f
1169 ;;; Functions.
1171 ;; Note: All these after the macros, to be on safe side in avoiding
1172 ;; bugs where macros are defined too late. These bugs often only show
1173 ;; when the files are compiled in a certain order within the same
1174 ;; session.
1177 ;; Replacement for end-of-defun that use c-beginning-of-defun-1.
1179 ;; Skip forward into the next defun block. Don't bother to avoid
1180 ;; comments, literals etc, since beginning-of-defun doesn't do that
1181 ;; anyway.
1193 ;; Mark the "<" character at POS as a template opener using the
1194 ;; `syntax-table' property via the `category' property.
1195 ;;
1196 ;; This function does a hidden buffer change. Note that we use
1197 ;; indirection through the `category' text property. This allows us to
1198 ;; toggle the property in all template brackets simultaneously and
1199 ;; cheaply. We use this, for instance, in `c-parse-state'.
1206 ;; Mark the ">" character at POS as an sexp list closer using the
1207 ;; syntax-table property.
1208 ;;
1209 ;; This function does a hidden buffer change. Note that we use
1210 ;; indirection through the `category' text property. This allows us to
1211 ;; toggle the property in all template brackets simultaneously and
1212 ;; cheaply. We use this, for instance, in `c-parse-state'.
1216 ;; Unmark the "<" or "<" character at POS as an sexp list opener using
1217 ;; the syntax-table property indirectly through the `category' text
1218 ;; property.
1219 ;;
1220 ;; This function does a hidden buffer change. Note that we use
1221 ;; indirection through the `category' text property. This allows us to
1222 ;; toggle the property in all template brackets simultaneously and
1223 ;; cheaply. We use this, for instance, in `c-parse-state'.
1227 ;; Suppress the syntactic effect of all marked < and > as parens. Note
1228 ;; that this effect is NOT buffer local. You should probably not use
1229 ;; this directly, but only through the macro
1230 ;; `c-with-<->-as-parens-suppressed'
1235 ;; Restore the syntactic effect of all marked <s and >s as parens. This
1236 ;; has no effect on unmarked <s and >s
1241 ;; Like progn, except that the paren property is suppressed on all
1242 ;; template brackets whilst they are running. This macro does a hidden
1243 ;; buffer change.
1250 ;;;;;;;;;;;;;;;
1253 ;; This is the value of the `category' text property placed on every #
1254 ;; which introduces a CPP construct and every EOL (or EOB, or character
1255 ;; preceding //, etc.) which terminates it. We can instantly "comment
1256 ;; out" all CPP constructs by giving `c-cpp-delimiter' a syntax-table
1257 ;; property '(14) (generic comment delimiter).
1259 ;; This macro does a hidden buffer change.
1265 ;; This macro does a hidden buffer change.
1272 ;; Render all preprocessor constructs syntactically commented out.
1275 ;; Restore the syntactic visibility of preprocessor constructs.
1279 ;; Execute FORMS... whilst the syntactic effect of all characters in
1280 ;; all CPP regions is suppressed. In particular, this is to suppress
1281 ;; the syntactic significance of parens/braces/brackets to functions
1282 ;; such as `scan-lists' and `parse-partial-sexp'.
1291 ;; Execute FORMS... whilst the syntactic effect of all characters in
1292 ;; every CPP region APART FROM THE ONE BETWEEN BEG and END is
1293 ;; suppressed.
1300 \f
1302 ;; return the element of ALIST that matches the first element found
1303 ;; in LIST. Uses assq.
1308 match))
1311 ;; first, find the first entry from LIST that is present in ALIST1,
1312 ;; then find the entry in ALIST2 for that entry.
1316 "Return the syntactic symbol in LANGELEM.
1320 form as used in `c-syntactic-element'."
1324 "Return the anchor position in LANGELEM, or nil if there is none.
1328 form as used in `c-syntactic-element'."
1334 "Return the column of the anchor position in LANGELEM.
1335 Also move the point to that position unless PRESERVE-POINT is non-nil.
1339 form as used in `c-syntactic-element'."
1351 "Return the secondary position in LANGELEM, or nil if there is none.
1354 in `c-syntactic-element'. It may also be a cons cell as passed in the
1355 first argument to lineup functions, but then the returned value always
1356 will be nil."
1360 ;; Do whatever is necessary to keep the region active in XEmacs.
1361 ;; This is not needed for Emacs.
1375 the corresponding symbol."
1381 c-buffer-is-cc-mode))
1386 the value of the variable with that name."
1390 "Return non-nil if position POS in the current buffer has any of the
1391 faces in the list FACES."
1398 pos-faces)
1402 ;; Return t if FACENAME is the name of a face. This method is
1403 ;; necessary since facep in XEmacs only returns t for the actual
1404 ;; face objects (while it's only their names that are used just
1405 ;; about anywhere else) without providing a predicate that tests
1406 ;; face names.
1410 "Like `concat' on LIST, but separate each element with SEPARATOR.
1411 Notably, null elements in LIST are ignored."
1415 "Make a regexp that matches all the strings the list.
1416 Duplicates and nil elements in the list are removed. The resulting
1417 regexp may contain zero or more submatch expressions.
1419 If ADORN is t there will be at least one submatch and the first
1420 surrounds the matched alternative, and the regexp will also not match
1421 a prefix of any identifier. Adorned regexps cannot be appended. The
1422 language variable `c-nonsymbol-key' is used to make the adornment.
1424 A value 'appendable for ADORN is like above, but all alternatives in
1426 instead, so that the regexp remains appendable. Note that this
1427 variant doesn't always guarantee that an identifier prefix isn't
1428 matched since the symbol constituent '_' is normally considered a
1431 The optional MODE specifies the language to get `c-nonsymbol-key' from
1432 when it's needed. The default is the current language taken from
1433 `c-buffer-is-cc-mode'."
1444 ;; This is kludgy but it works: Search for a string that
1445 ;; doesn't occur in any word in LIST. Append it to all
1446 ;; the alternatives where we want to add \>. Run through
1447 ;; `regexp-opt' and then replace it with \>.
1451 pos list)
1455 nil)
1456 t))
1458 found))
1472 ;; Emacs 20 and XEmacs (all versions so far) has a buggy
1473 ;; regexp-opt that doesn't always cope with strings containing
1474 ;; newlines. This kludge doesn't handle shy parens correctly
1475 ;; so we can't advice regexp-opt directly with it.
1499 ;; Add our own grouping parenthesis around re instead of
1500 ;; passing adorn to `regexp-opt', since in XEmacs it makes the
1501 ;; top level grouping "shy".
1510 re)))
1512 ;; Produce a regexp that matches nothing.
1520 "Make a character alternative string from the list of characters CHARS.
1521 The returned string is of the type that can be used with
1522 `skip-chars-forward' and `skip-chars-backward'. If INVERTED is
1523 non-nil, a caret is prepended to invert the set."
1524 ;; This function ought to be in the elisp core somewhere.
1530 ;; Quoting necessary (this method only works in the skip
1531 ;; functions).
1534 ;; Check for range.
1542 str))
1544 ;; Leftovers from (X)Emacs 19 compatibility.
1548 \f
1549 ;; Figure out what features this Emacs has
1557 ;; I've no idea what this actually is, but it's legacy. /mast
1560 ;; XEmacs uses 8-bit modify-syntax-entry flags.
1561 ;; Emacs uses a 1-bit flag. We will have to set up our
1562 ;; syntax tables differently to handle this.
1564 entry)
1567 ;; Emacs
1570 ;; In Emacs, table entries are cons cells
1572 ;; XEmacs
1575 ;; incompatible
1580 list)))
1582 ;; Check whether beginning/end-of-defun call
1583 ;; beginning/end-of-defun-function nicely, passing through the
1584 ;; argument and respecting the return code.
1605 parse-sexp-lookup-properties
1606 parse-sexp-ignore-comments
1611 ;; For some reason we have to set some of these after the
1612 ;; buffer has been made current. (Specifically,
1613 ;; `parse-sexp-ignore-comments' in Emacs 21.)
1615 parse-sexp-ignore-comments t
1616 lookup-syntax-properties t)
1618 ;; Find out if the `syntax-table' text property works.
1629 "CC Mode is incompatible with this version of Emacs - "
1630 "support for the `syntax-table' text property "
1633 ;; Find out if generic comment delimiters work.
1639 ;; Find out if generic string delimiters work.
1645 ;; See if POSIX char classes work.
1647 ;; All versions of Emacs 21 so far haven't fixed
1648 ;; char classes in `skip-chars-forward' and
1649 ;; `skip-chars-backward'.
1658 ;; See if `open-paren-in-column-0-is-defun-start' exists and
1659 ;; isn't buggy (Emacs >= 21.4).
1667 ;; XEmacs. Afaik this is currently an Emacs-only
1668 ;; feature, but it's good to be prepared.
1672 ;; Emacs
1685 ;; See if `parse-partial-sexp' returns the eighth element.
1690 "CC Mode is incompatible with this version of Emacs - "
1693 ;;(message "c-emacs-features: %S" list)
1694 list)
1695 "A list of certain features in the (X)Emacs you are using.
1696 There are many flavors of Emacs out there, each with different
1697 features supporting those needed by CC Mode. The following values
1698 might be present:
1700 '8-bit 8 bit syntax entry flags (XEmacs style).
1701 '1-bit 1 bit syntax entry flags (Emacs style).
1702 'argumentative-bod-function beginning-of-defun passes ARG through
1703 to a non-null beginning-of-defun-function. It is assumed
1704 the end-of-defun does the same thing.
1705 'syntax-properties It works to override the syntax for specific characters
1706 in the buffer with the 'syntax-table property. It's
1707 always set - CC Mode no longer works in emacsen without
1708 this feature.
1709 'gen-comment-delim Generic comment delimiters work
1710 (i.e. the syntax class `!').
1711 'gen-string-delim Generic string delimiters work
1712 (i.e. the syntax class `|').
1713 'pps-extended-state `parse-partial-sexp' returns a list with at least 10
1714 elements, i.e. it contains the position of the start of
1715 the last comment or string. It's always set - CC Mode
1716 no longer works in emacsen without this feature.
1717 'posix-char-classes The regexp engine understands POSIX character classes.
1718 'col-0-paren It's possible to turn off the ad-hoc rule that a paren
1719 in column zero is the start of a defun.
1720 'infodock This is Infodock (based on XEmacs).
1724 \f
1725 ;;; Some helper constants.
1727 ;; If the regexp engine supports POSIX char classes then we can use
1728 ;; them to handle extended charsets correctly.
1742 \f
1743 ;;; System for handling language dependent constants.
1745 ;; This is used to set various language dependent data in a flexible
1746 ;; way: Language constants can be built from the values of other
1747 ;; language constants, also those for other languages. They can also
1748 ;; process the values of other language constants uniformly across all
1749 ;; the languages. E.g. one language constant can list all the type
1750 ;; keywords in each language, and another can build a regexp for each
1751 ;; language from those lists without code duplication.
1752 ;;
1753 ;; Language constants are defined with `c-lang-defconst', and their
1754 ;; value forms (referred to as source definitions) are evaluated only
1755 ;; on demand when requested for a particular language with
1756 ;; `c-lang-const'. It's therefore possible to refer to the values of
1757 ;; constants defined later in the file, or in another file, just as
1758 ;; long as all the relevant `c-lang-defconst' have been loaded when
1759 ;; `c-lang-const' is actually evaluated from somewhere else.
1760 ;;
1761 ;; `c-lang-const' forms are also evaluated at compile time and
1762 ;; replaced with the values they produce. Thus there's no overhead
1763 ;; for this system when compiled code is used - only the values
1764 ;; actually used in the code are present, and the file(s) containing
1765 ;; the `c-lang-defconst' forms don't need to be loaded at all then.
1766 ;; There are however safeguards to make sure that they can be loaded
1767 ;; to get the source definitions for the values if there's a mismatch
1768 ;; in compiled versions, or if `c-lang-const' is used uncompiled.
1769 ;;
1770 ;; Note that the source definitions in a `c-lang-defconst' form are
1771 ;; compiled into the .elc file where it stands; there's no need to
1772 ;; load the source file to get it.
1773 ;;
1774 ;; See cc-langs.el for more details about how this system is deployed
1775 ;; in CC Mode, and how the associated language variable system
1776 ;; (`c-lang-defvar') works. That file also contains a lot of
1777 ;; examples.
1780 "Declare a new language in the language dependent variable system.
1781 This is intended to be used by modes that inherit CC Mode to add new
1782 languages. It should be used at the top level before any calls to
1783 `c-lang-defconst'. MODE is the mode name symbol for the new language,
1784 and BASE-MODE is the mode name symbol for the language in CC Mode that
1785 is to be the template for the new mode.
1787 The exact effect of BASE-MODE is to make all language constants that
1788 haven't got a setting in the new language fall back to their values in
1789 BASE-MODE. It does not have any effect outside the language constant
1790 system."
1799 ;; This obarray is a cache to keep track of the language constants
1800 ;; defined by `c-lang-defconst' and the evaluated values returned by
1801 ;; `c-lang-const'. It's mostly used at compile time but it's not
1802 ;; stored in compiled files.
1803 ;;
1804 ;; The obarray contains all the language constants as symbols. The
1805 ;; value cells hold the evaluated values as alists where each car is
1806 ;; the mode name symbol and the corresponding cdr is the evaluated
1807 ;; value in that mode. The property lists hold the source definitions
1808 ;; and other miscellaneous data. The obarray might also contain
1809 ;; various other symbols, but those don't have any variable bindings.
1814 ;; Return the base name of the current file.
1817 ;; Being loaded.
1818 load-file-name)
1821 ;; Being compiled.
1822 byte-compile-dest-file)
1824 ;; Being evaluated interactively.
1829 "Can be used inside a VAL in `c-lang-defconst' to evaluate FORM
1830 immediately, i.e. at the same time as the `c-lang-defconst' form
1831 itself is evaluated."
1832 ;; Evaluate at macro expansion time, i.e. in the
1833 ;; `cl-macroexpand-all' inside `c-lang-defconst'.
1836 ;; Only used at compile time - suppress "might not be defined at runtime".
1840 "Set the language specific values of the language constant NAME.
1841 The second argument can optionally be a docstring. The rest of the
1842 arguments are one or more repetitions of LANG VAL where LANG specifies
1843 the language(s) that VAL applies to. LANG is the name of the
1845 of such language names, or `t' for all languages. VAL is a form to
1846 evaluate to get the value.
1848 If LANG isn't `t' or one of the core languages in CC Mode, it must
1849 have been declared with `c-add-language'.
1851 Neither NAME, LANG nor VAL are evaluated directly - they should not be
1852 quoted. `c-lang-defconst-eval-immediately' can however be used inside
1853 VAL to evaluate parts of it directly.
1855 When VAL is evaluated for some language, that language is temporarily
1856 made current so that `c-lang-const' without an explicit language can
1857 be used inside VAL to refer to the value of a language constant in the
1858 same language. That is particularly useful if LANG is `t'.
1860 VAL is not evaluated right away but rather when the value is requested
1861 with `c-lang-const'. Thus it's possible to use `c-lang-const' inside
1862 VAL to refer to language constants that haven't been defined yet.
1863 However, if the definition of a language constant is in another file
1864 then that file must be loaded \(at compile time) before it's safe to
1865 reference the constant.
1867 The assignments in ARGS are processed in sequence like `setq', so
1868 \(c-lang-const NAME) may be used inside a VAL to refer to the last
1869 assigned value to this language constant, or a value that it has
1870 gotten in another earlier loaded file.
1872 To work well with repeated loads and interactive reevaluation, only
1873 one `c-lang-defconst' for each NAME is permitted per file. If there
1874 already is one it will be completely replaced; the value in the
1875 earlier definition will not affect `c-lang-const' on the same
1876 constant. A file is identified by its base name."
1879 ;; Make `c-lang-const' expand to a straightforward call to
1880 ;; `c-get-lang-constant' in `cl-macroexpand-all' below.
1881 ;;
1882 ;; (The default behavior, i.e. to expand to a call inside
1883 ;; `eval-when-compile' should be equivalent, since that macro
1884 ;; should only expand to its content if it's used inside a
1885 ;; form that's already evaluated at compile time. It's
1886 ;; however necessary to use our cover macro
1887 ;; `cc-eval-when-compile' due to bugs in `eval-when-compile',
1888 ;; and it expands to a bulkier form that in this case only is
1889 ;; unnecessary garbage that we don't want to store in the
1890 ;; language constant source definitions.)
1893 bindings
1894 pre-files)
1900 ;; The docstring is hardly used anywhere since there's no normal
1901 ;; symbol to attach it to. It's primarily for getting the right
1902 ;; format in the source.
1909 ;; Rework ARGS to an association list to make it easier to handle.
1910 ;; It's reversed at the same time to make it easier to implement
1911 ;; the demand-driven (i.e. reversed) evaluation in `c-lang-const'.
1928 val)
1935 ;; Emacs has a weird bug where it seems to fail to read
1936 ;; backquote lists from byte compiled files correctly (,@
1937 ;; forms, to be specific), so make sure the bindings in the
1938 ;; expansion below don't contain any backquote stuff.
1939 ;; (XEmacs handles it correctly and doesn't need this for that
1940 ;; reason, but we also use this expansion handle
1941 ;; `c-lang-defconst-eval-immediately' and to register
1942 ;; dependencies on the `c-lang-const's in VAL.)
1948 ;; Compile in the other files that have provided source
1949 ;; definitions for this symbol, to make sure the order in the
1950 ;; `source' property is correct even when files are loaded out of
1951 ;; order.
1953 ;; Reverse to get the right load order.
1961 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1962 ; '
1967 ;; Used by `c-lang-defconst'.
1976 ;;(when (cdr-safe elem)
1977 ;; (message "Language constant %s redefined in %S" name file))
1979 ;; Note that the order in the source alist is relevant. Like how
1980 ;; `c-lang-defconst' reverses the bindings, this reverses the
1981 ;; order between files so that the last to evaluate comes first.
1991 ;; Bind the symbol as a variable, or clear any earlier evaluated
1992 ;; value it has.
1995 ;; Clear the evaluated values that depend on this source.
1998 ptr)
2011 name))
2014 "Get the mode specific value of the language constant NAME in language LANG.
2015 LANG is the name of the language, i.e. the mode name without the
2017 `c-lang-defvar', LANG may be left out to refer to the current
2018 language. NAME and LANG are not evaluated so they should not be
2019 quoted."
2027 mode source-files args)
2033 "Unknown language %S since it got no `c-mode-prefix' property"
2037 ;; No need to find out the source file(s) when we evaluate
2038 ;; immediately since all the info is already there in the
2039 ;; `source' property.
2044 ;; Get the source file(s) that must be loaded to get the value
2045 ;; of the constant. If the symbol isn't defined yet we assume
2046 ;; that its definition will come later in this file, and thus
2047 ;; are no file dependencies needed.
2049 ;; Reverse to get the right load order.
2053 nil ; Exclude our own file.
2057 ;; Make some effort to do a compact call to
2058 ;; `c-get-lang-constant' since it will be compiled in.
2062 args)))
2067 load-in-progress
2070 ;; Either a straight call is requested in the context, or
2071 ;; we're in an "uncontrolled" context and got no language,
2072 ;; or we're not being byte compiled so the compile time
2073 ;; stuff below is unnecessary.
2076 ;; Being compiled. If the loading and compiling version is
2077 ;; the same we use a value that is evaluated at compile time,
2078 ;; otherwise it's evaluated at runtime.
2087 ;; Used by `c-lang-const'.
2095 elem
2099 ;; Record the dependencies between this symbol and the one we're
2100 ;; being evaluated in.
2105 ;; Make sure the source files have entries on the `source'
2106 ;; property so that loading will take place when necessary.
2111 ;; Might pull in more definitions which affect the value. The
2112 ;; clearing of dependent values etc is done when the
2113 ;; definition is encountered during the load; this is just to
2114 ;; jump past the check for a cached value below.
2122 ;; Check if an evaluation of this symbol is already underway.
2123 ;; In that case we just continue with the "assignment" before
2124 ;; the one currently being evaluated, thereby creating the
2125 ;; illusion if a `setq'-like sequence of assignments.
2130 ;; Append `c-lang-constants-under-evaluation' even if an
2131 ;; earlier entry is found. It's only necessary to get
2132 ;; the recording of dependencies above correct.
2136 value
2137 ;; Make sure the recursion limits aren't very low
2138 ;; since the `c-lang-const' dependencies can go deep.
2145 ;; First try the original mode but don't accept an
2146 ;; entry matching all languages since the fallback
2147 ;; mode might have an explicit entry before that.
2150 c-lang-constants)
2151 ;; Try again with the fallback mode from the
2152 ;; original position. Note that
2153 ;; `c-buffer-is-cc-mode' still is the real mode if
2154 ;; language parameterization takes place.
2157 fallback t name))
2158 c-lang-constants)))
2159 ;; A simple lookup with no fallback mode.
2162 c-lang-constants))
2164 "`%s' got no (prior) value in %s (might be a cyclic reference)"
2165 name mode))
2170 ;; Print a message to aid in locating the error. We don't
2171 ;; print the error itself since that will be done later by
2172 ;; some caller higher up.
2174 sym mode)
2179 value))))
2182 ;; Find the first assignment entry that applies to MODE at or after
2183 ;; SOURCE-POS. If MATCH-ANY-LANG is non-nil, entries with `t' as
2184 ;; the language list are considered to match, otherwise they don't.
2185 ;; On return SOURCE-POS is updated to point to the next assignment
2186 ;; after the returned one. If no assignment is found,
2187 ;; `c-lang-constants' is returned as a magic value.
2188 ;;
2189 ;; SOURCE-POS is a vector that points out a specific assignment in
2190 ;; the double alist that's used in the `source' property. The first
2191 ;; element is the position in the top alist which is indexed with
2192 ;; the source files, and the second element is the position in the
2193 ;; nested bindings alist.
2194 ;;
2195 ;; NAME is only used for error messages.
2200 assignment)
2203 t
2204 ;; Handled the last assignment from one file, begin on the
2205 ;; next. Due to the check in `c-lang-defconst', we know
2206 ;; there's at least one.
2211 ;; The file containing the source definitions has not
2212 ;; been loaded.
2215 ;;(message (concat "Loading %s to get the source "
2216 ;; "value for language constant %s")
2217 ;; file name)
2221 ;; The load didn't fill in the source for the
2222 ;; constant as expected. The situation is
2223 ;; probably that a derived mode was written for
2224 ;; and compiled with another version of CC Mode,
2225 ;; and the requested constant isn't in the
2226 ;; currently loaded one. Put in a dummy
2227 ;; assignment that matches no language.
2232 t))
2240 match-any-lang)
2243 c-lang-constants)))
2246 ;; `c-major-mode-is' expands to a call to this function inside
2247 ;; `c-lang-defconst'. Here we also match the mode(s) against any
2248 ;; fallback modes for the one in `c-buffer-is-cc-mode', so that
2249 ;; e.g. (c-major-mode-is 'c++-mode) is true in a derived language
2250 ;; that has c++-mode as base mode.
2257 nil)
2259 match))
2261 \f
2264 ;;; cc-defs.el ends here