| blob | 2991b511830e655ccf122160f124a679fb2fb063 |
1 ;;; cc-defs.el --- compile time definitions for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2011 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 ;; Get the regular expression `sentence-end'.
382 ;; Emacs 22:
384 ;; Emacs <22 + XEmacs
388 ;; Get the default value of the variable sentence end.
390 ;; Emacs 22:
392 ;; Emacs <22 + XEmacs
395 ;; The following is essentially `save-buffer-state' from lazy-lock.el.
396 ;; It ought to be a standard macro.
398 "Bind variables according to VARLIST (in `let*' style) and eval BODY,
399 then restore the buffer state under the assumption that no significant
400 modification has been made in BODY. A change is considered
401 significant if it affects the buffer text in any way that isn't
402 completely restored again. Changes in text properties like `face' or
403 `syntax-table' are considered insignificant. This macro allows text
404 properties to be changed, even in a read-only buffer.
406 This macro should be placed around all calculations which set
408 known to be writable. That way, these text properties remain set
409 even if the user undoes the command which set them.
412 changes \(like adding a newline to calculate a text-property then
413 deleting it again\), so that the user never sees them on his
414 `buffer-undo-list'. See also `c-tentative-buffer-changes'.
416 However, any user-visible changes to the buffer \(like auto-newlines\)
417 must not be within a `c-save-buffer-state', since the user then
418 wouldn't be able to undo them.
420 The return value is the value of the last form in BODY."
423 before-change-functions after-change-functions
424 deactivate-mark
425 buffer-file-name buffer-file-truename ; Prevent primitives checking
426 ; for file modification
436 "Eval BODY and optionally restore the buffer contents to the state it
437 was in before BODY. Any changes are kept if the last form in BODY
438 returns non-nil. Otherwise it's undone using the undo facility, and
439 various other buffer state that might be affected by the changes is
440 restored. That includes the current buffer, point, mark, mark
441 activation \(similar to `save-excursion'), and the modified state.
442 The state is also restored if BODY exits nonlocally.
444 If BODY makes a change that unconditionally is undone then wrap this
445 macro inside `c-save-buffer-state'. That way the change can be done
446 even when the buffer is read-only, and without interference from
447 various buffer change hooks."
449 -tnt-chng-state)
451 ;; Insert an undo boundary for use with `undo-more'. We
452 ;; don't use `undo-boundary' since it doesn't insert one
453 ;; unconditionally.
461 ;; Used internally in `c-tentative-buffer-changes'.
464 ;; No need to use markers for the point and mark; if the
465 ;; undo got out of synch we're hosed anyway.
472 ;; Used internally in `c-tentative-buffer-changes'.
476 ;; No change was done after all.
480 ;; Find and remove the undo boundary.
486 ;; `primitive-undo' will remove the boundary.
491 saved-undo-list))))
503 "Forward skip over syntactic whitespace.
504 Syntactic whitespace is defined as whitespace characters, comments,
505 and preprocessor directives. However if point starts inside a comment
506 or preprocessor directive, the content of it is not treated as
507 whitespace.
509 LIMIT sets an upper limit of the forward movement, if specified. If
510 LIMIT or the end of the buffer is reached inside a comment or
511 preprocessor directive, the point will be left there.
513 Note that this function might do hidden buffer changes. See the
514 comment at the start of cc-engine.el for more info."
522 "Backward skip over syntactic whitespace.
523 Syntactic whitespace is defined as whitespace characters, comments,
524 and preprocessor directives. However if point starts inside a comment
525 or preprocessor directive, the content of it is not treated as
526 whitespace.
528 LIMIT sets a lower limit of the backward movement, if specified. If
529 LIMIT is reached inside a line comment or preprocessor directive then
530 the point is moved into it past the whitespace at the end.
532 Note that this function might do hidden buffer changes. See the
533 comment at the start of cc-engine.el for more info."
541 "Move forward across COUNT balanced expressions.
542 A negative COUNT means move backward. Signal an error if the move
543 fails for any reason.
545 This is like `forward-sexp' except that it isn't interactive and does
546 not do any user friendly adjustments of the point and that it isn't
547 susceptible to user configurations such as disabling of signals in
548 certain situations."
553 "See `c-forward-sexp' and reverse directions."
558 "Like `scan-lists' but returns nil instead of signaling errors
559 for unbalanced parens.
561 A limit for the search may be given. FROM is assumed to be on the
562 right side of it."
576 res)))
578 \f
579 ;; Wrappers for common scan-lists cases, mainly because it's almost
580 ;; impossible to get a feel for how that function works.
583 "Move backward across one balanced group of parentheses.
585 Return POINT when we succeed, NIL when we fail. In the latter case, leave
586 point unmoved."
589 endpos)))
592 "Move backward across one balanced group of parentheses.
594 Return POINT when we succeed, NIL when we fail. In the latter case, leave
595 point unmoved."
598 endpos)))
601 "Return the first position after the list sexp containing POS,
602 or nil if no such position exists. The point is used if POS is left out.
604 A limit for the search may be given. The start position is assumed to
605 be before it."
609 "Return the position of the start of the list sexp containing POS,
610 or nil if no such position exists. The point is used if POS is left out.
612 A limit for the search may be given. The start position is assumed to
613 be after it."
617 "Return the first position inside the first list sexp after POS,
618 or nil if no such position exists. The point is used if POS is left out.
620 A limit for the search may be given. The start position is assumed to
621 be before it."
625 "Return the last position inside the last list sexp before POS,
626 or nil if no such position exists. The point is used if POS is left out.
628 A limit for the search may be given. The start position is assumed to
629 be after it."
633 "Move the point to the first position after the list sexp containing POS,
634 or containing the point if POS is left out. Return t if such a
635 position exists, otherwise nil is returned and the point isn't moved.
637 A limit for the search may be given. The start position is assumed to
638 be before it."
644 res)))
647 "Move the point to the position of the start of the list sexp containing POS,
648 or containing the point if POS is left out. Return t if such a
649 position exists, otherwise nil is returned and the point isn't moved.
651 A limit for the search may be given. The start position is assumed to
652 be after it."
658 res)))
661 "Move the point to the first position inside the first list sexp after POS,
662 or before the point if POS is left out. Return t if such a position
663 exists, otherwise nil is returned and the point isn't moved.
665 A limit for the search may be given. The start position is assumed to
666 be before it."
672 res)))
675 "Move the point to the last position inside the last list sexp before POS,
676 or before the point if POS is left out. Return t if such a position
677 exists, otherwise nil is returned and the point isn't moved.
679 A limit for the search may be given. The start position is assumed to
680 be after it."
686 res)))
688 \f
690 ;; Wrapper around beginning-of-defun.
691 ;;
692 ;; NOTE: This function should contain the only explicit use of
693 ;; beginning-of-defun in CC Mode. Eventually something better than
694 ;; b-o-d will be available and this should be the only place the
695 ;; code needs to change. Everything else should use
696 ;; (c-beginning-of-defun-1)
697 ;;
698 ;; This is really a bit too large to be a macro but that isn't a
699 ;; problem as long as it only is used in one place in
700 ;; `c-parse-state'.
704 c-enable-xemacs-performance-kludge-p)
706 ;; XEmacs only. This can improve the performance of
707 ;; c-parse-state to between 3 and 60 times faster when
708 ;; braces are hung. It can also degrade performance by
709 ;; about as much when braces are not hung.
711 pos)
721 ;; unbalanced parenthesis, while invalid C code,
722 ;; shouldn't cause an infloop! See unbal.c
724 ;; Punt!
731 ))
733 ;; Emacs, which doesn't have buffer-syntactic-context-depth
736 ;; if defun-prompt-regexp is non-nil, b-o-d won't leave us at the
737 ;; open brace.
742 \f
743 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
744 ;; V i r t u a l S e m i c o l o n s
745 ;;
746 ;; In most CC Mode languages, statements are terminated explicitly by
747 ;; semicolons or closing braces. In some of the CC modes (currently AWK Mode
748 ;; and certain user-specified #define macros in C, C++, etc. (November 2008)),
749 ;; statements are (or can be) terminated by EOLs. Such a statement is said to
750 ;; be terminated by a "virtual semicolon" (VS). A statement terminated by an
751 ;; actual semicolon or brace is never considered to have a VS.
752 ;;
753 ;; The indentation engine (or whatever) tests for a VS at a specific position
754 ;; by invoking the macro `c-at-vsemi-p', which in its turn calls the mode
755 ;; specific function (if any) which is the value of the language variable
756 ;; `c-at-vsemi-p-fn'. This function should only use "low-level" features of
757 ;; CC Mode, i.e. features which won't trigger infinite recursion. ;-) The
758 ;; actual details of what constitutes a VS in a language are thus encapsulated
759 ;; in code specific to that language (e.g. cc-awk.el). `c-at-vsemi-p' returns
760 ;; non-nil if point (or the optional parameter POS) is at a VS, nil otherwise.
761 ;;
762 ;; The language specific function might well do extensive analysis of the
763 ;; source text, and may use a caching scheme to speed up repeated calls.
764 ;;
765 ;; The "virtual semicolon" lies just after the last non-ws token on the line.
766 ;; Like POINT, it is considered to lie between two characters. For example,
767 ;; at the place shown in the following AWK source line:
768 ;;
769 ;; kbyte = 1024 # 1000 if you're not picky
770 ;; ^
771 ;; |
772 ;; Virtual Semicolon
773 ;;
774 ;; In addition to `c-at-vsemi-p-fn', a mode may need to supply a function for
775 ;; `c-vsemi-status-unknown-p-fn'. The macro `c-vsemi-status-unknown-p' is a
776 ;; rather recondite kludge. It exists because the function
777 ;; `c-beginning-of-statement-1' sometimes tests for VSs as an optimization,
778 ;; but `c-at-vsemi-p' might well need to call `c-beginning-of-statement-1' in
779 ;; its calculations, thus potentially leading to infinite recursion.
780 ;;
781 ;; The macro `c-vsemi-status-unknown-p' resolves this problem; it may return
782 ;; non-nil at any time; returning nil is a guarantee that an immediate
783 ;; invocation of `c-at-vsemi-p' at point will NOT call
784 ;; `c-beginning-of-statement-1'. `c-vsemi-status-unknown-p' may not itself
785 ;; call `c-beginning-of-statement-1'.
786 ;;
787 ;; The macro `c-vsemi-status-unknown-p' will typically check the caching
788 ;; scheme used by the `c-at-vsemi-p-fn', hence the name - the status is
789 ;; "unknown" if there is no cache entry current for the line.
790 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
793 ;; Is there a virtual semicolon (not a real one or a }) at POS (defaults to
794 ;; point)? Always returns nil for languages which don't have Virtual
795 ;; semicolons.
796 ;; This macro might do hidden buffer changes.
801 ;; Return NIL only if it can be guaranteed that an immediate
802 ;; (c-at-vsemi-p) will NOT call c-beginning-of-statement-1. Otherwise,
803 ;; return non-nil. (See comments above). The function invoked by this
804 ;; macro MUST NOT UNDER ANY CIRCUMSTANCES itself call
805 ;; c-beginning-of-statement-1.
806 ;; Languages which don't have EOL terminated statements always return NIL
807 ;; (they _know_ there's no vsemi ;-).
810 \f
812 ;; Formats an error message for the echo area and dings, i.e. like
813 ;; `error' but doesn't abort.
819 ;; Temporarily switches to the specified syntax table in a failsafe
820 ;; way to execute code.
830 "Skip over any whitespace following point.
831 This function skips over horizontal and vertical whitespace and line
832 continuations."
836 ;; skip-syntax-* doesn't count \n as whitespace..
851 "Skip over any whitespace preceding point.
852 This function skips over horizontal and vertical whitespace and line
853 continuations."
857 ;; skip-syntax-* doesn't count \n as whitespace..
873 "Return non-nil if the current CC Mode major mode is MODE.
874 MODE is either a mode symbol or a list of mode symbols."
877 ;; Inside a `c-lang-defconst'.
891 \f
892 ;; Macros/functions to handle so-called "char properties", which are
893 ;; properties set on a single character and that never spread to any
894 ;; other characters.
897 ;; Constant used at compile time to decide whether or not to use
898 ;; XEmacs extents. Check all the extent functions we'll use since
899 ;; some packages might add compatibility aliases for some of them in
900 ;; Emacs.
909 ;; `c-put-char-property' is complex enough in XEmacs and Emacs < 21 to
910 ;; make it a function.
914 ;; XEmacs.
924 end-open t)))))))))
927 ;; In Emacs < 21 we have to mess with the `rear-nonsticky' property.
934 'rear-nonsticky
936 ;; This won't be used for anything.
941 ;; Put the given property with the given value on the character at
942 ;; POS and make it front and rear nonsticky, or start and end open
943 ;; in XEmacs vocabulary. If the character already has the given
944 ;; property then the value is replaced, and the behavior is
945 ;; undefined if that property has been put by some other function.
946 ;; PROPERTY is assumed to be constant.
947 ;;
948 ;; If there's a `text-property-default-nonsticky' variable (Emacs
949 ;; 21) then it's assumed that the property is present on it.
950 ;;
951 ;; This macro does a hidden buffer change.
955 ;; XEmacs and Emacs < 21.
957 ;; In Emacs 21 we got the `rear-nonsticky' property covered
958 ;; by `text-property-default-nonsticky'.
963 ;; Get the value of the given property on the character at POS if
964 ;; it's been put there by `c-put-char-property'. PROPERTY is
965 ;; assumed to be constant.
968 ;; XEmacs.
971 ;; Emacs.
974 ;; `c-clear-char-property' is complex enough in Emacs < 21 to make it
975 ;; a function, since we have to mess with the `rear-nonsticky' property.
985 'rear-nonsticky
991 ;; Remove the given property on the character at POS if it's been put
992 ;; there by `c-put-char-property'. PROPERTY is assumed to be
993 ;; constant.
994 ;;
995 ;; This macro does a hidden buffer change.
998 ;; XEmacs.
1002 ;; In Emacs 21 we got the `rear-nonsticky' property covered
1003 ;; by `text-property-default-nonsticky'.
1008 ;; Emacs < 21.
1012 ;; Remove all the occurrences of the given property in the given
1013 ;; region that has been put with `c-put-char-property'. PROPERTY is
1014 ;; assumed to be constant.
1015 ;;
1016 ;; Note that this function does not clean up the property from the
1017 ;; lists of the `rear-nonsticky' properties in the region, if such
1018 ;; are used. Thus it should not be used for common properties like
1019 ;; `syntax-table'.
1020 ;;
1021 ;; This macro does hidden buffer changes.
1024 ;; XEmacs.
1028 ;; Emacs.
1032 "Search forward for a text-property PROPERTY having value VALUE.
1033 LIMIT bounds the search. The comparison is done with `equal'.
1035 Leave point just after the character, and set the match data on
1036 this character, and return point. If VALUE isn't found, Return
1037 nil; point is then left undefined."
1051 "Search backward for a text-property PROPERTY having value VALUE.
1052 LIMIT bounds the search. The comparison is done with `equal'.
1054 Leave point just before the character, set the match data on this
1055 character, and return point. If VALUE isn't found, Return nil;
1056 point is then left undefined."
1070 "Remove all text-properties PROPERTY from the region (FROM, TO)
1071 which have the value VALUE, as tested by `equal'. These
1072 properties are assumed to be over individual characters, having
1073 been put there by c-put-char-property. POINT remains unchanged."
1085 ;; Do we have to do anything with stickiness here?
1089 "Remove all text-properties PROPERTY from the region [FROM, TO)
1090 which have the value VALUE, as tested by `equal'. These
1091 properties are assumed to be over individual characters, having
1092 been put there by c-put-char-property. POINT remains unchanged."
1094 ;; XEmacs
1100 ;; Gnu Emacs
1102 \f
1103 ;; Macros to put overlays (Emacs) or extents (XEmacs) on buffer text.
1104 ;; For our purposes, these are characterized by being possible to
1105 ;; remove again without affecting the other text properties in the
1106 ;; buffer that got overridden when they were put.
1109 ;; Put an overlay/extent covering the given range in the current
1110 ;; buffer. It's currently undefined whether it's front/end sticky
1111 ;; or not. The overlay/extent object is returned.
1113 ;; Emacs.
1116 ol)
1117 ;; XEmacs.
1120 ext)))
1123 ;; Deletes an overlay/extent object previously retrieved using
1124 ;; `c-put-overlay'.
1126 ;; Emacs.
1128 ;; XEmacs.
1131 \f
1132 ;; Make edebug understand the macros.
1133 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1134 ; '(progn
1163 \f
1164 ;;; Functions.
1166 ;; Note: All these after the macros, to be on safe side in avoiding
1167 ;; bugs where macros are defined too late. These bugs often only show
1168 ;; when the files are compiled in a certain order within the same
1169 ;; session.
1172 ;; Replacement for end-of-defun that use c-beginning-of-defun-1.
1174 ;; Skip forward into the next defun block. Don't bother to avoid
1175 ;; comments, literals etc, since beginning-of-defun doesn't do that
1176 ;; anyway.
1188 ;; Mark the "<" character at POS as a template opener using the
1189 ;; `syntax-table' property via the `category' property.
1190 ;;
1191 ;; This function does a hidden buffer change. Note that we use
1192 ;; indirection through the `category' text property. This allows us to
1193 ;; toggle the property in all template brackets simultaneously and
1194 ;; cheaply. We use this, for instance, in `c-parse-state'.
1201 ;; Mark the ">" character at POS as an sexp list closer using the
1202 ;; syntax-table property.
1203 ;;
1204 ;; This function does a hidden buffer change. Note that we use
1205 ;; indirection through the `category' text property. This allows us to
1206 ;; toggle the property in all template brackets simultaneously and
1207 ;; cheaply. We use this, for instance, in `c-parse-state'.
1211 ;; Unmark the "<" or "<" character at POS as an sexp list opener using
1212 ;; the syntax-table property indirectly through the `category' text
1213 ;; property.
1214 ;;
1215 ;; This function does a hidden buffer change. Note that we use
1216 ;; indirection through the `category' text property. This allows us to
1217 ;; toggle the property in all template brackets simultaneously and
1218 ;; cheaply. We use this, for instance, in `c-parse-state'.
1222 ;; Suppress the syntactic effect of all marked < and > as parens. Note
1223 ;; that this effect is NOT buffer local. You should probably not use
1224 ;; this directly, but only through the macro
1225 ;; `c-with-<->-as-parens-suppressed'
1230 ;; Restore the syntactic effect of all marked <s and >s as parens. This
1231 ;; has no effect on unmarked <s and >s
1236 ;; Like progn, except that the paren property is suppressed on all
1237 ;; template brackets whilst they are running. This macro does a hidden
1238 ;; buffer change.
1245 ;;;;;;;;;;;;;;;
1248 ;; This is the value of the `category' text property placed on every #
1249 ;; which introduces a CPP construct and every EOL (or EOB, or character
1250 ;; preceding //, etc.) which terminates it. We can instantly "comment
1251 ;; out" all CPP constructs by giving `c-cpp-delimiter' a syntax-table
1252 ;; property '(14) (generic comment delimiter).
1254 ;; This macro does a hidden buffer change.
1260 ;; This macro does a hidden buffer change.
1267 ;; Render all preprocessor constructs syntactically commented out.
1270 ;; Restore the syntactic visibility of preprocessor constructs.
1274 ;; Execute FORMS... whilst the syntactic effect of all characters in
1275 ;; all CPP regions is suppressed. In particular, this is to suppress
1276 ;; the syntactic significance of parens/braces/brackets to functions
1277 ;; such as `scan-lists' and `parse-partial-sexp'.
1286 ;; Execute FORMS... whilst the syntactic effect of all characters in
1287 ;; every CPP region APART FROM THE ONE BETWEEN BEG and END is
1288 ;; suppressed.
1295 \f
1297 ;; return the element of ALIST that matches the first element found
1298 ;; in LIST. Uses assq.
1303 match))
1306 ;; first, find the first entry from LIST that is present in ALIST1,
1307 ;; then find the entry in ALIST2 for that entry.
1311 "Return the syntactic symbol in LANGELEM.
1315 form as used in `c-syntactic-element'."
1319 "Return the anchor position in LANGELEM, or nil if there is none.
1323 form as used in `c-syntactic-element'."
1329 "Return the column of the anchor position in LANGELEM.
1330 Also move the point to that position unless PRESERVE-POINT is non-nil.
1334 form as used in `c-syntactic-element'."
1346 "Return the secondary position in LANGELEM, or nil if there is none.
1349 in `c-syntactic-element'. It may also be a cons cell as passed in the
1350 first argument to lineup functions, but then the returned value always
1351 will be nil."
1355 ;; Do whatever is necessary to keep the region active in XEmacs.
1356 ;; This is not needed for Emacs.
1370 the corresponding symbol."
1376 c-buffer-is-cc-mode))
1381 the value of the variable with that name."
1385 "Return non-nil if position POS in the current buffer has any of the
1386 faces in the list FACES."
1393 pos-faces)
1397 ;; Return t if FACENAME is the name of a face. This method is
1398 ;; necessary since facep in XEmacs only returns t for the actual
1399 ;; face objects (while it's only their names that are used just
1400 ;; about anywhere else) without providing a predicate that tests
1401 ;; face names.
1405 "Like `concat' on LIST, but separate each element with SEPARATOR.
1406 Notably, null elements in LIST are ignored."
1410 "Make a regexp that matches all the strings the list.
1411 Duplicates and nil elements in the list are removed. The resulting
1412 regexp may contain zero or more submatch expressions.
1414 If ADORN is t there will be at least one submatch and the first
1415 surrounds the matched alternative, and the regexp will also not match
1416 a prefix of any identifier. Adorned regexps cannot be appended. The
1417 language variable `c-nonsymbol-key' is used to make the adornment.
1419 A value 'appendable for ADORN is like above, but all alternatives in
1421 instead, so that the regexp remains appendable. Note that this
1422 variant doesn't always guarantee that an identifier prefix isn't
1423 matched since the symbol constituent '_' is normally considered a
1426 The optional MODE specifies the language to get `c-nonsymbol-key' from
1427 when it's needed. The default is the current language taken from
1428 `c-buffer-is-cc-mode'."
1439 ;; This is kludgy but it works: Search for a string that
1440 ;; doesn't occur in any word in LIST. Append it to all
1441 ;; the alternatives where we want to add \>. Run through
1442 ;; `regexp-opt' and then replace it with \>.
1446 pos list)
1450 nil)
1451 t))
1453 found))
1467 ;; Emacs 20 and XEmacs (all versions so far) has a buggy
1468 ;; regexp-opt that doesn't always cope with strings containing
1469 ;; newlines. This kludge doesn't handle shy parens correctly
1470 ;; so we can't advice regexp-opt directly with it.
1494 ;; Add our own grouping parenthesis around re instead of
1495 ;; passing adorn to `regexp-opt', since in XEmacs it makes the
1496 ;; top level grouping "shy".
1505 re)))
1507 ;; Produce a regexp that matches nothing.
1515 "Make a character alternative string from the list of characters CHARS.
1516 The returned string is of the type that can be used with
1517 `skip-chars-forward' and `skip-chars-backward'. If INVERTED is
1518 non-nil, a caret is prepended to invert the set."
1519 ;; This function ought to be in the elisp core somewhere.
1525 ;; Quoting necessary (this method only works in the skip
1526 ;; functions).
1529 ;; Check for range.
1537 str))
1539 ;; Leftovers from (X)Emacs 19 compatibility.
1543 \f
1544 ;; Figure out what features this Emacs has
1552 ;; I've no idea what this actually is, but it's legacy. /mast
1555 ;; XEmacs uses 8-bit modify-syntax-entry flags.
1556 ;; Emacs uses a 1-bit flag. We will have to set up our
1557 ;; syntax tables differently to handle this.
1559 entry)
1562 ;; Emacs
1565 ;; In Emacs, table entries are cons cells
1567 ;; XEmacs
1570 ;; incompatible
1575 list)))
1577 ;; Check whether beginning/end-of-defun call
1578 ;; beginning/end-of-defun-function nicely, passing through the
1579 ;; argument and respecting the return code.
1600 parse-sexp-lookup-properties
1601 parse-sexp-ignore-comments
1602 lookup-syntax-properties)
1606 ;; For some reason we have to set some of these after the
1607 ;; buffer has been made current. (Specifically,
1608 ;; `parse-sexp-ignore-comments' in Emacs 21.)
1610 parse-sexp-ignore-comments t
1611 lookup-syntax-properties t)
1613 ;; Find out if the `syntax-table' text property works.
1624 "CC Mode is incompatible with this version of Emacs - "
1625 "support for the `syntax-table' text property "
1628 ;; Find out if generic comment delimiters work.
1634 ;; Find out if generic string delimiters work.
1640 ;; See if POSIX char classes work.
1642 ;; All versions of Emacs 21 so far haven't fixed
1643 ;; char classes in `skip-chars-forward' and
1644 ;; `skip-chars-backward'.
1653 ;; See if `open-paren-in-column-0-is-defun-start' exists and
1654 ;; isn't buggy (Emacs >= 21.4).
1662 ;; XEmacs. Afaik this is currently an Emacs-only
1663 ;; feature, but it's good to be prepared.
1667 ;; Emacs
1680 ;; See if `parse-partial-sexp' returns the eighth element.
1685 "CC Mode is incompatible with this version of Emacs - "
1688 ;;(message "c-emacs-features: %S" list)
1689 list)
1690 "A list of certain features in the (X)Emacs you are using.
1691 There are many flavors of Emacs out there, each with different
1692 features supporting those needed by CC Mode. The following values
1693 might be present:
1695 '8-bit 8 bit syntax entry flags (XEmacs style).
1696 '1-bit 1 bit syntax entry flags (Emacs style).
1697 'argumentative-bod-function beginning-of-defun passes ARG through
1698 to a non-null beginning-of-defun-function. It is assumed
1699 the end-of-defun does the same thing.
1700 'syntax-properties It works to override the syntax for specific characters
1701 in the buffer with the 'syntax-table property. It's
1702 always set - CC Mode no longer works in emacsen without
1703 this feature.
1704 'gen-comment-delim Generic comment delimiters work
1705 (i.e. the syntax class `!').
1706 'gen-string-delim Generic string delimiters work
1707 (i.e. the syntax class `|').
1708 'pps-extended-state `parse-partial-sexp' returns a list with at least 10
1709 elements, i.e. it contains the position of the start of
1710 the last comment or string. It's always set - CC Mode
1711 no longer works in emacsen without this feature.
1712 'posix-char-classes The regexp engine understands POSIX character classes.
1713 'col-0-paren It's possible to turn off the ad-hoc rule that a paren
1714 in column zero is the start of a defun.
1715 'infodock This is Infodock (based on XEmacs).
1719 \f
1720 ;;; Some helper constants.
1722 ;; If the regexp engine supports POSIX char classes then we can use
1723 ;; them to handle extended charsets correctly.
1737 \f
1738 ;;; System for handling language dependent constants.
1740 ;; This is used to set various language dependent data in a flexible
1741 ;; way: Language constants can be built from the values of other
1742 ;; language constants, also those for other languages. They can also
1743 ;; process the values of other language constants uniformly across all
1744 ;; the languages. E.g. one language constant can list all the type
1745 ;; keywords in each language, and another can build a regexp for each
1746 ;; language from those lists without code duplication.
1747 ;;
1748 ;; Language constants are defined with `c-lang-defconst', and their
1749 ;; value forms (referred to as source definitions) are evaluated only
1750 ;; on demand when requested for a particular language with
1751 ;; `c-lang-const'. It's therefore possible to refer to the values of
1752 ;; constants defined later in the file, or in another file, just as
1753 ;; long as all the relevant `c-lang-defconst' have been loaded when
1754 ;; `c-lang-const' is actually evaluated from somewhere else.
1755 ;;
1756 ;; `c-lang-const' forms are also evaluated at compile time and
1757 ;; replaced with the values they produce. Thus there's no overhead
1758 ;; for this system when compiled code is used - only the values
1759 ;; actually used in the code are present, and the file(s) containing
1760 ;; the `c-lang-defconst' forms don't need to be loaded at all then.
1761 ;; There are however safeguards to make sure that they can be loaded
1762 ;; to get the source definitions for the values if there's a mismatch
1763 ;; in compiled versions, or if `c-lang-const' is used uncompiled.
1764 ;;
1765 ;; Note that the source definitions in a `c-lang-defconst' form are
1766 ;; compiled into the .elc file where it stands; there's no need to
1767 ;; load the source file to get it.
1768 ;;
1769 ;; See cc-langs.el for more details about how this system is deployed
1770 ;; in CC Mode, and how the associated language variable system
1771 ;; (`c-lang-defvar') works. That file also contains a lot of
1772 ;; examples.
1775 "Declare a new language in the language dependent variable system.
1776 This is intended to be used by modes that inherit CC Mode to add new
1777 languages. It should be used at the top level before any calls to
1778 `c-lang-defconst'. MODE is the mode name symbol for the new language,
1779 and BASE-MODE is the mode name symbol for the language in CC Mode that
1780 is to be the template for the new mode.
1782 The exact effect of BASE-MODE is to make all language constants that
1783 haven't got a setting in the new language fall back to their values in
1784 BASE-MODE. It does not have any effect outside the language constant
1785 system."
1794 ;; This obarray is a cache to keep track of the language constants
1795 ;; defined by `c-lang-defconst' and the evaluated values returned by
1796 ;; `c-lang-const'. It's mostly used at compile time but it's not
1797 ;; stored in compiled files.
1798 ;;
1799 ;; The obarray contains all the language constants as symbols. The
1800 ;; value cells hold the evaluated values as alists where each car is
1801 ;; the mode name symbol and the corresponding cdr is the evaluated
1802 ;; value in that mode. The property lists hold the source definitions
1803 ;; and other miscellaneous data. The obarray might also contain
1804 ;; various other symbols, but those don't have any variable bindings.
1809 ;; Return the base name of the current file.
1812 ;; Being loaded.
1813 load-file-name)
1816 ;; Being compiled.
1817 byte-compile-dest-file)
1819 ;; Being evaluated interactively.
1826 "Can be used inside a VAL in `c-lang-defconst' to evaluate FORM
1827 immediately, i.e. at the same time as the `c-lang-defconst' form
1828 itself is evaluated."
1829 ;; Evaluate at macro expansion time, i.e. in the
1830 ;; `cl-macroexpand-all' inside `c-lang-defconst'.
1833 ;; Only used at compile time - suppress "might not be defined at runtime".
1837 "Set the language specific values of the language constant NAME.
1838 The second argument can optionally be a docstring. The rest of the
1839 arguments are one or more repetitions of LANG VAL where LANG specifies
1840 the language(s) that VAL applies to. LANG is the name of the
1842 of such language names, or `t' for all languages. VAL is a form to
1843 evaluate to get the value.
1845 If LANG isn't `t' or one of the core languages in CC Mode, it must
1846 have been declared with `c-add-language'.
1848 Neither NAME, LANG nor VAL are evaluated directly - they should not be
1849 quoted. `c-lang-defconst-eval-immediately' can however be used inside
1850 VAL to evaluate parts of it directly.
1852 When VAL is evaluated for some language, that language is temporarily
1853 made current so that `c-lang-const' without an explicit language can
1854 be used inside VAL to refer to the value of a language constant in the
1855 same language. That is particularly useful if LANG is `t'.
1857 VAL is not evaluated right away but rather when the value is requested
1858 with `c-lang-const'. Thus it's possible to use `c-lang-const' inside
1859 VAL to refer to language constants that haven't been defined yet.
1860 However, if the definition of a language constant is in another file
1861 then that file must be loaded \(at compile time) before it's safe to
1862 reference the constant.
1864 The assignments in ARGS are processed in sequence like `setq', so
1865 \(c-lang-const NAME) may be used inside a VAL to refer to the last
1866 assigned value to this language constant, or a value that it has
1867 gotten in another earlier loaded file.
1869 To work well with repeated loads and interactive reevaluation, only
1870 one `c-lang-defconst' for each NAME is permitted per file. If there
1871 already is one it will be completely replaced; the value in the
1872 earlier definition will not affect `c-lang-const' on the same
1873 constant. A file is identified by its base name."
1876 ;; Make `c-lang-const' expand to a straightforward call to
1877 ;; `c-get-lang-constant' in `cl-macroexpand-all' below.
1878 ;;
1879 ;; (The default behavior, i.e. to expand to a call inside
1880 ;; `eval-when-compile' should be equivalent, since that macro
1881 ;; should only expand to its content if it's used inside a
1882 ;; form that's already evaluated at compile time. It's
1883 ;; however necessary to use our cover macro
1884 ;; `cc-eval-when-compile' due to bugs in `eval-when-compile',
1885 ;; and it expands to a bulkier form that in this case only is
1886 ;; unnecessary garbage that we don't want to store in the
1887 ;; language constant source definitions.)
1890 bindings
1891 pre-files)
1897 ;; The docstring is hardly used anywhere since there's no normal
1898 ;; symbol to attach it to. It's primarily for getting the right
1899 ;; format in the source.
1906 ;; Rework ARGS to an association list to make it easier to handle.
1907 ;; It's reversed at the same time to make it easier to implement
1908 ;; the demand-driven (i.e. reversed) evaluation in `c-lang-const'.
1925 val)
1932 ;; Emacs has a weird bug where it seems to fail to read
1933 ;; backquote lists from byte compiled files correctly (,@
1934 ;; forms, to be specific), so make sure the bindings in the
1935 ;; expansion below don't contain any backquote stuff.
1936 ;; (XEmacs handles it correctly and doesn't need this for that
1937 ;; reason, but we also use this expansion handle
1938 ;; `c-lang-defconst-eval-immediately' and to register
1939 ;; dependencies on the `c-lang-const's in VAL.)
1945 ;; Compile in the other files that have provided source
1946 ;; definitions for this symbol, to make sure the order in the
1947 ;; `source' property is correct even when files are loaded out of
1948 ;; order.
1950 ;; Reverse to get the right load order.
1958 ;(eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
1959 ; '
1964 ;; Used by `c-lang-defconst'.
1973 ;;(when (cdr-safe elem)
1974 ;; (message "Language constant %s redefined in %S" name file))
1976 ;; Note that the order in the source alist is relevant. Like how
1977 ;; `c-lang-defconst' reverses the bindings, this reverses the
1978 ;; order between files so that the last to evaluate comes first.
1988 ;; Bind the symbol as a variable, or clear any earlier evaluated
1989 ;; value it has.
1992 ;; Clear the evaluated values that depend on this source.
1995 ptr)
2008 name))
2011 "Get the mode specific value of the language constant NAME in language LANG.
2012 LANG is the name of the language, i.e. the mode name without the
2014 `c-lang-defvar', LANG may be left out to refer to the current
2015 language. NAME and LANG are not evaluated so they should not be
2016 quoted."
2024 mode source-files args)
2030 "Unknown language %S since it got no `c-mode-prefix' property"
2034 ;; No need to find out the source file(s) when we evaluate
2035 ;; immediately since all the info is already there in the
2036 ;; `source' property.
2041 ;; Get the source file(s) that must be loaded to get the value
2042 ;; of the constant. If the symbol isn't defined yet we assume
2043 ;; that its definition will come later in this file, and thus
2044 ;; are no file dependencies needed.
2046 ;; Reverse to get the right load order.
2050 nil ; Exclude our own file.
2054 ;; Make some effort to do a compact call to
2055 ;; `c-get-lang-constant' since it will be compiled in.
2059 args)))
2064 load-in-progress
2067 ;; Either a straight call is requested in the context, or
2068 ;; we're in an "uncontrolled" context and got no language,
2069 ;; or we're not being byte compiled so the compile time
2070 ;; stuff below is unnecessary.
2073 ;; Being compiled. If the loading and compiling version is
2074 ;; the same we use a value that is evaluated at compile time,
2075 ;; otherwise it's evaluated at runtime.
2084 ;; Used by `c-lang-const'.
2092 elem
2096 ;; Record the dependencies between this symbol and the one we're
2097 ;; being evaluated in.
2102 ;; Make sure the source files have entries on the `source'
2103 ;; property so that loading will take place when necessary.
2108 ;; Might pull in more definitions which affect the value. The
2109 ;; clearing of dependent values etc is done when the
2110 ;; definition is encountered during the load; this is just to
2111 ;; jump past the check for a cached value below.
2119 ;; Check if an evaluation of this symbol is already underway.
2120 ;; In that case we just continue with the "assignment" before
2121 ;; the one currently being evaluated, thereby creating the
2122 ;; illusion if a `setq'-like sequence of assignments.
2127 ;; Append `c-lang-constants-under-evaluation' even if an
2128 ;; earlier entry is found. It's only necessary to get
2129 ;; the recording of dependencies above correct.
2133 value
2134 ;; Make sure the recursion limits aren't very low
2135 ;; since the `c-lang-const' dependencies can go deep.
2142 ;; First try the original mode but don't accept an
2143 ;; entry matching all languages since the fallback
2144 ;; mode might have an explicit entry before that.
2147 c-lang-constants)
2148 ;; Try again with the fallback mode from the
2149 ;; original position. Note that
2150 ;; `c-buffer-is-cc-mode' still is the real mode if
2151 ;; language parameterization takes place.
2154 fallback t name))
2155 c-lang-constants)))
2156 ;; A simple lookup with no fallback mode.
2159 c-lang-constants))
2161 "`%s' got no (prior) value in %s (might be a cyclic reference)"
2162 name mode))
2167 ;; Print a message to aid in locating the error. We don't
2168 ;; print the error itself since that will be done later by
2169 ;; some caller higher up.
2171 sym mode)
2176 value))))
2179 ;; Find the first assignment entry that applies to MODE at or after
2180 ;; SOURCE-POS. If MATCH-ANY-LANG is non-nil, entries with `t' as
2181 ;; the language list are considered to match, otherwise they don't.
2182 ;; On return SOURCE-POS is updated to point to the next assignment
2183 ;; after the returned one. If no assignment is found,
2184 ;; `c-lang-constants' is returned as a magic value.
2185 ;;
2186 ;; SOURCE-POS is a vector that points out a specific assignment in
2187 ;; the double alist that's used in the `source' property. The first
2188 ;; element is the position in the top alist which is indexed with
2189 ;; the source files, and the second element is the position in the
2190 ;; nested bindings alist.
2191 ;;
2192 ;; NAME is only used for error messages.
2197 assignment)
2200 t
2201 ;; Handled the last assignment from one file, begin on the
2202 ;; next. Due to the check in `c-lang-defconst', we know
2203 ;; there's at least one.
2208 ;; The file containing the source definitions has not
2209 ;; been loaded.
2212 ;;(message (concat "Loading %s to get the source "
2213 ;; "value for language constant %s")
2214 ;; file name)
2218 ;; The load didn't fill in the source for the
2219 ;; constant as expected. The situation is
2220 ;; probably that a derived mode was written for
2221 ;; and compiled with another version of CC Mode,
2222 ;; and the requested constant isn't in the
2223 ;; currently loaded one. Put in a dummy
2224 ;; assignment that matches no language.
2229 t))
2237 match-any-lang)
2240 c-lang-constants)))
2243 ;; `c-major-mode-is' expands to a call to this function inside
2244 ;; `c-lang-defconst'. Here we also match the mode(s) against any
2245 ;; fallback modes for the one in `c-buffer-is-cc-mode', so that
2246 ;; e.g. (c-major-mode-is 'c++-mode) is true in a derived language
2247 ;; that has c++-mode as base mode.
2254 nil)
2256 match))
2258 \f
2261 ;;; cc-defs.el ends here