src/libsyntax/sess.rs

   1 //! Contains `ParseSess` which holds state living beyond what one `Parser` might.
   2 //! It also serves as an input to the parser itself.
   3
   4 use crate::ast::{CrateConfig, NodeId};
   5 use crate::early_buffered_lints::{BufferedEarlyLint, BufferedEarlyLintId};
   6 use crate::source_map::{SourceMap, FilePathMapping};
   7 use crate::feature_gate::UnstableFeatures;
   8
   9 use errors::{Applicability, Handler, ColorConfig, DiagnosticBuilder};
  10 use rustc_data_structures::fx::{FxHashSet, FxHashMap};
  11 use rustc_data_structures::sync::{Lrc, Lock, Once};
  12 use syntax_pos::{Symbol, Span, MultiSpan};
  13 use syntax_pos::edition::Edition;
  14 use syntax_pos::hygiene::ExpnId;
  15
  16 use std::path::PathBuf;
  17 use std::str;
  18
  19 /// Collected spans during parsing for places where a certain feature was
  20 /// used and should be feature gated accordingly in `check_crate`.
  21 #[derive(Default)]
  22 crate struct GatedSpans {
  23     /// Spans collected for gating `let_chains`, e.g. `if a && let b = c {}`.
  24     crate let_chains: Lock<Vec<Span>>,
  25     /// Spans collected for gating `async_closure`, e.g. `async || ..`.
  26     crate async_closure: Lock<Vec<Span>>,
  27     /// Spans collected for gating `yield e?` expressions (`generators` gate).
  28     crate yields: Lock<Vec<Span>>,
  29     /// Spans collected for gating `or_patterns`, e.g. `Some(Foo | Bar)`.
  30     crate or_patterns: Lock<Vec<Span>>,
  31     /// Spans collected for gating `const_extern_fn`, e.g. `const extern fn foo`.
  32     crate const_extern_fn: Lock<Vec<Span>>,
  33     /// Spans collected for gating `trait_alias`, e.g. `trait Foo = Ord + Eq;`.
  34     pub trait_alias: Lock<Vec<Span>>,
  35     /// Spans collected for gating `associated_type_bounds`, e.g. `Iterator<Item: Ord>`.
  36     pub associated_type_bounds: Lock<Vec<Span>>,
  37     /// Spans collected for gating `crate_visibility_modifier`, e.g. `crate fn`.
  38     pub crate_visibility_modifier: Lock<Vec<Span>>,
  39     /// Spans collected for gating `const_generics`, e.g. `const N: usize`.
  40     pub const_generics: Lock<Vec<Span>>,
  41 }
  42
  43 /// Info about a parsing session.
  44 pub struct ParseSess {
  45     pub span_diagnostic: Handler,
  46     crate unstable_features: UnstableFeatures,
  47     pub config: CrateConfig,
  48     pub edition: Edition,
  49     pub missing_fragment_specifiers: Lock<FxHashSet<Span>>,
  50     /// Places where raw identifiers were used. This is used for feature-gating raw identifiers.
  51     pub raw_identifier_spans: Lock<Vec<Span>>,
  52     /// Used to determine and report recursive module inclusions.
  53     pub(super) included_mod_stack: Lock<Vec<PathBuf>>,
  54     source_map: Lrc<SourceMap>,
  55     pub buffered_lints: Lock<Vec<BufferedEarlyLint>>,
  56     /// Contains the spans of block expressions that could have been incomplete based on the
  57     /// operation token that followed it, but that the parser cannot identify without further
  58     /// analysis.
  59     pub ambiguous_block_expr_parse: Lock<FxHashMap<Span, Span>>,
  60     pub injected_crate_name: Once<Symbol>,
  61     crate gated_spans: GatedSpans,
  62 }
  63
  64 impl ParseSess {
  65     pub fn new(file_path_mapping: FilePathMapping) -> Self {
  66         let cm = Lrc::new(SourceMap::new(file_path_mapping));
  67         let handler = Handler::with_tty_emitter(
  68             ColorConfig::Auto,
  69             true,
  70             None,
  71             Some(cm.clone()),
  72         );
  73         ParseSess::with_span_handler(handler, cm)
  74     }
  75
  76     pub fn with_span_handler(handler: Handler, source_map: Lrc<SourceMap>) -> Self {
  77         Self {
  78             span_diagnostic: handler,
  79             unstable_features: UnstableFeatures::from_environment(),
  80             config: FxHashSet::default(),
  81             edition: ExpnId::root().expn_data().edition,
  82             missing_fragment_specifiers: Lock::new(FxHashSet::default()),
  83             raw_identifier_spans: Lock::new(Vec::new()),
  84             included_mod_stack: Lock::new(vec![]),
  85             source_map,
  86             buffered_lints: Lock::new(vec![]),
  87             ambiguous_block_expr_parse: Lock::new(FxHashMap::default()),
  88             injected_crate_name: Once::new(),
  89             gated_spans: GatedSpans::default(),
  90         }
  91     }
  92
  93     #[inline]
  94     pub fn source_map(&self) -> &SourceMap {
  95         &self.source_map
  96     }
  97
  98     pub fn buffer_lint(
  99         &self,
 100         lint_id: BufferedEarlyLintId,
 101         span: impl Into<MultiSpan>,
 102         id: NodeId,
 103         msg: &str,
 104     ) {
 105         self.buffered_lints.with_lock(|buffered_lints| {
 106             buffered_lints.push(BufferedEarlyLint{
 107                 span: span.into(),
 108                 id,
 109                 msg: msg.into(),
 110                 lint_id,
 111             });
 112         });
 113     }
 114
 115     /// Extend an error with a suggestion to wrap an expression with parentheses to allow the
 116     /// parser to continue parsing the following operation as part of the same expression.
 117     pub fn expr_parentheses_needed(
 118         &self,
 119         err: &mut DiagnosticBuilder<'_>,
 120         span: Span,
 121         alt_snippet: Option<String>,
 122     ) {
 123         if let Some(snippet) = self.source_map().span_to_snippet(span).ok().or(alt_snippet) {
 124             err.span_suggestion(
 125                 span,
 126                 "parentheses are required to parse this as an expression",
 127                 format!("({})", snippet),
 128                 Applicability::MachineApplicable,
 129             );
 130         }
 131     }
 132 }