1 use super::{Capturing, FlatToken, ForceCollect, Parser, ReplaceRange, TokenCursor, TrailingToken};
2 use rustc_ast::token::{self, Delimiter, Token, TokenKind};
3 use rustc_ast::tokenstream::{AttrAnnotatedTokenStream, AttributesData, CreateTokenStream};
4 use rustc_ast::tokenstream::{AttrAnnotatedTokenTree, DelimSpan, LazyTokenStream, Spacing};
5 use rustc_ast::{self as ast};
6 use rustc_ast::{AttrVec, Attribute, HasAttrs, HasTokens};
7 use rustc_errors::PResult;
8 use rustc_span::{sym, Span};
10 use std::convert::TryInto;
13 /// A wrapper type to ensure that the parser handles outer attributes correctly.
14 /// When we parse outer attributes, we need to ensure that we capture tokens
15 /// for the attribute target. This allows us to perform cfg-expansion on
16 /// a token stream before we invoke a derive proc-macro.
18 /// This wrapper prevents direct access to the underlying `ast::AttrVec>`.
19 /// Parsing code can only get access to the underlying attributes
20 /// by passing an `AttrWrapper` to `collect_tokens_trailing_tokens`.
21 /// This makes it difficult to accidentally construct an AST node
22 /// (which stores an `ast::AttrVec`) without first collecting tokens.
24 /// This struct has its own module, to ensure that the parser code
25 /// cannot directly access the `attrs` field
26 #[derive(Debug, Clone)]
27 pub struct AttrWrapper {
29 // The start of the outer attributes in the token cursor.
30 // This allows us to create a `ReplaceRange` for the entire attribute
31 // target, including outer attributes.
35 // This struct is passed around very frequently,
36 // so make sure it doesn't accidentally get larger
37 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
38 rustc_data_structures::static_assert_size!(AttrWrapper, 16);
41 pub(super) fn new(attrs: AttrVec, start_pos: usize) -> AttrWrapper {
42 AttrWrapper { attrs, start_pos }
44 pub fn empty() -> AttrWrapper {
45 AttrWrapper { attrs: AttrVec::new(), start_pos: usize::MAX }
47 // FIXME: Delay span bug here?
48 pub(crate) fn take_for_recovery(self) -> AttrVec {
52 // Prepend `self.attrs` to `attrs`.
53 // FIXME: require passing an NT to prevent misuse of this method
54 pub(crate) fn prepend_to_nt_inner(self, attrs: &mut AttrVec) {
55 let mut self_attrs = self.attrs.clone();
56 std::mem::swap(attrs, &mut self_attrs);
57 attrs.extend(self_attrs);
60 pub fn is_empty(&self) -> bool {
64 pub fn maybe_needs_tokens(&self) -> bool {
65 crate::parser::attr::maybe_needs_tokens(&self.attrs)
69 /// Returns `true` if `attrs` contains a `cfg` or `cfg_attr` attribute
70 fn has_cfg_or_cfg_attr(attrs: &[Attribute]) -> bool {
71 // NOTE: Builtin attributes like `cfg` and `cfg_attr` cannot be renamed via imports.
72 // Therefore, the absence of a literal `cfg` or `cfg_attr` guarantees that
73 // we don't need to do any eager expansion.
74 attrs.iter().any(|attr| {
75 attr.ident().map_or(false, |ident| ident.name == sym::cfg || ident.name == sym::cfg_attr)
79 // Produces a `TokenStream` on-demand. Using `cursor_snapshot`
80 // and `num_calls`, we can reconstruct the `TokenStream` seen
81 // by the callback. This allows us to avoid producing a `TokenStream`
82 // if it is never needed - for example, a captured `macro_rules!`
83 // argument that is never passed to a proc macro.
84 // In practice token stream creation happens rarely compared to
85 // calls to `collect_tokens` (see some statistics in #78736),
86 // so we are doing as little up-front work as possible.
88 // This also makes `Parser` very cheap to clone, since
89 // there is no intermediate collection buffer to clone.
91 struct LazyTokenStreamImpl {
92 start_token: (Token, Spacing),
93 cursor_snapshot: TokenCursor,
95 break_last_token: bool,
96 replace_ranges: Box<[ReplaceRange]>,
99 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
100 rustc_data_structures::static_assert_size!(LazyTokenStreamImpl, 144);
102 impl CreateTokenStream for LazyTokenStreamImpl {
103 fn create_token_stream(&self) -> AttrAnnotatedTokenStream {
104 // The token produced by the final call to `{,inlined_}next` was not
105 // actually consumed by the callback. The combination of chaining the
106 // initial token and using `take` produces the desired result - we
107 // produce an empty `TokenStream` if no calls were made, and omit the
108 // final token otherwise.
109 let mut cursor_snapshot = self.cursor_snapshot.clone();
111 std::iter::once((FlatToken::Token(self.start_token.0.clone()), self.start_token.1))
112 .chain((0..self.num_calls).map(|_| {
113 let token = cursor_snapshot.next(cursor_snapshot.desugar_doc_comments);
114 (FlatToken::Token(token.0), token.1)
116 .take(self.num_calls);
118 if !self.replace_ranges.is_empty() {
119 let mut tokens: Vec<_> = tokens.collect();
120 let mut replace_ranges = self.replace_ranges.to_vec();
121 replace_ranges.sort_by_key(|(range, _)| range.start);
123 #[cfg(debug_assertions)]
125 for [(range, tokens), (next_range, next_tokens)] in replace_ranges.array_windows() {
127 range.end <= next_range.start || range.end >= next_range.end,
128 "Replace ranges should either be disjoint or nested: ({:?}, {:?}) ({:?}, {:?})",
137 // Process the replace ranges, starting from the highest start
138 // position and working our way back. If have tokens like:
140 // `#[cfg(FALSE)]` struct Foo { #[cfg(FALSE)] field: bool }`
142 // Then we will generate replace ranges for both
143 // the `#[cfg(FALSE)] field: bool` and the entire
144 // `#[cfg(FALSE)]` struct Foo { #[cfg(FALSE)] field: bool }`
146 // By starting processing from the replace range with the greatest
147 // start position, we ensure that any replace range which encloses
148 // another replace range will capture the *replaced* tokens for the inner
149 // range, not the original tokens.
150 for (range, new_tokens) in replace_ranges.into_iter().rev() {
151 assert!(!range.is_empty(), "Cannot replace an empty range: {:?}", range);
152 // Replace ranges are only allowed to decrease the number of tokens.
154 range.len() >= new_tokens.len(),
155 "Range {:?} has greater len than {:?}",
160 // Replace any removed tokens with `FlatToken::Empty`.
161 // This keeps the total length of `tokens` constant throughout the
162 // replacement process, allowing us to use all of the `ReplaceRanges` entries
163 // without adjusting indices.
164 let filler = std::iter::repeat((FlatToken::Empty, Spacing::Alone))
165 .take(range.len() - new_tokens.len());
168 (range.start as usize)..(range.end as usize),
169 new_tokens.into_iter().chain(filler),
172 make_token_stream(tokens.into_iter(), self.break_last_token)
174 make_token_stream(tokens, self.break_last_token)
179 impl<'a> Parser<'a> {
180 /// Records all tokens consumed by the provided callback,
181 /// including the current token. These tokens are collected
182 /// into a `LazyTokenStream`, and returned along with the result
185 /// Note: If your callback consumes an opening delimiter
186 /// (including the case where you call `collect_tokens`
187 /// when the current token is an opening delimiter),
188 /// you must also consume the corresponding closing delimiter.
190 /// That is, you can consume
191 /// `something ([{ }])` or `([{}])`, but not `([{}]`
193 /// This restriction shouldn't be an issue in practice,
194 /// since this function is used to record the tokens for
195 /// a parsed AST item, which always has matching delimiters.
196 pub fn collect_tokens_trailing_token<R: HasAttrs + HasTokens>(
199 force_collect: ForceCollect,
200 f: impl FnOnce(&mut Self, ast::AttrVec) -> PResult<'a, (R, TrailingToken)>,
201 ) -> PResult<'a, R> {
202 // We only bail out when nothing could possibly observe the collected tokens:
203 // 1. We cannot be force collecting tokens (since force-collecting requires tokens
205 if matches!(force_collect, ForceCollect::No)
206 // None of our outer attributes can require tokens (e.g. a proc-macro)
207 && !attrs.maybe_needs_tokens()
208 // If our target supports custom inner attributes, then we cannot bail
209 // out early, since we may need to capture tokens for a custom inner attribute
211 && !R::SUPPORTS_CUSTOM_INNER_ATTRS
212 // Never bail out early in `capture_cfg` mode, since there might be `#[cfg]`
213 // or `#[cfg_attr]` attributes.
216 return Ok(f(self, attrs.attrs)?.0);
219 let start_token = (self.token.clone(), self.token_spacing);
220 let cursor_snapshot = self.token_cursor.clone();
222 let has_outer_attrs = !attrs.attrs.is_empty();
223 let prev_capturing = std::mem::replace(&mut self.capture_state.capturing, Capturing::Yes);
224 let replace_ranges_start = self.capture_state.replace_ranges.len();
226 let ret = f(self, attrs.attrs);
228 self.capture_state.capturing = prev_capturing;
230 let (mut ret, trailing) = ret?;
232 // When we're not in `capture-cfg` mode, then bail out early if:
233 // 1. Our target doesn't support tokens at all (e.g we're parsing an `NtIdent`)
234 // so there's nothing for us to do.
235 // 2. Our target already has tokens set (e.g. we've parsed something
236 // like `#[my_attr] $item`. The actual parsing code takes care of prepending
237 // any attributes to the nonterminal, so we don't need to modify the
238 // already captured tokens.
239 // Note that this check is independent of `force_collect`- if we already
240 // have tokens, or can't even store them, then there's never a need to
241 // force collection of new tokens.
242 if !self.capture_cfg && matches!(ret.tokens_mut(), None | Some(Some(_))) {
246 // This is very similar to the bail out check at the start of this function.
247 // Now that we've parsed an AST node, we have more information available.
248 if matches!(force_collect, ForceCollect::No)
249 // We now have inner attributes available, so this check is more precise
250 // than `attrs.maybe_needs_tokens()` at the start of the function.
251 // As a result, we don't need to check `R::SUPPORTS_CUSTOM_INNER_ATTRS`
252 && !crate::parser::attr::maybe_needs_tokens(ret.attrs())
253 // Subtle: We call `has_cfg_or_cfg_attr` with the attrs from `ret`.
254 // This ensures that we consider inner attributes (e.g. `#![cfg]`),
255 // which require us to have tokens available
256 // We also call `has_cfg_or_cfg_attr` at the beginning of this function,
257 // but we only bail out if there's no possibility of inner attributes
258 // (!R::SUPPORTS_CUSTOM_INNER_ATTRS)
259 // We only capture about `#[cfg]` or `#[cfg_attr]` in `capture_cfg`
260 // mode - during normal parsing, we don't need any special capturing
261 // for those attributes, since they're builtin.
262 && !(self.capture_cfg && has_cfg_or_cfg_attr(ret.attrs()))
267 let mut inner_attr_replace_ranges = Vec::new();
268 // Take the captured ranges for any inner attributes that we parsed.
269 for inner_attr in ret.attrs().iter().filter(|a| a.style == ast::AttrStyle::Inner) {
270 if let Some(attr_range) = self.capture_state.inner_attr_ranges.remove(&inner_attr.id) {
271 inner_attr_replace_ranges.push(attr_range);
275 .delay_span_bug(inner_attr.span, "Missing token range for attribute");
279 let replace_ranges_end = self.capture_state.replace_ranges.len();
281 let cursor_snapshot_next_calls = cursor_snapshot.num_next_calls;
282 let mut end_pos = self.token_cursor.num_next_calls;
284 // Capture a trailing token if requested by the callback 'f'
286 TrailingToken::None => {}
287 TrailingToken::Semi => {
288 assert_eq!(self.token.kind, token::Semi);
291 TrailingToken::MaybeComma => {
292 if self.token.kind == token::Comma {
298 // If we 'broke' the last token (e.g. breaking a '>>' token to two '>' tokens),
299 // then extend the range of captured tokens to include it, since the parser
300 // was not actually bumped past it. When the `LazyTokenStream` gets converted
301 // into an `AttrAnnotatedTokenStream`, we will create the proper token.
302 if self.token_cursor.break_last_token {
306 "Cannot set `break_last_token` and have trailing token"
311 let num_calls = end_pos - cursor_snapshot_next_calls;
313 // If we have no attributes, then we will never need to
314 // use any replace ranges.
315 let replace_ranges: Box<[ReplaceRange]> = if ret.attrs().is_empty() && !self.capture_cfg {
318 // Grab any replace ranges that occur *inside* the current AST node.
319 // We will perform the actual replacement when we convert the `LazyTokenStream`
320 // to an `AttrAnnotatedTokenStream`
321 let start_calls: u32 = cursor_snapshot_next_calls.try_into().unwrap();
322 self.capture_state.replace_ranges[replace_ranges_start..replace_ranges_end]
325 .chain(inner_attr_replace_ranges.iter().cloned())
326 .map(|(range, tokens)| {
327 ((range.start - start_calls)..(range.end - start_calls), tokens)
332 let tokens = LazyTokenStream::new(LazyTokenStreamImpl {
336 break_last_token: self.token_cursor.break_last_token,
340 // If we support tokens at all
341 if let Some(target_tokens) = ret.tokens_mut() {
342 if target_tokens.is_none() {
343 // Store se our newly captured tokens into the AST node
344 *target_tokens = Some(tokens.clone());
348 let final_attrs = ret.attrs();
350 // If `capture_cfg` is set and we're inside a recursive call to
351 // `collect_tokens_trailing_token`, then we need to register a replace range
352 // if we have `#[cfg]` or `#[cfg_attr]`. This allows us to run eager cfg-expansion
353 // on the captured token stream.
355 && matches!(self.capture_state.capturing, Capturing::Yes)
356 && has_cfg_or_cfg_attr(final_attrs)
358 let attr_data = AttributesData { attrs: final_attrs.iter().cloned().collect(), tokens };
360 // Replace the entire AST node that we just parsed, including attributes,
361 // with a `FlatToken::AttrTarget`. If this AST node is inside an item
362 // that has `#[derive]`, then this will allow us to cfg-expand this
365 if has_outer_attrs { attrs.start_pos } else { cursor_snapshot_next_calls };
366 let new_tokens = vec![(FlatToken::AttrTarget(attr_data), Spacing::Alone)];
369 !self.token_cursor.break_last_token,
370 "Should not have unglued last token with cfg attr"
372 let range: Range<u32> = (start_pos.try_into().unwrap())..(end_pos.try_into().unwrap());
373 self.capture_state.replace_ranges.push((range, new_tokens));
374 self.capture_state.replace_ranges.extend(inner_attr_replace_ranges);
377 // Only clear our `replace_ranges` when we're finished capturing entirely.
378 if matches!(self.capture_state.capturing, Capturing::No) {
379 self.capture_state.replace_ranges.clear();
380 // We don't clear `inner_attr_ranges`, as doing so repeatedly
381 // had a measurable performance impact. Most inner attributes that
382 // we insert will get removed - when we drop the parser, we'll free
383 // up the memory used by any attributes that we didn't remove from the map.
389 /// Converts a flattened iterator of tokens (including open and close delimiter tokens)
390 /// into a `TokenStream`, creating a `TokenTree::Delimited` for each matching pair
391 /// of open and close delims.
392 fn make_token_stream(
393 mut iter: impl Iterator<Item = (FlatToken, Spacing)>,
394 break_last_token: bool,
395 ) -> AttrAnnotatedTokenStream {
398 // This is `None` for the first frame, `Some` for all others.
399 open_delim_sp: Option<(Delimiter, Span)>,
400 inner: Vec<(AttrAnnotatedTokenTree, Spacing)>,
402 let mut stack = vec![FrameData { open_delim_sp: None, inner: vec![] }];
403 let mut token_and_spacing = iter.next();
404 while let Some((token, spacing)) = token_and_spacing {
406 FlatToken::Token(Token { kind: TokenKind::OpenDelim(delim), span }) => {
407 stack.push(FrameData { open_delim_sp: Some((delim, span)), inner: vec![] });
409 FlatToken::Token(Token { kind: TokenKind::CloseDelim(delim), span }) => {
410 let frame_data = stack
412 .unwrap_or_else(|| panic!("Token stack was empty for token: {:?}", token));
414 let (open_delim, open_sp) = frame_data.open_delim_sp.unwrap();
417 "Mismatched open/close delims: open={:?} close={:?}",
420 let dspan = DelimSpan::from_pair(open_sp, span);
421 let stream = AttrAnnotatedTokenStream::new(frame_data.inner);
422 let delimited = AttrAnnotatedTokenTree::Delimited(dspan, delim, stream);
426 panic!("Bottom token frame is missing for token: {:?}", token)
429 .push((delimited, Spacing::Alone));
431 FlatToken::Token(token) => stack
433 .expect("Bottom token frame is missing!")
435 .push((AttrAnnotatedTokenTree::Token(token), spacing)),
436 FlatToken::AttrTarget(data) => stack
438 .expect("Bottom token frame is missing!")
440 .push((AttrAnnotatedTokenTree::Attributes(data), spacing)),
441 FlatToken::Empty => {}
443 token_and_spacing = iter.next();
445 let mut final_buf = stack.pop().expect("Missing final buf!");
446 if break_last_token {
447 let (last_token, spacing) = final_buf.inner.pop().unwrap();
448 if let AttrAnnotatedTokenTree::Token(last_token) = last_token {
449 let unglued_first = last_token.kind.break_two_token_op().unwrap().0;
451 // An 'unglued' token is always two ASCII characters
452 let mut first_span = last_token.span.shrink_to_lo();
453 first_span = first_span.with_hi(first_span.lo() + rustc_span::BytePos(1));
455 final_buf.inner.push((
456 AttrAnnotatedTokenTree::Token(Token::new(unglued_first, first_span)),
460 panic!("Unexpected last token {:?}", last_token)
463 assert!(stack.is_empty(), "Stack should be empty: final_buf={:?} stack={:?}", final_buf, stack);
464 AttrAnnotatedTokenStream::new(final_buf.inner)