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     /// Spans collected for gating `decl_macro`, e.g. `macro m() {}`.
  42     pub decl_macro: Lock<Vec<Span>>,
  43 }
  44
  45 /// Info about a parsing session.
  46 pub struct ParseSess {
  47     pub span_diagnostic: Handler,
  48     crate unstable_features: UnstableFeatures,
  49     pub config: CrateConfig,
  50     pub edition: Edition,
  51     pub missing_fragment_specifiers: Lock<FxHashSet<Span>>,
  52     /// Places where raw identifiers were used. This is used for feature-gating raw identifiers.
  53     pub raw_identifier_spans: Lock<Vec<Span>>,
  54     /// Used to determine and report recursive module inclusions.
  55     pub(super) included_mod_stack: Lock<Vec<PathBuf>>,
  56     source_map: Lrc<SourceMap>,
  57     pub buffered_lints: Lock<Vec<BufferedEarlyLint>>,
  58     /// Contains the spans of block expressions that could have been incomplete based on the
  59     /// operation token that followed it, but that the parser cannot identify without further
  60     /// analysis.
  61     pub ambiguous_block_expr_parse: Lock<FxHashMap<Span, Span>>,
  62     pub injected_crate_name: Once<Symbol>,
  63     crate gated_spans: GatedSpans,
  64 }
  65
  66 impl ParseSess {
  67     pub fn new(file_path_mapping: FilePathMapping) -> Self {
  68         let cm = Lrc::new(SourceMap::new(file_path_mapping));
  69         let handler = Handler::with_tty_emitter(
  70             ColorConfig::Auto,
  71             true,
  72             None,
  73             Some(cm.clone()),
  74         );
  75         ParseSess::with_span_handler(handler, cm)
  76     }
  77
  78     pub fn with_span_handler(handler: Handler, source_map: Lrc<SourceMap>) -> Self {
  79         Self {
  80             span_diagnostic: handler,
  81             unstable_features: UnstableFeatures::from_environment(),
  82             config: FxHashSet::default(),
  83             edition: ExpnId::root().expn_data().edition,
  84             missing_fragment_specifiers: Lock::new(FxHashSet::default()),
  85             raw_identifier_spans: Lock::new(Vec::new()),
  86             included_mod_stack: Lock::new(vec![]),
  87             source_map,
  88             buffered_lints: Lock::new(vec![]),
  89             ambiguous_block_expr_parse: Lock::new(FxHashMap::default()),
  90             injected_crate_name: Once::new(),
  91             gated_spans: GatedSpans::default(),
  92         }
  93     }
  94
  95     #[inline]
  96     pub fn source_map(&self) -> &SourceMap {
  97         &self.source_map
  98     }
  99
 100     pub fn buffer_lint(
 101         &self,
 102         lint_id: BufferedEarlyLintId,
 103         span: impl Into<MultiSpan>,
 104         id: NodeId,
 105         msg: &str,
 106     ) {
 107         self.buffered_lints.with_lock(|buffered_lints| {
 108             buffered_lints.push(BufferedEarlyLint{
 109                 span: span.into(),
 110                 id,
 111                 msg: msg.into(),
 112                 lint_id,
 113             });
 114         });
 115     }
 116
 117     /// Extend an error with a suggestion to wrap an expression with parentheses to allow the
 118     /// parser to continue parsing the following operation as part of the same expression.
 119     pub fn expr_parentheses_needed(
 120         &self,
 121         err: &mut DiagnosticBuilder<'_>,
 122         span: Span,
 123         alt_snippet: Option<String>,
 124     ) {
 125         if let Some(snippet) = self.source_map().span_to_snippet(span).ok().or(alt_snippet) {
 126             err.span_suggestion(
 127                 span,
 128                 "parentheses are required to parse this as an expression",
 129                 format!("({})", snippet),
 130                 Applicability::MachineApplicable,
 131             );
 132         }
 133     }
 134 }